Cisco CMTS Cable Command Reference

First Published: 2017-08-28

Last Modified: 2025-04-25

Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
© 2017–2025 Cisco Systems, Inc. All rights reserved.
 CONTENTS

CHAPTER 1 Cable Commands: a through cable-modem 1

ac-start-delay 2
ac-stop-delay 4
access-denied 6
activate-rule at-byte-count 8
active 11
add-priv-data 12
admission-control max-reserved-bandwidth 13
admission-control application-type 15

analog 17
annex 18
annex modulation 19
announce-event-profile 21
application-id 23
assign 24
attributes 26
auto-channel-id 28
base-channel-power 29
bind-vcg 30
block-unref-pids 31

CHAPTER 2 Cable Commands: cable a through cable c 33

cable acfe constant-eir-demand 35

cable acfe enable 36
cable acfe guar-bw-sync-period 37
cable acfe max-bonus-bandwidth 38

Cisco CMTS Cable Command Reference

iii
Contents

cable acfe max-eir-ratio 39

cable admission-control 40
cable admission-control ds-bandwidth 42
cable admission-control event 45
cable admission-control max-reserved-bandwidth 47
cable admission-control preempt priority-voice 49
cable admission-control us-bandwidth 50
cable application-type include 53
cable application-type name 57
cable arp 59
cable arp filter 61
cable asf-qos-profile 64
cable attribute-mask 66
cable bgsync 68
cable bgsync active 70
cable bonding-group-id 72
cable bonding-group-secondary 75
cable cache-snmp active 77

cable channel-group 78
cable clock clear-counters 79
cable clock dti 81
cable clock dti clear-counters 82
cable clock force 83
cable clock source-midplane 85
cable clock upgrade 87
cable cm-status 88
cable cm-status enable 90
cable cmc 93
cable cmc image_upgrade 96
cable cmcpe-list valid-time 97
cable cmts-id 99
cable config-file 100
cable controller-profile 104

Cisco CMTS Cable Command Reference

iv
 Contents

CHAPTER 3 Cable Commands: cable d 105

cable d31-mode 108

cable d40-mode 110
cable dci-response 111
cable dci-upstream-disable 113
cable def-phy-burst 115

cable default-phy-burst 117

cable depi multicast pool 120
cable depi multicast pool redundant include-video-controller 121
cable depi multicast statistic monitor 124

cable device 125

cable dfo-retry-count 127
cable dhcp ipv4 profile 128
cable dhcp-giaddr 129
cable dhcp-insert 133
cable dhcp-parse option 135
cable diaglog 136
cable diplexer-band-edge 137
cable diplexer-mdd-override-band-edge 138
cable divert-rate-limit 139
cable docsis30-voice downstream req-attr-mask 140
cable docsis-ver 142
cable dot1q-vc-map 143
cable dot1q-vc-map port-channel 146
cable downstream annex 147
cable downstream attribute-mask 149
cable downstream channel-id 150
cable downstream-channel-id automatic 152
cable downstream controller-profile 153
cable downstream description 154
cable downstream dsg 155
cable downstream dsg chan-list 156
cable downstream dsg dcd-enable 158

Cisco CMTS Cable Command Reference

v
Contents

cable downstream dsg disable 160

cable downstream dsg rule 161
cable downstream dsg tg 163
cable downstream dsg tg channel 165
cable downstream dsg timer 167
cable downstream dsg vendor-param 169
cable downstream freq-profile 171
cable downstream frequency 172
cable downstream if-output 175
cable downstream interleave-depth 177
cable downstream modulation 179
cable downstream ofdm-chan-profile 181
cable downstream ofdm-flow-to-profile 183
cable downstream ofdm-modulation-profile 185
cable downstream ofdm-power-profile 186
cable downstream ofdm-prof-mgmt exempt-sc-pct 188
cable downstream ofdm-prof-mgmt mer-margin-qdb 189
cable downstream ofdm-prof-mgmt prof-dwngrd-auto 190
cable downstream ofdm-prof-mgmt prof-order-method 191
cable downstream ofdm-prof-mgmt prof-upgrade-pma 192
cable downstream ofdm-prof-mgmt recommend-profile-age 193
cable downstream ofdm-prof-mgmt rxmer-poll-interval 194
cable downstream ofdm-prof-mgmt unfit-profile-age 195
cable downstream override 197
cable downstream power-down-2nd-module 199
cable downstream qam-profile 200
cable downstream qos wfq weight 201
cable downstream rate-limit 203
cable downstream rf-power 206
cable downstream rf-shutdown 209
cable ds-high-low-rate-ratio 212
cable ds-max-burst 213
cable ds-resiliency 216
cable dsg 217

Cisco CMTS Cable Command Reference

vi
 Contents

cable dsg cfr 221

cable dsg chan-list 224
cable dsg client-list 226
cable dsg keepalive 228
cable dsg name-update-interval 230
cable dsg tg 231
cable dsg tg channel 233
cable dsg tg channel ucid 235
cable dsg tg channel vendor-param 237
cable dsg tg default-priority 239
cable dsg tg priority 240
cable dsg timer 241
cable dsg tunnel 243
cable dsg tunnel srv-class 245
cable dsg vendor-param 247
cable dynamic-bonding-group 249
cable dynamic-bw-sharing 251
cable dynamic-flow vrf 253
cable dynamic-qos trace 254
cable dynamic-secret 255
cable dynamic-secret exclude 263
cable dynamic-secret tftp insert-upgrade-server 265

CHAPTER 4 Cable Commands: cable e through cable i 267

cable enable-trap 268

cable event priority 271
cable event syslog-server 274
cable event throttle-adminStatus 277
cable event throttle-interval 280
cable event throttle-threshold 282
cable falcon-100g 284
cable fiber-node 285
cable filter group 288
cable flap-list aging 295

Cisco CMTS Cable Command Reference

vii
 Contents

cable flap-list insertion-time 297

cable flap-list miss-threshold 299
cable flap-list power-adjust threshold 301
cable flap-list size 303
cable freq-range 305
cable frequency-exclusion-band 310
cable helper-address 311
cable host access-group 315
cable high-priority-call-window 317
cable igmp static-group 319
cable init-channel-timeout 321
cable insertion-interval 322
cable intercept 324
cable ip-init 327
cable ip-broadcast-echo 328
cable ip-multicast-echo 330
cable ipc-stats 332
cable ipc-watermark 333
cable ipv6 dhcp-insert 334
cable ipv6 dhcp-relay override 336
cable ipv6 source-verify 337
cable ipv6 source-verify dhcp ns-probe 340
cable ipv6 source-verify leasequery-filter downstream 342

CHAPTER 5 Cable Commands: cable l 343

cable l2vpn 345

cable l2-vpn-service atm-vc 346
cable l2-vpn-service default-nsi 347
cable l2-vpn-service dot1q 349
cable l2-vpn-service xconnect 351
cable l2-vpn-service xconnect nsi dot1q interface port-channel 353
cable l2-vpn dot1q-nsi-redundancy force-switchover 354
xconnect backup force-switchover 355
cable l3-mobility 356

Cisco CMTS Cable Command Reference

viii
 Contents

cable lcha partial-service-reset-timer 358

cable lcha sw-reset 359
cable license 100G-conversion 360
cable linecard auto-rommon-downgrade 361
cable linecard auto-rommon-upgrade 362
cable linecard critical-event-poweroff 363
cable load-balance d20-ggrp-default 365
cable load-balance d20 GLBG auto-generate 368
cable load-balance d30-ggrp-default 370
cable load-balance docsis-enable 373
cable load-balance docsis20-enable 374
cable load-balance docsis30-enable 375
cable load-balance docsis30-enable dynamic downstream 378
cable load-balance docsis30-enable static 379

cable load-balance docsis30-dynamic-enable 380

cable load-balance docsis-group 381
cable load-balance docsis-policy 384
cable load-balance exclude 385
cable load-balance fixed-primary-channel 389
cable load-balance group 390
cable load-balance group (interface) 395
cable load-balance group (Supporting Dynamic Channel Change) 398
cable load-balance group interval 400
cable load-balance group policy 402
cable load-balance group policy ugs 404
cable load-balance group threshold 406
cable load-balance group threshold (Supporting Dynamic Channel Change) 411
cable load-balance method-utilization min-threshold 413
cable load-balance modem max-failures 414
cable load-balance restrict modem 415
cable load-balance rule 416
cable load-balance static cm-delay 418
cable logging badipsource 419
cable logging downstream-index 422

Cisco CMTS Cable Command Reference

ix
 Contents

cable logging layer2events 424

CHAPTER 6 Cable Commands: cable m to n 427

cable map-advance 429

cable match address 431
cable max-hosts 433
cable mc-link-stat ignore 435
cable metering data-per-session 436
cable metering destination 438
cable metering filesystem 442
cable metering ipdr 445
cable metering ipdr-d3 447
cable metering localtime 449

cable metering source-interface 450

cable modem access-group 453
cable modem change-frequency 455
cable modem max-cpe 456
cable modem max-hosts 458
cable modem opt0 460
cable modem qos profile 461
cable modem remote-query 463
cable modem service-class-name 466
cable modem v6-max-cpe-prefix 468
cable modem vendor 469
cable modulation-profile 471
cable modulation-profile global-scheme 481
cable mod-profile-ofdma 483
cable mod-profile-ofdma data-iuc modulation pilot-pattern cwerr-downgrade-iuc 485
cable monitor 487
cable mrc-mode 491
cable mtc-mode 493
cable multicast auth enable default-action 495
cable multicast auth profile-name 496
cable multicast group-encryption 497

Cisco CMTS Cable Command Reference

x
 Contents

cable multicast group-qos 498

cable multicast group-qos default 500
cable multicast mdf-disable 501
cable multicast qos group 503
cable multicast ses-cache 505
cable multicast source 507
cable nd 508

cable nd timeout 509

cable nd validate 510

CHAPTER 7 Cable Commands: cable o through cable r 511

cable ofdm-rf-change-trigger 514

cable ofdma-frequency-exclusion-band 516

cable ofdma-frequency-unused-band 517

cable oudp-leak-detect 518
cable oudp-leak-detect session-id 518

cable oudp-leak-detect 521

cable oudp-leak-detect 522
cable oob 523

cable power 524

cable pre-equalization exclude 527
cable primary-sflow-qos11 keep 530
cable privacy 532
cable privacy bpi-plus-enforce 536
cable privacy bpi-plus-exclude 538
cable privacy bpi-plus-policy 539
cable privacy clone-detect 541
cable privacy eae-exclude 543
cable privacy eae-policy 544
cable privacy encrypt-alg-priority 546
cable privacy hotlist 548
cable privacy kek 550
cable privacy non-mtc-aes128 552
cable privacy revocation crl skip-sig-check 553

Cisco CMTS Cable Command Reference

xi
Contents

cable privacy revocation enable 554

cable privacy revocation ocsp skip-sig-check 555
cable privacy revocation skip-cm-cert 556
cable privacy revocation timeout 557
cable privacy tek 558
cable profile 560
cable profile rpd-event 565
cable proxy-arp 567
cable qos enforce-rule 569
cable qos permission 572
cable qos pre-registration 574
cable qos pro max-ds-burst 575
cable queue-limit 578
cable ranging cm packet 580
cable ranging upstream packet 581

cable rate-limit-algorithm min-plus-excess 582

cable rcc-template 583
cable rcc-templates frequency-based 584

cable rcp-control 585

cable rcp-id 587
cable reconciliation enable 589

cable reconciliation time 590

cable reduction-mode energy-management dynamic-channel-percent 591

cable reduction-mode energy-management enable 592
cable reduction-mode energy-management process-queue-size 593
cable reduction-mode energy-management ranging-init-technique 594
cable reduction-mode mta-battery 595

cable redundancy hashfilter 597

cable redundancy myid 599
cable redundancy node 600
cable redundancy node frequency 602
cable redundancy target 603
cable redundancy threshold 605
cable registration-timeout 607

Cisco CMTS Cable Command Reference

xii
 Contents

cable relay-agent-option 608

cable resiliency cm-max-rbg-moves 610
cable resiliency exclude 611
cable resiliency ds-bonding 613
cable resiliency free-interval 614
cable resiliency idle-interval 615
cable resiliency rbg-throttle 616
cable resiliency traps-interval 619
cable rf-adapt timer 620
cable rf-bandwidth-percent 622
cable rf-change-dampen-time 625
cable rf-change-trigger 626
cable rf-change-up-multiplier 628
cable rf-channel 629
cable rf-channels 634

cable rfswitch copy 636

cable rfswitch delete 637
cable rfswitch reboot 638
cable rfswitch set-active 639
cable rpd 640
cable rpd period-fft (exec mode) 642
cable rpd external-core 643
cable rpd external-core (exec mode) 643
cable rphy static-route 645
cable rphy gcp 647
cable rphy gcp keepalive timeout 649
cable rphy rpd-capability reject-mismatch 651

cable rphy statistics session update-freq 653

cable rphy supso suppress-rpd 654
cable rsvp default-scn 656

CHAPTER 8 Cable Commands: cable s 657

cable service attribute ds-bonded downstream-type bonding-enabled 659

cable service attribute non-ds-bonded downstream-type bonding-disabled 661

Cisco CMTS Cable Command Reference

xiii
Contents

cable service attribute non-ds-bonded legacy-ranging downstream-type 663

cable service attribute voice-enabled 665
cable service attribute withhold-TLVs 667
cable service class 668
cable service flow activity-timeout 675
cable service-flow inactivity-timeout 677
cable service flow inactivity-threshold 679
cable service flow priority 681
cable service type 682
cable set mpls-experimental 683
cable sflog 684
cable shared-secondary-secret 686
cable shared-secret 689
cable sid-cluster-group 692
cable sid-cluster-switching 694
cable sip cir-scale 696
cable sip fpd-auto 697
cable sip ib-stats 698
cable snmp cache active 699

cable snmp cm-rcs 700

cable snmp iftype ds-phy 701
cable snmp trap detailed-alarm 702
cable source-route 703
cable source-verify 704
cable source-verify dhcp arp-probe 709
cable source-verify enable-sav-static 710
cable source-verify enable-sav-trust-last 711
cable source-verify group 712
cable source-verify leasequery-filter downstream 714
cable source-verify leasequery-filter upstream 716
cable source-verify sav-static-group-override 718
cable spectrum-group (global) 719
cable spectrum-group (interface) 723
cable spectrum-group hop period 725

Cisco CMTS Cable Command Reference

xiv
 Contents

cable spectrum-group hop threshold 727

cable spectrum-group shared 730
cable submgmt default 732
cable sync-interval 738

CHAPTER 9 Cable Commands: cable t 739

cable tag 740

cable telco-return enable 743
cable telco-return interval 745
cable telco-return registration-ip 747
cable telco-return spd dhcp-authenticate 749
cable telco-return spd dhcp-server 751
cable telco-return spd dial-timer 753
cable telco-return spd factory-default 755
cable telco-return spd manual-dial 757
cable telco-return spd password 759
cable telco-return spd phonenum 761
cable telco-return spd ppp-authenticate 763
cable telco-return spd radius-realm 765
cable telco-return spd service-provider 767
cable telco-return spd threshold 769
cable telco-return spd username 771
cable tftp-enforce 773
cable throttle-modem 778
cable throttle-ranging 780
cable time-server 781
cable toaster-shrink 782

cable toaster-voltage-adjust 783

cable trust 784

cable trust-last 786
cable tx-power-headroom 787

CHAPTER 10 Cable Commands: cable u through cable w 789

Configuring Upstream Cable Interface Features on the Cisco CMTS Routerscable udc-capability 792

Cisco CMTS Cable Command Reference

xv
Contents

cable upgrade dsphy-fw auto 793

cable upstream active-codes 794
cable upstream adjust-frequency 795
cable upstream admission-control 796
cable upstream admission-control max-reserved-bandwidth 800
cable upstream attribute-mask 802
cable upstream balance-scheduling 803
cable upstream bcast-init-ranging tcc-enc excl-timing 805
cable upstream bonding-group 806
cable upstream chan-class-id 808
cable upstream channel-width 810
cable upstream codes-per-minislot 815
cable upstream concatenation 816
cable upstream connector 817
cable upstream controller-profile 821
cable upstream data-backoff 822
cable upstream description 824
cable upstream differential-encoding 825
cable upstream docsis-mode 826
cable upstream dpon 831

cable upstream dps 833

cable upstream equalization-coefficient 834
cable upstream equalization-error-recovery 837
cable upstream ext-power 839
cable upstream fec 840
cable upstream fec-strength 841
cable upstream fragmentation 842
cable upstream fragment-force 844
cable upstream freq-adj averaging 847
cable upstream frequency 848
cable upstream hopping blind 851
cable upstream hop-priority 853
cable upstream ingress-noise-cancellation 855
cable upstream jumbo-grants 858

Cisco CMTS Cable Command Reference

xvi
 Contents

cable upstream load-balance group 859

cable upstream maintain-psd 861
cable upstream max-channel-power-offset 863
cable upstream max-codes-per-subframe 864
cable upstream max-interleave-step 865
cable upstream max-logical-chans 867
cable upstream max-ports 871
cable upstream min-bwreq-ops 873
cable upstream minimal-voice-jitter 874
cable upstream minislot-size 875
cable upstream modulation-profile 878
cable upstream ofdma-prof-mgmt active-scs-threshold-pct 884
cable upstream ofdma-prof-mgmt downgrade 885
cable upstream ofdma-prof-mgmt exempt-mslot-pct 887
cable upstream ofdma-prof-mgmt mer-margin-qdb 888
cable upstream ofdma-prof-mgmt prof-upgrade-auto 889
cable upstream ofdma-prof-mgmt rxmer-poll-interval 890
cable upstream power-adjust 891
cable upstream power-level 895
cable upstream priority 898
cable upstream qos wfq 899
cable upstream range-backoff 901
cable upstream ranging-init-technique 903
cable upstream ranging-poll 904
cable upstream rate-adapt (global) 906
cable upstream rate-adapt (interface) 907
cable upstream rate-limit 909
cable upstream rate-limit-bwreq exempted-priority 911
cable upstream rate-limit-ccf 912
Upstream Channel Bondingcable upstream resiliency 914
cable upstream resiliency recover 917
cable upstream rf-adapt (logical channel) 918
cable upstream rf-adapt 920
cable upstream rng-holdoff 922

Cisco CMTS Cable Command Reference

xvii
 Contents

cable upstream scheduling type 924

cable upstream scrambler 926
cable upstream-sharing 928
cable upstream shutdown 929
cable upstream spectrum-group 931
cable upstream spreading-interval 933
cable upstream threshold 934
cable upstream threshold hysteresis 939
cable upstream threshold rf-adapt 941
cable upstream timing-adjust 943
cable upstream unfrag-slot-jitter 945
cable util-interval 946
cable vc-map 948
cable video 950
cable video source-switch 951
cable vrf-steering cable-modem 952
cable wideband auto-reset 953

CHAPTER 11 Cable Commands: ca through cr 955

ca-interface 957
ca-system-id 959
channel-group 960
channel-id (cable configuration file) 962
check-scg-at-prov 964
class 966

clear cable admission control counters 967

clear cable arp-filter 969
clear cable bgsync counters 971
clear cable cmc 972
clear cable dsg 973
clear cable flap-list 975
clear cable hop 977

clear cable host 980

clear cable ipc-stats 982

Cisco CMTS Cable Command Reference

xviii
 Contents

clear cable load-balance 983

clear cable load-balance error-statistics 985
clear cable logging 986
clear cable modem attribute-masks 988
clear cable modem cm-status 990
clear cable modem counters 992
clear cable modem delete 994
clear cable modem device-class 998

clear cable modem flap-counters 1001

clear cable modem lock 1004
clear cable modem name 1007
clear cable modem partial-service 1009
clear cable modem path-sel 1010

clear cable modem pnm 1011

clear cable modem rcs-counts 1013
clear cable modem reset 1015
clear cable modem rf-adapt 1019
clear cable modem service-type-id 1021
clear cable modem voice 1023
clear cable multicast ses-cache 1025
clear cable multicast statistics counter 1028
clear cable resil-rf-status 1029
clear cable rf-status 1030
clear cable rpd all event 1031
clear cable rpd reset 1032
clear cable secondary-ip 1034
clear cable upstream ofdma mer-fec 1036
clear hccp counters 1037
clear hccp linecard 1039
clear packetcable gate counter commit 1040
clear packetcable rks 1042
clear pxf 1044
clear pxf statistics drl all 1046

clear pxf statistics drl cable-wan-ip 1047

Cisco CMTS Cable Command Reference

xix
 Contents

clear pxf statistics drl wan-non-ip 1048

clear pxf statistics drl max-rate 1049

clear redundancy 1050

cmc 1052
connection 1053
controller downstream-oob 55d1-profile 1054
controller integrated-cable 1055
controller modular-cable 1057
controller upstream-cable 1059

controller upstream-oob 55d1-profile 1060

cops ip dscp 1061
cops listeners access-list 1065
cops tcp window-size 1067
core-interface 1069
cp-overrule 1070
cpd 1071
cpd cr-id 1072
cpe max 1073
cyclic-prefix 1075

CHAPTER 12 Cable Commands: d through h 1077

default-nit-reference 1079
default-onid 1080
default-psi-interval 1081
depi-class 1082
depi-tunnel 1084
depi cin-failover 1086
depi eqam-stats 1088
desc-rule 1089
description (bonding-group) 1090
description (cable fiber-node) 1092
description (OFDM channel profile) 1093
description (OFDM modulation profile) 1094
description (redundancy-linecard) 1095

Cisco CMTS Cable Command Reference

xx
 Contents

dest-ip 1096
diagnostic load 1097
diagnostic ondemand action-on-failure 1099
diagnostic unload 1101
disable-auto-restart 1103
do-not-insert 1104
docsis-channel-id 1105
docsis-policy 1106
docsis-version 1107
downstream 1108
downstream cable 1110
downstream downstream-cable 1112
downstream downstream-cable rf-channel 1113
downstream integrated-cable rf-channel (interface) 1114
downstream local upstream 1116
downstream modular-cable rf-channel (channel group) 1117
downstream modular-cable rf-channel (interface) 1118
downstream modular-cable rf-channel 1120
ds-channel 1122
duration 1123
dvb 1126

ecm-pid-source 1127
ecmg 1129
ecmg (Tier-based) 1130
eis 1131
enable (Tier-based) 1132
enabled (enforce-rule) 1133
encrypt 1135
enforced qos-profile 1136
event-profile 1139
exception pxf 1140
facility-alarm (ubr10012) 1142
factory-reset all 1145
factory-reset all secure 1147

Cisco CMTS Cable Command Reference

xxi
 Contents

fail-to-clear 1149
fail-to-clear-duration 1150
filter pid vcg 1151
filter program vcg 1152
freq-profile 1153
frequency 1154
guardband-override (OFDM channel profile) 1155
hccp authentication 1157
hccp authentication key-chain 1159
hccp bypass version 1161
hccp channel-switch 1163
hccp check version 1167
hccp ds-switch 1169
hccp lockout 1171
hccp protect 1173
hccp resync 1175
hccp revertive 1177
hccp reverttime 1179
hccp switch 1181
hccp timers 1183
hccp track 1185
hccp unlockout 1188
hccp working 1190
hw-module bay reload 1192
hw-module shutdown (ubr10012) 1193
hw-module slot 1196

hw-module slot pos 1198

hw-module slot srp 1200
hw-module subslot 1202

CHAPTER 13 Cable Commands: i through p 1205

identifier 1209
init-tech-list 1210
init-tech-ovr 1211

Cisco CMTS Cable Command Reference

xxii
 Contents

interface cable 1213

interface cable-modem 1215
interface integrated-cable 1217
interface modular-cable 1219
interface port-channel 1221
interface virtualportgroup 1223
interface wideband-cable 1224
interleaver-depth (QAM profile) 1227
interleaver-depth (OFDM channel profile) 1229
interval 1230
ip (virtual-arpd) 1231
ip (virtual-om) 1232
ip address 1233
ip address docsis 1234
ip-address (controller) 1236
ip dhcp ping packet 0 1238

ip dhcp pool 1241

ipdr associate 1244
ipdr authorization 1246

ipdr collector 1247

ipdr exporter ack-timeout 1249
ipdr exporter connection active 1250
ipdr exporter keepalive 1251
ipdr exporter max-unacked 1252
ipdr exporter start 1253
ipdr session 1254
ipdr session (global configuration) 1255
ipdr template 1257
ipdr type 1260
ipv6 address ?
issu linecard abortversion 1263
issu linecard acceptversion 1265
issu linecard changeversion 1266
issu linecard loadversion 1268

Cisco CMTS Cable Command Reference

xxiii
Contents

issu linecard prepareversion 1269

issu linecard process stop 1271
issu linecard reloadversion 1273
issu linecard runversion 1275
jitter 1276
join-group 1277
keepalive 1278
lacp fast-switchover 1279
lacp max-bundle 1280
lacp min-bundle 1281
lacp port-priority 1282
lacp system-priority 1284
lane start-freq 1285
lc-control-plane-timeout 1286
lc-us-scheduler-timeout 1287
lcha-preferred 1288
license feature evaluation disable 1289
license feature evaluation enable 1291
linecard 1293
linecard-group (redundancy) 1295
listening-port 1296
logging cmts ipc-cable 1297
logging cmts sea 1299
logical-edge-device 1301
load-interval 1302
low-latency 1303
mac-addr-filter 1304
mac-address 1305
mgmt-intf virtualportgroup 1307
main-cpu 1308
maintenance-mode 1310
match 1312
match rule 1313
max-carrier 1315

Cisco CMTS Cable Command Reference

xxiv
 Contents

max-comp-time 1316
max-ofdm-spectrum 1318
max-streams 1319
member slot 1321

method 1323
mgmt-ip 1325
mgmt-ip (DVB) 1327
microcode (uBR10012) 1328
microcode reload (uBR10012) 1330
min-cp-duration 1332
mode 1334
modular-host subslot 1336
modulation 1338
monitoring-basics 1339
monitoring-duration 1341
mute 1344
multicast-label 1345
multicast-pool 1346
multicast-uplink 1347
name 1348
nc 1349
network 1350
network-delay 1352
nls 1353
nls ag-id auth-key 1354
nls resp-timeout 1355
ofdm-freq-excl-band 1356
ofdm channel-profile 1357
onid 1358
oui 1359
output-rate 1360
override 1362
overrule 1363
overwrite-scg 1365

Cisco CMTS Cable Command Reference

xxv
Contents

packetcable 1366
packetcable authorize vanilla-docsis-mta 1368
packetcable element-id 1370
packetcable gate maxcount 1372
packetcable gate send-subscriberID 1374
packetcable multimedia 1375
packetcable timer 1376
pcr-based-source-switch 1378
peak-time1 1379
penalty-period 1383
periodic-rel-pxf enable 1387
ping docsis 1388
ping docsis pnm 1393
platform power protection 1394
platform punt-policer 1396
platform punt-sbrl 1398
platform aom pending-thresh 1401
pilot-scaling 1402
pme cem 1403
pme mgmt-ip 1405
pme vodsid 1406
policy 1407
power-adjust 1408
power-tilt 1409
prefix 1410
principal 1412
privacy 1413
profile 1415
profile-control 1416
profile-data 1418
profile-description 1420
profile-ncp 1421
protect-tunnel 1422
protocol 1423

Cisco CMTS Cable Command Reference

xxvi
 Contents

provider-name 1424
psi-interval 1425
show ptp clock running 1426
pxf-fail-switchover-trap enable 1427

CHAPTER 14 Cable Commands: q through sg 1429

qos-profile enforced 1432

qos-profile registered 1435
qam-profile 1437
r-dti 1438
rcp-id 1439
receive-channel 1440
receive-module 1442
redundancy 1444
redundancy force-failover main-cpu 1445
redundancy force-switchover main-cpu 1447
redundancy linecard-group 1449
redundancy reload 1454
redundancy switch-activity 1457
registered qos-profile 1459
remap pid vcg 1461
rep-period 1462
report-stream-error cc-error 1464
report-stream-error input-stream-failure report-interval syslog 1465
request platform hardware diagnostic load 1466
request platform hardware diagnostic unload 1467
request platform software package expand 1468
request platform software package install node 1469
request platform software package install rp 1471
request platform software process restart 1472

reserve-pid-range 1474
reset-interval 1475
restart-retry 1476
restricted 1477

Cisco CMTS Cable Command Reference

xxvii
Contents

revertive 1478
rf-chan 1479
rf-channel 1480
rf-channel (Virtual Carrier Group) 1481
rf-channel (table-based vcg) 1482
rf-channel cable downstream channel-id 1483
rf-channel depi-tunnel 1486
rf-channel description 1487
rf-channel frequency 1489
rf-channel group-address 1492
rf-channel ip-address mac-address udp-port 1493
rf-channel network-delay 1496
rf-channel rf-power 1498
rf-channel rf-shutdown 1501
rf-channel stacking 1503
rf-output 1504
rf-port integrated-cable 1505
rf-switch auxport enable 1506
roll-off 1507
route-ecmg 1508
routing-interface-ip 1510
routing-interface-vrf 1511
rpd-ds downstream-cable 1512
rpd-ds downstream-oob-vom 1513
rpd-event 1514
rpd-us upstream-cable 1515
rpd-us upstream-oob-varpd 1516
rpd downstream-cable 1517
sbfd 1518
scramble-video-audio 1519
secondary aux 1520
server 1521
service divert-limit 1523
service divert-rate-limit 1524

Cisco CMTS Cable Command Reference

xxviii
 Contents

service divert-rate-limit ip 1526

service divert-rate-limit ipv6 1528
service divert-rate-limit ip trusted-site 1531
service divert-rate-limit max-rate us-cable 1533
service divert-rate-limit max-rate wan 1535
service divert-rate-limit non-ip 1537
service divert-rate-limit trusted-site 1538
service divert-rate-limit trusted-site-ipv6 1540
service instance 1542
service udp-small-servers max-servers no-limit 1543
service-class 1545
service-class (cmts-tag) 1547
service-class (enforce-rule) 1548
service-descriptor-default 1550
service-distribution-group 1551
service-id 1552
service-name 1553
service-type (service descriptor) 1554
service-type (virtual carrier group) 1555
service-type-id (load-balance) 1556
service-type-id (cmts-tag) 1557
serving-area 1558
session 1559
session name multicast-label 1562

session-range 1564
set clock 1565

CHAPTER 15 Cable Commands: show a through show cable l 1567

show application-buckets 1569

show bridge cable-modem 1571
show cable acfe controller 1573
show cable acfe interface 1576
show cable acfe summary 1579
show cable active-reman 1581

Cisco CMTS Cable Command Reference

xxix
Contents

show cable admission-control 1584

show cable admission-control fiber-node 1592

show cable arp-filter 1593

show cable asf-qos-profile 1601
show cable bgsync 1603
show cable bgsync sync-info cable 1607
show cable bundle 1611
show cable bundle multicast 1614
show cable burst-profile 1616
show cable calls 1618
show cable card 1620

show cable cgd-associations 1623

show cable channel-group 1625
show cable clock 1628
show cable clock dti counters 1634
show cable clock dti status 1635
show cable cmc 1636
show cable cmts-id 1646
show cable depi multicast 1647
show cable device access-group 1649
show cable downstream controller-profile 1652
show cable dp aqm 1653
show cable dp pfg 1655
show cable dp queue 1656
show cable dsg 1658
show cable dsg cfr 1662
show cable dsg host 1667
show cable dsg static-group bundle 1669
show cable dsg tg 1671
show cable dsg tunnel 1674
show cable dynamic-qos trace 1681
show cable dynamic-bonding-group 1683
show cable entropy status 1690
show cable fiber-node 1691

Cisco CMTS Cable Command Reference

xxx
 Contents

show cable filter 1697

show cable flap-list 1702
show cable flap-list reset-cm-list 1713
show cable flap-list wb-rf 1714
show cable freq-profile 1717
show cable hop 1720

show cable host access-group 1725

show cable ib-ipc 1727
show cable ipc-stats 1728
show cable ipv6 leasequery-filter 1732
show cable ipv6 leasequery-stats 1733
show cable l2-vpn dot1q-nsi-redundancy 1734
show cable l2-vpn dot1q-vc-map 1736
show cable l2-vpn vc-map 1741
show cable l2-vpn xconnect 1743
show cable leasequery-filter 1748
show cable leasequery-stats 1752
show cable licenses all 1753
show cable licenses cpb 1756
show cable license wan 1758
show cable load-balance 1759
show cable load-balance docsis-group 1771
show cable logging 1804

CHAPTER 16 Cable Commands: show cable m to show cable u 1811

show cable mac-domain cable forwarding 1816

show cable mac-domain cable cgd-associations 1818
show cable mac-domain cable downstream-service-group 1821
show cable mac-domain cable dpd ocd 1825
show cable mac-domain cable rcc 1827
show cable mac-domain cable rcc simplified 1830
show cable mac-domain cable upstream-service-group 1832
show cable mac-domain fiber-node 1834

show cable mac-domain docsis-mode 1836

Cisco CMTS Cable Command Reference

xxxi
Contents

show cable mcast-shadow 1838

show cable metering-status 1840
show cable modem 1844
show cable modem access-group 1904
show cable modem asf 1908
show cable modem asf sup 1910
show cable modem auth-profile 1911
show cable modem calls 1913
show cable modem classifiers 1916
show cable modem cnr 1919
show cable modem connectivity 1928
show cable modem counters 1933
show cable modem cpe 1938
show cable modem docsis device-class 1942
show cable modem docsis version 1951
show cable modem docsis version d31-capable 1963
show cable modem docsis version d40-capable 1965
show cable modem domain-name 1967
show cable modem errors 1970
show cable modem extended-power 1974
show cable modem fiber-node mac-domain 1976
show cable modem flap 1977
show cable modem internal load-balance 1983
show cable modem ipv6 1985
show cable modem ipv6 summary 1995
show cable load-balance move-history cable x/y/z 1996
show cable modem low-latency-capable 1998
show cable modem mac 1999
show cable modem maintenance 2011
show cable modem offline 2017
show cable modem partial-mode 2027
show cable modem partial-service 2030
show cable modem path-sel 2033
show cable modem phy normalized 2036

Cisco CMTS Cable Command Reference

xxxii
 Contents

show cable modem phy 2047

show cable modem phy us-pwr 2058

show cable modem phy ofdm 2064
show cable modem phy ofdm-profile 2065
show cable modem primary-channel 2068
show cable modem primary-channel summary total 2070
show cable modem privacy 2073
show cable modem prof-mgmt 2079
show cable modem qos 2109
show cable modem reduction-mode energy-management-mode 2116
show cable modem reduction-mode energy-management-param 2117
show cable modem reduction-mode energy-management-status 2118
show cable modem reduction-mode mta-battery 2119

show cable modem registered 2120

show cable modem remote-query 2127
show cable modem resiliency 2132
show cable modem rogue 2134
show cable modem rbg-activity 2138
show cable modem rpd 2140
show cable modem rpd all summary 2184
show cable modem select 2185
show cable modem service-type-id 2191
show cable modem service-flow 2193
show cable modem smp 2208
show cable modem subscriber 2209
show cable modem summary 2211
show cable modem summary scn 2218
show cable modem summary wb-rf 2219
show cable modem sysDescr 2222
show cable modem tcs summary 2225
show cable modem tftp 2228
show cable modem timeline 2230
show cable modem type 2233
show cable modem unregistered 2237

Cisco CMTS Cable Command Reference

xxxiii
Contents

show cable modem vendor 2248

show cable modem verbose 2255
show cable modem voice 2269
show cable modem wideband 2270
show cable modem wideband phy 2282

show cable modem wideband primary-channel 2285

show cable modem wideband rcs-status 2286
show cable modulation-profile 2291
show cable multicast authorization 2300
show cable multicast db 2304

show cable multicast debug 2310

show cable multicast dsid 2313
show cable multicast qos 2318
show cable multicast ses-cache 2321
show cable multicast statistics 2326
show cable noise 2331
show cable ofdm-chan-profiles 2332
show cable ofdm-modulation-profiles 2334
show cable privacy 2336
show cable profile 2338
show cable qam-profile 2340
show cable qos enforce-rule 2342
show cable qos permission 2347
show cable qos profile 2349
show cable rate-adapt 2352
show cable rate-limit-ccf 2354
show cable rcp-id 2356
show cable rcps 2357
show cable redundancy 2358
show cable resil-rf-status 2360
show cable resiliency 2362
show cable resiliency counts 2364
show cable resiliency exclude 2365
show cable resiliency throttled-cm 2366

Cisco CMTS Cable Command Reference

xxxiv
 Contents

show cable rf-adapt 2368

show cable rf-status 2371
show cable rpd 2373
show cable rpd 55d1-us cpp-cache 2377
show cable rpd alloc-chan-resources 2378
show cable rpd auxiliary 2379
show cable rpd capability 2381
show cable rpd config 2383
show cable rpd core-ident 2385
show cable rpd depi 2387
show cable rpd depi session 2392
show cable rpd depi tunnel 2396
show cable rpd event 2399
show cable rpd gcp-session 2400
show cable rpd gcp-state 2402
show cable rpd gcp-transaction 2404
show cable rpd group 2407
show cable rpd host-resources 2411
show cable rpd lcce-chan-reach 2413
show cable rpd identification 2414
show cable rpd info 2415
show cable rpd ipv6 2416
show cable rpd lcha-cores 2417
show cable rpd location 2419
show cable rpd md-association 2420
show cable rpd name 2422
show cable rpd online 2424
show cable rpd offline 2426
show cable rpd pilot-tone 2428
show cable rpd principal 2430
show cable rpd sbfd-session 2432
show cable rpd spectrum-capture-capabilities 2433
show cable rpd slot 2435
show cable rpd summary 2436

Cisco CMTS Cable Command Reference

xxxv
Contents

show cable rpd tengigabitethernet 2437

show cable rpd topology 2438
show cable rpd us-phy channel 2439
show cable rpd verbose 2441
show cable rpd version 2443
show cable rpd sw-version 2444
show cable rsvp flow-db 2445
show cable service-class 2447
show cable service-voice downstream-type 2451
show cable service-flow summary 2452
show cable service-flow summary detail 2456
show cable signal-quality 2458
show cable snmp cache-status 2462
show cable spectrum-analysis 2463
show cable spectrum-group 2466
show cable subscriber-usage 2469
show cable tech-support 2473
show cable throttle-modem 2477
show cable upstream controller-profile 2479
show cable upstream service-flow summary 2480
show cable upstream ofdma mer-fec 2482
show cable upstream ofdma chan-util 2483
show cable urm 2484
show cable us-sg 2490
show cable video announce-event-profile 2492
show cable video encryption 2493
show cable video encryption dvb 2494

show cable video encryption linecard 2497

show cable video encryption pme 2499
show cable video gqi connections 2501
show cable video jitter 2502
show cable video integrated-cable 2503
show cable video logical-edge-device 2505
show cable video low-latency linecard 2507

Cisco CMTS Cable Command Reference

xxxvi
 Contents

show cable video output-port 2508

show cable video scg 2509
show cable video service-distribution-group 2511
show cable video session all 2512
show cable video session logical-edge-device 2514
show cable video snmp-alarms 2520
show cable video snmp-alarm-config 2522
show cable video vei-bundle 2523
show cable video virtual-carrier-group 2524

CHAPTER 17 Cable Commands: show ch through show cr 2527

show checkpoint 2528

show cmts ipc-cable client base 2535
show controller gigabitethernet 2540
show controller integrated-cable 2542
show controllers integrated-cable counter ofdm-channel snmp-rolling-avg 2574
show controller integrated-cable counter rf-channel 2576
show controllers integrated-cable counter rf-channel snmp-rolling-avg 2578
show controller tengigabitethernet 2580
show controllers cable 2586
show controllers cable jib 2608
show controllers cable upstream spectrum 2615
show controllers clock-reference 2620
show controllers downstream-cable 2626
show controllers downstream-cable rf-channel prof-order 2629
show controllers jacket 2631
show controllers modular-cable 2633
show controllers upstream-cable 2646
show cpd 2649
show cr10k-rp cable 2650
show cr10k-rp controller 2654
show cr10k-rp queue 2657
show cr10k-rp slots 2661
show crypto entropy sample 2664

Cisco CMTS Cable Command Reference

xxxvii
 Contents

show crypto entropy status 2665

show crypto ikev2|ipsec sa detail 2666

CHAPTER 18 Cable Commands: show d through show i 2669

show debug 2672

show depi 2674
show depi session 2676
show depi tunnel 2684
show derived-config interface cable 2687
show derived-config interface wideband-Cable 2689
show dhcp 2691
show diag all eeprom detail | include MAC 2694
show diagnostic bootup level 2695
show diagnostic content 2696
show diagnostic ood-status 2700
show diagnostic result 2704
show diagnostic schedule 2708
show diagnostic status 2710
show facility-alarm status 2711
show frame-clocks 2714
show hardware pxf 2715
show hccp 2716
show hccp channel-switch 2726
show hccp group 2730
show hccp interface 2733
show hccp linecard 2735
show hdd-devices summary 2737
show hw-module bay 2738
show hw-module bay oir 2745
show hw-module bay transceiver 2749
show hw-module subslot oir 2751
show ib statistic 2754
show interface bundle 2755
show interface cable 2759

Cisco CMTS Cable Command Reference

xxxviii
 Contents

show interface cable admission-control reservation 2766

show interface cable cable-monitor 2770
show interface cable controller 2774
show interface cable downstream 2776
show interface cable dsg downstream 2779
show interface cable dsg downstream tg 2787
show interface cable dynamic-service statistics 2790
show interface cable intercept 2792
show interface cable mac-scheduler 2794
show interface cable modem 2807
show interface cable monitor 2817
show interface cable multicast-sessions 2819
show interface cable packetcable statistics 2822
show interface cable privacy 2825
show interface cable qos paramset 2829
show interface cable service-flow 2833
show interface cable sid 2847
show interface cable signal-quality 2859
show interface cable upstream 2861
show interface cable upstream debug 2874
show interface gigabitethernet 2878
show interface integrated-cable 2881
show interface integrated-cable queue 2888
show interface modular-cable 2893
show interface modular-cable accounting 2895
show interface modular-cable description 2897
show interface modular-cable dlm 2899
show interface modular-cable downstream 2901
show interface modular-cable intercept 2903
show interface modular-cable multicast-sessions 2905
show interface modular-cable stats 2908
show interface modular-cable summary 2910
show interface modular-cable switching 2912
show interface multicast-gcr 2914

Cisco CMTS Cable Command Reference

xxxix
 Contents

show interface port-channel 2916

show interface rf-status 2919
show interface resil-rf-status 2921
show interfaces tengigabitethernet 2923
show interfaces video accounting 2925
show interfaces VirtualPortGroup 2926
show interface wideband-cable 2928
show interface wideband-cable multicast-sessions 2938
show interface wideband-cable queue 2941
show ip arp vrf 2945
show ip interface brief 2947
show ipdr collector 2949
show ipdr exporter 2950
show ipdr session 2952
show ipdr session collector 2954
show ipdr session template 2956

CHAPTER 19 Cable Commands: show l through show z 2957

show lacp 2959

show lcha logging 2964

show lcha rfsw 2966

show license summary 2967

show logging onboard 2969

show nls 2973

show nls ag-id 2975
show nls flow 2976
show cable oudp-leak-detect 2977
show packetcable cms 2979
show packetcable event 2983
show packetcable gate 2986
show packetcable gate counter commit 2990
show packetcable gate ipv6 2992
show packetcable gate multimedia 2995
show packetcable global 2999

Cisco CMTS Cable Command Reference

xl
 Contents

show platform hardware diagnostic status 3003

show platform hardware dpic 3004
show platform hardware qfp active cable dpic-lcha if-name 3006
show platform hardware qfp active cable us-mpls-tc 3008
show platform hardware qfp active feature docsis bf 3010

show platform hardware qfp active feature docsis cbl-vrf-steering 3012

show platform hardware qfp active feature docsis mpls_tc-precfy db 3013

show platform hardware qfp active infrastructure punt sbrl 3014

show platform hardware qfp active infrastructure punt summary 3016

show platform integrity 3018

show platform software cable 3022
show platform software iomd 3024
show platform software ios/cdman ipccl 3026

show platform software ios ipccl 3029

show platform software ios socket statistics 0 3032

show platform software patch 3033

show platform software ptpd stat stream 3035

show platform software punt-policer 3037

show platform software restart info 3041
show platform software trace message lc-veman LC slot number/0 3043
show ptp clock 3044
show pxf cable 3047
show pxf cable controller 3053
show pxf cable feature 3055
show pxf cable interface 3057
show pxf cable multicast 3060
show pxf cpu 3061
show pxf cpu drl-trusted-sites 3078
show pxf cpu queue wb-spa 3080
show pxf cpu statistics drl ipv4 3083
show pxf cpu statistics drl ipv6 3085
show pxf cpu statistics drl max-rate us-cable 3087
show pxf cpu statistics drl max-rate wan 3088

show pxf cpu statistics drl us-cable 3089

Cisco CMTS Cable Command Reference

xli
 Contents

show redundancy 3091

show redundancy config-sync 3103

show redundancy linecard 3105

show redundancy platform 3107

show running-config interface cable 3109
show run interface VirtualPortGroup 3113
show run | se ptp 3114

show snmp | i queue 3115

show tech-support 3116
show usb-devices summary 3121

CHAPTER 20 Cable Commands: snmp through w 3123

snmp manager 3126

snmp server dispatcher-queue-size 3128
snmp-server enable traps cable 3129
snmp-server enable traps rpd-event 3132
snmp-server enable traps docsis-cm 3133
snmp-server enable traps docsis-cmts 3135
snmp-server enable traps docsis-resil 3137
snmp-server enable traps video-cable 3139
snmp-server host traps docsis-resil 3141
snmp-server host traps version 2c public udp-port 3142
snmp server local-queue-size 3143
snmp-trap input-stream-failure multicast 3144
source-id 3145
spectrum-inversion 3146
start-delay 3148
start-frequency 3150
stop-delay 3151
strong-pairing-enforce 3153
subcarrier-spacing 3154
switchover pxf restart 3156
switchover timeout 3158
symbol-rate 3160

Cisco CMTS Cable Command Reference

xlii
 Contents

table-based 3161
tag 3162
test cable dcc (Supporting Dynamic Channel Change) 3163
test cable pnm rxmer ifIndex get all 3167
test cable pnm rxmer show 3168
test cable voice 3169
threshold 3170
tier-based 3172
timeout init-session 3173
timeout idle-session 3174
timeout off-session 3175
timestamp 3176
tlv 3178
tos 3179
tos (multicast qos) 3180
trans-start-delay 3181
trans-stop-delay 3183
type 3185
type (ECMG) 3186
upgrade fpd auto 3187
upgrade fpd file 3189
upgrade fpga auto-upgrade 3190
upgrade fpga file 3192
upgrade hw-programmable cable 3194
upstream 3196
upstream (config-lb-group) 3197
upstream cable channel 3199
upstream cable connector 3201
upstream freq-range 3203
upstream upstream-cable 3205
us-channel 3206
us-channel chan-class-id 3209

us-channel channel-width 3210

us-channel cyclic-prefix 3212

Cisco CMTS Cable Command Reference

xliii
 Contents

us-channel description 3213

us-channel docsis-mode 3214

us-channel equalization-coefficient 3216

us-channel frequency 3218

us-channel hop-priority 3220

us-channel ingress-noise-cancellation 3222

us-channel maintain-psd 3223

us-channel minislot-size 3224

us-channel modulation-profile 3226

us-channel power-level 3228

us-channel rng-holdoff 3230
us-channel spectrum-group 3231

us-channel subcarrier-spacing 3232

us-channel threshold 3233

us-channel threshold hysteresis 3235

vcg 3236
vcg (config-video-bd) 3237
vcg (table-based) 3239
vei-bundle 3240
video 3242
virtual-arpd 3244
virtual-carrier-group 3245
virtual-edge-input-ip 3246
virtual-om 3248
vrf (multicast qos) 3249
weekend duration 3250
weekend off 3252
weekend peak-time1 3253
width 3256

CHAPTER 21 Cisco CMTS Router ROM Monitor Commands 3257

alias 3258
boot 3260
break 3264

Cisco CMTS Cable Command Reference

xliv
 Contents

confreg 3266
cont 3269
context 3271
cpu_card_type 3273
dev 3274
dir 3275
dis 3276
frame 3278
help 3280
history 3282
meminfo 3284
repeat 3285
reset 3287
set 3289
show_spd 3291
stack 3293
sync 3295
sysreset 3297
unalias 3299
unset 3301

Cisco CMTS Cable Command Reference

xlv
Contents

Cisco CMTS Cable Command Reference

xlvi
Cable Commands: a through cable-modem
• ac-start-delay, on page 2
• ac-stop-delay, on page 4
• access-denied, on page 6
• activate-rule at-byte-count, on page 8
• active, on page 11
• add-priv-data, on page 12
• admission-control max-reserved-bandwidth, on page 13
• admission-control application-type , on page 15
• analog, on page 17
• annex, on page 18
• annex modulation, on page 19
• announce-event-profile, on page 21
• application-id, on page 23
• assign, on page 24
• attributes, on page 26
• auto-channel-id, on page 28
• base-channel-power, on page 29
• bind-vcg, on page 30
• block-unref-pids, on page 31

Cisco CMTS Cable Command Reference

1
 Cable Commands: a through cable-modem
ac-start-delay

ac-start-delay
To configure the time between start of first CP after a change in AC and start of ECM broadcast, use the
ac-start-delay command in the DVB scrambling ECMG overrule configuration mode. To void the time
configuration, use the no form of this command.

ac-start-delay delay
no ac-start-delay

ac-start-delay delay Specifies the time between start of first CP after a

change in AC and start of ECM broadcast in
millisecond.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines This command specifies the time between start of first CP after a change in AC and start of ECM broadcast
in millisecond. The valid range is from -30000 to 30000.

The following is an example of how to specify the time between start of first CP after a change in
AC and start of ECM broadcast:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#overrule
Router(config-video-encrypt-dvb-ecmg-overrule)#ac-start-delay 10000

Related Commands Command Description

overrule Enters DVB scrambling configuration mode.

ac-stop-delay Specifies the time between end of last CP preceding

a change in AC and end of ECM broadcast.

max-comp-time Specifies the maximum time needed by ECMG to

compute an ECM.

max-streams Specifies the maximum number of simultaneous open

streams supported by the ECMG on a channel.

Cisco CMTS Cable Command Reference

2
Cable Commands: a through cable-modem
ac-start-delay

Command Description

min-cp-duration Specifies the minimum crypto period.

rep-period Specifies the time between two ECM packets at the

output.

start-delay Specifies the delay between the start of CP and ECM

broadcast.

stop-delay Specifies the delay between the end of CP and ECM

broadcast.

trans-start-delay Specifies the transition start delay.

trans-stop-delay Specifies the transition stop delay.

Cisco CMTS Cable Command Reference

3
 Cable Commands: a through cable-modem
ac-stop-delay

ac-stop-delay
To configure the time between end of last CP preceding a change in AC and end of ECM broadcast, use the
ac-stop-delay command in the DVB scrambling ECMG overrule configuration mode. To void the time
configuration, use the no form of this command.

ac-stop-delay delay
no ac-stop-delay

ac-stop-delay delay Specifies the time between end of last CP preceding

a change in AC and end of ECM broadcast in
millisecond.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines This command specifies the time between end of last CP preceding a change in AC and end of ECM broadcast
in milliseconds. The valid range is from -30000 to 30000.

The following is an example of how to configure the time between end of last CP preceding a change
in AC and end of ECM broadcast:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#overrule
Router(config-video-encrypt-dvb-ecmg-overrule)#ac-stop-delay 10000

Related Commands Command Description

overrule Enters DVB scrambling configuration mode.

ac-start-delay Specifies the time between start of first CP after a

change in AC and start of ECM broadcast.

max-comp-time Specifies the maximum time needed by ECMG to

compute an ECM.

max-streams Specifies the maximum number of simultaneous open

streams supported by the ECMG on a channel.

Cisco CMTS Cable Command Reference

4
Cable Commands: a through cable-modem
ac-stop-delay

Command Description

min-cp-duration Specifies the minimum crypto period.

rep-period Specifies the time between two ECM packets at the

output.

start-delay Specifies the delay between the start of CP and ECM

broadcast.

stop-delay Specifies the delay between the end of CP and ECM

broadcast.

trans-start-delay Specifies the transition start delay.

trans-stop-delay Specifies the transition stop delay.

Cisco CMTS Cable Command Reference

5
 Cable Commands: a through cable-modem
access-denied

access-denied
To create a DOCSIS configuration file that disables network access to the customer premise equipment (CPE)
devices that are attached to the cable modem (CM) on a Cisco CMTS router, use the access-deniedcommand
in cable config-file configuration mode. To enable access, use the no form of this command.

access-denied
no access-denied

Syntax Description This command has no arguments or keywords.

Command Default Access to the cable network is permitted.

Command Modes
Cable config-file configuration (config-file)

Command History Release Modification

12.1(2)EC1 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.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Network Access Control object in the DOCSIS configuration file. If the object is set
to 1 (set by the default of no access-denied), the CPE devices behind the CM allow access to the network. If
the object is set to 0 (by configuration of the access-denied command) to disable network access for the CPE
devices, the CM does not forward traffic from its attached CPE devices.
For normal operation, the CM must be set to allow access (the default). However, to deny service for reasons
such as nonpayment or unauthorized use of services, the access-denied command can be used.

Examples The following example shows how to disable network access for the CPE devices that are connected
to the CM:

cable config-file disable.cm

access-denied

Related Commands Command Description

cable Creates a DOCSIS configuration file and enters configuration file mode.
config-file

channel-id Specifies upstream channel ID.

cpe max Specifies customer premise equipment information.

download Specifies download information for the configuration file.

Cisco CMTS Cable Command Reference

6
Cable Commands: a through cable-modem
access-denied

Command Description

frequency Specifies the downstream frequency.

option Specifies vendor-specific information fields in a DOCSIS configuration file.

privacy Specifies privacy options for baseline privacy images.

service-class Specifies service class definitions for the configuration file.

snmp manager Specifies Simple Network Management Protocol (SNMP) options.

timestamp Enables time-stamp generation.

Cisco CMTS Cable Command Reference

7
 Cable Commands: a through cable-modem
activate-rule at-byte-count

activate-rule at-byte-count

Note Effective with Cisco IOS Release 12.3(9a)BC, the activate-rule at-byte-count command is not available in
Cisco IOS software.

To specify the number of bytes that a subscriber can transmit during the monitoring period on a Cisco CMTS
router, use the activate-rule at-byte-count command in enforce-rule configuration mode. To reset the rule
to its default values, use the no form of this command.

activate-rule at-byte-count kbytes {downstream | upstream} [enforce]

no activate-rule at-byte-count kbytes {downstream | upstream} [enforce]

Syntax Description kbytes Maximum number of kilobytes that the subscriber can transmit in the specified direction
during the monitoring period. The valid range is 1 to 4294967, with a default of 0 (no limit).
Note
To reset the kilobyte count to 0, use the no form of this command.

downstream Specifies that the kilobyte count applies to traffic in the downstream direction.

upstream Specifies that the kilobyte count applies to traffic in the upstream direction. The default value
is upstream.

enforce (Optional) Specifies that the enforce-rule QoS profile should be applied automatically if a
user violates the registered QoS profile.
Note
You must have previously configured a registered QoS profile, using the qos-profile
registered command, before being able to use the enforce keyword.

Command Default The kbytes value defaults to 0 (no limit), upstream direction, and enforce-rule QoS profiles are not automatically
applied (no activate-rule at-byte-count enforce).

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.3(9a)BC This command was removed.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The activate-rule at-byte-count command specifies the maximum number of bytes that a subscriber can
transmit during the monitor window period (see the monitoring-duration command). If a subscriber transmits
traffic beyond this maximum value, the CMTS router considers the subscriber to be overconsuming.

Cisco CMTS Cable Command Reference

8
 Cable Commands: a through cable-modem
activate-rule at-byte-count

If the optional enforce keyword has been specified for an enforce-rule, the CMTS router automatically switches
overconsuming subscribers to the enforced QoS profile (see the qos-profile enforcedcommand). The enforced
QoS profile remains in force during the penalty time period (see the qos-profile registered command).
An enforce-rule can be created for only one direction, either upstream or downstream. To activate subscriber
traffic management for both the upstream and downstream directions, create two different enforce-rules, with
one rule’s activate-rule-at-byte-count command specifying the downstream direction and the other rule
specifying the upstream direction.
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 the enforce-rule.

Note You can create an enforce-rule that is a duplicate of an existing enforce-rule, but the duplicate rule is not
activated and applied to service flows until at least one of its parameters is changed so that it has a unique
configuration.

Examples The following example shows a typical activate-rule-at-byte-count command for the downstream
direction:

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# activate-rule at-byte-count 20 downstream

The following example shows a typical activate-rule-at-byte-count command for the upstream
direction. The enforce option is also added so that the enforce-rule QoS profile is automatically
applied to users who exceed their registered profile:

Router# configure terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# activate-rule at-byte-count 5 upstream enforce

The following example shows the same command being given for a second enforce-rule. The system
rejects the command because it is a duplicate of an existing rule, using the same QoS profile and
direction. You must change at least one of the rule parameters to make it unique before it is mapped
and applied to service flows.

Router# configure terminal

Router(config)# cable qos enforce-rule test2

Router(enforce-rule)# activate-rule at-byte-count 5 upstream enforce

Enforce-rule test2 won't be mapped to service flows as it is duplicate of test1 with same
registered qos-profile 5 and same direction

Cisco CMTS Cable Command Reference

9
 Cable Commands: a through cable-modem
activate-rule at-byte-count

Related Commands Command Description

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

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management on a

Cisco CMTS router.

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

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

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

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

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

10
 Cable Commands: a through cable-modem
active

active
To activate the logical edge device, use the active command in logical edge device protocol configuration
mode. To deactivate the logical edge device, use the no form of this command.

active
no active

Command Default None.

Command Modes
Logical edge device protocol configuration (config-video-led-protocol)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command activates the logical edge device.

Examples The following example shows how to activate the logical edge device:

Router# configure terminal

Router(config)# cable video
Router(config-video)# logical-edge-device vod id 1
Router(config-video-led)# protocol table-based
Router(config-video-led-protocol)# active

Related Commands Command Description

logical-edge-device Define a logical edge device.

protocol Specifies the protocol used in the logical edge device.

virtual-edge-input-ip Specifies and configures a cable multicast QoS group.

vcg Specifies the virtual carrier group assigned to this logical edge device.

show cable video logical-edge-device Displays the logical edge device information.

Cisco CMTS Cable Command Reference

11
 Cable Commands: a through cable-modem
add-priv-data

add-priv-data
To add private data to the descriptor, use the add-priv-data command in the DVB scrambling ECMG descriptor
configuration mode. To void the addition, use the no form of this command.

add-priv-data {as-per-eis | at-es-level}private-data data {all | ecm-ids id}

no add-priv-data {as-per-eis | at-es-level}private-data data {all | ecm-ids id}

as-per-eis Specifies that the insertion level is determined by EIS.

at-es-level Insert at elementary streams level.

private-data data Specifies the private data for the descriptor.

all Apply the rule for all ecm ids.

ecm-ids id Specifies the ecm ids to apply the rule. Only applies
to session-based scrambling.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to add private data to the descriptor:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#desc-rule desc_8_1 id 1
Router(config-video-encrypt-dvb-ecmg-desc)#add-priv-data at-es-level private-data 12345678
ecm-ids 81,82,83,84,85

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

do-not-insert Prohibits inserting standard descriptors.

Cisco CMTS Cable Command Reference

12
 Cable Commands: a through cable-modem
admission-control max-reserved-bandwidth

admission-control max-reserved-bandwidth
To define the maximum reserved bandwidth per bonding group for all service flows that are allowed by the
Cisco CMTS, use the admission-control max-reserved-bandwidth command in the interface configuration
mode. To reset or disable the maximum reserved bandwidth value, use the no form of this command.

admission-control max-reserved-bandwidth bw-in-kbps

no admission-control max-reserved-bandwidth

Syntax Description bw-in-kbps Maximum admission control reserved bandwidth. The value is in kbps and is based on the RF
bandwidth percent defined for the bonding group. Valid range is from 0 to the maximum
bandwidth of the upstream bonding group.

Command Default Without explicitly configured max-reserved-bandwidth, service flows admitted on a US bonding group are
not subject to admission control.

Command Modes
Upstream bonding configuration (config-upstream-bonding)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to define the maximum reserved bandwidth per bonding group. The default
maximum reserved bandwidth value is 80 percent. However the user can choose to configure a higher (up to
96 percent) or lower reserved bandwidth so that there is bandwidth allocated for zero committed information
rate (CIR) best effort traffic.

Examples The following example shows a sample definition of the maximum reserved bandwidth value.

Router> enable
Router# configure terminal
Router(config)# interface c5/0/1
Router(config-if)# cable upstream bonding-group 1
Router(config-upstream-bonding)# admission-control max-reserved-bandwidth 6344

Related Commands Command Description

cable admission-control Configures the CPU and memory thresholds for the Cisco CMTS
router and supporting broadband processing engines (BPEs).

cable admission-control event Configures and enables admission control event types on the Cisco
CMTS router.

cable admission-control ds-bandwidth Configures admission control downstream bandwidth thresholds

on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

13
 Cable Commands: a through cable-modem
admission-control max-reserved-bandwidth

Command Description

cable admission-control us-bandwidth Configures admission control upstream bandwidth thresholds on

the Cisco CMTS router.

debug cable admission-control Enables automatic admission control troubleshooting processes on

the Cisco CMTS router.

show cable admission-control Displays the current admission control configuration and status on
the Cisco CMTS router or on a specified interface.

Cisco CMTS Cable Command Reference

14
 Cable Commands: a through cable-modem
admission-control application-type

admission-control application-type
To enable Service Group Admission Control (SGAC) checking for the specified application-type, use
admission-control application-type command in cable fiber node configuration mode. To remove the
configuration, use the no form of this command.

admission-conrtrol application-type app-type ds-bandwidth percentage

no admission-conrtrol application-type app-type ds-bandwidth

admission-conrtrol application-type grouplist ds-bandwidth percentage

no admission-conrtrol application-type grouplist ds-bandwidth

Syntax Description application-type app-type Specifies the application type. The valid range is from 1 to 8.

application-type grouplist Specifies the application type. The valid range is from 1 to 8. The grouplist
variable can be either a range of application types or a list of specific application
types separated by a space.

ds-bandwidth percentage Specifies the downstream bandwidth percentage. Valid range is from 0 to 100.

Command Default The command is not configured by default.

Command Modes
cable fiber node configuration (config-fiber-node)

Command History Release Modification

IOS-XE This command was modified. The app-type variable was replaced by grouplist variable.
3.17.0S

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.16.0S

Usage Guidelines Use the admission-control application-type command under each fiber node to enable SGAC check for an
application type and any service flow of the specified application type, which is admitted to a service group.
Starting with Cisco IOS-XE Release 3.17.0S, admission control can be applied for both normal priority and
emergency voice flows. The grouplist variable can be either a range of application types or a list of specific
application types separated by a space.

Examples The following example shows how to enable SGAC check for an application type and any service
flow of the specified application type:

Router# configure terminal

Router(config)# cable fiber-node 1
Router(config-fiber-node)# admission-control application-type 1 ds-bandwidth 1

The following example shows how to enable SGAC check for a group of application types:

Cisco CMTS Cable Command Reference

15
 Cable Commands: a through cable-modem
admission-control application-type

Router# configure terminal

Router(config)# cable fiber-node 1
Router(config-fiber-node)# admission-control application-type 1 6 ds-bandwidth 1

Or

Router# configure terminal

Router(config)# cable fiber-node 1
Router(config-fiber-node)# admission-control application-type 3-6 ds-bandwidth 1

Related Commands Command Description

cable application-type Defines an application type and its categorization rules.

Cisco CMTS Cable Command Reference

16
 Cable Commands: a through cable-modem
analog

analog
To configure the analog Tx/Rx modules alarm threshold, use the analog command in RPD configuration
mode. To void the alarm threshold configuration, use the no form of this command.

analog {rx-power | tx-power} major-lo-th value minor-lo-th value normal-th value minor-hi-th value

no analog {rx-power | tx-power}

Syntax Description rx-power Specifies the RPD analog module receiving power.

tx-power Specifies the RPD analog module transmitting power.

major-lo-th Specifies the major low threshold.

minor-lo-th Specifies the minor low threshold.

normal-th Specifies the normal threshold.

minor-hi-th Specifies the minor high threshold.

Command Default None

Command Modes RPD configuration (config-rpd)

Command History Release Modification

Cisco IOS XE Gibraltar 16.10.1d This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use this command to configure the analog Tx/Rx modules alarm threshold.

Note The threshold for each alarm must follow this rule: major low threshold < minor low threshold < normal
threshold < minor high threshold. Otherwise the command can not be executed.

Router# configure terminal

Router(config)# cable rpd 1
Router(config-rpd)# analog rx-power major-lo-th 0 minor-lo-th 50 normal-th 150 minor-hi-th
200

Related Commands Command Description

cable rpd Enters the RPD configuration mode.

Cisco CMTS Cable Command Reference

17
 Cable Commands: a through cable-modem
annex

annex
To set the annex (MPEG framing format) for a specific QAM profile, use the annex command in QAM
profile configuration mode.

annex {A | B | C}

Syntax Description A |B Specifies the MPEG framing format:

|C
• A–Annex A. The downstream is compatible with the European MPEG framing format specified
in ITU-TJ.83 Annex A.
• B–Annex B. The downstream is compatible with the North American MPEG framing format
specified in ITU-TJ.83 Annex B.
• C–Annex C. The downstream is compatible with the Japan MPEG framing format specified
in ITU-TJ.83 Annex C.

Command Default None

Command Modes
QAM profile configuration (config-qam-prof)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to set the Annex (MPEG framing format) for a specific QAM profile.

Examples The following example shows how to set the MPEG framing format for a specific QAM profile:

Router# configure terminal

Router(config)# cable downstream qam-profile 4
Router(config-qam-prof)# annex A

Related Commands Command Description

cable downstream qam-profile Set the QAM profile for the cable interface line card.

interleaver-depth Set the interleaver-depth.

modulation Set the QAM modulation format.

spectrum-inversion Set the spectrum-inversion on or off.

symbol-rate Set the symbol rate.

Cisco CMTS Cable Command Reference

18
 Cable Commands: a through cable-modem
annex modulation

annex modulation

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

To set the annex (MPEG framing format) and modulation for the Wideband SPA, use the annex modulation
command in controller configuration mode. To set the annex to B and the modulation to 64 QAM, use the no
form of this command.

annex {A | B} modulation {64qam | 256qam} [rf-start-index rf-end-index]

no annex {A | B} modulation {64qam | 256qam} [rf-start-index rf-end-index]

Syntax Description A |B Specifies the MPEG framing format:

• A–Annex A. The downstream is compatible with the European MPEG framing format
specified in ITU-TJ.83 Annex A.
• B–Annex B. The downstream is compatible with the North American MPEG framing
format specified in ITU-TJ.83 Annex B.

64qam|256qam Specifies the modulation rate:

• 64qam–64-QAM modulation.
• 256qam–256-QAM modulation.

rf-start-index (Optional) Specifies the start and end indexes for RF channels. The following values are
allowed:
rf-end-index
• If the annex is A and the modulation is 256 QAM, rf-start-index must be 0, and
rf-end-index must be 17.
• For all other cases, rf-start-index must be 0, and rf-end-index must be 23.

Command Default No annex or modulation is set for the Wideband SPA.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.3(23)BC This command was made obsolete and annex and modulation were included as keyword
options in the rf-channel frequency command.

IOS-XE This command was replaced by the controller Integrated-Cable and controller
3.15.0S Upstream-Cable commands on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to set the following on a Wideband SPA:

Cisco CMTS Cable Command Reference

19
 Cable Commands: a through cable-modem
annex modulation

• Annex (MPEG framing format)

• Modulation
• Start and end indexes for RF channels
Each Wideband SPA supports up to 24 RF channels depending on how the SPA is configured with the annex
modulation command.
• For annex A and 256 QAM modulator, each Wideband SPA supports 18 RF channels.
• For all other cases, each Wideband SPA supports 24 RF channels.
The rf-start-index and rf-end-index arguments are intended for future use and are not currently needed. If
rf-start-index and rf-end-index are not specified, the default values are as follows:
• If the annex is A and the modulation is 256 QAM, rf-start-index is 0, and rf-end-index is 17.
• For all other cases, rf-start-index is 0, and rf-end-index is 23.

Examples The following example shows how to set the MPEG framing format and modulation for the Wideband
SPA located at slot 1, subslot 0, bay 0:

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

Router(config-controller)# annex B modulation 64qam

Related Commands Command Description

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband

channel.

controller modular-cable Enters controller configuration mode to configure the

Wideband SPA controller.

ip-address (controller) Sets the IP address of the Wideband SPA FPGA.

modular-host subslot Specifies the modular-host line card.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address and UDP port for each RF
udp-port channel.

rf-channel network delay Specifies the CIN delay for each RF channel.

rf-channel description Specifies the description for each RF channel.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

Cisco CMTS Cable Command Reference

20
 Cable Commands: a through cable-modem
announce-event-profile

announce-event-profile
To configure the GQI announce event profile, use the announce-event-profile command in global configuration
mode.

announce-event-profile {name | id id }
ack-timeout time (in seconds)
filter [all-events | event-code]

Syntax Description name Specify a name for the GQI announce event profile.

id Specify an ID for the GQI announce event profile.

ack-timeout time (in Specify the time (in seconds) the Cisco cBR-8 router waits for an
seconds) acknowledgement from the SRM before sending the next announce message.
The range is from 0-240 seconds.
If the time is set to 0 seconds, the Cisco cBR-8 router sends the message
without waiting for an acknowledgement from SRM.

filter all-events Specifies that the Cisco cBR-8 router does not send any announce messages.

filter event-code Filter one or more messages by using specific event codes.

Command Default None.

Command Modes
Global configuration (config).

Command History Release Modification

Cisco IOS XE Everest 16.6.1 This command is introduced on the Cisco cBR Series Converged Broadband
Routers.

Examples The following example shows how to configure the GQI announce event profile:

enable
configure terminal
cable video
announce-event-profile gqi-led-1 id 2
ack-timeout 240
filter 5502
filter 5602
logical-edge-device led-1 id 1
protocol gqi
event-profile gqi-led-1
vcg vcg-1
active

Cisco CMTS Cable Command Reference

21
 Cable Commands: a through cable-modem
announce-event-profile

Related Commands Command Description

show cable video Displays the configuration of the GQI announce event profile and
announce-event-profile a list of LEDs that use the profile.

event-profile Applies the GQI announce event profile to a specific LED.

Cisco CMTS Cable Command Reference

22
 Cable Commands: a through cable-modem
application-id

application-id
To specify an application type to allow admission control to be applied to a group configuration, use the
application-id command in multicast QoS configuration mode. To disable admission control, use the no form
of this command.

application-id number
no application-id number

Syntax Description number Specifies the application identification number of the multicast QoS group. The valid range is
1–65535.

Command Default Multicast QoS group application type is not identified.

Command Modes
Multicast QoS configuration (config-mqos)

Command History Release Modification

12.2(33)SCA This command was introduced.

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

Usage Guidelines To enable intelligent multicast admission control, you must enable and configure an application type using
the application-id command.

Examples The following example identifies a multicast QoS group application ID using the applicaton-id
command:

Router(config)# cable multicast qos group 20 priority 55 global

Router(config-mqos)# application-id 44

The following example identifies a multicast QoS group application ID using the applicaton-id
command in Cisco cBR Series Converged Broadband Routers:

Router(config)# cable multicast qos group 30 priority 60 global

Router(config-mqos)# application-id 77

Related Commands Command Description

cable multicast qos group Specifies and configures a cable multicast QoS group.

showinterfacebundlemulticast-sessions Displays multicast session information for a specific virtual cable

bundle.

show interface cable multicast-sessions Displays multicast session information for a specific cable interface.

Cisco CMTS Cable Command Reference

23
 Cable Commands: a through cable-modem
assign

assign
To assign modulation to subcarrier, use the assign command in OFDM modulation profile configuration
mode. To undo a modulation assignment, use no form of this command.

assign {modulation-default value | modulation value {list-subcarriers {freq-abs | freq-offset}freqency

| range-subcarriers {freq-abs | freq-offset}freqency width value}}

no assign {modulation-default value | modulation value {list-subcarriers {freq-abs | freq-offset}freqency

| range-subcarriers {freq-abs | freq-offset}freqency width value}}

Syntax Description modulation-default value Assign a modulation value as the default value for all subcarriers. Valid values
are QPSK, 16-QAM, 64-QAM, 128-QAM, 256-QAM, 512-QAM, 1024-QAM,
2048-QAM, and 4096-QAM.

modulation value Assign a specific modulation value to a range or list of subcarriers. Valid values
are QPSK, 16-QAM, 64-QAM, 128-QAM, 256-QAM, 512-QAM, 1024-QAM,
2048-QAM, 4096-QAM, and zero-bit-load.

list-subcarriers Assign modulation to a list of up to 10 subcarriers.

range-subcarriers Assign modulation to a range of consecutive subcarriers specified by the first

frequency and width in Hz.

freq-abs freqency Specify range using absolute frequencies in Hz.

freq-offset freqency Specify range using frequency offsets in Hz from the first configurable subcarrier
determined by the profile's width.

width value Specify width of range in Hz.

Command Default None

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

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Cisco IOS XE This command was modified on the Cisco cBR Series Converged Broadband Routers.
16.8.1 zero-bit-load was added as a modulation value.

Usage Guidelines Use this command to assign modulation to subcarrier.

Only freq-abs or freq-offset keyword can be used depending on whether the start-frequency is configured.
If it is configured, freq-abs is used and subsequent frequency values must be absolute values. If it is not
configured, freq-offset is used and subsequent frequency values are offsets from the first configurable subcarrier
determined by the profile's width.

Cisco CMTS Cable Command Reference

24
 Cable Commands: a through cable-modem
assign

Examples The following example shows how to assign modulation to subcarrier with start-frequency
configured:

Router# configure terminal

Router(config)# cable downstream ofdm-modulation-profile 21
Router(config-ofdm-mod-prof)# width 96000000
Router(config-ofdm-mod-prof)# start-frequency 627000000
Router(config-ofdm-mod-prof)# assign modulation 1024-QAM range-subcarriers freq-abs 635000000
width 74050000

The following example shows how to assign modulation to subcarrier without start-frequency
configured:

Router# configure terminal

Router(config)# cable downstream ofdm-modulation-profile 21
Router(config-ofdm-mod-prof)# width 96000000
Router(config-ofdm-mod-prof)# assign modulation 1024-QAM range-subcarriers freq-offset
8000000 width 74050000

The following example shows how to configure ZBL on a modulation profile:

Router# configure terminal

Router(config)# cable downstream ofdm-modulation-profile 159
Router(config-ofdm-mod-prof)# description an example of ZBL starting at 10MHZ for 1MHZ
Router(config-ofdm-mod-prof)# subcarrier-spacing 50KHZ
Router(config-ofdm-mod-prof)# width 96000000
Router(config-ofdm-mod-prof)# assign modulation-default 1024-QAM
Router(config-ofdm-mod-prof)# assign modulation zero-bit-load range-subcarriers freq-offset
10000000 width 1000000

Related Commands Command Description

cable downstream Define the OFDM modulation profile on the OFDM channel.
ofdm-modulation-profile

description (OFDM modulation profile) Specify a user defined description for the profile up to 64
characters.

start-frequency (Optional) Specify the starting frequency associated with the first
configurable subcarrier in the profile determined by the width.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this

profile.

width Specify width of profile in Hz.

Cisco CMTS Cable Command Reference

25
 Cable Commands: a through cable-modem
attributes

attributes
To configure the attribute value for an upstream bonding group, use the attributes command in upstream
bonding configuration submode. To restore the default attribute value, use the no form of this command.

attributes value
no attributes

Syntax Description value The upstream bonding group attibute value, in hexadecimal format. The range is from 0 to FFFFFFFF.
The default is 80000000.

Command Default The upstream bonding group attribute value is 80000000.

Command Modes
Upstream bonding configuration (config-upstream-bonding)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The changes made to the configuration, using this command, on the working line card are synchronized with
the configuration on the protect line card only after exiting the configuration mode. Use the end command to
exit to Privileged EXEC mode, before using the show running configuration command.

Note Effective with Cisco IOS Release 12.2(33)SCH, the no form of this command disables the attribute on a Cisco
uBR10012 router.

Examples The following example shows how to configure the attribute value for an upstream bonding group
on a cable interface line card on the Cisco uBR10012 router:

Router# configure terminal

Router(config)# interface cable7/1/0
Router(config-if)# cable upstream bonding-group 20
Router(config-upstream-bonding)# attributes eeeeeeee

The following example shows how to configure the attribute value for an upstream bonding to allow
all devices:
Router# configure terminal
Router(config)# interface cable7/1/0
Router(config-if)# cable upstream 2 attribute-mask 20000000

The following example shows how to configure the attribute value for an upstream bonding to specific
devices:

Cisco CMTS Cable Command Reference

26
 Cable Commands: a through cable-modem
attributes

Router# configure terminal

Router(config)# interface cable7/1/0
Router(config-if)# cable upstream 2 attribute-mask 20000004

Related Commands Command Description

cable upstream bonding-group Creates an upstream bonding group on a cable interface.

Cisco CMTS Cable Command Reference

27
 Cable Commands: a through cable-modem
auto-channel-id

auto-channel-id
To enable automatic channel ID selection, use the auto-channel-id command in the DVB scrambling ECMG
configuration mode. To disable automatic channel ID selection, use the no form of this command.

auto-channel-id
no auto-channel-id

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to enable automatic channel ID selection:

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

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

connection Configures the ECMG connection.

ecm-pid-source Configures the source of ECM PID.

ca-system-id Configures the CA system ID.

type Configures the ECMG type.

mode Configures the application mode of ECMG.

desc-rule Configures the descriptor rule.

overrule Overrules the default settings.

Cisco CMTS Cable Command Reference

28
 Cable Commands: a through cable-modem
base-channel-power

base-channel-power
To set the base channel power level, use the base-channel-power command in the controller sub configuration
mode.

base-channel-power value

Syntax Description value Value for the base channel power level. Valid range is from 26 to 34.

Command Default If not specified, the default value is calculated based on the number of carriers.

Command Modes Controller sub configuration mode (config-controller).

Command History Release Modification

Cisco IOS-XE Release 3.15.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to specify the base channel power level on an RF port.

The following example shows how to define the base channel power level:
router#configure terminal
router(config)#controller Integrated-Cable 3/0/0
router(config-controller)#base-channel-power 26
router(config-controller)#exit
router#show controllers Integrated-Cable 3/0/0 rf-port
Admin: UP MaxCarrier: 128 BasePower: 26 dBmV Mode: normal
cbr8-router #show controller integrated-Cable 3/0/0 rf-channel 0

Chan State Admin Frequency Type Annex Mod srate Interleaver dcid power output

0 UP UP 93000000 DOCSIS B 256 5361 I32-J4 1 26 NORMAL

Related Commands Command Description

max-carrier Specifies the maximum number of carriers.

power-adjust Adjusts the power levels of the RF channel.

Cisco CMTS Cable Command Reference

29
 Cable Commands: a through cable-modem
bind-vcg

bind-vcg
To bind a set of virtual RF-channels defined in the virtual carrier group to the physical port in the service
distribution group, use the bind-vcg command in video configuration mode. To unbind all virtual groups, use
the no form of this command.

bind-vcg
no bind-vcg

Command Default None.

Command Modes
Video configuration (config-video)

Command History Release Modification

IOS-XE This command is introduced on the Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines This command binds a set of virtual RF-channels defined in the virtual carrier group to the physical port in
the service distribution group.

Examples The following example shows how to bind a set of virtual RF-channels defined in the virtual carrier
group to the physical port in the service distribution group:

Router#config t
Router(config)#cable video
Router(config-video)#bind-vcg
Router(config-video-bd)#vcg movie-channels sdg west-regions

Related Commands Command Description

service-distribution-group Defines a service distribution group.

rf-port integrated-cable Specifies the RF ports in a service distribution group.

virtual-carrier-group Defines a virtual carrier group.

rf-channel Specifies the virtual RF channels in a virtual carrier group.

Cisco CMTS Cable Command Reference

30
 Cable Commands: a through cable-modem
block-unref-pids

block-unref-pids
To block unreferenced PIDs on a QAM channel, use the block-unref-pids command in video configuration
mode. To remove the configuration, use the no form of the command.

block-unref-pids
no block-unref-pids

Command Default None.

Command Modes
Video configuration (config-video)

Command History Release Modification

IOS-XE This command is introduced on the Cisco cBR Series Converged Broadband Routers.
16.8.1

Examples The following example shows how to block unreferenced PIDs on a QAM channel:
Router(config)# cable video
Router(config-video)# filter pid vcg vcg1
Router(cable-video-filter)#rf-channel 20-21
Router(cable-video-filter-ch)#block-unref-pids

Cisco CMTS Cable Command Reference

31
 Cable Commands: a through cable-modem
block-unref-pids

Cisco CMTS Cable Command Reference

32
Cable Commands: cable a through cable c
• cable acfe constant-eir-demand, on page 35
• cable acfe enable, on page 36
• cable acfe guar-bw-sync-period, on page 37
• cable acfe max-bonus-bandwidth, on page 38
• cable acfe max-eir-ratio, on page 39
• cable admission-control, on page 40
• cable admission-control ds-bandwidth, on page 42
• cable admission-control event, on page 45
• cable admission-control max-reserved-bandwidth, on page 47
• cable admission-control preempt priority-voice, on page 49
• cable admission-control us-bandwidth, on page 50
• cable application-type include, on page 53
• cable application-type name, on page 57
• cable arp, on page 59
• cable arp filter, on page 61
• cable asf-qos-profile, on page 64
• cable attribute-mask, on page 66
• cable bgsync, on page 68
• cable bgsync active, on page 70
• cable bonding-group-id, on page 72
• cable bonding-group-secondary, on page 75
• cable cache-snmp active , on page 77
• cable channel-group, on page 78
• cable clock clear-counters, on page 79
• cable clock dti, on page 81
• cable clock dti clear-counters, on page 82
• cable clock force, on page 83
• cable clock source-midplane, on page 85
• cable clock upgrade, on page 87
• cable cm-status, on page 88
• cable cm-status enable, on page 90
• cable cmc, on page 93
• cable cmc image_upgrade, on page 96

Cisco CMTS Cable Command Reference

33
 Cable Commands: cable a through cable c

• cable cmcpe-list valid-time, on page 97

• cable cmts-id, on page 99
• cable config-file, on page 100
• cable controller-profile, on page 104

Cisco CMTS Cable Command Reference

34
 Cable Commands: cable a through cable c
cable acfe constant-eir-demand

cable acfe constant-eir-demand

To set the EIR demand(raw/scale) value for a bonding group, use cable acfe constant-eir-demand command
in interface configuration mode.

cable acfe constant-eir-demand value

Syntax Description value Constant EIR demand value for a bonding group. The valid range is from 1 to 100.

Command Default 0

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines ACFE uses the EIR demand value as weight to allocate bandwidth between bonding groups. The EIR demand
value is calculated dynamically base on service flow priority, unless this command is configured.

Examples The following example shows how to configure the EIR demand value for a bonding group:
Router(config-if)# cable acfe constant-eir-demand 11

Related Commands Command Description

cable acfe enable Enables Fairness Across DOCSIS Interfaces feature on the CMTS routers.

debug cable dp acfe Displays the debug information related to algorithm or interaction with the system.

Cisco CMTS Cable Command Reference

35
 Cable Commands: cable a through cable c
cable acfe enable

cable acfe enable

To enable Fairness Across DOCSIS Interfaces feature on the integrated-cable (IC), modular-cable (MC), or
wideband-cable (WB) interfaces, use the cable acfe enable command in global configuration mode. To disable
Fairness Across DOCSIS Interfaces feature, use the no form of this command.

cable acfe enable

no cable acfe enable

Syntax Description This command has no arguments or keywords.

Command Default Fairness Across DOCSIS Interfaces feature is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Configure the Fairness Across DOCSIS Interfaces feature on the MC, IC, or WB interfaces.
It is recommended that you clear the CIR reservation above the legacy “reservable” bandwidth before disabling
Fairness Across DOCSIS Interfaces feature. This is to prevent any CIR over-subscription after disabling
Fairness Across DOCSIS Interfaces feature.

Examples The following example shows how to enable Fairness Across DOCSIS Interfaces feature in cable
interfaces.

Router(config)# cable acfe enable

Related Commands Command Description

cable acfe period Configures the interval for running the EIR rebalancing process.

show cable acfe summary Displays Fairness Across DOCSIS Interfaces feature status and
statistics.

debug cable acfe (for uBR series router) Displays the debug information related to algorithm or interaction
with the system.

debug cable dp acfe (for cBR series Displays the debug information related to algorithm or interaction
router) with the system.

Cisco CMTS Cable Command Reference

36
 Cable Commands: cable a through cable c
cable acfe guar-bw-sync-period

cable acfe guar-bw-sync-period

Use the cable acfe guar-bw-sync-period configuration command to adjust bandwidth synchronisation period
between active SUP and standby SUP. The default value is 40 seconds.

cable acfe guar-bw-sync-period

Syntax Description This command has no arguments or keywords.

Command Default The default value is 40 seconds.

Command Modes
Global configuration (config)

Command History Release Modification

IOS XE Fuji This command was introduced.

16.7.1

Examples The following example shows how to configure the ACFE to adjust bandwidth synchronisation
period between active SUP and standby SUP

Router(config)# cable acfe guar-bw-sync-period

Related Commands Command Description

cable acfe period Configures the interval for running the EIR rebalancing process.

show cable acfe summary Displays Fairness Across DOCSIS Interfaces feature status and statistics.

Cisco CMTS Cable Command Reference

37
 Cable Commands: cable a through cable c
cable acfe max-bonus-bandwidth

cable acfe max-bonus-bandwidth

To configure the maximum usable bonus bandwidth for a bonding group (BG), use the cable acfe
max-bonus-bandwidth command in interface configuration mode. To revert to the default values, use the
no form of this command.

cable acfe max-bonus-bandwidth bonus-bandwidth

no cable acfe max-bonus-bandwidth

Syntax Description bonus-bandwidth Maximum usable bonus bandwidth for a BG. There is no valid range, and the bonus
bandwidth can use the entire bandwidth of an interface.

Command Default The bonus bandwidth can use the entire bandwidth of an interface.

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable acfe max-bonus-bandwidth command configures the maximum usable bonus bandwidth. After
disabling Fairness Across DOCSIS Interfaces feature, this configuration is retained. However, it will not be
used.

Examples The following example shows how to configure the maximum usable bonus bandwidth for a BG:

Router(config-if)# cable acfe max-bonus-bandwidth 1000000

Related Commands Command Description

cable acfe enable Enables Fairness Across DOCSIS Interfaces feature on the CMTS routers.

debug cable dp acfe Displays the debug information related to algorithm or interaction with the system.

Cisco CMTS Cable Command Reference

38
 Cable Commands: cable a through cable c
cable acfe max-eir-ratio

cable acfe max-eir-ratio

To configure the maximum EIR ratio between the BE bandwidth among adjacent bonding groups (BGs), use
the cable acfe max-eir-ratio command in global configuration mode. To return to the default values, use the
no form of this command.

cable acfe max-eir-ratio eir-ratio

no cable acfe max-eir-ratio

Syntax Description eir-ratio EIR rebalance ratio between two adjacent BGs. The valid range is from 1 to 100 with a default
value of 10.

Command Default The default value for EIR rebalance ratio is 10.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable acfe max-eir-ratio command configures the maximum EIR ratio between the BE bandwidth among
adjacent BGs.
The failure to maintain the maximum EIR ratio may reduce the guaranteed bandwidth rate for the BE traffic
to zero. This may lead to rejection of unicast CIR flows.

Examples The following example shows how to configure the EIR rebalance ratio between two adjacent BGs:

Router(config)# cable acfe max-eir-ratio 20

Related Commands Command Description

cable acfe enable Enables Fairness Across DOCSIS Interfaces feature on the
CMTS router.

debug cable acfe (for uBR series router) Displays the debug information related to algorithm or
interaction with the system.

debug cable dp acfe (for cBR series router) Displays the debug information related to algorithm or
interaction with the system.

Cisco CMTS Cable Command Reference

39
 Cable Commands: cable a through cable c
cable admission-control

cable admission-control
To configure the CPU and memory thresholds for a Cisco CMTS router supporting broadband processing
engines (BPEs), use the cable admission-control command in global configuration mode. This command
sets the CPU averaging method and memory thresholds. To remove thresholds from a Cisco CMTS router,
use the no form of this command.

cable admission-control {cpu-5sec | cpu-avg} {[io-mem] | [proc-mem] | [total-memory]}minor num1

major num2 critical num3
no cable admission-control {cpu-5sec | cpu-avg} {[io-mem] | [proc-mem] | [total-memory]}minor num1
major num2 critical num3

Syntax Description cpu-5sec Sets Admission Control thresholds on the Cisco CMTS based on a five-second average for
the CPU. This setting must be combined with the additional minor, major, and critical
threshold percentage values.

cpu-avg Sets Admission Control thresholds on the Cisco CMTS based on a one-minute average for
the CPU. This setting must be combined with the additional minor, major, and critical
threshold percentage values.

io-mem Sets Admission Control thresholds for input/output (IO) memory on the Cisco CMTS route
processors and BPE processors.

proc-mem Sets Admission Control thresholds according to CPU processor memory on the Cisco CMTS.

total-memory Sets Admission Control thresholds on the Cisco CMTS according to total-memory allocation.

minor num1 Sets the minor threshold level for the CPU or memory resource to be configured. Num1
expresses a percentage and must be an integer between 1 and 100.

major num2 Sets the major threshold level for the CPU or memory resource to be configured. Num2
expresses a percentage and must be an integer between 1 and 100.

critical num3 Sets the critical threshold level for the CPU or memory resource to be configured. Num3
expresses a percentage and must be an integer between 1 and 100.

Command Default Admission control is disabled with no CPU or memory resource threshold settings on the Cisco CMTS router.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced on the Cisco uBR10012 router and the Cisco uBR7246VXR
router, with supporting broadband processing engines (BPEs) or cable interface line cards
on the respective routers.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Cisco CMTS Cable Command Reference

40
 Cable Commands: cable a through cable c
cable admission-control

Usage Guidelines The threshold counters are set to zero when the resource is reconfigured.
An important concept for system resources that are set with this command (CPU and memory) is the concept
of dampening . Without dampening, and when admission control is configured for the first time, the system
resource check is unsuccessful if the current value exceeds the critical threshold. When this happens, the
system resource check subsequently succeeds only if the current value drops below the major threshold.

Note When the minor threshold value set with Num1 or a major threshold value set with Num2 is crossed, the
Cisco CMTS router sends an alarm (SNMP trap, when supported). When the critical threshold value set with
Num3 is crossed, the Cisco CMTS router drops the call request.

This dampening approach helps prevent significant fluctuations in the outcome of resource checks. For
example, if the critical threshold were 80 percent and the current values fluctuated between 79 and 81 percent,
this scenario would lead to an alternate success then failure event without dampening. The first check would
succeed, the second check would fail, and so forth.
For additional Admission Control feature information, refer to the Admission Control for the Cisco Cable
Modem Termination System document on Cisco.com.

Examples The following example configures the Cisco CMTS router with a Quality of Service (QoS) policy
that includes admission control dampening. This example illustrates the following conditions:
• When the cpu-avg exceeds 60%, a minor alarm (SNMP trap, when supported) is sent.
• When the cpu-avg exceeds 70%, a major alarm (SNMP trap, when supported) is sent.
• When the cpu-avg exceeds 80%, the incoming call request is rejected, and additional calls are
not accepted until after the cpu-avg returns to below 60% (the minor alarm level).

Router(config)# cable admission-control cpu-avg minor 60 major 70 critical 80

Related Commands Command Description

cable admission-control event Configures and enables admission control event types on the Cisco
CMTS router.

cable admission-control ds-bandwidth Configures admission control downstream bandwidth thresholds

on the Cisco CMTS router.

cable admission-control us-bandwidth Configures admission control upstream bandwidth thresholds on

the Cisco CMTS router.

clear cable admission control counters Clears all admission control resource counters on the Cisco CMTS
router.

debug cable admission-control Enables automatic admission control troubleshooting processes

on the Cisco CMTS router.

show cable admission-control Displays the current admission control configuration and status
on the Cisco CMTS router, or on a specified interface.

Cisco CMTS Cable Command Reference

41
 Cable Commands: cable a through cable c
cable admission-control ds-bandwidth

cable admission-control ds-bandwidth

To set the minor, major, and exclusive thresholds for downstream voice or data bandwidth for all interfaces
on a Cisco CMTS router, use the cable admission-control ds-bandwidth command in global configuration
mode or interface configuration mode. To remove this setting from a Cisco CMTS router or from a specified
interface, use the no form of this command.

cable admission-control ds-bandwidth traffic-type minor minor-threshold major major-threshold

exclusive exclusive-percentage non-exclusive non-exclusive-percentage
no cable admission-control ds-bandwidth traffic-type minor minor-threshold major major-threshold
exclusive exclusive-percentage non-exclusive non-exclusive-percentage

Syntax Description ds-bandwidth Sets downstream throughput thresholds.

traffic-type Either of the following keywords sets the traffic type for which Admission
Control applies. Both settings can be applied to the Cisco CMTS.
• voice—Applies thresholds to downstream voice traffic.
• data—Applies thresholds to downstream data traffic.

minor minor-threshold Sets the minor alarm threshold. The minor-threshold value is a percentage
value from 1 to 100.

major major-threshold Sets the major alarm threshold. The major-threshold value is a percentage
value from 1 to 100.

exclusive Specifies the percentage of throughput reserved exclusively for this class
exclusive-percentage (voice or data). The exclusive-percentage value is an integer between 1 and
100. No other class can use this throughput.

non-exclusive Specifies the percentage of throughput, over and above the exclusive share,
non-exclusive-percentage that can be used by this class. The non-exclusive-percentage value is an
integer between 1 and 100. Because this throughput is non-exclusive, it can
be used by other classes as specified.

Command Default Admission control is disabled on the Cisco CMTS router.

Command Modes
Global configuration (config)

Interface configuration (config-if)

Command History Release Modification

12.3(13a)BC This command was introduced on the Cisco uBR10012 and the Cisco uBR7246VXR
router.

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

Cisco CMTS Cable Command Reference

42
 Cable Commands: cable a through cable c
cable admission-control ds-bandwidth

Release Modification

12.2(33)SCC This command was modified to run on modular cable and integrated cable interfaces.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Downstream bandwidth settings support all interfaces on the Cisco CMTS router through global configuration.
Downstream bandwidth settings can be further refined per-interface or per-upstream, the latter of which
provides optimal downstream Admission Control granularity on the Cisco CMTS router.
When interface-level downstream configuration is used in combination with global configuration, then the
interface configuration supersedes global configuration.

Note The critical keyword is not present for the upstream throughput resource management with the Cisco Service
Flow Admission Control feature.

Note The minor threshold level cannot be greater than the major threshold level.

Examples The following example configures downstream bandwidth in the global configuration mode, with
30% of downstream bandwidth reserved exclusively for voice traffic. Minor and major alarms for
voice traffic are also set to be generated at 15% and 25% respectively.

Router(config)# cable admission-control ds-bandwidth voice minor 15 major 25 exclusive 30

Related Commands Command Description

cable admission-control Configures the CPU and memory thresholds for the Cisco CMTS
router and supporting broadband processing engines (BPEs).

cable admission-control event Configures and enables admission control event types on the Cisco
CMTS router.

cable admission-control Defines the maximum reserved bandwidth per bonding group for
max-reserved-bandwidth all service flows that are allowed by the Cisco CMTS.

cable admission-control us-bandwidth Configures admission control upstream bandwidth thresholds on

the Cisco CMTS router.

clear cable admission control counters Clears all admission control resource counters on the Cisco CMTS
router.

debug cable admission-control Enables automatic admission control troubleshooting processes

on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

43
 Cable Commands: cable a through cable c
cable admission-control ds-bandwidth

Command Description

show cable admission-control Displays the current admission control configuration and status on
the Cisco CMTS router or on a specified interface.

Cisco CMTS Cable Command Reference

44
 Cable Commands: cable a through cable c
cable admission-control event

cable admission-control event

To configure admission control event types on a Cisco CMTS router, and to enable admission control for all
previously configured resources on a Cisco CMTS router, use the cable admission-control event command
in global configuration mode. To disable admission control event types on a Cisco CMTS router, use the no
form of this command.

cable admission-control event {cm-registration | dynamic-service}

no cable admission-control event event_type

Syntax Description cm-registration Performs admission control checks when a cable modem registers with the Cisco CMTS
router headend. This setting can be combined with the dynamic-service setting, in which
cable modems are allowed to register but remain subject to a Quality of Service (QoS)
policy on the Cisco CMTS.

dynamic-service Performs admission control checks each time a voice call is made, and rejects voice calls
if they would impede QoS policies on the Cisco CMTS router. This setting can be combined
with the cm-registration setting.

Command Default Admission control event types are not defined on the Cisco CMTS router.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced for the Cisco uBR10012 router and the Cisco uBR7246VXR
router.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines At least one event type must be configured to enable admission control on the Cisco CMTS router.
For additional Admission Control feature information, refer to the Admission Control for the Cisco Cable
Modem Termination System document on Cisco.com.

Examples The following example configures each available option for the cable admission-control event
command on the Cisco CMTS router.

Router(config)# cable admission-control event cm-registration

Router(config)# cable admission-control dynamic-service

Cisco CMTS Cable Command Reference

45
 Cable Commands: cable a through cable c
cable admission-control event

Related Commands Command Description

cable admission-control Configures the CPU and memory thresholds for a Cisco CMTS
router and supporting broadband processing engines (BPEs).

cable admission-control ds-bandwidth Configures admission control downstream bandwidth thresholds

on a Cisco CMTS router.

cable admission-control us-bandwidth Configures admission control upstream bandwidth thresholds on

a Cisco CMTS router.

clear cable admission control counters Clears all admission control resource counters on a Cisco CMTS
router.

debug cable admission-control Enables automatic admission control troubleshooting processes

on a Cisco CMTS router.

show cable admission-control Displays the current admission control configuration and status on
a Cisco CMTS router, or on a specified interface.

Cisco CMTS Cable Command Reference

46
 Cable Commands: cable a through cable c
cable admission-control max-reserved-bandwidth

cable admission-control max-reserved-bandwidth

To define the maximum reserved bandwidth per bonding group for all service flows that are allowed by the
Cisco CMTS, use the cable admission-control max-reserved-bandwidth command in the interface
configuration mode. To reset or disable the maximum reserved bandwidth value, use the no form of this
command.

cable admission-control max-reserved-bandwidth bw-in-kbps

no cable admission-control max-reserved-bandwidth

Syntax Description bw-in-kbps Maximum admission control reserved bandwidth. The value is in kbps and is based on the RF
bandwidth percent defined for the bonding group. Valid range is from 0 to 14762.

Command Default The max-reserved-bandwidth value is 80 percent of the aggregate bandwidth of the RF channels configured
in the US or DS bonding group.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to define the maximum reserved bandwidth per bonding group. The default
maximum reserved bandwidth value is 80 percent. However the user can choose to configure a higher (up to
96 percent) or lower reserved bandwidth so that there is bandwidth allocated for zero committed information
rate (CIR) best effort traffic.

Examples The following example shows a sample definition of the maximum reserved bandwidth value.

Router> enable
Router# configure terminal
Router(config)# interface c5/0/1
Router(config-if)# cable admission-control max-reserved-bandwidth 6344

Related Commands Command Description

cable admission-control Configures the CPU and memory thresholds for the Cisco CMTS
router and supporting broadband processing engines (BPEs).

cable admission-control event Configures and enables admission control event types on the Cisco
CMTS router.

cable admission-control ds-bandwidth Configures admission control downstream bandwidth thresholds

on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

47
 Cable Commands: cable a through cable c
cable admission-control max-reserved-bandwidth

Command Description

cable admission-control us-bandwidth Configures admission control upstream bandwidth thresholds on

the Cisco CMTS router.

debug cable admission-control Enables automatic admission control troubleshooting processes on

the Cisco CMTS router.

show cable admission-control Displays the current admission control configuration and status on
the Cisco CMTS router or on a specified interface.

Cisco CMTS Cable Command Reference

48
 Cable Commands: cable a through cable c
cable admission-control preempt priority-voice

cable admission-control preempt priority-voice

To change the default PacketCable emergency 911 call preemption functions on a Cisco CMTS router to
support throughput and bandwidth requirements for emergency 911 calls above all other buckets on the Cisco
CMTS router, use the cable admission-control preempt priority-voice command in global configuration
mode. To disable preemption and return the bucket that supports PacketCable emergency 911 calls to its
default configuration, use the no form of this command.

cable admission-control preempt priority-voice

no cable admission-control preempt priority-voice

Syntax Description This command has no arguments or keywords.

Command Default Emergency 911 call preemption and service flow admission control is enabled on the Cisco CMTS router.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router and the Cisco uBR7246VXR
router.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines By default, PacketCable Emergency 911 calls are given priority on the Cisco CMTS. This priority may be
preempted or removed from the Cisco CMTS router with non-standard configuration of the Service Flow
Admission Control feature.
For additional information for Service Flow Admission Control beginning in Cisco IOS Release 12.3(21)BC,
refer to the Service Flow Admission Control for the Cisco Cable Modem Termination System document on
Cisco.com.

Examples The following example disables and then restores emergency 911 call preemption on the Cisco CMTS
router.

Router(config)# no cable admission-control preempt priority-voice

Router(config)# cable admission-control preempt priority-voice

Cisco CMTS Cable Command Reference

49
 Cable Commands: cable a through cable c
cable admission-control us-bandwidth

cable admission-control us-bandwidth

To configure upstream bandwidth thresholds for admission control on a Cisco CMTS router, use the cable
upstream admission-control us-bandwidth command in global configuration or interface configuration
mode. To disable or to remove this configuration from a Cisco CMTS router or the specified port, use the no
form of this command.

cable admission-control us-bandwidth [sched scheduling-type | service service-class-name] minor

minor-threshold major major-threshold exclusive exclusive-percentage non-exclusive
non-exclusive-percentage
no cable admission-control us bandwidth [sched scheduling-type | service service-class-name]
minor minor-threshold major major-threshold exclusive exclusive-percentage non-exclusive
non-exclusive-percentage

Syntax Description n Upstream on the router interface.

us-bandwidth Configures the upstream throughput thresholds.

sched scheduling-type (Optional) Specifies the scheduling type for a traffic class, where
scheduling-type is one of the following values:
• BE—Selects best effort traffic.
• NRTPS—Selects non-real-time polling service.
• RTPS—Selects real time polling service.
• UGS-AD—Selects UGS-AD service.
• UGS—Selects UGS service.

service service-class-name (Optional) Displays a string representing a previously defined service class.
Instead of specifying a class by a scheduling type, this keyword can be used
to specify a class using the service-class-name.

minor minor-threshold Sets the minor alarm threshold in a percentage value between 1 and 100.

major major-threshold Sets the major alarm threshold in a percentage value between 1 and 100.

exclusive Represents the critical threshold for the upstream throughput resource in a
exclusive-percentage percentage value between 1 and 100. Specifies the percentage of throughput
reserved exclusively for this class.

non-exclusive Specifies the percentage of throughput, over and above the exclusive share,
non-exclusive-percentage that can be used by this class. The non-exclusive-percentage value is an
integer between 1 and 100. Because this throughput is non-exclusive, it can
be used by other classes as specified.

Command Default Admission control is disabled by default on a Cisco CMTS router.

Command Modes
Global configuration (config)

Cisco CMTS Cable Command Reference

50
 Cable Commands: cable a through cable c
cable admission-control us-bandwidth

Interface configuration (config-if)

Command History Release Modification

12.3(13a)BC This command was introduced on the Cisco uBR10012 and the Cisco uBR7246VXR
routers.

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

12.2(33)SCC This command was modified to run on modular cable and integrated cable interfaces.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Upstream bandwidth settings support all interfaces on a Cisco CMTS router through global configuration.
Upstream bandwidth settings can be further refined on a per-interface or per-upstream basis using interface
configuration mode. Per-upstream settings provide the optimal upstream admission control granularity on the
Cisco CMTS router.
When interface or per-upstream configuration is used in combination with global configuration, then interface
or per-upstream configuration supersedes global configuration. Per-upstream configuration also supersedes
per-interface configuration.

Note The critical keyword is not present for the upstream throughput resource management with Cisco Admission
Control.

Note The minor threshold level cannot be greater than the major threshold level.

Examples For additional Admission Control feature information and examples, refer to the Admission Control
for the Cisco Cable Modem Termination System document on Cisco.com.

Related Commands Command Description

cable admission-control Configures the CPU and memory thresholds for the Cisco CMTS
router and supporting broadband processing engines (BPEs).

cable admission-control event Configures and enables admission control event types on the Cisco
CMTS router.

cable admission-control ds-bandwidth Configures admission control downstream bandwidth thresholds

on the Cisco CMTS router.

cable admission-control Defines the maximum reserved bandwidth per bonding group for
max-reserved-bandwidth all service flows that are allowed by the Cisco CMTS.

Cisco CMTS Cable Command Reference

51
 Cable Commands: cable a through cable c
cable admission-control us-bandwidth

Command Description

clear cable admission control counters Clears all admission control resource counters on the Cisco CMTS
router.

debug cable admission-control Enables automatic admission control troubleshooting processes on

the Cisco CMTS router.

show cable admission-control Displays the current admission control configuration and status on
the Cisco CMTS router or on a specified interface.

Cisco CMTS Cable Command Reference

52
 Cable Commands: cable a through cable c
cable application-type include

cable application-type include

To associate an application type with a specific and prioritized bucket on a Cisco CMTS router, use the cable
application-type include command in global configuration mode. To remove the application type settings,
use the no form of this command.

cable application-type bucket-number include {Best-effort | multicast application-id | packetcable

{normal | priority} | pcmm {app-id gate-app-id | priority gate-priority} | sched-type type | service-class
service-class-name}
no cable application-type bucket-number include {Best-effort | multicast application-id | packetcable
{normal | priority} | pcmm {app-id gate-app-id | priority gate-priority} | sched-type type | service-class
service-class-name}

Cisco cBR Series Converged Broadband Routers

cable application-type bucket-number include {Best-effort | multicast application-id | packetcable
{normal | priority} | pcmm {app-id gate-app-id | priority gate-priority} | service-class
service-class-name}
no cable application-type bucket-number include {Best-effort | multicast application-id | packetcable
{normal | priority} | pcmm {app-id gate-app-id | priority gate-priority} | service-class
service-class-name}

Syntax Description bucket-number Bucket number to which an application type is associated. Range is from 1
to 8, with 1 as the first in the sequence.

Best-effort Applies best effort committed information rate (CIR) to the specified bucket.

multicast application-id Specifies the application identification for the multicast service flow. The
valid range is 1 to 65535.

packetcable {normal | Specifies PacketCable service flows for the designated bucket, with the
priority} following priorities:
• normal—Selects PacketCable calls with normal priority.
• priority—Selects PacketCable calls with high priority.

pcmm {app-id gate-app-id | Specifies PacketCable Multimedia (PCMM) service flows for the designated
priority gate-priority} bucket, with the following options:
• app-id gate-app-id—Selects the gate application identifier from 0 to
65535. For each bucket, up to ten application type rules may be defined.
• priority gate-priority—Selects the priority level from 0 to 7.

sched-type type Specifies upstream scheduling types, with one of the following additional
keywords used for the DOCSIS scheduling type:
• be—Best effort.
• nrtps—Non-real-time polling service.
• rtps—Real-time polling service.
• ugs—Unsolicited Grant Service.
• ugs-ad—Unsolicited grant service-activity detection (UGS-AD) service.

Cisco CMTS Cable Command Reference

53
 Cable Commands: cable a through cable c
cable application-type include

service-class Specifies the name of the service class being assigned to the designated bucket,
service-class-name where service-class-name is an alphanumeric string.

Command Default Service flow admission control is enabled without the application types.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router and the Cisco uBR7246VXR
router.

12.2(33)SCA This command was introduced in Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added. The multicast keyword was added to this command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.16.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The sched-type keyword was removed.

Usage Guidelines The details of this command vary according to the bucket number and application type being mapped to a
service flow on the Cisco CMTS router. This command overrides default service flow admission control
settings on the Cisco CMTS.
Best Effort
The best effort CIR service flow rule may be applicable to both upstream and downstream. However, in the
case of upstream service flows, in most cases, the same service flow may map both the rules.
For best effort, there is also the sched-type keyword option that applies to upstream service flows. This best
effort scheduling type rule is applicable only for upstream service flows.
Service Classes
DOCSIS 1.1 introduced the concept of service classes. A service class is identified by a service class name.
A service class name is a string the CMTS router associates with a QoS parameter set. One of the objectives
of using a service class is to allow the high-level protocols to create the service flows with the desired QoS
parameter set. Using a service class is a convenient way to bind the application with the service flows. The
rules provide a mechanism to implement such binding.
Note the following factors when using the service-class keyword:
• Service classes are separately configured using the cable match command to provide the QoS for multicast
traffic. This step maps a bucket using a rule to allocate bandwidth for multicast traffic.
• A named service class may be classified into any application type.
• Up to ten service class names may be configured per application type. Attempting to configure more
than ten service classes results in an error message.
For additional information, see the Service Flow Admission Control feature documentation on Cisco.com.

Examples The following example maps high-priority PacketCable service flows into application bucket 5:

Router(config)# cable application-type 5 include packetcable priority

Cisco CMTS Cable Command Reference

54
 Cable Commands: cable a through cable c
cable application-type include

The following example maps normal PacketCable service flows into application bucket 1:

Router(config)# cable application-type 1 include packetcable normal

The following example maps the specified bucket number with PCMM service flow with a priority
of 7, then maps an application identifier of 152 for the same bucket number:

Router(config)# cable application-type 2 include pcmm priority 7

Router(config)# cable application-type 2 include pcmm app-id 152

The following example maps both UGS and UGS-AD into bucket number 1:

Router(config)# cable application-type 1 include sched-type ugs

Router(config)# cable application-type 1 include sched-type ugs-ad

The following example maps the best effort CIR flows to bucket 3:

Router(config)# cable application-type 3 include Best-effort

The following example maps the service class name with a value of service-name1 into application
bucket 3:

Router(config)# cable application-type 3 include service-class service-name1

The following example maps the multicast application type with a value of 18 into application bucket
3:

Router(config)# cable application-type 3 include multicast 18

Related Commands Command Description

cable admission-control Sets the minor, major, and exclusive thresholds for downstream
ds-bandwidth voice or data bandwidth for all interfaces on the Cisco CMTS router.

cable admission-control preempt Changes the default PacketCable emergency 911 call preemption
priority-voice functions on the Cisco CMTS router to support throughput and
bandwidth requirements for emergency 911 calls above all other
buckets on the Cisco CMTS router.

cable admission-control Configures upstream bandwidth thresholds for admission control

us-bandwidth on the Cisco CMTS router.

cable application-type name Assigns an alphanumeric name for the specified bucket.

cable upstream admission-control Configures per-upstream bandwidth thresholds and exclusive or

non-exclusive resources on the Cisco CMTS router.

debug cable admission-control Displays service flow categorization results, enabled when a service
flow-categorization flow is classified.

show application-buckets Displays rules for any or all buckets supporting service flow
admission control on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

55
 Cable Commands: cable a through cable c
cable application-type include

Command Description

show interface cable Displays service flows, categorizations, and bandwidth consumption
admission-control reservation on the Cisco CMTS router, for the specified interface, and the
specified service flow direction.

Cisco CMTS Cable Command Reference

56
 Cable Commands: cable a through cable c
cable application-type name

cable application-type name

To assign an alphanumeric name for the specified bucket, use the cable application-type name command in
global configuration mode. To remove this configuration, use the no form of this command.

cable application-type bucket-number name bucket-name

no cable application-type bucket-number name bucket-name

Cisco cBR Series Converged Broadband Routers

cable application-type bucket-number name bucket-name
no cable application-type bucket-number name bucket-name

Syntax Description bucket-number Bucket number to which the name is applied. The priority sequence of the buckets, according
to their original numeration of 1 to 8, still applies, whether the default bucket numbers or
customized alphanumeric names are used.

bucket-name Alphanumeric bucket name.

Command Default Service flow admission control and the default configuration of this command is enabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router and the Cisco uBR7246VXR
router.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.16.OS This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This bucket name appears in supporting show and debug commands along with the default bucket number.
For additional information, see the Service Flow Admission Control feature documentation on Cisco.com.

Examples The following example illustrates the use of descriptive names for the associated buckets:

Router(config)# cable application-type 2 name video

Router(config)# cable application-type 3 name gaming

Cisco CMTS Cable Command Reference

57
 Cable Commands: cable a through cable c
cable application-type name

Related Commands Command Description

cable admission-control Sets minor, major and exclusive thresholds for downstream voice
ds-bandwidth or data bandwidth for each or all interfaces on the Cisco CMTS

cable admission-control preempt Changes the default PacketCable Emergency 911 call preemption
priority-voice functions on the Cisco CMTS, supporting throughput and bandwidth
requirements for Emergency 911 calls above all other buckets on
the Cisco CMTS.

cable admission-control Configures global or interface-level upstream bandwidth thresholds

us-bandwidth and exclusive or non-exclusive resources on the Cisco CMTS.

cable application-type include Associates an application type with a specific and prioritized bucket
on the Cisco CMTS.

cable upstream admission-control Configures per-upstream bandwidth thresholds and exclusive or

non-exclusive resources on the Cisco CMTS.

debug cable admission-control Displays service flow categorization results, enabled when a service
flow-categorization flow is classified.

show application-buckets Displays rules for any or all buckets supporting Service Flow
Admission Control on the Cisco CMTS.

show interface cable Displays service flows, categorizations, and bandwidth consumption
admission-control reservation on the Cisco CMTS, for the specified interface, and the specified
service flow direction.

Cisco CMTS Cable Command Reference

58
 Cable Commands: cable a through cable c
cable arp

cable arp
To activate cable Address Resolution Protocol (ARP), use the cable arp command in cable interface or
subinterface configuration mode. To block ARP requests for cable modems (CMs), use the no form of this
command.

cable arp
no cable arp

Syntax Description This command has no arguments or keywords.

Command Default ARP is enabled.

Command Modes
Interface configuration (config-if)

Subinterface configuration (config-subif)

Command History Release Modification

12.1T This command was introduced.

12.0(6)SC This command was supported.

12.1(2) EC1 This command was supported.

12.1(3a)EC Subinterface support was added.

12.2(8)BC1 Interaction with the clear arp-cache command was changed. Previously, the clear
arp-cache command sent an ARP request to a CM before clearing its ARP entry. Now,
the clear arp-cache command clears the ARP entry without communicating with the CM.
The CM (or its CPE devices) must send one or more IP packets to the CMTS before IP
communications can be restored (assuming the CM or CPE devices are authorized to
connect to the network).

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
This command is integrated into bundle interface configuration mode.

Usage Guidelines ARP is an Internet protocol used to map IP addresses to MAC addresses on computers and other equipment
installed in a network. You must activate ARP requests so that the Cisco CMTS router can perform IP address
resolution on the downstream path.
Occasionally, you might want to use the no cable arp and clear arp-cache commands to block out new ARP
requests and clear the existing ARP table. In this situation, the Cisco CMTS router will retain the ARP addresses
of currently online CMs (CMs with a known IP address) and will continue to send ARP requests for those
CMs when those ARP entries time out or are cleared, so that those CMs can continue to remain online. ARP

Cisco CMTS Cable Command Reference

59
 Cable Commands: cable a through cable c
cable arp

requests for CMs that are currently offline and for any other unknown IP addresses, however, will remain
blocked until ARP requests are reenabled on the downstream using the cable arp command.

Note Using the no cable arp and no cable proxy-arp commands shifts all responsibility for the management of
the IP addresses used by CMs and CPE devices to the DHCP server and provisioning system.

Tip You can expect to see a temporary spike in CPU usage after initially giving the no cable arp command,
because of the need to verify CPE IP addresses. CPU usage drops after the router has verified and learned all
of the CPE IP addresses that are currently online. (This same situation occurs after initially enabling the cable
source-verify dhcp command, because the router must send a DHCP LEASEQUERY request for every
unknown CPE IP address.)

Note Starting from IOX-XE 3.15 OS, this command is integrated into bundle interface configuration mode for cBR
Series Converged Broadband Routers.

Examples The following example shows how to activate cable ARP requests for port 0 on the cable interface
line card installed in slot 6 of a Cisco CMTS router:

router(config)# interface cable 6/0

router(config-if)# cable arp

The following example shows how to activate cable ARP requests for port 0 on the cable interface
line card installed in slot 6, subinterface 1, of a Cisco CMTS router:

router(config)# interface cable 6/0.1

router(config-subif)# cable arp

The following example shows how to activate cable ARP requests on the bundle interface line card
on Cisco cBR Series Converged Broadband Routers:
router(config)# interface bundle 1
router(config-if)# cable arp

Related Commands Command Description

clear arp-cache Clears the ARP table on the router.

cable proxy-arp Activates cable proxy ARP on the cable interface.

Cisco CMTS Cable Command Reference

60
 Cable Commands: cable a through cable c
cable arp filter

cable arp filter

To control the number of Address Resolution Protocol (ARP) packets that are allowable for each Service ID
(SID) on a cable interface, use the cable arp filter command in cable interface configuration mode. To stop
the filtering of ARP broadcasts for CMs, use the no form of this command.

cable arp filter {reply-accept | request-send} number window-size

no cable arp filter {reply-accept | request-send}
default cable arp filter {reply-accept | request-send}

Syntax Description reply-accept Configures the cable interface to accept only the specified number of ARP reply packets
every window-size seconds for each active Service ID (SID) on that interface. The cable
interface drops ARP reply packets for a SID that would exceed this number.

request-send Configures the cable interface to send only the specified number of ARP request packets
every window-size seconds for each active SID on that interface. The cable interface drops
ARP requests for a SID that would exceed this number.

number Number of ARP reply packets that is allowed for each SID within the window time period.
The allowable range is 0 to 20 packets, with a default of 4 packets. If number is 0, the cable
interface drops all ARP reply packets.

window-size Size of the window time period, in seconds, in which to monitor ARP requests. The valid
range is 1 to 5 seconds, with a default of 2 seconds.

Command Default ARP packets are not filtered, which means the Cisco CMTS router accepts all ARP reply packets and sends
all ARP request packets.

Command Modes
Cable interface configuration (config-if)

Command History Release Modification

12.2(15)BC2 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 universal
broadband routers.

12.3(9a)BC The values of number and window-size are optional for the the respective reply-accept
and request-send settings. In this release and for earlier supporting releases, when ARP
filtering is enabled, the default values for number and window-size are 4 and 2 respectively.

12.3(17a)BC In this release and for later releases, when ARP filtering is enabled, the default values for
number and window-size are 3 and 2 respectively.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S This command is integrated into bundle interface configuration mode.

Cisco CMTS Cable Command Reference

61
 Cable Commands: cable a through cable c
cable arp filter

Usage Guidelines Viruses, worms, and theft-of-service attacks can generate a large volume of ARP requests on a cable interface.
In some situations, the volume of ARP traffic can become so large that it throttles all other traffic.
To control the number of ARP replies and ARP requests that are allowed for each SID on a cable interface,
use the cable arp filter command. This command configures the interface so that it accepts only a certain
number of ARP reply or request packets per a specified time period. If a SID generates more ARP packets
than what is allowed, the cable interface drops the excessive traffic.
By default, no ARP filtering is done. ARP filtering is enabled on individual cable interfaces, and you can
choose to filter ARP packets only on the specific cable interfaces that require it. You can further choose to
filter only ARP request packets, only ARP reply packets, or both. You can configure different threshold values
on each interface, allowing you to customize the feature for each interface’s traffic patterns.
If using bundled cable interfaces, the Cable ARP Filtering feature is configured separately on the primary and
subordinate interfaces. This allows you to configure the feature only on the particular interfaces that require
it.

Note Cisco IOS Release 12.3(9a)BC introduces enhanced command option syntax for the cable arp filter command,
where number and window-size values are optional for reply-accept and request-send settings.

Note Disabling the cable ARP filtering feature, using the no cable arp filter command, does not reset the ARP
packet counters. The ARP packet counters do not increment when cable ARP filtering is disabled, but the
counters retain their current values until the interface counters are specifically cleared, using the clear counters
command.

The Linksys Wireless-B Broadband Router BEFW11S4 version 4 with 1.44.2 firmware incorrectly sends its
own ARP reply packet for every ARP request packet it receives, instead of replying only to the ARP requests
that are specifically for itself. Customers with these routers should upgrade the firmware to the latest revision
to fix this bug. To upgrade the firmware, go to the download section on the Linksys web site.

Note Starting from IOX-XE 3.15 OS, this command is integrated into bundle interface configuration mode for cBR
Series Converged Broadband Routers.

Examples The following example shows how to filter cable ARP reply packets, so that the cable interface
accepts a maximum of 15 ARP replies every three seconds per SID:

Router(config)# interface cable 5/1/0

Router(config-if)# cable arp filter reply-accept 15 3

The following example shows how to filter cable ARP request packets, so that the cable interface
sends a maximum of 10 requests per second per SID:

Router(config)# interface cable 6/0

Router(config-if)# cable arp filter request-send 10 1

Cisco CMTS Cable Command Reference

62
 Cable Commands: cable a through cable c
cable arp filter

The following example shows how to enable the filtering of cable ARP request and reply packets
on a cable interface, using the default values of 4 packets per CPE per every 2 seconds:

Router(config)# interface cable 3/0

Router(config-if)# default cable arp filter reply-accept

Router(config-if)# default cable arp filter request-send

Router(config-if)# end

Router# show running-config | include filter

cable arp filter reply-accept 4 2

cable arp filter request-send 4 2

The following example shows how to disable the filtering of cable ARP request and reply packets
on a cable interface:

Router(config)# interface cable 1/0

Router(config-if)# no cable arp filter reply-accept

Router(config-if)# no cable arp filter request-send

The following example shows how to filter cable ARP reply packets, so that the bundle interface
accepts a maximum of 15 ARP replies every three seconds per SID on Cisco cBR Series Converged
Broadband Routers:

Router(config)# interface bundle 1

Router(config-if)# cable arp filter reply-accept 15 3

The following example shows how to filter cable ARP request packets, so that the bundle interface
sends a maximum of 10 requests per second per SID on Cisco cBR Series Converged Broadband
Routers:

Router(config)# interface bundle 1

Router(config-if)# cable arp filter request-send 10 1

Related Commands Command Description

cable arp Activates cable ARP.

cable proxy-arp Activates cable proxy ARP on the cable interface.

clear arp-cache Refreshes dynamically created entries from the ARP cache.

clear counters Clears the packet counters on all interfaces or on a specific interface.

debug cable arp filter Displays debugging messages about the filtering of ARP broadcasts.

show cable arp-filter Displays the total number of ARP replies and requests that have been sent and
received, including the number of requests that have been filtered.

Cisco CMTS Cable Command Reference

63
 Cable Commands: cable a through cable c
cable asf-qos-profile

cable asf-qos-profile
This feature introduces LLD support for cBR-8 routers. LLD capable D31 modems can establish a bidirectional
ASF with two associated static service flows (sent from modem in individual TLVs). You can evaluate different
downstream classification approaches to have gaming traffic over one SF and BE traffic over the other SF.
Low Latency ASF can be configured via TLVs, Service Classes and/or ASF QoS Profiles (AQPs).
Use the cable asf-qos-profile command to configure an ASF QoS Profiles (AQPs) in global configuration
mode.

cable asf-qos-profile profile-name [ ds | us ] { aqm-coupling value | data-rate-unit data-rate |

classic-sf-scn string | ll-classifiers hex-data | ll-sf-scn string | max-burst | max-rate value | peak-rate
value | priority value | qp-drain-rate-exp value | qp-enable value | qp-latency-threshold value |
qp-score-threshold value | scheduling-weight value }

Syntax Description profile-name Name of the ASF QoS profile

ds Downstream ASF.

us Upstream ASF.

aqm-coupling value AQM Coupling Factor. The range is 0-255.

classic-sf-scn Classic SF SCN string.

data-rate-unit Configure Data Rate Unit Setting.

data-rate
The range is 0–3. 0=bps, 1=kbps, 2=Mbps, 3=Gbps.

ll-classifiers Low Latency SF Classifiers. Enter Hex-data value (Classifier TLV hexbytes).

ll-sf-scn The Ascii string identifier for this Service Class.

llasf Low Latency ASF. Enter 1 to enable and 0 to disable.

max-burst Max Tx Burst. The supported range is 1522-4294967295.

max-rate Max Rate (bps). The supported range is 0-4294967295.

min-packet-size Min Packet Size for Reserved Rate. The supported range is 0-65535.

min-rate Min Resv Rate (bps). The supported range is 0-4294967295.

peak-rate Peak Rate within maximum traffic burst (bps). The supported range is
0-4294967295.

priority Priority.The supported range is 0-7.

qp-drain-rate-exp Queue Protection Drain Rate Exponent. The supported range is 0-255.

qp-enable Queue Protection. Enter 1 to enable and 0 to disable.

qp-latency-threshold Queue Protection Latency Threshold. The supported range is 0-65535.

Cisco CMTS Cable Command Reference

64
 Cable Commands: cable a through cable c
cable asf-qos-profile

qp-score-threshold Queue Protection Score Threshold. The supported range is 0-65535.

scheduling-weight Scheduling Weight (ratio out of 256). The supported range is 0-255.

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Dublin 17.12.1z The data-rate-unit data-rate option is added.

Cisco IOS XE Cupertino 17.9.1x This command is introduced on the Cisco cBR Series Converged Broadband
Routers.

The following example shows how to configure an asf-qos-profile:

Router# configure terminal
Router(config)# cable asf-qos-profile profile1 ds

Command Description

show cable asf-qos-profile Display Cable AQP

Table.

Cisco CMTS Cable Command Reference

65
 Cable Commands: cable a through cable c
cable attribute-mask

cable attribute-mask
To configure an attribute for a modular cable interface, use the cable attribute-mask command in interface
configuration mode or MAC domain profile configuration mode. To disable this configuration, use the no
form of this command.

cable attribute-mask mask

no cable attribute-mask mask

Syntax Description mask Specifies the mask value for the interface.

Command Default If this command is not used, the default attribute will be used for the modular cable interface. The default
attribute for a modular cable interface is zero.

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines The attribute mask comprises 32 attributes and each attribute represents a single bit in the mask. You can
configure a provisioned attribute mask for each channel and provisioned bonding group to assign values to
the operator-defined binary attributes, or to override the default values of the specification-defined attributes.
The operator may configure, in the CM configuration file, a required attribute mask and a forbidden attribute
mask for a service flow. Additionally, in a CM-initiated dynamic service request, the CM can include a required
attribute mask and a forbidden attribute mask for a service flow.

Examples The following example shows how to configure an attribute for a modular cable interface:

Router# configure terminal

Router(config)# interface modular-cable 1/0/0:0
Router(config-if)# cable attribute-mask 2000ff00

The following example shows how to configure an attribute for a Integrated cable interface:
Router# configure terminal
Router(config)# interface Integrated-Cable 9/0/3:0
Router(config-if)# cable attribute-mask 2000ff00

Cisco CMTS Cable Command Reference

66
 Cable Commands: cable a through cable c
cable attribute-mask

Related Commands Command Description

interface modular-cable Specifies a modular cable interface.

cable downstream attribute-mask Specifies an attribute mask value for a wideband cable interface.

interface wideband-cable Specifies a wideband cable interface.

Cisco CMTS Cable Command Reference

67
 Cable Commands: cable a through cable c
cable bgsync

cable bgsync
To set the data intervals for the background synchronization of SNMP MIB data on the Cisco CMTS, use the
cable bgsync command in global configuration mode. To disable background synchronization, use the no
form of this command.

cable bgsync {itime i-interval | ptime p-interval | delay seconds}

no cable bgsync

Syntax Description itime Indicates the data interval time between two interval synchronizations.

ptime Indicates the incremental data interval time between two synchronizations.

i-interval Length of the data interval in seconds. The valid range is from 5 to 31536000. The default
value is 86400.

p-interval Length of the incremental data interval in seconds. The valid range is from 5 to 86400. The
default value is 5.

delay Indicates the delay time (in seconds) by which the first i packet (synchronization packet) is
seconds sent after SUP switchover. The valid range is from 0 to 31536000. The default value is 0.

Command Default This command is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

IOS-XE 3.18.0S This command is implemented on the Cisco cBR Series Converged Broadband
Routers.

Cisco IOS XE Fuji This command is update to include delay keyword.

16.7.3

Usage Guidelines

Note To use the cable bgsync command, you must configure the service internal command in global configuration
mode. Use the cable bgsync command carefully as it can impact the CPU utilization.

For more information about MIB objects that are synchronized during background synchronization, see the
Cisco CMTS Universal Broadband Router Series MIB Specifications Guide 12.2SC.

Cisco CMTS Cable Command Reference

68
 Cable Commands: cable a through cable c
cable bgsync

Examples The following example shows how to set the data intervals for background synchronization on the
Cisco CMTS:

Router# configure terminal

Router(config)# service internal
Router(config)# cable bgsync itime 3600
Router(config)# cable bgsync ptime 6
Router(config)# cable bgsync delay 300
Router(config)#

Related Commands Command Description

cable bgsync active Activates background synchronization process on the Cisco CMTS.

clear cable bgsync counters Clears the background synchronization counters on the Cisco CMTS.

show cable bgsync Displays the information on the background synchronization process on the
Cisco CMTS.

Cisco CMTS Cable Command Reference

69
 Cable Commands: cable a through cable c
cable bgsync active

cable bgsync active

To activate the background synchronization process on the Cisco CMTS, use the cable bgsync active command
in global configuration mode. To deactivate the background synchronization process, use the no form of this
command.

cable bgsync active

no cable bgsync active

Syntax Description This command has no arguments or keywords.

Command Default This command is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

IOS-XE This command is implemented on the Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines Use the cable bgsync active command to activate the background synchronization process.
In Cisco uBR10012 and Cisco 7200 Series routers, SNMP objects use interprocess communication (IPC) to
access data between the line card and the route processor (RP). When SNMP queries are sent to a Cisco CMTS
with large number of modems configured, IPC takes a long time to retrieve the information from the line card
and pass it on to the RP. This resulted in an increase in the SNMP response time. The background
synchronization process slowly synchronizes the data between the line card and the RP. Therefore, when
SNMP queries are sent to the Cisco CMTS, the Cisco CMTS returns the SNMP data from the RP. IPC requests
are not sent to retrieve the data, thereby improving the SNMP performance.
In Cisco cBR Series routers, SNMP background synchronization features provides periodic background
synchronization of DOCSIS MIB data from line card to Supervisor in order to improve the performance of
the SNMP polling of these MIB tables. It is based on raw socket and uses TCP protocol.
The background synchronization process is enabled by default on the Cisco cBR-8, Cisco uBR10012, and
Cisco 7200 Series routers.
For more information about the MIB objects that are synchronized during background synchronization, see
the Cisco CMTS Universal Broadband Router Series MIB Specifications Guide 12.2SC. and Cisco cBR
Series Converged Broadband Routers Troubleshooting and Network Management Configuration Guide.

Examples The following example shows how to deactivate the background synchronization process on the
Cisco CMTS:

Router# configure terminal

Cisco CMTS Cable Command Reference

70
 Cable Commands: cable a through cable c
cable bgsync active

Router(config)# no cable bgsync active

Router(config)#

Related Commands Command Description

cable bgsync Sets the data intervals for background synchronization on the Cisco CMTS.

show cable bgsync Displays the information on the background synchronization process, on the
Cisco CMTS.

clear cable bgsync counters Clears the background synchronization counters on the Cisco CMTS.

Cisco CMTS Cable Command Reference

71
 Cable Commands: cable a through cable c
cable bonding-group-id

cable bonding-group-id

Note Effective with Cisco IOS Release 12.2(33)SCE, the cable bonding-group-id command is replaced by the
cable bonding-group-secondary command. See the cable bonding-group-secondary command for more
information.

To specify a Bonding Group ID and indicate whether the bonding group is a primary or secondary bonded
channel, use the cable bonding-group-id command in wideband-cable interface configuration mode. To
remove a bonding group configuration and revert to the default bonding group (a primary bonding group),
use the no form of this command.

cable bonding-group-id id_num [secondary]

no cable bonding-group-id id_num [secondary]

Syntax Description id_num A unique Bonding Group ID. Valid values are 1 to 255. The bonding group ID must be unique
for each wideband channel on the CMTS.

secondary Specifies that the bonding group is a secondary bonding group. If the secondary keyword is
not used, the bonding group is a primary bonding group.

Command Default If the cable bonding-group-id command is not issued, Cisco IOS software assigns a default ID to the bonding
group and configures the wideband-channel cable interface as a primary bonding group.

Command Modes
Interface configuration mode for a wideband-cable interface (config-if)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

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

12.2(33)SCE This command was replaced with the cable bonding-group-secondary command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable bonding-group-id command is not needed for the wideband channels that will be received by the
Scientific Atlanta DPC2505 or EPC2505 wideband cable modems.
The cable bonding-group-id command is used only for wideband channels that will be received by the
Linksys WCM300-NA, WCM300-EURO, or WCM300-JP wideband cable modems.
Linksys WCM300 Cable Modem
For wideband channels that will be received by the Linksys WCM300-NA, WCM300-EURO, and WCM300-JP
cable modems, the cable bonding-group-id command assigns a Bonding Group ID to a wideband-channel

Cisco CMTS Cable Command Reference

72
 Cable Commands: cable a through cable c
cable bonding-group-id

cable interface and configures the bonding group as a primary bonding group if the secondary keyword is
not specified, or as a secondary bonding group if the secondary keyword is specified.
• A primary bonding group is a primary bonded channel.
• A secondary bonding group is a secondary bonded channel.
The primary bonded channel is the wideband channel on which the Linksys WCM300 modem receives all of
its unicast traffic and some of its multicast traffic. The cable modem may identify the primary bonded channel
and any secondary bonded channels to the CMTS at cable modem registration time. The DOCSIS configuration
file may define the primary bonded channel for the CMTS to assign to the cable modem.
In addition to joining one primary bonded channel, the Linksys WCM300 may join up to two secondary
bonded channels simultaneously in order to receive additional data streams. The DOCSIS configuration file
may define the secondary bonded channels for the modem to pass to the CMTS. Secondary bonded channels
are intended to receive multicast traffic such as broadcast video that is not available on the primary bonded
channel.
For information on the TLV encodings that can be used in the DOCSIS configuration file to identify primary
and secondary bonded channels, see the Cisco Cable Wideband Solution Design and Implementation Guide,
Release 1.0 .

Note If a wideband channel is specified as a primary or secondary bonded channel in the DOCSIS configuration
file, it must be identically defined as a primary or secondary bonded channel in the CMTS active, running
configuration file.

• If a wideband channel is configured with the cable bonding-group-id command or by default to be a

primary bonded channel, the Linksys WCM300 modem will not register using it as one of its secondary
bonded channels.
• If a wideband channel is configured with the cable bonding-group-id command to be a secondary
bonded channel, the Linksys WCM300 modem will not register using it as its primary bonded channel.

Note When a wideband channel is defined on a Wideband SPA, Cisco IOS software configures the wideband
channel as a primary bonding group (primary bonded channel) and assigns a default ID to the bonding group.
If a wideband channel is to be used as a secondary bonded channel, use the cable bonding-group-id command
with the secondary keyword to specify that the channel is a secondary bonded channel.

If you specify a non-unique Bonding Group ID for the id_num argument, cable bonding-group-id displays
an error message and does not modify the ID.

Examples The following examples show how to use the cable bonding-group-id command for a variety of
purposes. The following cable bonding-group-id command specifies that wideband channel 10 on
the Wideband SPA in slot/subslot/bay 1/0/1 will be a secondary bonding group (secondary bonded
channel) having the bonding group ID 20.

Router# configure terminal

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

Router(config-if)# cable bonding-group-id 20 secondary

Cisco CMTS Cable Command Reference

73
 Cable Commands: cable a through cable c
cable bonding-group-id

The following example shows how to change a bonding group with an ID of 20 from a secondary
to a primary bonding group by omitting the secondary keyword:

Router(config-if)# cable bonding-group-id 20

The no form of the cable bonding-group-id removes the configured bonding group and reverts the
configuration to the default bonding group. For a secondary bonding group with the ID of 20, the
following no forms of the command are equivalent:

Router(config-if)# no cable bonding-group-id 20

or

Router(config-if)# no cable bonding-group-id 20 secondary

When either of the preceding commands are issued, the wideband-channel cable interface is
configured to use a default bonding group, which has a default bonding group ID assigned
by Cisco IOS software and is a primary bonding group.

Related Commands Command Description

interface Enters interface configuration mode.

Cisco CMTS Cable Command Reference

74
 Cable Commands: cable a through cable c
cable bonding-group-secondary

cable bonding-group-secondary
To specify a bonding group as a secondary bonded channel, use the cable bonding-group-secondary command
in wideband-cable interface configuration mode. To remove the bonding group configuration and revert to
the default bonding group (a primary bonding group), use the no form of this command.

cable bonding-group-secondary
no cable bonding-group-secondary

Command Default If the cable bonding-group-secondary command is not issued, Cisco IOS software configures the
wideband-channel cable interface as the primary bonding group.

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

Command History Release Modification

12.2(33)SCE This command was introduced for the Cisco uBR-MC3GX60V cable interface line card.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Starting with Cisco IOS Release 12.2(33)SCE, the cable bonding-group-secondary command replaces the
cable bonding-group-id command. If you upgrade from an earlier Cisco IOS Release to Cisco IOS Release
12.2(33)SCE and later, the cable bonding-group-id command will no longer change the bonding-group ID.
The cable bonding-group-secondary command is used only for wideband channels that are received by the
Linksys WCM300-NA, WCM300-EURO, or WCM300-JP wideband cable modems.
Linksys WCM300 Cable Modem
For wideband channels that are received by the Linksys WCM300-NA, WCM300-EURO, and WCM300-JP
cable modems, the show controllers Modular-Cable slot/subslot/controller wideband command displays
the bonding group ID of a wideband-channel cable interface and the cable bonding-group-secondary
command configures the bonding group as a secondary bonding group.
The primary bonded channel is the wideband channel on which the Linksys WCM300 modem receives all of
its unicast traffic and some of its multicast traffic. The cable modem identifies the primary bonded channel
and any secondary bonded channels to the CMTS at cable modem registration time. The DOCSIS configuration
file defines the primary bonded channel for the CMTS to assign to the cable modem.
In addition to joining one primary bonded channel, the Linksys WCM300 joins up to two secondary bonded
channels simultaneously in order to receive additional data streams. The DOCSIS configuration file defines
the secondary bonded channels for the modem to pass to the CMTS. Secondary bonded channels are intended
to receive multicast traffic such as broadcast video that is not available on the primary bonded channel.
For information on the TLV encodings that can be used in the DOCSIS configuration file to identify primary
and secondary bonded channels, see Cisco Cable Wideband Solution Design and Implementation Guide,
Release 1.0 .

Cisco CMTS Cable Command Reference

75
 Cable Commands: cable a through cable c
cable bonding-group-secondary

Note If a wideband channel is specified as a primary or secondary bonded channel in the DOCSIS configuration
file, it must be identically defined as a primary or secondary bonded channel in the CMTS active, running
configuration file.

The following points list the restrictions for configuring the wideband channel with the cable
bonding-group-secondary command:
• If a wideband channel is not configured with the cable bonding-group-secondary command, the Linksys
WCM300 modem may not use it as a secondary bonding group.
• If a wideband channel is configured with the cable bonding-group-secondary command to be a secondary
bonded channel, the Linksys WCM300 modem may not use it as a primary bonded group.

Note When a wideband channel is defined, the Cisco IOS software configures the wideband channel as a primary
bonding group (primary bonded channel) and assigns a default ID to the bonding group. If a wideband channel
is to be used as a secondary bonded channel, use the cable bonding-group-secondary command to specify
that the channel is a secondary bonded channel.

Examples The following example shows how to use the cable bonding-group-secondary command:

Router# configure terminal

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

Router(config-if)# cable bonding-group-secondary

Related Commands Command Description

interface Enters interface configuration mode.

Cisco CMTS Cable Command Reference

76
 Cable Commands: cable a through cable c
cable cache-snmp active

cable cache-snmp active

To enable the cache mechanism, use cable cache-snmp active command in global configuration mode. To
remove the configuration, use the no form of this command.

cable cache-snmp active

no cable cache-snmp active

Syntax Description This command has no arguments or keywords.

Command Default The cache mechanism is active by default.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCI2 This command was introduced.

Usage Guidelines By default, the SNMP cache feature is activated. It can be enabled or disabled globally using the cable
cache-snmp active command. It cannot be enabled or disabled per table currently. You can turn cache off
if their polling strategy does not suit the cache principle so that cache will help on a sequential polling.

Examples The following example shows how to enable the cache mechanism:
Router#configure terminal
Router(config)#cable cache-snmp active
Router(config)#

Cisco CMTS Cable Command Reference

77
 Cable Commands: cable a through cable c
cable channel-group

cable channel-group
To configure the channel group, use the cable channel-group command in global configuration mode. To
disable the channel group, use the no form of the command.

cable channel-group group-id

no cable channel-group group-id

Syntax Description group-id Channel group ID. The range is from 1 to 1000.

Command Default Channel group is not configured.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)CX This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

The following example shows how to configure a channel group:

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

Related Commands Command Description

show cable channel-group Displays the channel group information.

upstream cable channel Configures the upstream cable channel for a channel
group.

downstream modular-cable rf-channel (channel Configures the downstream modular cable RF channel
group) for a channel group.

cmc Configures the Cisco Coaxial Media Converter

(CMC).

Cisco CMTS Cable Command Reference

78
 Cable Commands: cable a through cable c
cable clock clear-counters

cable clock clear-counters

To reset the counters that are displayed with the show controllers clock-reference command, use the cable
clock clear-counters command in privileged EXEC mode.

cable clock clear-counters

Syntax Description This command has no keywords or arguments.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.1(1a)T1 This command was introduced.

12.1(2)EC1 This command was supported on the EC train for the Cisco uBR7246VXR router.

12.2(2)XF This command was supported for the TCC+ card on Cisco uBR10012 routers.

12.2(4)BC1 Support for this command was added to the Release 12.2 BC train for the Cisco
uBR7246VXR and Cisco uBR10012 routers.

12.3(23)BC This command is supported only for standalone (freerun) mode.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command resets any counters that were displayed from the last time the show controllers clock-reference
command was used.

Note This command is not supported on the SC train.

This command supports the Cisco CMTS clock feature set, which provides a synchronized clock for improved
Voice-over-IP (VoIP) operations. The clock feature set requires one of the following configurations:
• A Cisco uBR10012 router with one or two TCC+ cards that are connected to an external national clock
source.

Note Beginning in Cisco IOS Release 12.3(23)BC, TCC+ is replaced with the DOCSIS Timing and Control Card
(DTCC) and does not require to be connected to an extenal national clock source.

• A Cisco uBR7246 VXR router using a Cisco uBR-MC16S, Cisco uBR-MC16E, Cisco uBR-MC28C, or
Cisco uBR-MC28C-BNC cable interface line card. The router must also be equipped with a Cisco cable
clock card and be running Cisco IOS Release 12.1(1a)T1, Cisco IOS Release 12.1(2)EC1, or a later
release. The Cisco cable clock card should be connected to an external national clock source.

Cisco CMTS Cable Command Reference

79
 Cable Commands: cable a through cable c
cable clock clear-counters

Only these cable interface cards support the external clock card reference from a clock card to distribute that
signal to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other cable
interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable interfaces will not
synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. For example, the Cisco
uBR924, running Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature automatically.

Note The show controllers clock-reference command might display compare errors on the Cisco uBR10012 router
because there could be a slight delay at system startup before the clock cards synchronize with each other.
These initial compare errors can be ignored and cleared with the cable clock clear-counters command.

Examples The following example shows how to reset all counters that are displayed for the clock card:

Router# cable clock clear-counters

Related Commands Command Description

show controllers clock-reference Displays the cable clock card’s hardware information.

Cisco CMTS Cable Command Reference

80
 Cable Commands: cable a through cable c
cable clock dti

cable clock dti

To configure the DOCSIS Timing Interface (DTI) clock reference mode, use the cable clock dti command
in global configuration mode. To terminate the DTI clock referemce mode and restart the standalone mode,
use the no form of the command.

cable clock dti

no cable clock dti

Syntax Description This command has no keywords or arguments.

Command Default Standalone mode

Command Modes
Global configuration (config)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to configure DTI clocking mode.

This command may be stored in NVRAM as part of the DOCSIS Timing and Control Card (DTCC)
configuration on the Cisco uBR10012 and Cisco uBR7225VXR routers.

Note When the cable clock dti command or its no form is used to configure the DTI clock reference mode, the
DTCC card on the Cisco uBR10012 router restarts and the cable modems may re-initialize or re-register.

Examples
Router# configure terminal
Router(config)# cable clock dti

Related Commands Command Description

show cable clock dti Displays DTI information.

Cisco CMTS Cable Command Reference

81
 Cable Commands: cable a through cable c
cable clock dti clear-counters

cable clock dti clear-counters

To reset the counters that are displayed with the show cable clock dti counters command in DOCSIS Timing
Interface (DTI) mode, use the cable clock dti clear-counters command in privileged EXEC mode.

cable clock dti clear-counters slot/subslot

Syntax Description slot/subslot Specifies the slot and subslot location of the DTCC ports. Valid values are 1/1 or 2/1.

Command Default No default behavior or values

Command Modes
Privileged EXEC

Command History Release Modification

12.3(23)BC This command was introduced on the Cisco uBR10012 router .

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines This command resets any counters that were displayed from the last time the show cable clock dti client
command was used in DTI mode.
This command supports the Cisco CMTS clock feature set, which provides a synchronized clock for improved
Voice-over-IP (VoIP) operations.

Examples The following example shows how to reset all counters that are displayed for the clock card:

Router# cable clock dti clear-counters

Related Commands Command Description

show cable clock dti counters Displays the cable clock card’s hardware information.

Cisco CMTS Cable Command Reference

82
 Cable Commands: cable a through cable c
cable clock force

cable clock force

To select the external timing source when the clock card is in holdover mode, use the cable clock force
command in global configuration mode. To disable the selection and return to the default, use the no form of
this command.

cable clock force {primary | secondary}

no cable clock force

Syntax Description primary Forces the primary source to act as the clock reference.

secondary Forces the secondary source to act as the clock reference.

Command Default The clock card automatically uses the primary external source, if available. If the primary source fails, the
clock card enters holdover mode and, after a few seconds, switches to the secondary external source. The
clock card switches back to the primary source when it becomes available.

Command Modes
Global configuration (config)

Command History Release Modification

12.1(1a)T1 This command was introduced.

12.1(2)EC1 This command was integrated into Cisco IOS Release 12.1(2)EC1.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines This command overrides the default behavior of the clock card when the clock card is in holdover mode. If
the clock card is not in holdover mode, this command is ignored. You cannot force the reference to a port if
the clock card is in free-running mode.

Note This command is not applicable on the SC train.

Note The clock card enters holdover mode if the forced reference is lost, even if the other external reference is
available.

To support the clock feature set in VoIP configurations, a Cisco uBR7246 VXR chassis, equipped with a
clock card; and a Cisco uBR-MC16S, a Cisco uBR-MC16E, or a Cisco uBR-MC28C cable interface line card
must be used running Cisco IOS Release 12.1(1a)T1 or later releases. Only these cable interface line cards
support the external clock card reference from a clock card to distribute that signal to CMs or set-top boxes
(STBs) attached to the specific network segments. You can use other cable interface cards, such as the Cisco
uBR-MC16C, with the clock card, but these other cable interfaces will not synchronize their downstream
SYNC messages with the external clock source.

Cisco CMTS Cable Command Reference

83
 Cable Commands: cable a through cable c
cable clock force

Each CM or STB must also support VoIP applications and the clock feature set. For example, the Cisco
uBR924, running Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature automatically.

Examples The following example shows how to force the timing reference for the cable clock card to come
from the secondary external source, when the clock card is in holdover mode:

Router(config)# cable clock force secondary

Related Commands Command Description

show cable clock Displays status information for the cable clock card.

show controllers clock-reference Displays hardware information, register values, and current counters for
the cable clock card.

Cisco CMTS Cable Command Reference

84
 Cable Commands: cable a through cable c
cable clock source-midplane

cable clock source-midplane

To make the midplane time-division multiplexing (TDM) clock the primary timing reference for the clock
card, use the cable clock source-midplane command in global configuration mode. To disable the selection
and return to the default, use the no form of this command.

cable clock source-midplane

no cable clock source-midplane

Syntax Description This command has no keywords or arguments.

Command Default The clock card does not get its timing reference from the midplane TDM clock.

Command Modes
Global configuration (config)

Command History Release Modification

12.1(1a)T1 This command was introduced.

12.1(2)EC1 This command was integrated into Cisco IOS Release 12.1(2)EC1.

12.3BC This command was integrated into Cisco OS Release 12.3BC.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines Because the clock card automatically provides the timing reference to the midplane TDM clock, the midplane
cannot in turn act as the reference for the clock card. This means that the cable clock source-midplane
command does not take effect unless a port adapter is configured as the primary clock reference source for
the midplane.

Note This command is not applicable on the SC train.

To support the clock feature set in VoIP configurations, a Cisco uBR7246 VXR chassis, equipped with a
clock card; and a Cisco uBR-MC16S, a Cisco uBR-MC16E, or a Cisco uBR-MC28C cable interface line card
must be used running Cisco IOS Release 12.1(1a)T1 or higher releases. Only these cable interface line cards
support the external clock card reference from a clock card to distribute that signal to CMs or set-top boxes
(STBs) attached to the specific network segments. You can use other cable interface cards, such as the Cisco
uBR-MC16C, with the clock card, but these other cable interfaces will not synchronize their downstream
SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. The Cisco uBR924, running
Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature automatically.

Examples The following example shows how to set the primary clock reference to the midplane TDM clock:

Cisco CMTS Cable Command Reference

85
 Cable Commands: cable a through cable c
cable clock source-midplane

Router(config)# cable clock source-midplane

Related Commands Command Description

show cable Displays status information for the cable clock card.
clock

Cisco CMTS Cable Command Reference

86
 Cable Commands: cable a through cable c
cable clock upgrade

cable clock upgrade

To upgrade the Field-Programmable Gate Array (FPGA) image manually on the DOCSIS Timing & Control
Card (DTCC), use the cable clock upgrade command in privileged EXEC mode.

cable clock upgrade slot/subslot

Syntax Description slot Chassis slot number of the DTCC card. The valid slot is 1.

subslot Secondary slot number of the DTCC card. Valid subslots are 1 or 2.

Command Default No default behaviors or values

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines In Cisco IOS Release 12.2(33) SCC and later, you can manually upgrade the FPGA image only if a single
DTCC card is installed on the Cisco uBR 10012 router. If the manual upgrade fails or is interrupted, the DTCC
card may become unusable. Do not reset or unplug the DTCC card during the manual upgrade. We recommend
that you take precaution against extended downtime if the FPGA upgrade fails unexpectedly by having a
standby DTCC card installed on the Cisco uBR10012 router.

Note You will have to enter y (yes) when the system prompts you to continue the manual upgrade.

Examples The following example shows how to start the manual FPGA upgrade process on the DTCC card:

Router# cable clock upgrade 1/1

Related Commands Command Description

cable clock dti Configures the DOCSIS Timing Interface (DTI) clock reference mode.

Cisco CMTS Cable Command Reference

87
 Cable Commands: cable a through cable c
cable cm-status

cable cm-status
To configure the values of the “Event Holdoff Timer” and “Number of Reports per Event” parameters for the
cable modem (CM) status events, use the cable cm-status command in global configuration mode. To revert
to the default values, use the no form of this command.

cable cm-status {allevent} [holdoff {timer | default} | reports {reportvalue | default}]

no cable cm-status

Syntax Description all Specifies all CM status events.

event Type of CM status event.

holdoff (Optional) Sets the CM status event holdoff timer. The holdoff units are defined in milliseconds.
The timer value increments by 20 milliseconds.
• timer—Holdoff timer value. The valid range is from 1 to 65535 milliseconds. The default value
is 500 milliseconds.
• default—Specifies the default value of 500 milliseconds.

reports (Optional) Sets the value for the number of reports per event.
• reportvalue—Report value. The valid range is from 0 to 255. The default value is 5.
• default—Specifies the default value of 5.

Command Default Default values are used for the “Event Holdoff Timer” and “Number of Reports per Event” parameters.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE 17.3.1z The default value was updated.

Usage Guidelines The cable cm-status command updates the event table for the MAC Domain Descriptor (MDD) belonging
to a primary channel. The help text of the command provides a mapping of an event type to the corresponding
integer.
The ten CM status events are:
1. Secondary channel MDD time-out
2. QAM/FEC lock failure
3. Sequence out-of-range

Cisco CMTS Cable Command Reference

88
 Cable Commands: cable a through cable c
cable cm-status

4. MDD recovery
5. QAM/FEC lock recovery
6. T4 time-out
7. T3 re-tries exceeded
8. Successful ranging after T3 re-tries exceeded
9. CM operating on battery backup
10. CM returned to A/C power

Note The CM-STATUS message event ‘sequence out of range’ is enabled and supported on the Cisco Wideband
SPA from Cisco IOS Release 12.2(33)SCE5 onwards. When the Cisco CMTS receives the ‘sequence out of
range’ event, it toggles the sequence-change-count (SCC) bit for each of the indicated downstream service
identifiers (DSIDs).

Examples The following example shows how to configure an event holdoff timer of 100 milliseconds and four
reports per event for all CM-STATUS events:

Router# configure terminal

Router(config)# cable cm-status all holdoff 100 reports 4

The following example shows how to configure the CM status event “MDD recovery” with an event
holdoff timer of 150 milliseconds and three reports for the event:

Router# configure terminal

Router(config)# cable cm-status 4 holdoff 150 reports 3

Related Commands Command Description

cable cm-status enable Enables a CM status event or a group of CM status events on a primary cable
interface.

Cisco CMTS Cable Command Reference

89
 Cable Commands: cable a through cable c
cable cm-status enable

cable cm-status enable

To enable a CM status event or a group of CM status events on a primary cable interface, use the cable
cm-status enable command in interface configuration mode or MAC domain profile configuration mode. To
disable a particular event on a primary cable interface, use the no form of this command.

cable cm-status enable range

no cable cm-status

Syntax Description range Specifies the CM status events you want to enable on a primary cable interface. The valid range is 1
to 10. You can enable a single event by specifying the event number or a group of events by specifying
a range (for example, 1-9).
The following events are enabled by default on a cable or modular cable interface on the Cisco
uBR10012 and Cisco uBR7200 series routers:
• Secondary channel MDD time-out
• QAM/FEC lock failure
• Sequence out of range
• MDD recovery
• QAM/FEC lock recovery

Note
The default events are not displayed in the output of the show running-config interface cable
command.

Command Default The downstream related events such as secondary channel MDD time-out, QAM/FEC lock failure, Sequence
out of range, MDD recovery, and QAM/FEC lock recovery are enabled.

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines This command applies to all non-primary RF channels on a CMTS.

The ten CM status events per interface on the Cisco uBR10012 and Cisco uBR7200 series routers are:
• 1—Secondary channel MDD time-out

Cisco CMTS Cable Command Reference

90
 Cable Commands: cable a through cable c
cable cm-status enable

• 2—QAM/FEC lock failure

• 3—Sequence out of range
• 4—MDD recovery
• 5— QAM/FEC lock recovery
• 6—T4 time-out
• 7— T3 re-tries exceeded
• 8— Successful ranging after T3 re-tries exceeded
• 9— CM operating on battery backup
• 10— CM returned to A/C power

The six CM status events per interface on the Cisco cBR series routers are:
• 3—Sequence out of range
• 6—T4 time-out
• 7—T3 re-tries exceeded
• 8— Successful ranging after T3 re-tries exceeded
• 9—CM operating on battery backup
• 10— CM returned to A/C power

Note If the no form of the command is executed on the interface for specific events, then the show running-config
interface command lists the events only that are enabled. If no events are enabled then, the show running
interface cable command displays no cable cm-stauts enable with the events.

Examples The following example shows how to enable all CM status events on a primary cable interface:

Router# configure terminal

Router(config)# interface cable 8/0/0
Router(config-if)# cable cm-status enable 1-10

The following example shows the no cable cm-status enable command being configured and the
corresponding example shows show running-config interface command output:

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

Router(config-if)# cable cm-status enable 1-10
Router(config-if)# no cable cm-status enable 1-2 4-5
Router(config-if) exit
Router# show running-config interface cable 8/0/0
Building configuration...
Current configuration : 1557 bytes
!
interface Cable8/0/0
shutdown
cable cm-status enable 3 6-10

Cisco CMTS Cable Command Reference

91
 Cable Commands: cable a through cable c
cable cm-status enable

no cable packet-cache
cable default-phy-burst 0
cable map-advance dynamic 300 500
cable bundle 1
cable downstream channel-id 145

The following example shows the show running-config interface cable command output when no
events are enabled on the CMTS:

Router# show running-config interface cable 8/0/0

Building configuration...
Current configuration : 1558 bytes
!
interface Cable8/0/0
shutdown
no cable cm-status enable 1-10
no cable packet-cache
cable default-phy-burst 0
cable map-advance dynamic 300 500
cable bundle 1
cable downstream channel-id 145
cable downstream annex B
cable downstream modulation 256qam
cable downstream interleave-depth 32
cable downstream frequency 555000000
cable downstream rf-shutdown
cable upstream max-ports 4
no cable upstream 0 connector
cable upstream 0 frequency 40000000
cable upstream 0 channel-width 3200000 3200000
cable upstream 0 power-level 26
cable upstream 0 docsis-mode tdma-atdma
cable upstream 0 minislot-size 4
--More--

Related Commands Command Description

show cable modem Displays information for the registered and unregistered CMs.

Cisco CMTS Cable Command Reference

92
 Cable Commands: cable a through cable c
cable cmc

cable cmc
To configure the downstream RF power or Forward Optical Receiver Module (FRx) for the Cisco Coaxial
Media Converter (CMC), use the cable cmc command in global configuration mode. To disable the
configuration, use the no form of the command.

cable cmc mac-address {ds-rf-power power [tilt tilt-value ] | frx {att att-value | eq eq-value}}

no cable cmc mac-address { ds-rf-power | frx {att | eq}}

Syntax Description mac-address MAC address of the Cisco CMC.

ds-rf-power Specifies the RF power for downstream channels on the

Cisco CMC.

power RF power in dBmV. The valid range is from 35 to 62. RF

power is specified in the format xy.z, where z is 0.

tilt tilt-value (Optional) Sets the tilt equalization value for downstream
channel RF power on the Cisco CMC. The default value is
9 dB.
tilt-value—Tilt equalization can be set to one of the
following values:
• -15dB—Sets the tilt equalization value to -15 dB.
• -12dB—Sets the tilt equalization value to -12 dB.
• -9dB—Sets the tilt equalization value to -9 dB.
• -6dB—Sets the tilt equalization value to -6 dB.
• -3dB—Sets the tilt equalization value to -3 dB.
• 0dB—Sets the tilt equalization value to 0 dB.

frx Configures FRx on the Cisco CMC.

att att-value Specifies the attenuation value in dB.

• att-value—Attenuation value. The valid range is from
0 to 10.

eq eq-value Sets the equalization value in dB.

• eq-value—Equalization value. The valid range is from
3 to 15.

Command Default Downstream RF power and FRx are not configured on the Cisco CMC.

Command Modes Global configuration (config)

Cisco CMTS Cable Command Reference

93
 Cable Commands: cable a through cable c
cable cmc

Command History Release Modification

Cisco IOS Release 12.2(33)CX This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines The cable cmc command configures the resource sharing between the Cisco CMCs in a channel group based
on the MAC address.
The valid downstream RF power value is based on the number of active downstream RF channels on the
Cisco CMC. If the configured downstream RF power value for a specific number of downstream RF channels
is out of the valid range, the downstream RF power is adjusted according to the number of active downstream
RF channels on the Cisco CMC and a warning message is displayed.
We recommend that you use the following downstream RF power values based on the number of active
downstream RF channels:

Table 1: Recommended Downstream RF Power Values

Number of Downstream RF Channels Recommended RF Power Values

1 50 dBmV to 6 2dBmV

2 46 dBmV to 58 dBmV

3 44 dBmV to 56 dBmV

4 42 dBmV to 54 dBmV

5 41 dBmV to 53 dBmV

6 40 dBmV to 52 dBmV

7 39 dBmV to 51 dBmV

8 39 dBmV to 51 dBmV

9 38 dBmV to 50 dBmV

10 38 dBmV to 50 dBmV

11 37 dBmV to 49 dBmV

12 37 dBmV to 49 dBmV

13 36 dBmV to 48 dBmV

14 36 dBmV to 48 dBmV

15 35 dBmV to 47 dBmV

16 35 dBmV to 47 dBmV

Cisco CMTS Cable Command Reference

94
 Cable Commands: cable a through cable c
cable cmc

The following example shows how to configure RF power for downstream channel on the Cisco CMC
with a tilt equalization value of 0 dB:
Router# configure terminal
Router(config)# cable cmc 0001.0002.0003 ds-rf-power 35 tilt 0dB

The following example shows how to configure FRx for the Cisco CMC with an attenuation value
of 6 dB:
Router# configure terminal
Router(config)# cable cmc 0001.0002.0003 frx att 6

The following example shows how to configure FRx for the Cisco CMC with an equalization value
of 3 dB:
Router# configure terminal
Router(config)# cable cmc 0001.0002.0003 frx eq 3

Related Commands Command Description

clear cable cmc Clears the information on the Cisco CMC.

show cable cmc Displays the Cisco CMC information.

Cisco CMTS Cable Command Reference

95
 Cable Commands: cable a through cable c
cable cmc image_upgrade

cable cmc image_upgrade

To upgrade the Cisco CMC image , use the cable cmc image_upgrade command in privileged EXEC mode.
To disable the upgrade, use the no form of the command.

cable cmc mac-address image_upgrade

no cable cmc mac-address image_upgrade

Syntax Description mac-address MAC address of the Cisco CMC.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS Release 12.2(33)CX This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Before upgrading the Cisco CMC image through the Cisco CMTS, you must specify the TFTP or FTP server
address and the full file path in the DHCP server.

The following example shows how to upgrade the Cisco CMC image:
Router> enable
Router# cable cmc 0001.0002.0003 image_upgrade

Cisco CMTS Cable Command Reference

96
 Cable Commands: cable a through cable c
cable cmcpe-list valid-time

cable cmcpe-list valid-time

To set the length of time that a CMTS router will consider the current list of CM and CPE devices to be valid,
use the cable cmcpe-list valid-time command in global configuration mode. To reset the time period to its
default value of 3 minutes, use the no form of this command.

cable cmcpe-list valid-time time

no cable cmcpe-list valid-time

Syntax Description time Specifies the time period, in seconds, that the Cisco CMTS router should consider the current CM/CPE
list to be valid. In Cisco IOS Release 12.2(15)BC1 and earlier releases, the valid range is 0 to 3600
seconds, with a default value of 180 seconds (3 minutes). In Cisco IOS Release 12.2(15)BC2 and later
releases, the valid range is 0 to 86400 seconds, with a default value of 900 seconds (15 minutes).

Command Default 180 seconds (3 minutes)—Cisco IOS Release 12.2(15)BC1 and earlier releases
900 seconds (15 minutes)—Cisco IOS Release 12.2(15)BC2 and later releases

Command Modes
Global configuration (config)

Command History Release Modification

12.0(15)SC1, 12.1(8)EC1, This command was introduced for the Cisco uBR7100 series and Cisco uBR7200
series routers.

12.2(4)BC1 This command was supported on the 12.2 BC train for the Cisco uBR10012
router.

12.2(15)BC2 The maximum range for time was expanded from 3600 to 86400 seconds, and
the default was changed from 180 to 900 seconds.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines The Cisco CMTS router maintains an internal list of cable modems and CPE devices that were connected on
its cable interfaces in the last 24 hours. This list does not capture cable modems and CPE devices that were
connected before the last 24 hours.
The CMTS router uses this list to provide the data for various show commands and to respond to SNMP
requests that query the entries in the cdxCmCpeTable table in the CISCO-DOCS-EXT-MIB MIB.
By default, the Cisco CMTS router uses the current list if it is less than 3 minutes old. If the current list is
older than 3 minutes, the Cisco CMTS router considers it invalid and rebuilds a new list. This prevents the
CMTS router from having to build a new list for every query, which could impact system performance.

Cisco CMTS Cable Command Reference

97
 Cable Commands: cable a through cable c
cable cmcpe-list valid-time

You can use the cable cmcpe-list valid-time command to change the length of time that the CMTS router
considers the current CM and CPE device list to be valid. This allows you to find the optimum time value
that provides the most current information without affecting the number of CPU cycles that are available for
network processing.
A smaller time period ensures that the CM and CPE device list is more current but it requires more processing
time to maintain the list. A longer time period reduces the load on the processor but the CM/CPE list might
not be current.
If CPU usage dramatically increases when performing SNMP queries of the cdxCmCpeTable table, use this
command to increase the valid list time so that the Cisco CMTS router does not have to rebuild the CM/CPE
list more often than needed to respond to the queries.

Note To find the current valid list time, use the show running-config command and look for the cable cmcpe-list
valid-time command in the output. If the command does not appear, the valid list time is set for its default
value.

Examples The following example shows how to set the valid list time to 60 seconds (1 minute):

Router(config)# cable cmcpe-list valid-time 60

The following example shows how to find the current valid list time setting:

Router# show running-config | include cmcpe-list

cable cmcpe-list valid-time 60

Related Commands Command Description

show cable modem Displays information for the registered and unregistered CMs.

Cisco CMTS Cable Command Reference

98
 Cable Commands: cable a through cable c
cable cmts-id

cable cmts-id
To configure the CMTS ID for the Cisco CMTS, use the cable cmts-id command in global configuration
mode. To set the CMTS ID to its default value, use the no form of this command.

cable cmts-id cmts-id

no cable cmts-id cmts-id

Syntax Description cmts-id CMTS ID for the Cisco CMTS. The range is from 0 to 16383. The default is 8191.

Command Default CMTS ID is 8191.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This configuration allows you to define the value for the CMTS ID portion of Gate IDs. The CMTS ID value
is the 13 least significant bits (0-12) of the Gate ID.

Example
The following example shows how to configure the CMTS ID:
Router(config)# cable cmts-id 9000

Related Commands Command Description

show cable cmts-id Displays the configured CMTS ID.

Cisco CMTS Cable Command Reference

99
 Cable Commands: cable a through cable c
cable config-file

cable config-file
To create a configuration filename for a Cisco CMTS router internal CM configuration file, use thecable
config-file command in global configuration mode. To delete the configuration filename, use theno form of
this command.

cable config-file filename

no cable config-file filename

Syntax Description filename Specifies the configuration filename to create and edit.

Command Default None.

Command Modes
Global configuration (config)

Command History Release Modification

12.1(2)EC1 This command was introduced.

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

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines A DOCSIS CMTS router automatically downloads a DOCSIS configuration file to a CM during its initial
registration procedure. The DOCSIS configuration file configures the CM for its network operations and
includes information such as the maximum number of CPE devices that are supported, the quality of service
(QoS) options provided for the CM, and whether the CM should upgrade to a new software image.
The DOCSIS specification defines the format of the DOCSIS configuration files, which can be created by
any number of tools. In addition to the other tools that Cisco provides for this purpose, the cable config-file
command can be used to create the DOCSIS configuration files needed for your network. These configuration
files are stored in the Flash memory on the Cisco CMTS router and can be automatically downloaded to the
CM as needed.
The cable config-file command creates the DOCSIS configuration file if it does not already exist and then
enters config-file configuration mode. You can then give one of the following subcommands to create the
configuration file:
• access-denied
• channel-id
• cpe max
• download

Cisco CMTS Cable Command Reference

100
 Cable Commands: cable a through cable c
cable config-file

• frequency
• option
• privacy
• service-class
• snmp manager
• timestamp

Note When a DOCSIS shared secret is configured on the downstream interface (see the cable shared-secret
command), the cable config-file command automatically inserts the appropriate MD5 Message Integrity
Check (MIC) value at the end of the dynamically generated DOCSIS configuration file. You do not need to
specify the DOCSIS shared secret string with the cable config-file command.

After using the cable config-file subcommands, enter the exit command to leave config-file mode and to
save the configuration file in the Flash memory. After a configuration file is created, it also appears in the
running-configuration file. To delete a configuration file and remove it from Flash memory, use the no cable
config-file command
To allow CMs to download the configuration files, you must also enable the router’s onboard TFTP server,
using the tftp-server configuration command. Unless you are running on a small lab network, you should
also remove the default limit of 10 TFTP sessions by using the service udp-small-serves max-servers no
limit command.
In addition, the following commands are also recommended:
• cable time-server - Enables the Cisco CMTS router to function as a time-of-day (ToD) server.
• ip dhcp pool - Configures the Cisco CMTS router as a DHCP server. Otherwise, you need an external
DHCP server.
• ip dhcp ping packets 0 - Improves the scalability of the Cisco CMTS router DHCP server.

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

Examples The following example shows two DOCSIS configuration files being configured. The first
configuration file allows each CM to have up to four CPE devices and configures the QoS parameters
for its traffic. The second configuration file denies network access to the CM and its CPE devices.

Router# configure terminal

Router(config)# cable config-file test.cm
Router(config-file)# cpe max 4
Router(config-file)# service-class 1 priority 2
Router(config-file)# service-class 1 max-upstream 128
Router(config-file)# service-class 1 max-downstream 1000

Cisco CMTS Cable Command Reference

101
 Cable Commands: cable a through cable c
cable config-file

Router(config-file)# timestamp
Router(config-file)# exit
Router(config)# cable config-file denied.cm
Router(config-file)# access-denied
Router(config-file)# exit
Router(config)#

The following is a portion of a typical Cisco IOS configuration file that shows the above two DOCSIS
configuration files, as well as a typical DHCP server configuration:

Router# show running-config

...
service udp-small-servers max-servers no-limit
!
cable time-server
!
cable config-file test.cm
cpe max 4
service-class 1 priority 2
service-class 1 max-upstream 128
service-class 1 max-downstream 1000
timestamp
cable config-file disable.cm
access-denied
!
ip dhcp pool modems-c3
network 10.30.128.0 255.255.240.0
bootfile test.cm
next-server 10.30.128.1
default-router 10.30.128.1
option 7 ip 10.30.128.1
option 4 ip 10.30.128.1
option 2 hex 0000.0000
!
...

Related Commands Command Description

cable config-file Creates a DOCSIS configuration file and enters configuration file mode.

access-denied Disables access to the network.

channel-id Specifies upstream channel ID.

cpe max Specifies the maximum number of CPE devices allowed access.

debug cable config-file Displays information about the DOCSIS configuration files that are generated by
the internal DOCSIS configuration file editor.

download Specifies the filename and server IP address for downloading a new software
image.

frequency Specifies the downstream frequency.

option Specifies options for the configuration file that are not provided for by the other
commands.

privacy Specifies privacy options for baseline privacy images.

Cisco CMTS Cable Command Reference

102
Cable Commands: cable a through cable c
cable config-file

Command Description

service-class Specifies service class definitions for the configuration file.

snmp manager Specifies Simple Network Management Protocol (SNMP) options.

timestamp Enables time-stamp generation.

show running-config Displays the current run-time configuration, which includes any configuration
files that have been defined.

show startup-config Displays the current saved configuration, which includes any configuration files
that have been defined and saved.

Cisco CMTS Cable Command Reference

103
 Cable Commands: cable a through cable c
cable controller-profile

cable controller-profile
To enable I-CMTS controller profile configuration, use the cable controller-profile I-CMTS enable command
in global configuration mode.
Post configuring the cable controller-profile I-CMTS enable command, total chassis only supports Profile
based controller configuration. Once enabled, it cannot rollback.

cable controller-profile I-CMTS enable

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Fuji This command is introduced on the Cisco cBR Series Converged Broadband
16.7.1 Routers.

Usage Guidelines i-CMTS controllers are configured using legacy controller configuration commands by default. If you want
to use i-CMTS controller profile, then you must enable it first.

The following example shows how to enable i-CMTS controller profile configuration:
Router# configure terminal
Router(config)# cable controller-profile I-CMTS enable

Related Commands Command Description

cable downstream controller-profile Enters downstream controller profile configuration

mode.

cable upstream controller-profile Enters upstream controller profile configuration mode.

Cisco CMTS Cable Command Reference

104
Cable Commands: cable d
• cable d31-mode, on page 108
• cable d40-mode, on page 110
• cable dci-response, on page 111
• cable dci-upstream-disable, on page 113
• cable def-phy-burst , on page 115
• cable default-phy-burst, on page 117
• cable depi multicast pool, on page 120
• cable depi multicast pool redundant include-video-controller, on page 121
• cable depi multicast statistic monitor , on page 124
• cable device, on page 125
• cable dfo-retry-count, on page 127
• cable dhcp ipv4 profile, on page 128
• cable dhcp-giaddr, on page 129
• cable dhcp-insert, on page 133
• cable dhcp-parse option, on page 135
• cable diaglog, on page 136
• cable diplexer-band-edge, on page 137
• cable diplexer-mdd-override-band-edge, on page 138
• cable divert-rate-limit, on page 139
• cable docsis30-voice downstream req-attr-mask, on page 140
• cable docsis-ver, on page 142
• cable dot1q-vc-map, on page 143
• cable dot1q-vc-map port-channel, on page 146
• cable downstream annex, on page 147
• cable downstream attribute-mask, on page 149
• cable downstream channel-id, on page 150
• cable downstream-channel-id automatic, on page 152
• cable downstream controller-profile, on page 153
• cable downstream description, on page 154
• cable downstream dsg, on page 155
• cable downstream dsg chan-list, on page 156
• cable downstream dsg dcd-enable, on page 158
• cable downstream dsg disable, on page 160

Cisco CMTS Cable Command Reference

105
 Cable Commands: cable d

• cable downstream dsg rule, on page 161

• cable downstream dsg tg, on page 163
• cable downstream dsg tg channel, on page 165
• cable downstream dsg timer, on page 167
• cable downstream dsg vendor-param, on page 169
• cable downstream freq-profile, on page 171
• cable downstream frequency, on page 172
• cable downstream if-output, on page 175
• cable downstream interleave-depth, on page 177
• cable downstream modulation, on page 179
• cable downstream ofdm-chan-profile, on page 181
• cable downstream ofdm-flow-to-profile, on page 183
• cable downstream ofdm-modulation-profile, on page 185
• cable downstream ofdm-power-profile, on page 186
• cable downstream ofdm-prof-mgmt exempt-sc-pct, on page 188
• cable downstream ofdm-prof-mgmt mer-margin-qdb, on page 189
• cable downstream ofdm-prof-mgmt prof-dwngrd-auto, on page 190
• cable downstream ofdm-prof-mgmt prof-order-method, on page 191
• cable downstream ofdm-prof-mgmt prof-upgrade-pma, on page 192
• cable downstream ofdm-prof-mgmt recommend-profile-age, on page 193
• cable downstream ofdm-prof-mgmt rxmer-poll-interval, on page 194
• cable downstream ofdm-prof-mgmt unfit-profile-age, on page 195
• cable downstream override, on page 197
• cable downstream power-down-2nd-module, on page 199
• cable downstream qam-profile, on page 200
• cable downstream qos wfq weight, on page 201
• cable downstream rate-limit, on page 203
• cable downstream rf-power, on page 206
• cable downstream rf-shutdown, on page 209
• cable ds-high-low-rate-ratio, on page 212
• cable ds-max-burst, on page 213
• cable ds-resiliency, on page 216
• cable dsg, on page 217
• cable dsg cfr, on page 221
• cable dsg chan-list, on page 224
• cable dsg client-list, on page 226
• cable dsg keepalive, on page 228
• cable dsg name-update-interval, on page 230
• cable dsg tg, on page 231
• cable dsg tg channel, on page 233
• cable dsg tg channel ucid, on page 235
• cable dsg tg channel vendor-param, on page 237
• cable dsg tg default-priority, on page 239
• cable dsg tg priority, on page 240
• cable dsg timer, on page 241
• cable dsg tunnel, on page 243

Cisco CMTS Cable Command Reference

106
Cable Commands: cable d

• cable dsg tunnel srv-class, on page 245

• cable dsg vendor-param, on page 247
• cable dynamic-bonding-group, on page 249
• cable dynamic-bw-sharing, on page 251
• cable dynamic-flow vrf, on page 253
• cable dynamic-qos trace, on page 254
• cable dynamic-secret, on page 255
• cable dynamic-secret exclude, on page 263
• cable dynamic-secret tftp insert-upgrade-server, on page 265

Cisco CMTS Cable Command Reference

107
 Cable Commands: cable d
cable d31-mode

cable d31-mode
To enable the DOCSIS 3.1 mode on a MAC domain, use the cable d31-mode command in the interface
configuration mode. To disable the DOCSIS 3.1 mode, use the no form of the command.

[no] cable d31-mode

This command has no keywords or arguments.

Command Default DOCSIS 3.1 mode is enabled.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Enabling the DOCSIS 3.1 mode has the following effects:
• MDDs advertise the MAC domain as DOCSIS 3.1 capable.
• DOCSIS 3.1 protocol support is enabled for the MAC domain, including:
• v5 Ranging support
• D3.1 TLV parsing
• D3.1 MMMs

• OFDM channels are included in MD-SG calculations assuming that they are a member of an associated
fiber node.
• OFDM channels are allowed to become active primary-capable downstream channels within the MAC
domain.

The following example shows how to enable DOCSIS 3.1 mode:

router#configure terminal
router(config)#interface c3/0/0
router(config-if)#cable d31-mode

Related Commands Command Description

cable mtc-mode Enables Multiple Transmit Channel mode for the MAC domain. For
d31-mode to be active, mtc-mode must also be configured.

cable mrc-mode Enables Multiple Receive Channel mode for the MAC domain. For
d31-mode to be active, mrc-mode must also be configured.

Cisco CMTS Cable Command Reference

108
Cable Commands: cable d
cable d31-mode

Command Description

show interface Cable Displays the status of the controller, including the d31-mode
slot/subslot/port controller enablement state.

Cisco CMTS Cable Command Reference

109
 Cable Commands: cable d
cable d40-mode

cable d40-mode
To enable the DOCSIS 4.0 mode on a MAC domain, use the cable d40-mode command in the interface
configuration mode. To disable the DOCSIS 4.0 mode, use the no form of the command.

cable d40-mode

no cable d40-mode
This command has no keywords or arguments.

Command Default DOCSIS 4.0 mode is enabled.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

Cisco IOS XE Dublin This command was introduced on the Cisco cBR Series Converged Broadband
17.12.1z Routers.

Usage Guidelines Enabling the DOCSIS 4.0 mode has the following effects:
• MDDs advertise the MAC domain as DOCSIS 4.0 capable.
• DOCSIS 4.0 protocol support is enabled for the MAC domain, including:
• D4.0 TLV parsing
• D4.0 MMMs

• OFDM channels are included in MD-SG calculations assuming that they are a member of an associated
fiber node.
• OFDM channels are allowed to become active primary-capable downstream channels within the MAC
domain.

The following example shows how to enable DOCSIS 4.0 mode:

router#configure terminal
router(config)#interface c4/0/0
router(config-if)#cable d40-mode

Related Commands Command Description

cable To enable the DOCSIS 3.1 mode on a MAC domain, use the cable d31-mode command
d31-mode in the interface configuration mode.

Cisco CMTS Cable Command Reference

110
 Cable Commands: cable d
cable dci-response

cable dci-response
To configure how a cable interface responds to DCI-REQ messages for CMs on that interface, use the cable
dci-response command in cable interface configuration mode.

cable dci-response [success | ignore | reject permanent | reject temporary]

Syntax Description success (Optional) Configures the interface so that the Cisco CMTS responds to DCI-REQ
messages from CMs on the interface by sending a DCI-RSP response with the confirmation
code of Success (0).

ignore (Optional) Configures the interface so that the Cisco CMTS ignores DCI-REQ messages
from CMs on the interface. It does not send any DCI-RSP responses.

reject permanent (Optional) Configures the interface so that the Cisco CMTS responds to DCI-REQ
messages from CMs on the interface by sending a DCI-RSP response with the confirmation
code of Reject Permanent (4).

reject temporary (Optional) Configures the interface so that the Cisco CMTS ignores the first four DCI-REQ
messages from a CM on the interface, but on the fifth DCI-REQ message, the CMTS
responds with a DCI-RSP response with the confirmation code of Reject Temporary (3).
The CMTS then continues to ignore the next seven DCI-REQ messages and then restarts
this process when it receives the twelfth DCI-REQ message.

Command Default The Cisco CMTS router responds to DCI-REQ messages from all CMs by sending a DCI-RSP response with
the confirmation code of Success (0).

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Description

12.1(4)CX This command was introduced for DOCSIS 1.1 operation.

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

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The Device Class Identification (DCI) messages are part of the Media Access Control Specification section
of the DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above). A CM can optionally use the
DCI-REQ message to inform the CMTS router of certain capabilities, such as whether it is a CPE-controlled
cable modem (CCCM).
The CMTS router then responds with one of the following confirmation codes:
• Success—Allows the CM to continue with the registration process.

Cisco CMTS Cable Command Reference

111
 Cable Commands: cable d
cable dci-response

• Reject Permanent—Instructs the CM to cancel its registration process on this downstream channel. The
CM must try all other available downstream channels before attempting to register on this downstream
channel again.
• Reject Temporary—Instructs the CM to reset its DCI-REQ counter, to send another DCI-REQ message,
and to wait for the DCI-RSP before proceeding with the registration process.

Note The CMTS router also can respond with an Upstream Transmitter Disable (UP-DIS) message. See the
description of the cable dci-upstream-disable command for details.

Examples The following example shows how to configure the CMTS router so that it ignores all DCI-REQ
messages from CMs on the cable interface at slot 6:

Router# configure terminal

Router(config)# interface c6/0
Router(config-if)# cable dci-response ignore

The following example shows how to configure the CMTS router so that it returns to its default
behavior for the cable interface on slot 6, which is to respond to all DCI-REQ messages from CMs
by sending a DCI-RSP with a Success confirmation code:

Router# configure terminal

Router(config)# interface c6/0
Router(config-if)# cable dci-response success

Note The cable dci-response success command does not appear in a startup or running configuration file,
because it is the default configuration for a cable interface.

Related Commands Command Description

cable dci-upstream-disable Configures the cable interface so that it transmits an Upstream Transmitter
Disable (UP-DIS) message instead of a DCI-RSP message to a particular CM.

debug cable dci Enables debugging of DCI-REQ, DCI-RSP, and UP-DIS messages.

Cisco CMTS Cable Command Reference

112
 Cable Commands: cable d
cable dci-upstream-disable

cable dci-upstream-disable
To configure a cable interface so that it transmits a DOCSIS 1.1 Upstream Transmitter Disable (UP-DIS)
message to a particular CM, use the cable dci-upstream-disable command in cable interface configuration
mode. To remove that configuration and return to the default configuration, use the no form of this command.

cable dci-upstream-disable mac-address [enable | disable]

no cable dci-upstream-disable mac-address [enable | disable]

Syntax Description mac-address Specifies the MAC physical layer address for a particular CM.

enable (Optional) Enables the UP-DIS message for the particular CM, so that when the CM sends a
DCI-REQ message, the CMTS router responds by sending an UP-DIS response.

disable (Optional) Disables the sending of UP-DIS messages to a particular CM.

Command Default The Cisco CMTS router does not transmit UP-DIS messages to any CMs.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Description

12.1(4)CX This command was introduced for DOCSIS 1.1 operation.

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

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above) allows a CMTS router to transmit
an Upstream Transmitter Disable (UP-DIS) message to a CM. If the CM supports the UP-DIS message, it
responds by immediately disabling its upstream transmitter circuitry. The CM must be power-cycled before
it can begin transmitting on the upstream again.

Examples The following example shows the cable dci-upstream-disable command being used to enable the
UP-DIS message for the CM with the MAC address of 0123.4567.89ab.

Router# configure terminal

Router(config)# interface c6/0
Router(config-if)# cable dci-upstream-disable 0123.4567.89ab enable
Router(config-if)# exit
Router(config)# exit

Cisco CMTS Cable Command Reference

113
 Cable Commands: cable d
cable dci-upstream-disable

Related Commands Command Description

cable dci-response Configures how the cable interface responds to DCI-REQ messages from CMs on that
interface.

debug cable dci Enables debugging of DCI-REQ, DCI-RSP, and UP-DIS messages.

Cisco CMTS Cable Command Reference

114
 Cable Commands: cable d
cable def-phy-burst

cable def-phy-burst
To specify a value for the upstream Maximum Traffic Burst parameter for CMs that do not specify their own
value, use the cable def-phy-burst command in controller configuration mode. To reset the maximum burst
size to its default, use the no form of this command.

cable def-phy-burst burst-size

no cable def-phy-burst

Syntax Description burst-size Specifies the maximum number of bytes that are allowed in a burst. The valid range is 0 to 4096
bytes, with a default of 2000 bytes. A value of 0 specifies that CMs cannot register unless they
specify a valid burst size.

Command Default 2000 bytes

Command Modes Controller configuration—upstream-cable only (config-controller)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.
This command replaces the cable default-phy-burst command.

Usage Guidelines

Note The cable def-phy-burst command applies to cable modems that cannot perform fragmentation. The value
specified by the cable def-phy-burst command is used to determine the maximum total frame burst size
supported for a cable modem request. In contrast, the cable upstream fragment-force command may be
used to determine the largest single physical burst a cable modem can transmit, when the cable modem supports
fragmentation.

The DOCSIS 1.0 specification allows CMs to register without specifying a maximum upstream burst size, or
to register with a value of 0, which means an unlimited burst size. This behavior can interfere with DOCSIS
1.1 networks because excessively large bursts on an upstream will generate unpredictable jitter and delay in
voice calls. DOCSIS 1.1 CMs can also cause this problem if they register without enabling fragmentation of
packets at the DOCSIS MAC layer.
This command allows you to specify a default burst size for CMs that register without specifying a burst size
or that register with a burst size of 0. It also specifies the maximum size of long data grants if a CM specifies
a size of 0 (unlimited) in the Upstream Channel Descriptor (UCD) packet. If a CM specifies a long data grant
that would exceed the maximum burst size, and the CM is not using DOCSIS concatenation, the DOCSIS
scheduler drops the bandwidth request.
To prevent CMs from registering without defining a burst profile, use this command with a burst-size of zero.
CMs that do not define a burst profile will not be allowed to register and come online.

Cisco CMTS Cable Command Reference

115
 Cable Commands: cable d
cable def-phy-burst

Note Typically, DOCSIS 1.1 CMs set the maximum upstream transmit burst size to the larger value of 1522 bytes
and maximum concatenated burst size (which can be a maximum of 4096 bytes).

The default PHY burst parameter interacts with two other parameters that are configured in the DOCSIS
configuration file:
• DOCSIS 1.1 configuration files can also specify a value for the maximum concatenation burst, which
has a default of 1522 bytes. If this parameter is greater than the default PHY burst size, the CM can
override the default PHY burst when it is using concatenation.
• DOCSIS 1.0 and 1.1 configuration files can also specify a maximum transmit burst size. In DOCSIS 1.1
configurations, this parameter defaults to 3044 bytes, with a minimum of 1522 bytes. DOCSIS 1.0
configuration files could set this parameter to a value lower than 1522 bytes, depending on what version
of the DOCSIS 1.0 specification they support. The CMTS router will enforce the lower limit between
the default phy burst and the maximum transmit burst, so you should ensure that all configuration files
in your network specify a minimum of 1522 bytes for the maximum transmit burst size.

Example
The following example shows how to set the default maximum burst size to 1 on a Cisco cBR-8
router:
Router(config)# controller upstream-Cable 3/0/1
Router(config-controller)# cable def-phy-burst 1

Related Commands Command Description

cable upstream fragmentation Enables fragmentation of DOCSIS frames on a particular upstream.

cable upstream fragment-force Specifies that a cable interface line card should fragment DOCSIS frames
on an upstream when the frame exceeds a particular size.

show cable modem Displays information for the registered and unregistered CMs, including
the QoS configuration for individual CMs.

show controllers cable Displays the downstream MPEG framing format (Annex A or Annex B)
setting.

Cisco CMTS Cable Command Reference

116
 Cable Commands: cable d
cable default-phy-burst

cable default-phy-burst
To specify a value for the upstream Maximum Traffic Burst parameter for CMs that do not specify their own
value, use the cable default-phy-burst command in cable interface configuration mode. To reset the maximum
burst size to its default, use the no form of this command.

cable default-phy-burst burst-size

no cable default-phy-burst

Syntax Description burst-size Specifies the maximum number of bytes that are allowed in a burst. The valid range is 0 to 4096
bytes, with a default of 2000 bytes. A value of 0 specifies that CMs cannot register unless they
specify a valid burst size.

Command Default 2000 bytes

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.2(8)BC1 This command was introduced for the Cisco uBR7100 series, Cisco uBR7200 series, and
Cisco uBR10012 routers.

12.2(15)BC2 The cable upstream fragment-force command is introduced, with considerations to the
cable defaut-phy-burst command.
The maximum upstream traffic burst may also be influenced by the new cable upstream
fragment-force command for cable modems that are able to perform fragmentation.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was replaced by the cable def-phy-burst command on the Cisco cBR
Series Converged Broadband Routers.

Usage Guidelines

Note The cable default-phy-burst command applies to cable modems that cannot perform fragmentation. The
value specified by the cable default-phy-burst command is used to determine the maximum total frame burst
size supported for a cable modem request. In contrast, the cable upstream fragment-force command may
be used to determine the largest single physical burst a cable modem can transmit, when the cable modem
supports fragmentation.

The DOCSIS 1.0 specification allows CMs to register without specifying a maximum upstream burst size, or
to register with a value of 0, which means an unlimited burst size. This behavior can interfere with DOCSIS
1.1 networks because excessively large bursts on an upstream will generate unpredictable jitter and delay in

Cisco CMTS Cable Command Reference

117
 Cable Commands: cable d
cable default-phy-burst

voice calls. DOCSIS 1.1 CMs can also cause this problem if they register without enabling fragmentation of
packets at the DOCSIS MAC layer.
This command allows you to specify a default burst size for CMs that register without specifying a burst size
or that register with a burst size of 0. It also specifies the maximum size of long data grants if a CM specifies
a size of 0 (unlimited) in the Upstream Channel Descriptor (UCD) packet. If a CM specifies a long data grant
that would exceed the maximum burst size, and the CM is not using DOCSIS concatenation, the DOCSIS
scheduler drops the bandwidth request.
To prevent CMs from registering without defining a burst profile, use this command with a burst-size of zero.
CMs that do not define a burst profile will not be allowed to register and come online.

Note Typically, DOCSIS 1.1 CMs set the maximum upstream transmit burst size to the larger value of 1522 bytes
and maximum concatenated burst size (which can be a maximum of 4096 bytes).

The default PHY burst parameter interacts with two other parameters that are configured in the DOCSIS
configuration file:
• DOCSIS 1.1 configuration files can also specify a value for the maximum concatenation burst, which
has a default of 1522 bytes. If this parameter is greater than the default PHY burst size, the CM can
override the default PHY burst when it is using concatenation.
• DOCSIS 1.0 and 1.1 configuration files can also specify a maximum transmit burst size. In DOCSIS 1.1
configurations, this parameter defaults to 3044 bytes, with a minimum of 1522 bytes. DOCSIS 1.0
configuration files could set this parameter to a value lower than 1522 bytes, depending on what version
of the DOCSIS 1.0 specification they support. The CMTS router will enforce the lower limit between
the default phy burst and the maximum transmit burst, so you should ensure that all configuration files
in your network specify a minimum of 1522 bytes for the maximum transmit burst size.

Examples The following example shows the default maximum burst size to 1522 bytes, which is the minimum
size required by the DOCSIS 1.1 specification:

Router(config)# interface cable 5/1

Router(config-if)# cable default-phy-burst 1522

The following example shows the default maximum burst size to 0, which means that a CM must
specify a valid burst profile before the Cisco CMTS allows it to register and come online:

Router(config)# interface cable 5/1

Router(config-if)# cable default-phy-burst 0

The following example shows the default maximum burst size being reset to its default of 2000 bytes:

Router(config)# interface cable 5/1

Router(config-if)# no cable default-phy-burst

Cisco CMTS Cable Command Reference

118
 Cable Commands: cable d
cable default-phy-burst

Related Commands Command Description

cable upstream fragmentation Enables fragmentation of DOCSIS frames on a particular upstream.

cable upstream fragment-force Specifies that a cable interface line card should fragment DOCSIS frames
on an upstream when the frame exceeds a particular size.

show cable modem Displays information for the registered and unregistered CMs, including
the QoS configuration for individual CMs.

show controllers cable Displays the downstream MPEG framing format (Annex A or Annex B)
setting.

Cisco CMTS Cable Command Reference

119
 Cable Commands: cable d
cable depi multicast pool

cable depi multicast pool

To configure the DEPI multicast pool for downstream virtual splitting, use the cable depi multicast pool
command in global configuration mode. To void the DEPI multicast pool configuration, use the no form of
this command.

cable depi multicast pool id

no cable depi multicast pool id

Syntax Description id Specifies the ID of the DEPI multicast pool.

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the DEPI multicast pool.

The following example shows how to configure the DEPI multicast pool:
Router# configure terminal
Router(config)# cable depi multicast pool 1
Router(config-multicast-pool)#

Related Commands Command Description

ip address Specifies IP address range for multicast pool.

Cisco CMTS Cable Command Reference

120
 Cable Commands: cable d
cable depi multicast pool redundant include-video-controller

cable depi multicast pool redundant include-video-controller

To configure the DEPI multicast pool for downstream virtual splitting, use the cable depi multicast pool id
[redundant include-video-controller] command in global configuration mode. To void the DEPI multicast
pool configuration, use the no form of this command.

cable depi multicast pool id [ redundant [ include-video-controller ] ]

no cable depi multicast pool id [ redundant [ include-video-controller ] ]

Syntax Description id Specifies the ID of the DEPI multicast pool.

redundant Redundant multicast pool for secondary Linecard Downstream Controller.

redundant IP assignment for redundant(stand-by) controllers including video

include-video-controller controllers if supported by CBR-CCAP-LC-G2-R Linecard.

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This command is introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines • If you configure cable depi multicast pool 10 redundant, then multicast IPs is assigned only to
downstream-cable controllers.
• If you configure cable depi multicast pool 10 redundant include-video-controller, then
multicast IPs are assigned for both downstream-cable and downstream-video controllers
CBR-CCAP-LC-G2-R Linecards.

If video controllers are not supported by CBR-CCAP-LC-40G Linecards, then IPs are assigned only to
downstream-cable controllers. The total redundant pool is set up by the system and allocates IP addresses for
all possible controllers multiplied by the number of interfaces available.

The following example shows how to configure redundant include-video-controller:

Router# configure terminal

Router(config)# cable depi multicast pool 10
Router(config-multicast-pool)# redundant include-video-controller
Router(config-multicast-pool)#

The following example shows the difference between redundant and redundant
include-video-controller configurations:

• If you use the redundant config, then the total controllers = 16 DOCSIS(x interfaces) + 20
OOB.

Cisco CMTS Cable Command Reference

121
 Cable Commands: cable d
cable depi multicast pool redundant include-video-controller

• If you use the redundant include-video-controller config, then the total controllers = 16
DOCSIS(x interfaces) + 16 VIDEO(x interfaces) + 20 OOB

For Example, If Linecard ‘0’ is secondary, then IP is allocated to downstream-cable and

downstream-video controllers as shown below:
• The following allocations are only applicable to CBR-CCAP-LC-40G and CBR-CCAP-LC-G2-R
Linecards prior to Cisco IOS XE Bengaluru 17.6.1z:
• If Linkha is enabled and redundant is configured as 16(x4) + 20 = 84 IPs, then the IPs are
assigned to the following controllers:

Controllers Interfaces

DS0/0/0 to DS0/0/15 Te0/1/0 and Te0/1/2

DS0/0/16 to DS0/0/31 Te0/1/4 and Te0/1/6

• If Linkha is disabled and redundant is configured as 16(x8) + 20 = 148 IPs, then the IPs
are assigned to the following controllers:

Controllers Interfaces

DS0/0/0 to DS0/0/15 Te0/1/0, Te0/1/1, Te0/1/2, Te0/1/3

DS0/0/16 to DS0/0/31 Te0/1/4, Te0/1/5, Te0/1/6, Te0/1/7

• If Linkha is enabled and redundant include-video-controller is configured as 16(x4)

+ 16(x4) + 20 = 148 IPs, then the IPs are assigned to the following controllers:

Controllers Interfaces

DS0/0/0 to DS0/0/15 Te0/1/0 and Te0/1/2

DS0/0/16 to DS0/0/31 Te0/1/4 and Te0/1/6

VID0/0/0 to VID0/0/15 Te0/1/0 and Te0/1/2

VID0/0/16 to VID0/0/31 Te0/1/4 and Te0/1/6

• If Linkha is disabled and redundant include-video-controller is configured as 16(x8)

+ 16(x8) + 20 = 276 IPs, then the IPs are assigned to the following controllers:

Controllers Interfaces

DS0/0/0 to DS0/0/15 Te0/1/0, Te0/1/1, Te0/1/2, Te0/1/3

DS0/0/16 to DS0/0/31 Te0/1/4, Te0/1/5, Te0/1/6, Te0/1/7

VID0/0/0 to VID0/0/15 Te0/1/0, Te0/1/1, Te0/1/2, Te0/1/3

VID0/0/16 to VID0/0/31 Te0/1/4, Te0/1/5, Te0/1/6, Te0/1/7

Cisco CMTS Cable Command Reference

122
 Cable Commands: cable d
cable depi multicast pool redundant include-video-controller

• The following allocations are only applicable to CBR-CCAP-LC-G2-R cards for Cisco IOS XE
Bengaluru 17.6.1z and later.
If Linkha is disabled and redundant include-video-controller is configured as 16(x8) +
16(x8) + 20 = 276 IPs, then the IPs are assigned to the following controllers:

Controllers Interfaces
DS0/0/0 to DS0/0/7 Te0/1/0, Te0/1/1

DS0/0/8 to DS0/0/15 Te0/1/2, Te0/1/3

DS0/0/16 to DS0/0/23 Te0/1/4, Te0/1/5

DS0/0/24 to DS0/0/31 Te0/1/6, Te0/1/7

VID0/0/0 to VID0/0/7 Te0/1/0, Te0/1/1

VID0/0/8 to VID0/0/15 Te0/1/2, Te0/1/3

VID0/0/16 to VID0/0/23 Te0/1/4, Te0/1/5

VID0/0/24 to VID0/0/31 Te0/1/6, Te0/1/7

Related Commands Command Description

cable depi multicast pool Specifies the ID of the DEPI multicast pool.

Cisco CMTS Cable Command Reference

123
 Cable Commands: cable d
cable depi multicast statistic monitor

cable depi multicast statistic monitor

This feature enables you to view statistics for the multicast group assigned by DEPI multicast pool. You can
enable this feature using the cable depi multicast statistic monitor command. Use this command for docsis,
bcast and ncast video configurations. OOB configuration is not supported. To void the configuration, use the
no form of this command.

cable depi multicast statistic monitor

no cable depi multicast statistic monitor

Syntax Description monitor Enable monitor multicast DEPI throughput.

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This command is introduced for the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use this command to view statistics for the multicast group assigned by DEPI multicast pool.

The following example shows how to configure the cable depi multicast statistic monitor command:
Router# configure terminal
Router(config)# cable depi multicast statistic monitor
Router(config)#

After configuring the command, you can verify your configuration using the following command:

Router# show cable depi multicast counter

IP POOL ID pps bps IF
Controller
225.225.225.0 1 4686 39335848 Te3/1/0
DS3/0/1

Related Commands Command Description

cable rphy statistics session update-freq Specifies the DEPI statistics synchronization interval
in units of 5 seconds

Cisco CMTS Cable Command Reference

124
 Cable Commands: cable d
cable device

cable device
To configure an access list for a cable modem (CM) device or host on the Cisco CMTS router, use the cable
device command in privileged EXEC mode. To remove an access group, use the no access-group option of
this command.

cable device { {ip-addressmac-address} [no] access-group {access-listaccess-name} | [vrf vrf-name]

ip-address [no] access-group [access-listaccess-name]}

Syntax Description ip-address IP address of the CM device or host.

mac-address MAC address of the CM device or host.

access-group Enables access-group options. The no form removes access-group

specifications.

{access-list | access-name} Specifies the IP access list (standard or extended), either by access-list number
(1 to 199) or by access-list name.

vrf vrf-name Specifies a virtual routing and forwarding (VRF) instance that is populated with
VPN routes.
• vrf-name—Name of the VRF instance

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Description

12.1 This command was moved from earlier releases.

12.1(1a)T1 The vrf keyword was added for Multiprotocol Label Switching (MPLS) VPN support.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines For the vrf keyword of this command, only the ip-address option is supported.
An access list can be configured to deny access to any IP address other than the ones previously configured,
using the access-list access-list deny any any command. Starting with Cisco IOS Release 12.2(33)SCD,
when a CM is added to such an access list on the Cisco uBR7200 series universal broadband routers, the ping
fails. If the CM is reset, removed, or powered off, the ping succeeds after the CM comes online. However,
the show cable modem access-group command displays that the CM does not belong to the access-group.

Cisco CMTS Cable Command Reference

125
 Cable Commands: cable d
cable device

Note The cable device command is not supported on the Cisco uBR10012 universal broadband router.

Note The vrf keyword is not supported in Cisco IOS Releases 12.0 SC, 12.1 EC, and 12.2 BC.

Examples The following example shows how to assign an access list to the MAC address of a cable device:

Router# configure terminal

Router(config)# cable device 0010.7b6b.77ed acc 1

Router(config)# exit

Related Commands Command Description

clear cable host Clears the host from the internal address tables of the Cisco CMTS router.

cable host access-group Configures the access list for the specified hosts on the Cisco CMTS
router.

show cable device access-group Displays CMs and hosts behind the CMs on the network on the Cisco
CMTS router.

show cable host access-group Displays hosts behind the CMs on the network on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

126
 Cable Commands: cable d
cable dfo-retry-count

cable dfo-retry-count
To configure the Downstream Frequency Override (DFO) retry count, use the cable dfo-retry-count command
in global configuration mode. To reset the DFO retry count to its default value, use the no form of this
command.

cable dfo-retry-count n
no cable dfo-retry-count n

Syntax Description n Downstream frequency override retry count. The valid range is from 1 to 100.

Command Default The DFO retry count is 20 on the Cisco uBR10012 and Cisco uBR7200 series routers.
The DFO retry count is 5 on the Cisco cBR series routers.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD7 This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The Downstream Frequency Override (DFO) feature enables cable modems to register on a specific primary
RF channel. Because of RF failure conditions and some cable modem types, the cable modem takes more
time to register on a specific primary RF channel. You can configure the DFO retry count to reduce the cable
modem registration time using the cable dfo-retry-count command.

Examples The following example shows how to configure the DFO retry count as 10:

Router# configure terminal

Router(config)# cable dfo-retry-count 10

Related Commands Command Description

cable service attribute ds-bonded Forces a downstream bonding-capable modem to initialize

downstream-type bonding-enabled on a bonded primary-capable downstream channel.

cable service attribute non-ds-bonded Forces the non-bonding-capable modems to register only
downstream-type bonding-disabled on non-bonded RF channels on the CMTS.

cable service type ds-frequency Redirects matching service types to the downstream
frequency.

Cisco CMTS Cable Command Reference

127
 Cable Commands: cable d
cable dhcp ipv4 profile

cable dhcp ipv4 profile

To enter the IPv4 DHCP profile configuration mode, use the cable dhcp ipv4 profile command in global
configuration mode. To remove the configured profile, use the no form of this command.

cable dhcp ipv4 profile name

no cable dhcp ipv4 profile name

Syntax Description name Specifies the name of the IPv4 DHCP profile.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

IOS XE Fuji 16.8.1 This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to enter the IPv4 DHCP profile configuration mode:

Router# configure terminal

Router(config)# cable dhcp ipv4 profile DEVICE1

Router(config-dhcpv4-profile)#

Related Commands Command Description

match Specifies the matching option for the IPv4 DHCP profile.

Cisco CMTS Cable Command Reference

128
 Cable Commands: cable d
cable dhcp-giaddr

cable dhcp-giaddr
To modify the GIADDR field for the DHCPDISCOVER and DHCPREQUEST packets with a relay IP address
before they are forwarded to the DHCP server, use the cable dhcp-giaddr command in cable interface or
subinterface configuration mode. To set the GIADDR field to its default, use the no form of this command.

cable dhcp-giaddr {policy [strict | host | mta | ps | stb | profile name ] giaddr | primary}
no cable dhcp-giaddr

Syntax Description policy Selects the control policy, so that the primary address is used for cable modems and the
secondary addresses are used for hosts and other customer premises equipment (CPE) devices.
This setting is typically used when the CMs on the interface are configured for routing, so that
the CMs and hosts can use IP addresses on different subnets.

strict (Optional, only when the policy keyword is specified) Selects the GIADDR IP address as the
source IP address in the forwarded DHCPOFFER packet.
By default when using the policy option, the Cisco CMTS changes the source IP address in
the DHCPOFFER packet to match that of the primary address on the cable interface. Enable
the strict option to prevent this behavior, which could interfere with any access lists applied
to the CM when the CM is using a different subnet from the primary address space of the cable
interface.

host Specifies the GIADDR for hosts.

mta Specifies the GIADDR for media terminal adapters (MTA).

ps Specifies the GIADDR for portal servers (PS).

stb Specifies the GIADDR for set-top boxes (STB).

profile Specifies DHCP profile as control policy.

name

giaddr IP addresses of the secondary interface of the bundle interface.

primary Selects the primary address always to be used for the GIADDR field for both CMs and CPE
devices. This option is typically used for the Cisco uBR-MC16E card and Cisco uBR7100E
series routers to support EuroDOCSIS operations.

Command Default None

Command Modes
Interface configuration (config-if)

Subinterface configuration (config-subif)

Command History Release Modification

12.0(4)T This command was introduced.

Cisco CMTS Cable Command Reference

129
 Cable Commands: cable d
cable dhcp-giaddr

Release Modification

12.0(6)SC This command was integrated into Cisco IOS Release 12.0(6)SC.

12.1(2)EC1 This command was integrated into Cisco IOS Release 12.1(2)EC1.

12.1(3a)EC This command was modified to support subinterfacess.

12.2(15)BC2 This command was modified to include the strict option.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. This command was
modified to support the Cisco uBR7225VXR router.

12.2(33)SCD5 This command was modified to support the host, mta, ps, and stb keywords.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji Thiscommand was modified to add the profile keyword.

16.8.1

Usage Guidelines You can use this command to modify the GIADDR field of DHCPDISCOVER and DHCPREQUEST packets
to provide a relay IP address before packets are forwarded to the DHCP servers. Use this command to set a
policy option such that primary addresses are used for CMs and secondary addresses are used for hosts (such
as PCs) behind the CMs.
When using multiple secondary subnets, the Cisco CMTS router uses the first secondary IP address as the
GIADDR field when forwarding a DHCPDISCOVER request to the DHCP server. If no DHCP server responds
with a DHCPOFFER message after three attempts, the Cisco CMTS router uses the next secondary IP address,
up to a maximum of 16 secondary addresses.

Note If you have configured a Cisco CM for routing mode and are also using the cable-modem dhcp-prox nat
command on the CM, you must configure the corresponding cable interface on the Cisco CMTS using the
cable dhcp-giaddr policy strict] command.

Caution You cannot use the strict option with the internal DHCP server that is onboard the Cisco CMTS router,
because the strict option requires the use of DHCP relay operation, which is not performed by DHCP
termination points such as the internal DHCP server.

Note For cBR Series Converged Broadband Routers, internal DHCP server is not supported.

Examples The following example shows how to set the primary address to be used always for GIADDR:

Router# configure terminal

Cisco CMTS Cable Command Reference

130
 Cable Commands: cable d
cable dhcp-giaddr

Router(config)# interface cable 3/0

Router(config-if)# cable dhcp-giaddr primary

The following example shows how to set the primary address to be used always for GIADDR in the
cable subinterface mode:

Router# configure terminal

Router(config)# interface cable 6/0.1

Router(config-subif)# cable dhcp-giaddr primary

The following example shows how to configure the router so that the primary address is used for
CMs and the secondary addresses are used for hosts. In addition, the GIADDR is used as the source
IP address in forwarded DHCPOFFER packets.

Router# configure terminal

Router(config)# interface cable 5/1/0

Router(config-if)# cable dhcp-giaddr policy strict

The following example shows how to configure the router so that the CPE device (in this case, the
MTA) uses a specific secondary interface:

Router# configure terminal

Router(config)# interface bundle 25
Router(config-if)# cable dhcp-giaddr mta 172.10.10.1

The following example shows how to specify DHCP profile as control policy:

Router# configure terminal

Router(config)# interface bundle 2
Router(config-if)# cable dhcp-giaddr policy profile DEVICE1 2.2.1.1

Related Commands Command Description

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

cable relay-agent-option Enables the system to insert the CM MAC address into a DHCP
packet received from a CM or host, and forward the packet to a
DHCP server.

cable source-verify Enables CM upstream verification.

cable telco-return spd Enforces the telco-return CM to use a specific DHCP server.
dhcp-authenticate

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

debug cable dhcp Enables debugging of the DHCP when it is used on the cable
interface.

Cisco CMTS Cable Command Reference

131
 Cable Commands: cable d
cable dhcp-giaddr

Command Description

debug cable mac-address Enables debugging of the MAC address on the cable interface.

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

ip dhcp smart-relay Monitors client retransmissions when address pool depletion occurs.

Cisco CMTS Cable Command Reference

132
 Cable Commands: cable d
cable dhcp-insert

cable dhcp-insert
To configure the Cisco CMTS router to insert descriptors into DHCP packets using option 82, use the cable
dhcp-insert command in global configuration mode. To remove this configuration, use the no form of this
command.

cable dhcp-insert {downstream-description | hostname | service-class | upstream-description}

Syntax Description downstream-description Appends received DHCP packets with downstream port descriptors.

hostname Appends received DHCP packets with router host names.

service-class Appends received DHCP packets with router service class.

upstream-description Appends received DHCP packets with upstream port descriptors.

Command Default This configuration is disabled by default.

Command Modes
Interface configuration (config-if) and bundle interface configuration.

Command History Release Modification

12.3(21)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.

12.2(33)SCF2 This command was modified. The service-class keyword was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable dhcp-insert command is used to configure the following feature:
DHCP, ToD, and TFTP Services for the CMTS Routers
This feature enhances the DHCP security potential and the Cable Duplicate MAC Address Feature on the
Cisco CMTS router.
The cable dhcp-insert command specifies which descriptors to append to DHCP packets. The DHCP servers
can then detect cable modem clones and extract geographical information.

Note Multiple types of descriptor strings can be configured as long as the maximum relay information option size
is not exceeded.

The Cisco CMTS router can use the DHCP Relay Agent Information option (DHCP option 82) to send
particular information about a cable modem, such as its MAC address and the cable interface to which it is
connected. If the DHCP server cannot match the information with that belonging to a cable modem in its

Cisco CMTS Cable Command Reference

133
 Cable Commands: cable d
cable dhcp-insert

database, the Cisco CMTS router identifies that the device is a CPE device. This allows the Cisco CMTS
router and DHCP server to retain accurate information about which CPE devices are using which cable modems
and whether the devices should be allowed network access.
The DHCP Relay Agent can also be used to identify cloned modems or gather geographical information for
E911 and other applications. Using the cable dhcp-insert command, configure the Cisco CMTS router to
insert downstream, upstream, hostname, or service class descriptors into DHCP packets. A DHCP server can
utilize such information to determine service levels available to the host specific to the provisioned subscriber.

Note To use the service-class option, the service class name specified in the CM configuration file must be configured
on the Cisco CMTS. The ip dhcp relay information option-insert command should be configured on the
bundle interface to insert the service-class option into the DHCP DISCOVER messages.

Examples The following example shows how to insert descriptors into DHCP packets. The DHCP server can
then use these descriptors to identify cable modem clones and extract geographical information.

Router(dhcp-config)# cable dhcp-insert service-class

Related Commands Command Description

ip dhcp relay information option-insert Enables the system to insert a DHCP Relay Agent option in
forwarded BOOTREQUEST messages to a DHCP server.

cable ipv6 dhcp-insert Enables the system to insert descriptors into DHCPv6 packets.

Cisco CMTS Cable Command Reference

134
 Cable Commands: cable d
cable dhcp-parse option

cable dhcp-parse option

To enable parsing of Dynamic Host Configuration Protocol (DHCP) options, use the cable dhcp-parse option
command in cable interface configuration mode. To disable parsing, use the no form of this command.

cable dhcp-parse option-optnum

no cable dhcp-parse option-optnum

Syntax Description -optnum Specifies the DHCP option. Valid values are 43 and 60.

Command Default The CMTS does not parse the specified DHCP options.

Command Modes
Cable interface configuration (config-if)

Command History Release Modification

12.3(21)BC This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines To determine specific device and system information, configure cable dhcp-parse option-43 command on
the CMTS. The CMTS parses option-43 of the CPE DHCP message to determine the device and system
information of the CPE.
To determine the CPE device type, configure cable dhcp-parse option-60 command on the CMTS. The
CMTS parses option-60 of the CPE DHCP message to determine the device type of the CPE.

Examples The following example shows DHCP option 43 enabled on the CMTS:

Router(config-if)# cable dhcp-parse option-43

Router(config-if)#

Related Commands Command Description

cable helper address Specifies a destination IP address for User Datagram Protocol (UDP) broadcast
Dynamic Host Configuration Protocol (DHCP) packets.

Cisco CMTS Cable Command Reference

135
 Cable Commands: cable d
cable diaglog

cable diaglog
To enable the DOCSIS 3.1 mode on a MAC domain, use the cable d31-mode command in the interface
configuration mode. To disable the DOCSIS 3.1 mode, use the no form of the command.

[no] cable d31-mode

This command has no keywords or arguments.

Command Default DOCSIS 3.1 mode is enabled.

Command Modes Interface configuration (config-if)

Command History Release Modification

Cisco IOS XE Fuji This command was introduced on the Cisco cBR Series Converged Broadband
16.6.1 Routers.

Usage Guidelines Enabling the DOCSIS 3.1 mode has the following effects:
• MDDs advertise the MAC domain as DOCSIS 3.1 capable.
• DOCSIS 3.1 protocol support is enabled for the MAC domain, including:
• v5 Ranging support
• D3.1 TLV parsing
• D3.1 MMMs

• OFDM channels are included in MD-SG calculations assuming that they are a member of an associated
fiber node.
• OFDM channels are allowed to become active primary-capable downstream channels within the MAC
domain.

The following example shows how to enable DOCSIS 3.1 mode:

router#configure terminal
router(config)#interface c3/0/0
router(config-if)#cable d31-mode

Related Commands Command Description

cable mtc-mode Enables Multiple Transmit Channel mode for the MAC domain. For
d31-mode to be active, mtc-mode must also be configured.

cable mrc-mode Enables Multiple Receive Channel mode for the MAC domain. For
d31-mode to be active, mrc-mode must also be configured.

show interface Cable Displays the status of the controller, including the d31-mode
slot/subslot/port controller enablement state.

Cisco CMTS Cable Command Reference

136
 Cable Commands: cable d
cable diplexer-band-edge

cable diplexer-band-edge
To enable transmitting diplexer band edges in MAC Domain Descriptor (MDD) messages use the cable
diplexer-band-edge comand. To disable transmitting diplexer band edges in MAC Domain Descriptor (MDD)
messages use the no cable diplexer-band-edge comand.

cable diplexer-band-edge
no cable diplexer-band-edge
This command has no keywords or arguments.

Command Default Transmitting diplexer band edges in MAC Domain Descriptor (MDD) messages is enabled by default.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Example
The following sample shows and example of the cable diplexer-band-edge command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) #cable diplexer-band-edge
Router(config-profile-md)#end

The following sample shows and example of the no cable diplexer-band-edge command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) #no cable diplexer-band-edge
Router(config-profile-md)#end

Cisco CMTS Cable Command Reference

137
 Cable Commands: cable d
cable diplexer-mdd-override-band-edge

cable diplexer-mdd-override-band-edge
To override diplexer band edge settings in MAC Domain Descriptor (MDD) messages, use the cable
diplexer-band-edge comand. You can manually set the values used in MDD TLV 21.
To disable override diplexer band edge settings in MAC Domain Descriptor (MDD) messages, use the no
cable diplexer-band-edge comand.

cable diplexer-mdd-override-band-edge { ds_lower frequency-value | ds_upper frequency-value |

us_upper frequency-value }
no cable diplexer-mdd-override-band-edge

Syntax Description ds_lower frequency-value Configure DS Lower Band Edge. You can configure 108MHz or 258MHz.

ds_upper frequency-value Configure DS Upper Band Edge. You can configure 1002MHz or 1218MHz.

us_upper frequency-value Configure DS Upper Band Edge. You can configure 42MHz, 65MHz, 85MHz,
117MHz, 204MHz.

Command Default override diplexer band edge settings in MAC Domain Descriptor (MDD) messages is disabled by default.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

Cisco IOS XE This command is introduced on the Cisco cBR Series Converged Broadband Routers.
Dublin 17.12.1w

The following sample shows an example of the cable diplexer-mdd-override-band-edge command.

Router#configure terminal
Router#(config)#interface Cable1/0/0
Router(config-if)#cable diplexer-mdd-override-band-edge us_upper 204MHz
Router(config-if)#cable diplexer-mdd-override-band-edge ds_lower 258MHz
Router(config-if)#cable diplexer-mdd-override-band-edge ds_upper 1218MHz
Router(config-if)#end

Use the following command to verify the configuration.

Router#show cable mac-domain Cable1/0/0 mdd Integrated-Cable 1/0/0 0 | be Diplexer
Diplexer Band Edge
US Upper Band Edge: 4
DS Lower Band Edge: 1
DS Upper Band Edge: 0

Cisco CMTS Cable Command Reference

138
 Cable Commands: cable d
cable divert-rate-limit

cable divert-rate-limit
To set Cable-side DRL rate and limit, use the cable divert-rate-limit command in interface configuration
mode. To reset the rate and limit to the default values, use the no form of this command.

cable divert-rate-limit rate rate limit limit

no cable divert-rate-limit

Syntax Description rate Specifies the divert rate in packets per second. Minimum rate is 1 packet per second. Maximum rate
is 65535 packets per second. The default rate is 2000 packets per second.

limit Specifies the number of packets to be diverted in an initial burst of packets. Minimum limit is 4 packets.
Maximum limit is 4194 packets. The default limit is 2000 packets.

Command Default The default DRL configuration for every physical cable interface is 2000 packets per second and the default
limit is 2000 packets.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was replaced by the platform punt-sbrl subscriber rate command on the
Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Cable-side DRL is configured on the physical cable interface. It cannot be configured on a cable bundle
interface.

Examples The following example shows how to configure the rate and limit values for a cable interface.:

Router(config-if)# cable divert-rate-limit rate 1 limit 4

Related Commands Command Description

service divert-rate-limit ip This command configures DRL rate and limit for WAN-side IP packet
streams.

service divert-rate-limit non-ip This command configures DRL for WAN-side non-IP packet streams.

Cisco CMTS Cable Command Reference

139
 Cable Commands: cable d
cable docsis30-voice downstream req-attr-mask

cable docsis30-voice downstream req-attr-mask

To configure downstream DOCSIS 3.0 QoS parameters of the required attribute-mask and forbidden
attribute-mask number for all DS voice flows, use the cable docsis30-voice downstream req-attr-mask
command in global configuration mode. To disable the required attribute-mask and forbidden attribute-mask
number, use the no form of this command.

cable docsis30-voice downstream req-attr-mask req-attr-mask forb-attr-mask forb-attr-mask

no cable docsis30-voice

Syntax Description req-attr-mask Specifies the required attribute-mask value.

Example: 0
It can also include HEX format.
Example:
cable docsis30-voice downstream req-attr-mask FF for-attr-mask 8000AAbb

forb-attr-mask Specifies the forbidden attribute-mask value.

Example: 80000000

Command Default The value of required attribute-mask and forbidden attribute-mask number is 0. Use the no form of this
command to return to default. It will set the values for required attribute-mask and forbidden attribute-mask
number to 0.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is used to configure DOCSIS 3.0 voice-related downstream service-flow attribute-mask number.

Examples The following example shows how to configure the downstream attribute mask for the interface
cable:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# cable docsis30-voice downstream req-attr-mask ?

<0-FFFFFFFF> The attribute bitmap in hex

Router(config)# cable docsis30-voice downstream req-attr-mask aa00 ?
forb-attr-mask SF Forbidden Attribute Mask
Router(config)# cable docsis30-voice downstream req-attr-mask aa00 forb-attr-mask ?

Cisco CMTS Cable Command Reference

140
 Cable Commands: cable d
cable docsis30-voice downstream req-attr-mask

<0-FFFFFFFF> The attribute bitmap in hex

Router(config)# cable docsis30-voice downstream req-attr-mask aa00 forb-attr-mask bbcc

Router(config)# do show run | include docsis30

cable docsis30-voice downstream req-attr-mask AA00 forb-attr-mask BBCC

Router(config)# no cable docsis30-voice down

Router(config)# no cable docsis30-voice

Router(config)# do show run | include docsis30

Related Commands Command Description

cable downstream attribute-mask This command enables attribute-based forwarding which allows CMTS
to choose bonding group or individual channel for unicast and multicast
forwarding.

Cisco CMTS Cable Command Reference

141
 Cable Commands: cable d
cable docsis-ver

cable docsis-ver
To report the CMTS-supported DOCSIS version to the DHCP server, use the cable docsis-ver command in
global configuration mode. To report the default DOCSIS verison to the DHCP server, use the no form of the
command.

cable docsis-ver [major version | minor version]

no cable docsis-ver [major version | minor version]

Syntax Description major Specifies the major DOCSIS version.

version

minor Specifies the minor DOCSIS version.

version

Command Default The default value of the command is cable docsis-ver 3 1

Command Modes
Global configuration (config)

Command History Release Modification

IOS-XE 16.7.1 This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Cisco CMTS Cable Command Reference

142
 Cable Commands: cable d
cable dot1q-vc-map

cable dot1q-vc-map
To map a cable modem to a particular Virtual Local Area Network (VLAN) on a local outbound Ethernet
interface, use the cable dot1q-vc-map command in global configuration mode. To remove this mapping, or
to remove a particular customer’s name from the internal tables, use the no form of this command.

cable dot1q-vc-map mac-address ethernet-interface vlan-id {cust-name}

cable dot1q-vc-map mac-address ethernet-interface backup-interface ethernet-interface vlan-id {cust-name}
no cable dot1q-vc-map mac-address ethernet-interface backup-interface ethernet-interface vlan-id
{cust-name}
no cable dot1q-vc-map mac-address
no cable dot1q-vc-map customer cust-name

Syntax Description mac-address Hardware (MAC) address for the cable modem whose traffic is to be mapped.

ethernet-interface Outbound interface to which this cable modem should be mapped.

On the Cisco uBR7100 series and Cisco uBR7246VXR routers, you can specify
an Ethernet, Fast Ethernet, or Gigabit Ethernet interface, depending on what
interfaces are actually installed in the chassis.
On the Cisco cBR series routers, you can specify the Gigabit Ethernet 0 interface
or a Ten Gigabit Ethernet interface.

vlan-id ID for the IEEE 802.1Q Virtual Local Area Network (VLAN) that should be used
to tag the frames for this cable modem. The range is 1 to 4095, with no default on
the Cisco uBR7100 series and Cisco uBR7246VXR routers. The range is 2 to 4095
on the Cisco cBR series routers.
Note
The switches acting as the bridge aggregators might support a lower number of
VLAN IDs. If so, the Cisco CMTS router should be configured within the limits
of the switches’ maximum number of VLANs.

cust-name (Optional) Identifies the customer using this VLAN. The cust-name can be any
arbitrary alphanumeric string, up to 127 characters long.

customer cust-name (Optional) Deletes all VCs belong to this customer. The cust-name can be any
arbitrary alphanumeric string, up to 127 characters long.

backup-interface Specifies the backup WAN interface.

ethernet-interface

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC2 This command was introduced for Cisco uBR7246VXR universal broadband routers.

Cisco CMTS Cable Command Reference

143
 Cable Commands: cable d
cable dot1q-vc-map

Release Modification

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

12.2(33)SCJ This command was modified. The backup-interface keyword was added.

IOS-XE 3.18.0S This command was modified. The backup-interface keyword was added.

Usage Guidelines This command maps a cable modem, on the basis of its hardware (MAC) address, to a particular IEEE 802.1Q
VLAN on a particular outbound Ethernet interface. This enables the cable modem’s traffic to be part of a
virtual LAN at the Layer-2 level.

Note To use this command, you must first enable the use of IEEE 802.1Q Layer 2 tunnels, using the cable
l2-vpn-service dot1q command. Then use this command to map individual cable modems to specific VLANs.

Examples The following example shows how to enable the use of Layer 2 tunnels and then map specific CMs
to VLANs on a specific interface on a Cisco uBR7246VXR router:

Router# configure terminal

Router(config)# cable l2-vpn-service dot1q
Router(config)# cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4
Router(config)# cable dot1q-vc-map 0010.7bed.9c95 GigabitEthernet 1/0 5
Router(config)# exit

The following example shows the same command as above on a Cisco uBR7246VXR router, but
this time each VLAN is identified by the customer that is using it:

Router# configure terminal

Router(config)# cable l2-vpn-service dot1q
Router(config)# cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4 ENTERPRISE-CO1
Router(config)# cable dot1q-vc-map 0010.7bed.9c95 GigabitEthernet 1/0 5 ENTERPRISE-CO2
Router(config)# exit

The following example shows how to remove the Layer 2 mapping for a specific cable modem on
a Cisco uBR7246VXR router. This particular cable modem’s traffic is then routed using the normal
Layer 3 routing processes.

Router# config terminal

Router(config)# no cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4
Router(config)# exit

The following example shows how to enable the use of Layer 2 tunnels and then map specific CMs
to VLANs on a specific interface on a Cisco cBR-8 router:

Router# configure terminal

Cisco CMTS Cable Command Reference

144
 Cable Commands: cable d
cable dot1q-vc-map

Router(config)# cable l2-vpn-service dot1q

Router(config)# cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 0 2
Router(config)# cable dot1q-vc-map 0010.7bed.9c95 TenGigabitEthernet 4/1/0 5
Router(config)# exit

The following example shows how to configure a backup WAN interface on DOT1Q L2VPN on a
Cisco cBR-8 router:

Router# configure terminal

Router(config)# cable l2-vpn-service dot1q
Router(config)# cable dot1q-vc-map 0025.2eab.8482 Te4/0/1 backup-interface Te4/0/7 207
Topgun

Related Commands Command Description

cable l2-vpn-service dot1q Enables the use of Layer 2 tunnels so that traffic for individual cable
modems can be routed over a particular Virtual Local Area Network
(VLAN) on an Ethernet interface.

debug cable l2-vpn Displays debugging messages for the Layer 2 mapping of cable modems
to particular PVCs or VLANs.

show cable l2-vpn dot1q-vc-map Displays the mapping of one or all cable modems to VLANs on the
router’s Ethernet interfaces.

Cisco CMTS Cable Command Reference

145
 Cable Commands: cable d
cable dot1q-vc-map port-channel

cable dot1q-vc-map port-channel

To configure the port-channel uplink port for TLS L2VPN, use the cable dot1q-vc-map port-channel
command in global configuration mode.

cable dot1q-vc-map mac address port-channel number vlan id custom name

Syntax Description mac address MAC address of the cable modem.

number Port-channel interface number.

vlan id IEEE 802.1Q VLAN ID.

custom name Name of the customer.

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines The cable dot1q-vc-map port-channel command configures the port-channel uplink port for TLS L2VPN.

The following example shows how to configure the port-channel uplink port for TLS L2VPN:
router# configure terminal
router(config)#cable l2-vpn-service xconnect nsi dot1q
router(config)#cable dot1q-vc-map c8fb.26a5.551c port-channel 64 1200 topgun

Cisco CMTS Cable Command Reference

146
 Cable Commands: cable d
cable downstream annex

cable downstream annex

To set the Moving Picture Experts Group (MPEG) framing format for a downstream port on a cable interface
line card to either Annex A (Europe) or Annex B (North America), use the cable downstream annex command
in cable interface configuration mode.

cable downstream annex {A | B}

Syntax Description A Annex A. The downstream uses the EuroDOCSIS J.112 standard.

B Annex B. The DOCSIS-compliant cable plants that support North American channel plans use ITU J.83
Annex B downstream radio frequency.

Command Default Annex B for all Cisco cable interface cards other than the Cisco uBR-MC16E. Annex A, if using the Cisco
uBR-MC16E cable interface line card and the Cisco uBR7111E and Cisco uBR7114E universal broadband
routers.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.1(1a)T1 This command was introduced.

12.0(7)T, 12.1(1a)T1, 12.1 Support for Annex A was introduced for the Cisco uBR-MC16E cable
mainline, 12.0(8)SC, 12.1(2)EC1 interface line card.

12.1(7)EC Support for Annex A was added for the Cisco uBR7111E and Cisco
uBR7114E universal broadband routers.

12.2(15)CX Support was added for both Annex A and Annex B on the Cisco
uBR-MC16U/X and Cisco uBR-MC28U/X cable interface line cards.

12.2(15)BC2 Support was added for both Annex A and Annex B on the Cisco
uBR-MC5X20U/S cable interface line cards.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Router.

Usage Guidelines The MPEG framing format must be compatible with the downstream symbol rate you set. Annex B is the
North America (DOCSIS) standard and Annex A is the European (EuroDOCSIS) standard. You should review
your local standards and specifications for downstream MPEG framing to determine which format you should
use.

Cisco CMTS Cable Command Reference

147
 Cable Commands: cable d
cable downstream annex

The Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and Cisco uBR-MC5X20U cable interface line cards
support both Annex A and Annex B operation. However, on the Cisco uBR-MC28U/X, both downstreams
must be configured for the same mode (either both Annex A or both Annex B).
On the Cisco uBR-MC16U and Cisco uBR-MC28U (with integrated upconverter), the IF frequency is fixed
at 44 MHz for both Annex A and Annex B modes of operation. On the Cisco uBR-MC16X and Cisco
uBR-MC28X (without integrated upconverter), the IF frequency is set to 36.125 MHz in Annex A mode and
44 MHz in Annex B mode.

Note This command can be used to change the symbol rate, alpha, and other parameters for compliance with
EuroDOCSIS (annex A), or DOCSIS (annex B). Annex A is not supported on the Cisco uBR-MC1xC, Cisco
uBR-MC16B, Cisco uBR-MC16S, and Cisco uBR-MC28C cable interface line cards. Annex B is not supported
on the Cisco uBR-MC16E card and on the Cisco uBR7111E and Cisco uBR7114E universal broadband
routers.

Note The cable interface line card downstream ports and the CMs on the HFC network connected through these
ports must be set to the same MPEG framing format.

Caution In Cisco IOS Release 12.1, only Annex B MPEG framing format is supported.

Tip Changing the MPEG framing format affects the PHY layer on the downstream and disconnects all online
CMs. For this reason, if you are using N+1 HCCP redundancy, you should configure this command on both
the Protect and Working interfaces, so that the PHY layer is properly configured before a switchover occurs.
Otherwise, online CMs could be disconnected when a switchover occurs. (This also applies to the cable
downstream modulation and cable downstream interleave-depth commands.)

Examples The following example shows how to set the MPEG framing format to Annex A:

Router# configure terminal

Router(config)# interface cable 1/0
Router(config-if)# cable downstream annex A

The following example shows how to set the MPEG framing format to Annex B:

Router# configure terminal

Router(config)# interface cable 4/0
Router(config-if)# cable downstream annex B

Related Commands Command Description

show controllers cable Displays the downstream MPEG framing format (Annex A or Annex B) setting.

Cisco CMTS Cable Command Reference

148
 Cable Commands: cable d
cable downstream attribute-mask

cable downstream attribute-mask

To configure an attribute for a cable interface or a wideband cable interface, use the cable downstream
attribute-mask command in interface configuration mode or MAC domain profile configuration mode. To
disable this configuration, use the no form of this command.

cable downstream attribute-mask mask

no cable downstream attribute-mask mask

Syntax Description mask Specifies the mask value for the interface.

Command Default If this command is not used, the default attribute is used for the cable interface and the wideband cable interface.
The default attribute is 0x80000000 (31-bit) for the wideband cable interface and zero for the cable interface.
For a wideband cable interface, 31-bit mask is always set to 1.

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines The attribute-mask comprises 32 attributes and each attribute represents a single bit in the mask. You can
configure a provisioned attribute mask for each channel and provisioned bonding group to assign values to
the operator-defined binary attributes, or to override the default values of the specification-defined attributes.
The operator may configure, in the CM configuration file, a required attribute mask and a forbidden attribute
mask for a service flow. Additionally, in a CM-initiated dynamic service request, the CM can include a required
attribute mask and a forbidden attribute mask for a service flow.

Examples The following example shows how to configure an attribute for a wideband cable interface:

Router# configure terminal

Router(config)# interface wideband-cable 1/0/0:0
Router(config-if)# cable downstream attribute-mask 800000ff

Related Commands Command Description

interface wideband-cable Specifies a wideband cable interface.

interface cable Specifies a cable interface.

Cisco CMTS Cable Command Reference

149
 Cable Commands: cable d
cable downstream channel-id

cable downstream channel-id

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

cable downstream channel-id id

no cable downstream channel-id

Syntax Description id Specifies a downstream channel ID. Valid values for releases prior to Cisco IOS Release 12.2(33)SCB
are from 0 to 255 and the valid values for Cisco IOS Release 12.2(33)SCB and later are from 1 to 255 as
0 is reserved for network management.

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

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(5)T This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCB1 The downstream channel ID scheme was changed.

IOS-XE 3.15.0S This command was replaced by thedocsis-channel-idcommand on the Cisco cBR Series
Converged Broadband Router.

Usage Guidelines Use this command to ensure that each downstream channel has a unique ID when there are multiple Cisco
CMTS routers at a headend facility.
Cisco IOS assigns the default ID number of each downstream channel in the order in which devices connected
to the downstream channels appear to the CMTS router. The downstream channel connected to the first device
that appears to the CMTS router is configured with a default ID of 1, the downstream channel connected to
the second device that appears is configured with an ID of 2, and so on.
The local downstream channel channel ID is unique across all SPA channels. When you add a channel to the
MAC domain using the downstream modular-cable rf-channel command, the channel IDs in the MAC
domain are unique. This also facilitates channel ID uniqueness when the channels are added to a fiber node.
The following applies to rf-channel rf-port cable downstream channel-id channel-id command also.

Table 2: Downstream Channel ID Scheme for 12.2(33)SCB1

8/1 8/0 7/1 7/0 6/1 6/0 5/1 5/0 slot 3 slot 1

SPA Bay 0 217-240 193-216

Cisco CMTS Cable Command Reference

150
 Cable Commands: cable d
cable downstream channel-id

8/1 8/0 7/1 7/0 6/1 6/0 5/1 5/0 slot 3 slot 1

SPA Bay 1 217-240 193-216

SPA Bay 2 217-240 193-216

SPA Bay 3 217-240 193-216

5x20 DS /0 169 145 121 97 73 49 25 1

5x20 DS /1 173 149 125 101 77 53 29 5

5x20 DS /2 177 153 129 105 81 57 33 9

5x20 DS /3 181 157 133 109 85 61 37 13

5x20 DS /4 185 161 137 113 89 65 41 17

Table 3: Downstream Channel ID Scheme for 12.3(23)BCx

8/1 8/0 7/1 7/0 6/1 6/0 5/1 5/0 slot 3 slot 1

SPA Bay 0 24-47 24-47

SPA Bay 1 48-71 48-71

5x20 188-192 180-184 168-172 160-164 148-152 140-144 128-132 120-124

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

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

Router(config-if)# cable downstream channel-id 44

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

Router(config-if)# cable downstream channel-id

Cisco CMTS Cable Command Reference

151
 Cable Commands: cable d
cable downstream-channel-id automatic

cable downstream-channel-id automatic

To automatically configure the downstream channel IDs, use the cable downstream-channel-id automatic
command in global configuration mode. To set the downstream channel ID (DCID) to its default value, use
the no form of this command.

cable downstream-channel-id automatic

no cable downstream-channel-id automatic

Syntax Description automatic Specifies an automatic assignment of the DCIDs by the Cisco CMTS.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines Use this command to automatically assign unique channel IDs for all downstream channels in a fiber node.
Automatic DCIDs are not assigned to downstreams that are not in any fiber node.

Examples This example shows how to automatically configure the downstream channel IDs:

Router(config)# cable downstream-channel-id automatic

Related Commands Command Description

show cable fibernode Displays channel ID information for downstreams in a fiber node.

Cisco CMTS Cable Command Reference

152
 Cable Commands: cable d
cable downstream controller-profile

cable downstream controller-profile

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

cable downstream controller-profile id[RPHY|I-CMTS]

no cable downstream controller-profile id

Syntax Description
Syntax Description id Specifies the downstream controller profile ID.

Command Default None

Command Modes
Global configuration (config)

Command History
Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Cisco IOS XE Fuji 16.7.1 This command was modified on the Cisco cBR Series Converged Broadband
Routers. Keywords RPHY and I-CMTS were added.

Usage Guidelines Use this command to configure the downstream controller profile.
When configuring a new i-CMTS controller profile, keyword I-CMTS is needed. If user input RPHY or do
not input any keyword, the system will consider it as a RPHY controller profile.

Examples The following example shows how to enter the downstream controller profile configuration mode:

Router# configure terminal

Router(config)# cable downstream controller-profile 1 I-CMTS
Router(config-controller-profile)#

Related Commands Command Description

multicast-pool Specifies the multicast pool for the downstream controller profile.

Cisco CMTS Cable Command Reference

153
 Cable Commands: cable d
cable downstream description

cable downstream description

To specify a description for a downstream port, use the cable downstream description description command.

cable downstream description description

Syntax Description description Specifies a description that is up to 80 characters describing the downstream port.

Command Default By default, no description is configured.

Command Modes cable interface (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Example
The following sample shows and example of the cable downstream description command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) # cable downstream description DS
Router(config-profile-md) # no cable downstream description
Router(config-profile-md)#end

Cisco CMTS Cable Command Reference

154
 Cable Commands: cable d
cable downstream dsg

cable downstream dsg

Supports Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) configuration under MAC domain interface
on a Cisco CMTS router with an OPS MD-profile. The method of configuring A-DSG by OPS MD-profile
now is in addition to the existing method of using legacy CLI to configure DSG TG.

cable downstream dsg[channel list DSG Channel List Setting | dcd-enable Enable DSG DCD messages
when no enabled rules/tunnels | tg DSG Tunnel group | timer DSG Timer Setting | vendor-param DSG
vendor specific parameters]

chan-list (Optional) Specifies the downstream Channel List Setting. The valid range is from 1 to
65535.

dcd-enable (Optional) Enables the DSG DCD messages when no enabled rules/tunnels are enabled.

tg (Optional) Specifies the DSG Tunnel group.

timer (Optional) Specifies the DSG Timer Setting.

vendor-param (Optional) Sepecifies the DSG vendor-specific parameters group ID.

The following example shows how the show cable downstream dsg command is used:

router# show cable downstream dsg tg

TG Chan TG Rule Vendor UCID Service-group Profile
id id state I/F pri Param list Profile chan state
----- ----- ----- ------- ---- ------ --------------- --------------
2000 1 en C1/0/0 0 SG1 en
4500 1 en C1/0/0 2 2 1 2 SG1 dis
4500 2 en 0 -- --

Cisco CMTS Cable Command Reference

155
 Cable Commands: cable d
cable downstream dsg chan-list

cable downstream dsg chan-list

To associate an Advanced-mode DOCSIS Set-Top Gateway (A-DSG) channel list entry to a downstream
channel and include it in the Downstream Channel Descriptor (DCD) message on a Cisco CMTS router, use
the cable downstream dsg chan-listcommand in interface configuration mode. To remove the configuration,
use the no form of this command.

cable downstream dsg chan-list list-index

no cable downstream dsg chan-list list-index

Syntax Description list-index Alphanumeric list index identifier.

Command Default Channel lists are not defined by default.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG 1.1 on the Cisco uBR10012 and Cisco
uBR7200 series routers.

12.2SB This command was integrated into Cisco IOS Release 12.2SB. Support for the Cisco
uBR7225VXR router was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines Global configuration for A-DSG must be complete before configuring interface definitions.

Examples The following example shows configuration of inclusion of DSG channel list entries in DCD messages
on a downstream cable interface on a Cisco CMTS router:

interface Cable6/0
cable downstream dsg chan-list 2

Examples for Cisco cBR Series Converged Broadband Router

Router# configure terminal

Router(config)#interface cable 1/0/0
Router(config-if)#cable downstream dsg chan-list 1

Related Commands Command Description

cable downstream dsg dcd-enable Enables DCD messages to be sent on a downstream channel on a
Cisco CMTS router.

Cisco CMTS Cable Command Reference

156
Cable Commands: cable d
cable downstream dsg chan-list

Command Description

cable downstream dsg rule Defines and associates an A-DSG rule to a downstream channel on
a Cisco CMTS router.

cable downstream dsg timer Associates an A-DSG timer entry to a downstream channel and
includes the DCD message on a Cisco CMTS router.

cable downstream dsg vendor-param Associates A-DSG vendor parameters to a downstream and includes
them in the DCD message on a Cisco CMTS router.

cable dsg chan-list Configures the A-DSG downstream channel list on a CMTS router.

Cisco CMTS Cable Command Reference

157
 Cable Commands: cable d
cable downstream dsg dcd-enable

cable downstream dsg dcd-enable

To enable Downstream Channel Descriptor (DCD) messages to be sent on a downstream channel on a Cisco
CMTS router, use the cable downstream dsg dcd-enable command in interface configuration mode. To
disable DCD messages, use the no form of this command.

cable downstream dsg dcd-enable

no cable downstream dsg dcd-enable

Syntax Description This command has no arguments or keywords.

Command Default DCD messages are disabled.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG 1.1 on the Cisc uBR10012 router and
Cisco uBR7200 series routers.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines Global configuration for Advanced-mode DOCSIS Set-top Gateway (A-DSG) must be complete before
configuring interface definitions. This command is used when there are no enabled rules or tunnels for A-DSG
on a Cisco CMTS router.

Examples The following example shows how to enable DCD messages on a downstream interface on a Cisco
CMTS router along with several other A-DSG interface configuration commands:

interface Cable6/0
cable downstream dsg dcd-enable
cable downstream dsg chan-list 2
cable downstream dsg timer 3
cable downstream dsg vendor-param 2
cable downstream dsg rule 1 priority 1 clients 1 tunnel 1
cable downstream dsg rule 1 vendor-param 1
cable downstream dsg rule 1 classifiers 1 5
cable downstream dsg rule 2 priority 1 clients 2 tunnel 2

Related Commands Command Description

cable downstream dsg chan-list Associates the A-DSG channel list entry to a downstream channel,
to be included in the DCD message on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

158
Cable Commands: cable d
cable downstream dsg dcd-enable

Command Description

cable downstream dsg rule Defines and associates an A-DSG rule to a downstream channel on
a Cisco CMTS router.

cable downstream dsg timer Associates an A-DSG timer entry to a downstream channel and
includes the DCD message on a Cisco CMTS router.

cable downstream dsg Associates A-DSG vendor parameters to a downstream and includes
vendor-param them in the DCD message on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

159
 Cable Commands: cable d
cable downstream dsg disable

cable downstream dsg disable

To exclude the primary capable interface from DOCSIS Set-Top Gateway DSG forwarding, use the cable
downstream dsg disable command in cable interface configuration mode. To remove the configuration, use
the no form of this command.

cable downstream dsg disable

no cable downstream dsg disable

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable downstream dsg disable command is associated with the Advanced Mode DOCSIS Set-Top
Gateway 1.2 for the Cisco CMTS Routers feature.
When DSG is enabled on the MAC domain interface and DSG forwarding is disabled on the primary capable
interface, the Cisco CMTS router does not create multicast service flows on the primary capable interface.
If DSG forwarding is already enabled on the primary capable interface, the Cisco CMTS router removes
multicast service flows from the interface.

Examples The following example shows how to disable A-DSG forwarding on a primary capable modular
interface on the Cisco CMTS router:

Router# configure terminal

Router(config)# interface modular-cable 1/0/0:0
Router(config-if)# cable downstream dsg disable
Router(config-if)# end

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on the Cisco CMTS router.

show cable dsg cfr Displays DSG classifier details.

Cisco CMTS Cable Command Reference

160
 Cable Commands: cable d
cable downstream dsg rule

cable downstream dsg rule

Note Effective with Cisco IOS Release 12.3(17a)BC2, the cable downstream dsg rule command is removed from
Cisco IOS software.

To define and associate an Advanced-mode DOCSIS Set-top Gateway (A-DSG) rule to the downstream
channel on a Cisco CMTS router, use the cable downstream dsg rule command in interface configuration
mode. To remove the DSG rule configuration, use the no form of this command.

cable downstream dsg rule rule-id [clients clnt-list-id tunnel tun-id | priority priority | vendor-param
vsif-grp-id | ucid ucid1 | [ucid1 ucid2 ... ucidn] | cfr cfr-index [cfr-index ...] | disable]
no cable downstream dsg rule rule-id [clients clnt-list-id tunnel tun-id | priority priority |
vendor-param vsif-grp-id | ucid ucid1 | [ucid1 ucid2 ... ucidn] | cfr cfr-index [cfr-index ...] |
disable]

Syntax Description rule-id Defines the DSG rule identifier.

clients clnt-list-id Sets the DSG clients and associates the clients with the channel list
identifier for this DSG rule.

tunnel tun-id Sets the DSG tunnel to be associated with this rule, and defines the DSG
tunnel identifier.

priority priority Sets the priority of the DSG rule.

vendor-param vsif-grp-id Associates DSG vendor-specific parameters with the specified DSG rule.

ucid ucid1 | [ucid1 ucid2...ucidn] Sets the upstream channel identifider for the DSG rule.

cfr cfr-index [cfr-index...] Sets the index for the classifier value associated with the DSG rule.

disable Disables a DSG rule.

Command Default DSG rules are disabled by default when they are created.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG 1.1 on the Cisco uBR10012 router and
Cisco uBR7200 series routers.

12.3(17a)BC2 This command was removed.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Cisco CMTS Cable Command Reference

161
 Cable Commands: cable d
cable downstream dsg rule

Usage Guidelines Global configuration for A-DSG must be complete before configuring interface definitions.
Because rules are disabled when they are created, you must enable the configuration using the no cable
downstream dsg rule disable command. To disable a DSG rule configuration, use the cable downstream
dsg rule disable command.
You can associate DSG clients, vendor specific parameters, classifiers, DSG tunnel address, upstream channel
identifier range, and rule priority to a downstream channel. You can apply more than one rule to a downstream
channel. All configured rules that are enabled are included in the Downstream Channel Descriptor (DCD)
message.

Examples The following example shows configuration and association of DSG rules on a downstream cable
interface on a Cisco CMTS router, followed by an example of enabling the configured DSG rules:

interface Cable6/0
cable downstream dsg rule 1 clients 1 tunnel 1
cable downstream dsg rule 1 priority 1
cable downstream dsg rule 1 vendor-param 1
cable downstream dsg rule 1 classifiers 1 5
cable downstream dsg rule 2 clients 2 tunnel 2
cable downstream dsg rule 2 priority 1
!
! Enable the DSG rule configuration
!
no cable downstream dsg rule 1 disable
no cable downstream dsg rule 2 disable

The following example shows how to disable DSG rules that were previously enabled:

interface cable6/0
cable downstream dsg rule 1 disable
cable downstream dsg rule 2 disable

Related Commands Command Description

cable downstream dsg chan-list Associates an A-DSG channel list to a downstream channel on a
Cisco CMTS router.

cable downstream dsg dcd-enable Enables DCD messages to be sent on a downstream channel on a
Cisco CMTS router.

cable downstream dsg timer Associates an A-DSG timer entry to a downstream channel and
includes the DCD message on a Cisco CMTS router.

cable downstream dsg vendor-param Associates A-DSG vendor parameters to a downstream and includes
them in the DCD message on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

162
 Cable Commands: cable d
cable downstream dsg tg

cable downstream dsg tg

To associate an Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) tunnel group to a MAC domain interface
on a Cisco CMTS router, use the cable downstream dsg tg command in cable interface configuration mode.
To remove this association, use the no form of this command.

cable downstream dsg tg tgid [channel channel_ID | priority DSG-rule-priority [enable | disable]
| ucid ID1 [ID2 ID3 ID4] | vendor-param vendor-group-ID]
no cable downstream dsg tg tgid

Syntax Description dsg tg tgid Specifies the DSG tunnel group ID. The valid range is from 1 to 65535.

channel channel_ID (Optional) Specifies the downstream channel ID. The valid range is from
1 to 65535.

priority DSG-rule-priority (Optional) Specifies the DSG rule priority for the cable interface. The
valid range is from 0 to 255.

enable (Optional) Enables the DSG rule priority on a DSG tunnel group.

disable (Optional) Disables the DSG rule priority on a DSG tunnel group.

ucid upstream-channel-ID (Optional) Specifies the upstream channel ID (UCID). You can specify a
maximum of four upstream channel IDs.
Cisco cBR-8 router—The valid range is 0 to 8.

vendor-param vendor-group-ID (Optional) Specifies the vendor specific parameters group ID. The valid
range is from 1 to 65535.

Command Default The DSG traffic is not forwarded to the MAC domain.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable downstream dsg tg command is used to configure the Advanced Mode DOCSIS Set-Top Gateway
1.2 for the Cisco CMTS Routers feature.
If you do not specify a downstream channel ID using the channel keyword, the Cisco CMTS router
automatically assigns a free channel to associate the MAC domain interface with the DSG tunnel group. This
channel is created with default parameters.
If you specify the channel keyword in the no form of the command, only the MAC domain to DSG tunnel
group association is removed from the configuration. If the no form of the command is used without the
channel keyword, both the tunnel group association and the channel are removed.

Cisco CMTS Cable Command Reference

163
 Cable Commands: cable d
cable downstream dsg tg

Examples The following example shows how to associate an A-DSG tunnel group to a MAC domain interface:

Router(config)# interface cable 5/1/0

Router(config-if)# cable downstream dsg tg 1
Router(config-if)# cable downstream dsg tg 1 channel 22
Router(config-if)# cable downstream dsg tg 1 priority 2 enable
Router(config-if)# cable downstream dsg tg 1 ucid 1 2 3 4
Router(config-if)# cable downstream dsg tg 1 vendor-param 20

Examples for Cisco cBR Series Converged Broadband Router

This example shows how to associate an A-DSG tunnel group to a MAC domain interface on a Cisco
cBR-8 router:

Router(config)# interface cable 1/0/0

Router(config-if)# cable downstream dsg tg 1
Router(config-if)# cable downstream dsg tg 1 channel 2
Router(config-if)# cable downstream dsg tg 1 priority 0 enable
Router(config-if)# cable downstream dsg tg 1 ucid 1 2 3 4
Router(config-if)# cable downstream dsg tg 1 vendor-param 20

Related Commands Command Description

cable downstream dsg disable Excludes the primary capable interface from A-DSG forwarding.

Cisco CMTS Cable Command Reference

164
 Cable Commands: cable d
cable downstream dsg tg channel

cable downstream dsg tg channel

To associate an Advanced-mode DOCSIS Set-Top Gateway (A-DSG) tunnel group to a downstream interface
on a Cisco CMTS router, use the cable downstream dsg tg channel command in interface configuration
mode. To remove this configuration, use the no form of this command.

cable downstream dsg tg group-id channel channel-id

no cable downstream dsg tg group-id channel channel-id

Syntax Description group-id Specifies the A-DSG tunnel group identifier as a number from 1 to 65535.

channel-id Specifies the downstream channel identifier as a number from 1 to 65535.

Command Default The A-DSG tunnel group is not associated to a downstream interface.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(17a)BC2 This command was introduced to support A-DSG 1.2 on the Cisco uBR10012 router and
Cisco uBR7200 series routers.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines Thecable dsg tg channel global configuration command establishes the configuration of tunnels in a tunnel
group. Tunnel groups are enabled by default.
Then, you can associate the tunnel group to a downstream cable interface using the cable downstream dsg
tg channel interface configuration command.

Examples The following example shows the configuration and activation of a tunnel group with ID of 1 and
channel ID of 2 in global configuration, followed by association of the tunnel group to a downstream
interface on a Cisco CMTS router:

cable dsg tg 1 channel 2

interface cable 8/1/2
cable downstream dsg tg 1 channel 2

Examples This example shows the configuration and activation of a tunnel group with ID of 1 and channel ID
of 1in global configuration, followed by association of the tunnel group to a downstream interface
on a Cisco cBR-8 router:

cable dsg tg 1 channel 1

Cisco CMTS Cable Command Reference

165
 Cable Commands: cable d
cable downstream dsg tg channel

interface cable 1/0/0

cable downstream dsg tg 1 channel 1

Related Commands Command Description

cable downstream dsg chan-list Associates an A-DSG channel list entry to a downstream channel and
includes it in the DCD message on a Cisco CMTS router.

cable downstream dsg dcd-enable Enables DCD messages to be sent on a downstream channel on a
Cisco CMTS router.

cable downstream dsg timer Associates an A-DSG timer entry to a downstream channel and
includes the DCD message on a Cisco CMTS router.

cable downstream dsg Associates A-DSG vendor parameters to a downstream and includes
vendor-param them in the DCD message on a Cisco CMTS router.

cable dsg tunnel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

166
 Cable Commands: cable d
cable downstream dsg timer

cable downstream dsg timer

To associate an Advanced-mode DOCSIS Set-Top Gateway (A-DSG) timer entry to a downstream channel
and include it in the Downstream Channel Descriptor (DCD) message on a Cisco CMTS router, use the cable
downstream dsg timer command in interface configuration mode. To remove this setting, use the no form
of this command.

cable downstream dsg timer timer-index

no cable downstream dsg timer timer-index

Syntax Description timer-index Identifier for the DSG timer setting in the index.

Command Default The downstream DSG timer is not configured by default.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG 1.1 on the Cisco uBR10012 router and
Cisco uBR7200 series routers.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines Global configuration for A-DSG must be complete before configuring interface definitions.

Examples The following example shows the configuration DSG timers for inclusion in DCD messages on a
downstream cable interface on a Cisco CMTS router:

interface Cable6/0
cable downstream dsg timer 3

Examples for Cisco cBR Series Converged Broadband Router

This example shows how to associate an A-DSG tunnel group to a MAC domain interface on a Cisco
cBR-8 router:

Router(config)# interface cable 1/0/0

Router(config-if)# cable downstream dsg timer 1

Cisco CMTS Cable Command Reference

167
 Cable Commands: cable d
cable downstream dsg timer

Related Commands Command Description

cable downstream dsg chan-list Associates an A-DSG channel list entry to a downstream channel
and include it in the DCD message on a Cisco CMTS router.

cable downstream dsg dcd-enable Enables DCD messages to be sent on a downstream channel on a
Cisco CMTS router.

cable downstream dsg rule Defines and associates an A-DSG rule to a downstream channel on
a Cisco CMTS router.

cable downstream dsg vendor-param Associates A-DSG vendor parameters to a downstream and includes
them in the DCD message on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

168
 Cable Commands: cable d
cable downstream dsg vendor-param

cable downstream dsg vendor-param

To associate Advanced-mode DOCSIS Set-Top Gateway (A-DSG) vendor parameters to a downstream, to
be included in the Downstream Channel Descriptor (DCD) message on a Cisco CMTS router, use the cable
downstream dsg vendor-param command in interface configuration mode. To remove this configuration
from a Cisco CMTS router, use the no form of this command.

cable downstream dsg vendor-param vsif-grp-id

no cable downstream dsg vendor-param vsif-grp-id

Syntax Description vsif-grp-id Associates a vendor parameter with a group identifier.

Command Default This command is not configured by default.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG 1.1 on the Cisco uBR10012 router and
Cisco uBR7200 series routers.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines Global configuration for A-DSG must be complete before configuring interface definitions.

Examples The following example shows configuration of A-DSG vendor parameters on a downstream interfac,
along with several other downstream interface commands on a Cisco CMTS router:

interface Cable6/0
cable downstream dsg dcd-enable
cable downstream dsg chan-list 2
cable downstream dsg timer 3
cable downstream dsg vendor-param 2
cable downstream dsg rule 1 priority 1 clients 1 tunnel 1
cable downstream dsg rule 1 vendor-param 1
cable downstream dsg rule 1 classifiers 1 5
cable downstream dsg rule 2 priority 1 clients 2 tunnel 2

Related Commands Command Description

cable downstream dsg chan-list Associates an A-DSG channel list entry to a downstream channel and
include it in the DCD message on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

169
 Cable Commands: cable d
cable downstream dsg vendor-param

Command Description

cable downstream dsg dcd-enable Enables DCD messages to be sent on a downstream channel on a Cisco
CMTS router.

cable downstream dsg rule Defines and associates an A-DSG rule to a downstream channel on a
Cisco CMTS router.

cable downstream dsg timer Associates an A-DSG timer entry to a downstream channel and includes
the DCD message on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

170
 Cable Commands: cable d
cable downstream freq-profile

cable downstream freq-profile

To set the frequency profile for the cable interface line card, use the cable downstream freq-profile command
in global configuration mode.

cable downstream freq-profile id

Syntax Description
Syntax Description id Downstream frequency profile ID. 0 to 3 are system defined, 4 to 15 are user defined.

Command Default None

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to set the frequency profile for the cable interface line card.

Examples The following example shows how to enable the downstream frequency profile configuration:

Router# configure terminal

Router(config)# cable downstream freq-profile 4
Router(config-freq-prof)#

Related Commands Command Description

lane start-freq Set the start frequency for a specific lane.

Cisco CMTS Cable Command Reference

171
 Cable Commands: cable d
cable downstream frequency

cable downstream frequency

To note the downstream center frequency for the cable interface line card to reflect the digital carrier frequency
of the downstream radio frequency carrier (the channel) for that downstream port, use the cable downstream
frequency command in cable interface configuration mode. On cable interfaces with an integrated upconverter,
to unset the downstream frequency and to disable the RF output from the integrated upconverter, use the no
form of this command.

cable downstream frequency down-freq-hz

no cable downstream frequency

Syntax Description down-freq-hz The known center frequency of the downstream carrier in Hz (the valid range is 55,000,000
to 858,000,000). The usable range depends on whether the downstream is configured for
DOCSIS or EuroDOCSIS operations:
• DOCSIS = 88,000,000 to 855,000,000 MHz
• Extended frequency range = 70,000,000 to 855,000,000 MHz
• EuroDOCIS = 112,000,000 to 858,000,000 MHz
The Cisco IOS supports a superset of these standards, and setting a center frequency to a value
outside these limits violates the DOCSIS or EuroDOCSIS standards. Cisco does not guarantee
the conformance of the downstream and upconverter outputs when using frequencies outside
the DOCSIS or EuroDOCSIS standards.

Command Default Disabled. On the Cisco uBR7100 series routers, the default downstream center frequency for the integrated
upconverter is 500 MHz.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

11.3 XA This command was introduced to support NTSC/DOCSIS Annex B RF operation.

12.0(7)XR2, 12.0(8)SC Modified to support PAL/SECAM EuroDOCSIS RF operation.

12.1(2)EC1 Supports both Annex A and Annex B.

12.1(5)EC1 Modified to support the integrated upconverter on the Cisco uBR7100 series
universal broadband router.

12.2(11)CY, 12.2(11)BC3 Support was added for the Cisco uBR-MC5X20S cable interface line card.

12.2(15)CX Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X
cable interface line cards.

12.2(15)BC2 Support was added for the extended frequency range and for the Cisco
uBR-MC5X20U cable interface line card. In addition, the command was changed
to accept only center frequencies in 250 KHz increments (previously, the
command allowed 125 KHz increments).

Cisco CMTS Cable Command Reference

172
 Cable Commands: cable d
cable downstream frequency

Release Modification

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines This command is either optional or required, depending on the cable interface line card being used.
• On the Cisco uBR7100 series routers using the integrated upconverter (the DS0 RF output), and on cable
interfaces that support integrated upconverters (such as the Cisco uBR-MC16U, Cisco uBR-MC28U,
and Cisco uBR-MC5X20U), this command configures the frequency for the integrated upconverter. The
no form of this command unsets the frequency and disables the output from the integrated upconverter.
• For cable interfaces that use an external upconverter (such as the Cisco uBR-MC16S and the DS0 (IF)
output on Cisco uBR7100 series routers), this command is informational-only, because it does not affect
the external upconverter. The external upconverter must be programmed separately with the appropriate
center frequency.

Note The no form of this command is supported only on the Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and
Cisco uBR-MC5X20S/U cable interface line cards, and on the Cisco uBR7100 series universal broadband
router.

Note We recommend configuring this command on all cable interfaces, even those that are using external
upconverters. This is because this command is required to enable the downstream frequency override feature
and for N+1 line card redundant operation when using SNMP-capable external upconverters.

The downstream frequency of your RF output must be set to match the expected input frequency of your
upconverter. To do this, you enter the fixed center frequency of the downstream channel for the downstream
port. (You can also select a default that does not set a specific fixed value.) The valid range for a fixed center
frequency is 54,000,000 to 858,000,000 Hz. The center frequency is also used to configure an IF-to-RF
upconverter that must be installed in your downstream path.
The digital carrier frequency is specified to be the center of a 6.0 MHz channel. For example, EIA channel
95 spans 90.000 to 96.000 MHz. The center frequency is 93.000 MHz, which is the digital carrier frequency
that should be configured as the downstream frequency. The typical range for current CATV headends is
88,000,000 to 860,000,000 Hz.
In Cisco IOS software releases before Cisco IOS Release 12.2(15)BC2, the cable downstream frequency
command allowed the center frequency to be specified in 125 KHz increments. In Cisco IOS Release
12.2(15)BC2 and later releases, this was changed to allow only 250 KHz increments, because of the
requirements of the Broadband Processing Engine cable interface line cards that use an internal upconverter
(Cisco uBR-MC16U, Cisco uBR-MC28U, and Cisco uBR-MC5X20S/U).

Cisco CMTS Cable Command Reference

173
 Cable Commands: cable d
cable downstream frequency

Note DOCSIS allows downstreams to use any center frequency within 88,000,000 to 855,000,000 MHz. However,
when most cable modems first come online, they initially start scanning the downstream for the frequencies
that are in the NTSC channel plan. If a valid downstream is not found among those frequencies, the cable
modems then beginning scanning the remaining frequencies. For the fastest and most efficient registration
times, we recommend configuring downstreams for the frequencies that are specified in the NTSC channel
plan.

Note For cBR Series Converged Broadband Routers, the frequency configuration will be available as a part of the
RF channel configuration.

Examples The following example shows how to set the downstream center frequency display value:

Router(config)# interface c6/0

Router(config-if)# cable downstream frequency 96000000

Related Commands Command Description

cable downstream annex Sets the MPEG framing format for a downstream port on a cable interface
line card to either Annex A (Europe) or Annex B (North America).

cable downstream rf-power Configures the desired RF output power on the integrated upconverter.

cable downstream rf-shutdown Enables or disables the RF output from the integrated upconverter.

show controllers cable Displays status and configuration information for the cable interface. On
supported cable interfaces, this includes information about the integrated
upconverter.

Cisco CMTS Cable Command Reference

174
 Cable Commands: cable d
cable downstream if-output

cable downstream if-output

To activate a downstream port on a cable interface and to generate either a standard modulated signal or a
test signal, use the cable downstream if-output command in cable interface configuration mode. To disable
all signal output on the intermediate frequency (IF) carrier and to shut down the interface, use the no form of
this command.

cable downstream if-output [continuous-wave | prbs]

no cable downstream if-output

Syntax Description continuous-wave Outputs an unmodulated carrier signal on the downstream, shutting down normal data
network operations.

prbs Outputs a Pseudo Random Bit Stream (PRBS) test signal on the downstream, shutting
down normal data network operations.

Command Default The downstream interface is enabled for normal data use.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

11.3 XA This command was introduced.

12.0(7)XR2, 12.0(7)T, This command was modified to support Annex A (EuroDOCSIS)

12.(0)SC,12.1(2)EC1 downstreams, and the continuous-wave and prbs options were added.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Router.

Usage Guidelines Typically, a downstream is configured to output a modulated signal, using the cable downstream if-output
command, allowing data transmissions to be sent over the HFC cable network. However, this command can
also be used to test the cable plant or to shut down the interface completely:
• cable downstream if-output continuous-wave—Generates an unmodulated, continuous sine wave on
the downstream interface. You can use a spectrum analyzer to verify the frequency, amplitude, and power
of the wave. The test signal continues on the downstream until you resume normal modulated operations
using the cable downstream if-output command.
• cable downstream if-output prbs—Generates a PRBS test signal on the downstream interface. You
can use a spectrum analyzer to verify the frequency, amplitude, and power of the wave. The test signal
continues on the downstream until you resume normal modulated operations using the cable downstream
if-output command.

Cisco CMTS Cable Command Reference

175
 Cable Commands: cable d
cable downstream if-output

• no cable downstream if-output—Terminates all signal output and shuts down the downstream interface.
The interface remains shut down until you reactive the downstream using the cable downstream if-output
command.

Note Generating a PRBS or continuous-wave test signal or shutting down the interface automatically stops the
modulated carrier data signal and disconnects all CMs on that downstream. These commands should not be
used on a live network except as part of troubleshooting major network problems.

Examples The following example shows how to enable downstream port 0 on a cable interface:

Router# configure terminal

Router# interface c6/0
Router(config-if)# cable downstream if-output

The following example shows a PRBS test signal being generated on a downstream for a period of
time. The downstream is then shut down so that the test engineer can verify that no signal is being
sent on the downstream. After the tests have been run, the downstream is reactivated for normal
modulated data use:

Router# configure terminal

Router# interface c6/0
Router(config-if)# cable downstream if-output prbs
(the signals are verified by a spectrum analyzer...)
Router#(config-if)# no cable downstream if-output
(the downstream is checked to verify no signals are being sent on it...)
Router#(config-if)# cable downstream if-output
Router#(config-if)# exit

Cisco CMTS Cable Command Reference

176
 Cable Commands: cable d
cable downstream interleave-depth

cable downstream interleave-depth

To set the downstream interleave depth, use the cable downstream interleave-depth command in cable
interface configuration mode. To restore the default setting, use the no form of this command.

cable downstream interleave-depth {8 | 16 | 32 | 64 | 128}

no cable downstream interleave-depth

Syntax Description 8 | 16 | 32 | 64 | 128 Indicates the downstream interleave depth in number of rows of codewords.

Command Default The downstream interleave depth value is 32.

Command Modes
Interface configuration—cable interface only (config-if)

Command History
Command History Release Modification

11.3 XA This command was introduced.

12.0(7)XR2, 12.(0)SC,12.1(2)EC1 This command was modified to support Annex A operation (which uses
a fixed interleave).

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Router.

Usage Guidelines

Note This command is not supported on the Cisco uBR-MC16E cable interface line card or on the Cisco uBR7111E
and Cisco uBR7114E universal broadband routers, because the interleave on the EuroDOCSIS downstream
is fixed.

This command sets the minimum latency of the system. A higher interleave depth provides more protection
from bursts of noise on the HFC network by spreading out the bits for each codeword over a greater transmission
time.
Interleave transmissions do not transmit each codeword by itself, but instead send bits from multiple codewords
at the same time, so that a noise burst affects the minimum number of bits per codeword, which allows the
Forward Error Correction (FEC) algorithm a greater chance of detecting and correcting any transmission
errors.
A higher interleave depth transmits bits from a greater number of codewords, increasing the efficacy of the
FEC algorithm. However, a higher depth also increases downstream latency, which might slow TCP/IP

Cisco CMTS Cable Command Reference

177
 Cable Commands: cable d
cable downstream interleave-depth

throughput for some configurations, so you need to choose an interleave depth that is appropriate both for
your plant’s noise levels and application needs.
If your cable plant is experiencing high noise levels, consider increasing the interleave from the default of 32
to 64. For plants with exceptionally high noise levels, increase the interleave to 128 to provide the maximum
protection from noise bursts.
Low interleave depth values typically cause some packet loss on typical HFC networks, because burst noise
lasts beyond the error correction block correctable length. However, on cable plants with exceptionally low
noise levels, Cisco recommends initially using the default value of 32, and then trying an interleave of either
16 or 8 to see if this increases performance without increasing the number of errors that result from noise.
The table below shows interleave characteristics and their relation to each other.

Note The table below does not apply to EuroDOCSIS cable plants because the interleave depth for EuroDOCSIS
cable interfaces is fixed.

Table 4: DOCSIS Downstream Cable Interleave Descriptions

I (Number of Taps) J (Increment) Burst Protection Latency

64-QAM/256 QAM 64-QAM/256 QAM

8 16 5.9 microseconds/4.1 milliseconds 0.22 ms/0.15 ms

16 8 12 microseconds/8.2 milliseconds 0.48 ms/0.33 ms

32 4 24 microseconds/16 milliseconds 0.98 ms/0.68 ms

64 2 47 microseconds/33 milliseconds 2.0 ms/1.4 ms

128 1 95 microseconds/66 milliseconds 4.0 ms/2.8 ms

Tip Changing the interleave depth affects the PHY layer on the downstream and disconnects all online CMs. For
this reason, if you are using N+1 HCCP redundancy, you should configure this command on both the Protect
and Working interfaces, so that the PHY layer is properly configured before a switchover occurs. Otherwise,
online CMs could be disconnected when a switchover occurs. (This also applies to the cable downstream
annex and cable downstream modulation commands.)

Examples The following example shows how to configure the downstream interleave depth to 128 microseconds:

Router# configure terminal

Router(config)# interface cable 3/0
Router(config-if)# cable downstream interleave-depth 128

Cisco CMTS Cable Command Reference

178
 Cable Commands: cable d
cable downstream modulation

cable downstream modulation

To set the modulation format for a downstream port on a cable interface line card, use the cable downstream
modulation command in cable interface configuration mode.

cable downstream modulation {64qam | 256qam}

Syntax Description
Syntax Description 64qam Modulation rate is 6 bits per downstream symbol.

256qam Modulation rate is 8 bits per downstream symbol.

Command Default The default modulation for Cisco RF Gateway 10 is 64 QAM.

Command Modes
Interface configuration—cable interface only (config-if)

Command History
Command History Release Modification

11.3 XA This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines Downstream modulation defines the speed in bits per second at which data travels downstream to the
subscriber’s CM. A symbol is the basic unit of modulation. QPSK encodes 2 bits per symbol, 16-QAM encodes
4 bits per symbol, 64-QAM encodes 6 bits per symbol, and 256-QAM encodes 8 bits per symbol.

Note Setting a downstream modulation format of 256-QAM requires approximately a 6-dB higher signal-to-noise
ratio (SNR) than 64-QAM at the subscriber’s cable modem. If your network is marginal or unreliable at
256-QAM, use the 64-QAM format instead.

Tip Changing the modulation format affects the PHY layer on the downstream and disconnects all online CMs.
For this reason, if you are using N+1 HCCP redundancy, you should configure this command on both the
Protect and Working interfaces, so that the PHY layer is properly configured before a switchover occurs.
Otherwise, online CMs could be disconnected when a switchover occurs. (This also applies to the cable
downstream annex and cable downstream interleave-depth commands.)

Examples The following example shows how to set the downstream modulation to 256-QAM:

Cisco CMTS Cable Command Reference

179
 Cable Commands: cable d
cable downstream modulation

Router# configure terminal

Router(config)# interface cable 3/0
Router(config-if)# cable downstream modulation 256qam

Cisco CMTS Cable Command Reference

180
 Cable Commands: cable d
cable downstream ofdm-chan-profile

cable downstream ofdm-chan-profile

To define the OFDM channel profile on the OFDM channel, use the cable downstream ofdm-chan-profile
command in global configuration mode. To remove the profile, use no form of this command.

cable downstream ofdm-chan-profile id

no cable downstream ofdm-chan-profile id

Syntax Description
Syntax Description id Downstream OFDM modulation profile ID. Valid range is from 20 to 255.

Command Default None

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to define the OFDM channel profile for the OFDM channel.

Examples The following example shows how to enable the OFDM channel profile configuration:

Router# configure terminal

Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)#

Related Commands Command Description

cyclic-prefix Specify the channel cyclic-prefix.

description (OFDM channel profile) Specify a user defined description for the profile.

interleaver-depth Specify the channel interleaver-depth.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-control Specify default modulation or profile as the channel control profile.

profile-data Specify default modulation or profile as the channel data profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

roll-off Specify the channel roll-off value.

Cisco CMTS Cable Command Reference

181
 Cable Commands: cable d
cable downstream ofdm-chan-profile

Command Description

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

show cable ofdm-chan-profiles Verify the OFDM channel profile configuration.

Cisco CMTS Cable Command Reference

182
 Cable Commands: cable d
cable downstream ofdm-flow-to-profile

cable downstream ofdm-flow-to-profile

To override the profile selection logic, use the cable downstream ofdm-flow-to-profile command in global
configuration mode.

Cisco cBR-8 Converged Broadband Router

cable downstreamofdm-flow-to-profile [interface Integrated-Cable slot/subslot/port:chan]profile-data
profile ID mac-address cable-modem-mac

Syntax Description profile ID Data profile identifier.

cable-modem-mac MAC address of the cable modem.

slot/subslot/port:chan Specifies the OFDM channel.

Command Default None

Command Modes Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Cisco IOS XE Everest This command was modified on the Cisco cBR Series Converged Broadband
16.6.1 Routers. The interface integrated-Cable keyword was added.

Usage Guidelines When this command is configured, all the service flows on the cable modem, identified by its MAC address,are
mapped to the specified data profile. With the Interface option, profile override can be specified for a particular
downstream OFDM channel. Thus with two OFDM downstream channels on a single CM, each channel can
have a unique profile override. When the ofdm-flow-to-profile override is configured and no OFDM channel
is specified, the profile Id will apply to all OFDM channels in use on the cable modem.

Examples The following example shows how to override the selection logic:
Router(config)# cable downstream ofdm-flow-to-profile profile-data 2 mac-address
fc52.8d5e.9e55

Once this command is configured, all the service flows on the cable modem whose MAC address is
fc52.8d5e.9e55, are mapped to the profile ID 2.
The following example shows how to override the selection logic on a specific channel.

Router(config)# cable downstream ofdm-flow-to-profile interface integrated-Cable 1/0/0:158

profile-data 3 mac-address 4800.33ea.7012

Router(config)# cable downstream ofdm-flow-to-profile interface integrated-Cable 1/0/0:159

profile-data 2 mac-address 4800.33ea.7012

Cisco CMTS Cable Command Reference

183
 Cable Commands: cable d
cable downstream ofdm-flow-to-profile

Related Commands Command Description

cable downstream ofdm-prof-mgmt unfit-profile-age Configure the unfit profile age.

age

cable downstream ofdm-prof-mgmt Configure the recommended profile age.

recommend-profile-age age

cable downstream ofdm-prof-mgmt Configure the RxMER poll interval.

rxmer-poll-interval interval

cable downstream ofdm-prof-mgmt exempt-sc-pct Configure the percentage of subcarriers that can
percent be exempted from bit loading comparison.

no cable downstream ofdm-prof-mgmt Disable the automatic profile downgrade upon

prof-dwngrd-auto CM status event 16.

cable downstream ofdm-prof-mgmt mer-margin-qdb Configure the offset.

quarter-decibel

Cisco CMTS Cable Command Reference

184
 Cable Commands: cable d
cable downstream ofdm-modulation-profile

cable downstream ofdm-modulation-profile

To define the OFDM modulation profile on the OFDM channel, use the cable downstream
ofdm-modulation-profile command in global configuration mode. To remove the profile, use no form of
this command.

cable downstream ofdm-modulation-profile id

no cable downstream ofdm-modulation-profile id

Syntax Description
Syntax Description id Downstream OFDM modulation profile ID. Valid range is from 8 to 255.

Command Default None

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to define the OFDM modulation profile for the OFDM channel.

Examples The following example shows how to enable the OFDM modulation profile configuration:

Router# configure terminal

Router(config)# cable downstream ofdm-modulation-profile 21
Router(config-ofdm-mod-prof)#

Related Commands Command Description

assign Assign modulations to subcarriers.

description (OFDM modulation Specify a user defined description for the profile up to 64
profile) characters.

start-frequency (Optional) Specify the starting frequency associated with the first
configurable subcarrier in the profile determined by the width.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this

profile.

width Specify width of profile in Hz.

show cable ofdm-modulation-profiles Verify the OFDM modulation profile configuration.

Cisco CMTS Cable Command Reference

185
 Cable Commands: cable d
cable downstream ofdm-power-profile

cable downstream ofdm-power-profile

To configure an OFDM Power Profile on a DOCSIS 3.1 system, use the cable downstream
ofdm-power-profile command in the global configuration mode.

cable downstream ofdm-power-profile {profile_id}

Syntax Description profile_id Specify a global power profile ID. You can define up to 64 OFDM power profiles with IDs
from 1 to 64.
This profile ID is used to apply the power profile to an OFDM channel in a controller-integrated
cable OFDM channel configuration. You can apply a single OFDM power profile to multiple
OFDM channels.

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS-XE Release This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to apply a power profile to an OFDM channel on the Cisco cBR Series Converged Broadband
Router.

The following example shows how to configure an OFDM power profile:

Router# configure terminal
Router(config)# cable downstream ofdm-power-profile 3
power-adjust-default 0.0
power-tilt-linear 3.5
band-index 0
power-adjust 4.0

controller Integrated-Cable 3/0/0

...
rf-chan 158
power-profile 3

Related Commands Command Description

power-adjust-default Specifies the default power level value applied to

bands that are not configured using other means. This
value is also the starting power level for band 0 when
a linear power-tilt is configured.
The value is specified in dB. The valid range is limited
by integrated-controllers in which the
ofdm-power-profile is configured. The range remains
between –9 and +8 dB.

Cisco CMTS Cable Command Reference

186
Cable Commands: cable d
cable downstream ofdm-power-profile

Command Description

power-tilt-linear Specifies the amount of linear tilt that is corrected

across the OFDM channel. The power tilt is applied
from the band value 0, specified by the
power-adjust-default value, to the last band value,
specified by the power-tilt-linear value.
Each band in-between is set to a power level based
on the linear interpolation between these two values
(to the nearest 1/10th dB).
The integrated-cable controllers in which the OFDM
power profile is configured limits the valid range for
power-tilt-linear. The range remains between –9
dB and +8 dB.

band-index Specifies a particular band or sequence of bands.

power-adjust Specifies a power-level override for the current

band-index range. Each band is set to the specified
value. This command takes precedence over the
power-tilt-linear values.

ofdm-channel-width Specifies the channel width of the OFDM power

profile in hertz (Hz).
This width should match the OFDM channel width
as configured in the integrated-cable (IC) controller
OFDM channels.
If the channel width of the OFDM power profile is
larger than the IC controller OFDM channel width,
the system allows configurations. However, it does
not use all band settings of the 6 MHz bands of the
power-profile.
If the channel width of the OFDM power profile is
smaller than the IC controller OFDM channel width,
configuring the OFDM power profile in the IC
controller OFDM channel is not allowed.

controller Integrated-Cable {slot}/{subslot}/{port} The {ofdm-power-profile-id} specifies the global

OFDM power profile that is applied to the OFDM
rf-channel {158 - 162 }
channel of this controller.
power-profile {ofdm-power-profile-id}

Cisco CMTS Cable Command Reference

187
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt exempt-sc-pct

cable downstream ofdm-prof-mgmt exempt-sc-pct

To configure a percentage of subcarriers that can be exempted from bit loading comparison, use the cable
downstream ofdm-prof-mgmt exempt-sc-pct percent command in global configuration mode.

Cisco cBR-8 Converged Broadband Router

cable downstream ofdm-prof-mgmt exempt-sc-pct percent

Syntax Description percent Percentage of subcarriers that can be exempted from bit loading comparison. The valid range is
from 0 to 100 percent.

Command Default 2 percent

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The configured percentage value is used while comparing a modem's desired bit loading values (derived from
its RxMER) to the profiles. It is also used while comparing profiles to determine their ordering.

Examples The following example shows how to configure the percentage of subcarriers that can be exempted
from bit loading comparison:
Router(config)# cable downstream ofdm-prof-mgmt exempt-sc-pct 20

Related Commands Command Description

cable downstream ofdm-prof-mgmt unfit-profile-age age Configure the unfit profile age.

cable downstream ofdm-prof-mgmt Configure the recommended profile age.

recommend-profile-age age

cable downstream ofdm-prof-mgmt rxmer-poll-interval Configure the RxMER poll interval.

interval

cable downstream ofdm-prof-mgmt mer-margin-qdb Configure the offset.

quarter-decibel

no cable downstream ofdm-prof-mgmt prof-dwngrd-auto Disable the automatic profile downgrade upon
CM status event 16.

cable downstream ofdm-flow-to-profile profile-data profile Override the selection logic.

ID mac-address cable-modem-mac

Cisco CMTS Cable Command Reference

188
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt mer-margin-qdb

cable downstream ofdm-prof-mgmt mer-margin-qdb

To configure the offset in quarter-decibel (DB), when RxMER is mapped to the ideal bit loading, use the
cable downstream ofdm-prof-mgmt mer-margin-qdb command in global configuration mode.

Cisco cBR-8 Converged Broadband Router

cable downstream ofdm-prof-mgmt mer-margin-qdb quarter-decibel

Syntax Description quarter-decibel Quarter-decibel to configure the offset. The valid value is from 0 to 40 quarter-DB.

Command Default 0 quarter-DB

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This value is used to control the aggressiveness in mapping RxMER values to the desired bit loading values
by a CM. The configured offset value is added to the RxMER before using the default RxMER to bit loading
mapping table published in DOCSIS 3.1 OSSI.

Examples The following example shows how to configure the offset:

Router(config)# cable downstream ofdm-prof-mgmt mer-margin-qdb 20

Related Commands Command Description

cable downstream ofdm-prof-mgmt unfit-profile-age Configure the unfit profile age.

age

cable downstream ofdm-prof-mgmt Configure the recommended profile age.

recommend-profile-age age

cable downstream ofdm-prof-mgmt rxmer-poll-interval Configure the RxMER poll interval.

interval

cable downstream ofdm-prof-mgmt exempt-sc-pct Configure the percentage of subcarriers that can
percent be exempted from bit loading comparison.

no cable downstream ofdm-prof-mgmt Disable the automatic profile downgrade upon

prof-dwngrd-auto CM status event 16.

cable downstream ofdm-flow-to-profile profile-data Override the selection logic.

profile ID mac-address cable-modem-mac

Cisco CMTS Cable Command Reference

189
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt prof-dwngrd-auto

cable downstream ofdm-prof-mgmt prof-dwngrd-auto

To disable the automatic profile downgrade upon CM-status event 16, use the no cable downstream
ofdm-prof-mgmt prof-dwngrd-auto command in global configuration mode.

Cisco cBR-8 Converged Broadband Router

no cable downstream ofdm-prof-mgmt prof-dwngrd-auto

Command Default The automatic profile downgrade upon CM-status event 16 is enabled by default.

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to disable the automatic profile downgrade upon CM-status event
16:
Router(config)# no cable downstream ofdm-prof-mgmt prof-dwngrd-auto

Related Commands Command Description

cable downstream ofdm-prof-mgmt unfit-profile-age age Configure the unfit profile age.

cable downstream ofdm-prof-mgmt Configure the recommended profile age.

recommend-profile-age age

cable downstream ofdm-prof-mgmt rxmer-poll-interval Configure the RxMER poll interval.

interval

cable downstream ofdm-prof-mgmt exempt-sc-pct percent Configure the percentage of subcarriers that
can be exempted from bit loading comparison.

cable downstream ofdm-prof-mgmt mer-margin-qdb Configure the offset.

quarter-decibel

cable downstream ofdm-flow-to-profile profile-data Override the selection logic.

profile ID mac-address cable-modem-mac

Cisco CMTS Cable Command Reference

190
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt prof-order-method

cable downstream ofdm-prof-mgmt prof-order-method

To configure the type of OFDM Profile Downgrade method cable downstream ofdm-prof-mgmt
prof-order-method command in global configuration mode. Using the no cable downstream
ofdm-prof-mgmt prof-order-method command, configures the default option (bit-loading).

Cisco cBR-8 Converged Broadband Router

cable downstream ofdm-prof-mgmt prof-order-method { bit-loading | capacity }

no cable downstream ofdm-prof-mgmt prof-order-method

Syntax Description bit-loading Legacy method of profile downgrade.

capacity Configure this option if you wish to downgrade the profile based on the capacity. This option
does not skip any good profiles.

Command Default The bit-loading option is configured by default.

Command Modes
Global configuration (config)

Command History
Command History Release Modification

Cisco IOS XE Dublin This command is introduced on the Cisco cBR Series Converged Broadband
17.12.1z Routers.

Usage Guidelines The following example shows how to configure the capacity method of downgrading OFDM profiles.
Router(config)# cable downstream ofdm-prof-mgmt prof-order-method capacity

Related Commands Command Description

cable downstream ofdm-prof-mgmt recommend-profile-age Configure the recommended profile age.

age

Cisco CMTS Cable Command Reference

191
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt prof-upgrade-pma

cable downstream ofdm-prof-mgmt prof-upgrade-pma

To enable the external profile management application (PMA), use the cable downstream ofdm-prof-mgmt
prof-upgrade-pma command in global configuration mode. This will disable internal PMA. To disable
external PMA, use no form of this command. This will enable internal PMA.

Cisco cBR-8 Converged Broadband Router

cable downstream ofdm-prof-mgmt prof-upgrade-pma

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to disable the PMA:

Router(config)# cable downstream ofdm-prof-mgmt prof-upgrade-pma

Related Commands Command Description

cable downstream ofdm-prof-mgmt unfit-profile-age Configure the unfit profile age.

age

cable downstream ofdm-prof-mgmt Configure the recommended profile age.

recommend-profile-age age

cable downstream ofdm-prof-mgmt rxmer-poll-interval Configure the RxMER poll interval.

interval

cable downstream ofdm-prof-mgmt exempt-sc-pct Configure the percentage of subcarriers that can
percent be exempted from bit loading comparison.

cable downstream ofdm-prof-mgmt mer-margin-qdb Configure the offset.

quarter-decibel

cable downstream ofdm-flow-to-profile profile-data Override the selection logic.

profile ID mac-address cable-modem-mac

no cable downstream ofdm-prof-mgmt Disable the automatic profile downgrade upon

prof-dwngrd-auto CM status event 16.

Cisco CMTS Cable Command Reference

192
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt recommend-profile-age

cable downstream ofdm-prof-mgmt recommend-profile-age

To configure the recommended profile age, use the cable downstream ofdm-prof-mgmt
recommend-profile-age command in global configuration mode.

Cisco cBR-8 Converged Broadband Router

cable downstream ofdm-prof-mgmt recommend-profile-age age

Syntax Description age Recommended profile age in minutes. The valid range is from 5 to 1440 minutes.

Command Default 120 minutes

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines If the recommended profile for a cable modem exceeds this age, that profile is no longer valid.

Examples The following example shows how to configure the recommended profile age:
Router(config)# cable downstream ofdm-prof-mgmt recommend-profile-age 20

Related Commands Command Description

cable downstream ofdm-prof-mgmt unfit-profile-age Configure the unfit profile age.

age

cable downstream ofdm-prof-mgmt rxmer-poll-interval Configure the RxMER polling interval.

interval

cable downstream ofdm-prof-mgmt exempt-sc-pct Configure the percentage of subcarriers that can
percent be exempted from bit loading comparison.

cable downstream ofdm-prof-mgmt mer-margin-qdb Configure the offset.

quarter-decibel

no cable downstream ofdm-prof-mgmt Disable the automatic profile downgrade upon

prof-dwngrd-auto CM status event 16.

cable downstream ofdm-flow-to-profile profile-data Override the selection logic.

profile ID mac-address cable-modem-mac

Cisco CMTS Cable Command Reference

193
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt rxmer-poll-interval

cable downstream ofdm-prof-mgmt rxmer-poll-interval

To configure the Receive Modulation Error Ratio (RxMER) poll interval, use the cable downstream
ofdm-prof-mgmt rxmer-poll-interval command in global configuration mode.

Cisco cBR-8 Converged Broadband Router

cable downstream ofdm-prof-mgmt rxmer-poll-interval interval

Syntax Description interval RxMER poll interval in minutes. The valid range is from 5 to 1440 minutes.

Command Default 60 minutes

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The CMTS uses OPT message with bit-0 option to collect RxMER data from CMs, after the initial CM
registration and periodically thereafter. The RxMER collection period or the poll interval is configurable. The
collected RxMER data is used to compute the recommended profile for each CM.

Examples The following example shows how to configure the RxMER poll interval:
Router(config)# cable downstream ofdm-prof-mgmt rxmer-poll-interval 20

Related Commands Command Description

cable downstream ofdm-prof-mgmt unfit-profile-age Configure the unfit profile age.

age

cable downstream ofdm-prof-mgmt Configure the recommended profile age.

recommend-profile-age age

cable downstream ofdm-prof-mgmt exempt-sc-pct Configure the percentage of subcarriers that can
percent be exempted from bit loading comparison.

cable downstream ofdm-prof-mgmt mer-margin-qdb Configure the offset.

quarter-decibel

no cable downstream ofdm-prof-mgmt Disable the automatic profile downgrade upon

prof-dwngrd-auto CM status event 16.

cable downstream ofdm-flow-to-profile profile-data Override the selection logic.

profile ID mac-address cable-modem-mac

Cisco CMTS Cable Command Reference

194
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt unfit-profile-age

cable downstream ofdm-prof-mgmt unfit-profile-age

To configure the unfit profile age, use the cable downstream ofdm-prof-mgmt unfit-profile-age command
in global configuration mode. Using the no cable downstream ofdm-prof-mgmt unfit-profile-age command
reverts to the default unfit-profile-age configuration of 60 minutes.

Cisco cBR-8 Converged Broadband Router

cable downstream ofdm-prof-mgmt unfit-profile-age { age | diasble }

no cable downstream ofdm-prof-mgmt unfit-profile-age

Syntax Description age Unfit profile age in minutes. The valid range is 5–1440 minutes.

diasble Disable OFDM Unfit Profile aging. This is equivalent to an infinite timer.

Command Default 60 minutes

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Cisco IOS XE Dublin The diasble option is introduced.

17.12.1z

Usage Guidelines If the unfit profile for a cable modem exceeds this age, the profile is no longer considered unfit for that CM.

Examples The following example shows how to configure the unfit profile age:
Router(config)# cable downstream ofdm-prof-mgmt unfit-profile-age 20

Examples The following example shows you how to disable OFDM Unfit Profile aging (Cisco IOS XE Dublin
17.12.1z and later):
Router(config)# cable downstream ofdm-prof-mgmt unfit-profile-age disable

Related Commands Command Description

cable downstream ofdm-prof-mgmt Configure the recommended profile age.

recommend-profile-age age

cable downstream ofdm-prof-mgmt rxmer-poll-interval Configure the RxMER poll interval.

interval

Cisco CMTS Cable Command Reference

195
 Cable Commands: cable d
cable downstream ofdm-prof-mgmt unfit-profile-age

Command Description

cable downstream ofdm-prof-mgmt exempt-sc-pct Configure the percentage of subcarriers that can
percent be exempted from bit loading comparison.

cable downstream ofdm-prof-mgmt mer-margin-qdb Configure the offset.

quarter-decibel

no cable downstream ofdm-prof-mgmt Disable the automatic profile downgrade upon

prof-dwngrd-auto CM status event 16.

cable downstream ofdm-flow-to-profile profile-data Override the selection logic.

profile ID mac-address cable-modem-mac

Cisco CMTS Cable Command Reference

196
 Cable Commands: cable d
cable downstream override

cable downstream override

To enable cable downstream frequency override, use the cable downstream override command in cable
interface configuration mode. To disable the override feature, use the no form of this command.

cable downstream override

no cable downstream override

Syntax Description This command has no keywords or arguments.

Command Default Cable downstream frequency override is enabled by default.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.0(13)SC This command was introduced.

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

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

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Router.

Usage Guidelines This command is never needed for normal operations, because downstream frequency override is enabled by
default for DOCSIS operations. However, this command can be used to disable the frequency override feature
for test and lab use, so as to force the CMs on that interface to use a particular downstream frequency, regardless
of the signal quality.

Note Because frequency override is enabled by default, this command does not appear as part of a cable interface’s
configuration section in the Cisco CMTS router configuration file unless the no cable downstream override
command has been given.

Examples The following example shows how to disable the downstream frequency override feature on a
particular cable interface:

Router# configure terminal

Router(config)# interface cable 6/0
Router(config-if)# no cable downstream override

Cisco CMTS Cable Command Reference

197
 Cable Commands: cable d
cable downstream override

Router(config-if)# exit

Examples for Cisco cBR Series Converged Broadband Router

This example shows how to disable the downstream frequency override feature on a particular cable
interface:

Router# configure terminal

Router(config)# interface cable 1/0/0
Router(config-if)# no cable downstream override
Router(config-if)# exit

Use the show running-config | include override to see the disabled status of the command:

Router#show running-config | include override

no cable downstream override
Router#

Cisco CMTS Cable Command Reference

198
 Cable Commands: cable d
cable downstream power-down-2nd-module

cable downstream power-down-2nd-module

To reduce power consumption on Cisco cBR-8 by powering down the second PHY module on the CCAP line
card, use the cabledownstreampower-down-2nd-module slot command in global configuration mode.

cable downstream power-down-2nd-module slot

Command Default None.

Command Modes Global configuration (config).

Command History Release Modification

Cisco IOS XE Fuji This command was introduced on the Cisco cBR Series Converged Broadband
16.9.1 Router.

Examples The following example shows how to set up the power saving configuration.

Router# configure terminal

Router(config)# cable downstream power-down-2nd-module slot 1

Cisco CMTS Cable Command Reference

199
 Cable Commands: cable d
cable downstream qam-profile

cable downstream qam-profile

To set the QAM profile for the cable interface line card, use the cable downstream qam-profile command
in global configuration mode.

cable downstream qam-profile id

Syntax Description
Syntax Description id Downstream QAM profile ID. 0 to 3 are system defined, 4 to 31 are user defined.

Command Default None

Command Modes
Global configuration (config)

Command History
Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to set the QAM profile for the cable interface line card.

Examples The following example shows how to enable the downstream QAM profile configuration:

Router# configure terminal

Router(config)# cable downstream qam-profile 4
Router(config-qam-prof)#

Related Commands Command Description

annex Set the MPEG framing format.

interleaver-depth Set the interleaver-depth.

modulation Set the QAM modulation format.

spectrum-inversion Set the spectrum-inversion on or off.

symbol-rate Set the symbol rate.

Cisco CMTS Cable Command Reference

200
 Cable Commands: cable d
cable downstream qos wfq weight

cable downstream qos wfq weight

To specify custom DOCSIS priority to excess ratio mappings for downstream service flows, use the cable
downstream qos wfq weight command in cable interface configuration mode. Use the no form of this
command to revert to the default mappings.

cable downstream qos wfq weights weight1...weight8

no cable downstream qos wfq weights

Syntax Description weights Specifies the custom excess ratios for 8 priorities.
weight
• weight1...weight8 —Custom weight. Valid values range from 1 to
100.

Command Default DOCSIS priority to excess ratio mapping is used.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines This command configures custom DOCSIS priority to excess ratio mappings for downstream service flows.

Examples This example example shows how to configure custom DOCSIS priority to excess ratio mappings
for downstream service flows on a cable interface of Cisco uBR series router:

Router# configure terminal

Router(config)# interface cable 8/0/0
Router(config-if)# cable downstream qos wfq weights 10 20 30 40 50 60 70 80

Examples for Cisco cBR Series Converged Broadband Router

This example shows the configuration of QoS WFG weights on the wideband cable interface of a
Cisco cBR-8 router:

Router(config)#interface wideband-Cable 1/0/0:0

Router(config-if)#cable downstream qos wfq weights 10 20 30 40 50 60 70 80

This example shows the configuration on integrated cable interface of a Cisco cBR-8 router:

Router(config)#interface integrated-Cable 1/0/0:1

Cisco CMTS Cable Command Reference

201
 Cable Commands: cable d
cable downstream qos wfq weight

Router(config-if)#cable downstream qos wfq weights 10 20 30 40 50 60 70 80

Related Commands Command Description

show cr10k-rp queue Displays the queue parameters associated with downstream service
flow queues (including the excess ratio). (This command is not
supported in Cisco cBR-8 routers.)

show running-config interface cable Displays the configuration for the specified cable interface on a
Cisco uBR series router.

show running-config interface Displays the configuration for the specified cable interface on a
[wideband-Cable | integrated-Cable Cisco cBR-8 router.

Cisco CMTS Cable Command Reference

202
 Cable Commands: cable d
cable downstream rate-limit

cable downstream rate-limit

Note Effective with Cisco IOS Release 12.2(33)SCF, the cable downstream rate-limit command is not supported
for Cisco uBR-MC88U line card in Cisco IOS software.

To enable DOCSIS rate limiting on downstream traffic, use the cable downstream rate-limit command in
cable interface configuration mode. To disable DOCSIS rate limiting on downstream traffic, use the no form
of this command.

cable downstream rate-limit [token-bucket [[shaping [granularity msec | max-delay msec]] |

weighted-discard]] [exp-weight]
no cable downstream rate-limit

Syntax Description token-bucket (Optional) Specifies the token-bucket filter algorithm, which enforces an average long-term
transmission rate while permitting occasional bursts.

shaping (Optional in Release 12.1 EC, Required in Release 12.2 BC) Enables rate limiting on the
downstream port using the token-bucket policing algorithm with default traffic shaping
parameters.

granularitymsec (Optional) Specifies traffic shaping granularity in milliseconds. Valid values are 1, 2, 4,
8, or 16 milliseconds.

max-delay msec (Optional) Specifies the maximum traffic-shaping buffering delay in milliseconds. Valid
values are 128, 256, 512, or 1028 milliseconds. As a general guideline, the lower the
downstream rates, the higher the delay should be to ensure full use of the bandwidth.

weighted-discard (Optional) Specifies the weighted discard algorithm.

exp-weight (Optional) Specifies the weight for the exponential moving average of loss rate. Valid
values are from 1 to 4.

Command Default In Cisco IOS Release 12.1 EC and earlier releases, the system defaults to monitoring the traffic to and from
each CM over each 1-second period, and if the CM exceeds its bandwidth quota for that second, the CMTS
router drops packets for the rest of the second (no cable downstream rate-limit).
In Cisco IOS Release 12.2 BC and later releases, the token-bucket and shaping keywords are on by default,
and the max-delay option is set to 128 milliseconds (cable downstream rate-limit token-bucket shaping
max-delay 128).

Note In Cisco IOS Release 12.2 BC, do not use the cable downstream rate-limit token command without specifying
the shaping option, because this results in packet drops.

Command Modes
Interface configuration—cable interface only (config-if)

Cisco CMTS Cable Command Reference

203
 Cable Commands: cable d
cable downstream rate-limit

Command History Release Modification

11.3(6) NA This command was introduced.

12.0(4)XI, 12.0(5)T1, 12.1(1)EC1 The shaping keyword was added.

12.2(4)BC1 Support was added to the 12.2 BC train, and the defaults were changed
so that the shaping keyword is on by default, to accommodate DOCSIS
1.1 requirements.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCF This command does not support Cisco uBR-MC88U line card in Cisco
IOS software.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines The cable downstream rate-limit command specifies the type of DOCSIS rate limiting that the CMTS router
imposes on downstream traffic that is sent to the CMs. When rate-limiting is enabled, traffic to the CM is
examined to ensure it will not exceed the limit set for the CM.
For DOCSIS networks, the best rate limiting algorithm combines the token-bucket and shaping to use
keywords, which is optimized for relatively steady data rates, such as are used for web browser, without
allowing the user to exceed the maximum allowable download rate that is specified in the DOCSIS configuration
file.

Note The token-bucket and shaping options are the default in Cisco IOS Release 12.2 BC and should not be
changed. If using a 64 kbps downstream rate, you can avoid a performance impact by turning off the shaping
option, but this is not recommended for DOCSIS 1.1 operation because it can result in erratic traffic patterns
and packet drops on the downstream.

If a packet would exceed the traffic limits for a CM, the CMTS router will buffer the packet, up to the maximum
delay time given by the max-delay option, so that the traffic can be sent at a later time when it would not
violate the maximum downstream traffic limits. If the packet is still too large, or if the volume of traffic
consistently exceeds the traffic limits, even after the delay, the CMTS router begins dropping packets.
The default behavior of the cable downstream rate-limit command was changed in Cisco IOS Release 12.2
BC to accommodate the different requirements of DOCSIS 1.1 operation (which requires the use of the
token-bucket rate-limiting algorithm). This default is optimized for downstream traffic rates that are higher
than 84 kbps.
If you are using a 64 kbps downstream traffic rate on a Cisco CMTS router that is running Cisco IOS Release
12.2 BC, you should set the max-delay option to 256 milliseconds to avoid a performance impact on TCP/IP
traffic that uses packets larger than 1024 bytes (such as FTP or HTTP web traffic). Alternatively, you can set
the max-burst option on the cable service class command to 3044, which is two packets of the minimum
size for DOCSIS 1.1 networks.
Understanding the max-delay and granularity Options

Cisco CMTS Cable Command Reference

204
 Cable Commands: cable d
cable downstream rate-limit

The Cisco CMTS router uses a calendar-queuing system to process the packets being shaped. The calendar
queue is a time wheel that is as big as the value specified by the max-delay option (128, 256, 512, or 1028
milliseconds), and is divided into “buckets” of the size specified by the granularity option (1, 2, 4, 8, or 16
milliseconds).
The number of buckets depends on both the max-delay and granularity options. For example, if the max-delay
option is set to 256 milliseconds, and the granularity option is set to 4 milliseconds, the calendar queue
contains 256/4, or 64, buckets, where a new bucket is processed every 4 milliseconds.
When the Cisco CMTS router adds a shaped packet to the queue, it adds the packet into the bucket that
corresponds to the deadline by which the packet must be processed. At the end of every granularity time
period, the Cisco CMTS router processes the packets that are in the corresponding bucket.
Decreasing the max-delay value increases how often the packets in the entire queue are processed, while
decreasing the granularity value increases the accuracy of the shaping mechanism. Decreasing these values,
however, could result in a possible increase in CPU processor usage. In most circumstances, this increase in
processor usage is negligible, but it should be monitored whenever fine-tuning the max-delay or granularity
values.

Tip For more information about the DOCSIS 1.1 rate-limiting specifications, see section C.2.2.5.2, Maximum
Sustained Traffic Rate , in the DOCSIS 1.1 specification.

Examples The following example shows how to apply the token-bucket filter algorithm on a Cisco uBR7200
series router running Cisco IOS Release 12.1 EC:

Router(config)# interface cable 6/0

Router(config-if)# cable downstream rate-limit token-bucket

The following example shows how to apply the token-bucket filter algorithm on a Cisco uBR10012
router running Cisco IOS Release 12.2 BC:

Router(config)# interface cable 5/1/0

Router(config-if)# cable downstream rate-limit token-bucket shaping

The following example shows how to use token-bucket shaping with a max-delay of 256 milliseconds
on a Cisco uBR7100 series router:

Router(config)# interface cable 1/0

Router(config-if)# cable downstream rate-limit token-bucket shaping max-delay 256

Related Commands Command Description

cable service class Sets the parameters for a DOCSIS 1.1 cable service class.

cable upstream rate-limit Sets DOCSIS rate limiting for an upstream port on a cable interface line card.

Cisco CMTS Cable Command Reference

205
 Cable Commands: cable d
cable downstream rf-power

cable downstream rf-power

To set the RF power output level on an integrated upconverter on the Cisco uBR7100 series router, Cisco
uBR-MC16U, Cisco uBR-MC28U, or Cisco uBR10-MC5X20S/U cable interface line card, use the cable
downstream rf-power command in cable interface configuration mode. To reset the RF output power level
to its default value, use the no form of this command.

cable downstream rf-power {power-level | hccp-delta diff-pwr | hccp-override override-pwr}

no cable downstream rf-power {power-level | hccp-delta diff-pwr | hccp-override override-pwr}

Syntax Description power-level RF output power level in dBmV. The valid range is from 45 to 63 dBmV.
Note
The official range for acceptable power levels in the DOCSIS specification is 50 to 61
dBmV. Cisco cable interfaces exceed the DOCSIS standard, but power levels outside
the DOCSIS standards should be used only in lab and test environments.

hccp-delta (Protect interfaces only) When using N+1 Hotstandby Connection-to-Connection Protocol
diff-pwr (HCCP) redundancy, the protect interface adds the diff-pwr value to the current power
value of the working interface when a switchover occurs. This allows the router to
accommodate relative differences between the RF power levels in working and protect
interfaces. The valid value for diff-pwr ranges from –12 to +12 dBmV.

hccp-override (Protect interfaces only) When using N+1 HCCP redundancy, the protect interface uses
override-pwr the override power value instead of the power value of the working interface when a
switchover occurs. This allows the router to accommodate absolute differences between
the RF power levels in working and protect interfaces. The valid value for override-pwr
ranges from 45 to 63 dBmV.
Note
The official range for acceptable power levels in the DOCSIS specification is 50 to 61
dBmV. Cisco cable interfaces exceed the DOCSIS standard, but power levels outside
the DOCSIS standards should be used only in lab and test environments.

Command Default 50 dBmV for the Cisco uBR7100 series router

55 dBmV for the Cisco uBR-MC5X20S cable interface line card on the Cisco uBR10012 router
55 dBmV for the Cisco uBR-MC16U and Cisco uBR-MC28U cable interface line cards
55 dBmV for the Cisco uBR10-MC5X20U-D cable interface line card on the Cisco uBR10012 router

Command Modes
Interface configuration (config-if).

Command History Release Modification

12.1(5)EC1 This command was introduced to provide support on the integrated upconverter
on the Cisco uBR7100 series router.

12.2(11)CY, 12.2(11)BC3 Support was added for the Cisco uBR10-MC5X20S cable interface line card on
the Cisco uBR10012 router.

Cisco CMTS Cable Command Reference

206
 Cable Commands: cable d
cable downstream rf-power

Release Modification

12.2(15)CX Support was added for the Cisco uBR-MC16U and Cisco uBR-MC28U cable
interface line cards.

12.2(15)BC2 Support was added for the Cisco uBR-MC5X20U cable interface line card.
Support was also added for the hccp-delta and hccp-override options.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCC4 Support for the following keywords was moved to the global redundancy
configuration mode:
• hccp-delta
• hccp-override

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband
Router.

Usage Guidelines

Note In Cisco IOS Release 12.2(33)SCC4, the support for the hccp-delta and hccp-override keywords is moved
from the interface configuration mode to the global redundancy configuration mode. You can now configure
these keyword options using the member subslot command.

The hccp-delta and hccp-override options can be configured only on a protect interface (an interface that
has been configured with the hccp protect command). However, it is possible to manually edit a configuration
file on a TFTP server to include these options on a working interface configuration, and then download that
configuration to the router from the TFTP server.
If you manually edit the Cisco IOS configuration files, ensure that you specify these options only on protect
interfaces. If you specify the hccp-delta or hccp-override option on a working interface, the router will
modify the configured downstream power with the given power delta or override value.
The official range for acceptable power levels in the DOCSIS standard depends on the stacking level. The
DOCSIS levels are as follows:
1:1 stacking—52 dBmV ~ 60 dBmV
2:1 stacking—48 dBmV ~ 56 dBmV
4:1 stacking—44 dBmV ~ 52 dBmV

Note Cisco cable interfaces exceed the DOCSIS standard, but power levels outside the DOCSIS standards should
be used only in lab and test environments.

Cisco CMTS Cable Command Reference

207
 Cable Commands: cable d
cable downstream rf-power

Examples The following example shows how to configure the integrated upconverter on a Cisco uBR7100
series router for an RF output power level of 45 dBmV:

Router(config)# cable interface 1/0

Router(config-if)# cable downstream rf-power 45

The following example shows how to configure the first integrated upconverter on a Cisco uBR10012
router for an RF output power level of 53 dBmV:

Router(config)# cable interface 5/1/0

Router(config-if)# cable downstream rf-power 53

The following commands shows how to configure the first integrated upconverter to the default
power level of 55 dBmV on the Cisco uBR10012 router:

Router(config)# cable interface 5/1/0

Router(config-if)# no cable downstream rf-power
Router(config-if)# exit

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(config)# cable interface 6/0/0

Router(config-if)# cable downstream rf-power hccp-delta 3
Router(config-if)# exit

The 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(config)# cable interface 6/0/0

Router(config-if)# cable downstream rf-power hccp-override 48
Router(config-if)# exit

Note The hccp-delta and hccp-override commands configure the power of the protect interface at the
time of the switchover. To display the RF power currently being used on a cable interface, use the
show controller cable command.

Related Commands Command Description

cable downstream frequency Configures the cable downstream center frequency on the integrated
upconverter.

cable downstream rf-shutdown Enables or disables the RF output from the integrated upconverter.

debug cable upconverter Enables debugging of the internal upconverter operation.

show controllers cable Displays status and configuration information for the cable interface,
including the integrated upconverter, if present.

Cisco CMTS Cable Command Reference

208
 Cable Commands: cable d
cable downstream rf-shutdown

cable downstream rf-shutdown

To disable the RF output from an integrated upconverter on the Cisco uBR7100 series router, Cisco
uBR-MC16U, Cisco uBR-MC28U or the Cisco uBR10-MC5X20S/U cable interface line card and Cisco RF
Gateway 10, use the cable downstream rf-shutdown command in cable interface configuration mode and
QAM interface and subinterface configuration mode. To enable the RF output on the integrated upconverter,
use the no form of this command.

cable downstream rf-shutdown

no cable downstream rf-shutdown

Syntax Description This command has no arguments or keywords.

Command Default RF output is disabled.

Command Modes
Interface configuration—cable interface only (config-if)

QAM interface and subinterface configuration (config-if and config-subif)

Command History Release Modification

12.1(5)EC1 This command was introduced to provide support on the integrated upconverter
on the Cisco uBR7100 series router.

12.2(11)CY, 12.2(11)BC3 Support was added for the Cisco uBR10-MC5X20S cable interface line card on
the Cisco uBR10012 router.

12.2(15)CX Support was added for the Cisco uBR-MC16U and Cisco uBR-MC28U cable
interface line cards.

12.2(15)BC2 Support was added for the Cisco uBR-MC5X20U cable interface line card.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(44)SQ This command was integrated into Cisco IOS Release 12.2(44)SQ. Support for
the Cisco RF Gateway 10 was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband
Router.

Usage Guidelines By default, the integrated upconverter on the Cisco uBR7100 series router, Cisco uBR-MC16U, Cisco
uBR-MC28U, and the Cisco uBR10-MC5X20S/U cable interface line cards is disabled, and the downstream
port does not output any signal. The no form of this command enables the integrated upconverter, allowing
it to output an RF signal through the downstream port.
However, before a valid DOCSIS downstream signal can be output, the following must also be done:

Cisco CMTS Cable Command Reference

209
 Cable Commands: cable d
cable downstream rf-shutdown

• A valid downstream RF frequency must be configured using the cable downstream frequency cable
interface command.
• The cable interface must be enabled using the no shutdown command on the cable interface.

Note This command does not affect the IF output from the DS0 downstream port on the Cisco uBR7100 series
router. The Cisco uBR10-MC5X20S/U, Cisco uBR-MC16U, and Cisco uBR-MC28U cable interface line
cards do not provide IF output for their downstream ports.

Executing this command at the port level command modifies all the QAM channels on that port. However no
channel is affected if the command is executed at the channel level.

Examples The following example enables the integrated upconverter on the Cisco uBR7100 series router:

Router(config)# cable interface 1/0

Router(config-if)# no cable downstream rf-shutdown

The following example enables the second integrated upconverter on a Cisco uBR-MC5X20S cable
interface line card in the Cisco uBR10012 router:

Router(config)# cable interface 7/0/1

Router(config-if)# no cable downstream rf-shutdown

The following commands must also be given before the DS0 RF port can transmit a valid RF signal:

Router(config-if)# cable downstream frequency

center-frequency

Router(config-if)# no shutdown

Router(config-if)# exit

router(config)#

Cisco RF Gateway 10
The following example enables the integrated upconverter on the Cisco RFGW-10:

Router(config)#configure terminal
Router(config-if)#interface qam 3/1.1
Router(config-subif)#cable downstream rf-shutdown

Related Commands Command Description

cable downstream frequency Configures the downstream center frequency on the integrated upconverter.

cable downstream rf-power Configures the desired RF output power on the integrated upconverter.

debug cable upconverter Enables debugging of the internal upconverter operation.

show controllers cable Displays status and configuration information for the cable interface,
including information about the integrated upconverter, if present.

Cisco CMTS Cable Command Reference

210
Cable Commands: cable d
cable downstream rf-shutdown

Command Description

show controllers qam Displays cable downstream information configured on the QAM channel
and port.

Cisco CMTS Cable Command Reference

211
 Cable Commands: cable d
cable ds-high-low-rate-ratio

cable ds-high-low-rate-ratio
If the ratio between the highest and the lowest rates on an interface is too high, the output traffic can become
bursty and may experience long delays. To specify the maximum allowed ratio to achieve expected latency
requirement, use thecable ds-high-low-rate-ratio command in global configuration mode. To remove this
configuration, use the no form of this command.

cable ds-high-low-rate-ratio ratio

no cable ds-high-low-rate-ratio

Syntax Description ratio Specifies the ratio of highest to lowest max-rate. Suggested value is 1000.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines This command only affects the service flows created after the ratio is configured. We suggest reset all modems
after configuring this ratio.

Examples The following example shows how to specify the maximum allowed ratio to achieve expected latency
requirement:

Router> enable
Router# configure terminal
Router(config)# cable ds-high-low-rate-ratio 2000

Cisco CMTS Cable Command Reference

212
 Cable Commands: cable d
cable ds-max-burst

cable ds-max-burst
To enable a specialized Enhanced-Rate Bandwidth Allocation (ERBA) feature on the Cisco uBR10012 router
with Performance Routing Engine 2 (PRE2) or Performance Routing Engine 4 (PRE4) modules, use thecable
ds-max-burst command in global configuration mode. To remove this configuration, use the no form of this
command.

cable ds-max-burst [burst-threshold threshold peak-rate peak-rate]

no cable ds-max-burst

Cisco cBR Series Converged Broadband Routers

cable ds-max-burst [burst-threshold threshold ]
no cable ds-max-burst

Syntax Description burst-threshold (Optional) Defines the burst threshold in Kbytes. The range is from 64 Kbyte to 2
threshold GB. The default is 1MB. For Cisco cBR Series Converged Broadband Routers, the
valid rang is from 64Kbyte to 1 GB.
This value is used to compare with the per-service flow maximum traffic burst value
as defined in DOCSIS 2.0.

peak-rate peak-rate Peak rate in Kbps. The default is 0, which represents the line rate.
(For Cisco uBR10012 Router and CiscouBR7200 Series Routers)The peak-rate
value is a global value and is applied to all the service flows created after the
configuration of cable ds-max-burst command.

Command Default This configuration is disabled on the Cisco uBR10012 router. This command is neither required nor supported
on the Cisco uBR7100 Series, Cisco uBR7225VXR and Cisco uBR7246VXR router.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced in support of ERBA on the Cisco uBR10012 router with
PRE2 modules.

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

12.2(33)SCB The peak-rate option was introduced and support for Performance Routing Engine 4 (PRE4)
was added in Cisco IOS Release 12.2(33)SCB.

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

Usage Guidelines Cisco IOS Release 12.3(21)BC introduces the ERBA feature on the Cisco uBR10012 CMTS with Performance
Routing Engine 2 (PRE2) modules. The ERBA feature in Cisco IOS release 12.3(21)BC is characterized by
the following enhancements:

Cisco CMTS Cable Command Reference

213
 Cable Commands: cable d
cable ds-max-burst

• Enables support for the DOCSIS1.1 Downstream Maximum Transmit Burst parameter on the Cisco
CMTS by using cable ds-max-burst configuration command. This command is not supported on the
Cisco uBR7225VXR, Cisco uBR7246VXR and the Cisco uBR7100 Series routers, as this parameter is
supported by default.
• Allows DOCSIS1.0 modems to support the DOCSIS1.1 Downstream Maximum Transmit Burst parameter
by using DOCSIS QoS profile. This feature uses the cable qos pro max-ds-burst configuration command.

Note Thecable ds-max-burst and related commands are supported only on the Cisco uBR10012 router with PRE2
or PRE4 modules on Cisco IOS Release 12.3(21)BC or later releases.

To display service flows on the Cisco uBR10012 router with PRE2 or PRE4, and identify which service flows
have maximum burst enabled, use the following command in privileged EXEC mode:
show cr10k-rp cable slot/subslot/port sid service-flow ds
• • slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)

For additional information about the cable qos profile command and configuring QoS profiles, see the DOCSIS
1.1 for the Cisco CMTS document on Cisco.com:
https://www.cisco.com/c/en/us/td/docs/switches/lan/catalyst9400/software/release/16-6/configuration_guide/
qos/b_166_qos_9400_cg/b_166_qos_9400_cg_chapter_01.html

Examples The following example shows how to configure ERBA on the Cisco uBR10012 router, with a sample
burst threshold setting:

Router> enable
Router# configure terminal
Router(config)# cable ds-max-burst burst-threshold 2048
peak-rate 1000
Router(config)# Ctrl^Z
Router# show cr10k-rp cable 7/0/0 sid service-flow ds

When this feature is enabled, new service flows with burst size larger than the burst threshold are
supported. However, the existing service flows are not affected.
When this feature is disabled, no new service flows are configured with the Downstream Maximum
Transmit Burst parameter—the cable ds-max-burst command settings. However, the existing service
flows are not affected.
The following example illustrates configuration of the ERBA maximum burst for the specified service
flow:

Router# sh cr10k-rp c7/0/0 1 service-flow ds

RP SFID LC SFID Conform Exceed Conform Exceed Total QID
Xmit Pkts Xmit Pkts Drop Pkts Drop Pkts Pkts
32930 10 41 0 0 0 41 131349
Forwarding interface: Modular-Cable1/0/0:0
32931 13 0 0 0 0 0 131350
Forwarding interface: Modular-Cable1/0/0:0

Cisco CMTS Cable Command Reference

214
 Cable Commands: cable d
cable ds-max-burst

Related Commands Command Description

cable qos profile Configures a QoS profile.

show cable qos permission Displays the status of permissions for changing QoS tables for a
cable router.

show cable qos profile Displays the QoS profiles that have been defined.

show cr10k-rp cable sid service-flow ds Displays service flows on the Cisco uBR10012 router with PRE2,
and identifies which service flows have maximum burst enabled.

Cisco CMTS Cable Command Reference

215
 Cable Commands: cable d
cable ds-resiliency

cable ds-resiliency
To reserve a resiliency bonding group or wideband (WB) interface for a line card on the Cisco CMTS, use
the cable ds-resiliency command in interface configuration mode. To remove this setting, use the no form
of this command.

cable ds-resiliency
no cable ds-resiliency

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable ds-resiliency command is used to configure the Donwstream Resiliency Bonding Group feature.
Remove all existing configuration commands from the WB interface when setting aside that interface as a
WB resiliency bonding group.
The cable ds-resiliency command is used in conjunction with the cable resiliency ds-bonding command to
configure the Downstream Resiliency Bonding Group feature.

Examples The following example shows how to reserve a wideband cable interface in slot 5, subslot 1, and
port 2 for a resiliency bonding group:

Router(config) interface wideband-cable 5/1/2:0

Router(config-if)# cable ds-resiliency

Related Commands Command Description

cable resiliency ds-bonding Enables the Downstream Resiliency Bonding Group feature on the Cisco
CMTS router.

show cable modem resiliency Displays resiliency status of the cable modem in resiliency mode on the
Cisco CMTS router.

show cable resiliency Displays all information about the resiliency bonding groups on the Cisco
CMTS router.

Cisco CMTS Cable Command Reference

216
 Cable Commands: cable d
cable dsg

cable dsg

Note Effective with Cisco IOS Release 12.3(13a)BC, the cable dsg command is not available in Cisco IOS software.

To enable the DOCSIS Set-Top Gateway (DSG) on a cable interface on a Cisco CMTS router, and to configure
its tunnel-mapping parameters, use the cable dsg command in interface or subinterface configuration mode.
To remove the DSG tunnel from the interface, use the no form of this command.

cable dsg tunnel-MAC-address group-ip-address CA-vendor-name

no cable dsg tunnel-MAC-address group-ip-address CA-vendor-name

Syntax Description tunnel-MAC-address Well-known MAC address for the DSG tunnel.

group-ip-address Multicast group IP address for the DSG stream.

CA-vendor-name Name for the Conditional Access (CA) vendor that owns the DSG tunnel. This
parameter is a string up to 7 characters in length and should match the vendor of the
CA server. A maximum of four vendors per router are supported.

Command Default No DSG tunnels are defined.

Command Modes
Interface configuration—cable interface only (config-if)

Subinterface configuration—cable interface only (config-subif)

Command History Release Modification

12.2(15)BC2 This command was introduced for the Cisco uBR7100 series and Cisco uBR7246VXR
routers.

12.3(9a)BC This command was introduced for the Cisco uBR10012 router.

12.3(13a)BC This command was removed.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines This command enables DSG operations on the cable interface, creating a DSG tunnel that uses the specified
IGMP multicast address and well-known MAC address.
The tunnel-MAC-address could optionally be an Internet Group Management Protocol (IGMP) multicast
address, using the algorithm for converting host group IP address to an Ethernet MAC address that is given
in RFC 1112. If the MAC address is 0000.0000.0000, the DSG tunnel uses the algorithm given in RFC 1112
to derive the multicast address for the tunnel as follows:
An IP host group address is mapped to an Ethernet multicast address by placing the low-order 23-bits of the
IP address into the low-order 23 bits of the Ethernet multicast address 01-00-5E-xx-xx-xx (hex). Because

Cisco CMTS Cable Command Reference

217
 Cable Commands: cable d
cable dsg

there are 28 significant bits in an IP host group address, more than one host group address may map to the
same Ethernet multicast address.
For example, if you specify the command cable dsg 0.0.0 228.9.9.9 AAA, the command uses the IGMP IP
address of 228.9.9.9 to generate the MAC address of 0100.5E09.0909 for the DSG tunnel. If the IGMP address
were 228.129.9.9, the resulting MAC address would be 0100.5E01.0909.
You can specify only Global Scope (224.0.1.0 through 238.255.255.255) and Administratively Scoped
(239.0.0.0 through 239.255.255.255) addresses. You cannot use Local Scope addresses (224.0.0.0 through
224.0.0.255).
Entering the cable dsgcommand also automatically configures the interface for the appropriate IGMP static
group, using the ip igmp static-groupcommand. Do not manually enter another ip igmp static-group command
for this interface, because the system assumes that this IGMP configuration is for a separate configuration
that cannot be used by the DSG subsystem.

Note If any previously configured static groups exist on this interface, you should remove those other ip igmp
static-group commands on a cable interface before you can enter the cable dsg command. If you do not
remove those other groups, the cable dsg command displays a warning notifying you that you should remove
them.

The no cable dsg command automatically removes the IGMP static group from the interface by issuing the
no ip igmp static-group command. Do not manually remove this static group yourself.
In addition, you must have enabled Protocol Independent Multicast (PIM) on the cable interface, using the
ip piminterface configuration command, before enabling and configuring DSG operations. The DOCSIS
Set-Top Gateway feature supports the following PIM modes:
• ip pim sparse-modecommand—Configures sparse mode of operation.
• ip pim sparse-dense-modecommand—Configures the interface for either sparse mode or dense mode
of operation, depending on the mode in which the multicast group is operating.
• ip pim dense-modecommand—Configures dense mode of operation.

Limitations and Restrictions

The DOCSIS Set-Top Gateway feature also has the following limitations:
• If using bundled interfaces, configure the DSG configurations only on the primary interface, not on the
subordinate interfaces. However, when DSG has been properly configured on the primary interface, DSG
traffic can flow across both the primary and subordinate interfaces.
• If using subinterfaces, you must configure the DSG tunnels only on subinterfaces. When DSG tunnels
are configured on a subinterface, you cannot also configure the tunnels on the main interface. If you
configure DSG tunnels on both the main interface and subinterfaces, the main interface can drop packets.

We also recommend putting all DSG configurations on the same, single subinterface. Although you can
configure DSG tunnels on multiple subinterfaces, this is not guaranteed to be supported in future software
releases.
• You can configure up to four separate Conditional Access (CA) vendors per router.
• You can configure a maximum of eight DSG tunnels (as identified by the well-known MAC address)
per CA vendor, for a maximum possible total of 32 DSG tunnels per router.

Cisco CMTS Cable Command Reference

218
 Cable Commands: cable d
cable dsg

• Each CA vendor can have one or more DSG tunnels on each cable interface, but each DSG tunnel must
be using a separate IP multicast address.
• IP multicast routing should be enabled on the router, using the ip multicast-routing command.
• Multicast rate-limiting can be enabled optionally on a cable interface that is configured for DSG operations,
using the ip multicast rate-limit out group-listcommand.
• For best performance, fast switching of IP multicast should be enabled on incoming and outgoing
interfaces, using theip mroute-cache command.
• You cannot use the same IP multicast groups for both DSG traffic and for other IP multicast traffic. If
an IP multicast group is being used for DSG traffic, do not use the ip igmp static-group command to
manually configure that same IP multicast group for other, non-DSG traffic.
• Different CA vendors cannot share IP multicast addresses. Each vendor must use a unique set of IP
multicast addresses, and after an IP multicast address is assigned to a DSG tunnel, that same address
cannot be used for any other purpose. However, all other multicast addresses and groups can still be used
on the interface for other multicast applications.
• DSG-related IP unicast traffic is not supported. The CMTS receives the unicast traffic from the DSG
network controllers, but it does not forward that traffic to the set-top boxes.
• DSG traffic should be less than 2.048 Mbps per vendor, so as to conform to the DSG specifications.
• DSG does not support Baseline Privacy Interface (BPI)-encrypted IP multicast streams.

Note In Cisco IOS Release 12.2(15)BC2, N+1 HCCP high availability redundancy does not preserve the DSG
traffic and configuration after a switchover. If you configure a cable interface for both N+1 HCCP redundancy
and for DSG operations, DSG traffic does not continue after a switchover.

Examples The following example shows how to configure a cable interface on a Cisco uBR7246VXR router
to enable the DSG feature on cable interface 3/0, using a well-known MAC address of 0001.0002.0003
and a destination IP address of 225.2.3.4:

interface cable 3/0

ip pim dense-mode
ip multicast rate-limit out group-list 123 1024
cable dsg 1.2.3 225.2.3.4 CCC

Note The above configuration also automatically configures the interface with the appropriate ip igmp
static-group command (ip igmp static-group 225.3.4.5). This command will appear in the interface
configuration and should not be removed manually.

The following example shows the error message that appears if you specify a broadcast IP address
that has already been added to the router’s IGMP database. This entry typically would have been
created manually on the router or dynamically by a customer premise equipment (CPE) device that
is attached to a cable modem on the cable network.

Cisco CMTS Cable Command Reference

219
 Cable Commands: cable d
cable dsg

interface cable 3/0

cable dsg 1.1.1 224.3.3.10 cisco
Multicast group 224.3.3.10 is already in use on the interface Cable3/0, please retry.

The following example shows how to delete a DSG tunnel on a cable interface:

interface cable 4/0

no cable dsg 0020.0020.0020 230.8.8.8 abc
4d17h: DSG: interface Cable5/0 left the igmp static group 230.8.8.8.
4d17h: DSG: tunnel 0020.0020.0020 is removed
4d17h: DSG: the specified DSG entry has been removed.

The following example shows the error message that appears when a unicast IP address is specified
instead of a multicast IP address:

interface cable 4/0

cable dsg 1.1.1 192.168.13.10 cisco
Only multicast is supported for current version.

Related Commands Command Description

cable dsg keepalive Enables keepalive messages over DSG tunnels on all cable interfaces.

debug cable dsg Enables general, DCD, or packet-related debugging for DSG on a Cisco CMTS router.

show cable dsg Displays the current DSG tunneling parameters.

Cisco CMTS Cable Command Reference

220
 Cable Commands: cable d
cable dsg cfr

cable dsg cfr

To define and enable Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) classifiers on a Cisco CMTS
router, use the cable dsg cfr command in global configuration mode. To remove one or more specified A-DSG
classifiers from a Cisco CMTS router, use the no form of this command. To disable one or more specified
A-DSG classifiers but retain their configuration, use the disable form of this command.

cable dsg cfr index [dest-ip {ipaddrhostname}] [tunnel index] [dest-ports start end] [priority
priority] [src-ip {ipaddrhostname} [src-prefix-len length]] [disable | enable] [in-dcd {yes | no |
ignore}]
no cable dsg cfr index

Syntax Description index DSG index. The valid range is from 1 to 65535.

ipaddr (Optional) Destination multicast group IP address. This argument is required for
a new classifier, but optional for an existing classifier.

hostname (Optional) Fully-qualified domain name (FQDN). This argument is required for
a new classifier, but optional for an existing classifier.

tunnel index (Optional) Defines a tunnel index identified by a number from 1 to 65535.

dest-portsstart end (Optional) Defines the destination TCP/UDP with the starting and ending port
ranging from 0 to 65535.

priority priority (Optional) Defines the classifier priority.

src-ip ipaddr (Optional) Defines the source IP address and prefix length, if desired.

src-prefix-len length (Optional) Defines the source prefix length.

disable (Optional) Disables the classifier. This is the default.

enable (Optional) Enables the classifier.

in-dcd {yes | no | ignore} (Optional) Defines whether to include, exclude, or ignore the DSG rules of the
Downstream Channel Descriptor (DCD) message.
• yes—Includes the classifier.
• no—Excludes the classifier.
• ignore—Excludes the classifier from the DCD message and enables the
DSG rule regardless of the tunnel MAC address.

Command Default The A-DSG classifiers are undefined by default on a Cisco CMTS router. When configured, A-DSG classifiers
are enabled by default.

Command Modes
Global configuration (config)

Cisco CMTS Cable Command Reference

221
 Cable Commands: cable d
cable dsg cfr

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG 1.1 on the Cisco uBR10012 router and
Cisco uBR7200 series routers.

12.3(17a)BC The in-dcd keyword option was added.

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

12.2(33)SCD5 This command was modified. The ignore option was added to the in-dcd keyword.

12.2(33)SCG This command was modified. The hostname argument was added to specify the FQDN
for the destination or source IP address.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg cfr command is used to configure the Advanced Mode DOCSIS Set-Top Gateway 1.2 for the
Cisco CMTS Routers feature.
The cable dsg cfr command creates an index to which one or several A-DSG classifiers apply. The A-DSG
classifiers can only be mapped to one DSG tunnel. The Cisco CMTS router applies the classifier parameters
to the packets received from the DSG server in order to assign the packet to the appropriate DSG tunnel.
When you use the in-dcd yes option, the classifiers are also included in the DSG rules as part of the DCD
message.
When you use the in-dcd ignore option, the DSG rule is enabled after bypassing the RFC-1112 MAC address
check, and the DSG classifier is not included in the DCD message.
The no form of the cable dsg cfr command disables the DSG rule if the tunnel MAC address is derived from
the RFC-1112.
During the software downgrade process, if the software does not support the in-dcd ignore option then the
in-dcd yes option is used.

Examples The following example shows how to configure an A-DSG classifier on a Cisco CMTS router:

Router(config)# cable dsg cfr 1

Router(config)# cable dsg cfr 2 dest-ip 209.165.200.225 tunnel 1 dest-port 0 65535 priority
1
Router(config)# cable dsg cfr 2 dest-ip 209.165.200.226 dest-ports 22 777 enable in-dcd yes
Router(config)# cable dsg cfr 3 dest-ip 209.165.200.227 dest-ports 22 777 src-ip
ciscovideo.com

Examples This example shows how to configure an A-DSG classifier on a Cisco cBR-8 router:

Router(config)# cable dsg cfr 1

Router(config)# cable dsg cfr 2 dest-ip 209.165.200.225 tunnel 1 dest-port 0 65535 priority
1
Router(config)# cable dsg cfr 2 dest-ip 209.165.200.226 dest-ports 22 777 enable in-dcd yes

Cisco CMTS Cable Command Reference

222
 Cable Commands: cable d
cable dsg cfr

Router(config)# cable dsg cfr 3 dest-ip 209.165.200.227 dest-ports 22 777 src-ip

ciscovideo.com

Related Commands Command Description

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS
router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

cable dsg vendor param Configures vendor-specific parameters for an A-DSG on a Cisco
CMTS router.

Cisco CMTS Cable Command Reference

223
 Cable Commands: cable d
cable dsg chan-list

cable dsg chan-list

To configure the Advanced-mode DOCSIS Set-Top Gateway (A-DSG) downstream channel list on a CMTS
router, use the cable dsg chan-list command in global configuration mode. To remove the A-DSG channel
list, use the no form of this command.

cable dsg chan-list list-index index entry-index freq freq

no cable dsg chan-list list-index index entry-index freq freq

Syntax Description list-index Defines the DSG channel list and index identifier as a number in the range 1 to 65535.

index Defines the DSG channel frequency entry index as a number in the range 1 to 65535.
entry-index

freq freq Defines the center frequency of the downstream channel in the range 47000000 to
862000000 Hz.

Command Default A-DSG channel lists are disabled and undefined by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced on the Cisco uBR10012 router and Cisco uBR7200 series
routers.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The channel list entry created with this command can be associated to a downstream interface and be included
in the Downstream Channel Descriptor (DCD) message by using the cable downstream dsg chan-list
command.

Examples The following example shows A-DSG channel list global configurations on a Cisco CMTS router:

cable dsg chan-list 1 index 1 freq 47000000

cable dsg chan-list 1 index 2 freq 125000000
cable dsg chan-list 1 index 3 freq 55500000
cable dsg chan-list 2 index 1 freq 47000000
cable dsg chan-list 2 index 2 freq 125000000
cable dsg chan-list 2 index 3 freq 55500000

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

224
Cable Commands: cable d
cable dsg chan-list

Command Description

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

cable dsg vendor param Configures vendor-specific parameters for A-DSG on a Cisco CMTS
router.

Cisco CMTS Cable Command Reference

225
 Cable Commands: cable d
cable dsg client-list

cable dsg client-list

To configure client parameters for Advanced-mode DOCSIS Set-Top Gateway (A-DSG) on a Cisco CMTS
router, use the cable dsg client-listcommand in global configuration mode. This command configures the
client parameters and the associated DSG rule. To remove this configuration, use the no form of the command.

cable dsg client-list client-list-id id-index id {application-id app-id | broadcast [broadcast-id] |

ca-system-id sys-id | mac-addr mac-addr}
no cable dsg client-list client-list-id id-index id {application-id app-id | broadcast [broadcast-id]
| ca-system-id sys-id | mac-addr mac-addr}

Syntax Description client-list-id Defines an identifier for the DSG client list as a number from 1 to 65535.

id-index id Defines the DSG client index identifier as a number from 1 to 65535.

application-id app-id Defines the DSG client type application identifier as a hexadecimal value from 1
to FFFF.

broadcast [broadcast-id] Defines an optional DSG client type broadcast value:

• 1—Contains Society of Cable Telecommunications Engineers (SCTE) 65.
• 2—Contains SCTE 18.
• 3—Contains OpenCable Application Platform (OCAP) Object Carousel
(OCAP 1.0)
• 4—Contains OpenCable Common Download Carousel (OC-CD).
• 5 to 55534—Reserved for future use.
• 55535 to 65535—Reserved for Multipler Service Operator (MSO)-specific
use.

ca-system-id sys-id Defines the DSG client type CA system identifier as a hexadecimal value from 1
to FFFF.

mac-addr mac-addr Defines the DSG client type hexadecimal MAC address.

Command Default Client lists for A-DSG are not configured by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG on the Cisc uBR10012 router and Cisco
uBR7200 series routers.

12.3(17a)BC2 The broadcast-id argument was added. Support for the same DSG client identifier to be
associated with multiple DSG tunnels was added.

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

Cisco CMTS Cable Command Reference

226
 Cable Commands: cable d
cable dsg client-list

Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines Beginning in Cisco IOS Release 12.3(17a)BC2, the same DSG client identifer can be associated with multiple
DSG tunnels.

Examples The following example shows global configuration for four A-DSG client lists:

cable dsg client-list 1 id-index 1 broadcast

cable dsg client-list 2 id-index 2 application-id FFFF
cable dsg client-list 3 id-index 3 ca-system-id EEEE
cable dsg client-list 4 id-index 4 mac-addr 0100.5e0a.0a04

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS
router.

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

cable dsg vendor param Configures vendor-specific parameters for A-DSG on a Cisco CMTS
router.

Cisco CMTS Cable Command Reference

227
 Cable Commands: cable d
cable dsg keepalive

cable dsg keepalive

Note Effective with Cisco IOS Release 12.3(13a)BC, the cable dsg keepalive command is not available in Cisco
IOS software.

To enable keepalive messages over DOCSIS Set-Top Gateway (DSG) tunnels on all cable interfaces, use the
cable dsg keepalive command in global configuration mode. To disable DSG keepalives, use the no form of
this command.

cable dsg keepalive

no cable dsg keepalive

Syntax Description This command has no arguments or keywords.

Command Default Keepalive messages are disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC2 This command was introduced for the Cisco uBR7100 series and Cisco uBR7246VXR
routers.

12.3(9a)BC This command was introduced for the Cisco uBR10012 router.

12.3(13a)BC This command was removed.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines By default, a Cisco CMTS router does not send keepalive messages on any DSG tunnels. When keepalives
are enabled using the cable dsg keepalive command, the Cisco CMTS router sends one keepalive message
each second on each DSG tunnel on each downstream. In Cisco IOS Release 12.2(15)BC2, the keepalive
packet is a null packet.

Note Do not enable DSG keepalive messages unless your application and DSG set-top boxes require them.

Tip Use the show cable dsg command to display whether keepalive messages are enabled.

Examples The following example shows how to enable DSG keepalives on all cable interfaces on the router:

Cisco CMTS Cable Command Reference

228
 Cable Commands: cable d
cable dsg keepalive

cable dsg keepalive

The following example shows how to disable DSG keepalives on all cable interfaces, which is the
default configuration:

no cable dsg keepalive

Related Commands Command Description

cable dsg Enables DSG on a cable interface, and configures its tunnel-mapping parameters.

debug cable dsg Enables the display of debugging messages for the operation of the DSG feature.

show cable dsg Displays the current DSG tunneling parameters.

Cisco CMTS Cable Command Reference

229
 Cable Commands: cable d
cable dsg name-update-interval

cable dsg name-update-interval

To update fully-qualified domain name (FQDN) classifiers on a Cisco CMTS router based on the DNS server
record, use the cable dsg name-update-interval command in global configuration mode. To remove this
configuration, use the no form of this command.

cable dsg name-update-interval minutes

no cable dsg name-update-interval minutes

Syntax Description minutes Interval in minutes to check the DNS server for any FQDN classifier changes. The valid range is
from 1 to 60. The default value is 5.

Command Default The default value of 5 minutes is configured.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg-name-update-interval command is used to configure the Advanced Mode DOCSIS Set-Top
Gateway 1.2 for the Cisco CMTS Routers feature.
Use the cable dsg name-update-interval command to configure the DSG name process feature. This feature
supersedes the Time to Live (TTL) value associated with the DNS server while obtaining the latest DNS
server record.

Examples The following example shows how to specify the DSG name interval on the Cisco CMTS router:

Router(config)# cable dsg name-update-interval 3

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

show cable dsg cfr Displays DSG classifier details.

Cisco CMTS Cable Command Reference

230
 Cable Commands: cable d
cable dsg tg

cable dsg tg
To associate a group of Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) tunnels to one or more
downstream interfaces on a Cisco CMTS router, use the cable dsg tg command in global configuration mode.
To remove this configuration, use the no form of this command.

cable dsg tg group-id [channel channel_ID | priority DSG-rule-priority [enable | disable] | ucid ID1
[ID2 ID3 ID4] | vendor-param vendor-group-ID]
no cable dsg tg group-id

Syntax Description group-id A-DSG tunnel group identifier. The valid range is from 1 to 65535.

channel-id (Optional) The downstream channel identifier. The valid range is from 1
to 65535.

priority DSG-rule-priority (Optional) Specifies the A-DSG rule priority. The valid range is from 0
to 255.

enable (Optional) Enables the specified A-DSG tunnel group.

disable (Optional) Disables the specified A-DSG tunnel group. This is the default.

ucid upstream-channel-ID (Optional) Specifies the upstream channel ID. You can specify a maximum
of four upstream channel IDs.

vendor-param vendor-group-ID (Optional) Specifies the vendor specific parameters group ID. The valid
range is from 1 to 65535.

Command Default The A-DSG tunnel group configuration is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(17a)BC2 This command was introduced to support A-DSG version 1.2 on the Cisco uBR10012
router and Cisco uBR7200 series routers.

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

12.2(33)SCG The channel keyword was made optional, and the following new keywords were added:
• ucid
• vendor-param

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg tg command establishes the configuration of the tunnel group. You can use the disable and
enable keyword forms of the command to deactivate and activate the tunnel group configuration.

Cisco CMTS Cable Command Reference

231
 Cable Commands: cable d
cable dsg tg

Examples The following example shows configuration and activation of a DSG tunnel group with channel ID,
A-DSG rule priority, upstream channel ID, and vendor parameter group ID:

Router(config)# cable dsg tg 1

Router(config)# cable dsg tg 1 channel 2
Router(config)# cable dsg tg 1 channel 2 enable
Router(config)# cable dsg tg 1 channel 2 priority 3
Router(config)# cable dsg tg 1 channel 2 priority 3 enable
Router(config)# cable dsg tg 1 channel 2 ucid 1
Router(config)# cable dsg tg 1 channel 2 vendor-param 30

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS
router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

Cisco CMTS Cable Command Reference

232
 Cable Commands: cable d
cable dsg tg channel

cable dsg tg channel

To associate a group of Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnels to one or more downstream
interfaces on a Cisco CMTS router, use the cable dsg tg channel command in global configuration mode.
To remove this configuration, use the no form of this command.

cable dsg tg group-id channel channel-id [priority rule-priority] [enable | disable]

no cable dsg tg group-id channel channel-id [priority rule-priority]

Syntax Description group-id Specifies the A-DSG tunnel group identifier as a number from 1–65535.

channel-id Specifies the downstream channel identifier as a number from 1–65535.

priority rule-priority Specifies the A-DSG rule priority as a number from 0–255.

enable Enables the specified A-DSG tunnel group.

disable Disables the specified A-DSG tunnel group. This is the default.

Command Default The A-DSG tunnel group configuration is enabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(17a)BC2 This command was introduced to support A-DSG version 1.2 on the Cisco uBR10012
router and Cisco uBR7200 series routers.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg tg channel command establishes the configuration of the tunnel group. You can use the disable
and enable keyword forms of the command to deactivate and activate the tunnel group configuration. To
remove the configuration, use the no form of the command.

Examples The following example shows configuration and activation of a tunnel group with group ID 1 and
channel ID 2:

Router(config)# cable dsg tg 1 channel 2

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

233
 Cable Commands: cable d
cable dsg tg channel

Command Description

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS
router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

Cisco CMTS Cable Command Reference

234
 Cable Commands: cable d
cable dsg tg channel ucid

cable dsg tg channel ucid

To configure the upstream channel IDs for an Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnel
group on a Cisco CMTS router, use the cable dsg tg channel ucid command in global configuration mode.
To remove this configuration, use the no form of this command.

cable dsg tg group-id channel channel-id ucid upstream-id [upstream-id . . .]

no cable dsg tg group-id channel channel-id ucid upstream-id [upstream-id . . .]

Syntax Description group-id Specifies the A-DSG tunnel group identifier as a number from 1–65535.

channel-id Specifies the downstream channel identifier as a number from 1–65535.

upstream-id Specifies one or more upstream channel IDs as a number from 1–8.

Command Default Upstream channel IDs are not defined.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(17a)BC2 This command was introduced to support A-DSG version 1.2 on the Cisco uBR10012
router and Cisco uBR7200 series routers.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg tg channel command must be configured before this command is made available.

Examples The following example shows configuration of a tunnel group with group ID 1 and channel ID 2,
followed by configuration of the upstream channel IDs associated with the tunnel group:

Router(config)# cable dsg tg 1 channel 2

Router(config)# cable dsg tg 1 channel 2 ucid 1 2 3 4 5 6 7 8

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS
router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

235
 Cable Commands: cable d
cable dsg tg channel ucid

Command Description

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

Cisco CMTS Cable Command Reference

236
 Cable Commands: cable d
cable dsg tg channel vendor-param

cable dsg tg channel vendor-param

To associate a vendor-specific group with an Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnel
group on a Cisco CMTS router, use the cable dsg tg channel vendor-param command in global configuration
mode. To remove this configuration, use the no form of this command.

cable dsg tg group-id channel channel-id vendor-param vendor-group

no cable dsg tg group-id channel channel-id vendor-param vendor-group

Syntax Description group-id Specifies the A-DSG tunnel group identifier as a number from 1–65535.

channel-id Specifies the downstream channel identifier as a number from 1–65535.

vendor-group Specifies the A-DSG vendor-specific group ID as a number from 1–65535.

Command Default The A-DSG vendor-specific group is not associated.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(17a)BC2 This command was introduced to support A-DSG version 1.2 on the Cisco uBR10012
router and Cisco uBR7200 series routers.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg tg channel command must be configured before this command is made available. You also
need to configure the vendor-specific parameter list using the cable dsg vendor-param command before you
can associate it with the tunnel group.

Examples The following example shows configuration of the vendor-specific parameter list, followed by
configuration of a tunnel group and ssociation with the defined vendor group 3:

! Configure the vendor-specific parameter list

cable dsg vendor-param 3 vendor 1 oui ABCDEC value 0101AB
!
! Configure the tunnel group and associate the vendor group to the tunnel
!
cable dsg tg 1 channel 2
cable dsg tg 1 channel 2 vendor-param 3

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

237
 Cable Commands: cable d
cable dsg tg channel vendor-param

Command Description

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule on a Cisco
CMTS router.

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream interfaces on
a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on a Cisco
CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco CMTS router.

cable dsg vendor-param Configures A-DSG vendor-specific parameters on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

238
 Cable Commands: cable d
cable dsg tg default-priority

cable dsg tg default-priority

To change the default channel priority for a tunnel group on the Cisco CMTS router, use the cable dsg tg
default-priority command in global configuration mode. To set the channel priority back to the default value
of zero, use the no form this command.

cable dsg tg group-id default-priority DSG-rule-priority

no cable dsg tg group-id priority DSG-rule-priority

Syntax Description group-id Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) tunnel group
identifier. The valid range is from 1 to 65535.

default-priorityDSG-rule-priority Specifies the DSG rule priority of the downstream channels. The range
is from 0 to 255. The default is 0.

Command Default The default channel priority for a tunnel group is 0.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg tg default-priority command is associated with the Advanced Mode DOCSIS Set-Top Gateway
1.2 for the Cisco CMTS Routers feature.
All channels that are configured after setting the default priority use the same priority value.

Examples The following example shows how to specify the default channel priority for a tunnel group on the
Cisco CMTS router:

Router(config)# cable dsg tg 1 default-priority 20

Related Commands Command Description

cable dsg Defines and enables A-DSG classifiers on a Cisco CMTS router.
cfr

Cisco CMTS Cable Command Reference

239
 Cable Commands: cable d
cable dsg tg priority

cable dsg tg priority

To change the priority of existing Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) channels in a tunnel
group on a Cisco CMTS router, use the cable dsg tg priority command in global configuration mode. To set
the DSG rule priority of all existing channels in a tunnel group to the default value of zero, use the no form
of this command.

cable dsg tg group-id priority DSG-rule-priority

no cable dsg tg group-id priority DSG-rule-priority

Syntax Description group-id A-DSG tunnel group identifier. The range is from 1 to 65535.

priorityDSG-rule-priority Specifies the DSG rule priority of the downstream channels. The range is from
0 to 255. The default is 0.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg tg priority command is used to configure the Advanced Mode DOCSIS Set-Top Gateway 1.2
for the Cisco CMTS Routers feature.
This command does not impact the downstream channels configured after setting the priority. The no form
of the cable dsg tg priority command sets the DSG rule priority of all existing channels in a tunnel group to
the default value of 0.

Examples The following example shows how to specify the DSG rule priority for all existing A-DSG channels
in a tunnel group on a Cisco CMTS router:

Router(config)# cable dsg tg 1 priority 20

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

show cable dsg cfr Displays DSG classifier details.

Cisco CMTS Cable Command Reference

240
 Cable Commands: cable d
cable dsg timer

cable dsg timer

To configure the Advanced-mode DOCSIS Set-Top Gateway (A-DSG) timer entry to be associated to the
downstream channel, and encoded into the downstream channel descriptor (DCD) message on a Cisco CMTS
router, use the cable dsg timer command in global configuration mode. To remove the cable A-DSG timer,
use the no form of this command.

cable dsg timer index [Tdsg1 Tdsg1] [Tdsg2 Tdsg2] [Tdsg3 Tdsg3] [Tdsg4 Tdsg4]
no cable dsg timer index [Tdsg1 Tdsg1] [Tdsg2 Tdsg2] [Tdsg3 Tdsg3] [Tdsg4 Tdsg4]

Syntax Description index Defines the DSG timer and associates to an index for the downstream channel as a number
from 1 to 65535.

Tdsg1 (Optional) Sets the DSG Initialization Timeout (Tdsg1). The range is from 1 to 65535.
Tdsg1

Tdsg2 (Optional) Sets the DSG Operational Timeout (Tdsg2). The range is from 1 to 65535.
Tdsg2

Tdsg3 (Optional) Sets the DSG Two-Way Retry Timer (Tdsg3). The range is from 0 to 65535.
Tdsg3

Tdsg4 (Optional) Sets the DSG One-Way Retry Timer (Tdsg4). The range is from 0 to 65535.
Tdsg4

Command Default The A-DSG timer is not defined.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG 1.1 on the Cisco uBR10012 router and
Cisco uBR7200 series routers.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The A-DSG timer entry can be associated to the downstream to encode into the DCD message.

Examples The following example shows global configuration of three A-DSG timers:

cable dsg timer 1 Tdsg1 1 Tdsg2 2 Tdsg3 3 Tdsg4 4

cable dsg timer 2 Tdsg1 2 Tdsg2 22 Tdsg3 33 Tdsg4 44
cable dsg timer 3 Tdsg1 2 Tdsg2 600 Tdsg3 300 Tdsg4 1800

Cisco CMTS Cable Command Reference

241
 Cable Commands: cable d
cable dsg timer

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS
router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

cable dsg vendor param Configures vendor-specific parameters for A-DSG on a Cisco CMTS
router.

Cisco CMTS Cable Command Reference

242
 Cable Commands: cable d
cable dsg tunnel

cable dsg tunnel

To create Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnels on a Cisco CMTS router, use the cable
dsg tunnel command in global configuration mode. To remove this configuration, use the no form of this
command. To disable A-DSG tunnels, use the disable form of this command.

cable dsg tunnel tunnel-id mac-addr mac-addr tg tunnel-group-id clients number [disable | enable]
no cable dsg tunnel tunnel-id mac-addr mac-addr tg tunnel-group-id clients number

Syntax Description tunnel-id Defines the DSG tunnel with an identifier as a number from 1–65535.

mac-addr mac-addr Specifies the multicast group MAC address in hexadecimal format.

tg tunnel-group-id Associates a tunnel group ID as a number from 1–65535.

clients number Specifies the client to which the configuration applies as a number from 1–65535.

disable (Optional) Disables the specified A-DSG tunnel.

enable (Optional) Enables the specified A-DSG tunnel.

Command Default A-DSG tunnels are not configured by default, but are enabled by default once configured.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG version 1.1 on the Cisco uBR10012
router and Cisco uBR7200 series routers.

12.3(17a)BC The tg and clients keywords were added in support of A-DSG version 1.2.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The cable dsg tunnel command establishes the configuration of the tunnel. You can use the disable and
enable keywords of the command to deactivate and activate the tunnel configuration. To remove the
configuration, use the no form of the command.
Each tunnel is mapped to the destination MAC address and once defined, can be associated with a configured
QoS service class name using the cable dsg tunnel srv-class command.

Examples The following example shows configuration of four A-DSG tunnels on a Cisco CMTS router:

cable dsg tunnel 1 mac-addr 0100.5e0a.0a01

cable dsg tunnel 2 mac-addr 0100.5e0a.0a02

Cisco CMTS Cable Command Reference

243
 Cable Commands: cable d
cable dsg tunnel

cable dsg tunnel 3 mac-addr 0100.5e0a.0a03

cable dsg tunnel 4 mac-addr 0100.5e0a.0a04

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS
router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

cable dsg vendor param Configures vendor-specific parameters for A-DSG on a Cisco CMTS
router.

Cisco CMTS Cable Command Reference

244
 Cable Commands: cable d
cable dsg tunnel srv-class

cable dsg tunnel srv-class

To associate a cable service class with an Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnel on a
Cisco CMTS router, use the cable dsg tunnel srv-class command in global configuration mode. To remove
this configuration, use the no form of this command.

cable dsg tunnel tunnel-id srv-class class-name

no cable dsg tunnel tunnel-id srv-class class-name

Syntax Description tunnel-id Identifies the DSG tunnel with an identifier as a number from 1–65535.

class-name Specifies the name of a configured cable service class.

Command Default Cable service classes are not configured or associated with a DSG tunnel.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced on the Cisco uBR10012 router and Cisco uBR7200 series
routers.

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

12.2(33)SCC1 This command was modified to reflect the change in behavior of the command when the
default MQoS is configured.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The A-DSG tunnel and tunnel group must be created before the cable dsg tunnel srv-class command becomes
available to associate the tunnel with a configured QoS service class.

Examples The following example shows how to configure a cable service class named “test” on a Cisco CMTS
router, followed by the association of that test cable service class with a DSG tunnel:

Router(config)# cable service class 1 name test

Router(config)# cable service class 1 downstream
Router(config)# cable service class 1 max-rate 20000
Router(config)# cable service class 1 min-rate 3000
Router(config)# cable dsg client-list 1 id-index 1 mac-addr 0050.4d00.0007
Router(config)# cable dsg tg 1 channel 1
Router(config)# cable dsg tunnel 1 mac-addr 0050.4d00.0007 tg 1 clients 1
Router(config)# cable dsg tunnel 1 srv-class test

When the service class name is configured without the default MQoS configuration, the following
error message is displayed and the configuration is rejected prompting the user to configure the
default MQoS.

Cisco CMTS Cable Command Reference

245
 Cable Commands: cable d
cable dsg tunnel srv-class

Router(config)# cable dsg tunnel 1 srv-class test

The default mqos doesn't exist, please, create one and then reconfigure service class name
to tunnel 1
Router(config)#

When the last service class name is not configured, the following error message is displayed prompting
the user to remove the default MQoS (if not needed.)

Router(config)# no cable dsg tunnel 1 srv-class test

There is no DSG tunnel associated with a service class name, so, remove the default mqos
if not needed
Router(config)#

Related Commands Command Description

cable service class Configures parameters for a DOCSIS service class on a Cisco CMTS
router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

cable dsg tg channel Associates a group of A-DSG tunnels to one or more downstream
interfaces on a Cisco CMTS router.

cable dsg tg channel ucid Configures the upstream channel IDs for an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg tg channel vendor-param Specifies a vendor-specific group for an A-DSG tunnel group on a
Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

cable dsg vendor param Configures vendor-specific parameters for A-DSG on a Cisco CMTS
router.

Cisco CMTS Cable Command Reference

246
 Cable Commands: cable d
cable dsg vendor-param

cable dsg vendor-param

To configure Advanced-mode DOCSIS Set-top Gateway (A-DSG) vendor-specific parameters on a Cisco
CMTS router, use the cable dsg vendor-param command in global configuration mode. To remove this
configuration, use the no form of this command.

cable dsg vendor-param group-id vendor vendor-index oui oui value value-in-TLV
no cable dsg vendor-param group-id vendor vendor-index oui oui value value-in-TLV

Syntax Description group-id Defines the DSG vendor parameter and associates with a DSG group.

vendor vendor-index Selects the DSG vendor and associated DSG index.

oui oui Selects the DSG Organizationally Unique Identifier (OUI) setting.

value value-in-TLV Sets the type/length value for the defined DSG vendor.

Command Default The A-DSG vendor-specific parameters are not defined.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG on the Cisco uBR10012 router and Cisco
uBR7200 series routers.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The vendor-specific parameters can be associated to the downstream to encode into the Downstream Channel
Descriptor (DCD) message.
To associate a vendor parameter list with a tunnel group, use the cable dsg tg channel vendor-param
command. The same vendor parameter list can be associated with multiple tunnel groups.

Examples The following sample configuration illustrates global vendor parameters for A-DSG:

cable dsg vendor-param 1 vendor 1 oui ABCDEA value 0101AB

cable dsg vendor-param 2 vendor 1 oui ABCDEB value 0101AB
cable dsg vendor-param 3 vendor 1 oui ABCDEC value 0101AB

Related Commands Command Description

cable dsg cfr Defines and enables A-DSG classifiers on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

247
 Cable Commands: cable d
cable dsg vendor-param

Command Description

cable dsg chan-list Configures the A-DSG downstream channel list on a Cisco CMTS
router.

cable dsg client-list Configures the A-DSG client parameters and the associated DSG rule
on a Cisco CMTS router.

cable dsg tg channel vendor-param Associates a vendor-specific group with an A-DSG tunnel group on
a Cisco CMTS router.

cable dsg timer Configures the A-DSG timer on a Cisco CMTS router.

cable dsg tunnel Creates A-DSG tunnels on a Cisco CMTS router.

cable dsg tunnel srv-class Associates a cable service class with an A-DSG tunnel on a Cisco
CMTS router.

Cisco CMTS Cable Command Reference

248
 Cable Commands: cable d
cable dynamic-bonding-group

cable dynamic-bonding-group
To enable dynamic bonding group, use the cable dynamic-bonding-group command. To disable dynamic
bonding group, use the no form of the command.

cable dynamic-bonding-group [ eight-contiguous-channel | load-balance | reclaim-hold-interval

{ percent percentage | modems count } | reclaim-threshold | registration | snmp ]

Syntax Description eight-contiguous-channel Forces the cBR-8 router to create 8-channel DBG with contiguous
frequency channels.

load-balance Specifies that the dynamic bonding group creation can be triggered by
the load balancing.

reclaim-hold-interval Specifies the time interval in seconds between DBG unused and reclaim.
The default value is 600 seconds. The range is 30-3600 seconds.

reclaim-threshold percent value Specifies the bonding group reclaim thresholds. The default values are
modems count 5 for value and 6 for count.

registration Specifies that the dynamic bonding group creation can be triggered by
the cable modem registration.

snmp Enable the snmp trap on dynamic bonding group.

Command Default The Dynamic Bonding Group is disabled by default.

Command Modes Global configuration (config).

Command History Release Modification

Cisco IOS XE 16.7.1 This command is introduced on the Cisco cBR Series Converged
Broadband Router.

Cisco 1x2 / Compact Shelf RPD Software This command is modified to add reclaim-threshold,
4.1 registration, and load-balance options.

Cisco IOS XE Bengaluru 17.6.1x This command is modified to add eight-contiguous-channel

option.

Cisco IOS XE Dublin 17.12.1w This reclaim-hold-interval option is added.

The following example shows how to configure the time interval between DBG unused and reclaim:

router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
router(config)# cable dynamic-bonding-group reclaim-hold-interval 1000
router(config)# end

Use the following command to verify the above configuration:

Cisco CMTS Cable Command Reference

249
 Cable Commands: cable d
cable dynamic-bonding-group

router# show run | s reclaim-hold-interval

cable dynamic-bonding-group reclaim-hold-interval 1000

The following example enables dynamic bonding group on a modular cable interface using the cable
dynamic-bonding-group command:

router # configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
router(config)# cable dynamic-bonding-group
router(config)# end

The following example shows how to configure the bonding group reclaim thresholds:

router # configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
router(config)# cable dynamic-bonding-group reclaim-threshold percent 5% modems 6
router(config)# end

Cisco CMTS Cable Command Reference

250
 Cable Commands: cable d
cable dynamic-bw-sharing

cable dynamic-bw-sharing
To enable dynamic bandwidth sharing (DBS) on a specific modular cable or wideband cable interface, use
the cable dynamic-bw-sharing command in interface configuration mode. To disable DBS on the interface
and revert to static bandwidth sharing, use the no form of this command.

cable dynamic-bw-sharing
no cable dynamic-bw-sharing

Syntax Description This command has no arguments or keywords.

Command Default Dynamic bandwidth sharing is disabled and static bandwidth sharing is enabled.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(23)BC1 This command was introduced.

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

12.2(33)SCE The command default was changed. The DBS mode is now enabled by default.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines DBS may be configured on a modular cable or wideband cable interface only when the interface is
administratively down. Additionally, the interface must be administrative down when using the no form of
this command to disable dynamic bandwidth sharing.

Note Starting with Cisco IOS Release 12.2(33)SCE, the DBS mode is enabled by default, on the WB/MC/IC
interfaces. To disable the DBS mode, configure the no cable dynamic-bw-sharing command.

Note Starting with Cisco IOS-XE 3.15.0S, DBS is enabled by default on cBR series Converged Broadband Routers
and cannot be disabled on.

Examples The following example enables dynamic bandwidth sharing on a modular cable interface using the
cable dynamic-bw-sharing command:

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

Router(config-if)# shutdown
Router(config-if)# cable dynamic-bw-sharing
Router(config-if)# no shutdown

Cisco CMTS Cable Command Reference

251
 Cable Commands: cable d
cable dynamic-bw-sharing

The following example enables dynamic bandwidth sharing on a wideband cable interface using the
cable dynamic-bw-sharing command:

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

Router(config-if)# shutdown
Router(config-if)# cable dynamic-bw-sharing
Router(config-if)# no shutdown

Related Commands Command Description

cable rf-bandwidth-percent Enables either static or dynamic bandwidth sharing for a modular cable (MC)
interface.

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband channel and
allocates bandwidth.

debug cr10k-rp dbs-queue Displays debug information for dynamic bandwidth sharing (DBS) on the
Cisco uBr10012 universal broadband router.

show pxf cable controller Displays information about the RF channel Versatile Traffic Management
System (VTMS) links and link queues.

show pxf cpu queue Displays parallel express forwarding (PXF) queueing and link queue statistics.

Cisco CMTS Cable Command Reference

252
 Cable Commands: cable d
cable dynamic-flow vrf

cable dynamic-flow vrf

To configure a VPN routing or forwarding instance for dynamic flow settings, use the cable dynamic-flow
vrf command. To disable this feature, use the no form of this command.

{ no } cable dynamic-flow vrf vrf

Syntax Description vrf Specifies the VPN Routing/Forwarding instance name

Command Default By default, no VPN routing or forwarding instance is configured.

Command Modes cable interface (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Example
The following sample shows and example of the cable dynamic-flow vrfcommand.
Router# conf t
Router(config)#vrf definition vrpd
Router(config-vrf)#vrf definition vrpd
Router(config-vrf)# rd 27:1
Router(config-vrf)# route-target export 27:1
Router(config-vrf)# route-target import 27:1
Router(config-vrf)#
Router(config-vrf)# address-family ipv4
Router(config-vrf-af)# route-target export 27:1
Router(config-vrf-af)# route-target import 27:1
Router(config-vrf-af)#end

Router# conf t

Router(config)# cable profile mac-domain MD1

Router(config-profile-md) # cable dynamic-flow vrf vrpd
Router(config-profile-md) # no cable dynamic-flow vrf vrpd
Router(config-profile-md)#end

Cisco CMTS Cable Command Reference

253
 Cable Commands: cable d
cable dynamic-qos trace

cable dynamic-qos trace

To enable the call trace functionality on the Cisco CMTS router for the PacketCable or PacketCable Multimedia
(PCMM) service subscribers, use the cable dynamic-qos trace command in global configuration mode. To
disable this configuration, use the no form of this command.

cable dynamic-qos trace subscriber-number

no cable dynamic-qos trace

Syntax Description subscriber-number Number of subscribers for a PacketCable or PCMM service. The range is from 1 to 20.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Examples The following example shows how to configure the call trace functionality on the Cisco uBR10012
router for the PacketCable or PCMM service subscribers:

Router# configure terminal

Router(config)# cable dynamic-qos trace 12

Related Commands Command Description

debug cable dynamic-qos subscriber Enables debugging of the call trace functionality on the Cisco CMTS
router for a particular subscriber.

debug cable dynamic-qos trace Enables call trace debugging on the Cisco CMTS router for all the
subscribers for whom call trace is configured.

show cable dynamic-qos trace Displays the number of subscribers for whom call trace is enabled
on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

254
 Cable Commands: cable d
cable dynamic-secret

cable dynamic-secret
To enable the Dynamic Shared Secret feature, so that Data-over-Cable Service Interface Specifications
(DOCSIS) configuration files are verified with a Message Integrity Check (MIC) that has been created with
a dynamically generated shared secret, use the cable dynamic-secret command in cable interface configuration
mode or MAC domain profile configuration mode. To disable this feature, use the no form of this command.

cable dynamic-secret {lock [lock-qos] | mark | reject} [nocrypt]

no cable dynamic-secret

Syntax Description lock Allows CMs that do not pass MIC verification to come online, but with a restrictive quality of
service (QoS) configuration that limits access to the network. The CMTS also locks those CMs so
that they must be offline for 24 hours before being allowed to reregister with a valid DOCSIS
configuration file. (You can also manually unlock a cable modem using the clear cable modem
lock command.)

lock-qos (Optional) Specifies the QoS profile to be assigned to the CM while it is locked. The valid range
is 1 to 256. If not specified, the CM is locked into a CMTS-created profile that limits both the
upstream and downstream to 10 Kbps.
Note
The QoS profile must have already been created before it can assigned using the lock lock-qos
option.

mark Allows CMs to come online even if they do not present a DOCSIS configuration file with a valid
CMTS MIC, but the CMTS prints a warning message and marks those CMs with an exclamation
point (!) in the show cable modem command.

reject Rejects registration for CMs with DOCSIS configuration files that contain an invalid CMTS MIC.

nocrypt (Optional) Specifies that the filename for DOCSIS configuration files should not be encrypted
when the Cisco CMTS sends the files to CMs. The CMTS instead transmits the files using their
original filenames.
The nocrypt option slightly decreases the security provided by the dynamic shared secret feature,
but it allows the operator to poll the DOCSIS config file name listed by the cable modem for more
convenient network management.
Note
A cable modem that is running unauthorized or hacked software can return whatever SNMP values
the user desires. This information should therefore not be trusted by the billing and provisioning
systems.

Command Default The Dynamic Shared Secret feature is disabled. When enabled, the filenames for DOCSIS configuration files
are encrypted.

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

MAC domain profile configuration (config-profile-md)

Cisco CMTS Cable Command Reference

255
 Cable Commands: cable d
cable dynamic-secret

Note Configuring the Dynamic Shared Secret feature on the primary interface in a bundle also automatically
configures it for all interfaces in the bundle.

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.2(15)BC1b Support for the nocrypt option was added.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines The cable dynamic-secret configuration command automatically creates a unique DOCSIS shared secret on
a per-modem basis, creating a one-time-use DOCSIS configuration file that is valid only for the current session.
This ensures that a DOCSIS configuration file that has been downloaded for one cable modem can never be
used by any other modem, nor can the same modem reuse this configuration file at a later time. This
patent-pending feature is designed to guarantee that all registered modems are using only the QOS parameters
that have been specified by the DOCSIS provisioning system for that particular modem at the time of its
registration.
The cable dynamic-secret configuration command enhances the existing shared secret support on the Cisco
CMTS by using a one-time, dynamically generated shared secret each time a cable modem registers. This
prevents theft-of-service attacks in which users are able to substitute a DOCSIS configuration file that provides
a higher-level of service during the registration phase.
The DOCSIS specification allows cable service providers to use a shared secret to create the CMTS MIC
value that is stored in a DOCSIS configuration file. If a user attempts to register with the CMTS using a
different or modified DOCSIS configuration file, the CMTS can compare the CMTS MIC value sent by the
cable modem with the CMTS MIC it has calculated. If the two MIC values are different, the file has been
modified.
The cable dynamic-secret command allows the CMTS to dynamically create the shared secret at the time
that the cable modem is registering, and that shared secret is valid only for that particular session with that
particular cable modem. A new dynamically generated shared secret is used each time each cable modem
registers, which prevents users from guessing the shared secret and using it again to register with a modified
DOCSIS configuration file.
If the cable modem’s DOCSIS configuration file fails the CMTS MIC verification check, one of the following
messages is displayed on the console:

%UBR7200-4-BADCFGFILE: Modem config file platinum.cm at C3/0: CMTS MIC Invalid

%UBR7200-4-BADCFGFILE: Modem config file platinum.cm at C3/0: No CMTS MIC

Cisco CMTS Cable Command Reference

256
Cable Commands: cable d
cable dynamic-secret

If the error message specifies that the reason for the failure is “CMTS MIC Invalid,” the CMTS MIC was not
encoded with the proper dynamically generated shared secret. If the reason is “No CMTS MIC,” the DOCSIS
configuration file did not contain any value for the CMTS MIC, which could indicate that the customer has
attempted to bypass the DOCSIS security checks by creating the user’s own DOCSIS configuration file without
any MIC values.

Note The Dynamic Shared Secret feature does not affect the use of the original shared secret or secondary shared
secrets that are configured using the cable shared-secondary-secret and cable shared-secret commands.
(Cisco cBR-8 router does not allow the simultaneous configuration of the two commands.) If these shared
secrets are configured, the Cisco CMTS continues to use them to validate the original DOCSIS configuration
file that is downloaded from the TFTP server. If the DOCSIS configuration file fails to pass the original or
secondary shared secret verification checks, the cable modem is not allowed to register, and the Dynamic
Shared Secret feature is not invoked for that particular cable modem.

Note The Cisco uBR7100 series router does not support the Dynamic Shared Secret feature when running in MxU
bridging mode.

The original filename for the DOCSIS configuration file is automatically encrypted by default to prevent
unauthorized parties from obtaining any useful information from the filename, or from attempting to replace
the original file with their own. This encryption can be disabled, using the nocrypt option, so that DOCSIS
configuration files are sent using their original filenames.

Note Do not use the cable dynamic-secret command along with the ip tftp-source command in Cisco IOS Release
12.2(15)BC1, because this could result in certain models of CMs not being able to come online but instead
be stuck in the init(o) state. This restriction is removed in Cisco IOS Release 12.2(15)BC2 and later releases.

Modes of Operation
The cable dynamic-secret command offers three different possible responses to cable modems that fail the
CMTS MIC verification check:
• When the mark option is used, the CMTS allows CMs to come online even if they fail the CMTS MIC
validity check. However, the CMTS also prints a warning message on the console and marks the cable
modem in the show cable modem command with an exclamation point (!), so that this situation can be
investigated. The following message is displayed on the console when such a CM registers with the Cisco
CMTS:

06:53:57: %UBR7200-4-CMMARKED: Cable Modem 00ff.ffee.ddcc in C3/0 attempted theft of service

• When the lock option is used, the CMTS assigns a restrictive QoS configuration to CMs that fail the
CMTS MIC validity check. If an optional lock-qos profile is specified, the CMTS assigns this profile to
the CM while it is locked.

If the lock-qos profile is not specified, the CMTS uses a special QoS configuration that limits the network
access for these CMs by restricting their downstream and upstream service flows to a maximum rate of 10

Cisco CMTS Cable Command Reference

257
 Cable Commands: cable d
cable dynamic-secret

kbps. (If you do not specify the lock-qos profile, you must also allow cable modems to create QoS profiles,
using the cable qos permission command. If you do not do this and use the lock option without specifying
a particular QoS profile, locked cable modems will not be allowed to register until the lock clears or expires.)
If a customer resets their CM, the CM will reregister but still uses the restricted QoS profile. A locked CM
continues with the restricted QoS profile until it goes offline and remains offline for at least 24 hours, at which
point it is allowed to reregister with a valid DOCSIS configuration file. This option frustrates users who are
repeatedly registering with the CMTS in an attempt to guess the shared secret, or to determine the details of
the Dynamic Shared Secret security system.
In addition, the following message is displayed on the console when a CM is locked.

06:53:57: %UBR7200-4-CMLOCKED: Cable Modem 00ff.ffee.ddcc in C3/0 attempted theft of service

Locked cable modems are shown with an exclamation point (!) in the show cable modem displays:

Router# show cable modem

MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPE Enb
0010.9507.01db 144.205.151.130 C5/1/0/U5 online(pt) 1 0.25 938 1 N
0080.37b8.e99b 144.205.151.131 C5/1/0/U5 online 2 -0.25 1268 0 N
0002.fdfa.12ef 144.205.151.232 C6/1/0/U0 online(pt) 13 -0.25 1920 1 N
0002.fdfa.137d 144.205.151.160 C6/1/0/U0 !online 16 -0.50 1920 1 N
0003.e38f.e9ab 144.205.151.237 C6/1/0/U0 !online 3 -0.50 1926 1 N
Router#

Tip You can also manually clear the lock on a CM by using the clear cable modem lock command.

• When the reject option is used, the CMTS refuses to allow CMs to come online if they fail the CMTS
MIC validity check. These cable modems appear with a MAC state of “reject(m)” in the displays generated
by the show cable modem command. After a short timeout period, the CM attempts to reregister with
the CMTS. The CM must register with a valid DOCSIS configuration file before being allowed to come
online. When the CM does come online, the CMTS prints a warning message on the console and marks
the cable modem in the show cable modem command with an exclamation point (!), so that this situation
can be investigated.

Tip Cisco recommends that you initially use the mark option, so that potential problems are identified without
immediately interfering with users’ ability to come online. After you identify and resolve these initial problems,
reconfigure the cable interfaces with the reject or lock option to block problem cable modems that attempt
to come online without a valid shared secret.

Note To account for possible network problems, such as loss of packets and congestion, the Cisco CMTS will allow
a cable modem to attempt to register twice before marking it as having failed the Dynamic Shared Secret
authentication checks.

Filename Encryption

Cisco CMTS Cable Command Reference

258
Cable Commands: cable d
cable dynamic-secret

By default, the cable dynamic-secret command encrypts the original filename for a DOCSIS configuration
file when the Cisco CMTS transmits the file to the CM. This filename changes in a semi-random manner,
making it difficult for users to predict the filename for the file that should be downloaded to the CM.
This does mean, however, that the filenames specified in the DHCP HELLO and ACK messages are different,
and that the filenames on the CM and on the TFTP server are different. This could interfere with custom
network management applications and scripts. If this is the case, you can disable the automatic filename
encryption by adding the nocrypt option to the command.
The nocrypt option does slightly decrease the security provided by this feature, so this possibility should be
weighed against the ability to more conveniently manage the network.
Interaction with the TFTP Enforce Feature

Note Cisco cBR-8 router does not support cable tftp-enforce command.

The cable tftp-enforce command provides another layer of protection against theft-of-service attacks by
requiring cable modems to download a DOCSIS configuration file through the CMTS cable interface before
being allowed to register. When the cable tftp-enforce command is used with the cable dynamic-secret
command, the TFTP enforce checks are done before the dynamic shared-secret checks. If a cable modem fails
to download a DOCSIS configuration file through the CMTS, it is not allowed to register, regardless of the
dynamic shared-secret checks.
Displaying Rogue Cable Modems
Use the show cable modem rogue command to display the cable modems that have failed the dynamic
shared-secret authentication checks:

Router# show cable modem rogue

Spoof TFTP
MAC Address Vendor Interface Count Dnld Dynamic Secret
AAAA.7b43.aa7f Vendor1 C4/0/U5 2 Yes 45494DC933F8F47A398F69EE6361B017
AAAA.7b43.aa7f Vendor1 C4/0/U5 2 Yes D47BCBB5494E9936D51CB0EB66EF0B0A
BBBB.7b43.aa7f Vendor2 C4/0/U5 2 No 8EB196423170B26684BF6730C099D271
AAAA.7b43.aa7f Vendor1 C4/0/U5 2 No DF8FE30203010001A326302430120603
BBBB.7b43.aa7f Vendor2 C4/0/U5 2 No 300E0603551D0F0101FF040403020106
AAAA.7b43.aa7f Vendor1 C4/0/U5 2 Yes 820101002D1A264CE212A1BB6C1728B3
DDDD.7b43.aa7f Vendor4 C4/0/U5 2 Yes 7935B694DCA90BC624AC92A519C214B9
AAAA.7b43.aa7f Vendor1 C4/0/U5 2 No 3AB096D00D56ECD07D9B7AB662451CFF
Router#

If the CMTS cannot obtain the DOCSIS configuration file from the TFTP server, a message similar to the
following is displayed on the console:

%UBR7200-4-NOCFGFILE: Cannot read modem config file platinum.cm from C3/0: <reason>

where the reason can be one of the following, depending on the error that the TFTP server reported:
• Compression Failed
• File too big
• Invalid Checksum
• Invalid IP address or hostname
• Uncompression Failed

Cisco CMTS Cable Command Reference

259
 Cable Commands: cable d
cable dynamic-secret

• User Abort

Examples The following example shows how to configure a cable interface on a Cisco uBR7200 series router
with the mark option, so that CMs that fail the MIC verification are allowed to register but are
marked in the show cable modem displays so that their situation can be further investigated:

Router# configure terminal

Router(config)# interface cable 4/0

Router(config-if)# cable dynamic-secret mark

Router(config-if)# exit

Router(config)# exit

Router#

The following example shows how to configure the cable interface on a Cisco uBR7100 series router,
so that CMs that fail the MIC verification are locked with a QoS profile that limits upstream and
downstream service flows to 10 kbps:

Router# configure terminal

Router(config)# cable qos permission create

Router(config)# cable qos permission update

Router(config)# interface cable 1/0

Router(config-if)# cable dynamic-secret lock

Router(config-if)# exit

Router(config)# exit

Router#

Note If you do not use the cable qos permission global configuration command to allow cable modems
to create their own QoS profiles, the CMTS rejects this command and displays the following error
message: %Need permission for modems to create QoS profile

The following example shows how to configure a cable interface so that CMs that fail the MIC
verification are locked with a specific QoS profile:

Router# configure terminal

Router(config)# interface cable 1/0

Router(config-if)# cable dynamic-secret lock 31

Router(config-if)# exit

Router(config)# exit

Router#

Cisco CMTS Cable Command Reference

260
 Cable Commands: cable d
cable dynamic-secret

Note If the specified QoS profile does not exist, the CMTS rejects this command and displays the following
error message: %Profile qos-id to lock modem does not exist

The following example shows how to configure a cable interface on a Cisco uBR7200 series router,
so that CMs that fail the MIC verification are not allowed to register and must reregister with a valid
DOCSIS configuration file before being allowed to come online:

Router# configure terminal

Router(config)# interface cable 3/0

Router(config-if)# cable dynamic-secret reject

Router(config-if)# exit

Router(config)# exit

Router#

The following example shows how to disable the Dynamic Shared Secret feature on a cable interface
on the Cisco uBR10012 router:

Router# configure terminal

Router(config)# interface cable 6/1/0

Router(config-if)# no cable dynamic-secret

Router(config-if)# exit

Router(config)# exit

Router#

Related Commands Command Description

cable dynamic-secret exclude Excludes one or more specific cable modems from being processed by
the Dynamic Shared Secret feature.

cable shared-secondary-secret Configures one or more secondary shared secret keys that CMs can use
to successfully process the DOCSIS configuration file and register with
the CMTS.

cable shared-secret Configures an authentication shared secret key that CMs must use to
successfully process the DOCSIS configuration file and register with the
CMTS.

cable tftp-enforce (for uBR Requires that all CMs on a cable interface attempt to download a DOCSIS
series router) configuration file using Trivial File Transfer Protocol (TFTP) through
the cable interface before being allowed to register and come online.

clear cable modem lock Resets the lock on one or more CMs, and reinitializes them, so that they
can reregister with a valid DOCSIS configuration file.

Cisco CMTS Cable Command Reference

261
 Cable Commands: cable d
cable dynamic-secret

Command Description

show cable modem rogue Displays a list of cable modems that have been marked, locked, or rejected
because they failed the dynamic shared-secret authentication checks.

Cisco CMTS Cable Command Reference

262
 Cable Commands: cable d
cable dynamic-secret exclude

cable dynamic-secret exclude

To exclude one or more specific cable modems from being processed by the Dynamic Shared Secret feature,
use the cable dynamic-secret exclude command in global configuration mode. To disable this feature, use
the no form of this command.

cable dynamic-secret exclude {modem mac-address | oui oui-id}

no cable dynamic-secret {modem mac-address | oui oui-id}

Syntax Description modem mac-address Specifies the hardware (MAC) address of a specific individual cable modem to be
excluded from the Dynamic Shared Secret feature. (You cannot specify a multicast
MAC address.)

oui oui-id Specifies the organization unique identifier (OUI) of a vendor, so that cable modems
from this vendor are excluded from the Dynamic Shared Secret feature. The OUI
should be specified as three hexadecimal bytes separated by either periods or colons.

Command Default All modems are processed by the Dynamic Shared Secret feature when the feature is enabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(9a)BC This command was introduced.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines When the cable dynamic-secretconfiguration command is configured on a cable interface, it automatically
includes all cable modems that register on that interface. To exclude one or more cable modems from being
processed by the Dynamic Shared Secret security checks, use the cable dynamic-secret exclude command
in global configuration mode.
You may exclude cable modems from the Dynamic Shared Secret security checks if they need to download
additional files from the TFTP server at registration time. For example, Cisco cable CPE devices, such as the
Cisco uBR925 cable access router, can be instructed to download a Cisco IOS configuration file after
downloading the DOCSIS configuration file.
However, when Dynamic Shared Secret checks are being used, the Cisco CMTS does not allow the cable
modem to download any other files after the first successful download of the DOCSIS configuration file. To
allow these cable modems to download their Cisco IOS configuration files, use the cable
dynamic-secret-exclude command to exclude them from the Dynamic Shared Secret checks.
You can exclude either a specific cable modem by its MAC address, or all of a vendor’s cable modems by
their OUI value. Excluded cable modems must still register according to the normal DOCSIS provisioning

Cisco CMTS Cable Command Reference

263
 Cable Commands: cable d
cable dynamic-secret exclude

procedures, but their DOCSIS configuration files are no longer verified by the Dynamic Shared Secret security
checks.

Tip When a cable modem is excluded from the Dynamic Shared Secret feature, the Dynamic Secret field in its
show cable modem verbosedisplay shows “Excluded”.

Examples The following example shows how to exclude a specific cable modem, with the MAC address of
00d0.45ba.b34b, from being processed by the Dynamic Shared Secret feature:

Router# configure terminal

Router(config)# cable dynamic-secret exclude modem 00d0.45ba.b34b

Router(config)# exit

Router#

The following example shows how to exclude all cable modems with a vendor OUI value 00.01.B4
from being processed by the Dynamic Shared Secret feature:

Router# configure terminal

Router(config)# cable dynamic-secret exclude oui 00.01.B4

Router(config)# exit

Related Commands Command Description

cable dynamic-secret Enables the Dynamic Shared Secret feature, so that DOCSIS configuration
files are verified with a MIC that has been created with a dynamically
generated shared secret.

cable shared-secondary-secret Configures one or more secondary shared secret keys that CMs can use to
successfully process the DOCSIS configuration file and register with the
CMTS.

cable shared-secret Configures an authentication shared secret key that CMs must use to
successfully process the DOCSIS configuration file and register with the
CMTS.

cable tftp-enforce (for uBR Requires that all CMs on a cable interface attempt to download a DOCSIS
series router) configuration file using Trivial File Transfer Protocol (TFTP) through the
cable interface before being allowed to register and come online.

clear cable modem lock Resets the lock on one or more CMs, and reinitializes them, so that they
can reregister with a valid DOCSIS configuration file.

show cable modem rogue Displays a list of cable modems that have been marked, locked, or rejected
because they failed the dynamic shared-secret authentication checks.

Cisco CMTS Cable Command Reference

264
 Cable Commands: cable d
cable dynamic-secret tftp insert-upgrade-server

cable dynamic-secret tftp insert-upgrade-server

To dynamically insert the IPv4 or IPv6 TLV values in the Data-over-Cable Service Interface Specifications
(DOCSIS) configuration file to complete firmware upgrade on cable modems, use the cable dynamic-secret
tftp insert-upgrade-server command in the global configuration mode.

cable dynamic-secret tftp insert-upgrade-server

no cable dynamic-secret tftp insert-upgrade-server

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The Dynamic Shared Secret feature must be configured before you can upgrade the firmware on cable modems.
To enable this feature, execute the cable dynamic-secret command in the cable interface configuration mode.

Examples The following example dynamically inserts the correct IPv4 or IPv6 TLV values from the DOCSIS
configuration file to upgrade firmware on the cable modems.

Router(config)# cable dynamic-secret tftp insert-upgrade-server

Router(config)# end

Related Commands Command Description

cable dynamic-secret Enables the Dynamic Shared Secret feature so that DOCSIS configuration
files are verified with a Message Integrity Check (MIC) that has been created
with a dynamically generated shared secret.

cable dynamic-secret exclude Excludes one or more specific cable modems from being processed by the
Dynamic Shared Secret feature.

clear cable modem lock Resets the lock on one or more CMs, and re-initializes them, so that they
can reregister with a valid DOCSIS configuration file.

Cisco CMTS Cable Command Reference

265
 Cable Commands: cable d
cable dynamic-secret tftp insert-upgrade-server

Cisco CMTS Cable Command Reference

266
Cable Commands: cable e through cable i
• cable enable-trap, on page 268
• cable event priority, on page 271
• cable event syslog-server, on page 274
• cable event throttle-adminStatus, on page 277
• cable event throttle-interval, on page 280
• cable event throttle-threshold, on page 282
• cable falcon-100g, on page 284
• cable fiber-node, on page 285
• cable filter group, on page 288
• cable flap-list aging, on page 295
• cable flap-list insertion-time, on page 297
• cable flap-list miss-threshold, on page 299
• cable flap-list power-adjust threshold, on page 301
• cable flap-list size, on page 303
• cable freq-range, on page 305
• cable frequency-exclusion-band, on page 310
• cable helper-address, on page 311
• cable host access-group, on page 315
• cable high-priority-call-window, on page 317
• cable igmp static-group, on page 319
• cable init-channel-timeout, on page 321
• cable insertion-interval, on page 322
• cable intercept, on page 324
• cable ip-init, on page 327
• cable ip-broadcast-echo, on page 328
• cable ip-multicast-echo, on page 330
• cable ipc-stats, on page 332
• cable ipc-watermark, on page 333
• cable ipv6 dhcp-insert, on page 334
• cable ipv6 dhcp-relay override, on page 336
• cable ipv6 source-verify, on page 337
• cable ipv6 source-verify dhcp ns-probe, on page 340
• cable ipv6 source-verify leasequery-filter downstream, on page 342

Cisco CMTS Cable Command Reference

267
 Cable Commands: cable e through cable i
cable enable-trap

cable enable-trap
To permanently set four CISCO-DOCS-EXT-MIB MIB attributes that enable the sending of a trap when a
CM changes between the online and offline states, use the cable enable-trap command in cable interface
configuration mode. To return to the default settings found in the MIB, which disable the sending of these
traps, use the no form of this command.

cable enable-trap [cmonoff-notification | cmonoff-interval time-in-secs]

no cable enable-trap [cmonoff-notification | cmonoff-interval]

Syntax Description cmonoff-notification Enables or disables the sending of the notification traps.

cmonoff-interval Specifies the minimum interval that must pass before sending out a new trap for the
same CM.

time-in-secs Specifies the number of seconds. The range is from 0 to 86400. The default is zero.

Command Default The default is to use the MIB defaults, which specify that traps must not be sent. The default value is zero
seconds.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(13)SC This command was introduced.

12.1(5)EC1 This command was added to the 12.1 EC train and support was added for the Cisco uBR7100
series routers.

12.2(4)BC1 This command was added to the 12.2 BC train and support was added for the Cisco
uBR10012 router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines This command sets four attributes in the CISCO-DOCS-EXT-MIB MIB, so that the new values can be
automatically loaded whenever the CMTS router powers on or reloads. To do so, put the appropriate commands
in the configuration file and save it to the CMTS router’s Flash memory. The CMTS router automatically sets
the appropriate MIB values when it processes the configuration file at startup.
These commands affect whether the CM online/offline notification trap (cdxCmtsCmOnOffNotification) is
sent, and if so, the minimum interval that must exist between traps that are sent for the same CM undergoing
the same state changes. The following describes the relationship between these commands and the attributes
in the CISCO-DOCS-EXT-MIB MIB:

Cisco CMTS Cable Command Reference

268
 Cable Commands: cable e through cable i
cable enable-trap

• The cable enable-trap cmonoff-notification command sets the cdxCmtsCmOnOffTrapEnable attribute

to 1 (true), which enables the sending of the CM online and offline traps.
• The no cable enable-trap cmonoff-notification command sets the cdxCmtsCmOnOffTrapEnable
attribute to 2 (false), which disables the sending of the CM online and offline traps.
• The cable enable-trap cmonoff-interval command sets the cdxCmtsCmOnOffTrapInterval attribute to
the specified time period (0 to 86400 seconds), which sets the minimum interval that must exist before
the CMTS sends out the same trap for the same CM.
For example, if the interval is set to 600 seconds, and the same CM goes offline three times and online
twice in that time period, only one online trap and one offline trap is sent to the SNMP manager.
• The no cable enable-trap cmonoff-interval command sets the cdxCmtsCmOnOffTrapInterval attribute
to 0, which means a trap will be sent for every CM online/offline transition.

Command History Release Modification

Cisco IOS XE Cupertino The cdxcmonoffnotification has been enhanced to retreive the following
17.15.1w attribute details:
• Fiber Node ID
• RPD Mac Address
• RPD Alias (RPD Name)
• RPD upstream and downstream port
• Modem Registration Time

Note cBR-8 does not support sending modem on/off event notifications to the syslog-server.

Note Setting the cmonoff-interval option and the cdxCmtsCmOnOffTrapInterval attribute has meaning only if
cdxCmtsCmOnOffNotification traps have been previously enabled.

Examples The following commands enable the sending of CM on or off traps, with a minimum interval of 1200
seconds between traps being sent for the same CM:

router(config)# interface c6/0

router(config-if)# cable enable-trap cmonoff-notification

router(config-if)# cable enable-trap cmonoff-interval 1200
router(config-if)# exit

router(config)#

The following commands disable the sending of CM on or off traps.

router(config)# interface c6/0

Cisco CMTS Cable Command Reference

269
 Cable Commands: cable e through cable i
cable enable-trap

router(config-if)# no cable enable-trap cmonoff-notification

router(config-if)# exit

router(config)#

Related Commands Command Description

snmp-server enable traps cable Enables traps for cable-related events.

snmp-server enable traps docsis-cmts Enables traps for DOCSIS-related MAC-layer events.

Cisco CMTS Cable Command Reference

270
 Cable Commands: cable e through cable i
cable event priority

cable event priority

To configure the event reporting flags for DOCSIS event messages, which determines how the Cisco CMTS
reports these events, use the cable event priority command in global configuration mode. To return to the
default settings found in the MIB, use the no form of this command.

cable event priority {alert | critical | debug | emergency | error | informational | notice | warning}
flags

Syntax Description alert Sets the event reporting flag for alert system error messages. (Alert messages indicate that
some type of system or connection failure has occurred and requires immediate attention.)

critical Sets the event reporting flag for critical system error messages. (Critical messages indicate
that an error occurred which requires immediate attention to avoid system or connection
failure.)

debug Sets the event reporting flag for debug system error messages. (Debug messages appear only
when debugging has been enabled.)

emergency Sets the event reporting flag for emergency system error messages. (Emergency messages
indicate that the system has become unusable and requires immediate attention. This problem
might also be affecting other parts of the network.)

error Sets the event reporting flag for error system error messages. (Error messages indicate that
an error condition occurred that requires attention to resolve. Failure to address this problem
will result in some type of system or connection failure in the near future.)

informational Sets the event reporting flag for informational system error messages. (Informational messages
might or might not be significant to the system administrators.)

notice Sets the event reporting flag for notice system error messages. (Notice messages indicate
that a situation occurred that is normal but is significant enough that system administrators
might want to notice.)

warning Sets the event reporting flag for warning system error messages. (Warning messages indicate
that a condition occurred that indicates attention is needed in near future to avoid potential
problems. Failure to address this problem could result in some type of system or connection
failure later on.)

flags Sets the event reporting flags value, in hex, which specifies how this particular type of event
message should be reported. The valid range is 0x0 through 0xF0, which is a bitmask
specifying the types of reporting that should be done. See the Usage Guidelines for details.

Command Default The defaults are configured as per the DOCSIS 1.1 Operations Support System Interface (OSSI) Specification:
• Emergency and alert messages = (0x10) (reported to the local volatile log)
• Critical, error, warning, and notice = (0x70) (reported to the local volatile log, and forwarded as traps
and to the SYSLOG server)
• Information and debug = 0x0 (not reported)

Cisco CMTS Cable Command Reference

271
 Cable Commands: cable e through cable i
cable event priority

Command Modes
Global configuration (config)

Command History Release Modification

12.2(8)BC1 This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The DOCSIS 1.1 specifications require the CMTS to generate a set of messages for DOCSIS-specific events.
These messages can be assigned one of eight priority levels, ranging from emergency (the highest level) to
debug (the lowest level), and the CMTS can be configured to log each level of messages differently.
The Cisco CMTS supports the following types of logging, as defined by the DOCS-CABLE-DEVICE-MIB
MIB (RFC 2669):
• none (0x0) = DOCSIS messages are not reported. (The corresponding Cisco IOS event messages, however,
continue to be logged.)
• local-volatile (0x10) = DOCSIS messages are saved in a local log on the CMTS. This log can be limited
in size and can automatically discard previous messages to make room for incoming messages.
• syslog (0x20) = DOCSIS messages are sent to a SYSLOG server (if one has been configured, using the
cable event syslog-server command).
• traps (0x40) = DOCSIS messages are sent as SNMP traps to one or more SNMP managers.

These values can be added together to specify that the CMTS should report an event in more than one way.
For example, a value of 0x70 specifies that the CMTS should record the event in its local volatile log, and
also send it both as a trap and as a SYSLOG message.

Note If event messages are configured for traps or syslog reporting, they must also be configured for either local
volatile or local non-volatile reporting. This means that values 0x20 (syslog-only), 0x40 (trap-only), and 0x60
(syslog and trap only) are not supported.

Use the cable event priority command to set the reporting flags for each type of event. This also configures
the appropriate instance of the docsDevEvReporting attribute DOCS-CABLE-DEVICE-MIB MIB ( RFC
2669 ) with the same value.

Note This command affects only the DOCSIS event messages, and does not affect how the Cisco IOS software
handles event messages. If SYSLOG traps are enabled on the Cisco CMTS (using the snmp-server enable
traps syslog command), they continue to be sent, regardless of the cable event priority configuration.

Cisco CMTS Cable Command Reference

272
 Cable Commands: cable e through cable i
cable event priority

Examples The following commands configure the Cisco CMTS so that it reports all emergency, alert, and
critical messages as SNMP traps and SYSLOG messages, as well as logging it in the local volatile
log:

Router# configure terminal

Router(config)# cable event priority alert 0x70

Router(config)# cable event priority critical 0x70

Router(config)# cable event priority emergency 0x70

The following commands configure the Cisco CMTS so that it reports the lowest priority messages
only to the local volatile log and SYSLOG server:

Router# configure terminal

Router(config)# cable event priority debug 0x30

Router(config)# cable event priority informational 0x30

Router(config)# cable event priority notice 0x30

Related Commands Command Description

cable event syslog-server Enables logging of DOCSIS event messages to a SYSLOG server.

cable event throttle-adminStatus Configures how the Cisco CMTS throttles the SNMP traps and
SYSLOG messages it generates for DOCSIS event messages.

cable event throttle-interval Specifies the throttle interval, which helps control how often the
Cisco CMTS generates SNMP traps and SYSLOG messages for
DOCSIS event messages.

cable event throttle-threshold Sets the maximum number of SNMP traps and SYSLOG messages
that the Cisco CMTS can generate for DOCSIS event messages
during the throttle interval.

snmp-server enable traps cable Enables traps for cable-related events.

snmp-server enable traps docsis-cmts Enables traps for DOCSIS-related MAC-layer events.

Cisco CMTS Cable Command Reference

273
 Cable Commands: cable e through cable i
cable event syslog-server

cable event syslog-server

To enabling logging of DOCSIS event messages to a SYSLOG server, use the cable event syslog-server
command in global configuration mode. To disable the logging of a DOCSIS syslog server, use the no form
of this command.

cable event syslog-server ip-address

no cable event syslog-server

Syntax Description ip-address Specifies the IPv4 or IPv6 address for the DOCSIS SYSLOG server, which is the
docsDevEvSyslog attribute in the DOCS-CABLE-DEVICE-MIB (RFC 2669). If the IP address
is 0.0.0.0 or 0:0:0:0::0, SYSLOG service is disabled for DOCSIS events.

Command Default 0.0.0.0 or 0:0:0:0::0 (No DOCSIS SYSLOG server is defined.)

Command Modes
Global configuration (config)

Command History Release Modification

12.2(8)BC1 This command was introduced.

12.2(33)SCA This command was modified in Cisco IOS Release 12.2(33)SCA to support IPv6 addresses.
Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The DOCSIS 1.1 specifications require the CMTS router to generate a set of messages for DOCSIS-specific
events. Use the cable event syslog-server command to enable DOCSIS SYSLOG services and to set the IP
address for the DOCSIS SYSLOG server (which is the docsDevEvSyslog attribute in the
DOCS-CABLE-DEVICE-MIB).

Note cBR-8 does not support sending modem on/off event notifications to the syslog-server.

You can also configure the server’s IP address using SNMP commands to set the docsDevEvSyslog attribute
directly. Setting the docsDevEvSyslog attribute also creates a matching cable event syslog-server command
in the router’s configuration.
When you specify the IP address for a DOCSIS SYSLOG server, either by using the cable event syslog-server
command or by setting the docsDevEvSyslog attribute, the Cisco CMTS router begins generating event
messages that conform to the DOCSIS 1.1 specifications. This format is similar to but not identical to the
format that is used by the Cisco IOS software. For example, the following message is in the typical Cisco IOS
software format:

%UBR7200-4-DCC_ACK_REJ_MSG_SYNTAX_ERROR: DCC-ACK rejected message syntax error

The same error message appears as follows when using the DOCSIS 1.1 format:

Cisco CMTS Cable Command Reference

274
 Cable Commands: cable e through cable i
cable event syslog-server

<133>CMTS[DOCSIS]:<67040500> DCC-ACK rejected message syntax error

To disable the sending of events to the DOCSIS SYSLOG server, use the no cable event syslog-server
command, or specify an IP address of 0.0.0.0 (cable event syslog-server 0.0.0.0). Both commands set the
docsDevEvSyslog attribute to 0.0.0.0 and disable DOCSIS SYSLOG service. However, this does not disable
the Cisco IOS SYSLOG server (if it has been configured using the logging ip-address command).

Note You can use the same SYSLOG server for both Cisco IOS event messages and for DOCSIS-style event
messages, but it might be more convenient to use separate servers for the two different message formats. Use
the logging ip-address command in global configuration mode to set the IP address for the Cisco IOS SYSLOG
server. The DOCSIS SYSLOG server collects only event messages for DOCSIS events using the DOCSIS
format, while the Cisco IOS server collects all event messages (including DOCSIS events) using the standard
Cisco IOS message format.

Tip For more information about DOCSIS SYSLOG services and event messages, see Section 4.4.2.2.2, SYSLOG
Message Format, in the DOCSIS 1.1 Operations Support System Interface (OSSI) Specification
(SP-OSSIv1.1-I06-020830). For more information about all cable-related event messages that can be generated
on a Cisco CMTS router, see the Cisco CMTS System Messages guide.

Examples The following command sets the docsDevEvSyslog attribute with an IPv4 address of 192.168.100.137:

cable event syslog-server 192.168.100.137

The following commands specifies different SYSLOG servers. The server at IPv4 address
192.168.100.137 receives the DOCSIS-style event messages, and the server at IPv4 address
192.168.100.138 receives the Cisco IOS style messages.

cable event syslog-server 192.168.100.137

logging 192.168.100.138

The following command sets the docsDevEvSyslog attribute to IPv4 address 0.0.0.0, which disables
DOCSIS SYSLOG services:

no cable event syslog-server

Note You can also disable DOCSIS SYSLOG services with the cable event syslog-server 0.0.0.0 command.

The following command specifies a DOCSIS SYSLOG server with an IPv6 address:

cable event syslog-server 2001:0DB8:0:ABCD::1

Cisco CMTS Cable Command Reference

275
 Cable Commands: cable e through cable i
cable event syslog-server

Related Commands Command Description

cable event priority Configures the event reporting flags for DOCSIS event messages,
which determines how the Cisco CMTS router reports these events.

cable event throttle-adminStatus Configures how the Cisco CMTS router throttles the SNMP traps and
SYSLOG messages it generates for DOCSIS event messages.

cable event throttle-interval Specifies the throttle interval, which helps control how often the Cisco
CMTS router generates SNMP traps and SYSLOG messages for
DOCSIS event messages.

cable event throttle-threshold Sets the maximum number of SNMP traps and SYSLOG messages
that the Cisco CMTS router can generate for DOCSIS event messages
during the throttle interval.

snmp-server enable traps cable Enables traps for cable-related events.

snmp-server enable traps Enables traps for DOCSIS-related MAC-layer events.

docsis-cmts

Cisco CMTS Cable Command Reference

276
 Cable Commands: cable e through cable i
cable event throttle-adminStatus

cable event throttle-adminStatus

To configure how the Cisco CMTS router throttles the SNMP traps and syslog messages it generates for
DOCSIS event messages, use the cable event throttle-adminStatus command in global configuration mode.
To restore the default behavior, use the no form of this command.

cable event throttle-adminStatus {inhibited | maintainBelowThreshold | stopAtThreshold |

unconstrained}
no cable event throttle-adminStatus

Syntax Description inhibited Supresses all SNMP traps and syslog messages for DOCSIS event messages.

maintainBelowThreshold Performs throttling, so that SNMP traps and syslog messages are suppressed if
they would otherwise exceed the throttle threshold. The Cisco CMTS resumes
generating traps and messages at the start of the next throttle interval.

stopAtThreshold Performs throttling, so that the Cisco CMTS stops generating all SNMP traps
and syslog messages if they would exceed the throttle threshold. The Cisco CMTS
does not resume generating traps and messages until directed to do so by repeating
this command.

unconstrained Specifies that the SNMP traps and syslog messages for DOCSIS event messages
are not throttled.

Command Default SNMP traps and syslog messages for DOCSIS event messages are not throttled (unconstrained).

Command Modes
Global configuration (config)

Command History Release Modification

12.2(8)BC1 This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the value of the docsDevEvThrottleAdminStatus attribute in the
DOCS-CABLE-DEVICE-MIB MIB ( RFC 2669 ), which controls whether the Cisco CMTS should throttle
SNMP traps and syslog messages that are generated for DOCSIS event messages.
The DOCS-CABLE-DEVICE-MIB MIB supports the following threshold configurations:
• inhibited—The Cisco CMTS does not generate any SNMP traps or syslog messages for DOCSIS events.
• maintainBelowThreshold—Throttling is performed, and SNMP traps and syslog messages are suppressed
if they would exceed the throttle threshold (as set by the cable event throttle-interval and cable event

Cisco CMTS Cable Command Reference

277
 Cable Commands: cable e through cable i
cable event throttle-adminStatus

throttle-threshold commands). The Cisco CMTS resumes generating traps and messages at the start of
the next throttle interval.
• stopAtThreshold—Throttling is performed, and the Cisco CMTS stops generating all SNMP traps and
syslog messages when they exceed the throttle threshold. The Cisco CMTS does not resume generating
traps and messages until the threshold state is reset. This can be done by repeating the cable event
throttle-adminStatus command, or by setting the docsDevEvThrottleAdminStatus attribute in the
DOCS-CABLE-DEVICE-MIB MIB.
• unconstrained—All SNMP traps and syslog messages are transmitted without any throttling.

Tip For more information about DOCSIS syslog services and event messages, see Section 4.4.2.2.2, syslog Message
Format, in the DOCSIS 1.1 Operations Support System Interface (OSSI) Specification
(SP-OSSIv1.1-I06-020830). For more information about all cable-related event messages that can be generated
on the Cisco CMTS router, see the Cisco CMTS Error Message manual.

Examples The following commands configure the Cisco CMTS router to throttle SNMP traps and syslog
messages according to the specified throttle interval and threshold:

Router# configure terminal

Router(config)# cable event throttle-interval 90

Router(config)# cable event throttle-threshold 30

Router(config)# cable event throttle adminStatus maintainBelowThreshold

The following commands configure the Cisco CMTS router for the default behavior, so that it does
not throttle SNMP traps and syslog messages. The configured throttle interval and threshold are
ignored.

Router# configure terminal

Router(config)# cable event throttle adminStatus unconstrained

Related Commands Command Description

cable event priority Configures the event reporting flags for DOCSIS event messages,
which determines how the Cisco CMTS reports these events.

cable event syslog-server Enables logging of DOCSIS event messages to a syslog server.

cable event throttle-interval Specifies the throttle interval, which helps control how often the
Cisco CMTS generates SNMP traps and syslog messages for
DOCSIS event messages.

cable event throttle-threshold Sets the maximum number of SNMP traps and syslog messages that
the Cisco CMTS can generate for DOCSIS event messages during
the throttle interval.

snmp-server enable traps cable Enables traps for cable-related events.

Cisco CMTS Cable Command Reference

278
Cable Commands: cable e through cable i
cable event throttle-adminStatus

Command Description

snmp-server enable traps docsis-cmts Enables traps for DOCSIS-related MAC-layer events.

Cisco CMTS Cable Command Reference

279
 Cable Commands: cable e through cable i
cable event throttle-interval

cable event throttle-interval

To specify the throttle interval, which controls how often the Cisco CMTS router generates SNMP traps and
syslog messages for DOCSIS event messages, use the cable event throttle-interval command in global
configuration mode. To restore the default behavior, use the no form of this command.

cable event throttle-interval seconds

no cable event throttle-interval

Syntax Description seconds Length of the throttle interval, in seconds. The range is from 0 to 2147483647. The default is 60.

Command Default The throttle interval is 60 seconds (1 minute).

Command Modes
Global configuration (config)

Command History Release Modification

12.2(8)BC1 This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The DOCSIS 1.1 specifications require the CMTS to generate a set of messages for DOCSIS-specific events.
In certain situations, such as a power outage that causes a mass reregistration of cable modems, this can
generate such a large volume of event messages that it can impact system performance.
To avoid this possibility, use the cable event throttle-interval command, together with the cable event
throttle-threshold command, to specify the maximum number of SNMP traps or syslog events that the Cisco
CMTS can generate for DOCSIS events over a specific interval:
• cable event throttle-interval—Specifies the length of the throttle interval.
• cable event throttle-threshold—Specifies the maximum number of SNMP traps and syslog events that
the Cisco CMTS can generate during that period.
The threshold value counts DOCSIS events, not SNMP traps or syslog messages. If a DOCSIS event generates
both an SNMP trap and a syslog message, the Cisco CMTS counts it as only one event.

Note The cable event throttle-interval and cable event throttle-threshold commands do not have any effect
unless the cable event throttle-adminStatus has been configured to allow the throttling of DOCSIS event
messages.

Cisco CMTS Cable Command Reference

280
 Cable Commands: cable e through cable i
cable event throttle-interval

Tip For more information about DOCSIS syslog services and event messages, see Section 4.4.2.2.2, syslog Message
Format, in the DOCSIS 1.1 Operations Support System Interface (OSSI) Specification
(SP-OSSIv1.1-I06-020830). For more information about all cable-related event messages that can be generated
on the Cisco CMTS router, see the Cisco CMTS Error Message manual.

Examples The following commands configure the Cisco CMTS router so that it can generate a maximum
number of 30 SNMP traps and syslog messages for DOCSIS events over a 90-second period:

Router# configure terminal

Router(config)# cable event throttle-interval 90

Router(config)# cable event throttle-threshold 30

Related Commands Command Description

cable event priority Configures the event reporting flags for DOCSIS event messages,
which determines how the Cisco CMTS reports these events.

cable event syslog-server Enables logging of DOCSIS event messages to a syslog server.

cable event throttle-adminStatus Configures how the Cisco CMTS throttles the SNMP traps and
syslog messages it generates for DOCSIS event messages.

cable event throttle-threshold Sets the maximum number of SNMP traps and syslog messages
that the Cisco CMTS can generate for DOCSIS event messages
during the throttle interval.

snmp-server enable traps cable Enables traps for cable-related events.

snmp-server enable traps docsis-cmts Enables traps for DOCSIS-related MAC-layer events.

Cisco CMTS Cable Command Reference

281
 Cable Commands: cable e through cable i
cable event throttle-threshold

cable event throttle-threshold

To set the maximum number of SNMP traps and syslog messages that the Cisco CMTS router can generate
for DOCSIS event messages during the throttle interval, use the cable event throttle-threshold command in
global configuration mode. To restore the default number, use the no form of this command.

cable event throttle-threshold number

no cable event throttle-threshold

Syntax Description number Maximum allowable number of DOCSIS events for which the Cisco CMTS can generate SNMP
traps and syslog messages during the throttle period. The range is from 0 to 2147483647. The default
of 10.

Command Default The default maximum is 10.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(8)BC1 This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The DOCSIS 1.1 specifications require the CMTS to generate a set of messages for DOCSIS-specific events.
In certain situations, such as a power outage that causes a mass reregistration of cable modems, this can
generate such a large volume of event messages that it can impact system performance.
To avoid this possibility, use the cable event throttle-threshold command, together with the cable event
throttle-interval command, to specify the maximum number of SNMP traps or syslog events that the Cisco
CMTS can generate for DOCSIS events over a specific interval:
• cable event throttle-interval—Specifies the length of the throttle interval.
• cable event throttle-threshold—Specifies the maximum number of SNMP traps and syslog events that
the Cisco CMTS can generate during that period.
The threshold value counts DOCSIS events, not SNMP traps or syslog messages. If a DOCSIS event generates
both an SNMP trap and a syslog message, the Cisco CMTS counts it as only one event.

Note The cable event throttle-interval and cable event throttle-threshold commands do not have any effect
unless the cable event throttle-adminStatus has been configured to allow the throttling of DOCSIS event
messages.

Cisco CMTS Cable Command Reference

282
 Cable Commands: cable e through cable i
cable event throttle-threshold

Tip For more information about DOCSIS syslog services and event messages, see Section 4.4.2.2.2, syslog Message
Format, in the DOCSIS 1.1 Operations Support System Interface (OSSI) Specification
(SP-OSSIv1.1-I06-020830). For more information about all cable-related event messages that can be generated
on the Cisco CMTS router, see the Cisco CMTS Error Message manual.

Examples The following commands configure the Cisco CMTS router so that it can generate a maximum
number of 25 SNMP traps and syslog messages for DOCSIS events over a two-minute period:

Router# configure terminal

Router(config)# cable event throttle-interval 120

Router(config)# cable event throttle-threshold 25

Related Commands Command Description

cable event priority Configures the event reporting flags for DOCSIS event messages,
which determines how the Cisco CMTS reports these events.

cable event syslog-server Enables logging of DOCSIS event messages to a syslog server.

cable event throttle-adminStatus Configures how the Cisco CMTS throttles the SNMP traps and
syslog messages it generates for DOCSIS event messages.

cable event throttle-interval Specifies the throttle interval, which helps control how often the
Cisco CMTS generates SNMP traps and syslog messages for
DOCSIS event messages.

snmp-server enable traps cable Enables traps for cable-related events.

snmp-server enable traps docsis-cmts Enables traps for DOCSIS-related MAC-layer events.

Cisco CMTS Cable Command Reference

283
 Cable Commands: cable e through cable i
cable falcon-100g

cable falcon-100g
To configure the falcon registers for the two falcon 100g modes, use the cable falcon-100g command in the
cable falcon-100g configuration mode.

cable falcon-100g { 10-km-link | 10-m-link }

no cable falcon-100g

Syntax Description 10-km-link Configures sup250 falcon 100g 10-km-link mode

10-m-link Configures sup250 falcon 100g 10-m-link mode

Command Default The default configuration is sup250 falcon 100g 10-km-link mode.

Command Modes cable falcon-100g configuration mode (config-falcon)

Command History Release Modification

Cisco IOS XE Amsterdam 17.3.1 This command was introduced.

The following example shows how to configure sup250 falcon 100g 10-km-link mode.
Router# configure terminal
Router(config)# cable falcon-100g 10-km-link
Router(config)# end

The following example shows how to configure sup250 falcon 100g 10-m-link mode.
Router# configure terminal
Router(config)# cable falcon-100g 10-m-link
Router(config)# end

The following example shows how to use the command no cable falcon-100g.
Router# configure terminal
Router(config)# no cable falcon-100g
Router(config)# end

Cisco CMTS Cable Command Reference

284
 Cable Commands: cable e through cable i
cable fiber-node

cable fiber-node
To enter cable fiber-node configuration mode to configure a fiber node, use the cable fiber-node command
in global configuration mode. To remove a fiber node configuration, use the no form of this command.

cable fiber-node fiber-node-id

no cable fiber-node fiber-node-id

Syntax Description fiber-node-id Specifies a unique numerical ID for the fiber node. The range is from 1 to 256.

Command Default The command mode is unchanged.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.3(23)BC This command was updated to allow an RF channel from the SPA or a Cisco
uBR10-MC5X20 downstream channel can serve as a primary channel in a fiber node.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines In Cisco uBR series router, the cable fiber-node command allows the multiple service operator (MSO) or
service provider to configure the CMTS to be more intelligent by making Cisco IOS aware of how the cable
plant is wired. The downstream channels of the cable plant must be accurately configured in the CMTS fiber
nodes. This allows the CMTS to accurately signal the wideband modems on which wideband channels are
available to the modem.
In a cable network, a cable modem is physically connected to only one fiber node. Fiber node software
configuration mirrors the physical topology of the cable network. When configuring fiber nodes with Cisco
IOS CLI commands, a fiber node is a software mechanism to define the following:
• The set of downstream RF channels that will flow into the fiber node
• At least one primary downstream channel

Note In Cisco IOS Releases 12.3(21)BC and 12.3(21a)BC3, this is a traditional DOCSIS downstream channel for
the fiber node. Beginning in Cisco IOS Release 12.3(23)BC, either an RF channel from the SPA or a Cisco
uBR10-MC5X20 downstream channel can serve as a primary channel in a fiber node.

• The set of upstream channel ports on the cable interface line card that are connected to the fiber node
and available as upstream channels
Use the cable fiber-node command to enter cable fiber-node configuration mode so that you can configure
a fiber node.
For a wideband channel to work correctly, each fiber node must be configured as follows:

Cisco CMTS Cable Command Reference

285
 Cable Commands: cable e through cable i
cable fiber-node

1. Use the cable fiber-node command to create the fiber node and to enter cable fiber-node configuration
mode.
2. Use the downstream command to associate the fiber node with one or more primary downstream channels
(traditional DOCSIS downstream channels).

Note Beginning in Cisco IOS Release 12.3(23)BC, if the primary downstream channel for this fiber node is assigned
from a SPA RF downstream channel, then this command is not required.

3. Use the upstream command to specify the upstream channel ports for a fiber node.
4. Use the downstream modular-cable rf-channel command to make one or more SPA RF channels
available for the fiber node.
5. Optionally, use the description (cable fiber-node) command to specify a description for the fiber node.
For each fiber node, a traditional DOCSIS downstream channel on the Cisco uBR10-MC5X20 cable interface
line card is used to carry MAC management and signaling messages, and the associated traditional DOCSIS
upstream channel is used for return data traffic and signaling. The traditional DOCSIS downstream channel
used in this way is called the primary downstream channel . Beginning in Cisco IOS Release 12.3(23)BC,
either an RF channel from the SPA or a Cisco uBR10-MC5X20 downstream channel can serve as a primary
channel in a fiber node. If the fiber node does not have a Cisco uBR10-MC5X20 downstream channel, then
make sure that at least one of the SPA RF channels specified in the downstream modular-cable rf-channel
command is a primary-capable downstream channel.
Each wideband channel must be associated with at least one primary downstream channel and can be associated
with multiple primary downstream channels. A wideband channel and its associated primary downstream
channels must be belong to the same virtual bundle interface.
The maximum number of cable fiber nodes that can be configured is limited to 256 for each CMTS.
In Cisco cBR series router, for a wideband channel to work correctly, each fiber node must be configured as
follows:
1. Use the cable fiber-node command to create the fiber node and to enter cable fiber-node configuration
mode.
2. Use the downstream integrated-cable command to associate the fiber node with a downstream port, all
the downstream channels on this port are included in the fiber node .
3. Use the upstream upstream-cable command to specify the a upstream port for the fiber node.
To map SG channel to the physical RF channel, use the following commands:
• downstream sg-channel low high integrated-cable slot/subslot/port rf-channel low high
• upstream sg-channel low high upstream-controller slot/subslot/port us-channel low high

Use the service-group profile profile name command to associate SG profile to a fiber-node, which will
generate all the MAC domains, integrated-cable interfaces and wideband interfaces.

Examples The following example shows how to enter configuration mode for fiber node 5.

Cisco IOS Release 12.3(21)BC

Router# configure terminal

Cisco CMTS Cable Command Reference

286
 Cable Commands: cable e through cable i
cable fiber-node

Router(config)# cable fiber-node 5

Router(config-fiber-node)#
downstream Cable 6/0/0
downstream Modular-Cable 1/0/0 rf-channel 0-1
upstream cable 5/0 connector 0

Cisco IOS Release 12.3(23)BC

Router# configure terminal

Router# cable fiber-node 5
Router(config-fiber-node)#
downstream Modular-Cable 1/0/0 rf-channel 0-3
upstream cable 5/0 connector 0

Cisco IOS-XE Release 3.15.0S

Router# configure terminal

Router(config)# cable fiber-node 5
Router(config-fiber-node)# downstream Integrated-Cable 3/0/0

Related Commands Command Description

description (cable fiber-node) Specifies a description for a fiber node.

downstream cable Assigns a primary downstream channel for a fiber node.

downstream modular-cable rf-channel Specifies the RF channels that are available for wideband channels
on a fiber node.

upstream cable connector Specifies the upstream channel ports for a fiber node.

Cisco CMTS Cable Command Reference

287
 Cable Commands: cable e through cable i
cable filter group

cable filter group

To create, configure, and activate a DOCSIS 1.1 filter group that filters packets on the basis of the TCP/IP
and UDP/IP headers, use the cable filter group command in global configuration mode. To delete a filter
group or to reset a particular option to its default value, use the no form of this command.

cable filter group group-id index index-num [option option-value]

no cable filter group group-id index index-num [option option-value]

Syntax Description group-id Specifies a unique group ID for this filter group.
(For Cisco uBR Series Router) The range is from 1 to 254.
255 is reserved for use by the CMTS router.
(For Cisco cBR Series Router) The range is from 1 to 254.

index-num Specifies a unique index for this particular filter. The range
is from 1 to 128 on a uBR7200 series router, and 1 to 255
on a uBR10012 router and cBR-8 router.

Specify one of the following options and

option-values
dest-ip ip-address (Optional) Specifies the destination IP address that should
be matched. The default IP address is 0.0.0.0. (IPv4 filters
only)

dest-mac-addr mac-address (Optional) Specifies the destination MAC address that

should be matched. Cisco cBR-8 router does not have this
option.

dest-mac-mask mask (Optional) Specifies the mask for the destination MAC
address that should be matched. Cisco cBR-8 router does
not have this option.

dest-mask mask (Optional) Specifies the mask for the destination address
that should be matched. The mask is ANDed with the IP
address specified by the dest-ip option and compared to
the result of ANDing the mask with the packet’s destination
IP address. The filter considers it a match if the two values
are the same. (IPv4 filters only)
Note
The default mask of 0.0.0.0 matches all IP addresses.

dest-port port-number (Optional) Specifies the TCP/UDP destination port number

that should be matched. The range is from 0 to 65535. The
default value matches all TCP/UDP port numbers (IPv4
and IPv6 filters).

eth-proto-type ethernet protocol type (Optional) Specifies the Ethernet protocol type number that
should be matched. The range is from 0 to 65536. Cisco
cBR-8 router does not have this option.

Cisco CMTS Cable Command Reference

288
Cable Commands: cable e through cable i
cable filter group

eth-protocol ethernet protocol number (Optional) Specifies the Ethernet protocol that should be
matched. The range is from 0 to 65536. Cisco cBR-8 router
does not have this option.

ip-proto proto-type (Optional) Specifies the IP protocol type number that should
be matched. The range is from 0 to 256. The default is 256,
which matches all protocols (IPv4 and IPv6 filters).
Some commonly-used values are:
• 1—ICMP, Internet Control Message Protocol.
• 2—IGMP, Internet Group Management Protocol.
• 4—IP in IP encapsulation.
• 6—TCP, Transmission Control Protocol.
• 17—UDP, User Datagram Protocol.

ip-tos tos-mask tos-value (Optional) Specifies a type of service (TOS) mask and
value to be matched (IPv4 and IPv6 filters):
• tos-mask—8-bit value expressed in hexadecimal
notation. The valid range is 0x00 through 0xFF.
• tos-value—8-bit value expressed in hexadecimal
notation. The valid range is 0x00 through 0xFF.
The tos-mask is logically ANDed with the tos-value and
compared to the result of ANDing the tos-mask with the
packet’s actual TOS value. The filter considers it a match
if the two values are the same.
Note
The default values for both parameters matches all ToS
values.

ip-version (Optional) Specifies the IP version of the filter:

• ipv4—Filter is an IP version 4 filter group (default).
• ipv6—Filter is an IP version 6 filter group.

match-action {accept | drop} (Optional) Specifies the action that should be taken for
packets that match this filter (IPv4 and IPv6 filters):
• accept—Packets that match the filter are accepted
(default).
• drop—Packets that match the filter are dropped.

range-dest-port start-port number end-port (Optional) Specifies the TCP/UDP destination port start
number range. The range is from 0 to 65535.

range-ip-tos mask against TOS start value and (Optional) Specifies IP TOS byte range settings expressed
end value in hexadecimal notation. The range is from 0x00 through
0xFF.

range-src-port start-port number end-port (Optional) Specifies TCP/UDP source port start range. The
number range is from 0 to 65535.

Cisco CMTS Cable Command Reference

289
 Cable Commands: cable e through cable i
cable filter group

range-user-pri low-priority value high-priority (Optional) Specifies the user priority.The range for priority
value is from 0 to 8. The Priority field indicates the frame priority
level from 0 (lowest) to 8 (highest), which prioritizes
different classes of traffic (such as voice, video and data).
Cisco cBR-8 router does not have this option.

src-ip ip-address (Optional) Specifies the source IP address that should be

matched. The default IP address is 0.0.0.0. (IPv4 filters
only)

src-mac-addr mac address (Optional) Specifies the source MAC address to be

matched. Cisco cBR-8 router does not have this option.

src-mask mask (Optional) Specifies the mask for the source address that
should be matched. The mask is ANDed with the IP address
specified by the src-ip option and compared to the result
of ANding the mask with the packet’s source IP address.
The filter considers it a match if the two values are the
same. (IPv4 filters only)
Note
The default mask of 0.0.0.0 matches all IP addresses.

src-port port-number (Optional) Specifies the TCP/UDP source port number that
should be matched. The range is from 0 to 65535. The
default value matches all TCP/UDP port numbers (IPv4
and IPv6 filters).

status {active | inactive} (Optional) Enables or disables the filter (IPv4 and IPv6
filters):
• active—Enables the filter immediately (default).
• inactive —Disables the filter immediately.
Note
You must create a filter group using at least one of the
other options before you can use this command to enable
or disable the filter.

tcp-flags flags-mask flags-value (Optional) Specifies the TCP flag mask and value to be
matched (IPv4 and IPv6 filters):
• flags-mask—8-bit value expressed in hexadecimal
notation. The valid range is 0x0 through 0x3F.
• flags-value—8-bit value expressed in hexadecimal
notation. The valid range is 0x0 through 0x3F.

v6-dest-address ipv6-address (Optional) Specifies the IPv6 destination address that

should be matched using the format X:X:X:X::X (IPv6
filters only).

v6-dest-pfxlen prefix-length (Optional) Specifies the length of the network portion of

the IPv6 destination address. The range is from 0 to 128
(IPv6 filters only).

Cisco CMTS Cable Command Reference

290
 Cable Commands: cable e through cable i
cable filter group

v6-flow-label flow-label value (Optional) Specifies the IPv6 flow label to be used by the
source to label packets of a flow. The range is from 0 to
1048575. A flow label of zero is used to indicate packets
not part of any flow.

v6-src-address ipv6-address (Optional) Specifies the IPv6 source address that should
be matched using the format X:X:X:X::X (IPv6 filters
only).

v6-src-pfxlen prefix-length (Optional) Specifies the length of the network portion of

the IPv6 source address. The range is form 0 to 128 (IPv6
filters only).

vlan-id vlan-id (Optional) Specifies the VLAN Identifier to be matched,

which is a 12-bit field specfying the VLAN to which the
packet belongs.The range is from 0 to 4094. Cisco cBR-8
router does not have this option.

Command Default No filter groups are defined. When a filter group is created, it defaults to accepting all source and destination
IP addresses and TCP/UDP ports, all protocol types, and all ToS and TCP flag values.

Command Modes
Global configuration (config)

Command History Release Modification

12.1(6)EC1 This command was introduced on the Cisco uBR7100 series and Cisco uBR7200
series routers.

12.2(2)XF, 12.2(4)BC1 This command was supported on the Cisco uBR10012 routers.

12.2(8)BC2 The status option was added to allow filter groups to be activated and deactivated
without removing the filter group’s configuration.

12.2(33)SCA The v6-src-address, v6-dest-address, v6-src-pfxlen, v6-dest-pfxlen, and

ip-version keywords were added for support of IPv6 filter groups. Support for the
Cisco uBR7225VXR router was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers. The dest-mac-addr, dest-mac-mask, eth-proto-type, eth-protocol,
range-user-pri, src-mac-addr and vlan-id keywords were removed.

Usage Guidelines This command implements DOCSIS 1.1 packet filtering, as defined in the DOCS-SUBMGT-MIB . Each filter
group can contain multiple filters, as defined by the different index numbers.

Note The DOCS-SUBMGT-MIB MIB is supported only on Cisco IOS Release 12.2(8)BC2 and later 12.2 BC
releases. See the description of the docsSubMgtPktFilterTable table in this MIB for further information.

Cisco CMTS Cable Command Reference

291
 Cable Commands: cable e through cable i
cable filter group

Note Before configuring layer 4 src-port and dest-port options, configure the IP protocol number using the ip-proto
option. If a layer 4 IP protocol is not configured, the default value (256) is used and the filter groups configured
with multiple filters will fail.

When matching the source or destination addresses, the filter ANDs the mask value with the filter’s
corresponding IP address. The filter then ANDs the mask with the packet’s actual IP address and compares
the two values. If they are the same, the filter matches the packet.
For example, if you specify a src-ip of 192.168.100.0 and a src-mask of 255.255.255.0, the filter matches
all packets that have a source IP address in the range of 192.168.100.0 through 192.168.100.255. Use a mask
value of 0.0.0.0 (default) to match all IP addresses. Use a mask value of 255.255.255.255 to match one specific
IP address.
Similarly, when comparing TOS values, the filter ANDs the tos-mask parameter with the tos-value parameter
and compares it to the result of ANDing the tos-mask parameter with the packet’s actual TOS value. If the
two values are the same, the filter matches the packet.

Note For the filter group to work for CMs, a CM must re-register after the CMTS router is configured.

Cable Subscriber Management Guidelines

Cable subscriber management is a DOCSIS 1.1 specification, whose functionality can be established using
the following configuration methods:
• CMTS router configuration (via CLI)
• SNMP configuration
• DOCSIS 1.1 configuration file (TLVs 35, 36, and 37)
There are certain CMTS configuration requirements if the CM DOCSIS 1.1 configuration file is not used to
activate cable subscriber management for the CPE. Specifically, if the docsSubMgtCpeActive object is not
provisioned using TLVs 35, 36, and 37 in the DOCSIS 1.1 CM configuration file, then the object uses the
docsSubMgtCpeActiveDefault object setting, which is false. This means that cable subscriber management
functionality is disabled.
Therefore, if you do not provision TLVs 35, 36, and 37, then you must activate the functionality by specifying
the cable submgmt default active global configuration command on the CMTS router.

Note Since TLVs 35, 36, and 37 do not apply to DOCSIS 1.0 CM configuration files, the only way to enable cable
subscriber management for a DOCSIS 1.0 CM is to configure it explicitly on the CMTS router and activate
it by using the cable submgmt default active global configuration command.

IPv6 Cable Filter Group Guidelines

Note When parallel eXpress forwarding (PXF) is configured on the Cisco ubR10012 router, either the interface
ACL (ip access-list command) or the cable filter group commands can be used to filter the packets.

Cisco CMTS Cable Command Reference

292
 Cable Commands: cable e through cable i
cable filter group

Consider the following restrictions and guidelines when configuring IPv6 cable filter groups:
• Chained IPv6 headers are not supported.
• If you need to support IPv4 and IPv6 filters for the same filter group, then you must use a separate index
number with the same filter group ID, and configure one index as ip-version ipv4, and the other index
as ip-version ipv6.

Examples The following example shows configuration of an IPv4 filter group that drops packets with a source
IP address of 10.7.7.7 and a destination IP address of 10.8.8.8, and a source port number of 2000
and a destination port number of 3000. All protocol types and ToS and TCP flag values are matched:

configure terminal
cable filter group 10 index 10 src-ip 10.7.7.7
cable filter group 10 index 10 src-mask 255.255.0.0
cable filter group 10 index 10 dest-ip 10.8.8.8
cable filter group 10 index 10 dest-mask 255.255.0.0
cable filter group 10 index 10 ip-proto 256
cable filter group 10 index 10 src-port 2000
cable filter group 10 index 10 dest-port 3000
cable filter group 10 index 10 tcp-flags 0 0
cable filter group 10 index 10 match-action drop

IPv6 Example
The following example shows the configuration of an IPv6 filter group that drops traffic from a
specific IPv6 host (with source address 2001:33::20B:BFFF:FEA9:741F/128) behind a cable router
to an IPv6 host on the network (with destination address 2001:1::224/128):

configure terminal
!
! Specify the filter group criteria using ID 254
!
cable filter group 254 index 128 v6-src-address 2001:33::20B:BFFF:FEA9:741F
cable filter group 254 index 128 v6-src-pfxlen 128
cable filter group 254 index 128 v6-dest-address 2001:1::224
cable filter group 254 index 128 v6-dest-pfxlen 128
!
! Specify that the filter group is IPv6
!
cable filter group 254 index 128 ip-version IPv6
!
! Specify the drop action for matching packets
!
cable filter group 254 index 128 match-action drop
!
! Apply the filter group with ID 254 to all CM upstream traffic
!
cable submgmt default filter-group cm upstream 254

Related Commands Command Description

show cable filter Displays the DOCSIS 1.1 filter groups that are currently defined.

Cisco CMTS Cable Command Reference

293
 Cable Commands: cable e through cable i
cable filter group

Command Description

cable submgmt default Sets the default values for attributes in the Subscriber Management MIB
(DOCS-SUBMGT-MIB), and enables the Cisco Static CPE Override feature on
the Cisco CMTS.

Cisco CMTS Cable Command Reference

294
 Cable Commands: cable e through cable i
cable flap-list aging

cable flap-list aging

To specify the number of days to keep a CM in the flap-list table before aging it out of the table, use the cable
flap-list aging command in global configuration mode. To disable this feature, use the no form of this
command.

cable flap-list aging minutes

no cable flap-list aging

Syntax Description minutes Specifies how long, in minutes, that a CM remains in the flap list. The range is from 1 to 86400.
The default is 10080.

Command Default A CM is kept in the flap-list table for 10080 minutes (1 week).

Command Modes
Global configuration (config)

Command History Release Modification

11.3 NA This command was introduced.

12.0(4)XA, 12.1 T, 12.1 EC The days parameter was removed.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Flapping refers to the rapid disconnecting and reconnecting of a CM that is having problems holding its
connection to the CMTS. A flap list is a table maintained by the Cisco CMTS for every modem (active or
not) that is having communication difficulties. The flap list contains modem MAC addresses and logs the
time of the most recent activity. You can configure the size and entry thresholds for the flap list.

Examples The following example shows how to specify that the flap-list table retain 2400 minutes (40 hours)
of performance for this CM:

Router(config)# cable flap-list aging 2400

Related Commands Command Description

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

cable flap-list miss-threshold Specifies miss threshold for recording a flap-list event.

Cisco CMTS Cable Command Reference

295
 Cable Commands: cable e through cable i
cable flap-list aging

Command Description

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

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

clear cable flap-list Clears all the entries in the flap-list table.

debug cable flap Displays information about the operation of the CM flap list that
is maintained for the cable interfaces.

ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters
as appropriate.

show cable flap-list Displays the current contents of the flap list.

Cisco CMTS Cable Command Reference

296
 Cable Commands: cable e through cable i
cable flap-list insertion-time

cable flap-list insertion-time

To set the cable flap-list insertion time interval, use the cable flap-list insertion-time command in global
configuration mode. To disable insertion time, use the no form of this command.

cable flap-list insertion-time seconds

no cable flap-list insertion-time

Syntax Description seconds Insertion time interval in seconds. The range is from 60 to 86,400. The default is 180.

Command Default The default insertion time interval is 180 seconds (3 minutes).

Command Modes
Global configuration (config)

Command History Release Modification

12.1 T This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines This command controls the operation of a flapping modem detector. When a CM makes two or more initial
Ranging Requests (also known as insertion or reinsertion requests) within the period of time defined by this
command, the CM is placed in the flap list. A CM is not put into the flap list if the time between its two
consecutive initial Ranging Requests is greater than the insertion time interval.
For example, if the CMTS is configured for the default insertion time of three minutes, and if the CM reinserts
itself four minutes after its last insertion, the CM is not placed in the flap list. However, if the CM reinserts
itself two minutes after its last insertion, the CM is placed in the flap list.
Also, a CM is put into the flap list only once for each insertion time interval, even if the CM reinserts itself
multiple times. For example, if the CMTS is set for the default insertion time interval of 3 minutes, and the
CM reinserts itself three times within that period, the flap list shows that the CM has flapped once. If the CM
reinserts itself three times within the first 3 minute period and three more times within the next 3 minute
period, the flap list shows that the CM has flapped twice.

Examples The following example shows how to set the insertion time interval to 62 seconds:

Router(config)# cable flap-list insertion-time 62

Cisco CMTS Cable Command Reference

297
 Cable Commands: cable e through cable i
cable flap-list insertion-time

Related Commands Command Description

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

cable flap-list miss-threshold Specifies miss threshold for recording a flap-list event.

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

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

clear cable flap-list Clears all the entries in the flap-list table.

debug cable flap Displays information about the operation of the CM flap list that is
maintained for the cable interfaces.

ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters
as appropriate.

show cable flap-list Displays the current contents of the flap list.

Cisco CMTS Cable Command Reference

298
 Cable Commands: cable e through cable i
cable flap-list miss-threshold

cable flap-list miss-threshold

To set the miss threshold for recording a flap-list event, use the cable flap-list miss-threshold command in
global configuration mode. To disable this function, use the no form of this command.

cable flap-list miss-threshold misses

no cable flap-list miss-threshold

Syntax Description misses Specifies the number of consecutive MAC-layer keepalive (Station Maintenance) that can be missed
before a CM is placed in the flap list. The range is from 1 to 12. The default is 6.

Command Default The default number of station maintenance messages that can be missed is 6.

Command Modes
Global configuration (config)

Command History Release Modification

12.1 T This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines In a DOCSIS network, the CMTS regularly sends out MAC-layer keepalive messages, known as station
maintenance messages, to each CM that is online. If a CM does not respond to a station maintenance message,
the CMTS repeats sending these messages either until the CM responds or the CMTS reaches the maximum
allowable number of messages that can be sent.
The cable flap-list miss-threshold command specifies how many consecutive station maintenance messages
can be missed before the cable modem is placed in the flap list. A miss occurs when a CM does not reply to
a station maintenance message.

Note Station maintenance messages are occasionally lost due to noise or congestion in a typical DOCSIS network,
with a loss rate of approximately 8 percent considered nominal. A higher miss rate can indicate RF plant
problems, such as intermittent upstream problems, fiber laser clipping, or common-path distortion.

Examples The following example shows how to set the miss threshold to 5:

Router(config)# cable flap-list miss-threshold 5

Cisco CMTS Cable Command Reference

299
 Cable Commands: cable e through cable i
cable flap-list miss-threshold

Related Commands Command Description

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

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

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

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

clear cable flap-list Clears all the entries in the flap-list table.

debug cable flap Displays information about the operation of the CM flap list that is
maintained for the cable interfaces.

ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters
as appropriate.

show cable flap-list Displays the current contents of the flap list.

Cisco CMTS Cable Command Reference

300
 Cable Commands: cable e through cable i
cable flap-list power-adjust threshold

cable flap-list power-adjust threshold

To specify the power-adjust threshold for recording a flap-list event, use the cable flap-list power-adjust
threshold command in global configuration mode. To disable power-adjust thresholds, use the no form of
this command.

cable flap-list power-adjust threshold dB

no cable flap-list power-adjust threshold

Syntax Description dB Specifies the minimum power adjustment, in decibels, that results in a flap-list event. The range is from
1 to 10.

Command Default The default minimum power adjustment threshold is 2 dB.

Command Modes
Global configuration (config)

Command History Release Modification

12.1 T This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines This command controls the operation of a flapping modem detector. When the power adjustment of a CM
exceeds the configured threshold value, the modem is placed in the flap list.

Note A power adjustment threshold of less than 2 dB might cause excessive flap-list event recording. Cisco
recommends setting this threshold value to 3 dB or higher.

Note For underground HFC networks with 4 amplifier cascade length, a typical threshold value should be 3 dB.
For overhead HFC networks with 4 amplifier cascade length, a typical threshold value should be 4 dB. Longer
coaxial cascades without return path thermal gain control and sites with extreme daily temperatures will have
larger threshold ranges.

Examples The following example shows the power-adjust threshold being set to 5 dB:

Router(config)# cable flap-list power-adjust threshold 5

Cisco CMTS Cable Command Reference

301
 Cable Commands: cable e through cable i
cable flap-list power-adjust threshold

Related Commands Command Description

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

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

cable flap-list miss-threshold Specifies miss threshold for recording a flap-list event.

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

clear cable flap-list Clears all the entries in the flap-list table.

debug cable flap Displays information about the operation of the CM flap list that is
maintained for the cable interfaces.

ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters as
appropriate.

show cable flap-list Displays the current contents of the flap list.

Cisco CMTS Cable Command Reference

302
 Cable Commands: cable e through cable i
cable flap-list size

cable flap-list size

To specify the maximum number of CMs that can be displayed from the flap-list table, use the cable flap-list
size command in global configuration mode. To reset it to the default flap-list table size, use the no form of
this command.

cable flap-list size number

no cable flap-list size

Syntax Description number Maximum number of CMs to be displayed. The range is from 1 to 8191 depending on the type of
line cards. The default is 100.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.1 T This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines • The flap-list size is determined by the architecture of the CMTS and the cable line cards. Previously, the
cable flap-list tables were stored on the Route Processors and Performance Routing Engine (PRE)
modules.
• The legacy non-distributed cable line cards, Cisco uBR-MC16C/MC16E/MC16S line card and Cisco
uBR-MC28C/MC28E line card did not store the flap-list tables in the line cards.
• The distributed line cards are designed such that they store the flap-list tables on the line cards. For a
CMTS using distributed line cards, the flap-list size is the maximum size per line card.
• The distributed line cards supported on a Cisco uBR7200 router are Cisco uBR-MC28U/X and Cisco
uBR-16U/16X.
• The distributed line cards supported on a Cisco uBR10012 router are Cisco uBR10-MC5X20S/U/H.
• You can calculate the flap list sizes using the following formulas:
• For a Cisco uBR10012 router without line card high availability (LC-HA)—8191 * (Number of
cable line cards)
• For a Cisco uBR10012 router with line card high availability (LC-HA)—8191 * (Number of cable
line cards - 1)
• For a Cisco uBR72VXR router using legacy and distributed line cards—8191 * (1 + Number of
distributed cable line cards)
• The flap-list tables sizes are as follows:
• A fully loaded Cisco uBR10012 router
With distributed line cards and no LC-HA configured—8191 * 8 = 65528 CMs.
With distributed line cards and LC-HA configured—8191 * (8-1) = 57337 CMs.

Cisco CMTS Cable Command Reference

303
 Cable Commands: cable e through cable i
cable flap-list size

Note: Legacy line cards behave as the distributed line cards on a Cisco uBR10012 router. Thus, the
flap-list sizes are same as for distributed line cards.
• A fully loaded Cisco uBR7246VXR router
With distributed line cards— 8191 * 6 = 49146 CMs.
With legacy line cards—8191 * (1+0) = 8191 CMs.
With legacy and distributed line cards— 8191 * (1 + no of the distributed line cards) CMs.

Examples The following example shows how to display a maximum of 200 flap-list entries per downstream:

Router# configure terminal

Router(config)# cable flap-list size 200

Router(config)#

Related Commands Command Description

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

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

cable flap-list miss-threshold Specifies miss threshold for recording a flap-list event.

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

clear cable flap-list Clears all the entries in the flap-list table.

debug cable flap Displays information about the operation of the CM flap list that
is maintained for the cable interfaces.

ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters
as appropriate.

show cable flap-list Displays the current contents of the flap list.

Cisco CMTS Cable Command Reference

304
 Cable Commands: cable e through cable i
cable freq-range

cable freq-range
To configure the Cisco CMTS router for the range of frequencies that are acceptable on upstreams, use the
cable freq-range command in global configuration mode. To restore the default value (which is based on the
cable interface and on the Annex A/B configuration), use the no form of this command.

cable freq-range [european | japanese | north-american]

no cable freq-range

Syntax Description european Configures the Cisco CMTS router to accept upstream frequency ranges that conform with
the EuroDOCSIS specifications (5 MHz to 65 MHz).

japanese Configures the Cisco CMTS router to accept upstream frequency ranges that conform to
the extended range used in Japan (5 MHz to 55 MHz).

north-american Configures the Cisco CMTS router to accept upstream frequency ranges that conform to
the DOCSIS specifications (5 MHz to 42 MHz).

Command Default no cable freq-range, which defaults to a frequency range based on the Annex configuration:
• Annex A = european (EuroDOCSIS, 5 MHz to 65 MHz)—Supported only on cable interfaces that
support EuroDOCSIS
• Annex B = north-american (DOCSIS, 5 MHz to 55 MHz)—All cable interfaces support the 5 MHz to
42 MHz range. The 42 MHz to 55 MHz range is supported only on certain cable interfaces.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC2 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 universal
broadband routers.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines In Cisco IOS Release 12.2(15)BC2 and later, the Cisco CMTS router supports three different modes of
operation, depending on the cable interface line cards being used. The range of frequencies that are allowed
in each mode are as follows:
• North American DOCSIS (Annex B)—Upstreams use frequencies between 5 MHz and 42 MHz. This
range is supported by all cable interface line cards.
• European EuroDOCSIS (Annex A)—Upstreams use frequencies between 5 MHz and 65 MHz.
• Japanese Extended Range (Annex B)—Upstreams use frequencies between 5 MHz and 55 MHz.

Cisco CMTS Cable Command Reference

305
 Cable Commands: cable e through cable i
cable freq-range

Note The frequency range specified in this command does not apply to upstreams of the Cisco uBR-MC3GX60V
cable interface line cards. To specify the upstream frequency for the Cisco uBR-MC3GX60V cable interface
line card, use the cable upstream frequency command.

To configure the router so that it supports the proper range of upstream frequencies, use the upstream
freq-range command. After you have configured the router with the cable freq-range command, the cable
upstream frequency and cable spectrum-group (interface configuration) commands then accept only
frequencies that are in the configured range.
Typically, the upstream freq-range command is not needed because the default behavior covers the most
common configurations. However, this command can be used in the following situations:
• This command is required to enable EuroDOCSIS operations on the Cisco uBR-MC16U/X and Cisco
uBR-MC28U/X cards.
• This command is never needed for the Cisco uBR-MC5X20U card nor for EuroDOCSIS cable interfaces
(Cisco uBR-MC16E card, and the Cisco uBR7111E and Cisco uBR7114E routers), because these interfaces
default to the EuroDOCSIS range of frequencies. However, if you have previously used this command
to restrict the allowable range of frequencies, you must use the european option to re-enable the
EuroDOCSIS range of frequencies.
• The north-american option is usually not needed, because this is the default mode of operations for all
DOCSIS cable interfaces. However, this option can be useful on the Cisco uBR-MC16U/X and Cisco
uBR-MC28U/X cards when noise exists on the frequencies above 42 MHz. In this situation, using the
north-american option filters out the higher frequencies and reduces the impact of that noise.
• Similarly, the japanese option is not needed on those cable interface cards that support it, because this
is the default configuration on those cards. However, if you have previously used the north-american
option on an interface, you need to use the japanese option to re-enable the extended frequency range.
• Even when the upstream freq-range command is not needed to enable a frequency range, using it
ensures that the cable upstream frequency and cable spectrum-group commands allow only frequencies
that are within the desired range. This can help operators from assigning invalid frequencies to upstreams.

Tip If one or more cable interface line cards that are installed in the chassis do not support the frequency range
that you select with this command, the command displays an informational warning message for each of those
cable interface cards. Also, you cannot configure the router for a particular frequency range if an upstream
or spectrum group on the router is currently configured for a frequency that is invalid for the new range. If
you try to do so, the command is ignored and a warning message is printed prompting you to reconfigure the
upstream or spectrum group before retrying the command.

Note This command configures only the range of frequencies that can be configured on an upstream. It does not
configure the upstreams for the DOCSIS (Annex B) or EuroDOCSIS (Annex A) modes of operation, which
is done using the cable downstream annex interface command. (Annex C mode is not supported.) You must
configure the downstream for Annex A for EuroDOCSIS operations and Annex B for DOCSIS operations.
You can configure certain cable interface cards (such as the Cisco uBR-MC28U) for both the DOCSIS Annex
B mode and the EuroDOCSIS frequency range, but this violates the DOCSIS specifications and should not
be used on standard DOCSIS networks.

Cisco CMTS Cable Command Reference

306
 Cable Commands: cable e through cable i
cable freq-range

The allowable range for the upstream channel frequency depends on the cable interface line card and Cisco
IOS software release being used. See Table below for the currently supported values.

Table 5: Allowable Frequency Range for Cable Interface Line Cards

Frequency Range Supported Cable Interfaces Minimum Cisco IOS Releases

5 to 42 MHz All cable interfaces All releases supported for the Cisco CMTS

5 to 55 MHz Cisco uBR-MC16E, Cisco Cisco IOS Release 12.2(15)BC2

uBR-MC16U/X, Cisco uBR-MC28U/X,
Cisco uBR-MC5X20U

5 to 65 MHz Cisco uBR-MC16E, Cisco Cisco IOS Release 12.0(13)SC and 12.1(4)EC
uBR-MC16U/X, Cisco uBR-MC28U/X, for Cisco uBR-MC16E
Cisco uBR-MC5X20U, Cisco uBR7111E
Cisco IOS Release 12.1(5)EC1 for Cisco
and Cisco uBR7114E routers
uBR711E and Cisco uBR7114E
Cisco IOS Release 12.2(15)BC2 for Cisco
uBR-MC16U/X, Cisco uBR-MC28U/X, and
Cisco uBR-MC5X20U

Note The cable freq-range command fails if any upstreams or spectrum groups on the router are currently configured
for a frequency that is outside the new range being selected. You must reconfigure those upstreams or spectrum
groups, using the cable upstream frequency or cable spectrum-group commands, for lower frequencies,
and then repeat the cable freq-range command.

Examples The following example shows how to configure the Cisco CMTS router to support the EuroDOCSIS
upstream frequency range of 5 MHz to 65 MHz. The router then displays a list of the cable interface
line cards, if any, that do not support this range. After giving this command, the cable upstream
frequency command shows the valid range of upstream frequencies as being the EuroDOCSIS range:

Router# configure terminal

Router(config)# cable freq-range european

Interface Cable3/0 does not support European frequency range

Interface Cable3/1 does not support European frequency range
Interface Cable5/0 does not support European frequency range
Interface Cable5/1 does not support European frequency range
Router(config)# interface cable 6/0
! This cable interface supports EuroDOCSIS
Router(config-if)# cable upstream 0 frequency ?

<5000000-65000000> Return Frequency in HZ

Router(config-if)#

The following example shows how to configure the Cisco CMTS router to support the extended
Japanese upstream frequency range of 5 MHz to 55 MHz. The router then displays a list of the cable
interface line cards, if any, that do not support this range. After giving this command, the cable
upstream frequency command shows the valid range of upstream frequencies as being the extended
frequency range for Japanese networks:

Cisco CMTS Cable Command Reference

307
 Cable Commands: cable e through cable i
cable freq-range

Router# configure terminal

Router(config)# cable freq-range japanese

Interface Cable3/0 does not support Japanese frequency range

Interface Cable4/0 does not support Japanese frequency range
Interface Cable5/0 does not support Japanese frequency range
Router(config)# interface cable 6/0
! This cable interface supports the Japanese range
Router(config-if)# cable upstream 0 frequency ?

<5000000-55000000> Return Frequency in HZ

The following example shows how to configure the Cisco CMTS router for its default configuration
(DOCSIS upstream frequency range of 5 MHz to 42 MHz). (No warning messages are displayed
with this configuration because all cable interface line cards support the basic DOCSIS frequency
range.) After giving this command, the cable upstream frequency command shows the valid range
of upstream frequencies as being the DOCSIS range:

Router# configure terminal

Router(config)# cable freq-range north-american

Router(config)# interface cable 3/0

Router(config-if)# cable upstream 0 frequency ?

<5000000-42000000> Return Frequency in HZ

The following example shows all of the commands that are needed to configure the cable interface
and upstream on a Cisco uBR-MC28U/X cable interface line card to support a frequency in the
EuroDOCSIS upstream frequency range of 5 MHz to 65 MHz:

Router# configure terminal

Router(config)# cable freq-range european

Router(config)# interface 3/0

Router(config-if)# cable downstream annex a

Router(config-if)# cable upstream 0 frequency 62500000

The following example shows the cable freq-range command failing because an upstream is
configured for a frequency that is invalid for the new range. The upstream must be reconfigured
before the cable freq-range command can be given successfully.

Router# configure terminal

Router(config)# cable freq-range japanese

%%Interface Cable 3/0/U0 has invalid frequency (62500000 Hz) for specified range
%%Set upstream frequencies within range prior to changing freq-range
Router(config)# interface 3/0

Router(config-if)# cable upstream 0 frequency 38600000

Router(config-if)# exit

Cisco CMTS Cable Command Reference

308
 Cable Commands: cable e through cable i
cable freq-range

Router(config)# cable freq-range japanese

Related Commands Command Description

cable downstream annex Sets the Motion Picture Experts Group (MPEG) framing format for a
downstream port on a cable interface line card.

cable upstream frequency Configures a fixed frequency of the upstream radio frequency (RF) carrier for
an upstream port.

Cisco CMTS Cable Command Reference

309
 Cable Commands: cable e through cable i
cable frequency-exclusion-band

cable frequency-exclusion-band
To exclude a frequency band from TaFDM, use the cable frequency-exclusion-band command in the
configuration mode.

cable frequency-exclusion-band

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

IOS XE Fuji 16.7.1 This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines If you want the SC-QAM to exclusively use a specific frequency range, configure Cisco cBR to exclude the
band using the cable frequency-exclusion-band command.

The following example shows how to excule a frequency range:

controller Upstream-Cable slot/subslot/port
cable frequency-exclusion-band 18700000 22100000

Cisco CMTS Cable Command Reference

310
 Cable Commands: cable e through cable i
cable helper-address

cable helper-address
To specify a destination IP address for User Datagram Protocol (UDP) broadcast Dynamic Host Configuration
Protocol (DHCP) packets, use the cable helper-address command in cable interface or subinterface
configuration mode. To disable this feature, use the no form of this command.

cable helper-address IP-address [cable-modem | host | mta | stb | profile name ]

no cable helper-address IP-address [ cable-modem | host | mta | stb | profile name ]

Syntax Description IP-address The IP address of a DHCP server to which UDP broadcast packets will be sent.

cable-modem (Optional) Specifies that only CM UDP broadcasts are forwarded.

host (Optional) Specifies that only host UDP broadcasts are forwarded.

mta (Optional) Specifies that only media terminal adapter (MTA) UDP broadcasts are forwarded.

stb (Optional) Specifies that only set-top box (STB) UDP broadcasts are forwarded.

profile name (Optional) Specifies that only UDP broadcasts with specific DHCP profile are forwarded.

Command Default If no options are specified, both CM and host UDP broadcasts are forwarded.

Command Modes
Interface configuration—cable interface only (config-if)

Subinterface configuration—cable interface only (config-subif)

Command History Release Modification

12.1 T This command was introduced.

12.1(3a)EC This command was modified to add the subinterface support.

12.2(33)SCB This command was integrated into Cisco IOS Release 12.3(33)SCB and the mta and
stb keywords were added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to add the profile keyword.
16.8.1

Usage Guidelines This command enables CMs and their attached CPE devices (hosts) to use separate DHCP servers, so that
CMs and hosts receive their IP addresses from separate address pools. The cable-modem keyword specifies
that only UDP DHCP broadcasts from CMs are forwarded to that particular destination IP address. The host
keyword specifies that only UDP broadcasts from hosts (CPE devices) are forwarded to that particular
destination IP address.

Cisco CMTS Cable Command Reference

311
 Cable Commands: cable e through cable i
cable helper-address

Note You must specify both the cable-modem or host options in separate commands, using separate IP addresses,
if you decide to use them. If you specify only one option, then the other type of device (cable modem or host)
will not be able to connect with a DHCP server. In addition, if you use the cable-modem or host option with
the same IP address that was previously configured with this command, the new configuration overwrites the
old configuration.

Note Starting with Cisco IOS Release 12.2(33)SCG, if you use the cable-modem or host option with the same IP
address that was previously configured with this command on the Cisco uBR10012 and Cisco uBR7200 series
routers, the new configuration does not overwrite the old configuration. It is configured under a bundle
interface.

Tip If you configure different helper addresses on different sub-bundles within a bundle, the cable modem may
not come online. We recommend that you use the same helper address on all sub-bundles within a bundle.

The cable helper-address command is similar to the ip helper-address command, but the cable
helper-address command has been enhanced for cable interfaces and DOCSIS networks to allow separate
helper addresses for CMs and hosts. Use only the cable helper-address command on cable interfaces, and
use the ip helper-address command on all non-cable interfaces.
The cable helper-address command, as is the case with the ip helper-address command, cannot be used on
subordinate interfaces, so these commands are automatically removed from an interface configuration when
the interface is configured as a subordinate interface. Subordinate interfaces use the IP configuration of the
primary interface, which includes not only the IP address for the interface itself, but also the helper addresses
that have been configured on the primary interface.

Tip You can repeat this command to specify any number of helper addresses, but the Cisco IOS software uses
only the first 16 valid addresses that are configured on each interface (using either the cable helper-address
command or the ip helper-address command) when forwarding DHCP requests.

Examples The following example shows how to forward UDP broadcasts from both CMs and CPE devices to
the DHCP server at 172.23.66.44:

Router(config)# interface cable 1/0

Router(config-if)# cable helper-address 172.23.66.44
Router(config-if)# exit
Router(config)#

The following example shows how to forward UDP broadcasts from CMs and CPE devices to separate
DHCP servers:

Router(config)# interface cable 6/0

Router(config-if)# cable helper-address 172.23.66.143 host
Router(config-if)# cable helper-address 172.23.66.144 cable-modem

Cisco CMTS Cable Command Reference

312
 Cable Commands: cable e through cable i
cable helper-address

Router(config-if)# exit
Router(config)#

The following example shows that when you specify the cable-modem and host options with the
same IP address, the second command overwrites the first one:

Router(config)# interface cable 3/0

Router(config-if)# cable helper-address 10.10.10.13 host
Router(config-if)# cable helper-address 10.10.10.13 cable-modem
Router(config-if)# exit
Router(config)# exit

Router# show running-config | include helper-address

cable helper-address 10.10.10.13 cable-modem
Router#

The following example shows that when you specify the cable-modem and host options with the
same IP address on a Cisco uBR10012 router running Cisco IOS Release 12.2(33)SCG and later, it
is configured under a bundle interface:

Router(config)# interface cable 3/0

Router(config-if)# cable helper-address 10.10.10.13 host
Router(config-if)# cable helper-address 10.10.10.13 cable-modem
Router(config-if)# end
Router# show running-config | include helper-address
cable helper-address 10.10.10.13 cable-modem
cable helper-address 10.10.10.13 host
Router#

The following example shows how to specify that only UDP broadcasts with specific DHCP profile
are forwarded on Cisco cBR-8 router.

Router(config)# interface bundle 2

Router(config-if)# cable helper-address 2.2.2.2 profile DEVICE1

Related Commands Command Description

cable dhcp-giaddr Modifies the GIADDR field of DHCPDISCOVER and

DHCPREQUEST packets with a Relay IP address before they are
forwarded to the DHCP server.

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

cable source-verify Turns on CM upstream verification.

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

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

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

Cisco CMTS Cable Command Reference

313
 Cable Commands: cable e through cable i
cable helper-address

Command Description

ip dhcp smart-relay Monitors client retransmissions when address pool depletion occurs.

Cisco CMTS Cable Command Reference

314
 Cable Commands: cable e through cable i
cable host access-group

cable host access-group

To configure the access list for a customer premises equipment (CPE) device or host on the Cisco CMTS
router, use the cable host command in privileged EXEC mode. To remove an access list, use this command
with the no access-group option.

cable host {ip-addressmac-address} access-group {access-listaccess-name}

cable host {ip-addressmac-address} no access-group

Syntax Description ip-address IP address of the CPE device or host.

mac-address MAC address of the CPE device or host.

access-group Enables access-group options. The no form removes access-group

specifications.

{access-list | access-name} Specifies the IP access list (standard or extended), either by access-list number
(1 to 199) or by access-list name.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

11.3 NA This command was introduced.

12.2(4)BC1 The functionality of this command was made identical to that of the cable modem
access-group command, but both commands were retained for backwards compatibility.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines For the vrf keyword of this command, only the ip-address option is supported.
An access list can be configured to deny access to any IP address other than the ones previously configured,
using the access-list access-list deny any any command. Starting with Cisco IOS Release 12.2(33)SCD,
when a CM is added to such an access list on the Cisco uBR10012 and Cisco uBR7200 series universal
broadband routers, the ping fails. If the CM is reset, removed, or powered off, the ping succeeds after the CM
comes online. However, the show cable modem access-group command displays that the CM does not belong
to the access-group.

Cisco CMTS Cable Command Reference

315
 Cable Commands: cable e through cable i
cable host access-group

Note The cable host command, and its SNMP equivalent, cdxCmCpeAccessGroup, are not supported on the Cisco
uBR10012 universal broadband router. On this router, use the standard DOCSIS MIB, DOCS-SUBMGT-MIB,
instead.

Tip This command is equivalent to configuring cdxCmCpeAccessGroup in CISCO-DOCS-EXT-MIB.

Examples The following example shows how to assign access list number 2 to the cable host with an IP address
of 10.1.1.1:

Router# cable host 10.1.1.1 access-group 2

Related Commands Command Description

clear cable host Clears the host from the internal address tables of the Cisco CMTS router.

cable device Configures an access list for a CM device or host on the Cisco CMTS
router.

cable modem access-group Configures the access-group for a CM on the Cisco CMTS router.

show cable device access-group Display the CMs and the hosts behind the CMs on the network on the
Cisco CMTS router.

show cable host access-group Displays the hosts behind the CMs on the network on the Cisco CMTS
router.

Cisco CMTS Cable Command Reference

316
 Cable Commands: cable e through cable i
cable high-priority-call-window

cable high-priority-call-window
To set the call window (in minutes) during which the Cisco CMTS router maintains records of Emergency
911 calls, use the cable high-priority-call-window command in global configuration mode. To remove the
call window configuration from the Cisco CMTS router, use the no form of this command:

cable high-priority-call-window minutes

no cable high-priority-call-window

Syntax Description window This value defines the length of time, in minutes, for which E911 Call History is to be maintained.

Command Default This command and the PacketCable Emergency 911 Services Listing and History feature is disabled by default
on the Cisco CMTS.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced supporting PacketCable Emergency 911 Services Listing
and History on the Cisco CMTS:
• Cisco uBR7246VXR router
• Cisco uBR10012 router

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The following command example configures the call window on the Cisco uBR10012 router to be 1 minute
in length:

Router(config)# cable high-priority-call-window 1

To observe Emergency 911 calls made within the configured window, use the show cable calls command in
privileged EXEC mode:
The following command example illustrates that one Emergency 911 call was made on the Cable8/1/1 interface
on the Cisco uBR10012 router during the window set for high priority calls:

Router# show cable calls

Interface ActiveHiPriCalls ActiveAllCalls PostHiPriCallCMs RecentHiPriCMs
Cable5/0/0 0 0 0 0
Cable5/0/1 0 0 0 0
Cable5/1/0 0 0 0 0
Cable5/1/1 0 0 0 0
Cable5/1/2 0 0 0 0
Cable5/1/3 0 0 0 0
Cable5/1/4 0 0 0 0
Cable6/0/0 0 0 0 0

Cisco CMTS Cable Command Reference

317
 Cable Commands: cable e through cable i
cable high-priority-call-window

Cable6/0/1 0 0 0 0
Cable7/0/0 0 0 0 0
Cable7/0/1 0 0 0 0
Cable8/1/0 0 0 0 0
Cable8/1/1 1 1 0 0
Cable8/1/2 0 0 0 0
Cable8/1/3 0 0 0 0
Cable8/1/4 0 0 0 0
Total 1 1 0 0

The following command example configures the call window on the Cisco cBR Series Converged Broadband
Routers to be 2 minutes in length:

Router(config)# cable high-priority-call-window 2

Related Commands Command Description

show cable calls Displays voice call history information and status for the PacketCable Emergency
911 Services Listing and History feature.

show cable modem calls Displays voice call information for a particular cable modem.

Cisco CMTS Cable Command Reference

318
 Cable Commands: cable e through cable i
cable igmp static-group

cable igmp static-group

To configure cable per-physical-downstream static multicast support on the Cisco CMTS router, use the cable
igmp static-group command in interface configuration mode.

cable igmp static-group multicast-group-ip [source source-ip] [subinterface]

Syntax Description multicast-group-ip IP address of the multicast group.

source source-ip (Optional) Source IP address for SSM.

subinterface (Optional) Subinterface number:

• default: 0 for the main interface

Note
If the subinterface is configured at the virtual bundle interface, the subinterface number
option for this CLI must be configured to match up with the desired subinterface devices.

Command Default Cable per-physical-downstream static multicast support is not defined by default.

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

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

Usage Guidelines The Cable per-physical-downstream Static Multicast Support feature introduces the concept of a physical
IGMP static group, which is an extension of the existing logical IGMP static group. The differences between
the two IGMP static groups are:
• A cable bundle logical IGMP static group creates the IGMP static group for the logical IP domain and
forwards multicast traffics for the configured multicast group to every subordinate interface in the same
bundle.
• A cable bundle physical IGMP static group creates the IGMP static group on per-physical subordinate
interface basis and will only forwards multicast traffics to only configured subordinate interfaces.

When an IGMP static group is configured on a primary interface, the IGMP static group will perform a check
for each subordinate interface in the multicast group. If the multicast group is configured as a physical static
group, then only the corresponding subordinate interfaces will be added to the cable bundle forwarding table.
If the multicast group is configured as a logical static group, then all subordinate interfaces will be added to
the cable bundle forwarding table.

Cisco CMTS Cable Command Reference

319
 Cable Commands: cable e through cable i
cable igmp static-group

Note When all remaining physical static groups are un-configured from the subordinate interface for a particular
multicast group on a particular bundle, the Cisco CMTS router will revert back to the logical static group for
that multicast group on that bundle.

The cable igmp static-group command will only appear in the output of the show running-configuration
command if it is configured via the CLI. If it is configured by DSG, the cable igmp static-group command
CLI will remain hidden for a particular multicast group. This is done in order to eliminate any confusion with
the current DSG configurations.

Note Any multicast group being used by DSG (or CLI) within the same CMTS, should not be used for CLI (or
DSG) configuration.

Examples The following example shows the cable igmp static-group command on the Cisco CMTS router:

Router(config-if)# cable igmp static-group 230.1.1.1

The following example shows the cable igmp static-group command with the source option on the
Cisco CMTS router:

Router(config-if)# cable igmp static-group 232.1.1.1 source 10.1.1.1

Related Commands Command Description

ip igmp Configure static group membership entries on an interface.

static-group

Cisco CMTS Cable Command Reference

320
 Cable Commands: cable e through cable i
cable init-channel-timeout

cable init-channel-timeout
To specify the maximum time that a CM can spend performing initial ranging on the upstream channels
described in the Registration Response (REG-RSP) and Multipart Registration Response (REG-RSP-MP)
messages, use the cable init-channel-timeout command in cable interface configuration mode. To disable
this configuration, use the no form of this command.

cable init-channel-timeout value

no cable init-channel-timeout value

Syntax Description value Channel timeout value in seconds. The range is from 10 to 180. The default is 60.

Command Default None

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Examples The following example shows how to specify the channel timeout value on a cable interface at
slot/subslot/port 5/1/0 on a Cisco uBR10012 router:

Router# configure terminal

Router(config)# interface cable 5/1/0
Router(config-if)# cable init-channel-timeout 90

The following example shows how to specify the channel timeout value on a cable interface at
slot/subslot/port 3/0/0 on a Cisco cBR Series Converged Broadband Routers:

Router# configure terminal

Router(config)# interface cable 3/0/0
Router(config-if)# cable init-channel-timeout 90

Cisco CMTS Cable Command Reference

321
 Cable Commands: cable e through cable i
cable insertion-interval

cable insertion-interval
To configure the interval between consecutive initial ranging slots on an upstream, use the cable
insertion-interval interface configuration command. To configure the automatic setting and ignore any
minimum or maximum time settings, use the no form of this command.

cable insertion-interval {fixed-intrvl | automatic [min-intrvl] [max-intrvl]}

no cable insertion-interval

Syntax Description fixed-intrvl Fixed interval between initial ranging slots in milliseconds. The range is from 100 to 2000.

automatic Causes the Cisco CMTS MAC scheduler for each upstream CM to vary the initial ranging times
available to new CMs joining the network.

min-intrvl (Optional) Minimum value in milliseconds between the initial ranging slots on the upstream.
The range is from 20 to 120. The default is 60.

max-intrvl (Optional) Maximum value in milliseconds between the initial ranging slots on the upstream.
The range is from 240 to 1800. The default is 480.

Command Default Automatic (dynamically varying the frequency of initial ranging upstream slots between 60 milliseconds and
480 milliseconds).

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

11.NA This command was introduced.

12.1 T This command was modified.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines Use this command to specify the minimum and maximum duration between initial ranging opportunities that
appear in MAP messages sent by the Cisco CMTS router. MAP messages define the precise time intervals
during which CMs can send.
The default insertion interval setting (automatic) configures the Cisco CMTS router to optimize the initial
ranging times available to new CMs that attempt to join the network. The optimization algorithm automatically
varies the initial ranging times between 60 and 480 milliseconds, depending on the number of CMs attempting
to come online.

Cisco CMTS Cable Command Reference

322
 Cable Commands: cable e through cable i
cable insertion-interval

Use the cable insertion-interval automatic command to bring a large number of CMs online quickly (for
example, after a major power failure). After the CMs have come online, you can override the automatic
keyword by giving this command again and specifying a specific insertion interval.

Examples The following example shows the default configuration, which is to specify automatic insertion
intervals, using the default initial ranging intervals:

Router# configure terminal

Router(config)# interface cable 3/0

Router(config-if)# cable insertion-interval automatic

The following example shows how to set the minimum insertion interval to 100 ms:

Router# configure terminal

Router(config)# interface cable 5/1/0

Router(config-if)# cable insertion-interval 100

Related Commands Command Description

cable upstream data-backoff Specifies automatic or fixed start and stop values for data backoff.

cable upstream range-backoff Specifies automatic or configured initial ranging backoff calculation.

Cisco CMTS Cable Command Reference

323
 Cable Commands: cable e through cable i
cable intercept

cable intercept
To allow the Cisco CMTS router to forward all traffic to and from a particular CPE to a data collector located
at particular User Datagram Protocol (UDP) port, use the cable intercept command in cable interface
configuration mode. To deactivate this function, use the no form of this command.

cable intercept mac-address ip-address udp-port

no cable intercept mac-address

Syntax Description mac-address Specifies the MAC address to be intercepted.

For Cisco uBR10012 router, a maximum of 4095 MAC addresses can be configured. For Cisco
uBR7200 series router, a maximum of 10 MAC addresses per interface can be configured.

ip-address Specifies the IP address for the destination data collector.

udp-port Specifies the destination UDP port number for the intercept stream at the data collector. The
range is from 0 to 65535.

Command Default Disabled

Command Modes
Interface configuration—cable interface only (config-if)

Starting from Cisco IOS Release 12.2(33)SCC,

Interface configuration—bundle interface only (config-if)

Command History Release Modification

12.0(5)T1 This command was introduced.

12.0(6)SC This command was introduced on the 12.0 SC train.

12.1(2)EC This command was introduced on 12.1 EC train.

12.1(11b)EC Support was added to allow the data collector to be more than two hops from the Cisco
CMTS router.

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

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCC This command was modified. The command is now configured under bundle interface.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines When this command is activated, the Cisco CMTS router examines each packet for the desired MAC address;
when a matching MAC address is found (for either the origination or destination endpoint), a copy of the

Cisco CMTS Cable Command Reference

324
 Cable Commands: cable e through cable i
cable intercept

packet is encapsulated into a UDP packet, which is then sent to the specified server at the given IP address
and port.

Note The data collecting system at the ip-address on the udp-port must be configured to listen for and capture the
necessary data stream. An IP route to the specified IP address must exist, and IP connectivity to that device
must be present for the traffic to be captured. Before Cisco IOS Release 12.1(11b)EC, the data collecting
system must be within two routing hops of the Cisco CMTS.

For Cisco uBR10012 router, a maximum of 4095 MAC intercepts can be configured. This includes the MAC
intercepts configured using the cable intercept command, and other lawful intercept features (such as Service
Independent Intercept [SII]). The bandwidth used by each MAC intercept is also a deciding factor for the
number of MAC intercepts that can be configured. High bandwidth usage by a MAC intercept might reduce
the number of MAC intercepts that can be configured.
This command is originally designed to comply with the United States Federal Communications Assistance
for Law Enforcement Act (CALEA) and other law enforcement wiretap requirements for voice communications.
For additional information, see the PacketCable Electronic Surveillance Specification , which is available at
the following URL at the PacketCable web site: http://www.packetcable.com.

Note For lawful intercept, it is recommended to use SII (through SNMPv3) instead of the cable intercept command.

Note Starting from Cisco IOS Release 12.2(33)SCC, the cable intercept command is configured under bundle
interface.
Starting from Cisco IOS Release 12.2(33)SCH, the cable intercept command is not allowed to configure in
Cable Interface, both in Cisco uBR7200 series and Cisco uBR10012 routers.

Examples The following commands specify that a copy of all traffic for the CPE with the MAC address of
0080.fcaa.aabb should be forwarded to the data collector that is listening at UDP port 512 at the IP
address of 10.12.13.8. The show interface cable intercept command displays which intercepts are
currently active.

Router# configure terminal

Router#(config) interface cable 6/0

Router(config-if)# cable intercept 0080.fcaa.aabb 10.12.13.8 512

Router(config-if)# exit

Router(config)# exit

Router# show interface cable 6/0 intercept

Destination Destination
MAC Address IP Address UDP Port
0080.fcaa.aabb 3.12.13.8 512

Cisco CMTS Cable Command Reference

325
 Cable Commands: cable e through cable i
cable intercept

The following example shows the behavior of the cable intercept command that is configured under
bundle interface. The show running interface command displays which intercepts are currently
active.

Router# configure terminal

Router#(config) interface bundle 10

Router(config-if)# cable intercept 0080.fcaa.aabb 10.12.13.8 512

Router(config-if)# exit

Router(config)# exit

Router# show running interface bundle 10 | i intercept

cable intercept 0080.fcaa.aabb 10.12.13.8 512

Related Commands Command Description

cable monitor Enables the forwarding of selected packets on the cable interface to an
external LAN analyzer.

show interface cable intercept Displays the CMs for which cable intercept is currently active.

Cisco CMTS Cable Command Reference

326
 Cable Commands: cable e through cable i
cable ip-init

cable ip-init
To configure the IP provisioning mode supported by the cable interface on a Cisco CMTS router, use the
cable ip-init command in interface or subinterface configuration mode or MAC domain profile configuration
mode. To remove the IP provisioning configuration, use the no form of this command.

cable ip-init {apm | dual-stack | ipv4 | ipv6}

no cable ip-init {apm | dual-stack | ipv4 | ipv6}

Syntax Description apm Configures the interface to support Alternative Provisioning Mode (APM).

dual-stack Configures the interface to support both IPv4 and IPv6 addressing.

ipv4 Configures the interface to support IPv4 address only.

ipv6 Configures the inerface to support IPv6 address only.

Command Default None

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCA This command was introduced.

12.2(33)SCC This command was modified. The apm keyword was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines The cable ip-init command configures the cable interface for the IP addressing mode that it supports. This
information is included in the IP initialization parameters of the MAC Domain Descriptor (MDD) message.

Examples The following example shows how to configure a cable interface on a Cisco CMTS router to support
both IPv4 and IPv6 addressing:

interface cable 5/0/1

cable ip-init dual-stack

Cisco CMTS Cable Command Reference

327
 Cable Commands: cable e through cable i
cable ip-broadcast-echo

cable ip-broadcast-echo
To activate upstream IP broadcast echo so that the Cisco CMTS router can echo broadcast packets, use the
cable ip-broadcast-echo command in cable interface or subinterface configuration mode. To disable the
upstream IP broadcast echo, use the no form of this command.

cable ip-broadcast-echo
no cable ip-broadcast-echo

Syntax Description This command has no arguments or keywords.

Command Default Upstream IP broadcast echo is disabled.

Command Modes
Cable interface configuration (config-if)

Cable subinterface configuration (config-subif)

Command History Release Modification

11.3 XA This command was introduced.

12.1(3a) EC The subinterface support was added.

12.1(5)EC Support was added for the Cisco uBR7100 series routers.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines By default, broadcast IP packets that arrive on the upstream at the Cisco CMTS router are not forwarded on
the downstream ports so that they would be delivered to the other CMs and CPE devices. This behavior
prevents broadcast storms in which such packets are repeatedly looped through the network.
The cable ip-broadcast-echo command changes this behavior by forwarding such packets on the appropriate
downstream ports, so that the packet is received by all CMs and CPE devices on that segment of the network.
This allows the cable network to behave more like a standard Ethernet network, and support direct peer-to-peer
communications using IP broadcasts.

Note This command should not be used in a typical service provider network.

Examples The following example shows how to activate IP broadcast echo in the cable interface configuration
mode:

Cisco CMTS Cable Command Reference

328
 Cable Commands: cable e through cable i
cable ip-broadcast-echo

Router(config-if)# cable ip-broadcast-echo

The following example shows how to activate IP broadcast echo in the cable subinterface configuration
mode:

Router(config)# interface cable 6/0.1

Router(config-subif)# cable ip-broadcast-echo

Related Commands Command Description

cable ip-multicast-echo Enables IP multicast echo so that the Cisco CMTS can echo multicast packets.

Cisco CMTS Cable Command Reference

329
 Cable Commands: cable e through cable i
cable ip-multicast-echo

cable ip-multicast-echo
To enable IP multicast echo so that the Cisco CMTS can echo multicast packets, use the cable ip-multicast-echo
command in cable interface configuration mode. To disable IP multicast echo, use the no form of this command.

cable ip-multicast-echo
no cable ip-multicast-echo

Syntax Description This command has no arguments or keywords.

Command Default IP multicast echo is disabled.

Command Modes
Cable interface configuration (config-if)

Command History Release Modification

11.3 XA This command was introduced for Cisco uBR7200 series routers.

12.1(3a) EC The subinterface support was added.

12.1(5)EC Support was added for Cisco uBR7100 series routers.

12.2(4)BC1 Support was added for the Cisco uBR10012 router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCB The command default is changed to disabled in Cisco IOS Release 12.2(33)SCB and later.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines By default, multicast IP packets that arrive on the upstream at the Cisco CMTS are forwarded on the appropriate
downstream ports so that they are delivered to the other CMs and CPE devices on that segment of the network.
This allows the cable network to behave like a standard Ethernet network in terms of its handling of multicast
IP traffic.
This behavior might not be appropriate for certain applications or networks, so the no cable ip-multicast-echo
command changes this behavior by preventing the forwarding of multicast packets. Disabling multicast traffic
can prevent some types of broadcast storms in which such packets are repeatedly looped through the network.
To verify if IP multicast echo has been activated or deactivated, enter the show running-config command
and look for the cable interface configuration information.
If IP multicast echo is enabled, it appears in this output of the show running-config command.
If IP multicast echo is disabled, it is not displayed in the output show running-config command.
If you are having trouble, make sure that you have entered the correct slot and port numbers when you entered
cable bundle interface configuration mode.

Cisco CMTS Cable Command Reference

330
 Cable Commands: cable e through cable i
cable ip-multicast-echo

Note On the Cisco uBR10012 router, input access lists are not applied to the multicast traffic that is echoed on each
downstream. To control the echoed multicast traffic, you therefore need to configure an output access list and
apply it to each downstream interface.

Examples The following example shows how to disable IP multicast echo in the bundle interface configuration
mode:

Router(config-if)# no cable ip-multicast-echo

Related Commands Command Description

cable ip-broadcast-echo Enables upstream IP broadcast echo so that the Cisco CMTS can echo broadcast
packets.

Cisco CMTS Cable Command Reference

331
 Cable Commands: cable e through cable i
cable ipc-stats

cable ipc-stats
To enable the Cable IPC Statistics Collection tool on a Cisco CMTS router, use the cable ipc-stats command
in global configuration mode. To disable this configuration, use the no form of this command.

cable ipc-stats
no cable ipc-stats

Syntax Description This command has no arguments or keywords.

Command Default The Cable IPC Statistics Collection tool is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The Cable IPC Statistics Collection tool provides debugging information about all IPC messages. We
recommend that you enable this tool only when it is necessary as the tool consumes considerable amount of
CPU memory while running on a Cisco CMTS router.
The cable ipc-stats command is synchronized on all cable interface line cards from the active RP. You do
not have to use this command on cable interface line cards separately.

Examples The following example shows how to enable the Cable IPC Statistics Collection tool on a Cisco
CMTS router:

Router# configure terminal

Router(config)# cable ipc-stats

Related Commands Command Description

clear cable ipc-stats Clears the active database and resets IPC statistics in the active database to zero.

show cable ipc-stats Displays statistics of all the IPC messages on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

332
 Cable Commands: cable e through cable i
cable ipc-watermark

cable ipc-watermark
To set the IPC watermark level for the line cards on a Cisco CMTS router, use the cable ipc-watermark
command in global configuration mode. To disable this configuration, use the no form of this command.

cable ipc-watermark {clcslot/subslot service-type low medium high | rp service-type low medium high }
no cable ipc-watermark {clcslot/subslot service-type low medium high | rp service-type low medium high
}

Syntax Description slot/subslot • Specifies the slot number. The range is from 5 to 8.
• Specifies the sub-slot number. The values are 0 and 1.

service-type Specifies the IPC service type for the Cisco CMTS router.
The values are:
0—Default
1—Inband
2—Expedite
3—Non-critical

low medium high Specifies the low, medium, and high IPC watermark level. The range is from 1 to 8000.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCJ1 This command was introduced in Cisco uBR10012 router.

Examples The following example shows how to set the IPC watermark level for the line cards on a Cisco CMTS
router:

Router# configure terminal

Router(config)# cable ipc-watermark rp 0 1000 2000 4000
Router(config)# cable ipc-watermark clc 5/0 0 1000 2000 2000

Related Commands Command Description

show ipc Displays statistics of all the IPC nodes on a Cisco CMTS router.
node

Cisco CMTS Cable Command Reference

333
 Cable Commands: cable e through cable i
cable ipv6 dhcp-insert

cable ipv6 dhcp-insert

To configure the Cisco cBR-8 series routers to insert descriptors into DHCPv6 packets, use the cable ipv6
dhcp-insert hostname command in global configuration mode.
To configure the Cisco cBR-8 series routers to insert downstream description into the DHCPv6 packets, use
the cable ipv6 dhcp-insert downstream-description command in global configuration mode.
To remove this configuration, use the no form of this command.

cable ipv6 dhcp-insert { hostname | downstream-description }

hostname Appends received DHCPv6 packets with router hostnames.

downstream-description Appends received DHCPv6 packets with downstream description.

Command Default This configuration is disabled by default.

Command Modes Interface configuration (config-if) and bundle interface configuration.

Command History Release Modification

Cisco IOS XE Gibraltar 17.3.1x This command is introduced.

Cisco IOS XE Cupertino 17.9.1x The downstream-description option is introduced.

Usage Guidelines The cable ipv6 dhcp-insert command is used to configure the following feature: DHCP, ToD, and TFTP
Services for the CMTS Routers.
This feature enhances the DHCPv6 security potential and the Cable duplicate MAC address feature on the
Cisco cBR-8 router.
The cable ipv6 dhcp-insert command specifies which descriptors to append to DHCPv6 packets. The
DHCPv6 servers can then detect cable modem clones and extract geographical information.
The Cisco cBR-8 series router can use the DHCPv6 Relay Agent Information option to send particular
information about a cable modem, such as its MAC address and the cable interface to which it is connected.
If the DHCPv6 server cannot match the information with that belonging to a cable modem in its database, the
Cisco cBR-8 series router identifies that the device is a CPE device. This allows the Cisco cBR-8 series router
and DHCPv6 server to retain accurate information about which CPE devices are using which cable modems
and whether the devices should be allowed network access.

Example: Configuration
The following example shows how to configure downstream-description and hostname:
router(config)#interface bundle 1
router(config-if)#cable ipv6 dhcp-insert downstream-description
router(config-if)#cable ipv6 dhcp-insert hostname

router(config)#interface cable 9/0/1

router(config-if)#cable downstream description node1-ca9/0/1

Use the following command to verify the configuration:

Cisco CMTS Cable Command Reference

334
Cable Commands: cable e through cable i
cable ipv6 dhcp-insert

router#show running-config interface bundle 1 | inc insert

ip dhcp relay information option-insert
cable ipv6 dhcp-insert hostname
cable ipv6 dhcp-insert downstream-description
cable dhcp-insert hostname
cable dhcp-insert downstream-description

Cisco CMTS Cable Command Reference

335
 Cable Commands: cable e through cable i
cable ipv6 dhcp-relay override

cable ipv6 dhcp-relay override

To configure the Cisco cBR-8 series routers to override Enterprise ID to 4491 in Vendor Specific Information
when relaying DHCPv6 packets, use the cable ipv6 dhcp-relay override command in global configuration
mode. This is the default behavior. To disable overriding of Enterprise ID in Vendor Specific Information
during DHCPv6 relay, use the no form of this command.

cable ipv6 dhcp-relay override

no cable ipv6 dhcp-relay override

Command Default This configuration is enabled by default.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Gibraltar 16.12.1z2 This command was
introduced.

Usage Guidelines The command, cable ipv6 dhcp-relay override is enabled by default. When it releays DHCPv6 packets,
cBR-8 overrides Enterprise ID to 4491 in Vendor Specific Information.
If you explicitly disable this command by using the no cable ipv6 dhcp-relay override command, cBR-8
does not change Enterprise ID in Vendor Specific Information during DHCPv6 relay.

Cisco CMTS Cable Command Reference

336
 Cable Commands: cable e through cable i
cable ipv6 source-verify

cable ipv6 source-verify

To enable source verification of IPv6 packets received by a cable interface upstream on a Cisco CMTS router,
use the cable ipv6 source-verify command in bundle interface or subinterface configuration mode. To disable
IPv6 source verification, use the no form of this command.

cable ipv6 source-verify [dhcp [server ip-address] | leasequery-filter upstream threshold interval
| leasetimer value]
no cable ipv6 source-verify

Syntax Description dhcp (Optional) Verifies IP address with the DHCPv6 server.
• server—Enables the Leasequery server to send the DHCPv6 Leasequeries.
• ip-address—IPv6 address of the Leasequery server.

leasequery-filter (Optional) Filters the IPv6 Leasequery requests.

• upstream—Indicates that the Leasequery requests are sent on cable upstream
interfaces.
• threshold—Maximum number of DHCP Leasequeries allowed per SID for each
interval period. The range is from 0 to 55.
• interval—Time period, in seconds, when Leasequeries should be monitored. The
range is from 1 to 5.

leasetimer (Optional) Specifies the time, in minutes, when the router should check its internal CPE
database for IP addresses whose lease times has expired.
• value—Lease time value. The range is from 1 to 240. The default is 60.

Command Default IPv6 source verification is disabled.

Command Modes
Bundle interface configuration (config-if),

Bundle subinterface configuration (config-subif)

Command History Release Modification

12.2(33)SCA This command was introduced.

12.2(33)SCF1 This command was modified. The dhcp keyword was added to verify IPv6 address with
the DHCPv6 server. The leasequery-filter and leasetimer keywords were added to further
filter the IPv6 Leasequery requests.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The IPv6 source verification feature is enabled on a cable bundle interface or subinterface.

Cisco CMTS Cable Command Reference

337
 Cable Commands: cable e through cable i
cable ipv6 source-verify

When you enable IPv6 source verification on the Cisco CMTS bundle interface, the source verification routine
is run to verify the MAC-SID-IP binding of the packet. If the source verification succeeds, the packet is
forwarded. If the verification fails, then the packet is dropped.
When a cable modem (CM) is operating as a bridged modem device, then the Cisco CMTS router verifies
the entire IPv6 address for that CM and the CPEs behind that CM.
When a CM is operating as a router modem device, then the Cisco CMTS router only verifies the network
prefix for that CM and the CPEs behind that CM. To be successful, this means that all cable modem routers
must have different prefixes assigned to them.
The cable ipv6 source-verify command only controls the source verification of IPv6 packets. For IPv4-based
source verification, you must use the cable source-verify command, which also supports different options.

Note On the Cisco uBR10012 router in Cisco IOS Release 12.2(33)SCA, source verification of IPv6 packets occurs
only on packets in the process-switched path of the route processor (RP).

Using the dhcp Option

If the dhcp option is used, the Cisco CMTS sends a DHCPv6 Leasequery message to the DHCP server to
verify the IP address. If a valid response is received from the DHCP server, the Cisco CMTS updates its
database with the new CPE device and allows future traffic through. If the DHCP server does not return a
successful response, all traffic from the CPE is dropped.
If you are using the dhcp option, you have the option to specify an alternate DHCP server using its IP address.
The dhcp option supports source verification from multiple dhcp servers.
For single DHCP server, use the cable ipv6 source-verify dhcp [server ipv6-address] command. For multiple
DHCP servers use the cable ipv6 source-verify dhcp command.
Using the leasetimer Option
The leasetimer option adds another level of verification by activating a timer that periodically examines the
lease times for the IP addresses for known CPE devices. If the Cisco CMTS discovers that the DHCP lease
for a CPE device has expired, it removes that IP address from its database, preventing the CPE device from
communicating until it makes another DHCP request. This prevents users from treating DHCP-assigned
addresses as static addresses, as well as from using IP addresses that were previously assigned to other devices.
The leasetimer option takes effect only when the dhcp option is also used on an interface. Also, this option
is supported only on the primary bundle interface and cannot be configured on subinterfaces. Configuring it
for a primary bundle interface automatically applies it to all subinterfaces.
Using the leasequery-filter Option
To prevent a large volume of Leasequery requests on a cable interface, use the cable ipv6 source-verify
leasequery-filter command. After configuring this command, the Cisco CMTS allows only the configured
number of DHCPv6 Leasequery requests within the specified interval time period.
For example, the cable ipv6 source-verify leasequery-filter 5 10 command configures the Cisco CMTS so
that the Cisco CMTS allows a maximum of five DHCPv6 Leasequery requests every 10 seconds for each
SID.

Examples The following example shows how to enable IPv6 source verification on a Cisco CMTS router bundle
interface by first configuring cable ipv6 source-verify at the bundle interface:

Cisco CMTS Cable Command Reference

338
 Cable Commands: cable e through cable i
cable ipv6 source-verify

interface bundle 1
cable ipv6 source-verify

After you configure the bundle interface, associate the bundle at the cable interface:

interface cable 6/0/2

cable bundle 1

The following example shows how to configure the Cisco CMTS router to send DHCPv6 Leasequeries
to verify unknown source IP addresses in upstream data packets. Both cable ipv6 source-verify
dhcp and no cable nd commands must be configured on the Cisco CMTS bundle before the Cisco
CMTS will issue any DHCPv6 Leasequery to recover an unknown IPv6 CPE to the Cisco CMTS.

configure terminal
interface bundle 1
cable ipv6 source-verify dhcp
no cable nd

The following example shows how to configure the leasetimer option so that the Cisco CMTS checks
the IP addresses in the CPE database for that particular interface for expired lease time:

configure terminal
interface bundle 1
cable ipv6 source-verify dhcp
cable ipv6 source-verify leasetimer 120

The following example shows how to configure the Cisco CMTS router so that it allows a maximum
of five DHCP Leasequery requests per SID over each 2-second interval on a particular cable interface.

configure terminal
interface bundle 1
cable ipv6 source-verify dhcp
cable ipv6 source-verify leasequery-filter 5 2

Associated Features
The cable ipv6 source-verify command is used to configure the following feature:
• Cable DHCP Leasequery

Related Commands Command Description

cable source-verify Enables verification of IPv4 addresses for CMs and CPE
devices on an upstream.

cable ipv6 source-verify leasequery-filter Enables the Leasequery filter in the CMTS downstream for
downstream IPv6 packets.

Cisco CMTS Cable Command Reference

339
 Cable Commands: cable e through cable i
cable ipv6 source-verify dhcp ns-probe

cable ipv6 source-verify dhcp ns-probe

To send NS to CPE after source verify is successful, use the cable ipv6 source-verify dhcp ns-probe command
in global configuration mode. To disable the configuration, use the no form of this command.

cable ipv6 source-verify dhcp ns-probe [ cpe | pd | interval seconds { retries number-of-probes } ]
no cable ipv6 source-verify dhcp ns-probe [ cpe | pd | interval seconds { retries number-of-probes }
]

Syntax Description source-verify IPv6 Source verification.

dhcp DHCPv6 LQ.

ns-probe NS Probe
If a switch is present between CM and CPE router, for some CM firmware, the
CPE router can't receive traffic until it sends traffic. Configure ns-probe to
overcome this issue.

cpe Send probe to any CPE

pd Only send probe to CPE router

interval seconds Interval between NS probes (seconds). Range is 10–60 seconds.

retries number-of-probes Number of probes.

Command Default This command is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This command is introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines Using the ns-probe option

If the ns-probe option is used, the Cisco CMTS sends NS probes to CPE or PD, after LQ succeeds.

Examples The following example shows how to enable DHCPv6 LQ NS Probe IPv6 source verification on a
Cisco CMTS router:

router#configure terminal
router(config)#cable ipv6 source-verify dhcp ns-probe pd interval 30 retries 3

Use the following command to verify the configuration:

Cisco CMTS Cable Command Reference

340
 Cable Commands: cable e through cable i
cable ipv6 source-verify dhcp ns-probe

router(config)#do sh run | i ns-probe

cable ipv6 source-verify dhcp ns-probe pd interval 20 retries 8

The following example shows how to configure the no cable ipv6 source-verify dhcp ns
command:

router(config)#no cable ipv6 source-verify dhcp ns

router(config)#do sh run | i ns-probe
router(config)#end

Related Commands Command Description

cable source-verify Enables verification of IPv4 addresses for CMs and CPE devices on an upstream.

Cisco CMTS Cable Command Reference

341
 Cable Commands: cable e through cable i
cable ipv6 source-verify leasequery-filter downstream

cable ipv6 source-verify leasequery-filter downstream

To enable the Leasequery filter on the Cisco CMTS downstream for IPv6 packets, use the cable ipv6
source-verify leasequery-filter downstream command in global configuration mode. To disable the
Leasequery filter on the Cisco CMTS downstream, use the no form of this command.

cable ipv6 source-verify leasequery-filter downstream threshold interval

no cable ipv6 source-verify leasequery-filter downstream

Syntax Description downstream Filters the IPv6 Leasequery requests on the Cisco CMTS downstream.
• threshold —Maximum number of DHCP Leasequeries allowed for unknown SIDs for
each interval period. The range is from 0 to 255.
• interval —Time period, in seconds, when Leasequeries should be monitored. The range
is from 1 to 10.

Command Default IPv6 source verification for downstream is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF1 This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the cable ipv6 source-verify leasequery-filter downstream command to enable the Leasequery filter
on the Cisco CMTS downstream for IPv6 packets.

Examples The following example shows how to enable the Leasequery filter on the CMTS downstream for
IPv6 packets on all downstream cable interfaces.

Router# configure terminal

Router(config)# cable ipv6 source-verify leasequery-filter downstream 10 5

Associated Features
The cable ipv6 source-verify leasequery-filter downstream command is used to configure the
following feature:
• Cable DHCP Leasequery

Related Commands Command Description

cable ipv6 source-verify Enables source verification of IPv6 packets received by a cable interface upstream
on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

342
Cable Commands: cable l
• cable l2vpn, on page 345
• cable l2-vpn-service atm-vc, on page 346
• cable l2-vpn-service default-nsi, on page 347
• cable l2-vpn-service dot1q, on page 349
• cable l2-vpn-service xconnect, on page 351
• cable l2-vpn-service xconnect nsi dot1q interface port-channel, on page 353
• cable l2-vpn dot1q-nsi-redundancy force-switchover, on page 354
• xconnect backup force-switchover, on page 355
• cable l3-mobility, on page 356
• cable lcha partial-service-reset-timer, on page 358
• cable lcha sw-reset, on page 359
• cable license 100G-conversion, on page 360
• cable linecard auto-rommon-downgrade, on page 361
• cable linecard auto-rommon-upgrade, on page 362
• cable linecard critical-event-poweroff, on page 363
• cable load-balance d20-ggrp-default, on page 365
• cable load-balance d20 GLBG auto-generate, on page 368
• cable load-balance d30-ggrp-default, on page 370
• cable load-balance docsis-enable, on page 373
• cable load-balance docsis20-enable, on page 374
• cable load-balance docsis30-enable, on page 375
• cable load-balance docsis30-enable dynamic downstream, on page 378
• cable load-balance docsis30-enable static , on page 379
• cable load-balance docsis30-dynamic-enable, on page 380
• cable load-balance docsis-group, on page 381
• cable load-balance docsis-policy, on page 384
• cable load-balance exclude, on page 385
• cable load-balance fixed-primary-channel, on page 389
• cable load-balance group, on page 390
• cable load-balance group (interface), on page 395
• cable load-balance group (Supporting Dynamic Channel Change), on page 398
• cable load-balance group interval, on page 400
• cable load-balance group policy, on page 402

Cisco CMTS Cable Command Reference

343
 Cable Commands: cable l

• cable load-balance group policy ugs, on page 404

• cable load-balance group threshold, on page 406
• cable load-balance group threshold (Supporting Dynamic Channel Change), on page 411
• cable load-balance method-utilization min-threshold, on page 413
• cable load-balance modem max-failures, on page 414
• cable load-balance restrict modem, on page 415
• cable load-balance rule, on page 416
• cable load-balance static cm-delay, on page 418
• cable logging badipsource, on page 419
• cable logging downstream-index, on page 422
• cable logging layer2events, on page 424

Cisco CMTS Cable Command Reference

344
 Cable Commands: cable l
cable l2vpn

cable l2vpn
To enable the Ethernet Layer 2 Virtual Private Network (L2VPN) service and enter L2VPN configuration
mode, use the cable l2vpn command in global configuration mode. To disable this configuration, use the no
form of this command.

cable l2vpn mac-address [customer-name]

no cable l2vpn mac-address [customer-name]

Syntax Description mac-address MAC address of a CM.

customer-name (Optional) Customer name. Only 0-9, a-z, A-Z, ., , -, _ can be used as the customer name.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to enable the Ethernet L2VPN service and enter L2VPN
configuration mode:

Router# configure terminal

Router(config)# cable l2vpn 0000.396e.6a68 customer1
Router(config-l2vpn)#

Related Commands Command Description

service instance Specifies an Ethernet service instance for a particular customer.

Cisco CMTS Cable Command Reference

345
 Cable Commands: cable l
cable l2-vpn-service atm-vc

cable l2-vpn-service atm-vc

To enable the use of Layer 2 tunnels for the Customer Premises Equipment (CPE) traffic that is behind cable
modems so that individual CPE traffic can be routed to a particular permanent virtual connection (PVC) on
an Asynchronous Transfer Mode (ATM) interface, use the cable l2-vpn-service atm-vc command in global
configuration mode. To disable the use of Layer 2 tunneling, use the no form of this command.

cable l2-vpn-service atm-vc

no cable l2-vpn-service atm-vc

Syntax Description This command has no arguments or keywords.

Command Default The use of Layer 2 tunneling for ATM PVC mapping is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(11)BC3 This command was introduced for Cisco uBR7100 series and Cisco uBR7200 series routers.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command enables the use of Layer 2 tunnels on all cable and ATM interfaces in the router—which in
turn allows you to map cable modems, on the basis of their hardware (MAC) addresses, to particular PVCs
on an ATM interface—using the cable vc-map command.

Examples The following example shows how to enable the use of Layer 2 tunnels on a router so that cable
modems can be mapped to particular PVCs on an ATM interface:

Router# config terminal

Router(config)# cable l2-vpn-service atm-vc

Related Commands Command Description

cable vc-map Maps a cable modem to a particular PVC on an ATM interface.

debug cable l2-vpn Displays debugging messages for the Layer 2 mapping of cable modems to a
particular PVC on an ATM interface.

show cable l2-vpn vc-map Displays the mapping of one or all cable modems to PVCs on the ATM
interfaces.

Cisco CMTS Cable Command Reference

346
 Cable Commands: cable l
cable l2-vpn-service default-nsi

cable l2-vpn-service default-nsi

Note Effective with Cisco IOS Release 12.2(33)SCC, the cable l2-vpn-service default-nsi command is replaced
by the cable l2-vpn-service xconnect command. See the cable l2-vpn-service xconnect command for more
information.

To configure an Ethernet Network System Interface (NSI) for Layer 2 VPN support over cable, use the cable
l2-vpn-service default-nsi command in global configuration mode. To remove the interface, use the no form
of this command.

cable l2-vpn-service default-nsi type number

no cable l2-vpn-service default-nsi type number

Syntax Description type Interface type. See the Usage Guidelines section for supported types.

number Interface or subinterface number. For more information about the numbering syntax for your
networking device, use the question mark (?) online help function.

Command Default No NSI interface is configured.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCA This command was introduced.

12.2(33)SCC This command was replaced by the cable l2-vpn-service xconnect command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The Cisco CMTS routers support only the configuration of a single L2VPN NSI per CMTS.
This command supports the following interface types:
• Cisco uBR100012 Universal Broadband Router—Gigabit Ethernet.
• Cisco uBR7246VXR Universal Broadband Router—Fast Ethernet or Gigabit Ethernet

Examples The following example configures the Gigabit Ethernet line card located in slot 4/0/0 as an NSI for
L2VPN using global configuration mode:

cable l2-vpn-service default-nsi GigabitEthernet4/0/0

Cisco CMTS Cable Command Reference

347
 Cable Commands: cable l
cable l2-vpn-service default-nsi

Related Commands Command Description

show cable l2-vpn dot1q-vc-map Displays the mapping of one or all cable modems to IEEE 802.1Q VLANs
on the router’s Ethernet interfaces.

Cisco CMTS Cable Command Reference

348
 Cable Commands: cable l
cable l2-vpn-service dot1q

cable l2-vpn-service dot1q

To enable the use of Layer 2 tunnels so that traffic for individual cable modems can be routed over a particular
Virtual Local Area Network (VLAN), use the cable l2-vpn-service dot1q command in global configuration
mode. To disable the use of Layer 2 tunneling, use the no form of this command.

cable l2-vpn-service dot1q

no cable l2-vpn-service dot1q

Syntax Description This command has no arguments or keywords.

Command Default Layer 2 tunneling is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC2 This command was introduced for Cisco uBR7246VXR universal broadband routers.

IOS-XE 3.15.0S This command was replaced by the cable l2-vpn-service xconnect nsi dot1q command
on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command enables the use of Layer 2 tunnels, using IEEE 802.1Q VLAN tagging, on all cable interfaces
in the router. This in turn allows you to map traffic to and from cable modems, on the basis of the modems’
hardware (MAC) addresses, to a particular VLAN on a particular WAN interface, using the cable dot1q-vc-map
command.

Examples The following example shows how to enable the use of IEEE 802.1Q Layer 2 tunnels on a router so
that cable modems can be mapped to particular VLAN:

Router# config terminal

Router(config)# cable l2-vpn-service dot1q

Router(config)#

The following example shows how to disable the use of IEEE 802.1Q Layer 2 tunnels on a router.
All mapping of cable modems to IEEE 802.1Q VLANs is halted (but any other Layer 2 mapping,
such as the mapping of cable modems to ATM PVCs, is unaffected).

Router# config terminal

Router(config)# no cable l2-vpn-service dot1q

Router(config)#

Cisco CMTS Cable Command Reference

349
 Cable Commands: cable l
cable l2-vpn-service dot1q

Related Commands Command Description

cable dot1q-vc-map Maps a cable modem to a particular Virtual Local Area Network (VLAN)
on a local outbound Ethernet interface.

debug cable l2-vpn Displays debugging messages for the Layer 2 mapping of cable modems
to particular PVCs or VLANs.

show cable l2-vpn dot1q-vc-map Displays the mapping of one or all cable modems to IEEE 802.1Q Virtual
Local Area Networks (VLANs) on the router’s Ethernet interfaces.

Cisco CMTS Cable Command Reference

350
 Cable Commands: cable l
cable l2-vpn-service xconnect

cable l2-vpn-service xconnect

To enable Multiprotocol Label Switching (MPLS) tunnel traffic on the network side interface to support
configuration of MPLS pseudowires for L2VPN service, use the cable l2-vpn-service xconnect command
in global configuration mode. To disable this configuration, use the no form of this command.

cable l2-vpn-service xconnect nsi { dot1q | mpls }

no cable l2-vpn-service xconnect nsi { dot1q | mpls }
cable l2-vpn-service xconnect nsi dot1q interface ethernet-interface
no cable l2-vpn-service xconnect nsi dot1q interface ethernet-interface
cable l2-vpn-service xconnect nsi dot1q interface ethernet-interface backup-interface ethernet-interface
no cable l2-vpn-service xconnect nsi dot1q interface ethernet-interface backup-interface
ethernet-interface
cable l2-vpn-service xconnect { extended-mtu | mtu-auto-negotiation }

Syntax Description nsi Specifies the network side interface (NSI).

dot1q Specifies the usage of DOT1Q tunneling on the NSI for Ethernet L2VPN traffic.

mpls Specifies the usage of MPLS tunneling on the NSI for Ethernet L2VPN traffic.

backup-interface Specifies the backup WAN interface.

extended-mtu Specifies a global MTU used by all D31 CMs to negotiate VC.

mtu-auto-negotiation Enables the capability to match the remote MTU in VC negotiation, as long as the
remote VC is not higher than the CM's capability. It overrides extended-mtu.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

12.2(33)SCJ This command was modified. The backup-interface keyword was added.

IOS-XE 3.18.0S This command was modified. The backup-interface keyword was added.

IOS-XE 17.3.1x This command was modified. The mtu-auto-negotiation keyword was added.

Usage Guidelines You must enable MPLS tunnel traffic on the network side interface using the cable l2-vpn-service xconnect
command before provisioning MPLS pseudowires.

Cisco CMTS Cable Command Reference

351
 Cable Commands: cable l
cable l2-vpn-service xconnect

Examples The following example shows how to enable the use of Layer 2 tunnels based on an AToM pseudowire
on the Cisco uBR10012 router:

Router# configure terminal

Router(config)# cable l2-vpn-service xconnect nsi mpls

The following example shows how to configure an ethernet interface on DOT1Q L2VPN on the
Cisco CMTS router:

Router# configure terminal

Router(config)# cable l2-vpn-service xconnect nsi dot1q interface Te4/0/1

The following example shows how to configure a backup WAN interface on DOT1Q L2VPN on
the Cisco CMTS router:

Router# configure terminal

Router(config)# cable l2-vpn-service xconnect nsi dot1q interface Te4/0/2 backup-interface
Te4/0/3

The following example shows how to configure a global MTU used by all D31 CMs:

Router# configure terminal

Router(config)# cable l2-vpn-service xconnect extended-mtu ?
<1500-2000> Customized MTU
<cr> <cr>

The following example shows how to configure arbitrary Maximum Transmission Unit (MTU) for
each D3.1 modem differently. This auto-negotiates the set up of L2VPN pseudowire automatically:

Router# configure terminal

Router(config)# cable l2-vpn-service xconnect mtu-auto-negotiation
<cr> <cr>
Router# show mpls l2transport vc 235 detail | in MTU
MTU: local 1700, remote 1700 ………………… CM default MTU 2000, remote MTU 1700, CBR
will set CM MTU to 1700

Related Commands Command Description

cable l2vpn Enables the Ethernet Layer 2 Virtual Private Network (L2VPN).

Cisco CMTS Cable Command Reference

352
 Cable Commands: cable l
cable l2-vpn-service xconnect nsi dot1q interface port-channel

cable l2-vpn-service xconnect nsi dot1q interface port-channel

To configure the port-channel uplink port for DOCSIS L2VPN, use the cable l2-vpn-service xconnect nsi
dot1q interface port-channel command in global configuration mode.

cable l2-vpn-service xconnect nsi dot1q interface port-channel number

Syntax Description number Port-channel interface number.

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines The cable l2-vpn-service xconnect nsi dot1q interface port-channel command configures the port-channel
uplink port for DOCSIS L2VPN.

The following example shows how to configure the port-channel uplink port for DOCSIS L2VPN:
router# configure terminal
router(config)#cable l2-vpn-service xconnect nsi dot1q interface port-channel
64

Cisco CMTS Cable Command Reference

353
 Cable Commands: cable l
cable l2-vpn dot1q-nsi-redundancy force-switchover

cable l2-vpn dot1q-nsi-redundancy force-switchover

This command is designed for uplink redundancy feature, which allows you to configure a backup Network
System Interface(NSI) interface and a default primary interface for dot1q L2VPN. When the primary NSI
interface goes down, the backup NSI interface takes over and the traffic flows through the second interface.
When two uplink DOT1Q Ethernet NSI ports are UP, to manually switch over traffic flows from current
active NSI port to another, use the cable l2-vpn dot1q-nsi-redundancy force-switchover command in
privileged EXEC mode.

cable l2-vpn dot1q-nsi-redundancy force-switchover from active-nsi

Syntax Description active-nsi Specifies the active NSI.

Command Default The current active uplink NSI port is not changed.

Command Modes Privileged EXEC(#)

Command History Release Modification

12.2(33) SCJ This command was introduces on

the Cisco uBR Series Universal
Broadband Routers

IOS-XE 3.18.0S This command was introduced on

the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines • This feature is applicable only for DOT1Q L2VPN and not Multiprotocol Label Switching (MPLS)
L2VPN.
• This feature is configurable when both the DOT1Q NSI ports are UP.

The following example shows how to manually switch over active uplink NSI port from current
active uplink port to the specified port:
Router# cable l2-vpn dot1q-nsi-redundancy force-switchover from Te4/0/1

Related Commands Command Description

show cable l2-vpn dot1q-nsi-redundancy Displays the backup pair details and the current active
uplink DOT1Q NSI port.

Cisco CMTS Cable Command Reference

354
 Cable Commands: cable l
xconnect backup force-switchover

xconnect backup force-switchover

To manually force a switchover to a pseudowire peer, use the xconnect backup force-switchover command
in privileged EXEC mode.

xconnect backup force-switchover peer ip-address vcid

Syntax Description peer ip-address vcid Specifies the IP address and virtual circuit (VC) ID of the pseudowire to be used for
the switchover.
• ip-address—IP address of the peer pseudowire.
• vcid—Virtual circuit address of the peer pseudowire.

Command Default The pseudowire is not changed.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines You can perform a switchover only to an available member in the redundancy group. That is, if the member
being specified in the xconnect backup force-switchover command is not available, the command will be
rejected.

Examples The following example shows how to manually switchover to a peer router.

Router# xconnect backup force-switchover peer 10.10.1.1 123

Related Commands Command Description

backup delay Specifies how long a backup pseudowire VC should wait before taking over
after the primary pseudowire VC goes down.

backup peer Configures a redundant peer for a pseudowire VC.

show cable l2vpn xconnect Displays information about the mapping between a Multiprotocol Label
Switching (MPLS) pseudowire and its VCs.

show mpls l2transport vc Displays information about Any Transport over MPLS (AToM) VCs and static
pseudowires that have been enabled to route Layer 2 packets on a router

show xconnect all Displays information about xconnect attachment circuits and pseudowires.

Cisco CMTS Cable Command Reference

355
 Cable Commands: cable l
cable l3-mobility

cable l3-mobility
To enable mobility for a particular IPv4 or IPv6 subnet, use the cable l3-mobility command in bundle or
sub-bundle interface mode. To disable mobility, use the no form of this command.

cable l3-mobility {IPv4-address mask IPv6 prefix}

nocable l3-mobility { IPv4-address mask IPv6 prefix}

Syntax Description IPv4-address Specifies the IPv4 address of a CPE for which the mobility has to be enabled.

IPv6 prefix Specifies the IPv6 prefix associated with a particular SAV group, specified in the X:X:X:X::/X
format.

mask Specifies the subnet mask for which the mobility has to enabled.

Command Default The mobility of the IP address is disabled.

Command Modes
Bundle interface configuration (config-if)

Bundle sub-interface configuration (config-subif)

Command History Release Modification

12.2(33)SCH2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines Mobility subnets should match with the IPv4 or IPv6 address configured on the bundle or sub-bundle interface.
If the IPv4 or IPv6 address does not match, the following warning message is displayed:
Mobility IP should match the IDB subnet!

If you remove the IPv4 or IPv6 address from the interface, the mobility scope is removed for the IP address
and the following warning message is displayed.
IPv6 2001:40:3:111::1 removed from Mobility subnets on Bundle1

Examples The following example shows how to enable the mobility for a particular IPv4 or IPv6 subnet in a
bundle interface:

Router# configure terminal

Router(config)# interface Bundle 1
Router(config-if)#cable l3-mobility 192.173.82.1 255.255.255.0

The following example shows how to enable the mobility for a particular IPv4 or IPv6 subnet in a
sub-bundle interface:

Router# configure terminal

Cisco CMTS Cable Command Reference

356
 Cable Commands: cable l
cable l3-mobility

Router(config)# interface Bundle 1

Router(config-if)#cable cable l3-mobility 192.173.82.1 255.255.255.0

Related Commands Command Description

show cablebundle Displays the details of the cable bundle.

service divert-limitl3-mobility-counter Sets the layer 3 mobility threshold limit.

Cisco CMTS Cable Command Reference

357
 Cable Commands: cable l
cable lcha partial-service-reset-timer

cable lcha partial-service-reset-timer

Some Docsis 3.1 cable modems enter partial service mode (downstream or upstream) after LCHA. To configure
a timer that starts running after LCHA is complete to reset any Docsis 3.1 cable modems that are in partial
service mode after the line card switchover, use the cable lcha partial-service-reset-timer command in global
configuration mode. To disable this feature, use the no form of this command.

cable lcha partial-service-reset-timer time

no cable lcha partial-service-reset-timer time

Command Default N/A

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest This command is introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines This command enables or disables the timer to reset the cable modem in partial service mode. It is recommended
that a value of 120 or greater to be used for the timer.

Examples The following example shows how to set the timer to reset the cable modem in partial service mode:

Router# config terminal

Router(config)# cable lcha partial-service-reset-timer 120

Related Commands Command Description

show cable flap-list reset-cm-list Displays the Docsis 3.1 cable modem list that was reset by the partial
service reset timer.

Cisco CMTS Cable Command Reference

358
 Cable Commands: cable l
cable lcha sw-reset

cable lcha sw-reset

To enable the software reset option in the normal LCHA scenario and reduce the time for linecard ISSU to
complete, use the cable lcha sw-reset enable command in global configuration mode. To disable the
software reset option, use the cable lcha sw-reset disable command in global configuration mode. To
restore the pre-configured behavior, use the no form of this command.

cable lcha sw-reset {disable | enable}

no cable lcha sw-reset {disable | enable}

Command Default N/A

Command Modes
Global configuration (config)

Command History Release Modification

IOS-XE 3.18.0SP This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command enables or disables the software reset option in the normal LCHA scenario. It is only applicable
to Docsis 3.1 Downstream Module with Micro firmware version 3.16 and higher.

Examples The following example shows how to enable the software reset option:

Router# config terminal

Router(config)# cable lcha sw-reset enable

Cisco CMTS Cable Command Reference

359
 Cable Commands: cable l
cable license 100G-conversion

cable license 100G-conversion

The cable license 100G-conversion command configures he Cisco cBR to consume 100G WAN licenses for
Supervisor 250G

cable license 100G-conversion

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes
Privileged EXEC (#)

Release Modification

IOS-XE This command was introduced.

16.8.1

Command Description

cable license 100G-conversion Configures the10G WAN license on the 100G WAN ports.

nocable license 100G-conversion Disables the 10G WAN license for the 100G WAN ports.

Cisco CMTS Cable Command Reference

360
 Cable Commands: cable l
cable linecard auto-rommon-downgrade

cable linecard auto-rommon-downgrade

To enable the automatic ROM-Monitor (ROMMON) image downgrade on cable interface line cards, use the
cable linecard auto-rommon-downgrade command in global configuration mode. To disable automatic
ROMMON image downgrade on cable interface line cards, use the no form of this command.

cable linecard auto-rommon-downgrade

no cable linecard auto-rommon-downgrade

Syntax Description This command has no arguments or keywords.

Command Default The automatic ROMMON image downgrade is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The automatic ROMMON downgrade is disabled by default on all line cards, and we recommend that you
do not change this default behavior.

Examples The following example shows how to enable automatic ROMMON downgrade on all cable interface
line cards:

Router(config
)# cable linecard auto-rommon-downgrade

The following example shows how to disable automatic ROMMON downgrade on all cable interface
line cards:

Router(config
)# no cable linecard auto-rommon-downgrade

Related Commands Command Description

cable linecard auto-rommon-upgrade Enables or disables automatic ROMMON image upgrade on cable
interface line cards.

Cisco CMTS Cable Command Reference

361
 Cable Commands: cable l
cable linecard auto-rommon-upgrade

cable linecard auto-rommon-upgrade

To enable the automatic ROM-Monitor (ROMMON) image upgrade on cable interface line cards, use the
cable linecard auto-rommon-upgrade command in global configuration mode. To disable automatic
ROMMON upgrade on cable interface line cards, use the no form of this command.

cable linecard auto-rommon-upgrade

no cable linecard auto-rommon-upgrade

Syntax Description This command has no arguments or keywords.

Command Default The automatic ROMMON image upgrade is disabled.

Note Effective with Cisco IOS Release 12.2(33)SCF1, the automatic ROMMON image upgrade is enabled by
default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines To perform automatic ROMMON upgrade on the cable interface line card, use the cable linecard
auto-rommon-upgrade command to enable automatic ROMMON image upgrade on the line card and then
reload the line card.

Examples The following example shows how to enable automatic ROMMON image upgrade on all cable
interface line cards:

Router(config
)# cable linecard auto-rommon-upgrade

The following example shows how to disable automatic ROMMON image upgrade on all cable
interface line cards:

Router(config
)# no cable linecard auto-rommon-upgrade

Related Commands Command Description

cable linecard auto-rommon-downgrade Enables or disables automatic ROMMON image downgrade on

cable interface line cards.

Cisco CMTS Cable Command Reference

362
 Cable Commands: cable l
cable linecard critical-event-poweroff

cable linecard critical-event-poweroff

To power off the Cisco uBR-MC3GX60V cable interface line card when a device temperature reaches critical
threshold values on the CMTS chassis, use the cable linecard critical-event-poweroff command in the global
configuration mode. To disable this feature, use the no form of the command.

cable linecard critical-event-poweroff

no cable linecard critical-event-poweroff

Syntax Description This command has no arguments or keywords.

Command Default Enabled

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The PRE powers off the Cisco uBR-MC3GX60V line card if any of the device temperatures on the line card
exceeds the critical threshold value. To disable this power off feature, user should configure the no cable
linecard critical-event-poweroff command and save the configuration.
The temperature thresholds for the devices on the Cisco uBR-MC3GX60V line card are:

Router#show environment subslot 6/0

------------------------------------------------------------------------
TEMPERATURE/POWER INFORMATION
------------------------------------------------------------------------
Number of Temperature Sensors : 9
Sampling frequency : 2 minutes
------------------------------------------------------------------------
Sensor | ID | Current | Minor | Major | Critical | Alarm |
| | Temperature | Threshold | Condition |
| | degC | degC | |
------------------------------------------------------------------------
Nickel 10G 1 69 84 89 94 Normal
Inlet #1 2 47 64 69 74 Normal
CPU 3 68 86 91 96 Normal
Raven 4 46 64 69 74 Normal
Santana 5 36 57 62 67 Normal
Coldplay 6 63 73 78 83 Normal
Waxbill 7 76 85 90 95 Normal
Fauna 8 70 77 82 87 Normal
Fluorine 9 62 70 75 80 Normal
------------------------------------------------------------------------
Power: 146.216 watts

Examples The following example allows the PRE to power off the Cisco uBR-MC3GX60V line card when the
device temperature reaches critical threshold values.

Cisco CMTS Cable Command Reference

363
 Cable Commands: cable l
cable linecard critical-event-poweroff

Router# cable linecard critical-event-poweroff

Related Commands Command Description

show environment Displays temperature, voltage, fan, and power supply information.

Cisco CMTS Cable Command Reference

364
 Cable Commands: cable l
cable load-balance d20-ggrp-default

cable load-balance d20-ggrp-default

To configure a DOCSIS 2.0 general load balancing group (GLBG) that is created automatically for each fiber
node (FN) configuration, use the cable load-balance d20-ggrp-default command in the global configuration
mode. To disable the default values of the DOCSIS 2.0 GLBG, use the no form of this command.

cable load-balance d20-ggrp-default {disable | init-tech-list tech-list | docsis-policy0-0xffffffff | interval

n | method {modemservice-flowsutilization} | threshold {load [minimum]pcmmpure-ds-loadugsus-across-ds}
| us-method {modemservice-flowsutilization}}
no cable load-balance d20-ggrp-default disable

Cisco cBR Series Converged Broadband Routers

cable load-balance d20-ggrp-default {disable | init-tech-list tech-list | docsis-policy 0-4294967295 |
interval n | method {modemutilization} | threshold {load [minimum]pcmmpure-ds-loadugsus-across-ds} |
us-method {modemutilization}}

Note The default values that are set using the command apply to DOCSIS 2.0 GLBGs created thereafter. Parameters
for existing DOCSIS 2.0 GLBGs do not change.

Syntax Description disable Disables the default values of the DOCSIS 2.0 GLBG that are enabled by default.

init-tech-list tech-list Sets the default DOCSIS 2.0 GLBG DCC and DBC initialization techniques.

docsis-policy Sets the default DOCSIS 2.0 GLBG load balancing policy.
0-0xffffffff

interval n Sets the default interface polling interval in seconds. The range is 1to1000.

method Sets the default load balancing method. It can have one of the following values:
• modems—Number of modems.
• (For Cisco uBR10012 Router and Cisco uBR7200 Series Routers)
service-flows—Number of service flows.
• utilization—Interface utilization.

policy Sets the default policy on modems selection based on the type of service flow to be
balanced.
• pcmm—Enable balancing of modems with active PCMM service flows
• pure-ds-load—Considers only DS utilization for load balancing
• ugs—Enable balancing of modems with active UGS service flows
• us-across-ds—Load balancing on US groups across DS, DS method will be
ignored

Cisco CMTS Cable Command Reference

365
 Cable Commands: cable l
cable load-balance d20-ggrp-default

threshold Specifies the default threshold percentage of usage. Load balancing occurs after the
threshold is exceeded.
• load—Sets the default interface load threshold setting.
• minimum—(Optional) Sets the minimum default interface load threshold
setting.
• pcmm—Sets the default PCMM service flow threshold.
• stability—Sets the default threshold for stability detection.
• ugs—Sets the default UGS service flow threshold.
• n—Percentage of usage. The range is 1to100.

us-method (Optional) Sets the default load balancing method to upstream. It can have one of the
following values:
• modems—Number of modems.
• (For Cisco uBR10012 Router and Cisco uBR7200 Series Routers)
service-flows—Number of service flows.
• utilization—Interface utilization.

Command Default no cable load-balance d20-ggrp-default disable

cable load-balance d20-ggrp-default init-tech-list 0-4
cable load-balance d20-ggrp-default docsis-policy 0

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

12.2(33)SCH This command was modified. The interval, method, policy, and threshold keywords were
introduced.

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

Usage Guidelines The group parameters in the cable load-balance d20-ggrp-default command can be set as default values.

Examples The following is a sample output of the cable load-balance d20-ggrp-default command.

Router(config)# cable load-balance d20-ggrp-default

Router(config)# cable load-balance d20-ggrp-default disable
Router(config)# cable load-balance d20-ggrp-default docsis-policy 2
Router(config)# cable load-balance d20-ggrp-default init-tech-list 1
Router(config)# cable load-balance d20-ggrp-default interval 1
Router(config)# cable load-balance d20-ggrp-default method modems
Router(config)# cable load-balance d20-ggrp-default policy ugs
Router(config)# cable load-balance d20-ggrp-default threshold load 10
Router(config)# cable load-balance d20-ggrp-default us-method
modems

Cisco CMTS Cable Command Reference

366
 Cable Commands: cable l
cable load-balance d20-ggrp-default

Related Commands Command Description

cable load-balance d20-ggrp-default Configures a DOCSIS 2.0 general load balancing group (GLBG)
that is created automatically for each fiber node (FN) configuration.

Cisco CMTS Cable Command Reference

367
 Cable Commands: cable l
cable load-balance d20 GLBG auto-generate

cable load-balance d20 GLBG auto-generate

To automatically generate DOCSIS 2.0 general load balancing group (GLBG), use the cable load-balance
d20 GLBG auto-generate command in previleged EXEC mode.
cable load-balance d20 GLBG auto-generate [FN fnid] [renew | update]

Syntax Description FN (Optional) Specifies the fiber node ID number for which GLBG is automatically generated. The
fnid range is 1 - 256. If fnid is not specified, GLBG is created for all the fiber nodes.

renew (Optional) Creates DOCSIS 2.0 GLBG for the current FN configuration after removing all DOCSIS
load balancing groups with group IDs in the reserved range (0xff00 to 0xffff).

update (Optional) Updates DOCSIS 2.0 GLBG with reserved group ID for the current FN configuration.
See “Usage Guidelines” section for more information.

Command Default Creates GLBG for all fiber nodes.

Command Modes
Previleged EXEC (#)

Command History Release Modification

12.2(33)SCH This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines For renew keyword, the command executes as follows:

• If the reserved group range (0xff00 to 0xffff) has not been used for any GLBG, a new GLBG is created
for the current fiber node.
• If the reserved group range has been used for any GLBG, the existing GLBG is removed and a new
GLBG is created for the current fiber node configuration.
• If the reserved group ID has been used for a restricted load balancing group (RLBG), the command fails
with a warning message.
For update keyword, the command executes as follows:
• If the reserved group range (0xff00 to 0xffff) has not been used for any GLBG, a new GLBG is created
for that fiber node.
• If the reserved group range has been used for any GLBG, the GLBG is updated for the current fiber node
configuration.
• If the reserved group ID has been used for a restricted load balancing group (RLBG), the command fails
with a warning message.
This command is associated with Auto-generate DOCSIS 2.0 GLBG feature.

Examples The following example shows how to configure the cable load-balance d20 GLBG auto-generate
command:

Cisco CMTS Cable Command Reference

368
 Cable Commands: cable l
cable load-balance d20 GLBG auto-generate

Router#
Router# cable load-balance d20 GLBG auto-generate
FN
3
Router#

Related Commands Command Description

show cable load-balance docsis-group Displays real time configurational, statistical, and operational
information of the load balancing operations on the router.

Cisco CMTS Cable Command Reference

369
 Cable Commands: cable l
cable load-balance d30-ggrp-default

cable load-balance d30-ggrp-default

To configure a DOCSIS 3.0 general load balancing group (GLBG) that is created automatically for each
MD-CM-SG based on the fiber node (FN) configuration, use the cable load-balance d30-ggrp-default
command in the global configuration mode. To disable the default values of the DOCSIS 3.0 GLBG, use the
no form of this command.

cable load-balance d30-ggrp-default {disable | init-tech-list tech-list | docsis-policy0-0xffffffff | interval

n | method {modemservice-flowsutilization} | threshold {load [minimum]pcmmpure-ds-loadugsus-across-ds}
| us-method {modemservice-flowsutilization}}
no cable load-balance d30-ggrp-default disable

Cisco cBR Series Converged Broadband Routers

cable load-balance d30-ggrp-default {disable | init-tech-list tech-list | docsis-policy 0-4294967295 |
interval n | method {modemutilization} | threshold {load [minimum]pcmmpure-ds-loadugsus-across-ds} |
us-method {modemutilization}}

Note The default values that are set using the command apply to DOCSIS 3.0 GLBGs created thereafter. Parameters
for existing DOCSIS 3.0 GLBGs do not change.

Syntax Description disable Disables the default values of the DOCSIS 3.0 GLBG that are enabled by default.

init-tech-list tech-list Sets the default DOCSIS 3.0 GLBG DCC and DBC initialization techniques.

docsis-policy Sets the default DOCSIS 3.0 GLBG load balancing policy.
0-0xffffffff

interval Sets the default interface polling interval in seconds. The range is 1-1000.

method Sets default load balancing method. It can have one of the following values:
• modems—Number of modems.
• (For Cisco uBR10012 Router and Cisco uBR7200 Series Routers)
service-flows—Number of service flows.
• utilization—Interface utilization.

policy Sets the default policy for modems selection based on the type of service flow to be
balanced.
• pcmm—Enable balancing of modems with active PCMM service flows
• pure-ds-load—Considers only DS utilization for load balancing
• ugs—Enable balancing of modems with active UGS service flows
• us-across-ds—Load balancing on US groups across DS groups

Cisco CMTS Cable Command Reference

370
 Cable Commands: cable l
cable load-balance d30-ggrp-default

threshold Specifies the default threshold percentage of usage. Load balancing occurs after the
threshold is exceeded.
• load—Sets the default interface load threshold setting.
• minimum—(Optional) Sets the minimum default interface load threshold
setting.
• pcmm—Sets the default PCMM service flow threshold.
• stability—Sets the default threshold for stability detection.
• ugs—Sets the default UGS service flow threshold.
• n—Percentage of usage. The range is 1to100.

us-method (Optional) Sets the default load balancing method to upstream. It can have one of the
following values:
• modems—Number of modems.
• (For Cisco uBR10012 Router and Cisco uBR7200 Series Routers)
service-flows—Number of service flows.
• utilization—Interface utilization.

Command Default no cable load-balance d30-ggrp-default disable

cable load-balance d30-ggrp-default init-tech-list 0-4
cable load-balance d30-ggrp-default docsis-policy 0

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

12.2(33)SCH This command was modified. The interval, method, policy, and threshold keywords were
introduced.

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

Usage Guidelines The group parameters in the cable load-balance d30-ggrp-default command can be set as default values.

Examples The following is a sample output of the cable load-balance d30-ggrp-default command.

Router(config)# cable load-balance d30-ggrp-default

Router(config)# cable load-balance d30-ggrp-default disable
Router(config)# cable load-balance d30-ggrp-default docsis-policy 2
Router(config)# cable load-balance d30-ggrp-default init-tech-list 1
Router(config)# cable load-balance d20-ggrp-default interval 1
Router(config)# cable load-balance d20-ggrp-default method modems
Router(config)# cable load-balance d20-ggrp-default policy ugs
Router(config)# cable load-balance d20-ggrp-default threshold load 10
Router(config)# cable load-balance d20-ggrp-default us-method
modems

Cisco CMTS Cable Command Reference

371
 Cable Commands: cable l
cable load-balance d30-ggrp-default

Related Commands Command Description

cable load-balance d20-ggrp-default Configure a DOCSIS 2.0 general load balancing group (GLBG) that
is created automatically for each fiber node (FN) configuration

Cisco CMTS Cable Command Reference

372
 Cable Commands: cable l
cable load-balance docsis-enable

cable load-balance docsis-enable

To enable or disable DOCSIS load balancing on the CMTS, use the cable load-balance docsis-enable
command in the global configuration mode. To disable DOCSIS load balancing, use the no form of this
command.

cable load-balance docsis-enable

no cable load-balance docsis-enable

Syntax Description This command has no arguments or keywords.

Command Default The command is disabled on all the routers.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines When the no cable load-balance docsis-enable command is configured, cable modems do not participate in
the load balancing operation after they are assigned to the correct Load Balancing Group (LBG).
However, the no cable load-balance docsis-enable command does not prevent the cable modems from
moving to the correct LBG, therefore, the show cable load-balance docsis-group pending and show cable
load-balance commands may display the movement of the cable modems while they are being assigned to
the correct LBG. This is an expected behavior.

Examples The following example shows how to enable DOCSIS load balancing on the CMTS using the cable
load-balance docsis-enable command.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-enable
Config: Last Batch 0, 38 bytes
cable load-balance docsis-enable
end
Router(config)#

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

373
 Cable Commands: cable l
cable load-balance docsis20-enable

cable load-balance docsis20-enable

To enable dynamic downstream Load Balancing for DOCSIS 2.0 Cable Modems, use the cable load-balance
docsis20-enable command in global configuration mode. Use the no form of this command to disable this
feature.

cable load-balance docsis20-enable

no cable load-balance docsis20-enable

Syntax Description This command has no arguments or keywords.

Command Default This command is enabled by default.

Command Modes Global configuration mode (config)

Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.17.0S

Usage Guidelines Please provide some usage guidelines.

When the no cable load-balance docsis20-enable command is configured, cable modems which are
narrow-band online does not participate in the load balancing operation after the correct Load Balancing
Group (LBG) is assigned.

The following example show how to configure the enable dynamic downstream Load Balancing for
DOCSIS 2.0 Cable Modems using theno cable load-balance docsis20-enable command:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# no cable load-balance docsis20-enable
Router(config)# end

Related Commands Command Description

show cable load-balance Displays real-time configurational, statistical and operational

information for load balancing operations on the router.

show cable load-balance Displays real-time configurational, statistical, and operational

docsis-group information of the DOCSIS group operations on the router.

Cisco CMTS Cable Command Reference

374
 Cable Commands: cable l
cable load-balance docsis30-enable

cable load-balance docsis30-enable

To enable DOCSIS 3.0 static modem count-based load balancing, use the cable load-balance docsis30-enable
command in global configuration mode. To disable DOCSIS 3.0 static modem count-based load balancing,
use the no form of this command.

cable load-balance docsis30-enable [downstream-only]

no cable load-balance docsis30-enable [downstream-only]

Cisco cBR Series Converged Broadband Routers

cable load-balance docsis30-enable
no cable load-balance docsis30-enable

Syntax Description downstream-only (For Cisco uBR10012 Router and Cisco uBR7200 Series Routers) Enables only
downstream load balancing without enabling upstream load balancing.

Command Default By default, DOCSIS 3.0 static modem count-based load balancing is enabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF1 This command was introduced.

12.2(33)SCH1 This command was modified. The downstream-only keyword was added.

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

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

IOS-XE This command is implemented on the Cisco cBR Series Converged Broadband Routers.
3.17.0S

Usage Guidelines Use the downstream-only keyword to enable only the downstream load balancing. When the downstream-only
keyword is used, upstream load balancing is disabled.

Examples The following example shows how to disable DOCSIS 3.0 static modem count-based load balancing:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# no cable load-balance docsis30-enable
Router(config)#

The following example shows how enable only downstream load balancing, without enabling upstream
load balancing:

Router# configure terminal

Cisco CMTS Cable Command Reference

375
 Cable Commands: cable l
cable load-balance docsis30-enable

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# cable load-balance docsis30-enable downstream-only

Router(config)#
The following example shows how to verify if the DOCSIS 3.0 static modem count-based load
balancing is disabled:

Router# show cable load-balance | include DOCSIS 3

DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Enabled: No
DOCSIS 3.0 General LB

The following example shows how to enable DOCSIS 3.0 static modem count-based load balancing:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis30-enable
Router(config)#

The following example shows how to verify if DOCSIS 3.0 static modem count-based load balancing
is enabled:

Router# show cable load-balance | include DOCSIS 3

DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Enabled: Yes
DOCSIS 3.0 General LB

Effective with Cisco IOS Release 12.2(33)SCH1, the output of the show cable load-balance command
shows the satus of the downstream-only keyword configuration. The following example shows how
to verify if only downstream load balancing is enabled:

Router#show cable load-balance

Load for five secs: 0%/0%; one minute: 0%; five minutes: 0%
Time source is NTP, 20:22:33.307 UTC Wed Jul 17 2013
Legacy Group Interval Method DCC Init Threshold
Group Index Technique Minimum Static Enforce Ugs
PCMM
1 513 30 modems 0 5 10% --- ---
---
DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Downstream Enabled: Yes DOCSIS 3.0 LB U
pstream Enabled: No
DOCSIS Group Status Interval DCC mask Policy Method Threshold
Group Index /UCC DS/US M/E/U/P/S
1 1 GE 30 0xF8(0)/N 5 m/m 5/10/70/70/50
2 2 RE 30 0x40(1)/N 1 m/m 2/2/70/70/50
DOCSIS 3.0 General LB
MD FN Group S Intv DCC mask Policy Mtd MD-CM-SG Threshold
Index /UCC D/U M/E/U/P/S
Ca5/0/0 1 32768 E 30 0xF8(0)/N 0 m/m 0x101 5/10/70/70/50
Router#

The cable load-balance docsis30-enable command is used to configure the following features:
• Load Balancing, Dynamic Channel Change, and Dynamic Bonding Change on the Cisco CMTS
Routers
• Restricted/General Load Balancing and Narrowband Dynamic Bandwidth Sharing with
Downstream Dynamic Load Balancing

Cisco CMTS Cable Command Reference

376
 Cable Commands: cable l
cable load-balance docsis30-enable

Related Commands Command Description

show cable load-balance Displays real-time configurational, statistical and operational

information for load balancing operations on the router.

show cable load-balance Displays real-time configurational, statistical, and operational

docsis-group information of the DOCSIS group operations on the router.

Cisco CMTS Cable Command Reference

377
 Cable Commands: cable l
cable load-balance docsis30-enable dynamic downstream

cable load-balance docsis30-enable dynamic downstream

To enable utilization based dynamic downstream Load Balancing for DOCSIS 3.0 Cable Modems, use the
cable load-balance docsis30-enable dynamic downstream command in global configuration mode. Use
the no form of this command to disable this feature.

cable load-balance docsis30-enable dynamic downstream

no cable load-balance docsis30-enable dynamic downstream
This command has no arguments or keywords.

Command Default The command is disabled by default.

Command Modes Global configuration mode (config)

Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.17.0S

Usage Guidelines When the cable load-balance docsis30-enable dynamic downstream command is configured, cable modems
which are wide-band online participates in the dynamic downstream utilization based on load balancing
operation after the correct Load Balancing Group (LBG) is assigned.

The following example shows how to enable utilization based dynamic downstream Load Balancing
for DOCSIS 3.0 Cable Modems using the cable load-balance docsis30-enable dynamic downstream
command:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis30-enable dynamic downstream
endRouter(config)#

Related Commands Command Description

show cable load-balance Displays real-time configurational, statistical and operational

information for load balancing operations on the router.

show cable load-balance Displays real-time configurational, statistical, and operational

docsis-group information of the DOCSIS group operations on the router.

Cisco CMTS Cable Command Reference

378
 Cable Commands: cable l
cable load-balance docsis30-enable static

cable load-balance docsis30-enable static

To enable static downstream Load Balancing for DOCSIS 3.0 Cable Modems, use the cable load-balance
docsis30-enable static command in global configuration mode. Use the no form of this command to disable
this feature.

cable load-balance docsis30-enable static

no cable load-balance docsis30-enable static

Syntax Description static Please provide a description.

Command Default The command is enabled by default.

Command Modes Global configuration mode (config)

Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.17.0S

Usage Guidelines When the cable load-balance docsis30-enable staticcommand is configured, cable modems which are
wide-band online does not participate in the static modem count based load balancing operation after the
correct Load Balancing Group (LBG) is assigned.

The following example shows how to enable static downstream Load Balancing for DOCSIS 3.0
Cable Modems using the cable load-balance docsis30-enable static command:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# no cable load-balance docsis30-enable static
Router(config)# end

Related Commands Command Description

show cable load-balance Displays real-time configurational, statistical and operational

information for load balancing operations on the router.

show cable load-balance Displays real-time configurational, statistical, and operational

docsis-group information of the DOCSIS group operations on the router.

Cisco CMTS Cable Command Reference

379
 Cable Commands: cable l
cable load-balance docsis30-dynamic-enable

cable load-balance docsis30-dynamic-enable

To enable DOCSIS 3.0 dynamic load balancing on the downstream channels, use the cable load-balance
docsis30-dynamic-enable command in the global configuration mode. To disable the DOCSIS 3.0 dynamic
load balancing, use the no form of this command.

cable load-balance docsis30-dynamic-enable

no cable load-balance docsis30-dynamic-enable

Syntax Description This command has no arguments or keywords.

Command Default The DOCSIS 3.0 dynamic load balancing is disabled.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCI This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines Before configuring the DOCSIS 3.0 dynamic load balancing on Cisco CMTS, you need to enable DOCSIS
2.0 and DOCSIS 3.0 load balancing on CMTS.

Example
The following example shows how to enable the DOCSIS 3.0 dynamic load balancing on the CMTS
using the cable load-balance docsis30-dynamic-enable command.
Router>enable
Router# configure terminal
Router(config)# cable load-balance docsis30-dynamic-enable
Router(config)# exit

Related Commands Command Description

show cable load-balance Displays real-time configuration, statistical and operational

information for load balancing operations on the router.

clear cable load-balance error-statistics Clears all the failure counters in error statistics.

show cable load-balance Displays information of the DOCSIS 3.0 and DOCSIS 2.0 load
balance failure.

show cable load-balance docsis-group Displays real-time configurational, statistical, and operational
information of the DOCSIS group operations on the router.

Cisco CMTS Cable Command Reference

380
 Cable Commands: cable l
cable load-balance docsis-group

cable load-balance docsis-group

To configure a DOCSIS load balancing group (LBG) on the CMTS, use the cable load-balance docsis-group
command in the global configuration mode. To delete a DOCSIS load balancing group and to remove it from
the CMTS configuration, use the no form of this command.

cable load-balance docsis-group docsis-group-id

no cable load-balance docsis-group docsis-group-id

Cisco uBR10012 Router

cable load-balance docsis-groupFN fn-id MD cable slot/subslot/port

Cisco uBR7225VXR and Cisco uBR7246VXR Routers

cable load-balance docsis-groupFN fn-id MD cable slot/port

Cisco cBR Series Converged Broadband Routers

cable load-balance docsis-groupFN fn-id MD cable slot/subslot/port

Syntax Description docsis-group-id DOCSIS load balance group ID. A valid DOCSIS load balance group ID ranges from
1 to 2147483647 and does not overlap with the legacy LBG ID. Therefore, both cable
load-balance group 1 and cable load-balance docsis-group 1 commands can be
configured. The DOCSIS load balance group ID ranging from 2147483648 to 2^32-1
is reserved for DOCSIS 3.0 general load balancing group (GLBG).

FN fn-id Specifies the fiber node (FN) where certain DOCSIS 3.0 GLBG parameters, such as
disable, docsis-policy, init-tech-list, interval, method, policy, and threshold, can be
configured.

MD cable Specifies the MAC domain interface of the fiber node.

slot/subslot/port
• slot—Slot where the line card resides. The permitted range is from 5 to 8. The
permitted range is 0 to 9 in cBR.
• subslot—Subslot where the line card resides. The available slots are 0 or 1. For
cBR, only slot 0 is available.
• port—The downstream controller number on the line card. The permitted port
range is from 0 to 4. For cBR, the permitted range is 0 to 15.

MD cable slot/port Specifies the MAC domain interface of the fiber node on the Cisco uBR7246VXR or
Cisco uBR7225VXR router.
• slot—Slot where the line card resides.
• Cisco uBR7225VXR router—The valid range is from 1 to 2.
• Cisco uBR7246VXR router—The valid range is from 3 to 6.
• port—Downstream controller number on the line card. The permitted port values
are 0 or 1.

Command Default None

Cisco CMTS Cable Command Reference

381
 Cable Commands: cable l
cable load-balance docsis-group

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

Usage Guidelines The cable load-balance docsis-group command creates a DOCSIS LBG with the specified number and then
enters the config-lb-group configuration mode. Use the config-lb-group configuration mode to configure the
DOCSIS LBG.
• disable
• docsis-policy
• downstream
• init-tech-list
• init-tech-ovr
• interval
• method
• policy
• restricted
• service-type-id
• tag
• threshold
• upstream

Examples The following example shows how to create a DOCSIS group numbered "1":

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# init-tech-list 1 ucc
Router(config-lb-group)# downstream Cable 1/1
Router(config-lb-group)# upstream Cable 1/0 2
Router(config-lb-group)# docsis-policy 0
Router(config-lb-group)# init-tech-ovr Cable 1/1 1 Cable 1/0 2 init-tech-list 1 ucc
Router(config-lb-group)# service-type-id ccc
Router(config-lb-group)# tag t1
Router(config-lb-group)# interval 10
Router(config-lb-group)# method modems us-method modems
Router(config-lb-group)# no policy us-across-ds pure-ds-load ugs

Router(config-lb-group)# restricted
Router(config-lb-group)# threshold pcmm 70 load 10 stability 50 ugs 70
Router(config-lb-group)#

The following example shows how to configure DOCSIS 3.0 GLBG parameters:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group FN 2 MD cable 1/0

Cisco CMTS Cable Command Reference

382
 Cable Commands: cable l
cable load-balance docsis-group

Related Commands Command Description

docsis-policy Assigns a policy to a group, which is the default policy assigned to the CM when the CM
is not assigned a different policy.

downstream Sets downstream RF channels.

upstream Sets upstream channels.

init-tech-list Sets the DCC/DBC initialization techniques that the CMTS uses to load balance cable
modems. The init-tech-list command can also be used to determine whether UCC can be
used for modems during dynamic upstream load balancing.

init-tech-ovr (For Cisco uBR10012, uBR7225VXR and uBR7246VXR Series Routers) Sets DCC
initialization techniques that overrides the physical upstream channel pair. The init-tech-ovr
command can also be used to determine whether UCC can be used for modems during
dynamic upstream load balancing.
Note
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.

interval Sets the duration of time the CMTS waits before checking the load on an interface.

method Selects the method the CMTS uses to determine the load. US methods can be different
from DS methods.

policy Selects modems, based on the type of service flow that will be balanced.

restricted Selects the restricted group type. By default, the general group type is selected.

service-type-id Adds a service type ID that is compared with the cable modem provisioned service type
ID, to determine an appropriate restricted load balancing group (RLBG).

tag Adds a tag to the load balancing group. The tag is used to assign the RLBG to the CMs
that have the same tag name.

threshold Specifies the threshold percentage of use exceeding which load balancing occurs.

cable tag Configures the tag that gets added to the load balancing group.

Cisco CMTS Cable Command Reference

383
 Cable Commands: cable l
cable load-balance docsis-policy

cable load-balance docsis-policy

To create a DOCSIS policy and associate an existing rule and tag with the policy, use the cable load-balance
docsis-policy command in global configuration mode. To remove a DOCSIS policy, rule, or tag from the
policy, use the no form of this command.

cable load-balance docsis-policy policy-id [rule rule-id | tag tag name [override]]
no cable load-balance docsis-policy policy-id [rule rule-id | tag tag name [override]]

Syntax Description policy-id Specifies the DOCSIS policy to be created.

rule rule-id Specifies the rule to be used with the DOCSIS policy.

tag tag Specifies the tag to be used with the DOCSIS policy.
name

override Overrides all the policies in the CM that has the specified tag name.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

12.2(33)SCC The tag parameter was added to the command.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines This command associates a rule with a policy. A policy is created only when a rule is associated with it.
Similarly, the policy is removed if you remove the last rule associated with the policy.

Examples The following example defines a DOCSIS policy, and associates a predefined rule and tag with this
policy:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-policy 1 rule 1
Router(config)# cable load-balance docsis-policy 1 tag SPG override
Router(config)#

Related Commands Command Description

cable load-balance rule Creates a rule to prevent CM from disabling or enabling load balancing.

cable tag Creates a tag to associate it with DOCSIS policies and groups.

Cisco CMTS Cable Command Reference

384
 Cable Commands: cable l
cable load-balance exclude

cable load-balance exclude

To exclude a particular cable modem, or all cable modems from a particular vendor, from one or more forms
of load-balancing operations, use the cable load-balance exclude command in global configuration mode.
To end the exclusion, so that these particular cable modems are subject to the load-balancing policies of the
load-balance group to which they belong, use the no form of this command.

cable load-balance exclude {device-class id | modem mac-address | oui word} [mask | assignment
| enforce | static | strict]
cable load-balance exclude {device-class id | modem mac-address | oui word}

Cisco cBR Series Converged Broadband Routers

cable load-balance exclude { modem mac-address | oui word }

Syntax Description device-class id (For Cisco uBR10012 Router and Cisco uBR7200 Series Routers) Specifies the device
class ID of the cable modems to be excluded in a bitmap format (0-ffff).

modem mac-address Specifies the hardware (MAC) address of an individual cable modem to be excluded
from load balancing. (You cannot specify a multicast MAC address.)

mask (Optional) Specifies the mask for the range (group) of hardware (MAC) addresses,
so that the cable modems with hardware (MAC) addresses in that range are excluded
from load balancing.

oui word Specifies the organization unique identifier (OUI) of a vendor, so that cable modems
from this vendor are excluded from load balancing. The OUI must be specified as
three hexadecimal bytes separated by either periods or colons.

assignment (Optional) Excludes the cable modems that were moved into a load balancing group
in assignment phase.

enforce (Optional) Excludes the cable modems from dynamic load balancing, but they continue
to participate in static load balancing.

static (Optional) Excludes the cable modems from static load balancing, but they continue
to participate in passive load balancing and dynamic load balancing.

strict (Optional) Excludes the cable modems from all forms of load balancing.

Note Passive load balancing is not supported on cBR Series Converged Broadband Routers.

Command Default By default, all cable modems on an interface are automatically included in all configured load-balancing
operations when that cable interface is assigned to a load-balance group (no cable load-balance exclude).
When a cable modem is excluded without any options specified, the cable modem is excluded from dynamic
and static load balancing, but it continues to participate in passive load balancing.

Command Modes
Global configuration

Cisco CMTS Cable Command Reference

385
 Cable Commands: cable l
cable load-balance exclude

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.2(33)SCH This command was modified with the following argument and keywords:
• mask
• assignment
• device-class

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

Usage Guidelines The cable load-balance exclude command allows you to specify that particular cable modems should not
participate in one or more types of load-balancing operations. This might be done for cable modems that are
currently provisioned for premium services, for cable modems that do not respond appropriately to upstream
channel change (UCC) or channel override messages, or for other reasons.
In particular, you must use the cable load-balance exclude command to exclude cable modems that require
specific upstream channels or downstream frequencies. Load balancing cannot be done when cable modems
are assigned specific channels or frequencies in their DOCSIS configuration files.
The load balancing process has two phases.
• Assignment phase:
When a modem is coming online in the assignment phase, the modem is moved to the load balance group
by assigning it a load balancing group (LBG) ID. The assignment phase occurs only when a modem is
coming online. Use the assignment option to exclude a modem during the assignment phase.
• Balancing phase:
In the balancing phase, a modem is re-assigned to an LBG to balance the load. Use the static option to
exclude a modem from static load balancing, the enforce, or strict options from dynamic load balancing,
in the balancing phase.

You can use the cable load-balance exclude command to specify that these cable modems should not
participate in the following types of load-balancing operations:
• Static load balancing—Load balancing is done at the time a cable modem registers by specifying the
proper target channel in the Downstream Frequency Override or an Upstream Channel ID Override field
in the registration response (REG-RSP) message that the Cisco CMTS sends to the cable modem. This
is the default form of registration-based load balancing.
• Passive load balancing—Load balancing is done at the time a cable modem registers by ignoring a cable
modem’s registration request (REG-REQ) message until it uses the correct target channels. Use the cable
load-balance exclude command to specify this form of load balancing for older cable modems that do
not respond well to the active form of load balancing.

Note Passive load balancing is not supported on cBR Series Converged Broadband
Routers.

Cisco CMTS Cable Command Reference

386
 Cable Commands: cable l
cable load-balance exclude

• Dynamic load balancing—A form of traffic-based load balancing, in which cable modems are balanced
among upstreams and downstreams after they come online, while they are passing traffic. (Dynamic load
balancing is enabled using the enforce option with the cable load-balance group threshold command.)
Use the cable load-balance exclude command to exclude a cable modem from any combination of
load-balancing operations. The table below shows which forms of load-balancing operations are excluded
and which are enabled for each form of the cable load-balance exclude command:

Table 6: cable load-balance exclude Command

1 2
Static Passive Dynamic

Default (no cable load-balance exclude) Yes Excluded Yes

cable load-balance exclude Excluded Yes Excluded

cable load-balance exclude enforce Yes Excluded Excluded

cable load-balance exclude static Excluded Yes Yes

cable load-balance exclude strict Excluded Excluded Excluded

cable load-balance exclude static strict Excluded Excluded Yes

1
Passive load balancing is not supported on cBR Series Converged Broadband Routers.
2
Dynamic load balancing must also be separately enabled for a load-balance group by using the enforce
option with the cable load-balance group threshold command.

Note Excluding cable modems might be required for some cable modems that are not DOCSIS-compliant. Such
cable modems can go offline for long periods of time when load balancing is attempted using DOCSIS MAC
messages. If this is the case, use the cable load-balance exclude command to exclude such cable modems
from load-balancing operations until the modem can be upgraded to DOCSIS-compliant software.

Effective with Cisco IOS Release 12.2(33)SCH, you can configure the cable load-balance exclude command
once to exclude all the STBs, that do not support load balancing, using the mask argument. You can also move
cable modems that were moved to a load balancing group in assignment phase, using the assignment option.

Examples The following example shows how to exclude a particular cable modem with the MAC address of
0001.0203.0405 from active and dynamic load-balancing operations:

Router# config terminal

Router(config)# cable load-balance exclude mac 0001.0203.0405

The following example shows how to exclude all cable modems with the OUI of 00.00.0C from
active and dynamic load-balancing operations:

Router# config terminal

Router(config)# cable load-balance exclude oui 00.00.0C

The following example shows how to exclude all cable modems with the OUI of 00.00.0C from
dynamic load-balancing operations. These cable modems are still subject to static load-balancing
operations.

Cisco CMTS Cable Command Reference

387
 Cable Commands: cable l
cable load-balance exclude

Router# config terminal

Router(config)# cable load-balance exclude oui 00.00.0C enforce

The following example shows how to exclude a particular cable modem from all forms of
load-balancing operations:

Router# config terminal

Router(config)# cable load-balance exclude mac 0001.0203.0405
strict

The following example shows how to exclude all the cable modems with MAC address 0016.924f.82b4
and mask f000.0000.0000 which have been moved to the load balancing group in the assignment
phase.

Router# configure terminal

Router(config)# cable load-balance exclude modem 0016.924f.82b4 f000.0000.0000 assignment

The following example shows how to exclude cable modems from DOCSIS load balance based on
the cable modem device class:

Router# config terminal

Router(config)# cable load-balance exclude device-class 1

The cable load-balance exclude command is associated with the Excluding Cable Modems from a
Load Balancing Group feature.

Related Commands Command Description

cable load-balance group (global Creates and configures a load-balance group.

configuration)

cable load-balance group (interface Assigns a downstream to a load-balance group.

configuration)

cable load-balance group interval Configures the frequency of the load-balancing policy updates.

cable load-balance group policy ugs Configures how the Cisco CMTS should load balance cable
modems with active unsolicited grant service (UGS) service
flows.

cable load-balance group threshold Configures the threshold values that a load-balance group
should use for load-balancing operations.

cable upstream load-balance group Assigns an upstream to a load-balance group.

clear cable load-balance Clears the counters or state machine used to track
load-balancing operations.

show cable load-balance Displays real-time statistical and operational information for
load-balancing operations.

Cisco CMTS Cable Command Reference

388
 Cable Commands: cable l
cable load-balance fixed-primary-channel

cable load-balance fixed-primary-channel

To reduce service outage while enabling dynamic load balancing, enable fixed primary channel movement,
use the cable load-balance fixed-primary-channel command in global configuration mode.
DOCSIS 3.0 load balance does not change the modem's primary channel during dynamic movement when
you enable fixed primary channel movement.

cable load-balance fixed-primary-channel

Command Default Fixed primary channel for load balancing is not enabled by default on the Cisco CMTS.

Command Modes
Global configuration

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.7.1

Examples The following example shows how to enable fixed primary channel movement:

Router# config terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance fixed-primary-channel
Router(config)# end

The following example shows how to check the enabled status of the fixed primary channel movement:
Router# show run
Router# show running-config | in fixed
cable load-balance fixed-primary-channel

Related Commands Command Description

cable load-balance docsis30-enable dynamic Enables utilization based dynamic downstream Load
downstream Balancing for DOCSIS Cable Modems

Cisco CMTS Cable Command Reference

389
 Cable Commands: cable l
cable load-balance group

cable load-balance group

To create a load-balance group and configure the type of load-balancing to be used, use the cable load-balance
group command in global configuration mode. To delete a load-balance group, use the no form of this
command. To reset a load-balance group to its default configuration, use the default form of this command.

cable load-balance group n [method utilization | method modem | method service-flows]

no cable load-balance group n

Syntax Description n Specifies the number of the load balance group. In Cisco IOS Release 12.2(33)SCE3
and earlier, the valid range is from 1 to 80. In Cisco IOS Release 12.2(33)SCE4 and
later, the valid range is from 1 to 256.

method modem (Optional) Specifies that the load-balance group should use the number of active cable
modems on an interface to determine the current load (default). This method does not
take into account the amount of traffic flowing through those particular cable modems.

method (Optional) Specifies that the load-balance group should use the number of active
service-flows service flow IDs (SFIDs) on an interface to determine the current load.

method utilization (Optional) Specifies that the load-balance group should use an interface’s current
percentage of utilization to determine the current load.
Tip
The utilization method does not begin moving cable modems for load balancing until
the utilization of the interface is at 25 percent or more. This is done to avoid the
unnecessary moving of cable modems due to temporary spikes in an interface’s
utilization rates.

Command Default No load-balance groups are created. By default, a load-balance group uses the actual number of cable modems
online each interface to determine load balancing needs (modem option).

Note If you do not create any load-balance groups, the Cisco CMTS defaults to using a form of registration-based
load balancing that attempts to equally distribute cable modems among upstreams at the time the cable modems
register and come online. No load balancing is done for downstreams or for cable modems that are already
online.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.2(33)SCE4 The valid range for the load balance group was changed.

Cisco CMTS Cable Command Reference

390
 Cable Commands: cable l
cable load-balance group

Release Modification

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable load-balance group command is used to configure the following features:
• IGMP-Triggered Dynamic Channel Change Load Balancing for DOCSIS 2.0 Cable Modems
• Load Balancing and Dynamic Channel Change on the Cisco CMTS Routers
• Restricted/General Load Balancing and Narrowband Dynamic Bandwidth Sharing with Downstream
Dynamic Load Balancing
The cable load-balance command creates a load-balance group, which can then be assigned to a number of
upstream and downstream cable interfaces to allow the Cisco CMTS to load balance cable modems as needed.
The Cisco CMTS can use the load-balance groups for static, passive, and dynamic load balancing of both
upstream and downstream channels. You can configure downstreams and upstreams to use the same load
balancing parameters, or you can configure upstreams and downstreams separately.

Note You can create a maximum of 20 load-balance groups on each chassis. However, you can reuse those
load-balance groups on different sets of cable interfaces, as long as they are in different domains. If downstreams
are not included in a load-balance group, then each downstream can be considered a separate domain.

Use the cable load-balance group (global configuration) command to initially create and configure a
load-balance group. Then use the cable load-balance group (interface configuration) command to assign
this load-balance group to an upstream or downstream, so that the cable interface will begin participating in
load-balancing operations.
You can configure a load-balance group to use one of the following types of load-balancing methods:
• Modem Method—Uses the number of active cable modems on an interface.
• Service Flow Method—Uses the number of active Service Flow IDs (SFIDs) on an interface.
• Utilization Method—Uses an interface’s current percentage of utilization.
See the following sections for more information about each method.
Modem Method
The modem method of load-balancing uses the number of active cable modems on an interface to determine
the current load. This is a form of distribution-based load balancing, in which the absolute numbers of modems
are used to determine whether interfaces are load balanced.
This method does not take into account the amount of traffic flowing through the cable modems, but the
system does take into account the relative bandwidth of the channels being used, so that channels with higher
bandwidths are allocated higher numbers of cable modems. This means that when interfaces are using different
channel widths or modulation profiles, the system can assign different numbers of cable modems to the
interfaces to achieve a balanced load. For example:
• Channel widths— If two upstreams are being load balanced, and one upstream is configured with a
channel width of 1.6 MHz and the other upstream is configured for a channel width of 3.2 MHz, the
Cisco CMTS allocates twice as many cable modems to the second upstream, because its channel width
is twice as large as the first upstream’s channel width.

Cisco CMTS Cable Command Reference

391
 Cable Commands: cable l
cable load-balance group

• Modulation profiles— If one downstream is configured for 64-QAM and the other downstream is
configured for 256-QAM, the Cisco CMTS allocates a proportionately larger number of cable modems
to the second downstream so as to achieve a balanced load.
When both the channel width and different modulation profile are set differently on two interfaces, the system
calculates a “weight” value to use as a guide to determine the relative bandwidths of the interfaces.

Tip In a system with balanced loads, the interfaces will contain the same number of cable modems only when the
interfaces are configured with the same modulation parameters.

Service Flow Method

The service-flows method of load balancing uses the number of active service flow IDs (SFIDs) on an interface
to determine the current load. This is a form of distribution-based load balancing, in which the absolute
numbers of service flows are used to determine whether interfaces are load balanced.
This method does not take into account the amount of traffic flowing on each SFID, but the system does take
into account the relative bandwidth of the channels being used, so that channels with higher bandwidths are
allocated higher numbers of SFIDs. This means that when interfaces are using different channel widths or
modulation profiles, the system can assign different numbers of SFIDs to the interfaces to achieve a balanced
load. For example:
• Channel widths— For example, if two upstreams are being load balanced, and one upstream is configured
with a channel width of 1.6 MHz and the other upstream is configured for a channel width of 3.2 MHz,
the Cisco CMTS allocates twice as many SFIDs to the second upstream, because its channel width is
twice as large as the first upstream’s channel width.
• Modulation profiles— For example, if one downstream is configured for 64-QAM and the other
downstream is configured for 256-QAM, the Cisco CMTS allocates a proportionately larger number of
SFIDs to the second downstream so as to achieve a balanced load.
When both the channel width and different modulation profile are set differently on two interfaces, the system
calculates a “weight” value to use as a guide to determine the relative bandwidths of the interfaces.

Tip In a system with balanced loads, the interfaces will contain the same number of SFIDs only when the interfaces
are configured with the same modulation parameters.

Utilization Method
The utilization method uses an interface’s current percentage of utilization to determine the current load.
This method uses the amount of traffic being sent over an interface, in the form of the percentage of total
bandwidth being used. (To avoid unnecessary movement of cable modems, the utilization method does not
perform load balancing until an interface is at least 25 percent of utilization.)

Note Do not use the utilization method of load balancing on cable interfaces that have a small number of cable
modems and where a single modem is responsible for the majority of the interface load. In this condition, the
Cisco CMTS could end up continually moving cable modems from one interface to another in an endless
attempt to load balance the interfaces. To avoid this, configure the utilization threshold to a value that is higher
than what can be caused by any single cable modem.

Cisco CMTS Cable Command Reference

392
 Cable Commands: cable l
cable load-balance group

When using the utilization method, the system takes into account the relative throughput and bandwidth (as
determined by the modulation profiles and channel widths) of each interface when evaluating the load on
those interfaces. For example, if two upstreams are being load-balanced using the utilization method, and the
first upstream has twice the bandwidth of the second upstream, the two upstreams are considered balanced
when they reach the same percentage of utilization. The first upstream is carrying more traffic than the second
upstream because it has a larger capacity for traffic, but the percentage of utilization will be the same.

Note Certain conditions can cause a system instability that could result in the Cisco CMTS endlessly attempting
to load balance the interfaces. For example, this situation could occur in noisy environments, where cable
modems drop offline on a regular basis, or when cable modems are repeatedly trying to register because the
provisioning system has sent them the wrong DOCSIS configuration files. If the Cisco CMTS detects such
unstable situations, it does not load balance cable modems from those interfaces until the system stabilizes.
However, if the system instability persists, you should increase the threshold values using the cable
load-balance group threshold command until you can solve the stability problems.

Use the no form of this command to delete a load-balance group. Deleting a load-balance group also
automatically removes all upstream and downstream channel associations that were made with that group
using the cable load-balance and cable upstream load-balance commands.

Tip To exclude individual cable modems from one or more types of load balancing, use the cable load-balance
exclude command.

Examples The following example shows how to create a load-balance group numbered 10, using the default
method of modem, which specifies that the Cisco CMTS uses the actual number of cable modems
that are online to determine load-balancing operations.

Router# config terminal

Router(config)# cable load-balance group 10

Router(config)#

The following example shows how to create a load-balance group numbered 1, which uses the number
of active SFIDs on an interface to determine the current load on the interface:

Router# config terminal

Router(config)# cable load-balance group 1 method service-flows

Router(config)#

Related Commands Command Description

cable load-balance exclude Excludes a particular cable modem, or all cable modems from a
particular vendor, from one or more types of load-balancing
operations.

cable load-balance group (interface Assigns a downstream to a load-balance group.

configuration)

Cisco CMTS Cable Command Reference

393
 Cable Commands: cable l
cable load-balance group

Command Description

cable load-balance group interval Configures the frequency of the load-balancing policy updates.

cable load-balance group policy ugs Configures how the Cisco CMTS should load balance cable
modems with active unsolicited grant service (UGS) service
flows.

cable load-balance group threshold Configures the threshold values that a load-balance group should
use for load-balancing operations.

cable upstream load-balance group Assigns an upstream to a load-balance group.

clear cable load-balance Clears the counters or state machine used to track load-balancing
operations.

show cable load-balance Displays real-time statistical and operational information for
load-balancing operations.

Cisco CMTS Cable Command Reference

394
 Cable Commands: cable l
cable load-balance group (interface)

cable load-balance group (interface)

To assign a downstream cable interface to a load balance group, use the cable load-balance group command
in interface configuration mode. To remove a downstream from a load balance group, use the no form of this
command.

cable load-balance group n

no cable load-balance group n

Syntax Description n Specifies the number of the load balance group to which the downstream should be assigned. In Cisco
IOS Release 12.2(33)SCE3 and earlier, the range is from 1 to 80. In Cisco IOS Release 12.2(33)SCE4
and later, the range is from 1 to 256.

Command Default A downstream is not assigned to a load balance group. When you use this command to add a downstream to
a group, it also automatically adds all the associated upstreams to the same group, unless you have also used
the cable upstream load-balance group command to assign the upstreams to different groups.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.2(33)SCE4 The valid range for the load balance group was changed.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable load-balance group command is used to configure the following features:
• IGMP-Triggered Dynamic Channel Change Load Balancing for DOCSIS 2.0 Cable Modems
• Load Balancing and Dynamic Channel Change on the Cisco CMTS Routers
• Restricted/General Load Balancing and Narrowband Dynamic Bandwidth Sharing with Downstream
Dynamic Load Balancing
After you have used the cable load-balance group (global configuration) command to initially create and
configure a load balance group, use the cable load-balance group (interface configuration) command to
assign this load balance group to a downstream. This enables the cable interface to begin participating in
load-balancing operations.

Tip Use the cable upstream load-balance group command to assign this load balance group to an upstream.

The following rules apply when creating and assigning load balance groups:
• A downstream or upstream can belong to only one load balance group.
• All downstreams and upstreams in a load balance group must share physical radio frequency (RF)
connectivity to the same group of cable modems. Downstreams can be in a separate load balance group

Cisco CMTS Cable Command Reference

395
 Cable Commands: cable l
cable load-balance group (interface)

than upstreams, but all downstreams or all upstreams that have the same RF physical connectivity must
be members of the same load balance group. You cannot distribute downstreams or upstreams that share
physical connectivity across multiple load balance groups.

Note If both downstreams and upstreams are assigned to the same load balance group, the Cisco CMTS attempts
to balance both the downstream and upstream values when it moves cable modems.

• If the load balance group includes downstream interfaces, you must also configure the downstream center
frequency on those interfaces, using the cable downstream frequency cable interface command. This
command is informational-only on cable interfaces that use an external upconverter, but it is required
for load balancing, so that the Cisco CMTS knows where to move cable modems when it is load balancing
downstreams.
• Load balancing is done only on a per-chassis basis—all interfaces in a load balance group must be in the
same chassis.

Note In Cisco IOS Release 12.2(15)BC1, you can configure an interface for both load balancing and Hot-Standby
Connection-to-Connection (HCCP) N+1 redundancy, but load balancing does not continue after a switchover
from a Working to a Protect interface. Load balancing resumes when the Cisco CMTS switches back to the
Working interface.

Examples The following example shows how to assign the first downstream on the cable interface line in slot
five to load balance group 5:

Router# configure terminal

Router(config)# interface cable 5/0
Router(config-if)# cable load-balance group 5

Router(config-if)#

Related Commands Command Description

cable load-balance exclude Excludes a particular cable modem, or all cable modems from a
particular vendor, from one or more types of load-balancing
operations.

cable load-balance group (global Creates and configures a load balance group.
configuration)

cable load-balance group interval Configures the frequency of the load balancing policy updates.

cable load-balance group policy ugs Configures how the Cisco CMTS should load balance cable
modems with active unsolicited grant service (UGS) service
flows.

cable load-balance group threshold Configures the threshold values that a load balance group should
use for load-balancing operations.

Cisco CMTS Cable Command Reference

396
Cable Commands: cable l
cable load-balance group (interface)

Command Description

cable upstream load-balance group Assigns an upstream to a load balance group.

clear cable load-balance Clears the counters or state machine used to track load balancing
operations.

show cable load-balance Displays real-time statistical and operational information for load
balancing operations.

Cisco CMTS Cable Command Reference

397
 Cable Commands: cable l
cable load-balance group (Supporting Dynamic Channel Change)

cable load-balance group (Supporting Dynamic Channel Change)

To set multiple parameters for Load Balancing with Dynamic Channel Change (DCC), use the following
command in global configuration mode. To remove this configuration, use the no form of this command.

cable load-balance group group-num {dcc-init-technique | interval | method | policy | threshold}

no cable load-balance group group-num {dcc-init-technique | interval | method | policy | threshold}

Syntax Description dcc-init-technique Sets DCC initialization technique

interval Sets interface polling interval

method Sets upstream load balancing type/method

policy Sets load balancing policy

threshold Load balancing threshold in percentage

Command Default Load balancing is not configured by default on the Cisco CMTS.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(17a)BC This command was introduced on the Cisco uBR10012 router and the Cisco uBR7246VXR
router, with supporting broadband processing engines (BPEs) or cable interface line cards
on the respective routers.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example illustrates configuration of the initialization techniques specified for DCC:

Router(config)# cable load-balance group 1 dcc-init-technique 4

For further examples of this command, and related keywords, refer to related commands, and refer
also to Configuring Load Balancing and Dynamic Channel Change (DCC) on the Cisco CMTS .

Usage Guidelines This command is subject to the restrictions and prerequisites described in Configuring Load Balancing and
Dynamic Channel Change (DCC) on the Cisco CMTS .

Related Commands Command Description

cable load-balance group dcc-init-technique Sets the initialization technique for Dynamic Channel
(Supporting Dynamic Channel Change) Change (DCC) for Load Balancing.

Cisco CMTS Cable Command Reference

398
Cable Commands: cable l
cable load-balance group (Supporting Dynamic Channel Change)

Command Description

cable load-balance group policy (Supporting Sets the type of service flow for use with Load Balancing
Dynamic Channel Change) and DCC, whether PacketCable MultiMedia (PCMM) or
Unsolicited Grant Service (UGS).

cable load-balance group threshold Sets the threshold levels for corresponding service flow
(Supporting Dynamic Channel Change) types for the specified Load Balancing group, supporting
Dynamic Channel Change (DCC)

show controllers cable Displays statistics for Dynamic Channel Change (DCC) for
load balancing.

test cable dcc (Supporting Dynamic Channel Performs testing functions for Load Balancing with DCC
Change)

Cisco CMTS Cable Command Reference

399
 Cable Commands: cable l
cable load-balance group interval

cable load-balance group interval

To configure the frequency of the load-balancing policy updates, use the cable load-balance group interval
command in global configuration mode. To reset the frequency of the policy updates to its default values, use
the no form of this command.

cable load-balance group n interval interval

no cable load-balance group n interval

Syntax Description n Specifies the number of the load balance group. In Cisco IOS Release 12.2(33)SCE3 and earlier,
the range is from 1 to 80. In Cisco IOS Release 12.2(33)SCE4 and later, the range is from 1 to 256.

interval Specifies the frequency, in seconds, for how often the Cisco CMTS router should determine the
current load on each cable interface. This also determines the minimum time between when cable
modems can be moved to load balance the interfaces. One cable modem at most is moved during
each interval time period. The range is from 1 to 1000. The default is 10 in Cisco IOS Release
12.2(33)SCE and earlier. The default is 30 in Cisco IOS Release 12.2(33)SCE1 and later.

Command Default Each load balance group uses the default interval value, if the interval time period is not specified.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.2(33)SCE1 The default value for the interval keyword was changed from 10 seconds to 30 seconds.

12.2(33)SCE4 The valid range for the load balance group was changed.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable load-balance group interval command is used to configure the following feature:
• Load Balancing and Dynamic Channel Change on the Cisco CMTS Routers
To perform load balancing, the Cisco CMTS must determine the actual load on an interface on a periodic
basis. This frequency of the updates also determines how frequently cable modems can be moved to achieve
balanced loads. One cable modem, at most, is moved during each update period.
The more often these updates are performed, the more accurate the Cisco CMTS can be in performing its load
balancing operations. As a general rule, begin with the default frequency value, and then adjust the value
accordingly, in small increments, as load balancing conditions or performance levels might require. The default
interval value was changed in Cisco IOS Release 12.2(33)SCF to reduce thrashing of cable modems when
utilization-based method is used with DOCSIS load balancing.

Cisco CMTS Cable Command Reference

400
 Cable Commands: cable l
cable load-balance group interval

Note Having too small an interval could result in cable modems being constantly moved to achieve balanced loads
during peak usage times when load balance could spike to transient heavy traffic. Also, more frequent updates
can have a performance impact, especially on routers with a large number of active interfaces and cable
modems.

Examples The following example shows how to configure load-balance group 3 so that it performs a policy
update every 30 seconds:

Router# configure terminal

Router(config)# cable load-balance group 3 interval 30

Router(config)#

The following example shows how to reset load-balance group 10 to its default update frequency of
10 seconds:

Router# configure terminal

Router(config)# no cable load-balance group 10 interval
Router(config)#

Related Commands Command Description

cable load-balance exclude Excludes a particular cable modem, or all cable modems from
a particular vendor, from one or more types of load-balancing
operations.

cable load-balance group (global Creates and configures a load-balance group.

configuration)

cable load-balance group (interface Assigns a downstream to a load-balance group.

configuration)

cable load-balance group policy ugs Configures how the Cisco CMTS should load balance cable
modems with active unsolicited grant service (UGS) service
flows.

cable load-balance group threshold Configures the threshold values that a load-balance group should
use for load-balancing operations.

cable upstream load-balance group Assigns an upstream to a load-balance group.

clear cable load-balance Clears the counters or state machine used to track load-balancing
operations.

show cable load-balance Displays real-time statistical and operational information for
load-balancing operations.

Cisco CMTS Cable Command Reference

401
 Cable Commands: cable l
cable load-balance group policy

cable load-balance group policy

The following command is introduced to the Cisco CMTS starting in Cisco IOS Release 12.2(17b)BC4.
To set the type of service flow policy for use with Load Balancing, use the following command in global
configuration mode. This enhancement synchronizes the pending statistic between different cable interface
line cards in the load balancing group. The result is an alternative downstream load balancing scheme that
makes use of per-upstream loads rather than total downstream loads.
To remove this configuration, use the no form of this command.

cable load-balance group ds-lb-group-id policy us-groups-across-ds

no cable load-balance group ds-lb-group-id policy us-groups-across-ds

Syntax Description ds-lb-group-id Specifies the load balancing group being configured. This downstream group includes
the upstream segment in load balancing decisions.

us-groups-across-ds Specifies the upstream group to be distributed in load balancing decisions for the
downstream group specified.

Command Default By default, this load balancing configuration is not enabled on the Cisco CMTS.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(17b)BC4 This command was introduced on the Cisco uBR10012 router and the Cisco uBR7246VXR
router, with supporting broadband processing engines (BPEs) or cable interface line cards
on the respective routers.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example illustrates this command and one supported implementation:

Router(config)# cable load-balance group 1 policy 2

Router(config)#

In this example, a cable modem that comes online on the interface cable 5/0 Upstream 2 could
potentially come online on the following interfaces:
• cable 3/0 upstream 2
• cable 4/0 upstream 2
• cable 6/0 upstream 2
• nowhere else, however
With downstream load balancing prior to Cisco IOS Release 12.2(17b)BC4, having 100 cable modems
per segment would be possible in an extreme case that distributes cable modems as follows:

Cisco CMTS Cable Command Reference

402
 Cable Commands: cable l
cable load-balance group policy

U0 U1 U2 U3 Downstream
3/0 97 1 1 1 100
4/0 1 97 1 1 100
5/0 1 1 97 1 100
6/0 1 1 1 97 100

Usage Guidelines This command is subject to the restrictions and prerequisites described in Configuring Load Balancing and
Dynamic Channel Change (DCC) on the Cisco CMTS .
Cisco IOS Release 12.2(17b)BC4 enables the optional operation of making downstream load balancing
decisions as follows:
• The target downstream segment is in the same downstream load balancing group as the source downstream
segment.
• The upstream load balancing group can be set for the corresponding channel on which a cable modem
is balanced.
• The Cisco CMTS automatically locates the upstream segment for a load balancing group and processes
the upstream group status on the source interface that has the lowest load.
• The target downstream segment must have an upstream channel set in the upstream load balancing group.
• The highest target upstream segment must carry less load than any other potential target —the highest
upstream segment on other interfaces.
This command enables an alternative downstream load balancing scheme that makes use of per-upstream
loads rather than total downstream loads.
This enhancement performs downstream load balancing that accounts upstream channel loads in the same
upstream load balancing group, rather than on the basis of the entire downstream channel load. Prior Cisco
IOS releases may not have distributed cable modems evenly over individual upstream channels, nor in a way
that accounted for downstream and upstream together.
This enhancement applies when downstream load balancing occurs on a headend system with separate upstream
load balancing segments; the upstream segments are spread over multiple downstreams segments.
This optional configuration supports output of the show cable load-balance command so that the command
displays more information about loads on channels that are configured on external or remote cable interface
line cards.

Related Commands Command Description

show cable load-balance Displays information about loads on channels that are configured on external or
remote cable interface line cards, to include integrated per-upstream load balancing
information.

Cisco CMTS Cable Command Reference

403
 Cable Commands: cable l
cable load-balance group policy ugs

cable load-balance group policy ugs

To configure whether the Cisco CMTS should load balance cable modems with Unsolicited Grant Service
(UGS) service flows (which are typically used for active voice calls), use the cable load-balance group
policy ugs command in global configuration mode. To reset the load-balance group to its default policy setting,
use the no form of this command.

cable load-balance group n policy ugs

no cable load-balance group n policy ugs

Syntax Description n Specifies the number of the load-balance group. In Cisco IOS Release 12.2(33)SCE3 and earlier, the valid
range is from 1 to 80. In Cisco IOS Release 12.2(33)SCE4 and later, the valid range is from 1 to 256.

Command Default Cable modems with active UGS service flows can be moved for load-balancing (cable load-balance group
n policy ugs)

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.2(33)SCE4 The valid range for the load balance group was changed.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable load-balance group policy ugs command determines whether a load-balance group can move
cable modems with UGS service flows, so as to enforce dynamic load balancing policies. Because most voice
calls use UGS service flows to allow real-time traffic, this option is primarily used to determine whether the
Cisco CMTS will move cable modems with active voice calls.
If you disable this option (no cable load-balance group policy ugs), the Cisco CMTS does not move cable
modems with active UGS service flows to a new upstream or downstream. This prevents some possible
interruptions of service to these customers, but it could result in denial of service conditions for other customers
if the interface starts becoming overloaded.
To avoid this, the default configuration (cable load-balance group policy ugs) of this command allows the
Cisco CMTS to move cable modems to a new upstream or downstream, even if they have active UGS service
flows. This enables the Cisco CMTS to perform optimum load balancing, but it could cause a momentary
interruption in the voice call—users on the voice call might hear a momentary drop during the call, but the
call should not be terminated.

Note The cable load-balance group policy ugs command affects only dynamic load-balancing operations and
does not affect static and passive load-balancing operations. Dynamic load balancing is enabled using the
enforce option with the cable load-balance group threshold command.

Cisco CMTS Cable Command Reference

404
 Cable Commands: cable l
cable load-balance group policy ugs

Examples The following example shows how to enable the UGS policy on a load-balance group (the default
configuration), so that the Cisco CMTS can move cable modems with active UGS service flows as
needed to enforce the current dynamic load balancing policy:

Router# config terminal

Router(config)# cable load-balance group 13 policy ugs

Router(config)#

The following example shows how to configure a load-balance group so that the Cisco CMTS does
not move cable modems with active UGS service flows (default configuration):

Router# config terminal

Router(config)# no cable load-balance group 100 policy ugs

Router(config)#

The cable load-balance group policy ugs command is used to configure the following feature:
• Load Balancing and Dynamic Channel Change on the Cisco CMTS Routers

Related Commands Command Description

cable load-balance exclude Excludes a particular cable modem, or all cable modems from a
particular vendor, from one or more types of load-balancing
operations.

cable load-balance group Creates and configures a load-balance group.

cable load-balance group (interface) Assigns a downstream to a load-balance group.

cable load-balance group interval Configures the frequency of the load-balancing policy updates.

cable load-balance group threshold Configures the threshold values that a load-balance group should
use for load-balancing operations.

cable upstream load-balance group Assigns an upstream to a load-balance group.

clear cable load-balance Clears the counters or state machine used to track load-balancing
operations.

show cable load-balance Displays real-time statistical and operational information for
load-balancing operations.

Cisco CMTS Cable Command Reference

405
 Cable Commands: cable l
cable load-balance group threshold

cable load-balance group threshold

To configure the threshold values that a load-balance group should use for load-balancing operations, use the
cable load-balance group threshold command in global configuration mode. To reset the load-balance group
to its default threshold values, use the no form of this command.

cable load-balance group n threshold {load load-value [enforce threshold] | load minimum
number | stability percent | ugs band-value}

Syntax Description n Specifies the number of the load-balance group. In Cisco IOS Release 12.2(33)SCE3 and
earlier, the valid range is from 1 to 80. In Cisco IOS Release 12.2(33)SCE4 and later, the
valid range is from 1 to 256.

load load-value Specifies the maximum load difference, as expressed in a percentage of total load, that can
exist between interfaces in a load-balance group before the Cisco CMTS performs load
balancing. If the load between interfaces is greater than the value specified by load-value
, cable modems that are registering are assigned to the lesser-utilized interface until the
load difference is once again below this value. The valid range for load-value is 1 to 100
percent, with a default of 10 percent.
Note
The default of 10 percent is the minimum recommended threshold. Do not set this threshold
below 10 percent unless you have been instructed to do so by Cisco TAC.

enforce (Optional) Enables dynamic load balancing, which moves online cable modems after their
threshold initial registration to achieve load balancing of the cable interfaces in a load-balance group.
Cable modems that are currently online are moved when the load difference between two
interfaces in the load-balance group exceeds this percentage. Modems continue to be moved
until the load difference falls below this value.
The possible valid range for threshold is 1 to 100 percent, but the threshold must be equal
to or greater than the percentage specified with the load-value option. For this reason, the
actual minimum for threshold is the current setting of the load-value option. The default
is also the same value as the load-value parameter.

load minimum (Optional) Specifies that cable modems should be moved only if the load between the two
number interfaces is greater than the specified number of cable modems or service flows (valid
only when the method is the number of modems or service flows). The valid range is 1 to
100, with a default of 5.

stability Specifies the threshold to be used to determine whether a channel or interface is unstable,
percent in terms of the percentage of successful ranging requests. The percent value specifies the
minimum percentage of successful ranging requests that is acceptable; otherwise, the CMTS
begins moving CMs. The valid range is 1 to 100 percent, with a default of 50 percent.

Cisco CMTS Cable Command Reference

406
 Cable Commands: cable l
cable load-balance group threshold

ugs band-value Specifies that the Cisco CMTS should move cable modems with active UGS service flows
when the current UGS usage reaches the percentage of total bandwidth available that is
specified by the band-value parameter. The valid range for band-value is 0 to 100 percent,
with a default of 70 percent.
Note
This option is effective only when the enforce option has also been used to enable dynamic
load balancing, and the Cisco CMTS has been authorized to move cable modems with
active UGS service flows (using the cable load-balance group policy ugs command).

Command Default The load parameter defaults to 10 percent, the load minimum parameter defaults to 5, the stability parameter
defaults to 50 percent, and the ugs parameter defaults to 70 percent. By default, only static load balancing is
done (no enforce option). If the enforce option is given without a threshold value, it defaults to the same
value as the load parameter.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.2(33)SCE4 The valid range for the load balance group was changed.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable load-balance group threshold command is used to configure the following feature:
• Load Balancing and Dynamic Channel Change on the Cisco CMTS Routers
The cable load-balance group threshold command configures a load-balance group for the threshold values
that it should use to determine when a cable modem should be moved to a new downstream or upstream. You
can specify the following different thresholds:
• load—Specifies the maximum load usage that can exist between interfaces in a load-balance group before
the Cisco CMTS begins static load-balancing operations. The default value of load-value is 10 percent,
which means that two upstreams or two downstreams can have usage rates that vary up to 10 percent
before the Cisco CMTS begins rebalancing the load usage. This rebalancing, however, is done only when
cable modems first register with the Cisco CMTS—the Cisco CMTS does not switch cable modems that
are already online.
For example, if the load value is 10 percent, and upstream 1 is at 23 percent and upstream 2 is at 30 percent,
no cable modems are moved. However, if load usage for upstream 2 reaches 35 percent, the Cisco CMTS
begins assigning new cable modems, as they register, to upstream 1 until the difference in load usage between
the two upstreams falls below 10 percent.

Note The default of 10 percent is the minimum recommended threshold. Do not set this threshold below 10 percent
unless you have been instructed to do so by Cisco TAC.

Cisco CMTS Cable Command Reference

407
 Cable Commands: cable l
cable load-balance group threshold

• enforce—Enables dynamic load balancing, so that the Cisco CMTS can move cable modems that are
already online. This option has its own threshold value, which specifies the difference in load usage that
must exist between two interfaces in a group before the Cisco CMTS begins moving online cable modems.
The Cisco CMTS continues to move cable modems until the difference in load usage rates falls below
the threshold value.
When using dynamic load balancing and an upstream channel is overloaded, the Cisco CMTS sends an
Upstream Channel Change (UCC) request to a cable modem to instruct it to move to another upstream. The
cable modem should move to the new upstream channel, without going offline or having to reregister with
the CMTS.
When using dynamic load balancing and a downstream channel is overloaded, the Cisco CMTS sends an stop
response to a cable modem’s ranging request (RNG-REQ) message. When the cable modem sends a new
REG-REQ message, the Cisco CMTS specifies the new downstream channel in the Downstream Frequency
Override field in its REG-RSP message. The cable modem must go offline and reregister on the new downstream
channel, so as to conform to the DOCSIS 1.0 specifications.

Note In Cisco IOS Release 12.2(15)BC1, the dynamic load balancing method results in cable modems going offline
and having to reregister whenever the modems are moved between downstreams. This is because the DOCSIS
1.0 specification requires cable modems to reregister whenever the downstream is changed using the
Downstream Frequency Override message. Cable modems should not go offline when moved between
upstreams.

The Cisco CMTS also continues to enforce the load threshold value to perform static load balancing as well.
Therefore, the threshold percentage should be equal to or greater than the percentage specified with the load
load-value option.
For example, if you specify load 10 enforce 15, the Cisco CMTS monitors the load usage between cable
interfaces in the load-balance group. If upstream 1 reaches 33 percent and upstream 2 reaches 45 percent, the
Cisco CMTS begins static load-balancing operations by assigning new cable modems to upstream 1 when
they register. If the difference still continues to grow, and upstream 2 reaches 50 percent, the Cisco CMTS
also begins dynamic load-balancing operations by moving online cable modems, until the difference in load
usage falls below 15 percent. The Cisco CMTS then continues static load-balancing operations until the
difference falls below 10 percent.

Tip The enforce threshold is not displayed in the configuration file if it is the same as the load threshold. For
example, if you enter the cable load-balance group 1 threshold load 50 enforce 50 command, it appears as
cable load-balance group 1 threshold load 50 enforce in the configuration file.

• load minimum—Specifies that cable modems should be moved only if the load between the two interfaces
is greater than the specified number of cable modems or service flows. This option is valid only when
you have configured the load-balance group using either the method modem or method service-flows
options with the cable load-balance group command. It is not used with the utilization method.
• stability—Specifies the minimum percentage of ranging requests that are successful before the Cisco
CMTS determines that the interface or channel is unstable. When the channel has fewer than this
percentage of cable modems responding to periodic ranging requests over a one-minute period, the Cisco
CMTS begins moving modems to other channels in the load-balance group. For example, when set to
75 percent, the Cisco CMTS begins moving modems when fewer than 75 percent of modems are replying
to ranging requests.

Cisco CMTS Cable Command Reference

408
 Cable Commands: cable l
cable load-balance group threshold

• ugs—Specifies a threshold for when the Cisco CMTS should move cable modems that have active UGS
service flows, which are typically used for active voice calls. This option goes into force only when
dynamic load balancing has been enabled (using the enforce option), and the Cisco CMTS has been
allowed to move cable modems with active UGS service flows (using the cable load-balance group
policy ugs command). The band-value threshold specifies the maximum usage of UGS service flows
that should exist before the Cisco CMTS begins moving calls.
For example, if the band-value threshold is at its default of 70 percent, the Cisco CMTS does not begin moving
cable modems with active UGS service flows until UGS usage on an upstream or downstream reaches 70
percent of the total available bandwidth. The Cisco CMTS continues moving cable modems that are online
with active UGS service flows until the UGS usage on the interface falls below 70 percent.

Note Certain conditions can cause a system instability that could result in the Cisco CMTS endlessly attempting
to load balance the interfaces. For example, this situation could occur in noisy environments, where cable
modems drop offline on a regular basis, or when cable modems are repeatedly trying to register because the
provisioning system has sent them the wrong DOCSIS configuration files. If the Cisco CMTS detects such
unstable situations, it does not load balance cable modems from those interfaces until the system stabilizes.
However, if the system instability persists, you should increase the threshold values using the cable
load-balance group threshold command until the system stabilizes.

Examples The following example shows how to configure load-balance group 2 so that it performs static load
balancing when the difference between two cable interfaces in the group is 20 percent or more.

Router# config terminal

Router(config)# cable load-balance group 2 threshold load 20
Router(config)#

The following example shows how to configure load-balance group 5 so that it performs static load
balancing when the difference in usage between two cable interfaces in the group is 20 percent or
more, and so that it performs dynamic load balancing when the difference in usage is 30 percent or
more. The Cisco CMTS will also begin moving cable modems with active UGS service flows when
UGS service flows reach 60 percent of the total bandwidth available on the upstream channel.

Router(config)# cable load-balance group 5 threshold load 20 enforce 30

Router(config)# cable load-balance group 5 threshold ugs 60

Router(config)# cable load-balance group 5 policy ugs

Router(config)#

Note You must configure the load-balance group with the cable load-balance group policy ugs command
before the Cisco CMTS begins enforcing the threshold that was set with the cable load-balance
group threshold ugs command.

Cisco CMTS Cable Command Reference

409
 Cable Commands: cable l
cable load-balance group threshold

Related Commands Command Description

cable load-balance exclude Excludes a particular cable modem, or all cable modems from a
particular vendor, from one or more types of load-balancing
operations.

cable load-balance group Creates and configures a load-balance group.

cable load-balance group (interface) Assigns a downstream to a load-balance group.

cable load-balance group interval Configures the frequency of the load-balancing policy updates.

cable load-balance group policy ugs Configures how the Cisco CMTS should load balance cable modems
with active unsolicited grant service (UGS) service flows.

cable upstream load-balance group Assigns an upstream to a load-balance group.

clear cable load-balance Clears the counters or state machine used to track load-balancing
operations.

show cable load-balance Displays real-time statistical and operational information for
load-balancing operations.

Cisco CMTS Cable Command Reference

410
 Cable Commands: cable l
cable load-balance group threshold (Supporting Dynamic Channel Change)

cable load-balance group threshold (Supporting Dynamic

Channel Change)
To set the threshold levels and corresponding service flow types for the specified Load Balancing group,
supporting Dynamic Channel Change (DCC) on the Cisco router, use the following command in global
configuration mode. To remove threshold settings, use the no form of this command.

cable load-balance group n threshold {load | pcmm | stability | ugs} {0-100}

cable load-balance group n threshold ugs <1-100>
cable load-balance group n threshold load <1-100> {minimum}
cable load-balance group n threshold load 75 {enforce}

Syntax Description n Specifies the number of the load balance group. In Cisco IOS Release 12.2(33)SCE3 and earlier,
the valid range is from 1 to 80. In Cisco IOS Release 12.2(33)SCE4 and later, the valid range is
from 1 to 256.

load Interface load threshold settings

pcmm PCMM service flow threshold

stability Threshold for stability detection

ugs UGS service flow threshold

1-100 Interface utilization threshold in percentage of interface capacity.

load Interface load threshold settings

1-100 Threshold value in percentage

minimum Set minimum number of modems/flows difference before loadbalancing starts

enforce Enters the enforce threshold

Command Default Load balancing is not configured by default on the Cisco CMTS.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(17a)BC This command was introduced on the Cisco uBR10012 router and the Cisco uBR7246VXR
router, with supporting broadband processing engines (BPEs) or cable interface line cards
on the respective routers.

12.2(33)SCE4 The valid range for the load balance group was changed.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Cisco CMTS Cable Command Reference

411
 Cable Commands: cable l
cable load-balance group threshold (Supporting Dynamic Channel Change)

Examples The following command specifies the reserved bandwidth threshold. Above this level, cable modems
with active PCMM service flows participate in load balancing, and the default threshold is 70%.
Note that if UGS is used for PCMM, the UGS threshold needs to be crossed as well. The default
UGS threshold is 70%)

Router(config)# cable load-balance group 4 threshold pcmm <pcmm-value>

Usage Guidelines In Cisco IOS releases prior to Cisco IOS Release 12.3(17a)BC, the load balancing default setting is UGS.
This is not the case with Cisco IOS Release 12.3(17a)BC. In this latter release, and subsequent releases,
configuration is required if the cable modems with active UGS flows are desired to participate in load balancing.
This command is subject to the restrictions and prerequisites described in Configuring Load Balancing and
Dynamic Channel Change (DCC) on the Cisco CMTS .
The cable load-balance group threshold command is used to configure the following feature:
• Load Balancing and Dynamic Channel Change on the Cisco CMTS Routers

Related Commands Command Description

cable load-balance group (Supporting Sets multiple parameters for Load Balancing with DCC.
Dynamic Channel Change)

cable load-balance group dcc-init-technique Sets the initialization technique for Dynamic Channel
(Supporting Dynamic Channel Change) Change (DCC) for Load Balancing.

cable load-balance group policy (Supporting Sets the type of service flow for use with Load Balancing
Dynamic Channel Change) and DCC, whether PacketCable MultiMedia (PCMM) or
Unsolicited Grant Service (UGS).

show controllers cable Displays statistics for Dynamic Channel Change (DCC)
for load balancing.

Cisco CMTS Cable Command Reference

412
 Cable Commands: cable l
cable load-balance method-utilization min-threshold

cable load-balance method-utilization min-threshold

To configure the minimum threshold for initiating load balancing under the utilization method , use the cable
load-balance method-utilization min-threshold command in global configuration mode.

cable load-balance method-utilization min-threshold min_threshold

Syntax Description min_threshold (Optional) Specifies the minimum threshold value in percentage, of utilization to initiate load
balancing. The valid range is from 10 to 90. The default value is 25.

Command Default The minimum utilization threshold is 25 percent.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCH This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Examples The following example shows how to configure the cable load-balance method-utilization
min-threshold min_threshold command:

Router# enable
Router(config)# cable load-balance method-utilization min-threshold
40
Router(config)# exit

Related Commands Command Description

cable load-balance group threshold Configures the threshold values that a load-balance group should use
for load-balancing operations

Cisco CMTS Cable Command Reference

413
 Cable Commands: cable l
cable load-balance modem max-failures

cable load-balance modem max-failures

To configure the number of times a CM can fail before the CM is removed from the dynamic load balancing
group, use the cable load-balance modem max-failures command in the global configuration mode. To
remove the configured number for a CM to fail, use the no form of this command.

cable load-balance modem max-failures0-100

no cable load-balance modem max-failures

Syntax Description 0-100 Specifies the maximum number of failures before a CM is removed from the dynamic LB. However,
if you give the value 0, the cable load-balance modem max-failures command gets disabled.
Note
The CM is excluded from the dynamic load balance operations after it has failed the specified number
of times, however it still belongs to a LBG.

Command Default The default value is 10.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Examples The following example shows how to configure CM using the cable load-balance modem
max-failures command.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#
cable load-balance modem max-failures 10
Router(config)#

Cisco CMTS Cable Command Reference

414
 Cable Commands: cable l
cable load-balance restrict modem

cable load-balance restrict modem

To configure a list of cable modems statically provisioned at the CMTS to a restricted load balancing group
(RLBG) or a service type ID, use the cable load-balance restrict modem command in the global configuration
mode. To remove the configured list of cable modems, use the no form of this command.

cable load-balance restrict modem index mac-addr [mac-mask] {docsis-group docsis-group-id |

service-type-id string}
no cable load-balance restrict modem index mac-addr [mac-mask] {docsis-group docsis-group-id
| service-type-id string}

Syntax Description index Assigns an index number ranging from 1 to 4294967295.

mac-addr Specifies the MAC address of the modem that is restricted.

mac-mask Specifies the MAC mask of the modem that is restricted.

docsis-group docsis-group-id Restricts modems to a DOCSIS load balancing group.

service-type-id string Restricts modems to a service type ID.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Examples The following example shows how to assign a group of modems with a common MAC mask to a
group or a service type ID using the cable load-balance restrict modem command. To assign the
modem to a LBG, you can either specify the LBG ID or the service type ID.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance restrict modem 1 001a.c30c.7eee FFFF.FFFF.0000 docsis-group
100
Router(config)#

Cisco CMTS Cable Command Reference

415
 Cable Commands: cable l
cable load-balance rule

cable load-balance rule

To create a rule that prevents cable modem (CM) from disabling or enabling load balancing, use the cable
load-balance rule command in cable global configuration mode. To remove a defined rule, a rule from all
policies, or the policy itself if it is the last rule of that policy, use the no form of this command.

cable load-balance rule rule-id {disable-period dis-start start-time dis-period disable-period |

disable-throughput-lowerbound {ds n | us n} | disabled | enabled | vdoc-enabled}
no cable load-balance rule rule-id

Cisco cBR Series Converged Broadband Routers

cable load-balance rule rule-id {disable-period dis-start start-time dis-period disable-period |
disable-throughput-lowerbound {ds n | us n} | disabled | enabled}

Syntax Description rule-id Specifies the rule to load balance CM.

disable-period Specifies the number of seconds to prevent CM from load balancing at a

given start time.

dis-start start-time Specifies the start time to disable CM from load balancing. The dis-start
is the start time ranging from 0 to 86400 seconds from midnight.

dis-period disable period Specifies the period to disable CM from load balancing. The dis-period
is the duration time ranging from 0 to 86400 seconds from midnight.

disable-throughput-lowerbound Disables load balancing if CM throughput is lower than a threshold.

ds n | us n Specifies downstream or upstream channels throughput lowerbound in

kbps, ranging from 0 to 1000000.

disabled Disables the CM from load balancing.

enabled Enables load balancing on CM.

vdoc-enabled (For Cisco uBR10012 Router and Cisco uBR7200 Series Routers) Enables
the video over DOCSIS (VDOC) load balancing for static multicast groups.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

12.2(33)SCC The disable-throughput-lowerbound parameter was added in the command.

12.2(33)SCD5 The vdoc-enabled parameter was added in the command.

Cisco CMTS Cable Command Reference

416
 Cable Commands: cable l
cable load-balance rule

Release Modification

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

Usage Guidelines The cable load-balance rule rule-id disable-period dis-start start-time dis-period disable-period command
can be used for a 24 hours period.

Important You cannot disable load balancing and enable it for the next day using a single rule. You must configure two
separate rules using the cable load-balance rule rule-id disable-period dis-start start-time dis-period 0
command to disable it and the cable load-balance rule rule-id disable-period dis-start 0 dis-period
disable-period command to enable it for the next day.

The no form of this command supports the following actions:

• Remove a defined rule.
• Remove the rule from all policies.
• Remove the policy itself if it is the last rule of that policy.

Note Static multicast groups must be configured on the specific bundle interface as well as on the correct forwarding
interfaces to enable the vdoc-enabled rule.

Examples The following example shows how to create a rule:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance rule 1 disable-period dis-start 40 dis-period 50
Router(config)# cable load-balance rule 1 disable-throughput-lowerbound ds 2500
Router(config)# cable load-balance rule 1 disabled
Router(config)# cable load-balance rule 2 enabled
Router(config)# cable load-balance rule 1 vdoc-enabled
Router(config)#

Related Commands Command Description

cable load-balance docsis-policy Creates a DOCSIS policy and associates a new or existing rule with the
policy.

Cisco CMTS Cable Command Reference

417
 Cable Commands: cable l
cable load-balance static cm-delay

cable load-balance static cm-delay

To configure the delay time to trigger static load balancing on the cable modem after registration hold-off
time ends, use the cable load-balance static cm-delay command.

cable load-balance static cm-delay delay

Syntax Description delay Cable modem delay time in seconds for static load balancing to trigger after registration hold. Valid
delay range is 0–65535.

Command Default By default, the cable modem delay time is 600 seconds.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Amsterdam 17.3.1w This command was
introduced.

Usage Guidelines When you set cable modem delay time to 0, successful registration triggers static load balancing instantly
after registration hold off time ends.

Examples The following example shows how to set load balancing cm-delay to 60 seconds.
Router#configure terminal
Router(config)#cable load-balance static cm-delay 60
Router(config)#end

Cisco CMTS Cable Command Reference

418
 Cable Commands: cable l
cable logging badipsource

cable logging badipsource

To log error messages about bad IP source addresses on the cable interfaces to a separate log buffer, use the
cable logging badipsource command in global configuration mode. To turn off the logging function and
clear out the buffer, so that any error messages are logged to the console or current system log, use the no
form of this command.

cable logging badipsource [buffer-size]

no cable logging badipsource

Syntax Description buffer-size Specifies the total size of the buffer that contains the logged error messages, in bytes. The range
is from 4096 to 1048576 (4 KB to 1 MB). The default is 4096.
Note
The maximum buffer size is limited by the amount of actual unused memory that is available
on the Cisco CMTS.

Command Default Error messages for bad IP source addresses are logged to the console or current system log. The default logging
buffer size is 4096 entries.

Command Modes
Global configuration (config)

Command History Release Modification

12.1(13)EC This command was introduced for the Cisco uBR7100 series and Cisco uBR7200
series universal broadband routers.

12.2(11)CY Support was added for the Cisco uBR10012 universal broadband router.

12.2(11)BC2 Support was added to the Release 12.2 BC train for the Cisco uBR7100 series,
Cisco uBR7200 series, and Cisco uBR10012 routers.

12.2(15)BC1, 12.2(15)CX The maximum buffer size was adjusted to 1 MB, which can contain
approximately 2000 error messages. Also, if the requested amount of memory
is not available in a contiguous block, the CMTS displays an error message and
does not change the buffer size.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines The cable source-verify command enables service providers to verify that the IP addresses being used on the
cable interface have been properly assigned by the provider’s DHCP servers. When a bad IP address is detected,
the Cisco CMTS generates a BADIPSOURCE error message in the console logs.
In previous Cisco IOS releases, the Cisco CMTS generated these particular error messages for every IP packet
that contained a bad IP source address. This can create a large volume of error messages that can make it
difficult to see other error messages in the console logs.
To create a separate log for these error messages, use the cable logging badipsource command. You can also
specify the size of the buffer that contains these error messages. When the buffer becomes full, the oldest

Cisco CMTS Cable Command Reference

419
 Cable Commands: cable l
cable logging badipsource

messages are deleted to make room for newer messages, so choose a buffer size that allows you to retain all
messages until you can examine them.
On the Cisco uBR10012 router, this command includes only the BADIPSOURCE error messages generated
by the PRE module. The cable interface line cards also generate their own error messages, but because these
error messages are typically duplicates of the ones generated by the PRE module, they are not included in the
separate log.

Tip If you find that the current buffer is too small to contain the current volume of error log messages, you can
issue this command again with a larger buffer size. However, doing so automatically clears out all messages
currently in the buffer, so ensure that you have viewed all the current messages before giving a second cable
logging badipsource command.

Note Be cautious when specifying the buffer size, because the Cisco CMTS could run out of memory for other
tasks. Use the show memory EXEC command to display the maximum available processor memory, and set
the buffer size for this command to a value well within that maximum value.

To display the contents of this error log, use the show cable logging command. To clear the buffer after you
have viewed the error messages, use the clear cable logging command. You can also use the service
timestamps log command to add a timestamp to the messages in the log.
To print the BADIPSOURCE messages to the console or syslog server, use the no cable logging badipsource
command (which is the default configuration). Note that this configuration does not turn off the generation
of BADIPSOURCE messages, but only configures the system for the default log message behavior.

Tip If you do not want to see any BADIPSOURCE messages at all, use the cable logging badipsource 4096
command so that these messages go to a separate buffer with the smallest possible size. You will then not see
these error messages unless you explicitly use the show cable logging command to display them.

Examples The following example shows how to enable the logging of bad IP source address error messages,
using a buffer size of 524,288 bytes (512 KB):

Router# configure terminal

Router(config)# cable logging badipsource 524288

Router(config)#

Tip You must also use the cable source-verify command to enable verification of source IP addresses
before the buffer contains any error messages about bad IP source addresses. If you do not use the
cable source-verify command, you can still use the cable logging badipsource command to create
a buffer, but the buffer always remains empty.

The following example shows how to enlarge the current buffer for bad IP source address error
messages by giving the cable logging badipsource command a second time. Because this will empty

Cisco CMTS Cable Command Reference

420
 Cable Commands: cable l
cable logging badipsource

out the buffer of all current messages, be sure to display the current buffer contents before giving
the command a second time.

Router# configure terminal

Router(config)# cable logging badipsource 8192

Router(config)# exit

Router# show cable logging badipsource

<<buffer contents omitted>>

Router# configure terminal

Router(config)# cable logging badipsource 256000

The following example shows how to stop the logging of bad IP source address error messages to a
separate buffer. This clears out all error messages from the buffer and removes the buffer from
memory, and future error messages for bad IP source addresses are logged to the console or to the
current system log, if any.

Router# configure terminal

Router(config)# no cable logging badipsource

Router(config)#

Related Commands Command Description

cable source-verify Enables verification of IP addresses for CMs and CPE devices on the upstream.

clear cable logging Removes all error messages about bad IP source addresses on the cable interfaces from
the error log buffer.

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

Cisco CMTS Cable Command Reference

421
 Cable Commands: cable l
cable logging downstream-index

cable logging downstream-index

To enable logging for downstream indexes, use the cable logging downstream-index command in global
configuration mode. To turn off logging and clear the buffer, use the no form of this command.

cable logging downstream-index [buffer-size]

no cable logging downstream-index [buffer-size]

Syntax Description buffer-size Total size of the buffer that contains the logged downstream indexes, in bytes. The range is from
4096 to 4121440. The default is 4096.
Note
The maximum buffer size is limited by the amount of actual unused memory that is available
on the Cisco CMTS.

Command Default The downstream indexes are logged on the line card on which this configuration is enabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable logging downstream-index command is configured on the Cisco uBR-MC3GX60V or Cisco
UBR-MC20X20V cable line cards or on the line card that is configured to be the modular-host for a SPA.
The downstream index logging may be enabled on the cable line card that has the MAC domain.

Note This command is used to collect data only when requested by Cisco TAC.

Caution Be cautious when specifying the buffer size because the Cisco CMTS could run out of memory for other tasks.
Use the show memory EXEC command to display the maximum available processor memory, and set the
buffer size for this command to a value well within the maximum value.

To display the contents of the downstream index log, use the show cable logging downstream-index command.
To clear the buffer after you have viewed the log, use the clear cable logging downstream-index command.
You can also use the service timestamps log command to add a timestamp to the messages in the log.

Examples The following example shows how to enable downstream index logging:

Router> enable
Router# configure terminal
Router(config)# cable logging downstream-index 4096

Cisco CMTS Cable Command Reference

422
 Cable Commands: cable l
cable logging downstream-index

Related Commands Command Description

clear cable logging Removes all downstream index log messages.

show cable logging Displays all downstream index log messages

Cisco CMTS Cable Command Reference

423
 Cable Commands: cable l
cable logging layer2events

cable logging layer2events

To save selected (low priority) DOCSIS events that are specified in CMTS MIB Registry to the cable logging
buffer (instead of to the general logging buffer), use the cable logging layer2events command in global
configuration mode. To disable the logging of DOCSIS events to the cable logging buffer, use the no form
of this command.

cable logging layer2events

no cable logging layer2events

Syntax Description This command has no arguments or keywords.

Command Default The DOCSIS events are saved to the general logging buffer on the Cisco CMTS. The default logging buffer
size is 4096 entries.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(9a)BC This command was introduced on the Cisco uBR10012 and Cisco uBR7246VXR universal
broadband routers.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines Use the show cable logging command to check whether the logging feature is enabled and the status of the
logging buffer.

Examples The following example shows how to clear the log buffer that contains a bad IP source address error
messages:

Router# show cable logging summary

Cable logging: BADIPSOURCE Enabled
Total buffer size (bytes): 1000000
Used buffer size (bytes) : 36968
Logged messages : 231
Router# clear cable logging badipsource
Router# show cable logging summary
Cable logging: BADIPSOURCE Enabled
Total buffer size (bytes): 1000000
Used buffer size (bytes) : 0
Logged messages : 0

Related Commands Command Description

cable logging badipsource Logs error messages about bad IP source addresses on the cable interfaces to a
separate log buffer,

Cisco CMTS Cable Command Reference

424
Cable Commands: cable l
cable logging layer2events

Command Description

show cable logging Indicates whether the logging feature is enabled and the status of the logging
buffer.

Cisco CMTS Cable Command Reference

425
 Cable Commands: cable l
cable logging layer2events

Cisco CMTS Cable Command Reference

426
Cable Commands: cable m to n
• cable map-advance, on page 429
• cable match address, on page 431
• cable max-hosts, on page 433
• cable mc-link-stat ignore, on page 435
• cable metering data-per-session, on page 436
• cable metering destination, on page 438
• cable metering filesystem, on page 442
• cable metering ipdr, on page 445
• cable metering ipdr-d3, on page 447
• cable metering localtime , on page 449
• cable metering source-interface, on page 450
• cable modem access-group, on page 453
• cable modem change-frequency, on page 455
• cable modem max-cpe, on page 456
• cable modem max-hosts, on page 458
• cable modem opt0, on page 460
• cable modem qos profile, on page 461
• cable modem remote-query, on page 463
• cable modem service-class-name, on page 466
• cable modem v6-max-cpe-prefix, on page 468
• cable modem vendor, on page 469
• cable modulation-profile, on page 471
• cable modulation-profile global-scheme, on page 481
• cable mod-profile-ofdma, on page 483
• cable mod-profile-ofdma data-iuc modulation pilot-pattern cwerr-downgrade-iuc, on page 485
• cable monitor, on page 487
• cable mrc-mode, on page 491
• cable mtc-mode, on page 493
• cable multicast auth enable default-action, on page 495
• cable multicast auth profile-name, on page 496
• cable multicast group-encryption, on page 497
• cable multicast group-qos, on page 498
• cable multicast group-qos default, on page 500

Cisco CMTS Cable Command Reference

427
 Cable Commands: cable m to n

• cable multicast mdf-disable, on page 501

• cable multicast qos group, on page 503
• cable multicast ses-cache, on page 505
• cable multicast source, on page 507
• cable nd, on page 508
• cable nd timeout, on page 509
• cable nd validate, on page 510

Cisco CMTS Cable Command Reference

428
 Cable Commands: cable m to n
cable map-advance

cable map-advance
To configure the dynamic map advance algorithm, use the cable map-advance command in cable interface
configuration mode or MAC domain profile configuration mode. To disable this function, use the no form of
this command.

cable map-advance [dynamic [safety] | static] [max-delay]

no cable map-advance

Syntax Description dynamic safety Enables the dynamic MAP advance algorithm that automatically tunes lookahead time in
MAPs based on the current farthest CM on a particular upstream port.
• safety—Specifies a safety factor for the dynamic map advance algorithm in
microseconds. This value controls the amount of extra lookahead time in MAPs to
account for inaccuracies of the measurement system and internal software latencies.
The range is from 300 to 1500. The default is 1000.
Note
Using larger safety factors increases the run time lookahead in MAPs, but reduces the
upstream performance.

static Enables the static map advance algorithm that uses a fixed lookahead time value in MAPs
based on the worst-case propagation delay of 100 mile HFC cable network.

max-delay Specifies the maximum round trip delay between the cable plant and furthest CM in
microseconds. The range is from 100 to 2000. The default is 1800. The typical delay for a
mile of coaxial cable is approximately 7 microseconds. The typical delay for a mile of fiber
cable is approximately 8 microseconds.

Command Default Dynamic map advance with a safety factor of 1000 microseconds and a maximum round trip delay of 1800
microseconds.

Command Modes
Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.1T This command was introduced.

12.0 (9)SC, 12.1(2)EC1 The dynamic option was added.

12.1(10)EC The max-delay option was added. The dynamic MAP algorithm was also enhanced
so that it can quickly determine whether the furthest CM is now offline, so that the
MAP advance algorithm can be updated accordingly.

12.2(8)BC1 The range for the max-delay option was changed to the current values of between
100 and 2000 microseconds.

Cisco CMTS Cable Command Reference

429
 Cable Commands: cable m to n
cable map-advance

Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

IOS XE Fuji 16.7.1 This command was modified to support MAC domain profile configuration on the
Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The max-delay option, which was introduced in Cisco IOS Release 12.1(10)EC, specifies the maximum
possible round-trip delay between the cable plant and furthest CM in the cable network. A CM is not allowed
to exceed the maximum timing offset given by the max-delay value (in static mode) or given by the combination
of the max-delay and safety values (in dynamic mode). If a CM reports a timing offset beyond the maximum
value, the CMTS resets its offset to the maximum value and puts an exclamation point (!) next to its offset
value in the show cable modem display.
In dynamic MAP operation, Cisco IOS 12.1(10)EC also implements a regular polling of the furthest CM, to
determine if that CM is now offline. If the furthest CM has gone offline, the CMTS scans the currently online
CMs to determine which CM is now the furthest offline and updates the dynamic MAP advance algorithm
with the new value.

Examples The following example shows how to configure the dynamic map advance to 1500 microseconds:

router(config-if)# cable map-advance dynamic 1500

Related Commands Command Description

show cable modem Displays statistics for the connected CMs.

Cisco CMTS Cable Command Reference

430
 Cable Commands: cable m to n
cable match address

cable match address

To specify that IP multicast streams be encrypted, use the cable match address command in cable interface
configuration mode. To specify that multicast streams should not be encrypted, use the no form of this
command.

cable match address access-list

no cable match address

Syntax Description access-list Specifies that the IP multicast streams defined by the access list be encrypted. Access lists can
be IP access list numbers or an IP access list name. Valid access list numbers are from 100 to
199.

Command Default None

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.1 T This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable match address command binds an access-list to a cable interface, allowing multicast encryption
to be performed on traffic through that interface. To configure the access list, use the ip access-list command.

Note This command is not available for cable subinterfaces.

Note This command is available only on images that support Baseline Privacy Interface (BPI) and Baseline Privacy
Interface Plus (BPI+) encryption.

Examples The following example shows how to specify that the multicast stream defined by the access list
named reno be encrypted on cable interface 3/0:

Router(config)# interface c3/0

Router(config-if)# cable match address reno

Cisco CMTS Cable Command Reference

431
 Cable Commands: cable m to n
cable match address

The following example shows how to specify that the multicast stream defined by the access list
number 102 be encrypted:

Router(config)# interface c3/0

Router(config-if)# cable match address 102

Related Commands Command Description

ip access-list Defines an IP access list by name.

Cisco CMTS Cable Command Reference

432
 Cable Commands: cable m to n
cable max-hosts

cable max-hosts
To specify the maximum number of hosts that can be attached to a subscriber's CM, use the cable max-hosts
command in cable interface configuration mode. To reset the allowable number of hosts attached to a CM to
the default value of 0 hosts, use the no form of this command.

cable max-hosts n
no cable max-hosts

Syntax Description n Specifies the maximum number of hosts that can be attached to a CM on this interface. The range is from
0 to 255. The default is 0.

Command Default The maximum number of hosts that can be attached to a CM is 0.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

12.0(6)SC, 12.1(2)EC1 Support was added on the Cisco IOS 12.0 SC and 12.1 EC release trains.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines The Cisco CMTS uses three commands set the maximum number of hosts for a particular CM, for all CMs
on a particular cable interface, or for all CMs using the Cisco CMTS router:
• cable modem max-hosts—Sets the maximum number of hosts for a particular CM.
• cable max-hosts—Sets the maximum number of hosts for all CMs on a particular cable interface.
• cable modem max-cpe—Sets the maximum number of hosts for all CMs using the Cisco CMTS router.
The more specific commands override the settings of the less specific commands. For example, if you use
the cable modem max-cpe command to set the maximum number of hosts to 2 for all CMs, you can still use
the cable modem max-hosts command to give a particular CM a larger maximum host value.

Note The CMTS assigns the MAX Host value to a cable modem at the time that the cable modem registers with
the CMTS. Changing any of the MAX Host commands affects only cable modems that register after the
change.

Examples The following example shows how to set the maximum hosts for CMs on this particular cable interface
to 15:

Router(config)# interface c6/0

Router(config-if)# cable max-hosts 15

Cisco CMTS Cable Command Reference

433
 Cable Commands: cable m to n
cable max-hosts

Related Commands Command Description

cable modem access-group Specifies an access group for a CM.

cable modem change-frequency Changes the downstream frequency or upstream channel ID.

cable modem max-cpe Sets the maximum number of hosts for all CMs using the Cisco CMTS
router.

cable modem max-hosts Sets the maximum number of hosts for a particular CM.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

434
 Cable Commands: cable m to n
cable mc-link-stat ignore

cable mc-link-stat ignore

To ensure that whenever the Downstream External PHY Interface (DEPI) Ethernet port goes down, the module
interface or the mc-link does not go down, use the cable mc-link-stat ignore command in global configuration
mode.

cable mc-link-stat ignore

Syntax Description This command has no arguments or keywords.

Command Default Whenever DEPI Ethernet port goes down, the module interface or the mc-link also goes down. That is, the
no cable mc-link-stat ignore command is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCH This command was introduced.

Examples The following example shows how to ensure that the module interface does not go down whenever
DEPI ethernet port goes down:
Router(config)# cable mc-link-stat ignore

Cisco CMTS Cable Command Reference

435
 Cable Commands: cable m to n
cable metering data-per-session

cable metering data-per-session

To view the number of cable metering data flows per session for a cable modem termination system, use the
cable metering data-per-session command in the global configuration mode. To disable this feature, use the
no form of this command.

cable metering data-per-session data-per-session timer timer value

no cable metering data-per-session data-per-session timer timer value

Syntax Description data-per-session Specifies the number of data flows per session in KB. The range is
from 3 to 30. The default is 5.

timer Displays the cable line card timer to wake up.

timer value Specifies the timer wake up interval value in milliseconds. The range
is from 8 to 500. The default is 100.

Command Default The cable metering data flow values are not visible.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB1 This command was introduced.

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

12.3(23)BC7.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series
Converged Broadband Routers.

Usage Guidelines The cable metering data-per-session command allows users to view the number of cable metering data flows
per session. The command limits or throttles the data collection between the cable line card and the route
processor.

Examples The following example displays the number of cable metering data flows per session:

Router# configure terminal

Router(config)# cable metering data-per-session 8 timer 100

Router# show run | include metering

cable metering destination 2.7.36.88 6789 0 15 non-secure

cable metering data-per-session 8 timer 100

Cisco CMTS Cable Command Reference

436
 Cable Commands: cable m to n
cable metering data-per-session

Related Commands Command Description

show cable metering-status Displays information about the most recent successful usage-based billing
operation.

cable metering destination Enables usage-based billing and to stream the billing records to an external
collection server,

Cisco CMTS Cable Command Reference

437
 Cable Commands: cable m to n
cable metering destination

cable metering destination

To enable usage-based billing and to stream the billing records to an external collection server, use the cable
metering destination command in global configuration mode. To disable usage-based billing, use the no
form of this command.

cable metering destination ip-address port [ip-address2 port2] retries minutes {non-secure | secure}
[cpe-list-suppress] [flow-aggregate] [full-records]
no cable metering

Syntax Description ip-address port Address and TCP port number for the billing application on the external server:
• ip-address— IP address for the external collection server.
• port—TCP port number for the billing collection application on the server. The range
is from 0 to 65535, but the port should not be one of the widely-used TCP port
numbers (0 to 1024).

ip-address2 (Optional) IP address and TCP port number for a billing application on a secondary
port2 external server that is used if the primary server fails to respond:
• ip-address2— IP address for the secondary external server.
• port2— TCP port number for the billing collection application on the secondary
server. The range is from 0 to 65535, but the port should not be one of the widely-used
TCP port numbers (0 to 1024).

retries Number of retry attempts that the Cisco CMTS makes to establish a secure connection
with the external server before using the secondary server (if configured) and sending an
SNMP trap about the failure. The range for n is from 0 to 5. The default is 1 retry attempt.

minutes Frequency of the billing records streamed to the external server in minutes. The range is
2 to 1440 (24 hours), with no default.
Note
We recommend a minimum interval of 30 minutes.

non-secure Specifies that the Cisco CMTS should use an unencrypted TCP connection when
connecting with the billing application on the external server.

secure Specifies that the Cisco CMTS should use a secure socket layer (SSL) TCP connection
when connecting with the billing application on the external server.
Note
This option is available only on the Cisco CMTS software images that support Baseline
Privacy Interface (BPI) encryption.

cpe-list-suppress (Optional) Eliminates the customer premises equipment (CPE) IP addresses from the
billing records to improve performance.
Note
The default is for CPE addresses to be included in the billing record, up to a maximum
of five CPE IP addresses for each cable modem.

Cisco CMTS Cable Command Reference

438
 Cable Commands: cable m to n
cable metering destination

flow-aggregate (Optional) Combines all information for an individual cable modem into one record.
Separate counters are maintained for upstream and downstream traffic, but those counters
include all service flows in that direction.

full-records (Optional) Provides information about full service flow (active and idle) records.

Command Default Usage-based billing is disabled. When enabled, CPE IP addresses (a maximum of five per cable modem) are
included in the billing records by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(9a)BC This command was introduced.

Note
In Cisco IOS Release 12.3(9a)BC, this command supports the monitoring of all service
flows for DOCSIS 1.0, DOCSIS 1.1, and DOCSIS 2.0 cable modems:
• upstream and downstream
• primary
• secondary
• dynamic

12.2(33)SCD2 This command was modified to add the full-records keyword.

Note
In Cisco IOS Release 12.2(33)SCD2 and later releases, this command is also supported
on DOCSIS 3.0 cable modems.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable metering destination command enables usage-based filling and configures it for streaming mode,
where the Cisco CMTS creates the billing records and regularly sends them to an external server for use by
the billing application.
The Cisco CMTS attempts to establish a connection with the first (primary) external server, and if this fails,
the CMTS sends an SNMP trap about the failure. The Cisco CMTS retries the connection for the number of
times specified in the cable metering destination command, and if all of those attempts fail, the Cisco CMTS
switches to the secondary external server, if configured. The Cisco CMTS repeats this sequence at every
interval, and always tries to connect to the primary server first before attempting to use the secondary server.

Note You can enable usage-based billing using either the cable metering filesystem or cable metering destination
command, but not both. If you give these commands twice, the second command overwrites the first.

If the CMTS cannot transmit the billing record to the external server, and if metering traps have been enabled
using the snmp-server enable traps cable metering command, the CMTS sends an SNMP trap to the SNMP
manager describing the reason for the failure. Typically, the reason is either that a timeout occurred with the

Cisco CMTS Cable Command Reference

439
 Cable Commands: cable m to n
cable metering destination

external server, or that the billing record no longer exists on the local filesystem. An SNMP trap is sent for
each connection failure.
To disable usage-based billing, use the no cable metering command. This immediately stops the collection
of billing information, except when the billing records are currently being streamed to the external server. If
a billing operation is in progress when you give the no cable metering command, the system displays the
message “CMTS Metering in progress. Ignoring current config.” Wait until the billing operation is finished
and then reenter the no cable metering command.

Note If the show cable metering-status command displays the status of a streaming operation as “success” but
the records were not received on the billing application server, verify that the Cisco CMTS and server are
configured for the same type of communications (non-secure TCP or secure SSL). If the Cisco CMTS is
configured for non-secure TCP and the server is configured for secure SSL, the Cisco CMTS transmits the
billing record successfully, but the server discards all of the data, because it did not arrive in a secure SSL
stream.

Examples The following example shows how to enable usage-based billing for streaming mode, with the CMTS
transmitting the billing records every 60 minutes to the server at the IP address of 10.10.10.37 and
TCP port of 5215, using a secure socket layer (SSL) TCP connection. A secondary external service
is also defined. The CMTS will retry the connection three times before giving up and switching to
the secondary server, as well as sending an SNMPv3 trap to notify the SNMP management system
of the failure:

U7246VXR# configure terminal

U7246VXR(config)# cable metering destination 10.10.10.37 5215 10.10.10.41 5215 3 60 secure

U7246VXR(config)#

The following example shows how to enable usage-based billing for streaming mode, with the CMTS
transmitting the billing records every 30 minutes to the server at the IP address of 10.10.10.37 and
TCP port of 8181, using an unencrypted TCP connection. No secondary server is defined. The CMTS
will retry the connection only once before giving up and sending an SNMPv3 trap to notify the SNMP
management system of the failure:

Router# configure terminal

Router(config)# cable metering destination 10.10.10.37 8181 1 30 non-secure

Router(config)#

The following example shows how to enable usage-based billing, using the same configuration as
above, except that the billing records do not include the IP addresses for the CPE devices:

Router# configure terminal

Router(config)# cable metering destination 10.10.10.37 8181 1 30 non-secure cpe-list-suppress

Router(config)#

Cisco CMTS Cable Command Reference

440
 Cable Commands: cable m to n
cable metering destination

The following example shows how to enable usage-based billing, using an unencrypted TCP
connection, including the IP addresses for the CPE devices, and enabling the full-records option:

Router# configure terminal

Router(config)# cable metering destination 10.10.10.37 11 1 222 non-secure full-records

cpe-list-suppress
Router#

Related Commands Command Description

cable metering filesystem Enables usage-based billing and writes the billing records to a file on a
local file system.

cable metering ipdr Enables usage-based billing using the IPDR and SP2.1 protocol.

cable metering ipdr-d3 Enables usage-based billing on DOCSIS 3.0 cable modems.

cable metering source-interface Enables debugging of usage-based billing operations.

show cable metering-status Displays information about the most recent usage-based billing operation.

snmp-server enable traps cable Ensures that the Simple Network Management Protocol (SNMP) traps
are sent for cable-related events.

Cisco CMTS Cable Command Reference

441
 Cable Commands: cable m to n
cable metering filesystem

cable metering filesystem

To enable usage-based billing and to write the records to a file on a local file system, use the cable metering
filesystem command in global configuration mode. To disable usage-based billing, use the no form of this
command.

cable metering filesystem filesystem [cpe-list-suppress] [flow-aggregate] [full-records]

no cable metering

Syntax Description filesystem File system where the billing record file is written. The filesys parameter has a maximum
length of 25 characters and must specify a valid file system on the router (such as slot0,
disk1, or flash).
Note
The system writes the billing records to this file system using a file name that contains
the hostname of the router followed by a timestamp when the record was written.

cpe-list-suppress (Optional) Eliminates the customer premises equipment (CPE) IP addresses from the
billing records to improve performance.
Note
If this option is not selected, a maximum of five CPE IP addresses are included in the
billing record for each cable modem.

flow-aggregate (Optional) Combines all information for an individual cable modem into one record.
Separate counters are maintained for upstream and downstream traffic, but those counters
include all service flows in that direction.

full-records (Optional) Provides information about full service flow (active and idle) records.

Command Default Usage-based billing is disabled. When usage-based billing is enabled, CPE IP addresses (a maximum of five)
are included in the billing records by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(9a)BC This command was introduced.

Note
In Cisco IOS Release 12.3(9a)BC, this command supports the monitoring of all service
flows for DOCSIS 1.0, 1.1, and 2.0 cable modems:
• • upstream and downstream
• primary
• secondary
• dynamic

Cisco CMTS Cable Command Reference

442
 Cable Commands: cable m to n
cable metering filesystem

Release Modification

12.2(33)SCD2 This command was modified to add the full-records keyword.

Note
In Cisco IOS Release 12.2(33)SCD2 and later releases, this command is also supported
on the DOCSIS 3.0 cable modems.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable metering filesystem command enables usage-based filling and configures it for file mode, where
the CMTS writes the billing records to the local file system. The system writes the billing record to the
filesystem specified by this command, using a file name that consists of the router’s hostname followed by a
timestamp for when the file was created.
When the CMTS writes a billing record, it can also optionally send an SNMPv3 trap to notify the billing
application that a billing record is available for pickup. The billing application can then log into the Cisco
CMTS and use the File Transfer Protocol (FTP) or Secure Copy (SCP) to pick up the file.

Note You can enable usage-based billing using either the cable metering filesystem or cable meteringdestination
command, but not both. If you give these commands twice, the second command overwrites the first.

If the CMTS cannot write the billing record to the local filesystem, and if metering traps have been enabled
using the snmp-server enable traps cable metering command, the CMTS sends an SNMP trap to the SNMP
manager describing the reason for the failure. Typically, the reason is either that the disk is full or that an disk
error occurred (such as no PCMCIA card in the slot).
To disable usage-based billing, use the no cable metering command. This immediately stops the collection
of billing information, except when the billing records are currently being written to the local file system. If
a billing operation is in progress when you give the no cable metering command, the system displays the
message “CMTS Metering in progress. Ignoring current config.” Wait until the billing operation is finished
and then reenter the no cable metering command.

Examples The following example shows how to enable usage-based billing, writing the records to a file on the
disk0: device.

U7246VXR# configure terminal

U7246VXR(config)# cable metering filesystem disk0:

U7246VXR(config)#

Note Do not use nvram as the file system. For example, do not use: Router(config)# cable metering
filesystem nvram:

The following example shows how to enable usage-based billing, writing the records to files on the
disk2 device on an NPE-G1 processor:

Cisco CMTS Cable Command Reference

443
 Cable Commands: cable m to n
cable metering filesystem

Router# configure terminal

Router(config)# cable metering filesystem disk2:

Router(config)#

The following example shows how to enable usage-based billing, writing the records to files in Flash
Memory. The IP addresses for the CPE devices are not included in the billing records.

Router# configure terminal

Router(config)# cable metering filesystem flash: cpe-list-suppress

Router(config)#

The following example shows how to enable usage-based billing, writing the records to files in Flash
Memory, and enabling the full-records option:

Router# configure terminal

Router(config)# cable metering filesystem disk2:xyz full-records
Router#

Related Commands Command Description

cable metering destination Enables usage-based billing and streams the billing records to an external
server.

cable metering ipdr Enables usage-based billing using the IPDR and SP2.1 protocol.

cable metering ipdr-d3 Enables usage-based billing on DOCSIS 3.0 cable modems.

cable metering source-interface Enables debugging of usage-based billing operations.

show cable metering-status Displays information about the most recent usage-based billing operation.

snmp-server enable traps cable Enables the sending of Simple Network Management Protocol (SNMP)
traps for cable-related events.

Cisco CMTS Cable Command Reference

444
 Cable Commands: cable m to n
cable metering ipdr

cable metering ipdr

To configure the Subscriber Account Management Interface Specification (SAMIS) and enable usage-based
billing on DOCSIS 2.0 cable modems, use the cable metering ipdr command in global configuration mode.
To disable usage-based billing, use the no form of this command.

cable metering ipdr interval session session-id [flow-aggregate] [full-records]

no cable metering

Cisco cBR Series Converged Broadband Routers

cable metering ipdr interval session session-id {full-records}

Syntax Description interval Specifies the Metering data streaming interval in minutes. The interval is the time between
the completion of one export and the beginning of another. The range is from 2 to 1440
(24 hours).

session session IP Detail Records (IPDR) session ID. The session ID range is from 1 to 255.
id

flow-aggregate (Optional) Combines all information for an individual cable modem into one record.
Separate counters are maintained for upstream and downstream traffic, but those counters
include all service flows in that direction. (For Cisco uBR10012 Router and Cisco uBR7200
Series Routers)

full-records (Optional) Provides information about full service flow (active and idle) records. (For
Cisco uBR10012 Router and Cisco uBR7200 Series Routers)

Command Default Usage-based billing is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCA This command was introduced.

Note
In Cisco IOS Release 12.2(33)SCA, this command is supported on DOCSIS 1.0, DOCSIS
1.1, and DOCSIS 2.0 cable modems.

12.2(33)SCD2 The command was modified to include the full-records keyword.

Note
In Cisco IOS Release 12.2(33)SCD2 and later releases, this command is also supported
on DOCSIS 3.0 cable modems.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S The flow-aggregate keyword was removed.

Cisco CMTS Cable Command Reference

445
 Cable Commands: cable m to n
cable metering ipdr

Usage Guidelines The cable metering ipdr command configures how SAMIS data is exported. This command is used for
DOCSIS 2.0 SAMIS schema.
When flow-aggregate is enabled, the service flows are combined into one record per cable modem:
• ServiceClassName element always returns a null value in IPDR records, even when service flows on the
cable modem have a valid service class name.
• ServiceIdentifier element always returns a zero value.

Examples The following example shows how to enable usage-based billing for IPDR, with the billing record
interval set to every 60 minutes with full-records and flow-aggregate options enabled:

Router# configure terminal

Router(config)# cable metering ipdr 60 session 111 full-records flow-aggregate
Router(config)#

Related Commands Command Description

cable metering destination Enables usage-based billing, and streams the billing records to an external
server.

cable metering filesystem Enables usage-based billing and writes the billing records to a file on a
local file system.

cable metering source-interface Enables debugging of usage-based billing operations.

show cable metering-status Displays information about the most recent usage-based billing operation.

snmp-server enable traps cable Ensure that the Simple Network Management Protocol (SNMP) traps are
sent for cable-related events.

Cisco CMTS Cable Command Reference

446
 Cable Commands: cable m to n
cable metering ipdr-d3

cable metering ipdr-d3

To configure the Subscriber Account Management Interface Specification (SAMIS) and enable usage-based
billing on DOCSIS 3.0 cable modems, use the cable metering ipdr-d3 command in global configuration
mode. To disable usage-based billing, use the no form of this command.

cable metering ipdr-d3 session session-id type type [flow-aggregate] [full-records]

no cable metering

Syntax Description session session Specifies the IPDR session ID. The range is from 1 to 255.
id

type type Specifies the IPDR DOCSIS 3.0 service definition type of metering. The range is from 1
to 2.

flow-aggregate (Optional) Combines all information for an individual cable modem into one record.
Separate counters are maintained for upstream and downstream traffic, but those counters
include all service flows in that direction. (For Cisco uBR10012 Router and Cisco uBR7200
Series Routers)

full-records (Optional) Provides information about full service flow (active and idle) records. (For
Cisco uBR10012 Router and Cisco uBR7200 Series Routers)

Command Default Usage-based billing is disabled, by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable metering ipdr-d3 command configures how the SAMIS data is exported. This command is used
for DOCSIS 3.0 SAMIS schema (including type 1 and type 2).
When flow-aggregate is enabled, the service flows are combined into one record per cable modem:
• ServiceClassName element always returns a null value in IPDR records, even when service flows on the
cable modem have a valid service class name.
• ServiceIdentifier element always returns a zero value.

Examples The following example shows how to enable usage-based billing for IPDR DOCSIS 3.0, with
full-records and flow-aggregate options enabled:

Router# configure terminal

Router(config)# cable metering ipdr-d3 session 111 type 2 full-records flow-aggregate
Router(config)#

Cisco CMTS Cable Command Reference

447
 Cable Commands: cable m to n
cable metering ipdr-d3

Related Commands Command Description

cable metering destination Enables usage-based billing, and streams the billing records to an
external server.

cable metering filesystem Enables usage-based billing and writes the billing records to a file
on a local file system.

cable metering source-interface Enables debugging of usage-based billing operations.

cable sflog max-entry Enables service flow logging and configuring the number and
duration of entries in the log.

show cable metering-status Displays information about the most recent usage-based billing
operation.

snmp-server enable traps cable Ensures that Simple Network Management Protocol (SNMP) traps
metering are sent for cable-related events.

Cisco CMTS Cable Command Reference

448
 Cable Commands: cable m to n
cable metering localtime

cable metering localtime

To provide usage records with local time timestamping, use cable metering localtime command in global
configuration mode.

cable metering localtime

Syntax Description This command has no arguments or keywords.

Command Default This command is not configured by default.

Command Modes
Global configuration(config)

Command History Release Modification

12.2(33)SCI2 This command was introduced.

Usage Guidelines When the cable metering localtime command is configured, the timestamp in metering output is local time,
e.g. "2015-03-03T16:26:07", otherwise it's the UTC time, e.g. "2015-03-03T16:26:07Z" (with a "Z" indicating
that the time is UTC/GMT).

Examples The following example configures usage records with local time timestamping:

Router(config)#cable metering localtime

Router(config)#

Related Commands Command Description

cable metering destination Enables usage-based billing and streams the billing external server.

cable metering ipdr Enables usage-based billing using the IPDR and SP2.1 protocol.

cable metering ipdr-d3 Enables usage-based billing on DOCSIS 3.0 cable modems.

cable metering source-interface Enables debugging of usage-based billing operations.

show cable metering-status Displays information about the most recent usage-based billing operation.

cable metering file-system Enables usage-based billing and writes the billing records to a file on a
local file system.

Cisco CMTS Cable Command Reference

449
 Cable Commands: cable m to n
cable metering source-interface

cable metering source-interface

To enable specification of the source-interface for the billing packets, use the cable metering source-interface
command in privileged EXEC mode. To turn off the specified source-interface, use the no form of this
command.

cable metering source-interface interface

no cable metering source-interface interface

Syntax Description interface Specifies the source of the usage-based billing packets originated by the router using the cable
metering source-interface command. This is often used to set the source-interface as the IP address
of the loopback interface.

Command Default Usage billing is disabled. When enabled, CPE IP addresses (a maximum of five per cable modem) are included
in the billing records by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable metering source-interface command enables the user to specify the source-interface of the
usage-based billing packets. All billing packets are usually automatically assigned a source-interface, but
users using the cable metering source-interface command can set the source-interface to be the IP address
of the loopback interface.
If the user does not specify the source-interface configuration, SAMIS picks the highest IP address of the
loopback interface as the source interface. If the loopback interface is not available, then SAMIS selects the
highest IP of the physical interface for source interface.

Note If a loopback interface is specified, the MAC address is that of the management interface in the docID in the
billing packet.

Note The option of specifying the source-interface for metering is available only after the metering mode is
configured.

If the cable metering source-interface command is used when the Usage-Based Billing feature is operating
in the File Mode, the CMTS IP address in the billing packets are changed to the IP address of the
source-interface specified using the cable metering source-interface command or through setting the

Cisco CMTS Cable Command Reference

450
 Cable Commands: cable m to n
cable metering source-interface

ccmtrCollectionSrcIfIndex object. The MAC address in the billing packets' header is also changed to the
MAC address of the source-interface.
If the cable metering source-interface command is used when the Usage-Based Billing feature is operating
in the Streaming Mode, the CMTS IP address in the billing packets, as well as the source IP address of the
billing packets, are changed to the IP address of the source-interface specified using the cable metering
source-interface command or through setting the ccmtrCollectionSrcIfIndex object. The MAC address in
the billing packets' header is also changed to the MAC address of the source-interface.
When defining the source-interface, the following possible error checks can be performed to determine if the
source-interface that the user has defined is a valid source-interface for metering:
1. Verify that the interface specified is up and has an IP address.
2. Verify that the IP address is in the same subnet/majornet as that of the destination address.

Note Even after performing these error checks, there are no guarantees that the billing packets will be sent out since
the TCP connection may not succeed due to the absence of a physical connection between the CMTS and the
collection server.

Examples The following is an example where the source-interface specified was a loopback interface and it
had a mac-address of 000C31F6F400 and an ip address of 1.100.100.100.

Router# configure terminal

Router(config)# cable metering source-interface loopback 1.100.100.100

<?xmlversion="1.0"encoding="UTF8"?><IPDRDocxmlns="http://www.ipdr.org/namespaces/ipdr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="DOCSIS-3.5-A.0.xsd"
docId="C7B1B20E-0000-0000-0000-000C31F6F400" creationTime="2006-03-02T18:03:58Z"
IPDRRecorderInfo="VXR3" version="3.5-A.0"><IPDR
xsi:type="DOCSIS-Type"><IPDRcreationTime>2006-03-02T18:03:58Z</IPDRcreationTime><CMTShostname>VXR3</CMTShostname><CMTSipAddress>1.100.100.100</CMTSipAddress><CMTSsysUpTime>185867

<
/
C
M
TS
s
y
sU
p
T
i
me
>
<
CM
T
S
c
at
v
I
fN
a
m
e
>C
a
b
le
4
/
0
</
C
M
TS
c
a
t
vI
f
N
am
e
>
<
CM
T
S
ca
t
v
I
fI
n
d
ex
>
1
6
</
C
M
TS
c
a
t
vI
f
I
nd
e
x
>
<C
M
T
Su
p
I
f
Na
m
e
>C
a
4
/
0-
u
p
st
r
e
a
m0
<
/
CM
T
S
u
pI
f
N
am
e
>
<
CM
T
S
up
I
f
T
yp
e
>
12
9
<
/
CM
T
S
up
I
f
T
yp
e
>
<C
M
T
S
do
w
n
If
N
a
m
e>
C
a
4/
0
-
d
ow
n
s
tr
e
a
m
</
C
M
TS
d
o
w
nI
f
N
am
e
>
<
CM
m
a
cA
dr
e
s>
0-
0
7
-
0E
-
0
7-
0
B
-
0D
<
/
CM
m
a
c
Adr
e
s>
<
C
M
ip
A
dr
e
s>
1.
1.
0
.
2
</
C
M
ip
A
dr
e
s>
<
C
M
do
c
s
is
M
o
d
e>
1
.
0<
/
C
M
do
c
s
is
M
o
d
e>
<
R
ec
t
y
p
e>
1
<
/R
e
c
t
yp
e
>
<s
e
r
v
ic
e
I
de
n
t
i
fi
e
r
>0
<
/
s
er
v
i
ce
I
d
e
nt
i
f
ie
r
>
<
se
r
v
ic
e
C
l
asN
a
m
e
><
/
s
er
v
i
c
eC
l
a
sN
a
m
e>
<
s
e
rv
i
c
eD
i
r
e
ct
i
o
n>
1
<
/
se
r
v
ic
e
D
i
re
c
t
io
n
>
<
se
r
v
ic
e
O
c
te
t
s
Pa
se
d
>
6
25
<
/s
e
r
v
ic
e
O
ct
e
t
s
Pa
se
d
>
<
se
r
v
ic
e
P
k
ts
P
a
se
d
>
21
<
/
s
er
v
i
ce
P
k
t
sP
a
se
d
>
<
se
r
v
ic
e
S
l
aD
r
o
pP
k
t
s
>0
<
/
se
r
v
i
ce
S
l
aD
r
o
p
Pk
t
s
><
s
e
r
vi
c
e
Sl
a
D
e
la
y
P
kt
s
>
1
</
s
e
rv
i
c
e
Sl
a
D
el
a
y
P
kt
s
>
<s
e
r
v
ic
e
T
im
e
C
r
ea
t
e
d>
0
<
/
se
r
v
ic
e
T
i
me
C
r
ea
t
e
d
><
s
e
rv
i
c
e
Ti
m
e
Ac
t
i
v
e>
0
<
/s
e
r
v
ic
e
T
im
e
A
c
ti
v
e
><
/
I
P
DR
>
<
IP
D
R

xsi:type="DOCSIS-Type"><IPDRcreationTime>2006-03-02T18:03:58Z</IPDRcreationTime><CMTShostname>VXR3</CMTShostname><CMTSipAddress>1.100.100.100</CMTSipAddress><CMTSsysUpTime>185867

<
/
C
M
TS
s
y
sU
p
T
i
me
>
<
CM
T
S
c
at
v
I
fN
a
m
e
>C
a
b
le
4
/
0
</
C
M
TS
c
a
t
vI
f
N
am
e
>
<
CM
T
S
ca
t
v
I
fI
n
d
ex
>
1
6
</
C
M
TS
c
a
t
vI
f
I
nd
e
x
>
<C
M
T
Su
p
I
f
Na
m
e
>C
a
4
/
0-
u
p
st
r
e
a
m0
<
/
CM
T
S
u
pI
f
N
am
e
>
<
CM
T
S
up
I
f
T
yp
e
>
12
9
<
/
CM
T
S
up
I
f
T
yp
e
>
<C
M
T
S
do
w
n
If
N
a
m
e>
C
a
4/
0
-
d
ow
n
s
tr
e
a
m
</
C
M
TS
d
o
w
nI
f
N
am
e
>
<
CM
m
a
cA
dr
e
s>
0-
0
7
-
0E
-
0
7-
0
B
-
0D
<
/
CM
m
a
c
Adr
e
s>
<
C
M
ip
A
dr
e
s>
1.
1.
0
.
2
</
C
M
ip
A
dr
e
s>
<
C
M
do
c
s
is
M
o
d
e>
1
.
0<
/
C
M
do
c
s
is
M
o
d
e>
<
R
ec
t
y
p
e>
1
<
/R
e
c
t
yp
e
>
<s
e
r
v
ic
e
I
de
n
t
i
fi
e
r
>0
<
/
s
er
v
i
ce
I
d
e
nt
i
f
ie
r
>
<
se
r
v
ic
e
C
l
asN
a
m
e
><
/
s
er
v
i
c
eC
l
a
sN
a
m
e>
<
s
e
rv
i
c
eD
i
r
e
ct
i
o
n>
2
<
/
se
r
v
ic
e
D
i
re
c
t
io
n
>
<
se
r
v
ic
e
O
c
te
t
s
Pa
se
d
>
1
23
0<
/
s
e
rv
i
c
eO
c
t
e
ts
P
a
se
d
>
<s
e
r
v
ic
e
P
kt
s
P
a
se
d
>2
9
<
/
se
r
v
ic
e
P
k
ts
P
a
se
d
>
<s
e
r
v
ic
e
S
la
D
r
o
pP
k
t
s>
0
<
/
se
r
v
ic
e
S
l
aD
r
o
pP
k
t
s
><
s
e
rv
i
c
e
Sl
a
D
el
a
y
P
kt
s
>
13
<
/
s
er
v
i
ce
S
l
a
De
l
a
yP
k
t
s
><
s
e
rv
i
c
e
Ti
m
e
Cr
e
a
t
ed
>
0
</
s
e
r
vi
c
e
Ti
m
e
C
re
a
t
ed
>
<
s
er
v
i
ce
T
i
m
eA
c
t
iv
e
>
0
</
s
e
rv
i
c
e
Ti
m
e
Ac
t
i
v
e>
<
/
IP
D
R
>
<I
P
D
RD
o
c
.
En
d
count="2" endTime="2006-03-02T18:03:59Z"/></IPDRDoc>
Router(config)#

The following is an example where the source-interface specified was a loopback interface and it
had a mac-address of 00027D67DC0 and an ip address of 2.90.100.100.

Router# configure terminal

Router(config)# cable metering source-interface loopback 2.90.100.10

Accept 2.90.100.100:42380
<?xmlversion="1.0"encoding="UTF8"?><IPDRDocxmlns="http://www.ipdr.org/namespaces/ipdr"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="DOCSIS-3.5-A.0.xsd"
docId="C7B701D1-0000-0000-0000-00027D67DC00" creationTime="2006-03-06T18:45:37Z"
IPDRRecorderInfo="ubr7246-R7427" version="3.5-A.0"><IPDR
xsi:type="DOCSIS-Type"><IPDRcreationTime>2006-03-06T18:45:37Z</IPDRcreationTime><CMTShostname>ubr7246-R7427</CMTShostname><CMTSipAddress>2.90.100.100</CMTSipAddress><CMTSsysUpTime>372172

<
/
C
M
TS
s
y
sU
p
T
i
me
>
<
CM
T
S
c
at
v
I
fN
a
m
e
>C
a
b
le
3
/
0
</
C
M
TS
c
a
t
vI
f
N
am
e
>
<
CM
T
S
ca
t
v
I
fI
n
d
ex
>
5
<
/C
M
T
Sc
a
t
v
If
I
n
de
x
>
<
CM
T
S
up
I
f
N
am
e
>
Ca
3
/
0
-u
p
s
tr
e
a
m
0<
/
C
MT
S
u
p
If
N
a
me
>
<
C
MT
S
u
pI
f
T
y
pe
>
1
29
<
/
C
MT
S
u
pI
f
T
y
pe
>
<
CM
T
S
d
ow
n
I
fN
a
m
e
>C
a
3
/0
-
d
o
wn
s
t
re
a
m
<
/C
M
T
Sd
o
w
n
If
N
a
me
>
<
C
Mm
a
c
Adr
e
s>
0-
5
0
-
04
-
F
9-
E
F
-
8<
/
CM
m
a
c
Adr
e
s>
<
C
M
ip
A
dr
e
s>
1.
4
0
.
1.
2
<
/C
M
i
p
Adr
e
s>
<
C
M
do
c
s
is
M
o
d
e>
1
.
0<
/
C
M
do
c
s
is
M
o
d
e>
<
R
ec
t
y
p
e>
1
<
/R
e
c
t
yp
e
>
<s
e
r
v
ic
e
I
de
n
t
i
fi
e
r
>3
<
/
s
er
v
i
ce
I
d
e
nt
i
f
ie
r
>
<
se
r
v
ic
e
C
l
asN
a
m
e
><
/
s
er
v
i
c
eC
l
a
sN
a
m
e>
<
s
e
rv
i
c
eD
i
r
e
ct
i
o
n>
2
<
/
se
r
v
ic
e
D
i
re
c
t
io
n
>
<
se
r
v
ic
e
O
c
te
t
s
Pa
se
d
>
28
3
9
2<
/
s
e
rv
i
c
eO
c
t
e
ts
P
a
se
d
>
<s
e
r
v
ic
e
P
kt
s
P
a
se
d
>21
6
<
/
se
r
v
ic
e
P
k
ts
P
a
se
d
>
<s
e
r
v
ic
e
S
la
D
r
o
pP
k
t
s>
0
<
/
se
r
v
ic
e
S
l
aD
r
o
pP
k
t
s
><
s
e
rv
i
c
e
Sl
a
D
el
a
y
P
kt
s
>
0<
/
s
e
rv
i
c
eS
l
a
D
el
a
y
Pk
t
s
>
<s
e
r
vi
c
e
T
im
e
C
re
a
t
e
d>
6
5
0<
/
s
er
v
i
c
eT
i
m
eC
r
e
a
te
d
>
<s
e
r
v
ic
e
T
im
e
A
c
ti
v
e
>3
6
4
8
</
s
e
rv
i
c
e
Ti
m
e
Ac
t
i
v
e>
<
/
IP
D
R
>
<I
P
D
R

xsi:type="DOCSIS-Type"><IPDRcreationTime>2006-03-06T18:45:37Z</IPDRcreationTime><CMTShostname>ubr7246-R7427</CMTShostname><CMTSipAddress>2.90.100.100</CMTSipAddress><CMTSsysUpTime>372172

Cisco CMTS Cable Command Reference

451
 Cable Commands: cable m to n
cable metering source-interface

<
/
C
M
TS
s
y
sU
p
T
i
me
>
<
CM
T
S
c
at
v
I
fN
a
m
e
>C
a
b
le
3
/
0
</
C
M
TS
c
a
t
vI
f
N
am
e
>
<
CM
T
S
ca
t
v
I
fI
n
d
ex
>
5
<
/C
M
T
Sc
a
t
v
If
I
n
de
x
>
<
CM
T
S
up
I
f
N
am
e
>
Ca
3
/
0
-u
p
s
tr
e
a
m
0<
/
C
MT
S
u
p
If
N
a
me
>
<
C
MT
S
u
pI
f
T
y
pe
>
1
29
<
/
C
MT
S
u
pI
f
T
y
pe
>
<
CM
T
S
d
ow
n
I
fN
a
m
e
>C
a
3
/0
-
d
o
wn
s
t
re
a
m
<
/C
M
T
Sd
o
w
n
If
N
a
me
>
<
C
Mm
a
c
Adr
e
s>
0-
5
0
-
04
-
F
9-
E
F
-
8<
/
CM
m
a
c
Adr
e
s>
<
C
M
ip
A
dr
e
s>
1.
4
0
.
1.
2
<
/C
M
i
p
Adr
e
s>
<
C
M
do
c
s
is
M
o
d
e>
1
.
0<
/
C
M
do
c
s
is
M
o
d
e>
<
R
ec
t
y
p
e>
1
<
/R
e
c
t
yp
e
>
<s
e
r
v
ic
e
I
de
n
t
i
fi
e
r
>4
<
/
s
er
v
i
ce
I
d
e
nt
i
f
ie
r
>
<
se
r
v
ic
e
C
l
asN
a
m
e
><
/
s
er
v
i
c
eC
l
a
sN
a
m
e>
<
s
e
rv
i
c
eD
i
r
e
ct
i
o
n>
1
<
/
se
r
v
ic
e
D
i
re
c
t
io
n
>
<
se
r
v
ic
e
O
c
te
t
s
Pa
se
d
>
2
01
3
4<
/
s
e
rv
i
c
eO
c
t
e
ts
P
a
se
d
>
<s
e
r
v
ic
e
P
kt
s
P
a
se
d
>2
1
9
7
</
s
e
rv
i
c
e
Pk
t
s
Pa
se
d
>
<
se
r
v
ic
e
S
l
aD
r
o
pP
k
t
s
>0
<
/
se
r
v
i
ce
S
l
aD
r
o
p
Pk
t
s
><
s
e
r
vi
c
e
Sl
a
D
e
la
y
P
kt
s
>
0
</
s
e
rv
i
c
e
Sl
a
D
el
a
y
P
kt
s
>
<s
e
r
v
ic
e
T
im
e
C
r
ea
t
e
d>
6
5
0<
/
s
er
v
i
c
eT
i
m
eC
r
e
a
te
d
>
<s
e
r
v
ic
e
T
im
e
A
c
ti
v
e
>3
6
4
8
</
s
e
rv
i
c
e
Ti
m
e
Ac
t
i
v
e>
<
/
IP
D
R
>
<I
P
D
RD
o
c
.
En
d
count="2" endTime="2006-03-06T18:45:37Z"/></IPDRDoc>
Closing socket 2.90.100.100:42380
Router(config)#

Related Commands Command Description

cable metering source-interface Enables usage-based billing and streams the billing records to an external
server.

cable metering filesystem Enables usage-based billing and writes the billing records to a file on a
local file system.

debug cable remote-query Turns on debugging to gather information from remote CMs.

show cable metering-status Displays information about the most recent usage-based billing operation.

snmp-server enable traps cable Enables the sending of Simple Network Management Protocol (SNMP)
traps for cable-related events.

Cisco CMTS Cable Command Reference

452
 Cable Commands: cable m to n
cable modem access-group

cable modem access-group

To configure the access-group for a CM, use the cable modem access-group command in privileged EXEC
mode. To disable the specification, use the no access-group form of this command.

cable modem {mac-addrip-addr} access-group [access-listaccess-name]

cable modem {mac-addrip-addr} no access-group

Note The cable modem access-group command is not supported on the Cisco uBR10012 universal broadband
router.

Syntax Description ip-addr Specifies the IP address for the CM.

mac-address Specifies the MAC address for the CM.

access-list Specifies the IP access list (standard or extended). The range is from 1 to 199.

access-name Specifies the access-list name.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

11.3(8) NA This command was introduced.

12.2(4)BC1 The functionality of this command was made identical to that of the cable host
access-group command, but both commands were retained for backwards compatibility.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows the cable modem access-group command assigning access-list 1 to
the CM with the MAC address of abcd.ef01.2345:

Router# cable modem abcd.ef01.2345 access-group 1

Router#

Related Commands Command Description

cable host access-group Configures the access list for a host.

cable modem change-frequency Changes the downstream frequency or upstream channel ID.

Cisco CMTS Cable Command Reference

453
 Cable Commands: cable m to n
cable modem access-group

Command Description

cable modem max-hosts Specifies the maximum hosts for a CM.

cable modem qos profile Specifies the QoS profile for a CM.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

454
 Cable Commands: cable m to n
cable modem change-frequency

cable modem change-frequency

To override the frequency used by a CM, use the cable modem change-frequency command in privileged
EXEC mode.

cable modem {mac-addrip-addr} change-frequency {ds-frequency-hz [us-channel-id]us-channel-id}

Syntax Description ip-addr Specifies the IP address for the CM.

mac-address Specifies the MAC address for the CM.

ds-frequency-hz Specifies the downstream frequency for the CM (in Hertz).

us-channel-id Specifies the upstream channel ID.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the CMTS administrator to change the downstream frequency for a CM, overriding
the DOCSIS configuration file setting. This command is not applicable on Cisco IOS Release 12.1(3a)EC.

Examples The following example shows how to change the downstream frequency of the CM having IP address
172.172.172.12 to 570 MHz:

Router# cable modem 172.172.172.12 change-freq 57000000

Router#

Related Commands Command Description

cable modem access-group Specifies an access group for a CM.

cable modem max-hosts Specifies the maximum hosts for a CM.

cable modem qos profile Specifies the QoS profile for a CM.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

455
 Cable Commands: cable m to n
cable modem max-cpe

cable modem max-cpe

To specify a maximum number of permitted hosts per modem (overriding the max-cpe value in the CM
configuration file), use the cable modem max-cpe command in global configuration mode.

cable modem max-cpe [n | unlimited]

Syntax Description n Specifies the configuration file value. The range is from 1 to 255.

unlimited Specifies the maximum CPE value to be unlimited.

Command Default The max-cpe value provided in the configuration file is used by the CMTS to limit the number of hosts
connected to a single CM (no cable modem max-cpe).

Command Modes
Global configuration (config)

Command History Release Modification

12.0(10)SC, 12.1(2)EC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines The CMTS enables up to n number of hosts for a modem.When set to unlimited, or n is greater than the
max-cpe value in the configuration file of a CM, the max-cpe value in the configuration file of the CM is
used.

Note When the the maximum number of CPEs, set by the cable modem max-cpe command in the Cisco CMTS,
is smaller than the maximum number of CPEs set in the configuration file of the CMs, the number set by the
cable modem max-cpe command overrides the number set in the configuration file of the CMs.

Note When setting to unlimited or n is greater than the max-cpe value in the configuration file of a CM, the CM
must control the maximum number of hosts, and the DHCP server must control the number of IP addresses
assigned to hosts behind a single CM.

Caution Use of this command might open a security hole in the system by enabling denial of service attacks. Specifically,
it might enable a user to obtain a large number of IP addresses, thereby taking down the entire network, after
all the available IP addresses have been reserved by this single user. Cisco recommends that, if this command
is enabled, the number of IP addresses assigned to hosts behind a single modem be strictly controlled by the
DHCP server.

Cisco CMTS Cable Command Reference

456
 Cable Commands: cable m to n
cable modem max-cpe

The Cisco CMTS uses three commands to set the maximum number of hosts for a particular CM, for all CMs
on a particular cable interface, or for all CMs using the Cisco CMTS router:
• cable modem max-hosts—Sets the maximum number of hosts for a particular CM.
• cable max-hosts—Sets the maximum number of hosts for all CMs on a particular cable interface.
• cable modem max-cpe—Sets the maximum number of hosts for all CMs using the Cisco CMTS router.
The more specific commands override the settings of the less specific commands. For example, if you use
the cable modem max-cpe command to set the maximum number of hosts to 2 for all CMs, you can still use
the cable modem max-hosts command to give a particular CM a larger maximum host value.

Note The CMTS assigns the MAX Host value to a cable modem at the time that the cable modem registers with
the CMTS. Changing any of the MAX Host commands affects only cable modems that register after the
change.

Note The “Number of CPEs” field in the show cable modem command shows the maximum CPE value for the
CM, not the value for the CMTS that is set by the cable modem max-cpe command.

Examples The following example shows how to override the max-cpe setting in a CM configuration file:

Router(config)# cable modem max-cpe unlimited

Related Commands Command Description

cable max-hosts Sets the maximum number of hosts for all CMs on a particular cable
interface.

cable modem access-group Specifies an access group for a CM.

cable modem change-frequency Changes the downstream frequency or upstream channel ID.

cable modem max-hosts Sets the maximum number of hosts for a particular CM.

cable modem qos profile Specifies the QoS profile for a CM.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

457
 Cable Commands: cable m to n
cable modem max-hosts

cable modem max-hosts

To specify the maximum number of customer premises equipment (CPE) devices (hosts) that can be supported
by a specific CM, use the cable modem max-hosts command in privileged EXEC mode.

cable modem {mac-addrip-addr} max-hosts {n | default}

Syntax Description ip-addr Specifies the IP address for the CM.

mac-address Specifies the MAC address for the CM.

max-hosts {n | default} Specifies either the maximum number of hosts supported by the CM (from 0 to
255), or specifies the default value of 0.

Command Default 0

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The Cisco CMTS uses three commands to set the maximum number of hosts for a particular CM, for all CMs
on a particular cable interface, or for all CMs using the Cisco CMTS router:
• cable modem max-hosts—Sets the maximum number of hosts for a particular CM.
• cable max-hosts—Sets the maximum number of hosts for all CMs on a particular cable interface.
• cable modem max-cpe—Sets the maximum number of hosts for all CMs using the Cisco CMTS router.
The more specific commands override the settings of the less specific commands. For example, if you use
the cable modem max-cpe command to set the maximum number of hosts to 2 for all CMs, you can still use
the cable modem max-hosts command to give a particular CM a larger maximum host value.

Note The CMTS assigns the MAX Host value to a cable modem at the time that the cable modem registers with
the CMTS. Changing any of the MAX Host commands affects only cable modems that register after the
change.

Examples The following example shows sets the CM with the IP address of 172.172.172.12 to a maximum of
40 attached CPE devices:

Router# cable modem 172.172.172.12 max-hosts 40

Cisco CMTS Cable Command Reference

458
 Cable Commands: cable m to n
cable modem max-hosts

Related Commands Command Description

cable modem access-group Specifies an access group for a CM.

cable modem change-frequency Changes the downstream frequency or upstream channel ID.

cable max-hosts Sets the maximum number of hosts for all CMs on a particular cable
interface.

cable modem max-cpe Sets the maximum number of hosts for all CMs using the Cisco CMTS
router.

cable modem qos profile Specifies the QoS profile for a CM.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

459
 Cable Commands: cable m to n
cable modem opt0

cable modem opt0

To collect Receive Modulation Error Ratio (RxMER) data from the cable modem on-demand, use the cable
modem opt0 command in privileged EXEC mode.

cable modem {mac-addrip-addr} opt0

Syntax Description ip-addr IP address for the CM.

mac-address address for the CM.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.18.1SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the cable modem opt0 command to collect RxMER data from the CM. Based on the RxMER values
collected from a modem, the CMTS finds among the existing profiles the one that may provide the highest
speed, and yet at the same time may have sufficient Signal to Noise Ratio (SNR) margin for the modem to
receive code words with acceptable error.

Examples The following example shows how to collect RxMER data from the CM:

Router# cable modem fc52.8d5e.84e1 opt0

Router#

Cisco CMTS Cable Command Reference

460
 Cable Commands: cable m to n
cable modem qos profile

cable modem qos profile

To force a DOCSIS 1.0 CM to use a specific quality-of-service (QoS) profile, use the cable modem qos
profile command in privileged EXEC mode.

cable modem {mac-addrip-addr} qos profile qos-profile-index [no-persistence]

Syntax Description ip-addr IP address for the CM.

mac-address address for the CM.

qos-profile-index QoS profile index values.

The range is from 1 to 255, with no default. In Cisco IOS Release 12.2(15)BC1 and later
releases, this profile must be created on the Cisco CMTS using the cable qos profile
command. In addition, this profile should specify a maximum upstream bandwidth equal
to or less than the current bandwidth. If the new profile specifies a higher bandwidth, it
is ignored, and the cable modem continues to use the bandwidth that was specified at
registration time.
The range is from 1 to 1023 on the Cisco cBR series routers.

no-persistence (Optional) Specifies that the QoS profile should not remain in force when a cable modem
reboots. Instead, when a cable modem reboots, it uses the QoS profile specified in its
DOCSIS configuration file.
The default is without this option, so that the QoS profile remains in force for cable
modems across reboots.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.0(4)XI This command was introduced.

12.1(11)EC This command was supported on Cisco IOS Release 12.1 EC.

12.2(8)BC1 This command was enhanced to allow a DOCSIS 1.1 CMTS to temporarily change the
QoS profile for DOCSIS 1.0 and 1.0+ CMs.

12.2(15)BC1 This command was changed so that it does not have any effect unless both the QoS profile
specified by this command and the QoS profile specified for the CM in its DOCSIS
configuration file are already created on the Cisco CMTS. This restriction did not exist in
previous releases.

12.2(15)BC2 The no-persistence option was added. Also, the restriction on changing CM-created
profiles that was implemented in Cisco IOS Release 12.2(15)BC1 was removed, so that
this command can again be used to change the profile of a CM that is using a CM-created
profile, as was the case in earlier releases.

Cisco CMTS Cable Command Reference

461
 Cable Commands: cable m to n
cable modem qos profile

Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines On a Cisco CMTS running DOCSIS 1.0 software, the cable modem qos profile command forces a CM to
use a specific QoS profile.
On a Cisco CMTS running DOCSIS 1.1 software, the cable modem qos profile command temporarily forces
a DOCSIS 1.0 or DOCSIS 1.0+ CM to use a specific QoS profile, without forcing the CM to first go off-line
and re-register. For DOCSIS 1.0+ CMs, this command affects only the primary SID on the CM.

Note In Cisco IOS Release 12.2(15)BC1, this command has an effect only when the profile that it specifies and the
original QoS profile on the CM have been created already on the Cisco CMTS, using the cable qos profile
command. In Cisco IOS Release 12.2(15)BC2 and later releases, this restriction is removed and this command
can also be used to change the profile for a CM even when it is using a CM-created QoS profile.

This command does not affect DOCSIS 1.1 CMs, which support dynamic service change messages that allow
the QoS profile to be changed dynamically.

Note This command acts as a toggle. Give the cable modem qos profile command once to enforce a QoS profile.
Give the same command again with the same parameters to cancel the enforcement of that profile (the CM
will return to using its registered profile.)

When the no-persistence option is specified, the QoS profile is not applied when a cable modem reboots.
Instead, the Cisco CMTS allows the cable modem to use the QoS profile that is specified in its DOCSIS
configuration file.
The no-persistence option can be used when initially when identifying potential problem applications and
users. When repeat offenders are identified, the service provider can remove the no-persistence option, so
that these users continue to use the specified QoS profile even if they reboot their cable modems.

Examples The following example shows how to specify a QoS profile index to a CM:

Router# cable modem qos profile 255

Router#

Related Commands Command Description

cable modem access-group Specifies an access group for a CM.

cable modem change-frequency Changes the downstream frequency or upstream channel ID.

cable modem max-hosts Specifies the maximum hosts for a CM.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

462
 Cable Commands: cable m to n
cable modem remote-query

cable modem remote-query

To enable and configure the remote query feature to gather cable modem performance statistics on the Cisco
CMTS router, use the cable modem remote-query command in global configuration mode. To disable the
gathering of cable modem statistics, use the no form of this command.

cable modem remote-query [polling-interval community-string] [src-ip ip-address]

no cable modem remote-query [src-ip ip-address]

Syntax Description polling-interval (Optional) The delay between each poll that the Cisco CMTS router makes to collect cable
modem statistics, in seconds. When the Cisco CMTS router completes one remote query
poll, the router waits this time period before beginning another poll. The range is from 1
to 86,400. The recommended default value is 30.

community-string (Optional) The Simple Network Management Protocol (SNMP) community string.
Note
If resetting a configured SNMP community string value, first disable the remote query
feature with the no form of this command, then set the new community string using the
cable modem remote-query command when the polling delays is timed out.

src-ip ip-address (Optional) Specifies the source IP address for SNMP requests.
Note
You should enable the remote query feature before configuring src-ip option.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.0(7)XR, 12.1(2)T This command was introduced.

12.1(2)EC1 Support for this command was added to the 12.1 EC train.
Note
This command is not supported on Cisco IOS Release 12.1(3a)EC1 but is
supported on Cisco IOS Release 12.1(4)EC and later 12.1 EC releases.

12.2(4)BC1b Support for this command was added to the 12.2 BC train.

12.2(15)BC1, 12.2(15)CX The sysDescr field is now obtained for each cable modem when the remote query
feature is enabled. (This value can be displayed using the verbose option of the
show cable modem command.

12.3(23)BC Support for the scr-ip option was added to this release.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Cisco CMTS Cable Command Reference

463
 Cable Commands: cable m to n
cable modem remote-query

Usage Guidelines To use the remote query feature, you must configure the cable modem and Cisco CMTS as follows:
• Configure a read-only SNMP community string on the cable modem for use with the remote query
feature. This should be a separate community string from the read-write string used to remotely monitor
and configure the cable modem.
• Configure a matching community string on the Cisco CMTS using the snmp-server community
community-string and snmp-server manager commands.
• Enable the remote query feature on the Cisco CMTS with the cable modem remote-query command.
The polling-interval should be chosen so that the statistics can be obtained in a timely manner without
seriously impacting system performance. Cisco recommends initially setting the polling-interval to 30
seconds and adjusting that time period as needed.

Note If the remote query feature is enabled, the Cisco CMTS router consumes extra memory per cable modem and
takes additional CPU time. We recommend that you do not configure this feature on routers that have lower
free memory or a large number of cable modems.

The polling-interval time period determines only how long the Cisco CMTS router waits after completing
one polling cycle before beginning a new polling cycle. It does not indicate how long the router spends in
each polling cycle, which depends on the number of cable modems being polled. To calculate the approximate
time for a polling cycle, assume 4 to 5 CMs per second (100 to 200 milliseconds per CM). Also take into
account the possibility that one or more cable modems might not respond, with an approximate timeout period
of 90 seconds.
You must specify matching community strings for the cable modem, the snmp-server community
community-string command, and the cable modem remote-query command.
You can reissue the cable modem remote-query command to change the polling interval at any time, and
the change becomes effective immediately. However, to change the SNMP community string, you must first
disable remote polling with the no snmp manager and no cable modem remote-query commands. Then
reconfigure the new community string with the snmp-server community community-string, snmp-server
manager, and cable modem remote-query commands.
You must configure the remote query feature before configuring the scr-ip option.

Tip After enabling the remote query feature, you can display the collected statistics with the show cable modem
remote-query command. You can also display these statistics by querying the attributes in the
CISCO-DOCS-REMOTE-QUERY-MIB .

Resetting the Community String for Cable Modem Remote Query

In Cisco IOS Release 12.3BC and later releases, if you wish to reconfigure the SNMP community string for
the cable modem remote query feature, perform these brief steps.
1. Disable the remote query feature with the no form of this command.
2. Reset the timers on the Cisco CMTS router with short timeout values for the polling interval, so that
timeout commences quickly. Use the cable modem remote-query command in privileged EXEC mode,
using a very low value for the polling interval value.
3. Once time-outs are applied, reset the community string value with the cable modem remote-query
command.

Cisco CMTS Cable Command Reference

464
 Cable Commands: cable m to n
cable modem remote-query

4. Change the polling interval timers on the Cisco CMTS router back to preferred levels using the cable
modem remote-query command in privileged EXEC mode.

Examples The following example illustrates how to set the polling interval to 5 seconds and the SNMP
community string to private:

Router# configure terminal

Router(config)# cable modem remote-query 5 private

Router(config)# snmp-server community private

Router(config)# snmp-server manager

The following example demonstrates how to change the remote query configuration, by first deleting
the existing configuration and then giving the new configuration:

Router# configure terminal

Router(config)# no cable modem remote-query

Router(config)# no snmp-server manager

Router(config)# cable modem remote-query 10 public

Router(config)# snmp-server community public

Router(config)# snmp-server manager

Related Commands Command Description

debug cable remote-query Turns on debugging to gather information from remote CMs.

show cable modem Displays information for the registered and unregistered CMs.

show cable modem phy Displays DOCSIS PHY layer information for one or more CMs.

show cable modem remote-query Displays the statistics accumulated by the remote query feature.

snmp-server enable traps cable Enables traps that are sent when the remote polling of CMs has been
completed.

Cisco CMTS Cable Command Reference

465
 Cable Commands: cable m to n
cable modem service-class-name

cable modem service-class-name

To change a QoS service class for a particular cable modem (CM), use the cable modem service-class-name
command in privileged EXEC mode.

cable modem {ip-addressmac-address} service-class-name name

Syntax Description ip-address Specifies the IP address of the CM to be assigned the named service class.

mac-address Specifies the MAC address of the CM to be assigned the named service class.

name Specifies the name of the QoS service class.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command has the following restrictions:

• The no form of the command is not supported, as the CMTS does not cache the service class parameters
of the modem.
• The command is supported only on DOCSIS 1.1 CMs primary service flows.
• You can specify this command only after the CM has been online for at least 200 seconds.
• The parameters defined by the named service class should be a subset of the admitted qos parameters.
Normally, the admitted and the active parameters have the same QoS parameters. However, it is better
to ensure that the following parameters are a subset of the original or registered set of parameters: priority,
max-rate, max-burst, min-rate, max-latency, min-packet-size, act_timeout, or adm_timeout. Also,
ensure that the values of required_mask, forbidden_mask, and aggregate_mask are the same.

Examples The following example changes the QoS parameter set for the CM with MAC address aaaa.bbbb.cccc
to the service class named “test”:

Router# cable modem aaaa.bbbb.cccc service-class-name test

Cisco CMTS Cable Command Reference

466
 Cable Commands: cable m to n
cable modem service-class-name

Related Commands Command Description

cable service class Sets parameters for a DOCSIS 1.1 cable service class.

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

Cisco CMTS Cable Command Reference

467
 Cable Commands: cable m to n
cable modem v6-max-cpe-prefix

cable modem v6-max-cpe-prefix

To specify the maximum number of IPv6 addresses per modem, use the cable modem v6-max-cpe-prefix
command in global configuration mode. To set the default value of the command, use the no form of this
command.

cable modem v6-max-cpe-prefix [n]

no cable modem v6-max-cpe-prefix [n]

Syntax Description n Specifies the maximum number of IPv6 addresses per modem. The range is from 0 to 1023. The default
is 16.

Command Default The default number of IPv6 addresses per modem is 16.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCH1 This command was introduced.

IOS-XE 3.15.0S This command was replaced by the cable submgmt default max-ipv6-cpe command on
the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is used to check the IPv6 Global Unicast Address (GUA), link-local address (LLA) and IPv6
Prefix Delegation (PD) of the CPE.

Examples The following example shows how to specify the maximum number of the IPv6 addresses per modem:

Router> enable
Router# configure terminal
Router(config)# cable modem v6-max-cpe-prefix 10
Router(config)# cable submgmt default active
Router(config)# exit

Related Commands Command Description

show cable modem Displays information for the registered and unregistered cable modems.

Cisco CMTS Cable Command Reference

468
 Cable Commands: cable m to n
cable modem vendor

cable modem vendor

To associate the name of a vendor with its Organizational Unique Identifier (OUI), use the cable modem
vendor command in global configuration mode. To remove the association of the vendor name with its OUI,
use the no form of this command.

cable modem vendor OUI [vendor-name]

no cable modem vendor OUI [vendor-name]

Syntax Description OUI Specifies the Organizational Unique Identifier (OUI). An OUI is the first 3 octets (3 bytes, 6
hexadecimal digits) of the CM MAC address and typically indicates the vendor for the CM.
The octets can be specified as one string (for example, 000102), or each octet can be separated
by a hyphen, period, or colon (for example, 00-01-02 or 00:01:02 or 00.01.02).
Note
You can use either a period or colon as the separator between octets when manually entering
this command, but the command that is written to the running and startup configuration files
always uses a period.

vendor-name (Optional) Specifies an arbitrary string identifying the vendor for this OUI.

Command Default A default database contains approximately 300 OUIs associated with approximately 60 vendor names.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(8)BC2 This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable modem vendor command allows you to associate an arbitrary string with an OUI to identify the
vendor of the associated CM. The vendor name is then displayed as part of the show cable modem vendor
command.
The show cable modem vendor command uses a default database of approximately 300 OUIs. If the OUI
and vendor are not in that database, the show cable modem vendor command displays the OUI as the vendor
name, but you can use the cable modem vendor command to associate a vendor name with the new OUI.
If you specify an OUI with the cable modem vendor command that already exists in the OUI database, the
previous value is overwritten with the new value. You can use the default prefix to restore the original value
for an OUI in the default database.
You can also use the no cable modem vendor command to remove the association between an OUI and a
vendor name. The show cable modem vendor command then displays only the OUI as the vendor name.

Tip The Institute of Electrical and Electronics Engineers (IEEE) is the official issuer of OUI values.

Cisco CMTS Cable Command Reference

469
 Cable Commands: cable m to n
cable modem vendor

Examples The following shows several examples of the cable modem vendor command using Cisco OUIs:

Router(config)# cable modem vendor 00:01:42 Cisco

Router(config)# cable modem vendor 00:01:43 Cisco

Router(config)# cable modem vendor 00:01:63 Cisco

Router(config)# cable modem vendor 00:01:64 Cisco

Router(config)# cable modem vendor 00:0A:41 Cisco

Router(config)# cable modem vendor 00:0A:42 Cisco

Router(config)#

The following shows an example of the default cable modem vendor command being used to restore
the original association between Cisco and its company OUI of 00:00:0C. Any previous user-defined
vendor name is deleted from the OUI database.

Router(config)# default cable modem vendor 00000C

The following shows an example of the no cable modem vendor command being used to remove
the association between Cisco and an OUI of 00:0A:42. If any CMs exist with that OUI, the show
cable modem vendor command displays the OUI (“00:0A:42”) as the vendor name.

Router(config)# no
cable modem vendor 00:0A:42 Router(config)#

Related Commands Command Description

show cable modem vendor Displays the vendor name or Organizational Unique Identifier (OUI) for the
CMs on each cable interface.

Cisco CMTS Cable Command Reference

470
 Cable Commands: cable m to n
cable modulation-profile

cable modulation-profile
To define a modulation profile for use on the router, use the cable modulation-profile command in global
configuration mode. To remove the entire modulation profile or to reset a default profile to its default values,
use the no form of this command.

DOCSIS 1.0 and 1.1 Mixed Mode:

cable modulation-profile profile {mix | qam-16 | qpsk | robust-mix}
no cable modulation-profile profile {iuc | mix | qam-16 | qpsk | robust-mix}
cable modulation-profile profile iuc fec-tbytes fec-len burst-len guard-t mod scrambler seed diff
pre-len last-cw uw-len

DOCSIS 1.x/2.0 Mixed Mode:

cable modulation-profile profile {mix-high | mix-low | mix-mid | mix-qam | qam-16 | qpsk |
robust-mix-high | robust-mix-mid | robust-mix-qam}
no cable modulation-profile profile {iuc | mix-high | mix-low | mix-mid | mix-qam | qam-16 | qpsk |
robust-mix-high | robust-mix-mid | robust-mix-qam}
cable modulation-profile profile iuc fec-tbytes fec-len burst-len guard-t mod scrambler seed diff
pre-len last-cw uw-len

DOCSIS 2.0 A-TDMA Mode:

cable modulation-profile profile {mix-high | mix-low | mix-mid | mix-qam | qam-8 | qam-16 | qam-32
| qam-64 | qpsk | robust-mix-high | robust-mix-low | robust-mix-mid}
no cable modulation-profile profile {iuc | mix-high | mix-low | mix-mid | mix-qam | qam-8 | qam-16
| qam-32 | qam-64 | qpsk | robust-mix-high | robust-mix-low | robust-mix-mid}
cable modulation-profile profile iuc fec-tbytes fec-len burst-len guard-t mod scrambler seed diff
pre-len last-cw uw-len

Cisco IOS Release 12.2(33)SCC and Later

DOCSIS 2.0 A-TDMA Mode and DOCSIS 2.0 S-CDMA Mode:

cable modulation-profile profile {mix-high | mix-low | mix-mid | mix-qam | qam-16 | qpsk |
robust-mix-high | robust-mix-low | robust-mix-mid}
no cable modulation-profile profile {iuc | mix-high | mix-low | mix-mid | mix-qam | qam-16 | qpsk |
robust-mix-high | robust-mix-low | robust-mix-mid}
cable modulation-profile profile iuc fec-tbytes fec-len burst-len guard-t mod scrambler seed diff
pre-len last-cw uw-len

Cisco cBR Series Converged Broadband Routers

DOCSIS 1.x TDMA Mode:

cable modulation-profile profile tdma {mix | qam-16 | qpsk | robust-mix}
no cable modulation-profile profile tdma {iuc | mix | qam-16 | qpsk | robust-mix}
cable modulation-profile profile tdma iuc fec-tbytes fec-len burst-len guard-t mod scrambler seed
diff pre-len last-cw uw-len

DOCSIS 1.x/2.0 TDMA-ATDMA Mixed Mode:

cable modulation-profile profile mixed {mix-high | mix-low | mix-mid | mix-qam | qam-16 | qpsk |
robust-mix-high | robust-mix-mid | robust-mix-qam}

Cisco CMTS Cable Command Reference

471
 Cable Commands: cable m to n
cable modulation-profile

no cable modulation-profile profile mixed {iuc | mix-high | mix-low | mix-mid | mix-qam | qam-16
| qpsk | robust-mix-high | robust-mix-mid | robust-mix-qam}
cable modulation-profile profile mixed iuc fec-tbytes fec-len burst-len guard-t mod scrambler
seed diff pre-len last-cw uw-len

DOCSIS 2.0 A-TDMA Mode:

cable modulation-profile profile atdma {mix-high | mix-low | mix-mid | mix-qam | qam-8 | qam-16
| qam-32 | qam-64 | qpsk | robust-mix-high | robust-mix-low | robust-mix-mid}
no cable modulation-profile profile atdma {iuc | mix-high | mix-low | mix-mid | mix-qam | qam-8 |
qam-16 | qam-32 | qam-64 | qpsk | robust-mix-high | robust-mix-low | robust-mix-mid}
cable modulation-profile profile atdma iuc fec-tbytes fec-len burst-len guard-t mod scrambler
seed diff pre-len last-cw uw-len

Syntax Description profile Specifies the modulation profile number. The valid values for the profile number depend
on the cable interface being used and the upstream’s mode of operation.
The range is 1 to 400 on the Cisco cBR series routers.
In Cisco IOS Release 12.2(15)CX and later releases, you can create a maximum of 10
profiles for each mode of operation, for a total of 30 profiles on the Cisco uBR10012
and Cisco uBR7200 series routers. In earlier software releases, you can create a maximum
of 8 profiles only for DOCSIS 1.0 and DOCSIS 1.1 mode.

mix (DOCSIS 1.0 and DOCSIS 1.1 mode only) Creates a default QPSK/16-QAM mix
modulation profile where short and long grant bursts are sent using 16-QAM, while
request, initial ranging, and station maintenance bursts are sent using QPSK). The burst
parameters are set to their default values for each burst type.

mix-high (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 modes only) Creates a default QPSK/64-QAM
modulation profile.

mix-low (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 modes only) Creates a default QPSK/16-QAM
modulation profile.

mix-mid (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only) Creates a default
QPSK/32-QAM modulation profile.

mix-qam (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only) Creates a default
16-QAM/64-QAM modulation profile.

qam-8 (DOCSIS 2.0 A-TDMA mode only) Creates a default 8-QAM modulation profile.
This modulation profile is available in hidden and internal mode only from Cisco IOS
Release 12.2(33)SCC and Cisco IOS-XE Release 3.15.0S onwards.

qam-16 Creates a default 16-QAM modulation profile.

qam-32 (DOCSIS 2.0 A-TDMA mode only) Creates a default 32-QAM modulation profile.
This modulation profile is available in hidden and internal mode only from Cisco IOS
Release 12.2(33)SCC and Cisco IOS-XE Release 3.15.0S onwards.

Cisco CMTS Cable Command Reference

472
Cable Commands: cable m to n
cable modulation-profile

qam-64 (DOCSIS 2.0 A-TDMA mode only) Creates a default 64-QAM modulation profile.
This modulation profile is available in hidden and internal mode only from Cisco IOS
Release 12.2(33)SCC and Cisco IOS-XE Release 3.15.0S onwards.

qpsk Creates a default QPSK modulation profile.

robust-mix (DOCSIS 1.0 and DOCSIS 1.1 mode only) Creates a default QPSK/16-QAM modulation
profile with a longer preamble that is more robust and more able to deal with noise on
the upstream better than the mix profile.

robust-mix-high (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only) Creates a default
QPSK/64-QAM mixed modulation profile with a longer preamble that is more robust
and more able to deal with noise on the upstream better than the mix-high profile.

robust-mix-low (DOCSIS 2.0 A-TDMA mode only) Creates a default QPSK/16-QAM modulation profile
with a longer preamble that is more robust and better able to deal with noise on the
upstream than the mix-low profile.

robust-mix-mid (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only) Creates a default
QPSK/32-QAM modulation profile with a longer preamble that is more robust and better
able to deal with noise on the upstream than the mix-mid profile.

robust-mix-qam (DOCSIS 1.x/2.0 mixed mode only) Creates a default 16-QAM/64-QAM mixed
modulation profile with a longer preamble that is more robust and better able to deal
with noise on the upstream than the mix-qam profile.

iuc Interval usage code. Valid entries depend on the mode of operation:
• If the upstream is configured for DOCSIS 1.0 and DOCSIS 1.1 modulation profiles,
the valid values are initial, long, request, reqdata, short, or station.
• If the upstream is configured for DOCSIS 1.x and DOCSIS 2.0 mixed modulation
profiles, the valid values are a-long, a-short, a-ugs, initial, long, request, reqdata,
short, or station.
• If the upstream is configured for DOCSIS 2.0 A-TDMA modulation profiles, the
valid values are a-long, a-short, a-ugs, initial, long, request, reqdata, short, or
station.
The reqdata burst type is included as a placeholder for scripts that might reference it,
but the DOCSIS MAC scheduler on the Cisco CMTS does not use this type of burst.
When you are using the initial and station bursts for DOCSIS 2.0 A-TDMA mode,
qam-8, qam-32, and qam-64 modulation profiles are available in hidden mode only.

preamble (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only, for a-long and a-short
options) Specifies the preamble format. Valid values are qpsk0 and qpsk1.

rs-interleave-depth (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only, for a-long and a-short
options) Specifies the RS interleave depth. The valid range is from 0 to 114.

rs-interleave-block (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only, for a-long and a-short
options) Specifies the RS interleave block size. The valid range is from 18 to 2048.

Cisco CMTS Cable Command Reference

473
 Cable Commands: cable m to n
cable modulation-profile

fec-tbytes The number of bytes that can be corrected per FEC code word. For DOCSIS 1.0 and
DOCSIS 1.1 mode, valid values are from 0 to 10 (decimal), where 0 means no FEC.
For DOCSIS 2.0 A-TDMA mode, the valid values are from 0 to 16 (decimal), where 0
means no FEC.

fec-len FEC code-word length. Valid values are from 16 to 253.

burst-len Maximum burst length in minislots. Valid values are from 0 to 255, where 0 means no
limit.

guard-t Guard time in symbols. The time between successive bursts, with a range from 22 to
255. (In Cisco IOS Release 12.2(15)BC2 and earlier releases, the minimum guard time
was 0 symbols, but we do not recommend using a guard time smaller than 22 symbols.)

mod Modulation. Valid entries are 16qam and qpsk for DOCSIS 1.0 and DOCSIS 1.1
upstreams. Valid entries are 8qam, 16qam, 32qam, 64qam, and qpsk for DOCSIS 2.0
upstreams.
The qam-8, qam-32, and qam-64 modulation profiles are available in hidden and internal
modes only from Cisco IOS Release 12.2(33)SCC and Cisco IOS-XE Release 3.15.0S
onwards.

scrambler Enable or disable scrambler. Valid entries are scrambler and no-scrambler.

seed (Required if scrambler option used) Scrambler seed in hexadecimal format. Valid values
are from 0x0 to 0x7FFF.

diff Enable or disable differential encoding. Valid entries are diff and no-diff.
In DOCSIS 2.0 mode, differential encoding cannot be enabled for the 8-QAM, 32-QAM,
and 64-QAM modulations.
The qam-8, qam-32, and qam-64 modulation profiles are available in hidden and internal
modes only from Cisco IOS Release 12.2(33)SCC and Cisco IOS-XE Release 3.15.0S
onwards.

pre-len Preamble length in bits. Valid values are from 2 to 256.

last-cw Handling of FEC for last code word. Valid entries are fixed for fixed code-word length
and shortened for shortened last code word.

uw-len Upstream unique word length. Enter uw8 for 8-bit unique code words or uw16 for 16-bit
unique code words.

Command Default Modulation profile 1 is defined as a qpsk Time Division Multiple Access (TDMA) profile.
In Cisco IOS Release 12.2(15)CX, Release 12.2(15)BC2 and later releases, additional modulation profiles
are defined as the default mixed TDMA/A-TDMA profile and the default Advanced TDMA (A-TDMA)
profile.

Command Modes
Global configuration (config)

Cisco CMTS Cable Command Reference

474
 Cable Commands: cable m to n
cable modulation-profile

Command History Release Modification

11.3 NA This command was introduced.

12.0(7)XR2 This command was supported.

12.0(6)SC and The mix, qpsk, and qam-16 options were added.
12.1(3a)EC1

12.2(8)BC2 Support was added for the Cisco uBR10012 router.

12.2(11)CY Support was added for the Cisco uBR-MC5X20S cable interface line card. This
includes creating default modulation profile 21 for the card.

12.2(15)CX Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X
cable interface line card, including support for DOCSIS 2.0 A-TDMA and mixed
modulation profiles on this card.
The robust predefined modulation profiles were also added for all modes of
operation. The robust profiles use a longer preamble to provide better handling
of noise on the upstream, but they also consume more bandwidth at the PHY
layer than the other profiles.

12.2(15)BC2 Support was added for the Cisco uBR10-MC5X20S/U cable interface line cards,
including support for DOCSIS 2.0 A-TDMA and mixed modulation profiles.
Support for the IUC-11 burst profile (Advanced UGS, a-ugs) was also added for
mixed TDMA/A-TDMA modulation profiles.

12.3BC This command was integrated into Cisco IOS Release 12.3BC. Support was
added for the Cisco uBR10-MC5X20H cable interface line card.

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

12.2(33)SCC This command was modified. Moved qam-8, qam-32, and qam-64 options to
hidden and internal mode only. Support was added for Synchronous Code Division
Multiple Access (S-CDMA) modulation profiles.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines A modulation profile is a collection of at least six burst profiles that are sent out in an upstream channel
descriptor (UCD) message to configure a modem’s transmit parameters.
You can use the no cable modulation-profile command to remove all modulation profiles except the default
modulation profiles (1, 21, 41, 101, 121, 201, 221, 241, and 321, depending on the cable interface line cards
being used). In the case of the default modulation profiles, the no cable modulation-profile command resets
the default profile to its default values.
We recommend that you use the predefined profiles instead of manually specifying the individual bursts for
a modulation profile. The predefined profiles are optimized for the default of 32 symbols per minislot for
each particular modulation scheme. The robust predefined profiles use a longer preamble for better handling
of noise on the upstream, but at the cost of consuming more PHY layer bandwidth than the other non-robust
profiles.

Cisco CMTS Cable Command Reference

475
 Cable Commands: cable m to n
cable modulation-profile

If you want to manually specify the individual bursts, enter a line with all parameters for each upstream burst
type. Then repeat this command for each burst type, which also must be fully specified. A profile with
incomplete or missing bursts can cause unreliable operation or loss of modem connectivity.

Caution Changes to modulation profiles causes changes to the physical layer. Because changing physical layer
characteristics affects router performance and function, this task should be reserved for expert users who have
a thorough understanding of DOCSIS systems and how each parameter affects the network.

Note The reqdata burst type is included as a placeholder for SNMP scripts that might reference it, but it has no
effect. You can use this command (and SNMP commands) to specify the reqdata types, but the DOCSIS
MAC scheduler on the Cisco CMTS does not use this type of burst.

From Cisco IOS Release 12.2(33)SCC and Cisco IOS-XE Release 3.15.0S onwards, the qam-8, qam-32, and
qam-64 modulation profiles are available in hidden and internal modes only. When you are using the initial
and station bursts for DOCSIS 2.0 A-TDMA mode, qam-8, qam-32, and qam-64 modulation profiles are
available in hidden mode only. However, these modulation profiles are available for a-long, a-short, a-ugs,
long, request, reqdata, and short.
Modulation Profile Ranges
The valid range for modulation profiles depends on the cable interface being used and the type of modulation
profile being created. The table below lists the valid ranges according to cable interface and modulation type.

Table 7: Allowable Ranges for Modulation Profiles

Cable Interface DOCSIS 1.X (TDMA) Mixed DOCSIS 1.X/2.0 DOCSIS 2.0 (A-TDMA) DOCSIS 2.0 (S-CDMA)

Cisco uBR7100 series 1 to 103, default=1 N/A N/A N/A

Cisco uBR-MC16C 1 to 10, default=1 N/A N/A N/A

Cisco uBR-MC16S 1 to 10, default=1 N/A N/A N/A

Cisco uBR-MC28C 1 to 10, default=1 N/A N/A N/A

Cisco uBR-MC5X20S, Cisco 21 to 30, default=21 121 to 130, default=121 221 to 230, default=221 321 to 330 (default is
uBR-MC5X20U, Cisco 321)
uBR-MC5X20H

Cisco uBR-MC16U/X, Cisco 41 to 50, default=41 141 to 150, default=141 241 to 250, default=241 N/A
uBR-MC28U/X

Cisco cBR-8 CCAP 1 to 400, default=21 1 to 400, default=121 1 to 400, default=221 N/A
3
Only 8 modulation profiles are supported in Cisco IOS software releases before 12.2(15)BC1, so in these releases the valid
range is from 1 to 8.

DOCSIS 1.0 and DOCSIS 1.1 Support

Cisco CMTS Cable Command Reference

476
 Cable Commands: cable m to n
cable modulation-profile

For DOCSIS 1.0 and 1.1 cable modems, the following burst types are required: request, request data, initial
maintenance, station maintenance, short grant, and long grant. You must issue the cable modulation-profile
command six times for each individual burst type to correctly create a new modulation profile.
The three default profiles can be used to quickly create modulation profiles, without having to specify the
parameters for each individual burst: mix, qpsk, and qam-16. The burst parameters for the request, initial,
station maintenance, short, and long bursts are set to their default values for each burst type. (The reqdata
burst type is not created when using the default modulation profiles because it is not used by the MAC
scheduler.)
The default profiles allow basic profiles to be implemented for initial network connectivity. As the
characteristics of a cable plant become better known, the profiles can then be adjusted accordingly.

Note Do not use the qam-16 mode unless you have verified that your cable plant can support that modulation
profile. Most cable plants should instead use the qpsk or mix modulation profile for the primary profile.

Caution Turning the scrambler off can cause packet loss and is used only in lab testing environments.

Errors or incompatible configurations in the burst profiles cause cable modems to drop connectivity, to drop
short or long data packets, or to fail to connect to the network. It is possible to build a burst profile set for
which no implementation of a DOCSIS receiver is capable of receiving the modem’s transmission.
Data rates of 160 Ksymbol/sec and 2560 Ksymbol/sec are highly sensitive to unique word length, preamble
length, and FEC sizing. Incorrect choices for these values can cause poor, or no, connectivity at these symbol
rates.
DOCSIS 2.0 Support
Cisco IOS Release 12.2(11)CY, 12.2(15)BC1, 12.3BC, 12.2(33)SCA, 12.2(33)SCC, and later releases support
10 modulation profiles for each of the three DOCSIS modes (DOCSIS 1.X, DOCSIS 2.0, and mixed mode)
on the Cisco uBR10012 and Cisco uBR7200 series routers, for a total maximum of 30 modulation profiles.
In addition, the router also creates several default modulation profiles (1, 21, 41, 101, 121, 141, 201, 221,
241, and 321, depending on the cable interface line cards that are installed).

Examples The following example shows how to create a mixed modulation profile, using 16-QAM for the short
and long grant bursts and QPSK for the request, initial ranging, and station maintenance bursts on a
Cisco uBR10012 router. The burst parameters are set to their default values for each burst type.

Router(config)# cable modulation-profile 8 mix

Router(config)# exit

Router# show cable modulation-profile 8

Mod IUC Type Preamb Diff FEC FEC Scrambl Max Guard Last Scrambl Preamb
length enco T CW seed B time CW offset
BYTES size size size short
8 request qpsk 64 no 0x0 0x10 0x152 0 8 no yes 0
8 initial qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0
8 station qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0
8 short qam 144 no 0x6 0x4B 0x152 6 8 yes yes 0
8 long qam 160 no 0x8 0xDC 0x152 0 8 yes yes 0
Router#

Cisco CMTS Cable Command Reference

477
 Cable Commands: cable m to n
cable modulation-profile

Note The above example shows the default values for the burst parameters. The main differences in the
default values between 16-QAM and QPSK bursts are in the Type and Preamble Length fields.

The following example shows how to define the burst parameters for profile 2 with the following
parameters: 0 fec-tbytes, 16 kbytes fec-len, a burst-len of 1, a guard time of 8, a mod value of qpsk,
scrambler enabled with a seed value of 152, differential encoding disabled, a preamble length of 64
bits, a fixed code-word length, and 8-bit unique words for upstream unique word length a Cisco
uBR10012 router.

Router(config)# cable modulation-profile 2 request 0 16 1 8 qpsk scrambler 152 no-diff 64

fixed uw8
Router(config)# cable modulation-profile 2 reqdata 0 16 1 8 qpsk scrambler 152 no-diff 64
fixed uw8
Router(config)# cable modulation-profile 2 initial 5 34 0 48 qpsk scrambler 152 no-diff 128
fixed uw16
Router(config)# cable modulation-profile 2 station 5 34 0 48 qpsk scrambler 152 no-diff 128
fixed uw16
Router(config)# cable modulation-profile 2 short 6 75 6 8 16qam scrambler 152 no-diff 144
fixed uw8
Router(config)# cable modulation-profile 2 long 8 220 0 8 16qam scrambler 152 no-diff 160
fixed uw8

Note You must create all of the bursts (request, initial, station, short and long) for this modulation profile,
using the cable modulation-profile command. The reqdata burst is optional.

The following example shows an example of a DOCSIS 1.X/DOCSIS 2.0 mixed modulation profile
a Cisco uBR10012 router:

Router# configure terminal

Router(config)# cable modulation-profile 142 request 0 16 0 8 qpsk scrambler 152 no-diff

64 fixed uw8

Router(config)# cable modulation-profile 142 initial 5 34 0 48 qpsk scrambler 152 no-diff

32 fixed uw16

Router(config)# cable modulation-profile 142 station 5 34 0 48 qpsk scrambler 152 no-diff

32 fixed uw16

Router(config)# cable modulation-profile 142 short 5 75 6 8 qpsk scrambler 152 no-diff 72

shortened uw8

Router(config)# cable modulation-profile 142 long 8 220 0 8 qpsk scrambler 152 no-diff 80
shortened uw8

Router(config)# cable modulation-profile 142 a-short qpsk0 0 18 5 99 10 8 64qam scrambler

152 no-diff 128 shortened uw8

Router(config)# cable modulation-profile 142 a-long qpsk0 0 18 15 200 0 8 64qam scrambler

152 no-diff 128 shortened uw8

Router(config)#

Cisco CMTS Cable Command Reference

478
Cable Commands: cable m to n
cable modulation-profile

The following example shows an example of a DOCSIS 2.0 A-TDMA modulation profile a Cisco
uBR10012 router:

Router# configure terminal

Router(config)# cable modulation-profile 242 request qpsk0 0 0 0 16 0 8 qpsk scrambler 152

no-diff 64 fixed uw8

Router(config)# cable modulation-profile 242 initial qpsk0 0 0 5 34 0 48 qpsk scrambler 152

no-diff 32 fixed uw16

Router(config)# cable modulation-profile 242 station qpsk0 0 0 5 34 0 48 qpsk scrambler 152

no-diff 32 fixed uw16

Router(config)# cable modulation-profile 242 short qpsk0 0 0 5 75 6 8 qpsk scrambler 152

no-diff 72 shortened uw8

Router(config)# cable modulation-profile 242 long qpsk0 0 0 8 220 0 8 qpsk scrambler 152
no-diff 80 shortened uw8

Router(config)# cable modulation-profile 242 a-short qpsk0 0 18 5 99 10 8 64qam scrambler

152 no-diff 128 shortened uw8

Router(config)# cable modulation-profile 242 a-long qpsk0 0 18 15 200 0 8 64qam scrambler

152 no-diff 128 shortened uw8

Router(config)#

The following example shows an example of a DOCSIS 2.0 S-CDMA modulation profile:

Router# configure terminal

Router(config)# cable modulation-profile 324 request 0 16 10 16qam scrambler 152 no-diff

64 fixed qpsk0 spreader 12 12 no-tcm
Router(config)# cable modulation-profile 324 initial 0 16 10 16qam scrambler 152 no-diff
64 fixed qpsk0 off-spreader 12 12 no-tcm
Router(config)# cable modulation-profile 324 station 0 16 10 16qam scrambler 152 no-diff
64 fixed qpsk0 off-spreader 12 12 no-tcm
Router(config)# cable modulation-profile 324 a-short 0 16 10 16qam scrambler 152 no-diff
64 fixed qpsk0 off-spreader 12 12 no-tcm
Router(config)# cable modulation-profile 324 a-long 16 10 16qam scrambler 152 no-diff 64
fixed qpsk0 off-spreader 12 12 no-tcm

Router(config)# cable modulation-profile 324 a-ugs 16 10 16qam scrambler 152 no-diff 64

fixed qpsk0 off-spreader 12 12 no-tcm
Router(config)#

The following example shows how to create TDMA modulation profiles on a Cisco cBR series router:
Router# configure terminal
Router(config)# cable modulation-profile 24 tdma qam-16
Router(config)# cable modulation-profile 25 tdma qpsk
Router(config)# cable modulation-profile 26 tdma request 0 16 0 8 qpsk scrambler 152 no-diff
68 fixed

The following example shows how to create TDMA/A-TDMA mixed modulation profiles on a Cisco
cBR series router:
Router# configure terminal
Router(config)# cable modulation-profile 125 mixed qam-16

Cisco CMTS Cable Command Reference

479
 Cable Commands: cable m to n
cable modulation-profile

Router(config)# cable modulation-profile 127 mixed request 0 16 0 8 qpsk scrambler 152

no-diff 68 fixed
Router(config)# cable modulation-profile 127 mixed initial 5 34 0 48 qpsk scrambler 152
no-diff 128 fixed

The following example shows how to create A-TDMA mixed modulation profiles on a Cisco cBR
series router:
Router# configure terminal
Router(config)# cable modulation-profile 225 atdma qam-64
Router(config)# cable modulation-profile 227 atdma request 0 16 0 8 qpsk scrambler 152
no-diff 68 fixed qpsk0 1 2048
Router(config)# cable modulation-profile 227 atdma initial 0 16 0 0 qpsk no-scrambler no-diff
2 fixed qpsk1 0 18

See the show cable modulation-profile command for a description of the output display fields.

Related Commands Command Description

cable upstream modulation-profile Assigns a modulation profile to an interface.

show cable modulation-profile Displays a modulation profile group’s information.

Cisco CMTS Cable Command Reference

480
 Cable Commands: cable m to n
cable modulation-profile global-scheme

cable modulation-profile global-scheme

To define a global modulation profile for use on the router, use the cable modulation-profile global-scheme
command in global configuration mode. To remove the newly created modulation profile or to reset to the
legacy profile mode, use the no form of this command.

cable modulation-profile global-scheme profile

no cable modulation-profile global-scheme

Syntax Description profile Modulation profile number. The profile number range is from 1 to 400.

Command Default The global modulation profile scheme is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Using the global modulation profile scheme, you can assign any number between 1 to 400 to any modulation
profiles. It eliminates the number space restriction and increases the number of modulation profiles that can
be created per DOCSIS mode. The global modulation profile mode allows you to create and configure DOCSIS
3.0 channel type 4SR (scdma-d3). When an upstream DOCSIS mode is changed to scdma-d3 , it is initially
assigned to the system created default modulation profile.

Note Though you can assign any number between 1 to 400 to any modulation profile, the default modulation profile
number assigned to an upstream channel for a given channel type will remain the same. That is, modulation
profile numbers 21, 121, 221, 321, and 381 will be applicable for TDMA, mixed, A-TDMA, S-CDMA, and
DOCSIS 3.0 S-CDMA channel types.

All the existing and previously defined modulation profiles are converted to the new format. However, all the
newly created modulation profiles, which are outside of the legacy number space range, are lost when you
revert to the legacy modulation profile.

Note The default profiles cannot be deleted. Using the no cable modulation global command on the default profiles
resets them to their original, default values.

Modulation Profile Ranges

The valid range for modulation profiles depends on the cable interface being used and the type of modulation
profile being created.
The table below lists the valid ranges according to cable interface and modulation type:

Cisco CMTS Cable Command Reference

481
 Cable Commands: cable m to n
cable modulation-profile global-scheme

Table 8: Allowable Ranges for Modulation Profiles

Cable Interface DOCSIS 2.0 (S-CDMA) DOCSIS 3.0 (S-CDMA)

Cisco UBR-MC20X20V 321 to 330 (default is 321) 1 to 400 (default is 381)

Examples The following example shows how to create a global modulation profile scheme:

Router(config)# cable modulation-profile global-scheme

Related Commands Command Description

cable upstream modulation-profile Assigns a modulation profile to an interface.

show cable modulation-profile Displays modulation profile information of a group.

Cisco CMTS Cable Command Reference

482
 Cable Commands: cable m to n
cable mod-profile-ofdma

cable mod-profile-ofdma
To define the OFDMA modulation profile for OFDMA channels, cable mod-profile-ofdma command in
the global configuration mode.

cable mod-profile-ofdma id

Syntax Description data-iuc Configures the data IUC (Interval Usage Codes) profile.

fine-rng-subcarrier Configures the number of subcarriers for fine ranging.

initial-rng-preamble Configures the number of symbols per subcarrier for initial

ranging preamble.

initial-rng-subcarrier Configures the number of subcarriers for initial ranging.

subcarrier-spacing Defines the subcarrier spacing.

ofdma-prof-mgmt downgrade rxmer Defines the data IUC below which the OFDMA channel will be
min-iuc value downgraded to partial mode.

Command Default The default OFDMA modulation profile for subcarrier spacing 25KHz is 421. The default OFDMA modulation
profile for subcarrier spacing 50KHz is 461. In these two modulation profiles, the default IUC is IUC 13.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest 16.6.1 This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Cisco IOS XE Amsterdam 17.3.1w This command was updated. ofdma-prof-mgmt downgrade rxmer
min-iuc option was added.

Usage Guidelines Use this command to define the OFDMA modulation profile that can be applied to OFDMA channels. The
OFDMA modulation profile is used to configure initial ranging, fine ranging, and data IUC parameters.

Configuring OFDMA Modulation Profile

The following example shows how to configure OFDMA modulation profile.
Router# enable
Router# configure terminal
Router(config)# cable mod-profile-ofdma 466
Router(config-ofdma-mod-profile)# subcarrier-spacing 50KHz
Router(config-ofdma-mod-profile)# initial-rng-subcarrier 64
Router(config-ofdma-mod-profile)# fine-rng-subcarrier 128
Router(config-ofdma-mod-profile)# data-iuc 13 modulation 1024-QAM pilot-pattern 2
Router(config-ofdma-mod-profile)# exit
Router(config)# cable mod-profile-ofdma 423
Router(config-ofdma-mod-profile)# subcarrier-spacing 25KHz
Router(config-ofdma-mod-profile)# initial-rng-subcarrier 64

Cisco CMTS Cable Command Reference

483
 Cable Commands: cable m to n
cable mod-profile-ofdma

Router(config-ofdma-mod-profile)# fine-rng-subcarrier 128

Router(config-ofdma-mod-profile)# data-iuc 6 modulation 1024-QAM pilot-pattern 8
Router(config-ofdma-mod-profile)# data-iuc 9 modulation 1024-QAM pilot-pattern 8
Router(config-ofdma-mod-profile)# data-iuc 10 modulation 512-QAM pilot-pattern 8
Router(config-ofdma-mod-profile)# data-iuc 11 modulation 256-QAM pilot-pattern 8
Router(config-ofdma-mod-profile)# data-iuc 12 modulation 128-QAM pilot-pattern 9
Router(config-ofdma-mod-profile)# data-iuc 13 modulation 64-QAM pilot-pattern 9

Cisco CMTS Cable Command Reference

484
 Cable Commands: cable m to n
cable mod-profile-ofdma data-iuc modulation pilot-pattern cwerr-downgrade-iuc

cable mod-profile-ofdma data-iuc modulation pilot-pattern

cwerr-downgrade-iuc
To downgrade to a particular IUC directly, use the cable mod-profile-ofdma data-iuc-type data-iuc
data-iuc-type modulation modulation pilot-pattern pilot-pattern-id cwerr-downgrade-iuc
cwerr-downgrade-iuc command in the global configuration mode, to downgrade to this a particular IUC
directly.

cable mod-profile-ofdma data-iuc-type data-iuc data-iuc-type modulation modulation pilot-pattern

pilot-pattern-id cwerr-downgrade-iuc cwerr-downgrade-iuc

Syntax Description data-iuc Configure the data IUC (Interval Usage Codes) profile. The valid options
are 10, 11, 12, 13, 5, 6, or 9.

modulation modulation Configure the data IUC modulation. The valid options are 1024-QAM,
128-QAM, 16-QAM, 2048-QAM, 256-QAM, 32-QAM, 4096-QAM,
512-QAM, 64-QAM, 8-QAM, BPSK, NONE, or QPSK.

pilot-pattern pilot-pattern-id Configure the data IUC pilot pattern. The valid range is:
• Regular: 1-4 and 8-11
• Boosted: 5-7 and 12-14

cwerr-downgrade-iuc Configure to downgrade to this IUC directly. The valid options are 10,
cwerr-downgrade-iuc 11, 12, 13, 5, 6, or 9.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Dublin This command is introduced on Cisco cBR-8 Series Converged Broadband
17.12.1z Routers.

Configuring OFDMA Modulation Profile

Here is a sample configuration for manually configuring IUC downgrade:
Router# configure terminal
Router(config)# cable mod-profile-ofdma 461
Router(config-ofdma-mod-profile)# subcarrier-spacing 50KHz
Router(config-ofdma-mod-profile)# initial-rng-subcarrier 32
Router(config-ofdma-mod-profile)# fine-rng-subcarrier 100
Router(config-ofdma-mod-profile)#
data-iuc 5 modulation 1024-QAM pilot-pattern 1 cwerr-downgrade-iuc 10
Router(config-ofdma-mod-profile)#
data-iuc 6 modulation 512-QAM pilot-pattern 1 cwerr-downgrade-iuc 10
Router(config-ofdma-mod-profile)#
data-iuc 9 modulation 256-QAM pilot-pattern 2 cwerr-downgrade-iuc 13
Router(config-ofdma-mod-profile)# data-iuc 10 modulation 128-QAM pilot-pattern 2
cwerr-downgrade-iuc 13

Cisco CMTS Cable Command Reference

485
 Cable Commands: cable m to n
cable mod-profile-ofdma data-iuc modulation pilot-pattern cwerr-downgrade-iuc

Router(config-ofdma-mod-profile)#
data-iuc 11 modulation 64-QAM pilot-pattern 3 cwerr-downgrade-iuc 13
Router(config-ofdma-mod-profile)# data-iuc 12 modulation 32-QAM pilot-pattern 3
Router(config-ofdma-mod-profile)# data-iuc 13 modulation 16-QAM pilot-pattern 4
Router(config-ofdma-mod-profile)# end

Cisco CMTS Cable Command Reference

486
 Cable Commands: cable m to n
cable monitor

cable monitor
To enable the forwarding of selected packets on the cable interface to an external LAN analyzer, use the cable
monitor command in cable interface configuration mode. To disable this function, use the no form of this
command.

cable monitor [incoming | outbound] [timestamp] interface interface {slot/ {subslot | bay}/port}
[access-list {name | number} | mac-address address | sid sid-number | upstream number | packet-type
{data docsis | data ethernet | mac [type type]}]

cable monitor outbound downstream {modular-cable | Integrated-cable | wideband-cable} slot/

{subslot | bay}/controller:channel

no cable monitor

Syntax Description incoming Forwards only packets being received on the upstream.

outbound Forwards only packets being transmitted on the downstream.

timestamp Enables packet time-stamping by appending a four-byte value to the forwarded

packets. The timestamp value is in hundredths of a second.

interface interface Specifies the WAN interface to which an external LAN analyzer is attached, and
to which packets should be forwarded.
interface—Specifies the interfaces such as Ethernet, Fast Ethernet, Gigabit Ethernet,
or Ten Gigabit Ethernet interface.

slot Slot where the line card resides.

• Cisco uBR7246VXR router—The range is from 3 to 6.
• Cisco uBR7225VXR router—The range is from 1 to 2.
• Cisco uBR7100 series router—The value is 1.

subslot | bay (Cisco uBR10012 only) Secondary subslot of the cable interface line card or bay
of the SPA. The subslot values are 0 or 1 for the cable line card. The values for
bay are from 0 to 3.

port Specifies the WAN interface number.

access-list name | (Optional) Specifies the IP access list name or number (1 to 2699).
number

mac-address address (Optional) Specifies the MAC address of the device being monitored.

sid sid-number (Optional) Specifies the service ID for the packets that should be forwarded (1 to
16384).
Note
This option is supported only in Cisco IOS releases that support DOCSIS 1.1
operations.

Cisco CMTS Cable Command Reference

487
 Cable Commands: cable m to n
cable monitor

upstream number (Optional) Specifies the upstream interface. Valid values for the Cisco
uBR-MC20X20V and Cisco uBR-MC5X20 line cards range from 0 to 3

packet-type (Optional) Specifies whether data or MAC packets are forwarded.

data docsis Specifies that complete DOCSIS packets (both the DOCSIS header and the complete
Ethernet frame) should be forwarded.
Note
Enabling this option can result in %LINK-4-TOOBIG messages being generated
if the original Ethernet frame is at or near the maximum Ethernet size of 1500
bytes. This is because this option adds additional bytes (the DOCSIS header) to
the Ethernet frame, which can result in a total frame size that exceeds the maximum
size that is allowed for standard Ethernet frames.

data ethernet Specifies that the DOCSIS header should be stripped from the packet and that only
the Ethernet frame should be forwarded.

mac [type type] Specifies that only DOCSIS MAC-layer packets should be forwarded. If you are
using the sid option, you can also optionally specify the type option with one of
the following keywords to indicate that only the specific type of MAC-layer traffic
should be forwarded:
• dsa—Dynamic service addition
• dsc—Dynamic service change
• dsd—Dynamic service deletion
• map-grant—Grants
• map-req—Requests

outbound downstream Enables cable monitor on the specified downstream interface.

controller: channel Identifies the controller.

• Valid range for Cisco uBR-MC3GX60V line card is from 0 to 2.
• RF channel—The range is from 0 to 23.
• Bonding group—The range is from 0 to 31.
• Valid range for Cisco UBR-MC20X20 line card is 0 to 4.
• RF channel—The range is from 0 to 3.
• Bonding group—The range is from 0 to 5.
• Valid value for Cisco Wideband SPA is 0.
• RF channel—The range is from 0 to 23.
• Bonding group—The range is from 0 to 31.

Command Default Both upstream (incoming) and downstream (outbound) traffic is forwarded.

Command Modes
Interface configuration—cable interface only (config-if)

Cisco CMTS Cable Command Reference

488
 Cable Commands: cable m to n
cable monitor

Command History Release Modification

12.1(3a)EC This command was introduced.

12.1(4)CX The sid option was added for DOCSIS 1.1 support.

12.2(4)XF Support was added for the Cisco uBR10012 universal broadband router.

12.2(4)BC1 Support was added to the Release 12.2 BC train.

12.3(13a)BC Supports the Cisco MC5x20U-D broadband processing engine (BPE) and the Cisco MC28U
cable interface line card.

12.3(17a)BC • Access Control Lists are now supported on the Cisco uBR-MC5X20U/D and Cisco
uBR-MC28U cable interface line cards
• Unconditional downstream sniffing now enables downstream packets to be monitored,
either for MAC or data packets. This enhancement supports both DOCSIS and Ethernet
packet encapsulation.

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

12.2(33)SCB Support was added for the Ten Gigabit Ethernet interface type.

12.2(33)SCE Support was added for the Cisco UBR-MC3XG60V line cards.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable monitor command is used to configure the Cable Monitor and Intercept Features on the Cisco
CMTS Routers feature.
The cable monitor command allows an external LAN packet analyzer to monitor inbound and outbound data
packets for specific types of traffic between the Cisco CMTS and the CMs on a cable interface. This feature
enables the CMTS administrator to analyze traffic problems with customer data exchanges.
The interface used for forwarding packets can be used only for the external LAN analyzer; and cannot be used
for other purposes.
The cable monitor outbound downstream command can be enabled:
• • only one mac-domain on a line card at a time
• for one modular-cable or intergrated-cable interface per line card at one time
• for one wideband-cable interface per line card at one time

Tip One possible software utility you can use for decoding the DOCSIS MAC frames is Wireshark software,
which is available for Windows and Unix systems at http://www.wireshark.org .

Examples The following example shows how to configure the Cisco CMTS so that it monitors incoming
MAC-layer packets for the CM with the MAC address of 0123.4567.89ab and forwards copies of
the packets to the LAN analyzer on the Ethernet interface in slot 1, port 2:

Cisco CMTS Cable Command Reference

489
 Cable Commands: cable m to n
cable monitor

Router(config-if)# cable monitor incoming interface e1/2 mac-address 0123.4567.89ab

packet-type mac

The following example shows how to configure a Cisco CMTS running DOCSIS 1.1 software so
that it monitors incoming MAC-layer packets of type DSA for the CM identified by SID 173 and
forwards copies of the packets to the LAN analyzer on the Ethernet interface in slot 1, port 2:

Router(config-if)# cable monitor incoming interface e1/2 sid 173 packet-type mac type dsa

The following example shows how to configure a mac domain to monitor all packets on a modular
primary downstream and forward copies of the packets to a Gigabit Ethernet interface:

Router# configure terminal

Router(config)# interface cable 5/0/0
Router(config-if)# cable monitor outbound downstream Modular-Cable 5/1/0:21
Router(config-if)# cable monitor outbound interface GigabitEthernet3/0/0
Router(config-if)# exit

The following example shows how to configure a mac domain to monitor all packets on a particular
downstream bonding group and forward copies of the packets to a Gigabit Ethernet interface:

Router# configure terminal

Router(config)# interface cable 5/0/0
Router(config-if)# cable monitor outbound downstream Wideband-Cable 5/1/2:30
Router(config-if)# cable monitor outbound interface GigabitEthernet3/0/0
Router(config-if)# exit

The following example shows how to configure a mac domain to monitor all packets on a particular
bonding group destined to a specific modem and forward copies of the packets to a Gigabit Ethernet
interface:

Router# configure terminal

Router(config)# interface cable 5/0/0
Router(config-if)# cable monitor outbound downstream Wideband-Cable 5/1/2:30
Router(config-if)# cable monitor outbound interface GigabitEthernet3/0/0 mac-address
0123.4567.89ab
Router(config-if)# exit

Related Commands Command Description

cable intercept Allows the CMTS to forward all traffic to and from a particular CM to a
data collection server located at particular User Datagram Protocol (UDP)
port.

show interface cable monitor Displays monitor flow information on the upstream port.

Cisco CMTS Cable Command Reference

490
 Cable Commands: cable m to n
cable mrc-mode

cable mrc-mode
To enable Multiple Receive Channel (MRC) mode for a Media Access Control (MAC) interface during or
after the cable modem (CM) registration, use the cable mrc-mode command in cable interface configuration
mode or MAC domain profile configuration mode. To disable this configuration, use the no form of this
command.

cable mrc-mode
no cable mrc-mode

Syntax Description This command has no arguments or keywords.

Command Default The MRC mode is enabled by default on a downstream bonding capable cable interface line card.

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines When you enable or disable the MRC mode, cable modems switch the operation to or from the MRC mode
only after the reinitialization of cable modems. You cannot enable the MRC mode on a non-upstream bonding
capable cable interface line card.

Examples The following example shows how to enable the MRC mode for a MAC interface:

Router# configure terminal

Router(config)# interface cable 7/1/0
Router(config-if)# cable mrc-mode

The following example shows how to enable the MRC mode for a MAC interface on a Cisco cBR-8
router:

Router# configure terminal

Router(config)# interface cable 3/0/1
Router(config-if)# cable mrc-mode

Cisco CMTS Cable Command Reference

491
 Cable Commands: cable m to n
cable mrc-mode

Related Commands Command Description

cable Enables or disables the Multiple Transmit Channel mode (MTC) for a MAC interface.
mtc-mode

Cisco CMTS Cable Command Reference

492
 Cable Commands: cable m to n
cable mtc-mode

cable mtc-mode
To enable Multiple Transmit Channel (MTC) mode for a Media Access Control (MAC) interface during or
after the cable modem (CM) registration, use the cable mtc-mode command in cable interface configuration
mode or MAC domain profile configuration mode. To disable this configuration, use the no form of this
command.

cable mtc-mode [required-attribute]

no cable mtc-mode [required-attribute]

Cisco cBR Series Converged Broadband Routers

cable mtc-mode[required-attribute]
no cable mtc-mode[required-attribute]

Syntax Description required-attribute (Optional) Specifies the per-CM basis MTC mode configuration.

Command Default The MTC mode is enabled by default with the required attribute. With this default configuration, the Cisco
CMTS router enables the MTC mode on a per-CM basis by looking at the configuration file of each cable
modem.

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The required-attribute keyword was removed.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The required-attribute keyword was added.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines Multiple Transmit Channel mode is a CM capability that enables CMs to send upstream traffic on multiple
upstream channels. You can enable the MTC mode on a cable interface line card in two ways:
• MTC mode on a per-CM basis—By default, the MTC mode is enabled with the required attribute. With
this default configuration, the Cisco CMTS router enables MTC mode on a per-CM basis by looking at
each CM’s configuration file. When the CM configuration file has the bonded-bit (bit-0) on in
type-length-value (TLV) 43.9.3 (cable modem upstream required attribute mask), the Cisco CMTS router
lets the CM come online in the MTC mode. If the CM configuration file does not have the bonded-bit
on, the CM comes online in non-MTC mode.

Cisco CMTS Cable Command Reference

493
 Cable Commands: cable m to n
cable mtc-mode

• MTC mode for all cable modems in a MAC domain—The MTC mode for all cable modems in a MAC
domain is disabled by default on an upstream bonding capable cable interface line card. You can enable
the MTC mode for all cable modems in a MAC domain using the cable mtc-mode command in cable
interface configuration mode.

Note You do not have to use the required-attribute keyword to enable the MTC mode for all cable modems in a
MAC domain. You can use the no form of this command with the required-attribute keyword to disable the
default per-CM basis configuration.

You cannot enable the MTC mode on a non-upstream bonding capable cable interface line card.

Examples The following example shows how to enable the MTC mode for all cable modems in a MAC domain:

Router# configure terminal

Router(config)# interface cable 7/1/0
Router(config-if)# cable mtc-mode

The following example shows how to enable the MTC mode for all cable modems in a MAC domain
on a Cisco cBR-8 router:

Router# configure terminal

Router(config)# interface cable 3/0/1
Router(config-if)# cable mtc-mode

The following example shows how to configure the required CM attribute on USCB in a MAC
domain on a Cisco cBR Series Converged Broadband Router:
Router# configure terminal
Router(config)# interface cable 3/0/1
Router(config-if)# cable mtc-mode required-attribute
Router(config-if)#

Related Commands Command Description

cable Enables the Multiple Receive Channel mode (MRC) for a MAC interface.
mrc-mode

Cisco CMTS Cable Command Reference

494
 Cable Commands: cable m to n
cable multicast auth enable default-action

cable multicast auth enable default-action

To enable cable multicast authorization profile and set the maximum sessions limit, use the cable multicast
auth enable default-action command in global configuration mode. To disable a cable multicast authorization
profile, use the no form of this command.

cable multicast auth enable default-action {permitdeny} max-sessions [limit]

no cable multicast auth enable

Syntax Description permit Specifies packets to forward.

deny Specifies packets to reject.

limit Specifies the maximum number of dynamic multicast sessions allowed per CM.
No default value.
Max value allowed is 65535.

Command Default Cable multicast authorization is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

Usage Guidelines This command is used to enable cable multicast authorization profile feature and defines the default value.
However, it does not define the actual authorization files.

Examples The following example shows how to enable the default multicast authorization profile:

Router(config
)# cable multicast auth enable default-action deny max-sessions 10

Related Commands Command Description

cable multicast authorization profile-name Defines the cable multicast authorization profile.

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

Cisco CMTS Cable Command Reference

495
 Cable Commands: cable m to n
cable multicast auth profile-name

cable multicast auth profile-name

To define a cable multicast authorization profile, and to set it as the default profile, use the cable multicast
auth profile-name command in global configuration mode. To disable a cable multicast authorization profile,
use the no form of this command.

cable multicast auth profile-name name [default]

no cable multicast auth profile-name name [default]

Syntax Description name Specifies the name of the authorization profile to be used.

default (Optional) Specifies that the profile name should be treated as the default profile.

Command Default Cable multicast authorization is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

12.2(33)SCC The optional default keyword was added.

Usage Guidelines This command defines a cable multicast authorization profile, and optionally sets it as the default profile. If
the default keyword is not used while modifying the profile, the profile is automatically converted to a
non-default profile. Similarly, if the default keyword is added while modifying a profile, the profile is treated
as a default profile.

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

Router(config
)# cable multicast auth profile-name GOLD default

Related Commands Command Description

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

match rule This command configures the match rule, rule priority and related action
in the selected cable multicast authorization profile

Cisco CMTS Cable Command Reference

496
 Cable Commands: cable m to n
cable multicast group-encryption

cable multicast group-encryption

To configure a group encryption profile for a multicast group, use the cable multicast group-encryption
command in global configuration mode. To disable a group encryption profile, use the no form of this command.

cable multicast group-encryption number algorithm 56bit-des

no cable multicast group-encryption number algorithm 56bit-des

Syntax Description number Specifies the number of a specific cable multicast QoS group encryption profile. The
range is from 1 to 255.

algorithm Specifies that the data encryption standard (DES) is 56 bits.

56bit-des

Command Default Cable multicast group encryption is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCA This command was introduced.

Usage Guidelines To apply encryption rules to a cable multicast QoS group, you must first enable and identify an encryption
group.

Examples The following example enables encryption, identifies encryption group 12, and applies the encryption
rule to QoS group 2:

Router(config)# cable multicast group-encryption 12 algorithm 56bit-des

Router(config)# cable multicast qos group 2 priority 7 global
Router(config-mqos)# group-encryption 12

Related Commands Command Description

cable multicast qos group Specifies and configures a cable multicast QoS group.

show interface bundle multicast-sessions Displays multicast session information for a specific virtual cable
bundle.

show interface cable multicast-sessions Displays multicast session information for a specific cable
interface.

Cisco CMTS Cable Command Reference

497
 Cable Commands: cable m to n
cable multicast group-qos

cable multicast group-qos

To configure a QoS profile for a QoS group, use the cable multicast group-qos command in global
configuration mode. To disable a QoS profile, use the no form of this command.

cable multicast group-qos number scn service-class-name control {single | aggregate [limit
max-sessions]} [override]
no cable multicast group-qos number scn service-class-name control {single | aggregate [limit
max-sessions]} [override]

Cisco cBR Series Converged Broadband Routers

cable multicast group-qos number scn service-class-name {single | aggregate [limit max-sessions]}
[override]
no cable multicast group-qos number scn service-class-name {single | aggregate [limit
max-sessions]} [override]

Syntax Description number Specifies the QoS profile number for the cable multicast QoS group. The range is
from 1 to 255. If a multicast group does not match the group QoS classifiers, a
default group-QoS option is applied to the multicast flow.

scn service-class-name Specifies a service class name for the QoS profile.

control Specifies the type of control to the service flow.

single Specifies that a separate service flow is created for each session.

aggregate Specifies that service flows are grouped for sessions in the same multicast QoS
group.

limit max-sessions (Optional) Specifies the Internet Group Management Protocol (IGMP) session limit
for aggregate service flows. The range is from 1 to 255.

override (Optional) Specifies the additional multicast session admitted and forwarded as best
effort traffic, else disallows any additional multicast session once the max-sessions
limit is reached.

Command Default The QoS profile for a QoS group is not enabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCA This command was introduced.

12.2(33)SCB This command was modified with the addition of override keyword.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The control keyword was removed.

Cisco CMTS Cable Command Reference

498
 Cable Commands: cable m to n
cable multicast group-qos

Usage Guidelines If a QoS profile number is not specified, a default QoS profile is applied. The default group QoS configuration
creates a default multicast service flow for each cable interface that is used when a multicast session does not
match any classifiers of a GC on the interface.

Examples The following example configures QoS profile 5 with a service name of name1 and a control of
single to indicate that a separate service flow is created for each session. QoS profile 5 is then assigned
to QoS group 2 on the Cisco uBR 10012 router:

Router(config)# cable multicast group-qos 5 scn name1 control single

Router(config)# cable multicast qos group 2 priority 7 global
Router(config-mqos)# cable multicast group-qos 5
Router(config)# cable multicast group-qos 1 scn mcast1 aggre lim 2 ?
override Allow sessions when limit is exceeded with Default qos sessions
Router(config)# cable multicast group-qos 1 scn mcast1 aggre lim 2

The following example configures QoS profile 5 with a service name of name1 and specifies that a
separate service flow is created for each session. QoS profile 5 is then assigned to QoS group 2 on
a Cisco cBR-8 router:

Router(config)# cable multicast group-qos 5 scn name1 single

Router(config)# cable multicast qos group 2 priority 7 global
Router(config-mqos)# group-qos 5

The following example configures QoS profile 1 with a service name of mcast1 and specifies that
service flows are grouped for sessions in the same multicast QoS group on a Cisco cBR-8 router:

Router(config)# cable multicast group-qos 1 scn mcast1 aggregate limit 2 ?

override Allow sessions when limit is exceeded with Default qos sessions
Router(config)# cable multicast group-qos 1 scn mcast1 aggregate limit 2 override

Related Commands Command Description

cable multicast qos group Specifies and configures a cable multicast QoS group.

show interface cable multicast-sessions Displays multicast session information for a specific cable
interface.

Cisco CMTS Cable Command Reference

499
 Cable Commands: cable m to n
cable multicast group-qos default

cable multicast group-qos default

To configure the service class name of the default multicast quality of service (MQoS) for the QoS profile,
use the cable multicast group-qos default command in global configuration mode. To disable the service
class name of the default MQoS for the QoS profile, use the no form of this command.

cable multicast group-qos default scn service-class-name aggregate

no cable multicast group-qos default scn service-class-name aggregate

Syntax Description scn service-class-name Specifies a service class name for the QoS profile.

aggregate Specifies that service flows are grouped for sessions in the same MQoS group.

Command Default The default MQoS profile is not configured.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC1 This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines If you configure the service class name with the DOCSIS Setup Gateway (DSG) tunnel when no default
MQoS exists, the configuration is rejected and you are prompted to configure the default MQoS.
The CMTS selects the primary downstream channel to forward the multicast traffic when the default MQoS
is configured and there is no matching MQoS group configuration. Otherwise, the wideband interface is used
to forward the multicast traffic.

Note If you configure or unconfigure the default MQoS while the CMTS is sending multicast traffic, duplicate
traffic is generated for approximately 3 minutes (or 3 times the query interval).

Examples The following example configures the default MQoS profile with the service class name name1.

Router(config)# cable multicast group-qos default scn name1 aggregate

Related Commands Command Description

cable multicast group-qos Configures a QoS profile for a QoS group.

cable multicast qos group Specifies and configures a cable multicast QoS group.

show interface cable multicast-sessions Displays multicast session information for a specific cable
interface.

Cisco CMTS Cable Command Reference

500
 Cable Commands: cable m to n
cable multicast mdf-disable

cable multicast mdf-disable

To disable Multicast DSID-based Forwarding (MDF) capability of all cable modems associated with a Cisco
CMTS router, use the cable multicast mdf-disable command in global configuration mode. To enable MDF
on the cable modem, use the no form of this command.

cable multicast mdf-disable [wb-incapable-cm | dsg]

no cable multicast mdf-disable [wb-incapable-cm | dsg]

Syntax Description wb-incapable-cm (Optional) Disables MDF on all DOCSIS 2.0 hybrid cable modems.

dsg (Optional) Disables MDF capability of all DSG embedded cable modems, including
DOCSIS 3.0 DSG and DOCSIS 2.0 DSG hybrid modems.

Command Default By default, MDF is not always enabled on the cable modem because it is dependent on the cable modem
hardware.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD3 This command was introduced.

12.2(33)SCE4 The wb-incapable-cm keyword was added.

12.2(33)SCF2 The dsg keyword was added, and behavior of the wb-incapable-cm keyword was changed
to include only non-DSG DOCSIS 2.0 hybrid cable modems.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable multicast mdf-disable command is associated with the DOCSIS 3.0 Multicast Support on the
CMTS Routers feature.
In Cisco IOS Release 12.2(33)SCE4, the wb-incapable-cm keyword was added to the cable multicast
mdf-disable command to disable MDF on all DOCSIS 2.0 hybrid cable modems, including DOCSIS 2.0
DSG embedded cable modems. In Cisco IOS Release 12.2(33)SCF2, the wb-incapable-cm keyword was
changed to include only non-DSG DOCSIS 2.0 hybrid cable modems.
After disabling MDF capability, you must run clear cable modem reset command to bring all DSG embedded
cable modems online.

Examples The following example shows how to disable MDF capability on all cable modems:

Router# configure terminal

Router(config)# cable multicast mdf-disable

The following example shows how to disable MDF capability of all non-DSG DOCSIS 2.0 hybrid
cable modems:

Cisco CMTS Cable Command Reference

501
 Cable Commands: cable m to n
cable multicast mdf-disable

Router# configure terminal

Router(config)# cable multicast mdf-disable wb-incapable-cm

The following example shows how to disable MDF capability of all DSG embedded cable modems:

Router# configure terminal

Router(config)# cable multicast mdf-disable dsg

Related Commands Command Description

ip multicast-routing Enables multicast routing globally or on a particular virtual routing and

forwarding (VRF) interface.

ip multicast-routing distributed Enables Multicast Distributed Switching (MDS)

Cisco CMTS Cable Command Reference

502
 Cable Commands: cable m to n
cable multicast qos group

cable multicast qos group

To specify and configure a cable multicast QoS group and enter multicast QoS configuration mode, use the
cable multicast qos group command in global configuration mode. To disable a cable multicast QoS group,
use the no form of this command.

cable multicast qos group id priority value [global]

no cable multicast qos group id priority value [global]

Syntax Description id Specifies the number of the cable multicast QoS group. The range is from 1 to 255.

priority Specifies the priority of the cable multicast QoS group. The range is from 1 to 255.
value
Starting with Cisco IOS Release 12.2(33)SCC and Cisco IOS-XE Release 3.15.0S, the range
is from 1 to 63 and from 192 to 255. The values from 64 to 191 are used internally by the
Cisco CMTS.

global (Optional) Specifies that the multicast QoS group configuration is applied to all cable
interfaces.

Command Default A cable multicast QoS group is not identified.

Command Modes Global configuration (config)

Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

Command History Release Modification

12.2(33)SCA This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You must configure a group QoS profile using the cable multicast group-qos command, and a group encryption
profile using the cable multicast group-encryption command before you configure a cable multicast QoS
group.

Examples The following example specifies multicast QoS group 2 with a priority of 6 and global application.
Application ID, group encryption, group QoS, session range, ToS, and VRF options are configured
for QoS group 2.

Router(config)# cable multicast qos group 2 priority 6 global

Router(config-mqos)# application-id 44
Router(config-mqos)# group-encryption 4
Router(config-mqos)# group-qos 3
Router(config-mqos)# session-range 224.10.10.01 255.255.255.254
Router(config-mqos)# tos 1 6 15
Router(config-mqos)# vrf name1

Cisco CMTS Cable Command Reference

503
 Cable Commands: cable m to n
cable multicast qos group

Related Commands Command Description

application-id Specifies an application type to allow admission control to be applied

to a group configuration.

cable multicast group-encryption Configures a group encryption profile for a multicast group.

cable multicast group-qos Configures a group QoS profile for a multicast QoS group.

session-range Identifies the multicast QoS group session range.

show interface bundle Displays multicast session information for a specific virtual cable
multicast-sessions bundle.

show interface cable Displays multicast session information for a specific cable interface.
multicast-sessions

tos Sets the type of service (ToS) low byte, high byte, and mask values
within a multicast QoS group.

vrf Specifies the name for a virtual routing and forwarding (VRF)
instance.

Cisco CMTS Cable Command Reference

504
 Cable Commands: cable m to n
cable multicast ses-cache

cable multicast ses-cache

To enable multicast replication session on the forwarding interface, use the cable multicast ses-cache command
in global configuration and interface configuration mode. To disable, use the no cable multicast ses-cache
command.

cable multicast ses-cache value

no cable multicast ses-cache value

Syntax Description value Sets the value for the multicast replication session cache. The valid range is from 0 to 500. The default
value is 0.

Command Default This command is disabled by default.

Command Modes Global configuration (config)

Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

Command History Release Modification

12.2(33)SCH This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines Multicast replication session cache feature helps reducing CPU utilization by reusing multicast replication
sessions stored in the cache. The sessions are cached and reused later when a new IGMP join request is
received.

Note Only IPv4 IGMP multicast replication sessions can be cached and reused.

The multicast replication session cache can be configured at a global level for all the interfaces on the Cisco
uBR10012 router or at an interface level for a forwarding interface. The session cache value configured at
the interface shall override the global configuration.
The cable multicast ses-cache command is supported on the integrated-cable, modular-cable, and
wideband-cable interfaces.

Note Ensure that the session cache value being configured is lower than that the current value.

• Changing the multicast replication session cache value from 10 to 0 clears the current cache.
The cable multicast ses-cache command is used with the multicast replication session cache feature:
• DOCSIS 3.0 Multicast Support on the CMTS Routers

Cisco CMTS Cable Command Reference

505
 Cable Commands: cable m to n
cable multicast ses-cache

Examples The following example sets the multicast replication session cache to 100 at the global level on the
Cisco uBR10012 router:

Router# configure terminal

Router(config)# cable multicast ses-cache 100
Router(config)# exit

The following example sets the multicast replication session cache on the integrated interface to 10:

Router# configure terminal

Router(config)# interface Integrated-Cable 8/1/0:0
Router(config-if)# cable multicast ses-cache 10

Related Commands Command Description

clear cable multicast ses-cache Clears the cached multicast replication sessions on the interfaces on the
Cisco uBR10012 router.

show cable multicast ses-cache Displays the multicast replication session cache information both at the
global and interface level of the forwarding interface.

Cisco CMTS Cable Command Reference

506
 Cable Commands: cable m to n
cable multicast source

cable multicast source

To configure a multicast session range for a PacketCable Multimedia (PCMM) multicast group on a Cisco
CMTS router, use the cable multicast source command in global configuration mode. To disable this
configuration, use the no form of this command.

cable multicast source pcmm

no cable multicast source pcmm

Syntax Description pcmm Specifies the PCMM client and enters the multicast session range configuration mode.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced in Cisco IOS Release 12.2(33)SCE.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.18.0S

Examples The following example shows how to configure a multicast session range for a PCMM multicast
group on a Cisco CMTS router:

Router# configure terminal

Router(config)# cable multicast source pcmm
Router(config-msrc)# session-range 229.0.0.0 255.0.0.0

Related Commands Command Description

show packetcable gate multimedia summary Displays information about the total number of PCMM
multicast gates.

Cisco CMTS Cable Command Reference

507
 Cable Commands: cable m to n
cable nd

cable nd
To enable the IPv6 Neighbor Discovery (ND) Gleaning feature on the Cisco CMTS router, use the cable nd
command in bundle interface configuration mode. To disable IPv6 ND gleaning, use the no form of this
command.

cable nd
no cable nd

Syntax Description This command has no arguments or keywords.

Command Default The IPv6 ND Gleaning feature is enabled by default.

Command Modes
Bundle interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable nd command is associated with the IPv6 ND Gleaning feature.
The cable nd command adds a CPE (host behind a cable modem) to the Cisco CMTS subscriber database.
This command does not impact the IPv6 ND protocol operation on the Cisco CMTS router.
The cable ipv6 source-verify and cable nd commands are not compatible with each other in Cisco IOS
Release 12.2(33)SCE and later. You must disable IPv6 ND gleaning using the no form of the cable nd
command before configuring IPv6 source verification using the DHCPv6 Leasequery feature.

Examples The following example shows how to configure IPv6 ND gleaning on the Cisco CMTS router:

Router# configure terminal

Router(config)# interface bundle 1
Router(config-if)# cable nd

Related Commands Command Description

cable ipv6 source-verify Enables source verification of IPv6 packets on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

508
 Cable Commands: cable m to n
cable nd timeout

cable nd timeout
To delete corresponding IPv6 address from the subscriber database after IPv6 Neighbor Discovery (ND)
timeout , use the cable nd timeout command in bundle interface configuration mode. To disable this feature,
use the no form of this command.

cable nd timeout
no cable nd timeout

Syntax Description This command has no arguments or keywords.

Command Default The IPv6 ND Gleaning feature is enabled by default.

Command Modes
Bundle interface configuration (config-if)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines By default, the cable nd timeout command is configured. When configured, if the ND cache of an CPE IPv6
address is timed out, the corresponding IPv6 address will be removed from CMTS subscriber DB. In the no
cable nd timeout configuration, the ND cache timeout will not cause the removal of CPE IPv6 address from
the subscriber DB.

Examples The following example shows how to configure IPv6 ND timeout on the Cisco cBR Series Converged
Broadband Routers:

Router# configure terminal

Router(config)# interface bundle 1
Router(config-if)# cable nd timeout

Related Commands Command Description

cable nd Enables the IPv6 Neighbor Discovery (ND) Gleaning feature on the Cisco CMTS routers.

Cisco CMTS Cable Command Reference

509
 Cable Commands: cable m to n
cable nd validate

cable nd validate
To enable validation checks of neighbor discovery messages (both NA and NS) to ensure that the messages
will be processed, use the cable nd validate command in bundle interface configuration mode. To disable
this feature, use the no form of this command.

cable nd validate
no cable nd validate

Syntax Description This command has no arguments or keywords.

Command Default None.

Command Modes Bundle interface configuration (config-if)

Command History Release Modification

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

Examples The following example shows how to configure IPv6 ND validate on the Cisco cBR Series Converged
Broadband Routers:

Router# configure terminal

Router(config)# interface bundle 1
Router(config-if)# cable nd validate

Related Commands Command Description

cable nd Enables the IPv6 Neighbor Discovery (ND) Gleaning feature on the Cisco CMTS routers.

Cisco CMTS Cable Command Reference

510
Cable Commands: cable o through cable r
• cable ofdm-rf-change-trigger, on page 514
• cable ofdma-frequency-exclusion-band , on page 516
• cable ofdma-frequency-unused-band, on page 517
• cable oudp-leak-detect, on page 518
• cable oob, on page 523
• cable power, on page 524
• cable pre-equalization exclude, on page 527
• cable primary-sflow-qos11 keep, on page 530
• cable privacy, on page 532
• cable privacy bpi-plus-enforce, on page 536
• cable privacy bpi-plus-exclude, on page 538
• cable privacy bpi-plus-policy, on page 539
• cable privacy clone-detect, on page 541
• cable privacy eae-exclude, on page 543
• cable privacy eae-policy, on page 544
• cable privacy encrypt-alg-priority, on page 546
• cable privacy hotlist, on page 548
• cable privacy kek, on page 550
• cable privacy non-mtc-aes128, on page 552
• cable privacy revocation crl skip-sig-check, on page 553
• cable privacy revocation enable, on page 554
• cable privacy revocation ocsp skip-sig-check, on page 555
• cable privacy revocation skip-cm-cert, on page 556
• cable privacy revocation timeout, on page 557
• cable privacy tek, on page 558
• cable profile, on page 560
• cable profile rpd-event, on page 565
• cable proxy-arp, on page 567
• cable qos enforce-rule, on page 569
• cable qos permission, on page 572
• cable qos pre-registration, on page 574
• cable qos pro max-ds-burst, on page 575
• cable queue-limit, on page 578

Cisco CMTS Cable Command Reference

511
 Cable Commands: cable o through cable r

• cable ranging cm packet, on page 580

• cable ranging upstream packet , on page 581
• cable rate-limit-algorithm min-plus-excess, on page 582
• cable rcc-template, on page 583
• cable rcc-templates frequency-based , on page 584
• cable rcp-control, on page 585
• cable rcp-id, on page 587
• cable reconciliation enable , on page 589
• cable reconciliation time , on page 590
• cable reduction-mode energy-management dynamic-channel-percent, on page 591
• cable reduction-mode energy-management enable, on page 592
• cable reduction-mode energy-management process-queue-size, on page 593
• cable reduction-mode energy-management ranging-init-technique, on page 594
• cable reduction-mode mta-battery , on page 595
• cable redundancy hashfilter, on page 597
• cable redundancy myid, on page 599
• cable redundancy node, on page 600
• cable redundancy node frequency, on page 602
• cable redundancy target, on page 603
• cable redundancy threshold, on page 605
• cable registration-timeout, on page 607
• cable relay-agent-option, on page 608
• cable resiliency cm-max-rbg-moves, on page 610
• cable resiliency exclude, on page 611
• cable resiliency ds-bonding, on page 613
• cable resiliency free-interval, on page 614
• cable resiliency idle-interval, on page 615
• cable resiliency rbg-throttle, on page 616
• cable resiliency traps-interval, on page 619
• cable rf-adapt timer, on page 620
• cable rf-bandwidth-percent, on page 622
• cable rf-change-dampen-time, on page 625
• cable rf-change-trigger, on page 626
• cable rf-change-up-multiplier, on page 628
• cable rf-channel, on page 629
• cable rf-channels , on page 634
• cable rfswitch copy, on page 636
• cable rfswitch delete, on page 637
• cable rfswitch reboot, on page 638
• cable rfswitch set-active, on page 639
• cable rpd, on page 640
• cable rpd period-fft (exec mode), on page 642
• cable rpd external-core, on page 643
• cable rphy static-route, on page 645
• cable rphy gcp, on page 647
• cable rphy gcp keepalive timeout, on page 649

Cisco CMTS Cable Command Reference

512
Cable Commands: cable o through cable r

• cable rphy rpd-capability reject-mismatch , on page 651

• cable rphy statistics session update-freq, on page 653
• cable rphy supso suppress-rpd, on page 654
• cable rsvp default-scn, on page 656

Cisco CMTS Cable Command Reference

513
 Cable Commands: cable o through cable r
cable ofdm-rf-change-trigger

cable ofdm-rf-change-trigger
To configure the trigger thresholds specific to OFDM RF impairment, use the cable ofdm-rf-change-trigger
command in global configuration mode.

cable ofdm-rf-change-trigger { count number | percent value | prof-zero-fail dampen-time seconds

recovery-multiplier number } [ no-ncp ] [ no-plc ]

Syntax Description count number Specifies the number of cable modems that must report that a particular non-primary
OFDM RF downstream channel is down before that channel is suspended from the
downstream bonding groups. The default is 0.

no-ncp If you configure this option, the DOCSIS3.1 Downstream Resiliency feature does not
take any action when cable modem reports CM-STATUS-EVENT 20.

no-plc If you configure this option, the DOCSIS3.1 Downstream Resiliency feature does not
take any action when cable modem reports CM-STATUS-EVENT 21.

percent value Indicates the percentage of cable modems that must report that a particular non-primary
OFDM RF channel is down before that channel is suspended from the bonding group.
The valid range is 1 to 100. The default is 0.

prof-zero-fail Configure Profile 0 Failure as an Impairment

dampen-time Configure the time in seconds for a non-primary RF downstream channel status change
to persist. The valid range is 1 to 65535. There is no default value.

recovery-multiplier Multiplier of dampen-time for recovery. Use this option to set an event-specific recovery
delay that is equal to the dampen-time in seconds times the recovery-multiplier value.
The valid range is 1 to 100. There is no default value.

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Dublin 17.12.1z The dampen-time and recovery-multiplier options are added.

Cisco IOS XE Everest 16.10.1d You can exclude NCP and PLC reports separately by configuring
no-ncp or no-plc. This replaces the no-ncp-plc option.

Cisco 1x2 / Compact Shelf RPD Software This command was modified on the Cisco Remote PHY Device
4.1 to add a no-ncp-plc option.

Cisco IOS XE Everest 16.6.1 This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Cisco IOS XE Dublin 17.12.1z and later:

The following example shows how to configure Downstream Resiliency for profile 0:

Cisco CMTS Cable Command Reference

514
 Cable Commands: cable o through cable r
cable ofdm-rf-change-trigger

Router# configure terminal

Router(config)# cable ofdm-rf-change-trigger prof-zero-fail dampen-time 20 recovery-multiplier
2

The following example shows how to disable Downstream Resiliency for profile 0:

Router# configure terminal

Router(config)# no cable ofdm-rf-change-trigger

Disabling downstream resiliency for profile 0, resets dampen-time and recovery-multiplier values to 0.
Cisco IOS XE Dublin 17.12.1y and earlier:
This command is optional and the configured trigger thresholds apply to non-primary OFDM channels only.
If this command is not configured, the trigger thresholds that are configured by the command cable
rf-change-trigger percentis used for the non-primary OFDM channels.
With no-ncp-plc configured in the command, DOCSIS3.1 Downstream Resiliency for RPHY feature does
not take any action when cable modem reports CM-STATUS-EVENT 20 or 21.
The following example shows how to configure DOCSIS3.1 Downstream Resiliency for RPHY:

Router# configure terminal

Router(config)# cable ofdm-rf-change-trigger percent 75 count 10

Related Commands Command Description

cable rf-change-trigger Specifies the amount of time an event must persist before it triggers an action for
the reporting cable modem.

Cisco CMTS Cable Command Reference

515
 Cable Commands: cable o through cable r
cable ofdma-frequency-exclusion-band

cable ofdma-frequency-exclusion-band
To exclude the range of frequencies from all OFDMA channels on a port, use the cable
ofdma-frequency-exclusion-band command in controller configuration mode.

cable ofdma-frequency-exclusion-band start value end value

Syntax Description start Specify the start value of the frequency range.
value

end value Specify the end value of the frequency range.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

Cisco IOS XE Everest 16.6.1 This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines Exclusion bands apply to OFDMA channels only. OFDMA channel does not use frequencies in exclusion
band set by the cable ofdma-frequency-exclusion-band command. So the legacy SC-QAM channel can be
placed in this band.

Related Commands Command Description

cable ofdma-frequency-unused-band Set the frequency range in the unsed band.

Cisco CMTS Cable Command Reference

516
 Cable Commands: cable o through cable r
cable ofdma-frequency-unused-band

cable ofdma-frequency-unused-band
To configure frequencies in unused band, use the cable ofdma-frequency-unused-band command in
controller configuration mode.

cable ofdma-frequency-unused-band start value end value

Syntax Description start Specify the start value of the frequency range.
value

end value Specify the end value of the frequency range.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

Cisco IOS XE Everest 16.6.1 This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines Unused bands apply to OFDMA channels only. OFDMA channel does not use frequencies in unused band
set by the cable ofdma-frequency-unused-band command for data traffic, but can send probes in them.

Related Commands Command Description

cable ofdma-frequency-exclusion-band Set the frequency range to be excluded from all OFDMA channels
on a port.

Cisco CMTS Cable Command Reference

517
 Cable Commands: cable o through cable r
cable oudp-leak-detect

cable oudp-leak-detect
See the OFDMA OUDP Leak Detection Configuration section in the configuration guide for the EXEC,
Global configuration, Configuration and Show commands.
To configure OUDP leakage test sessions on one or more upstream OFMDA channels simultaneously, use
the cable oudp-leak-detect session-id OUDP parent test session id session create command.

cable oudp-leak-detect OUDP parent test session id session { create | delete | stop | reset }

Syntax Description create Creates a new OUDP Parent test session assigning a new parent session ID.

delete Deletes the specified OUDP parent test session and frees the parent session ID and all children sessions
and IDs.

stop Stops the specified OUDP test session in ACTIVE state. Stopping a parent session stops all child
sessions.

reset Resets an OUDP Parent Test Session. Removes all child sessions, deletes all stats, clears the parent
start and stop time, and sets the session status back to CONFIGURING. This CLI is intended to allow
a COMPLETED parent test session to be reused.

Command Modes
Privileged EXEC (#)

Release Modification

17.6.1z This command was introduced.

Usage Guidelines The show cable oudp-leak-detectsession-id OUDP parent test session id session create command is used
to configure OUDP leakage test sessions on one or more upstream OFMDA channels simultaneously.

Examples The following example shows how to create a OUDP parent test session for leak detection:

Router#cable oudp-leak-detect session-id 99 session create

Create Session : 99 (parent) success

cable oudp-leak-detect session-id

To specify the date and time for the test session to start and stop, use the cable oudp-leak-detect session-id
start datetimestop datetime command.

cable oudp-leak-detect session-id OUDP parent test session id { start datetime datetime | stop datetime
datetime }

cable oudp-leak-detect session-id OUDP parent test session id { start now | stop never }

cable oudp-leak-detect session-id OUDP parent test session id frequency start hertz end hertz

Cisco CMTS Cable Command Reference

518
 Cable Commands: cable o through cable r
cable oudp-leak-detect session-id

cable oudp-leak-detect session-id OUDP parent test session id transmit burst duration no. of frames gap
no. of frames { cycle-gap no. of frames | fixed-bursts-per-cycle no. of frames | cycle-time milliseconds }

cable oudp-leak-detect session-id OUDP parent test session id controller upstream-cable

[slot][subslot][ctrlr] us-channel us-chan

cable oudp-leak-detect session-id OUDP parent test session id interface cable [slot][subslot][md-idx]

cable oudp-leak-detect session-id OUDP parent test session id cm { add | delete } mac-address

cable oudp-leak-detect session-id OUDP parent test session id strict-cm-list

cable oudp-leak-detect session-id OUDP parent test session id reserved-probe-pct percentage

cable oudp-leak-detect session-id OUDP parent test session id clear { cm-list | cm-stats | interface |
strict-cm-list }

cable oudp-leak-detect session-id OUDP parent test session id session preview

cable oudp-leak-detect session-id OUDP parent test session id session supha-recover

cable oudp-leak-detect delete all

cable oudp-leak-detect clear system-boot-holdoff

Syntax Description start datetime Date-and-Time Format

[YY]YY-[M]M-[D]D,[h]h:mm:ss.0,[+|-][T]T:ZZ

stop datetime Date-and-Time Format

[YY]YY-[M]M-[D]D,[h]h:mm:ss.0,[+|-][T]T:ZZ

start now stop never In lieu of specifying the Date-and-Time format,

the option start now and stop never are supported.
A test session that is stop never must be manually
stopped or deleted by the administrator.

frequency starthertz endhertz Sets the start and end frequencies of the OUDP
parent test session. The OUDP child test session
includes all minislots, which include the parent test
session frequency range.
The valid range is 4500000-204500000 Hz.

Cisco CMTS Cable Command Reference

519
 Cable Commands: cable o through cable r
cable oudp-leak-detect session-id

transmit burst duration no. of frames gap no. of frames Sets the OUDP parent test session OUDP transmit
{ cycle-gap no. of frames | fixed-bursts-per-cycle no. burst parameters for burst duration, burst gap and
of frames | cycle-time milliseconds } either cycle-gap or cycle-time.
Cycle-Gap complies with the OSSI specifications
for OUDP testing. The OUDP test cycle repeat
interval is measured in frames.
Cycle-Time provides a time-based repeat interval
for the OUDP test cycle that is compatible with
RF-detectors requiring a minimum repeat burst
interval.

controller Sets the OUDP parent test session interface to

upstream-cable[slot][subslot][ctrlr]us-channelus-chan specify an upstream-cable controller, or
upstream-cable controller channel.
A controller upstream-cable interface may expand
to include up to two OFDMA channels/child test
session.
A controller upstream-cable channel specifies a
single OFDMA channels/child session.
A controller upstream-cable channel specifies a
single OFDMA channels/child session.

interface Cable[slot][subslot][md-idx] Sets the OUDP parent test session interface to

specify a mac-domain.
A Cable MAC domain interface may expand to
include up to four OFDMA channels/child sessions.

cm-add mac-address Adds the MAC address to the parent test session
CM-List.

cm-delete mac-address Removes the MAC address from the parent test
session CM-List.

strict-cm-list Requires the child test sessions to preserve the

CM-List position of modems in the parent test
session CM-List.

reserved-probe-pct percentage Reserves a percentage of frames in the OUDP test

cycle for OFDMA channel upstream profile
management probes.
The default value is 3%.

clear Clears the specified item.

{ cm-list | cm-stats | interface |

strict-cm-list }

Cisco CMTS Cable Command Reference

520
 Cable Commands: cable o through cable r
cable oudp-leak-detect

session preview Allows the system admin to preview the child test
session create from an OUDP parent test session
prior to the pretest setup time.
Child test sessions and modems are created based
on the current state of the system, and are not
guaranteed to be the same at the actual pretest setup
time when child test sessions are rebuilt for the
actual test start.

session supha-recover Provides a mechanism for the child test sessions

to be restored to the Active SUP. Existing child
test sessions are deleted and all CLC line cards
update the SUP with their current child test
sessions.

delete all Deletes all OUDP test sessions regardless of state.

clear system-boot-holdoff Allows the administrator to manually terminate the

OUDP system-boot-holdoff timer. OUDP test
sessions are started based on the state of the
OFDMA channels and modems.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This command is introduced on the Cisco cBR Series Converged
Broadband Routers.

cable oudp-leak-detect
You can use the Global configuration mode to execute the cable oudp-leak-detect commands.

cable oudp-leak-detect pre-test-setup-time seconds

cable oudp-leak-detect system-boot-holdoff minutes

cable oudp-leak-detect reserved-probe-pct percentage

cable oudp-leak-detect ccap-modem-select allow-late-cm-join

cable oudp-leak-detect ccap-modem-select allow-late-cm-join { all | icmts | none }

Syntax Description pre-test-setup-time seconds The valid range is 10-300 seconds. The default value is 60 seconds.

expire-age days The valid range is 1-7 days. The default value is 3 days.

Cisco CMTS Cable Command Reference

521
 Cable Commands: cable o through cable r
cable oudp-leak-detect

system-boot-holdoff minutes
reserved-probe-pct percentage The valid range is 0-10 percent. The default value is 3 percent.

modem-selectallow-late-cm-join Enables modems to join child test sessions after they reach the active
state. Normal rules for CM-List and interface modem participation
apply.

adjust-test-time { all | icmts | none OUDP tests are scheduled based on the PTP/GPS clock time. The
} CLC line card scheduler uses the DOCSIS frame clock. This command
enables a timing adjustment between the GPS clock and the DOCSIS
clock. Normally RPHY will not require the time adjustment, whereas
iCMTS does.
The default value is icmts.

Command Default None.

Command Modes Global Configuration (config)

cable oudp-leak-detect
You can use the Configuration mode to execute the cable oudp-leak-detect commands.

cable oudp-leak-detect burst-profile number

cable oudp-leak-detect burst-profile number start datetime datetime

cable oudp-leak-detect burst-profile number start now stop never

cable oudp-leak-detect schedule recurring weekday days start timeofday time stop timeofday time

Syntax Description burst-profile number Creates a OUDP burst profile and enters the burst profile
configuration sub-mode.
The valid range is 1-9999.

burst-profilenumberstart datetimedatetime Creates a persistent one-time scheduled test session.

cable oudp-leak-detect Creates a persistent 24x7 OUDP test session.

burst-profilenumberstart now stop never
cable oudp-leak-detect schedule recurring Creates a persistent weekly test session that runs at the same
weekdaydaysstart timeofdaytimestop time, each day, on configured weekdays
timeofdaytime (“SuMoTuWeThFrSa”).
One or more weekdays, for example, "MoWeFr” must be
specified.

Command Default None.

Command Modes Configuration (config)

Cisco CMTS Cable Command Reference

522
 Cable Commands: cable o through cable r
cable oob

cable oob
To enter the out of band (OOB) configuration mode, use the cable oob command in global configuration
mode. To void the OOB configuration, use the no form of this command.

cable oob

no cable oob

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to enter the OOB configuration mode.

Examples The following example shows how to enter the OOB configuration mode:

Router# configure terminal

Router(config)# cable oob
Router(config-oob)#

Related Commands Command Description

virtual-arpd Defines a virtual advanced return path demodulator

configuration.

virtual-om Defines a virtual OOB modulator configuration.

Cisco CMTS Cable Command Reference

523
 Cable Commands: cable o through cable r
cable power

cable power
To manually power a cable interface line card on or off on a Cisco uBR10012 router, use the cable power
command in privileged EXEC mode.

cable power [on | off] slot/card

Syntax Description on Turns on power to the specified cable interface line card.

off Turns off power to the specified cable interface line card. Power to that particular card slot remains
off until power is turned back on using the cable power on version of this command.

slot/card Specifies the slot and card number for the desired cable interface card number. The valid range
for slot is 5 to 8 and for card is 0 or 1.

Command Default Cable interface line cards are powered on by default when the card is inserted into the chassis slot.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(4)BC1b This command was introduced for the Cisco uBR10012 router.

12.2(8)BC1 This command is disabled if a working TCC+ card is not present in the Cisco uBR10012
router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is typically not used during normal operations, but it can be used for lab, diagnostic, and
troubleshooting purposes. For example, using this command to first power off and then power on a card is
functionally equivalent to performing an online insertion and removal (OIR) of the card.
Be aware of the following points when using this command:
• Using the cable power off command is functionally equivalent to disconnect the cables from the card’s
upstream and downstream connectors and then removing the card from the chassis. When you use this
command to turn off power to a card, the output for the show interface cable command for that card
will display the message “Hardware is not present.”

Note You can also use the LC Power off Status Reg and Line Card Presence Status Reg fields in the show controllers
clock-reference command to determine whether a cable interface line card is actually present in the chassis
and whether it has been powered on or off.

Cisco CMTS Cable Command Reference

524
 Cable Commands: cable o through cable r
cable power

• Powering off a cable interface line card automatically drops all sessions with the cable modems that are
using that card’s upstreams and downstreams. Do not use this command on a live network unless this is
what you intend.
• All cards are powered on when you upgrade to a new software image for the Cisco uBR10012 router,
even if a card had previously been powered off using the cable power off command.
• You can turn power both on and off to a cable interface line card slot, even if a card is not physically
present in the slot.
• This is the only CLI command that actually powers off a card. The hw module reset command appears
to perform a similar function, but it performs only the equivalent of issuing the shutdown and no
shutdown commands on the card.
• When power is turned off for a cable interface line card, the power to that card slot will remain off until
the cable power on command is used to turn the power back on. If you insert a cable interface card in
to a slot that had been previously powered down, you will have to use the cable power on command to
turn on power before being able to use the card.
• This command requires that a working TCC+ card be present because the TCC+ card controls and
monitors the operation of the cable interface line cards. In Cisco IOS Release 12.2(8)BC1 and later, this
command is disabled if a working TCC+ card is not present in the router.

Note The Cisco uBR10012 router requires a working TCC+ card for normal operations. Using the router without
a working TCC+ card is not a supported configuration.

Examples The following example shows how to power off the first cable interface card in a Cisco uBR10012
chassis (card 5, slot 0). It also shows the output from the show interface cable command, with a
line that indicates that the hardware is not present.

router# cable power off 5/0

Line Card 5/0 is POWERED OFF

router# show int c5/0/0

Cable5/0/0 is down, line protocol is down

Hardware is not present
Hardware is UBR10012 CLC, address is 0005.00e0.2f14 (bia 0005.00e0.2f14)
Internet address is 10.20.42.1/24
MTU 1500 bytes, BW 27000 Kbit, DLY 1000 usec,
reliability 255/255, txload 1/255, rxload 1/255
...
router#

Note The show interface cablecommand will not display output for a card that is not physically present,
so if you can use the show interface cable command but it indicates that the hardware is not present,
this usually means that power to the card has been turned off using the cable power offcommand.

The following example shows the error message that results when you attempt to power on or off a
cable interface card that is not physically present in the chassis:

router# cable power off 6/1

Cisco CMTS Cable Command Reference

525
 Cable Commands: cable o through cable r
cable power

Line Card 6/1 is not present

router#

Note Power is still turned on or off to a cable interface line card slot, even when the card is not physically
present in that slot.

Related Commands Command Description

hw module reset Resets a line card, performing the equivalent of the shutdown, no
shutdown commands.

show controllers clock-reference Displays status information from the TCC+ card, including whether a
line card is physically present and whether power has been turned off
to its slot.

show interface cable Displays configuration and status information for a cable interface line
card.

show version Displays the basic configuration of the router, including whether an
active TCC+ card is present.

shutdown Disables or enables the interface on a line card.

Cisco CMTS Cable Command Reference

526
 Cable Commands: cable o through cable r
cable pre-equalization exclude

cable pre-equalization exclude

To exclude a cable modem (CM) from pre-equalization during registration with the Cisco CMTS router, use
the cable pre-equalization excludecommand in global configuration mode. To remove exclusion for the
specified cable modem or interface, use the no form of this command.

cable pre-equalization exclude {modem mac-addr | oui id}

no cable pre-equalization exclude {modem mac-addr | oui id}

Syntax Description modem Excludes the cable modem with the specified MAC address from pre-equalization during
mac-addr cable modem registration.

oui id Excludes the specified Organizational Unique Identifier (OUI) from pre-equalization
during cable modem registration.

Command Default Pre-equalization is disabled by default on a Cisco CMTS router, and for cable modems that have a valid and
operational DOCSIS configuration file.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(17a)BC This command was introduced to the Cisco uBR10012 router and the Cisco uBR7246VXR
router.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the cable pre-equalization exclude command to disable pre-equalization for DOCSIS 1.1 CMs that
claim pre-equalization support but do not properly implement pre-equalization functions.
To enable pre-equalization, use the cable upstream equalization-coefficient interface configuration command.
Pre-equalization starts when a cable modem that supports DOCSIS 1.1 or above sends the CMTS router a
ranging request message indicating that pre-equalization is possible.
The following example of output from the show cable modem verbose command shows which modems are
indicating pre-equalizer support during the DOCSIS registration process. In this example, the first two modems
are capable of pre-equalization support, and the last two modems support DOCSIS 1.0, which does not support
pre-equalization. You do not need to use the cable pre-equalization exclude command for DOCSIS 1.0 CMs.

Router# show cable modem verbose | include MAC Address|Equalizer

MAC Address : 0019.474a.c4b0
Transmit Equalizer Support : {Taps/Symbol= 1, Num of Taps= 24}
MAC Address : 0019.474a.c498
Transmit Equalizer Support : {Taps/Symbol= 1, Num of Taps= 24}
MAC Address : 0020.40dc.4ce4
Transmit Equalizer Support : {Taps/Symbol= 0, Num of Taps= 0}

Cisco CMTS Cable Command Reference

527
 Cable Commands: cable o through cable r
cable pre-equalization exclude

MAC Address : 0020.4077.21a0

Transmit Equalizer Support : {Taps/Symbol= 0, Num of Taps= 0}

Exclusion is supported for a specified DOCSIS 1.1 cable modem, or for a specified OUI value for the entire
interface. Removing the cable pre-equalization exclude configuration returns the cable modem or interface
to normal pre-equalization processes during cable modem registration.

Examples The following example configures pre-equalization to be excluded for the specified cable modem.
Pre-equalization data is not sent for the corresponding cable modem:

Router(config)# cable pre-equalization exclude modem 1111.2222.3333

The following example configures pre-equalization to be excluded for the specified OUI value of
the entire interface. Pre-equalization data is not sent for the corresponding OUI value of the entire
interface:

Router(config)# cable pre-equalization exclude oui

00.09.04

The following series of commands configures pre-equalization on the Cisco uBR10012 router with
MC5X20U BPEs. On the PRE Console, configure the following commands.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable pre-equalization exclude oui 00.09.04
Router(config)# end
Router# show run
Router# show running-config | include oui
cable pre-equalization exclude oui 00.09.04
Router#

On the line card console for the same Cisco uBR10012 router, verify the configuration with the
following command:

Linecard# show running-config | include oui

cable pre-equalization exclude oui 00.09.04

The following series of commands configures pre-equalization on the Cisco uBR7246VXR router
with MC28U cable interface line cards. On the Network Processing Engine (NPE) console, configure
and verify with the following commands.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable pre-equalization exclude oui 00.09.24
Router(config)# end
Router#show run
02:58:10: %SYS-5-CONFIG_I: Configured from console by consolen
Router# show running-config | include oui
cable pre-equalization exclude oui 00.09.24

On the line card console for the same Cisco uBR7246VXR router, verify the configuration with the
following command:

Linecard# show running-config | include oui

cable pre-equalization exclude oui 00.09.24

Cisco CMTS Cable Command Reference

528
 Cable Commands: cable o through cable r
cable pre-equalization exclude

After either of these exclusion methods for pre-equalization are configured, you can verify that all
ranging messages do not include pre-equalization data. Use the following debug commands in global
configuration mode:
• debug cable range
• debug cable interface cx/x/x mac-addr
Verify the ranging message for the non-excluded cable modems include pre-equalization data, and
for the excluded cable modems, the ranging messages do not include such data.
The following example removes pre-equalization exclusion for the specified OUI and interface. This
results in the cable modem or OUI to return to normal pre-equalization functions. Ranging messages
resume sending pre-equalization data.

Router(config)# no cable pre-equalization exclude {modem mac-addr | oui id}

You can verify removal of this feature using the debug cable interfacecommand.

Related Commands Command Description

debug cable interface Verifies pre-equalization data and configurations.

debug cable range Verifies ranging messages for pre-equalization.

Cisco CMTS Cable Command Reference

529
 Cable Commands: cable o through cable r
cable primary-sflow-qos11 keep

cable primary-sflow-qos11 keep

To preserve the traffic counters for primary service flows after a CM that was provisioned for DOCSIS 1.1
quality of service (QoS) goes offline, use the cable primary-sflow-qos11 keep command in global
configuration mode. To return to the default configuration and reset the counters to zero when a DOCSIS
1.1-provisioned CM goes offline, use the no form of this command.

cable primary-sflow-qos11 keep {all | snmp-only}

no cable primary-sflow-qos11 keep

Syntax Description all Preserves all primary service flow traffic counters when a DOCSIS 1.1-provisioned CM goes
offline. This includes the counters displayed by CLI commands and counters that are obtained
through SNMP requests.

snmp-only Preserves only the primary service flow traffic counters that are obtained through SNMP requests.
The counters displayed by CLI commands are reset to zero when a DOCSIS 1.1-provisioned
CM goes offline.

Command Default Primary service flow traffic counters are not preserved after a DOCSIS 1.1-provisioned CM goes offline (no
cable primary-sflow-qos11 keep). Service-flow information is always preserved for DOCSIS 1.0-provisioned
CMs, regardless of the configuration of this command.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)CX, 12.2(15)BC2 This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines By default, when a CM that is provisioned for DOCSIS 1.1 quality of service (QoS) service flows goes offline,
the CMTS deletes all service flow information, including traffic counters, that correspond to that CM. The
cable primary-sflow-qos11 keep command preserves the service flow traffic counters after a DOCSIS
1.1-provisioned CM goes offline and then comes back online. This allows service providers to track the total
usage of CMs over a period of time, regardless of the number of times the CMs go offline and reboot.

Note This command affects only CMs that are provisioned for DOCSIS 1.1 operations and that are currently online
all cable interfaces on the Cisco CMTS. Information is not preserved for DOCSIS 1.1-provisioned CMs that
went offline before this command was given. The service-flow information for CMs that are provisioned for
DOCSIS 1.0 operations is always preserved, regardless of how this command is configured.

Examples The following example shows how to preserve both the CLI and SNMP service flow counters when
a DOCSIS 1.1-provisioned CM goes offline:

Cisco CMTS Cable Command Reference

530
 Cable Commands: cable o through cable r
cable primary-sflow-qos11 keep

Router(config)# cable primary-sflow-qos11 keep all

Router(config)#

The following example shows how to preserve only the SNMP-based service flow counters when a
DOCSIS 1.1-provisioned CM goes offline. The CLI-based counters are still reset to zero when this
CM goes offline.

Router(config)# cable primary-sflow-qos11 keep snmp-only

Router(config)#

The following example shows how to disable this command and return to the default behavior, which
is to reset all CLI-based and SNMP-based counters when a DOCSIS 1.1-provisioned CM goes offline.

Router(config)# no cable primary-sflow-qos11 keep

Router(config)#

Related Commands Command Description

cable sflog Enables service flow logging and configures the number and duration of
entries in the log.

show cable modem counters Displays downstream and upstream traffic counters for one or more CMs.

Cisco CMTS Cable Command Reference

531
 Cable Commands: cable o through cable r
cable privacy

cable privacy
To enable and configure BPI or BPI+ encryption, use the cable privacy command in cable interface
configuration mode or MAC domain profile configuration mode. To disable privacy or to remove a particular
configuration, use the no form of this command.

Cisco uBR Series Router

cable privacy [accept-self-signed-certificate | authenticate-modem | authorize-multicast | mandatory
| oaep-support | dsx-support | retain-failed-certificates | skip-validity-period]
no cable privacy [accept-self-signed-certificate | authenticate-modem | authorize-multicast | mandatory
| oaep-support | dsx-support | retain-failed-certificates | skip-validity-period]

Cisco cBR Series Router

cable privacy [accept-self-signed-certificate | mandatory | oaep-support | dsx-support |
retain-failed-certificates | skip-validity-period]
no cable privacy [accept-self-signed-certificate | mandatory | oaep-support | dsx-support |
retain-failed-certificates | skip-validity-period]

Syntax Description accept-self-signed-certificate (Optional) Allows cable modems to register using self-signed
manufacturer certificates, as opposed to a manufacturer certificate that
is chained to the DOCSIS root certificate.

authenticate-modem (for uBR (Optional) Uses AAA protocols in conjunction with BPI to authenticate
series router) all CMs.

authorize-multicast (for uBR (Optional) Uses AAA protocols with baseline privacy interface (BPI)
series router) to authorize all multicast stream (IGMP) join requests.

mandatory (Optional) Requires baseline privacy be active for all CMs with BPI/BPI+
enabled in their DOCSIS configuration files or the CMs are forced to
go offline.
If a CM does not have BPI enabled in its DOCSIS configuration file, it
will be allowed online without BPI.

oaep-support (Optional) Enables Optimal Asymmetric Encryption Padding (OAEP)

BPI+ encryption.

dsx-support (Optional) Enables encryption for dynamic services SIDs.

retain-failed-certificates (Optional) Allows to retain failed certificates.

skip-validity-period (Optional) Enables to skip certificate validity period.

Command Default The encryption priority defaults to 128bit AES, 56bit DES, 40bit DES depending on modem capability. The
CMTS treats self-signed manufacturer certificates as untrusted. Untrusted certificates are not retained by the
CMTS.

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

Cisco CMTS Cable Command Reference

532
 Cable Commands: cable o through cable r
cable privacy

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.1 T This command was introduced.

12.1(4)CX, 12.2(1)XF1, Added the dsx-supportandoaep-support keywords as part of support for

12.2(4)BC1 BPI+ encryption.

12.2(11)BC1 Changed the accept-self-signed-certificate option from a global

configuration option to a cable interface option.

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

12.2(33)SCC This command was modified. Added the retain-failed-certificates and

skip-validity-period keywords. Removed the 40-bit-des keyword.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged
Broadband Routers. The authenticate-modem and authorize-multicast
keywords were removed.

IOS XE Fuji 16.7.1 This command was modified to support MAC domain profile configuration
on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is applicable only on images that support BPI or BPI+ encryption.

Note The cable privacy accept-self-signed-certificate command affects only those CMs that register after you
give the command. For example, if you give the no cable privacy accept-self-signed-certificate command
so that CMs cannot register using self-signed certificates, you must then issue the clear cable modem all
reset command to force all CMs reregister using certificates that are chained to the DOCSIS root certificate.

Providing Self-Signed Certificates

Cisco IOS Release 12.2(33)SCC and later releases allow self-signed CA certificates to be programmed on
the file system to allow specific modems to authenticate. This is frequently used for test equipment and modems
that are not DOCSIS compliant.
To provide self-signed CA certificates, perform the following steps:
1. Acquire the CA certificate in Distinguished Encoding Rules (DER) format. This can be supplied by the
manufacturer or retrieved from the cable modem.
2. Store the self-signed CA certificate in the bootflash by naming it “trusted-cert-scert n”, for example
“trusted-cert-scert1” or “trusted-cert-scert2”.
3. Ensure that cable privacy accept-self-signed-certificate command is not enabled.
4. Save the configuration.
5. Reboot the router.

The router reads the new files and the self-signed cable modem comes online.

Cisco CMTS Cable Command Reference

533
 Cable Commands: cable o through cable r
cable privacy

Examples The following example shows how to force baseline privacy interface (BPI) to be used for all CMs
on a particular cable interface:

Router(config)# interface cable 6/0/0

Router(config-if)# cable privacy mandatory

The following example shows how to turn on the BPI modem authentication for an interface:

Router(config)# interface cable 6/0/1

Router(config-if)# cable privacy authenticate-modem

The following example shows how to turn on BPI multicast authorization on a particular cable
interface on Cisco uBR series router:

Router(config)# interface cable 1/0

Router(config-if)# cable privacy authorize-multicast

The following example shows how to allow CMs to register with self-signed certificates on a particular
cable interface:

Router(config)# interface cable 7/0/0

Router(config-if)# cable privacy accept-self-signed-certificate

The following example shows how to allow CMs to enable privacy DSX support on a particular
cable interface:

Router(config)# interface cable 6/0/0

Router(config-if)# cable privacy dsx-support

The following example shows how to allow CMs to enable OAEP support on a particular cable
interface:

Router(config)# interface cable 6/0/0

Router(config-if)# cable privacy oaep-support

The following example shows how to allow CMs to retain failed certificates on a particular cable
interface:

Router(config)# interface cable 6/0/0

Router(config-if)# cable privacy
retain-failed-certificates

The following example shows how to allow CMs to skip certificate validity period on a particular
cable interface:

Router(config)# interface cable 6/0/0

Router(config-if)# cable privacy
skip-vailidity-period

Related Commands Command Description

cable privacy eae-policy Selects Early Authentication and Encryption policy.

cable privacy hotlist Adds a CM certificate to the DOCSIS hotlist so that it is no longer accepted.

Cisco CMTS Cable Command Reference

534
Cable Commands: cable o through cable r
cable privacy

Command Description

cable privacy kek Sets key encryption keys and timeout periods.

cable privacy tek Sets traffic encryption keys and timeout periods.

show cable privacy Displays information about BPI status and operation.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

535
 Cable Commands: cable o through cable r
cable privacy bpi-plus-enforce

cable privacy bpi-plus-enforce

Note Effective with Cisco IOS Release 12.2(33)SCD5, the cable privacy bpi-plus-enforce command is replaced
with the cable privacy bpi-plus-policy command. For more information, see the cable privacy bpi-plus-policy
command.

To mandate that a cable modem provisioned in DOCSIS 1.1 or higher must register with DOCSIS Baseline
Privacy Interface Plus (BPI+), and not use the earlier DOCSIS BPI, use the cable privacy bpi-plus-enforce
command in global configuration mode. To remove this configuration, use the no form of this command.

cable privacy bpi-plus-enforce

no cable privacy bpi-plus-enforce

Syntax Description This command has no arguments or keywords.

Command Default The cable privacy bpi-plus-enforce command is not enabled by default, but must be configured for optimal
DOCSIS BPI+ security.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced.

12.2(33)SCD5 This command was replaced with the cable privacy bpi-plus-policy command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable privacy bpi-plus-enforce command enables the Cisco CMTS router to detect cloned cable modems
and eliminate denial-of-service (DOS) attacks that are caused by cloned cable modems.
If the cable modem is not provisioned to use DOCSIS BPI or BPI+ security certificates, then the existing
behavior of the Cisco CMTS router remains unchanged. The Cisco CMTS router does not attempt to distinguish
between two cable modems if neither is provisioned for BPI+ security.

Note The non-DOCSIS compliant cable modems that are commonly available contain an option to force registration
in DOCSIS BPI, as opposed to DOCSIS BPI+ mode, even in DOCSIS 1.1-provisioned networks.

Examples The following example illustrates logging messages that are created with the detection of cloned
cable modems:

SLOT 7/0: Nov 14 12:07:26: %UBR10000-6-CMMOVED: Cable modem 0007.0e03.3e71 has been moved
from interface Cable7/0/1 to interface Cable7/0/0.

Cisco CMTS Cable Command Reference

536
 Cable Commands: cable o through cable r
cable privacy bpi-plus-enforce

Nov 14 12:07:57: %UBR10000-5-CLONED_CM_DETECTED: Cloned CM with MAC address 0013.7116.e726

access detected at Cable7/0/0 interface

Related Commands Command Description

cable logging layer2events Saves selected (low priority) DOCSIS events that are specified in the Cisco
CMTS MIB registry to the cable logging buffer (instead of to the general
logging buffer).

cable privacy bpi-plus-policy Configures the BPI+ enforcement policies on a Cisco CMTS router.

show cable logging Displays the log of messages about bad IP source addresses or DOCSIS layer
events on the cable interfaces.

show cable modem Displays information for registered and non-registered cable modems on the
Cisco CMTS.

Cisco CMTS Cable Command Reference

537
 Cable Commands: cable o through cable r
cable privacy bpi-plus-exclude

cable privacy bpi-plus-exclude

To exclude cable modems from the Baseline Privacy Interface Plus (BPI+) enforcement policies configured
on a Cisco CMTS router, use the cable privacy bpi-plus-exclude command in global configuration mode.
To disable this configuration, use the no form of this command.

cable privacy bpi-plus-exclude mac-address [address-mask]

no cable privacy bpi-plus-exclude mac-address [address-mask]

Syntax Description mac-address Cable modem MAC address.

address-mask (Optional) Cable modem subnet.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD5 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines You can exclude individual cable modems, which are compliant with DOCSIS 1.0 and later versions, from
the BPI+ enforcement policy based on their MAC addresses on a per-MAC domain basis. If a cable modem
is added to the exclusion list, the Cisco CMTS router does not enforce the BPI+ enforcement policy on that
cable modem. You can exclude a maximum of 30 cable modems per MAC domain.

Examples The following example shows how to exclude a cable modem from the BPI+ enforcement policy
based on its MAC address:

Router# configure terminal

Router(config)# cable privacy bpi-plus-exclude 0010.9571.03ab

Related Commands Command Description

cable privacy bpi-plus-policy Configures the BPI+ enforcement policy on a Cisco CMTS router.

show interface cable privacy Displays baseline privacy information.

Cisco CMTS Cable Command Reference

538
 Cable Commands: cable o through cable r
cable privacy bpi-plus-policy

cable privacy bpi-plus-policy

To configure the Baseline Privacy Interface Plus (BPI+) enforcement policies on a Cisco CMTS router, use
the cable privacy bpi-plus-policy command in cable interface configuration mode. To disable this
configuration, use the no form of this command.

cable privacy bpi-plus-policy {capable-enforcement | d11-enabled-enforcement | d11-enforcement |

total-enforcement}
no privacy bpi-plus-policy {capable-enforcement | d11-enabled-enforcement | d11-enforcement |
total-enforcement}

Syntax Description capable-enforcement Specifies that BPI+ enforcement is required on all BPI+ capable cable modems
that are BPI+ enabled and provisioned with DOCSIS1.1 configuration file (Policy
1).

d11-enabled-enforcement Specifies that BPI+ enforcement is required on all cable modems that register
with a DOCSIS 1.1 configuration file with parameters indicating BPI+ is enabled
with or without TLV 29 (Policy 2).

d11-enforcement Specifies that BPI+ enforcement is required on all cable modems that are
compliant with DOCSIS 1.1 and later versions (Policy 3).

total-enforcement Specifies that BPI+ enforcement is required on all cable modems (Policy 4).

Command Default None

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

Command History Release Modification

12.2(33)SCD5 This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable privacy bpi-plus-policy command replaced the cable privacy bpi-plus-enforce command in
Cisco IOS Relase12.2(33)SCD5. If you upgrade from an earlier Cisco IOS Release to Cisco IOS Release
12.2(33)SCD5 and later, the existing BPI+ enforcement configuration is disabled by default during the upgrade.
You must reconfigure the BPI+ enforcement policy using the cable privacy bpi-plus-policy command.
You can configure only one enforcement policy at a time per MAC domain. If you configure one policy after
another, the latest policy supersedes the already existing policy. For example, if you want Policy 2 to take
over Policy 1, you can directly configure the former without disabling the latter.

Examples The following example shows how to configure BPI+ enforcement policies on the cable interface
3/0 on the Cisco uBR7246VXR router:

Router# configure terminal

Cisco CMTS Cable Command Reference

539
 Cable Commands: cable o through cable r
cable privacy bpi-plus-policy

Router(config)# interface cable 3/0

Router(config-if)# cable privacy bpi-plus-policy capable-enforcement
Router(config-if)# cable privacy bpi-plus-policy d11-enabled-enforcement
Router(config-if)# cable privacy bpi-plus-policy d11-enforcement
Router(config-if)# cable privacy bpi-plus-policy total-enforcement

Related Commands Command Description

cable privacy bpi-plus-exclude Excludes individual cable modems from BPI+ enforcement policies based
on their MAC addresses.

show interface cable privacy Displays baseline privacy information.

Cisco CMTS Cable Command Reference

540
 Cable Commands: cable o through cable r
cable privacy clone-detect

cable privacy clone-detect

To enable the clone modem functionality for a cable modem, use the cable privacy clone-detect command
in global configuration mode. To disable clone modem functionality, use the no form of this command.

cable privacy clone-detect

no cable privacy clone-detect

Syntax Description This command has no keywords or arguments.

Command Default The clone modem functionality is enabled .

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows how to enable the clone modem functionality, so that the cloned cable
modems cannot register with the CMTS:

Router# configure terminal

Router(config)# cable privacy clone-detect

Related Commands Command Description

cable privacy Enables and configures BPI+ encryption on a cable interface.

(Not supported for Cisco uBR10K Series Specifies that a cable modem provisioned in DOCSIS 1.1 or higher
and cBR Series Converged Broadband must register with DOCSIS BPI+, and not use the earlier DOCSIS
Routers) cable privacy BPI.
bpi-plus-enforce

cable logging layer2events Saves selected (low priority) DOCSIS events that are specified in
the Cisco CMTS MIB registry to the cable logging buffer (not of
the general logging buffer).

show cable logging Displays the log of messages, about bad IP source addresses or
DOCSIS-layer events, on the cable interfaces.

show cable modem Displays information for registered and non-registered cable
modems on the Cisco CMTS.

Cisco CMTS Cable Command Reference

541
 Cable Commands: cable o through cable r
cable privacy clone-detect

Command Description

show running-config interface cable Displays the bundles that are configured on a Cisco CMTS router
showing the running configuration for each of the cable interfaces.

Cisco CMTS Cable Command Reference

542
 Cable Commands: cable o through cable r
cable privacy eae-exclude

cable privacy eae-exclude

To force a cable modem to register without an Early Authentication and Encryption (EAE) and add it to the
EAE exclusion list, use the cable privacy eae-exclude command in global configuration mode. To remove
a particular CM from the exclusion list, use the no form of this command.

cable privacy eae-exclude cm-mac-address [mask]

no cable privacy eae-exclude cm-mac-address [mask]

Syntax Description cm-mac-address Hardware (MAC) address of a specific cable modem to be added to the EAE exclusion
list.

mask (Optional) Mask value for the cable modem.

Command Default The EAE exclusion list does not contain any MAC address.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The exclusion list is mainly used to debug issues with specific cable modems.

Examples The following example shows how to add a CM with the MAC address of 00C0.8345.de51 to the
EAE exclusion list, so that this particular CM cannot register with the CMTS:

Router# configure terminal

Router(config)# cable privacy eae-exclude 00C0.8345.de51
Router(config)#

Related Commands Command Description

cable privacy Enables and configures BPI+ encryption on a cable interface.

cable privacy kek Sets key encryption keys and timeout periods.

cable privacy tek Sets traffic encryption keys and timeout periods.

show cable privacy Displays information about BPI status and operation.

Cisco CMTS Cable Command Reference

543
 Cable Commands: cable o through cable r
cable privacy eae-policy

cable privacy eae-policy

To enable the Early Authentication and Encryption (EAE) policy, use the cable privacy eae-policy command
in cable interface configuration mode or MAC domain profile configuration mode. To disable the EAE policy,
use the no form of this command.

cable privacy eae-policy {capability-enforcement | disable-enforcement | ranging-enforcement |

total-enforcement}
no cable privacy eae-policy {capability-enforcement | disable-enforcement | ranging-enforcement
| total-enforcement}

Syntax Description capability-enforcement Enforces EAE on capable modems.

disable-enforcement Disables EAE thereby preventing the CMTS from enforcing EAE on any cable
modem.

ranging-enforcement Enforces EAE only on DOCSIS 3.0 modems.

total-enforcement Enforces EAE on all cable modems.

Command Default EAE policy is disabled.

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines The EAE policy is applied on a MAC domain and the policies are mutually exclusive. The CMTS enforces
EAE only on CMs that initialize on a downstream channel on which the CMTS is transmitting MAC Domain
Descriptor (MDD) messages.
The EAE exclusion list is a global list and is created on all line cards as part of the DOCSIS 3.0 specifications.
Cable modems in the EAE exclusion list are always exempted from EAE enforcement. If the CMTS receives
an authorization request before the CM is registered in the EAE exclusion list, the CMTS rejects that request.

Note When Early Authentication and Encryption is enabled in Cisco cBR-8 router, BPI will revert back to DES-56
even if the hardware supports AES-128.

Cisco CMTS Cable Command Reference

544
 Cable Commands: cable o through cable r
cable privacy eae-policy

Examples The following example shows how to enforce EAE policy on capable modems:

Router(config)# interface cable 3/0/0

Router(config-if)# cable privacy eae-policy capability-enforcement

The following example shows how to disable EAE policy so that the CMTS does not enforce EAE
policy on any cable modem:

Router(config)# interface cable 3/0/0

Router(config-if)# cable privacy eae-policy disable-enforcement

The following example shows how to enforce EAE policy on DOCSIS 3.0 modems only:

Router(config)# interface cable 3/0/0

Router(config-if)# cable privacy eae-policy ranging-enforcement

The following example shows how to enforce EAE policy on all cable modems:

Router(config)# interface cable 3/0/0

Router(config-if)# cable privacy eae-policy total-enforcement

Related Commands Command Description

cable privacy exe-exclude Adds the CM to be excluded from EAE policy enforcement.

cable privacy hotlist Adds a CM certificate to the DOCSIS hotlist so that it is no longer accepted.

cable privacy kek Sets key encryption keys and timeout periods.

cable privacy tek Sets traffic encryption keys and timeout periods.

show cable privacy Displays information about BPI status and operation.

Cisco CMTS Cable Command Reference

545
 Cable Commands: cable o through cable r
cable privacy encrypt-alg-priority

cable privacy encrypt-alg-priority

To specify the order in which to use the Advanced Encryption Standard (AES) and Data Encryption Standard
(DES) encryption algorithm, use the cable privacy encrypt-alg-priority command in global configuration
mode. To remove the encryption algorithm and revert to the default priority, use the no form of this command.

cable privacy encrypt-alg-priority {aes128-des40-des56 | aes128-des56-des40 | des40-aes128-des56 |

des40-des56-aes128 | des56-aes128-des40 | des56-des40-aes128}
no cable privacy encrypt-alg-priority

Syntax Description aes128-des40-des56 Specifies the order of the encryption algorithm priority.
AES with a 128-bit block is given the highest priority, followed by DES with 40-bit
block size, and DES with 56-bit block size.

aes128-des56-des40 Specifies the order of the encryption algorithm priority.

AES with a 128-bit block size is given the highest priority, followed by DES with
56-bit block size, DES with 40-bit block size.

des40-aes128-des56 Specifies the order of the encryption algorithm priority.

DES with 40-bit block size is given the highest priority, followed by AES with a
128-bit block size, and DES with 56-bit block size.

des40-des56-aes128 Specifies the order of the encryption algorithm priority.

DES with 40-bit block size is given the highest priority, followed by DES with 56-bit
block size and AES with 128-bit block size.

des56-aes128-des40 Specifies the order of the encryption algorithm priority.

DES with 56-bit block size is given the highest priority, followed by AES with a
128-bit block size, and DES with 40-bit block size.

des56-des40-aes128 Specifies the order of the encryption algorithm priority.

DES with 56-bit block size is given the highest priority, followed by DES with 40-bit
block size, and AES with a 128-bit block size.

Command Default Default value is aes128-des56-des40.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Cisco CMTS Cable Command Reference

546
 Cable Commands: cable o through cable r
cable privacy encrypt-alg-priority

Usage Guidelines Use this command to specify the order of the encryption algorithm priority.
When Early Authentication and Encryption is enabled in Cisco cBR-8 router, BPI will revert back to DES-56
even if the hardware supports AES-128.

Examples The following example shows how to assign AES the highest priority, followed by 40-bit DES, and
56-bit DES.

Router# configure terminal

Router(config)# cable privacy encrypt-alg-priority aes128-des40-des56
Router(config)#

Related Commands Command Description

cable privacy Enables and configures BPI+ encryption on a cable interface.

cable privacy kek Sets key encryption keys and timeout periods.

cable privacy tek Sets traffic encryption keys and timeout periods.

show cable privacy Displays information about BPI status and operation.

Cisco CMTS Cable Command Reference

547
 Cable Commands: cable o through cable r
cable privacy hotlist

cable privacy hotlist

To mark a manufacturer’s or CM certificate as untrusted and add them to the CMTS hotlist of invalid
certificates, thereby preventing those CMs or host's from registering, use the cable privacy hotlist command
in global configuration mode. To remove a particular CM or manufacturer’s certificate from the hotlist, use
the no form of this command.

cable privacy hotlist {cm mac-address | manufacturer cert-serial-number}

no cable privacy hotlist {cm mac-address | manufacturer cert-serial-number}

Cisco cBR Series Converged Broadband Routers

cable privacy hotlist {cm mac-address | host mac-address }
no cable privacy hotlist {cm mac-address | host mac-address }

Syntax Description cm mac-address Specifies the MAC address for the CM to be added to the hotlist. The
mac-address should be specified as a hexadecimal string, without periods
or other separators. In Cisco IOS Release 12.2(15)BC2 and later releases,
you can also specify it as three sets of hexadecimal digits, separated by
periods.

manufacturercert-serial-number Specifies the serial number for the particular manufacturer CA certificate.
The cert-serial-number should be specified as a hexadecimal string up to
32 bytes in length. Enter multiple lines as needed, and use a blank line to
terminate the string.

host mac-address Specifies the MAC address for the host to be added to the hotlist. The
mac-address should be specified as a hexadecimal string, without periods
or other separators. In Cisco IOS Release 12.2(15)BC2 and later releases,
you can also specify it as three sets of hexadecimal digits, separated by
periods.

Command Default The CMTS hotlist does not contain any certificates.

Command Modes
Global configuration (config)

Command History Release Modification

12.1(7)CX, 12.2(1)XF1, This command was introduced for the Cisco uBR7100 series and Cisco
12.2(4)BC1 uBR7200 series routers.

12.2(11)BC1 The accept-self-signed-certificate option was moved to the cable privacy

cable interface command.

12.2(15)BC2 The mac-address can be specified in the canonical form of three pairs of
hexadecimal digits, separated by periods (for example, 0000.0001.0002).

12.2(33)SCB5 This command was integrated into the 12.2SC release train.

Cisco CMTS Cable Command Reference

548
 Cable Commands: cable o through cable r
cable privacy hotlist

Release Modification

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged
Broadband Routers. The host keyword was added.

Usage Guidelines The cable privacy hotlist command is used to configure the following features:
• DOCSIS 1.1 for the Cisco CMTS Routers
This command is applicable only on images that support BPI or BPI+ encryption.

Note The cable privacy hotlist command is not supported on the Cisco uBR10012 router running Cisco IOS
releases prior to Cisco IOS release 12.3(23)BC9, Cisco IOS release 12.2(33)SCB5, and Cisco IOS
release12.2(33)SCC. To add a manufacturer’s or CM certificate to the hotlist on the Cisco uBR10012 router,
use SNMP commands to set the appropriate attributes in DOCS-BPI-PLUS-MIB.

Examples The following command adds the CM certificate with the MAC address of 00C0.8345.de51 to the
hotlist, so that this particular CM cannot register with the CMTS:

Router# configure terminal

Router(config)# cable privacy hotlist cm 00C08345de51
Router(config)#

The following example adds a manufacturer CA certificate into the BPI+ hotlist, so that the CMTS
will reject any CM attempting to register with a certificate from that particular manufacturer:

Router# configure terminal

Router(config)# cable privacy hotlist manufacturer 3435414631413439383335453731423733333643

Related Commands Command Description

cable privacy Enables and configures BPI+ encryption on a cable interface.

option Determines whether a specific CM is online.

cable privacy kek Sets key encryption keys and timeout periods.

cable privacy tek Sets traffic encryption keys and timeout periods.

show cable privacy Displays information about BPI status and operation.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

549
 Cable Commands: cable o through cable r
cable privacy kek

cable privacy kek

To set key encryption keys (KEKs) life-time values for baseline privacy on an HFC network, use the cable
privacy kek command in cable interface configuration mode or MAC domain profile configuration mode.
To restore the default values, use the no form of this command.

Note This command is applicable only on images that support BPI or BPI+ encryption.

cable privacy kek life-time [seconds]

no cable privacy kek life-time

Syntax Description life-timeseconds (Optional) Length of the key encryption life-time in seconds. The valid range is 300 to
604,8000. The default is 604,800 seconds (7 days).

Command Default The life-time option to 604,800 seconds (7 days).

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

11.3 XA This command was introduced.

12.1(4)CX, 12.2(1)XF1, 12.2(4)BC1 The valid range for both options was changed to support DOCSIS 1.1
and BPI+ encryption.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

IOS XE Fuji 16.7.1 This command was modified to support MAC domain profile
configuration on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Baseline privacy on an HFC network is configured with key encryption keys (KEKs) and traffic encryption
keys (TEKs). The encryption is based on 40-bit or 56-bit data encryption standard (DES) encryption algorithms.
A KEK is assigned to a cable modem based on the cable modem service identifier (SID) and permits the cable
modem to connect to the Cisco CMTS when baseline privacy is activated. KEKs can be set to expire based
a life-time value.
The life-time keyword is used to assign a more permanent key to a cable modem.
A cable modem that has a life-time key assigned by the Cisco CMTS requests a new key before the current
one expires.

Examples The following example shows how to set the KEK privacy life-time to 750,000 seconds:

Cisco CMTS Cable Command Reference

550
 Cable Commands: cable o through cable r
cable privacy kek

Note CableLabs recommended operational KEK life time is:

• Minimum 1 day
• Normal 7 days
• Maximum 70 days and
• 300 seconds for integration testing alone

Router(config)# interface cable c3/0/0

Router(config-if)# cable privacy kek life-time 750000
Router(config-if)#

Related Commands Command Description

cable privacy Enables and configures BPI+ encryption on a cable interface.

cable privacy tek Sets traffic encryption keys and timeout periods.

option Determines whether a specific CM is online.

privacy Configures the BPI or BPI+ configuration parameters in a DOCSIS

configuration file.

show cable privacy Displays information about BPI status and operation.

show interface cable privacy Displays the current values of the KEK and TEK timers for an interface.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

551
 Cable Commands: cable o through cable r
cable privacy non-mtc-aes128

cable privacy non-mtc-aes128

To allows DOCSIS3.0 cable modem working on non-MTC mode to use AES-128 as BPI encryption algorithms,
use the cable privacy non-mtc-aes128 command in global configuration mode. To disable this feature, use
the no form of this command.

cable privacy non-mtc-aes128

no cable privacy non-mtc-aes128

Command Default None.

Command Modes
Global configuration (config)

Command History Release Modification

IOS-XE 3.18.1SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to add a CM with the MAC address of 00C0.8345.de51 to the
EAE exclusion list, so that this particular CM cannot register with the CMTS:

Router# configure terminal

Router(config)# cable privacy non-mtc-aes128
Router(config)#

Cisco CMTS Cable Command Reference

552
 Cable Commands: cable o through cable r
cable privacy revocation crl skip-sig-check

cable privacy revocation crl skip-sig-check

To allow the Cisco CMTS router to skip the certification revocation list (CRL) response signature check, use
the cable privacy revocation crl skip-sig-check command in global configuration mode. To enable CRL
signature check, use the no form of this command.

cable privacy revocation crl skip-sig-check

no cable privacy revocation crl skip-sig-check

Syntax Description This command has no keywords or arguments.

Command Default The CRL response signature check is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable privacy revocation crl skip-sig-check command allows you to use the CRL response from the
CRL server without validating the signature of the response.

Examples The following example shows how to skip the CRL response signature check:

Router(config)# cable privacy revocation crl skip-sig-check

Related Commands Command Description

cable privacy revocation ocsp skip-sig-check Allows to skip the OCSP response signature check.

cable privacy revocation skip-cm-cert Allows to disable checking of the CM certificates.

cable privacy revocation timeout Sets the timeout value of CRL or OCSP response time.

cable privacy revocation enable Allows to quickly enable privacy revocation checking.

show cable privacy Displays information about BPI status and operation.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

553
 Cable Commands: cable o through cable r
cable privacy revocation enable

cable privacy revocation enable

To quickly enable privacy revocation checking, use the cable privacy revocation enable command in global
configuration mode. To disable privacy revocation checking, use the no form of this command.

cable privacy revocation enable

no cable privacy revocation enable

Syntax Description This command has no keywords or arguments.

Command Default The privacy revocation checking is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows you to quickly enable or disable revocation checking. When you enable revocation
checking, it creates the trustpoints for both the EU and US certificates.

Examples The following example shows how to enable revocation checking:

Router(config)# cable privacy revocation enable

Related Commands Command Description

cable privacy revocation ocsp skip-sig-check Allows to skip the OCSP response signature check.

cable privacy revocation skip-cm-cert Allows to disable checking of the CM certificates.

cable privacy revocation timeout Sets the timeout value of CRL or OCSP response time.

show cable privacy Displays information about BPI status and operation.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

554
 Cable Commands: cable o through cable r
cable privacy revocation ocsp skip-sig-check

cable privacy revocation ocsp skip-sig-check

To allow the Cisco CMTS router to skip the Online Certificate Status Protocol (OCSP) response signature
check, use the cable privacy revocation ocsp skip-sig-check command in global configuration mode. To
enable OCSP signature check, use the no form of this command.

cable privacy revocation ocsp skip-sig-check

no cable privacy revocation ocsp skip-sig-check

Syntax Description This command has no keywords or arguments.

Command Default OCSP response signature check is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable privacy revocation ocsp skip-sig-check command allows you to use the OCSP response from the
OCSP responder without validating the signature of the response.

Examples The following example shows how to skip the OCSP response signature check:

Router(config)# cable privacy revocation ocsp skip-sig-check

Related Commands Command Description

cable privacy revocation enable Allows to quickly enable privacy revocation checking.

cable privacy revocation skip-cm-cert Allows to disable checking of the CM certificates.

cable privacy revocation timeout Sets the timeout value of CRL or OCSP response time.

show cable privacy Displays information about BPI status and operation.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

555
 Cable Commands: cable o through cable r
cable privacy revocation skip-cm-cert

cable privacy revocation skip-cm-cert

To disable checking of the CM certificates, use the cable privacy revocation skip-cm-cert command in
global configuration mode. To enable checking of CM certificates, use the no form of this command.

cable privacy revocation skip-cm-cert

no cable privacy revocation skip-cm-cert

Syntax Description This command has no keywords or arguments.

Command Default CM certificate checking is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

Note Checking CM certificates requires a lot of processing power, which impacts the router performance.

Examples The following example shows how to disable checking of CM certificates:

Router(config)# cable privacy revocation skip-cm-cert

Related Commands Command Description

cable privacy revocation enable Allows to quickly enable privacy revocation checking.

cable privacy revocation ocsp skip-sig-check Allows to skip the OCSP response signature check.

cable privacy revocation timeout Sets the timeout value of CRL or OCSP response time.

show cable privacy Displays information about BPI status and operation.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

556
 Cable Commands: cable o through cable r
cable privacy revocation timeout

cable privacy revocation timeout

To set the timeout value of certification revocation list (CRL) or Online Certificate Status Protocol (OCSP)
response time for authorization “reply” or “reject” messages, use the cable privacy revocation timeout
command in global configuration mode. To return to the default timeout value, use the no form of this
command.

cable privacy revocation timeout

no cable privacy revocation timeout

Syntax Description This command has no keywords or arguments.

Command Default The default timeout value is 1 second.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command only takes effect if cable privacy revocation enable command is configured. The timeout
value for authorization “reply” or “reject” messages in the CM configuration file must be greater than the
revocation timeout value.

Examples The following example shows how to set the timeout value for CRL or OCSP response:

Router(config)# cable privacy revocation timeout 15

Related Commands Command Description

cable privacy revocation enable Allows to quickly enable privacy revocation checking.

cable privacy revocation ocsp skip-sig-check Allows to skip the OCSP response signature check.

cable privacy revocation skip-cm-cert Allows to disable checking of the CM certificates.

show cable privacy Displays information about BPI status and operation.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

557
 Cable Commands: cable o through cable r
cable privacy tek

cable privacy tek

To set traffic encryption keys (TEKs) life-time values for baseline privacy on an HFC network, use the cable
privacy tek command in cable interface configuration mode or MAC domain profile configuration mode. To
restore the default value, use the no form of this command.

Note This command is applicable only on images that support BPI or BPI+ encryption.

cable privacy tek life-time [seconds]

no cable privacy tek life-time

Syntax Description life-time (Optional) Length of the traffic encryption life-time in seconds. The range is 180 to
seconds 604,8000. The default is 43,200.

Command Default The life-time option to 43200 seconds (12 hours).

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

11.3 XA This command was introduced.

12.1(4)CX, 12.2(1)XF1, 12.2(4)BC1 The valid range for both options was changed to support DOCSIS 1.1
and BPI+ encryption.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

IOS XE Fuji 16.7.1 This command was modified to support MAC domain profile
configuration on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Baseline privacy on an HFC network is configured with key encryption keys (KEKs) and traffic encryption
keys (TEKs). The encryption is based on 40-bit or 56-bit data encryption standard (DES) or 128-bit AES
encryption algorithms.
The TEK is assigned to a CM when its KEK has been established. The TEK is used to encrypt data traffic
between the CM and the Cisco CMTS. TEKs can be set to expire based a life-time value.
The life-time keyword is used to assign a more permanent key to a CM.

Cisco CMTS Cable Command Reference

558
 Cable Commands: cable o through cable r
cable privacy tek

Note CableLabs recommended operational TEK life time is:

• Minimum 30 minutes
• Normal 12 hours
• Maximum 7 days and
• 180 seconds for integration testing alone

A CM that has a life-time key assigned by the Cisco CMTS requests a new key before the current one expires.

Examples The following example shows how to set the traffic encryption key life-time to 800000 seconds:

Router(config)# interface cable c3/0/0

Router(config-if)# cable privacy tek life-time 800000
Router(config-if)#

Related Commands Command Description

cable privacy Enables and configures BPI+ encryption on a cable interface.

cable privacy kek Sets key encryption keys and timeout periods.

option Determines whether a specific CM is online.

privacy Configures the BPI or BPI+ configuration parameters in a DOCSIS

configuration file.

show cable privacy Displays information about BPI status and operation.

show interface cable privacy Displays the current values of the KEK and TEK timers for an interface.

debug cable privacy Displays debug messages for BPI operation.

Cisco CMTS Cable Command Reference

559
 Cable Commands: cable o through cable r
cable profile

cable profile
To create and configure common profile for service group based configuration of layer 2 (L2) interfaces, use
the cable profile command. To remove a common profile use the no form of the command with the appropriate
key words and variables.

cable profile profile-type profile-name

Syntax Description profile-type Configures the profile type for configuration.

• mac-domain — Selects a MAC domain common profile for configuration.
• downstream — Selects a downstream interface common profile to configure.
• wideband-interface — Selects a wideband interface common profile to
configure.
• service-group — Creates fiber-node service group profile.

profile-name Configures the profile name.

Command Default Not configured.

Command Modes Privileged Configuration Mode (config)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This following statements are introduced for the cable profile mac-domain
command:
• shutdown
• cable upstream resiliency [ change-channel-set |
channel-down-detect | data-burst | modem-offline-detect |
on-failure | sf-move ]

Cisco IOS-XE 3.17.0S This command is introduced on theCisco cBR Series Converged Broadband
Routers.

Usage Guidelines Feature—Service Group Profile Based Configuration for DOCSIS interfaces and fiber nodes.
Use this command to configure the three common profiles — MAC domain, primary downstream channel
profile and wideband-cable interface profile. When you enter the profile configuration mode, configure the
parameters for the profile. These parameters will be applied when this profile is added to a specific service
group profile. This command is used to create the service group profile.
MAC Domain Common Profile
When you enter the MAC domain common profile configuration mode, configure the following using the
cable command:
• cable ip-init [apm | dual-stack | ipv4 | ipv6]

Cisco CMTS Cable Command Reference

560
Cable Commands: cable o through cable r
cable profile

• cable mrc-mode
• cable mtc-mode
• cable dynamic-secret [lock | mark | reject]
• cable shared-secret [0 | 7 | LINE]
• cable privacy bpi-plus-policy [capable-enforcement | d11-enabled-enforcement | d11-enforcement
| total-enforcement ]
• cable privacy mandatory

Primary Downstream Channel Common Profile

When you enter the primary downstream channel common profile configuration mode, configure the following
using the cable command:
• cable rf-bandwidth-percent percent [remaining ratio percent]
• cable attribute-mask mask

Wideband Interface Common Profile

When you enter the wideband interface common profile configuration mode, configure the following using
the cable command:
• cable downstream attribute-mask mask

Global Service Group Profile

When you enter the global service group configuration mode, use the following commands:
• Enter the MAC domain mode using mac-domain mac-domain id profilemac-domain profile name
• In the MAC domain mode:
• Configure the downstream service group channels using the downstream sg-channel group list
profile ds profile name upstream group list
• Configure the upstream service group channels using the upstream Id sg-channel sg channel Id
• Configure the upstream bonding group by entering the upstream bonding group configuration mode
using the us-bonding-group Id command.
• In the upstream bonding group configuration mode, use the upstream Id command to add
the upstream channels.
• In the upstream bonding group configuration mode, use the attribute mask command to add
attribute mask for this upstream bonding group .

• Enter the wideband interface configuration group using the wideband-interface Id profile BG profile
name
• In the wideband interface configuration mode, use the downstream sg-channel group list
rf-bandwidth-percent percent command to add the upstream channels.

Cisco CMTS Cable Command Reference

561
 Cable Commands: cable o through cable r
cable profile

MAC Domain Common Profile

This example shows how to configure a MAC domain common profile using the cable profile
command.

Router(config)#cable profile mac-domain md1

Router(config-profile-md)#cable dynamic-secret mark
Router(config-profile-md)#cable shared-secret 0
Router(config-profile-md)#cable ip-init ipv4
Router(config-profile-md)#cable mtc-mode
Router(config-profile-md)#cable mrc-mode
Router(config-profile-md)#cable privacy mandatory
Router(config-profile-md)#cable privacy bpi-plus-policy total-enforcement

Router(config-profile-md)#exit
Router(config)#

Primary Downstream Channel Common Profile

This example shows how to configure a primary downstream channel common profile using the
cable profile command. Set the attribute mask value and the RF bandwidth percentage for the primary
downstream channel profile.

Router(config)#cable profile downstream ds1

Router(config-profile-ds)# cable attribute-mask mask
Router(config-profile-ds)# cable rf-bandwidth-percent percent

Router(config-profile-ds)#exit
Router(config)#

Wideband Interface Common Profile

This example shows how to configure a wideband interface common profile using the cable profile
command. Set the attribute mask value for the wideband interface profile using the downstream
keyword.

Router(config)#cable profile wideband-interface BG1

Router(config-profile-wb)# cable downstream attribute-mask mask
Router(config-profile-wb)#exit
Router(config)#

Configuring DSG on Service-Group Profile

This example shows how to configure a DSG on service-group profile using the cable profile
service-group <name> command:

Router(config)# cable profile service-group SG-16x8-1_1

Cisco CMTS Cable Command Reference

562
Cable Commands: cable o through cable r
cable profile

cable bundle bundle ID

mac-domain mac-domain ID profile mac-domain profile name
downstream sg-channel grouplist profile downstream interface
cable downstream dsg chan-list 111
cable downstream dsg timer 1
cable downstream dsg vendor-param 2
cable downstream dsg tg 4500
cable downstream dsg tg 4500 priority 2
cable downstream dsg tg 4500 vendor-param 2
cable downstream dsg tg 4500 ucid 1 2

Global Service Group Profile

This example shows how to configure a global service group profile using the cable profile command.
Configure the required MAC domain and wideband interface parameters in the global service group
profile configuration mode.

Router(config)#cable profile service-group SG-16x8-1_1

Router(config-profile-sg)#cable bundle bundle ID
Router(config-profile-sg)#mac-domain mac-domain ID profile mac-domain profile name
Router(config-profile-sg-md)#downstream sg-channel grouplist profile downstream interface
profile ID
upstream grouplist
Router(config-profile-sg-md)#upstream Id sg-channel sg channel Id
Router(config-profile-sg-md)#us-bonding-group bonding group ID
Router(config-profile-sg-md-usbg)#upstream Id
Router(config-profile-sg-md-usbg)#attributes mask
Router(config-profile-sg-md-usbg)#exit
Router(config-profile-sg-md)#exit
Router(config-profile-sg)#

Router(config-profile-sg)#wideband-interface downstream bonding group id profile

downstream bonding group id
Router(config-profile-sg-bg)#downstream sg-channel grouplist rf-bandwidth-percent
bandwidth percent
Router(config-profile-sg-bg)#end
Router#

Configuring mac-domain with shutdown

Router# show run | sec cable profile mac-domain MD1
cable profile mac-domain MDI
shutdown

Router# show run int c2/0/0

Building configuration...

Current configuration : 112 bytes

!
interface Cable2/0/0
shutdown
cable mac-domain-profile MD1
cable bundle 1
cable managed fiber-node 1
end

Router# show derive int c2/0/0

Building configuration...

Cisco CMTS Cable Command Reference

563
 Cable Commands: cable o through cable r
cable profile

Derived configuration : 487 bytes

!
interface Cable2/0/0
shutdown
downstream Integrated-Cable 2/0/0 rf-channel 0 profile DS
upstream 0 Upstream-Cable 2/0/0 us—channel 0
upstream 1 Upstream-Cable 2/0/0 us-channel 1
upstream 2 Upstream-Cable 2/0/0 us-channel 2
upstream 3 Upstream-Cable 2/0/0 us-channel 3
cable mac-domain-profile MD1
cable upstream bonding-group 1
upstream 0
upstream 1
attributes 88000000
cable bundle 1
cable ip-init ipv4
cable managed fiber-node 1
cable mtc-mode
cable mrc-mode
end

Configuring mac-domain with cable upstream resiliency

Router# show cable profile mac-domain MD1
cable profile mac-domain MD1
cable upstream resiliency on-failure reset-modem
cable upstream resiliency channel -down-detect 50
cable upstream resiliency sf-move RTPS
cable upstream resiliency sf-move NRTPS
cable upstream resiliency sf-move UGS
cable upstream resiliency sf-move UGS-AD
cable upstream resiliency data-burst snr 10 ufec 15 cfec 20 hysteresis 10

Router# show derive int c2/0/0

Building configuration...

Derived configuration : 814 bytes

!
interface Cable2/0/0
downstream Integrated-Cable 2/0/0 rf-channel 0 profile DS
upstream 0 Upstream-Cable 2/0/0 us-channel 0
upstream 1 Upstream-Cable 2/0/0 us-channel 1
upstream 2 Upstream-Cable 2/0/0 us-channel 2
upstream 3 Upstream-Cable 2/0/0 us-Channel 3
Cable mac-domain-profile MD1
cable upstream resiliency on-failure reset-modem
cable upstream resiliency channel-down-detect 59
cable upstream resiliency st-move RTPS
cable upstream resiliency st-move NRTPS
cable upstream resiliency st-move UGS
cable upstream resiliency sf-move UGS-AD
cable upstream resiliency data-burst snr 10 ufec 15 cfec 20 hysteresis 10
cable upstream resiliency bonding-group 1
upstream 0
upstream 1
attributes 88000000
cable bundle 1
cable ip-init ipv4
cable managed fiber-node 1
cable mtc-mode
cable mrc -mode
end

Cisco CMTS Cable Command Reference

564
 Cable Commands: cable o through cable r
cable profile rpd-event

cable profile rpd-event

To configure an event profile and apply it to RPD, use the cable profile rpd-event profile_id command
in the global configuration mode.

cable profile rpd-event profile_id priority {0x00x10x20x3}

Syntax Description rpd-event Configures an event profile

profile-id Profile ID for the event.

priority The type of event.

• emergency
• alert
• critical
• error
• warning
• notice
• informational
• debug

{0x0|0x1|0x2|0x3} Type of notifications.

• 0x0—No log
• 0x1— Save log in RPD local storage
• 0x2—Report to Cisco cBR
• 0x3—Save log in RPD local storage and report to Cisco
cBR

Command Default Not configured.

Command Modes Privileged Configuration Mode (config)

Command History Release Modification

Cisco RPD IOS The cable profile rpd-event profile_id command was introduced.
1.1

Usage Guidelines RPD Event Profile

The cable profile rpd-event profile_id command is used to configure an RPD event profile. After you
create an event profile, you can apply it to an RPD.

Cisco CMTS Cable Command Reference

565
 Cable Commands: cable o through cable r
cable profile rpd-event

RPD Event Profile

Router(config)>enable
Router#configure terminal
Router(config)#cable profile rpd-event 6
Router(config rpd-event)#priority emergency 0x3
Router(config rpd-event)#priority alert 0x3
Router(config rpd-event)#priority critical 0x3
Router(config rpd-event)#priority error 0x3
Router(config rpd-event)#priority warning 0x3
Router(config rpd-event)#priority notice 0x3
Router(config rpd-event)#priority informational 0x3
Router(config rpd-event)#enable-notify
Router(config)#cable rpd node6
Router(config-rpd)#identifier badb.ad13.5e08
Router(config-rpd)#core-interface Te3/1/5
Router(config-rpd-core)#principal
Router(config-rpd-core)#rpd-ds 0 downstream-cable 3/0/17 profile 10
Router(config-rpd-core)#rpd-us 0 upstream-cable 3/0/34 profile 13
Router(config-rpd-core)#r-dti 16
Router(config-rpd-core)#rpd-event profile 6

Cisco CMTS Cable Command Reference

566
 Cable Commands: cable o through cable r
cable proxy-arp

cable proxy-arp
To activate cable proxy Address Resolution Protocol (ARP) on the cable interface or subinterface, use the
cable proxy-arp command in cable interface or subinterface configuration mode. To disable this feature, use
the no form of this command.

cable proxy-arp
no cable proxy-arp

Syntax Description This command has no arguments or keywords.

Command Default Proxy APR service is enabled.

Command Modes
Cable interface configuration (config-if)

Cable subinterface configuration (config-subif)

Command History Release Modification

11.3 XA This command was introduced.

12.1(3a)EC The subinterface support was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command enables or disables direct host-to-host communications over the same cable subnet. Because
the downstream and upstream are separate interfaces, CMs cannot directly perform address resolution with
other CMs on the cable plant. This means that the CMs must send all traffic through the CMTS, even if the
destination CM is on the same subnet.
The cable proxy-arp command enables the Cisco CMTS to act as a proxy for ARP requests generated by the
CMs, which allows CMs on the same cable subnet to communicate directly which each other, without the
traffic having to be routed first through the CMTS. The no cable proxy-arp command disables this feature,
preventing CMs on the same subnet from communicating with each other without routing the traffic through
the CMTS.

Note Using the no cable arp and no cable proxy-arpcommands shifts all responsibility for the management of
the IP addresses used by CMs and CPE devices to the DHCP server and provisioning system.

Examples The following example shows how to activate proxy ARP for host-to-host communications:

Router(config-subif)# cable proxy-arp

The following example shows how to activate proxy ARP for host-to-host communications, on the
cable subinterface:

Cisco CMTS Cable Command Reference

567
 Cable Commands: cable o through cable r
cable proxy-arp

Router(config)# interface cable 6/0.1

Router(config-subif)# cable proxy-arp

Related Commands Command Description

cable arp Activates cable Address Resolution Protocol (ARP).

Cisco CMTS Cable Command Reference

568
 Cable Commands: cable o through cable r
cable qos enforce-rule

cable qos enforce-rule

To create an enforce-rule to enforce a particular quality of service (QoS) profile for subscriber traffic
management, and to enter enforce-rule configuration mode, use the cable qos enforce-rule command in
global configuration mode. To delete an enforce-rule and to remove it from the CMTS configuration, use the
no form of this command.

cable qos enforce-rule rule-name

no cable qos enforce-rule rule-name

Syntax Description rule-name Name of the enforce-rule to be created and configured. This name can be any arbitrary and unique
string from 1 to 15 characters in length.

Command Default No enforce-rules are created.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.3(9a)BC This command was integrated into Cisco IOS Release 12.3(9a)BC. This command replaces
the cable qos monitoring command.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable qos enforce-rule command creates an enforce-rule with the specified name and then enters
enforce-rule configuration mode. After entering enforce-rule configuration mode, use the following commands
to configure the enforce-rule for uBR Series Routers:
• activate-rule at-byte-count
• enabled (enforce-rule)
• enforced qos-profile
• monitoring-duration
• penalty-period
• registered qos-profile
At the very minimum, you must use the activate-rule at-byte-count and registered qos-profilecommands
to configure an enforce-rule, and the enabled command to activate it, before it takes effect.

Note Effective with Cisco IOS Release 12.3(9a)BC, the activate-rule at-byte-count command is not available in
Cisco IOS software.

Cisco CMTS Cable Command Reference

569
 Cable Commands: cable o through cable r
cable qos enforce-rule

Maximum Number of Rules

The Cisco CMTS routers support a certain maximum number of enforce-rules depending on your Cisco IOS
software release. If you have created the maximum number of enforce-rules and want to create another rule,
you must first delete one of the existing rules.
• Cisco IOS Release 12.2(15)BC1 and later—Supports a maximum of 20 enforce-rules.
• Beginning in Cisco IOS Release 12.3(23)BC2—Supports a maximum of 40 enforce-rules.
• Cisco IOS Release IOS-XE 3.16.0S and later—Supports a maximum of 40 enforce-rules.

Note The maximum number of enforce-rules is counted as the total number of rules created on both the upstreams
and downstreams combined.

Examples The following example shows the creation of an enforce-rule named “residential.” The system then
enters the enforce-rule configuration mode.

Router# configure terminal

Router(config)# cable qos enforce-rule residential
Router(enforce-rule)# ?
Configuration commands for QoS enforce rules:
activate-rule Activate rule parameters
enabled Enable the enforce-rule
enforced Enforced qos-profile
exit Exit from QoS enforce rule editing mode
monitoring-duration Monitoring duration parameters
no Negate a command or set its defaults
penalty-period Penalty-period
registered Registered qos-profile
Router(enforce-rule)# activate-rule at-byte-count 50000000 downstream enforced
Router(enforce-rule)# registered qos-profile 5
Router(enforce-rule)# enforced qos-profile 99
Router(enforce-rule)# monitoring-duration 120 sample-rate 20
Router(enforce-rule)# penalty-period 1440
Router(enforce-rule)# enabled
Router(enforce-rule)# exit
Router(config)# exit

The following example shows the deletion of an enforce-rule named “test”:

Router# configure terminal

Router(config)# no cable qos enforce-rule test

The following example shows the error message that is displayed if you try to create more than 20
enforce-rules in Cisco IOS Release 12.3(23)BC1 and earlier:

Router# configure terminal

Router(config)# cable qos enforce-rule residential
Can't create more enforce-rules. The maximum number is 20.

The following example shows the error message that is displayed when you try to name an enforce-rule
with a name that is larger than 15 characters. An error message is displayed, and the name is truncated
to the first 15 characters.

Router# configure terminal

Cisco CMTS Cable Command Reference

570
 Cable Commands: cable o through cable r
cable qos enforce-rule

Router(config)# cable qos enforce-rule reallyreallyreallylongname

Only the first 15 characters would be taken

The following example shows the creation of an enforce-rule named "test1" on Cisco cBR Series
Converged Broadband Routers. The system then enters the enforce-rule configuration mode.
Router(config)#cable qos enforce-rule test1
Router(enforce-rule)# ?
Configuration commands for QoS enforce rules:
Penalty-period Penalty period in Minutes
duration Legacy monitoring parameters
enabled Enable the enforce-rule
exit Exit from QoS enforce rule editing mode
monitoring-basics Set the monitoring basics
no Negate a command or set its defaults
peak-time1 Peak-OffPeak parameters
qos-profile qos-profile for monitoring cable modems
service-class service-class for monitoring cable modems
weekend Setup different peak-time for weekends

Related Commands Command Description

activate-rule at-byte-count Specifies the number of bytes that a subscriber can transmit during
the monitoring period.

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

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management

on a Cisco CMTS router.

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

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

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

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

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

571
 Cable Commands: cable o through cable r
cable qos permission

cable qos permission

To specify permission for updating the quality of service (QoS) table, use the cable qos permission command
in global configuration mode. To remove a previously enabled permission, use the no form of this command.

cable qos permission {create | enforce index | modems | update}

no cable qos permission

Syntax Description create Permits creation of QoS table entries by Simple Network Management Protocol (SNMP).

enforce The enforce keyword overrides the provisioned QoS profile of the CM and enforces a specific
index CMTS-local QoS profile. The index argument specifies the number of the QoS profile to be
enforced on all CMs connecting to the CMTS. Valid values are from 1 to 255.
Note
Both the originally provisioned QoS profile and the enforced QoS profile must be created
on the Cisco CMTS. This option does not support profiles that are created by the CM.

modems Permits creation of QoS table entries by modem registration requests.

update Permits dynamic update of QoS table entries by SNMP.

Command Default Enable by modem and SNMP.

Command Modes
Global configuration (config)

Command History Release Modification

11.3 NA This command was introduced.

11.3(9)NA The enforce keyword was added.

12.1(4)CX This command was deprecated for DOCSIS 1.1 use, because DOCSIS 1.1 replaces the
QoS profile model with a service flow model.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines If the QoS profile to be enforced does not exist at the CMTS during registration, the CMTS uses the QoS
profile configured for the registering CM.
If you disable the use of CM-created profiles, using the no cable qos permission command, any CMs using
such a profile go offline immediately and the CM-created profiles are removed.
This no cable qos permission command is similar to the docsIfCmtsQosProfilePermissions attribute in the
DOCS-IF-MIB, as both prohibit CMs from creating their own QoS profiles in the future. However, the no
cable qos permission command also immediately deletes QoS profiles that have been created by the cable
modems and takes those modems offline. The docsIfCmtsQosProfilePermissions method does not affect QoS
profiles that are currently in use, but only unused profiles and profiles that are created in the future.

Cisco CMTS Cable Command Reference

572
 Cable Commands: cable o through cable r
cable qos permission

Examples The following example shows how to enable CMs to request arbitrary QoS parameters:

Router(config)# cable qos permission modems

The following example shows how a CM with a QoS profile 4 created by the CM is reset to use QoS
profile 225 enforced by the cable router (management):

CMTS01# show cable modem

Interface SID Online Timing Receive QoS IP address MAC address
State Offset Power
Cable6/0/U0 1 online 2848 0.00 4 19.2.20.139 0010.7b6b.7215
CMTS01# show cable qos profile 4
Service Prio Max Guarantee Max Max tx TOS TOS Create B
class upstream upstream downstream burst mask value by priv
bandwidth bandwidth bandwidth enab
4 7 128000 64000 2048000 255 0x0 0x0 cm no
CMTS01(config)# cable qos profile 225 max-upstream 256
CMTS01(config)# cable qos permission enforce 225
CMTS01# clear cable modem all reset
CMTS01# show cable modem
Interface SID Online Timing Receive QoS IP address MACaddress
State Offset Power
Cable6/0/U0 1 offline 2848 0.25 2 19.2.20.139 0010.7b6b.7215
CMTS01# debug cable reg
....
00:15:59: Finished parsing REG Request
00:15:59: Overriding Provisioned QoS Parameters In REG-REQ
....
CMTS01# show cable modem
Interface SID Online Timing Receive QoS IP address MACaddress
State Offset Power
Cable6/0/U0 1 online 2852 0.00 225 19.2.20.139 0010.7b6b.7215
CMTS01# show cable qos profile 225
Service Prio Max Guarantee Max Max tx TOS TOS Create B
class upstream upstream downstream burst mask value by priv
bandwidth bandwidth bandwidth enab
225 0 256000 0 0 0 0x0 0x0 management no

Related Commands Command Description

cable qos profile Configures a QoS profile.

show cable qos permission Displays the status of permissions for changing QoS tables for a cable router.

show cable qos profile Displays the QoS profiles that have been defined.

Cisco CMTS Cable Command Reference

573
 Cable Commands: cable o through cable r
cable qos pre-registration

cable qos pre-registration

To ensure that cable modems get online when a large number of existing online cable modems are actively
transmitting data, use the cable qos pre-registration us-priority command.

cable qos pre-registration us-priority priority-value

Syntax Description us-priority Specifies the upstream priority to be assigned to the pre-registration traffic.

priority-value Priority value of the QoS profile-2.

The valid range is from 0 to 7.
Note
When a cable modem begins initializing, its default upstream service flow is assigned a QoS
profile-2 priority of zero. Zero is the lowest priority scheduled.

Command Default The default QoS profile-2 priority of the initializing cable modem is zero.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD2 This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable qos pre-registration command allows the Cisco CMTS operators to enforce a profile on all cable
modems that have not yet begun initialization. However, this command has no affect on cable modems that
have already started initialization and may be having difficulties getting [w-]online.

Examples The following example shows how to set the priority of the QoS profile-2.

Router# configure terminal

Router(config)# cable qos pre-registration us-priority 2
Router(config)#

Related Commands Command Description

show cable qos profile Displays the QoS profiles for a Cisco CMTS.

Cisco CMTS Cable Command Reference

574
 Cable Commands: cable o through cable r
cable qos pro max-ds-burst

cable qos pro max-ds-burst

To define ERBA on the downstream for DOCSIS 1.0 cable modems, use the cable qos pro max-ds-burst
command in global configuration mode. To remove this ERBA setting from the QoS profile, use the no form
of this command.

cable qos pro max-ds-burst burst-size

no cable qos pro max-ds-burst

Syntax Description burst-size The downstream burst size of QoS profile in bytes.

Command Default This DOCSIS 1.0 configuration is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced for the Cisco uBR7100 Series and Cisco uB7246VXR
router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines To display ERBA settings as applied to DOCSIS 1.0 cable modems and QoS profiles on the Cisco CMTS,
use the show cable qos profile command in Privileged EXEC mode.
The following example of the cable qos profile command in global configuration mode illustrates changes
to the cable qos profile command. Fields relating to the ERBA feature are shown in bold for illustration:

Router(config)# cable qos pro 10 ?

grant-interval Grant interval
grant-size Grant size
guaranteed-upstream Guaranteed Upstream
max-burst Max Upstream Tx Burst
max-ds-burst Max Downstream Tx burst (cisco specific)
max-downstream Max Downstream
max-upstream Max Upstream
name QoS Profile name string (cisco specific)

priority Priority
privacy Cable Baseline Privacy Enable
tos-overwrite Overwrite TOS byte by setting mask bits to value

The following example of the show cable qos profile command illustrates that the maximum downstream
burst has been defined, and is a management-created QoS profile:

Router# show cable qos pro

ID Prio Max Guarantee Max
Max TOS TOS Create B IP prec.
upstream upstream downstream
tx mask value by priv rate
bandwidth bandwidth bandwidth
burst enab enab

Cisco CMTS Cable Command Reference

575
 Cable Commands: cable o through cable r
cable qos pro max-ds-burst

1 0 0 0 0
0 0xFF 0x0 cmts(r) no no
2 0 64000 0 1000000
0 0xFF 0x0 cmts(r) no no
3 7 31200 31200 0
0 0xFF 0x0 cmts yes no
4 7 87200 87200 0
0 0xFF 0x0 cmts yes no
6 1 90000 0 90000
1522
0xFF 0x0 mgmt
yes no
10 1 90000 0 90000
1522
0x1 0xA0 mgmt
no no
50 0 0 0 96000
0 0xFF 0x0 mgmt no no
51 0 0 0 97000
0 0xFF 0x0 mgmt no no

The following example illustrates the maximum downstream burst size in sample QoS profile 10 with the
show cable qos prof verbose command in privileged EXEC mode:

Router# show cable qos pro 10 ver

Profile Index 10
Name
Upstream Traffic Priority 1
Upstream Maximum Rate (bps) 90000
Upstream Guaranteed Rate (bps) 0
Unsolicited Grant Size (bytes) 0
Unsolicited Grant Interval (usecs) 0
Upstream Maximum Transmit Burst (bytes) 1522
Downstreamam Maximum Transmit Burst (bytes) 100000
IP Type of Service Overwrite Mask 0x1
IP Type of Service Overwrite Value 0xA0
Downstream Maximum Rate (bps) 90000
Created By mgmt
Baseline Privacy Enabled no

If a cable modem registers with a QoS profile that matches one of the existing QoS profiles on the Cisco
CMTS, then the maximum downstream burst size, as defined for that profile, is used instead of the default
DOCSIS QoS profile of 1522.
For example, a DOCSIS 1.0 configuration that matches QoS profile 10 in the previous examples would be as
follows:

03 (Net Access Control) = 1

04 (Class of Service Encodings Block)
S01 (Class ID) = 1
S02 (Maximum DS rate) = 90000
S03 (Maximum US rate) = 90000
S06 (US burst) = 1522
S04 (US Channel Priority) = 1
S07 (Privacy Enable) = 0

The maximum downstream burst size (as well as the ToS overwrite values) are not explicitly defined in the
QoS configuration file because they are not defined in DOCSIS. However, because all other parameters are
a perfect match to profile 10 in this example, then any cable modem that registers with these QoS parameters
has a maximum downstream burst of 100000 bytes applied to it.

Cisco CMTS Cable Command Reference

576
 Cable Commands: cable o through cable r
cable qos pro max-ds-burst

For further illustration, consider a scenario in which packets are set in lengths of 1000 bytes at 100 packets
per second (pps). Therefore, the total rate is a multiplied total of 1000, 100, and 8, or 800kbps.
To change these settings, two or more traffic profiles are defined, with differing downstream QoS settings as
desired. The table below provides two examples of such QoS profiles for illustration:

Table 9: Sample QoS Profiles with Differing ERBA (Maximum Downstream) Settings

QoS Profile Setting QoS Profile 101 QoS Profile 102

Maximum Downstream Transmit Burst (bytes) max-burst 4000 max-burst 4000

Maximum Downstream Burst (bps) max-ds-burst 20000 max-ds-burst 5000

Maximum Downstream Bandwidth max-downstream 100 max-downstream 100

In this scenario, both QoS profiles are identical except for the max-ds-burst size, which is set to 5000 in QoS
profile 101 and 5000 in QoS profile 102.
Optimal Settings for DOCSIS 1.0 Downstream Powerburst
DOCSIS allows the setting different token bucket parameters for each service flow, including the token bucket
burst size. When burst sizes are closer to 0, QoS is enforced in a stricter manner, allowing a more predictable
sharing of network resources, and as a result easier network planning.
When burst sizes are larger, individual flows can transmit information faster (lower latency), although the
latency variance can be larger as well.
For individual flows, a larger burst size is likely to be better. As long as the system is not congested, a large
burst size reduces the chances of two flows transmitting at the same time, because each burst is likely to take
less time to transmit. However, as channel bandwidth consumption increases, it is probably that large burst
traffic would exceed the thresholds of buffer depths, and latency is longer than with well shaped traffic.
For additional information about the cable qos profile command and configuring QoS profiles, see the DOCSIS
1.1 for the Cisco CMTS document on Cisco.com.

Related Commands Command Description

cable qos profile Configures a QoS profile.

show cable qos permission Displays the status of permissions for changing QoS tables for a cable router.

show cable qos profile Displays the QoS profiles that have been defined.

Cisco CMTS Cable Command Reference

577
 Cable Commands: cable o through cable r
cable queue-limit

cable queue-limit
To set the DOCSIS service flow queue limits to non-default values on the Cisco CMTS, use the cable
queue-limit command in global configuration mode. To disable this function, use the no form of this command.

cable queue-limit queue_limit_in_ms bandwidth-threshold threshold_value

no cable queue-limit queue_limit_in_ms bandwidth-threshold threshold_value

Syntax Description queue_limit_in_ms Queue limit in milliseconds. The valid range is from 1 to 200 milliseconds.

threshold_value Queue bandwidth threshold in Kbps. The valid range is from 0 to 1000000.
Note
The queue limit specification take effect only if the queue shape rate exceeds the
queue-bandwidth threshold.

Command Default This command is not enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

12.2(33)SCG1 Support was added for the Cisco uBR7200 Series router.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable queue-limit bandwidth-threshold command is used to configure the DOCSIS WFQ Scheduler
on the Cisco CMTS Routers feature.
The queue size on the downstream interfaces can be adjusted to be different than the default settings; for
example, when the application can benefit from a larger queue size on a high speed queue.
The queue size in packets is calculated as:
queue-size = bandwidth (Kbps) * queue-limit (ms) / 8 / 1518
(where 1518 B is the packet size, and bandwidth is the same as queue shape rate).

Examples The following example shows how to set the queue limit to 25 ms at max-rate when bandwidth
exceeds 100000 Kbps:

Router(config)# cable queue-limit 25 bandwidth-threshold 100000

Cisco CMTS Cable Command Reference

578
 Cable Commands: cable o through cable r
cable queue-limit

Related Commands Command Description

(For uBR10K Series Routers) show cable Displays the queue information on the Cisco uBR7200 router.
modem queue

(For uBR10K Series Routers) show pxf Displays parallel express forwarding (PXF) queuing, link queue
cpu queue statistics, and the service flow queue information including the
queue size on the Cisco uBR10012 router.

(For uBR10K Series Routers) show pxf Displays information about a particular service ID (SID),
cable interface including information about the status of queues used by the SID
on the Cisco uBR10012 router

Cisco CMTS Cable Command Reference

579
 Cable Commands: cable o through cable r
cable ranging cm packet

cable ranging cm packet

From cBR 16.12.1w and later, the rates of per-CM and per-US SNR have been improved, and supports the
cable ranging cm packet command, which configures the number of ranging packets to get the CM-based
SNR.

cable ranging cm packet

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.12.1w

The following example shows how to configure the number of ranging packets to get the CM-based
SNR using the cable ranging cm packet command:

Router(config)# cable ranging cm packet

<1-20> number of ranging packet

Cisco CMTS Cable Command Reference

580
 Cable Commands: cable o through cable r
cable ranging upstream packet

cable ranging upstream packet

From cBR 16.12.1w and later, the rates of per-CM and per-US SNR have been improved, and supports the
cable ranging upstream packet command, which configures the number of ranging packets to get the US
channel-base SNR.

cable ranging upstream packet

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.12.1w

The following cable ranging upstream packet command example shows how to configure the
number of ranging packets to get the US channel-base SNR:

Router(config)# cable ranging upstream packet

<10-80> packet number for ranging to average

Cisco CMTS Cable Command Reference

581
 Cable Commands: cable o through cable r
cable rate-limit-algorithm min-plus-excess

cable rate-limit-algorithm min-plus-excess

To enable a service flow to receive not only its configured minimum reserved traffic rate bandwidth but also
its expected excess traffic rate bandwidth, use the cable rate-limit-algorithm min-plus-excess command in
global configuration mode. To disable this configuration, use the no form of this command.

cable rate-limit-algorithm min-plus-excess

no cable rate-limit-algorithm min-plus-excess

Syntax Description min-plus-excess Specifies that the service flow requires a bandwidth of the specified minimum reserved
traffic rate, plus excess traffic rate.

Command Default When the cable rate-limit-algorithm min-plus-excess command is not configured, service flows with the
minimum reserved traffic rate configured are guaranteed only their minimum reserved traffic rate. Excess
traffic rate bandwidth may not be shared evenly among service flows with or without the minimum rate
configured.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD5 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Examples The following example shows how to specify the min-plus-excess keyword:

Router> enable
Router# configure terminal
Router(config)# cable rate-limit-algorithm argument min-plus-excess
Router(config)#

Related Commands Command Description

show interface cable mac-scheduler Displays the current time-slot scheduling state, statistics, and weighted
fair queuing (WFQ) parameters for the indicated cable interface.

show interface cable service-flow Displays the attributes of the DOCSIS service flows on a cable
interface.

Cisco CMTS Cable Command Reference

582
 Cable Commands: cable o through cable r
cable rcc-template

cable rcc-template
To define a receive channel configuration (RCC) template, use the cable rcc-template command in global
configuration mode.

cable rcc-template index

Syntax Description index Specifies an RCC template ID in the range 1 to 255.

Command Default If an RCC template is not assigned to a cable interface, the CMTS will use the wideband cable interface
generated RCC for a receive channel profile (RCP).

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was replaced by the cable rcc-templates frequency-based command on
the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines A valid RCC template consists of a configured RCP ID, a receive module (RM) entry, and a receive channel
(RC) entry.
First, you define an RCC template for an RCP, and then assign the template to a cable interface to generate
RCCs based on the actual DS channel configuration.

Note When assigning an RCC template to a cable interface, use this command in interface configuration mode.

Examples The following example shows how to define an RCC template:

Router# configure terminal

Router(config)# cable rcc-template 1

Related Commands Command Description

rcp-id Specifies an ID for the Receive Channel Profile.

receive-module Specifies a receive module entry in the form of a numeric value.

receive-channel Specifies a receive channel entry in the form of a numeric value.

Cisco CMTS Cable Command Reference

583
 Cable Commands: cable o through cable r
cable rcc-templates frequency-based

cable rcc-templates frequency-based

To allow users to create RCC templates based on frequency-based RCC templates, use the cable rcc-templates
frequency-based command in interface configuration mode. To remove an RCC template, use the no form
of the command.

cable rcc-templates frequency-based ID

no cable rcc-templates frequency-based ID

Syntax Description frequency-based Specifies frequency-based RCC templates (1 - 8).

ID RCC template ID. The range is from 1 to 64.

Command Default Associates an RCC template with a particular MAC domain.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.
This command replaces the cable rcc-template command.

Usage Guidelines This command is used to define multiple RCC templates.

The following example shows how to define an RCC template:

Router(config)# cable rcc-templates frequency-based 1

Router(config-rcc-freq-based)# rcp-id 00 10 18 80 61
(config-rcc-freq-based)# cm-attribute-mask 00ffffff
(config-rcc-freq-based)# rcc-template 1
(config-rcc-freq-based-tmplt)# module 1 channel 1-4 start-frequency 111000000
(config-rcc-freq-based-tmplt)# module 2 channel 5-8 start-frequency 135000000

(config)# interface cable 7/0/0

(config-if)# cable rcc-templates frequency-based 1

Related Commands Command Description

cable Specifies an ID for the Receive Channel Profile.

rcp-id

Cisco CMTS Cable Command Reference

584
 Cable Commands: cable o through cable r
cable rcp-control

cable rcp-control
To enable the receive channel profile (RCP) reporting with verbose description, use the cable rcp-control
command in interface configuration mode. To revert to the default simple RCP reporting, use the no form of
this command.

cable rcp-control verbose

no cable rcp-control

Syntax Description verbose Enables RCP reporting with verbose description that contains complete subtype encodings defined
in DOCSIS 3.0.

Command Default If this command is not used, cable modems use the default RCP reporting method that contains only the RCP
identifiers.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines Use this command to enable a CM to send detailed RCP data in the registration request. This detailed RCP
data can be verified using the debug cable registration command. This verbose RCP data is useful while
configuring a receive channel configuration (RCC) template.

Examples The following example shows how to enable RCP reporting with verbose description on a cable
interface on the Cisco uBR10012 router:

Router# configure terminal

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

Router(config-if)# cable rcp-control verbose

The following example shows how to enable RCP reporting with verbose description on a cable
interface on the Cisco cBR Series Converged Broadband Routers:

Router# configure terminal

Router(config)# interface cable 3/0/0

Router(config-if)# cable rcp-control verbose

Related Commands Command Description

debug cable registration Displays debug messages for the CM registration process.

Cisco CMTS Cable Command Reference

585
 Cable Commands: cable o through cable r
cable rcp-control

Command Description

(For Cisco uBR Series Routers) cable Defines a Receive Channel Configuration (RCC)
rcc-template template.

(For Cisco cBR Series Routers) cable Defines a frequency based Receive Channel
rcc-template frequency-based Configuration (RCC) template.

Cisco CMTS Cable Command Reference

586
 Cable Commands: cable o through cable r
cable rcp-id

cable rcp-id
To configure vendor specific Receive Channel Profile's (RCP), use the cable rcp-id command in global
configuration mode.

cable rcp-id rcp id

no cable rcp-id rcp id

Syntax Description rcp id Specifies a unique RCP ID in hexadecimal.

Command Default The Standard Receive Channel Profile's (RCP) defined in DOCSIS 3.0 MULPI Specification Annex E are
pre-defined in the system by default. These RCP's are un-configurable and can be displayed using the show
cable rcps command.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The RCP's define the physical layer components that permit CM to receive multiple downstream channels.
All standard RCP's defined in DOCSIS 3.0 MULPI specification are already pre-loaded into the system. Users
can configure vendor specific RCPs using this command.

The following example shows a typical display for the cable rcp-id rcp id command for all cable
interfaces:
Router(config)#cable rcp-id 00 10 18 80 61
Router(config-rcp)#name TI
Router(config-rcp)#center-frequency-spacing 6
Router(config-rcp)#number-of-channels 8
Router(config-rcp)#primary-capable-channels 1
Router(config-rcp)#module 1 minimum-center-frequency 111000000 maximum-center-frequency
999000000(config-rcp)#module 1 number-of-adjacent-channels 10
Router(config-rcp)#module 1 connected-module 1
Router(config-rcp)#module 2 minimum-center-frequency 111000000 maximum-center-frequency
999000000
Router(config-rcp)#module 2 number-of-adjacent-channels 10
Router(config-rcp)#module 2 connected-module 2 #show cable rcp-id 00 10 18 80 61
RCP-ID : 00 10 18 10 61
Name : TI
Number of association : 1
Center Frequency Spacing : 6
Number of Channels : 8
Primary Capable Channels : 1
Number of Modules : 2
Module [1]:
Number-of-adjacent-channels : 10
Minimum-center-frequency : 111000000
Maximum-center-frequency : 999000000
Connected Module : 1
Module [2]:
Number-of-adjacent-channels : 10

Cisco CMTS Cable Command Reference

587
 Cable Commands: cable o through cable r
cable rcp-id

Minimum-center-frequency : 111000000
Maximum-center-frequency : 999000000
Connected Module : 2

Related Commands Command Description

center-frequency-spacing Specifies center frequency spacing between each channel in RCP.

number-of-channels Specifies the number of receive channels.

Cisco CMTS Cable Command Reference

588
 Cable Commands: cable o through cable r
cable reconciliation enable

cable reconciliation enable

If the cable modem does not respond to pings from the Cisco Converged Broadband Router, the modem
DSBG, DSID, and the BPI index values on the Cisco Converged Broadband Router may be incorrect. To
recover the unresponsive modem, run the cable reconciliation enable command to generate the correct
DSBG, DSID, and the BPI index values.

cable reconciliation enable

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.8.1

The following example shows how to recover unresponsive modems using the cable reconciliation
enable command for all cable interfaces:
Router(config)#configure terminal
Router(config)# cable reconciliation enable
Router(config)# end

Related Commands Command Description

cable reconciliation time Specifies the time when the cable reconciliation enable command should run.

Cisco CMTS Cable Command Reference

589
 Cable Commands: cable o through cable r
cable reconciliation time

cable reconciliation time

To set the time when the cable reconciliation enable command should run, use the cable reconciliation time
hours command, where hours is the time in the 24 hour format.

cable reconciliation time

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.8.1

The following example shows how to set the time when the cable reconciliation enable command
should run:
Router(config)#configure terminal
Router(config)# cable reconciliation time 23
Router(config)# end

Related Commands Command Description

cable reconciliation enable Recover unresponsive modems.

Cisco CMTS Cable Command Reference

590
 Cable Commands: cable o through cable r
cable reduction-mode energy-management dynamic-channel-percent

cable reduction-mode energy-management

dynamic-channel-percent
To set the percentage of dynamic channel bandwidth, use the cable reduction-mode energy-management
dynamic-channel-percent command in the global configuration mode. Use the no form of the command to
restore the default value.

[no] cable reduction-mode energy-management dynamic-channel-percent value

Syntax Description value Percentage to channel bandwidth when creating dynamic bonding groups for energy management.
Valid range is from 1-96.

Command Default The default value is set to 5.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines The cable reduction-mode energy-management dynamic-channel-percent command sets the percentage
of dynamic channel bandwidth.

Router# configure terminal

Router(config)#cable reduction-mode energy-management dynamic-channel-percent
10

Cisco CMTS Cable Command Reference

591
 Cable Commands: cable o through cable r
cable reduction-mode energy-management enable

cable reduction-mode energy-management enable

To enable the energy management feature, use the cable reduction-mode energy-management enable
command in the global configuration mode. To disable the energy management feature, use the no form of
the command.

[no] cable reduction-mode energy-management enable

Syntax Description This command has no arguments or keywords.

Command Default Disabled.

Command Modes Global configuration (config)

Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE This command was introduced on Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines The cable reduction-mode energy-management enable command enables the energy management mode.

The following example shows how to enable or disable the energy management feature:
Router# configure terminal
Router(config)# cable reduction-mode energy-management enable
Router(config)#no cable reduction-mode energy-management enable

Related Commands Command Description

show cable modem Shows if a modem is working in the energy management

mode.

Show cable modem reduction-mode Shows the the original wideband and upstream channel
energy-management-mode information.

Cisco CMTS Cable Command Reference

592
 Cable Commands: cable o through cable r
cable reduction-mode energy-management process-queue-size

cable reduction-mode energy-management process-queue-size

To set the queue size of the energy management requests, use the cable reduction-mode energy-management
process-queue-size command in the global configuration mode. Use the no form of the command to restore
the default value.

[no] cable reduction-mode energy-management process-queue-size value

Syntax Description value Queue

size.

Command Default The default value is set to 150.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines The cable reduction-mode energy-management process-queue-size command sets the queue size of the
energy management requests.

Router# configure terminal

Router(config)#cable reduction-mode energy-management process-queue-size 500

Cisco CMTS Cable Command Reference

593
 Cable Commands: cable o through cable r
cable reduction-mode energy-management ranging-init-technique

cable reduction-mode energy-management

ranging-init-technique
To configure the technique in init-ranging, use the cable reduction-mode energy-management
ranging-init-technique command in global configuration mode. Use the no form of the command to restore
the default value.

[no] cable reduction-mode energy-management ranging-init-technique value

Syntax Description value Value of US init-ranging technique:

• 1—Broadcast
• 2—Unicast
• 3—Broadcast or unicast
• 4—Direct use

Command Default The default value is set to 1.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines The cable reduction-mode energy-management ranging-init-technique command sets the technique in
init-ranging.

Router#configure terminal
Router(config)#cable reduction-mode energy-management ranging-init-technique
3

Cisco CMTS Cable Command Reference

594
 Cable Commands: cable o through cable r
cable reduction-mode mta-battery

cable reduction-mode mta-battery

To configure channel bonding downgrade for cable modems in battery backup mode, use the cable
reduction-mode mta-battery command in global configuration and interface configuration mode. To remove
the configuration, use the no form of this command.

Note For DOCSIS 3.1 battery mode, the inter-op testing with real CM is limited due to CM limitation. Most of the
testing was run by simulation.

cable reduction-mode mta-battery { { dampen-time seconds } | { dynamic-channel-percent

percent } | { enable } | { process-queue-size size } | { ranging-init-technique
us-raning-init-technique } | { scqam-primary } }

Syntax Description dampen-time seconds Specifies the dampen time in seconds. Valid range is from 30 to 300.

dynamic-channel-percent percent Specifies the maximum and first try percentage of dynamic channel
bandwidth in battery backup mode. Valid range is from 1 to 96.

enable Enables the channel bonding downgrade for cable modems in battery
backup mode.

process-queue-size size Specifies the maximum transaction that can be processed at the same
time. Valid range is from 50 to 10000.

ranging-init-technique Specifies the init-ranging technique. The valid values are:

us-raning-init-technique
• 1 - Broadcast.
• 2 - Unicast.
• 3 - Broadcast or Unicast.
• 4 - Direct use.

scqam-primary Use SCQAM primary channel in battery backup mode when the modem
is with OFDM primary channel. This option is disabled by default.

Command Default No default behavior or values.

Command Modes
Global configuration (config)

Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Cisco CMTS Cable Command Reference

595
 Cable Commands: cable o through cable r
cable reduction-mode mta-battery

Command History Release Modification

Cisco IOS XE Dublin This scqam-primary option is introduced.

17.12.1

12.2(33)SCI2 This command was introduced.

IOS-XE 3.16.0S This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use the cable reduction-mode mta-battery command to enable channel bonding downgrade for cable
modems in battery backup mode. In addition, you can configure dampen time, init-range technique, maximum
and first try percentage using this command.

Examples The following example shows how to enable the channel bonding downgrade for cable modems in
battery backup mode globally:

Router(config)# cable reduction-mode mta-battery enable

Router(config)#

The following example shows how to configure dampen time:

Router(config)# cable reduction-mode mta-battery dampen-time 30
Router(config)#

The following example shows how to configure the init-ranging technique:

Router(config)# cable reduction-mode mta-battery ranging-init-technique 3
Router(config)#

The following example shows how to configure the maximum and first try percentage of dynamic
channel bandwidth in battery backup mode:
Router(config)# cable reduction-mode mta-battery dynamic-channel-percent 20
Router(config)#

The following example shows how to enable the channel bonding downgrade for cable modems in
battery backup mode for each MAC domain:

Router(config-if)# cable reduction-mode mta-battery enable

Router(config-if)#

The following example shows how to enable support for DOCSIS 3.1 CM to single carrier (1 SCQAM
DS + 1 SCQAM US) when it runs in Battery Reduction Mode:
:

Router(config-if)# cable reduction-mode mta-battery scqam-primary

Router(config-if)#

Related Commands Command Description

show cable modem reduction-mode Displays the channel bonding downgrade information for
mta-battery cable modems in battery backup mode.

Cisco CMTS Cable Command Reference

596
 Cable Commands: cable o through cable r
cable redundancy hashfilter

cable redundancy hashfilter

To set the MAC address and DDC node mappings of the DDC redundancy scheme, use the cable redundancy
hashfilter command in global configuration mode. This hash filter is to be shared by all DDC nodes (routers)
in the redundancy scheme. To remove the hash filter from the Cisco CMTS router, use the no form of this
command.

cable redundancy hashfilter hash_id {type namestring | mac-mask mac-mask | mac-map mac-address
node node_id | oui-map oui node node_id}
no cable redundancy hashfilter

Syntax Description hash_id Unique ID for the shared hash filter. Multiple (differently named) hash filters are
supported in the same Cisco DDC Redundancy scheme at the same time, though
only one hash filter can be enabled at any one time. The valid range is from 1 to 3.

type namestring Alphanumeric hash filter name. Only the namestring of default is supported at this
time.

mac-mask mac-mask Specifies the number of bits in the cable modem’s MAC address to be used by the
hashing algorithm.

mac-map mac-address A manually configured MAC address for the DDC node (overrides any default MAC
address configured on the router).

node node_id This value overrides the node that all cable modems with the shared mac-address
or oui value will use, and updates the MAC address mapping in the hash filter.

oui-map oui This value overrides the node that all cable modems with the shared OUI value will
use, and updates the OUI address mapping in the hash filter.

Command Default • Cable redundancy hash filters are disabled (not configured) by default.
• Only the hash filter name of default is supported at this time.

Command Modes
Global configuration (config)

Command History Release Modification

Release 12.3(9a)BC This command was introduced on the Cisco uBR7246 universal broadband router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is used in the early stages of configuring DDC Redundancy on all DDC nodes (routers) in the
scheme. For additional information in context, refer to the Configuring Cisco DDC Redundancy on the Cisco
uBR7246VXR Universal Broadband Router feature documentation on Cisco.com.

Cisco CMTS Cable Command Reference

597
 Cable Commands: cable o through cable r
cable redundancy hashfilter

Note This configuration must be present and identical on each CMTS router participating in the DDC redundancy
scheme.

Examples The following example implements the cable redundancy hashfilter command in four sequential
steps, completing the entire mapping information required for one DDC node in a redundancy scheme
of two routers:

Router# cable redundancy hashfilter 1 type default

Router# cable redundancy hashfilter 1 macmask FFFF.FF00.0000
Router# cable redundancy hashfilter 1 macmap 0007.0e03.68ad node 2
Router# cable redundancy hashfilter 1 ouimap 00070e node 1

Related Commands Command Description

cable redundancy myid Sets the total number of Cisco DDC nodes (routers) in the DDC Redundancy
scheme, and sets the ID of the current DDC node.

cable redundancy node Configures the DDC node with active or standby state.

show cable redundancy Displays the current DDC redundancy configurations and status.

Cisco CMTS Cable Command Reference

598
 Cable Commands: cable o through cable r
cable redundancy myid

cable redundancy myid

To set the total number of Cisco DDC nodes (routers) in the DDC Redundancy scheme, and to set the ID of
the current DDC node, use the cable redundancy myid command in global configuration mode. To remove
a DDC node ID from the router, use the no form of this command.

cable redundancy myid node_id nodes nodes

no cable redundancy myid node_id

Syntax Description node_id A unique identifier for the Cisco DDC node currently being configured. The value must be 1 or
greater (not to exceed the value used for nodes). This value must be unique on each CMTS that
participates in the scheme.

nodes Total number of Cisco CMTS routers participating in the DDC redundancy scheme (range 1 to 3).
This value must be identical on all DDC nodes (routers).

Command Default DDC Redundancy is disabled and DDC nodes (routers) are not configured for DDC redundancy by default.

Command Modes
Global configuration (config)

Command History Release Modification

Release 12.3(9a)BC This command was introduced on the Cisco uBR7246 universal broadband router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This configuration must be present (identical except node_id) on all DDC nodes (routers) participating in the
scheme.
This command is used in the early stages of configuring DDC Redundancy on all DDC nodes (routers) in the
scheme. For additional information in context, refer to the Configuring Cisco DDC Redundancy on the Cisco
uBR7246VXR Universal Broadband Router feature documentation on Cisco.com.

Examples The following example configures the DDC node (router) ID to be 2 in a scheme in which there are
three DDC nodes total.

Router# cable redundancy myid 2 nodes 3

Related Commands Command Description

cable redundancy node Configures the DDC node with active or standby state.

show cable redundancy Displays the current DDC redundancy configurations and status.

Cisco CMTS Cable Command Reference

599
 Cable Commands: cable o through cable r
cable redundancy node

cable redundancy node

To set the DDC node (router) with which a subinterface is associated, and to set the state for that interface,
use the cable redundancy node command in subinterface configuration mode. To remove this configuration
from the router, use the no form of this command.

cable redundancy node node_id {active | standby} [force]

no cable redundancy node node_id {active | standby}

Syntax Description node_id DDC node (router) with which the subinterface is associated. The range is the number of DDC
nodes in the scheme.

force Optional keyword forces the subinterface into the standby state regardless of the number of active
voice or E911 calls.

Command Default DDC switchover events are disabled by default and must be manually initiated on a case-by-case basis.

Command Modes
Subinterface configuration (config-subif)

Command History Release Modification

Release 12.3(9a)BC This command was introduced on the Cisco uBR7246 universal broadband router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command can be used in the context of DDC configuration, testing or forced switchover events. Refer
to earlier procedures in this document for additional information.

Note Use of this command is subject to additional constraints described in the Active Voice Call Protection in Cisco
DDC Redundancy section of the Configuring Cisco DDC Redundancy on the Cisco uBR7246VXR Universal
Broadband Router feature documentation on Cisco.com.

Examples The following command sequence sets the DDC node states in a scheme with two DDC nodes
(routers), then forces a switchover event on DDC node 1 that puts it into standby state.

Router(config-subif)# cable redundancy node 2 active

Router(config-subif)# cable redundancy node 1 standby
Router(config-subif)# cable redundancy node 1 standby force

Related Commands Command Description

cable redundancy myid Sets the total number of Cisco DDC nodes (routers) in the DDC Redundancy
scheme, and sets the ID of the current DDC node.

Cisco CMTS Cable Command Reference

600
Cable Commands: cable o through cable r
cable redundancy node

Command Description

show cable redundancy Displays the current DDC redundancy configurations and status.

Cisco CMTS Cable Command Reference

601
 Cable Commands: cable o through cable r
cable redundancy node frequency

cable redundancy node frequency

To set the downstream frequencies for each node participating in the scheme other than the current DDC node
(router), use the cable redundancy node frequency command in interface configuration mode. This frequency
is used to switch cable modems to the downstream frequency of the backup interface (on another DDC node)
via DFO and DCC messages. To remove this setting from the router, use the no form of this command.

cable redundancy node node_id frequency frequency

no cable redundancy node node_id frequency frequency

Syntax Description node_id DDC target node ID for which the frequency is being set.

frequency Downstream frequency of the target interface.

Command Default Cable downstream frequency override is enabled by default.

Command Modes
Interface configuration (config-if)

Command History Release Modification

Release 12.3(9a)BC This command was introduced on the Cisco uBR7246 universal broadband router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command must be present on each cable interface participating in the scheme, regardless of its bundle
status.

Examples The following example configures the downstream frequency of DDC node 1 to be 435000000.

Router(config-if)# cable redundancy node 1 frequency 435000000

Related Commands Command Description

cable redundancy myid Sets the total number of Cisco DDC nodes (routers) in the DDC Redundancy
scheme, and sets the ID of the current DDC node.

cable redundancy node Configures the DDC node with active or standby state.

cable redundancy target Configures the DDC node by setting the target DDC node (router) to use in
a DDC switchover event.

cable redundancy threshold Configures the DDC node by setting the active voice call threshold on the
current DDC node (router)

show cable redundancy Displays the current DDC redundancy configurations and status.

Cisco CMTS Cable Command Reference

602
 Cable Commands: cable o through cable r
cable redundancy target

cable redundancy target

To set the target DDC node (router) to use in a DDC switchover event, use the cable redundancy target
command in interface configuration mode. To remove this configuration from the router, use the no form of
this command.

cable redundancy target node_id

no cable redundancy target node_id

Syntax Description node_id Target node ID (in relation to the current DDC node)

Command Default When this command is not present, the default target node is the next higher node in the scheme.

Command Modes
Interface configuration (config-if)

Command History Release Modification

Release 12.3(9a)BC This command was introduced on the Cisco uBR7246 universal broadband router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The downstream frequency that is used in a DDC switchover event is the frequency set on the respective target
DDC node, as set with this command.

Note This command may be present on each participating cable interface, regardless of its bundle status.

When this command is not present, the default target node is the next higher node in the scheme (the next
higher node_id value in the scheme). For example, if there are three participating nodes, the default target
nodes are as follows (respectively):
• If the current node is 1, the target node is 2.
• If the current node is 2, the target node is 3.
• If the current node is 3, the target node is 1.

Examples The following example configures the target node on the current router to be DDC node 1, often
referred to as CMTS A in additional sections of this document.

Router(config-if)# cable redundancy target 1

Related Commands Command Description

cable redundancy myid Sets the total number of Cisco DDC nodes (routers) in the DDC
Redundancy scheme, and sets the ID of the current DDC node.

cable redundancy node Configures the DDC node with active or standby state.

Cisco CMTS Cable Command Reference

603
 Cable Commands: cable o through cable r
cable redundancy target

Command Description

cable redundancy node frequency Configures the DDC scheme by setting the DS frequencies for each
node in the scheme other than the current DDC node (router).

cable redundancy threshold Configures the DDC node by setting the active voice call threshold on
the current DDC node (router).

show cable redundancy Displays the current DDC redundancy configurations and status.

Cisco CMTS Cable Command Reference

604
 Cable Commands: cable o through cable r
cable redundancy threshold

cable redundancy threshold

To set the active voice call threshold on the current DDC node (router), use the cable redundancy threshold
command in interface configuration mode. To remove this configuration from the router, use the no form of
this command.

cable redundancy threshold max-calls

no cable redundancy threshold

Syntax Description max-calls The threshold value for the number of active voice calls.

Command Default The threshold for maximum calls is not set by default.

Command Modes
Interface configuration (config-if)

Command History Release Modification

Release 12.3(9a)BC This command was introduced on the Cisco uBR7246 universal broadband router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines If the number of active voice calls exceeds this value, a DDC switchover does not take place unless it is forced
by using the cable redundancy node node_id standby force subinterface configuration command.
If the command is configured on a bundle primary, the threshold is used to compare with the total number of
voice calls in the bundle. This command is not accepted on interfaces configured as bundle subordinates.
If this threshold is not configured, this check does not occur and the DDC switchover proceeds regardless of
how many voice calls are active. This is subject to additional constraints described in the Call Priority in
Cisco DDC Redundancy section of the Configuring Cisco DDC Redundancy on the Cisco uBR7246VXR
Universal Broadband Router feature documentation on Cisco.com.

Examples The following example configures DDC redundancy not to take place if there are more than 20 active
or E911 calls at the time a DDC switchover event is attempted or requested.

Router(config-if)# cable redundancy threshold 20

Related Commands Command Description

cable redundancy myid Sets the total number of Cisco DDC nodes (routers) in the DDC
Redundancy scheme, and sets the ID of the current DDC node.

cable redundancy node Configures the DDC node with active or standby state.

cable redundancy node frequency Configures the DDC scheme by setting the DS frequencies for each
node in the scheme other than the current DDC node (router).

Cisco CMTS Cable Command Reference

605
 Cable Commands: cable o through cable r
cable redundancy threshold

Command Description

cable redundancy target Configures the DDC node (node_id) by setting the target DDC node
(router) to use in a DDC switchover event.

show cable redundancy Displays the current DDC redundancy configurations and status.

Cisco CMTS Cable Command Reference

606
 Cable Commands: cable o through cable r
cable registration-timeout

cable registration-timeout
To set the value of the DOCSIS registration timeout timer (T9 timer) on a particular interface, use the cable
registration-timeout command in cable interface configuration mode. To reset the timeout value to the
default, use the no form of this command.

cable registration-timeout minutes

no cable registration-timeout

Syntax Description minutes Sets the value of the DOCSIS CM registration timeout timer (T9 timer). The range is from 2 to 60.
The default is 3.

Command Default 3 minutes

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.0(7)XR2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The DOCSIS 1.1 specification states that the CMTS should enforce the T9 timer, which is a registration
timeout timer that specifies the maximum time allowed between the CMTS sending a successful Ranging
Response (RNG-RSP) message and the CM replying with a Registration Request (REG-REQ) message. If
this timer expires, the CMTS must remove the CM from its list of active CMs, and the CM must restart the
registration process.
The cable registration-timeoutcommand can be used to customize the value of the T9 timer for each cable
interface, to accommodate the CMs using that interface.

Examples The following example shows the registration timeout value being increased from 3 minutes to 10
minutes:

Router# configure terminal

Router (config)# interface c6/0
Router(config-if)# cable registration-timeout 10
Router(config-if)# exit
Router(config)#

Cisco CMTS Cable Command Reference

607
 Cable Commands: cable o through cable r
cable relay-agent-option

cable relay-agent-option
To enable the system to insert the CM MAC address into a Dynamic Host Configuration Protocol (DHCP)
packet received from a CM or host and forward the packet to a DHCP server, use the cable relay-agent-option
command in cable interface configuration mode. To disable MAC address insertion, use the no form of this
command.

cable relay-agent-option
no cable relay-agent-option

Syntax Description This command has no keywords or arguments.

Command Default MAC address insertion is disabled (no cable relay-agent-option).

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

11.3 NA This command was introduced.

12.0 mainline, 12.1(2)EC1, 12.0(10) This command was made obsolete and was replaced by the ip dhcp
SC relay information option command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This functionality enables the use of DHCP Option 82 to allow a DHCP server to identify the CM sending
the request and to initiate the appropriate action based on this information. On Cisco IOS Release 12.0 and
later releases, use the ip dhcp relay information option command to enable Option 82 processing.

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

Router(config-if)# cable relay-agent-option

Related Commands Command Description

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

cable dhcp-giaddr Modifies the GIADDR field of DHCPDISCOVER and

DHCPREQUEST packets with a Relay IP address before they are
forwarded to the DHCP server.

cable source-verify Turns on CM upstream verification.

cable telco-return spd Enforces the telco-return CM to use a specific DHCP server.
dhcp-authenticate

Cisco CMTS Cable Command Reference

608
Cable Commands: cable o through cable r
cable relay-agent-option

Command Description

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

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

ip dhcp smart-relay Monitors client retransmissions when address pool depletion occurs.

Cisco CMTS Cable Command Reference

609
 Cable Commands: cable o through cable r
cable resiliency cm-max-rbg-moves

cable resiliency cm-max-rbg-moves

You can use the cable resiliency cm-max-rbg-moves command to configure the maximum number of times
a CM can be moved to any RBG within the configured interval.
If a CM is currently at the configured limit, and it reports a new DS impairment, the CM moves to narrow
band (primary DS only). CM-STATUS recovery events are still handled for CMs that are currently at the
configured limit.
To disable this feature, use the no form of this command.

cable resiliency cm-max-rbg-moves moves interval interval

no cable resiliency cm-max-rbg-moves moves interval interval

Syntax Description cm-max-rbg-moves moves Number of times a CM can be moved to any RBG.The range is 1-10.

interval interval Configurable interval in minutes. The range is 1-65535.

Command Default This command is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Dublin 17.12.1w This command is introduced for the Cisco cBR Series Converged Broadband
routers.

Usage Guidelines Use this command to enter configuration mode.

Examples The following example shows how to enter configuration mode:

router# configure terminal

router(config)#

The following example shows how to deny any CM from moving to RBG more than 5 times in one
day
router(config)#cable resiliency cm-max-rbg-moves 5 interval 1440
router(config)#end

USe the following command to verify the configuration

router#show run | s cm-max-rbg-moves
cable resiliency cm-max-rbg-moves 5 interval 1440

Related Commands Command Description

show cable modem rbg-activity View CM RBG usage statistics.

Cisco CMTS Cable Command Reference

610
 Cable Commands: cable o through cable r
cable resiliency exclude

cable resiliency exclude

You can use the cable resiliency exclude command to exclude cable modems from Downstream Resiliency
operations. This ensures that RBG and NB are not used and the resiliency activity reduces. The exclusion list
is stored on the SUP.
The benefit of excluding cable modems is that you can manage the downstream resiliency feature better and
improve CPU efficiency. The following scenarios are examples of when you can use this feature and exclude
cable modems from Downstream Resiliency operations.
• If cable modems report an excessive amount of impairment or recovery events, then you can move cable
modems to the exclusion list. You can use the show cable resiliency counts command to identify which
downstream channels and cable modems have the most impairments.
• During planned maintenance windows, you can move cable modems to the exclusion list.

To disable this feature and remove the modem from the exclusion list, use the no form of this command.

cable resiliency exclude { modem mac-address | oui id }

no cable resiliency exclude { modem mac-address | oui id }

Syntax Description modem mac-address Excludes the cable modem with the specified MAC address from Downstream
Resiliency operations.

oui id Excludes the specified Organizational Unique Identifier (OUI) from Downstream
Resiliency operations.

Command Default This command is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Dublin This command is introduced for the Cisco cBR Series Converged Broadband
17.12.1x routers.

Usage Guidelines Use this command to enter configuration mode.

Examples
router# configure terminal
router(config)#

The following example shows how to exclude a cable modem with a specified MAC address from
Downstream Resiliency operations.
router(config)#cable resiliency exclude modem 34bd.fa0f.4784
router(config)#end

Cisco CMTS Cable Command Reference

611
 Cable Commands: cable o through cable r
cable resiliency exclude

The following example shows how to exclude a cable modem with a specified OUI from Downstream
Resiliency operations.
router(config)#cable resiliency exclude oui 34.bd.fa
router(config)#end

Use the following command to verify the configuration and view the list of excluded modems.
router# show cable resiliency exclude
Load for five secs: 14%/0%; one minute: 4%; five minutes: 4%
Time source is NTP, 21:59:51.293 EDT Sun Nov 30 2023

MAC Address I/F State Primary WB

34bd.fa0f.4784 C8/0/1 w-online(pt) Wi8/0/1:4
34bd.fa0f.3726 C8/0/1 w-online(pt) Wi8/0/1:4
34bd.fa0f.5690 C8/0/0 w-online(pt) Wi8/0/0:3
34bd.fa0f.8899 C8/0/0 w-online(pt) Wi8/0/0:5

Related Commands Command Description

show cable resiliency exclude Use this command to display a list of cable modems excluded from
Downstream Resiliency operations.

Cisco CMTS Cable Command Reference

612
 Cable Commands: cable o through cable r
cable resiliency ds-bonding

cable resiliency ds-bonding

To enable the Downstream Resiliency Bonding Group feature and to create a resiliency bonding group (RBG)
on the Cisco CMTS router, use the cable resiliency ds-bonding command in global configuration mode. To
disable this feature, use the no form of this command.

cable resiliency ds-bonding

no cable resiliency ds-bonding

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable ds-resiliency command is used to configure the Downstream Resiliency Bonding Group feature.

Examples The following example shows how to configure the Downstream Resiliency Bonding Group feature:

Router(config)# cable resiliency ds-bonding

Related Commands Command Description

cable ds-resiliency Reserves a resiliency bonding group for a line card on the Cisco CMTS
router.

show cable modem resiliency Displays resiliency status of the cable modem in resiliency mode on the
Cisco CMTS router.

show cable resiliency Displays all information about resiliency bonding groups on the Cisco CMTS
router.

Cisco CMTS Cable Command Reference

613
 Cable Commands: cable o through cable r
cable resiliency free-interval

cable resiliency free-interval

To set the wait time before a created resiliency bonding group is freed/recycled, use the cable resiliency
free-interval command in global configuration mode. To disable this feature, use the no form of this command.

cable resiliency free-interval seconds

no cable resiliency free-interval

Syntax Description seconds Specifies the wait time in seconds before a created resiliency bonding group is freed/recycled. The
recommended value is 360.

Command Default None.

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Gibraltar 16.12.1y This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command applies to all non-primary RF channels on a Cisco CMTS router.

Examples The following example shows how to specify the wait time in seconds before a created resiliency
bonding group is freed/recycled:

Router# configure terminal

Router(config)# cable resiliency free-interval 360

Related Commands Command Description

cable rf-change-up-multiplier Specifies the rf-channel up dampen time as an integer multiplier of the
rf-channel down dampen time.

Cisco CMTS Cable Command Reference

614
 Cable Commands: cable o through cable r
cable resiliency idle-interval

cable resiliency idle-interval

You can set the time in seconds for the cable ds-resiliency idle-interval seconds command to move an unused
Resiliency Bonding Group's (RBG) state from Assigned to In_Delete in global configuration mode. To
disable this feature, use the no form of this command.

cable resiliency idle-interval seconds

no cable resiliency idle-interval

Syntax Description seconds Specify the time in seconds for the cable ds-resiliency command to move an unused RBG's state
from Assigned to In_Delete. The valid range is 1 to 3600. The default value is 300.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This command is introduced for the Cisco cBR Series Converged
Broadband Routers

Usage Guidelines Use the cable ds-resiliency idle-interval seconds command to move an unused Resiliency Bonding Group's
(RBG) state from Assigned to In_Delete. This command applies to all non-primary RF channels on a Cisco
CMTS router.

Examples The following example shows how to configure the cable resiliency idle-interval command:

Router# configure terminal

Router(config)# cable resiliency idle-interval 480

Related Commands Command Description

cable Reserves a resiliency bonding group for a line card on the Cisco CMTS router.
ds-resiliency

Cisco CMTS Cable Command Reference

615
 Cable Commands: cable o through cable r
cable resiliency rbg-throttle

cable resiliency rbg-throttle

You can use the cable resiliency rbg-throttle command to reduce SUP CPU usage during CM Mass
Registration Events. You can configure the SUP CPU threshold and CM online rate threshold.
To disable this feature, use the no form of this command.

cable resiliency rbg-throttle { auto { cm-threshold cm-threshold | cpu-threshold cpu-threshold |

nb-to-rbg-rate nb-to-rbg-rate | settle-time time } | rate rate [ auto ] }

no cable resiliency rbg-throttle

Syntax Description auto Resiliency bonding group throttle auto mode.

rate Resiliency bonding group throttle rate.

rate The number of RBGs that are created per minute. The range is 0-100.

cm-threshold Auto mode CM online threshold.

cm-threshold Average CM online rate per minute. The range is 0-500.

cpu-threshold Auto mode cpu threshold.

cpu-threshold Average cpu usage per minute. The range is 0-100.

nb-to-rbg-rate Rate of moving CMs from throttled-cm list to RBGs.

nb-to-rbg-rate Cisco IOS XE Dublin 17.12.1y Release and earlier: Number of CMs moved every 30
seconds. The range is 1-10.
Cisco IOS XE Dublin 17.12.1z Release and later: Number of CMs moved every 60
seconds. The range is 1-20.

settle-time Auto mode settling state duration.

time Settle state duration in minutes. The range is 0-65535.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Dublin 17.12.1z This rate and range for nb-to-rbg-rate values are updated.

Cisco IOS XE Bengaluru 17.6.1z This command is introduced for the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use this command to enter configuration mode.

Cisco CMTS Cable Command Reference

616
 Cable Commands: cable o through cable r
cable resiliency rbg-throttle

Examples The following example shows how to enter configuration mode:

Router# configure terminal

Router(config)#

The following example shows how to configure RBG Throttle auto mode and set CM threshold,
CPU threshold values, and settle time values.
Router(config)#cable resiliency rbg-throttle rate 10 auto
Router(config)#cable resiliency rbg-throttle auto cm-threshold 25
Router(config)#cable resiliency rbg-throttle auto cpu-threshold 95
Router(config)#cable resiliency rbg-throttle auto settle-time 2
Router(config)#cable resiliency rbg-throttle auto nb-to-rbg-rate 2
Router(config)#end

Use the following commands to verify the configuration.

• This is an example for Cisco IOS XE Dublin 17.12.1z Release and later:

Router# show cable resiliency throttled-cm stats

RBG Throttle: Enabled
RBG Throttle Auto Mode: Enabled

RBG Throttle Auto Mode State: STEADY

RBG Throttle Auto Mode Settling State Duration: 3 (minutes)
RBG Throttle Auto Mode NB to RBG Rate: 10 (per minute)

Metric: Configured Threshold: Current Value:

RBG Creation Rate 100 0
CPU Usage 090% 19
CM Online Rate 500 0

Throttled CM Statistics Rate (per minute) Total

CMs Added to List: 0000 0
CMs Removed from List: 0000 0
Attempts to Remove: 0005 10
RBG Creation: 0000 4

• This is an example for Cisco IOS XE Dublin 17.12.1y Release and earlier:

Router# show cable resiliency throttled-cm stats

RBG Throttle: Enabled
RBG Throttle Auto Mode: Enabled

RBG Throttle Auto Mode State: STEADY

RBG Throttle Auto Mode Settling State Duration: 2 (minutes)
RBG Throttle Auto Mode NB to RBG Rate: 2 (per 30 seconds)

Metric: Configured Threshold: Current Value:

RBG Creation Rate 010 0
CPU Usage 095% 3
CM Online Rate 025 0

Router# show cable resiliency throttled-cm list

Number of Throttled CMs: 3

MAC Address Timestamp

-------------- ---------
c8fb.26a3.cd54 Jul 28 23:25:58

Cisco CMTS Cable Command Reference

617
 Cable Commands: cable o through cable r
cable resiliency rbg-throttle

c8fb.26a3.961a Jul 28 23:26:06

c8fb.26a3.aa82 Jul 28 23:26:11

Related Commands Command Description

cable ds-resiliency Reserves a resiliency bonding group for a line card on the Cisco CMTS
router.

show cable resiliency throttled-cm Displays all information about resiliency bonding groups on the Cisco
CMTS router.

Cisco CMTS Cable Command Reference

618
 Cable Commands: cable o through cable r
cable resiliency traps-interval

cable resiliency traps-interval

To set the interval at which traps must be sent for Wideband Resiliency related events for each cable modem
on the Cisco CMTS, use the cable resiliency traps-interval command in global configuration mode. To
disable the interval, use the no form of this command.

cable resiliency traps-interval count

no cable resiliency traps-interval

Syntax Description count Time interval (in seconds) at which the traps must be sent for each cable modem. The range is from
0 to 86400. The default is 1.

Command Default By default, the resiliency trap interval is enabled and set as 1 second.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCG2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable resiliency traps-interval command is associated with the Wideband Modem Resiliency feature.
When the network has less number of cable modems with resiliency events occurring at a given time, use the
default value of 1 second interval. But if the network has many cable modems with resiliency events occurring
at a given time, set the interval to a higher value.

Examples The following example shows how to set the time interval to 10 second for sending traps for each
cable modem:

Router(config)# cable resiliency traps-interval 10

Related Commands Command Description

show cable modem resiliency Displays resiliency status of the cable modem in resiliency mode on the
Cisco CMTS router.

Cisco CMTS Cable Command Reference

619
 Cable Commands: cable o through cable r
cable rf-adapt timer

cable rf-adapt timer

To configure timers for RF adaptation, use the cable rf-adapt timer command in global configuration mode.
To disable the timers, use the noform of this command.

cable rf-adapt timer {general time | candidate time | relocation time}

no cable rf-adapt timer

Syntax Description general Period when the RF adaptation process examines the physical layer statistics of all modems on
RF adaptation-enabled upstream channels. The valid range is from 1 to 300 seconds. The default
value is 10 seconds.

candidate Period when the RF adaptation process examines the physical layer statistics of modems flagged
as downgrade and/or upgrade candidates. The valid range is from 1 to 300 seconds. The default
value is 1 second.

relocation Period when the RF adaptation process performs a single relocation of a candidate modem from
its current upstream channel to the appropriate destination. The valid range is from 1 to 300
seconds. The default value is 1 second.

time Time in seconds. The valid range is from 1 to 300.

Command Default Default timer values are used.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to set timers for cable modem upstream RF adaptation:

Router(config)# cable rf-adapt timer general 120

Router(config)# cable rf-adapt timer candidate 10
Router(config)# cable rf-adapt timer relocation 5

Related Commands Command Description

cable upstream rf-adapt Enables RF adaptation on the physical upstream channel.

cable upstream rf-adapt (logical Configures the primary upstream logical channel and secondary
channel) upstream logical channel.

Cisco CMTS Cable Command Reference

620
Cable Commands: cable o through cable r
cable rf-adapt timer

Command Description

cable upstream threshold Configures the upstream for the signal-to-noise ratio (SNR) and
forward error correction (FEC) threshold values to be used in
determining the allowable noise levels.

cable upstream threshold hysteresis Configures the hysteresis value to be used in conjunction with the
dynamic modulation upgrade thresholds.

cable upstream threshold rf-adapt Configures the upstream RF adaptation threshold value, which
prevents excessive relocation of modems from the primary upstream
channel to the secondary upstream channel.

show cable modem rf-adapt Displays the RF adaptation history.

show cable rf-adapt Displays the downgrade and upgrade candidate lists.

Cisco CMTS Cable Command Reference

621
 Cable Commands: cable o through cable r
cable rf-bandwidth-percent

cable rf-bandwidth-percent
To enable either static or dynamic bandwidth sharing for a modular cable (MC) or integrated cable (IC)
interface, use the cable rf-bandwidth-percent command in interface configuration mode or MAC domain
profile configuration mode. To remove bandwidth sharing for the MC or IC interface, use the no form of this
command.

cable rf-bandwidth-percent percent-value [remaining ratio excess-value]

no cable rf-bandwidth-percent

Cisco cBR Series Converged Broadband Routers

cable rf-bandwidth-percent percent-value

Syntax Description percent-value Specifies static bandwidth allocation of a downstream RF channel. The range is 1–96. The
default is 0.

remaining (Optional) Specifies the ratio of the remaining or excess bandwidth that can be allocated
ratio to the modular cable channel. (For Cisco uBR10012 Router and Cisco uBR7200 Series
Routers)
Note
This option is only available when dynamic bandwidth sharing is enabled.

excess-value (For Cisco uBR10012 Router and Cisco uBR7200 Series Routers) Specifies the value of
excess bandwidth that can be allocated to the modular cable channel. The valid range is
from 1 to 100. The default is 1.

Command Default The default static bandwidth percentage for a modular cable or integrated cable interface is 0.

Command Modes
Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

12.3(23)BC1 The remaining ratio option was added.

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

IOS-XE 3.15.0S This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
cBR Series Converged Broadband Routers was added.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Cisco CMTS Cable Command Reference

622
 Cable Commands: cable o through cable r
cable rf-bandwidth-percent

Usage Guidelines The total percentage of the RF channel bandwidth allocated to both the modular cable (MC) and wideband
interfaces must not exceed 96 percent. The remaining 4 percent of the bandwidth is reserved for minislot
allocation packet (MAP) and other MAC management messages (MMM) DOCSIS traffic using this RF
channel as its primary channel.
When dynamic bandwidth sharing (DBS) is enabled on the MC or IC interface, the bandwidth percentage is
converted to a committed information rate (CIR) value for the corresponding link queue. By re-interpreting
the bandwidth percentage value as a CIR value for the interface, the interface receives, at minimum, the
configured percent of bandwidth and more when the RF channel’s bandwidth is not consumed by other
interfaces sharing the same RF channel. The remaining ratio option (applicable only for Cisco uBR7K and
uBR10K Series Routers) is only available when DBS is enabled using the cable dynamic-bw-sharing
command.

Note For Cisco cBR Series Converged Broadband Routers, DBS is always enabled but the remaining ratio is not
configurable.

(For Cisco uBR7K and uBR10K Series Routers) If the cable rf-bandwidth-percent command is not configured
and DBS is enabled, no bandwidth is reserved for the MC interface and it is effectively in the protocol down
state—the MC link queue is not created. Static bandwidth sharing (the default) or DBS can be configured on
an MC interface, but you cannot have both on the same interface.

Examples The following is an example of static bandwidth allocation configuration:

Router# configure terminal

Router(config)# interface modular-cable 1/0/0:0
Router(config-if)# cable rf-bandwidth-percent 70

The following is an example of dynamic bandwidth sharing configuration:

Router# configure terminal

Router(config)# interface modular-cable 1/0/0:0
Router(config-if)# shutdown
Router(config-if)# cable dynamic-bw-sharing
Router(config-if)# no shutdown
Router(config-if)# cable rf-bandwidth-percent 70 remaining ratio 25

The following is an example of static bandwidth allocation configuration in cBR Series Converged
Broadband Routers:

Router# configure terminal

Router(config)# interface Integrated-cable 3/0/0:0
Router(config-if)# cable rf-bandwidth-percent 70

Related Commands Command Description

cable dynamic-bw-sharing Enables dynamic bandwidth sharing on a specific modular cable or wideband
cable interface.

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband channel and
allocates bandwidth.

Cisco CMTS Cable Command Reference

623
 Cable Commands: cable o through cable r
cable rf-bandwidth-percent

Command Description

show pxf cable controller Displays information about the RF channel Versatile Traffic Management
System (VTMS) links and link queues.

show pxf cpu queue Displays parallel express forwarding (PXF) queueing and link queue statistics.

Cisco CMTS Cable Command Reference

624
 Cable Commands: cable o through cable r
cable rf-change-dampen-time

cable rf-change-dampen-time
To configure the amount of time a radio frequency (RF) channel must remain in its new state (either up or
down), use the cable rf-change-dampen-time command in global configuration mode. To restore the default
value, use the no form of this command.

cable rf-change-dampen-time seconds

no cable rf-change-dampen-time

Syntax Description seconds Specifies the amount of time in seconds for a non-primary RF channel to remain in its new state.
The valid range is 1 to 65535. The default value is 60.

Command Default If this command is not used, the default value of 30 seconds is restored.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE 17.3.1z The default value was updated.

Usage Guidelines This command applies to all non-primary RF channels on a CMTS.

Examples The following example shows how to specify the amount of time for a non-primary RF channel to
remain in its new state:

Router# configure terminal

Router(config)# cable rf-change-dampen-time 10

Related Commands Command Description

cable rf-change-trigger Specifies the persistence thresholds for an event before the event triggers an action
for the cable modem.

Cisco CMTS Cable Command Reference

625
 Cable Commands: cable o through cable r
cable rf-change-trigger

cable rf-change-trigger
To specify the amount of time an event must persist before it triggers an action for the reporting cable modem,
use the cable rf-change-trigger command in global configuration mode. To restore the default value, use the
no form of this command.

cable rf-change-trigger {percent value | count number} [secondary]

no cable rf-change-trigger {percent value | count number} [secondary]

Syntax Description percent Indicates the percentage of cable modems that must report that a particular non-primary RF
value channel is down before that channel is suspended from the bonding group. The valid range
is 1 to 100. The default is 50.

count Specifies the number of cable modems that must report that a particular non-primary
number downstream channel is down before that channel is suspended from the downstream bonding
groups. The default is 0

secondary (Optional) Configures the Cisco CMTS to move the unicast secondary service flows to the
primary channel interface, when the number of cable modems reporting RF channel impairment
is less than the configured (percent or count) threshold.
By default, the secondary keyword is not configured.
Note
Only those unicast secondary service flows, which share the same wideband interface as the
primary interface, are moved to the primary channel interface.

Command Default If this command is not used, the default value 0 is used.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

12.2(33)SCE4 This command was modified. A new keyword secondary was added to move the unicast
secondary SFs, which share the same interface as the primary SF, to the primary channel
interface when the trigger threshold is not reached.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE 17.3.1z The default value was updated.

Usage Guidelines The cable rf-change-trigger command is used to configure the Wideband Modem Resiliency feature.
This command applies to all non-primary RF channels on a Cisco CMTS router. The default value of 0 prevents
any bonding group modifications. In order to dampen the change of a logical state of an RF channel, the
trigger for the channel can be set to one half of the number used for the logical state. For example, if you enter
cable rf-change-trigger percent 20, when 20 percent of the cable modems report an RF channel is down,

Cisco CMTS Cable Command Reference

626
 Cable Commands: cable o through cable r
cable rf-change-trigger

the logical state of the RF channel is changed to down. And when 10 percent of the cable modems report that
the affected RF channel is back, the logical state is changed to up.
In the case of a small number of wideband modems, you can specify an absolute value for triggering an event
in addition to the percentage. Both values must be true in order to trigger the suspension of an RF channel.
When both values are 0, the cable modem is reset if the cable modem reports an RF failure through a status
message. Also, if you set thresholds to 0, then all cable modems with RF failures are reset and any RFs
suspended from a bonding group are reactivated.

Examples The following example shows how to specify the amount of time an event must persist before it
triggers an action for the reporting cable modem:

Router# configure terminal

Router(config)# cable rf-change-trigger percent 50 count 1
The following example shows how to configure the Cisco CMTS to move secondary SFs to primary
interface when the trigger threshold is not reached, in Cisco IOS Release 12.2(33)SCE4:
Router# configure terminal
Router(config)# cable rf-change-trigger percent 50 count 1 secondary

Related Commands Command Description

cable rf-change-dampen-time Specifies the amount of time an RF channel must remain in its new state.

Cisco CMTS Cable Command Reference

627
 Cable Commands: cable o through cable r
cable rf-change-up-multiplier

cable rf-change-up-multiplier
To set the rf-channel up dampen time as an integer multiplier of the rf-channel down dampen time, use the
cable rf-change-up-multiplier command in global configuration mode. To disable this feature, use the no
form of this command.

cable rf-change-up-multiplier value

no cable rf-change-up-multiplier

Syntax Description value Specifies the multiplier of the rf-channel down dampen time. The valid range is 1 to 10. The default
value is 1.

Command Default 1

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Gibraltar 16.12.1y This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Cisco IOS XE Gibraltar 16.12.1z2 This command was updated on the Cisco cBR Series Converged
Broadband Routers. The default value was updated to 1.

Usage Guidelines This command applies to all non-primary RF channels on a Cisco CMTS router.

Examples The following example shows how to specify the multiplier of the rf-channel down dampen time:

Router# configure terminal

Router(config)# cable rf-change-up-multiplier 2

Related Commands Command Description

cable resiliency free-interval Specifies the wait time before a created resiliency bonding group is
freed/recycled.

Cisco CMTS Cable Command Reference

628
 Cable Commands: cable o through cable r
cable rf-channel

cable rf-channel
To associate an RF channel on the Cisco Wideband SPA with a wideband interface and allocate bandwidth,
use the cable rf-channel command in interface configuration mode. To remove an association of an RF
channel to a wideband interface, use the no form of this command.

cable rf-channel {rf-port | controller controller-num channel channel-num} [bandwidth-percent

bw-percent] [remaining ratio excess-value]
no cable rf-channel {rf-port | controller controller-num channel channel-num}

Syntax Description rf-port Specifies the RF channel physical port on the Wideband SPA field-programmable
gate array (FPGA).
Note
Valid values for the RF port depend on the configuration set with the annex
modulation command (see the “Usage Guidelines” section).

controller controller-num Specifies the controller associated with the RF channel. The valid range is from
0 to 4.
Effective with Cisco IOS Release 12.2(33)SCH for Bonding Across 3G60
Controllers Support feature, valid range is from 0 to 2.

channel channel-num Specifies the channel from the controller. The valid range is from 0 to 3.
Effective with Cisco IOS Release 12.2(33)SCH for Bonding Across 3G60
Controllers Support feature, valid range is from 0 to 23.

bandwidth-percent (Optional) Specifies the percent of bandwidth from this RF channel that will be
bw-percent used for the wideband interface. The range is 0 to 100. If bandwidth-percent is
not used, the default bandwidth value is 100 percent.

remaining ratio (Optional) Specifies the ratio of the excess bandwidth that can be allocated to
excess-value the wideband interface. The default value is 1. The range is 1 to 100.
Note
This option is only available when dynamic bandwidth sharing (DBS) is enabled.

Command Default No default RF channel association with a wideband interface is configured. If the cable rf-channel command
is used without specifying bandwidth-percent, the default bandwidth value is 100 percent.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.3(23)BC The annex and modulation keyword options were added.

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

Cisco CMTS Cable Command Reference

629
 Cable Commands: cable o through cable r
cable rf-channel

Release Modification

12.3(23)BC1 The remaining ratio option was added.

12.2(33)SCB The remaining ratio option was integrated into Cisco IOS Release 12.2(33)SCB.

12.2(33)SCH The controller option is supported for the Cisco uBR-MC3GX60V cable interface line
card on the Cisco uBR10012 router.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable rf-channel command associates an RF channel (port) on a Wideband SPA with a wideband interface.
Optionally, you can specify the percent of bandwidth from this RF channel that will be used for the specified
wideband interface.
The Cisco uBR10012 router supports two Wideband SPAs. Each Wideband SPA supports up to 24 RF channels
depending on how the SPA is configured with the annex modulation command. For annex A and 256 QAM
modulation, each Wideband SPA supports up to 18 RF channels at full rate and up to 24 RF channels at less
than full rate. For all other cases, the SPA supports 24 RF channels.

Note The command changes in Cisco IOS releases 12.3(23)BC and 12.3(23)BC1 are not supported in Cisco IOS
release 12.2(33)SCA.

Note In Cisco IOS Releases 12.3(21)BC and 12.3(21a)BC3, the cable rf-channel command is not available on the
Cisco IOS command line until annex and modulation have been set with annex modulation command.
Effective with Cisco IOS Release 12.3(23)BC, the annex modulation command is obsolete and annex and
modulation are included as keyword options in the rf-channel frequency command.

Each Wideband SPA supports up to 32 wideband channels. A wideband interface cannot consist of RF channels
from two different Wideband SPAs. The number of RF channels that can be aggregated into a wideband
interface is determined by the capability of the wideband cable modem.
• The Linksys WCM300-NA, WCM300-EURO, and WCM300 JP wideband cable modems can receive
a wideband interface consisting of up to eight downstream RF channels at 6 MHz per channel, or up to
six downstream RF channels at 8 MHz per channel. The modem requires that the channels be received
in a 50-MHz capture window.
• The Scientific Atlanta DPC2505 and EPC2505 wideband cable modems support the receiving of one
wideband interface. The wideband channel consists of three downstream RF channels at either 6 MHz
per channel or 8 MHz per channel.
An RF channel can be associated with multiple wideband interfaces as long as the wideband interfaces belong
to the same virtual bundle interface (cable bundle) and the RF channel’s total allocated bandwidth does not
exceed 100 percent. As an example, the table below shows that a single RF channel can be associated with
multiple wideband interfaces as long as the total allocated bandwidth for the RF channel does not exceed 100
percent.

Cisco CMTS Cable Command Reference

630
 Cable Commands: cable o through cable r
cable rf-channel

Table 10: RF Channel Bandwidth Allocation

RF Channel Wideband Bandwidth

Interface Allocated

10 0 30 percent

10 1 30 percent

10 2 40 percent

Total Bandwidth Percent: 100 percent

The table below shows that a single RF channel can be associated with a narrowband and multiple wideband
interfaces as long as the total allocated bandwidth for the RF channel does not exceed 100 percent.

Table 11: Bandwidth Allocation Using a Primary-Capable RF Channel

Modular Cable Interface Wideband Wideband Wideband Total Bandwidth

Percent
Channel 0 Channel 1 Channel 2

Bandwidth 54 percent (4 percent used 10 percent 22 percent 14 percent 100 percent

Allocated from RF internally for DOCSIS
Channel 10 signaling)

Note Each RF channel on the CMTS can be mapped to a specific QAM port on an edge QAM device. Traffic from
different Wideband SPAs cannot be mixed on the same QAM port.

When dynamic bandwidth sharing (DBS) is enabled, the bandwidth percentage is converted to a committed
information rate (CIR) value that provides the level of guaranteed bandwidth for the wideband interface. The
reserved bandwidth for the wideband interface is the sum of its link queue CIR values and is used for admission
control of the service flows with minimal reserved rate. With DBS enabled and the cable rf-channel command
configured, the corresponding link queue can have 100 percent of the CIR value. The excess-value is the
percent of excess bandwidth that can be allocated to the wideband channel.
Static bandwidth sharing (the default) or DBS can be configured on a wideband interface, but you cannot
have both on the same interface.

Examples The following example shows how to associate RF channel 10 and RF channel 11 with wideband
interface 0:

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

Router(config-if)# cable rf-channel 10 bandwidth-percent 50

Router(config-if)# cable rf-channel 11

The following example shows how to associate a controller to the RF channel for a wideband interface:

Router(config)# interface wideband-Cable 7/1/0:0

Router(config-if)# cable rf-channel controller 0 channel 1

Cisco CMTS Cable Command Reference

631
 Cable Commands: cable o through cable r
cable rf-channel

In the preceding example, because no bandwidth-percent is specified in the second cable rf-channel
command, the default value (100 percent of bandwidth) applies; that is, 100 percent of RF channel
11 bandwidth is used for wideband interface 0.
The following example shows bandwidth allocation when DBS is enabled:

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

Router(config-if)# shutdown
Router(config-if)# cable dynamic-bw-sharing
Router(config-if)# no shutdown
Router(config-if)# cable rf-channel 10 bandwidth-percent 50
remaining ratio 5

In the preceding example, because DBS is enabled, the wideband interface is guaranteed 50 percent
of the bandwidth and 5 as the value for allocating excess bandwidth.
The following example shows how the Bonding Groups Across 3G60 Controllers feature is configured:

Router(config-if)#interface wideband-cable 7/0/1:30

Router(config-if)#cable rf-channel controller 1 channel 21 bandwidth-percent 10
Router(config-if)#cable rf-channel controller 1 channel 22 bandwidth-percent 10
Router(config-if)#cable rf-channel controller 1 channel 23 bandwidth-percent 10
Router(config-if)#cable rf-channel controller 0 channel 21 bandwidth-percent 10
Router(config-if)#cable rf-channel controller 0 channel 22 bandwidth-percent 10
Router(config-if)#cable rf-channel controller 0 channel 23 bandwidth-percent 10
Router(config-if)#cable rf-channel 18 bandwidth-percent 10
Router(config-if)#cable rf-channel 19 bandwidth-percent 10
Router(config-if)#end

Related Commands Command Description

annex modulation Sets the annex and modulation for the Wideband SPA.

cable bonding-group-id Specifies a Bonding Group ID and indicates whether the bonding
group is a primary or secondary bonded channel.

cable dynamic-bw-sharing Enables dynamic bandwidth sharing on a specific modular cable

or wideband cable interface.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

downstream cable Assigns a primary downstream channel for a fiber node.

ip-address (controller) Sets the IP address of the Wideband SPA FPGA.

modular-host subslot Specifies the modular-host line card for Wideband protocol
operations.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

rf-channel description Specifies the description for each RF channel.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address and UDP port for each RF
udp-port channel.

Cisco CMTS Cable Command Reference

632
Cable Commands: cable o through cable r
cable rf-channel

Command Description

rf-channel network delay Specifies the CIN delay for each RF channel.

upstream cable connector Specifies the upstream channel ports for a fiber node.

Cisco CMTS Cable Command Reference

633
 Cable Commands: cable o through cable r
cable rf-channels

cable rf-channels
To associate RF channels on the router with a wideband interface and allocate bandwidth, use the cable
rf-channels command in interface configuration mode. To remove the association of an RF channel with a
wideband interface, use the no form of this command.

Note This command can be used in the wideband interface configuration to specify RF channels on different
controllers or to specify different bandwidth percentages.

cable rf-channels [controller controller number ] channel-list group-list [bandwidth-percent bw-percent]

no cable rf-channels [controller controller number ] channel-list group-list

Syntax Description channel-list group-list Specifies the channels from the controller. The valid range is from 0 to
127.

controller controller number (Optional) Specifies the controller associated with the RF channel. The
range is from 0 to 7. If not specified, the controller is the same as
wideband interface's controller.

bandwidth-percent (Optional) Specifies the percent of bandwidth from this RF channel that
bandwidth-percent is used for the wideband interface. The range is from 0 to 100.

Command Default RF channel is not associated with a wideband interface.

Command Modes Interface configuration (config-if)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines An RF channel can be associated with multiple wideband interfaces as long as the wideband interfaces belong
to the same virtual bundle interface (cable bundle) and the RF channel’s total allocated bandwidth does not
exceed 100 percent.
An RF channel may be associated to a wideband interface on a different controller using the "controller"
option, however the following restriction applies. Wideband interfaces on controllers 0 - 3 may only include
RF channels on the same controllers. Likewise, wideband interfaces on controllers 4 - 7 may only include RF
channels on those controllers.

The following example shows how to associate an RF channel with wideband interface and allocate
bandwidth:
Router(config)# interface Wideband-Cable3/0/0:60
Router(config-if)# cable bundle 1
Router(config-if)# cable rf-channels channel-list 0-1 3-31 bandwidth-percent 1

Cisco CMTS Cable Command Reference

634
Cable Commands: cable o through cable r
cable rf-channels

Router(config)# interface Wideband-Cable3/0/0:45

Router(config-if)# cable bundle 1
Router(config-if)# cable rf-channels controller 2 channel-list 4-6 bandwidth-percent 2

Cisco CMTS Cable Command Reference

635
 Cable Commands: cable o through cable r
cable rfswitch copy

cable rfswitch copy

To copy an image from the Cisco CMTS router to the Cisco NGRFSW-ADV or from Cisco NGRFSW-ADV
to the Cisco CMTS, use the cable rfswitch copy command in privileged EXEC mode.

cable rfswitch copy filename_cmts {to-rfsw | from-rfsw} filename_rfsw

Syntax Description filename_cmts Filename of the image on or copied to the Cisco CMTS router.

to-rfsw Copies an image from the Cisco CMTS router to the Cisco NGRFSW-ADV.

from-rfsw Copies an image from the Cisco NGRFSW-ADV to the Cisco CMTS router.

filename_rfsw Filename of the image on or copied to the Cisco NGRFSW-ADV.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the cable rfswitch copy command when an existing image on the Cisco NGRFSW-ADV or Cisco CMTS
router is corrupt or out-of-date and needs to be replaced with another image.

Examples The following example shows how to download the gcv2.11 image from the Cisco CMTS router to
the Cisco NGRFSW-ADV:

Router> enable
Router# cable rfswitch copy disk0:gcv2.11 to-rfsw gcv2.11

The following example shows how to upload the gcv2.11 image from the Cisco NGRFSW-ADV to
the Cisco uBR10012 CMTS:

Router> enable
Router# cable rfswitch copy disk0:gcv2.11 from-rfsw gcv2.11

Related Commands Command Description

show hccp channel-switch state Displays the current state of the Cisco NGRFSW-ADV.

Cisco CMTS Cable Command Reference

636
 Cable Commands: cable o through cable r
cable rfswitch delete

cable rfswitch delete

To delete an image in the Cisco NGRFSW-ADV, use the cable rfswitch delete command in privileged EXEC
mode.

cable rfswitch delete filename_rfsw

Syntax Description filename_rfsw Filename of the image on the Cisco NGRFSW-ADV that needs to be deleted.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable rfswitch delete command is used to configure the Cisco uBR Advanced RF Switch
(NGRFSW-ADV). For more information, see the Cisco uBR Advanced RF Switch Software Configuration
Guide .
Use the cable rfswitch delete command when an existing image on the Cisco NGRFSW-ADV is corrupt,
out-of-date, or needs to be replaced with another image. You cannot delete the active or the golden image on
the Cisco NGRFSW-ADV.

Examples The following example shows how to delete the gcv2.11 image on the Cisco NGRFSW-ADV:

Router> enable
Router# cable rfswitch delete gcv2.11

Related Commands Command Description

show hccp channel-switch image Displays the image list on the Cisco NGRFSW-ADV.

show hccp channel-switch state Displays the current state of the Cisco NGRFSW-ADV.

Cisco CMTS Cable Command Reference

637
 Cable Commands: cable o through cable r
cable rfswitch reboot

cable rfswitch reboot

To reboot the Cisco NGRFSW-ADV, use the cable rfswitch reboot command in privileged EXEC mode.

cable rfswitch reboot

Syntax Description reboot Reboots the Cisco NGRFSW-ADV.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable rfswitch reboot command is used to configure the Cisco uBR Advanced RF Switch
(NGRFSW-ADV). For more information, see the Cisco uBR Advanced RF Switch Software Configuration
Guide .

Examples The following example shows how to reboot the Cisco NGRFSW-ADV:

Router> enable
Router# cable rfswitch reboot

Related Commands Command Description

show hccp channel-switch image Displays the image list on the Cisco NGRFSW-ADV.

show hccp channel-switch state Displays the current state of the Cisco NGRFSW-ADV.

Cisco CMTS Cable Command Reference

638
 Cable Commands: cable o through cable r
cable rfswitch set-active

cable rfswitch set-active

To set an image as active on the Cisco NGRFSW-ADV, use the cable rfswitch set-active command in
privileged EXEC mode.

cable rfswitch set-active filename_rfsw

Syntax Description filename_rfsw Filename of the image on the Cisco NGRFSW-ADV that needs to be set as active.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable rfswitch set-active command is used to configure the Cisco uBR Advanced RF Switch
(NGRFSW-ADV). For more information, see the Cisco uBR Advanced RF Switch Software Configuration
Guide .

Examples The following example shows how to set the gcv2.11 image as active on the Cisco NGRFSW-ADV:

Router> enable
Router# cable rfswitch set-active gcv2.11
Router# cable rfswitch reboot

Related Commands Command Description

show hccp channel-switch image Displays the image list on the Cisco NGRFSW-ADV.

show hccp channel-switch state Displays the current state of the Cisco NGRFSW-ADV.

Cisco CMTS Cable Command Reference

639
 Cable Commands: cable o through cable r
cable rpd

cable rpd
To enter the RPD configuration mode, use the cable rpd command in global configuration mode. To void
the RPD configuration, use the no form of this command.

cable rpd name

no cable rpd name

Syntax Description name Specifies the name of the

RPD.

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on theCisco cBR Series Converged Broadband
16.5.1 Routers.

Cisco IOS XE Fuji 16.8.1 This command was updated to support Generic Control Protocol Principal
(GCPP) on theCisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to enter the RPD configuration mode.

Examples The following example shows how to enter the RPD configuration mode:

Router# configure terminal

Router(config)# cable rpd
Router(config-rpd)#RphyNode-L01

Use this command to apply an Event Profile to RPD.

The following example shows how to apply an event profile to RPD.
Router(config)#cable rpd node6
Router(config-rpd)#identifier badb.ad13.5e08
Router(config-rpd)#core-interface Te3/1/5
Router(config-rpd)#principal
Router(config-rpd)#rpd-ds 0 downstream-cable 3/0/17 profile 10
Router(config-rpd)#rpd-us 0 upstream-cable 3/0/34 profile 13
Router(config-rpd)#r-dti 16
Router(config-rpd)#rpd-event profile 6

Use the following command to get events from RPD.

cable rpd {RPD IPRPD MACall }event {locallogpending }

To set the GCPP server as the core server, remove the principal keyword under RPD configuration.

Cisco CMTS Cable Command Reference

640
 Cable Commands: cable o through cable r
cable rpd

cable rpd p1_0719

identifier 0004.9f00.0719
core-interface Te6/1/2
principal <<<<<<<<<<< remove it, gcpp is the principal core
rpd-ds 0 downstream-cable 6/0/17 profile 7
rpd-us 0 upstream-cable 6/0/17 profile 7
core-interface Te6/1/1
rpd-ds 0 downstream-cable 6/0/3 profile 17
r-dti 6
rpd-event profile 0

Related Commands Command Description

core-interface Configures the core-interface of the RPD.

rpd-event profile profile_id Applies the event profile to RPD.

identifier MAC address of RPD.

principal The keyword to specify that this core is the principal

core.
Remove this option to set the GCPP server as the core
server.

rpd-ds 0 downstream-cable downstream_controller Specifies the mapping relationship for RPD

profile downstream_controller_profile downstream channels and the Cisco cBR-8 routers
downstream controller.

rpd-us 0 upstream-cable upstream_controller profile Specifies mapping relationship for RPD upstream
upstream_controller_profile port0 and Cisco cBR-8 routers upstream controller.

rpd-us 1 upstream-cable upstream_controller profile Specifies mapping relationship for RPD upstream
upstream_controller_profile port1 and Cisco cBR-8 upstream controller.

Cisco CMTS Cable Command Reference

641
 Cable Commands: cable o through cable r
cable rpd period-fft (exec mode)

cable rpd period-fft (exec mode)

You can start or stop RPD periodical FFT polling using the cable rpd { ip-address |mac-address | all | slot }
period-fft { start | stop } command in Privileged EXEC mode. To void the configuration, use the no form of
this command.

cable rpd { ip-address | mac-address | all | slot } period-fft { start | stop }

no cable rpd { ip-address | mac-address | all | slot } period-fft { start | stop }

Syntax Description ip-address Specify the RPD IPv4 or IPv6 address.

mac-address Specify the RPD MAC address.

all Select all the RPDs.

slot Specify RPDs by slot.

start Start RPD periodical FFT polling.

stop Stop RPD periodical FFT polling.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Dublin This command is introduced on the Cisco cBR Series Converged Broadband
17.12.1x Routers.

Examples The following example shows how to start RPD periodical FFT polling for a specific RPD by
mentioning the MAC address.

Router# cable rpd 0004.9f32.0019 period-fft start

Confirm to continue? [no]: yes

Examples The following example shows how to stop RPD periodical FFT polling for all RPDs.

Router# cable rpd all period-fft stop

Confirm to continue? [no]: yes

Related Commands Command Description

show cable rpd core-ident Displays active Cisco Remote PHY Devices (RPD).

Cisco CMTS Cable Command Reference

642
 Cable Commands: cable o through cable r
cable rpd external-core

cable rpd external-core

You can modify auxiliary cores to which the RPD is connected using the cable
rpdnameexternal-coreip-address command. You can add or remove aux cores that exist outside the cBR-8
router without having to reboot the RPD. To void the RPD configuration, use the no form of this command.

cable rpd name external-core ip-address

no cable rpd name external-core ip-address

Syntax Description name Specifiy the name of the RPD.

ip-address Specify the IPv4 or IPv6 address.

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This command is introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use this command to enter the RPD configuration mode.

Examples The following example shows how to enter the RPD configuration mode:

Router# configure terminal

Router(config)# cable rpd node6
Router(config-rpd)# external-core 10.1.19.19
Router(config-rpd)# end

Related Commands Command Description

show cable rpd core-ident Displays RPD CCAP Core Identification information.

cable rpd external-core (exec mode)

You can modify auxiliary cores to which the RPD is connected using the cable rpd { ip-address |mac-address
| all | group | oui | slot } name external-corecore-ip-address { add | delete }} command. You can add or
remove aux cores that exist outside the cBR-8 router without having to reboot the RPD. To void the RPD
configuration, use the no form of this command.

cable rpd { ip-address mac-address | all | group | oui | slot } name external-core core-ip-address
{ add | delete } }

Cisco CMTS Cable Command Reference

643
 Cable Commands: cable o through cable r
cable rpd external-core (exec mode)

no cable rpd { ip-address mac-address | all | group | oui | slot } name external-core core-ip-address
{ add | delete } }

Syntax Description ip-address Specify the RPD IPv4 or IPv6 address.

mac-address Specify the RPD Mac address.

all Select all the RPDs.

group Specify HA-Shelf group .

oui Specify RPDs by OUI .

slot Specify RPDs by slot.

core-ip-address Specify the RPD IPv4 or IPv6 address of the core.

add Add the core.

delete Delete the core.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This command is introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use this command to enter the RPD configuration mode.

Examples The following example shows how to enter the RPD configuration mode:

Router# cable rpd 0004.9f00.0655 external-core 10.1.10.19 add

Related Commands Command Description

show cable rpd core-ident Displays RPD CCAP Core Identification information.

Cisco CMTS Cable Command Reference

644
 Cable Commands: cable o through cable r
cable rphy static-route

cable rphy static-route

cBR8 transmits RPHY packets from the accurate DPIC interface in L3 ECMP scenario (CIN without VRF
configured). You can use the cable rphy static-route command to dynamically add or remove the static route
through code during the time when an RPD comes online or turns to offline, instead of configuring manually.

cable rphy static-route

no cable rphy static-route

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Fuji This command was introduced on theCisco cBR Series Converged Broadband
16.8.1 Routers.

Usage Guidelines Use this command to enter the RPD configuration mode.

Examples After configuring the command, you can check if there are static routes that are dynamically added
by code through show [ipv6|ip] static route [vrf <id>] command.

Router# show ipv6 static

IPv6 Static routes Table - default
Codes: * - installed in RIB, u/m - Unicast/Multicast only
U - Per-user Static route
N - ND Static route
M - MIP Static route
P - DHCP-PD Static route
R - RHI Static route
* 2001:10:90:3::93/128 via 2001:192:106:1::93, distance 1
* 2001:10::/32 via 2001:80:3:1::1, distance 1
* 2001:20::/32 via 2001:80:3:1::1, distance 1
* 2001:80::/32 via 2001:80:3:1::1, distance 1
*U 2001:120:102:70:3:4E53:215E:4778/128 via FE80::2DE:FBFF:FE83:C7C2,
TenGigabitEthernet9/1/6, distance 1
*U 2001:120:102:70:3:5F42:9DA2:DA17/128 via FE80::2DE:FBFF:FE83:C7C2,
TenGigabitEthernet9/1/2, distance 1
*U 2001:120:102:70:3:7501:E3ED:3719/128 via FE80::2DE:FBFF:FE83:C7C2,
TenGigabitEthernet9/1/2, distance 1
*U 2001:120:102:70:7:B66B:F900:8352/128 via FE80::2DE:FBFF:FE83:C7C2,
TenGigabitEthernet9/1/6, distance 1
*U 2001:120:102:70:7:D14E:33F1:CF80/128 via FE80::2DE:FBFF:FE83:C7C2,
TenGigabitEthernet9/1/6, distance 1

Infra_C05#show ip static route vrf s9

Load for five secs: 6%/1%; one minute: 7%; five minutes: 7%
No time source, *09:59:43.206 UTC Fri Sep 29 2017

Codes: M - Manual static, A - AAA download, N - IP NAT, D - DHCP,

G - GPRS, V - Crypto VPN, C - CASA, P - Channel interface processor,
B - BootP, S - Service selection gateway

Cisco CMTS Cable Command Reference

645
 Cable Commands: cable o through cable r
cable rphy static-route

DN - Default Network, T - Tracking object

L - TL1, E - OER, I - iEdge
D1 - Dot1x Vlan Network, K - MWAM Route
PP - PPP default route, MR - MRIPv6, SS - SSLVPN
H - IPe Host, ID - IPe Domain Broadcast
U - User GPRS, TE - MPLS Traffic-eng, LI - LIIN
IR - ICMP Redirect
Codes in []: A - active, N - non-active, B - BFD-tracked, D - Not Tracked, P - permanent

Static local RIB for s9

M 120.102.70.117/32 [0/0] via TenGigabitEthernet0/1/7 192.168.9.2 [A]

Cisco CMTS Cable Command Reference

646
 Cable Commands: cable o through cable r
cable rphy gcp

cable rphy gcp

Use the options under cable rphy gcp to configure GCP-related information. To remove this configuration,
use the no form of this command.

cable rphy gcp [ flowctrl-threshold | keepalive interval retries | max-idle-time | reconnect-timeout

| recovery-act-delay | recovery-act-retry | recovery-action action ]

no cable rphy gcp [ flowctrl-threshold | keepalive interval retries | max-idle-time | reconnect-timeout

| recovery-act-delay | recovery-act-retry | recovery-action action ]

Syntax Description flowctrl-threshold Set GCP sending flow control for low priority msg.

keepalive interval retries GCP KA interval in seconds. The default value is 4 and the range is 0-100s. For
more information, see cable rphy gcp keepalive timeout, on page 649.

max-idle-time Configure the maximum GCP idle time in seconds. The range is 0-300s. The
default value is 0.
0 means disable Max GCP Idle Time.

reconnect-timeout Configure the GCP reconnect timeout in seconds. The range is 5-120s. The default
value is 120s.

recovery-act-delay Configure the GCP recovery action delay in seconds. The range is 0-600s. The
default value is 30s.

recovery-act-retry Configure the number of retries that the RPD attempts for the configured recovery
action. The range is 0 - 255. The default value is 12.
Note
This attribute is not applicable to all of the defined recovery actions.

recovery-action action Configure one of the following actions:

• 1 - GcpWaitForAction
• 2 - GcpReconnectToSameCore(default)
• 3 - GcpHandoverToBackup
• 4 - WaitAndReboot
• 5 - GcpHandoverToBackupAfterReconnectFail

Command Default None.

Command Modes Global configuration (config)

Cisco CMTS Cable Command Reference

647
 Cable Commands: cable o through cable r
cable rphy gcp

Command History Release Modification

Cisco IOS XE Cupertino 17.9.1y This command is introduced on theCisco cBR Series Converged Broadband
Routers.

Usage Guidelines Use this command to enter the configuration mode.

The following is a sample configuration:

Router# configure terminal

Router(config)#cable rphy gcp keepalive timeout 20 30
Router(config)#cable rphy gcp max-idle-time 70
Router(config)#cable rphy gcp reconnect-timeout 100
Router(config)#cable rphy gcp recovery-act-delay 500
Router(config)#cable rphy gcp recovery-act-retry 200
Router(config)#cable rphy gcp recovery-action 2
Router(config)#exit

After configuring the command, you can verify your configuration using the following command:
Router# show cable rphy gcp config-info
Keepaliveinterval : 20
Keepaliveretries : 30
MaxGcpIdleTime : 70
GcpRecoveryAction : 2
GcpRecoveryActionRetry : 200
GcpRecoveryActionDelay : 500
GcpReconnectTimeout : 100

Cisco CMTS Cable Command Reference

648
 Cable Commands: cable o through cable r
cable rphy gcp keepalive timeout

cable rphy gcp keepalive timeout

By default, the cBR-8 router sends a GCP KeepAlive message every 4 seconds to RPD. If no GCP message
is received from RPD, the cBR-8 router continues to send GCP KeepAlive message to RPD. The max retry
attempts are 6 by default. That means the GCP timeout value is 24(4x6)s by default. After that cBR-8 router
marks the RPD offline due to GCP timeout.
GCP KeepAlive messages are used to verify GCP connectivity between a CCAP Core and an RPD. You can
use the cable rphy gcp keepalive timeout interval retries command to configure the interval and retry attempts
of the GCP keepAlive messages, that the cBR-8 router sends to RPD.

cable rphy gcp keepalive timeout retries

no cable rphy gcp keepalive timeout retries

Syntax Description timeout GCP KA interval in seconds. The default value is 4 and the range is 0 through 100.
Note
If you configure the GCP KA interval using the values as 1 through 3 or if the total timeout value
is less than 24, then this may cause RPD flapping during SUPHA or LCHA in a large-scale
environment.
If you configure the GCP KA interval as 0, then the GCP keepalive function is disabled and the
cBR-8 router cannot detect the GCP connection status using a keepalive message. Configure CP
KA interval as 0 only for debugging.
For standby core GCP connection, the GCP KA interval is 3 times the active core. After LCHA,
the interval value is reset to the correct value for the corresponding role.

retries Number of GCP keepalive retry attempts. The default value is 6 and the range is 3 through 1000.

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Cupertino 17.9.1y The range for timeout is updated from 0-1000 to 0-100.

Cisco IOS XE Bengaluru 17.6.1z This command is introduced on theCisco cBR Series Converged Broadband
Routers.

Usage Guidelines Use this command to enter the configuration mode.

Examples
Router# configure terminal
Router(config)# cable rphy gcp keepalive timeout 20 6
Router# test platform software rphyman R0 gcp-keepalive logging enable

After configuring the command, you can verify your configuration using the following command:

Cisco CMTS Cable Command Reference

649
 Cable Commands: cable o through cable r
cable rphy gcp keepalive timeout

Router# show cable rpd 0004.9f33.0091 Te9/1/5 gcp-transaction | i GDM

0004.9f33.0091 Te9/1/5 21375 GCP_MSG_ID_GDM N/A 2022-01-04
16:46:09.294
0004.9f33.0091 Te9/1/5 21374 GCP_MSG_ID_GDM N/A 2022-01-04
16:45:49.294
0004.9f33.0091 Te9/1/5 21373 GCP_MSG_ID_GDM N/A 2022-01-04
16:45:29.294
0004.9f33.0091 Te9/1/5 21372 GCP_MSG_ID_GDM N/A 2022-01-04
16:45:09.293
0004.9f33.0091 Te9/1/5 21371 GCP_MSG_ID_GDM N/A 2022-01-04
16:44:49.294
0004.9f33.0091 Te9/1/5 21370 GCP_MSG_ID_GDM N/A 2022-01-04
16:44:29.294
0004.9f33.0091 Te9/1/5 21369 GCP_MSG_ID_GDM_RSP N/A 2022-01-04
16:44:09.299
0004.9f33.0091 Te9/1/5 21369 GCP_MSG_ID_GDM N/A 2022-01-04
16:44:09.294
0004.9f33.0091 Te9/1/5 21368 GCP_MSG_ID_GDM_RSP N/A 2022-01-04
16:43:49.298
0004.9f33.0091 Te9/1/5 21368 GCP_MSG_ID_GDM N/A 2022-01-04
16:43:49.293
0004.9f33.0091 Te9/1/5 21367 GCP_MSG_ID_GDM_RSP N/A 2022-01-04
16:43:29.300
0004.9f33.0091 Te9/1/5 21367 GCP_MSG_ID_GDM N/A 2022-01-04
16:43:29.294

Cisco CMTS Cable Command Reference

650
 Cable Commands: cable o through cable r
cable rphy rpd-capability reject-mismatch

cable rphy rpd-capability reject-mismatch

Use the cable rphy rpd-capability reject-mismatch to control whether RPDs with OFDM capability mismatch
are online or not. If the cable rphy rpd-capability reject-mismatch command is enabled, then RPDs with
OFDM capability mismatch do not become online.
You can use the no cable rphy rpd-capability reject-mismatch command to disable this configuration and
to accept the capabilities mismatch and let the RPDs come online.
RPDs may behave in a non-deterministic manner if there is a capability mismatch.

cable rphy rpd-capability reject-mismatch

no cable rphy rpd-capability reject-mismatch

Syntax Description reject-mismatch You can use this configuration to determine whether RPDs with OFDM capability
mismatch are online or not.

Command Default This command is enabled by default.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Dublin This command is introduced on the Cisco cBR Series Converged Broadband
17.12.1 Routers.

Usage Guidelines The following example shows you how to configure the no cable rphy rpd-capability reject-mismatch
command, accept the capabilities mismatch and let the RPDs come online.

Examples Router#show cable rpd 0004.9f31.0979 capability | s Downstream OFDM

Downstream OFDM Channels Per Port : 2

Router#show cable rpd

MAC Address IP Address I/F State Role HA Auth Name

0004.9f31.0979 --- Te6/1/0 online Pri Act N/A RPD1

Router(config)#cable rpd RPD1

Router(config-rpd)# identifier 0004.9f31.0979
Router(config-rpd)# core-interface Te6/1/0
Router(config-rpd-core)# principal
Router(config-rpd-core)#rpd-ds 0 downstream-cable 6/0/3 profile 23

2023/01/16 12:27:14.953736374 {rphyman_R0-0}{255}: [errmsg] [1630]: UUID: 0, ra: 0 (ERR):

%RPHYMAN-3-RPD_CAPA_PARAM_MISMATCH_ERROR:
R0/0: rphyman: rpd_capa check, rpd_id: 0004.9f31.0979, config_value 3 rpdCapa_value 2,
event: NumDsOfdmChannels mismatch, reject RPD online,
please configure OFDM channels equal to its capability..

Router#show cable rpd

MAC Address IP Address I/F State Role HA Auth Name
0004.9f31.0979 --- Te6/1/0 offline Pri Act N/A RPD1

Cisco CMTS Cable Command Reference

651
 Cable Commands: cable o through cable r
cable rphy rpd-capability reject-mismatch

After configuring the no cable rphy rpd-capability reject-mismatch command, the RPD status
displays as online as shown in the show cable rpd output below.
Router(config)#no cable rphy rpd-capability reject-mismatch

2023/01/16 12:32:13.480653142 {rphyman_R0-0}{255}: [errmsg] [1630]: UUID: 0, ra: 0 (warn):

%RPHYMAN-4-RPD_CAPA_PARAM_MISMATCH_WARNING:
R0/0: rphyman: rpd_capa check, rpd_id: 0004.9f31.0979, config_value 3 rpdCapa_value 2,
event: NumDsOfdmChannels mismatch, accept RPD online,
but it may behave in a non-deterministic manner, suggest configure OFDM channels equal to
its capability.

Router#show cable rpd

MAC Address IP Address I/F State Role HA Auth Name
0004.9f31.0979 --- Te6/1/0 init(gcp) Pri Act N/A RPD1

Router#show cable rpd

MAC Address IP Address I/F State Role HA Auth Name
0004.9f31.0979 --- Te6/1/0 online Pri Act N/A RPD1

Cisco CMTS Cable Command Reference

652
 Cable Commands: cable o through cable r
cable rphy statistics session update-freq

cable rphy statistics session update-freq

To configure the DEPI statistics synchronization interval, use the cable rphy statistics session update-freq
command in global configuration mode. To void the configuration, use the no form of this command. This
command is applied on all the CLC cards.

cable rphy statistics session update-freq value

no cable rphy statistics session update-freq value

Syntax Description value Specifies the DEPI statistics synchronization interval in unit of 5 seconds.

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Amsterdam 17.3.1z This command was introduced on theCisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use this command to configure the DEPI statistics synchronization interval.

Examples The following example shows how to configure the DEPI statistics synchronization interval:

Router# configure terminal

Router(config)# cable rphy statistics session update-freq 20

Cisco CMTS Cable Command Reference

653
 Cable Commands: cable o through cable r
cable rphy supso suppress-rpd

cable rphy supso suppress-rpd

SUP CPU utilization is high when SUPSO occurs, during new SUP rebuilding of RPDs, CMs, and so on. At
this time, if RPDs fail to recover, then those rpds are suppressed and the speed it takes to become online again
is based on the SUP IOS’s CPU utilization. This can prevent the system from being further burdened by RPDs
and CMs which come after them, by coming online and reducing the impact to other RPDs or CMs rebuilding.
You can use the cable rphy supso suppress-rpd max-cpu max-cpu min-cpu min-cpu time time command
to configure this feature.

cable rphy supso suppress-rpd max-cpu max-cpu min-cpu min-cpu time time

no cable rphy supso suppress-rpd max-cpu max-cpu max-cpu max-cpu time time

Syntax Description max-cpu The maximum IOS CPU Utilization value that starts RPD suppress mode.
The valid range is 1–100. The default is 95.

min-cpu The minimum IOS CPU Utilization value that stops RPD suppress mode. Only if IOS CPU
Utilization decreases under this min-cpu the RPD suppress mode stop.
The valid range is 1–100. The default is 90.

time The total suppress time(seconds) after SUPSO.

The valid range is 1–3600. The default is 1800.

Note If a time out of the total suppress time occurs, then the RPD suppress mode stops even though the CPU load
isn’t dropped to min-cpu value.

Command Default This command is enabled by default.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Cupertino 17.9.1x This command is introduced on theCisco cBR Series Converged Broadband
Routers.

Examples The following example shown how to configure this feature:

router(config)# cable rphy supso suppress-rpd max-cpu 90 min-cpu 80 time 1800

router(config)# end

Use this command to verify the configuration:

router# show run | in rphy

cable rphy gcp keepalive timeout 5 8

Cisco CMTS Cable Command Reference

654
Cable Commands: cable o through cable r
cable rphy supso suppress-rpd

cable rphy supso suppress-rpd max-cpu 90 min-cpu 80 time 1800

cable wideband rphy-auto-reset

Cisco CMTS Cable Command Reference

655
 Cable Commands: cable o through cable r
cable rsvp default-scn

cable rsvp default-scn

To specify the default service class that enables the Resource ReSerVation Protocol (RSVP) created service
flows to inherit characteristics , use the cable rsvp default-scn command in global configuration mode.

cable rsvp default-scn service-class name

Syntax Description service-class name The name of a downstream DOCSIS service-class .

Command Default Service class is not configured.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable rsvp default-scn command allows users to specify the default service class that enables the RSVP
created service flows to inherit characteristics.

Examples The following example configures a default RSVP service class.

Router# configure terminal

Router(config)# cable service class 220 name RSVPClass
Router(config)# cable service class 220 downstream
Router(config)# cable service class 220 max-latency 100000
Router(config)# cable service class 220 req-attr-mask ffff0000
Router(config)# cable rsvp default-scn RSVPClass
Router(config)# cable rsvp default-scn RSVPClass

Related Commands Command Description

show cable rsvp flow-db Displays the contents of the RSVP to DOCSIS service-flow mapping database.

Cisco CMTS Cable Command Reference

656
Cable Commands: cable s
• cable service attribute ds-bonded downstream-type bonding-enabled, on page 659
• cable service attribute non-ds-bonded downstream-type bonding-disabled, on page 661
• cable service attribute non-ds-bonded legacy-ranging downstream-type, on page 663
• cable service attribute voice-enabled, on page 665
• cable service attribute withhold-TLVs, on page 667
• cable service class, on page 668
• cable service flow activity-timeout, on page 675
• cable service-flow inactivity-timeout, on page 677
• cable service flow inactivity-threshold, on page 679
• cable service flow priority, on page 681
• cable service type, on page 682
• cable set mpls-experimental, on page 683
• cable sflog, on page 684
• cable shared-secondary-secret, on page 686
• cable shared-secret, on page 689
• cable sid-cluster-group, on page 692
• cable sid-cluster-switching, on page 694
• cable sip cir-scale, on page 696
• cable sip fpd-auto, on page 697
• cable sip ib-stats, on page 698
• cable snmp cache active , on page 699
• cable snmp cm-rcs, on page 700
• cable snmp iftype ds-phy, on page 701
• cable snmp trap detailed-alarm, on page 702
• cable source-route, on page 703
• cable source-verify, on page 704
• cable source-verify dhcp arp-probe, on page 709
• cable source-verify enable-sav-static, on page 710
• cable source-verify enable-sav-trust-last, on page 711
• cable source-verify group, on page 712
• cable source-verify leasequery-filter downstream, on page 714
• cable source-verify leasequery-filter upstream, on page 716
• cable source-verify sav-static-group-override, on page 718

Cisco CMTS Cable Command Reference

657
 Cable Commands: cable s

• cable spectrum-group (global), on page 719

• cable spectrum-group (interface), on page 723
• cable spectrum-group hop period, on page 725
• cable spectrum-group hop threshold, on page 727
• cable spectrum-group shared, on page 730
• cable submgmt default, on page 732
• cable sync-interval, on page 738

Cisco CMTS Cable Command Reference

658
 Cable Commands: cable s
cable service attribute ds-bonded downstream-type bonding-enabled

cable service attribute ds-bonded downstream-type

bonding-enabled
To force a downstream bonding-capable modem to initialize on a bonded primary-capable downstream channel,
use the cable service attribute ds-bonded downstream type bonding-enabled command in global
configuration mode. To restore default configuration, use the no form of the command.

cable service attribute ds-bonded downstream-type bonding-enabled [enforce]

no cable service attribute ds-bonded downstream-type bonding-enabled

Syntax Description enforce Enforces bonding-capable modems to register only on bonded RF channels.

Command Default A bonding-capable modem is allowed to register on the primary channel selected by the modem for initiation
even if the channel is not part of a bonding group.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(23)BC This command was introduced for the uBR10012 router.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines For bonding capable cable modems, the primary channel selection that is done by the CMTS depends on
whether the modems can resolve its MAC Domain Downstream Service Group ID (MD-DS-SG). The CM
must attempt to determine its MAC Domain Downstream Service Group ID (MD-DS-SG-ID) if an MDD is
present on the downstream. If a modem has resolved its MD-DS-SG, the CMTS selects a bonded primary
channel, the primary channel that is part of an operational wideband channel, from the RF channel set
corresponding to the MD-DS-SG determined by the modem. The bonded primary channel selected by the
CMTS needs to be hosted by an interface on the same uBR10-MC5X20 cable interface line card as the modem’s
initial primary channel. If there are multiple primary capable channels that meet the above criteria, the final
primary channel will be randomly selected among the eligible channel set.
When the CMTS has an existing record of a CM (listed in the show cable modem command output) that
should be moved to a bonded channel, a Dynamic Frequency Override (DFO) is triggered to be sent in the
RNG-RSP from the CMTS to that CM.
If a CM is ranging for the first time (not listed in the show cable modem command output), no DFO is
triggered at initial-ranging time. The CM proceeds to register and the CMTS gleans the bonding capabilities
of the CM to determine if it should be moved to a bonded channel. If the CM is on a wrong primary DS
channel, the DOCSIS specification does not allow a DFO at this time, so the CMTS rejects the registration
of the CM forcing it to enter the reject(c) state. The CMTS then waits for the CM to start ranging again. If
the CM engages with the same incorrect DS channel, the CMTS triggers a DFO to the CM during initial-ranging
because it now has a record of that CM.
If a modem has not resolved its MD-DS-SG and the enforce option is configured, the CMTS selects a bonded
primary channel based on MAP group associated with the modem’s upstream channel. Typically, an upstream

Cisco CMTS Cable Command Reference

659
 Cable Commands: cable s
cable service attribute ds-bonded downstream-type bonding-enabled

channel is configured into a single fiber node and the CMTS infers the topology information based on the
downstream channels associated with the upstream. If the enforce option is not configured or the CMTS
cannot find a target primary channel, the modem will be allowed to register on the primary channel currently
selected by the modem for initialization.

Note The CMTS will only try to move the modem with MD-DS-SG unresolved if the enforce option is configured.

By default, changing the primary channel to select a wideband channel is not enforced and modems are allowed
to operate on a primary channel even if they are not included in any load balancing groups. At any time after
the system is up, enabling the primary channel selection for bonding capable modems will not affect existing
modems in the system. The operator has to manually reset the bonding capable modems using the clear cable
modem command either globally or at per-MAC Domain level.

Note Enabling primary channel selection for wideband modems will not affect existing modems in the system.

Examples
Router# configure terminal

Router(config)# cable service attribute ds-bonded downstream-type bonding-enabled [enforce]

Related Commands Command Description

cable dfo-retry-count Configures the Downstream Frequency Override (DFO) retry

count.

cable service attribute non-ds-bonded Forces the non-bonding-capable modems to register only on
downstream-type bonding-disabled non-bonded RF channels on the CMTS.

cable service attribute voice-enabled Restricts voice services to only to the uBR10-MC5x20 line
cards for high availability.

Cisco CMTS Cable Command Reference

660
 Cable Commands: cable s
cable service attribute non-ds-bonded downstream-type bonding-disabled

cable service attribute non-ds-bonded downstream-type

bonding-disabled
To force the non-bonding-capable modems to register only on non-bonded RF channels on the CMTS, use
the cable service attribute non-ds-bonded downstream-type bonding-disabled command in global
configuration mode. To restore default behavior, use the no form of the command.

cable service attribute non-ds-bonded downstream-type bonding-disabled

Syntax Description This command has no keywords or arguments.

Command Default The non-bonding-capable modem registers on its current primary channel.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines A modem is identified as a non-bonding-capable modem if the modem reports a Multiple Receive Channel
Support value of 1 for TLV 5.29 or an RCP ID unknown to the CMTS during the modem’s registration request.
The non-bonding capable modem, identified at registration, will be moved to a non-bonded primary channel
through downstream frequency override, if its current primary channel is part of a bonding group. The target
non-bonded primary channel will be selected among primary capable channels that are associated to the
modem’s current upstream channel, however not included in any wideband channels associated to any host
interfaces on the local line card. Once this option is enabled, the bonded primary channels will be taken out
of load balancing group, to prevent non-bonding capable modems to be moved back to bonded primary
channels for load balancing purpose.

Note Enabling primary channel selection for wideband modems will not affect existing modems in the system. The
operator has to reset the existing non-bonding capable modems using the clear cable modem command.

Examples
Router# configure terminal

Router(config)# cable service attribute non-ds-bonded downstream-type bonding disabled

Related Commands Command Description

cable dfo-retry-count Configures the Downstream Frequency Override (DFO) retry

count.

Cisco CMTS Cable Command Reference

661
 Cable Commands: cable s
cable service attribute non-ds-bonded downstream-type bonding-disabled

Command Description

cable service attribute ds-bonded Forces a downstream bonding-capable modem to initialize on a

downstream-type bonding-disabled bonded primary-capable downstream channel.

cable service attribute voice-enabled Restricts voice services to only to the uBR10-MC5x20 line cards
for high availability.

clear cable modem Removes all modems or modems hosted by a uBR10-MC5x20

downstream interface under a specific category.

Cisco CMTS Cable Command Reference

662
 Cable Commands: cable s
cable service attribute non-ds-bonded legacy-ranging downstream-type

cable service attribute non-ds-bonded legacy-ranging

downstream-type
To redirect potential non-bonding-capable modems that access the CMTS with INIT-RNG_REQ at initialization
to a specified downstream channel frequency, use the cable service attribute non-ds-bonded legacy-ranging
downstream-type command in global configuration mode. To restore default behavior, use the no form of
the command.

cable service attribute non-ds-bonded legacy-ranging downstream-type frequency freq

no cable service attribute legacy-ranging downstream-type

Syntax Description frequency Specifies the downstream channel frequency to which modems that access the CMTS with
freq legacy INIT-RNG-REQ are moved.

Command Default The non-bonding-capable modem continues the ranging process on the primary channel currently selected
by the modem for initialization.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(23)BC This command was introduced for the uBR10012 router.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable service attribute non-ds-bonded command provides the ability to prevent potential
non-bonding-capable modems that access CMTS with legacy INIT-RNG-REQ at initialization to register on
a CMTS that supports bonding-capable modem. These modems that use legacy initial ranging will be redirected
to a specified downstream channel frequency.

Note If the frequency option is used and if the frequency is modified, then the new frequency setting will only
impact new modems trying to initialize after the frequency is modified. To enforce the downstream channel
selection policy on existing modems, each modem has to be manually reset either globally or at the individual
primary channel level using theclear cable modem command.

Examples
Router# configure terminal

Router(config)# cable service attribute non-ds-bonded legacy-ranging downstream-type frequency

55000000

Cisco CMTS Cable Command Reference

663
 Cable Commands: cable s
cable service attribute non-ds-bonded legacy-ranging downstream-type

Related Commands Command Description

cable service attribute voice-enabled Restricts voice services only to the uBR10-MC5x20 line cards
for high availability.

cable service attribute ds-bonded Forces a downstream-bonding capable modem to initialize on

downstream-type bonding-enabled a bonded primary-capable downstream channel.

cable service attribute non-ds-bonded Forces the non-bonding-capable modems to register only on
downstream-type bonding-disabled non-bonded RF channels on the CMTS.

clear cable modem Removes all modems or modems hosted by a uBR10-MC5x20

line card downstream interface under a specific category.

Cisco CMTS Cable Command Reference

664
 Cable Commands: cable s
cable service attribute voice-enabled

cable service attribute voice-enabled

To restrict voice services only to the uBR10-MC5X20 downstream interfaces for high availability, use the
cable service attribute voice-enabled command in global configuration mode. To remove the restriction of
voice services to the uBR10-MC5X20 downstream interfaces, use the no form of the command.

cable service attribute voice-enabled downstream-type HA-capable

no cable service attribute voice-enabled downstream-type HA-capable

Syntax Description downstream-type Restricts voice services to a specific downstream type.

HA-capable Restricts voice services to the uBR10-MC 5x20 line card.

Command Default All primary-capable downstream channels on the uBR10-MC 5x20 line card and the SPA can support
downstream voice service flows.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines A voice-enabled cable modem is identified either at registration by decoding DHCP TLV 122 in the modem's
DHCP-ACK, or at its first voice call if DHCP TLV 122 is not exchanged. If a voice-enabled modem is detected
at registration on a SPA downstream channel, it will be moved to the uBR10-MC5x20 downstream channel
in the CGD via downstream frequency override. If the voice-enabled modem is detected at its first voice call
after registration, it will be moved after the call is over to the uBR10-MC5x20 channel in the CGD via DCC.
If the voice enabled modem fails to come up on the target uBR10-MC5x20 channel, the CMTS will continue
to move the modem until three retries (the maximum number of allowed retries) has been reached, when the
modem will be allowed to stay on the SPA downsream channel until another set of retries is attempted by the
CMTS every 24 hours. A voice enabled modem on the uBR10-MC5x20 channel will be excluded from being
load balanced to a SPA downstream channel. If this option is configured at any time after the system if up,
voice enabled modems that have been identified on the SPA dowsntream channel without active voice calls
will be gradually moved to the uBR10-MC5x20 downstream channel in the CGD at the rate of one modem
per five seconds.

Examples
Router# configure terminal

Router(config)# cable service attribute voice-enabled downstream-type HA-capable

Related Commands cable service attribute non-ds-bonded Forces a non-bonding-capable modem to register only on
non-bonded RF channels.

Cisco CMTS Cable Command Reference

665
 Cable Commands: cable s
cable service attribute voice-enabled

cable service attribute ds-bonded Forces a downstream-bonding capable modem to initialize on a

bonded primary-capable DS channel.

Cisco CMTS Cable Command Reference

666
 Cable Commands: cable s
cable service attribute withhold-TLVs

cable service attribute withhold-TLVs

To block sending of DOCSIS 3.0 time, length, value (TLVs) to DOCSIS 1.x and DOCSIS 2.0 cable modems,
use the cable service attribute withhold-TLVs command in global configuration mode. To unblock sending
of the DOCSIS 3.0 TLVs to DOCSIS 1.x and DOCSIS2.0 cable modems, use the no form of this command.

cable service attribute withhold-TLVs peak-rate

no cable service attribute withhold-TLVs peak-rate

Syntax Description peak-rate Specifies the DOCSIS 3.0 peak traffic rate TLVs 24.27 and 25.27, which are blocked from being
sent to the non-DOCSIS 3.0 cable modems.

Command Default The DOCSIS 3.0 TLVs are sent to all cable modems.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB10 This command was introduced for the Cisco uBR10012 router.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines Some DOCSIS 1.x and DOCSIS 2.0 cable modems may fail to come online when they receive DOCSIS 3.0
TLVs from the CMTS during registration. The cable service attribute withhold-TLVs command allows
you to restrict sending of the configured DOCSIS 3.0 TLVs to DOCSIS 1.x and DOCSIS 2.0 cable modems.
This command does not restrict sending of DOCSIS 3.0 TLVs to DOCSIS 3.0 cable modems.

Note In Cisco IOS Release 12.2(33)SCB10 only the peak-rate keyword is supported, which represents TLVs 24.27
and 25.27.

Examples The following example shows how to configure the CMTS to restrict sending of DOCSIS 3.0 peak
traffic rate TLVs 24.27 and 25.27 to non-DOCSIS 3.0 cable modems:

Router # configure terminal

Router(config)# cable service attribute withhold-TLVs peak-rate

The following warning message is displayed when the above example is configured.

Warning: This configuration may violate D3.0 MULPI specification per section 6.4.8.

Related Commands Command Description

cable service class Defines and modifies a service class

Cisco CMTS Cable Command Reference

667
 Cable Commands: cable s
cable service class

cable service class

To set parameters for DOCSIS 1.1 cable service class, use the cable service class command in global
configuration mode. To delete a service class or to remove a configuration, use the no form of the command.

cable service class class-index [keyword-options]

no cable service class class-index [keyword-options]

Syntax Description class-index Specifies the class ID for the class to be modified. Valid range is 1 to 1023.

activity-timeout Specifies the activity timeout (0 to 65,535).

admission-timeout Specifies the admitted timeout (0 to 65,535).

downstream Specifies that the service class is for the downstream direction (from the CMTS
to the CM). (The default direction is upstream.)

data-rate-unit data-rate Configure Data Rate Unit Setting.

The range is 0–3. 0=bps, 1=kbps, 2=Mbps, 3=Gbps.

grant-interval Specifies the grant interval (0 to 4,294,967,295 microseconds).

grant-jitter Specifies the grant jitter (0 to 4,294,967,295 microseconds).

grant-size Specifies the grant size (0 to 65,535 bytes).

grants-per-interval Specifies the grants per interval (0 to 127 grants).

max-burst Specifies the maximum transmission burst (1522 to 4,294,967,295 bytes).

Note
The recommended value range is 1600 to 1800 bytes. Using a value of 0 or
greater than 1800 bytes can cause latency issues for Voice-over-IP. A value
of less than 1522 bytes can prevent the upstream transmission of large ethernet
frames for any CM or CMTS not implementing fragmentation.

max-buff-size Specifies the maximum buffer size of the upstream service-flow queue (or
buffer) on the CM. The valid range is from 0 to 4294967295 bytes. The default
value is 0.

max-concat-burst Specifies the maximum concatenation burst (0 to 65,535 bytes).

max-latency Specifies the maximum latency allowed (0 to 4,294,967,295 microseconds).

max-rate Specifies the maximum rate (0 to 4,294,967,295 bps).

min-buff-size Specifies the minimum buffer size of the upstream service-flow queue (or
buffer) on the CM. The valid range is from 0 to 4294967295 bytes. The default
value is 0.

min-packet-size Specifies the minimum packet size for reserved rate (0 to 65,535 bytes).

min-rate Specifies the minimum rate (0 to 4,294,967,295 bps).

Cisco CMTS Cable Command Reference

668
 Cable Commands: cable s
cable service class

name Specifies the service class name string.

peak-rate Specifies the peak rate (0 to 4,294,967,295 bps). Default value is zero, which
represents the line rate.
Note
The peak-rate option is not supported on the DOCSIS 1.0 modems.

poll-interval Specifies the poll interval (0 to 4,294,967,295 microseconds).

poll-jitter Specifies the poll jitter (0 to 4,294,967,295 microseconds).

priority Specifies the priority (0 to 7, where 7 is the highest priority).

req-trans-policy Specifies the request transmission policy bit field (0 to FFFFFFF in

hexadecimal).

sched-type Specifies the service class schedule type:

2–Best-Effort Schedule Type 3–Non-Real-Time Polling Service Schedule
Type (supported only in Cisco 12.2(4)BC and later releases) 4–Real-Time
Polling Service Schedule Type 5–Unsolicited Grant Service with Activity
Detection Schedule Type 6–Unsolicited Grant Service Schedule Type

tar-buff-size Specifies the target or desired size of the upstream service-flow queue (or
buffer) on the CM. The valid range is from 0 to 4294967295 bytes. The default
value is 0.

tos-overwrite and-mask Overwrites the ToS byte by first ANDing the TOS value with the and-mask
or-mask value and then ORing the result of that operation with the or-mask value. Both
parameters must be specified in hexadecimal. The and-mask value can range
from 0x0 to 0xFF and the or-mask value can range from 0x0 to 0xFF.

upstream Specifies that the service class is for the upstream direction (from the CM to
the CMTS). This is the default direction.

downstream Specifies that the service class is for the downstream direction (from the CMTS
to the CM).

n Specifies the bundle identifier.

req-attr-mask Specifies the required attribute mask bit field (0 to FFFFFFF in hexadecimal).

forb-attr-mask Specifies the forbidden attribute mask bit field (0 to FFFFFFF in hexadecimal).

Command Default Values that are not specified are set to their DOCSIS 1.1 defaults, if applicable to the service-class schedule
type. See Section C.2.2, Service Flow Encodings , in the DOCSIS 1.1 specification.

Command Modes
Global configuration (config)

Cisco CMTS Cable Command Reference

669
 Cable Commands: cable s
cable service class

Command History Release Modification

12.1(4)CX This command was introduced for DOCSIS 1.1 operation. This command
replaced the cable qos profile command that was used in previous versions
for DOCSIS 1.0 operation.

12.2(4)BC1 This command was integrated into Cisco IOS release 12.2(4)BC1. This
command was also enhanced to support NRTPS scheduling.

12.2(11)BC2 The default value for the maximum transmission burst parameter (max-burst)
was changed from 1522 bytes to 3044 bytes. The default value for the maximum
concatenation burst parameter was also changed from 0 bytes (unlimited) to
1522 bytes. These changes are to accommodate the latest revision of the
DOCSIS 1.1 specification (SP-RFI-v1.1-I09-020830).

12.3BC This command was integrated into Cisco IOS release 12.3BC.

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

12.2(33)SCB This command was modified with the addition of req-attr-mask and
forb-attr-mask keywords.

12.2(33)SCB1 This command was modified with the addition of peak-rate to set value greater
than the max-rate.

12.2(33)SCF2 This command was modified. Three new keywords max-buff-size,

min-buff-size, and tar-buff-size were added as part of the Upstream Buffer
Control feature.

12.2(33)SCI1 This command was modified with the addition of downstream keyword.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Cisco IOS XE Dublin The data-rate-unit data-rate option is added.

17.12.1z

Usage Guidelines The sched-type option must always be specified for each upstream class. The option cannot be configured
for downstream classes. When a certain scheduling type is selected, take care that the mandatory parameters
for that scheduling type are explicitly entered, while non-applicable parameters must be explicitly removed.
The default direction is upstream. We recommend that you do not change the direction of a service class
after you have created it, because some of the existing service class parameters might not be appropriate for
the new direction. Instead, delete the current service class and create a new service class with the correct
upstream or downstream direction.
If the service class is newly created, a service-class name must be defined before entering the parameters for
the service class.

Cisco CMTS Cable Command Reference

670
 Cable Commands: cable s
cable service class

Note Section C.2.2.6.10, IP Type of Service Overwrite , of the DOCSIS 1.1 specification changed the operation of
tos-overwrite option. In DOCSIS 1.1 networks, the new TOS value is calculated by the following formula:
New IP TOS = ((Original TOS value AND and-mask) OR or-mask). (For a description of the previous method
of calculating the TOS value, see the cable qos profile command.) The default is to leave the TOS value
unchanged (no overwrite).

Examples The following examples show configurations that use the cable service class command to create
service classes. Based on the scheduling type specified, some command lines are mandatory, while
others are optional.
Each example shown here is a complete configuration set for creating a service class.

Configuring a Service Class for Unsolicited Grant Scheduling Service

Router(config)# cable service class 1 name UP_UGS

Router(config)# cable service class 1 sched-type 6

Router(config)# cable service class 1 grant-size 100

Router(config)# cable service class 1 grant-interval 20000

Router(config)# cable service class 1 grant-jitter 4000

Router(config)# cable service class 1 grants-per-interval 1

Router(config)# cable service class 1 min-packet-size 100

Router(config)# cable service class 1 req-trans-policy 0x1FF

Router(config)# cable service class 1 tos-overwrite 0x1F 0xE0

Router(config)# cable service class 1 activity-timeout 30

Router(config)# cable service class 1 admission-timeout 30

Configuring a Service Class for Unsolicited Grant Scheduling with Activity Scheduling

Router(config)# cable service class 2 name UP_UGSAD

Router(config)# cable service class 2 sched-type 5

Router(config)# cable service class 2 grant-size 100

Router(config)# cable service class 2 grant-interval 20000

Router(config)# cable service class 2 grant-jitter 4000

Router(config)# cable service class 2 grants-per-interval 1

Router(config)# cable service class 2 poll-interval 10000

Cisco CMTS Cable Command Reference

671
 Cable Commands: cable s
cable service class

Router(config)# cable service class 2 poll-jitter 4000

Router(config)# cable service class 2 min-packet-size 100

Router(config)# cable service class 2 req-trans-policy 0x1FF

Router(config)# cable service class 2 tos-overwrite 0x1F 0xE0

Router(config)# cable service class 2 activity-timeout 30

Router(config)# cable service class 2 admission-timeout 30

Configuring a Service Class with Real-Time Polling Service

Router(config)# cable service class 3 name UP_RTPS

Router(config)# cable service class 3 sched-type 4

Router(config)# cable service class 3 poll-interval 10000

Router(config)# cable service class 3 poll-jitter 4000

Router(config)# cable service class 3 min-rate 64000

Router(config)# cable service class 3 max-rate 128000

Router(config)# cable service class 3 max-burst 2000

Router(config)# cable service class 3 max-concat-burst 1522

Router(config)# cable service class 3 req-trans-policy 0x1FF

Router(config)# cable service class 3 tos-overwrite 0x1F 0xE0

Router(config)# cable service class 3 activity-timeout 30

Router(config)# cable service class 3 admission-timeout 30

Configuring a Service Class for Best-Effort Upstream Service

Router(config)# cable service class 4 name UP_BE

Router(config)# cable service class 4 sched-type 2

Router(config)# cable service class 4 priority 5

Router(config)# cable service class 4 min-rate 0

Router(config)# cable service class 4 max-rate 128000

Router(config)# cable service class 4 max-burst 2000

Router(config)# cable service class 4 max-concat-burst 1522

Router(config)# cable service class 4 req-trans-policy 0x0

Router(config)# cable service class 4 tos-overwrite 0x1F 0xE0

Cisco CMTS Cable Command Reference

672
Cable Commands: cable s
cable service class

Router(config)# cable service class 4 activity-timeout 30

Router(config)# cable service class 4 admission-timeout 30

Configuring a Service Class for Best-Effort Downstream Service

Router(config)# cable service class 5 name DOWN_BE

Router(config)# cable service class 5 priority 5

Router(config)# cable service class 5 min-rate 0

Router(config)# cable service class 5 max-rate 1000000

Router(config)# cable service class 5 max-burst 3000

Router(config)# cable service class 5 activity-timeout 30

Router(config)# cable service class 5 admission-timeout 30

Configuring a Service Class for Peak-Rate

Router(config)# cable service class

201 name hsd
Router(config)# cable service class
201 downstream
Router(config)# cable service class
201 max-rate 1024000
Router(config)# cable service class
201 min-rate 1024000
Router(config)# cable service class
201 peak-rate 2000000

Configuring a Service Class with Upstream Buffer Control Parameters

Router(config)# cable service class

10 name REG-US
Router(config)# cable service class
10 upstream
Router(config)# cable service class
10 max-buff-size 20000
Router(config)# cable service class
10 min-buff-size 10000
Router(config)# cable service class
10 tar-buff-size 15000

Associated Features
The cable service class command is used to configure the following features:
• Configuring Upstream Cable Interface Features on the Cisco CMTS Routers
• Upstream Scheduler Mode for the Cisco CMTS Routers

Cisco CMTS Cable Command Reference

673
 Cable Commands: cable s
cable service class

Related Commands Command Description

cable qos profile Creates a DOCSIS 1.0 QoS profile.

show cable service-class Displays the service classes that have been created.

Cisco CMTS Cable Command Reference

674
 Cable Commands: cable s
cable service flow activity-timeout

cable service flow activity-timeout

To configure the activity timeout for dynamic cable service flows in DOCSIS 1.1 environments, where
PacketCable is inactive, use the cable service flow activity-timeout command in global configuration mode.
To remove the activity timer once configured, use the no form of this command.

cable service flow activity-timeout n

no cable service flow activity-timeout [<n>]

Syntax Description n The timeout length in seconds. Valid range is 0 - 65535 seconds. Setting this value to 0 configures the
service flow to never timeout.

Command Default 0 seconds

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC2 This command was introduced to support DOCSIS 1.1 service flow operation in
non-Packet-Cable environments.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines When PacketCable is supported, PacketCable sets the inactivity timeout from the PacketCable gate, and the
PacketCable activity overrides timeout values set with this command. This is the case even where the inactivity
timeout is set to zero, which configures the service flow to never timeout.
Apart from PacketCable, this command enables the cable modem to control the setup of the dynamic service
flows, and to remove inactive service flows. During the creation of service flows, all Upstream and Downstream
flows in the request are checked to see if the configured activity timeout needs to be applied.

Note The cable service flow activity-timeout command affects new calls only; it does not clear any existing hung
flows. To clear existing flows, use the test cable dsd mac-add sid command.

Examples The following example in global configuration mode configures the cable modems connected to the
Cisco CMTS to use activity timeout of zero, which means that related service flows do not timeout
in a non-PacketCable environment:

Router(config)# cable service flow activity-timeout 0

The following example in global configuration mode configures the cable modems connected to the
Cisco CMTS to use activity timeout of 300 seconds, which means that related service flows will
timeout if no activities in 5 minutes:

Router(config)# cable service flow activity-timeout 300

Cisco CMTS Cable Command Reference

675
 Cable Commands: cable s
cable service flow activity-timeout

Related Commands Command Description

cable qos profile Creates a DOCSIS 1.0 QoS profile.

(Not for Cisco cBR Series Routers) cable Sets the amount of time a dynamic service-flow can be
service flow inactivity-threshold present in the system without any activity (DOCSIS 1.1
operation).

show cable service-class Displays the service classes that have been created.

Cisco CMTS Cable Command Reference

676
 Cable Commands: cable s
cable service-flow inactivity-timeout

cable service-flow inactivity-timeout

To set the amount of time a dynamic service-flow can be present in the system without any activity, use the
cable service-flow inactivity-timeout command in global configuration mode. To remove the specification,
use the no form of this command.

cable service-flow inactivity-timeout minutes

no cable service-flow inactivity-timeout

Syntax Description minutes Specifies service-flow inactivity-timeout in minutes. Valid range is 1 to 120 minutes. Default value
is 30 minutes.

Command Default 30 minutes

Command Modes
Global configuration (config)

Command History Release Modification

12.1(3a)EC This command was introduced.

12.1(4)CX This command was replaced by the cable service flow inactivity-threshold command for
DOCSIS 1.1 operation.

Usage Guidelines Resources such as service identifiers (SIDs) and bandwidth are dynamically allocated by a CM using Dynamic
Service Addition (DSA) transaction. If the CM fails to release these resources by issuing a Dynamic Service
Deletion (DSD), then the resources might be locked indefinitely. Use this command to release unused resources.

Examples The following example shows how to set the inactivity timeout for dynamic service flows to 2
minutes. Once this setting is specified, any dynamic SID that does not show any activity in 2 minutes
will be deleted.

Router(config)# cable service-flow inactivity-timeout 2

The following example shows how to set the inactivity timeout back to the default value of 30 minutes:

Router(config)# cable service-flow inactivity-timeout

Related Commands Command Description

cable service flow inactivity-threshold Sets the amount of time a dynamic service-flow can be present in
the system without any activity (DOCSIS 1.1 operation).

cable qos permission Specifies permission for updating the cable router QoS table.

cable qos profile Configures a QoS profile.

Cisco CMTS Cable Command Reference

677
 Cable Commands: cable s
cable service-flow inactivity-timeout

Command Description

show controllers cable Displays QoS profiles.

Cisco CMTS Cable Command Reference

678
 Cable Commands: cable s
cable service flow inactivity-threshold

cable service flow inactivity-threshold

To set the inactivity threshold value for service flows using Unsolicited Grant Service with Activity Detection
(UGS-AD), use the cable service flow inactivity-threshold command in global configuration mode. To
disable the inactivity timer and reset the threshold limit timer to its default of 10 seconds, so that service flows
revert to UGS activity only, use the no form of this command.

cable service flow inactivity-threshold n

no cable service flow inactivity-threshold n

Syntax Description n Specifies the threshold limit in seconds, with 10 seconds as the default. Configurable limits are 1 to 3600
seconds.

Command Default The default is to enable the inactivity timer, with a default value of 10 seconds.

Command Modes
Global configuration (config)

Command History Release Modification

12.1(4)CX This command replaced the cable service-flow inactivity-timeout command for DOCSIS
1.1 operation.

12.2(4)BC1 Support for this command was added to the Release 12.2 BC train.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines DOCSIS 1.1 allows a CM to request Unsolicited Grant Service (UGS) for an upstream, allowing the CM to
reserve a certain amount of Constant Bit Rate (CBR) bandwidth for real-time traffic, such as Voice-over-IP
(VoIP) calls. The UGS-AD variation allows the CMTS to switch a service flow to Real Time Polling Service
(RTPS) after a certain period of inactivity, so that bandwidth is not reserved when it is not needed. The CM
can then request UGS service when the flow again becomes active.

Note This command replaced the cable service-flow inactivity-timeout command, which was used in DOCSIS
1.0 operation to enable or disable watchdog cleanup of dynamic service flows that are not sending any packets
on the upstream.

The cable service flow inactivity-threshold command sets the inactivity timer for how long a service flow
must be inactive before the CMTS can switch it from UGS-AD to RTPS. The no cable service flow
inactivity-threshold command disables the timer and resets it to its default value of 10 seconds, so that the
CMTS always provides UGS service to the service flow, even when the flow is idle.

Cisco CMTS Cable Command Reference

679
 Cable Commands: cable s
cable service flow inactivity-threshold

Caution The no cable service flow inactivity-threshold command effectively disables the use of RTPS and USG-AD
services and configures the CMTS to provide only UGS services. This will prevent a CM that registered for
USG-AD services from being able to obtain upstream transmission opportunities, resulting in a significant
loss of bandwidth when a large number of CMs are requesting UGS-AD service flows.

Examples The following example shows the inactivity timer being set to 20 seconds:

Router(config)# cable service flow inactivity-threshold 20

Router(config)#

The following command disables the inactivity timer, so that the service flow remains UGS, even
during periods of inactivity:

Router(config)# no cable service flow inactivity-threshold

Router(config)#

Related Commands Command Description

cable service class Sets the DOCSIS 1.1 service class parameters.

cable service-flow inactivity-timeout Sets the amount of time a dynamic service-flow can be present in
the system without any activity (DOCSIS 1.0 operation).

show controllers cable Displays information for the cable interface.

Cisco CMTS Cable Command Reference

680
 Cable Commands: cable s
cable service flow priority

cable service flow priority

To enable the service flow priority in downstream extended header, use the cable service flow priority
command in global configuration mode. To disable this feature, use the no form of this command.

cable service flow priority

no cable service flow priority

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the cable service flow priority command in global configuration mode to enable service flow priority
in downstream extended header.
The following example in global configuration mode enables the service flow priority in downstream extended
header:

Router(config)# cable service flow priority

Use the show running-config | in service flow command to check the enabled status of the feature:

Router(config)# show running-config | in service flow

cable service flow priority

Related Commands Command Description

show running-config | in service flow Displays the service classes that have been created.

Cisco CMTS Cable Command Reference

681
 Cable Commands: cable s
cable service type

cable service type

To redirect CMs matching a service-type to downstream frequency, use the cable service type command in
global configuration mode. To cancel the redirection of CMs, use the no form of this command.

cable service type service-type-id ds-frequency frequency

no cable service type service-type-id ds-frequency frequency

Syntax Description service-type-id Specifies the service type identifier to be redirected.

The maximum length of service-type-id is 16.

ds-frequency frequency Specifies the downstream frquency the CMs will be redirected to.

Command Default Disabled

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command will redirect the CMs matching a particular service-type identifier to downstream frequency.
Multiple service types can be redirected to one frequency. However, one service type cannot be redirected to
multiple DS frequencies.

Examples The following example shows how to redirect the CMs matching the service type to downstream
frequency:

Router(config)# cable service type commercial ds-frequency 519000000

Cisco CMTS Cable Command Reference

682
 Cable Commands: cable s
cable set mpls-experimental

cable set mpls-experimental

To specify experimental bits for Multiprotocol Label Switching (MPLS) labels, use the cable set
mpls-experimental command in Ethernet service configuration mode. To disable this configuration, use the
no form of this command.

cable set mpls-experimental value

no cable set mpls-experimental value

Syntax Description value Experimental bit for MPLS labels. Valid values are from 0 to 7.

Command Default If this command is not used, the experimental bits on the MPLS label are set to zero.

Command Modes
Ethernet service configuration (config-ethsrv)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The experimental bits are set for all inner and outer MPLS labels for the egress Layer 2 VPN traffic on the
WAN interface.

Examples The following example shows how to set an experimental bit for MPLS labels on a Cisco uBR10012
router:

Router# configure terminal

Router(config)# cable l2vpn 0000.396e.6a68 customer1
Router(config-l2vpn)# service instance 2000 Ethernet
Router(config-ethsrv)# xconnect 101.1.0.2 221 encapsulation mpls pw-type 4
Router(config-ethsrv)# cable set mpls-experimental 7

Related Commands Command Description

cable l2vpn Enables Ethernet L2VPN service and enters L2VPN configuration mode.

service instance Configures an Ethernet service instance for a particular customer.

xconnect Binds an attachment circuit to a pseudowire.

Cisco CMTS Cable Command Reference

683
 Cable Commands: cable s
cable sflog

cable sflog
To enable service flow logging, to configure the number and duration of entries in the log, and to represent
the time when the corresponding service flow is destroyed, use the cable sflog command in global configuration
mode. To disable service flow logging, use the no form of the command.

cable sflog {stop-record-time-overwrite | max-entry number entry-duration time }

no cable sflog

Syntax Description stop-record-time-overwrite Specifies the time when the corresponding service flow is destroyed.

max-entry number Specifies the maximum number of entries in the service flow log. When the
log becomes full, the oldest entries are deleted to make room for new entries.
The valid range is 0 to 59999, with a default of 0 (which disables service flow
logging).
Note
The max-entry value applies to the entire chassis on the Cisco uBR7100 series
and Cisco uBR7200 series routers, but applies to individual cable line cards
on the Cisco uBR10012 router and Cisco cBR Series Converged Broadband
Routers.

entry-duration time Specifies how long, in seconds, entries can remain in the service flow log. The
CMTS deletes entries in the log that are older than this value. The valid range
is 1 to 86400 seconds, with a default value of 3600 seconds (1 hour).

Command Default max-entry = 0 (service flow logging is disabled) and entry-duration = 3600 seconds

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC1 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

12.2(33)SCJ1 This command was modified with the addition of stop-record-time-overwrite keyword.

Usage Guidelines A DOCSIS specification currently being developed requires the DOCSIS CMTS to maintain a log table that
contains entries of deleted service flows. The cable sflog command enables the logging of deleted service
flows in this table and also sets the maximum number of entries in the log. When the log becomes full, the
oldest entries are deleted to make room for the newest ones.
This command also configures how long each entry can remain in the log. When an entry has been in the table
for the specified time, the CMTS deletes it, even if the log is not currently full.
To display the service flow log, use SNMP commands to display the docsQosServiceFlowLogEntry entries
in the docsQosServiceFlowLogTable table. These attributes are defined in the Data Over Cable System
Interface Specification Quality of Service Management Information Base (DOCSIS-QOS MIB) internet draft.

Cisco CMTS Cable Command Reference

684
 Cable Commands: cable s
cable sflog

Cisco IOS Release 12.2(15)BC1 supports version 4 of this DOCSIS-QOS MIB draft, which is available on
the IETF Internet-Drafts web site.

Note At the time of this document’s release, the DOCSIS-QOS MIB is still in draft form and is therefore subject
to change in future releases of Cisco IOS software.

The max-entry value specified by this command applies to the entire chassis for the Cisco uBR7100 series
and Cisco uBR7200 series routers, but to individual line cards on the Cisco uBR10012 and Cisco cBR Series
Converged Broadband Routers. However, the Cisco uBR10012 and Cisco cBR Series Converged Broadband
Routers still maintain only one log table for all deleted service flows.
For example, if the max-entry value is set to 10,000 on a Cisco uBR7200 series router, the service flow log
table holds a maximum of 10,000 entries for all cable line cards in the chassis. If the max-entry value is set
to 10,000 on a Cisco uBR100012 router that has four cable line cards installed, the service flow log table
holds a maximum of 40,000 entries, with each cable line card having a maximum of 10,000 entries each.

Examples The following example shows how to enable service flow logging with a maximum of 2,000 entries
in the log, and with each entry remaining in the log for a maximum of 2 hours (7200 seconds):

Router(config)# cable sflog max-entry 2000 entry-duration 7200

The following example shows how to set the max-entry value to its default of 0 and disable service
flow logging:

Router# configure terminal

Router(config)# no cable sflog

Router(config)# exit

Router#

Related Commands Command Description

cable service-flow inactivity-timeout Sets the amount of time a dynamic service-flow can be present in
the system without any activity (DOCSIS 1.0 operation).

cable service flow inactivity-threshold Sets the amount of time a dynamic service-flow can be present in
the system without any activity (DOCSIS 1.1 operation).

Cisco CMTS Cable Command Reference

685
 Cable Commands: cable s
cable shared-secondary-secret

cable shared-secondary-secret
To configure one or more secondary shared-secret keys that CMs can use to successfully process the DOCSIS
configuration file and register with the CMTS, use the cable shared-secondary-secret command in cable
interface configuration mode. To remove the secondary shared secrets, use the no form of this command.

cable shared-secondary secret index index-num [0 | 7] authentication-key

no cable shared-secondary secret index index-num

Syntax Description index index-num Specifies the order in which the CMTS will use the secondary shared-secrets to verify
the CM during the registration process. The valid range is 1 to 16.

0 (Optional) Specifies that an unencrypted message will follow.

7 (Optional) Specifies that an encrypted message will follow.

Note
As a general rule, the 7 option is not used by users at the command line because it
requires a pre-encrypted password. Typically, the 7 option is useful only when cutting
and pasting commands from another router’s configuration file.

authentication-key Text string specifying the shared secret string. When you also use the service
password-encryption command, the key is stored in encrypted form. The text string
can be any arbitrary string up to 80 characters in length.

Command Default No secondary shared secret is used. If no encryption option is specified, the key is stored in the configuration
file as encrypted text if the service password-encryption command has also been given.

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(8)BC2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable shared-secondary-secret command can be used to supplement the cable shared-secret command
so as to prevent unauthorized interception and alteration of the DOCSIS configuration file that is downloaded
to the CM during the registration process. The DOCSIS specification allows for a CM and CMTS to use a
shared secret (a secret encryption string) to calculate the MD5 Message Integrity Check (MIC) value for the
DOCSIS configuration file that is downloaded to the CM.
The CM must use the proper shared secret encryption string to successfully decrypt and process the
configuration file, and then register with the CMTS. If the CM does not have the proper encryption string, it
will be unable to calculate the proper MIC value, and the show cable modem command will show reject(m)
for the modem to indicate a MIC authentication failure.

Cisco CMTS Cable Command Reference

686
 Cable Commands: cable s
cable shared-secondary-secret

The cable shared-secondary-secret command allows a cable operator to specify up to 16 alternate DOCSIS
shared secrets. If a CM has a MIC authentication failure during registration, the CMTS then checks the MIC
values using the alternate shared secrets. If a match is found, the CM is allowed online. If none of the alternate
MIC values match the value returned by the CM, the CMTS refuses to allow the CM to come online and
instead logs a MIC authentication failure.
The use of secondary shared secrets allow the MSO to gradually phase in changes to the shared secret key.
If a shared secret has been compromised, or if the MSO decides to regularly change the shared secret, the
MSO can use the cable shared-secret command to immediately change the primary shared secret. The previous
key can then be made a secondary shared secret, using the cable shared-secondary-secret command, so that
CMs can continue to register until the MSO can change all of the DOCSIS configuration files to use the new
shared secret.
To use the secondary shared-secret feature, you must do the following:
• You must specify a shared secret with the cable shared-secret command. The cable
shared-secondary-secret command has no effect if you have not specified a primary shared secret.

Note At any particular time, the majority of CMs should use the primary shared secret to avoid excessive registration
times.

• Create DOCSIS configuration files that use the shared-secret encryption string to create the MD5 MIC
value. This can be done using the Cisco DOCSIS Configurator tool by entering the shared-secret string
in the CMTS Authentication field in the Miscellaneous parameters.

Tip The shared-secret string itself is not saved in the DOCSIS configuration file, so you must re-enter the string
in the “CMTS Authentication” field whenever you create or edit a DOCSIS configuration file using the Cisco
DOCSIS Configurator tool.

• Use the cable shared-secondary-secret command to configure the cable interfaces with one or more
matching shared-secret strings. The string configured on an interface must match the string used to create
the DOCSIS configuration files downloaded to the CMs on that interface, or the CMs will not be able
to register. You can use different shared secrets for each interface, if you are also using a different set
of configuration files for each interface.
• To encrypt the shared-secret strings in the CMTS configuration, you must include the service
password-encryption global configuration command in the router’s configuration.

Note You cannot use the shared secret feature with the files created by the internal DOCSIS configuration file editor
(cable config-file command).

Examples The following example shows how to specify multiple secondary shared-secret string using encrypted
keys:

Router# configure terminal

Router(config)# service password-encryption

Cisco CMTS Cable Command Reference

687
 Cable Commands: cable s
cable shared-secondary-secret

Router(config)# int c6/0

Router(config-if)# cable shared-secret n01jk_1a

Router(config-if)# cable shared-secondary-secret index 1 cabl3-x21b

Router(config-if)# cable shared-secondary-secret index 2 dasc9_ruld55ist5q3z

Router(config-if)# cable shared-secondary-secret index 3 j35u556_x_0

Router(config-if)# exit

Router(config)# exit

Router# show running-config | include shared

cable shared-secret 7 1407513181A0F13253920

cable shared-secondary-secret 7 14031A021F0D39263D3832263104080407
cable shared-secondary-secret 7 071B29455D000A0B18060615142B38373F3C2726111202431259545D6
cable shared-secondary-secret 7 0501555A34191B5F261D28420A555D
Router#

Note In this example, the shared-secret strings are initially entered as clear text, but because the service
password-encryption command has been used, the strings are encrypted in the configuration file.

Related Commands Command Description

cable dynamic-secret Enables the dynamic shared secret feature, so that DOCSIS configuration files are
verified with a dynamically generated shared secret.

cable shared-secret Configures an authentication shared-secret key that CMs must use to successfully
process the DOCSIS configuration file and register with the CMTS.

cable tftp-enforce Requires that all CMs on a cable interface attempt to download a DOCSIS
configuration file using the Trivial File Transfer Protocol (TFTP) through the cable
interface before being allowed to register and come online.

Cisco CMTS Cable Command Reference

688
 Cable Commands: cable s
cable shared-secret

cable shared-secret
To configure an authentication shared-secret encryption key that CMs must use to successfully process the
DOCSIS configuration file and register with the CMTS, use the cable shared-secret command in cable
interface configuration mode or MAC domain profile configuration mode. To disable the use of a shared-secret
key during the CM registration phase, use the no form of this command.

cable shared-secret [0 | 7] authentication-key

no cable shared-secret

Cisco cBR Series Converged Broadband Routers

cable shared-secret{0 | 7} authentication-key

Syntax Description 0 (Optional) Specifies that an unencrypted message (clear text) will follow.

7 (Optional) Specifies that an encrypted message will follow.

Note
As a general rule, the 7 option is not used by users at the command line because it requires
a pre-encrypted password. Typically, the 7 option is useful only when cutting and pasting
commands from another router’s configuration file.

authentication-key Text string specifying the shared secret string. When you also use the service
password-encryption command, the key is stored in encrypted form. The text string can
be any arbitrary string up to 80 characters in length.

Command Default No shared-secret encryption key is used during registration, only the default DOCSIS MD5-encrypted checksum.
When cable shared-secret is given without specifying an encryption option, the key is stored in the
configuration file as an encrypted password if the service password-encryption command has also been
given.

Command Modes Interface configuration—cable interface only (config-if)

Wideband-interface profile configuration (config-profile-wb)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

11.3 XA This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines The cable shared-secret command can be used to prevent unauthorized interception and alteration of the
DOCSIS configuration file that is downloaded to the CM during the registration process. The cable
shared-secret command specifies a secret encryption string that the CMTS uses to calculate the MD5 Message

Cisco CMTS Cable Command Reference

689
 Cable Commands: cable s
cable shared-secret

Integrity Check (MIC) value that is appended to every DOCSIS configuration file and that the CM and CMTS
use to verify the file’s integrity.
The CM must use the shared secret encryption string to successfully decrypt and process the configuration
file, and then register with the CMTS. If the CM does not have the proper encryption string, it will be unable
to calculate the proper MIC value, and the show cable modem command will show reject(m) for the modem
to indicate a MIC authentication failure.
To use the shared-secret feature, you must do the following:
• Create DOCSIS configuration files that use the shared-secret encryption string to create the MD5 MIC
value. This can be done using the Cisco DOCSIS Configurator tool by entering the shared-secret string
in the “CMTS Authentication” field in the “Miscellaneous” parameters.

Note The shared-secret string itself is not saved in the DOCSIS configuration file, so you must re-enter the string
in the “CMTS Authentication” field whenever you create or edit a DOCSIS configuration file using the Cisco
DOCSIS Configurator tool.

• Use the cable shared-secret command to configure the cable interfaces with a matching shared-secret
string. The string configured on an interface must match the string used to create the DOCSIS configuration
files downloaded to the CMs on that interface, or the CMs will not be able to register. You can use
different shared secrets for each interface, if you are also using a different set of configuration files for
each interface.
• To encrypt the shared-secret string in the CMTS configuration, you must include the service
password-encryption global configuration command in the router’s configuration.

Note You cannot use the shared secret feature with the files created by the internal DOCSIS configuration file editor
(cable config-file command).

Note In Cisco IOS Release 12.2(8)BC2 and later releases, you can also use the cable shared-secondary-secret
command to specify multiple shared-secret strings, so that you can gradually phase in a new shared secret
string.

Upgrading When Using Shared Secret Passwords

Cisco IOS Release 12.2 BC changed the encryption algorithm used for the cable shared-secret command.
If you are upgrading from a Cisco IOS 12.1 EC or 12.0 SC release, you cannot cut and paste the cable
shared-secret configuration lines that include an encrypted password. Instead, you must re-enter the original
shared secret passwords at the CLI prompt, and then resave the configuration.
For example, if the actual shared secret password is “cm-sharedsecret-password”, enter the cable shared-secret
cm-sharedsecret-password command at the CLI prompt. If you have enabled password encryption, the
configuration file will then show only the newly encrypted password.

Cisco CMTS Cable Command Reference

690
 Cable Commands: cable s
cable shared-secret

Note This change affects only the encryption of the passwords that are stored in the configuration file. It does not
affect the actual encryption that is used between the CMTS and CMs, so you do not need to change the shared
secret in the DOCSIS configuration files for the CMs.

Examples The following example shows how to specify a shared-secret string using an encrypted key:

Router# configure terminal

Router(config)# service password-encryption

Router(config)# int c6/0

Router(config-if)# cable shared-secret password

Router(config-if)# exit

Router(config)# exit

Router# show running-config | include shared

cable shared-secret 7 1407513181A0F13253920

Router#

Note In this example, the shared-secret string is initially entered as clear text, but because the service
password-encryption command has been used, the string is encrypted in the configuration file.

The following example shows how to remove the use of a shared-secret encryption key on a cable
interface. That particular interface then ignores any shared-secret that is used when calculating the
MD5 checksum:

Router# configure terminal

Router(config)# int c6/0

Router(config-if)# no cable shared-secret

Router(config-if)# end

Router#

Related Commands Command Description

cable dynamic-secret Enables the dynamic shared secret feature, so that DOCSIS configuration
files are verified with a dynamically generated shared secret.

cable Configures one or more secondary shared-secret keys that CMs can use to
shared-secondary-secret successfully process the DOCSIS configuration file and register with the
CMTS.

cable tftp-enforce Requires that all CMs on a cable interface attempt to download a DOCSIS
configuration file using the Trivial File Transfer Protocol (TFTP) through
the cable interface before being allowed to register and come online.

Cisco CMTS Cable Command Reference

691
 Cable Commands: cable s
cable sid-cluster-group

cable sid-cluster-group
To configure a SID cluster group on a cable interface line card, use the cable sid-cluster-group command in
cable interface configuration mode. To disable the configuration, use the no form of this command.

cable sid-cluster-group [ dynamic [max_rate_threshold] | req-multiplier value | num-of-cluster

number ]
no cable sid-cluster-group [ dynamic [max_rate_threshold] | req-multiplier value | num-of-cluster
number ]

Syntax Description dynamic max_rate_threshold If specified, the number of SID clusters is dynamically derived from the service
flow maximum rate. Valid values are from 1 to 4,294,967,295 bps. If not
specified, the legacy threshold of 28 Mbps is preserved.

req-multiplier value Specifies the queue-depth request byte multiplier. Valid values are 1, 2, 4, 8,
and 16. A cable modem uses queue-depth based requesting for all bandwidth
requests, if the Multiple Transmit Channel mode is enabled.

num-of-cluster number Specifies the number of SID clusters. Valid values are from 1 to 8. The default
value is 1.

Command Default None

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

IOS XE Gibraltar This command was updated. max_rate threshold option was added.
16.12.1z

Usage Guidelines Configure the cable sid-cluster-group num-of-cluster 2 command to achieve desired upstream bonded
speeds. Alternatively, use a large upstream Max Traffic burst in the cable modem file (such as 30 kB). The
Max Concat burst in the cable modem file does not need change because DOCSIS 3.0 uses continuous
concatenations and fragmentation (CCF), and can therefore use the default value of 3044 in the Max Concat
field.
If the cable sid-cluster-group command is not used, the router accepts the default SID cluster configuration.
By default, only one SID cluster is configured.

Examples The following example shows how to configure a SID cluster on a cable interface in slot 5, subslot
1, and port 0 on a Cisco uBR10012 router:

Cisco CMTS Cable Command Reference

692
 Cable Commands: cable s
cable sid-cluster-group

Router# configure terminal

Router(config)# interface cable 5/1/0
Router(config-if)# cable sid-cluster-group
Router(config-if)# cable sid-cluster-group dynamic
Router(config-if)# cable sid-cluster-group req-multiplier 8
Router(config-if)# cable sid-cluster-group num-of-cluster 2

The following example shows how to configure 2 SID clusters on Cisco cBR-8 router:

Router# configure terminal

Router(config)# interface cable 7/0/0
Router(config-if)# cable sid-cluster-group req-multiplier 12
Router(config-if)# cable sid-cluster-group num-of-cluster 2

The following example shows how to configure dynamic SID clusters on Cisco cBR-8 router:

Router# configure terminal

Router(config)# interface cable 7/0/0
Router(config-if)# cable sid-cluster-group dynamic 3000000000
Router(config-if)# cable sid-cluster-group req-multiplier 12

Associated Features
The cable sid-cluster-group command is used to configure the Upstream Channel Bonding feature.

Related Commands Command Description

cable sid-cluster-switching Specifies SID cluster switchover criteria on a cable interface line card.

Cisco CMTS Cable Command Reference

693
 Cable Commands: cable s
cable sid-cluster-switching

cable sid-cluster-switching
To specify Service ID (SID) cluster switchover criteria on a cable interface line card, use the cable
sid-cluster-switching command in cable interface configuration mode. To disable the configuration, use the
no form of this command.

cable sid-cluster-switching [max-outstanding-byte value | max-request value | max-time seconds |

max-total-byte value]
no cable sid-cluster-switching [max-outstanding-byte value | max-request value | max-time seconds
| max-total-byte value]

Syntax Description max-outstanding-byte value (Optional) Specifies the total size, in bytes, for outstanding requests using the
SID cluster. The valid values are from 0 to 4294967295.

max-request value (Optional) Specifies the maximum number of requests that can be made using
the SID cluster. The valid values are from 0 to 255. The default value is 1.
Note
Do not use 0 as a value for this configuration. The value 0 is used for Cisco
Internal purposes only.

max-time milliseconds (Optional) Specifies the total time, in milliseconds, that a service flow can
continue to use the SID cluster for bandwidth requests. The valid values are
from 0 to 65535.

max-total-byte value (Optional) Specifies the total number of bytes that can be requested using the
SID cluster. The valid values are from 0 to 4294967295.

Command Default None

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines If the service flow has only one SID cluster and the SID cluster switchover criterion limit is met, the cable
modem stops sending bandwidth requests until the SID cluster is cleared.
The SID cluster configuration along with switchover criterion may impact overall system performance. So
we recommend not to customizing switchover criterion unless justified. The default switchover criterion will
meet most of the requirements. If the cable sid-cluster-switching command is not used, the router accepts
the default SID cluster switchover criterion. That is only one request can be made using the SID cluster.

Cisco CMTS Cable Command Reference

694
 Cable Commands: cable s
cable sid-cluster-switching

Examples The following example shows how to specify SID cluster switchover criteria on a cable interface in
slot 5, subslot 1, and port 0 on a Cisco uBR10012 router:

Router# configure terminal

Router(config)# interface cable 5/1/0
Router(config-if)# cable sid-cluster-switching
Router(config-if)# cable sid-cluster-switching max-outstanding-byte 4444
Router(config-if)# cable sid-cluster-switching max-request 222
Router(config-if)# cable sid-cluster-switching max-time 444
Router(config-if)# cable sid-cluster-switching max-total-byte 67890

Related Commands Command Description

cable sid-cluster-group Configures a SID cluster on a cable interface line card.

Cisco CMTS Cable Command Reference

695
 Cable Commands: cable s
cable sip cir-scale

cable sip cir-scale

To configure the committed information rate (CIR) scaling ratio for scaling the admission control (AC)
bandwidth for all Modular Cable and Wideband interfaces on a SIP, use the cable sip cir-scale command in
global configuration mode. To disable the configuration, use the no form of the command.

cable sip slot cir-scale percent

no cable sip slot cir-scale

Syntax Description slot Slot number of the SIP on the Cisco uBR10012 router. The valid values are 1 and 3.

percent Percentage for scaling the AC bandwidth on the SIP. The valid range is from 10 to 100.

Command Default The AC bandwidth on the SIP is not scaled (that is, 100%).

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCI This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines When CIR scaling is configured, the maximum reserved bandwidth is scaled based on the specified percent.

Note Do not change the CIR scaling value frequently as it can increase the system load.

The table below provides the recommended values for the CIR scaling:

Table 12: Recommended Values for the CIR Scaling

Shared Port Adapters Recommended CIR Scaling

4 x Cisco 3 Gbps Wideband Shared Port Adapters 100%

4 x Cisco 6 Gbps Wideband Shared Port Adapters 50%

2 x Cisco 6 Gbps Wideband Shared Port Adapters 100%

1 x Cisco 6 Gbps Wideband Shared Port Adapter and 3 x 80%

Cisco 3 Gbps Wideband Shared Port Adapters

The following examples shows how to set the CIR value to 50%:
Router# configure terminal
Router(config)# cable sip 1 cir-scale 50

Cisco CMTS Cable Command Reference

696
 Cable Commands: cable s
cable sip fpd-auto

cable sip fpd-auto

To configure the automatic upgrade and downgrade of field-programmable device (FPD) image based on the
card configuration, use the cable sip fpd-auto command in global configuration mode. To disable the
configuration, use the no form of the command.

cable sip slot fpd-auto

Syntax Description slot Slot number of the SIP on the Cisco uBR10012 router.
The valid values are 1 and 3.

Command Default Automatic upgrade and downgrade of FPD image is disabled.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCI1 This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command can be used for automatic upgrade of Cisco 3 Gbps Wideband Shared Port Adapter and
downgrade of Cisco 6 Gbps Wideband Shared Port Adapter FPD images.

The following example shows how to enable automatic upgrade and downgrade of FPD image:
Router# configure terminal
Router(config)# cable sip 1 fpd-auto

Cisco CMTS Cable Command Reference

697
 Cable Commands: cable s
cable sip ib-stats

cable sip ib-stats

To configure the Ironbus throughput warning message threshold and print interval on a SIP, use the cable sip
ib-stats command in global configuration mode. To disable the configuration, use the no form of the command.

cable sip slot ib-stats bandwidth-usage percent message-throttle minutes

no cable sip slot ib-stats

Syntax Description slot Slot number of the SIP on the Cisco uBR10012 router.
The valid values are 1 and 3.

bandwidth-usage percent Specifies the bandwidth usage, in percentage. The valid

range is from 50 to 100. The default value is 90%.

message-throttle minutes Specifies the warning message interval, in minutes. The

valid range is from 0 to 60. The default value is 2 minutes.

Command Default None

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

Note If the warning message interval is set to 0, then the warning message is not displayed.

The following example shows how to set the bandwidth usage to 50% and the warning message
interval to 10 minutes:
Router# configure terminal
Router(config)# cable sip 1 ib-stats bandwidth-usage 50 message-throttle 10

Related Commands Command Description

show ib statistics Displays the Ironbus statistics information.

Cisco CMTS Cable Command Reference

698
 Cable Commands: cable s
cable snmp cache active

cable snmp cache active

To enable the SNMP cache status, use the cable snmp cache active command in global configuration mode.
To disable the configuration, use the no form of this command.

cable snmp cache active

no cable snmp cache active

Syntax Description This command has no keywords or arguments.

Command Default SNMP cache is enabled.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.
This command replaces the cable bgsync active command.

Usage Guidelines

Important You must configure the service internal command in global configuration mode to enable or disable SNMP
cache status.

The time interval for which the SNMP cache information is stored on the Supervisor is known as age and set
to 5 seconds.

Example
The following example shows how to enable the SNMP cache status:
Router(config)# service internal
Router(config)# cable snmp cache active

Related Commands Command Description

show cable snmp cache-status Displays the SNMP cache status.

Cisco CMTS Cable Command Reference

699
 Cable Commands: cable s
cable snmp cm-rcs

cable snmp cm-rcs

To receive the service-group ID or the bonding-group ID as Receive Channel Set (RCS) ID that the CM is
currently using.

cable snmp cm-rcs {service-group | bonding-group}

Syntax Description service-group Service-group ID is returned as RCS ID.

bonding-group Bonding-group ID is returned as RCS ID.

Command Default Service-group ID is returned as RCS ID.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.18.0SP This command was introduced on

the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines The no form of this command, that is, no cable snmp cm-rcs returns service-group ID as RCS ID.

Example
The following example shows how to configure the command to receive the service-group ID as
RCS ID:
Router(config)# service internal
Router(config)# cable snmp cm-rcs serivce-group

Cisco CMTS Cable Command Reference

700
 Cable Commands: cable s
cable snmp iftype ds-phy

cable snmp iftype ds-phy

Use the cable snmp iftype ds-phy command to change toggle the iftype for the downstream physical channels
between the default Cisco defined mode and the IANA defined mode.

cable snmp iftype ds-phy value

Syntax Description value Denotes the iftype of DS_PHY. The following values may be used:
• 1—Cisco-defined value for iftype of DS_PHY.
• 257—IANA-defined value for iftype of DS_PHY.

Command Default The default value is 1—Cisco defined iftype.

Command Modes Global Configuration (config)

Command History Release Modification

12.2(33)SCH5 This command was introduced.

12.2(33)SCI1 This command is integrated from Cisco IOS Release 12.2(33)SCH5.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is used to change the iftype of the downstream physical channel from the default Cisco-defined
value 1, to the IANA-defined value 257. The command is also used to revert to the default Cisco-defined
value.

Example
This example shows how to change the iftype value of the downstream physical channel for IANA:
Router(config)#cable snmp iftype ds-phy 257

This example shows how to verify that the iftype value has changed:
Router#show running-config | include iftype
cable snmp iftype ds-phy 257

Cisco CMTS Cable Command Reference

701
 Cable Commands: cable s
cable snmp trap detailed-alarm

cable snmp trap detailed-alarm

The cable snmp trap detailed-alarm CLI is used to add an entity name into the alarm description text in
alarm trap.

cable snmp trap detailed-alarm

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest 16.10.1g This command was introduced on
the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines The cable snmp trap detailed-alarm CLI feature is disabled by default. When this CLI is enabled, the entity
name is added into alarm trap description.
With the cable snmp trap detailed-alarm CLI, two new information will be added into the content of the
ceAlarmDescrText component in alarm trap:
• A prefix character ‘#’ .
• The entity name which has alarm.

There are no changes to the other existing components.

The following example shows an usage of the cable snmp trap detailed-alarm command:

Router(config)# configure terminal

Router(config)# cable snmp trap detailed-alarm
Router(config)# show running-config | i cable snmp
cable snmp trap detailed-alarm

Cisco CMTS Cable Command Reference

702
 Cable Commands: cable s
cable source-route

cable source-route
To configure the virtual routing and forwarding instance (VRF) source route, use the cable source-route
command in the cable modem's subinterface configuration mode. To disable the route, use the no form of this
command.

cable source-route
no cable source-route

Syntax Description This command has no arguments or keywords.

Command Default The VRF source route is not configured.

Command Modes
Subinterface configuration (config-subif)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to configure the VRF source route:

Note This command is supported on the Cisco uBR10012 broadband routers only.

Router(config-subif)# cable source-route

Related Commands Command Description

cable vrf-steering cable-modem Steers or directs the cable modems to the specified VRF.

ip vrf Defines a VRF instance and enters the interface configuration mode.

show ip arp vrf Displays which VRF contains a specific cable modem in the ARP table.

Cisco CMTS Cable Command Reference

703
 Cable Commands: cable s
cable source-verify

cable source-verify
To enable verification of IP addresses for CMs and CPE devices on the upstream, use the cable source-verify
command in bundle interface configuration mode. To disable verification, use the no form of this command.

cable source-verify [dhcp | leasetimer value]

no cable source-verify

Syntax Description dhcp (Optional) Specifies that queries will be sent to verify unknown source IP addresses in
upstream data packets.

leasetimer (Optional) Specifies the time, in minutes, for how often the router should check its internal
value CPE database for IP addresses whose lease times have expired. The valid range for value
is 1 to 240 minutes, with a default of 60 minutes.

Command Default Disabled. When the dhcp option is specified, the leasetimer option defaults to 60 minutes.

Command Modes
Bundle Interface configuration (config-if)

Command History Release Modification

11.3 XA This command was introduced.

12.0(7)T The dhcp keyword was added.

12.0(10)SC, 12.1(2)EC Support was added for these trains.

12.1(3a)EC Subinterface support was added.

12.1(13)EC, 12.2(11)BC1 The leasetimer keyword was added.

12.2(15)BC1 The verification of CPE devices was changed when using the dhcp keyword.

12.2(15)BC2 Support for verifying CMs and CPE devices that are on a different subnet than
the cable interface was enhanced to use Reverse Path Forwarding (RFP).

12.3(9a)BC Cisco IOS Release 12.3(9a)BC adds the option of using a per SID basis for
deriving lease queries from CPE devices. This release also introduces a global
rate limit for lease queries initiated by downstream traffic.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines Configuring the cable source-verify command on the bundle interface of a bundle will configure it for all
of the subordinate interfaces in the bundle as well.
The cable source-verify command helps to prevent the spoofing of IP addresses by CMs or their CPE devices
by verifying that the upstream packets coming from each CM are known to be associated with the IP address
in that packet. Packets with IP addresses that do not match those associated with the CM are dropped.

Cisco CMTS Cable Command Reference

704
Cable Commands: cable s
cable source-verify

In order to protect the Cisco CMTS from denial of service attacks, Cisco IOS Release 12.3(9a)BC adds the
option of using a per SID basis for deriving leasequeries from CPE devices. This release also introduces a
global rate limit for leasequeries initiated by downstream traffic. These enhancements reduce the CPU utilization
of Dynamic Host Configuration Protocol (DHCP) Receive and ISR processes when the Cisco CMTS is
configured with the cable source-verify dhcp and no cable arp commands.
When cable source-verify dhcp and no cable arp commands are configured, DHCP leasequery is sent for
downstream packets to verify unknown IP addresses within the IP address range configured on the bundle
interface.
For DHCP leasequery to work in the downstream direction, the Cisco Network Registrar (CNR) should be
made aware of the DHCP Option 82. This is required to make the CMTS map the CPE IP address to the
correct CM. To do this, configure the ip dhcp relay information option command on the bundle interface
to insert service class relay agent option into the DHCP DISCOVER messages. When the configuration is in
place, during DHCP DISCOVER, the values of DHCP Option 82 is cached by the CNR and is returned to
the CMTS on any subsequent DHCP leasequery for that IP address.
The Cisco CMTS maintains a database that links the MAC and IP addresses of known CPE devices with the
CMs that are providing network access for those CPE devices. The CMTS typically populates this database
with information obtained by examining the DHCP packets sent between the CPE devices and the DHCP
server. Other IP traffic provides information about which CMs service which CPE devices.
After the cable source-verify command is issued, every IP upstream packet is examined. If the IP and MAC
addresses of the CPE device are already associated with a known, online CM, it is allowed through. If not,
the source IP address is examined to determine if it belongs to the cable network. If so, and if the dhcp option
is not used, the packet is allowed through.
Using the dhcp Option

Note Do not enable the local DHCP server on the Cisco CMTS and configure local DHCP address pools using the
ip dhcp pool command, when using dhcp option, because this prevents DHCP address validation.

If the dhcp option is used, all packets with unknown IP addresses within the cable network are dropped, but
the Cisco CMTS sends a DHCP leasequery message to the DHCP server to verify the IP address. If a valid
response is received from the DHCP server, the CMTS updates its database with the new CPE device and
allows future traffic through. If the DHCP server does not return a successful response, all traffic from the
CPE is dropped.
In Cisco IOS Release 12.2(15)BC1 and later releases, the dhcp option extends the verification to CPE devices
that had been online using a valid IP address but then were reconfigured by the user with an unused static IP
address. With Cisco IOS Release 12.2(15)BC1 and later, CPE devices are not allowed online when they are
using static IP addresses that have not been allocated by the DHCP server. If you are using the dhcp option,
the CPE device must use an IP address that has been assigned by the DHCP server.

Note You must enable the ip dhcp relay information option command to properly trigger the leasequery after
configuring the cable source-verify dhcp command. If the ip dhcp relay information option command is
not enabled, the leasequery does not recover the IP address of the CPE properly.

Cisco CMTS Cable Command Reference

705
 Cable Commands: cable s
cable source-verify

Note The dhcp option automatically blocks all statically-assigned IP addresses unless the DHCP server has been
configured to recognize those addresses and respond with the appropriate leasequery response.

The cable source-verify command by itself prevents someone from stealing another customer’s IP address.
The cable source-verify dhcp command adds another level of security by refusing access to any CPE device
with an IP address that has not been assigned by the DHCP server.

Note This dhcp option requires that the DHCP server support the leasequery message. The CNR supports leasequery
in version 7.0 onwards. The leasequery message is defined in an IETF draft, and available at the URL:
http://www.ietf.org/rfc/rfc4388.txt

Caution Do not enable the local DHCP server on the Cisco CMTS and configure local DHCP address pools, using the
ip dhcp pool command, when you are also enabling the cable source-verify dhcp command, because the
DHCP server on the Cisco CMTS can intercept the leasequery messages and prevent them from reaching the
external DHCP server. This in turn prevents address validation from succeeding because the DHCP server
on the Cisco CMTS does not support leasequery messages.

Note When the cable source-verify dhcp feature is enabled, and a statically-defined IP address has been added to
the CMTS for a CM using the cable trust command to override the cable source-verify dhcp checks for this
device, packets from this CM will continue to be dropped until an entry for this CM is added to the ARP
database of the CMTS. To achieve this, disable the cable source-verify dhcp feature, ping the CMTS from
the CM to add an entry to the ARP database, and re-enable the cable source-verify dhcp feature.

Using the leasetimer Option

Note The leasetimer option takes effect only when the dhcp option is also used on an interface. Also, this option
is supported only on the primary interface and cannot be configured on subinterfaces. Configuring it for a
primary interface automatically applies it to all subinterfaces.

The leasetimer option adds another level of verification by activating a timer that periodically examines the
lease times for the IP addresses for known CPE devices. If the CMTS discovers that the DHCP lease for a
CPE device has expired, it removes that IP address from its database, preventing the CPE device from
communicating until it makes another DHCP request. This prevents users from treating DHCP-assigned
addresses as static addresses, as well as from using IP addresses that were previously assigned to other devices.

Note The leasetimer option is active only if you have also specified the cable source-verify dhcp command for
the bundle interface. If the dhcp option is not used, the leasetimer option has no effect. In addition, the
leasetimer option can be configured only on an interface, not a subinterface. Applying it to a primary interface
automatically applies it to all subinterfaces.

Cisco CMTS Cable Command Reference

706
 Cable Commands: cable s
cable source-verify

The leasetimer option allows you to configure how often the timer checks the lease times, so as to specify
the maximum amount of time a CPE device can use an IP address that was previously assigned by the DHCP
server but whose lease time has since expired. The time period can range from 1 minute to 240 minutes (4
hours), with a grace period of 2 minutes to allow a PC enough time to make a DHCP request to renew the IP
address. To turn off the timer, so that the CMTS no longer checks the lease times, issue the cable source-verify
command without the dhcp option, or turn off the feature entirely with the no cable source-verify command.
Using Multiple Subnets
In Cisco IOS Release 12.2(15)BC2 and later releases, the cable source-verify command can verify IP addresses
that are on different subnets than what is being used on the bundle interface or subinterfaces only when Reverse
Path Forwarding (RPF) is used in conjunction.

Note You must enable RPF before running the cable source-verify command to verify IP addresses on
subinterfaces.

Examples The following example shows how to enable RPF before running the cable source-verify command
to verify IP addresses on subinterfaces:

Router# configure terminal

Router(config)# ip cef
Router(config)# interface bundle 1
Router(config-if)# ip verify unicast source reachable-via rx

Note Beginning with Cisco IOS Release 12.2(33)SCA,ip verify unicast source reachable-via rx .
command must be used with the allow-default keyword

The following example shows how to turn on CM upstream verification and configures the Cisco
CMTS router to send DHCP lease queries to verify unknown source IP addresses in upstream data
packets:

Router# configure terminal

Router#(config) interface bundle 1
Router(config-if)# cable source-verify dhcp
Router(config-if)#

The following example shows how to enable the leasetimer feature so that every two hours, the
CMTS checks the IP addresses in the CPE database for that particular interface for expired lease
times:

Router# configure terminal

Router#(config) interface bundle 1
Router(config-if)# cable source-verify dhcp
Router(config-if)# cable source-verify leasetimer 120

The following example shows how to configure the bundle interface so that the CMTS can verify
IP addresses that are on a different subnet than the one that the bundle interface is using:

Cisco CMTS Cable Command Reference

707
 Cable Commands: cable s
cable source-verify

Router# configure terminal

Router(config)# ip cef
Router#(config) interface bundle 1
Router(config-if)# ip verify unicast source reachable-via rx
Router(config-if)# cable source-verify dhcp

Related Commands Command Description

cable arp Enables or disables the use of the ARP protocol for CMs and their CPE
devices.

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

cable dhcp-giaddr Modifies the GIADDR field of DHCP DISCOVER and DHCPREQUEST
packets with a Relay IP address before they are forwarded to the DHCP
server.

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

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

cable source-verify Controls the number of DHCP leasequery request messages that are sent
leasequery-filter downstream for unknown IP addresses on all cable downstream interfaces on the
Cisco CMTS router.

cable source-verify Controls the number of DHCP leasequery request messages that are sent
leasequery-filter upstream for unknown IP addresses per each service ID (SID) on an upstream.

clear cable logging Removes all error messages about bad IP source addresses on the cable
interfaces from the error log buffer.

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

ip dhcp smart-relay Monitors client retransmissions when address pool depletion occurs.

ip verify unicast reverse-path Enables Unicast Reverse Path Forwarding (Unicast RPF), which checks
each packet received on an interface to verify that the packet’s source
IP address appears in the routing tables as belonging to that interface, so
as to prevent spoofed IP source addresses.

Cisco CMTS Cable Command Reference

708
 Cable Commands: cable s
cable source-verify dhcp arp-probe

cable source-verify dhcp arp-probe

To send ARP to CPE after source verify is successful, use the cable source-verify dhcp arp-probe command
to control the interval and retries. To disable the configuration, use the no form of this command.

cable source-verify dhcp arp-probe [ interval seconds { retries number-of-probes } ]

cable source-verify dhcp arp-probe [ interval seconds [ retries number-of-probes ] ]

Syntax Description dhcp DHCP LQ

arp-probe ARP Probe

interval seconds Interval between ARP

probes

retries number-of-probes Number of probes

Command Default This command is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This command is introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines The following is a sample configuration of the command:

Router#configue terminal
Enter configuration commands, one per line. End with CNTL/Z.

Router(config)#cable source-verify dhcp arp-probe interval 30 retries 3

Related Commands Command Description

cable arp Enables or disables the use of the ARP protocol for CMs and their CPE devices.

Cisco CMTS Cable Command Reference

709
 Cable Commands: cable s
cable source-verify enable-sav-static

cable source-verify enable-sav-static

To enable source address verification (SAV) on the Cisco CMTS, use the cable source-verify enable-sav-static
command in global configuration mode. To disable the SAV, use the no form of this command.

cable source-verify enable-sav-static

no cable source-verify enable-sav-static

Syntax Description This command has no arguments or keywords.

Command Default SAV is disabled by default

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable source-verify enable-sav-static command allows you to enable of SAV prefix processing on the
Cisco CMTS. If the SAV feature is enabled, the SAV prefixes are matched during source verification. If the
feature is disabled the SAV prefixes are not matched, and the configured SAV prefixes do not have any impact
on the outcome of the source verification.
This feature is disabled by default.

Examples The following example shows how to enable SAV prefix processing on the Cisco CMTS:

Router(config)# cable source-verify enable-sav-static

Related Commands Command Description

cable source-verify group Configures SAV groups.

prefix Configures IPv4 or IPv6 prefixes in a SAV group.

Cisco CMTS Cable Command Reference

710
 Cable Commands: cable s
cable source-verify enable-sav-trust-last

cable source-verify enable-sav-trust-last

To enable source address verification (SAV) for trust-last, use the cable source-verify enable-sav-trust-last
command in global configuration mode. To disable the SAV for trust-last, use the no form of this command.

cable source-verify enable-sav-trust-last

no cable source-verify enable-sav-trust-last

Syntax Description This command has no arguments or keywords.

Command Default SAV is disabled by default

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE This command is introduced.

17.15.1y

Usage Guidelines SAV (source address verification) allows static CPE IPs within a prefix to bypass source-verify checks. It’s
similar to cable trust, which allows static IPs on specific MAC addresses(and only supports trust-first). The
cable source-verify enable-sav-trust-last command allows SAV on trust-first as well.
When it’s enabled, if a CM is configured with SAV, and a static CPE is configured with matching prefix, the
MAC address matching flag is not set in its FIB entry in CPP. The CPE is allowed to change its MAC address
while keeping the same IP address.
This feature is disabled by default.

Examples The following example shows how to enable SAV for trust-last:

Router(config)# cable source-verify enable-sav-trust-last

Related Commands Command Description

cable source-verify enable-sav-static Enable source address verification (SAV)

Cisco CMTS Cable Command Reference

711
 Cable Commands: cable s
cable source-verify group

cable source-verify group

To configure the source address verification (SAV) prefix group, use the cable source-verify group command
in global configuration mode. To disable the use of configured SAV prefix group, use the no form of this
command.

cable source-verify group groupname

no cable source-verify group groupname

Syntax Description groupname Name of the SAV prefix group. The groupname can be any arbitrary string up to 15 characters
in length.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable source-verify group command is used to configure SAV groups. A SAV group is a group of IPv4
or IPv6 prefixes. 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.1 specifies the group name to which a given CM belongs. 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 255 SAV groups can be configured on a Cisco CMTS, with each SAV group containing up
to four IPv4s, IPv6s, or a combination of both the prefixes (totalling up to four).

Examples The following example shows how to configure a SAV group with one IPv6 prefixes and one IPv4
prefixes:

Router(config
)# cable source-verify group sav1
Router(config
)# prefix 10.16.0.0/12
Router(config
)# prefix 10::/12

Router(config
)# exit

Cisco CMTS Cable Command Reference

712
 Cable Commands: cable s
cable source-verify group

Related Commands Command Description

cable source-verify enable-sav-static Enables SAV prefix processing.

prefix Configures IPv4 or IPv6 prefixes in a SAV group.

Cisco CMTS Cable Command Reference

713
 Cable Commands: cable s
cable source-verify leasequery-filter downstream

cable source-verify leasequery-filter downstream

To control the number of Dynamic Host Configuration Protocol (DHCP) LEASEQUERY request messages
that are sent for unknown IP addresses on all cable downstream interfaces on the Cisco Cable Modem
Termination System (CMTS) router, use the cable source-verify leasequery-filter downstream command
in global configuration mode. To stop the filtering of DHCP lease queries, use the no form of this command.

cable source-verify leasequery-filter downstream threshold interval

no cable source-verify leasequery-filter downstream

Syntax Description threshold Maximum number of DHCP lease queries allowed for each interval period. The valid range is 0
to 255 lease queries.

interval Time period, in seconds, over which lease queries should be monitored. The valid range is 1 to
10 seconds.

Command Default Filtering of DHCP lease queries is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(15)BC1d, 12.2(15)BC2b This command was introduced for the Cisco uBR7100 series, Cisco
uBR7246VXR, and Cisco uBR10012 universal broadband routers.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines When the cable source-verify dhcp and no cable arp commands are configured on a cable interface, the
Cisco CMTS router sends a DHCP LEASEQUERY request to the DHCP server to verify unknown IP addresses
that are found in packets to and from customer premises equipment (CPE) devices that are using the cable
modems on the cable interface. The DHCP server returns a DHCP ACK message with the MAC address of
the CPE device that has been assigned this IP address, if any. The router can then verify that this CPE device
is authorized to use this IP address, which prevents users from assigning unauthorized IP addresses to their
CPE devices.
Problems can occur, though, when viruses, denial of service (DoS) attacks, and theft-of-service attacks scan
ranges of IP addresses, in an attempt to find unused addresses. This type of activity can generate a large volume
of DHCP LEASEQUERY requests, which can result in high CPU utilization and a lack of available bandwidth
for other customers.
To prevent such a large volume of LEASEQUERY requests on all downstreams in the Cisco CMTS router,
use the cable source-verify leasequery-filter downstream command. After configuring this command, the
Cisco CMTS allows only a certain number of DHCP LEASEQUERY requests in the downstream direction
within each interval time period.
For example, the cable source-verify leasequery-filter downstream 5 10 command configures the router
so that it allows a maximum of 5 DHCP LEASEQUERY requests every 10 seconds for each SID on the
downstream direction. This command applies to all downstream cable interfaces in the router.

Cisco CMTS Cable Command Reference

714
 Cable Commands: cable s
cable source-verify leasequery-filter downstream

Note The cable source-verify leasequery-filter downstream command enables DHCP lease query filtering on
all downstreams, but the actual filtering does not begin until the cable source-verify dhcp command and the
no cable arp command are configured on a particular downstream. You can configure these commands on
either the downstream’s main interface, or on a subinterface for the downstream. If these commands are
configured on a subinterface, however, the lease query filtering occurs only for cable modems using that
subinterface.

Tip Use the cable source-verify leasequery-filter upstream command to filter DHCP LEASEQUERY requests
in the upstream direction.

Examples The following example shows how to configure the Cisco CMTS router so that it allows a maximum
of 10 DHCP lease query requests per SID over each five-second interval on all downstream cable
interfaces. This example also shows the configuration of cable source-verify dhcp and no cable
arp commands on a cable interface, which are required to use this feature.

Router# configure terminal

Router(config)# cable source-verify leasequery-filter downstream 10 5

Router(config)# interface cable 5/1/0

Router(config-if)# cable source-verify dhcp

Router(config-if)# no cable arp

Router(config-if)#

Related Commands Command Description

cable arp Activates the cable Address Resolution Protocol (ARP).

cable arp filter Controls the number of ARP requests and replies that can be forwarded
over a cable interface.

cable source-verify Enables verification of IP addresses for cable modems (CMs) and CPE
devices on the upstream.

cable source-verify Controls the number of DHCP lease query messages that are sent for
leasequery-filter upstream unknown IP addresses per each service ID (SID) on an upstream.

show cable leasequery-filter Displays the number of DHCP lease query messages that have been
filtered for all cable modems or for a particular cable interface.

Cisco CMTS Cable Command Reference

715
 Cable Commands: cable s
cable source-verify leasequery-filter upstream

cable source-verify leasequery-filter upstream

To control the number of Dynamic Host Configuration Protocol (DHCP) LEASEQUERY request messages
that are sent for unknown IP addresses per each service ID (SID) on an upstream, use the cable source-verify
leasequery-filter upstream command in cable interface configuration mode. To disable the filtering of DHCP
lease queries, use the no form of this command.

cable source-verify leasequery-filter upstream threshold interval

no cable source-verify leasequery-filter upstream

Syntax Description threshold Maximum number of DHCP lease queries allowed per SID for each interval period. The valid
range is 0 to 20 lease queries.

interval Time period, in seconds, over which lease queries should be monitored. The valid range is 1 to
5 seconds.

Command Default Filtering of DHCP lease queries is disabled.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.2(15)BC1d, 12.2(15)BC2b This command was introduced for the Cisco uBR7100 series, Cisco
uBR7246VXR, and Cisco uBR10012 universal broadband routers.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines When the cable source-verify dhcp and no cable arp commands are configured on a cable interface, the
Cisco Cable Modem Termination System (CMTS) router sends a DHCP LEASEQUERY request to the DHCP
server to verify unknown IP addresses that are found in packets to and from customer premises equipment
(CPE) devices that are using the cable modems on the cable interface. The DHCP server returns a DHCP
ACK message with the MAC address of the CPE device that has been assigned this IP address, if any. The
router can then verify that this CPE device is authorized to use this IP address, which prevents users from
assigning unauthorized IP addresses to their CPE devices.
Problems can occur, though, when viruses, denial of service (DoS) attacks, and theft-of-service attacks scan
ranges of IP addresses, in an attempt to find unused addresses. This type of activity can generate a large volume
of DHCP LEASEQUERY requests, which can result in high CPU utilization and a lack of available bandwidth
for other customers.
To prevent such a large volume of LEASEQUERY requests on the upstreams on a cable interface, use the
cable source-verify leasequery-filter upstream command. After configuring this command, the Cisco CMTS
allows only a certain number of DHCP LEASEQUERY requests in the upstream direction within each interval
time period.
For example, the cable source-verify leasequery-filter upstream 5 5 command configures the router so that
it allows a maximum of 5 DHCP LEASEQUERY requests every 5 seconds for each SID on the upstream
direction. This command applies to all upstreams on the cable interface.

Cisco CMTS Cable Command Reference

716
 Cable Commands: cable s
cable source-verify leasequery-filter upstream

Note The cable source-verify leasequery-filter upstream command enables DHCP lease query filtering on all
upstreams on a cable interface, but the actual filtering does not begin until the cable source-verify dhcp
command and the no cable arp command are configured on the upstream’s associated downstream interface.
You can configure these commands on either the downstream’s main interface, or on a subinterface for the
downstream. If these commands are configured on a subinterface, however, the lease query filtering occurs
only for cable modems using that subinterface.

Note If using cable interface bundling, configure the cable source-verify leasequery-filter upstream command
on all primary and subordinate interfaces.

Tip Use the cable source-verify leasequery-filter downstream command to filter DHCP LEASEQUERY requests
in the downstream direction.

Examples The following example shows how to configure the Cisco CMTS router so that it allows a maximum
of five DHCP lease query requests per SID over each two-second interval on all upstreams on a
particular cable interface. This example also shows the configuration of cable source-verify dhcp
and no cable arp commands on the cable interface, which are required to use this feature.

Router# configure terminal

Router(config)# interface cable 6/0

Router(config-if)# cable source-verify dhcp

Router(config-if)# cable source-verify leasequery-filter upstream 5 2

Router(config-if)# no cable arp

Router(config-if)#

Related Commands Command Description

cable arp Activates the cable Address Resolution Protocol (ARP).

cable arp filter Controls the number of ARP requests and replies that can be forwarded
over a cable interface.

cable source-verify Enables verification of IP addresses for cable modems (CMs) and CPE
devices on the upstream.

cable source-verify Controls the number of DHCP lease query messages that are sent for
leasequery-filter downstream unknown IP addresses on all cable downstream interfaces on the Cisco
CMTS router.

show cable leasequery-filter Displays the number of DHCP lease query messages that have been
filtered for all cable modems or for a particular cable interface.

Cisco CMTS Cable Command Reference

717
 Cable Commands: cable s
cable source-verify sav-static-group-override

cable source-verify sav-static-group-override

To override the global trust-last option, use the cable source-verify enable-sav-trust-last group-name
[trust-first|trust-last] command in global configuration mode. To disable the override, use the no form of
this command.

cable source-verify enable-sav-trust-last group-name [trust-first|trust-last]

no cable source-verify enable-sav-trust-last group-name

Syntax Description group-name Name of the SAV group.

trust-first Denies MAC address change.

trust-last Allows MAC address

change.

Command Default Disabled by default

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE This command is introduced.

17.15.1y

Usage Guidelines • If trust-last is disabled globally (by default), trust-last override on a group enables the trust-last feature
on the group only.
• If trust-last is enabled globally by this command, then trust-first override on a group disables the trust-last
feature on the group only.

This feature is disabled by default.

Examples The following example shows how to configure the override:

Router(config)# cable source-verify enable-sav-static Group2 trust-last

Related Commands Command Description

cable source-verify enable-sav-trust-last To enable source address verification (SAV) for trust-last.

Cisco CMTS Cable Command Reference

718
 Cable Commands: cable s
cable spectrum-group (global)

cable spectrum-group (global)

To create and configure a spectrum group, use the cable spectrum-group command in global configuration
mode. To disable this spectrum group, use the no form of this command.

cable spectrum-group group-number [time day hh:mm:ss ] frequencyup-freq-hz [ pwr-lvl-dbmv]

no cable spectrum-group group-number

Syntax Description group-number Specifies the spectrum group for which you are specifying a parameter value or
specifies the number of the spectrum group you wish to remove from your router
configuration. Valid range is from 1 to 32, or from 1 to 40, depending on the Cisco
IOS software release.

time day hh:mm:ss (Optional) For scheduled spectrum groups, enter the day of the week (Sun—Sat) and
the time of day that the frequency and input power level should change.

frequency up-freq-hz Specifies a center frequency for the upstream group. The valid range is 5,000,000 Hz
to 42,000,000 Hz (DOCSIS), 55,000,000 Hz (Japan), or 65,000,000 (EuroDOCSIS).
Note
You can enter this command multiple times for the same spectrum group to create a
group of individual frequencies to be used for frequency hopping.

band up-freq1-hz Specifies a range of center frequencies the Cisco CMTS can scan to find an acceptable
up-freq2-hz channel to which the spectrum group may hop. The valid range for up-freq1-hz is
5,000,000 Hz to 42,000,000 Hz (DOCSIS), 55,000,000 Hz (Japan), or 65,000,000
(EuroDOCSIS), but up-freq2-hz must be greater than up-freq1-hz.
Note
When creating spectrum groups for cable line cards that support Advanced Spectrum
Management (Cisco uBR10-MC16S, uBR10-MC16U/X, uBR10-MC28U/X, and
uBR10-MC5X20S/U), use the band option. The frequency option is not supported
for these types of line cards.

pwr-lvl-dbmv (Optional) Specifies the nominal input power level. The valid range is –10 to +25
dBmV, with a default of 0 dBmV. Some cable plants might want to change only the
input power level, and not the frequency, on a daily time schedule.

Command Default If not specified, the group is set for a nominal input power level of 0 dBmV and the group is not scheduled
for automatic frequency or power changes.

Command Modes
Global configuration (config)

Command History Release Modification

11.3 NA This command was introduced.

12.0(7)XR2 The band parameter for this command was added to enable frequency
range scanning capabilities in the Cisco uBR-MC16S cable interface line
card.

Cisco CMTS Cable Command Reference

719
 Cable Commands: cable s
cable spectrum-group (global)

Release Modification

12.0(13)SC, 12.1(4)EC, The allowable frequency range was increased to 65 MHz to support the
12.2(4)BC1 EuroDOCSIS frequency range of the Cisco uBR-MC16E cable interface
line card.

12.2(15)BC2 The maximum number of spectrum groups was increased from 32 to 40

groups per router.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Frequency agility is configured and activated using spectrum groups that are controlled by the spectrum
manager. You can create from 1 to 32, or from 1 to 40, spectrum groups for each cable modem card upstream
port, depending on the Cisco IOS software release.
To create spectrum groups, specify a list of upstream frequencies and nominal power levels that each spectrum
group can use when an upstream frequency change is necessary. Each spectrum group should have its own
list of upstream frequencies. At 1.6 MHz, the valid range is –10 dBmV to 25 dBmV. The power level value
should be changed only if you want to change only the power level as part of spectrum management. The
standard power level is 0 dBmV.
The cable spectrum-group command sets the center frequency for the upstream, but the total frequency
bandwidth that is actually used depends on the channel width. Table below shows the possible center frequencies
for each channel width, for both DOCSIS and EuroDOCSIS cable interfaces.

Table 13: Allowable Center Frequencies

Channel Width (MHz) Center Frequency (MHz) Center Frequency (MHz)

DOCSIS (5 to 42 MHz) EuroDOCSIS (5 to 65 MHz)

200,000 5.1 to 41.9 5.1 to 64.9

400,000 5.2 to 41.8 5.2 to 64.8

800,000 5.4 to 41.6 5.4 to 64.6

1,600,000 5.8 to 41.2 5.8 to 64.2

3,200,000 6.6 to 40.4 6.6 to 63.4

The allowable range for the upstream channel frequency depends on the cable interface line card and Cisco
IOS software release being used. See Table 2-11 for the currently supported values.

Table 14: Allowable Frequency Range for the cable upstream frequency Command

Frequency Range Supported Cable Interfaces Minimum Cisco IOS Releases

5 to 42 MHz All supported cable interfaces All releases supported for the Cisco
CMTS

5 to 55 MHz Cisco uBR-MC16U/X and Cisco Cisco IOS Release 12.2(15)BC2

uBR-MC28U/X, when operating with extended
frequencies for Japanese mode

Cisco CMTS Cable Command Reference

720
 Cable Commands: cable s
cable spectrum-group (global)

Frequency Range Supported Cable Interfaces Minimum Cisco IOS Releases

5 to 65 MHz Cisco uBR-MC16E, Cisco uBR7111E and Cisco Cisco IOS Release 12.0(13)SC,
uBR7114E routers 12.1(4)EC, and 12.2(4)BC1

Note If both an Cisco uBR-MC16E cable interface line card and a Cisco uBR-MC16C or a Cisco uBR-MC16S
cable interface line card are present in the chassis, a spectrum group in the 42-MHz to 65-MHz range should
not be assigned.

Tip Cisco cable interface line cards always program the upstream’s center frequency in 16 KHz increments, and
this is the frequency displayed by the show controller cable upstream command. For example, if you use
the cable upstream frequency command to specify a center frequency of 27 MHz (cable upstream x
frequency 27000000), the actual center frequency will be 27.008 MHz, which is the next highest 16 KHz
boundary.

You must repeat this command for each frequency or power level that you want to add to a spectrum group’s
list of valid values.
After you have created one or more spectrum groups for your cable network, you can add characteristics to
them, providing you with more definitive control over frequency usage and frequency hopping.
The cable interface does not operate until you either create and configure a spectrum group or set a fixed
upstream frequency. See the cable upstream channel-width command.

Examples The following example shows how to configure spectrum group 1 with an upstream frequency of
6,500,000 Hz and a default power level of 0 dBmV:

Router(config)# cable spectrum-group 1 frequency 6500000

The following example shows how to add the upstream frequency 7,000,000 Hz to the list of valid
frequencies with a default power level of 0 dBmV for spectrum group 1:

Router(config)# cable spectrum-group 1 frequency 7000000

The following example shows how to configure spectrum group 2 with an upstream frequency
7,500,000 Hz and change the power level to 5 dBmV:

Router(config)# cable spectrum-group 2 frequency 7500000 5

The following example shows how to configure spectrum group 3 with an upstream band of 12,000,000
to 18,000,000 Hz and default power level of 0 dBmV:

Router(config)# cable spectrum-group 3 band 12000000 18000000

The following example shows how to add the upstream band 20,000,000 to 24,000,000 Hz to the
list of valid bands with a change in the power level of 13 dBmV for spectrum group 3:

Router(config)# cable spectrum-group 3 band 20000000 24000000 13

Cisco CMTS Cable Command Reference

721
 Cable Commands: cable s
cable spectrum-group (global)

The following example shows how to configure a continuous band between 5,000,004 and 40,000,000
Hz for scheduled spectrum group 4 with a default power level of 0 dBmV. The spectrum group will
be available to the spectrum group starting at 12:00 p.m. local time each Monday:

Router(config)# cable spectrum-group 4 time Monday 12:00:00 band 5000004 40000000

The following example shows how to add the upstream frequency 9,500,000 Hz to the list of valid
frequencies and change the nominal power level to 5 dBmV. The spectrum manager adjusts frequencies
and power levels on this group at 2:00 a.m. local time each day:

Router(config)# cable spectrum-group 3 time 02:00:00 frequency 9500000 5

The following example shows how to remove a specified spectrum group from your configuration:

Router(config)# no cable spectrum-group 3

Router(config)#

Related Commands Command Description

cable modulation-profile Configures preset modulation profiles that you can apply to one or
more upstream cable interfaces when you identify and configure
spectrum groups.

cable spectrum-group hop period Sets the minimum frequency-hop interval for a cable spectrum group.

cable spectrum-group hop threshold Specifies a hop threshold for a cable spectrum group.

cable spectrum-group shared Specifies the upstream ports in a spectrum group can share the same
upstream frequency.

cable upstream frequency Specifies that the upstream should either be set to a specific center
frequency or be set dynamically.

cable upstream power-level Specifies the upstream cable interface receive power level in dBmV.

cable upstream shutdown Activates or shuts down a specified upstream cable interface.

cable upstream hopping blind Disengages the advanced spectrum management features of the
Cisco uBR-MC16S and Cisco uBR-MC5X20S cable interface line
cards by enabling blind frequency hopping behavior.

show controllers cable Displays information about the cable interface, including the
upstream center frequency.

Cisco CMTS Cable Command Reference

722
 Cable Commands: cable s
cable spectrum-group (interface)

cable spectrum-group (interface)

To assign a default spectrum group to all of the upstreams on a cable interface, use the cable spectrum-group
command in interface configuration mode. To remove the spectrum groups from the upstreams, use the no
form of this command.

cable spectrum-group group-number

no cable spectrum-group group-number

Syntax Description group-number Specifies the spectrum group that should be used as the default group for the upstreams on
this cable interface. The valid range is from 1 to 32, or from 1 to 40, depending on the Cisco
IOS software release.

Command Default None

Command Modes
Interface configuration (config-if)

Command History Release Modification

11.3 NA This command was introduced.

12.2(15)BC2 The maximum number of spectrum groups was increased from 32 to 40 groups per router.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command assigns a default spectrum group to all of the upstreams on the cable interface. All upstreams
on the interface use this spectrum group unless you override this configuration, using one of the following
commands:
• To assign a different spectrum group to a particular upstream, use the cable upstream spectrum-group
command.
• To assign a new frequency to a particular upstream, use the cable upstream frequency command.
These two commands override the cable spectrum-group command for the particular upstreams to which
they are applied. The remaining upstreams in the interface, however, continue to use the default configuration
that is specified by the cable spectrum-group command.

Tip You must first create and configure the spectrum groups before you can assign them to an interface. To create
and configure spectrum groups, use the set of cable spectrum-group commands that are available in global
configuration mode.

Examples The following example shows how to assign spectrum group 1 to all of the upstreams on the cable
interface in slot 3/0:

Router(config)# interface cable 3/0

Cisco CMTS Cable Command Reference

723
 Cable Commands: cable s
cable spectrum-group (interface)

Router(config-if)# cable spectrum-group 1

Router(config-if)# exit

Router(config)#

Related Commands Command Description

cable modulation-profile Configures preset modulation profiles that you can apply to one
or more upstream cable interfaces when you identify and configure
spectrum groups.

cable spectrum-group (global Creates and configures a spectrum group.

configuration)

cable spectrum-group hop period Sets the minimum frequency-hop interval for a cable spectrum
group.

cable spectrum-group hop threshold Specifies a hop threshold for a cable spectrum group.

cable spectrum-group shared Specifies the upstream ports in a spectrum group can share the
same upstream frequency.

cable upstream hopping blind Disengages the advanced spectrum management features of the
Cisco uBR-MC16S and Cisco uBR-MC5X20S cable interface line
cards by enabling blind frequency hopping behavior.

cable upstream spectrum-group Assigns a spectrum group to an individual upstream on a cable

interface line card.

Cisco CMTS Cable Command Reference

724
 Cable Commands: cable s
cable spectrum-group hop period

cable spectrum-group hop period

To change the minimum time between frequency hops, use the cable spectrum-group hop period command
in global configuration mode. To reset the frequency hop interval for this spectrum group to its default value,
use the no form of this command.

cable spectrum-group groupnum hop period seconds

no cable spectrum-group groupnum hop period

Syntax Description groupnum Spectrum group number. Valid values are from 1 to 32, or from 1 to 40, depending on the Cisco
IOS software release.

seconds Specifies the frequency-hop time period in seconds. Valid values are from 1 to 3600 seconds
(before Cisco IOS Release 12.2(8)BC1), or from 1 to 300 seconds (Cisco IOS Release 12.2(8)BC1
or later).
For Cisco cBR Series Converged Broadband Routers, the valid values are from 5 to 300.

Command Default Before Cisco IOS Release 12.2(15)BC1: 25 seconds

Cisco IOS Release 12.2(15)BC1 and later releases: 20 seconds when N+1 HCCP redundancy is not configured,
and 15 seconds when N+1 HCCP redundancy is configured on the cable interface

Command Modes
Global configuration (config)

Command History Release Modification

12.1 T This command was introduced.

12.1(7)CX1 The default hop period was changed from 300 seconds to 25 seconds to accommodate
the new spectrum management features for the Cisco uBR-MC16S spectrum management
card.

12.2(8)BC1 The maximum frequency-hop time period was changed from 3600 to 300 seconds.

12.2(15)BC1 The default hop period was changed from 25 seconds to 20 seconds when N+1 HCCP
redundancy is not configured on the cable interface, and changed to 15 seconds when N+1
HCCP redundancy is configured.

12.2(15)BC2 The maximum number of spectrum groups was increased from 32 to 40 groups per router.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable spectrum-group hop period command defines the minimum amount of time that must pass between
upstream frequency hops. If ingress noise becomes excessive on a particular upstream, you can set this time
period to a smaller value, so as to allow frequency hopping to continue more rapidly until a clear channel is
found. Conversely, if the problem appears to be a transient condition, such as a defective CM generating a

Cisco CMTS Cable Command Reference

725
 Cable Commands: cable s
cable spectrum-group hop period

large volume of errored packets, this time period can be increased to a larger value, so as to avoid excessive
frequency hopping by allowing more time between frequency hops.
On the Cisco uBR-MC1xC cards, the maximum recommended hop period is 20 seconds. On the Cisco
uBR-MC16S and Cisco uBR-MC5X20S/U cards, the minimum recommended hop period is 25 seconds and
the maximum recommended hop period is 35 seconds.
In Cisco IOS Release 12.2(15)BC2, the Cisco CMTS adaptively increases the hop period from the user-defined
value to the maximum value (300 seconds) whenever an upstream does not currently have any CMs ranging
on it, so as to avoid unnecessary frequency hopping. The user-defined value is restored when a CM starts
ranging on the upstream.

Note The hop period should be set to at least 25 seconds on the Cisco uBR-MC16S and Cisco uBR-MC5X20S/U
cards so that transient network problems that are unrelated to ingress noise do not generate unnecessary
frequency hops.

Examples The following example shows how to change the minimum frequency-hop interval to 60 seconds.
This means that frequency hops for this spectrum group cannot occur more quickly than once every
60 seconds, even if other characteristics, such as exceeding the CNR or FEC threshold values, would
normally trigger the hop.

Router# configure terminal

Router(config)# cable spectrum-group 1 hop period 60

Router(config)#

Related Commands Command Description

cable modulation-profile Creates a cable modulation profile.

cable spectrum-group hop threshold Specifies a hop threshold for a cable spectrum group.

cable upstream channel-width Configures an upstream for a range of allowable channel widths.

cable upstream modulation-profile Configures an upstream for one modulation profile (static profile)
or two modulation profiles (Dynamic Upstream Modulation).

show cable hop Displays the current hop period and threshold for an upstream, along
with other statistics.

Cisco CMTS Cable Command Reference

726
 Cable Commands: cable s
cable spectrum-group hop threshold

cable spectrum-group hop threshold

To specify a frequency hop threshold for a spectrum group, use the cable spectrum-group hop threshold
command in global configuration mode. To delete the hop threshold for this spectrum group, use the no form
of this command.

cable spectrum-group groupnum hop threshold [percent]

no cable spectrum-group groupnum hop threshold

Syntax Description groupnum Spectrum group number. Valid values are from 1 to 32, or from 1 to 40, depending on the Cisco
IOS software release.

percent (Optional) Specifies the frequency hop threshold as a percentage of station maintenance messages
that are lost. Valid range is from 1 to 100 percent.

Command Default 20 percent

Command Modes
Global configuration (config)

Command History Release Modification

12.1 T This command was introduced.

12.1(7)CX1 The default hop threshold was changed from 100 percent to 20 percent to accommodate
the new spectrum management features for the Cisco uBR-MC16S spectrum management
card.

12.2(4)BC1 Support for this command was added to the Release 12.2 BC train.

12.2(15)BC2 The maximum number of spectrum groups was increased from 32 to 40 groups per router.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The Cisco CMTS sends a station maintenance message to each CM at least once every 25 to 30 seconds. If a
CM does not respond to a station maintenance message within that time period, the CMTS then resends station
maintenance messages at a faster rate (typically one second apart) in an attempt to restore connectivity with
the CM.
Station maintenance messages can be lost because CMs have lost connectivity with the CMTS, or because
ingress noise and other factors are causing dropped and errored packets. Downstream noise can also affect
the delivery of station maintenance messages. When a user-configurable percentage of station maintenance
messages are lost, the CMTS hops to a new upstream frequency to improve connectivity and sends out an
Upstream Channel Descriptor (UCD) update to the CMs to inform them of the change.
The optimal hop threshold value depends on several factors, including the quality of the upstream return path
and the number of CMs on the upstream. In addition, the hop threshold works together with the hop period
so that transient network problems do not generate an unnecessary number of frequency hops. Ideally, the

Cisco CMTS Cable Command Reference

727
 Cable Commands: cable s
cable spectrum-group hop threshold

hop threshold should be set low enough so that the frequency hop can occur before a significant number of
CMs go offline, but not so low that it generates frequency hops that are not needed.
For example, if the hop threshold is at its default of 20 percent and an upstream has 100 active CMs, a power
outage that affected 20 CMs would usually cause a frequency hop since this is a 20 percent loss of CMs,
which in turn would be responsible for at least 20 percent loss of station maintenance messages. But in this
situation, the frequency hop would be unneeded because changing the upstream frequency could not correct
the original problem (the power outage). If this were a common situation on this upstream, the network
administrator might increase the hop threshold so that the repeated power outages would not generate unneeded
frequency hops.
If, on the other hand, the power outage affected only 10 CMs, a frequency hop would not occur unless another
factor, such as ingress noise, created a sufficient loss of station maintenance messages to reach the 20 percent
threshold. In this situation, the default threshold of 20 percent might be sufficient.
Downstream problems can also generate frequency hops. For example, if 20 CMs were on a particularly noisy
downstream, over time they could miss a sufficient number of station maintenance messages to generate a
frequency hop. The network administrator could increase the hop threshold to limit the possibility of frequency
hops due to downstream impairments.
Also, faulty CMs could generate a frequency hop under certain conditions. For example, if a number of faulty
CMs generated a large number of uncorrectable forward error correction (FEC) errors or otherwise missed
50 to 60 percent of their station maintenance messages, without actually going offline, over time they could
miss a sufficient number of station maintenance messages to cause a frequency hop or modulation change.
The network administrator could increase the hop threshold to prevent the CMTS from generating a frequency
hop or modulation change for problems such as these, which are unrelated to actual noise on the upstream.

Note If a previous frequency hop had already occurred within the user-configurable hop period, the CMTS will not
immediately frequency hop. Instead, the CMTS would wait until the hop period expires, and if the percentage
of station maintenance messages still exceeds the hop threshold, the CMTS would perform another frequency
hop.

Tip When an upstream has 25 or fewer CMs (which is typical with lab and test environments), the CMTS increases
the rate at which it sends station maintenance messages to the CMs. This higher polling rate, along with the
small number of CMs, means that frequency hopping can occur more quickly than with a normally loaded
upstream, especially when a small number of CMs are powered down or generate noisy traffic.

Note The DOCSIS specification states that when a CM misses 16 sequential station maintenance messages, the
CMTS should consider the CM offline and should stop sending station maintenance messages to that CM.
The CM must then reregister with the CMTS to resume connectivity.

Examples The following example shows how to set the threshold that triggers frequency hop to 25 percent of
station maintenance messages on the upstream that is assigned to spectrum-group 4:

Router# configure terminal

Cisco CMTS Cable Command Reference

728
 Cable Commands: cable s
cable spectrum-group hop threshold

Router(config)# cable spectrum-group 4 hop threshold 25

Router(config)#

Related Commands Command Description

cable modulation-profile Creates a cable modulation profile.

cable spectrum-group hop period Sets the minimum frequency-hop interval for a cable spectrum group.

cable upstream channel-width Configures an upstream for a range of allowable channel widths.

cable upstream modulation-profile Configures an upstream for one modulation profile (static profile) or
two modulation profiles (Dynamic Upstream Modulation).

show cable hop Displays the current hop period and threshold for an upstream, along
with other statistics.

Cisco CMTS Cable Command Reference

729
 Cable Commands: cable s
cable spectrum-group shared

cable spectrum-group shared

Note Effective with Cisco IOS Release 12.2(33)SCG, the cable spectrum-group shared command is not available
in Cisco IOS software.

To specify that the upstream ports in a spectrum group share the same upstream frequency, use the cable
spectrum-group shared command in global configuration mode. To delete this specification, use the no
form of this command.

cable spectrum-group groupnum shared

no cable spectrum-group groupnum shared

Syntax Description groupnum Spectrum group number. Valid values are from 1 to 32, or from 1 to 40, depending on the Cisco
IOS software release.

Command Default Upstream port frequency is the same for all ports in the spectrum group.

Command Modes
Global configuration (config)

Command History Release Modification

12.1 T This command was introduced.

12.2(11)BC3 Support was added for this command on the Cisco uBR-LCP2-MC16S card on the Cisco
uBR10012 router.

12.2(15)BC2 The maximum number of spectrum groups was increased from 32 to 40 groups per router.

12.2(33)SCG This command was removed.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines Because this command forces upstream ports to use the same spectrum, you must ensure that you do not
configure spectrum groups that have overlapping frequencies. To use shared spectrum groups, each group
must be using a discrete set of frequencies.

Caution Depending on the frequencies being used, and how cable modems are distributed across those frequencies
and among spectrum groups, switching from a group from shared to non-shared, or from non-shared to shared,
could cause CMs in the spectrum group to go offline and begin reranging procedures. You should therefore
use this command only during regularly schedule maintenance times, so that a minimum number of online
customers are affected.

Cisco CMTS Cable Command Reference

730
 Cable Commands: cable s
cable spectrum-group shared

Note This command does not enable any sort of load balancing on the shared upstreams.

Examples The following example shows how to specify that all the upstream ports for spectrum group 4 share
the same upstream frequency, and that these upstream frequencies are not assigned to other upstream
interfaces:

Router(config)# cable spectrum-group 4 shared

Router(config)#

Related Commands Command Description

cable modulation-profile Configures preset modulation profiles that you can apply to one or
more upstream cable interfaces when you identify and configure
spectrum groups.

cable spectrum-group (global Creates a spectrum group of one or more frequencies for an
configuration) upstream.

cable spectrum-group hop period Sets the minimum frequency-hop interval for a cable spectrum
group.

cable spectrum-group hop threshold Specifies a hop threshold for a cable spectrum group.

cable upstream hopping blind Disengages the advanced spectrum management features of the
Cisco uBR-MC16S and Cisco uBR-MC5X20S cable interface line
cards by enabling blind frequency hopping behavior.

show controllers cable Displays information about the cable interface, including the
upstream center frequency.

Cisco CMTS Cable Command Reference

731
 Cable Commands: cable s
cable submgmt default

cable submgmt default

To set the default values for attributes in the Subscriber Management MIB (DOCS-SUBMGT-MIB), and to
enable Cisco Static CPE Override on the Cisco CMTS, use the cable submgmt default global configuration
command. To restore the original defaults, use the no form of this command.

cable submgmt default [active | learnable | max-cpe cpe-num | max-ipv6-cpecpe-num]

no cable submgmt default [active | learnable | max-cpe cpe-num | max-ipv6-cpecpe-num]
cable submgmt default filter-group {cm | cpe | mta | stb | ps} {downstream | upstream} group-id
no cable submgmt default filter-group {cm | cpe | mta | stb | ps} {downstream | upstream} group-id

Cisco cBR Series Converged Broadband Routers

cable submgmt default [active | filter-group | {cm | cpe | mta | stb | ps} | {downstream | upstream}
group-id | learnable | max-cpe cpe-num | max-ipv6-cpecpe-num]
no cable submgmt default [active | filter-group | {cm | cpe | mta | stb | ps} | {downstream | upstream}
| learnable | max-cpe | max-ipv6-cpe]

Syntax Description no When used with the active and learnable options, the no form of the command sets the
default attributes to false. When used with the max-cpe, max-ipv6-cpe and filter-group
options, the no form of the command sets the attribute to 0.

active (Optional) Sets the docsSubMgtCpeActiveDefault attribute, which controls whether the
CMTS manages the CPE devices for a particular CM—when set to TRUE, the CMTS
enforces the MAX-CPE value and the implemented filters. The no cable submgmt
default active command sets the default value to FALSE (the original default), which
turns off CPE management at the CMTS.

learnable (Optional) Sets the docsSubMgtCpeLearnableDefault attribute, which controls whether

the CMTS learns the CPE IP addresses for a particular CM—when set to TRUE (the
original default), the CMTS learns IP addresses up to the MAX-CPE value. The no cable
submgmt default learnable command sets the default value to FALSE, which means
that the IP address for each allowable CPE device must be specified in the DOCSIS
configuration file.

max-cpe (Optional) Sets the docsSubMgtCpeMaxIpDefault attribute, which specifies the default
cpe-num number of simultaneous IP addresses (CPE devices) permitted for the CM. The possible
range is 0 to 1024, where 0 specifies that all CPE traffic from the CM is dropped. The
default is 16.

filter-group Specifies a filter group, which can be applied to either upstream or downstream traffic
for either a CM or its CPE devices.

cm Specifies that the filter group applies to traffic to or from a CM.

cpe Specifies that the filter group applies to traffic to or from a CPE device.

mta Specifies that the filter group applies to traffic to or from a multimedia terminal adaptor
(mta.)

stb Specifies that the filter group applies to traffic to or from a Set-Top Box (stb.)

Cisco CMTS Cable Command Reference

732
 Cable Commands: cable s
cable submgmt default

ps Specifies that the filter group applies to traffic to or from a portal server (ps.)

downstream Specifies that the filter group applies to the downstream traffic that is going to the specified
CM or CPE device.

upstream Specifies that the filter group applies to the upstream traffic that is coming from the
specified CM or CPE device.

group-id Specifies the filter group ID (0 to 254) to be applied for the CM or CPE, downstream or
upstream filter. This ID references the filter indexes that are used for rows in the
docsSubMgtPktFilterTable. A value of 0 indicates that no filtering is used for this particular
type of traffic.

Command Default The Subscriber Management MIB defaults to the following default values:
• The active parameter defaults to FALSE (the CMTS does not actively manage CPE devices).
• The learnable parameter defaults to TRUE (the CMTS learns the IP addresses for CPE devices).
• The max-cpe parameter defaults to 16 IP addresses.
• The filter group ID for each type of filter group defaults to 0, which means that no filtering is done on
that type of traffic.

Command Modes
Global configuration (config)

Command History Release Modification

12.1(7)CX1 This command was introduced.

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

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

12.2(33)SCB This command was updated to support MTA, STB, and portal server.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The max-ipv6-cpe keyword was added.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command enables field technicians to add a temporary CPE device behind the subscriber’s cable modem.
The temporary CPE device shares the same SID settings as the original CPE device, even though the temporary
CPE device has a different MAC address. The original CPE device automatically changes from dhcp cpe to
static cpe in the CMTS host routing tables, and the CPE device continues to receive service with the same
SID.
To disable Cisco CMTS Static CPE Override on the Cisco CMTS, use the no form of this command. This
automatically updates the routing tables and enables the MAC address from the technician’s laptop for a future
field service connection at a different location.Prior to using this command, the first (existing) DHCP CPE
device maintains its DHCP dynamic MAC address behind the cable modem. The SID is assigned to this IP
address.

Cisco CMTS Cable Command Reference

733
 Cable Commands: cable s
cable submgmt default

However, by enabling Static CPE override, you gain the following states and options on two CPE devices
behind the cable modem.
• The SID definition on the first CPE device is assigned a different static IP address. This enables you to
change the existing (dynamic) DHCP IP address to a static IP address without first clearing the DHCP
CPE host entries from the Cisco CMTS. The CPE IP state changes from dhcp to static cpe.
• This static override allows a second CPE device with a second MAC address behind the same cable
modem with SID1 to be assigned same IP address as the first CPE device.

Note The second CPE device changes from dhcp cpe to static cpe in the CMTS host tables.

The DOCSIS 1.1 Subscriber Management MIB (DOCS-SUBMGT-MIB) creates and maintains a number of
tables that describe the state of subscriber management for the CMs and CPE devices being serviced by the
Cisco CMTS. The CMTS creates rows in these tables for each CM and CPE device when the CM registers
with the CMTS, and if the CM does not specify a value for an attribute in this table, the CMTS uses the
defaults specified by the cable submgmt default command.

Timesaver The DOCS-SUBMGT-MIB MIB contains its own default values for these attributes, and those defaults can
be overridden by giving the appropriate SNMP SET commands. The cable submgmt default command,
however, allows the new defaults to be included in the Cisco IOS configuration file so that the defaults are
automatically reconfigured whenever the CMTS reboots or reloads.

Note The cable submgmt default command sets only the default value for these attributes. These default values
are used only if the CM does not specify other values when it registers with the CMTS. If the CM does specify
different values at registration time, those values are used instead of these default values.

The attributes in DOCS-SUBMGT-MIB control how the CMTS manages the CPE devices behind a CM and
the filters that are applied to the traffic to and from a particular CM and its CPE devices. The following sections
describe the relationship between the different forms of the cable submgmt default commands and the
attributes in DOCS-SUBMGT-MIB.
CPE Management
The first form of the cable submgmt default command controls the default values for the entries in the
docsSubMgtCpeControlTable, which controls how the CMTS manages the CPE devices for each CM:
cable submgmt default active
Sets the docsSubMgtCpeActiveDefault attribute, which is the default value for the
docsSubMgtCpeControlActive attribute in docsSubMgtCpeControlTable. This attribute controls whether the
CMTS performs CPE management for a particular CM.
• The cable submgmt default active command sets the default to TRUE, which specifies that the CMTS
is to manage CPE devices by enforcing the MAX-CPE number and the implemented filters.
• The no cable submgmt default active command sets the default to FALSE (the default value), which
specifies that the CMTS is not to perform CPE management for the particular CM.
cable submgmt default learnable

Cisco CMTS Cable Command Reference

734
Cable Commands: cable s
cable submgmt default

Sets the docsSubMgtCpeLearnableDefault attribute, which is the default value for the
docsSubMgtCpeControlLearnable attribute in docsSubMgtCpeControlTable. This attribute controls whether
the CMTS learns the IP addresses for CPE devices behind a particular CM.
• The cable submgmt default learnable command sets the default to TRUE (the default value), which
specifies that the CMTS is to learn the IP addresses for the CPE devices behind the CM, up to the value
specified by the MAX-CPE parameter. The CMTS learns the IP addresses by monitoring the traffic sent
by the CPE devices, and the first CPE devices to transmit traffic are the first CPE devices to be learned.
• The no cable submgmt default learnable command sets the default to FALSE, which specifies that the
CMTS does not learn the IP addresses for the CPE devices behind a particular CM. Instead, the IP
addresses for each CM that is to be allowed access must be specified in the DOCSIS configuration file.
cable submgmt default max-cpe cpe-num
Sets the docsSubMgtCpeMaxIpDefault attribute, which specifies the default value for the
docsSubMgtCpeControlMaxCpeIp attribute in docsSubMgtCpeControlTable. This attribute specifies the
maximum number of IP addresses that can transmit traffic through a particular CM. The possible range is 0
to 1024, and the original default is 16.

Note The MAX-CPE attribute is used only when the CMTS is actively managing CPE devices for the CM.

Filter Group Management

The second form of the cable submgmt default command controls the default values for the entries in the
docsSubMgtCmFilterTable, which assigns the CM to one or more filter groups. A filter group specifies what
filters are applied to the traffic going to or coming from each particular CM or CPE device. Filter groups can
be numbered 0 to 1024, where 0 specifies that no filtering is done for that particular traffic type.

Note The actual filters specified in these commands must be created by setting the appropriate attributes in the
DOCS-SUBMGT-MIB MIB using SNMP SET commands.

cable submgmt default filter-group cpe downstream group-id

Sets the ocsSubMgtSubFilterDownDefault attribute, which is the default value for the
docsSubMgtSubFilterDownstream attribute in the docsSubMgtCmFilterTable. This attribute applies to
downstream traffic that is sent to the CPE devices behind a particular CM.
cable submgmt default filter-group cpe upstream group-id
Sets the docsSubMgtSubFilterUpDefault attribute, which is the default value for the
docsSubMgtSubFilterUpstream attribute in the docsSubMgtCmFilterTable. This attribute applies to upstream
traffic that is sent by the CPE devices behind a particular CM.
cable submgmt default filter-group cm downstream group-id
Sets the docsSubMgtCmFilterDownDefault attribute, which is the default value for the
docsSubMgtCmFilterDownstream attribute in the docsSubMgtCmFilterTable. This attribute applies to
downstream traffic that is addressed to a particular CM.
cable submgmt default filter-group cm upstream group-id

Cisco CMTS Cable Command Reference

735
 Cable Commands: cable s
cable submgmt default

Sets the docsSubMgtCmFilterUpDefault attribute, which is the default value for the
docsSubMgtCmFilterUpstream attribute in the docsSubMgtCmFilterTable. This attribute applies to upstream
traffic that is sent by a particular CM.

Note For more information about using static CPE override, see the Cisco CMTS Static CPE Override feature on
Cisco.com.

Examples The following commands specify that the CMTS defaults to actively managing the CPE devices for
each CM that registers, allowing and learning up to four IP addresses for the CPE devices behind
that CM. The cable submgmt default max-cpe command specifies the number of IPv6 addresses
permitted behind a CM which includes all IPv6 addresses of all the CPE's.

Router# configure terminal

Router(config)# cable submgmt default active

Router(config)# cable submgmt default learnable

Router(config)# cable submgmt default max-cpe 4

The following commands specify that the CMTS defaults to actively managing the CPE devices for
each CM that registers. Each CM, however, must specify its own MAX-CPE value; otherwise, that
value defaults to 0 and all traffic to and from the CPE devices for that CM is blocked.

Router# configure terminal

Router(config)# cable submgmt default active

Router(config)# cable submgmt default max-cpe 0

The following commands specify that the CMTS defaults to not actively managing the CPE devices
for each CM that registers. However, if the CM at registration time indicates that the CMTS is to
actively manage the CPE devices, the CMTS defaults to allowing only one CPE device. Learning
also is disabled, so that one CPE device, therefore, must be specified in the DOCSIS configuration
file that the CM uses to register.

Router# configure terminal

Router(config)# no cable submgmt default active

Router(config)# no cable submgmt default learnable

Router(config)# cable submgmt default max-cpe 1

The following commands specify that the CMTS defaults to assigning three filter groups to each CM
that registers. Unless the CM indicates otherwise at registration time, downstream and upstream
traffic for the CPE devices behind the CM is filtered according to the rules for filter groups 20 and
21, respectively. Filter group 1 is applied to the downstream traffic addressed to the CM. Upstream
traffic sent by the CM, however, is not filtered.

Router# configure terminal

Router(config)# cable submgmt default filter-group cpe downstream 20

Cisco CMTS Cable Command Reference

736
 Cable Commands: cable s
cable submgmt default

Router(config)# cable submgmt default filter-group cpe upstream 21

Router(config)# cable submgmt default filter-group cm downstream 1
Router(config)# cable submgmt default filter-group cm upstream 0

Note The above example assumes that filter groups 1, 20, and 21 have already been created on the CMTS
using the appropriate SNMP commands.

Related Commands Command Description

cable filter group Creates a DOCSIS 1.1 filter group that filters packets on the basis of the TCP/IP and
UDP/IP headers.

Cisco CMTS Cable Command Reference

737
 Cable Commands: cable s
cable sync-interval

cable sync-interval
To specify the interval between successive sync message transmissions from the Cisco CMTS, use the cable
sync-interval command in cable interface configuration mode. To return the sync message interval to its
default value, use the no form of this command.

cable sync-interval msec

no cable sync-interval

Syntax Description msec Specifies the interval in milliseconds (ms) between successive sync message transmissions from the
Cisco CMTS. Valid values are from 1 to 200 ms. Default value is 10 ms.

Command Default 10 ms

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

11.3 NA This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines To verify whether or not a sync message interval has been configured, enter the show running-config command
and look for the cable interface configuration information. If a sync message interval has been configured, it
appears in this output. If the sync message interval has been deactivated or reset to its default value, no sync
interval command line appears in the output.

Examples The following example shows how to specify the interval for the sync message transmissions to 100
ms:

Router (config-if)# cable sync-interval 20

Cisco CMTS Cable Command Reference

738
Cable Commands: cable t
• cable tag, on page 740
• cable telco-return enable, on page 743
• cable telco-return interval, on page 745
• cable telco-return registration-ip, on page 747
• cable telco-return spd dhcp-authenticate, on page 749
• cable telco-return spd dhcp-server, on page 751
• cable telco-return spd dial-timer, on page 753
• cable telco-return spd factory-default, on page 755
• cable telco-return spd manual-dial, on page 757
• cable telco-return spd password, on page 759
• cable telco-return spd phonenum, on page 761
• cable telco-return spd ppp-authenticate, on page 763
• cable telco-return spd radius-realm, on page 765
• cable telco-return spd service-provider, on page 767
• cable telco-return spd threshold, on page 769
• cable telco-return spd username, on page 771
• cable tftp-enforce, on page 773
• cable throttle-modem, on page 778
• cable throttle-ranging, on page 780
• cable time-server, on page 781
• cable toaster-shrink , on page 782
• cable toaster-voltage-adjust , on page 783
• cable trust, on page 784
• cable trust-last, on page 786
• cable tx-power-headroom, on page 787

Cisco CMTS Cable Command Reference

739
 Cable Commands: cable t
cable tag

cable tag
To configure a tag for a DOCSIS load balancing group on the CMTS, use the cable tag command in the global
configuration mode. To delete the tag and remove it from the CMTS configuration, use the no form of this
command.

cable tag 1-1000

no cable tag 1-1000

Syntax Description 1-1000 Specifies a cable tag number.

Command Default None.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

12.2(33)SCH This command was modified. The tag to exclude TLV type was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable tag command creates a tag with the specified number and then enters the CMTS-tag configuration
mode. Use the following commands in the CMTS-tag configuration mode to configure the tag:
• docsis-version
• exclude
• exit
• name
• oui
• override
• service-class
• service-type-id
• tlv
General tagging is used by Cisco CMTS as follows:
• The Cisco CMTS can classify some modems with user-defined modem classifiers using the STID, service
class name, DOCSIS version and capability TLVs and MAC Organization Unique Identifier (OUI).
• Each modem classifier has a unique tag. The Cisco CMTS allows each modem to carry one tag. When
multiple tags match one cable modem, the tag that has the least index gets applied on the CM.
• The Cisco CMTS classifies a CM and assigns a tag, and if a RLBG with that tag is configured, the CM
gets assigned to that RLBG.
• The Cisco CMTS can match multiple tags to a RLBG and a DOCSIS policy.

Cisco CMTS Cable Command Reference

740
 Cable Commands: cable t
cable tag

Note • Try to match tag with upstream service flow prior to downstream service flow.
• Only match service class name of the first upstream/downstream service flow.

Examples The following example shows how to create a tag numbered as “1' following which the system enters
the cmts-tag configuration mode:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable tag 1
Router(config-cmts-tag)# name CSCO
Router(config-cmts-tag)# service-type-id commercial
Router(config-cmts-tag)# service-class work
Router(config-cmts-tag)# docsis-version docsis20
Router(config-cmts-tag)# oui 00.1a.c3
Router(config-cmts-tag)# override

The following example shows how to configure the tag to exclude a DOCSIS version, a MAC address,
a service class name, or a service type ID.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable tag 1
Router(config-cmts-tag)# exclude docsis-version docsis10
Router(config-cmts-tag)# exclude oui 00.1a.c3
Router(config-cmts-tag)# exclude service-class work
Router(config-cmts-tag)# exclude service-type-id commercial

In Cisco IOS Release 12.2(33)SCH, TLV type was introduced. The following example shows how
to configure the tag to exclude the TLV type:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable tag 1
Router(config-cmts-tag)# exclude tlv mrcs 4

Related Commands Command Description

docsis-version Configures the specified DOCSIS version of the cable modem (CM) for the tag.

exclude Configures the tag to exclude a DOCSIS version, a MAC address, a service class name, or
a service type ID.

name Specifies the name of the tag.

oui Configures the specified Organization Unique Identifier (OUI) of the CM for the tag.

override Overrides type/length/value (TLV) or Simple Network Management Protocol (SNMP)

settings when assigning the restricted load balancing group (RLBG) to CMs.

service-class Configures the specified service class name for the tag.

Cisco CMTS Cable Command Reference

741
 Cable Commands: cable t
cable tag

Command Description

service-type-id Configures the specified service type ID for the tag.

tag Associates the cable modem tag with a RLBG.

tlv Configures a TLV type matching rule.

Cisco CMTS Cable Command Reference

742
 Cable Commands: cable t
cable telco-return enable

cable telco-return enable

To enable telco-return support, use the cable telco-return enable command in cable interface configuration
mode. To disable this feature, use the no form of this command.

telco-return enable
no cable telco-return enable

Syntax Description This command has no arguments or keywords.

Command Default Telco-return support is disabled.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to enable telco-return:

Router(config-if)# cable telco-return enable

Note This command is available only in images that support telco-return. These images have a “t” as part
of the image name.

Related Commands Command Description

cable telco-return interval Defines the interval for sending Telephony Channel Descriptor
(TCD) and Termination System Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd Indicates that telco-return CMs must use a specific DHCP server.
dhcp-authenticate

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the service provider descriptor (SPD) that the telco-return
CM uses during the initialization process.

Cisco CMTS Cable Command Reference

743
 Cable Commands: cable t
cable telco-return enable

Command Description

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD message.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur before
the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

744
 Cable Commands: cable t
cable telco-return interval

cable telco-return interval

To set the interval for sending Telephony Channel Descriptor (TCD) and Termination System Information
(TSI) messages, use the cable telco-return intervalcommand in cable interface configuration mode. To
restore the default value, use the no form of this command.

cable telco-return interval seconds

no cable telco-return interval

Syntax Description seconds Number of seconds between intervals for sending TCD and TSI messages. The valid range is from
2 to 60.

Command Default 2 seconds

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to set the TCD and TSI message interval to 40 seconds:

Router(config-if)# cable telco-return interval 40

Note This command is available only in images that support telco-return. These images have a “t” as part
of the image name.

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

Cisco CMTS Cable Command Reference

745
 Cable Commands: cable t
cable telco-return interval

Command Description

cable telco-return spd factory-default Indicates the service provider descriptor (SPD) that the
telco-return CM uses during the initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

746
 Cable Commands: cable t
cable telco-return registration-ip

cable telco-return registration-ip

To select a different IP address for the telco-return CM to send its registration requests, use the cable
telco-return registration-ipcommand in cable interface configuration mode. To restore the default value,
use the no form of this command.

cable telco-return registration-ip ip-address

no cable telco-return registration-ip

Syntax Description ip-address Registration IP address that is sent in Termination System Information (TSI) messages. Value
is any of the cable interface’s IP addresses.

Command Default The downstream channel IP address of the Cisco CMTS is used.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.1(2)EC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Registration IP Address parameter in TSI messages. By default, the downstream
channel IP address of the Cisco CMTS is also used for the registration IP address. When this cable telco-return
registration-ip command is configured, telco-return CMs send their registration requests to this IP address
instead of to the downstream channel IP address.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows how to send the CM’s registration requests to IP address 172.16.1.1:

Router(config-if)# cable telco-return registration-ip 172.16.1.1

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending Telephony Channel Descriptor
(TCD) and TSI messages.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

Cisco CMTS Cable Command Reference

747
 Cable Commands: cable t
cable telco-return registration-ip

Command Description

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the service provider descriptor (SPD) that the
telco-return CM uses during the initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

748
 Cable Commands: cable t
cable telco-return spd dhcp-authenticate

cable telco-return spd dhcp-authenticate

To require the telco-return CM to use a specific Dynamic Host Configuration Protocol (DHCP) server, use
the cable telco-return spd dhcp-authenticate command in cable interface configuration mode. To restore
the default value, use the no form of this command.

cable telco-return spd spd-number dhcp-authenticate

no cable telco-return spd spd-number dhcp-authenticate

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is 1
through 5.

Command Default The CM can use any available DHCP server.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the DHCP Authenticate parameter to TRUE (1) for the specified SPD in the Telephony
Channel Descriptor (TCD) messages. It indicates that the CM must use the DHCP server that is specified with
the cable telco-return spd dhcp-server command.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example indicates that for SPD 2, CMs must use the DHCP server identified by IP
address 192.168.255.255:

Router(config-if)# cable telco-return spd 2 dhcp-authenticate

Router(config-if)# cable telco-return spd 2 dhcp-server 192.168.255.255

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

Cisco CMTS Cable Command Reference

749
 Cable Commands: cable t
cable telco-return spd dhcp-authenticate

Command Description

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

750
 Cable Commands: cable t
cable telco-return spd dhcp-server

cable telco-return spd dhcp-server

To identify the IP address of the Dynamic Host Configuration Protocol (DHCP) server that the telco-return
CM must access, use the cable telco-return spd dhcp-servercommand in cable interface configuration mode.
To restore the default value, use the no form of this command.

cable telco-return spd spd-number dhcp-server ip-address

no cable telco-return spd spd-number dhcp-server

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is 1
through 5.

ip-address IP address of the DHCP server that CMs must use.

Command Default The IP address is set to 0.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the DHCP Server parameter in the specified SPD in Telephony Channel Descriptor (TCD)
messages. Telco-return CMs use the DHCP server that is identified by this IP address if the cable telco-return
spd dhcp-authenticate command is configured. If the cable telco-return spd dhcp-authenticatecommand
is not configured, the CMs use any available DHCP server.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example indicates that for SPD 2, CMs must use the DHCP server identified by IP
address 192.168.255.255:

Router(config-if)# cable telco-return spd 2 dhcp-authenticate

Router(config-if)# cable telco-return spd 2 dhcp-server 192.168.255.255

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

Cisco CMTS Cable Command Reference

751
 Cable Commands: cable t
cable telco-return spd dhcp-server

Command Description

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

752
 Cable Commands: cable t
cable telco-return spd dial-timer

cable telco-return spd dial-timer

To set the number of seconds that a telephone connection is idle before the telco-return CM disconnects the
call, use the cable telco-return spd dial-timer command in cable interface configuration mode. To restore
the default value, use the no form of this command.

cable telco-return spd spd-number dial-timer seconds

no cable telco-return spd spd-number dial-timer

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is 1
through 5.

seconds Number of seconds that a connection is idle before the CM disconnects the call. Valid range is
0 through 4,294,967,295. The default of 0 means that the dial-timer is not used.

Command Default The dial-timer is set to 0, which means that inactive telephone connections are not disconnected.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Demand Dial Timer parameter for the specified SPD in Telephony Channel Descriptor
(TCD) messages. This enables the CM to emulate true dial-on-demand functionality by monitoring inactive
networking time and allowing it to disconnect any telephone connection that exceeds the timer.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows how to set the timer to 2 hours:

Router(config-if)# cable telco-return spd 2 dial-timer 7200

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

Cisco CMTS Cable Command Reference

753
 Cable Commands: cable t
cable telco-return spd dial-timer

Command Description

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

754
 Cable Commands: cable t
cable telco-return spd factory-default

cable telco-return spd factory-default

To indicate the service provider descriptor (SPD) that the telco-return CM uses during the initialization process,
use the cable telco-return spd factory-defaultcommand in cable interface configuration mode. To restore
the default value, use the no form of this command.

cable telco-return spd spd-number factory-default

no cable telco-return spd spd-number factory-default

Syntax Description spd-number Service provider descriptor (SPD) that contains the set of telephony attributes used by the CM
during initialization. Valid range is 1 through 5.

Command Default The Factory Default Flag in the SPD is set to 0, which means that this SPD is not used for the initialization
process.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Factory Default parameter in the specified SPD in Telephony Channel Descriptor
(TCD) messages. This determines the set of telephony attributes, as defined by the SPD, that are used for the
initialization process when the CM is powered on or is reset to its factory default.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows how to set the telco-return CM to use SPD 2 during the initialization
procedure:

Router(config-if)# cable telco-return spd 2 factory-default

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

Cisco CMTS Cable Command Reference

755
 Cable Commands: cable t
cable telco-return spd factory-default

Command Description

cable telco-return spd Indicates that telco-return CMs must use a specific Dynamic Host
dhcp-authenticate Configuration Protocol (DHCP) server.

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur before
the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

756
 Cable Commands: cable t
cable telco-return spd manual-dial

cable telco-return spd manual-dial

To enable the telco-return CM to operate in manual-dial mode, use the cable telco-return spd
manual-dialcommand in cable interface configuration mode. To restore the default value, use the no form
of this command.

cable telco-return spd spd-number manual-dial

no cable telco-return spd spd-number manual-dial

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is 1
through 5.

Command Default Manual-dial mode is disabled.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Manual Dial vendor-specific parameter in the specified SPD in Telephony Channel
Descriptor (TCD) messages.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows how to set manual-dial mode for SPD 1:

Router(config-if)# cable telco-return spd 1 manual-dial

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

Cisco CMTS Cable Command Reference

757
 Cable Commands: cable t
cable telco-return spd manual-dial

Command Description

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

758
 Cable Commands: cable t
cable telco-return spd password

cable telco-return spd password

To set the password that the telco-return CM uses for authentication when establishing a PPP connection with
the access server, use the cable telco-return spd passwordcommand in cable interface configuration mode.
To restore the default value, use the no form of this command.

cable telco-return spd spd-number password password-string

no cable telco-return spd spd-number password

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is
1 through 5.

password-string Login password that the CM uses for authentication during the initialization procedure.

Command Default No password is used.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Login Password parameter for the specified SPD in Telephony Channel Descriptor
(TCD) messages.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows how to set the password to 9JwoKd7 in service provider descriptor
2:

Router(config-if)# cable telco-return spd 2 password 9JwoKd7

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

Cisco CMTS Cable Command Reference

759
 Cable Commands: cable t
cable telco-return spd password

Command Description

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

760
 Cable Commands: cable t
cable telco-return spd phonenum

cable telco-return spd phonenum

To set the telephone numbers that the telco-return CM uses when connecting to the headend’s network access
server, use the cable telco-return spd phonenumcommand in cable interface configuration mode. To delete
previously entered telephone numbers, use the no form of this command.

cable telco-return spd spd-number phonenum dial-string

no cable telco-return spd spd-number phonenum dial-string

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is 1
through 5.

dial-string Telephone number that the CM uses to connect to the headend’s network access server.

Command Default None

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Phone Number parameters in the specified SPD in Telephony Channel Descriptor
(TCD) messages. You can repeat this command, entering as many as three telephone numbers for the CM to
use when attempting to establish a PPP connection with the network access server. The phone numbers are
mapped to the parameters Phone Number1, Phone Number2, Phone Number3 in the order in which you enter
them. The CM attempts to connect using Phone Number1 first. If it fails to connect, and its number of retries
exceeds the limit set with the cable telco-return spd threshold command, the CM dials the next number in
the list.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows how to set the primary phone number to 9255551212. If the CM fails
to connect using that number, it tries the next phone number, 9255551234:

Router(config-if)# cable telco-return spd 2 phonenum 9255551212

Router(config-if)# cable telco-return spd 2 phonenum 9255551234

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

Cisco CMTS Cable Command Reference

761
 Cable Commands: cable t
cable telco-return spd phonenum

Command Description

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

762
 Cable Commands: cable t
cable telco-return spd ppp-authenticate

cable telco-return spd ppp-authenticate

To select the authentication method used when the telco-return CM is establishing a PPP connection, use the
cable telco-return spd ppp-authenticatecommand in cable interface configuration mode. To restore the
default value, use the no form of this command.

cable telco-return spd spd-number ppp-authenticate [both | chap | pap]

no cable telco-return spd spd-number ppp-authenticate

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is 1
through 5.

both Challenge Handshake Authentication Protocol (CHAP) is used if the network access server
supports CHAP. Password Authentication Protocol (PAP) is used only if the network access
server does not support CHAP.

chap CHAP authentication is used.

pap PAP authentication is used.

Command Default The default is both; either CHAP or PAP is used depending on the methods supported by the network access
server.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the PPP Authentication parameter for the specified SPD in Telephony Channel Descriptor
(TCD) messages.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example requires the CM to perform CHAP authentication:

Router(config-if)# cable telco-return spd 2 ppp-authenticate chap

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

Cisco CMTS Cable Command Reference

763
 Cable Commands: cable t
cable telco-return spd ppp-authenticate

Command Description

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

764
 Cable Commands: cable t
cable telco-return spd radius-realm

cable telco-return spd radius-realm

To select a RADIUS server domain to use for the login response string, use the cable telco-return spd
radius-realmcommand in cable interface configuration mode. To restore the default value, use the no form
of this command.

cable telco-return spd spd-number radius-realm string

no cable telco-return spd spd-number radius-realm

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is 1
through 5.

string Alphanumeric string identifying a RADIUS server domain.

Command Default The default value is the null string.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the RADIUS Realm parameter for the specified SPD in Telephony Channel Descriptor
(TCD) messages. When this command is configured, telco-return CMs use this realm string to construct a
domain name for the login username when responding to a PPP login query.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows a login response string of “sandy@sunol”:

Router(config-if)# cable telco-return spd 3 radius-realm sunol

Router(config-if)# cable telco-return spd 3 username sandy

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

Cisco CMTS Cable Command Reference

765
 Cable Commands: cable t
cable telco-return spd radius-realm

Command Description

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

766
 Cable Commands: cable t
cable telco-return spd service-provider

cable telco-return spd service-provider

To include the service provider name in the SPD, use the cable telco-return service-providercommand in
cable interface configuration mode. To remove the parameter from the SPD, use the no form of this command.

cable telco-return spd spd-number service-provider spd-string

no cable telco-return spd spd-number service-provider

Syntax Description spd-number Service provider descriptor number for which this parameter is set. Valid range is 1 through 5.

spd-string Alphanumeric string that identifies the service provider.

Command Default None

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Service Provider Name parameter for the specified SPD in the Telephony Channel
Descriptor (TCD) messages.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows the service provider name being set to “san_jose” for SPD 2:

Router(config-if)# cable telco-return spd 2 service-provider san_jose

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd Indicates that telco-return CMs must use a specific DHCP server.
dhcp-authenticate

Cisco CMTS Cable Command Reference

767
 Cable Commands: cable t
cable telco-return spd service-provider

Command Description

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur before
the CM indicates a connection failure.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

768
 Cable Commands: cable t
cable telco-return spd threshold

cable telco-return spd threshold

To set the number of failed dial-up connections that can occur before the CM indicates a connection failure,
use the cable telco-return spd thresholdcommand in cable interface configuration mode. To restore the
default value, use the no form of this command.

cable telco-return spd spd-number threshold threshold-number

no cable telco-return spd spd-number threshold

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is
1 through 5.

threshold-number Number of dial-up attempts that fail before the CM declares a connection failure. Valid
range is 1 through 255.

Command Default The default value is 1.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Connection Threshold parameter for the specified SPD in the Telephony Channel
Descriptor (TCD) messages. A dial-up attempt is considered a connection failure if an answer connection is
not made after ten rings. The CM continues to try to connect until the connection threshold is reached. If
multiple phone numbers are configured using the cable telco-return spd phonenum command, the CM dials
each phone number until it makes a connection or exceeds the configured threshold.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows the connection threshold being set to 20:

Router(config-if)# cable telco-return spd 2 threshold 20

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

Cisco CMTS Cable Command Reference

769
 Cable Commands: cable t
cable telco-return spd threshold

Command Description

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd username Sets the username that the telco-return CM uses for authentication
when establishing a PPP connection.

Cisco CMTS Cable Command Reference

770
 Cable Commands: cable t
cable telco-return spd username

cable telco-return spd username

To set the username that the telco-return CM uses for authentication when establishing a PPP connection with
the access server, use the cable telco-return spd usernamecommand in cable interface configuration mode.
To restore the default value, use the no form of this command.

cable telco-return spd spd-number username login-string

no cable telco-return spd spd-number username login-string

Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is set. Valid range is 1
through 5.

login-string Username that the CM uses for authentication during the initialization procedure.

Command Default The default value is guest.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Login Username parameter for the specified SPD in the Telephony Channel Descriptor
(TCD) messages.

Note This command is available only in images that support telco-return. These images have a “t” as part of the
image name.

Examples The following example shows the username being set to “sandy” for SPD 3:

Router(config-if)# cable telco-return spd 3 username sandy

Related Commands Command Description

cable telco-return enable Enables telco-return functionality.

cable telco-return interval Defines the interval for sending TCD and Termination System
Information (TSI) messages.

cable telco-return registration-ip Selects a different IP address for the telco-return CM to send its
registration requests.

cable telco-return spd dhcp-authenticate Indicates that telco-return CMs must use a specific DHCP server.

Cisco CMTS Cable Command Reference

771
 Cable Commands: cable t
cable telco-return spd username

Command Description

cable telco-return spd dhcp-server Identifies the IP address of the DHCP server that the telco-return
CMs must use.

cable telco-return spd dial-timer Sets the number of seconds that a telephone connection is idle
before the telco-return CM disconnects the call.

cable telco-return spd factory-default Indicates the SPD that the telco-return CM uses during the
initialization process.

cable telco-return spd manual-dial Enables the telco-return CM to operate in manual-dial mode.

cable telco-return spd password Sets the password that the telco-return CM uses for authentication
when establishing a PPP connection.

cable telco-return spd phonenum Sets the telephone numbers that the telco-return CM dials when
connecting to the headend’s network access server.

cable telco-return spd ppp-authenticate Selects the authentication procedure to use when the telco-return
CM is establishing a PPP connection.

cable telco-return spd radius-realm Selects a RADIUS server domain to use for the login response
string.

cable telco-return spd service-provider Includes the service provider name in the SPD.

cable telco-return spd threshold Sets the number of failed dial-up connections that can occur
before the CM indicates a connection failure.

Cisco CMTS Cable Command Reference

772
 Cable Commands: cable t
cable tftp-enforce

cable tftp-enforce
To require that all CMs on a cable interface attempt to download a DOCSIS configuration file using the Trivial
File Transfer Protocol (TFTP) through the cable interface before being allowed to register and come online,
use the cable tftp-enforce command in cable interface configuration mode. To disable this feature, use the
no form of this command.

cable tftp-enforce [mark-only]

no cable tftp-enforce [mark-only]

Syntax Description mark-only (Optional) Allow CMs to come online without attempting to download a DOCSIS configuration
file through the Cisco CMTS cable interface, but prints a warning message and marks those
CMs with a pound sign (#) in the show cable modem command.

Command Default TFTP downloads through the Cisco CMTS are not required (no cable tftp-enforce).

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.1(11b)EC1 This command was introduced for the Cisco uBR7100 series and Cisco uBR7200 series
universal broadband routers.

12.1(19)EC CMs that fail the TFTP checked are now marked with a reject(c) error in the show cable
modem command, instead of the original reject(m) error, so as to be consistent with the
behavior in the Release 12.2 BC train.

12.2(8)BC2 Support for this command was added to the 12.2 BC release train for the Cisco uBR7100
series, Cisco uBR7200 series, and Cisco uBR10012 universal broadband routers.

12.2(15)BC1 The command was enhanced on the Cisco uBR10012 router to prevent the router from
rejecting cable modems that did properly download a DOCSIS configuration file.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable tftp-enforce cable interface configuration command requires all cable modems on a cable interface
to attempt a TFTP request for the DOCSIS configuration file through the cable interface with the Cisco CMTS
router before being allowed to register and come online. This can help prevent the following situations from
occurring:
• Users who attempt theft-of-service by reconfiguring their local networks to allow the downloading of
an unauthorized DOCSIS configuration file from a local TFTP server. Typically, some users do this to
obtain services that they have not paid for, such as higher guaranteed bandwidths or a higher priority
Quality of Service (QoS) profile.
• Some brands or models of cable modems might be running older software releases that cache the DOCSIS
configuration file and use the cached version instead of downloading the actual file from a TFTP server
during the registration process. Although this can marginally speed up the registration process, it also

Cisco CMTS Cable Command Reference

773
 Cable Commands: cable t
cable tftp-enforce

violates the DOCSIS requirements and could create a situation in which the cable modem is not using
the proper DOCSIS configuration file. A user might then be mistakenly accused of theft-of-service, when
in reality the problem is the non-DOCSIS-compliant cable modem.
The cable tftp-enforce command identifies these situations and can block these cable modems from registering
and coming online. This command also has a mark-only option that allows these cable modems to come
online, but it also identifies the cable modems so that the network administrators can investigate the situation
further before taking any action.
When the command is used without the mark-only option, cable modems that do not download a TFTP file
through the cable interface are blocked from registering and coming online. The following message is displayed
on the console when such a cable modem attempts to register:

06:53:57: %UBR7200-4-REGISTRATION_BEFORE_TFTP: Registration request unexpected:

Cable Modem did not attempt TFTP. Registration Rejected. CM Mac Addr <00ff.ff66.12fb>

The mark-only option allows cable modems that do not download the TFTP file to come online, but it also
prints a warning message on the console and marks the cable modem in the show cable modem command
with a pound sign (#). The following message is displayed on the console when such a cable modem registers
with the Cisco CMTS.

06:53:57: %UBR7200-4-REGISTRATION_BEFORE_TFTP: Registration request unexpected:

Cable Modem did not attempt TFTP. Modem marked with #. CM Mac Addr <00ff.ff66.12fb>

Tip Cisco recommends that you initially configure cable interfaces with the mark-only option, so that potential
problems are identified without immediately interfering with users’ ability to come online. After you identify
and resolve these initial problems, reconfigure the cable interfaces without the mark-only option to block
problem cable modems that attempt to come online without downloading a valid DOCSIS configuration file.

The default behavior is not to require the TFTP download through the cable interface with the Cisco CMTS
router. Each cable interface must be configured with this command to require the TFTP download.

Note The cable tftp-enforce command cannot be used on subinterfaces or on non-cable interfaces.

Operation on the Cisco uBR10012 Router

In Cisco IOS Release 12.2(15)BC1 and later releases, the Cisco uBR10012 router can occasionally allow a
cable modem to temporarily come online before the system has received confirmation that the cable modem
has downloaded the proper DOCSIS configuration file. This situation can occur when the cable interface line
card receives a registration request (REG-REQ) message from a cable modem before the PRE1 module has
notified the line card whether the modem did download the proper file from the TFTP server.
In previous Cisco IOS releases, these cable modems were not allowed to come online (or marked as TFTP
violators) even if they had successfully downloaded the appropriate DOCSIS configuration file. In Cisco IOS
Release 12.2(15)BC1 and later releases, however, the Cisco uBR10012 router allows these cable modems to
temporarily come online until the PRE1 module has finished determining the modem’s TFTP status. If the
system determines that the modem did not download the appropriate DOCSIS configuration file, it is then
taken offline (or marked as a TFTP violator).

Cisco CMTS Cable Command Reference

774
 Cable Commands: cable t
cable tftp-enforce

Note In the above situation, cable modems that do not download a DOCSIS configuration file are marked as “offline”
instead of “reject(c)” by the show cable modem command. The console still displays the
%UBR10000-4-REGISTRATION_BEFORE_TFTP error message, however, to allow you to identify these
cable modems as TFTP violators.

Examples The following example shows how to enforce TFTP downloads for all of the cable modems on cable
interface 3/0. These cable modems must attempt a TFTP download of the DOCSIS configuration
file through the cable interface with the Cisco CMTS. If they do not, they are not allowed to register
or come online, and they are marked as having either a registration error—reject(c)—in the show
cable modem command.

Note The initial version of this feature marked CMs that failed the TFTP check as having a Message
Integrity Check (MIC) failure—reject(m). The command was changed to show reject(c) in Cisco
IOS Release 12.2(8)BC2 and Release 12.1(19)EC.

Router# configure terminal

Router(config)# interface cable 3/0

Router(config-if)# cable tftp-enforce

Router(config-if)# exit

Router(config)#
Router# show cable modems

Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable3/0/U1 1 online(pt) 2734 0.50 5 0 10.1.1.38 00ff.fffa.0a35
Cable3/0/U0 2 online(pt) 2729 0.25 5 0 10.1.1.50 00ff.ff07.382f
Cable3/0/U0 3 init(i) 2732 0.25 2 0 10.1.1.48 00ff.ff03.307d
Cable3/0/U1 4 online(pt) 2737 0.75 5 0 10.1.1.34 00ff.ff59.4477
Cable3/0/U1 5 reject(m) 2215 0.25 2 0 10.1.1.47 00ff.ff66.12fb
Router#

Note DOCSIS-compliant cable modems that are rejected with a MIC failure go into the offline state for
a short period of time and then retry the registration process.

The debug cable registration command can be used to display additional information:

Router# debug cable interface c3/0 verbose

Router# debug cable registration CMTS registration debugging is on

Jun 6 23:27:15.859: Registration request from 00ff.ff66.12fb, SID 7 on Cable3/0/U1
Jun 6 23:27:15.859: Found a network access control parameter: Ok
Jun 6 23:27:15.859: Found a class of service block: Ok
Jun 6 23:27:15.859: Found Baseline Privacy config: Ok
Jun 6 23:27:15.859: Found Max CPE: Ok
Jun 6 23:27:15.859: Found CM MIC: Ok

Cisco CMTS Cable Command Reference

775
 Cable Commands: cable t
cable tftp-enforce

Jun 6 23:27:15.859: Found CMTS MIC: Ok

Jun 6 23:27:15.859: Found modem ip: Ok
Jun 6 23:27:15.859: Found modem capabilities: Ok
Jun 6 23:27:15.859: Finished parsing REG Request
Jun 6 23:27:15.859: Cable Modem sent Registration Request without attempting required TFTP
22:33:21 %UBR7200-4-REGISTRATION_BEFORE_TFTP: Registration request unexpected:
Cable Modem did not attempt TFTP. Registration Rejected. CM Mac Addr <00ff.ff66.12fb>
Registration failed for Cable Modem 00ff.ff66.12fb on interface Cable3/0/U0:
CoS/Sflow/Cfr/PHS failed in REG-REQ
Jun 6 23:27:15.859: REG-RSP Status : failure (2)
Jun 6 23:27:15.859: Registration Response:
Jun 6 23:27:15.859: 0x0000: C2 00 00 1B 00 00 00 50 73 4E B4 19 00 05 00 E0
Jun 6 23:27:15.859: 0x0010: 56 AC 00 09 00 00 03 01 07 00 00 02 02
Jun 6 23:27:15.859: Registration Response Transmitted

The following example of the mark-only option shows how that cable modems that do not attempt
a TFTP download through the Cisco CMTS are allowed to register and come online, but they are
marked with a pound sign (#) when using the show cable modem command.

Router# configure terminal

Router(config)# interface cable 3/0

Router(config-if)# cable tftp-enforce mark-only

Router(config-if)# exit

Router(config)#
Router# show cable modems

Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable3/0/U1 1 online(pt) 2734 0.50 5 0 10.1.1.38 00ff.fffa.0a35
Cable3/0/U0 2 online(pt) 2729 0.25 5 0 10.1.1.50 00ff.ff07.382f
Cable3/0/U0 3 init(i) 2732 0.25 2 0 10.1.1.48 00ff.ff03.307d
Cable3/0/U1 4 online(pt) 2737 0.75 5 0 10.1.1.34 00ff.ff59.4477
Cable3/0/U1 5 #online 2213 0.25 6 0 10.1.1.47 00ff.ff66.12fb
Router#

Thedebug cable registration command can be used to display additional information:

Jun 6 23:27:15.859: Registration request from 00ff.ff66.12fb, SID 7 on Cable3/0/U1

Jun 6 23:27:15.859: Found a network access control parameter: Ok
Jun 6 23:27:15.859: Found a class of service block: Ok
Jun 6 23:27:15.859: Found Baseline Privacy config: Ok
Jun 6 23:27:15.859: Found Max CPE: Ok
Jun 6 23:27:15.859: Found CM MIC: Ok
Jun 6 23:27:15.859: Found CMTS MIC: Ok
Jun 6 23:27:15.859: Found modem ip: Ok
Jun 6 23:27:15.859: Found modem capabilities: Ok
Jun 6 23:27:15.859: Finished parsing REG Request
Jun 6 23:27:15.859: Cable Modem sent Registration Request without attempting required TFTP
23:27:15: %UBR7200-4-REGISTRATION_BEFORE_TFTP: Registration request unexpected:
Cable Modem did not attempt TFTP. Modem marked with #. CM Mac Addr <00ff.ff66.12fb>
Jun 6 23:27:15.859: Sec sids obtained for all requested classes of service
Jun 6 23:27:15.859: Performing connection admission control (CAC) for each Sid
Jun 6 23:27:15.859: CAC Status for ClassID:1 is CAC_SUCCESS
Jun 6 23:27:15.859: Registration Status: ok (0)
Jun 6 23:27:15.859: Registration Response Transmitted

Cisco CMTS Cable Command Reference

776
 Cable Commands: cable t
cable tftp-enforce

Tip You can also use the show interface cable sid and show cable qos profilecommands to examine
the SID and service classes in use, to determine whether a CM has registered using unauthorized
QoS parameters.

Related Commands Command Description

cable dynamic-secret Enables the dynamic shared secret feature, so that DOCSIS configuration
files are verified with a dynamically generated shared secret.

cable shared-secondary-secret Configures one or more secondary shared-secret keys that CMs can use
to successfully process the DOCSIS configuration file and register with
the CMTS.

cable shared-secret Configures an authentication shared-secret key that CMs must use to
successfully process the DOCSIS configuration file and register with the
CMTS.

debug cable registration Displays debug messages for the CM registration process.

show cable modem Displays information for the registered and unregistered CMs.

Cisco CMTS Cable Command Reference

777
 Cable Commands: cable t
cable throttle-modem

cable throttle-modem
To enable the Cable Modem Registration Throttling feature, which improves the cable modem online speed
at initial ranging stage by reducing CPU usage, use the cable throttle-modem command in global configuration
mode. To disable this feature, use the no form of this command.

cable throttle-modem init-rate value holdoff-time value flush-rate value

no cable throttle-modem

Syntax Description init-rate value Specifies the maximum number of modems allowed to pass the initialization step per
second. The valid range is from 1 to 1000. The default value is 32.

holdoff-time value Specifies the maximum number of seconds a cable modem is allowed to wait in the
throttling queue. The valid range is from 5 to 100. The default value is 45.

flush-rate value Specifies the maximum number of modems flushed per second from the throttling queue
after the holdoff time expires. The valid range is from 100 to 1000. The default value is
300.

Command Default This command is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF3 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable throttle-modem command enables dynamic adjustment of number of cable modems in the
registration queue thus reducing CPU usage.
You must manually disable the cable throttle-ranging command (applicable only for Cisco uBR10K Series
Routers) configuration to enable the cable throttle-modem command configuration.

Examples The following example shows how to enable the Cable Modem Registration Throttling feature on a
Cisco CMTS:

Router# configure terminal

Router(config)# cable throttle-modem init-rate 1 holdoff-time 5 flush-rate 100

Related Commands Command Description

(For Cisco uBR10K Series Routers) cable Enables faster cable modem registration times.
throttle-ranging

Cisco CMTS Cable Command Reference

778
Cable Commands: cable t
cable throttle-modem

Command Description

show cable throttle-modem Displays cable throttle configuration information.

Cisco CMTS Cable Command Reference

779
 Cable Commands: cable t
cable throttle-ranging

cable throttle-ranging
To enable faster cable modem registration times, use the cable throttle-ranging command in global
configuration mode. To disable faster cable modem registration times, use the no form of this command.

cable throttle-ranging
no cable throttle-ranging

Syntax Description This command has no arguments or keywords

Command Default This command is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable throttle-ranging command enables faster cable modem registration times on the CMTS.
Reload the Cisco CMTS with a Cisco IOS Release 12.3(21)BC image and configure the cable throttle-ranging
command on the CMTS. Once the cable throttle-ranging has been configured, save the new configuration
and reload the Cisco CMTS again. Faster cable modem registration times will now be enabled on the Cisco
CMTS.

Note The cable throttle-ranging command is only available on an ubr10k CMTS.

Examples The following example shows how to enable Fast CM registration feature on a Cisco CMTS:

Router(config)# cable throttle-ranging

Cisco CMTS Cable Command Reference

780
 Cable Commands: cable t
cable time-server

cable time-server
To enable the integrated time-of-day (ToD) server on the Cisco CMTS series, enter the cable time-server
command in global configuration mode. To disable the time-of-day server function, use the no form of this
command.

cable time-server
no cable time-server

Syntax Description This command has no keywords or arguments.

Command Default The integrated time-of-day (ToD) server is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.0(4)XI This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Per the DOCSIS specifications, the ToD server uses the UDP protocol, so UDP minor servers must also be
enabled using the service udp-small-servers max-servers no-limit command.

Examples The following example shows how to enable the time-of-day server:

Router# configure terminal

Router(config)# service udp-small-servers max-servers no-limit

Router(config)# cable time-server
Router(config)#

Cisco CMTS Cable Command Reference

781
 Cable Commands: cable t
cable toaster-shrink

cable toaster-shrink
To enable turbo mode, which uses six or seven pipelines in Parallel eXpress Forwarding, use the cable
toaster-shrink command in global configuration mode. To reset to default settings, which use eight pipelines
in Parallel eXpress Forwarding, use the no form of this command.

cable toaster-shrink row-count

no cable toaster-shrink [row-count]

Syntax Description row-count Specifies the shutdown row count in toaster.

The values are:
• 1—Shutdown one pipeline and uses seven
pipelines.
• 2—Shutdown two pipelines and uses six
pipelines.

Command Default Disabled

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCJ1 This command was introduced in Cisco uBR10012 router.

Examples The following example shows how to enable turbo mode which shutdown one pipeline and uses
seven pipelines:

Router# configure terminal

Router(config)# cable toaster-shrink 1

Cisco CMTS Cable Command Reference

782
 Cable Commands: cable t
cable toaster-voltage-adjust

cable toaster-voltage-adjust
To change PRE5 toaster voltage from 1.2 V to 1.3 V for T0 to T3, and to enable high voltage margin for T4,
use the cable toaster-voltage-adjust command in global configuration mode. To reset to default settings, use
the no form of this command.

cable toaster-voltage-adjust {groupA | groupB}

no cable toaster-voltage-adjust {groupA | groupB}

Syntax Description groupA Enables the PRE5 toaster voltage from 1.2 V to 1.3 V for T0 to T3.

groupB Enables the high voltage margin for T4.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCJ1 This command was introduced in Cisco uBR10012 router.

Examples The following example shows how to change PRE5 toaster voltage from 1.2 V to 1.3 V for T0 to
T3:

Router# configure terminal

Router(config)# cable toaster-voltage-adjust groupA

Cisco CMTS Cable Command Reference

783
 Cable Commands: cable t
cable trust

cable trust
To enable packets from trusted source MAC addresses in DHCP, use the cable trust command in global
configuration mode. To remove a trusted MAC address from the MAC exclusion list, use the no form of this
command. Removing a MAC address from the exclusion list subjects all packets from that source to standard
DHCP source verification.

cable trust mac-address

no cable trust mac-address

Syntax Description mac-address The MAC address of a trusted DHCP source, and from which packets will not be subject to
standard DHCP source verification.

Command Default Disabled

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Per the DOCSIS specifications, the ToD server uses the UDP protocol, so UDP minor servers must also be
enabled using the service udp-small-servers max-servers no-limit command.
This command and capability are only supported in circumstances in which the Cable Source Verify feature
is first enabled on the Cisco CMTS.
When this feature is enabled in addition to cable source verify, a packet’s source must belong to the MAC
Exclude list on the Cisco CMTS. If the packet succeeds this exclusionary check, then the source IP address
is verified against Address Resolution Protocol (ARP) tables as per normal and previously supported source
verification checks. The service ID (SID) and the source IP address of the packet must match those in the
ARP host database on the Cisco CMTS. If the packet check succeeds, the packet is allowed to pass. Rejected
packets are discarded in either of these two checks.
Any trusted source MAC address in the optional exclusion list may be removed at any time. Removal of a
MAC address returns previously trusted packets to non-trusted status, and subjects all packets to standard
source verification checks on the Cisco CMTS.

Note When the cable source-verify dhcp feature is enabled, and a statically-defined IP address has been added to
the CMTS for a CM using the cable trust command to override the cable source-verify dhcp checks for this
device, packets from this CM will continue to be dropped until an entry for this CM is added to the ARP
database of the CMTS. To achieve this, disable the cable source-verify dhcp feature, ping the CMTS from
the CM to add an entry to the ARP database, and re-enable the cable source-verify dhcp feature.

Cisco CMTS Cable Command Reference

784
 Cable Commands: cable t
cable trust

Examples The following example shows how to configure this command:

Router# configure terminal

Router(config)# cable trust 0007.0e03.69f9
Router#

Cisco CMTS Cable Command Reference

785
 Cable Commands: cable t
cable trust-last

cable trust-last
To allow packets with source MAC addresses that match a configured trust-last MAC addresses, bypass
source-verification, use the cable trust-last command in global configuration mode. To remove a MAC
address from the trust-last list, use the no form of this command.

cable trust-last mac-address

no cable trust-last mac-address

Syntax Description mac-address The MAC address of a trust-last host.

Command Default Disabled

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE This command is introduced.

17.15.1y

Examples The following example shows how to configure this command

Router# configure terminal

Router(config)# cable trust-last 0034.0f04.69f9
Router#

Cisco CMTS Cable Command Reference

786
 Cable Commands: cable t
cable tx-power-headroom

cable tx-power-headroom
To configure cable modems with the extended transmit power capability based on the Organizational Unique
Identifier (OUI), use the cable tx-power-headroom command in global configuration mode. To disable this
configuration, use the no form of this command.

cable tx-power-headroom OUI dB-value

no cable tx-power-headroom OUI dB-value

Syntax Description OUI First 24 bits of a MAC address that is unique to the cable modem vendor.

dB-value Decibel value for the upstream channel transmit power. The valid range is from 1 to 6.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS Release 12.2(33)SCE3 This command was introduced.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines You can use the cable tx-power-headroom command for each unique OUI. You can specify either the MAC
address or the OUI value with this command. If you specify the MAC address, only its OUI value is saved.

Examples The following example shows how to configure extended transmit power on the Cisco CMTS router
in Cisco IOS Release 12.2(33)SCE3:

Router# configure terminal

Router(config)# cable tx-power-headroom 0025.2ed0.8cba 3

Related Commands Command Description

cable upstream Specifies the power budget offset value on the Cisco CMTS router
max-channel-power-off for the reduced channel set assignment.

show cable modem Displays transmit power values for each assigned upstream channel
along with cable modem details.

Cisco CMTS Cable Command Reference

787
 Cable Commands: cable t
cable tx-power-headroom

Cisco CMTS Cable Command Reference

788
Cable Commands: cable u through cable w
• Configuring Upstream Cable Interface Features on the Cisco CMTS Routerscable udc-capability, on
page 792
• cable upgrade dsphy-fw auto, on page 793
• cable upstream active-codes, on page 794
• cable upstream adjust-frequency, on page 795
• cable upstream admission-control, on page 796
• cable upstream admission-control max-reserved-bandwidth, on page 800
• cable upstream attribute-mask, on page 802
• cable upstream balance-scheduling, on page 803
• cable upstream bcast-init-ranging tcc-enc excl-timing, on page 805
• cable upstream bonding-group, on page 806
• cable upstream chan-class-id, on page 808
• cable upstream channel-width, on page 810
• cable upstream codes-per-minislot, on page 815
• cable upstream concatenation, on page 816
• cable upstream connector, on page 817
• cable upstream controller-profile, on page 821
• cable upstream data-backoff, on page 822
• cable upstream description, on page 824
• cable upstream differential-encoding, on page 825
• cable upstream docsis-mode, on page 826
• cable upstream dpon, on page 831
• cable upstream dps, on page 833
• cable upstream equalization-coefficient, on page 834
• cable upstream equalization-error-recovery, on page 837
• cable upstream ext-power, on page 839
• cable upstream fec, on page 840
• cable upstream fec-strength, on page 841
• cable upstream fragmentation, on page 842
• cable upstream fragment-force, on page 844
• cable upstream freq-adj averaging, on page 847
• cable upstream frequency, on page 848
• cable upstream hopping blind, on page 851

Cisco CMTS Cable Command Reference

789
 Cable Commands: cable u through cable w

• cable upstream hop-priority, on page 853

• cable upstream ingress-noise-cancellation, on page 855
• cable upstream jumbo-grants, on page 858
• cable upstream load-balance group, on page 859
• cable upstream maintain-psd, on page 861
• cable upstream max-channel-power-offset, on page 863
• cable upstream max-codes-per-subframe, on page 864
• cable upstream max-interleave-step, on page 865
• cable upstream max-logical-chans, on page 867
• cable upstream max-ports, on page 871
• cable upstream min-bwreq-ops, on page 873
• cable upstream minimal-voice-jitter, on page 874
• cable upstream minislot-size, on page 875
• cable upstream modulation-profile, on page 878
• cable upstream ofdma-prof-mgmt active-scs-threshold-pct, on page 884
• cable upstream ofdma-prof-mgmt downgrade, on page 885
• cable upstream ofdma-prof-mgmt exempt-mslot-pct, on page 887
• cable upstream ofdma-prof-mgmt mer-margin-qdb, on page 888
• cable upstream ofdma-prof-mgmt prof-upgrade-auto, on page 889
• cable upstream ofdma-prof-mgmt rxmer-poll-interval, on page 890
• cable upstream power-adjust, on page 891
• cable upstream power-level, on page 895
• cable upstream priority, on page 898
• cable upstream qos wfq, on page 899
• cable upstream range-backoff, on page 901
• cable upstream ranging-init-technique, on page 903
• cable upstream ranging-poll, on page 904
• cable upstream rate-adapt (global), on page 906
• cable upstream rate-adapt (interface), on page 907
• cable upstream rate-limit, on page 909
• cable upstream rate-limit-bwreq exempted-priority, on page 911
• cable upstream rate-limit-ccf, on page 912
• Upstream Channel Bondingcable upstream resiliency, on page 914
• cable upstream resiliency recover, on page 917
• cable upstream rf-adapt (logical channel), on page 918
• cable upstream rf-adapt, on page 920
• cable upstream rng-holdoff, on page 922
• cable upstream scheduling type, on page 924
• cable upstream scrambler, on page 926
• cable upstream-sharing, on page 928
• cable upstream shutdown, on page 929
• cable upstream spectrum-group, on page 931
• cable upstream spreading-interval, on page 933
• cable upstream threshold, on page 934
• cable upstream threshold hysteresis, on page 939
• cable upstream threshold rf-adapt, on page 941

Cisco CMTS Cable Command Reference

790
Cable Commands: cable u through cable w

• cable upstream timing-adjust, on page 943

• cable upstream unfrag-slot-jitter, on page 945
• cable util-interval, on page 946
• cable vc-map, on page 948
• cable video, on page 950
• cable video source-switch, on page 951
• cable vrf-steering cable-modem, on page 952
• cable wideband auto-reset, on page 953

Cisco CMTS Cable Command Reference

791
 Cable Commands: cable u through cable w
Configuring Upstream Cable Interface Features on the Cisco CMTS Routerscable udc-capability

Configuring Upstream Cable Interface Features on the Cisco

CMTS Routerscable udc-capability
To enable the Upstream Drop Classifier (UDC) feature on cable modems, use the cable udc-capability
command in interface configuration mode. To disable the UDC feature, use the no form of this command.

cable udc-capability
no cable udc-capability

Syntax Description This command has no arguments or keywords

Command Default Disabled.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCG5 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command is used in the MAC domain. When this command is used on a particular interface, the UDC
feature for all the cable modems on that interface is enabled.

Examples The following example shows how to configure the cable udc-capability command:

Router# configure terminal

Router(config)# interface cable 7/0/0
Router(config-if)# cable udc-capability

The following example shows how to configure the cable udc-capability command on Cisco cBR
Series Converged Broadband Routers:

Router# configure terminal

Router(config)# interface cable 3/0/0
Router(config-if)# cable udc-capability

The cable udc-capability command is used to configure the Upstream Drop Classifier (UDC) feature
on Cisco CMTS. For more information on the UDC feature, refer to the Configuring Upstream Cable
Interface Features on the Cisco CMTS Routers guide.

Related Commands Command Description

show cable modem Displays information for the registered and unregistered cable modems.

Cisco CMTS Cable Command Reference

792
 Cable Commands: cable u through cable w
cable upgrade dsphy-fw auto

cable upgrade dsphy-fw auto

To enable automatic upgrade of the Downstream PHY firmware on the Cisco cBR-8 router, use the cable
upgrade dsphy-fw auto command in global configuration mode. To disable the automatic upgrade, use the
no form of this command.

cable upgrade dsphy-fw auto

no cable upgrade dsphy-fw auto

Syntax Description This command has no arguments or keywords

Command Default Downstream PHY firmware auto upgrade is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.18.0S

Usage Guidelines Use this command to automatically upgrade the Downstream PHY firmware on the Cisco cBR-8 router.

Examples The following example shows how to enable automatic upgrade of the Downstream PHY firmware
on the Cisco cBR-8 router:

Router# configure terminal

Router(config)# cable upgrade dsphy-fw auto

The following example shows how to disable automatic upgrade of the Downstream PHY firmware
on the Cisco cBR-8 router:

Router# configure terminal

Router(config)# no cable upgrade dsphy-fw auto

Related Commands Command Description

Need info Need info

Cisco CMTS Cable Command Reference

793
 Cable Commands: cable u through cable w
cable upstream active-codes

cable upstream active-codes

To specify the number of active codes that can be configured on an upstream channel, use the cable upstream
active-codes command in cable interface configuration mode. To set the default value of active codes to 112
when ingress noise cancellation is enabled and to 128 when it is disabled, use the no form of this command.

cable upstream n active-codes active-code

no cable upstream n active-codes

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the cable
interface line card.

active-code Specifies the number of active codes. Valid values are from 64 to 128, with a default value of
112, when ingress noise cancellation is enabled; and a default value of 128, when ingress noise
cancellation is disabled.

Command Default The active-code setting cannot be applied if the Synchronous Code Division Multiple Access (S-CDMA) is
not configured.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is applicable only for S-CDMA channels. You should configure S-CDMA to apply the
active-code setting.

Examples The following example sets the active code to 128 on upstream port 0:

Router(config)# interface cable 7/0/4

Router(config-if)# cable upstream 0 active-codes 128
Router(config-if)#

Related Commands Command Description

cable upstream codes-per-minislot Specifies the number of codes per minislot allowed on an upstream
channel.

cable upstream spreading-interval Specifies the spreading interval for S-CDMA channels on an upstream
channel.

Cisco CMTS Cable Command Reference

794
 Cable Commands: cable u through cable w
cable upstream adjust-frequency

cable upstream adjust-frequency

To enable frequency adjustment, use the cable upstream adjust-frequency command in cable interface
configuration mode. To turn off frequency adjustment, use the no form of this command.

no
cable n upstream adjust-frequency

Syntax Description adjust-frequency Enables frequency adjustment

n Specifies the upstream port number. Valid values start with 0 for the first upstream port
on the cable interface line card. For cBR Series Converged Broadband Routers, the
valid range is from 0 to 15.

Command Default Frequency adjustment is enabled by default.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Example
The following sample shows and example of the cable upstream adjust-frequency command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) # cable upstream 0 adjust-frequency
Router(config-profile-md)#end

The following sample shows and example of the no cable upstream adjust-frequency command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) # no cable upstream 0 adjust-frequency
Router(config-profile-md)#end

Cisco CMTS Cable Command Reference

795
 Cable Commands: cable u through cable w
cable upstream admission-control

cable upstream admission-control

To specify the percentage overbooking rate that is allowed on an upstream channel, use the cable upstream
admission-control command in cable interface configuration mode. To set overbooking rate to its default of
100 percent, use the no form of this command.

cable upstream n admission-control percentage

no cable upstream n admission-control

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the cable
interface line card.

percentage Specifies the percentage overbooking rate to limit overbooking. Valid values are from 10 to
1000 percent, with a default of 100 percent.

Command Default 100 percent

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

11.3(6) NA This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command limits the maximum number of CMs for a given upstream port by looking at the minimum
guaranteed upstream bandwidth allocated to each CM. Cable modems providing residential services and
commercial services can be given different weights according to their traffic needs. This command affects
only whether CMs can register with the CMTS—it does not affect CMs that have already come online.
The CMTS uses the minimum guaranteed upstream bandwidth field from the CM’s DOCSIS configuration
file to calculate whether the CM can come online or not. If the CM’s minimum guaranteed upstream bandwidth
would exceed the total upstream bandwidth multiplied by the overbooking percentage specified by this
command, the CM cannot come online on that upstream. The CM will attempt to find another upstream, and
if it cannot register on any upstreams, it will attempt to lock on to a new downstream.

Note A CM with a guaranteed upstream bandwidth does not consume that bandwidth unless it has active traffic.
By guaranteeing a CM a minimum upstream bandwidth, individual customers are assured of never being
totally shut out from network access in a very high-traffic situation.

The following table shows the approximate bandwidth for each upstream channel, depending on channel
width, symbol rate, and modulation type, when admission control is used at 100 percent. When setting
admission control to other values, scale the bandwidth values in the following table accordingly, so as to plan
for the maximum number of CMs effectively allowed per upstream port.

Cisco CMTS Cable Command Reference

796
 Cable Commands: cable u through cable w
cable upstream admission-control

Table 15: Admission Control Bandwidth Table

Channel Width (KHz) Symbol Rate QPSK Virtual Channel 16 QAM Virtual Channel
(Ksym/sec) Bandwidth—100% limit Bandwidth—100% limit
(bits/sec) (bits/sec)

200 160 320,000 640,000

400 320 640,000 1,280,000

800 640 1,280,000 2,560,000

1600 1280 2,560,000 5,120,000

3200 2560 5,120,000 10,240,000

For example, with a 3.2 MHz channel width and QPSK modulation, the total bandwidth is approximately 5
Mbps. This is the maximum allowable bandwidth that can be allocated to CMs at the default admission rate
of 100%. If each CM is allocated a minimum upstream bandwidth of 128 kbps, this means a maximum of 40
CMs will be allowed to come online.
To verify whether or not upstream admission control is configured and activated, use the show interface
command for a cable upstream to display its configuration information. If upstream admission control is
configured and enabled, the output contains an entry stating “CIR admission control enforced.” If upstream
admission control is disabled, no admission control entry is displayed in the output.

Note Setting the admission control limit to below the current total reserved bandwidth for the channel does not
immediately force any CMs offline, but may prevent CMs from reconnecting if they drop offline at a later
time. Increasing the admission control limit allows more CMs to connect.

When an upstream becomes overbooked, use the test cable ucc command to move a cable modem that is
currently online from one upstream port to another. For example, the following example shows that the cable
modem with the IP address of 10.128.1.128 is being moved from port C3/0/U0 to C3/0/U1:

Router# show cable modem 10.128.1.128

Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable3/0/U0 101 online 1919 5.25 7 0 10.128.1.128 0030.1976.7067
Router# test cable ucc c3/0 101 1
Router# show cable modem 10.128.1.128

Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable3/0/U1 101 online 1920 5.25 7 0 10.128.1.128 0030.1976.7067

Examples The following example shows overbooking on upstream port 4 being limited to 125 percent:

Router(config)# interface cable 3/0

Router(config-if)# cable upstream 4 admission-control 125
Router(config-if)#

Cisco CMTS Cable Command Reference

797
 Cable Commands: cable u through cable w
cable upstream admission-control

Use the show interface cable upstream command to display the current status of admission control
on an interface. For example, the following command output shows that this upstream has allocated
a total bandwidth of 2.5 Mbit/sec to those online CMs that were assigned a guaranteed upstream
bandwidth in their DOCSIS configuration files.
This displays also shows that the admission control is being enforced at a subscription level of 125
percent. The Virtual channel BW field is computed by multiplying channel bandwidth by the admission
control limit. The Admissions requests rejected counter shows the number of cable modems that
attempted to register but were refused because of the admission control policy.

Router# show interface c3/0 u4

Cable3/0: Upstream 4 is up
Received 11585 broadcasts, 11854 multicasts, 3222651 unicasts
0 discards, 829 errors, 0 unknown protocol
3246090 packets input, 5 uncorrectable
557 noise, 0 microreflections
Total Modems On This Upstream Channel : 69 (68 active)
Default MAC scheduler
Queue[Rng Polls] 0/64, fifo queueing, 0 drops
Queue[Cont Mslots] 0/52, fifo queueing, 0 drops
Queue[CIR Grants] 0/64, fair queueing, 0 drops
Queue[BE Grants] 0/64, fair queueing, 0 drops
Queue[Grant Shpr] 0/64, calendar queueing, 0 drops
Reserved slot table currently has 0 CBR entries
Req IEs 205196036, Req/Data IEs 0
Init Mtn IEs 7604617, Stn Mtn IEs 422496
Long Grant IEs 4848, Short Grant IEs 1646196
Avg upstream channel utilization : 1%
Avg percent contention slots : 94%
Avg percent initial ranging slots : 1%
Avg percent minislots lost on late MAPs : 0%
Total channel bw reserved 2500000 bps
CIR admission control enforced
Subscribtion level 125%
Virtual channel bw 6400000 bps
Admission requests rejected 32
Current minislot count : 5200298 Flag: 0
Scheduled minislot count : 5200420 Flag: 0
Router#

If a CM is denied access due to the admission control policy, its entry in the show cable modem
command output shows “reject(c)”:

Router# show cable modem

Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable2/0/U0 1 online 2288 0.50 4 0 10.16.30.66 0010.7bb3.fb45
Cable2/0/U0 2 online 2288 0.50 4 0 10.16.30.68 0010.7bb3.fb7b
Cable2/0/U0 3 init(i) 2280 0.00 2 0 10.16.30.69 0010.9500.05e
. . .
Cable3/0/U1 113 online 3921 0.00 5 0 10.128.1.108 0030.9433.c38b
Cable3/0/U1 114 online 3920 0.25 6 0 10.128.1.87 0030.1976.6ebf
Cable3/0/U0 115 reject(c) 3922 0.25 2 0 10.128.1.75 0030.1976.703b
Cable3/0/U0 116 online 3919 0.75 5 0 10.128.1.57 0030.1976.6fa1

Cisco CMTS Cable Command Reference

798
 Cable Commands: cable u through cable w
cable upstream admission-control

Related Commands Command Description

debug cable mac-scheduler Displays information for the MAC layer’s scheduler and admission control
activities.

debug cable us-adm-ctrl Displays debug messages for upstream admission control activity.

show cable modem Displays statistics for a CM, including its upstream port and primary SID.

show interface cable upstream Displays the interface configuration, which for an upstream includes the
current admission control policy, if any.

Cisco CMTS Cable Command Reference

799
 Cable Commands: cable u through cable w
cable upstream admission-control max-reserved-bandwidth

cable upstream admission-control max-reserved-bandwidth

To define the maximum reserved bandwidth per bonding group for all service flows that are allowed by the
Cisco CMTS, use the cable upstream admission-control max-reserved-bandwidth command in the interface
configuration mode. To reset or disable the maximum reserved bandwidth value, use the no form of this
command.

cable upstreamnadmission-control max-reserved-bandwidth bw-in-kbps

no cable upstreamnadmission-control max-reserved-bandwidth

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the
cable interface line card.

bw-in-kbps Maximum admission control reserved bandwidth. The value is in kbps and is based on the RF
bandwidth percent defined for the bonding group. Valid range is from 0 to 30720.

Command Default The max-reserved-bandwidth value is 80 percent of the aggregate bandwidth of the RF channels configured
in the US or DS bonding group.

Command Modes
Interface configuration (config-if)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to define the maximum reserved bandwidth per bonding group. The default
maximum reserved bandwidth value is 80 percent. However the user can choose to configure a higher (up to
96 percent) or lower reserved bandwidth so that there is bandwidth allocated for zero committed information
rate (CIR) best effort traffic.

Examples The following example shows a sample definition of the maximum reserved bandwidth value.

Router> enable
Router# configure terminal
Router(config)# interface c5/0/1
Router(config-if)# cable upstream 0 admission-control max-reserved-bandwidth 6344

Related Commands Command Description

cable admission-control Configures the CPU and memory thresholds for the Cisco CMTS
router and supporting broadband processing engines (BPEs).

cable admission-control event Configures and enables admission control event types on the Cisco
CMTS router.

cable admission-control ds-bandwidth Configures admission control downstream bandwidth thresholds

on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

800
Cable Commands: cable u through cable w
cable upstream admission-control max-reserved-bandwidth

Command Description

cable admission-control us-bandwidth Configures admission control upstream bandwidth thresholds on

the Cisco CMTS router.

debug cable admission-control Enables automatic admission control troubleshooting processes on

the Cisco CMTS router.

show cable admission-control Displays the current admission control configuration and status on
the Cisco CMTS router or on a specified interface.

Cisco CMTS Cable Command Reference

801
 Cable Commands: cable u through cable w
cable upstream attribute-mask

cable upstream attribute-mask

To specify an upstream attribute mask in hexadecimal format, use the cable upstream attribute-mask
command in cable interface configuration mode or MAC domain profile configuration mode. Use the no form
of this command to set default value to upstream channel attribute mask.

cable upstream upstreamattribute-mask attribute-mask

no cable upstream upstream attribute-mask attribute-mask

Syntax Description upstream Specifies the upstream port.

attribute-mask attribute-mask Specifies the attribute mask bitmap in hexadecimal format.

Example: 0-FFFFFFFF

Command Default If the router is not high availability (HA) supported and the upstream is not bonded, the default value for cable
upstream attribute mask is 0x00.
If the router is HA supported, the default value is 0x20000000.
If the upstream channel is part of a bonding group, the default value is 0x80000000.
If the router is HA supported and the upstream channel is part of a bonding group, the default value is
0xA0000000.

Command Modes
Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the attribute mask of upstream channel.

Examples The following example shows how to set upstream attribute mask in hexadecimal format:

Router(config-if)# cable upstream 0 attribute-mask ffff

Related Commands Command Description

clear cable modem attribute-masks This command clears the cable modem attribute masks.

Cisco CMTS Cable Command Reference

802
 Cable Commands: cable u through cable w
cable upstream balance-scheduling

cable upstream balance-scheduling

To enable the USCB balancing scheduler, use the cable upstream balance-scheduling command in cable
interface configuration mode or MAC domain profile configuration mode. To disable, use the no form of this
command.

cable upstream balance-scheduling

no cable upstream balance-scheduling

Syntax Description This command has no arguments or keywords.

Command Default Disabled.

Command Modes Interface configuration (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCH2 This command was introduced.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines This command is used to balances service flows across upstream channels in a MAC domain. This command
is used only for UB-online cable modems.

The following example shows the configuration of the cable upstream balance-scheduling command:

Router# configure terminal

Router(config)# interface cable 8/1/2
Router(config-if)# cable upstream balance-scheduling

The following example shows the output of the show cable interface command that displays the
enabled status of the balancing scheduler:

Router# show interface cable 8/1/2 mac-scheduler 0

Load for five secs: 1%/0%; one minute: 2%; five minutes: 2%
Time source is hardware calendar, *07:29:34.137 CST Wed Feb 5 2014

DOCSIS 1.1 MAC scheduler for Cable8/1/2/U0: rate 7680000

wfq:None balance-scheduling: on
Queue[Rng Polls] 0/128, 0/0 drops, flows 0 max 0/0/0
Queue[CIR Grants] 0/256, 0/0 drops, flows 0 max 0/0/0
Queue[BE(7) Grants] 0/96, 0/0 drops, flows 0 max 0/0/0
Queue[BE(6) Grants] 0/96, 0/0 drops, flows 0 max 0/0/0
Queue[BE(5) Grants] 0/96, 0/0 drops, flows 0 max 0/0/0
Queue[BE(4) Grants] 0/96, 0/0 drops, flows 0 max 0/0/0
Queue[BE(3) Grants] 0/96, 0/0 drops, flows 0 max 0/0/0
Queue[BE(2) Grants] 0/96, 0/0 drops, flows 0 max 0/0/0

Cisco CMTS Cable Command Reference

803
 Cable Commands: cable u through cable w
cable upstream balance-scheduling

Queue[BE(1) Grants] 0/96, 0/0 drops, flows 0 max 0/0/0

Queue[BE(0) Grants] 0/96, 0/0 drops, flows 0 max 0/0/0
BG pending grant list entries: 0
BG delay list entries: 0
Req Slots 0, Req/Data Slots 0
Init Mtn Slots 0, Stn Mtn Slots 0
Short Grant Slots 0, Long Grant Slots 0
Adv Phy Short Grant Slots 0, Adv Phy Long Grant Slots 0
Adv Phy UGS Grant Slots 0
Awacs Slots 0
Fragmentation count 0
Fragmentation test disabled
Avg upstream channel utilization : 0%
Avg percent contention slots : 0%
Avg percent initial ranging slots : 0%
Avg percent minislots lost on late MAPs : 0%
Sched Table Rsv-state: Grants 0, Reqpolls 0
Sched Table Adm-State: Grants 0, Reqpolls 0, Util 0%
UGS : 0 SIDs, Reservation-level in bps 0
UGS-AD : 0 SIDs, Reservation-level in bps 0
RTPS : 0 SIDs, Reservation-level in bps 0
NRTPS : 0 SIDs, Reservation-level in bps 0
BE : 0 SIDs, Reservation-level in bps 0

MAP TSS: lch_state 1, init_retries 0

late_initial_maps 0, late_ucd_maps 0
mac-phy tss errors 0, missed ccc 0

Related Commands Command Description

cable upstream scheduling type Enables various scheduler modes

show interface cable Displays the current configuration and status of a cable interface

Cisco CMTS Cable Command Reference

804
 Cable Commands: cable u through cable w
cable upstream bcast-init-ranging tcc-enc excl-timing

cable upstream bcast-init-ranging tcc-enc excl-timing

To enable feature of ECN MULPIv3.0-N-14.1145-1 on the CMTS router, use the cable upstream
bcast-init-ranging tcc-enc excl-timing command in global configuration mode. To disable feature of ECN
MULPIv3.0-N-14.1145-1, use the no form of this command - no cable upstream bcast-init-ranging tcc-enc
excl-timing.

cable upstream bcast-init-rangingtcc-encexcl-timing

no cable upstream bcast-init-rangingtcc-encexcl-timing

Syntax Description This command has no arguments or keywords.

Command Default Disabled.

Command Modes Global configuration (config)

Command History Release Modification

IOS XE Fuji This command was

16.9.1a introduced.

Usage Guidelines To verify whether or not ECN MULPIv3.0-N-14.1145-1 feature is activated, enter the show running-config
command and look for the cable upstream bcast-init-ranging tcc-enc excl-timing information. By default,
it is disabled.

The following example shows the configuration of the cable upstream balance-scheduling command:

Router# configure terminal

Router(config)# cable upstream bcast-init-ranging tcc-enc excl-timing

Related Commands There are no related commands.

Cisco CMTS Cable Command Reference

805
 Cable Commands: cable u through cable w
cable upstream bonding-group

cable upstream bonding-group

To create a static upstream bonding group on a cable interface, use the cable upstream bonding-group
command in cable interface configuration mode. To disable this configuration, use the no form of this command.

cable upstream bonding-group id

no cable upstream bonding-group id

Syntax Description id Bonding group ID on the cable interface. Valid values are from 1 to 65535.

Command Default None

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

IOS-XE The valid range of upstream channels for each MAC Domain was increased to 0-15.
3.18.0S

Usage Guidelines You can configure up to 32 static upstream bonding groups for each Media Access Control (MAC) domain.
However, you can configure only 16 upstream channels for each MAC domain. If you delete an upstream
bonding group using the no form of the command, the Cisco CMTS router enforces the bonded upstream
service flows associated with the deleted upstream bonding group to readmit.
Under the upstream bonding configuration submode, you can specify the following for an upstream bonding
group:
• Upstream channels
• Bandwidth reservation
• Provisioned attribute masks

Note While adding upstream channels under the upstream bonding group, ensure that the upstream channel is
pre-configure using the following command:

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

Upstream channels that are not pre-configured are not accepted and an error message is displayed as follows:
Router(config-if)#cable upstream bonding-group 106
Router(config-upstream-bonding)#upstream 0
Router(config-upstream-bonding)#upstream 6
Upstream 6 is not yet defined in MD Cable9/0/0.

Cisco CMTS Cable Command Reference

806
 Cable Commands: cable u through cable w
cable upstream bonding-group

Note The changes made to the configuration, using the attributes command in the upstream bonding configuration
submode, on the working line card are synchronized with the configuration on the protect line card only after
exiting the configuration mode. Use the end command to exit to Privileged EXEC mode, before using the
show running configuration command.

Starting from Cisco IOS-XE 3.18.0S release, maximum of 16 upstream channels can be configured for each
MAC Domain, which are divided into two groups:
• Group 1: upstream channel 0-7
• Group 2: upstream channel 8-15
An upstream bonding-group should include all the upstream channels either from Group 1 or Group 2 only.
For example, consider the following configuration:

Router(config-if)#cable upstream bonding-group 106

Router(config-upstream-bonding)#upstream 0
Router(config-upstream-bonding)#upstream 6
Router(config-upstream-bonding)#upstream 7
.
.
.
Router(config-if)#cable upstream bonding-group 110
Router(config-upstream-bonding)#upstream 12
Router(config-upstream-bonding)#upstream 13
Router(config-upstream-bonding)#upstream 14

If you try to add upstream 11 into upstream bonding-group 106 or upstream 4 into upstream
bonding-group 110, it will be rejected.

Examples The following example shows how to configure an upstream bonding group on a cable interface in
slot 7, subslot 1, and port 0 on a Cisco CMTS router:

Router# configure terminal

Router(config)# interface cable 7/1/0
Router(config-if)# cable upstream bonding-group 235

Related Commands Command Description

upstream cable connector Specifies the upstream channel ports for a fiber node.

cable fiber-node Creates a fiber node and enters cable fiber-node configuration mode.

Cisco CMTS Cable Command Reference

807
 Cable Commands: cable u through cable w
cable upstream chan-class-id

cable upstream chan-class-id

To configure a channel class ID for a logical upstream channel on the CMTS router, use the cable upstream
chan-class-id command in cable interface configuration mode. To disable the channel class ID configuration,
use the no form of this command.

cable upstream port-number chan-class-id id

no cable upstream port-number chan-class-id id

Syntax Description port-number Cable upstream port number. The valid range depends on the number of upstream channels
configured in a MAC domain. For example, if the total number of upstream channels configured
is 4, then the valid range for the upstream port number is from 0 to 3.

id Channel class ID for the logical upstream channel in the hexadecimal format. The valid range
is from 0 to ffffffff. The default value is 0.

Command Default None

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCH This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable upstream chan-class-id command is associated with the CM Steering on the Cisco CMTS Routers
feature.
An upstream channel descriptor (UCD) message includes type, length, value (TLV) 18 and 19 for an upstream
logical channel based on the channel class ID and ranging hold-off priority configuration. If a channel class
ID is not configured, the UCD does not include TLV18 and 19 irrespective of the ranging hold-off priority
configuration.

Examples The following example shows how to configure a channel class ID for a logical upstream channel
on a cable interface line card on the cisco uBR10012 router:

Router# configure terminal

Router(config)# interface cable 5/0/0
Router(config-if)# cable upstream 0 chan-class-id ff

Related Commands Command Description

cable load-balance exclude Excludes a cable modem or a group of cable modems from DOCSIS load
balance.

Cisco CMTS Cable Command Reference

808
Cable Commands: cable u through cable w
cable upstream chan-class-id

Command Description

cable upstream rng-holdoff Configures an upstream ranging hold-off priority value for an upstream
logical channel on the CMTS router.

show cable modem verbose Displays information about the registered and unregistered cable modems
connected to the CMTS router.

Cisco CMTS Cable Command Reference

809
 Cable Commands: cable u through cable w
cable upstream channel-width

cable upstream channel-width

To specify an upstream channel width for an upstream port, use the cable upstream channel-width command
in cable interface configuration mode. To set the channel width back to the default setting of 1,600,000 Hz,
use the no form of this command.

cable upstream n channel-width first-choice-width [last-choice-width]

no cable upstream n channel-width

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port
on the cable interface line card.

first-choice-width Specifies the upstream channel width in hertz (Hz).

last-choice-width The upstream channel width in hertz. The valid values are the same as those for the
first-choice-width parameter, but for proper operation, the last-choice-width should be
equal to or less than the first-choice-width value. Use this parameter with supported cards
to enable symbol rate management algorithms.

Command Default The first-choice-width value and the last-choice-width value default to 1,600,000 Hz. When an upstream
channel is configured to operate in DOCSIS 2.0 A-TDMA or DOCSIS 3.0 S-CDMA-mode, only three channel
width options (1.6 Mhz, 3.2 Mhz, and 6.4 Mhz) are available.

Command Modes
Interface configuration (config-if)

Command History Release Modification

11.3(5)NA This command was introduced.

12.0(4)XI The last-choice-width argument was added.

12.2(11)CY, 12.2(11)BC3 Support was added for the Cisco uBR10-MC5X20S cable interface line card on
the Cisco uBR10012 router.

12.2(15)CX Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X
cable interface line card, including DOCSIS 2.0 A-TDMA and mixed modulation
profiles using 6.4 MHz channel widths.

12.2(15)BC2 Support was added for DOCSIS 2.0 A-TDMA and mixed modulation profiles
using 6.4 MHz channel widths on the Cisco uBR-MC5X20S/U cable interface
line cards.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCC Support was added for Cisco UBR10-MC20X20V cable interface line card.

12.2(33)SCG2 Support was added for Copy and Paste Support for TDMA to A-TDMA Upgrade
feature.

Cisco CMTS Cable Command Reference

810
 Cable Commands: cable u through cable w
cable upstream channel-width

Release Modification

IOS-XE 3.15.OS This command was removed. This command is replaced by us-channel
channel-width command.

Usage Guidelines The last-choice-width parameter is supported only by the Cisco uBR-MC16S, Cisco uBR-MC16U/X, Cisco
uBR-MC28U/X, and Cisco uBR-MC5X20S/U cable interface line cards. When one of these particular cards
is installed, the system attempts to increase the channel width from the smallest channel width value to the
largest channel width value.
When you specify both channel width values, the smaller value is taken as the last-choice-width parameter
and the larger value is taken as the first-choice-width parameter. In the event of noise in the channel, the
symbol rate automatically steps down to a value that is lower than the first-choice-width and greater or equal
to the last-choice-width to maintain a stable channel.

Table 16: Supported Channel Widths and DOCSIS Modes for Cable Interfaces

Cable Interface Channel Width DOCSIS 1.X Mixed DOCSIS DOCSIS 2.0 DOCSIS 2.0 DOCSIS 3.0
(TDMA) 1.X/2.0 (A-TDMA) (S-CDMA) (S-CDMA)

Cisco 6.4 MHz 3.2 MHz 1.6 41 to 50 141 to 150 241 to 250 N/A N/A
uBR-MC16U/X 4 , MHz 800 kHz 400 kHz (default is 41) (default is 141) (default is 241)
Cisco 200 kHz
uBR-MC28U/X

Cisco 6.4 MHz 3.2 MHz 1.6 21 to 30 121 to 130 221 to 230 N/A N/A
uBR-MC5X20S/U/H MHz 800 kHz 400 kHz (default is 21) (default is 121) (default is 221)
200 kHz

Cisco 6.4 MHz 3.2 MHz 1.6 21 to 30 121 to 130 221 to 230 321 to 330 1 to 400
uBR-MC20X205 MHz 800 kHz 400 kHz (default is 21) (default is 121) (default is 221) (default is (default is
200 kHz 321) 381)

Cisco uBR-MC88U 6.4 MHz 3.2 MHz 1.6 21 to 30 121 to 130 221 to 230 321 to 330 1 to 400
MHz 800 kHz 400 kHz (default is 21) (default is 121) (default is 221) (default is (default is
200 kHz 321) 381)

Cisco 6.4 MHz 3.2 MHz 1.6 21 to 30 121 to 130 221 to 230 321 to 330 1 to 400
uBR-MC3GX60V MHz 800 kHz 400 kHz (default is 21) (default is 121) (default is 221) (default is (default is
200 kHz 321) 381)
4
Supports 6,400,000 Hz (5,120,000) symbols/sec) while operating in the DOCSIS 2.0 (A-TDMA-only) mode.
5
The DOCSIS 3.0 S-CDMA modulation profiles do not support 200 kHz, 400 kHz, and 800 kHz channel widths.This applies
to Cisco uBR-MC88U and Cisco uBR-MC3GX60V.

Note The UBR-MC20X20V cable interface line card has three variants, UBR-MC20X20V-0D,
UBR-MC20X20V-5D, and UBR-MC20X20V-20D. The UBR-MC20X20V-0D line card supports 20 upstreams
and zero (no) downstreams. The UBR-MC20X20V-5D line card supports 20 upstreams and five downstreams,
and the UBR-MC20X20V-20D line card supports 20 upstreams and 20 downstreams.

Cisco CMTS Cable Command Reference

811
 Cable Commands: cable u through cable w
cable upstream channel-width

Note In Cisco IOS Release 12.2(15)BC1 and later releases, changing the channel width could force a frequency
hop, if the current frequency does not fit within the new channel width parameters, or if the system needs to
reset the fixed frequency or shared frequency group parameters to match the new channel width.

Caution In DOCSIS 1.X networks, do not change the channel width more than one step at a time on an interface that
has cable modems that are currently online. The DOCSIS 1.X specifications require that cable modems remain
online when the channel width is changed in single step increments (such as 800,000 to 1,600,000 Hz), but
cable modems can go offline when you change the channel width in larger amounts (such as changing it from
800,000 to 3,200,000 Hz). To check if the DOCSIS 2.0 cable modems support changing the channel width
by two steps, test each brand of modem before attempting it on a live network. Also, after changing the channel
width, do not change the channel width again until all cable modems have performed their ranging adjustments
for the new width (which could take up to a minute, depending on the number of cable modems).

Note To specify only one channel width for the Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, or Cisco
uBR-MC5X20S/U/H card, specify the same value for both the first-choice-width and last-choice-width
parameters. For example:cable upstream 0 channel-width 800000 800000

When using this command to change channel-widths for an upstream interface on the Cisco uBR-MC5X20S
cable interface line card, some DOCSIS 1.1 CMs can go offline if you do not change the minislot size to the
corresponding value. See the following examples for the correct channel-width and minislot pairings:

Router(config-if)# cable upstream 0 channel-width 3200000

Router(config-if)# cable upstream 0 minislot 4
Router(config-if)# cable upstream 0 channel-width 1600000
Router(config-if)# cable upstream 0 minislot 8
Router(config-if)# cable upstream 0 channel-width 800000
Router(config-if)# cable upstream 0 minislot 16
Router(config-if)# cable upstream 0 channel-width 400000
Router(config-if)# cable upstream 0 minislot 32
Router(config-if)# cable upstream 0 channel-width 200000
Router(config-if)# cable upstream 0 minislot 64

Note This limitation does not affect DOCSIS 1.1-compliant CMs. Also, in Cisco IOS Release 12.2(15)CX, Cisco
IOS Release 12.2(15)BC2, and later releases, there is no need to manually change the minislot size on the
Cisco uBR-MC16U/X, Cisco uBR-MC28C, and Cisco uBR-MC28U/X cards. These cards automatically
change the minislot size when the channel width is changed, to produce 32 symbols per minislot.

Note Starting with Cisco IOS 12.2(33)SCG2, when the channel-width value in the cable upstream channel-width
command is specified as 6.4 MHz in the TDMA or mixed TDMA/A-TDMA mode, the DOCSIS mode
automatically changes to A-TDMA-only (DOCSIS 2.0) mode.

Cisco CMTS Cable Command Reference

812
 Cable Commands: cable u through cable w
cable upstream channel-width

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

Examples The following example shows the upstream port 2 on a Cisco uBR-MCXXC card being configured
with a channel width of 200,000 Hz (which is equivalent to a symbol rate of 160 kilosymbols/second):

Router(config-if)# cable upstream 2 channel-width 200000

Router(config-if)#

The following example shows the upstream port 2 on a Cisco uBR-MC16U/X, Cisco uBR-MC28U/X,
or Cisco uBR-MC5X20S card being configured with a channel width of 200,000 Hz (which is
equivalent to a symbol rate of 160 kilosymbols/second):

Router(config-if)# cable upstream 2 channel-width 200000 200000

Router(config-if)#

The following example shows the upstream port 3 being configured to step from a channel width of
1,600,000 Hz to a channel width of 3,200,000 Hz in increments of 200,000 Hz:

Router(config-if)# cable upstream 3 channel-width 1600000 3200000

Router(config-if)#

The following example shows an upstream port on a Cisco uBR-MC16U/X, Cisco uBR-MC28U/X,
Cisco uBR-MC5X20S, Cisco uBR-MC20X20V, Cisco uBR-MC88U or Cisco uBR-MC3GX60V
card being configured with a channel width of 6.4 MHz, which is supported only in DOCSIS 2.0
A-TDMA-only mode:

Router(config-if)# cable upstream 0 channel-width 6400000

Router(config-if)#

The following example shows an upstream port on Cisco uBR-MC5X20H, Cisco uBR-MC20X20V,
Cisco uBR-MC88U, Cisco uBR-MC3GX60V line cards being configured with a channel width of
6.4 MHz in DOCSIS 3.0 S-CDMA mode:

Router(config-if)# cable upstream 0 channel-width 6400000

Router(config-if)#

Related Commands Command Description

cable upstream hopping blind Disables optimum frequency hopping on the Cisco uBR-MC16S and
Cisco uBR-MC5X20S cable interface line cards.

cable upstream minislot-size Specifies the minislot size for a specific upstream interface.

cable upstream modulation-profile Overrides modulation types specified in the modulation profile for
the specified upstream channel.

Cisco CMTS Cable Command Reference

813
 Cable Commands: cable u through cable w
cable upstream channel-width

Command Description

cable upstream docsis-mode Configures an upstream to use either DOCSIS 1.x or DOCSIS 2.0
modulation profiles.

Cisco CMTS Cable Command Reference

814
 Cable Commands: cable u through cable w
cable upstream codes-per-minislot

cable upstream codes-per-minislot

To specify the number of codes-per-minislot allowed on an upstream channel, use the cable upstream
codes-per-minislot command in cable interface configuration mode. To set the default values to the
codes-per-minislot, which depend on the setting of the cable upstream spreading-interval command, use
the no form of this command.

cable upstream n codes-per-minislot code

no cable upstream n codes-per-minislot

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the cable interface
line card.

code Specifies the number of codes-per-minislot. Valid values range from 2 to 32.

Command Default The codes-per-minislot setting cannot be applied if the Synchronous Code Division Multiple Access (S-CDMA)
is not configured. The default value of codes-per-minislot depends on the setting of the cable upstream
spreading-interval command.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command limits the maximum number of codes-per-minislot for a given upstream port. You should
configure S-CDMA to apply the active-code setting.

Examples The following example sets the codes-per-minislot to 8 on the upstream port 0:

Router(config)# interface cable 7/1/0

Router(config-if)# cable upstream 0 codes-per-minislot 8
Router(config-if)#

Related Commands Command Description

cable upstream active-codes Specifies the number of active codes that can be configured on an
upstream channel.

cable upstream spreading-interval Specifies the spreading interval for SCDMA on an upstream channel.

Cisco CMTS Cable Command Reference

815
 Cable Commands: cable u through cable w
cable upstream concatenation

cable upstream concatenation

To enable DOCSIS concatenation at the CMTS, use the cable upstream concatenation command in cable
interface configuration mode. To turn off concatenation, use the no form of this command.

cable upstream n concatenation

no cable upstream n concatenation

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card. For cBR Series Converged Broadband Routers, the valid range is from 0 to 15.

Command Default Concatenation is enabled.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.0(7)XR2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines Concatenation is part of DOCSIS 1.0 extension support. Concatenation provides for improved bandwidth
efficiency but must be supported at both the headend CMTS and the CM.
DOCSIS concatenation combines multiple upstream packets into one packet to reduce packet overhead and
overall latency and increase transmission efficiency. Using concatenation, a DOCSIS CM needs to make only
one bandwidth request for a concatenated packet, compared to making bandwidth requests for each individual
packet. This technique is especially effective for bursty real-time traffic such as voice calls.
Concatenation support improves upstream per CM data throughput. The Cisco CMTS radio frequency (RF)
line card driver can receive only one MAC frame in a data burst. Thus the CM must make explicit bandwidth
requests for every packet it sends upstream. This limits the maximum upstream data throughput received by
the CM due to the inherent request-to-grant round-trip latency of the hybrid fiber-coaxial (HFC) cable system
incurred by every packet. To increase this per-CM upstream throughput, the Cisco CMTS driver has been
enhanced to receive a concatenated burst of multiple MAC frames from the same CM.

Note Concatenation is not supported on the Cisco uBR-MC11 FPGA and Cisco uBR-MC16B cable interface line
cards.

Examples The following example shows how to enable concatenation for CMs on upstream port 2 on the cable
interface in slot 3/0:

Router(config)# interface c3/0

Router(config-if)# cable upstream 2 concatenation

Cisco CMTS Cable Command Reference

816
 Cable Commands: cable u through cable w
cable upstream connector

cable upstream connector

To map a MAC domain upstream port to a physical port on the Cisco cable interface line cards (Cisco
uBR-MC5X20U/H, Cisco uBR-MC20X20V, Cisco uBR-MC88V, Cisco uBR-MC28U, or Cisco
uBR-MC3GX60V), use the cable upstream connector command in cable interface configuration mode. To
remove the mapping, use the no form of this command.

cable upstream port connector physical-port shared

no cable upstream port connector physical-port shared

Syntax Description port Index of the MAC domain upstream. The index range is configured with the cable upstream
max-ports n command, and the valid range is 0 to n -1.

physical-port Index of the actual physical port to be mapped.

The valid range for Cisco uBR-MC520U/H, Cisco uBR-MC20X20V, and Cisco
uBR-MC3GX60V cable line cards is from 0 to 19. The valid range for Cisco uBR-MC28U
and Cisco uBR-MC88V cable line cards is from 0 to 7.

shared Indicates that the connector is shared by multiple upstream ports.

Note
This option is not valid for Cisco uBR-MC3GX60V cable interface lin ecard on Cisco IOS
Release 12.2(33)SCE and later releases. A connector becomes shared automatically when
multiple upstream ports are mapped to it.

Command Default By default, each MAC domain has four upstream ports allocated. For all the currently supported cable line
cards—Cisco uBR-MC5X20U/H, Cisco uBR-MC20X20V, Cisco uBR-MC88V, Cisco uBR-MC28U, and
Cisco uBR-MC3GX60V the default mapping is four upstream for each MAC domain.
For the Cisco uBR-MC5X20U/H and Cisco uBR-MC28U cable line cards, each MAC domain has one
downstream and four upstreams. For the other cards, each MAC domain can have multiple downstreams.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(15)BC1 This command was introduced to support the Cisco uBR-MC5X20S cable interface line
card.

12.2(15)BC2 Support was added for the Cisco uBR-MC5X20U card. Also, the entAliasMappingTable
in the ENTITY-MIB was updated to show the mapping between the physical upstream
connectors and the logical upstream connectors.

12.2(33)SCE Support for the shared keyword was removed.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable upstream connector command maps a MAC domain upstream port to a particular physical RF
port on the cable line card front panel. For all cable line cards except the Cisco uBR-MC3GX60V, the default

Cisco CMTS Cable Command Reference

817
 Cable Commands: cable u through cable w
cable upstream connector

mapping assigns one upstream port to one physical port. The default mapping of Cisco uBR-MC3GX60V
cable line card assigns four upstream ports to one physical port. The physical ports are mapped sequentially
in the order in which they appear on the front panel.
The no version of this command removes the upstream port mapping and shuts down the upstream port. The
port must be remapped to another physical port before it can come online again.

Tip Use the cable upstream max-ports command to set the maximum number of upstream ports per MAC domain
before using the cable upstream connector command.

Table 17: Default Upstream Port Assignments for the Cisco uBR-MC5X20U/H Cable Interface Line Card

Physical Ports (upstream, as labeled on the card)

Physical 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Upstream
Ports

MAC 0 1 2 3
Domain 0
Upstream

MAC 0 1 2 3
Domain 1
Upstream

MAC 0 1 2 3
Domain 2
Upstream

MAC 0 1 2 3
Domain 3
Upstream

MAC 0 1 2 3
Domain 4
Upstream

Table 18: Default Upstream Port Assignments for the Cisco uBR-MC3GX60V Cable Interface Line Card

Physical Ports (upstream, as labeled on the card)

Physical 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
Upstream
Ports

MAC 0-3
Domain 0
Upstream

Cisco CMTS Cable Command Reference

818
 Cable Commands: cable u through cable w
cable upstream connector

Physical Ports (upstream, as labeled on the card)

MAC 0-3
Domain 1
Upstream

MAC 0-3
Domain 2
Upstream

MAC 0-3
Domain 3
Upstream

MAC 0-3
Domain 4
Upstream

MAC 0-3
Domain 5
Upstream

MAC 0-3
Domain 6
Upstream

MAC 0-3
Domain 7
Upstream

MAC 0-3
Domain 8
Upstream

MAC 0-3
Domain 9
Upstream

MAC 0-3
Domain 10
Upstream

MAC 0-3
Domain 11
Upstream

MAC 0-3
Domain 12
Upstream

MAC 0-3
Domain 13
Upstream

Cisco CMTS Cable Command Reference

819
 Cable Commands: cable u through cable w
cable upstream connector

Physical Ports (upstream, as labeled on the card)

MAC 0-3
Domain 14
Upstream

Each MAC domain can have up to 8 upstream ports. Each upstream port can be mapped to a physical port.

Examples The following example shows how to configure a MAC domain with 8 upstream ports:

Router# configure terminal

Router(config)# interface cable 8/1/0
Router(config-if)# cable upstream max-ports 8
Router(config-if)# cable upstream 0 connector 16
Router(config-if)# cable upstream 1 connector 17
Router(config-if)# cable upstream 2 connector 18
Router(config-if)# cable upstream 3 connector 12
Router(config-if)# cable upstream 4 connector 13
Router(config-if)# cable upstream 5 connector 14
Router(config-if)# cable upstream 6 connector 15
Router(config-if)# cable upstream 7 connector 11
Router(config-if)# exit
Router(config)# exit
Router#

Note The "WARNING: This upstream will be removed from all the upstream channel bonding groups in
the MAC Domain." warning message is displayed when you configure no cable upstream connector
command.

When an upstream is mapped to a physical upstream port (connector), it is also mapped to an internal
upstream PHY receiver. In Cisco uBR-MC5X20U/H, Cisco uBR-MC20X20V, and Cisco uBR-MC88V
cable line cards, each upstream PHY chip has two connectors and two receivers, and can support
two upstreams. The two upstreams can be mapped in four ways:
• Straight mapping: upstream1 =>connector1 =>receiver1; upstream2 =>connector2 =>receiver2;
• Share A mapping: upstream1 =>connector1 =>receiver1; upstream2 =>connector1 =>receiver2;
• Share B mapping: upstream1 =>connector2 =>receiver1; upstream2 =>connector2 =>receiver2;
• Crossed mapping: upstream1 =>connector2 =>receiver1; upstream2 =>connector1 =>receiver2;
The card hardware only supports the first three mappings, and does not support crossed mapping.
During normal configuration, certain configuration sequence can cause crossed mapping. When that
happens, the connector command will fail, and the CNNR-NOXC error message is displayed. To fix
the cross mapping, remove all existing upstream connector configurations in these two connectors,
and re-provision them.

Related Commands Command Description

cable upstream max-ports Configures the maximum number of upstreams on a downstream (MAC domain)
on a Cisco uBR-MC5X20S cable interface line card.

Cisco CMTS Cable Command Reference

820
 Cable Commands: cable u through cable w
cable upstream controller-profile

cable upstream controller-profile

To configure the upstream controller profile, use the cable upstream controller-profile command in global
configuration mode. To void the upstream controller profile configuration, use the no form of this command.

cable upstream controller-profile id[RPHY|I-CMTS]

no cable upstream controller-profile id

Syntax Description
Syntax Description id Specifies the upstream controller profile ID.

Command Default None

Command Modes
Global configuration (config)

Command History
Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Cisco IOS XE Fuji 16.7.1 This command was modified on the Cisco cBR Series Converged Broadband
Routers. Keywords RPHY and I-CMTS were added.

Usage Guidelines Use this command to configure the upstream controller profile.
When configuring a new i-CMTS controller profile, keyword I-CMTS is needed. If user input RPHY or do
not input any keyword, the system will consider it as a RPHY controller profile.

Examples The following example shows how to enter the upstream controller profile configuration mode:

Router# configure terminal

Router(config)# cable upstream controller-profile 1 I-CMTS
Router(config-controller-profile)#

Cisco CMTS Cable Command Reference

821
 Cable Commands: cable u through cable w
cable upstream data-backoff

cable upstream data-backoff

To specify automatic or fixed start and stop values for data backoff, use the cable upstream data-backoff
command in cable interface configuration mode. To use the default data backoff values, use the no form of
this command.

cable upstream n data-backoff {automatic | start end}

no cable upstream n data-backoff

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the
cable interface line card.

automatic Specifies automatic data backoff start and stop values. It enables dynamic variation in the start
and end values.

start Binary exponential algorithm. Sets the start value for data backoff. Valid values are from 0 to
15. The default value is 3.

end Binary exponential algorithm. Sets the end value for data backoff. Valid values are from 0 to 15.
The default value is 5.

Command Default The default cable upstream data-backoff values are 3 5.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.1 T This command was introduced.

12.1(5)EC1 Support was added for the Cisco uBR7100 series router.

12.2(4)BC1 Support was added for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The DOCSIS-specified method of contention resolution for CMs used to send data or requests on the upstream
channel is a truncated binary exponential backoff with the initial backoff window and the maximum backoff
window controlled by the CMTS. The Cisco CMTS router specifies backoff window values for both data and
initial ranging, and sends these values downstream as part of the Bandwidth Allocation Map (MAP) MAC
message.
The values specified in this command are exponential power-of-two values. For example, a value of 4 indicates
a window between 0 and 15; a value of 10 indicates a window between 0 and 1023.
To manually specify the data-backoff values, use the following formula as a guideline for the start and end
binary exponents:

0.33 = (2**stop- 2**start)/n

Cisco CMTS Cable Command Reference

822
 Cable Commands: cable u through cable w
cable upstream data-backoff

where n is the number of CMs on the upstream. Choose start and stop values that come closest to the value
of 0.33 (which is the optimal probability to transmit on a contention-based system).

Related Commands Command Description

cable insertion-interval Configures the interval between consecutive initial ranging slots on an
upstream.

cable upstream range-backoff Specifies automatic or configured initial ranging backoff calculation.

show controllers cable Displays the backoff window setting for the configured upstream port.

Cisco CMTS Cable Command Reference

823
 Cable Commands: cable u through cable w
cable upstream description

cable upstream description

To assign a label to an upstream, use the cable upstream description command in cable interface configuration
mode. To remove the label from the upstream, use the no form of this command.

cable upstream n description label

no cable upstream n description

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card.

label An arbitrary string, up to 80 characters long, that describes this upstream for management and tracking
purposes. If the string contains any spaces, enclose the string within quotes.

Command Default No description is assigned to upstreams.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

11.3 NA This command was introduced.

IOS-XE 3.15.0S This command was replaced by the us-channel description command on the Cisco cBR
Series Converged Broadband Routers.

Usage Guidelines Use the cable upstream description command to assign arbitrary labels to the upstreams on the cable
interfaces. These labels can contain any information that identifies the upstream and that could aid in network
management or troubleshooting.

Tip Use the show interface cable upstream command to display the labels that are assigned to a particular
upstream.

Examples The following example shows how to assign descriptions to the first two upstreams on the cable
interface in slot 3:

Router# configure terminal

Router(config)# interface cable 3/0
Router(config-if)# cable upstream 0 description "SJ-Node1-Upstream 0"
Router(config-if)# cable upstream 1 description "SJ-Node1-Upstream 1 (Unused)"
Router(config-if)#

Related Commands Command Description

show interface cable Displays the current configuration and status of a cable interface.

Cisco CMTS Cable Command Reference

824
 Cable Commands: cable u through cable w
cable upstream differential-encoding

cable upstream differential-encoding

To enable differential encoding on upstream traffic to a specified cable interface, use the cable upstream
differential-encoding command in cable interface configuration mode. To disable this function, use the no
form of this command.

cable upstream n differential-encoding

no cable upstream n differential-encoding

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card.

Command Default Enabled

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.1 This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines To verify whether or not upstream differential encoding is activated, enter the show running-config command
and look for the cable interface configuration information. If upstream differential encoding is enabled, a
differential encoding entry is displayed in the output of the show running-config command. If upstream
differential encoding is disabled, no differential encoding entry is displayed in the output.
If you are having trouble, make sure that the cable connections are not loose or disconnected; the cable interface
line card is firmly seated in its chassis slot; the captive installation screws are tight; you have entered the
correct slot and port numbers; and you selected a valid frequency for your router.

Examples The following example shows how to enable differential encoding for upstream port 2:

Router(config-if)# cable upstream 2 differential-encoding

Router(config-if)#

Cisco CMTS Cable Command Reference

825
 Cable Commands: cable u through cable w
cable upstream docsis-mode

cable upstream docsis-mode

To configure an upstream to use DOCSIS 1.x, DOCSIS 2.0 or DOCSIS 3.0 modulation profiles, use the cable
upstream docsis-mode command in cable interface configuration mode. To reset the upstream to its default
configuration, use the no form of this command.

cable upstream n docsis-mode {atdma | scdma | scdma-d3 | tdma | tdma-atdma}

no cable upstream n docsis-mode {atdma | scdma | scdma-d3 | tdma | tdma-atdma}

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the cable
interface line card.

atdma Configures the upstream only for DOCSIS 2.0 Advanced Time Division Multiple Access
(A-TDMA) modulation profiles.

scdma Configures the upstream for DOCSIS 2.0 Synchronous Code Division Multiple Access
(S-CDMA) modulation profiles only.

scdma-d3 Configures the upstream for DOCSIS 3.0 S-CDMA modulation profiles. The scdma-d3 option
uses channel type 4SR mode.

tdma Configures the upstream only for DOCSIS 1.0/DOCSIS 1.1 Time Division Multiple Access
(TDMA) modulation profiles (default).

tdma-atdma Configures the upstream for both A-TDMA and TDMA operations (mixed mode). If you are
using abbreviations at the command line, you must specify at least the tdma to select the mixed
mode. If you choose a shorter abbreviation, you select TDMA-only mode.

Command Default All upstreams are configured ATDMA-only mode.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(15)CX This command was introduced to support DOCSIS 2.0 A-TDMA and mixed modulation
profiles on the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X cable interface line card
on the Cisco uBR7246VXR router.

12.2(15)BC2 Support was added for the Cisco uBR-MC5X20S/U cable interface line cards on the Cisco
uBR10012 router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCC This command was modified with the addition of scdma and scdma-d3 keyword options
and support was added for the Cisco UBR-MC20X20V cable interface line card on the
Cisco uBR10012 router.

12.2(33)SCG The command default was changed from TDMA to ATDMA.

Cisco CMTS Cable Command Reference

826
 Cable Commands: cable u through cable w
cable upstream docsis-mode

Release Modification

12.2(33)SCG2 Support was added for the Copy and Paste Support for TDMA to A-TDMA upgrade feature.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS This command is replaced by us-channel docsis-mode command.

Usage Guidelines The DOCSIS 2.0 specification builds on the existing TDMA to support advanced modulation profiles that
increase potential upstream bandwidth. The A-TDMA profiles support higher QAM rates of up to 64-QAM
and wider channel widths of up to 6.4 MHz (5.12 Msymbols).

Note The advanced hardware-based spectrum management features for the Cisco uBR-MC16S/U/X, Cisco
uBR-MC28U/X, and Cisco uBR-MC5X20S/U cards are supported only in the DOCSIS 1.0/1.1 TDMA-only
mode. They cannot be used in the mixed or A-TDMA-only modes.

Note Starting with Cisco IOS Release 12.2(33)SCG and later, the default upstream DOCSIS mode is ATDMA
only.

The DOCSIS 2.0 specification allows an upstream to be configured in one of the following three modes:
• A-TDMA only mode—Upstreams only support cable modems that register using A-TDMA modulation
profiles. The CMTS does not allow DOCSIS 1.0 and DOCSIS 1.1 cable modems to register and come
online on these upstreams. The Cisco uBR-MC5X20S /U , Cisco uBR-MC16U/X, and Cisco
uBR-MC28U/X cards also support 6,400,000 Hz (5,120,000 symbols/sec) when operating in DOCSIS
2.0 (A-TDMA-only) mode.
Changing the DOCSIS mode to A-TDMA only mode automatically changes the symbol rate to 5.12
megasymbols per second and the channel width to 6.4 MHz. It also automatically disables the dynamic
upstream modulation.

Note Starting with Cisco IOS 12.2(33)SCG2, when the channel-width value in the cable upstream channel-width
command is specified as 6.4 MHz in the TDMA or mixed TDMA/A-TDMA mode, the DOCSIS mode
automatically changes to A-TDMA-only (DOCSIS 2.0) mode. Changing DOCSIS mode to A-TDMA only
mode will not automatically change the symbol rate to 5.12 megasymbols per second and the channel width
to 6.4 MHz. The symbol rate and channel width before the DOCSIS mode change are maintained after the
change.

In addition, the following are required to support the DOCSIS 2.0 A-TDMA features:
• • Cable modems must be DOCSIS 2.0 compliant.
• The DOCSIS configuration file for the cable modem must either omit the DOCSIS 2.0 Enable field
(TLV 39), or it must set TLV 39 to 1 (enable). If you set TLV 39 to 0 (disable), a DOCSIS 2.0 CM
uses the TDMA mode.
• The upstream must be configured for either A-TDMA-only or mixed TDMA/A-TDMA mode.

Cisco CMTS Cable Command Reference

827
 Cable Commands: cable u through cable w
cable upstream docsis-mode

• TDMA-only mode—Upstreams only support cable modems that register using TDMA modulation
profiles. DOCSIS 2.0 cable modems can register on these upstreams only by using a DOCSIS 1.0/DOCSIS
1.1 modulation profile (which typically would happen only when a DOCSIS 2.0 cable modem cannot
find an A-TDMA channel in its DOCSIS domain).
Changing the DOCSIS mode to TDMA-only mode automatically changes the symbol rate to 1.28 megasymbols
per second and the channel width to 3.2 MHz. It also automatically disables the dynamic upstream modulation.
• Mixed mode—Upstreams support both DOCSIS 1.0/DOCSIS 1.1 cable modems using TDMA modulation
profiles and DOCSIS 2.0 cable modems using A-TDMA modulation profiles. (The maximum channel
width in mixed mode is 3.2 MHz.)
Changing the DOCSIS mode to mixed mode also automatically changes the symbol rate to 1.28 megasymbols
per second and the channel width to 3.2 MHz. Dynamic upstream modulation is also automatically disabled.

Note Mixed mode upstreams do not support the 6.4 MHz channel width.

The DOCSIS 3.0 specification allows an upstream to be configured in one of the following modes:
• SCDMA-d3 mode—Upstreams only support cable modems that register using DOCSIS 3.0 S-CDMA
modulation profiles.
• SCDMA mode—Upstreams only support cable modems that register using DOCSIS 2.0 S-CDMA
modulation profiles.

Note The DOCSIS 3.0 option scdma-d3 (4SR) is available only when the CMTS is configured to operate in the
global modulation profile format and is not available in the default mode. This option is available only for
the Cisco UBR-MC20X20V cable interface line card, and not for other legacy line cards.

Refer to the cable upstream channel-width command for valid values of supported channel widths and
DOCSIS modes for cable interfaces.

Note Changing the DOCSIS Mode for an Upstream Port Forces the Cable Modems on That Upstream to Go Offline
and Reregister

When you switch the DOCSIS mode of an upstream between the TDMA-only and mixed TDMA/A-TDMA
modes, cable modems that are currently online on that upstream are taken offline and are forced to reregister.
This helps the CMTS to determine the capabilities of the cable modems on the new channels.
If you change an upstream port to A-TDMA only mode, DOCSIS 1.x cable modems will not be able to come
online on that upstream. If you change an upstream to TDMA only mode, DOCSIS 2.0-compliant cable
modems are expected to attempt to come online on another upstream that is configured for A-TDMA or mixed
mode. If no such upstreams are configured, or if the cable modem is configured to use only that particular
upstream, it comes online in the DOCSIS 1.x mode.

Cisco CMTS Cable Command Reference

828
 Cable Commands: cable u through cable w
cable upstream docsis-mode

Note DOCSIS 2.0-compliant cable modems that are already online on a TDMA-only upstream do not automatically
reregister on another upstream that has been configured for mixed-mode operations. The cable modem must
either be reset or the CMTS must send an Upstream Channel Change (UCC) message to instruct the cable
modem to move to the new channel.

If you change an upstream port to the mixed TDMA/A-TDMA mode, and some cable modems remain offline,
or appear to come online but cannot pass traffic, upgrade the modem software to a DOCSIS-compliant software
version.

Note The cable physical plant must support the higher upstream bandwidths and symbol rates to be able to use the
A-TDMA or mixed mode modulation profiles.

Examples The following example configures the first four upstreams for the first downstream on the Cisco
uBR-MC28U/X cable interface line card in slot 5/0. The first two upstreams are configured for
A-TDMA mode and the last two upstreams are configured for mixed TDMA/A-TDMA mode.

Router# configure terminal

Router(config)# interface cable 5/0/0
Router(config-if)# cable upstream 0 docsis-mode atdma

%%Docsis mode set to ATDMA only, 1.x CMs will go offline.

%%The following defaults will be set:
%%Channel Width 6.4MHz
%%Minislot Size 1 tick
%%Modulation Profile 241
Router(config-if)# cable upstream 1 docsis-mode atdma

%%Docsis mode set to ATDMA only, 1.x CMs will go offline.

%%The following defaults will be set:
%%Channel Width 6.4MHz
%%Minislot Size 1 tick
%%Modulation Profile 241
Router(config-if)# cable upstream 2 docsis-mode tdma-atdma

%%Docsis mode set to DOCSIS2.0 Mixed Mode.

Router(config-if)# cable upstream 3 docsis-mode tdma-atdma

%%Docsis mode set to DOCSIS2.0 Mixed Mode.

Router(config-if)# exit

Router(config)# exit

Router#

The following example shows the abbreviations needed to configure TDMA-only and mixed
TDMA/A-TDMA modes.

Router# configure terminal

Router(config)# interface cable 4/0
Router(config-if)# cable upstream 0 docsis-mode tdm
%%Docsis mode set to DOCSIS1.0 TDMA Mode.
Router(config-if)# cable upstream 1 docsis-mode tdma-

Cisco CMTS Cable Command Reference

829
 Cable Commands: cable u through cable w
cable upstream docsis-mode

%%Docsis mode set to DOCSIS2.0 Mixed Mode.

Router(config-if)#

The following examples configures the SCDMA and SCDMA-d3 modes.

Router# configure terminal

Router(config-if)# cable upstream 0 docsis-mode scdma

%interface Cable7/1/0 U0 Docsis mode set to DOCSIS2.0 SCDMA

%modulation profile set to 321
Router(config-if)#
Router# configure terminal
Router(config-if)# cable upstream 0 docsis-mode scdma
-d3
%interface Cable7/1/0 U0 Docsis mode set to DOCSIS3.0 SCDMA (1.x and 2.0 CMs wi)
%modulation profile set to 381
Router(config-if)#
SLOT 7/1: Jul 10 22:04:24.356: %UBR10000-6-PREAMLENADJUST: initial burst's prea.
SLOT 7/1: Jul 10 22:04:24.356: %UBR10000-6-PREAMLENADJUST: station burst's prea.
Router(config-if)# end

Related Commands Command Description

cable modulation-profile Defines a modulation profile for use on the router.

cable modulation-profile global-scheme Defines a global modulation profile for use on the router.

cable upstream channel-width Specifies an upstream channel width for an upstream port.

cable upstream equalization-coefficient Enables the use of a DOCSIS 1.1 pre-equalization coefficient on
an upstream.

cable upstream maintain-psd Requires DOCSIS 2.0 CMs on an A-TDMA-only upstream to

maintain a constant power spectral density after a modulation
rate change.

cable upstream modulation-profile Assigns one or two modulation profiles to an upstream port.

show cable modulation-profile Displays the modulation profile information for a Cisco CMTS.

show interface cable mac-scheduler Displays the current time-slot scheduling state and statistics.

Cisco CMTS Cable Command Reference

830
 Cable Commands: cable u through cable w
cable upstream dpon

cable upstream dpon

To enable the DOCSIS Passive Optical Network (DPON) for a MAC domain on the Cisco CMTS router, use
thecable upstream dpon command in interface configuration mode. To disable one or more DPONs for the
MAC domains, use the no form of this command.

cable upstream dpon

no cable upstream dpon

Syntax Description This command has no arguments or keywords.

Command Default D-PON is not enabled.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

IOS-XE This command is implemented on the Cisco cBR Series Converged Broadband Routers.
3.17.OS

Usage Guidelines Configuring D-PON for a MAC domain enables D-PON for all MAC domains on that line card. However,
only a single MAC domain can be used within a D-PON fiber node. This is to ensure proper scheduling of
the upstream and to prevent multiple Optical Network Terminals (ONTs) from transmitting upstream data at
the same time.

Note On cBR Series Converged Broadband Routers, when the cable upstream dpon command is configured for
a specific MAC domain or interface, it is localized to that MAC domain or interface alone.

You should configure the cable upstream ranging-init-technique 2 command to prevent the use of additional
broadcast initial ranging opportunities for the non-DPON reference upstream channels.
When you shutdown an upstream channel, the D-PON associated with that MAC domain will stop working.
To enable D-PON again, you must manually shut down and enable the MAC domain using the shutdown
and no shutdown command.

Examples The following example shows how to enable D-PON on a Cisco CMTS router:

Router# configure terminal

Router(config)# interface cable 7/0/1
Router(config-if)# cable upstream dpon

Cisco CMTS Cable Command Reference

831
 Cable Commands: cable u through cable w
cable upstream dpon

Router(config-if)# shutdown
Router(config-if)# no shutdown

Related Commands Command Description

cable upstream ranging-init-technique Configures the initial ranging technique for the modem in the
MTC-mode.

interface cable Specifies a cable interface.

show interface cable mac-scheduler Displays the current time-slot scheduling state and statistics.

Cisco CMTS Cable Command Reference

832
 Cable Commands: cable u through cable w
cable upstream dps

cable upstream dps

To enable DOCSIS Predictive Scheduler (DPS) on a MAC domain, use the cable upstream dps command
in cable interface configuration mode.

cable upstream dps { scqam-only | ofdma-only | all }

no cable upstream dps { scqam-only | ofdma-only | all }

Keyword Description

scqam-only Enables DPS for scqam only.

ofdma-only Enables DPS for ofdma only.

all Enable sDPS for scqam and ofdma.

Command Default DPS is in disabled state by default.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z You can configure the cable upstream dps ofdma-only command without
configuring the service internal command in global configuration mode.

IOS XE Amsterdam 17.3.1w This command is introduced on the Cisco cBR Series Converged
Broadband Routers.

Examples The following example shows how to configure DPS on a MAC domain:
Router> enable
Router# configure terminal
Router(config)# interface Cable 7/0/1
Router(config-if)# cable upstream dps scqam-only

Cisco CMTS Cable Command Reference

833
 Cable Commands: cable u through cable w
cable upstream equalization-coefficient

cable upstream equalization-coefficient

To enable the use of a DOCSIS 1.1 or 2.0 pre-equalization coefficient on an upstream port, use the cable
upstream equalization-coefficient command in cable interface configuration mode. To disable the use of
the pre-equalization coefficient, use the no form of this command.

cable upstream n equalization-coefficient

no cable upstream n equalization-coefficient

Syntax Description n Specifies the upstream port number. Valid range is from 0 to 7 for upstream ports in the cable interface
line card.

Command Default Pre-equalization coefficient is disabled.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(4)BC1 This command was introduced.

12.2(15)CX Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X cable interface
line card, including DOCSIS 2.0 A-TDMA and mixed modulation profiles.

12.2(15)BC2 Support was added for DOCSIS 2.0 A-TDMA and mixed modulation profiles on the Cisco
uBR-MC5X20S/U cable interface line cards.

12.3(23)BC6 Support was added for updated default modulation profiles for use with pre-equalization
on the Cisco uBR-MC5X20S/U/H cable interface line cards.

12.2(33)SCB Support was added for updated default modulation profiles for use with pre-equalization
on the Cisco uBR-MC5X20S/U/H cable interface line cards.

IOS-XE This command was replaced by the us-channel equalization-coefficient command.

3.15.OS

Usage Guidelines The DOCSIS 1.1 and 2.0 specifications allow a CMTS to specify a pre-equalization coefficient in the DOCSIS
ranging response (RNG-RSP) MAC management messages it forwards to the cable modems (CM)s. When
this is enabled, a CM can engage in transmit-side equalization (pre-equalization) to mitigate the effects of
certain impairments in the cable plant, such as in-channel tilt, and group delay.
These impairments are more significant with higher order modulation formats such as 64-QAM or 16-QAM,
and near the first octave break-point of the diplex filters (34 MHz to 38 MHz). This break-point exists
predominantly as a time-domain group delay issue, and becomes severe for longer amplifier cascades.
Each amplifier causes the DOCSIS upstream signal to traverse two diplex filters. All diplex filter frequency
splits (5-42 MHz, 5-65 MHz, or 5-88 MHz) share this characteristic, which is not visible in a frequency
response measurement or sweep test.
For more information about the use of pre-equalization, see the DOCSIS 2.0 RFI specification section 6.2.15,
Transmit Pre-Equalizer, and section 8.3.6 Ranging Response (RNG-RSP) MAC Management Messages.

Cisco CMTS Cable Command Reference

834
Cable Commands: cable u through cable w
cable upstream equalization-coefficient

DOCSIS 1.1 specifies the Type 4 type length value (TLV), and an 8-tap equalizer. DOCSIS 2.0 adds the Type
9 TLV, and increases the equalizer to support 24 taps to compensate for more complex impairments.
The cable upstream equalization-coefficient command configures the CMTS to send Type 4 TLV or Type
9 TLVs in the DOCSIS RNG-RSP MAC management messages to the CMs.
The no form of the command disables the CMTS from sending Type 4 TLV or Type 9 TLVs in the DOCSIS
RNG-RSP MAC management messages to the CMs.
After the CMTS stops sending pre-equalization TLVs to the CM, the CM must retain these values until the
modem’s cable interface resets, or a modification is made to the upstream channel descriptor (UCD), which
would make the stored equalization coefficients invalid.
You can reset the cable modem’s interface by:
• Power cycling the cable modem
• Resetting the cable modem from the CMTS using the clear cable modem command

Router# clear cable modem aaaa.bbbb.cccc reset

You can reset the equalizer coefficient of all CMs on an upstream by:
• Changing the upstream center frequency. A 16-kHz or 32-kHz change is sufficient and unlikely to take
many CMs offline.
• Briefly changing the periodic ranging messages in the modulation profile between 16-QAM and Quadrature
Phase Shift Keying (QPSK), or 64-QAM and 16-QAM.
A CMTS operating in a pure DOCSIS 2.0 upstream mode sends equalizer data supporting 24 taps to all
modems during initial ranging.
The cable up 0 docsis-mode atdma command configures a DOCSIS 2.0-only upstream mode on the CMTS.
A CMTS operating in a DOCSIS 1.1 or mixed TDMA-ATDMA upstream mode sends equalizer data supporting
8 taps to all modems during initial ranging. The CMTS cannot send data supporting 24 taps until it is notified
by the CM, that it is DOCSIS 2.0 compliant in the Registration Request (REG-REQ) message, immediately
preceding the online state.
This can be configured on the CMTS using the cable up 0 docsis-mode tdma-atdma command.
When a CM receives a Type 4 TLV in the RNG-RSP MAC management message from the CMTS, it must
combine the previously stored values with the new values from the CMTS. Under certain HFC plant conditions,
a dynamic impairment occurs that require the CM to adjust its main equalizer tap. The DOCSIS standard
specifies a convolution function that is sometimes unable to adjust for dynamic impairments. The result, is a
CM whose signal-to-noise ratio (SNR) value as received by the CMTS, is quite low compared to other CMs
on the same upstream.
In a mixed modulation profile, where station maintenance is of a lower order modulation format than the data
grants, it is possible for the modem to enter a steady state where the SNR estimate is:
• Below the required estimate for data grants to be processed by the CMTS
• Above the requirement for station maintenance
This results in a modem that responds to DOCSIS Layer 2 pings, but not to Layer 3 traffic. The following
commands can be used to check status:
• ping docsis {cm-mac address | cm ip address}—succeeds
• ping ip {cm IP address | CPE IP address}—fails

Cisco CMTS Cable Command Reference

835
 Cable Commands: cable u through cable w
cable upstream equalization-coefficient

A cable modem whose SNR estimate is in this condition may enter the expired(pt) state when baseline privacy
interface plus (BPI+) is enabled. A modulation profile where station maintenance and data grants are of the
same order modulation, prevents this condition.
The CMTS may be configured to enable cable upstream pre-equalization on a per upstream port basis, and
may be configured to disable the sending of upstream equalization-coefficients on a per modem MAC address
or Organizational Unique Identifier (OUI) basis, using the related global exclude commands.
Some DOCSIS 2.0 compliant CMs / embedded media terminal adapters (EMTA)s have been known to report
as DOCSIS 1.1 compliant to the CMTS, unless connected to a DOCSIS 2.0 format upstream. These CMs are
treated by the CMTS as DOCSIS 1.1, and only send 8-tap equalizer coefficients. A firmware or SNMP set
may be used on these cable modems to enable the proper reporting of DOCSIS 2.0 compliance under a DOCSIS
1.1-style upstream (for example, 3.2 MHz, 16-QAM, TDMA format).
Some older DOCSIS cable modem firmware versions will incorrectly process the transition from 8 to 24 taps
when in a mixed TDMA-ATDMA mode, and will experience degrading or low SNR MER as displayed with
show cable modem phy command. Upgrade the CM firmware, and temporarily move these modems to a
pure DOCSIS 1.1 or 2.0 channel or disable pre-equalization for these devices with the exclude command.

Examples The example shows how to enable the use of the pre-equalization coefficient on upstream port 0 in
the cable interface line card in slot 5/1 on the Cisco uBR10012 router, while excluding the equalization
coefficient messaging to a modem with MAC address aaaa.bbbb.cccc, and all modems with the OUI
of 00aa.bb:

Router# configure terminal

Router# cable pre-equalization exclude aaaa.bbbb.cccc
Router# cable pre-equalization exclude 00aa.bb
Router(config)# interface cable 5/1/0
Router(config-if)# cable upstream 0 equalization-coefficient
Router(config-if)#

Related Commands Command Description

show cable modem phy Displays the physical layer RF parameters of the cable modem, including
USSNR estimate (MER).

show cable modem docsis Displays the DOCSIS version of a cable modem, and the upstream
version DOCSIS mode— TDMA or ATDMA.

show cable modem [verbose] Displays detailed information about the cable modem. Lines with the
string Equalizer describe modem specific equalizer data.

debug cable range Debugging commands to display the equalizer coefficients being sent by
the CMTS to the cable modem in the DOCSIS RNG-RSP MAC
management messages.

debug cable interface Debugging commands to display the equalizer coefficients being sent by
{interface} the CMTS to the cable modem in the DOCSIS RNG-RSP MAC
{cm-mac-address}[verbose] management messages.
Caution
Certain debug settings can produce a very large amount of data on a
production router, and should be used with caution. Specifying the CM
mac-address will dramatically reduce the amount of data produced.

Cisco CMTS Cable Command Reference

836
 Cable Commands: cable u through cable w
cable upstream equalization-error-recovery

cable upstream equalization-error-recovery

To enable the pre-equalizer direct load mechanism on an upstream port, use the cable upstream
equalization-error-recovery command in cable interface configuration mode.

cable upstream port number equalization-error-recovery

no cable upstream port number equalization-error-recovery

Syntax Description port number Specifies an upstream port number on a cable interface. Valid range is from 0 to 7.

Command Default This command is enabled by default.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.3(23)BC7 This command was introduced.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The pre-equalizer direct load mechanism is enabled by default. However, to use this direct load mechanism,
you must enable the pre-equalization coefficient on an upstream port using the cable upstream
equalization-coefficient command.
The cable upstream equalization-error-recovery command enables the CMTS to send Type-Length-Value
(TLV) Type 9 in the DOCSIS RNG-RSP MAC management messages. This mechanism helps CMs come
online when TLV Type 4 convolved method causes CMs to go offline.

Note The TLV Type 9, called pre-equalizer direct load, supports only the DOCSIS 2.0 or 3.0-certified modems.
When a CM receives TLV Type 9, the CM replaces its data with the new data provided in the DOCSIS
RNG-RSP MAC management messages.

Examples The example shows how to enable the pre-equalizer direct load mechanism on a cable interface line
card in slot 8/0 on the Cisco uBR10012 router.

Router# configure terminal

Router(config)# interface cable 8/0/0
Router(config-if)# cable upstream 0 equalization-error-recovery

Related Commands Command Description

show cable modem Displays information for the registered and unregistered CMs.

Cisco CMTS Cable Command Reference

837
 Cable Commands: cable u through cable w
cable upstream equalization-error-recovery

Command Description

cable upstream Enables the use of a DOCSIS 1.1 or 2.0 pre-equalization coefficient
equalization-coefficient on an upstream port.

show cable modem calls Displays displays voice call information for a particular CM,
identified either by its IP address or MAC address.

Cisco CMTS Cable Command Reference

838
 Cable Commands: cable u through cable w
cable upstream ext-power

cable upstream ext-power

To enable the DOCSIS extended transmit power support on the Cisco CMTS, use the cable upstream
ext-power command in interface configuration mode. To disable DOCSIS extended transmit power support,
use the no form of this command.

cable upstream ext-power

no cable upstream ext-power

Syntax Description This command has no arguments or keywords.

Command Default DOCSIS extended transmit power support is enabled.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCF2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable upstream ext-power command is used to configure the following feature:
• Upstream Channel Bonding

Examples The following example shows how to enable DOCSIS extended transmit power support on the Cisco
CMTS:

Router# configure terminal

Router(config)# interface cable 7/0/0
Router(config-if)# cable upstream ext-power
Router(config-if)# end

Related Commands Command Description

show cable modem extended-power Displays the list of cable modems that are transmitting at an extended
power level.

Cisco CMTS Cable Command Reference

839
 Cable Commands: cable u through cable w
cable upstream fec

cable upstream fec

To enable upstream forward error correction (FEC), use the cable upstream fec command in cable interface
configuration mode. To disable FEC, use the no form of this command.

cable upstream n fec

no cable upstream n fec

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card.

Command Default Enabled

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

11.3 XA This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The Cisco CMTS uses FEC to attempt to correct any upstream data that might have been corrupted. To use
this feature, you need to activate FEC on the upstream RF carrier. When FEC is activated, the Cisco CMTS
commands all CMs on the network to activate FEC.

Examples The following example shows how to activate upstream forward error correction:

Router (config-if)# cable upstream 0 fec

Related Commands Command Description

cable upstream frequency Enters a fixed frequency of the upstream RF carrier for an upstream port.

cable upstream power-level Sets the input power level for the upstream RF carrier in decibels per millivolt
(dBmV).

cable upstream scrambler Enables the cable upstream scrambler.

cable upstream shutdown Disables the upstream port.

Cisco CMTS Cable Command Reference

840
 Cable Commands: cable u through cable w
cable upstream fec-strength

cable upstream fec-strength

To override the forward error correction (FEC) setting specified in the modulation profile for this upstream
channel, use the cable upstream fec-strength command in cable interface configuration mode. To restore
the default value, use the no form of this command.

cable upstream n fec-strength t-bytes

no cable upstream n fec-strength

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card.

t-bytes Overrides the FEC strength specified in the modulation profile for this upstream channel. Valid values
are from 0 to 10, where:
• 0 disables FEC.
• 1 is the lowest FEC strength.
• 10 is the highest FEC strength.

Command Default No default behavior or values

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.0(4)XI This command was introduced.

12.1T This command was deprecated and removed.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to configure the cable upstream fec-strength command:

Router(config-if)# cable upstream 2 fec-strength 3

Related Commands Command Description

cable upstream channel-width Specifies an upstream channel width for a headend cable router.

cable upstream fec Enables the upstream FEC.

cable upstream hopping blind Disables optimum frequency hopping on the Cisco uBR-MC16S and
Cisco uBR-MC5X20S/U cable interface line cards.

cable upstream modulation-profile Overrides modulation types specified in the modulation profile for
the specified upstream channel.

Cisco CMTS Cable Command Reference

841
 Cable Commands: cable u through cable w
cable upstream fragmentation

cable upstream fragmentation

To enable fragmentation of DOCSIS frames on a particular upstream, use the cable upstream fragmentation
command in cable interface configuration mode. To disable fragmentation, use the no form of this command.

cable upstream n fragmentation

no cable upstream n fragmentation

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card. For Cisco cBR Series Converged Broadband Routers, the valid range is from 0 to 15.

Command Default By default, fragmentation is enabled for all upstream ports on ASIC line cards (Cisco uBR-MC11C, Cisco
uBR-MC12C, Cisco uBR-MC14C, Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C) and
disabled for all upstream ports on old FPGA line cards.

Note Cisco IOS Release 12.1 CX supports the Multiple Grant Mode of DOCSIS 1.1 fragmentation.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.1(4)CX This command was introduced.

12.2(4)BC1 Support for this command was added to the Release 12.2 BC train.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command enables and disables DOCSIS layer 2 fragmentation, which reduces run-time jitter experienced
by constant bit rate (CBR) slots on the corresponding upstream. Disabling fragmentation increases the run-time
jitter, but also reduces the fragmentation reassembly overhead for fragmented MAC frames. For ports running
CBR traffic, fragmentation should be enabled (the default).

Note Do not confuse DOCSIS Layer 2 fragmentation with IP Layer 3 fragmentation.

Examples The following command shows DOCSIS fragmentation being enabled on upstream 0 on the cable
interface in slot 2/0:

Router# configure terminal

Router(config)# interface c2/0
Router(config-if)# cable upstream 0 fragmentation
Router(config-if)#

Cisco CMTS Cable Command Reference

842
 Cable Commands: cable u through cable w
cable upstream fragmentation

Related Commands Command Description

cable default-phy-burst Specifies a value for the upstream Maximum Traffic Burst parameter for
CMs that do not specify their own value.

cable upstream fragment-force Specifies that a cable interface line card should fragment DOCSIS frames
on an upstream when the frame exceeds a particular size.

Cisco CMTS Cable Command Reference

843
 Cable Commands: cable u through cable w
cable upstream fragment-force

cable upstream fragment-force

To specify that a cable interface line card should fragment DOCSIS frames on an upstream when the frame
exceeds a particular size, use the cable upstream fragment-force command in cable interface configuration
mode. To set the fragment size to its default value, use the no form of this command.

cable upstream n fragment-force [fragment-threshold [number-of-fragments]]

no cable upstream n fragment-force

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream
port on the cable interface line card. For Cisco cBR Series Converged Broadband
Routers, the valid range is from 0 to 15.

fragment-threshold (Optional) Number of bytes for the threshold at which DOCSIS frames are fragmented.
The valid value ranges from 1,500 to 3,500 bytes, with the default value of 2,000 bytes.
For Cisco uBR10-MC5X20S cable interface line card running Cisco IOS Release
12.3(23)BC1, the valid value ranges from 0 to 1,987 bytes, with the default value of
1,600 bytes.

number-of-fragments (Optional) Number of fragments that the cable interface line card should create when
fragmenting DOCSIS frames. The card attempts to create this many equal-sized
fragments when fragmenting. The valid value ranges from 1 to 10 fragments, with the
default value of 3 fragments.
The number-of-fragments option has been deprecated. See Usage Guidelines section
for more details.

Command Default • Default value for fragment-threshold is 2,000 bytes.

• For Cisco uBR10-MC5X20S cable interface line card running Cisco IOS Release 12.3(23)BC1, default
value for fragment-threshold is 1,600 bytes.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(15)BC2 This command was introduced.

12.3(21a)BC This command was modified and the number-of-fragments option has been deprecated.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines DOCSIS 1.1 allows the CMTS to fragment DOCSIS frames to improve performance, especially in networks
that combine real-time traffic, such as voice, with data traffic. The cable upstream fragment-force command

Cisco CMTS Cable Command Reference

844
 Cable Commands: cable u through cable w
cable upstream fragment-force

allows you to specify the size of frames that should be fragmented, as well as the number of fragments that
should be created when fragmenting.

Tip This command takes effect only when fragmentation has been enabled on the upstream using the cable
upstream fragmentation command (which is the default configuration). Whether fragment is enabled or not,
is decided by the cable upstream fragmentation command.

In the default configuration, the Cisco CMTS fragments DOCSIS frames that are 2,000 bytes or larger in size,
and it fragments these frames into equally-sized fragments. Starting from Cisco IOS Release 12.2(21a)BC,
12.2(33)SCB, and later releases, the larger frames are fragmented by the threshold. Instead of dividing frames
into equal number of fragments as before, the concatenated frames are cut into many fragments, as defined
in the threshold size, with the last one being the shortest. For example, the previous form of the cable upstream
fragment-force command fragments a concatenated frame of 9000 into 5 frames of 1800. The new form of
the cable upstream fragment-force command fragments a concatenated frame of 9000 into frames of 2000,
2000, 2000, 2000, and 1000.
Do not use a fragment size greater than 1,600 bytes on the Cisco uBR10-MC5X20S cable interface line card
running Cisco IOS Release 12.3(23)BC1. Do not use a fragment size greater than 2,000 bytes on the Cisco
uBR10-MC5X20U cable interface line card, and do not use a fragment size greater than 3,500 bytes on all
other cable interface line cards, unless otherwise instructed by a Cisco TAC engineer.
When using DOCSIS concatenation, you might need to change the cable default-phy-burst command from
its default size, so that multiple frames can be concatenated into a maximum-sized burst. If you set the cable
default-phy-burst command to zero, the max burst then becomes the lowest of 255 mini-slots, the maximum
concatenated burst setting in the DOCSIS configuration file, or the value of the long data grant burst that is
specified in the upstream’s profile.
When you set the cable default-phy-burst command to zero, the CMTS fragments large requests into big
chunks and the cable modems will not be able to register on specific groupings of upstream interfaces due to
the large fragment size. We recommend the use of a fragment size of 2,000 bytes, if you want to set the cable
default-phy-burst command to zero to provide upstream speed of above 5 Mbps.

Caution Ensure that the number-of-fragments parameter is large enough to keep the size of each fragment of a
maximum-sized burst less than the 1,600 bytes or 2,000 bytes or 3,500 bytes specified above. If fragments
are too large, the cable modem might not be able to come online or pass traffic.

Note The number-of-fragments option has been deprecated from Cisco IOS Release 12.2(21a)BC, 12.2(33)SCB,
and later releases.

Note Do not confuse DOCSIS Layer 2 fragmentation with IP Layer 3 fragmentation.

Examples The following example shows how to enable DOCSIS fragmentation on frames that are 1,500 bytes
or larger, using four fragments per frame:

Cisco CMTS Cable Command Reference

845
 Cable Commands: cable u through cable w
cable upstream fragment-force

Router# configure terminal

Router(config)# interface c2/0
Router(config-if)# cable upstream 0 fragment-force 1500 4
Router(config-if)#

The following example shows how to disable the forced fragmentation of DOCSIS frames on an
upstream. This also resets the fragment-threshold parameter to default value.

Router# configure terminal

Router(config)# interface c5/1/0
Router(config-if)# no cable upstream 0 fragment-force
Router(config-if)#

Cisco IOS Release 12.2(21a)BC, 12.2(33)SCB and Later

The following example shows how to enable DOCSIS fragmentation on frames that are 2,000 bytes
or larger:

Router# configure terminal

Router(config)# interface c2/0
Router(config-if)# cable upstream 0 fragment-force 2000
Router(config-if)#

Related Commands Command Description

cable default-phy-burst Specifies a value for the upstream Maximum Traffic Burst parameter for
CMs that do not specify their own value.

cable upstream fragmentation Enables fragmentation of DOCSIS frames on a particular upstream.

Cisco CMTS Cable Command Reference

846
 Cable Commands: cable u through cable w
cable upstream freq-adj averaging

cable upstream freq-adj averaging

To specify the percentage of frequency adjustment packets that is required to change the adjustment method
from the regular power-adjustment method to the noise power-adjustment method, use the cable upstream
freq-adj averaging command in cable interface configuration mode. To disable power adjustments, use the
no form of this command.

cable upstream n freq-adj averaging % of frequency adjustment

no cable upstream n freq-adj averaging

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream
port on the cable interface line card. For Cisco cBR Series Converged Broadband
Routers, the valid range is from 0 to 15.

% of frequency Specifies the percentage of frequency-adjustment packets required to switch from

adjustment the regular power-adjustment method to the noise power-adjustment method. Valid
range is from 10 to 100 percent.

Command Default No default behavior or values

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.0(7)T This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows how to change the power-adjustment method when the
frequency-adjustment packet count reaches 50 percent:

Router(config-if)# cable upstream 0 freq-adj averaging 50

Related Commands Command Description

cable upstream power-adjust Controls power-adjustment methods on the Cisco CMTS.

show cable flap-list Displays a list of CMs that have exceeded the threshold number of power
adjustments.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

847
 Cable Commands: cable u through cable w
cable upstream frequency

cable upstream frequency

To enter a fixed frequency of the upstream radio frequency (RF) carrier for an upstream port, use the cable
upstream frequency command in cable interface configuration mode. To restore the default value for this
command, use the no form of this command.

cable upstream n frequency up-freq-hz

no cable upstream n frequency up-freq-hz

Syntax Description n Specifies the upstream port number on the cable interface line card for which you want to assign
an upstream frequency. Valid values start with 0 for the first upstream port on the cable interface
line card.

up-freq-hz The upstream center frequency is configured to a fixed Hertz (Hz) value. The valid upstream
frequency range is 5 MHz (5000000 Hz) to 42 MHz (42000000 Hz), 55 MHz (55000000 Hz),
or 65 MHz (65000000 Hz), depending on the cable interface line card being used. If you wish
to have the Cisco CMTS dynamically specify a center frequency for the given upstream interface,
do not enter any frequency value.

For D30 CMs, the upstream path selection will look at CM Capability TLV 5.20 to determine the upstream
frequency range supported by the CM. The frequency range can either be Standard (5MHz to 42MHz), or
Extended (5MHz to 85MHz). This new configuration is intended to be used by customers who are configuring
US spectrum above 42MHz. The configuration ensures that only the D30 CMs supporting Standard US
frequency range are excluded from US channels above 42Mhz.

cable us-freq-use-cm-cap
no cable us-freq-use-cm-cap
The default value of the config is no cable us-freq-use-cm-cap. Therefore, by default there is no change in
behavior.

Command Default Dynamic (not fixed frequency)

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

11.3 XA This command was introduced.

12.0(13)SC Support for the higher EuroDOCSIS upstream range (5 to 65 MHz) was introduced
for the Cisco uBR-MC16E cable interface line card.

12.1(4)EC, 12.2(4)BC1 Support for the higher EuroDOCSIS upstream range (5 to 65 MHz) was introduced
for the Cisco uBR7111E and Cisco uBR7114E routers.

12.2(15)BC2 The allowable range of frequencies that you can select with this command is
determined by the configuration of the upstream freq-range command.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers. This command is replaced by us-channel frequency command.

Cisco CMTS Cable Command Reference

848
 Cable Commands: cable u through cable w
cable upstream frequency

Usage Guidelines The upstream channel frequency of your RF output must be set to comply with the expected input frequency
of your cable interface line card. To configure an upstream channel frequency, you may:
• Configure a fixed frequency between the allowable ranges and enable the upstream port, or
• Create a global spectrum group, assign the interface to it, and enable the upstream port.
The allowable range for the upstream channel frequency depends on the cable interface line card and Cisco
IOS software release being used. The following table provides the currently supported values.

Table 19: Allowable Frequency Range for the cable upstream frequency Command

Frequency Range Supported Cable Interfaces Minimum Cisco IOS Releases

5 to 42 MHz All supported cable interfaces All releases supported for the Cisco
CMTS

5 to 55 MHz Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, Cisco IOS Release 12.2(15)BC2

Cisco uBR-MC5X20U

5 to 65 MHz Cisco uBR-MC16E, Cisco uBR-MC16U/X, Cisco Cisco IOS Release 12.0(13)SC,
uBR-MC28U/X, Cisco uBR-MC5X20U, Cisco 12.1(4)EC, and 12.2(4)BC1
uBR7111E and Cisco uBR7114E routers

Note In Cisco IOS Release 12.2(15)BC2 and later releases, the allowable range of frequencies that you can select
with the cable upstream frequency command is determined by the configuration of the upstream freq-range
command.

Tip If both a Cisco uBR-MC16E cable interface line card and a Cisco uBR-MC16C and/or a Cisco uBR-MC16S
cable interface line card are present in the chassis, a spectrum group in the 42 MHz to 65 MHz range should
not be assigned.

To configure the default upstream frequency (which is no fixed frequency), enter the cable upstream n>
frequency command without specifying a center frequency.

Examples The following example shows how to configure the upstream center frequency for port 0, located in
slot 6, to 5,700,000 Hz:

Router(config-if)# cable upstream 0 frequency 5700000

Router(config-if)# exit
Router(config)# exit
Router# show running-config | include frequency
cable upstream 0 frequency 5696000

Router#

Cisco CMTS Cable Command Reference

849
 Cable Commands: cable u through cable w
cable upstream frequency

Note Cisco cable interface line cards always program the upstream’s center frequency in 16 KHz increments,
and this is the frequency displayed by the lines added to the router’s configuration and by the show
controllers cable upstream command. For example, if you use the cable upstream frequency
command to specify a center frequency of 27 MHz (cable upstream x frequency 27000000), the
actual center frequency will be 27.008 MHz, which is the next highest 16 KHz boundary. The
configuration file will therefore show the line cable upstream 0 frequency 27008000.

The following example shows how to configure the upstream center frequency to a frequency
(54,700,000 Hz) within the extended Japanese frequency range:

Router# configure terminal

Router(config)# upstream freq-range japanese
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 0 frequency 54000000
Router(config-if)# exit
Router(config)# exit
Router#

The following example shows how to allow the Cisco CMTS to dynamically specify a center frequency
for the upstream port 0:

Router(config-if)# no cable upstream 0 frequency

The following command example from Cisco IOS Release 12.3 BC illustrates the allowable upstream
frequency range in Hz:

Router(config-if)# cable upstream 3 frequency ?

<5000000-55000000> Upstream Frequency in Hz

Related Commands Command Description

cable spectrum-group (global Creates spectrum groups, which contain one or more upstream
configuration) frequencies.

show controllers cable Displays information about the cable interface, including the
upstream center frequency.

upstream freq-range Configures the Cisco CMTS router for the range of frequencies
that are acceptable on upstreams.

Cisco CMTS Cable Command Reference

850
 Cable Commands: cable u through cable w
cable upstream hopping blind

cable upstream hopping blind

To override hop decisions, use the cable upstream hopping blind command in cable interface configuration
mode. To stop blind hopping, enter the noform of this command.

cable upstream n hopping blind

no cable upstream n hopping blind

Syntax Description n Specifies the upstream port for which blind frequency hopping will be activated. Valid values start with
0 for the first upstream port on the cable interface line card.

Command Default Disabled (hopping is optimized)

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.0(7)XR2 This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Enter this command to override the hardware spectrum manager’s decision to optimize hopping.

Note Do not use this command unless you have a specific reason to disable optimum hopping configurations. For
example, if you are experimenting with a Cisco uBR-MC16S or Cisco uBR-MC5X20S/U card, you can use
this command to enforce blind hopping on individual upstream channels.

Examples The following example shows how to specify hopping blind on the upstream port 0:

Router(config-if)# cable upstream 0 hopping blind

Related Commands Command Description

cable monitor Configures preset modulation profiles that you can apply to one
or more upstream cable interfaces when you identify and configure
spectrum groups.

cable spectrum-group (global Configures spectrum management characteristics for the given
configuration) spectrum group.

cable upstream channel-width Specifies the channel width of the given upstream cable interface.

cable upstream frequency Specifies the center frequency for a given upstream cable interface.

Cisco CMTS Cable Command Reference

851
 Cable Commands: cable u through cable w
cable upstream hopping blind

Command Description

cable upstream power-level Specifies the upstream cable interface receive power level in
dBmV.

cable upstream shutdown Activates or shuts down a specified upstream cable interface.

Cisco CMTS Cable Command Reference

852
 Cable Commands: cable u through cable w
cable upstream hop-priority

cable upstream hop-priority

To configure the priority of the corrective actions to be taken when a frequency hop is necessary due to ingress
noise on the upstream, use the appropriate cable upstream hop-priority command in cable interface
configuration mode.

cable upstream n hop-priority frequency modulation channel-width

cable upstream n hop-priority modulation frequency channel-width
cable upstream n hop-priority frequency channel-width modulation

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port
on the cable interface line card.

frequency, modulation, Specifies the priority of corrective actions to be taken when ingress noise occurs
channel-width on a downstream.
Note
The channel-width option must come after the frequency option, either
immediately or after the modulation option, as shown in the above examples.

Command Default The default priority is frequency, modulation, and channel-width.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(7)CX1 This command was introduced for Cisco uBR7200 series routers using the Cisco
uBR-MC16S cable interface line card.

12.2(8)BC2 Support was added for the Cisco uBR10012 router and the Cisco
uBR-LCP2-MC16S cable interface line card.

12.2(11)CY, 12.2(11)BC3 Support was added for the Cisco uBR10-MC5X20S cable interface line card on
the Cisco uBR10012 router.

12.2(15)BC2 Support was added for the Cisco uBR10-MC5X20U cable interface line card on
the Cisco uBR10012 router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers. This command is replaced by us-channel hop-priority command.

Usage Guidelines This command specifies the priority of the corrective actions that should be taken when a frequency hop is
necessary to correct excessive ingress noise on an upstream. For example, if the upstream on a Cisco
uBR-MC16S card is set for the default settings (frequency, modulation, and channel-width), the following
occurs when the upstream noise exceeds the CNR threshold value for the current modulation profile:
1. The Cisco uBR-MC16S changes to a new frequency, if a clean frequency is available in its spectrum
group.

Cisco CMTS Cable Command Reference

853
 Cable Commands: cable u through cable w
cable upstream hop-priority

2. If no clean frequency is available, the Cisco uBR-MC16S uses the Dynamic Upstream Modulation feature
to switch the upstream to the secondary modulation profile.
3. If the noise levels still exceed the CNR threshold value for the secondary modulation profile, and if the
upstream has been configured for a range of channel widths, the Cisco uBR-MC16S narrows the channel
width of the upstream by half. If the noise levels are still excessive, the channel width is again cut in half,
and this process continues until a clean upstream is found or the bandwidth is reduced to the minimum
channel width that has been configured using the cable upstream channel-width command.
Allowable DOCSIS channel widths are 3.2 MHz, 1.6 MHz, 800 KHz, 400 KHz, and 200 KHz. If the channel
width drops to 200 KHz, but the noise still exceeds the SNR threshold, the CMs go offline.

Note The default specifies only a single channel width of 1.6 MHz. If this is not changed to specify a range of
allowable channel widths (using the cable upstream channel-width command), the Cisco uBR-MC16S does
not attempt to change the channel width.

To use the Dynamic Upstream Modulation feature, you must first create two modulation profiles (using the
cable modulation-profile command) and assign them to the upstream (using the cable upstream
modulation-profile command).

Examples The following example shows that when ingress noise on the upstream exceeds the threshold allowed
for the primary modulation profile, the Cisco uBR-MC16S line card should first switch to the
secondary modulation profile, then try frequency hopping, and if that fails to correct problem, to
finally try narrowing the channel width:

Router(config)#interface cable 3/0

Router(config-if)#cable upstream 0 hop-priority modulation frequency channel-width
Router(config-if)#exit
Router(config)#

Related Commands Command Description

cable modulation-profile Creates a cable modulation profile.

cable upstream channel-width Configures an upstream for a range of allowable channel widths.

cable upstream modulation-profile Configures an upstream for one modulation profile (static profile) or
two modulation profiles (Dynamic Upstream Modulation).

show cable hop Displays the current hop period and threshold for an upstream, along
with other statistics.

show cable modulation-profile Displays the cable modulation profiles that have been created.

Cisco CMTS Cable Command Reference

854
 Cable Commands: cable u through cable w
cable upstream ingress-noise-cancellation

cable upstream ingress-noise-cancellation

To configure how often a cable interface line card should train its noise-cancellation circuitry so as to adjust
to noise levels on the upstream, use the cable upstream ingress-noise-cancellation command in cable interface
configuration mode. To disable the ingress noise cancellation feature, use the no form of this command.

cable upstream n ingress-noise-cancellation interval

no cable upstream n ingress-noise-cancellation

Syntax Description n Upstream port number. Valid values start with 0 for the first upstream port on the cable interface
line card.

interval Triggering interval, in milliseconds. The valid range is 10 to 3000 milliseconds, with a default value
of 100 milliseconds.

Command Default The default interval is 100 milliseconds.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(15)CX This command was introduced for the Cisco uBR-MC16U/X and Cisco
uBR-MC28U/X cable interface line cards on the Cisco uBR7246VXR router.

12.3(17b)BC4 Support was added for the Cisco uBR10-MC5X20H broadband processing engine
on the Cisco uBR10012 router.

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

12.2(23)BC10 and later The default interval was changed to 100 milliseconds.
12.2(33)SCB11 and later
12.2(33)SCC6 and later
12.2(33)SCD6 and later
12.2(33)SCE and later
12.2(33)SCF and later

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers. This command is replaced by us-channel ingress-noise-cancellation
command.

Cisco CMTS Cable Command Reference

855
 Cable Commands: cable u through cable w
cable upstream ingress-noise-cancellation

Usage Guidelines

Note This command is available only on the Cisco uBR10-MC5X20H BPE, Cisco uBR-MC16U/X, and Cisco
uBR-MC28U/X cable interface line cards. It cannot be used on other cable interface line cards.

Cable interface line cards, such as the Cisco uBR-MC28U/X cards, contain advanced hardware-based noise
cancellation circuitry that digitally removes in-channel impairments such as ingress, common path distortion,
and certain types of impulse noise. To configure how often these line cards should train their noise cancellation
circuity, so as to adapt to changes in the noise types and levels, use the cable upstream
ingress-noise-cancellation command.
When you enable ingress noise cancellation on an upstream, the Cisco CMTS periodically schedules a
256-symbol idle slot on the upstream channel. The interval option specified in the cable upstream
ingress-noise-cancellation command determines how often this idle slot is generated.
The default for BPE cards is for the card to train its circuitry every 100 milliseconds. The smaller the triggering
interval, the faster the card can adjust to changes in ingress noise, which makes the upstream more robust to
noise problems, but at the cost of decreasing bandwidth on the upstream channel. To determine the bandwidth
cost, in percentage of raw bandwidth, use the following formula:

(256/interval)/channel-symbol-rate

where interval is the time period in milliseconds specified by the cable upstream ingress-noise-cancellation
command, and channel-symbol-rate is the symbol rate in kilohertz. For example, if the upstream is using a
2.56 MHz channel rate and a noise cancellation interval of 10 milliseconds, the bandwidth cost is 1% of the
total raw bandwidth:

(256/10)/2560 = 0.01 (1% of bandwidth)

Broadband Processing Engine Support

The cable upstream ingress-noise-cancellation command is required on the Cisco uBR10-MC5X20H
broadband processing engine (BPE) to enable ingress noise cancellation.
The Cisco uBR10-MCX520S/U BPEs have ingress noise cancellation capability enabled by default, so no
configuration of ingress noise cancellation is available in the Cisco IOS software for these cards.
However, for configuration compatibility in support of high availability among Cisco uBR10-MC5X20S/U/H
cards, the Cisco IOS software will accept configuration of the cable upstream ingress-noise-cancellation
command for these BPEs without generating any warning or error when synchronizing the configuration.

Examples The following example shows how to configure the first upstream on a Cisco uBR-MC16U/X or
Cisco uBR-MC28U/X card to perform ingress noise cancellation every 300 milliseconds:

interface cable 5/0

cable upstream 0 ingress-noise-cancellation 300

Related Commands Command Description

cable modulation-profile Defines a modulation profile for use on the router.

cable upstream channel-width Specifies an upstream channel width for an upstream port.

Cisco CMTS Cable Command Reference

856
Cable Commands: cable u through cable w
cable upstream ingress-noise-cancellation

Command Description

cable upstream docsis-mode Configures an upstream to use either DOCSIS 1.x or DOCSIS 2.0
modulation profiles.

cable upstream frequency Enters a fixed frequency of the upstream RF carrier for an upstream
port.

cable upstream minislot-size Specifies the minislot size (in ticks) for a specific upstream interface.

cable upstream modulation-profile Assigns one or two modulation profiles to an upstream port.

cable upstream power-level Sets the input power level for the upstream RF carrier in decibels per
millivolt (dBmV).

show cable hop Displays CM configuration settings.

show cable modulation-profile Displays the modulation profile information for a Cisco CMTS.

show interface cable mac-schedule Displays the current time-slot scheduling state and statistics.

show interface cable sid Displays cable interface information.

Cisco CMTS Cable Command Reference

857
 Cable Commands: cable u through cable w
cable upstream jumbo-grants

cable upstream jumbo-grants

To allow jumbo grants, use the cable upstream jumbo-grants command. To disable jumbo grants, use the
no form of this command.

no
cable upstream n jumbo-grants

Syntax Description jumbo-grants Allows jumbo grants

n Specifies the upstream port number. Valid values start with 0 for the first upstream port on
the cable interface line card. For cBR Series Converged Broadband Routers, the valid range
is from 0 to 15.

Command Default Jumbo grants are disabled by default.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Example
The following sample shows and example of the cable upstream jumbo-grants command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) # cable upstream 0 jumbo-grants
Router(config-profile-md)#end

The following sample shows and example of the no cable upstream jumbo-grants command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) # no cable upstream 0 jumbo-grants
Router(config-profile-md)#end

Cisco CMTS Cable Command Reference

858
 Cable Commands: cable u through cable w
cable upstream load-balance group

cable upstream load-balance group

To assign an upstream to a load-balance group, use the cable upstream load-balance group command in
interface configuration mode. To remove an upstream from a load-balance group, use the no form of this
command.

cable upstream uport load-balance group n

no cable upstream uport load-balance group n

Syntax Description uport Specifies the upstream port that should be assigned to the load-balance group. Upstream port values
start with 0 and end with a value that depends on the number of upstream ports on the cable interface
line card.

n Specifies the number of the load-balance group to which the upstream should be assigned. In Cisco
IOS Release 12.2(33)SCE3 and earlier, the valid range is from 1 to 80. In Cisco IOS Release
12.2(33)SCE4 and later, the valid range is from 1 to 256.

Command Default An upstream is not assigned to any load-balance groups. If you use the cable load-balance group (interface
configuration) command to assign a downstream interface to a load-balance group, all its upstreams are
automatically assigned to the same group until you use the cable upstream load-balance group command
to reassign an upstream to a different group.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.2(33)SCE4 The valid range for the load balance group was changed.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable upstream load-balance group command is used to configure the following feature:
Load Balancing and Dynamic Channel Change on the Cisco CMTS Routers
After you have used the cable load-balance group (global configuration) command to initially create and
configure a load-balance group, use the cable upstream load-balance group command to assign this
load-balance group to an upstream. This enables the cable interface to begin participating in load-balancing
operations.

Tip Use the cable load-balance group (interface configuration) command to assign this load-balance group to
a downstream.

The following rules apply when creating and assigning load-balance groups:
• A downstream or upstream can belong to only one load-balance group.

Cisco CMTS Cable Command Reference

859
 Cable Commands: cable u through cable w
cable upstream load-balance group

• All downstreams and upstreams in a load-balance group must share physical radio frequency (RF)
connectivity to the same group of cable modems. Downstreams can be in a separate load-balance group
than upstreams, but all downstreams or all upstreams that have the same RF physical connectivity must
be members of the same load-balance group. You cannot distribute downstreams or upstreams that share
physical connectivity across multiple load-balance groups.
• Load balancing is done only on a per-chassis basis—all interfaces in a load-balance group must be in
the same chassis.

Examples The following example shows how to assign the first four upstreams for cable interface 5/1 to load
balance group 14:

Router# config terminal

Router(config)# interface cable 5/1/0
Router(config-if)# cable upstream 0 load-balance group 14
Router(config-if)# cable upstream 1 load-balance group 14
Router(config-if)# cable upstream 2 load-balance group 14
Router(config-if)# cable upstream 3 load-balance group 14
Router(config-if)#

Related Commands Command Description

cable load-balance exclude Excludes a particular cable modem, or all cable modems from
a particular vendor, from one or more types of load-balancing
operations.

cable load-balance group (global Creates and configures a load-balance group.

configuration)

cable load-balance group (interface Assigns a downstream to a load-balance group.

configuration)

cable load-balance group interval Configures the frequency of the load-balancing policy updates.

cable load-balance group policy ugs Configures how the Cisco CMTS should load balance cable
modems with active unsolicited grant service (UGS) service
flows.

cable load-balance group threshold Configures the threshold values that a load-balance group should
use for load-balancing operations.

clear cable load-balance Clears the counters or state machine used to track load-balancing
operations.

show cable load-balance Displays real-time statistical and operational information for
load-balancing operations.

Cisco CMTS Cable Command Reference

860
 Cable Commands: cable u through cable w
cable upstream maintain-psd

cable upstream maintain-psd

To require DOCSIS 2.0 CMs on an A-TDMA-only upstream to maintain a constant power spectral density
(PSD) after a modulation rate change, use the cable upstream maintain-psd command in cable interface
configuration mode. To return to the default behavior, so that CMs do not need to maintain their power spectral
density, use the no form of this command.

cable upstream uport maintain-psd

no cable upstream uport maintain-psd

Syntax Description uport Specifies the upstream port to be configured. Upstream port values start with 0 and end with a value
that depends on the number of upstream ports on the cable interface line card.

Command Default Cable modems are not required to maintain their power spectral density after a modulation rate change (no
cable upstream maintain-psd)

Note In Cisco IOS Release 12.2(15)BC2 and later releases, this command is automatically removed from the
configuration when you configure an upstream for a TDMA-only or mixed TDMA/A-TDMA configuration.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.2(15)CX This command was introduced to support DOCSIS 2.0 operations on the Cisco
uBR-MC16U/X and Cisco uBR-MC28U/X cable interface line card.

12.2(15)BC2 Support was added for DOCSIS 2.0 operations on the Cisco uBR-MC5X20S/U cable
interface line cards.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS This command is replaced by us-channel maintain-psd command.

Usage Guidelines Use this command to specify whether DOCSIS 2.0 CMs should maintain their power spectral density when
the Cisco CMTS changes their upstream modulation rate in an upstream channel descriptor (UCD) message.
When you configure an upstream with the cable upstream maintain-psd command, the Cisco CMTS sets
TLV 15 (Maintain Power Spectral Density) to ON in the UCD messages it sends to the CMs on that upstream.
When TLV 15 is on, and when the new UCD specifies a new upstream modulation rate for the CM, the CM
must change its transmit power level to keep its power spectral density as close as possible to what it was
before the modulation rate change. The CM must maintain this power spectral density until the CMTS sends
a power adjustment command in a Ranging-Response (RNG-RSP) message.
The default configuration (no cable upstream maintain-psd) configures TLV 15 to OFF, and CMs are not
required to maintain their power spectral density after a modulation rate change. However, per the DOCSIS
specifications, the CMs continue to maintain constant total input power on the upstream.

Cisco CMTS Cable Command Reference

861
 Cable Commands: cable u through cable w
cable upstream maintain-psd

Note This command affects only DOCSIS 2.0 CMs that are online an upstream that is configured for the DOCSIS
2.0 A-TDMA-only mode. This command has no effect on DOCSIS 1.0 and DOCSIS 1.1 CMs, which will
continue to maintain constant total input power on the upstream, per the DOCSIS 1.x specifications.

Examples The following example shows how to configure four upstreams on a cable interface line card to
require cable modems to maintain a constant power spectral density after a modulation rate change.

Router# configure terminal

Router(config)# interface cable c6/1/0
Router(config-if)# cable upstream 0 maintain-psd
Router(config-if)# cable upstream 1 maintain-psd
Router(config-if)# cable upstream 2 maintain-psd
Router(config-if)# cable upstream 3 maintain-psd
Router(config-if)# exit
Router(config)# exit
Router#

The following example shows how to configure an upstream for the default behavior, which is that
CMs are not required to maintain a constant power spectral density after a modulation rate change,
but do continue to maintain constant total input power levels on the upstream.

Router# configure terminal

Router(config)# interface cable c5/1/0
Router(config-if)# no cable upstream 0 maintain-psd
Router(config-if)# exit
Router(config)# exit
Router#

Related Commands Command Description

cable upstream docsis-mode Configures an upstream to use either DOCSIS 1.x or DOCSIS 2.0 modulation
profiles.

Cisco CMTS Cable Command Reference

862
 Cable Commands: cable u through cable w
cable upstream max-channel-power-offset

cable upstream max-channel-power-offset

To set the power budget offset value on the Cisco CMTS router for the reduced upstream channel set
assignment, use the cable upstream max-channel-power-offset command in cable interface configuration
mode. To disable this configuration, use the no form of this command.

cable upstream max-channel-power-offset dB-value

no cable upstream max-channel-power-offset dB-value

Syntax Description dB-value Decibel value for the upstream channel transmit power. The valid range is from 1 to 6. The default
is 3.
Note
Effective with Cisco IOS Release 12.2(33)SCH1 and Cisco IOS Release 12.2(33)SCG5, the valid
range is from 0 to 6.

Command Default The power budget offset is configured with the default value of 3 dB.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

Cisco IOS Release 12.2(33)SCE3 This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines The threshold value specified for the power budget offset (max-channel-power-offset) must be less than the
power threshold value (power-adjust continue) that determines the value of the Ranging Status field in the
Ranging Response (RNG-RSP) messages that the Cisco CMTS router sends to the cable modem. You can
specify the power threshold value using the cable upstream power-adjust command.

Examples The following example shows how to enable the Cisco CMTS router to reduce the channel set
assignment based on the total power budget of the cable modem in Cisco IOS Release 12.2(33)SCE3:

Router# configure terminal

Router(config)# interface cable 7/0/0
Router (config-if)# cable upstream max-channel-power-offset 5

Related Commands Command Description

cable tx-power-headroom Specifies the extended transmit power on the Cisco CMTS router.

show cable modem Displays transmit power values for each assigned upstream channel along with
cable modem details.

Cisco CMTS Cable Command Reference

863
 Cable Commands: cable u through cable w
cable upstream max-codes-per-subframe

cable upstream max-codes-per-subframe

To specify the upper limit to override the maximum value of codes-per-subframe defined in the individual
modulation profile setting for an upstream channel, use the cable upstream max-codes-per-subframe
command in cable interface configuration mode. To specify the default value of 2 to maximum
codes-per-subframe, use the no form of this command.

cable upstream n max-codes-per-subframe code

no cable upstream n max-codes-per-subframe

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the cable interface
line card.

code Specifies the number of codes-per-subframe. Valid values range from 1 to 128, with a default value
of 2.

Command Default The maximum codes per subframe setting cannot be applied if the Synchronous Code Division Multiple
Access (S-CDMA) is not configured.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is applicable only for S-CDMA channels. You should configure S-CDMA to apply the the
maximum codes-per-subframe setting. The number of codes-per-subframe should not exceed the number of
active codes.

Examples The following example sets the number of codes-per-subframe to 128 on the upstream port 0:

Router(config)# interface cable 7/0/4

Router(config-if)# cable upstream 0 max-codes-per-subframe 128
Router(config-if)#

Related Commands Command Description

cable upstream active-codes Specifies the number of active codes allowed on an upstream channel.

cable upstream codes-per-minislot Specifies the number of codes-per-minislot allowed on an upstream

channel.

cable upstream spreading-interval Specifies the spreading interval for S-CDMA on an upstream channel.

Cisco CMTS Cable Command Reference

864
 Cable Commands: cable u through cable w
cable upstream max-interleave-step

cable upstream max-interleave-step

To specify the upper limit to override the maximum interleave step for each burst defined in the modulation
profile for the upstream channel, use the cable upstream max-interleave-step command in cable interface
configuration mode. To specify the default interleave step size of 1, use the no form of this command.

cable upstream n max-interleave-step max-interleave-step

no cable upstream n max-interleave-step

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the
cable interface line card.

max-interleave-step Specifies the maximum number of interleave steps. Valid values range from 1 to 31,
with a default value of 1.

Command Default The maximum interleave step setting cannot be applied if the Synchronous Code Division Multiple Access
(S-CDMA) feature is not configured.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is applicable only for S-CDMA channels and the command limits the maximum number of
interleave steps for a given upstream port. The max-interleave-step value should be less than the
spreading-interval value specified using the cable upstream spreading-interval command.

Examples The following example sets the number of interleave steps to 31 on the upstream port 0:

Router(config)# interface cable 7/0/4

Router(config-if)# cable upstream 0 max-interleave-steps 31
Router(config-if)#

Related Commands Command Description

cable upstream active-codes Specifies the number of active codes that can be configured on
an upstream channel.

cable upstream codes-perminislot Specifies the number of codes-per-minislot allowed on an upstream

channel.

cable upstream Specifies the upper limit and the maximum value of
max-codes-per-subframe codes-per-subframe defined in the individual modulation profile
setting for an upstream channel.

Cisco CMTS Cable Command Reference

865
 Cable Commands: cable u through cable w
cable upstream max-interleave-step

Command Description

cable upstream spreading-interval Specifies the spreading interval for SCDMA on an upstream
channel.

Cisco CMTS Cable Command Reference

866
 Cable Commands: cable u through cable w
cable upstream max-logical-chans

cable upstream max-logical-chans

To specify the number of logical channels on a physical port, use the cable upstream max-logical-chans
command in cable interface configuration mode. To disable the use of multiple logical channels, use the no
form of this command.

cable upstream n max-logical-chans code

no cable upstream n max-logical-chans

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the cable interface
line card.

code Specifies the number of logical channels per port. Valid values are 1 and 2.

Command Default The maximum logical channels setting cannot be applied if the Synchronous Code Division Multiple Access
(S-CDMA) is not configured.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable upstream max-logical-chans command limits the number of logical channels per port on an
upstream channel. The default value is 1.
When two logical channels are configured through cable upstream max-logical-chans command, both logical
channels are mapped to the same physical port specified and the physical upstream bandwidth is shared
between the two logical channels. However, from the cable modem perspective, each logical channel appears
as an independent upstream channel.
When multiple logical channels are configured, the upstream related commands are categorized into two
groups: physical port level and logical channel level.
Physical Port Level
Physical port level commands use the format of cable upstream n, where n denotes the physical port number.
Logical Channel Level
Logical channel level commands use the format of cable upstream n m, where n denotes the physical port
number, and m denotes the logical channel index number of 0 or 1.

Note Multiple logical channels and Spectrum groups cannot be configured on the same upstream port.

The following commands are supported at the logical channel level:

Cisco CMTS Cable Command Reference

867
 Cable Commands: cable u through cable w
cable upstream max-logical-chans

• cable upstream active-codes

• cable upstream attribute-mask
• cable upstream codes-per-minislot
• cable upstream concatenation
• cable upstream data-backoff
• cable upstream description
• cable upstream differential-encoding
• cable upstream docsis-mode
• cable upstream equalization-coefficient
• cable upstream fec
• cable upstream fragment-force
• cable upstream fragmentation
• cable upstream freq-adjust
• cable upstream max-codes-per-subframe
• cable upstream max-interleave-step
• cable upstream modulation-profile
• cable upstream power-adjust
• cable upstream range-backoff
• cable upstream rate-adapt
• cable upstream rate-limit
• cable upstream scheduling type
• cable upstream scrambler
• cable upstream shutdown
• cable upstream spreading-interval
• cable upstream threshold
• cable upstream unfrag-slot-jitter

Note The above logical channel level commands are not available at the physical port level, when logical channels
are configured. However, the cable upstream shutdown and cable upstream threshold commands operate
both at the physical and at the logical channel level.

The physical upstream port level commands such as cable upstream frequency and cable upstream
channel-width affects all logical channels configured under a physical port.

Examples The following example sets two logical channels on the upstream port 0:

Router(config)# interface cable 7/0/4

Router(config-if)# cable upstream 0 max-logical-chans 2
Router(config-if)#

Related Commands Command Description

cable upstream attribute-mask Specifies the upstream attribute mask in hexadecimal format.

Cisco CMTS Cable Command Reference

868
Cable Commands: cable u through cable w
cable upstream max-logical-chans

Command Description

cable upstream codes-per-minislot Specifies the number of codes-per-minislot allowed on an upstream

channel.

cable upstream concatenation Enables DOCSIS concatenation at the CMTS.

cable upstream data-backoff Specifies automatic or fixed start and stop values for data backoff.

cable upstream description Assigns arbitrary labels to the upstreams on the cable interfaces.

cable upstream differential-encoding Enables differential encoding on upstream traffic to a specified

cable interface.

cable upstream docsis-mode Configures an upstream to use DOCSIS 1.x or DOCSIS 2.0 or
DOCSIS 3.0 modulation profiles.

cable upstream equalization-coefficient Enables the use of a DOCSIS 1.x or DOCSIS 2.0 or DOCSIS 3.0
pre-equalization coefficient on an upstream port.

cable upstream fec Enables upstream forward error correction.

cable upstream fragment-force Specifies that a cable interface line card should fragment DOCSIS
frames on an upstream when the frame exceeds a particular size.

cable upstream fragmentation Enables fragmentation of DOCSIS frames on a particular upstream.

cable upstream freq-adjust Specifies the percentage of frequency adjustment packets that is
required to change the adjustment method from the regular
power-adjustment method to the noise power-adjustment method.

cable upstream Specifies the upper limit to override the maximum value of
max-codes-per-subframe codes-per-subframe defined in the individual modulation profile
setting of an upstream channel.

cable upstream max-interleave-step Specifies the upper limit to override the maximum interleave step
for each burst defined in the modulation profile for the upstream
channel.

cable upstream modulation-profile Assigns up to three modulation profiles to an upstream port.

cable upstream power-adjust Controls power-adjustment methods on the Cisco CMTS.

cable upstream range-backoff Specifies automatic or configured initial ranging backoff

calculation.

cable upstream rate-adapt Enables and configures upstream utilization optimization.

cable upstream rate-limit Specifies DOCSIS rate limiting for an upstream port on a cable
interface line card.

cable upstream scheduling type Enables various scheduler modes.

cable upstream scrambler Enables the cable upstream scrambler.

Cisco CMTS Cable Command Reference

869
 Cable Commands: cable u through cable w
cable upstream max-logical-chans

Command Description

cable upstream shutdown Disables the upstream port.

cable upstream spreading-interval Specifies the spreading interval for S-CDMA on an upstream
channel.

cable upstream threshold Configures the upstream for the CNR or SNR and FEC threshold
values to be used in determining the allowable noise levels.

cable upstream unfrag-slot-jitter Specifies how much jitter can be tolerated on the corresponding
upstream due to unfragmentable slots.

Cisco CMTS Cable Command Reference

870
 Cable Commands: cable u through cable w
cable upstream max-ports

cable upstream max-ports

To configure the maximum number of upstreams on a MAC domain on a cable interface line card, use the
cable upstream max-ports command in cable interface configuration mode. To reset the card to its default
value of 4 upstreams per MAC domain, use the no form of this command.

cable upstream max-ports n

no cable upstream max-ports

Syntax Description n The valid range is 0 to 8, with a default of 4.

Command Default 4

Command Modes
Interface configuration (cable interface only)

Command Modes Release Modification

12.2(15)BC1 This command was introduced to support the Cisco uBR-MC5X20S cable interface line
card.

12.2(15)BC2 Support was added for the Cisco uBR-MC5X20U cable interface line card.

12.2(33)SCE The minimum number of max-ports supported was changed from 1 to 0.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify how many upstreams a MAC domain will support on the cable interface line
card, before using the cable upstream connector command to assign upstreams to physical ports on the card.
The MAC domains on a card can be configured for different maximum upstream values.
After using this command, the valid range for upstreams on that cable interface will be from 0 to one less than
the maximum port value. For example, if you use the cable upstream max-ports 6 command to specify a
maximum of 6 upstreams for the MAC domain, the valid range for upstreams will be 0 to 5.
The total of max-ports on each interface should not be greater than the total number of upstream channels in
the line card. For example, the Cisco uBR-MC3GX60V line card that has a total of 60 upstream channels can
have a maximum of 60 max-ports and the Cisco UBR-MC20X20V line card that has a total of 20 upstream
channels can have a maximum of 20 max-ports.
If the max-port exceeds the number of upstream channels on a line card, the total number of ports that can be
unshut is limited to the actual number of channels available on the line card and the remaining ports remain
as shutdown.
The cable upstream connector command fails when all the upstream channels are mapped. For example,
with Cisco uBR-MC3GX60V line card, if 60 upstream ports are mapped to connectors, adding more upstream
ports to connectors fail. When you configure a total of 120 ports and unshut the first 60 ports but map the last
60 ports to connectors, none of the ports work because the port is either shutdown or has no connector mapped
to it.

Cisco CMTS Cable Command Reference

871
 Cable Commands: cable u through cable w
cable upstream max-ports

Examples The following example shows how to configure all MAC domains on a Cisco uBR-MC5X20S card
for a maximum number of 6 upstreams.

Router# configure terminal

Router(config)# interface cable c6/1/0

Router(config-if)# cable upstream max-ports 1
Router(config-if)# interface cable c6/1/1
Router(config-if)# cable upstream max-ports 2
Router(config-if)# interface cable c6/1/2
Router(config-if)# cable upstream max-ports 3
Router(config-if)# interface cable c6/1/3
Router(config-if)# cable upstream max-ports 6
Router(config-if)# interface cable c6/1/4
Router(config-if)# cable upstream max-ports 8
Router(config-if)# exit
Router(config)# exit
Router#

Related Commands Command Description

cable upstream connector Maps an upstream port to a physical port on the cable interface line card for use
with a particular downstream.

Cisco CMTS Cable Command Reference

872
 Cable Commands: cable u through cable w
cable upstream min-bwreq-ops

cable upstream min-bwreq-ops

To configure the number of reserved minislots for contention, use the cable upstream min-bwreq-ops
command in cable interface configuration mode.

cable upstream min-bwreq-ops {scqam | ofdma} percent tenths_of_a_percent

Syntax Description scqam Specifies the percent of bandwidth request opportunities in SCQAM maps.

ofdma Specifies the percent of bandwidth request opportunities in OFDMA maps.

percent Specifies the minimum bandwidth request opportunities in 0% to 20%.

tenths_of_a_percent Specifies the minimum bandwidth request opportunities in 0 to 9 tenths of a percent.

Command Default No default behavior or values

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

IOS XE Amsterdam 17.3.1w This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Examples The following example shows how to configure the number of reserved minislots for contention:
Router> enable
Router# configure terminal
Router(config)# interface Cable 7/0/1
Router(config-if)# cable upstream min-bwreq-ops ofdma 5 0

Cisco CMTS Cable Command Reference

873
 Cable Commands: cable u through cable w
cable upstream minimal-voice-jitter

cable upstream minimal-voice-jitter

To configure the shortest jitter allowed, use the cable upstream minimal-voice-jitter command. To reset
the jitter value to default, use the no form of the command.

no
cable upstream n minimal-voice-jitter jitter

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card. For cBR Series Converged Broadband Routers, the valid range is from 0 to 15.

jitter Specifies the shortest jitter allowed.

Command Default The default jitter value is 2000 ms.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Example
The following sample shows and example of the cable upstream minimal-voice-jitter command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) # cable upstream 0 minimal-voice-jitter 2500
Router(config-profile-md)#end

The following sample shows and example of the no cable upstream minimal-voice-jitter command.
Router# conf t
Router(config)# cable profile mac-domain MD1
Router(config-profile-md) # no cable upstream 0 minimal-voice-jitter 2500
Router(config-profile-md)#end

Cisco CMTS Cable Command Reference

874
 Cable Commands: cable u through cable w
cable upstream minislot-size

cable upstream minislot-size

To specify the minislot size (in ticks) for a specific upstream interface, use the cable upstream minislot-size
command in cable interface configuration mode. To reset the minislot size to the default for the current channel
width setting, use the no form of this command.

cable upstream n minislot-size size

no cable upstream n minislot-size

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card.

size Specifies the minislot size in time ticks. Valid minislot sizes are:
• 1—(32 symbols at 6.4MHz channel width) Supported by the Cisco uBR-MC16U/X, Cisco
uBR-MC28U/X and Cisco uBR-MC5X20S /U cable interface line cards when operating in Advanced
TDMA (A-TDMA) DOCSIS 2.0 only mode.
• 2 (32 symbols at at 3.2 MHz channel width)
• 4 (64 symbols at 3.2 MHz channel width)
• 8 (128 symbols at 3.2 MHz channel width)
• 16 (256 symbols at 3.2 MHz channel width)
• 32 (512 symbols at 3.2 MHz channel width)
• 64 (1024 symbols at 3.2 MHz channel width)
• 128 (2048 symbols at 3.2 MHz channel width)

Command Default The default settings vary, depending on the upstream’s channel width. The default values were changed in
Cisco IOS Release 12.2(15)BC1 and later releases to better optimize data and voice traffic on the upstream.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

11.3(6) NA This command was introduced.

12.2(15)CX Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X cable interface
line cards, including support for minislot size of 1 to support DOCSIS 2.0 A-TDMA and
mixed modulation profiles.

12.2(15)BC1 The default minislot size was reduced to optimize the upstream for data and Voice-over-IP
(VoIP) traffic. The previous defaults produced 16 bytes per minislot when using QPSK
modulation and a 1.6 MHz channel width, and the new defaults produce 8 bytes per minislot
with the same configuration.

12.2(15)BC2 Support was added for the minislot size of 1 to support DOCSIS 2.0 A-TDMA and mixed
modulation profiles on the Cisco uBR-MC5X20S/U cable interface line cards.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS This command is us-channel minslot-size command.

Cisco CMTS Cable Command Reference

875
 Cable Commands: cable u through cable w
cable upstream minislot-size

Usage Guidelines The minislot size determines the minimum amount of information that can be transmitted on the upstream.
How much a particular minislot size can contain depends on the modulation profile and channel width being
used, with higher-bandwidth settings allowing larger amounts of data.
Because DOCSIS specifications require that the minislot size contain at least 32 symbols, you might need to
change the minislot size whenever you change the channel width or modulation of an upstream, to meet the
DOCSIS requirements.

Note In Cisco IOS Release 12.2(15)CX, Cisco IOS Release 12.2(15)BC2, and later releases, manually changing
the minislot size is not needed on the Cisco uBR-MC16U/X, Cisco uBR-MC28C, and Cisco uBR-MC28U/X
cards, because these cards automatically change the minislot size when the channel width is changed, to
produce 32 symbols per minislot, as required by the DOCSIS specifications.

The table below lists the default minislot sizes for each channel width for Cisco IOS releases before and after
Cisco IOS Release 12.2(15)BC1.

Table 20: Default Minislot Sizes

Releases Earlier than Cisco IOS Release 12.2(15)BC1 Cisco IOS Release 12.2(15)BC1 and Later Releases
(creates 64 symbols and 16 bytes per minislot) (creates 32 symbols and 8 bytes per minislot)

Channel Width Default Minislot Size (in Channel Width Default Minislot Size (in
Ticks) Ticks)

0.2 MHz 64 0.2 MHz 32

0.4 MHz 32 0.4 MHz 16

0.8 MHz 16 0.8 MHz 8

1.6 MHz 8 1.6 MHz 4

3.2 MHz 4 3.2 MHz 2

6.4 MHz (DOCSIS 2.0 16

only)
6
You must be using a 6.4 MHz channel width if using a minislot size of 1 tick. Otherwise, you will violate
the DOCSIS requirements that each minislot should contain 32 symbols.
Increasing the Minislot Size for High Bandwidth Users
The DOCSIS specifications allow a maximum burst limit of 255 minislots, which could require increasing
the minislot size from the default values if you are offering service level agreements (SLAs) that offer
guaranteed upstream speeds of 2 Mbps or greater, or if you are allowing maximum concatenation bursts
greater than 2000 bytes. This is because the default minislot sizes might not accommodate the largest bursts
that are possible with these configurations.
The default minislot sizes provide for 8 or 16 bytes per minislot, depending on Cisco IOS release. If the default
setting provides 8 bytes per minislot, then the maximum possible burst is 8 bytes * 255 minislots, or 2040
total bytes, which might not be sufficient for certain users with high guaranteed upstream speeds. You should
increase the minislot size to accommodate the expected maximum burst transmissions, adding in approximately
10 percent for overhead.

Cisco CMTS Cable Command Reference

876
 Cable Commands: cable u through cable w
cable upstream minislot-size

Caution Using values of 64 or 128 for higher symbol rates such as 1280 kilosymbols/second or 2560 kilosymbols/second
can cause performance problems. Depending on your current setting’s symbol rate, you should select the
minislot size (in ticks) that yields a minislot size of 32 or 64 symbols.

Examples The following example shows how to set the minislot size on upstream port 4 to 16:

Router# configure terminal

Router(config)# interface cable 3/0
Router(config-if)# cable upstream 4 minislot-size 16
Router(config-if)# exit
Router(config)# exit
Router#

Related Commands Command Description

cable modulation-profile Defines a modulation profile for use on the router.

cable upstream channel-width Specifies an upstream channel width for an upstream port.

cable upstream docsis-mode Configures an upstream to use either DOCSIS 1.x or DOCSIS
2.0 modulation profiles.

cable upstream equalization-coefficient Enables the use of a DOCSIS 1.1 pre-equalization coefficient on
an upstream.

cable upstream modulation-profile Assigns one or two modulation profiles to an upstream port.

show cable hop Displays CM configuration settings.

show cable modulation-profile Displays the modulation profile information for a Cisco CMTS.

show interface cable mac-schedule Displays the current time-slot scheduling state and statistics.

show interface cable sid Displays cable interface information.

Cisco CMTS Cable Command Reference

877
 Cable Commands: cable u through cable w
cable upstream modulation-profile

cable upstream modulation-profile

To assign up to three modulation profiles to an upstream port, use the cable upstream modulation-profile
command in cable interface configuration mode. To set the upstream modulation profile to the single default
profile based on the DOCSIS-mode setting of the upstream, use the no form of this command.

cable upstream n modulation-profile primary-profile-number [secondary-profile-number]

[tertiary-profile-number]
no cable upstream n modulation-profile primary-profile-number [secondary-profile-number]
[tertiary-profile-number]

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream
port on the cable interface line card.

primary-profile number Specifies the number identifying the primary modulation profile for the upstream
port. The primary modulation profile is used when the upstream is operating with
nominal noise conditions. The valid values depend on the cable interface being
used and the mode of operation.

secondary-profile-number (Optional) Specifies the secondary modulation profile for the upstream port, which
is used when noise on the upstream increases to the point that the primary
modulation profile can no longer be used. The valid values are the same ranges
as the primary modulation profile.
The secondary modulation profile should specify a more robust performance
profile (in terms of coping with noise) than the primary profile. The secondary
profile is used for both basic and advanced dynamic modulation.

tertiary-profile-number (Optional) Specifies the tertiary modulation profile for the upstream port, which
is used when noise on the upstream increases to the point that the secondary
modulation profile can no longer be used.
The tertiary modulation profile is only available for the basic dynamic modulation.
You cannot use the tertiary modulation profile when a spectrum group is defined
for the upstream.

Command Default Default modulation profiles are created, using profile numbers 1, 21, 41, 101, 121, 201, 221, 241, 321, and
381 depending on the DOCSIS mode and the cable interface line cards being used. See the table for a list of
the valid ranges for the individual cable interface cards.

Command Modes
Interface configuration (config-if)

Command History Release Modification

11.3 NA This command was first introduced.

12.0(7)XR2 and 12.1(1a)T1 This command was introduced into the Cisco IOS Release 12.0 and Release
12.1 trains, replacing the previous version of the cable upstream
modulation-profile command.

Cisco CMTS Cable Command Reference

878
 Cable Commands: cable u through cable w
cable upstream modulation-profile

Release Modification

12.1(3a)EC1 This command was modified to add the optional secondary-profile-number

parameter to enable the Dynamic Upstream Modulation feature.

12.1(5)EC This command was introduced for the Cisco uBR7100 series universal
broadband routers.

12.1(7)CX1 This command was enhanced for the Cisco uBR-MC16S line card.

12.2(4)BC1 Support for this command was added for the Cisco IOS Release 12.2 BC train.

12.2(8)BC2 Support for this command was added for the Cisco uBR-MC16S and Cisco
uBR-LCP2-MC16S line cards.

12.2(11)CY, 12.2(11)BC3 Support was added for the Cisco uBR10-MC5X20S cable interface line card
on the Cisco uBR10012 router.

12.2(15)CX Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X
cable interface line card, including DOCSIS 2.0 ATDMA and mixed modulation
profiles.

12.2(15)BC2 Support was added for DOCSIS 2.0 ATDMA and mixed modulation profiles
on the Cisco uBR-MC5X20S/U/H cable interface line cards.

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

12.3(23)BC7 This command was modified to add the optional tertiary-profile-number

parameter to enable Three Step Dynamic Upstream Modulation feature.

12.2(33)SCC Support was added for DOCSIS 2.0 S-CDMA and DOCSIS 3.0 S-CDMA
modulation profiles using 1.6 MHz, 3.2 MHz, and 6.4 MHz channel widths
on the Cisco UBR-MC20X20V cable interface line card.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers. This command is replaced by us-channel modulation-profile
command.

Usage Guidelines The cable upstream modulation-profile command assigns up to three modulation profiles to an upstream
port, depending on the type of cable interface and Cisco IOS software release being used. The third modulation
profile is only available for the basic dynamic modulation and is unavailable when a spectrum group is defined
for the upstream.
Static Modulation Profile (single profile)
The cable upstream modulation-profile command assigns a single modulation profile to an upstream port
on the Cisco uBR7100 series routers and on all cable interface line cards that are available for the Cisco CMTS
routers. This modulation profile affects all CMs and set-top boxes that are using that upstream port.
Dynamic Upstream Modulation (up to three profiles)
The cable upstream modulation-profile command assigns up to three modulation profiles to an upstream
port to use the Dynamic Upstream Modulation feature. You must assign at least two profiles to activate the
Dynamic Upstream Modulation feature. This feature operates differently, depending on the Cisco IOS software
release and the cable interface line card that is providing the upstream port:

Cisco CMTS Cable Command Reference

879
 Cable Commands: cable u through cable w
cable upstream modulation-profile

• The upstream port is on a Cisco uBR7100 series router or on a Cisco uBR-MC28U/X, or Cisco
uBR-MC16U/X line card that is used on Cisco CMTS router running Cisco IOS Release 12.3(23)BC7
or later release.
When using the Dynamic Upstream Modulation feature, the primary modulation profile is the default profile.
The line card monitors the signal-to-noise ratio (SNR) value and forward error correction (FEC) counters for
the upstream, to track the upstream signal quality. For a dual modulation profile, the line card monitors the
SNR value, carrier-to-noise ratio (CNR) value, and FEC counters to track the upstream signal quality.
When the noise on the upstream exceeds the threshold(s) for the primary profile, the upstream switches to the
secondary profile in a dual modulation profile. Whereas, in a three modulation profile setup, the upstream
can switch from primary profile to the secondary profile or directly to the tertiary profile based on the SNR,
and FEC counter thresholds. Two separate thresholds are used for switching between the primary profile and
the secondary profile and from secondary profile to the tertiary profile.
When the noise conditions improve (defined as a SNR value that is 3 dB greater than the threshold value and
FEC counters that are below the threshold values), the upstream automatically switches back to the primary
modulation profile. For a Three Step Dynamic Upstream Modulation, the user can configure the threshold
values and FEC counters for the upgrade. However, there is no direct upgrade from tertiary profile to the
primary profile. The upgrade follows a sequential order, from tertiary profile to secondary profile and then
to the primary profile.
For example, in a dual modulation profile, the primary modulation profile could be configured for 16-QAM
(or mixed 16-QAM and QPSK) operation and the secondary profile for QPSK operation. If noise conditions
on the upstream threaten to force CMs offline, the upstream switches to the secondary profile to implement
QPSK operation. When the noise ingress conditions are solved, the upstream switches back to 16-QAM
operation.
In a Three Step Dynamic Upstream Modulation, the primary modulation profile could be configured for
64-QAM operation, the secondary modulation profile for 16-QAM operation (or mixed 64-QAM and 16-QAM),
and the tertiary modulation profile for QPSK. If the noise conditions increase, the upstream switches to the
secondary profile to implement 16-QAM (or mixed profile) operation and then to the tertiary modulation
profile to implement QPSK operation. When the noise ingress conditions are improved, the upstream switches
back to 16-QAM operation (or mixed 64-QAM and 16-QAM), and then to the 64-QAM operation, on further
improvement of noise conditions.

Note For more information on this form of the Dynamic Upstream Modulation feature, see the chapter, Spectrum
Management for the Cisco Cable Modem Termination System .

When Dynamic Upstream Modulation is enabled and spectrum groups are configured on the same interface,
the line cards respond to excessive noise by first switching to the secondary modulation profile. If the noise
conditions worsen, the line card changes the modulation or frequency hopping in an attempt to find a new
upstream channel, and if that fails, the line card reduces the channel width.

Note The default priority of switching modulation profile is frequency (F), modulation (M), and channel-width (C).
However, it is user configurable and can be changed to MFC or FCM.

• The upstream port is on a Cisco uBR-MC16U/X line card that is used on Cisco CMTS routers using
Cisco IOS Release 12.1(7)CX1 or later release, or on a Cisco uBR-MC5X20S/U/H line card.

Cisco CMTS Cable Command Reference

880
 Cable Commands: cable u through cable w
cable upstream modulation-profile

The Dynamic Upstream Modulation feature on the Cisco uBR-MC16U/X line card is identical to other line
cards except that the spectrum management hardware onboard the Cisco uBR-MC16U/X or Cisco
uBR-MC5X20S/U/H line card uses the CNR value (you can use only the CNR value for a dual profile
configuration) in conjunction with the SNR value. The CNR value is a more accurate description of noise
conditions on the upstream. Because of this, these line cards switch back to the primary modulation profile
when noise conditions improve to a CNR value that is only 3 dB greater than the threshold value (assuming
FEC counters are also below the threshold values).

Note If the Cisco CMTS router is running Cisco IOS Release 12.1(3a)EC1 or a later Cisco IOS release, the Dynamic
Upstream Modulation feature on the Cisco uBR-MC16U/X line card operates the same as it does on the other
line cards.

When Dynamic Upstream Modulation is enabled and spectrum groups are configured on the same interface,
the line cards take corrective action in response to excessive noise, as determined by the cable upstream
hop-priority command (either frequency hopping or changing to the secondary modulation profile). If the
noise conditions worsen, the line card takes the second corrective action that has been defined, and if that
fails, the line card takes the last corrective action.

Note The Dynamic Upstream Modulation feature uses the SNR, CNR, and FEC thresholds for 64-QAM, 16-QAM,
and QPSK operation to determine when to switch modulation profiles. We recommend the use of 64-QAM,
16-QAM, and QPSK for primary, secondary, and tertiary profiles in a Three Step Dynamic Upstream
Modulation. For dual profile configuration, we recommend the use of 16-QAM or mixed 16-QAM and QPSK
modulation for primary profile and QPSK modulation for the secondary profile. However, this is optional.
Both modulation profiles can be either QPSK or QAM. It is not mandatory that one is QAM and the other
QPSK, but modulation profile switchover is tied to the QAM and QPSK thresholds.

Tip Modulation profiles must be first created using the cable modulation-profile command before they can be
assigned using the cable upstream modulation-profile command.

Modulation Profile Ranges

The valid range for modulation profiles depends on the cable interface used and the type of modulation profile
created.
The table below lists the valid ranges according to cable interface and modulation type.

Table 21: Supported Channel Widths and DOCSIS Modes for Cable Interfaces

Cable Interface DOCSIS 1.X (TDMA) Mixed DOCSIS 1.X/2.0 DOCSIS 2.0 (A-TDMA) DOCSIS 3.0
(S-CDMA)

Cisco uBR-MC16U/X 7 , 41 to 50 (default is 41) 141 to 150 (default is 141) 241 to 250 (default is 241) N/A
Cisco uBR-MC28U/X

Cisco 21 to 30 (default is 21) 121 to 130 (default is 121) 221 to 230 (default is 221) N/A
uBR10-MC5X20S/U/H

Cisco CMTS Cable Command Reference

881
 Cable Commands: cable u through cable w
cable upstream modulation-profile

Cable Interface DOCSIS 1.X (TDMA) Mixed DOCSIS 1.X/2.0 DOCSIS 2.0 (A-TDMA) DOCSIS 3.0
(S-CDMA)

Cisco UBR-MC20X20V8 21 to 30 (default is 21) 121 to 130 (default is 121) 221 to 230 (default is 221) 1 to 400 (default is
381)
7
Supports 6,400,000 Hz (5,120,000) symbols/sec) while operating in DOCSIS 2.0 (A-TDMA-only) mode .
8
The UBR-MC20X20V cable interface line card has three variants, UBR-MC20X20V-0D, UBR-MC20X20V-5D, and
UBR-MC20X20V-20D. The UBR-MC20X20V-0D line card supports 20 upstreams and zero (no) downstreams. The
UBR-MC20X20V-5D line card supports 20 upstreams and five downstreams, and the UBR-MC20X20V-20D line card supports
20 upstreams and 20 downstreams.

In addition to the legacy modulation profile number schemes, the new global modulation profile scheme
introduced in Cisco IOS Release 12.2(33)SCC, allows you to assign any modulation profile number to any
DOCSIS-mode up to 400, without any restrictions.
The global modulation profile mode allows you to create and configure DOCSIS 3.0 channel type 4SR
(scdma-d3). When an upstream's DOCSIS mode is changed into scdma-d3 , it is initially assigned to the
system created default modulation profile as shown in the table.

Note Though you can assign any number between 1 to 400 to any modulation profile, the default modulation profile
number assigned to an upstream channel for a given channel type will remain the same. That is, modulation
profile numbers 21, 121, 221, 321, and 381 will be applicable for TDMA, mixed, A-TDMA, S-CDMA, and
DOCSIS 3.0 S-CDMA channel types.

All the existing and previously defined modulation profiles are converted to the new format. However, all the
newly created modulation profiles, which are outside of the legacy number space range, will be lost when
you revert to the legacy modulation profile.
For more details on the new global modulation profile scheme, refer to the cable modulation-profile
global-scheme command.

Examples The following example assigns the primary modulation profile 2, the secondary modulation profile
1, and the tertiary modulation profile 4 to the upstream port 0 on the cable interface line card in slot
3. This automatically enables the Dynamic Upstream Modulation feature for all CMs using that
upstream.

Router(config)#interface cable 3/0

Router(config-if)#cable upstream 0 modulation-profile 2 1 4
Router(config-if)#

The following example assigns the primary modulation profile 2 and the secondary modulation
profile 1, to the upstream port 0 on the cable interface line card in slot 3. This automatically enables
the Dynamic Upstream Modulation feature for all CMs using that upstream.

Router(config)#interface cable 3/0

Router(config-if)#cable upstream 0 modulation-profile 2 1
Router(config-if)#

Cisco CMTS Cable Command Reference

882
 Cable Commands: cable u through cable w
cable upstream modulation-profile

Related Commands Command Description

cable modulation-profile Creates a cable modulation profile.

cable modulation-profile Defines a global modulation profile for use on the router.
global-scheme

cable upstream hop-priority Determines the order of the corrective actions to be taken when ingress
noise exceeds the allowable value for an upstream.
This command is related to the cable upstream modulation-profile
command only when using advanced dynamic modulation
configuration, that is, when spectrum group is defined for the upstream
channel.

show cable modulation-profile Displays the cable modulation profiles that have been created.

Cisco CMTS Cable Command Reference

883
 Cable Commands: cable u through cable w
cable upstream ofdma-prof-mgmt active-scs-threshold-pct

cable upstream ofdma-prof-mgmt active-scs-threshold-pct

To specify the active subcarrier percent below RxMER threshold, use the cable upstream ofdma-prof-mgmt
active-scs-threshold-pct command in cable interface configuration mode.

cable upstream ofdma-prof-mgmt active-scs-threshold-pct percent

Syntax Description percent Specifiy the active subcarrier percent below RxMER threshold. The valid range is from 0 to 100
percent.

Command Default None

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.6.1 Routers.

Examples The following example shows how to configure the active subcarrier percent below RxMER threshold.

Router(config)# cable upstream ofdma-prof-mgmt active-scs-threshold-pct 30

Related Commands Command Description

cable upstream ofdma-prof-mgmt Disable the automatic profile downgrade.

prof-upgrade-auto

cable upstream ofdma-prof-mgmt mer-margin-qdb Configure the offset.

cable upstream ofdma-prof-mgmt Configure the percentage of minislot average RxMER

exempt-mslot-pct that can be ignored in the recommended profile
calculation.

show cable ofdma-prof-mgmtrxmer-poll-interval Configure the RxMER poll interval.

Cisco CMTS Cable Command Reference

884
 Cable Commands: cable u through cable w
cable upstream ofdma-prof-mgmt downgrade

cable upstream ofdma-prof-mgmt downgrade

To configure the OFDMA profile downgrade, use the cable upstream ofdma-prof-mgmt downgrade
command in configuration mode.

cable upstream ofdma-prof-mgmt downgrade { enable | hold-down minutes | interval seconds |

min-cws value | partial-hold-down value | partial-threshold value | rxmer-enable |
rxmer-exempt-mslot-pct value | rxmer-invalid-enable | synchronized | threshold value }

Syntax Description downgrade Configuration options to enable profile management downgrade and specify
the downgrade interval, threshold value, hold-down time, and min codewords
needed for evaluation.

enable Enable codeword error downgrade. To disable this feature, use no form of
this command.

hold-down minutes Specifies the time after a profile downgrade to defer modem from
consideration by upgrade algorithms.

interval seconds Specifies the downgrade assessment interval.

min-cws value Specifies the minimum number of codewords that are required within
downgrade interval to consider modem for profile downgrade.

partial-hold-down Time in minutes that upgrade is disabled after a downgrade to partial-mode

partial-threshold value Specifies the codeword error threshold above which to trigger profile
downgrade to partial mode in hundredths of a percentage.

rxmer-enable Enables RxMER downgrade.

rxmer-exempt-mslot-pct Specifies the number of minislots that can be below minimum IUC and not
value trigger downgrade.

rxmer-invalid-enable Enable downgrade to partial based on invalid RxMER data.

synchronized Synchronize the downgrade processing with reception of new statistics.

Configuring this command enables the downgrade processing to be done as
soon as the statistics are available. When using this feature, the
ofdma-prof-mgmt downgrade interval must be a factor of 10 seconds.

threshold value Specifies the codeword error threshold above which to trigger profile
downgrade in hundredths of a percentage.

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE 17.15.1w The synchronized option is added.

Cisco CMTS Cable Command Reference

885
 Cable Commands: cable u through cable w
cable upstream ofdma-prof-mgmt downgrade

Release Modification

Cisco IOS XE Cupertino 17.9.1y The rxmer-invalid-enable option is added.

Cisco IOS XE Amsterdam 17.3.1w The rxmer-enable and rxmer-exempt-mslot-pct options are added.

Cisco IOS XE Gibraltar 16.12.1y The partial-threshold and partial-hold-down options are added.

Cisco IOS XE Gibraltar 16.12.1x This command is introduced on the Cisco cBR Series Converged
Broadband Routers.

Examples The following example shows how to enable the codeword error threshold feature.

Router(config)# cable upstream ofdma-prof-mgmt downgrade enable

Cisco CMTS Cable Command Reference

886
 Cable Commands: cable u through cable w
cable upstream ofdma-prof-mgmt exempt-mslot-pct

cable upstream ofdma-prof-mgmt exempt-mslot-pct

To specify the percentage of minislot average RxMER that can be ignored in the recommended profile
calculation, use the cable upstream ofdma-prof-mgmt exempt-mslot-pct command in cable interface
configuration mode.

cable upstream ofdma-prof-mgmt exempt-mslot-pct percent

Syntax Description percent Specifiy the minislot average RxMER that can be ignored in the recommended profile calculation
in percentage. The valid range is from 0 to 100 percent.

Command Default None

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.6.1 Routers.

Examples The following example shows how to configure the percentage of minislot average RxMER.

Router(config)# cable upstream ofdma-prof-mgmt exempt-mslot-pct 30

Related Commands Command Description

cable upstream ofdma-prof-mgmt prof-upgrade-auto Disable the automatic profile downgrade.

cable upstream ofdma-prof-mgmt mer-margin-qdb Configure the offset.

show cable ofdma-prof-mgmtrxmer-poll-interval Configure the RxMER poll interval.

Cisco CMTS Cable Command Reference

887
 Cable Commands: cable u through cable w
cable upstream ofdma-prof-mgmt mer-margin-qdb

cable upstream ofdma-prof-mgmt mer-margin-qdb

To configure the offset in quarter-decibel (DB), when RxMER is mapped to the ideal bit loading, use the
cable upstream ofdma-prof-mgmt mer-margin-qdb command in global configuration mode.

cable upstream ofdma-prof-mgmt mer-margin-qdbquarter-decibel

Syntax Description quarter-decibel Quarter-decibel to configure the offset. The valid value is from 0 to 40 quarter-DB.

Command Default 0 quarter-DB

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.6.1 Routers.

Usage Guidelines This configured value (quarter-DB) is added to the RxMER values collected by CMTS before using the above
mapping table, thus giving a user more control in selecting the recommended profiles.

Examples The following example shows how to configure the offset:

Router(config)# cable upstream ofdm-prof-mgmt mer-margin-qdb 20

Related Commands Command Description

cable upstream ofdma-prof-mgmt exempt-mslot-pct Specifiy the minislot average RxMER in

percentage.

cable upstream ofdma-prof-mgmt prof-upgrade-auto Disable the automatic profile downgrade.

show cable ofdma-prof-mgmtrxmer-poll-interval Configure the RxMER poll interval.

Cisco CMTS Cable Command Reference

888
 Cable Commands: cable u through cable w
cable upstream ofdma-prof-mgmt prof-upgrade-auto

cable upstream ofdma-prof-mgmt prof-upgrade-auto

To disable the auto profile management for OFDMA upstream channels, use the no cable upstream
ofdma-prof-mgmt prof-upgrade-auto command in global configuration mode. If disabled, profile changes
will not be implemented automatically by the system.

no cable upstream ofdma-prof-mgmt prof-upgrade-auto

Command Default The automatic profile management is enabled by default.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.6.1 Routers.

Examples The following example shows how to disable automatic profile namagement.

Router(config)# no cable upstream ofdma-prof-mgmt prof-upgrade-auto

Related Commands Command Description

cable upstream ofdma-prof-mgmt exempt-mslot-pct Specifiy the minislot average RxMER in

percentage.

cable upstream ofdma-prof-mgmt mer-margin-qdb Configure the offset.

show cable ofdma-prof-mgmtrxmer-poll-interval Configure the RxMER poll interval.

Cisco CMTS Cable Command Reference

889
 Cable Commands: cable u through cable w
cable upstream ofdma-prof-mgmt rxmer-poll-interval

cable upstream ofdma-prof-mgmt rxmer-poll-interval

To configure the interval at which to send periodic Receive Modulation Error Ratio (RxMER) probes and
periodic equalization probes, use the cable upstream ofdma-prof-mgmt rxmer-poll-interval command in
global configuration mode.

cable upstream ofdma-prof-mgmt rxmer-poll-intervalinterval

no cable upstream ofdma-prof-mgmt rxmer-poll-interval

Syntax Description interval RxMER poll interval in minutes. The valid range is from 5 to 1440 minutes. A value of 1440 disables
periodic probing.

Command Default 60 minutes

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.6.1 Routers.

Usage Guidelines The CMTS uses upstream probing to collect RxMER data per CM. This occurs during registration and
periodically thereafter. The collected RxMER data is averaged per minislot and used to compute the
recommended IUCs for each CM.
The no cable upstream ofdma-prof-mgmt rxmer-poll-interval command sets the rxmer-poll-interval to
1440, which is the value to disable the feature. The rxmer data is also not displayed after disabling the feature.

Examples The following example shows how to configure the offset:

Router(config)# cable upstream ofdm-prof-mgmt rxmer-poll-interval 20

Related Commands Command Description

cable upstream ofdma-prof-mgmt exempt-mslot-pct Specifiy the minislot average RxMER in

percentage.

cable upstream ofdma-prof-mgmt prof-upgrade-auto Disable the automatic profile downgrade.

cable upstream ofdma-prof-mgmt mer-margin-qdb Configure the offset.

Cisco CMTS Cable Command Reference

890
 Cable Commands: cable u through cable w
cable upstream power-adjust

cable upstream power-adjust

To control power-adjustment methods on the Cisco CMTS, use the cable upstream power-adjustcommand
in cable interface configuration mode or MAC domain profile configuration mode. To return to the default
values, use the no form of this command.

cable upstream n power-adjust {continue pwr-level | noise perc-pwr-adj | threshold value}

no cable upstream n power-adjust {continue | noise | threshold}

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port
on the cable interface line card.

continue pwr-level Specifies the power threshold value that determines the value of the Ranging Status
field in the Ranging Response (RNG-RSP) messages that the CMTS sends to the CM.
The valid range is from 2 to 15 dB, with a default of 4 dB.

threshold value Specifies the power adjustment threshold. The threshold range is from 0 to 10 dB, with
a default of 1 dB.

noise perc-pwr-adj Specifies the percentage of power adjustment packets that is required to change the
adjustment method from the regular power-adjustment method to the noise
power-adjustment method, which uses an averaging algorithm to smooth out wide jumps
in the power level. The valid range is 10 to 100 percent, with a default of 30 percent.

Command Default The continue option defaults to 4 dB, the noise option defaults to 30 percent, and the threshold option defaults
to 1 dB.

Command Modes
Interface configuration (cable interface only)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.0(7)T This command was introduced.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS XE Fuji This command was modified to support MAC domain profile configuration on the Cisco
16.7.1 cBR Series Converged Broadband Routers.

Usage Guidelines When a CM comes online, it sets itself for the optimal power level, as determined by the CMTS. As the CMTS
periodically polls each CM, the CMTS examines the CM’s power level and orders the CM to adjust its power
level to adapt to current total attenuation between it and the CMTS. These power adjustments can be required
because of temperature variations, upstream frequency hopping, or increased attenuation that has been added
either intentionally or unintentionally. The cable upstream power-adjustcommand controls how the CMTS
makes these power adjustments.

Cisco CMTS Cable Command Reference

891
 Cable Commands: cable u through cable w
cable upstream power-adjust

Note To set the upstream power level on the CMTS, see the cable upstream power-level command.

Setting the threshold Option

The threshold option specifies the allowable range between the target upstream power for a CM and the
actual receive power that the CMTS is measuring for that CM. If the CM receive power level is above or
below the target power level by a value that is greater than the threshold option, the CMTS will command
the CM to change its power level. When the CMTS receive power level for a CM falls within the threshold
range of the target power level, the CMTS stops commanding the CM to change its power level.
For example, the default threshold value of 1 dB means that the CM must be 1 dB above or below its target
power range before the CMTS will command it to change its power level. If the CM is within 1 dB of its
target power level, the CMTS does not adjust the CM’s power level.

Note The threshold parameter can be set from 0 dB to 10 dB with a default of 1 dB. However, do not set the
threshold to 0 dB because this means that the CMTS will command all CMs to continually change their
power levels until the CMTS measures the power levels at exactly 0 dBmV. Cisco recommends that you set
the threshold parameter to a minimum of its default value of 1 dB so that the CMs do not change their power
levels continually for minuscule RF plant variations.

Setting the continue Option

The continue option specifies the maximum allowable range for the CM’s power level, in relation to its target
power level. The CM can operate even at its maximum transmit power level, as long as it is within the continue
range. The continue parameter can be set from 2 dB to 15 dB, with a default of 4 dB. For example, with the
value of 2 dB, the CM can operate within 2 dB of its target power level, even if it is transmitting at its maximum
power level.
The continue option works together with the thresholdoption to control the CM’s operation. If the CM is
within the thresholdrange, the CMTS sets the Ranging Status field of its RNG-RSP messages to SUCCESS.
If the CM is outside the thresholdrange, but within the continuerange, the CMTS sets the Ranging Status
field to CONTINUE.

Note Cisco recommends designing the network so that CMs are at least 6 dB from the CM’s maximum transmit
power level. This will accommodate new services, changing modulation schemes, different channel widths,
customer-installed passives, temperature variations, and other non-linearities. DOCSIS specifies a minimal
power range of +8 dBmV to +55 dBmV for 16-QAM operation and +8 dBmV to +58 dBmV maximum power
level for QPSK operation. Cisco CMs typically have a maximum power level of +60 dBmV, which exceeds
the DOCSIS standards.

Tip If a number of CMs are transmitting close to their maximum transmit power, try increasing the continue range
to allow the CMTS to continue adjusting the CM’s power levels. This situation can happen when systems use
high value taps, such as 29 dB taps, in the design of the plant.

Cisco CMTS Cable Command Reference

892
Cable Commands: cable u through cable w
cable upstream power-adjust

Note When the CM requires 16 successive power adjustments that are greater than the value of the continue option,
the CMTS re-initializes the CM and starts to rescan downstream carriers, as per the DOCSIS specification.

Determining if the CM has Reached Its Maximum Power Level

Per the DOCSIS specification, the CMTS does not adjust the CM power level by commanding the CM to set
itself to an absolute power level. Instead, the CMTS changes the CM power levels by commanding the CM
to make relative power adjustments, using increments of +/–0.25 dB (or multiples thereof).
If the CMTS commands a CM to adjust its power level by a particular amount, but the measured power level
afterwards shows that the CM has made a smaller adjustment than requested, the show cableflap-list and
show cable modem commands show an exclamation point (!) for that particular CM. This typically indicates
that the CM has reached its maximum power level.
If the CM has not reached its maximum power level, but the show cable flap-list and show cable modem
commands still show an exclamation point (!) for that CM, the problem could be a fault in the upstream path
of the cable network. This fault is typically found as amplifier misalignment, where one upstream amplifier
is adjusted with too much input attenuation, and the next has too little. The amplifier with too little attenuation
enters non-linear operation and begins serious intermodulation.
Another possible cause is a faulty CM or a faulty connection between the CM and cable network. For example,
a faulty coaxial cable or bad F-connector could also create noise problems.

Note A CM that shows an exclamation point (!) in the show cable flap-list and show cable modem displays is
typically more prone to packet loss than other CMs.

Setting the noise Option

The noise option specifies that when the number of power adjustments beyond the threshold amount exceeds
a certain percentage of the total Ranging Requests for a CM, the CMTS switches into its noise power-adjustment
method. The noise power-adjustment method uses an averaging algorithm to make power adjustments for a
particular CM, so that if a modem is experiencing wide swings in its power levels (known as “bouncing’),
the CMTS averages the power levels before sending a power adjustment to the CM. The CMTS returns to
the normal power adjust method after receiving ten Ranging Request messages with power adjustments below
the threshold value.
For example, the cable upstream power-adjust noise 30 command instructs the CMTS that when 30 percent
(3 out of the last 10) of the Ranging Responses for a particular CM resulted in a power adjustment beyond
the threshold level, the CMTS begins using power averaging for that CM to adjust its power level.

Tip The cable upstream power-adjust noise command is typically not needed during normal operations, but it
can help in certain situations where the cable plant is experiencing ingress noise and other interference that
is forcing many CMs to frequently re-range. If the show cable flap-list and show cable modem commands
show a large number of CMs with asterisks (*), experiment with the noise option, so that the CMTS will
average its CM power readings before sending any power adjustments to the CMs.

Cisco CMTS Cable Command Reference

893
 Cable Commands: cable u through cable w
cable upstream power-adjust

Note When a CM is in power averaging mode, the show cable flap-list and show cable modem commands shows
an asterisk (*) for that particular CM.

Examples The following example shows the commands needed so that the CMTS will begin using the power
averaging adjustment method when 50 percent of Ranging Requests result in a power adjustment
beyond the threshold level of 2 dB:

Router(config)# interface c6/0

Router(config-if)# cable upstream 0 power-adjust threshold 2
Router(config-if)# cable upstream 0 power-adjust noise 50
Router(config-if)#

Related Commands Command Description

cable upstream frequency Configures a fixed frequency of the upstream RF carrier for an upstream port.

cable upstream power-level Sets the input power level for the upstream radio frequency (RF) carrier.

show cable flap-list Displays a list of CMs that have exceeded the threshold number of power
adjustments.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

894
 Cable Commands: cable u through cable w
cable upstream power-level

cable upstream power-level

To set the input power level for the upstream radio frequency (RF) carrier in decibels per millivolt (dBmV),
use the cable upstream power-level command in cable interface configuration mode. To restore the default
value for this command, use the no form of this command.

cable upstream n power-level dbmv

no cable upstream n power-level dbmv

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card.

dbmv Decibels per millivolt designating the upstream signal input power level. Valid range is –16 dBmV
to +26 dBmV, depending on the cable interface and the upstream’s symbol rate (channel width).

Command Default 0 dBmV

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

11.3 XA This command was introduced.

12.2(15)BC1 The allowable range of power levels was changed so that it depends on the upstream’s
channel width.

IOS-XE 3.15.0S This command was replaced by the us-channel power-level command on the Cisco cBR
Series Converged Broadband Routers.

Usage Guidelines The Cisco CMTS controls the output power levels of the CMs to meet the desired upstream input power level.
The nominal input power level for the upstream RF carrier is specified in decibels per millivolt (dBmV). The
default setting of 0 dBmV is the optimal setting for the upstream power level.
The valid range for the input power level depends on the data rate, as expressed as the symbol rate and channel
width. The table below shows the valid power levels for each allowable rate, as given in the DOCSIS
specification. Higher (more positive) values cause the CMs to increase their transmit power, achieving a
greater carrier-to-noise ratio (CNR).

Table 22: Allowable DOCSIS Power Levels

Symbol Rate (Symbols per second) Channel Width (Hz) Allowable Power Range (dBmV)

160,000 200,000 –16 to +14

320,000 400,000 –13 to +17

640,000 800,000 –10 to +20

1,280,000 1,600,000 –7 to +23

Cisco CMTS Cable Command Reference

895
 Cable Commands: cable u through cable w
cable upstream power-level

Symbol Rate (Symbols per second) Channel Width (Hz) Allowable Power Range (dBmV)

2,560,000 3,200,000 –4 to +26

5,120,0009 6,400,000 –1 to +29 (max. valid value for DOCSIS is +26)

9
The 5.12 MSymbols/sec symbol rate and 6.4 MHz channel width are supported only on upstreams that
are configured for DOCSIS 2.0 A-TDMA-only operation.

Note Some cable interfaces might allow smaller ranges of either –10 to +10 or –10 to +25 dBmV.

Tip You can use inline attenuators to force CMs to transmit at higher power levels and to achieve a higher CNR
value on the network.

Caution If you increase the input power level or add inline attenuators before the CMTS, the CMs on your HFC network
increase their transmit power level. Be careful if you adjust this parameter. You might violate the upstream
return laser design parameters or exceed the CM’s maximum transmit power level.

Note Do not adjust your input power level by more than 5 dB in a 30-second interval. If you increase the power
level by more than 5 dB within 30 seconds, you will disrupt CM service on your network. If you decrease the
power level by more than 5 dB within 30 seconds, the CMs on your network will be forced to re-range.

Tip When setting upstream power levels, Cisco recommends that the adjacent channels of equal bandwidth not
have a large variation. The recommended maximum input power variance is 5 to 6 dB.

Examples The following example shows how to set the input power level for upstream port 0 to -5 dBmV:

Router(config)# interface cable 5/1/0

Router(config-if)# cable upstream 0 power-level -5
Router(config-if)#

Related Commands Command Description

cable upstream fec Enables the upstream FEC.

cable upstream frequency Enters a fixed frequency of the upstream RF carrier for an upstream port.

cable upstream power-adjust Controls how the CMTS adjusts the CM power level so that the CMs reach
the target transmit power setting.

Cisco CMTS Cable Command Reference

896
Cable Commands: cable u through cable w
cable upstream power-level

Command Description

cable upstream shutdown Disables the upstream port.

To set the input power level for the upstream channel in decibels per millivolt (dBmV), use the cable upstream
power-level command in cable interface configuration mode. The value in dBmV reflects the upstream RF
set point's (the entry point the RF signal enter CMTS) power level. It is recommended to use the default value,
zero (0) dBmV. To restore the default value for this command, use the no form of this command.

Note If an upstream controller contains both OFDMA and SC-QAM channels, the upstream channel's power level
setting difference between OFDMA and SC-QAM should be within the following ranges, to avoid unexpected
behavior:
• For 6.4 MHz, the difference should not be larger than 10 dB.
• For 3.2 MHz, the difference should not be larger than 7 dB.
• For 1.6 MHz, the difference should not be larger than 4 dB.

The above power setting guideline applies to iCMTS, Node RPD, 6x12 shelf RPD, and HA-Shelf RPD.

Cisco CMTS Cable Command Reference

897
 Cable Commands: cable u through cable w
cable upstream priority

cable upstream priority

To specify the relative priority of an upstream channel, use the cable upstream priority command in cable
interface configuration mode. To set the default value, use the no form of this command.

cable upstream n priority value

no cable upstream n priority

Syntax Description n Specifies the upstream channel. Valid values start with 0 for the first upstream channel on the cable
interface line card.

value Specifies the priority. Valid values are from lowest priority 0 to highest priority 7, with a default value
of 0.

Command Default 0.

Command Modes
Interface configuration (config-if)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1w This command is introduced on the Cisco cBR Series Converged
Broadband Routers.

Examples The following example sets the priority to 1 on upstream channel 0:

Router(config)# interface cable 3/0/1

Router(config-if)# cable upstream 0 priority 1
Router(config-if)#

Cisco CMTS Cable Command Reference

898
 Cable Commands: cable u through cable w
cable upstream qos wfq

cable upstream qos wfq

To configure weighted fair queuing (WFQ) parameters for optimum bandwidth utilization for upstream service
flows on a cable interface, use the cable upstream qos wfq command in cable interface configuration mode.
To disable this configuration, use the no form of this command.

cable upstream qos wfq {class | activity | weights priority0-priority7}

no cable upstream qos wfq {class | activity | weights priority0-priority7}

Syntax Description class Enables class-based weighted fair queuing.

activity Enables activity-based weighted fair queuing.

weights Specifies custom weight values for all the eight service flow priorities in a service
priority0-priority7 class. By default, the weight of a priority is equal to “priority+1.” For example,
priority 0 has a weight of 1 and priority 1 has a weight of 2.
You must specify custom weight values for all the eight service flow priorities (0
to 7) when you modify the default weights of priorities. The valid range is from 1
to 255.

Command Default None

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCD2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows how to configure WFQ parameters on a cable interface in slot 7,
subslot 1, and port 0 on a Cisco uBR10012 router:

Router# configure terminal

Router(config)# interface cable 7/1/0
Router(config-if)# cable upstream qos wfq class
Router(config-if)# cable upstream qos wfq activity
Router(config-if)# cable upstream qos wfq weights 10 20 30 40 50 60 70 80

The following example shows how to configure WFQ parameters on a cable interface in slot 3,
subslot 0, and port 0 on a Cisco cBR Series Converged Broadband Routers:

Router# configure terminal

Router(config)# interface cable 3/0/0
Router(config-if)# cable upstream qos wfq class
Router(config-if)# cable upstream qos wfq activity
Router(config-if)# cable upstream qos wfq weights 10 20 30 40 50 60 70 80

Cisco CMTS Cable Command Reference

899
 Cable Commands: cable u through cable w
cable upstream qos wfq

Related Commands Command Description

show interface cable mac-scheduler Displays the current scheduling state, statistics, and WFQ parameters
configured on a cable interface.

Cisco CMTS Cable Command Reference

900
 Cable Commands: cable u through cable w
cable upstream range-backoff

cable upstream range-backoff

To specify automatic or configured initial ranging backoff calculation, use the cable upstream range-backoff
command in cable interface configuration mode. To set default values, use the no form of this command.

cable upstream n range-backoff {automatic | start end}

no cable upstream n range-backoff

Cisco cBR Series Converged Broadband Routers

cable upstream n range-backoff start end
no cable upstream n range-backoff

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the
cable interface line card.

automatic Specifies the fixed data backoff start and end values.
Note
The automatic setting is not supported on Cisco uBR-MC5X20S/U cable interface line cards,
which should use manually configured ranging backoff instead.

start Binary exponential algorithm. Sets the start value for initial ranging backoff. Valid values are
from 0 to 15.

end Binary exponential algorithm. Sets the end value for initial ranging backoff. Valid values are
from 0 to 15.

Command Default Ranging backoff is enabled with theautomatic setting

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.1 T This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.
The automatic keyword was removed.

Usage Guidelines The DOCSIS-specified method of contention resolution for CMs used to send data or requests on the upstream
channel is a truncated binary exponential back-off with the initial backoff window and the maximum backoff
window controlled by the CMTS. The Cisco CMTS router specifies backoff window values for both data and
initial ranging and sends these values downstream as part of the Bandwidth Allocation Map (MAP) MAC
message. The values are power-of-two values. For example, a value of 4 indicates a window between 0 and
15; a value of 10 indicates a window between 0 and 1023.
The automatic setting is optimized for a maximum of 250 CMs per upstream port. Set manual values for data
backoff windows only when operating with more than 250 CMs per upstream port. (The automatic setting

Cisco CMTS Cable Command Reference

901
 Cable Commands: cable u through cable w
cable upstream range-backoff

is not supported on Cisco uBR-MC5X20S/U cable interface line cards, which should use manually configured
ranging backoff instead.)

Tip Use the show controllers cable upstream command to display the current Ranging Backoff settings.

Examples The following example shows how to set the range backoff to automatic for upstream port 2 on a
Cisco uBR10012 router:

Router(config)# interface cable 4/0

Router(config-if)# cable upstream 2 range-backoff automatic
Router(config-if)#

The following example shows how to set the range backoff for upstream port 2 on a Cisco cBR-8
router:

Router(config)# interface cable 3/0/1

Router(config-if)# cable upstream 2 range-backoff 0 10
Router(config-if)#

Related Commands Command Description

cable insertion-interval Configures the interval between consecutive initial ranging slots on an
upstream.

cable upstream data-backoff Specifies automatic or fixed start and stop values for data backoff.

Cisco CMTS Cable Command Reference

902
 Cable Commands: cable u through cable w
cable upstream ranging-init-technique

cable upstream ranging-init-technique

To configure the initial ranging technique for the modem in the Multiple Transmit Channel (MTC) mode, use
the cable upstream ranging-init-technique command in interface configuration mode. To disable the ranging
initialization technique, use the no form of this command.

cable upstream ranging-init-technique 1-4

no cable upstream ranging-init-technique

Syntax Description 1-4 Type of ranging.

• 1—broadcast
• 2—unicast
• 3—broadcast or
unicast
• 4—direct use

Command Default The default option is 1—broadcast

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The ranging initialization technique is used when the modem transitions from a single channel to the multiple
transit channel mode (MTC-mode), for the initial ranging on the newly added channels during registration.
Use the default value of 1 for initial ranging.

Examples The following example shows how to configure the initial ranging for the modem in the MTC-mode:

Router# configure terminal

Router(config)# interface cable 7/0/1
Router(config-if)# cable upstream ranging-init-technique 1

Related Commands Command Description

cable Enables the MTC-mode for a MAC interface.

mtc-mode

interface cable Specifies a cable interface.

Cisco CMTS Cable Command Reference

903
 Cable Commands: cable u through cable w
cable upstream ranging-poll

cable upstream ranging-poll

To change the default ranging poll interval (20 seconds) on upstream channels, use the cable upstream
ranging-poll command in cable interface configuration mode. To disable this configuration, use the no form
of this command.

cable upstream ranging-poll [interval value | t4-multiplier timeout-value]

no cable upstream ranging-poll [interval value | t4-multiplier timeout-value]

Syntax Description interval value (Optional) Specifies the ranging poll interval in milliseconds. Valid values are
from 20000 to 30000. The default value is 20000.

t4-multiplier timeout-value (Optional) Specifies T4 timeout multiplier value for the cable modems that are
in the MTC mode. The valid range is from 1 to 10.

Command Default None

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines T4 multiplier is the T4 timeout multiplier value for cable modems that are in the MTC mode. The default
value is derived from the number of channels in the modem transmit channel set. You can change the default
T4 multiplier value using the cable upstream ranging-poll command in cable interface configuration mode.
For example, DOCSIS 2.0 defines T4 timeout for the modem at 30 seconds. If the T4 multiplier value is equal
to one, the cable modem will T4 time out in every 30 seconds. If you change the T4 multiplier to four, then
the new T4 timeout value will be 120 seconds (4 x 30 = 120).
In the MTC mode, you can increase the T4 timeout value in order to reduce the router overhead associated
with processing of ranging request (RNG-REQ) slots and ranging response (RNG-RSP) messages. If an
RNG-RSP message does not contain a T4 timeout multiplier value, then the cable modem uses the default T4
timeout value.

Note We recommend that you do not modify the default ranging poll interval unless required. With the default
configuration, a DOCSIS 2.0 cable modem in non-MTC mode performs ranging on one upstream channel
every 20 seconds.

Examples The following example shows how to change the default ranging poll interval and the T4 timeout
multiplier value on a cable interface line card:

Cisco CMTS Cable Command Reference

904
 Cable Commands: cable u through cable w
cable upstream ranging-poll

Router# configure terminal

Router(config)# interface cable 7/1/0
Router(config-if)# cable upstream ranging-poll interval 24000 t4-multiplier 4

Related Commands Command Description

cable Enables the Multiple Transmit Channel mode (MTC) for a MAC interface.
mtc-mode

Cisco CMTS Cable Command Reference

905
 Cable Commands: cable u through cable w
cable upstream rate-adapt (global)

cable upstream rate-adapt (global)

To globally enable upstream utilization optimization on all cable modem upstream flows, use the cable
upstream rate-adapt command in global configuration mode. To disable global upstream utilization
optimization, use the no form of this command.

cable upstream rate-adapt [local | priority value | rate number]

no cable upstream rate-adapt [local | priority value | rate number]

Syntax Description local (Optional) Specifies upstream utilization optimization is enabled on a specific upstream.

priority (Optional) Specifies upstream utilization optimization is enabled if an upstream flow meets
value or exceeds a defined priority. The valid range is 0–7.

rate number (Optional) Specifies upstream utilization optimization is enabled if an upstream flow meets
or exceeds the set minimum max-rate of the flow. The valid range is 0–30000000.

Command Default Upstream utilization optimization is globally disabled.

Command Modes
Global configuration (config)

Command History Release Modification

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines If upstream utilization optimization is globally enabled, activated service flows are configured for upstream
utilization optimization. The command also turns on local upstream utilization optimization so specific local
upstreams can be configured to be rate-adapt enabled. Using the priority or rate option allows you to restrict
upstream utilization optimization to service flows that meet or exceed specified levels for priority or rate.

Examples The following example enables upstream utilization optimization globally on all upstream flows.

Router(config)# cable upstream rate-adapt

Related Commands Command Description

cable upstream rate-adapt (interface) Enables and configures upstream utilization optimization locally.

show cable rate-adapt Displays the global and local upstream utilization optimization
configuration parameters.

Cisco CMTS Cable Command Reference

906
 Cable Commands: cable u through cable w
cable upstream rate-adapt (interface)

cable upstream rate-adapt (interface)

To enable and configure upstream utilization optimization locally, use the cable upstream rate-adapt
command in cable interface configuration mode. To disable upstream utilization optimization on the specified
upstream flow, use the no form of this command.

cable upstream port rate-adapt [bcs slots | duration millisecs | fcms-off | priority value | rate
number]
no cable upstream port rate-adapt [bcs slots | duration millisecs | fcms-off | priority value | rate
number]

Syntax Description port Identifies the specific upstream flow to be optimized and configured.

bcs slots (Optional) Specifies the number of broadcast contention minislots (BCS). MAPs that
have gaps are filled with BCS. You can override the default of 10 with a larger or smaller
number using the bcs option. The valid range is 0–80. The default is 10 BCS.

duration millisecs (Optional) Specifies the length of time, in milliseconds, that a flow rate-adapts. This
keyword overrides the default duration. The default is 1. The valid range is 0–2000.

fcms-off (Optional) Disables the forced broadcast contention minislot at the end of a filled MAP.

priority value (Optional) Specifies the minimum priority required to enable rate-adapt on a flow. This
keyword overrides any globally configured rate-adapt priority. The valid range is 0–7.

rate number (Optional) Specifies the minimum max-rate required to enable rate-adapt on a flow. This
keyword overrides any globally configured rate-adapt rate. The valid range is 0–30000000.

Command Default Upstream utilization optimization is not enabled on a local upstream.

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines If eligible, local upstream flows can utilize upstream utilization optimization.

Examples The following example enables and configures rate-adapt on upstream 0 with a priority of 6 and a
rate of 200.

Router(config-if)# cable upstream 0 rate-adapt priority 6 rate 200

Cisco CMTS Cable Command Reference

907
 Cable Commands: cable u through cable w
cable upstream rate-adapt (interface)

Related Commands Command Description

cable upstream rate-adapt (global) Enables upstream utilization optimization globally on all cable modem
upstream flows.

show cable rate-adapt Displays the global and local upstream utilization optimization
configuration parameters.

Cisco CMTS Cable Command Reference

908
 Cable Commands: cable u through cable w
cable upstream rate-limit

cable upstream rate-limit

To set DOCSIS rate limiting for an upstream port on a cable interface line card, use the cable upstream
rate-limit command in cable interface configuration mode. To disable DOCSIS rate limiting for the upstream
port, use the no form of this command.

cable upstream n rate-limit [token-bucket [shaping]]

no cable upstream n rate-limit

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream
port on the cable interface line card.

token-bucket (Optional) Enables rate limiting for the specified upstream cable interface using the
shaping token-bucket policing algorithm. The shaping option enables token-bucket shaping.
Note
For Cisco cBR Series Converged Broadband Routers, rate limiting is always enabled.

Command Default Token-bucket algorithm with traffic shaping

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

11.3(6)NA This command was introduced for the Cisco uBR7246VXR universal broadband routers.

11.3(9)NA The shaping keyword was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines Upstream rate limiting allows upstream bandwidth requests from rate-exceeding CMs to be buffered without
incurring TCP-related timeouts and retransmits. This enables the Cisco CMTS to enforce the peak upstream
rate for each CM without degrading overall TCP performance for the subscriber CPE devices. Upstream grant
shaping is per cable modem (SID).
When the token-bucket algorithm is configured, the Cisco CMTS automatically drops packets in violation
of allowable upstream bandwidth.
Use of the default value (the upstream port’s rate limit) enforces strict DOCSIS-compliant rate limiting. Cisco
highly recommends to using the default setting of token-bucket with the shaping option.
This command is specific to the uBR7225VXR routers only.

Examples The following example shows how to configure the token bucket filter algorithm with traffic shaping
on upstream port 4:

Router(config-if)# cable upstream 4 rate-limit token-bucket shaping

Cisco CMTS Cable Command Reference

909
 Cable Commands: cable u through cable w
cable upstream rate-limit

Related Commands Command Description

cable downstream rate-limit Enables DOCSIS rate limiting on downstream traffic.

Cisco CMTS Cable Command Reference

910
 Cable Commands: cable u through cable w
cable upstream rate-limit-bwreq exempted-priority

cable upstream rate-limit-bwreq exempted-priority

To configure the service flow priority of the bandwidth requests that should be exempted from being throttled
by the upstream (US) bandwidth request rate limiting (BRRL) feature, use the cable upstream rate-limit-bwreq
exempted-priority command in global configuration mode. To reset the exempted priority to the default
value, use the no form of this command.

cable upstream rate-limit-bwreq exempted-priority priority

no cable upstream rate-limit-bwreq

Syntax Description priority Service flow priority.

Bandwidth requests with this service flow priority value (and above) are exempted from being
throttled by the BRRL feature. For example, if the priority value is set to 3, then bandwidth requests
with priority 3, 4, 5, 6, and 7 are exempted. The valid range is from 0 to 7.

Command Default All bandwidth requests are throttled by the BRRL feature.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The upstream BRRL feature throttles incoming bandwidth requests in order to control CPU consumption by
the US scheduler.
The cable upstream rate-limit-bwreq exempted-priority command enables you to configure an exempted
priority. Any best effort(BE) service flow bandwidth requests received with this configured priority or above,
is exempted from BRRL and is therefore not dropped even if high CPU consumption by the US scheduler is
observed. For example, if the configured exempted priority is 4, any bandwidth request with priority 4, 5, 6,
or 7 is not dropped even if high CPU consumption is observed.
Exempted service flow priority is a platform level configuration and is applicable to all line cards. If the
exempted priority is set to value zero, all the BE bandwidth requests are exempted from being throttled by
the BRRL feature.

Examples The following example shows how to configure a BRRL exempted service flow priority to value 5:

Router# configure terminal

Router(config)# cable upstream rate-limit-bwreq exempted-priority 5

Cisco CMTS Cable Command Reference

911
 Cable Commands: cable u through cable w
cable upstream rate-limit-ccf

cable upstream rate-limit-ccf

To configure rate limiting parameters for upstream bonded service flows on a Cisco uBR10-MC5X20H cable
interface line card, use the cable upstream rate-limit-ccf command in global configuration mode. To disable
this configuration, use the no form of this command.

cable upstream rate-limit-ccf [aggregated-burst value | aggregated-throughput value | cpu-burst

value | cpu-threshold value]
no cable upstream rate-limit-ccf [aggregated-burst value | aggregated-throughput value | cpu-burst
value | cpu-threshold value]

Syntax Description aggregated-burst value (Optional) Specifies the burst rate for aggregated throughput-based rate
limiting in bits. The valid range is from 0 to 250000000. The default value
is 8000000.

aggregated-throughput (Optional) Specifies the throughput value for throughput-based rate limiting
value in bits per second (bps). The valid range is from 0 to 540000000. The default
value is 115000000.

cpu-burst value (Optional) Specifies the CPU burst for Continuous Concatenation and
Fragmentation (CCF) in percentage. The valid range is from 0 to 100. The
default value is 10.

cpu-threshold value (Optional) Specifies the CPU threshold for CCF in percentage. The valid
range is from 0 to 100. The default value is 50.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows how to configure rate limiting parameters for upstream bonded service
flows on a Cisco uBR10012 router:

Router# configure terminal

Router(config)# cable upstream rate-limit-ccf
Router(config)# cable upstream rate-limit-ccf aggregated-burst 25000
Router(config)# cable upstream rate-limit-ccf aggregated-throughput 540000
Router(config)# cable upstream rate-limit-ccf cpu-burst 30
Router(config)# cable upstream rate-limit-ccf cpu-threshold 60

Cisco CMTS Cable Command Reference

912
 Cable Commands: cable u through cable w
cable upstream rate-limit-ccf

Related Commands Command Description

show cable rate-limit-ccf Displays information about rate limiting criteria configured on a Cisco
uBR10-MC5X20H cable interface line card.

Cisco CMTS Cable Command Reference

913
 Cable Commands: cable u through cable w
Upstream Channel Bondingcable upstream resiliency

Upstream Channel Bondingcable upstream resiliency

To configure cable upstream resiliency on a cable interface line card, use the cable upstream resiliency
command in cable interface configuration mode. To disable the configuration, use the no form of this command.

cable upstream resiliency {channel-down-detect number | data-burst snr number ufec number
cfec number hysteresis number | modem-offline-detect number | on-failure {disable-channel |
extended-ranging | reset-modem} | sf-move {NRTPS | RTPS | UGS | UGS-AD}}
no cable upstream resiliency {channel-down-detect number | data-burst snr number ufec number
cfec number hysteresis number | modem-offline-detect number | on-failure {disable-channel |
extended-ranging | reset-modem} | sf-move {NRTPS | RTPS | UGS | UGS-AD}}
To configure data-burst resiliency polling interval, use the cable upstream resiliency data-burst
polling-interval command in global configuration mode. To disable the configuration, use the no form of
this command.

cable upstream resiliency data-burst polling-interval number

no cable upstream resiliency data-burst polling-interval number

Syntax Description channel-down-detect Specifies the threshold (number of consecutive ranging misses) to determine
number if a channel is down. The valid values are from 8 to 64.
Starting from Cisco IOS-XE 3.15.0S, the valid values are 32-128.

data-burst snr number ufec Specifies the upstream channel data burst resiliency.
number cfec number
• snr number—Sets the threshold value for SNR. The valid values are
hysteresis number
from 10 to 40.
• ufec number—Sets the threshold value for uncorrectable forward error
correction (uFEC) error. The valid values are from 0 to 100.
• cfec number—Sets the threshold value for correctable forward error
correction (cFEC) error. The valid values are from 0 to 100.
• hysteresis number—Sets the threshold value for hysteresis. The valid
values are from 0 to 15.

modem-offline-detect Specifies the threshold (number of consecutive ranging misses) to determine

number if a CM is offline. The valid values are from 4 to 16.

on-failure Allows you to specify what should be done if the channel is down and the
CM is offline.

disable-channel Allows the CMTS to mark the channel as unusable when a failure is detected.

extended-ranging Allows the CMTS to continue ranging when a failure is detected.

reset-modem Enforces the CM to go offline when a failure is detected.

Cisco CMTS Cable Command Reference

914
 Cable Commands: cable u through cable w
Upstream Channel Bondingcable upstream resiliency

sf-move Moves the upstream service flows on an impaired upstream channel to another
good upstream channel in the transmit channel set of the cable modem without
resetting the cable modem.
Starting from Cisco IOS-XE 3.15.0S, this option is extended to all service
flows for single channel bonding groups, RTPS, NRTPS, UGS and UGS-AD.

NRTPS Moves NRTPS type service flows.

RTPS Moves Real-time Polling Service (RTPS) type service flows.

UGS Moves Unsolicited Grant Service (UGS) type service flows.

UGS-AD Moves UGS-AD type service flows.

polling-interval number Note

polling-interval keyword is for global configuration mode.

Specifies the polling interval for data-burst resiliency in seconds. The valid
values are from 5 to 3600.

Command Default By default, the threshold to determine if a channel is down is not enabled, the CMTS is set to continue ranging
when a failure is detected and the threshold to determine if a CM is offline is set to 8.

Command Modes
Interface configuration (config-if) and Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

12.2(33)SCG This command was modified. The sf-move RTPS keyword was added.

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

IOS-XE This command was modified for the Cisco cBR Series Converged Broadband Routers. The
3.18.0S data-burst snr number ufec number cfec number hysteresis number keyword was added
for interface configuration mode and data-burst polling-interval number keyword was
added for global configuration mode.

Usage Guidelines The cable upstream resiliency command is used to configure the Upstream Channel Bonding feature.

Examples The following example shows how to configure upstream resiliency with different keywords on a
cable interface in slot 5, subslot 1, and port 0 on a Cisco uBR10012 router:

Router# configure terminal

Router(config)# interface cable 5/1/0
Router(config-if)# cable upstream resiliency channel-down-detect 30
Router(config-if)# cable upstream resiliency modem-offline-detect 16
Router(config-if)# cable upstream resiliency on-failure disable-channel
Router(config-if)# cable upstream resiliency sf-move NRTPS

Cisco CMTS Cable Command Reference

915
 Cable Commands: cable u through cable w
Upstream Channel Bondingcable upstream resiliency

Router(config-if)# cable upstream resiliency sf-move RTPS

Router(config-if)# cable upstream resiliency sf-move UGS
Router(config-if)# cable upstream resiliency sf-move UGS-AD

The following example shows how to configure RTPS type service flow move on a cable interface
in slot 7, subslot 0, and port 0 in Cisco IOS Release 12.2(33)SCG:

Router#show run all | i sf-move

no cable upstream resiliency sf-move RTPS

Router#configure terminal
Router(config)#interface cable 7/0/0
Router(config-if)#cable upstream resiliency sf-move RTPS
Router(config-if)#end
Router#
Router#show run interface cable 7/0/0 | i sf-move
cable upstream resiliency sf-move RTPS

The following example shows how to configure the upstream channel data burst resiliency:

Router#configure terminal
Router(config)#interface cable 0/0/1
Router(config-if)#cable upstream resiliency data-burst snr 24 ufec 1 cfec 0 hysteresis 3
Router(config-if)#end

The following example shows how to set a global time interval to loop all the upstream bonding
modems:

Router#configure terminal
Router(config)#cable upstream resiliency data-burst polling-interval 60
Router(config)#end

Related Commands Command Description

interface Configures cable interface.

cable

Cisco CMTS Cable Command Reference

916
 Cable Commands: cable u through cable w
cable upstream resiliency recover

cable upstream resiliency recover

To automatically recover the cable modem after it is downgraded to upstream partial mode, use the cable
upstream resiliency recover command in global configuration mode. This feature is enabled by default.

cable upstream resiliency recover delay seconds retry times

Syntax Description delay Specifies the time in seconds that the CMTS waits before recovering the upstream partial
seconds service cable modem.

retry times Specifies the times that the CMTS tries to recover the upstream partial service cable modem.
Note that sometimes the CMTS fails to recover the partial service cable modem after the
specified times. The retry times is recounted after the cable modem is back to partial service
mode again from the full service mode. You can set the retry times to 0 to disable this feature.

Command Default By default, the delay time is 900 seconds and retry 3 times.

Command Modes
Global configuration (config)

Command History Release Modification

Cisco IOS XE Gibraltar 16.12.1x This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Examples The following example shows how to configure the upstream resiliency recover:

Router#configure terminal
Router(config)#cable upstream resiliency recover 800 retry 3

Cisco CMTS Cable Command Reference

917
 Cable Commands: cable u through cable w
cable upstream rf-adapt (logical channel)

cable upstream rf-adapt (logical channel)

To specify the primary upstream logical channel and the secondary upstream logical channel, use the cable
upstream port logical-channel-index rf-adapt [primary | secondary] command in cable interface configuration
mode. To reset to the default settings, use the no form of this command.

cable upstream port logical-channel-index rf-adapt [primary | secondary]

no cable upstream port logical-channel-index rf-adapt [primary | secondary]

Syntax Description port Upstream port number. The valid values start with 0 for the first upstream port on the
cable interface line card and ends with a value that depends on the number of upstream
ports supported by the cable interface line card..

logical-channel-index Logical channel index. The valid values are 0 or 1.

primary (Optional) Assigns the logical channel as primary for RF adaptation. By default,
logical channel 0 is set as primary.

secondary (Optional) Assigns the logical channel as secondary for RF adaptation. By default,
logical channel 1 is set as secondary.

Command Default Uses the default configuration. Logical channel 0 is primary and logical channel 1 is secondary.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines It is recommended that logical channel 0 is set as primary, and logical channel 1 is set as secondary.

Examples The following example shows how to configure primary and secondary logical channels:

Router> enable
Router# configure terminal
Router(config)# interface cable 8/0/0
Router(config-if)# cable upstream 0 max-logical-chans 2
Router(config-if)# cable upstream 0 rf-adapt
Router(config-if)# cable upstream 0 1 rf-adapt primary
Router(config-if)# cable upstream 0 0 rf-adapt secondary

Related Commands Command Description

cable rf-adapt timer Configures timers for RF adaptation.

cable upstream rf-adapt Enables RF adaptation on the physical upstream channel.

Cisco CMTS Cable Command Reference

918
Cable Commands: cable u through cable w
cable upstream rf-adapt (logical channel)

Command Description

cable upstream threshold Configures the upstream for the signal-to-noise ratio (SNR) and
forward error correction (FEC) threshold values to be used in
determining the allowable noise levels.

cable upstream threshold hysteresis Configures the hysteresis value to be used in conjunction with the
dynamic modulation upgrade thresholds.

cable upstream threshold rf-adapt Configures the upstream RF adaptation threshold value, which
prevents excessive relocation of modems from the primary upstream
channel to the secondary upstream channel.

show cable modem rf-adapt Displays the RF adaptation history.

show cable rf-adapt Displays the downgrade and upgrade candidate lists.

Cisco CMTS Cable Command Reference

919
 Cable Commands: cable u through cable w
cable upstream rf-adapt

cable upstream rf-adapt

To enable RF adaptation on the physical upstream channel, use the cable upstream rf-adapt command in
cable interface configuration mode. To disable the RF adaptation, use the no form of this command.

cable upstream port rf-adapt

no cable upstream port rf-adapt

Syntax Description port Upstream port number. The valid values start with 0 for the first upstream port on the cable interface
line card and ends with a value that depends on the number of upstream ports supported by the cable
interface line card.

Command Default By default, RF adaptation is disabled.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable upstream port rf-adapt command is available only when the maximum number of logical channels
configured using the cable upstream max-logical-chans command is greater than 1.

Examples The following example shows how to enable RF adaptation on cable interface 8/0/0:

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

Router(config-if)# cable upstream 0 max-logical-chans 2
Router(config-if)# cable upstream 0 rf-adapt

Related Commands Command Description

cable rf-adapt timer Configures timers for RF adaptation.

cable upstream rf-adapt (logical Configures the primary upstream logical channel and secondary
channel) upstream logical channel.

cable upstream threshold Configures the upstream for the signal-to-noise ratio (SNR) and
forward error correction (FEC) threshold values to be used in
determining the allowable noise levels.

cable upstream threshold hysteresis Configures the hysteresis value to be used in conjunction with the
dynamic modulation upgrade thresholds.

Cisco CMTS Cable Command Reference

920
Cable Commands: cable u through cable w
cable upstream rf-adapt

Command Description

cable upstream threshold rf-adapt Configures the upstream RF adaptation threshold value, which
prevents excessive relocation of modems from the primary upstream
channel to the secondary upstream channel.

show cable modem rf-adapt Displays the RF adaptation history.

show cable rf-adapt Displays the downgrade and upgrade candidate lists.

Cisco CMTS Cable Command Reference

921
 Cable Commands: cable u through cable w
cable upstream rng-holdoff

cable upstream rng-holdoff

To hold off a cable modem from initial ranging (init rl) on a logical upstream channel on the CMTS router,
use the cable upstream rng-holdoff command in cable interface configuration mode. To disable the ranging
hold-off, use the no form of this command.

cable upstream port-number rng-holdoff priority

no cable upstream port-number rng-holdoff priority

Syntax Description port-number Cable upstream port number. The valid range depends on the number of upstream
channels configured in a MAC domain. For example, if the total number of upstream
channels configured is 4, then the valid range for the upstream port number is from 0
to 3.

rng-holdoffpriority Specifies the ranging hold-off priority value in the hexadecimal format. The valid range
is from 0 to ffffffff. The default value is 0.

Command Default None

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCH This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The cable upstream rng-holdoff command is associated with the CM Steering on the Cisco CMTS Routers
feature.
An upstream channel descriptor (UCD) message includes type, length, value (TLV) 18 and 19 for an upstream
logical channel based on the channel class ID and ranging hold-off priority configuration. If a ranging hold-off
priority value is not configured, the value of TLV 18 becomes zero. If an upstream channel class ID is
configured and a ranging hold-off priority value is not configured, the UCD message includes TLV 18 and
19, and the value of TLV 18 becomes zero.

Examples The following example shows how to specify a ranging hold-off priority value for a logical upstream
channel on a cable interface line card on the cisco uBR10012 router:

Router# config terminal

Router(config)# interface cable 5/0/0
Router(config-if)# cable upstream 0 rng-holdoff ff

Related Commands Command Description

cable load-balance exclude Excludes a cable modem or a group of cable modems from DOCSIS load
balance.

Cisco CMTS Cable Command Reference

922
Cable Commands: cable u through cable w
cable upstream rng-holdoff

Command Description

cable upstream chan-class-id Configures a channel class ID for a logical upstream channel on the CMTS
router.

show cable modem verbose Displays information about the registered and unregistered cable modems
connected to the CMTS router.

Cisco CMTS Cable Command Reference

923
 Cable Commands: cable u through cable w
cable upstream scheduling type

cable upstream scheduling type

To enable various scheduler modes, use the cable upstream scheduling type command in interface
configuration mode (cable interface only). The no form of this command reverts the scheduler to the default
‘docsis’ style scheduling mode.

cable upstream n scheduling type [ugs | rtps | nrtps] mode [llq | docsis]
no cable upstream n scheduling type [ugs | rtps | nrtps] mode [llq | docsis]

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the cable interface
line card. For Cisco cBR Series Converged Broadband Routers, the valid range is from 0 to 15.

ugs (Optional) Selects scheduling for UGS.

rtps (Optional) Selects scheduling for rtPS.

nrtps (Optional) Selects scheduling for nrtPS.

mode Enables the selection of packet-based Low Level Queueing (LLQ) or TDM-based DOCSIS scheduling.

llq (Optional) Selects LLQ scheduling.

docsis (Optional) Selects DOCSIS scheduling.

Command Default The only default is docsis.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines Any combination of ugs, rtps, rtps, nrtps, llq, and docsis is allowed.
Restrictions:
• To ensure proper operation, Call Admission Control (CAC) must be enabled. When the Low Latency
Queueing (LLQ) option is enabled, it is possible for the upstream path to be filled with so many calls
that it becomes unusable, making voice quality unacceptable. CAC must be used to limit the number of
calls to ensure acceptable voice quality, as well as to ensure traffic other than voice traffic.
• Even if CAC is not enabled, the default (DOCSIS) scheduling mode blocks traffic after a certain number
of calls.

Cisco CMTS Cable Command Reference

924
 Cable Commands: cable u through cable w
cable upstream scheduling type

Examples The following example shows how to enable LLQ-type (packet-based) scheduling for UGS services
on upstream port 4 on a Cisco CMTS interface:

Router(config-if)# cable upstream 4 scheduling type ugs mode llq

The following example shows how to enable standard DOCSIS (TDM-based) scheduling for rtPS
services on upstream port 4 on a Cisco CMTS interface:

Router(config-if)# cable upstream 4 scheduling type rtps mode docsis

Related Commands Command Description

show interface cable mac-scheduler Use this command to confirm whether LLQ scheduling is enabled.

Cisco CMTS Cable Command Reference

925
 Cable Commands: cable u through cable w
cable upstream scrambler

cable upstream scrambler

To enable the cable upstream scrambler, use the cable upstream scrambler command in cable interface
configuration mode. To restore the default configuration value for this command, use the no form of this
command.

cable upstream n scrambler

no cable upstream n scrambler

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card.

Command Default Disabled

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

11.3 XA This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command causes CMs to enable their pseudo-random scrambler circuitry to improve the robustness of
the upstream receiver on the line card.
The scrambler on the upstream radio frequency (RF) carrier enables CMs on the HFC network to use built-in
scrambler circuitry for upstream data transmissions. The scrambler circuitry improves reliability of the upstream
receiver on the cable interface line card. The upstream scrambler is activated by default and should not be
disabled under normal circumstances.

Caution Scrambler must be activated for normal operation. Deactivate only for prototype CMs that do not support
scrambler.

Examples The following example shows how to activate the upstream scrambler:

Router(config-if)# cable upstream 0 scrambler#

Related Commands Command Description

cable upstream fec Enables the upstream FEC.

cable upstream frequency Enters a fixed frequency of the upstream RF carrier for an upstream port.

Cisco CMTS Cable Command Reference

926
Cable Commands: cable u through cable w
cable upstream scrambler

Command Description

cable upstream power-level Sets the input power level for the upstream RF carrier in decibels per millivolt
(dBmV).

cable upstream shutdown Disables the upstream port.

Cisco CMTS Cable Command Reference

927
 Cable Commands: cable u through cable w
cable upstream-sharing

cable upstream-sharing
To specify the upstream sharing scheme for all CBR-CCAP-LC-G2-R line cards in a chassis, use the cable
upstream-sharing command in global configuration mode.

cable upstream-sharing { 128x8 | 256x4 }

Command Default The default upstream sharing mode is 256x4

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Gilbraltar 16.12.1w This command was
introduced.

Usage Guidelines The cable upstream-sharing command allows you to choose the preferred upstream sharing mode for
CBR-CCAP-LC-G2-R line cards. The 256x4 mode allows 256 scqam channels and 1:4 sharing ratio per line
card. The 128x8 mode allows 128 scqam channels and 1:8 sharing ratio per line card. This command allows
you to choose between a higher number of upstream channels at a smaller sharing ratio or a lower number of
upstream channels ata larger sharing ratio.

Caution After toggling the mode the cable upstream-sharing command requires a chassis reload to take effect. If the
RPD and upstream configuration doesn't match the new mode, the cBR rejects the incompatible configurations
after chassis reload. We recommend you to modify the the startup config to accommodate the new mode
before reloading the chassis.

Note The cable upstream-sharing command affects only upstream A-TDMA.

Cisco CMTS Cable Command Reference

928
 Cable Commands: cable u through cable w
cable upstream shutdown

cable upstream shutdown

To disable a single upstream physical or logical channel port, use the cable upstream shutdown command
in cable interface configuration mode. To enable the upstream port, use the no form of this command.

Physical Channel
cable upstream n shutdown
no cable upstream n shutdown

Logical Channel
cable upstream n m shutdown
no cable upstream n m shutdown

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the cable
interface line card.

m Specifies the logical channel index of 0 or 1.

Command Default Upstream port is enabled

Command Modes
Interface configuration (config-if)

Command History Release Modification

11.3 XA This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCC This command was modified with the addition of logical channel index.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The cable upstream shutdown command shuts down a single upstream physical or logical port without
affecting any of the other upstream or downstream ports on the cable interface.

Note The cable upstream shutdown command exists at both physical and logical channel level with minor variations
in the command syntax.

When multiple logical channels are configured, the upstream related CLIs are categorized into two groups:
physical port level and logical channel level. Logical channel level commands use the format of cable upstream
n m shutdown, where n denotes the physical port number, and m denotes the logical channel index number.

Cisco CMTS Cable Command Reference

929
 Cable Commands: cable u through cable w
cable upstream shutdown

When multiple logical channels are configured, the cable upstream shutdown command at the physical level
shuts down the upstream physical port and all the logical channles configured under that physical port. To
shut down the entire interface, use the shutdown command in cable interface configuration mode.

Examples The following example shows how to disable the upstream port for the physical channel:

Router(config-if)# cable upstream 0 shutdown

The following example shows how to disable the upstream port for the logical channel:

Router(config-if)# cable upstream 0 0 shutdown

Related Commands Command Description

shutdown Shuts down (disables) an interface and all of its ports.

Cisco CMTS Cable Command Reference

930
 Cable Commands: cable u through cable w
cable upstream spectrum-group

cable upstream spectrum-group

To assign a spectrum group to a single upstream on a cable interface line card, use the cable upstream
spectrum-group command in interface configuration mode. To remove a spectrum group from an upstream,
use the no form of this command.

cable upstream n spectrum-group group-number

no cable upstream n spectrum-group group-number

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on
the cable interface line card.

group-number Specifies the spectrum group for which you are specifying a parameter value or specifies
the number of the spectrum group you wish to remove from your router configuration. Valid
range is from 1 to 32, or from 1 to 40, depending on the Cisco IOS software release.

Command Default No default behavior or values.

Command Modes
Interface configuration

Command History Release Modification

11.3 NA This command was introduced.

12.2(15)BC2 The maximum number of spectrum groups was increased from 32 to 40 groups per router.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS This command is replaced by us-channel spectrum-group command.

Usage Guidelines This command assigns a spectrum group to a single upstream on the cable interface line card. To configure
the spectrum groups, use the set of cable spectrum-group commands in global configuration mode.

Note You can also spectrum groups to all of the upstreams on the cable interface using the cable spectrum-group
(interface configuration) command.

Examples The following example shows how to assign spectrum group 12 to the first upstream on the cable
interface line card in slot 5/0:

Router(config)# interface cable 5/0

Router(config-if)# cable upstream 0 spectrum-group 12
Router(config-if)# exit
Router(config)#

Cisco CMTS Cable Command Reference

931
 Cable Commands: cable u through cable w
cable upstream spectrum-group

Related Commands Command Description

cable modulation-profile Configures preset modulation profiles that you can apply to one
or more upstream cable interfaces when you identify and configure
spectrum groups.

cable spectrum-group (global Creates and configures a spectrum group.

configuration)

cable spectrum-group (interface Assigns a spectrum group to all of the upstreams on a cable
configuration) interface line card.

cable spectrum-group hop period Sets the minimum frequency-hop interval for a cable spectrum
group.

cable spectrum-group hop threshold Specifies a hop threshold for a cable spectrum group.

cable spectrum-group shared Specifies the upstream ports in a spectrum group can share the
same upstream frequency.

cable upstream hopping blind Disengages the advanced spectrum management features of the
Cisco uBR-MC16S and Cisco uBR-MC5X20S/U cable interface
line cards by enabling blind frequency hopping behavior.

Cisco CMTS Cable Command Reference

932
 Cable Commands: cable u through cable w
cable upstream spreading-interval

cable upstream spreading-interval

To specify the spreading interval for Synchronous Code Division Multiple Access (S-CDMA) channels on
an upstream channel, use the cable upstream spreading-interval command in cable interface configuration
mode. To set the spreading interval value to its default setting, use the no form of this command.

cable upstream n spreading-interval spreading-interval

no cable upstream n spreading-interval

Syntax Description n Specifies the upstream port. Valid values start with 0 for the first upstream port on the
cable interface line card.

spreading-interval Specifies the spreading interval for S-CDMA channels. Valid values range from 1 to 32,
with a default value of 16.

Command Default The spreading-interval setting cannot be applied if S-CDMA is not configured.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is applicable only for S-CDMA channels. You should configure S-CDMA to apply the
spreading-interval.

Examples The following example sets the spreading interval to 32 on the upstream port 0:

Router(config)# interface cable 7/0/4

Router(config-if)# cable upstream 0 spreading-interval 32
Router(config-if)#

Related Commands Command Description

cable upstream active-codes Specifies the number of active codes that can be configured on an
upstream channel.

cable upstream codes-per-minislot Specifies the number of codes-per-minislot allowed on an upstream

channel.

Cisco CMTS Cable Command Reference

933
 Cable Commands: cable u through cable w
cable upstream threshold

cable upstream threshold

To configure the upstream for the carrier-to-noise ratio (CNR) or signal-to-noise ratio (SNR) and forward
error correction (FEC) threshold values to be used in determining the allowable noise levels, use the cable
upstream threshold command in cable interface configuration mode. To return to the default values, use the
no form of the command.

Cisco IOS Releases 12.2(8)BC2 and Earlier

cable upstream n threshold cnr-profile1 cnr-threshold1 cnr-profile2 cnr-threshold2 corr-fec
fec-corrected uncorr-fec fec-uncorrected
no cable upstream n threshold cnr-profile1 cnr-threshold1 cnr-profile2 cnr-threshold2 corr-fec
fec-corrected uncorr-fec fec-uncorrected

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

Physical Channel
lcable upstream n threshold {cnr-profiles cnr-threshold1 cnr-threshold2 | snr-profiles snr-threshold1
snr-threshold2 | hysteresis hysteresis-value | corr-fec fec-corrected | uncorr-fec fec-uncorrected}
no cable upstream n threshold {cnr-profiles | snr-profiles | hysteresis | corr-fec | uncorr-fec}

Logical Channel
cable upstream n m threshold {snr-profiles snr-threshold1 snr-threshold2 | corr-fec fec-corrected
| uncorr-fec fec-uncorrected}
no cable upstream n m threshold {snr-profiles | corr-fec | uncorr-fec}

Syntax Description n Upstream port number. The valid values range from 0 to 3.

m Logical channel index of 0 or 1.

cnr-profiles Specifies the CNR threshold in dB.

cnr-threshold1 CNR threshold for the primary modulation profile specified for the upstream.
The valid values range from 5 to 35 dB, with a default value of 25 dB.
To bypass both the primary and secondary CNR thresholds, set the first parameter
(cnr-threshold1) to 0. This disallows the second parameter (cnr-threshold2), enabling
you to bypass both the CNR thresholds.

cnr-threshold2 CNR threshold for the secondary modulation profile specified for the upstream.
The valid values range from 5 to 35 dB, with a default value of 15 dB. The secondary
threshold value must be lesser than the primary threshold.
If the first parameter (cnr-threshold1) is set to 0, then the second parameter
(cnr-threshold2) is not allowed.

snr-profiles Specifies the SNR threshold in dB.

Cisco CMTS Cable Command Reference

934
 Cable Commands: cable u through cable w
cable upstream threshold

snr-threshold1 SNR threshold for the primary modulation profile specified for the upstream. This
value is also used by the Cable Modem Upstream RF Adaptation feature.
The valid values range from 5 to 35 dB, with a default value of 25 dB.
You can bypass the primary SNR threshold (snr-threshold1) by setting it to 0.

snr-threshold2 SNR threshold for the secondary modulation profile specified for the upstream.
The valid values range from 5 to 35 dB, with a default value of 15 dB. The secondary
threshold value must be lesser than the primary threshold.
Though, you can bypass the primary SNR threshold (snr-threshold1) by setting it to
0, you must enter the second parameter (snr-threshold2).

hysteresis Specifies the hysteresis value to be used in conjunction with the dynamic modulation
hysteresis-value upgrade thresholds.
The threshold is specified in dB, with a valid range of 0 to 10 dB, and a default value
of 3 dB.
You can bypass the hysteresis threshold by setting the value to 0.

corr-fec fec-corrected Specifies the allowable number of correctable FEC errors for the upstream.
The fec-corrected parameter is given as a percentage of total packets received on the
upstream during the polling period, with a valid range of 1 to 30, and a default of 3.
You can bypass the corr-fec threshold by setting the value to 0.

uncorr-fec Specifies the allowable number of uncorrectable FEC errors for the upstream.
fec-uncorrected
The fec-uncorrected parameter is given as a percentage of total packets received on
the upstream during the polling period, with a valid range of 1 to 30, and a default
of 1.
You can bypass the uncorr-fec threshold by setting the value to 0.

Command Default Uses the default values.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.1(7)CX1 This command was introduced for Cisco CMTS routers using the Cisco uBR-MC16S cable
interface line card.

12.2(8)BC2 Support was added for the Cisco uBR10012 router and the Cisco uBR-LCP2-MC16S cable
interface line card. Also, the ranges and defaults for the correctable and uncorrectable FEC
error thresholds were changed.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

Cisco CMTS Cable Command Reference

935
 Cable Commands: cable u through cable w
cable upstream threshold

Release Modification

12.2(33)SCC This command was modified with the addition of snr-profileskeyword option and support
was added for Cisco uBR-MC5X20H cable interface line card. Also, this command is used
at both physical and logical channel level with slight variations in the command syntax
for the uBR10012 router.

IOS-XE This command was replaced by the us-channel threshold command.

3.15.OS

Usage Guidelines Separate CNR or SNR thresholds are assigned to the primary and secondary modulation profiles. Both profiles,
however, are assigned the same correctable and uncorrectable FEC values.

Note The uncorrectable FEC error count includes packets that have header checksum errors and “no unique word
detected” errors.

The hysteresis keyword of the cable upstream threshold command configures a hysteresis value to prevent
upstream channels from becoming unstable and continuously changing between modulation profiles.
• The hysteresis value is used in dynamic modulation, frequency hopping, and dynamic channel-width
changes.
• The hysteresis value is used in conjunction with CNR or SNR thresholds to determine channel
configuration upgrade criteria for both advanced and basic spectrum management features.
The range and defaults for the correctable and uncorrectable FEC error thresholds were changed in Cisco IOS
Release 12.2(8)BC2.
From Cisco IOS Release 12.2(33)SCC onwards, you can configure two logical channels on a single physical
port for the uBR10012 router. When you configure logical channels, the upstream related commands are
categorized into two groups: physical port level and logical channel level.
Physical Port Level
Physical port level commands use the format of cable upstreamn, where n denotes the physical port number.
Logical Channel Level
Logical channel level commands use the format of cable upstreamn m, where n denotes the physical port
number, and m denotes the logical channel index number of 0 or 1.
The following restrictions and conditions applies to both physical and logical channel configurations:
• You can bypass both the primary and secondary CNR thresholds by setting the first parameter to 0. This
disallows the second parameter, enabling you to bypass both the CNR thresholds.
• If you provide the primary CNR threshold, then you must enter the secondary CNR threshold also.
• You can bypass the primary SNR threshold by setting it to 0. However, you must enter the second
parameter. This is required as each threshold is used independently in Three Step Dynamic Upstream
Modulation feature.
• You can bypass the hysteresis, corr-fec, and uncorr-fec thresholds by setting their values to 0.
• For normal plant use, we recommend that the uncorrectable FEC threshold remain at its default of 1
percent to avoid an unacceptable number of errors on the channel.

Cisco CMTS Cable Command Reference

936
Cable Commands: cable u through cable w
cable upstream threshold

Cisco IOS Releases 12.2(8)BC2 and Earlier

The following example shows upstream 5 configured with the CNR threshold for the primary
modulation profile set to 20 dB, the CNR threshold for the secondary modulation profile set to 10
dB, the correctable FEC error rate set to 5 percent of total packets received on the upstream, and the
uncorrectable FEC error rate set to 1 percent of total packets received on the upstream:

Router(config)#interface cable 3/0

Router(config-if)# cable upstream 5 threshold cnr-profile1 20 cnr-profile2 10 corr-fec 5
uncorr-fec 1
Router(config-if)#

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

The following example shows upstream 5 configured with the CNR threshold for the primary
modulation profile set to 20 dB, the CNR threshold for the secondary modulation profile set to 10
dB, the correctable FEC error rate set to 5 percent of total packets received on the upstream, and the
uncorrectable FEC error rate set to 1 percent of total packets received on the upstream:

Router(config)#interface cable 3/0

Router(config-if)# cable upstream 5 threshold cnr-profiles 20 10
Router(config-if)# cable upstream 5 threshold corr-fec 5
Router(config-if)# cable upstream 5 threshold uncorr-fec 1
Router(config-if)#

The following example shows upstream 5 configured with the SNR threshold for the primary
modulation profile set to 20 dB, the SNR threshold for the secondary modulation profile set to 10
dB, the correctable FEC error rate set to 5 percent of total packets received on the upstream, and the
uncorrectable FEC error rate set to 1 percent of total packets received on the upstream:

Router(config)# interface cable 3/0

Router(config-if)# cable upstream 5 threshold snr-profiles 20 10
Router(config-if)# cable upstream 5 threshold corr-fec 5
Router(config-if)# cable upstream 5 threshold uncorr-fec 1
Router(config-if)#

SNR Example on the Cisco uBR10012 Router Only

The following example shows upstream 5 and logical channel 1 configured with the SNR threshold
for the primary modulation profile set to 20 dB, the SNR threshold for the secondary modulation
profile set to 10 dB, the correctable FEC error rate set to 5 percent of total packets received on the
upstream, and the uncorrectable FEC error rate set to 1 percent of total packets received on the
upstream:

Router(config)#interface cable 7/0/0

Router(config-if)# cable upstream 5 1 threshold snr-profiles 20 10
Router(config-if)# cable upstream 5 1 threshold corr-fec 5
Router(config-if)# cable upstream 5 1 threshold uncorr-fec 1
Router(config-if)#

Cisco CMTS Cable Command Reference

937
 Cable Commands: cable u through cable w
cable upstream threshold

Related Commands Command Description

cable modulation-profile Creates a cable modulation profile.

cable modulation-profile Creates a global cable modulation profile that allows to assign any
global-system number from 1 to 400 for modulation profiles, irrespective of the
DOCSIS mode.

cable upstream hop-priority Determines the order of the corrective actions to be taken when ingress
noise exceeds the allowable value for an upstream.

cable upstream modulation-profile Configures an upstream for one modulation profile (static profile) or
two modulation profiles (dynamic upstream modulation).

cable upstream threshold rf-adapt Configures the upstream RF adaptation threshold value, which
prevents excessive relocation of modems from the primary upstream
channel to the secondary upstream channel.

show cable hop Displays the current hop period and threshold for an upstream, along
with other statistics.

show cable modulation-profile Displays the cable modulation profiles that have been created.

Cisco CMTS Cable Command Reference

938
 Cable Commands: cable u through cable w
cable upstream threshold hysteresis

cable upstream threshold hysteresis

To configure a hysteresis value to be used in conjunction with the dynamic modulation upgrade thresholds,
use the cable upstream threshold hysteresis command in cable interface configuration mode. To use the
default hysteresis value, use the no form of this command.

cable upstream n threshold hysteresis hysteresis-in-dB

no cable upstream n threshold hysteresis

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on
the cable interface line card.

hysteresis-in-dB Specifies the hysteresis value to be used in conjunction with the dynamic modulation
upgrade thresholds.
The valid values are from 0 to 10 dB.

Command Default The default value of hysteresis is 3 dB.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.3(23)BC7 This command was first introduced.

IOS-XE This command was replaced by the us-channel threshold hysteresis command.
3.15.OS

Usage Guidelines The cable upstream threshold hysteresis command can be used to configure a hysteresis value to prevent
upstream (US) channels from becoming unstable and continuously changing between modulation profiles.
• The hysteresis value is used in dynamic modulation, frequency hopping, and dynamic channel-width
changes.
• The hysteresis value is used in conjunction with carrier-to-noise ratio (CNR) or signal-to-noise ratio
(SNR) thresholds to determine channel configuration upgrade criteria for both advanced and basic
spectrum management features.
• The hysteresis value is used for cable modem upstream RF adaptation upgrades from the secondary to
the primary upstream channel.

Examples The following example configures a hysteresis value to be used in conjunction with the SNR and
CNR thresholds for dynamic modulation upgrade.

Router(config)#interface cable 3/0

Router(config-if)#cable upstream 0 threshold hysteresis 5
Router(config-if)#

Cisco CMTS Cable Command Reference

939
 Cable Commands: cable u through cable w
cable upstream threshold hysteresis

Related Commands Command Description

cable modulation-profile Creates a cable modulation profile.

cable upstream hop-priority Determines the order of the corrective actions to be taken when ingress
noise exceeds the allowable value for an upstream.
Note
This command is related to the cable upstream threshold hysteresis
command only when using advanced dynamic modulation configuration,
that is, when spectrum group is defined for the upstream channel.

cable upstream threshold Configures the upstream for the carrier-to-noise ratio (CNR) or
signal-to-noise ratio (SNR) and forward error correction (FEC) threshold
values to be used in determining the allowable noise levels.

cable upstream threshold Configures the upstream RF adaptation threshold value, which prevents
rf-adapt excessive relocation of modems from the primary upstream channel to
the secondary upstream channel.

show cable modulation-profile Displays the cable modulation profiles that have been created.

Cisco CMTS Cable Command Reference

940
 Cable Commands: cable u through cable w
cable upstream threshold rf-adapt

cable upstream threshold rf-adapt

To configure the upstream RF adaptation threshold value, which prevents excessive relocation of modems
from the primary upstream channel to the secondary, use the cable upstream threshold rf-adapt command
in cable interface configuration mode. To use the default rf-adapt value, use the no form of this command.

cable upstream port threshold rf-adapt threshold1-in-percent

no cable upstream port threshold rf-adapt

Syntax Description port Upstream port number. The valid values start with 0 for the first upstream port on the
cable interface line card and ends with a value that depends on the number of upstream
ports supported by the cable interface line card.

threshold1-in-percent RF adaptation threshold value in percentage. The valid range is from 1 to 50. The
value 0 indicates the RF adaptation threshold is bypassed. The default value is 10
percent.

Command Default The default value is 10 percent.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Usage Guidelines The rf-adapt threshold represents a percentage of affected modems relative to the total modem population on
a given upstream channel. If the rf-adapt threshold is bypassed, then it is ignored while determining if a
downgrade candidate should be relocated. The rf-adapt threshold is applied only to the physical channel and
is used to prevent relocation of modems that are downgrade candidates.
The rf-adapt value is used by the upstream RF adaptation application to prevent the relocation of more than
x% of the total modem population on that upstream channel, during PHY layer impairment.

Examples The following example shows how to configure the rf-adapt threshold for cable modem upstream
RF adaptation.

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

Router(config-if)# cable upstream 0 threshold rf-adapt 25

Related Commands Command Description

cable rf-adapt timer Configures timers for RF adaptation.

cable upstream rf-adapt Enables RF adaptation on the physical upstream channel.

Cisco CMTS Cable Command Reference

941
 Cable Commands: cable u through cable w
cable upstream threshold rf-adapt

Command Description

cable upstream rf-adapt (logical Configures the primary upstream logical channel and secondary
channel) upstream logical channel.

cable upstream threshold Configures the upstream for the signal-to-noise ratio (SNR) and
forward error correction (FEC) threshold values to be used in
determining the allowable noise levels.

cable upstream threshold hysteresis Configures the hysteresis value to be used in conjunction with the
dynamic modulation upgrade thresholds.

show cable modem rf-adapt Displays the RF adaptation history.

show cable rf-adapt Displays the downgrade and upgrade candidate lists.

Cisco CMTS Cable Command Reference

942
 Cable Commands: cable u through cable w
cable upstream timing-adjust

cable upstream timing-adjust

To enable upstream timing adjustment for a specified cable interface, use the cable upstream timing-adjust
command in cable interface configuration mode. To return to the default values, use the no form of this
command.

cable upstream n timing-adjust {continue sec | threshold sec}

no cable upstream n timing-adjust {continue sec | threshold sec}

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on
the cable interface line card.

continue sec Sets the minimum timing adjustment that sets continue ranging status in seconds. The range
for sec is 2 to 64 seconds. Default value is 2 seconds.

threshold sec Sets the timing adjustment threshold in seconds. Valid threshold value is 1 to 32 seconds.
Default is 1 second.

Command Default 2 seconds for continue and 1 second for threshold

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

11.3 NA This command was introduced.

12.0(12)SC This command was supported on the 12.0 SC release.

12.1(3)T This command was supported on the 12.1 T release.

12.1(3a)EC This command was removed and no longer supported on the 12.1 EC and later releases
(including those releases, such as 12.1 CX, that are based on the 12.1 EC train).

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines To verify whether or not upstream timing adjustment is configured and activated, enter the show running-config
command and look for the cable interface configuration information. If upstream timing adjustment is enabled,
either or both of the continue and threshold timing adjustment entries are displayed in the show running-config
output. If both the continue and threshold upstream timing adjustments are disabled, no timing adjustment
entry is displayed in the show running-config output.
If you are having trouble, make sure that the cable connections are not loose or disconnected; the cable interface
line card is firmly seated in its chassis slot; the captive installation screws are tight; and you have entered the
correct slot and port numbers.

Cisco CMTS Cable Command Reference

943
 Cable Commands: cable u through cable w
cable upstream timing-adjust

Note The cable timing-adjust command is applicable only on Cisco IOS Release 12.0(12)SC and Cisco IOS
Release 12.1(3)T. It is deprecated and removed on Cisco IOS Release 12.1(3a)EC, 12.1(4)CX, and later
releases.

Examples The following example shows how to set the upstream time adjustment ranging value to 5 seconds:

CMTS01(config-if)# cable upstream 0 time-adjust continue 5

The following example shows how to set the threshold value to the default of 12 seconds:

CMTS01(config-if)# cable upstream 0 time-adjust threshold 12

Cisco CMTS Cable Command Reference

944
 Cable Commands: cable u through cable w
cable upstream unfrag-slot-jitter

cable upstream unfrag-slot-jitter

To control how much jitter can be tolerated on the corresponding upstream due to unfragmentable slots, use
the cable upstream unfrag-slot-jitter command in cable interface configuration mode. To disallow all jitter,
use the no form of this command.

cable upstream n unfrag-slot-jitter [limit jitter | cac-enforce]

no cable upstream n unfrag-slot-jitter [limit jitter | cac-enforce]

Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream port on the
cable interface line card. For Cisco cBR Series Converged Broadband Routers, the valid range
is from 0 to 15.

limit jitter Specifies the allowable jitter limit caused by unfragmentable slots, in microseconds (0 to
4,294,967,295).

cac-enforce Rejects service flows requesting jitter less than the fragmentable slot jitter.

Command Default By default, the limit is 0 microseconds and the cac-enforce option is enabled.

Command Modes Interface configuration—cable interface only (config-if)

MAC domain profile configuration (config-profile-md)

Command History Release Modification

12.1(4)CX This command was introduced.

12.2(4)BC1 Support was added to the Release 12.2 BC train.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command controls how much jitter due to unfragmented slots is to be tolerated on each port. If the
specified value for the tolerated limit is less than the size of a maximum unfragmentable slot, the MAC
scheduler automatically blocks the slots in the scheduling table so that the unfragmentable slot can be
accommodated in the blocked space and avoid causing excessive jitter to CBR slots.
The cac-enforce option enforces the rule that service flows requesting run-time jitter less than unfragmentable
slot jitter should be rejected.

Examples The following example shows the jitter being set to 10 milliseconds (10,000 microseconds) for
upstream port 0 on cable interface 2/0:

Router# configure terminal

Router(config)# interface c2/0
Router(config-if)# cable upstream 0 unfrag-slot-jitter limit 10000
Router(config-if)#

Cisco CMTS Cable Command Reference

945
 Cable Commands: cable u through cable w
cable util-interval

cable util-interval
To set the load and utilization interval of upstream and downstream physical channels, use the cable
util-interval command in global configuration mode. To remove the utilization interval, use the no form of
this command.

cable util-interval interval

no cable util-interval interval

Syntax Description interval Utilization interval for the upstream and downstream channels. The valid range is 1–86400 seconds.
Note
In Cisco IOS XE Dublin 17.12.1y and later,
• The maximum supported value is 2000 seconds. If you configure a value greater than 2000
seconds, it is still considered as 2000 seconds. This is because the maximum supported value
for the utilization interval of downstream channels is 2000. (Maximum supported value for
the utilization interval for upstream channels remains to be 86400 seconds).
• The docsIf31CmtsDsOfdmChanUtilization and docsIfCmtsChannelUtUtilization MIBs
refresh rate is 30 seconds. If the interval value is less than 30 seconds, then the
docsIfCmtsChannelUtUtilization MIB value is updated as per the configured cable util
interval. For example if cable util interval is configured as 10 seconds, then the MIB is
updated every 10 seconds.

Command Default The utilization interval is not set by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD2 This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Cisco IOS XE Gibraltar 16.10.1c The behavior of this command was updated on the Cisco cBR Series
Converged Broadband Routers.

Cisco IOS XE Dublin 17.12.1y The behavior of this command is updated on the Cisco cBR Series
Converged Broadband Routers.

Cisco CMTS Cable Command Reference

946
 Cable Commands: cable u through cable w
cable util-interval

Table 23: Release Wise Usage Guidelines

Usage Guidelines

Release Release Wise Usage Guidelines

IOS-XE The cable util-interval command configures the same value as the
3.15.0S docsIfCmtsChannelUtilizationInterval and ccwbRFChanUtilInterval objects.
The interval is used to determine the number of samples that are used to calculate a running
average value of utilization. The samples are collected every 10 seconds and a maximum of
30 samples can be stored. It means that when the interval is set to 300, utilization is calculated
using the last 30 samples.
The unit of interval is seconds and it is not recommended to set a smaller value as it may cause
frequent utilization calculation that will consume more resources on both, the PRE or SUP and
cable line card.
A value between 60–300 seconds or greater is recommended.
Note
You must set the utilization interval value for the docsIfCmtsChannelUtilizationInterval
object.

Cisco IOS In Cisco IOS XE Gibraltar 16.10.1c release, this command does not have effect on OFDM
XE channel utilization from docsIfCmtsChannelUtilizationInterval object, use
Gibraltar ccwbRFChanUtilInterval object instead in this case. Each time the MIB query is performed,
16.10.1c utilization is calculated using the last 30 samples and the value is returned.
For SCQAM channel, both MIB objects update at the end of the interval that is configured by
this command.

Cisco IOS Starting with Cisco IOS XE Dublin 17.12.1y, use the cable util-interval value to determine
XE Dublin number of samples that you need to collect. These samples are used to calculate rolling avg
17.12.1y utilization value.
and later

Examples The following example shows how to set the utilization interval for the upstream and downstream
channels:

Router# configure terminal

Router(config)# cable util-interval 300

Related Commands Command Description

show running-config Displays the running configuration for each of the cable interfaces.

Cisco CMTS Cable Command Reference

947
 Cable Commands: cable u through cable w
cable vc-map

cable vc-map
To map a cable modem to a particular permanent virtual connection (PVC) on an Asynchronous Transfer
Mode (ATM) interface, use the cable vc-map command in global configuration mode. To remove this mapping,
use the no form of this command.

cable vc-map mac-address atm-interface vpi/vci [cust-name]

no cable vc-map mac-address
no cable vc-map customer cust-name

Syntax Description mac-address Specifies the hardware (MAC) address for the cable modem whose traffic is to be
mapped.

atm-interface Specifies the outbound ATM interface to which this cable modem should be mapped.

vpi/vci Specifies the virtual path identifier (VPI) and virtual channel identifier (VCI) on the
ATM interface to which this cable modem should be mapped.

cust-name (Optional) Identifies the customer for this PVC. The cust-name can be any arbitrary
alphanumeric string, up to 127 characters long.

customer cust-name (Optional) Deletes all PVCs belong to this customer. The cust-name can be any arbitrary
alphanumeric string, up to 127 characters long.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(11)BC3 This command was introduced for Cisco uBR7100 series and Cisco uBR7246VXR universal
broadband routers.

12.2(15)BC2 Support for the customer option was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command maps a cable modem, on the basis of its hardware (MAC) address, to a particular PVC on an
ATM interface.

Note To use this command, you must first enable the use of Layer 2 tunnels, using the cable l2-vpn-service atm-vc
command. Then use the cable vc-map command to enable the mapping of individual cable modems to specific
PVCs.

Cisco CMTS Cable Command Reference

948
 Cable Commands: cable u through cable w
cable vc-map

Examples The following example shows how to enable the use of Layer 2 tunnels and then map specific CMs
to specific PVCS:

Router# config terminal

Router(config)# cable l2-vpn-service atm-vc
Router(config)# cable vc-map 0007.0e03.69f9 ATM2/0 1/1
Router(config)# cable vc-map 0010.7bed.9c95 ATM2/0 1/2
Router(config)# exit
Router#

The following example shows the same configuration as above, but with the addition of a customer
name that identifies the customer that is using each particular PVC:

Router# config terminal

Router(config)# cable l2-vpn-service atm-vc
Router(config)# cable vc-map 0007.0e03.69f9 ATM2/0 1/1 ENTERPRISE-CO1
Router(config)# cable vc-map 0010.7bed.9c95 ATM2/0 1/2 ENTERPRISE-CO2
Router(config)# exit
Router#

Related Commands Command Description

cable l2-vpn-service atm-vc Enables the use of Layer 2 tunnels for the Customer Premises Equipment
(CPE) traffic that is behind cable modems, so that individual CPE traffic can
be routed to a particular PVC on an ATM interface.

debug cable l2-vpn Displays debugging messages for the Layer 2 mapping of cable modems to
a particular PVC on an ATM interface.

show cable l2-vpn vc-map Displays the mapping of one or all cable modems to PVCs on the ATM
interfaces.

Cisco CMTS Cable Command Reference

949
 Cable Commands: cable u through cable w
cable video

cable video
To enter the video configuration mode, use the cable video command in global configuration mode.

cable video

Syntax Description This command has no keywords or arguments.

Command Modes
Global configuration (config)

Command History Release Modification

IOS-XE 3.18.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to enter the video configuration mode.

Examples The following example shows how to enter the video configuration mode:

Router# configure terminal

Router(config)# cable video
Router(config-video)#

Cisco CMTS Cable Command Reference

950
 Cable Commands: cable u through cable w
cable video source-switch

cable video source-switch

To switch to another valid multicast source in certain scenarios, such as maintenance, use the cable video
source-switchcommand in privileged EXEC mode.

cable video source-switch {from-group group IP address from-source source IP address | to-group
new group IP address to-source source IP address}

Syntax Description from-group group IP address Force source switch from a given multicast group.

from-source source IP address Force source switch from a given multicast source.

to-group group IP address Force source switch to this multicast group.

to-source source IP address Force source switch to this multicast source.

Command Default None.

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Normally, the system automatically switches to the next valid source IP when the current source goes down
or fails for some reasons. Only use this command in certain scenarios, such as maintenance.

Examples The following example shows how to enable wideband auto-reset mode:

Router# cable video source-switch to-group 238.11.3.103 to-source 176.52.1.10

%%Current sessions with this source will be reset.
Service will be affected. Is this OK to continue? [Yes/No][confirm]y

1048781 126 Remap SSM 176.51.1.10,238.11.3.103 0 1

ACTIVE-PSI ON 2404203 2383890 CLEAR - SESS_PME1.1.8.184
1048780 127 Data-Piping SSM 176.51.1.10,238.11.3.77 0 -
ACTIVE-PSI ON 2404782 0 CLEAR - rw.1.8.185
1048678 140 Remap SSM 176.52.1.10,238.11.3.85 0 1
ACTIVE-PSI ON 2403607 2384815 CLEAR - SESS_PME2.1.8.336
1048679 141 Remap UDP 174.101.1.2 49500 1 OFF
ON 0 0 CLEAR - uni1.3.0.1.21.49500

Cisco CMTS Cable Command Reference

951
 Cable Commands: cable u through cable w
cable vrf-steering cable-modem

cable vrf-steering cable-modem

To steer or direct the cable modems to the first sub-bundle interface that is configured to use the virtual routing
and forwarding (VRF) instance, use the cable vrf-steering cable-modem command in the cable subinterface
configuration mode. To disable this feature, use the no form of this command.

cable vrf-steering cable-modem vrf-name

no cable vrf-steering cable-modem vrf-name

Syntax Description vrf-name VRF instance name.

Command Default Configure a sub-bundle using the ip vrf forwarding command first to enable this command.

Command Modes
Subinterface configuration (config-if)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to direct the cable modems to the specified VRF:

Note Create an ACL and route-map to steer the CPEs from the CM interface to the global interface before
you steer the CM to the first sub-bundle interface. Use the ip access-list extended access-list name
and route-map route map name permit commands to create an ACL and route-map respectively
on the Cisco uBR10012 routers. Use ip policy route-map route map name command to attach the
route-map to the CM's subbundle interface.

Router(config-if)#cable vrf-steering cable-modem vrfa

Related Commands Command Description

cable source-route Configures the VRF source route on the cable modem's subinterface configuration mode.

ip vrf Defines a VRF instance and enters the interface configuration mode.

show ip arp vrf Displays which VRF contains a specific cable modem in the ARP table.

Cisco CMTS Cable Command Reference

952
 Cable Commands: cable u through cable w
cable wideband auto-reset

cable wideband auto-reset

To enable wideband auto-reset mode on the CMTS, use the cable wideband auto-reset command in global
configuration mode. To disable wideband auto-reset mode, use the no form of this command.

cable wideband auto-reset

no cable wideband auto-reset

Syntax Description This command has no keywords or arguments.

Command Default Wideband auto-reset mode is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced for the uBR10012 router.

12.3(23)BC This command was updated.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to enable wideband auto-reset mode on the CMTS. If wideband auto-reset mode is enabled,
wideband cable modems registered on a cable interface as traditional DOCSIS modems (DOCSIS 1.x/2.0
modems) are auto-reset when the cable interface becomes wideband-capable. When a wideband cable modem
auto-resets, it deregisters on the CMTS as a traditional DOCSIS cable modem and immediately attempts to
re-register as a wideband cable modem.
A cable interface is considered wideband-capable when at least one fully configured and operational wideband
channel has been associated with the interface’s traditional DOCSIS (narrowband) channel.
For a fully configured wideband CMTS, wideband cable modems may register as traditional DOCSIS modems
for a variety of reasons, such as cable interface line card boot order or line card online insertion and removal
(OIR). Rather than defer wideband cable modem registration, wideband cable modems are permitted to register
as traditional DOCSIS modems.
If a wideband-capable modem registers as a traditional DOCSIS modem, it registers on a primary downstream
channel that has been assigned with the downstream cable command to the modem’s fiber node if the fiber
node is configured. If the modem’s fiber node is not configured, the wideband-capable modem can register
on any downstream channel that is visible to it (as a traditional cable modem does).

Note In Cisco IOS Release12.3(21)BC, the primary downstream channel is a traditional DOCSIS downstream
channel for the fiber node. Beginning in Cisco IOS Release 12.3(23)BC, either an RF channel from the SPA
or a Cisco uBR10-MC5X20 downstream channel serves as a primary channel in a fiber node. Beginning in
Cisco IOS Release12.3(23)BC if the primary downstream channel for this fiber node is assigned from a SPA
downstream, then the downstream cable command is not required.

Cisco CMTS Cable Command Reference

953
 Cable Commands: cable u through cable w
cable wideband auto-reset

When and if a cable interface becomes wideband capable, wideband cable modems that have registered as
traditional DOCSIS modems are reset for CMTS routers with wideband auto-reset mode enabled. These
modems are only reset when the interface first becomes wideband-capable and are not reset again if they
subsequently fail to register as wideband cable modems.

Examples The following example shows how to enable wideband auto-reset mode:

Router# configure terminal

Router(config)# cable wideband auto-reset

Related Commands Command Description

cable bundle Configures a cable interface to belong to a virtual bundle interface.

downstream cable Assigns a primary downstream channel for a fiber node.

Cisco CMTS Cable Command Reference

954
Cable Commands: ca through cr
• ca-interface, on page 957
• ca-system-id, on page 959
• channel-group, on page 960
• channel-id (cable configuration file), on page 962
• check-scg-at-prov, on page 964
• class , on page 966
• clear cable admission control counters, on page 967
• clear cable arp-filter, on page 969
• clear cable bgsync counters, on page 971
• clear cable cmc, on page 972
• clear cable dsg, on page 973
• clear cable flap-list, on page 975
• clear cable hop, on page 977
• clear cable host, on page 980
• clear cable ipc-stats, on page 982
• clear cable load-balance, on page 983
• clear cable load-balance error-statistics, on page 985
• clear cable logging, on page 986
• clear cable modem attribute-masks, on page 988
• clear cable modem cm-status, on page 990
• clear cable modem counters, on page 992
• clear cable modem delete, on page 994
• clear cable modem device-class , on page 998
• clear cable modem flap-counters, on page 1001
• clear cable modem lock, on page 1004
• clear cable modem name, on page 1007
• clear cable modem partial-service, on page 1009
• clear cable modem path-sel , on page 1010
• clear cable modem pnm, on page 1011
• clear cable modem rcs-counts, on page 1013
• clear cable modem reset, on page 1015
• clear cable modem rf-adapt, on page 1019
• clear cable modem service-type-id, on page 1021

Cisco CMTS Cable Command Reference

955
 Cable Commands: ca through cr

• clear cable modem voice, on page 1023

• clear cable multicast ses-cache, on page 1025
• clear cable multicast statistics counter, on page 1028
• clear cable resil-rf-status, on page 1029
• clear cable rf-status, on page 1030
• clear cable rpd all event, on page 1031
• clear cable rpd reset, on page 1032
• clear cable secondary-ip, on page 1034
• clear cable upstream ofdma mer-fec, on page 1036
• clear hccp counters, on page 1037
• clear hccp linecard, on page 1039
• clear packetcable gate counter commit, on page 1040
• clear packetcable rks, on page 1042
• clear pxf, on page 1044
• clear pxf statistics drl all , on page 1046
• clear pxf statistics drl cable-wan-ip, on page 1047
• clear pxf statistics drl wan-non-ip, on page 1048
• clear pxf statistics drl max-rate , on page 1049
• clear redundancy, on page 1050
• cmc, on page 1052
• connection, on page 1053
• controller downstream-oob 55d1-profile, on page 1054
• controller integrated-cable, on page 1055
• controller modular-cable, on page 1057
• controller upstream-cable , on page 1059
• controller upstream-oob 55d1-profile, on page 1060
• cops ip dscp, on page 1061
• cops listeners access-list, on page 1065
• cops tcp window-size, on page 1067
• core-interface, on page 1069
• cp-overrule, on page 1070
• cpd, on page 1071
• cpd cr-id, on page 1072
• cpe max, on page 1073
• cyclic-prefix, on page 1075

Cisco CMTS Cable Command Reference

956
 Cable Commands: ca through cr
ca-interface

ca-interface
To configure the conditional access interface for session based scrambling, use the ca-interface command in
the DVB scrambling configuration mode. To disable conditional access interface configuration, use the no
form of this command.

ca-interface linecard slot/bay ip_address

no ca-interface linecard slot/bay

slot/bay Specifies the slot and bay of the linecard.

ip_address Specifies the IP for the conditional access interface.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to configure the conditional access interface:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ca-interface linecard 7/0 1.24.10.8

Related Commands Command Description

dvb Enters DVB scrambling configuration mode.

strong-pairing-enforce Switches on the NDS strong pairing enforcement

mgmt-ip Configures the manangement IP for EIS/Broadcast

ECMG.

scramble-video-audio Scrambles only video and audio pids.

route-ecmg Configures the route to the ECMG server.

check-scg-at-prov Enables Check SCG at provision time.

tier-based Enters the tier-based scrambling configuration mode.

ecmg Enters the ECM Generator configuration mode.

Cisco CMTS Cable Command Reference

957
 Cable Commands: ca through cr
ca-interface

Command Description

eis Enters the Event Information Scheduler configuration

mode.

Cisco CMTS Cable Command Reference

958
 Cable Commands: ca through cr
ca-system-id

ca-system-id
To configure the CA system ID, use the ca-system-id command in the DVB scrambling ECMG configuration
mode. To void the CA system ID configuration, use the no form of this command.

ca-system-id id sub_id
no ca-system-id id sub_id

id Specifies the CA system ID in Hex.

sub_id Specifies the CA sub system ID in Hex.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to configure the CA system ID:

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

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

auto-channel-id Enables automatic channel ID selection.

connection Configures the ECMG connection.

ecm-pid-source Configures the source of ECM PID.

type Configures the ECMG type.

mode Configures the application mode of ECMG.

desc-rule Configures the descriptor rule.

overrule Overrules the default settings.

Cisco CMTS Cable Command Reference

959
 Cable Commands: ca through cr
channel-group

channel-group
To add an interface (Gigabit Ethernet or Fast Ethernet) to an EtherChannel Group, and to associate that
interface with an EtherChannel link, use the channel-group command in interface configuration mode.
To remove an EtherChannel interface from the EtherChannel group, use the no form of this command.

channel-group n
no channel-group n

Cisco cBR Series Converged Broadband Routers

channel-group n
link link-id | mode {active | passive} [ link link-id]
no channel-group n

Syntax Description n The identifying number for the EtherChannel group with which to associate this interface. An
EtherChannel group can be identified in the range of 1 to 64.
Each group can have up to four interfaces on the Cisco uBR10012 and Cisco uBR7200 series
routers, only one of which is the primary.
Each group can have up to eight interfaces on the Cisco cBR series routers, only one of which
is the primary.

link Assigns a link identifier used for load balancing.

link-id
• link-id—Load balancing link identifier. The range is from 1 to 8.

mode Specifies the Etherchannel mode for the interface.

active Enables Link Aggregation Control Protocol (LACP) unconditionally.

passive Enables LACP only if an LACP device is detected.

Command Default By default, the channel-group command has the following behaviors:
• EtherChannel groups and ports are not defined.
• EtherChannel groups and ports are disabled (off mode) once configured, and must be enabled.
• The first port assigned to an EtherChannel group is the bundle primary.

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(11)BC3 This command was introduced on the Cisco uBR7246VXR router.

12.2(9a)BC This command was introduced on the Cisco uBR10012 router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

Cisco CMTS Cable Command Reference

960
 Cable Commands: ca through cr
channel-group

Release Modification

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The no form of this command also removes the associated EtherChannel ports within the EtherChannel group.
For additional information, refer to the EtherChannel on the Cisco CMTS Routers feature document on
Cisco.com.
The Cisco cBR series routers support the channel group configuration on the Ten Gigabit Ethernet interface.

Examples The following example creates an EtherChannel link with a channel group identifier of 1 on the
specified port. If this is the first port assigned to EtherChannel group 1, it becomes the primary in
that EtherChannel group.

Router(config-if)# channel-group etherchannel 1

The following example creates an EtherChannel link with a channel group identifier of 3 on the
specified port on a Cisco cBR-8 router:

Router(config)# interface port-channel 3

Router(config-if)# exit
Router(config)# interface TenGigabitEthernet 5/1/0
Router(config-if)# channel-group 3 mode active

Related Commands Command Description

show interface port-channel Displays the EtherChannel interfaces and channel identifiers, with their mode
and operational status.

Cisco CMTS Cable Command Reference

961
 Cable Commands: ca through cr
channel-id (cable configuration file)

channel-id (cable configuration file)

To create a DOCSIS configuration file that specifies the upstream channel ID for a CM configuration file,
use the channel-id command in cable config-file configuration mode. To remove the channel ID specification,
use the no form of this command.

channel-id upstreamchan-id
no channel-id

Syntax Description upstreamchan-id Specifies the upstream channel ID. Valid range is 0 to 255, depending on the number of
actual upstream ports on the cable interface being used.

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

Command Modes
Cable configuration file (config-file)

Command History Release Modification

12.1(2)EC1 This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the Upstream Channel ID Configuration Setting field in the DOCSIS configuration file.
Typically, the CM uses the upstream channel ID that is specified by the CMTS during the registration process,
but this command overrides that setting and forces the CM to use the upstream channel specified in the DOCSIS
configuration file. If that upstream does not exist, or if the upstream cannot be obtained for some reason, the
CM cannot come online.

Note If you are using a telco-return CM, the upstream channel must be 0.

Examples The following example shows how to set the upstream channel ID for the configuration file to 3. If
the CM cannot obtain this upstream channel, it does not come online.

Router(config)# cable config-file channeloverride.cm

Router(config-file)# channel-id 3
Router(config-file)# exit

Cisco CMTS Cable Command Reference

962
 Cable Commands: ca through cr
channel-id (cable configuration file)

Related Commands Command Description

cable Creates a DOCSIS configuration file and enters configuration file mode.
config-file

access-denied Disables access to the network.

cpe max Specifies CPE information.

download Specifies download information for the configuration file.

frequency Specifies downstream frequency.

option Provides config-file options.

privacy Specifies privacy options for baseline privacy images.

service-class Specifies service class definitions for the configuration file.

snmp manager Specifies Simple Network Management Protocol (SNMP) options.

timestamp Enables time-stamp generation.

Cisco CMTS Cable Command Reference

963
 Cable Commands: ca through cr
check-scg-at-prov

check-scg-at-prov
To enable Check SCG at provision time, use the check-scg-at-prov command in the DVB scrambling
configuration mode. To disable Check SCG at provision time, use the no form of this command.

check-scg-at-prov
no check-scg-at-prov

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines When SCG checking at the time of provisioning is enabled, the Simulcrypt Synchroniser (SCS) does not
provision the SCG from EIS if the elementary streams or services in the incoming stream do not match the
streams or services in SCG provisioning message. When this configuration is disabled, the input transport
stream is verified only during scrambling.

The following is an example of how to enable Check SCG at provision time:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#check-scg-at-prov

Related Commands Command Description

dvb Enters DVB scrambling configuration mode.

strong-pairing-enforce Switches on the NDS strong pairing enforcement

mgmt-ip Configures the manangement IP for EIS/Broadcast

ECMG.

scramble-video-audio Scrambles only video and audio pids.

route-ecmg Configures the route to the ECMG server.

ca-interface Configures the conditional access interface.

tier-based Enters the tier-based scrambling configuration mode.

ecmg Enters the ECM Generator configuration mode.

Cisco CMTS Cable Command Reference

964
Cable Commands: ca through cr
check-scg-at-prov

Command Description

eis Enters the Event Information Scheduler configuration

mode.

Cisco CMTS Cable Command Reference

965
 Cable Commands: ca through cr
class

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

class 1:N
no class

Syntax Description 1:N Specifies N+1 redundancy class for the redundancy group.

Command Default None.

Command Modes Line card redundancy configuration (config-red-lc)

Command History Release Modification

IOS-XE Release 3.16.0S This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines You cannot change the class while group has members. Remove all the members to change the class.

Examples The following example shows how to configure 1:N redundancy class on Cisco cBR-8 Series
Converged Broadband Routers:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# redundancy
Router(config-red)# linecard-group 0 internal-switch
Router(config-red-lc)# class 1:N
Class set to 1:N for Redundancy group (0)
Router(config-red-lc)#

Related Commands Command Description

description Adds a description to the line card group.

linecard-groupinternal-switch Creates a line card group for the line card.

member slot Adds a slot to the redundancy group.

redundancy Enters redundancy configuration mode.

show redundancy linecard Displays information about a line card or a line card group.

Cisco CMTS Cable Command Reference

966
 Cable Commands: ca through cr
clear cable admission control counters

clear cable admission control counters

To reset all the resource counters on the Cisco CMTS to zero, use the clear cable admission control counters
command in privileged EXEC mode.

clear cable admission control counters

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(13a)BC This command was introduced.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The counters are also set to zero when a given resource is reconfigured. Counters can be displayed using the
show cable admission-control command.
For additional information, refer to the Admission Control for the Cisco CMTS feature documents on Cisco.com.

Examples The following example resets configured admission control counters to zero, whether configured in
global or interface configuration mode:

Router# clear cable admission control counters

Related Commands Command Description

cable admission-control Configures the CPU and memory thresholds for the Cisco CMTS
and supporting broadband processing engines (BPEs)

cable admission-control event Configures and enables Admission Control event types on the
Cisco CMTS.

cable admission-control ds-bandwidth Configures Admission Control downstream bandwidth thresholds

on the Cisco CMTS.

cable admission-control us-bandwidth Configures Admission Control upstream bandwidth thresholds on

the Cisco CMTS.

debug cable admission-control Enables automatic Admission Control troubleshooting processes

on the Cisco CMTS.

Cisco CMTS Cable Command Reference

967
 Cable Commands: ca through cr
clear cable admission control counters

Command Description

show cable admission-control Displays the current Admission Control configuration and status
on the Cisco CMTS, or on a specified interface.

Cisco CMTS Cable Command Reference

968
 Cable Commands: ca through cr
clear cable arp-filter

clear cable arp-filter

To reset Address Resolution Protocol (ARP) filter statistics displayed by the show cable arp-filter command,
use the clear cable arp-filter command in privileged EXEC mode.

clear cable arp-filter {bundle number cable slot/port | slot/subslot/port}

Syntax Description bundle number Resets the ARP filter statistics for the specified virtual bundle interface, where number
is a value from 1 to 255.

cable slot/port (Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal of CMs on
the specified cable interface and downstream port, where:
• slot—Specifies the chassis slot number of the cable interface line card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and cable interface
line card. Refer to the hardware documentation for your router chassis and cable interface
line card for supported slot and port numbering.

cable (Cisco uBR10012 Router) Specifies removal of CMs on the specified cable interface,
slot/subslot/port where:
• slot—Specifies the chassis slot number of the cable interface line card. Valid slots
are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line card.
Valid subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4, depending
on the cable interface line card.

cable (Cisco cBR Series Routers) Specifies removal of CMs on the specified cable interface,
slot/subslot/port where:
• slot—Slot number of the card. Valid slots are 0 to 3 and 6 to 9 on the Cisco
cBR-8router.
• subslot—Subslot number of the card. The valid value is 0 on the Cisco
cBR-8router.
• port—Downstream port number. The valid range is from 0 to 15 on the Cisco
cBR-8router.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(17a)BC This command was introduced.

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

Cisco CMTS Cable Command Reference

969
 Cable Commands: ca through cr
clear cable arp-filter

Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the clear cable arp-filter command to clear the ARP filter statistics that are displayed using the show
cable arp-filter command.

Examples This example shows cable ARP filter statistics for virtual bundle interface number 10, followed by
a clearing of the ARP filter statistics on that bundle and the resulting display of cleared statistics.

Router# show cable arp-filter bundle 10

ARP Filter statistics for Bundle10:
Replies Rcvd: 3069 total. 3062 unfiltered, 7 filtered
Requests Forwarded: 1175 total. 1175 unfiltered, 0 filtered
Requests Sent For IP: 0 total. 0 unfiltered, 0 filtered
Router# clear cable arp-filter bundle 10
Router# show cable arp-filter bundle 10
ARP Filter statistics for Bundle10:
Replies Rcvd: 0 total. 0 unfiltered, 0 filtered
Requests Forwarded: 0 total. 0 unfiltered, 0 filtered
Requests Sent For IP: 0 total. 0 unfiltered, 0 filtered

Related Commands Command Description

cable arp filter Controls the number of ARP packets that are allowable for each SID on a cable
interface.

clear arp-cache Refreshes dynamically created entries from the ARP cache.

show cable arp-filter Displays the total number of ARP replies and requests that have been sent and
received, including the number of requests that have been filtered.

Cisco CMTS Cable Command Reference

970
 Cable Commands: ca through cr
clear cable bgsync counters

clear cable bgsync counters

To clear the background synchronization information on the Cisco CMTS, use the clear cable bgsync counters
command in global configuration mode.

clear cable bgsync counters

Syntax Description This command has no arguments or keywords.

Command Modes
Global configuration mode (config)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.18.0S This command is implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the clear cable bgsync counters command to clear the background synchronization information statistics
on the Cisco CMTS.

Examples The following example shows how to clear the background synchronization counters on the Cisco
CMTS:

Router# configure terminal

Router(config)# clear cable bgsync counters
Router(config)#

Related Commands Command Description

cable bgsync Sets the data intervals for background synchronization on the Cisco CMTS.

cable bgsync active Activates background synchronization process on the Cisco CMTS.

show cable bgsync Displays the information on the background synchronization process.

Cisco CMTS Cable Command Reference

971
 Cable Commands: ca through cr
clear cable cmc

clear cable cmc

To clear the Cisco CMC information, use the clear cable cmc command in privileged EXEC mode.

clear cable cmc {all mac-address}

Syntax Description all Specifies that the information on all Cisco CMCs must be cleared.

mac-address MAC address of the Cisco CMC for which the information must be cleared.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)CX This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The clear cable cmc clears the Cisco CMC. When this command is used, the Cisco CMTS clears all the
running data of the Cisco CMC from current database and disconnects the Generic Control Protocol (GCP)
connection. Therefore, the Cisco CMC reboots.

The following example shows how to clear the information for all Cisco CMCs:
Router# clear cable cmc all

The following example shows how to clear the information on the Cisco CMC with the MAC address
0010.2024.7035:
Router# clear cable cmc 0010.2024.7035

Related Commands Command Description

cable cmc Configures the downstream RF power and FRx on

the Cisco CMC.

show cable cmc Displays the Cisco CMC information.

Cisco CMTS Cable Command Reference

972
 Cable Commands: ca through cr
clear cable dsg

clear cable dsg

To reset counters related to DOCSIS Set-top Gateway (DSG) tunnels, use the clear cable dsg command in
privileged EXEC mode.

clear cable dsg

Syntax Description This command has no arguments or keywords.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(15)BC2 This command was introduced for the Cisco uBR7100 series and Cisco uBR7246VXR
routers.

12.3(13a)BC This command is obsolete.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines DSG operation is disabled using the no cable dsg command, but this does not clear out the DSG-related
counter (“mapping entry is used”), so that you can retain its value in case you intend to restart DSG operations
again. If, however, you want to reset those counters to zero, use the clear cable dsg command.

Note This command resets the “mapping entry is used” counters for all DSG tunnels and interfaces on the router.

Examples The following example shows how to clear the DSG counters for all cable interfaces on the router,
and shows an example of the show cable dsg command showing the counters after they have been
cleared.

Router# show cable dsg stats

DSG statistics information

DSG keepalive is set
Vendor: DDD, Tunnel count: 1
Vendor: BBB, Tunnel count: 2
Vendor name is DDD, tunnel MAC is 0001.0002.0003
Group address is 226.2.2.2, source address is *
Interface is Cable5/1, mapping entry is used 2
Received 5968 packets, forwarded 5289 packets
Dropped 679 packets, last second rate 16878 bits/sec
Router# clear cable dsg

Router# show cable dsg stats

DSG statistics information

Vendor: DDD, Tunnel count: 1
Vendor: BBB, Tunnel count: 2
Vendor name is DDD, tunnel MAC is 0001.0002.0003

Cisco CMTS Cable Command Reference

973
 Cable Commands: ca through cr
clear cable dsg

Group address is 226.2.2.2, source address is *

Interface is Cable5/1, mapping entry is used 0
Received 5968 packets, forwarded 5289 packets
Dropped 679 packets, last second rate 16878 bits/sec

Related Commands Command Description

cable dsg Enables the DOCSIS Set-Top Gateway (DSG) on a cable interface, and configures its
tunnel-mapping parameters.

cable dsg keepalive Enables keepalive messages over DOCSIS Set-Top Gateway (DSG) tunnels on a cable
interface.

debug cable dsg Enables the display of debugging messages for the operation of the DOCSIS Set-Top
Gateway (DSG) feature.

show cable dsg Displays the current DOCSIS Set-Top Gateway (DSG) tunneling parameters.

Cisco CMTS Cable Command Reference

974
 Cable Commands: ca through cr
clear cable flap-list

clear cable flap-list

To reset the flap-list table for a specific CM or for all CMs connected to the Cisco CMTS router, use the clear
cable flap-list command in privileged EXEC mode.

clear cable flap-list {mac-addr | all} [save-counters]

Syntax Description mac-addr Specifies the 48-bit MAC address (hardware address) of an individual CM to be cleared
from the flap-list table.

all Removes all CMs from the flap-list table.

save-counters (Optional) Preserves the flap-list counters that are displayed by the show cable flap-list
command and by using SNMP requests to access the CISCO-CABLE-SPECTRUM-MIB.

Command Default Clears the flap-list counters.

Command Modes
Privileged EXEC (#)

Command History Release Modification

11.3 NA This command was introduced.

11.3(7)NA The save-counters option was supported on the Cisco uBR7200 series routers.

12.1(5)EC1 Support was added for the Cisco uBR7100 series routers.

12.2(4)BC1 Support for this command (without the save-counters option) was added for the Cisco
uBR10012 router.

12.2(15)BC2 The save-counters option was supported on the Cisco uBR10012 router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines Cable modems are removed from the flap-list table after the number of days (between 1 and 60) specified by
the cable flap-list aging global configuration command. Use the clear cable flap-list command to remove
individual CMs from the flap-list while retaining flapping activity for other CMs, or to clear the entire flap-list
table.

Examples The following example shows how to remove all the CMs from the flap-list table:

Router# clear cable flap-list all

Cisco CMTS Cable Command Reference

975
 Cable Commands: ca through cr
clear cable flap-list

Related Commands Command Description

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

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

cable flap-list miss-threshold Specifies miss threshold for recording a flap-list event.

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

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

clear cable modem counters Zeroes the CM counters, including flap-list counters.

clear cable modem reset Removes a CM from the Station Maintenance List and resets it.

debug cable flap Displays information about the operation of the CM flap list that
is maintained for the cable interfaces.

ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters
as appropriate.

show cable flap-list Displays the current contents of the flap list.

Cisco CMTS Cable Command Reference

976
 Cable Commands: ca through cr
clear cable hop

clear cable hop

To clear the forward error corrections (FEC) hop counters on one or all cable interfaces on a Cisco CMTS,
use the clear cable hop command in privileged EXEC mode.

clear cable hop [cable {slot/port | slot/subslot/port} [upstream uport]]

Cisco cBR Series Converged Broadband Routers

clear cable hop [upstream-cable {slot/card/port} [us-channel {physical us-channel number}]]

Syntax Description cable slot/port (Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal
of CMs on the specified cable interface and downstream port, where:
• slot—Specifies the chassis slot number of the cable interface line card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and cable
interface line card. Refer to the hardware documentation for your router chassis
and cable interface line card for supported slot and port numbering.

cable slot/subslot/port (Optional—Cisco uBR10012 Router) Specifies removal of CMs on the specified
cable interface, where:
• slot—Specifies the chassis slot number of the cable interface line card. Valid
slots are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line card.
Valid subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4, depending
on the cable interface line card.

upstream uport (Optional) Clears the hop counters on a specific upstream port on a specific cable
interface. The valid values for uport start with 0 for the first upstream port on the
cable interface line card.

upstream-cable (Optional) Clears the hop counters on a specific upstream-cable controller. The
slot/card/port valid values start with 0 for the first upstream port on the cable interface line card.

us-channel physical (Optional) Clears upstream channel information. Valid values are 0 to 11.
us-channel number

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(15)BC1 This command was introduced.

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

Cisco CMTS Cable Command Reference

977
 Cable Commands: ca through cr
clear cable hop

Release Modification

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS
• The upstream-cable keyword was added.
• The
us-channel keyword was added.

Usage Guidelines The clear cable hop command clears the correctable and uncorrectable forward error corrections (FEC)
counters that are displayed by the show cable hop command. You can clear the counters for all interfaces on
the Cisco CMTS, for one specific interface (one downstream and its associated upstreams), or for a specific
upstream on a cable interface.

Examples The following example shows how to clear the frequency hop counters on all cable interfaces on the
Cisco CMTS, along with sample output from the show cable hop command that shows the counters
being cleared:

Router# show cable hop

Upstream Port Poll Missed Min Missed Hop Hop Corr Uncorr
Port Status Rate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
Cable3/0/U0 15.008 Mhz 1000 * * *set to fixed frequency * * * 2238 133
Cable3/0/U1 admindown 1000 * * * frequency not set * * * 0 0
Cable3/0/U2 admindown 1000 * * * frequency not set * * * 0 0
Cable3/0/U3 admindown 1000 * * * frequency not set * * * 0 0
Router# clear cable hop

Router# show cable hop

Upstream Port Poll Missed Min Missed Hop Hop Corr Uncorr
Port Status Rate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
Cable3/0/U0 15.008 Mhz 1000 * * *set to fixed frequency * * * 0 0
Cable3/0/U1 admindown 1000 * * * frequency not set * * * 0 0
Cable3/0/U2 admindown 1000 * * * frequency not set * * * 0 0
Cable3/0/U3 admindown 1000 * * * frequency not set * * * 0 0
Router#

The following example shows how to clear the frequency hop counters on a specific cable interface
on the Cisco CMTS:

Router# clear cable hop c5/0

Router#

The following example shows how to clear the frequency hop counters on a specific upstream on
the Cisco CMTS:

Router# clear cable hop c5/1/0 upstream 2

Router#

Cisco CMTS Cable Command Reference

978
 Cable Commands: ca through cr
clear cable hop

The following example shows how to clear the frequency hop counters on a specific upstream on
the Cisco cBR Series Converged Broadband Routers:
Router# clear cable hop upstream-cable 3/0/3 us-channel 2
Router#

Related Commands Command Description

show cable hop Displays cable-hop statistics on a Cisco CMTS.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

979
 Cable Commands: ca through cr
clear cable host

clear cable host

To clear the host from the router’s internal address tables, use the clear cable host command in privileged
EXEC mode.

clear cable host {ip-addressmac-address | name fqdn}

Cisco cBR Series Converged Broadband Routers

clear cable host {ip-addressmac-address | vrf {VPN Routing/Forwarding instance name ip-address}}

Syntax Description ip-address IPv4 or IPv6 address for the device to be cleared.

mac-address MAC address for the device to be cleared.

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

vrf Specifies VPN Routing/Forwarding instance.

VPN Routing/Forwarding VPN Routing/Forwarding instance name.

instance name

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

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

12.1(5)EC1 Support was added for the Cisco uBR7100 series universal broadband router.

12.2(4)BC1 Support was added for the Cisco uBR10012 universal broadband router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA, with the following
changes:
• Support for the Cisco uBR7225VXR router was added.
• Support for specifying the IPv6 address of a CM or CPE device was added.
• The name keyword option was added for specifying the fully-qualified domain name
of a CM.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS The vrf keyword was added.

Cisco CMTS Cable Command Reference

980
 Cable Commands: ca through cr
clear cable host

Usage Guidelines This command removes a host’s IP, MAC address, or domain name from the router’s internal address tables.
This might be necessary to allow a new host to come online from the previous host’s CM.

Note If the cleared host continues communicating through the CM, the Cisco CMTS adds the host back to its internal
address tables, and the show interface cable interface modem command shows it as having a “static” address.
To block the host from any further access, use the cable source-verify dhcp command, so that the host cannot
access the network unless it obtains an IP address from an authorized DHCP server.

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

Examples The following example shows how to remove a host’s MAC address from the internal address tables
on the Cisco CMTS router:

Router# clear cable host 0050.7366.17ab

The following example shows how to remove a host’s domain name from the internal address tables
on the Cisco CMTS router:

Router# clear cable host cisco

The following example shows how to remove a VPN Routing/Forwarding instance on the Cisco cBR
Series Converged Broadband Routers:

Router# clear cable host vrf cisco 3046:1829:fefb::ddd1

Related Commands Command Description

cable device Configures the access list for a CM device or host.

cable host access-group Configures the access list for the specified hosts.

show cable device access-group Display the CMs and the hosts behind the CMs on the network.

show cable host access-group Displays only the hosts behind the CMs on the network.

Cisco CMTS Cable Command Reference

981
 Cable Commands: ca through cr
clear cable ipc-stats

clear cable ipc-stats

To clear the active database and reset all IPC statistics in the active database to zero, use the clear cable
ipc-stats command in privileged EXEC mode.

clear cable ipc-stats

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You must enable the Cable IPC Statistics Collection tool using the cable ipc-stats command before using the
clear cable ipc-stats command.

Examples The following example shows how to clear the active database using the clear cable ipc-stats
command on a Cisco CMTS router:

Router# clear cable ipc-stats

cr10k ipc stats is cleared at 03:38:54 PDT Fri Oct 9 2009
Router#

Related Commands Command Description

cable ipc-stats Enables the Cable IPC Statistics Collection tool on a Cisco CMTS router.

show cable ipc-stats Displays statistics of all the IPC messages on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

982
 Cable Commands: ca through cr
clear cable load-balance

clear cable load-balance

To clear the counters or state machine used to track load-balancing operations, use the clear cable load-balance
command in privileged EXEC mode.

clear cable load-balance { counters | state | move-history cable

slot/subslot/controller-interface-index }

Syntax Description counters Clears all load balancing statistical counters.

state Clears all state information in the load balancing state machine. This command will also put
all cable interfaces and their upstream channels in the “up” state, unless they are explicitly
shut down using the shutdown interface configuration command.

move-history Clears all of the move history entries for one mac-domain.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

IOS-XE 17.6.1w This command was updated. The move-history option was introduced.

Examples The following example shows how to clear all of the counters that track load-balancing operations,
resetting them all to zero:

Router# clear cable load-balance counters

The following example shows how to clear the state machine that is used for load-balancing operations:

Router# clear cable load-balance state

The following example shows how to clear all the move history entries for one mac-domain:

Router# clear cable load-balance move-history cable slot/subslot/controller-interface-index

Cisco CMTS Cable Command Reference

983
 Cable Commands: ca through cr
clear cable load-balance

Related Commands Command Description

cable load-balance exclude Excludes a particular cable modem, or all cable modems from
a particular vendor, from one or more types of load-balancing
operations.

cable load-balance group (global Creates and configures a load-balance group.

configuration)

cable load-balance group (interface Assigns a downstream to a load-balance group.

configuration)

cable load-balance group interval Configures the frequency of the load-balancing policy updates.

cable load-balance group policy ugs Configures how the Cisco CMTS should load balance cable
modems with active unsolicited grant service (UGS) service
flows.

cable load-balance group threshold Configures the threshold values that a load-balance group
should use for load-balancing operations.

cable upstream load-balance group Assigns an upstream to a load-balance group.

show cable load-balance Displays real-time statistical and operational information for
load-balancing operations.

show cable load-balance docsis-group x Provides detailed information on modem movement through
move-history load balancing.

Cisco CMTS Cable Command Reference

984
 Cable Commands: ca through cr
clear cable load-balance error-statistics

clear cable load-balance error-statistics

To clear all the failure counters in the error statistics, use the clear cable load-balance error-statistics
command in privileged EXEC mode.

clear cable load-balance error-statistics

no clear cable load-balance error-statistics

Syntax Description This command has no arguments or keywords.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)SCI This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.0S

Example
The following example shows how to clear all the failure counters in the error statistics.
Router# clear cable load-balance error-statistics

Related Commands Command Description

show cable load-balance Displays real-time configuration, statistical and operational

information for load balancing operations on the router.

show cable load-balance docsis-group Displays real-time configurational, statistical, and operational
information of the DOCSIS group operations on the router.

cable load-balance Enables the DOCSIS 3.0 dynamic load balancing on the Cisco
docsis30-dynamic-enable CMTS.

show cable load-balance statistics error Displays information of the DOCSIS 3.0 and DOCSIS 2.0 load
balance failure.

Cisco CMTS Cable Command Reference

985
 Cable Commands: ca through cr
clear cable logging

clear cable logging

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

clear cable logging {badipsource | downstream-index}

Cisco cBR Series Converged Broadband Routers

clear cable logging {badipsource | downstream-index | layer2events | overlapip}

Syntax Description badipsource Clears the log buffer for BADIPSOURCE messages.

downstream-index Clears the log buffer for downstream index messages.

layer2events Clears the layer 2 event messages.

overlapip Clears the overlap ip messages.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.1(13)EC This command was introduced for the Cisco uBR7100 series and Cisco uBR7200 series
universal broadband routers.

12.2(11)CY Support was added for the Cisco uBR10012 universal broadband router.

12.2(11)BC2 Support was added to the Release 12.2 BC train for the Cisco uBR7100 series, Cisco
uBR7200 series, and Cisco uBR10012 routers.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

12.2(33)SCG The downstream-index keyword was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The cable logging badipsource command creates a circular buffer that contains the BADIPSOURCE error
messages that the Cisco CMTS generates when it discovers a CM or CPE device using an unauthorized IP
address. When the buffer becomes full, the oldest messages are deleted to make room for newer messages.
When you have viewed all of the error messages in the current buffer, use the clear cable logging command
to clear out the buffer to make room for newer messages.

Examples The following example shows how to clear the log buffer that contains the bad IP source address
error messages:

Cisco CMTS Cable Command Reference

986
 Cable Commands: ca through cr
clear cable logging

Router# show cable logging summary

Cable logging: BADIPSOURCE Enabled
Total buffer size (bytes): 1000000
Used buffer size (bytes) : 36968
Logged messages : 231
Router# clear cable logging badipsource

Router# show cable logging summary

Cable logging: BADIPSOURCE Enabled
Total buffer size (bytes): 1000000
Used buffer size (bytes) : 0
Logged messages : 0
Router#

The following example shows how to clear the log buffer that contains the downstream index
messages:

Router# show cable logging downstream-index

Cable logging: Enabled

Total buffer size (bytes): 1000000
Used buffer size (bytes) : 36968
Logged messages : 231
Router# clear cable logging downstream-index

Router# show cable logging downstream-index

Cable logging: Enabled
Total buffer size (bytes): 1000000
Used buffer size (bytes) : 0
Logged messages : 0
Router#

Related Commands cable logging badipsource Logs error messages about bad IP source addresses on the cable interfaces.

cable logging layer2events Logs layer 2 messages.

cable logging overlapip Logs overlap IP messages.

cable logging downstream-index Logs buffer messages about the downstream indexes.

cable source-verify Enables verification of IP addresses for CMs and CPE devices on the
upstream.

show cable logging Displays the log of error and buffer messages on the cable interfaces.

Cisco CMTS Cable Command Reference

987
 Cable Commands: ca through cr
clear cable modem attribute-masks

clear cable modem attribute-masks

To clear the cable modem attribute masks, use the clear cable modem attribute-masks command in privileged
EXEC mode.

clear cable modem {mac-addrip-addr | cable slot/port {all | oui string | reject}} attribute-masks
clear cable modem {mac-addrip-addr | cable slot/subslot/port {all | oui string | reject}}
attribute-masks
clear cable modem {mac-addrip-addr | cable slot/subslot/cable-interface-index {all | oui string |
reject}} attribute-masks

Syntax Description mac-addr Specifies the MAC address for the CM.

ip-addr Specifies the IP address for the CM.

cable slot/port (Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies
removal of CMs on the specified cable interface and downstream port,
where:
• slot—Specifies the chassis slot number of the cable interface line
card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and
cable interface line card. Refer to the hardware documentation for your
router chassis and cable interface line card for supported slot and port
numbering.

cable slot/subslot/port (Optional—Cisco uBR10012 Router) Specifies removal of CMs on the

specified cable interface, where:
• slot—Specifies the chassis slot number of the cable interface line
card. Valid slots are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface
line card. Valid subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4,
depending on the cable interface line card.

cable (Optional—Cisco cBR Series Converged Broadband Routers) Specifies

slot/subslot/cable-interface-index removal of CMs on the specified cable interface, where:
• slot—Specifies the chassis slot number of the cable interface line
card. The valid range is from 0 to 3 and 6 to 9.
• subslot—Specifies the secondary slot number of the cable interface
line card. The valid subslot is 0. Depending on the platform and cable
interface line card, subslots 0 to 1 could be added.
• cable-interface-index— Specifies the cable line card MAC domain.
Valid range is from 0 to 15, depending on the cable interface line card

all Resets the flapping counters for all CMs.

Cisco CMTS Cable Command Reference

988
 Cable Commands: ca through cr
clear cable modem attribute-masks

oui string Resets the flapping counters for all CMs that match the specified
Organization Unique Identifier (OUI). The string parameter can be either
the three-byte hexadecimal string (such as 00.00.0C).

reject Resets the flapping counters for all CMs that are currently in one of the
reject states.

attribute-masks Specifies the attribute mask bitmap in hexadecimal format.

Example: 0-FFFFFFFF

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command clears the cable modem attribute masks.

Examples The following example shows how to clear cable modem attribute masks for CMs:

Router# clear cable modem all attribute-masks

Router# clear cable modem oui SA attribute-masks
Router# clear cable modem c5/0/0 offline attribute-masks

Related Commands Command Description

cable upstream attribute-mask This command specifies an upstream attribute mask in hexadecimal format.

Cisco CMTS Cable Command Reference

989
 Cable Commands: ca through cr
clear cable modem cm-status

clear cable modem cm-status

To reset the cable modem status events to zero, use the clear cable modem cm-status command in privileged
EXEC mode.

Cisco uBR7225VXR and Cisco uBR7246VXR Universal Broadband Routers

clear cable modem [ip addressmac address | cable slot/port] cm-status

Cisco uBR10012 Universal Broadband Router

clear cable modem [ip addressmac address | cable slot/subslot/cable-interface-index] cm-status

Cisco cBR Series Converged Broadband Routers

clear cable modem [ip addressmac address | cable slot/subslot/ cable-interface-index] cm-status

Syntax Description ip-address (Optional) IP address of a CM.

mac-address (Optional) MAC address of a CM.

cable slot/ subslot/ (Optional) Cable interface on the Cisco uBR10012 router. The following are the
cable-interface-index valid values:
• slot = 5 to 8
• subslot = 0 or 1
• cable-interface-index
• Cisco uBR10012 router—The valid range for the Cisco uBR-MC20X20V
and Cisco uBR-MC5X20 line cards is from 0 to 4. The valid range for
the Cisco uBR-MC3GX60V line card is from 0 to 14.

For Cisco cBR Series Converged Broadband Routers, the following are the valid
values:
• slot = 0 to 3 and 6 to 9
• subslot = 0
• cable-interface-index = 0 to 15

cable slot/port (Optional) Displays information for all CMs on the specified cable interface and
downstream port on the Cisco uBR7225VXR and Cisco uBR7246VXR routers,
where:
• slot—Slot where the line card resides.
Cisco uBR7246VXR router—The valid range is from 3 to 6
Cisco uBR7225VXR router—The valid range is from 1 to 2
• port—Specifies the downstream port number.

cm-status Resets the CM status events to zero for the specified CM's.

Command Modes
Privileged EXEC (#)

Cisco CMTS Cable Command Reference

990
 Cable Commands: ca through cr
clear cable modem cm-status

Command History Release Modification

12.2(33)SCB This command was introduced.

12.2(33)SCC This command was modified to clear the basic receive-statistics of all event code types
for a specific CM or a group of CMs.

12.2(33)SCD This command was modified. Support was added for Cisco uBR7225VXR and Cisco
uBR7246VXR routers.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete Removes one or more CMs from the internal address and routing tables on a
CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem name Removes or resets CMs by domain name.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and resets them.

Cisco CMTS Cable Command Reference

991
 Cable Commands: ca through cr
clear cable modem counters

clear cable modem counters

Note Effective with Cisco IOS Release 12.2(15)BC1, the clear cable modem counters command is replaced by
the clear counters command. See the clear counters command in the Cisco IOS software command reference
documentation for more information.

To reset the cable modem (CM) flap-list counters to zero, use the clear cable modem counters command in
privileged EXEC mode.

clear cable modem {mac-addrip-addr | [cable {slot/portslot/subslot/pot}] {all | oui string | reject}}
counters

Syntax Description mac-addr Specifies the 48-bit hardware address (MAC address) of an individual CM.

ip-addr Specifies the IP address of an individual CM.

cable slot/port (Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal of
CMs on the specified cable interface and downstream port, where:
• slot—Specifies the chassis slot number of the cable interface line card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and cable interface
line card. Refer to the hardware documentation for your router chassis and cable interface
line card for supported slot and port numbering.

cable (Optional—Cisco uBR10012 Router) Specifies removal of CMs on the specified cable
slot/subslot/port interface, where:
• slot—Specifies the chassis slot number of the cable interface line card. Valid slots
are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line card. Valid
subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4, depending
on the cable interface line card.

all Resets the flapping counters for all CMs.

oui string Resets the flapping counters for all CMs that match the specified Organization Unique
Identifier (OUI). The string parameter can be either the three-byte hexadecimal string
(such as 00.00.0C) or a vendor name that has been defined using the cable modem
vendor command.

reject Resets the flapping counters for all CMs that are currently in one of the reject states.
(See the show cable modem command for a description of these states.)

Command Default None

Cisco CMTS Cable Command Reference

992
 Cable Commands: ca through cr
clear cable modem counters

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.1 T This command was introduced.

12.2(11)BC2 Support was added for the oui and reject options.

12.2(11)BC3 Support for clearing the counters for a particular cable interface was added.

12.2(15)BC1 This command was replaced by the clear counters command.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows how to clear the counters for the CM at IP address 172.16.23.45:

Router# clear cable modem 172.16.23.45 counters

The following example shows how to clear the counters for all CMs that have an OUI that has been
defined as having the vendor name of Cisco using the cable modem vendor command:

Router# clear cable modem oui Cisco counters

The following example shows how to clear the counters for all CMs that are currently in one of the
reject states:

Router# clear cable modem reject counters

Note If running Cisco IOS Release 12.2(15)BC1 or later, use the clear cable modem flap-counters
command to clear the CM flap-list counters.

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete Removes one or more CMs from the internal address and routing tables
on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem flap-counters Resets the CM flap-list counters to zero.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and resets
them.

clear counters Resets interface counters and those counters associated with the show
cable modem counters command.

Cisco CMTS Cable Command Reference

993
 Cable Commands: ca through cr
clear cable modem delete

clear cable modem delete

To remove one or more cable modems (CMs) from the internal address and routing tables on a CMTS router
and stop DOCSIS station maintenance messages, use the clear cable modem delete command in privileged
EXEC mode.

clear cable modem {ip-addrmac-addr} delete

clear cable modem [cable {slot/portslot/subslot/port}] {all | non-bonding-capable [legacy-ranging]
| offline | oui string | reject | wideband [registered-traditional-docsis] } delete

Cisco cBR Series Converged Broadband Routers

clear cable modem {ip-addr | cable | {slot/subslot/cable interface index}mac-addr | all | cm-status |
non-bonding-capable | {delete | legacy-ranging | reset } | reject | {attribute-masks | cm-status | delete
| flap-counters | rcs-counts | reset | rf-adapt | service-type-id | voice} | offline | {attribute-masks | cm-status
| delete | flap-counters | rcs-counts | rf-adapt | service-type-id | voice} | online | {attribute-masks |
cm-status | delete | flap-counters | rcs-counts | rf-adapt | service-type-id | voice} | oui | {string } | rcs-counts
[Integrated-Cable] | wideband | {delete | registered-traditional-docsis | reset}}

Syntax Description ip-addr Specifies removal of an individual CM by its IPv4 or IPv6 address.

mac-addr Specifies removal of an individual CM by its 48-bit hardware address (MAC

address).

cable slot/ port (Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies
removal of CMs on the specified cable interface and downstream port, where:
• slot—Specifies the chassis slot number of the cable interface line card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and
cable interface line card. Refer to the hardware documentation for your router
chassis and cable interface line card for supported slot and port numbering.

cable slot/ cable interface (Optional— Cisco cBR Series Converged Broadband Routers) Specifies
index removal of CMs on the specified cable interface, where:
• slot—
Specifies the chassis slot number of the cable interface line card. The
valid range is from 0 to 3 and 6 to 9.
• port—Specifies the secondary slot number of the cable interface line
card. The valid subslot is 0.
• cable-interface-index— Specifies the cable line card MAC domain. Valid
range is from 0 to 15, depending on the cable interface line card.

Cisco CMTS Cable Command Reference

994
 Cable Commands: ca through cr
clear cable modem delete

cable slot/subslot/port (Optional—Cisco uBR10012 Router) Specifies removal of CMs on the

specified cable interface, where:
• slot—Specifies the chassis slot number of the cable interface line card.
Valid slots are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line
card. Valid subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4,
depending on the cable interface line card.

all Specifies removal of all CMs or all CMs associated with a specified cable
interface.

non-bonding-capable Specifies removal of all narrowband CMs that are not capable of downstream
channel bonding or all such CMs associated with a specified interface.

legacy-ranging (Optional) Specifies removal of narrowband CMs that are accessed with legacy
initial ranging or all such CMs associated with a specified interface.

offline Specifies removal of all offline CMs or all such CMs associated with a
specified interface.

offline Specifies removal of all online CMs or all such CMs associated with a specified
interface.

oui string Specifies removal of all CMs that match the specified Organization Unique
Identifier (OUI) or all such CMs associated with a specified interface. The
string parameter can be either the three-byte hexadecimal string (such as
00.00.0C) or a vendor name that has been defined using the cable modem
vendor command.

reject Specifies removal of all CMs that are currently in one of the reject states or
all such CMs associated with a specified interface. (See the show cable modem
command for a description of these states.)

rcs-counts Specifies removal of MDD, QAM/FEC failure and recovery counts.

wideband Specifies removal of all wideband CMs or or all such CMs associated with a
specified interface.

registered-traditional-docsis (Optional) Specifies removal of all wideband CMs that are registered as
traditional DOCSIS CMs or all such CMs associated with a specified interface.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(11)BC3 This command was introduced for the Cisco uBR7100 series, Cisco uBR7200 series, and
Cisco uBR10012 universal broadband routers.

Cisco CMTS Cable Command Reference

995
 Cable Commands: ca through cr
clear cable modem delete

Release Modification

12.2(15)BC1 The cable keyword option was added.

12.3(23)BC Support was added for the non-bonding-capable, legacy-ranging, wideband, and
registered-traditional-docsis keyword options.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA, with the following
changes:
• Support for the Cisco uBR7225VXR router was added.
• Support for specifying the IPv6 address of a CM was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command removes one or more CMs from the CMTS router memory, which causes the CMTS router
to stop all DOCSIS station maintenance messages for the specified CMs until they time out and reattempt
initial ranging.

Caution The clear cable modem all delete command should normally be used only on a test or lab network. If used
on a large network, it could impact service for a significant period of time, as it would force all CMs to
simultaneously reset and reregister with the Cisco CMTS. In addition, if HCCP N+1 redundancy has also
been configured, using the clear cable modem delete command can trigger a switchover to one or more
Protect interfaces, unless no keepalive has also been configured on the cable interfaces.

Examples The following example shows how to delete the CM at IP address 172.23.45.67:

Router# clear cable modem 172.23.45.67 delete

The following example shows how to delete all CMs that have a OUI that has been defined as having
the vendor name of Cisco using the cable modem vendor command:

Router# clear cable modem oui Cisco delete

The following example shows how to delete all CMs that are currently in one of the reject states:

Router# clear cable modem reject delete

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem flap -counters Resets the CM flap-list counters to zero.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem name Removes or resets CMs by domain name.

Cisco CMTS Cable Command Reference

996
Cable Commands: ca through cr
clear cable modem delete

Command Description

clear cable modem reset Removes one or more CMs from the Station Maintenance List and
resets them.

show cable modem Displays information for the registered and unregistered CMs.

Cisco CMTS Cable Command Reference

997
 Cable Commands: ca through cr
clear cable modem device-class

clear cable modem device-class

To reset the cable modems by device class type, use the clear cable modem device-class command in
privileged EXEC mode.

clear cable modem [Cable slot/port/cable-interface-index] device-class {DVA {delete | reset} | MTA
{delete | reset} | PS {delete | reset} | RTR {delete | reset} | STB {delete | reset}}

Syntax Description Cable slot/port/cable-interface-index Specifies the cable modems on the specified cable
interface.
• slot—Specifies the chassis slot number of the
cable interface line card. The valid range is from
0 to 9.
• port—Specifies the sub slot number of the cable
interface line card. The valid subslot is 0.
• delete—Removes the cable modems matching
the MTA device class.

DVA Removes or resets the cable modems for DVA

devices.
• reset—Resets the cable modems matching the
DVA device class.
• delete—Removes the cable modems matching
the DVA device class.

MTA Removes or resets the cable modems for MTA

devices.
• reset—Resets the cable modems matching the
MTA device class.
• delete—Removes the cable modems matching
the MTA device class.

PS Removes or resets the cable modems for PS devices.

• reset—Resets the cable modems matching the
PS device class.
• delete—Removes the cable modems matching
the PS device class.

Cisco CMTS Cable Command Reference

998
 Cable Commands: ca through cr
clear cable modem device-class

RTR Removes or resets the cable modems for Erouter

devices.
• reset—Resets the cable modems matching the
RTR device class.
• delete—Removes the cable modems matching
the RTR device class.

STB Removes or resets the cable modems for STB devices.

• reset—Resets the cable modems matching the
STB device class.
• delete—Removes the cable modems matching
the STB device class.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCJ1 This command was introduced in Cisco uBR Series router.

3.18.1SP This command was introduced in Cisco cBR Series Converged Broadband Router.

Examples The following example shows how to reset the MTA device class cable modems on Cable 8/1/0:

Router# clear cable modem Cable 8/1/0 device-class MTA reset

The following example shows how to remove the STB device class cable modems on Cable 8/1/0:

Router# clear cable modem Cable 8/1/0 device-class STB delete

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete Removes one or more CMs from the internal address and routing tables
on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem flap-counters Resets the CM flap-list counters to zero.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and resets
them.

Cisco CMTS Cable Command Reference

999
 Cable Commands: ca through cr
clear cable modem device-class

Command Description

clear counters Resets interface counters and those counters associated with the show
cable modem counters command.

Cisco CMTS Cable Command Reference

1000
 Cable Commands: ca through cr
clear cable modem flap-counters

clear cable modem flap-counters

To reset the cable modem (CM) flap-list counters to zero, use the clear cable modem flap-counters command
in privileged EXEC mode.

clear cable modem {ip-addrmac-addr} flap-counters

clear cable modem [cable {slot/portslot/subslot/port}] {all | offline | oui string | reject} flap-counters

Syntax Description ip-addr Resets the flap-list counters for an individual CM by its IPv4 or IPv6 address.

mac-addr Resets the flap-list counters for an individual CM by its 48-bit hardware address (MAC
address).

cable slot/port (Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Resets the flap-list
counters for all CMs on the specified cable interface and downstream port, where:
• slot—Specifies the chassis slot number of the cable interface line card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and cable interface
line card. Refer to the hardware documentation for your router chassis and cable interface
line card for supported slot and port numbering.

cable (Optional—Cisco uBR10012 Router) Resets the flap-list counters for all CMs on the
slot/subslot/port specified cable interface, where:
• slot—Specifies the chassis slot number of the cable interface line card. Valid slots
are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line card. Valid
subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4, depending on
the cable interface line card.

cable (Optional—Cisco cBR Series Routers) Resets the flap-list counters for all CMs on the
slot/subslot/port specified cable interface, where:
• slot—Specifies the chassis slot number of the interface card. Valid slots are 0 to 3
and 6 to 9 on the Cisco cBR-8 router.
• subslot—Specifies the secondary slot number of the interface card. Valid subslot
is 0 on the Cisco cBR-8 router.
• port—Specifies the cable interface index number. Valid values are 0 to 15 on the
Cisco cBR-8 router.

all Resets the flap-list counters for all CMs or all CMs associated with a specified cable
interface.

offline Resets the flap-list counters for all offline CMs or for all such CMs associated with a
specified interface.

Cisco CMTS Cable Command Reference

1001
 Cable Commands: ca through cr
clear cable modem flap-counters

oui string Resets the flap-list counters for all CMs that match the specified Organization Unique
Identifier (OUI) or for all such CMs associated with a specified interface. The string
parameter can be either the three byte hexadecimal string (such as 00.00.0C) or a vendor
name that has been defined using the cable modem vendor command.

reject Resets the flap-list counters for all CMs that are currently in one of the reject states or
for all such CMs associated with a specified interface. (See the show cable modem
command for a description of these states.)

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the clear cable modem flap-counters command to reset the flap-list counters associated with the show
cable flap-list command.
This command only resets flap-list counters. To reset other cable interface counters and those counters
associated with the show cable modem counters command, use the clear counters command.

Examples The following example shows how to reset the flap-list counters for the CM at IP address 172.16.23.45:

Router# clear cable modem 172.16.23.45 flap-counters

The following example shows how to reset the flap-list counters for all CMs that have a OUI that
has been defined as having the vendor name of Cisco using the cable modem vendor command:

Router# clear cable modem oui Cisco flap-counters

The following example shows how to reset the flap-list counters for all CMs that are currently in one
of the reject states:

Router# clear cable modem reject flap-counters

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

Cisco CMTS Cable Command Reference

1002
Cable Commands: ca through cr
clear cable modem flap-counters

Command Description

clear cable modem delete Removes one or more CMs from the internal address and routing tables on a
CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem name Removes or resets CMs by domain name.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and resets them.

clear counters Resets interface counters and those counters associated with the show cable
modem counters command.

Cisco CMTS Cable Command Reference

1003
 Cable Commands: ca through cr
clear cable modem lock

clear cable modem lock

To reset the lock on one or more cable modems (CMs), and to reinitialize them so that they can reregister
with a valid DOCSIS configuration file, use the clear cable modem lock command in privileged EXEC mode.

clear cable modem {ip-addrmac-addr} lock

clear cable modem [cable {slot/portslot/subslot/port}] {all | oui string} lock

Syntax Description ip-addr Resets the lock for an individual CM by its IPv4 or IPv6 address.

mac-addr Resets the lock for an individual CM by its 48-bit hardware address (MAC address).

cable slot/port (Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Resets the lock for
all CMs on the specified cable interface and downstream port, where:
• slot—Specifies the chassis slot number of the cable interface line card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and cable interface
line card. Refer to the hardware documentation for your router chassis and cable interface
line card for supported slot and port numbering.

cable (Optional—Cisco uBR10012 Router) Resets the lock for all CMs on the specified cable
slot/subslot/port interface, where:
• slot—Specifies the chassis slot number of the cable interface line card. Valid slots
are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line card. Valid
subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4, depending
on the cable interface line card.

cable (Optional—Cisco cBR-8 Router) Resets the lock for all CMs on the specified cable
slot/subslot/port interface, where:
• slot—Specifies the chassis slot number of the cable line card. Valid slots are 0 to
3 and 6 to 9.
• subslot—Specifies the secondary slot number of the cable line card. Valid subslot
is 0.
• port—Specifies the MAC domain index. Valid range is from 0 to 15.

all Resets the lock for all CMs or all CMs associated with a specified cable interface.

oui string Resets the lock for all CMs that match the specified Organization Unique Identifier
(OUI) or for all such CMs associated with a specified interface. The string parameter
can be either the three-byte hexadecimal string (such as 00.00.0C) or a vendor name
that has been defined using the cable modem vendor command.

Command Default None

Cisco CMTS Cable Command Reference

1004
 Cable Commands: ca through cr
clear cable modem lock

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines When you have configured the cable dynamic-secret lock command on a cable interface, the CMTS “locks”
CMs that use a DOCSIS configuration file that fails the CMTS verification check. These CMs are allowed to
come online, but with a restrictive QoS configuration that limits their service flows to 10 kbps.
Locked CMs are not allowed to reregister with a valid DOCSIS configuration file until they have been offline,
without attempting to reregister, for at least 24 hours. You can manually clear the lock on a CM by using the
clear cable modem lock command in privileged EXEC mode.
The clear cable modem lock command also automatically resets the CMs, so that they will reregister with
the CMTS. If the CMs then reregister with a valid DOCSIS configuration file, the CMTS allows the CMs to
come online with the requested QoS profiles. If the CMs violate the DOCSIS specifications again, they will
be locked again.

Note If a CM is not manually unlocked, it remains locked until it stays offline, without attempting to reregister, for
24 hours. It can also be unlocked by using the clear cable modem delete command to manually remove the
CM from all of the CMTS internal databases.

Examples The following example shows how to reset the lock for the CM with the MAC address of
0000.0C01.0203:

Router# clear cable modem 0000.0C01.0203 lock

The following example shows how to reset the lock for the CM at IP address 172.16.23.45:

Router# clear cable modem 172.16.23.45 lock

The following example shows how to reset the locks for all CMs that have an OUI that has been
defined as having the vendor name of Cisco using the cable modem vendor command:

Router# clear cable modem oui Cisco lock

Cisco CMTS Cable Command Reference

1005
 Cable Commands: ca through cr
clear cable modem lock

Related Commands Command Description

cable dynamic-secret Enables the dynamic shared secret feature, so that DOCSIS configuration
files are verified with a Message Integrity Check (MIC) that has been
created with a dynamically generated shared secret.

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem flap-counters Resets the CM flap-list counters to zero.

clear cable modem delete Removes one or more CMs from the internal address and routing tables
on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem name Removes or resets CMs by domain name.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and resets
them.

Cisco CMTS Cable Command Reference

1006
 Cable Commands: ca through cr
clear cable modem name

clear cable modem name

To remove or reset cable modems (CMs) by domain name, use the clear cable modem name command in
privileged EXEC mode.

clear cable modem name fqdn {delete | reset}

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

delete Removes the CM with the specified domain name from the Station Maintenance List.

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

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCA This command was introduced.

12.2(33)SCD This command was modified to remove flap-counters and lock keywords.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

Examples The following example shows how to delete a CM with the domain name “example”:

Router# clear cable modem name example delete

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem flap -counters Resets the CM flap-list counters to zero.

clear cable modem delete Removes one or more CMs from the internal address and routing tables
on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and
resets them.

Cisco CMTS Cable Command Reference

1007
 Cable Commands: ca through cr
clear cable modem name

Command Description

show cable modem Displays information for the registered and unregistered CMs.

Cisco CMTS Cable Command Reference

1008
 Cable Commands: ca through cr
clear cable modem partial-service

clear cable modem partial-service

To reset, re-initiate or delete cable modems that are either in downstream or upstream partial service, use the
clear cable modem partial-service command in privileged EXEC mode.

clear cable modem partial-service { all | d30 | d31 } [ds-partial | us-partial] { delete | reinit | reset }

Syntax Description all Specifies all partial service modems

d30 Specifies Docsis 3.0 partial service modems
d31 Specifies Docsis 3.1 partial service modems
delete Delete the partial service modems
reinit Re-initiate the partial service modems
reset Reset the partial service modems
ds-partial Specifies downstream partial service modems
us-partial Specifies upstream partial service modems

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Cupertino 17.9.1w This command is updated on the Cisco cBR Series Converged Broadband
Routers. The ds-partial and us-partial keywords are added.

Usage Guidelines The following example shows how to reset, re-initiate or delete cable modems that are either in downstream:

router# clear cable modem partial-service all us-partial reset

router# clear cable modem partial-service all ds-partial reset
router# clear cable modem partial-service d30 us-partial delete
router# clear cable modem partial-service d30 us-partial reinit

Cisco CMTS Cable Command Reference

1009
 Cable Commands: ca through cr
clear cable modem path-sel

clear cable modem path-sel

To clear the path selection status for the cable modems, use the clear cable modem path-sel command in
privileged EXEC mode.

clear cable modem [ip address | mac address | all] path-sel

Syntax Description ip address Clears the path selection status from the specified IP address.

mac address Clears the path selection status from the specified MAC address.

all Clears the path selection status from all the cable modems.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS-XE Release 3.18.0SP This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use this command to clear the path selection status for the cable modems.

The following example shows how to clear path selection status for a particular MAC address:
router#show cable modem c8fb.26a6.c46a path-sel
CM c8fb.26a6.c46a Path-Sel Info: N/A
Path-Sel status has been cleared after register online.

Related Commands Command Description

show cable modem path-sel Displays the path selection status of a cable modem.

show cable mac-domain rcc Displays runtime receive channel configuration (RCC) on a cable
line card interface.

show cable mac domain rcc simplified Shows detailed information for DOCSIS 3.1 capable RCC.

Cisco CMTS Cable Command Reference

1010
 Cable Commands: ca through cr
clear cable modem pnm

clear cable modem pnm

To clear all the PNM US RxPwr information for cable modems, use the following clear cable modem pnm
us-rxpwr command in the privileged EXEC mode.

clear cable modem pnm us-rxpwr

To clear all the PNM US RxPwr information for cable modems on a specific OFDMA channel, use the
following clear cable modem pnm us-rxpwr upstream <0-15> command in the privileged EXEC mode.

clear cable modem pnm us-rxpwr upstream <0-15>

To clear all the PNM US RxPwr information for cable modems on a specific cable interface, use the following
clear cable modem [Cable<slot/0/interface>] pnm us-rxpwr Cable command in the privileged EXEC
mode.

clear cable modem Cable <slot/0/interface> pnm us-rxpwr

To clear the PNM US RxPwr information for a cable modems on a specific cable interface on a specific
OFDMA channel, use the following clear cable modem [Cable<slot/0/interface>] pnm us-rxpwr upstream
<0-15> command in the privileged EXEC mode.
clear cable modem Cable <slot/0/interface>pnm us-rxpwr upstream<0-15>
To clear the PNM US RxPwr information for a specific cable modem, use the following clear cable modem
[H.H.H or A.B.C.D] pnm us-rxpwr upstream command in the privileged EXEC mode.
where [H.H.H] is a specific modem's unique MAC address, and [A.B.C.D] is a specific modem's assigned IP
address.

clear cable modem H.H.H pnm us-rxpwr

clear cable modem A.B.C.D pnm us-rxpwr

To clear the PNM US RxPwr information for a specific cable modem on a specific US OFDMA channel, use
the following clear cable modem[H.H.H or A.B.C.D] pnm us-rxpwr upstream <0-15> command in
privileged EXEC mode.
where [H.H.H] is a specific modem's unique MAC address and [A.B.C.D] is a specific modem's assigned IP
address.
where <0-15> is the upstream OFDMA channel the modem is registered on.

clear cable modem pnm H.H.H pnm us-rxpwr upstream <0-15>

clear cable modem A.B.C.D pnm us-rxpwr upstream <0-15>

Table 24: Syntax Description

Syntax Description

interface Interface on which the PNM RxPwr data is cleared

for a specified upstream channel.

Cisco CMTS Cable Command Reference

1011
 Cable Commands: ca through cr
clear cable modem pnm

Syntax Description

mac address MAC address of the system for which the PNM
RxPwr data is cleared for a specified upstream
channel.

ip address IP address of the system for which the PNM RxPwr

data is cleared for a specified upstream channel.

upstream Modems on a particular upstream channel. The valid

range is 0-15.

Cisco CMTS Cable Command Reference

1012
 Cable Commands: ca through cr
clear cable modem rcs-counts

clear cable modem rcs-counts

To clear the following failure and recovery event counts for all or given RF channels of a CM, use the clear
cable modem rcs-counts command in privileged EXEC mode:
• MAC Domain Descriptor (MDD)
• QAM/forward error correction (FEC)

clear cable modem [cable if | mac_addr | ip_addr] rcs-counts [modular-cable slot/bay/port

nb-channel-number]

Cisco cBR Series Converged Broadband Routers

clear cable modem [cable if | mac_addr | ip_addr] rcs-counts [integrated-cable slot/sub-slot/port
rf-channel-number]

Syntax Description cable if (Optional) The name of the downstream interface.

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

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

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

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

sub-slot The valid value is 0.

sub-plot The valid value is 1.

port Specifies the interface number on the SPA.

nb-channel-number Represents the narrowband channel number.

rf-channel-number Represents the downstream RF channel number.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
3.15.0S cBR Series Converged Broadband Routers was added.

Cisco CMTS Cable Command Reference

1013
 Cable Commands: ca through cr
clear cable modem rcs-counts

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete Removes one or more CMs from the internal address and routing tables on a
CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem name Removes or resets CMs by domain name.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and resets them.

Cisco CMTS Cable Command Reference

1014
 Cable Commands: ca through cr
clear cable modem reset

clear cable modem reset

To remove one or more cable modems (CMs) from the Station Maintenance List and reset them, use the clear
cable modem reset command in privileged EXEC mode.

clear cable modem {ip-addrmac-addr} reset

clear cable modem [cable {slot/portslot/subslot/port}] {all | non-bonding-capable [legacy-ranging]
| oui string | reject | wideband [registered-traditional-docsis] } reset

Syntax Description ip-addr Specifies removal of an individual CM by its IPv4 or IPv6 address.

mac-addr Specifies removal of an individual CM by its 48-bit hardware address (MAC

address).

cable slot/port (Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies
removal of all CMs on the specified cable interface and downstream port,
where:
• slot—Specifies the chassis slot number of the cable interface line card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and
cable interface line card. Refer to the hardware documentation for your router
chassis and cable interface line card for supported slot and port numbering.

cable slot/subslot/port (Optional—Cisco uBR10012 Router) Specifies removal of all CMs on the
specified cable interface, where:
• slot—Specifies the chassis slot number of the cable interface line card.
Valid slots are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line
card. Valid subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4,
depending on the cable interface line card.

cable slot/subslot/port (Optional—Cisco cBR Series Routers) Specifies removal of all CMs on the
specified cable interface, where:
• slot—Specifies the chassis slot number of the interface card. Valid slots
are 0 to 3 and 6 to 9 on the Cisco cBR-8 router.
• subslot—Specifies the secondary slot number of the interface card. Valid
subslot is 0 on the Cisco cBR-8 router.
• port—Specifies the cable interface index number. Valid values are 0 to
15 on the Cisco cBR-8 router.

all Specifies removal of all CMs or all CMs associated with a specified cable
interface.

non-bonding-capable Specifies removal of all narrowband CMs that are not capable of downstream
channel bonding or all such CMs associated with a specified interface.

Cisco CMTS Cable Command Reference

1015
 Cable Commands: ca through cr
clear cable modem reset

legacy-ranging (Optional) Specifies removal of narrowband CMs that are accessed with legacy
initial ranging or all such CMs associated with a specified interface.

oui string Specifies removal of all CMs that match the specified Organization Unique
Identifier (OUI) or all such CMs associated with a specified interface. The
string parameter can be either the three-byte hexadecimal string (such as
00.00.0C) or a vendor name that has been defined using the cable modem
vendor command.

reject Specifies removal of all CMs that are currently in one of the reject states or
all such CMs associated with a specified interface. (See the show cable modem
command for a description of these states.)

wideband Specifies removal of all wideband CMs or all such CMs associated with a
specified interface.

registered-traditional-docsis (Optional) Specifies removal of all wideband CMs that are registered as
traditional DOCSIS CMs or all such CMs associated with a specified interface.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.1(2) EC This command was introduced.

12.2(4)BC1 Support was added to the Release 12.2 BC train.

12.2(11)BC2 Support was added for the oui and reject options.

12.2(15)BC1 The cable keyword option was added.

12.3(21)BC Support was added for the wideband and registered-traditional-docsis keyword options.

12.3(23)BC Support was added for the non-bonding-capable and legacy-ranging keyword options.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA, with the following
changes:
• Support for the Cisco uBR7225VXR router was added.
• Support for specifying the IPv6 address of a CM was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command instructs the Cisco CMTS to stop sending DOCSIS station maintenance messages to one or
more CMs, which effectively terminates the link to those CMs until those CMs time out and reattempt initial
ranging. A CM responds to this by resetting itself. Depending on when the CM received the last station
maintenance message, it can take up to 30 seconds before the CM detects the missing station maintenance
messages and resets itself.

Cisco CMTS Cable Command Reference

1016
 Cable Commands: ca through cr
clear cable modem reset

If the clear cable modem {ip-address | mac-address} reset form of the command is used to reset an individual
modem, the CMTS router sends a ranging stop message to the specified modem in order to command the
modem to reset itself and begin initial ranging more quickly without having to wait for up to 30 seconds to
realize it is no longer receiving station maintenance keep-alive opportunities. This behavior is only seen when
using the clear cable modem reset command for a specific CM.

Tip You can also specify the MAC address or IP address for a CPE device or host, and the Cisco CMTS resets
the CM that is associated with that CPE device in its internal database.

In some circumstances, the customer premises equipment (CPE) device behind a CM stops receiving traffic
after the CM is reset. This is because the CMTS still has the CPE device listed in its address tables, but the
CM does not after being reset, so the traffic passes through the CMTS but is dropped by the CM. To resolve
this situation, the CPE device should simply send some type of traffic to the CM, such as a ping packet. (You
can also resolve this situation by using the clear arp-cache command on the Cisco CMTS router to clear the
router’s address table, but this is not recommended because it temporarily interrupts all traffic on the router.)

Caution The clear cable modem all reset command should normally be used only on a test or lab network. If used
on a large network, it could impact service for a significant period of time, as it would force all CMs to
simultaneously reset and reregister with the Cisco CMTS.

Note The clear cable modem all reset command can result in the CPU utilization temporarily reaching 100 percent
for a couple of minutes, as the CPU processes the command for all CMs. The CPU utilization will return to
normal within a couple of minutes.

Examples The following example shows how to reset the CM at IP address 172.23.45.67:

Router# clear cable modem 172.23.45.67 reset

The following example shows how to reset all CMs that have an OUI that has been defined as having
the vendor name of Cisco using the cable modem vendor command:

Router# clear cable modem oui Cisco reset

The following example shows how to reset all CMs that are currently in one of the reject states:

Router# clear cable modem reject reset

For the Cisco uBR10012 router, the following example shows how to reset all wideband CMs that
are registered as traditional DOCSIS modems:

Router# clear cable modem wideband registered-traditional-docsis reset

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

Cisco CMTS Cable Command Reference

1017
 Cable Commands: ca through cr
clear cable modem reset

Command Description

clear cable modem flap-counters Resets the CM flap-list counters to zero.

clear cable modem delete Removes one or more CMs from the internal address and routing tables
on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem name Removes or resets CMs by domain name.

show cable modem Displays information for registered and unregistered CMs.

Cisco CMTS Cable Command Reference

1018
 Cable Commands: ca through cr
clear cable modem rf-adapt

clear cable modem rf-adapt

To clear RF adaptation candidates or history information of the cable modems, use the clear cable modem
rf-adapt command in privileged EXEC mode.

clear cable modem {ip-addrmac-addr | [cable {slot/cable-interface-indexslot/subslot/cable-interface-index}

] {all | offline | reject | oui string}} rf-adapt {candidates [downgrade | upgrade] | history}

Syntax Description ip-addr IPv4 or IPv6 address of the cable modem.

mac-addr 48-bit MAC address of the cable modem.

cable Specifies the cable interface line card details.

• slot—Slot where the cable interface line card resides.
• subslot—(Cisco uBR10012 router only) Secondary slot number of the cable interface line
card.
• cable-interface-index—Downstream port number or MAC domain index of the cable
interface line card.

all Clears the RF adaptation history or candidate status of all cable modems.

offline Clears the RF adaptation history or candidate status of all offline cable modems.

reject Clears the RF adaptation history or candidate status of all cable modems in reject state.

oui string Clears the RF adaptation history or candidate status of the cable modems that match the specified
Organization Unique Identifier (OUI) or for all cable modems associated with a specified
interface. The string parameter can be either the three byte hexadecimal string (such as 00.00.0C)
or a vendor name that has been defined using the cable modem vendor command.

candidates Clears RF adaptation candidates.

downgrade (Optional) Clears RF adaptation downgrade candidates.

upgrade (Optional) Clears RF adaptation upgrade candidates.

history Clears RF adaptation history.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCF3 This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Cisco CMTS Cable Command Reference

1019
 Cable Commands: ca through cr
clear cable modem rf-adapt

Usage Guidelines The clear cable modem rf-adapt command is used to configure the Cable Modem Upstream RF Adaption
feature.
Use the clear cable modem rf-adapt history command to remove the history of all RF adaptation relocations
for a given cable modem.
Use the clear cable modem rf-adapt candidates command to change the status of a cable modem or group
of cable modems that are RF adaptation relocation candidates.
Using the clear cable modem rf-adapt history and clear cable modem rf-adapt candidates commands
do not affect the MAC state of the cable modem.
The table below displays the interface density information.

Table 25: Interface Density Information

CMTS Router Line Card Slot Subslot Port Cable Interface

Index

Cisco Cisco 5 to 8 0 or 1 0 or 4 0 to 14
uBR10012 uBR-MC3GX60V

Cisco 0 to 4
UBR-MC20X20V

Cisco
uBR10-MC5X20

Cisco All 1 or 2 0 or 1 0 or 1 —
uBR7225VXR

Cisco All 3 to 6 0 or 1 0 or 1 —
uBR7246VXR

Examples The following example shows how to reset the RF adaptation history for the cable modem at IP
address 192.0.2.255:

Router# clear cable modem 192.0.2.255 rf-adapt history

The following example shows how to reset the RF adaptation downgrade candidates for all cable
modems:

Router# clear cable modem all rf-adapt candidates downgrade

Related Commands Command Description

show cable modem rf-adapt Displays the RF adaptation history.

show cable rf-adapt Displays RF adaptation information of upgrade and downgrade candidates.

Cisco CMTS Cable Command Reference

1020
 Cable Commands: ca through cr
clear cable modem service-type-id

clear cable modem service-type-id

To clear the cable modem service type ID, use the clear cable modem service-type-id command in privileged
EXEC mode.

clear cable modem {ip | mac | name domain name | [[interface]] {all | offline | oui oui | reject |
wideband | none-bounding-capable}} service-type-id

Cisco cBR Series Converged Broadband Routers

clear cable modem {ip | mac | [[interface]] {all | offline | oui oui | reject}} service-type-id

Syntax Description ip Specifies removal of an individual CM by its IPv4 or IPv6 address.

mac Specifies removal of an individual CM by its 48-bit hardware address (MAC

address).

name domain name Specifies the domain name of the cable modem.

interface (Optional) Resets the attribute masks of the offline CMs.

all Specifies removal of all CMs or all CMs associated with a specified cable interface.

offline Specifies removal of all offline CMs or all such CMs associated with a specified
interface.

oui oui Specifies removal of all CMs that match the specified Organization Unique
Identifier (OUI) or all such CMs associated with a specified interface. The string
parameter can be either the three-byte hexadecimal string (such as 00.00.0C) or a
vendor name.

reject Specifies removal of all CMs that are currently in one of the reject states or all
such CMs associated with a specified interface.

wideband Specifies removal of all wideband CMs or all such CMs associated with a specified
interface.

none-bounding-capable Specifies removal of all narrowband CMs that are not capable of downstream
channel bonding or all such CMs associated with a specified interface.

service-type-id Specifies the service type identifier.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

Cisco CMTS Cable Command Reference

1021
 Cable Commands: ca through cr
clear cable modem service-type-id

Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The name, wideband, and none-bounding-capable keywords were removed.

Usage Guidelines This command clears the cable mdem service type ID.

Examples The following example shows how to clear cable modem service type ID:

Router# clear cable modem all service-type-id

Router# clear cable modem oui SA service-type-id
Router# clear cable modem c3/0/0 offline service-type-id

Related Commands Command Description

clear cable modem attribute-masks This command clears the cable modem attribute masks.

show cable modem service-type-id Displays the modems having service type id.

Cisco CMTS Cable Command Reference

1022
 Cable Commands: ca through cr
clear cable modem voice

clear cable modem voice

To clear the voice tag that is set for a cable modem (CM), use the clear cable modem voice command in
privileged EXEC mode.

clear cable modem {ip-addrmac-addr} voice {retries | tag}

clear cable modem [cable slot/subslot/port] {all | offline | oui string | reject} voice {retries | tag}

Syntax Description ip-addr Specifies removal of an individual CM by its IPv4 or IPv6 address.

mac-addr Specifies removal of an individual CM by its 48-bit hardware address (MAC address).

retries Clears the CM downstream retries record.

tag Clears the CM voice tag.

cable (Optional—Cisco uBR10012 Router) Specifies clearing of voice tags for CMs on the
slot/subslot/port specified cable interface, where:
• slot—Specifies the chassis slot number of the cable interface line card. Valid slots
are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line card.
Valid subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4, depending
on the cable interface line card.

cable (Optional—Cisco cBR Series Routers) Specifies clearing of voice tags for CMs on
slot/subslot/port the specified cable interface, where:
• slot—Specifies the chassis slot number of the interface card. Valid slots are 0 to
3 and 6 to 9 on the Cisco cBR-8 router.
• subslot—Specifies the secondary slot number of the interface card. Valid subslot
is 0 on the Cisco cBR-8 router.
• port—Specifies the cable interface index number. Valid values are 0 to 15 on the
Cisco cBR-8 router.

all Specifies clearing of voice tags for all CMs or all CMs associated with a specified
cable interface.

offline Specifies clearing of voice tags for all offline CMs or all such CMs associated with a
specified interface.

oui string Specifies clearing of voice tags for all CMs that match the specified Organization
Unique Identifier (OUI) or all such CMs associated with a specified interface. The
string parameter can be either the three byte hexadecimal string (such as 00.00.0C) or
a vendor name that has been defined using the cable modem vendor command.

reject Specifies clearing of voice tags for all CMs that are currently in one of the reject states
or all such CMs associated with a specified interface. (See the show cable modem
command for a description of these states).

Cisco CMTS Cable Command Reference

1023
 Cable Commands: ca through cr
clear cable modem voice

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to clear the voice tag and retries record for the CM at IP address
172.16.23.45:

Router# clear cable modem 172.16.23.45 voice retries

Related Commands Commands Description

show cable modem voice Displays the detected voice-enabled modems.

test cable voice Allows you to manually set the voice tag of a cable modem.

Cisco CMTS Cable Command Reference

1024
 Cable Commands: ca through cr
clear cable multicast ses-cache

clear cable multicast ses-cache

To clear the multicast replication sessions cache, use the clear cable ses-cache command in privileged EXEC
mode.

clear cable multicast ses-cable {all | counter | interface integrated-cable slot/subslot/port:rf-channel

| modular-cable slot/ {subslotbay}/port:interface-number | wideband-cable slot/
{subslotbay}/port:wideband-channel}

Syntax Description all Clears the cached multicast replication sessions for all interfaces.

counter Clears multicast replication sessions cache counters.

interface integrated-cable Clears the cached multicast replication sessions for a integrated-cable
slot/subslot/port:rf-channel interface.
• slot—Slot where a line card resides.
• subslot—(Cisco uBR10012 only) Secondary slot number of a line
card.
• port—Downstream port number.
• rf:channel—RF channel number.

interface modular-cable Clears the cached multicast replication sessions for a modular-cable
slot/{subslot | interface.
bay}/port:interface-number
• slot—Slot where a SPA interface processor (SIP) or a line card resides.
• subslot—Secondary slot for a shared port adapter (SPA) or a line card.
• bay—Bay in a SIP where a SPA is located.
• port—Downstream port number.
• interface-number—Modular channel number.

interface wideband-cable Clears the cached multicast replication sessions for a wideband-cable
slot/{subslot | interface.
bay}/port:wideband-channel
• slot—Slot where a SPA interface processor (SIP) or a line card resides.
• subslot—Secondary slot for a shared port adapter (SPA) or a line card.
• bay—Bay in a SIP where a SPA is located.
• port—Downstream port number.
• wideband-channel—Wideband channel number.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)SCH This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Cisco CMTS Cable Command Reference

1025
 Cable Commands: ca through cr
clear cable multicast ses-cache

Usage Guidelines Use the clear cable multicast ses-cache command to clear the multicast replication sessions configured on
the interfaces.
The table below displays the valid values for an integrated-cable interface.

Table 26: Integrated Cable Interface Density Information

CMTS Router Line Card Slot Subslot Port RF Channel Number

Cisco uBR10012 Cisco uBR-MC3GX60V 5 to 8 0 or 1 0 to 4 0 to 3

Cisco UBR-MC20X20V

Cisco uBR10-MC5X20

Cisco uBR7225VXR All 1 or 2 — 0 or 1 —

Cisco uBR7246VXR All 3 to 6 — 0 or 1 —

The table below displays the valid values for an modular-cable interface.

Table 27: Modular Cable Interface Density Information

Line Card Slot Subslot Bay Port Interface Number

Cisco uBR-MC3GX60V 5 to 8 0 or 1 — 0 to 2 0 to 23

Cisco UBR-MC20X20V — 0 to 5

Cisco Wideband SPA — 0 or 110 0 to 3 0

Cisco Wideband SIP / Cisco SIP-600 1 or 3 — — —

10
Applicable to SPAs when the SIP is in Slot1 or Slot 3. The subslot is not specified from Cisco IOS
Release 12.2(33)SCB onwards.
The table below displays the valid values for an wideband-cable interface.

Table 28: Wideband Interface Density Information

CMTS Router Line Card Slot Subslot Bay Port Wideband Channel

Cisco uBR10012 Cisco uBR-MC3GX60V 5 to 8 0 or 1 — 0 to 4 0 to 31

Cisco UBR-MC20X20V — 0 to 5

Cisco uBR10-MC5X20 — —

Cisco Wideband SPA — 0 or 111 0 to 3 0 —

Cisco Wideband SIP / Cisco 1 or 3 — — — —

SIP-600

Cisco uBR7225VXR All 1 to 2 — — 0 or 1 0 to 5

Cisco uBR7246VXR All 3 to 6 — —

Cisco CMTS Cable Command Reference

1026
 Cable Commands: ca through cr
clear cable multicast ses-cache

11
Applicable to SPAs when the SIP is in Slot1 or Slot 3. The subslot is not specified from Cisco IOS
Release 12.2(33)SCB onwards.

Examples The following example clears the multicast replication session cache for all interfaces on the Cisco
uBR10012 router:
Router# clear cable multicast ses-cache all

Related Commands Command Description

cable multicast ses-cache Configures the multicast replication session cache on the Cisco uBR10012
router.

show cable multicast ses-cache Displays the multicast replication session cache information both at the
global and interface level of the forwarding interface.

Cisco CMTS Cable Command Reference

1027
 Cable Commands: ca through cr
clear cable multicast statistics counter

clear cable multicast statistics counter

To reset all multicast statistics counters, use the clear cable multicast statistics counter command in privileged
EXEC mode.

clear cable multicast statistics counter

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The counters are also set to zero when a given multicast resource is reconfigured. Counters are displayed
using the show cable multicast statistics command.

Examples The following example shows how to reset configured multicast statistics index allocation details to
zero:

Router# clear cable multicast statistics counter

Router#

Related Commands Command Description

show cable multicast statistics Displays the multicast statistics index allocation details.

show cable multicast db Displays the contents of the multicast explicit tracking database.

Cisco CMTS Cable Command Reference

1028
 Cable Commands: ca through cr
clear cable resil-rf-status

clear cable resil-rf-status

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

clear cable resil-rf-status [Integrated-Cable slot/subslot/port rf-channel-number ]

Syntax Description Integrated-Cable (Opional) Specifies that the flap counts and flap time is reset for
the given RF channel.

slot Slot where interface card resides. The range is from 0 to 3 and 6
to 9 on the Cisco cBR-8 router.

subslot Subslot number of the interface card. The value is 0 on the Cisco
cBR-8 router.

port Port number. The range is from 0 to 7 on the Cisco cBR-8 router.

rf-channel-number Downstream RF channel number. The range is from 0 to 162 on

the Cisco cBR-8 router.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.
This command replaces the clear cable rf-status command.

The following example shows how to reset the flap counts and flap time for RF channel 4:
Router# clear cable resil-rf-status Integrated-Cable 3/0/2 4

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete Removes one or more CMs from the internal address and routing tables on a
CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and resets them.

Cisco CMTS Cable Command Reference

1029
 Cable Commands: ca through cr
clear cable rf-status

clear cable rf-status

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

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

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

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

port Specifies the interface number on the SPA.

nb-channel-number Represents the narrowband channel number.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was replaced by the clear cable resil-rf-status command on the Cisco
cBR Series Converged Broadband Routers.

Related Commands Command Description

clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete Removes one or more CMs from the internal address and routing tables on a
CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock Resets the lock on one or more CMs.

clear cable modem name Removes or resets CMs by domain name.

clear cable modem reset Removes one or more CMs from the Station Maintenance List and resets them.

Cisco CMTS Cable Command Reference

1030
 Cable Commands: ca through cr
clear cable rpd all event

clear cable rpd all event

To remove all events on Cisco cBR, use the clear cable rpd all event command.

clear cable rpd all event

This command has no arguments or keywords.

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco RPD IOS This command was introduced on the Cisco Remote-PHY Devices.
1.1

Usage Guidelines Use this command to clear RPD events.

The following example shows how to clear all RPD events.
Router(config)#clear cable rpd all event
Router(config)#show cable rpd event
Load for five secs: 13%/4%; one minute: 10%; five minutes: 10%
Time source is NTP, 17:43:36.424 CST Fri Apr 28 2017
RPD EventId Level Count LastTime Message

Cisco CMTS Cable Command Reference

1031
 Cable Commands: ca through cr
clear cable rpd reset

clear cable rpd reset

To reset RPD, use the clear cable rpd reset command.

clear cable rpd { rpd_mac | all | slot id | group name | interface

TenGigabitEthernet slot/subslot/port } reset [ factory | non-volatile | soft
| hard ]

Syntax Description rpd_mac Specifies the MAC address of the RPD to reset.

all Resets all the RPDs.

slot id Specifies the slot of the RPDs to reset.

group name Specifies the group of the RPDs to reset.

interface TenGigabitEthernet Specifies the Ten Gigabit Ethernet interface with slot, subslot, and port of
slot/subslot/port the RPDs to reset.

reset Performs a hard reset together with a legacy GDM reset for backward
compatibility.

factory Restores the factory configuration and performs a hard reset.

non-volatile Clears most non-volatile configuration and performs a hard reset.

factory Performs a software reset.

hard Performs hardware reset using TLV40.1.1 on:

• All RPDs
• Specific RPD using MAC address
• Specific RPD interface
• Specific RPD slot

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1x This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Cisco IOS XE Dublin 17.12.1w The hard option is introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command works only when cBR-8 router acts as the principal core of the RPD.

The following example shows how to reset RPD.

Cisco CMTS Cable Command Reference

1032
Cable Commands: ca through cr
clear cable rpd reset

Router#clear cable rpd 1004.9fb1.1300 reset non-volatile

Warning: Do you really want to do this? It will clear most RPD non-volatile configuration!

Confirm to continue? [no]: yes

Router#

The following example shows how to reset all the RPD configured on the CBR router using the hard
option:
Router#clear cable rpd all reset hard

The following example shows how to reset a specific RPD configured on the CBR router:
Router#clear cable rpd 1004.9fb1.1300 reset hard
Router#show cable rpd
Load for five secs: 6%/1%; one minute: 7%; five minutes: 7%
Time source is NTP, 10:08:19.582 CST Fri Aug 4 2023

MAC Address IP Address I/F State Role HA Auth Name

0018.48fe.e643 10.0.0.1 Te6/1/5 online Pri Act N/A vecima-rpd

1004.9fb1.1300 10.0.0.2 Te6/1/5 offline Pri Act N/A ng13-shelf-node2

! = PTP clock out of phaselock occurred, ^ = Default password in use

Cisco CMTS Cable Command Reference

1033
 Cable Commands: ca through cr
clear cable secondary-ip

clear cable secondary-ip

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

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

Syntax Description slot/port (Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies the cable interface and
downstream port, where:
• slot—Specifies the chassis slot number of the cable interface line card.
• port—Specifies the downstream port number.
Valid values for these arguments are dependent on your CMTS router and cable interface
line card. Refer to the hardware documentation for your router chassis and cable interface
line card for supported slot and port numbering.

slot/subslot/port Cisco uBR10012 Router) Specifies the cable interface, where:

• slot—Specifies the chassis slot number of the cable interface line card. Valid slots
are 5 to 8.
• subslot—Specifies the secondary slot number of the cable interface line card. Valid
subslots are 0 or 1.
• port—Specifies the downstream port number. Valid ports are 0 to 4, depending on
the cable interface line card.

all Specifies that all IP addresses in the secondary IP address table should be cleared.

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

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

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.1(13)EC This command was introduced for the Cisco uBR7100 series and Cisco uBR7200 series
universal broadband routers.

12.2(11)BC1 Support was added for the Cisco uBR10012 universal broadband router.

12.2(11)BC2 This command was removed because it is no longer needed, because of database changes.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

Cisco CMTS Cable Command Reference

1034
 Cable Commands: ca through cr
clear cable secondary-ip

Release Modification

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

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

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

Examples The following example shows how to clear all of the secondary IP addresses for a particular cable
interface:

Router# clear cable secondary-ip interface cable 3/0 all

The following example shows how to clear the secondary IP addresses for all CM and CPE devices
on cable interface 1/0 that are using SID 5:

Router# clear cable secondary-ip interface cable 1/0 sid 5

The following example shows how to clear the secondary IP addresses for the CM and CPE devices
on cable interface 5/0 that are using SID 113 and IP address 10.10.17.3:

Router# clear cable secondary-ip interface cable 5/0 sid 113 10.10.17.3

Related Commands Command Description

show interface cable sid Displays information for a particular SID, including the known secondary IP
addresses.

Cisco CMTS Cable Command Reference

1035
 Cable Commands: ca through cr
clear cable upstream ofdma mer-fec

clear cable upstream ofdma mer-fec

To clear OFDMA MER and FEC counts, use the clear cable upstream ofdma mer-fec command in privileged
EXEC mode.

clear cable upstream ofdma mer-fec { all | upstream-cable slot/card/port us-channel us_channel_number
}

Syntax Description all Clears Upstream OFDMA MER and FEC on the entire chassis.

upstream-cable slot/card/port us-channel Clears Upstream OFDMA MER and FEC on a specific OFDMA
us_channel_number upstream channel.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS XE Gibraltar This command was introduced on the Cisco cBR Series Converged Broadband
16.12.1y Routers.

The following example shows how to clear Upstream OFDMA MER and FEC on the entire chassis.:
Router# clear cable upstream ofdma mer-fec all
Check all IUCs are cleared in the entire cbr8

The following example shows how to clear Upstream OFDMA MER and FEC on a specific OFDMA
upstream channel:
Router# clear cable upstream ofdma mer-fec upstream-cable 1/0/0 us-channel 15

Cisco CMTS Cable Command Reference

1036
 Cable Commands: ca through cr
clear hccp counters

clear hccp counters

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

clear hccp [group | all] counters

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

all Clears the counters for all HCCP groups.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

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

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

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

12.3(21)BC This command is obsolete on the Cisco uBR7246VXR router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

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

Examples The following example shows the counters for group 1 being reset to 0:

Router# clear hccp 1 counters

The following example shows the counters for all groups being reset to 0:

Router# clear hccp all counters

Cisco CMTS Cable Command Reference

1037
 Cable Commands: ca through cr
clear hccp counters

Related Commands Command Description

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

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

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

Cisco CMTS Cable Command Reference

1038
 Cable Commands: ca through cr
clear hccp linecard

clear hccp linecard

To clear information about the Hot Standby Connection-to-Connection Protocol (HCCP) startup and switchover
flow and unused events associated with cable line cards, use the clear hccp linecard command in privileged
EXEC mode.

clear hccp linecard {fsm | nullfsm} buffer

Syntax Description fsm The HCCP state transition flow (startup and switchover flow). Each line card member in an HCCP
group is controlled by a state machine, which controls the HCCP startup and switchover flow.

nullfsm The HCCP members that received unused or redundant events. This option is used only for
debugging.

buffer Buffer for saving HCCP state transition flow.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to clear entries for the HCCP startup and switchover flow using
the clear hccp linecard command on a Cisco CMTS router:

Router# clear hccp linecard fsm buffer

Related Commands Command Description

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

show hccp linecard Displays line card level HCCP group information.

Cisco CMTS Cable Command Reference

1039
 Cable Commands: ca through cr
clear packetcable gate counter commit

clear packetcable gate counter commit

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

clear packetcable gate counter commit [dqos | multimedia]

Syntax Description dqos Clears PC DQoS gate counters.

multimedia Clears PCMM gate counters.

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

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(8)BC2 This command was introduced for the Cisco uBR7200 series universal broadband router.

12.2(15)BC1 Support was added for the Cisco uBR10012 router.

12.3(13a)BC This command was modified to support PCMM on the Cisco uBR10012 router and the
Cisco uBR7246VXR router. The dqos and multimedia keywords were added.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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

Examples The following example shows the committed gate counter being reset to zero:

Router# clear packetcable gate counter commit

Related Commands Command Description

packetcable authorize vanilla-docsis-mta Allows non-DQoS MTAs to send DOCSIS DSX messages.

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

Cisco CMTS Cable Command Reference

1040
Cable Commands: ca through cr
clear packetcable gate counter commit

Command Description

packetcable multimedia Enables and displays PacketCable Multimedia processing on

the Cisco CMTS.

packetcable timer multimedia T1 Sets the default timeout value for T1timer used in PCMM gate
processing.

Cisco CMTS Cable Command Reference

1041
 Cable Commands: ca through cr
clear packetcable rks

clear packetcable rks

To clear the record keeping server (RKS) entries when there are no calls associated with the RKS server, use
the clear packetcable rks command in privileged EXEC mode.

clear packetcable rks {ip_addr ip_addr port | all}

Syntax Description ip_addr Indicates the IP address of the RKS server to be cleared.
ip_addr

port Indicates the UDP port of the RKS server to be cleared.

all Indicates that information about all RKS servers will be cleared.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCD This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The clear packetcable rks command is used to clear the unwanted IP addresses of the RKS servers from the
RKS server group list.

Note This command clears the IP addresses of only those RKS servers that are currently not being used. In other
words, if the reference count of an RKS server is a non-zero value, that entry will not cleared from the RKS
server group list.

Tip You can verify the value of reference count (ref-cnt) by executing the show packetcable event command
with the rks-group keyword.

Examples The following sample shows how to clear the RKS server with IP address 2.39.26.8 on port 1816:

router#
clear packetcable rks ip_addr 2.39.26.8 1816

The following sample shows how to clear the entries of all RKS servers:

router#
clear packetcable rks all

Cisco CMTS Cable Command Reference

1042
 Cable Commands: ca through cr
clear packetcable rks

Related Commands Command Description

show packetcable event Displays information about the servers that are configured on the Cisco CMTS
router for PacketCable operations.

Cisco CMTS Cable Command Reference

1043
 Cable Commands: ca through cr
clear pxf

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

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

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

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

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

•context—Current and historical loads on the PXF.
•diversion—Traffic diverted from the PXF.
•drop—Dropped packets and bytes.
•ip— IP and ICMP statistics.
•ipv6—IPv6 statistics.

xcm counters Clears the PXF Error Code Correction (ECC) counters.

Command Default Clears the PXF Error Code Correction (ECC) counters.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.0(22)S This command was introduced on the Cisco 10000 series router.

12.2(1)XF1 This command was introduced on the Cisco uBR10012 router.

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

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

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

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

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Cisco CMTS Cable Command Reference

1044
 Cable Commands: ca through cr
clear pxf

Usage Guidelines If no interface is specified, the command clears PXF counters on all interfaces. The clear pxf command clears
counters associated with the show pxf dma, show pxf interface, show pxf statistics, and show pxf xcm
commands.
Cisco uBR10012 Universal Broadband Router
Not all keyword options are supported in the Cisco IOS software for the Cisco uBR10012 universal broadband
router. See the command history table for the unsupported keyword options by release.
The clear pxf xcm counters command is supported only on the PRE1 and later processors for the Cisco
uBR10012 router. This command is not supported on the PRE processor.

Examples The following sample clears PXF statistics for serial interface 1/0/0:

router#
clear pxf interface serial 1/0/0

The following sample clears PXF statistics on all interfaces:

router#
clear pxf interface

Related Commands Command Description

show pxf cpu statistics Displays PXF CPU statistics.

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

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

show pxf statistics Displays chassis-wide, summary PXF statistics

show pxf xcm Displays information about the servers that are configured on the Cisco CMTS
router for PacketCable operations.

Cisco CMTS Cable Command Reference

1045
 Cable Commands: ca through cr
clear pxf statistics drl all

clear pxf statistics drl all

To clear all the entries in all the DRL statistics table, use the clear pxf statistics drl all command in
privileged EXEC mode.

clear pxf statistics drl all

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)SCJ This command was introduced.

Example
The following example shows how to clear all the entries in all the DRL statistics table:
Router#clear pxf statistics drl all

Related Commands Command Description

clear pxf statistics drl max-rate Clears the DRL max-rate statistics on the WAN interface.

Cisco CMTS Cable Command Reference

1046
 Cable Commands: ca through cr
clear pxf statistics drl cable-wan-ip

clear pxf statistics drl cable-wan-ip

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

clear pxf statistics drl cable-wan-ip

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was replaced by the show platform hardware qfp active infrastructure
punt sbrl command on the Cisco cBR Series Converged Broadband Routers.

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

Examples The following example shows how to clear cable-wan-ip statistics:

Router# clear pxf statistics drl cable-wan-ip

Related Commands Command Description

clear pxf statistics drl wan-non-ip (for uBR This command set the drop count to zero for all entries in
series router) the PXF DRL wan-non-ip statistics table.

Cisco CMTS Cable Command Reference

1047
 Cable Commands: ca through cr
clear pxf statistics drl wan-non-ip

clear pxf statistics drl wan-non-ip

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

clear pxf statistics drl wan-non-ip

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was replaced by the show platform software punt-policer clear command
on the Cisco cBR Series Converged Broadband Routers.

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

Examples The following example shows how to clear the PXF statistics in wan-non-ip:

Router# clear pxf statistics drl wan-non-ip

Related Commands Command Description

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

Cisco CMTS Cable Command Reference

1048
 Cable Commands: ca through cr
clear pxf statistics drl max-rate

clear pxf statistics drl max-rate

To clear the DRL max-rate statistics on the WAN interface, use the clear pxf statistics drl max-rate
command in privileged EXEC mode.

clear pxf statistics drl max-rate

Syntax Description threshold The packet threshold value. The valid range is 0 to 4294967295.

output modifiers The following output modifiers are used.

• begin—Begins with the line that match.
• exclude—Excludes the lines that match.
• include—Includes the lines that match.
• redirect—Redirects the output to the URL.
• section—Filters a section of the output.
• tee—Copies output to the URL.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33)SCH3 This command was introduced.

IOS-XE 3.15.0S This command was replaced by the show platform software punt-policer clear command
on the Cisco cBR Series Converged Broadband Routers.

Example
The following example shows how to clear DRL max-rate statistics on the WAN interface:
Router#clear pxf statistics drl max-rate wan
dropped divert_code
No max-rate WAN drops

Related Commands Command Description

service divert-rate-limit max-rate Sets per-divert-code rate limit on the WAN interface

clear pxf statistics drl max-rate Clears the DRL max-rate statistics on the WAN interface.

Cisco CMTS Cable Command Reference

1049
 Cable Commands: ca through cr
clear redundancy

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

clear redundancy {counters | history}

Cisco cBR Series Converged Broadband Routers

clear redundancy {counters | history | idb-sync-history | linecard history}

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

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

idb-sync-history Clears the Interface Descriptor Blocks (IDB) synchronization history of RF activity that
is maintained by the RF subsystem.

linecard history Clears the line card redundancy information.

• history—Clears the line card redundancy history logs.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(4)XF1 This command was introduced for the Cisco uBR10012 router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The idb-sync-history and linecard keywords were added.

Usage Guidelines The clear redundancycommand clears the following information, which is shown by the show redundancy
command:
• counters—Number of messages sent and received, buffers used, and synchronization errors.
• history—RF subsystem activity, such as checkpoint messages sent between RF clients.
• idb-sync-history—(On Cisco cBR series routers) RF subsystem activity, such as IDB synchronization
information.
• linecard history—(On Cisco cBR series routers) Line card redundancy history information.

Cisco CMTS Cable Command Reference

1050
 Cable Commands: ca through cr
clear redundancy

Examples The following example shows how to clear the RF counters that are displayed by the show
redundancy command:

Router# clear redundancy counters

The following example shows how to clear the RF history information that is displayed by the show
redundancy command:

Router# clear redundancy history

The following example shows how to clear the RF IDB synchronization history information that is
displayed by the show redundancy command on the Cisco cBR series routers:

Router# clear redundancy idb-sync-history

The following example shows how to clear the line card redundancy history information that is
displayed by the show redundancy command on the Cisco cBR series routers:

Router# clear redundancy linecard history

Related Commands Command Description

show redundancy Displays the current redundancy state.

Cisco CMTS Cable Command Reference

1051
 Cable Commands: ca through cr
cmc

cmc
To configure the Cisco CMC in a channel group, use the cmc command in channel group configuration mode.
To disable the configuration, use the no form of the command.

cmc mac-address

no cmc mac-address

Syntax Description mac-address MAC address of the Cisco CMC.

Command Default Cisco CMC is not configured.

Command Modes Channel group configuration (config-ch-group)

Command History Release Modification

12.2(33)CX This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You can configure up to four Cisco CMCs in a channel group.

The following example shows how to configure a Cisco CMC in a channel group:
Router# configure terminal
Router(config)# cable channel-group 1
Router(config-ch-group)# cmc 0010.2024.7035

Related Commands Command Description

cable channel-group Configures channel group.

show cable channel-group Displays the channel group information.

Cisco CMTS Cable Command Reference

1052
 Cable Commands: ca through cr
connection

connection
To configure the ECMG connection, use the connection command in the DVB scrambling ECMG configuration
mode. To void the ECMG connection configuration, use the no form of this command.

connection id id priority priority ip_address port

no connection id id

id id Specifies the connection ID.

priority priority Specifies the connection priority.

ip_address port Specifies the connection IP address and port.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to configure the ECMG connection:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#connection id 1 priority 1 1.200.1.81 8888

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

auto-channel-id Enables automatic channel ID selection.

ecm-pid-source Configures the source of ECM PID.

ca-system-id Configures the CA system ID.

type Configures the ECMG type.

mode Configures the application mode of ECMG.

desc-rule Configures the descriptor rule.

overrule Overrules the default settings.

Cisco CMTS Cable Command Reference

1053
 Cable Commands: ca through cr
controller downstream-oob 55d1-profile

controller downstream-oob 55d1-profile

To configure the OOB downstream controller profile, use the controller downstream-oob 55d1-profile
command in global configuration mode.

controller downstream-oob 55d1-profile id

Syntax Description
Syntax Description id Specifies the OOB downstream controller profile ID.

Command Default None

Command Modes
Global configuration (config)

Command History
Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the OOB downstream controller profile.

Examples The following example shows how to enter the OOB downstream controller profile configuration
mode:

Router# configure terminal

Router(config)# controller downstream-oob 55d1-profile 1
Router(config-profile)#

Related Commands Command Description

ds-channel Configures the OOB downstream channel.

Cisco CMTS Cable Command Reference

1054
 Cable Commands: ca through cr
controller integrated-cable

controller integrated-cable
To enter controller configuration mode to configure the controller interface for an integrated DOCSIS 3.0
cable interface line card, use the controller integrated-cable command in global configuration mode.

Cisco uBR10012 Router and Cisco cBR Series Converged Broadband Routers
controller integrated-cable slot/subslot/port

Cisco uBR7225VXR and Cisco uBR7246VXR Routers

controller integrated-cable slot/port

Syntax Description integrated-cable Identifies the cable interface.

slot/subslot/port
For the Cisco uBR10012 router:
• slot—Slot where the line card resides. The valid range is from 5 to 8.
• subslot—Subslot where the line card resides. Available slots are 0 or 1.
• port—Downstream controller number on the line card. Valid port values are from
0 to 4.
For the Cisco cBR series router:
• slot—Slot where the interface card resides. The valid range is from 0 to 3 and 6
to 9 on the Cisco cBR-8 router.
• subslot—Subslot where the interface card resides. The valid value is 0 on the
Cisco cBR-8 router.
• port—Controller port number. The valid values are from 0 to 7 on the Cisco
cBR-8 router.

integrated-cable Identifies the cable interface on the Cisco uBR7246VXR or Cisco uBR7225VXR
slot/port router.
• slot—Slot where the line card resides.
• Cisco uBR7246VXR router: The valid range is from 3 to 6.
• Cisco uBR7225VXR router: The valid range is from 1 to 2.
• port—Downstream port number on the line card. The valid port value is 0 or 1.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

12.2(33)SCD This command was modified. Added support for the controller interface configuration on
Cisco uBR7246VXR and Cisco uBR7225VXR universal broadband routers.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Cisco CMTS Cable Command Reference

1055
 Cable Commands: ca through cr
controller integrated-cable

Examples The following example shows how to enter controller configuration mode to configure the controller
interface in slot 5, subslot 1, and port 0 of the Cisco uBR10012 router:

Router# configure terminal

Router(config)# controller integrated-cable 5/1/0

The following example shows how to enter controller configuration mode to configure the controller
interface in slot 3, subslot 0, and port 0 of the Cisco cBR-8 router:

Router# configure terminal

Router(config)# controller integrated-cable 3/0/0

Related Commands Command Description

annex modulation Sets the annex and modulation rates for each RF channel.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel rf-power Sets the RF power output level.

rf-channel rf-shutdown Enables or disables an RF channel.

Cisco CMTS Cable Command Reference

1056
 Cable Commands: ca through cr
controller modular-cable

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

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

controller modular-cable slot/subslot/bay

Cisco IOS Release 12.2(33)SCB and later releases

controller modular-cable
slot/bay/portslot/subslot/controller

Syntax Description slot/subslot/bay or The Wideband SPA slot, subslot, bay, and port.
slot/bay/port
• slot—Slot where the Wideband SIP resides. The valid values are 1 and 3.
• subslot—Subslot where the Wideband SIP resides. The valid value is 0.
• bay—Wideband SIP bay where the SPA resides. The valid range is from
0 to 3.
• port—Port number on the SPA. The valid value is always 0.

slot/subslot/controller Modular cable line card slot, subslot, and controller.

• slot—Modular cable line card slot. The valid values are 5, 6, 7, and 8.
• subslot—Modular cable line card subslot. The valid values are 0 and 1.
• controller—Modular cable line card controller. The valid range is from 0
to 2.

Command Default The command mode is unchanged.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

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

12.2(33)SCB This command was modified. The addressing format for the modular cable interface was
changed from slot/subslot/bay to slot/bay/port.

12.2(33)SCE This command was modified. This command now supports the Cisco uBR-MC3GX60V
cable interface line card. The addressing format slot/subslot/controller for the modular-cable
line card was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command indicates where the wideband modular interface controller is located and enters controller
configuration mode. The modular interface controller could be either a SPA, or a Cisco uBR-MC3GX60V
cable interface line card.

Cisco CMTS Cable Command Reference

1057
 Cable Commands: ca through cr
controller modular-cable

Examples The following example shows how to enter the controller configuration mode for the Cisco Wideband
SPA in slot 1, subslot 0, and bay 0.

Router# configure terminal

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

The following example shows how to enter the controller configuration mode for the Cisco
uBR-MC3GX60V line card in slot 8, subslot 1, and controller-unit-number 1.

Router# configure terminal

Router(config)# controller modular-cable 8/1/1

Related Commands Command Description

annex modulation Sets the annex and modulation for the Cisco Wideband SPA.

cable rf-channel Associates an RF channel on a Cisco Wideband SPA with a

wideband channel.

ip-address (controller) Sets the IP address of the Cisco Wideband SPA FPGA.

modular-host subslot Specifies the modular-host line card for the Cisco Wideband
SPA.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

rf-channel description Specifies the description for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address, and UDP port for each RF
udp-port channel.

rf-channel network delay Specifies the CIN delay for each RF channel.

Cisco CMTS Cable Command Reference

1058
 Cable Commands: ca through cr
controller upstream-cable

controller upstream-cable
To configure upstream-cable controller, use the controller upstream-cable command in global configuration
mode. To restore the default value, use the no form of this command.

contoller upstream-cable slot/subslot/controller port number

no contoller upstream-cable slot/subslot/controller port number

Syntax Description slot/subslot/controller port The slot, subslot and controller port number. The valid range values are:
number
• slot - The valid range is from 0 to 9.
• subslot - The valid subslot is 0.
• contoller port number - The valid range is from 0 to 15.

Command Default Cable linecards are created for all the 16 controllers (0 - 15) by default.

Command Modes
Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines Use the controller upstream-cable command to configure upstream-cable controller in global configuration
mode.

Examples The following example shows how to configure upstream cable controller using contoller
upstream-cable command:

Router# configure terminal

Router(config)# controller Upstream-Cable 3/0/0
Router(config-controller)#

Related Commands Command Description

controller integrated-cable Configures the Integrated-cable controller.

Cisco CMTS Cable Command Reference

1059
 Cable Commands: ca through cr
controller upstream-oob 55d1-profile

controller upstream-oob 55d1-profile

To configure the OOB upstream controller profile, use the controller upstream-oob 55d1-profile command
in global configuration mode.

controller upstream-oob 55d1-profile id

Syntax Description
Syntax Description id Specifies the OOB upstream controller profile ID.

Command Default None

Command Modes
Global configuration (config)

Command History
Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the OOB upstream controller profile.

Examples The following example shows how to enter the OOB upstream controller profile configuration mode:

Router# configure terminal

Router(config)# controller upstream-oob 55d1-profile 1
Router(config-profile)#

Related Commands Command Description

us-channel Configures the OOB upstream channel.

Cisco CMTS Cable Command Reference

1060
 Cable Commands: ca through cr
cops ip dscp

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

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

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

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

0-63 DSCP value ranging from 0-63.

af11 Use AF11 dscp (001010)

af12 Use AF12 dscp (001100)

af13 Use AF13 dscp (001110)

af21 Use AF21 dscp (010010)

af22 Use AF22 dscp (010100)

af23 Use AF23 dscp (010110)

af31 Use AF31 dscp (011010)

af32 Use AF32 dscp (011100)

af33 Use AF33 dscp (011110)

af41 Use AF41 dscp (100010)

af42 Use AF42 dscp (100100)

af43 Use AF43 dscp (100110)

cs1 Use CS1 dscp (001000) [precedence 1]

cs2 Use CS2 dscp (010000) [precedence 2]

cs3 Use CS3 dscp (011000) [precedence 3]

cs4 Use CS4 dscp (100000) [precedence 4]

cs5 Use CS5 dscp (101000) [precedence 5]

cs6 Use CS6 dscp (110000) [precedence 6]

cs7 Use CS7 dscp (111000) [precedence 7]

default Use default dscp (000000)

Cisco CMTS Cable Command Reference

1061
 Cable Commands: ca through cr
cops ip dscp

ef Use EF dscp (101110)

Command Default • This command is disabled by default.

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

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced to the Cisco CMTS.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This feature allows you to change the Differentiated Services Code Point (DSCP) marking for COPS messages
that are transmitted or received by the Cisco router. Cisco IOS Release 12.3(13a)BC supports this function
with the cops ip dscp command. The cops ip dscp command changes the default IP parameters for connections
between the Cisco router and COPS servers in the cable network.
DSCP values are used in Quality of Service (QoS) configurations on a Cisco router to summarize the
relationship between DSCP and IP precedence. This command allows COPS to remark the packets for either
incoming or outbound connections.
The default setting is 0 for outbound connections. On default incoming connections, the COPS engine takes
the DSCP value from the COPS server initiating the TCP connection.

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

• The cops ip dscp command allows the Cisco router to re-mark the COPS packets for either incoming or
outbound connections.
• This command affects all TCP connections with all COPS servers.
• This command does not affect existing connections to COPS servers. Once you issue this command, this
function is supported only for new connections after that point in time.
• For messages transmitted by the Cisco router, the default DSCP value is 0.
• For incoming connections to the Cisco router, the COPS engine takes the DSCP value used by the COPS
server that initiates the TCP connection, by default.
For additional information about this feature and related commands, refer to the “COPS Engine Operation on
the Cisco CMTS Routers” feature document on Cisco.com.

Examples The following basic example illustrates the use of this command:
The following example illustrates the cops ip dscp command with supported command variations:

Cisco CMTS Cable Command Reference

1062
Cable Commands: ca through cr
cops ip dscp

Router(config)# cops ip dscp ?

<0-63> DSCP value
af11 Use AF11 dscp (001010)
af12 Use AF12 dscp (001100)
af13 Use AF13 dscp (001110)
af21 Use AF21 dscp (010010)
af22 Use AF22 dscp (010100)
af23 Use AF23 dscp (010110)
af31 Use AF31 dscp (011010)
af32 Use AF32 dscp (011100)
af33 Use AF33 dscp (011110)
af41 Use AF41 dscp (100010)
af42 Use AF42 dscp (100100)
af43 Use AF43 dscp (100110)
cs1 Use CS1 dscp (001000) [precedence 1]
cs2 Use CS2 dscp (010000) [precedence 2]
cs3 Use CS3 dscp (011000) [precedence 3]
cs4 Use CS4 dscp (100000) [precedence 4]
cs5 Use CS5 dscp (101000) [precedence 5]
cs6 Use CS6 dscp (110000) [precedence 6]
cs7 Use CS7 dscp (111000) [precedence 7]
default Use default dscp (000000)
ef Use EF dscp (101110)
Router(config)# cops ip dscp 63

The following example specifies the COPS server and enables COPS for RSVP on the server. Both
of these functions are accomplished by using the ip rsvp policy cops command on the Cisco
uBR10012 router. By implication, the default settings for all remaining COPS for RSVP commands
are accepted.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# ip rsvp policy cops servers 161.44.130.168 161.44.129.6
Router(config)# exit

The following examples display three views of the COPS for RSVP configuration on the router,
which can be used to verify the COPS for RSVP configuration.
The following example displays the policy server address, state, keepalives, and policy client
information:

Router# show cops servers

COPS SERVER: Address: 161.44.135.172. Port: 3288. State: 0. Keepalive: 120 sec
Number of clients: 1. Number of sessions: 1.
COPS CLIENT: Client type: 1. State: 0.

The following example displays the policy server address, the ACL ID, and the client/server connection
status:

Router# show ip rsvp policy cops

COPS/RSVP entry. ACLs: 40 60
PDPs: 161.44.135.172
Current state: Connected
Currently connected to PDP 161.44.135.172, port 0

The following example displays the ACL ID numbers and the status for each ACL ID:

Router# show ip rsvp policy

Local policy: Currently unsupported
COPS:

Cisco CMTS Cable Command Reference

1063
 Cable Commands: ca through cr
cops ip dscp

ACLs: 40 60 . State: CONNECTED.

ACLs: 40 160 . State: CONNECTING.

Related Commands Command Description

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

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

debug packetcable cops Enables debugging processes for PacketCable with the COPS engine.

debug packetcable gate control Enables and displays debugging processes for PacketCable gate control.

debug packetcable subscriber Enables and displays debugging processes for PacketCable subscribers.

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

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

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

Cisco CMTS Cable Command Reference

1064
 Cable Commands: ca through cr
cops listeners access-list

cops listeners access-list

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

cops listeners access-list {acl-numacl-name}

no cops listeners access-list {acl-numacl-name}

Syntax Description acl-num Numeric identifier that identifies the access list to apply to the current interface. For standard
access lists, the valid range is 1 to 99; for extended access lists, the valid range is 100 to 199.
For IPv4 access list number, the normal range is 1 to 199 and extended range is 1300 to 2699 on
the Cisco cBR series routers.

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

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

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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

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

Router# cops listeners access-list 40

Related Commands Command Description

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

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

Cisco CMTS Cable Command Reference

1065
 Cable Commands: ca through cr
cops listeners access-list

Command Description

debug packetcable cops Enables debugging processes for PacketCable with the COPS engine.

debug packetcable gate control Enables and displays debugging processes for PacketCable gate control.

debug packetcable subscriber Enables and displays debugging processes for PacketCable subscribers.

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

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

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

Cisco CMTS Cable Command Reference

1066
 Cable Commands: ca through cr
cops tcp window-size

cops tcp window-size

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

cops tcp window-size bytes

no cops tcp window-size

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

Command Default The default COPS TCP window size is 4000 bytes.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(13a)BC This command was introduced.

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

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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

Examples The following example configures the TCP window size to be 64000 bytes.

Router(config)# cops tcp window-size 64000

Related Commands Command Description

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

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

debug packetcable cops Enables debugging processes for PacketCable with the COPS engine.

debug packetcable gate control Enables and displays debugging processes for PacketCable gate control.

debug packetcable subscriber Enables and displays debugging processes for PacketCable subscribers.

Cisco CMTS Cable Command Reference

1067
 Cable Commands: ca through cr
cops tcp window-size

Command Description

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

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

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

Cisco CMTS Cable Command Reference

1068
 Cable Commands: ca through cr
core-interface

core-interface
To configure the core-interface, use the core-interface command in RPD configuration mode. To void the
core-interface configuration, use the no form of this command.

core-interface tengigabitethernet slot/port/interface

no core-interface tengigabitethernet slot/port/interface

Syntax Description slot/port/interface Specifies the slot, port and interface of the core-interface.

Command Default None

Command Modes RPD configuration (config-rpd)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to enter the core-interface configuration mode.

The following example shows how to configure the core-interface:

Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# core-interface tengigabitethernet 3/0/1
Router(config-rpd-core)#

Related Commands Command Description

principal Specifies RPD as principal.

network-delay dlm Configures DEPI latency measurement.

rpd-ds Configures RPD downstream port.

rpd-us Configures RPD upstream port.

Cisco CMTS Cable Command Reference

1069
 Cable Commands: ca through cr
cp-overrule

cp-overrule
To overrule and specify the crypto period duration, use the cp-overrule command in the DVB scrambling
EIS configuration mode. To restore the default crypto period duration, use the no form of this command.

cp-overrule duration
no cp-overrule

duration Specifies the crypto period duration in seconds.

Command Default None

Command Modes DVB scrambling EIS configuration mode (config-video-encrypt-dvb-eis)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command overrules and specifies the crypto period duration. The valid range is from 1 to 3600 seconds.

The following is an example of how to overrule and specify the crypto period duration:

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

Related Commands Command Description

overwrite-scg Enables Scrambling Control Group (SCG) overwrite.

eis Enters the Event Information Scheduler configuration

mode.

listening-port Configures the listening TCP port.

Cisco CMTS Cable Command Reference

1070
 Cable Commands: ca through cr
cpd

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

cpd
no cpd

Syntax Description This command has no keywords or arguments.

Command Default CPD is enabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21a)BC3 This command was introduced.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows the cpd enabled on a router:

Router(config)# cpd

Related Commands Command Description

cpd cr-id Configures a control relationship identifier.

Cisco CMTS Cable Command Reference

1071
 Cable Commands: ca through cr
cpd cr-id

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

cpd cr-id cr id number

no cpd cr-id

Syntax Description cr id Control relationship identifier. The valid range is from 1 to 65535.
number

Command Default The CR ID is configured as 1.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21a)BC3 This command was introduced.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows the control relationship identifier configured as 236:

Router(config)# cpd cr-id 236

Related Commands Command Description

cpd Enables CPD functionality.

Cisco CMTS Cable Command Reference

1072
 Cable Commands: ca through cr
cpe max

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

cpe max cpe-num

no cpe max

Syntax Description cpe-num Specifies the number of CPEs. Valid range is 1 to 254.

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

Command Modes
Cable config-file configuration (config-file)

Command History Release Modification

12.1(2)EC1 This command was introduced.

12.2(4)BC1 Support was added to the Release 12.2 BC train.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

Examples The following example shows how to set the maximum CPE value for the configuration file:

Router(config)# cable config-file channeloverride.cm

Router(config-file)# cpe max 3

Router(config-file)# exit

Related Commands Command Description

cable Creates a DOCSIS configuration file and enters configuration file mode.
config-file

access-denied Disables access to the network.

channel-id Specifies upstream channel ID.

Cisco CMTS Cable Command Reference

1073
 Cable Commands: ca through cr
cpe max

Command Description

download Specifies download information for the configuration file.

frequency Specifies downstream frequency.

option Provides config-file options.

privacy Specifies privacy options for baseline privacy images.

service-class Specifies service class definitions for the configuration file.

snmp manager Specifies Simple Network Management Protocol (SNMP) options.

timestamp Enables time-stamp generation.

Cisco CMTS Cable Command Reference

1074
 Cable Commands: ca through cr
cyclic-prefix

cyclic-prefix
To specify the channel cyclic-prefix, use the cyclic-prefix command in OFDM channel profile configuration
mode. To undo the cyclic-prefix assignment, use no form of this command.

cyclic-prefix [192 | 256 | 512 | 768 | 1024]

no cyclic-prefix

Command Default 192

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

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the channel cyclic-prefix.

Examples The following example shows how to specify the channel cyclic-prefix:

Router# configure terminal

Router(config)# cable downstream ofdm-channel-profile 21
Router(config-ofdm-chan-prof)# cyclic-prefix 1024

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

description (OFDM channel profile) Specify a user defined description for the profile.

interleaver-depth Specify the channel interleaver-depth.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-control Specify default modulation or profile as the channel control profile.

profile-data Specify default modulation or profile as the channel data profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

roll-off Specify the channel roll-off value.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1075
 Cable Commands: ca through cr
cyclic-prefix

Cisco CMTS Cable Command Reference

1076
Cable Commands: d through h
• default-nit-reference, on page 1079
• default-onid, on page 1080
• default-psi-interval, on page 1081
• depi-class, on page 1082
• depi-tunnel, on page 1084
• depi cin-failover, on page 1086
• depi eqam-stats, on page 1088
• desc-rule, on page 1089
• description (bonding-group), on page 1090
• description (cable fiber-node), on page 1092
• description (OFDM channel profile), on page 1093
• description (OFDM modulation profile), on page 1094
• description (redundancy-linecard), on page 1095
• dest-ip, on page 1096
• diagnostic load, on page 1097
• diagnostic ondemand action-on-failure, on page 1099
• diagnostic unload, on page 1101
• disable-auto-restart, on page 1103
• do-not-insert, on page 1104
• docsis-channel-id, on page 1105
• docsis-policy, on page 1106
• docsis-version, on page 1107
• downstream, on page 1108
• downstream cable, on page 1110
• downstream downstream-cable, on page 1112
• downstream downstream-cable rf-channel, on page 1113
• downstream integrated-cable rf-channel (interface), on page 1114
• downstream local upstream, on page 1116
• downstream modular-cable rf-channel (channel group), on page 1117
• downstream modular-cable rf-channel (interface), on page 1118
• downstream modular-cable rf-channel, on page 1120
• ds-channel, on page 1122
• duration, on page 1123

Cisco CMTS Cable Command Reference

1077
 Cable Commands: d through h

• dvb, on page 1126

• ecm-pid-source, on page 1127
• ecmg, on page 1129
• ecmg (Tier-based), on page 1130
• eis, on page 1131
• enable (Tier-based), on page 1132
• enabled (enforce-rule), on page 1133
• encrypt, on page 1135
• enforced qos-profile, on page 1136
• event-profile, on page 1139
• exception pxf, on page 1140
• facility-alarm (ubr10012), on page 1142
• factory-reset all, on page 1145
• factory-reset all secure, on page 1147
• fail-to-clear, on page 1149
• fail-to-clear-duration, on page 1150
• filter pid vcg, on page 1151
• filter program vcg, on page 1152
• freq-profile, on page 1153
• frequency, on page 1154
• guardband-override (OFDM channel profile), on page 1155
• hccp authentication, on page 1157
• hccp authentication key-chain, on page 1159
• hccp bypass version, on page 1161
• hccp channel-switch, on page 1163
• hccp check version, on page 1167
• hccp ds-switch, on page 1169
• hccp lockout, on page 1171
• hccp protect, on page 1173
• hccp resync, on page 1175
• hccp revertive, on page 1177
• hccp reverttime, on page 1179
• hccp switch, on page 1181
• hccp timers, on page 1183
• hccp track, on page 1185
• hccp unlockout, on page 1188
• hccp working, on page 1190
• hw-module bay reload, on page 1192
• hw-module shutdown (ubr10012), on page 1193
• hw-module slot , on page 1196
• hw-module slot pos, on page 1198
• hw-module slot srp, on page 1200
• hw-module subslot , on page 1202

Cisco CMTS Cable Command Reference

1078
 Cable Commands: d through h
default-nit-reference

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

default-nit-reference PID

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

Command Default None

Command Modes Video configuration mode (config-video)

Command History Release Modification

Cisco IOS XE Fuji This command was introduced on the Cisco cBR Series Converged Broadband
16.7.1 Routers.

Usage Guidelines The NIT helps in conveying information about the physical organization of the multiplexes and transport
streams (TS) carried through a specific network and also the characteristics of the network.
Use the no default-nit-reference command to remove the configured NIT PID.

The following example shows how to configure the NIT reference.

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

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

Cisco CMTS Cable Command Reference

1079
 Cable Commands: d through h
default-onid

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

default-onid number

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

Command Default None.

Command Modes Video configuration mode (config-video)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to change the deault system ONID.

The following example shows how to change the default ONID number:
configure terminal
cable video
default-onid 1580

Cisco CMTS Cable Command Reference

1080
 Cable Commands: d through h
default-psi-interval

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

default-psi-interval number

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

Command Default None.

Command Modes Video configuration mode (config-video)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to change the default PSI interval.

The following example shows how to change the default PSI interval:
configure terminal
cable video
default-psi-interval 400

Cisco CMTS Cable Command Reference

1081
 Cable Commands: d through h
depi-class

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

depi-class depi-class-name
no depi-class depi-class-name

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

Command Default No DEPI classes are defined.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The depi-class depi-class-name command allows you to configure a DEPI class template that consists of
configuration settings used by different pseudowire classes. The depi-class command enters DEPI class
configuration mode, where DEPI control plane parameters are configured.
You must use the same DEPI class in the pseudowire configuration at both ends of a Layer 2 control channel.

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

Router# configure terminal

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

Related Commands Command Description

l2tp-class Creates a template of Layer 2 Tunnel Protocol (L2TP) control plane configuration settings
that can be inherited by different pseudowire classes and enters the L2TP class
configuration mode.

depi-tunnel Creates a template of Downstream External PHY Interface (DEPI) tunnel configuration
settings, which different pseudowire classes can inherit, and enters the DEPI data session
configuration mode.

show depi tunnel Displays all active control connections.

Cisco CMTS Cable Command Reference

1082
Cable Commands: d through h
depi-class

Command Description

show depi session Displays established DEPI data sessions.

Cisco CMTS Cable Command Reference

1083
 Cable Commands: d through h
depi-tunnel

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

depi-tunnel depi-tunnel-name
no depi-tunnel depi-tunnel-name

Syntax Description depi-tunnel-name Name of the DEPI tunnel.

Command Default This command has no default behavior or values.

Command Modes
Global configuration (config)

Subinterface configuration (config-subif)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The depi-tunnel creates a template of DEPI tunnel configuration settings. The DEPI data session inherits the
control plane configuration settings of a depi-control template.
The following depi data session configuration options are available in this mode:
• l2tp-class
• depi-class
• dest-ip
• tos

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

Router# configure terminal

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

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

Router(config)# interface qam 6/4.1

Router(config-subif)# depi-tunnel 0

Cisco CMTS Cable Command Reference

1084
 Cable Commands: d through h
depi-tunnel

Related Commands Command Description

l2tp-class Creates a template of Layer 2 Tunnel Protocol (L2TP) control plane configuration settings,
which different pseudowire classes can inherit, and enters the L2TP class configuration
mode.

depi-class Creates a template of Downstream External PHY Interface (DEPI) control plane
configuration settings, which different pseudowire classes can inherit, and enters the
DEPI class configuration mode.

dest-ip Assigns an IP address to the destination network.

tos Configures the Type of Service (ToS) byte in the header of Layer 2 tunneled packets.

show depi tunnel Displays all active control connections.

show depi session Displays established DEPI data sessions.

Cisco CMTS Cable Command Reference

1085
 Cable Commands: d through h
depi cin-failover

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

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

no depi cin-failover

Syntax Description cpu-threshold Configures the CPU threshold on the line card.

high Sets the high threshold level. Default value is 95.

low Sets the low threshold level. Default value is 85.

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

Command Default The DEPI CIN failover configuration is disabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

12.2(33)SCF4 This command was modified. The cpu-threshold keyword was added to the command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines If DEPI Control Plane High Availability is configured, the depi cin-failover command, which is configured
globally, triggers a cable line card switchover when a CIN failure occurs.
The depi cin-failover cpu-threshold command allows you to set a CPU threshold to alter when a failover
due to CIN failure is allowed to happen.
• When the high threshold is reached, a failover due to CIN failure is disabled.
• If (and only if) the high threshold was reached, the CPU will have to drop lower than the configured low
threshold before a failover due to CIN failure is enabled again.

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

Examples The following example shows how to configure a CIN failover:

Router(config)# depi

Cisco CMTS Cable Command Reference

1086
 Cable Commands: d through h
depi cin-failover

Router(config)# depi cin-failover

Router(config)# exit

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

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

Related Commands Command Description

show depi tunnel Displays all active control connections.

show depi session Displays information about DEPI sessions.

Cisco CMTS Cable Command Reference

1087
 Cable Commands: d through h
depi eqam-stats

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

depi eqam-stats
no depi eqam-stats

Syntax Description This command has no arguments or keywords.

Command Default The DEPI EQAM statistics configuration is enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

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

Router# configure terminal

Router(config)# depi eqam-stats

Related Commands Command Description

show depi session Displays information about DEPI sessions.

Cisco CMTS Cable Command Reference

1088
 Cable Commands: d through h
desc-rule

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

desc-rule descriptor_name [id id]

no desc-rule descriptor_name

descriptor_name Specifies the descriptor name.

id Specifies the descriptor ID.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

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

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

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

do-not-insert Prohibits inserting standard descriptors.

add-priv-data Adds private data to the descriptor

Cisco CMTS Cable Command Reference

1089
 Cable Commands: d through h
description (bonding-group)

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

description description
no description

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

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

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines The description command is used to configure the Upstream Channel Bonding feature.
The description command adds a comment to the configuration to provide information about the bonding
group.

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

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# interface cable 8/0/0
Router(config-if)# cable upstream bonding-group 1
Router(config-upstream-bonding)# description UBG1
Router(config-upstream-bonding)# end
Router# show running interface cable 8/0/0
Building configuration...
Current configuration : 1443 bytes
!
interface Cable8/0/0
downstream Modular-Cable 8/0/0 rf-channel 0-3
cable ip-init apm
cable mtc-mode
no cable packet-cache
cable bundle 6
cable upstream max-ports 4
cable upstream bonding-group 1
description UBG1
upstream 0
upstream 1

Cisco CMTS Cable Command Reference

1090
 Cable Commands: d through h
description (bonding-group)

upstream 2
upstream 3
attributes 80000000

Related Commands Command Description

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

upstream cable connector Specifies the upstream channel ports for a fiber node.

Cisco CMTS Cable Command Reference

1091
 Cable Commands: d through h
description (cable fiber-node)

description (cable fiber-node)

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

description description
no description

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

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

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

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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

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

Router# configure terminal

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

Related Commands Command Description

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

node.

downstream cable Assigns a primary downstream channel for a fiber node.

downstream modular-cable rf-channel Specifies the RF channels that are available for wideband channels
on a fiber node.

upstream cable connector Specifies the upstream channel ports for a fiber node.

Cisco CMTS Cable Command Reference

1092
 Cable Commands: d through h
description (OFDM channel profile)

description (OFDM channel profile)

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

description description

no description

Syntax Description description Specify a user defined description for the profile.

Command Default None

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

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

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

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

Router# configure terminal

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

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

cyclic-prefix Specify the channel cyclic-prefix.

interleaver-depth Specify the channel interleaver-depth.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-control Specify default modulation or profile as the channel control profile.

profile-data Specify default modulation or profile as the channel data profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

roll-off Specify the channel roll-off value.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1093
 Cable Commands: d through h
description (OFDM modulation profile)

description (OFDM modulation profile)

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

description description

no description

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

Command Default None

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

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

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

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

Router# configure terminal

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

Related Commands Command Description

cable downstream Define the OFDM modulation profile on the OFDM channel.
ofdm-modulation-profile

assign Assign modulations to subcarriers.

start-frequency (Optional) Specify the starting frequency associated with the first
configurable subcarrier in the profile determined by the width.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

width Specify width of profile in Hz.

Cisco CMTS Cable Command Reference

1094
 Cable Commands: d through h
description (redundancy-linecard)

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

description group-description
no description

Syntax Description group-description Specifies the description for the line card redundancy groups.

Command Default Description is not configured.

Command Modes Line card redundancy configuration (config-red-lc)

Command History Release Modification

IOS-XE Release 3.16.0S This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines The description string has a maximum limit of 127 characters.

Examples The following example shows how to configure redundancy group description on Cisco cBR-8 Series
Converged Broadband Routers:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# redundancy
Router(config-red)# linecard-group 0 internal-switch
Router(config-red-lc)# description Redundancy Group0
Router(config-red-lc)#

Related Commands Command Description

class Configures redundancy class on the line card.

member slot Adds a slot to the line card redundancy group.

linecard-group internal-switch Creates a line card group for the line card.

redundancy Configures line card redundancy.

show redundancy linecard Displays information about a redundant line card or a line card group.

Cisco CMTS Cable Command Reference

1095
 Cable Commands: d through h
dest-ip

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

dest-ip dest-ip-address
no dest-ip dest-ip-address

Syntax Description dest-ip-address IP address of the EQAM.

Command Default This command has no default behavior or values.

Command Modes
DEPI tunnel configuration

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

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

Router# configure terminal

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

Related Commands Command Description

l2tp-class Creates a template of Layer 2 Tunnel Protocol (L2TP) control plane configuration settings,
which different pseudowire classes can inherit, and enters the L2TP class configuration
mode.

depi-class Creates a template of Downstream External PHY Interface (DEPI) control plane
configuration settings, which different pseudowire classes can inherit, and enters the
DEPI class configuration mode.

depi-tunnel Specifies the name of the depi-tunnel and enters the DEPI tunnel configuration mode.

tos Configures the Type of Service (ToS) byte in the header of Layer 2 tunneled packets.

show depi tunnel Displays all active control connections.

show depi session Displays established DEPI data sessions.

Cisco CMTS Cable Command Reference

1096
 Cable Commands: d through h
diagnostic load

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

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

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

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

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

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

Command Default No default behavior or values.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(16)BX This command was introduced.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The show diagnostic result output will be lost once a Field Diagnostic image is successfully unloaded off a
line card. If you want to retain the results of the Field Diagnostic test, enter show diagnostic result and copy
the output into a separate file before entering diagnostic unload to unload the Field Diagnostic image off the
line card.
Entering this command successfully will resume normal line card operation.
If a line card needs to be placed back online immediately and a Field Diagnostic test is in progress, enter
diagnostic stop to stop the in-progress Field Diagnostic test before entering diagnostic unload to unload the
Field Diagnostic image off the line card.

Examples In the following example, the Field Diagnostic image is unloaded off of the line card in slot 2. Note
that the command is not successfully executed until confirmed at the screen prompt.
Router# diagnostic unload slot 2
******************************************************************************
WARNING:All Field Diagnostics test results and information will be unavailable
to both the "show diagnostic result <target>" and "show
diagnostic content <target>" commands. To save the test results,
cancel the unloading process and enter the "show diagnostic result
<target>" command. Copy the output into a file, then re-enter the

Cisco CMTS Cable Command Reference

1097
 Cable Commands: d through h
diagnostic load

"diagnostic unload <target>" command to restore normal line

card operation.
******************************************************************************
% Are you sure that you want to perform this operation?
[no]:y FDIAG [slot 2]> Unloading the Field
Diagnostics image and restoring the original run-time image, please wait ...
FDIAG [slot 2]> Field Diagnostics image was successfully unloaded

Related Commands Command Description

diagnostic event-log size Sets the size of the event table.

diagnostic load Loads the Field Diagnostic image onto the line card.

diagnostic ondemand action-on-failure Sets the number of errors allowed in the Field Diagnostic test
before the Field Diagnostic test is stopped.

diagnostic ondemand iterations Sets the number of times each specific Field Diagnostic test will
be run when a Field Diagnostic test is initiated.

diagnostic start Starts Field Diagnostic testing on the line card.

diagnostic stop Stops an in-progress Field Diagnostic test.

show diagnostic content Shows the Field Diagnostic test list for a particular line card.

show diagnostic events Displays the history of Field Diagnostic events since the last
system reload.

show diagnostic ondemand settings Shows the diagnostic on-demand settings.

show diagnostic result Shows the results of the Field Diagnostic test.

show diagnostic ood-status Displays various status information, such as line card slot and
name, Field Diagnostic image status, and previous Field Diagnostic
test results.

Cisco CMTS Cable Command Reference

1098
 Cable Commands: d through h
diagnostic ondemand action-on-failure

diagnostic ondemand action-on-failure

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

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

Syntax Description continuefailure-limit Specifies that Field Diagnostic testing should continue on the line card after a failed
test occurs. The failure-limit specifies the number of failed tests that can be detected
before testing on the line card should stop. A failure-limit of 0 means testing should
continue regardless of the number of failed tests.
Note
The failure-limit is the number of failed tests, not errors within a single test. For
example, if four errors occur during a single test, the failure-limit for that individual
test would be 1, not 4.

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

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

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(16)BX This command was introduced.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The diagnostic ondemand action-on-failure settings cannot be saved to a Cisco IOS configuration file.
Therefore, the diagnostic ondemand action-on-failure command will need to be re-entered each time a
router is reset or power cycled if the action-on-failure settings should be maintained.
The show diagnostic ondemand settings command can be used to verify the diagnostic ondemand
action-on-failure setting.
The show diagnostic events event-type error command can be used to gather additional information about
an error event.

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

Router# diagnostic ondemand iterations 2

Router# diagnostic ondemand action-on-failure stop

Cisco CMTS Cable Command Reference

1099
 Cable Commands: d through h
diagnostic ondemand action-on-failure

Router# show diagnostic ondemand settings

Test iterations = 2

Related Commands Command Description

diagnostic event-log size Sets the size of the event table.

diagnostic load Loads the Field Diagnostic image onto the line card.

diagnostic ondemand action-on-failure Sets the number of errors allowed in the Field Diagnostic test
before the Field Diagnostic test is stopped.

diagnostic ondemand iterations Sets the number of times each specific Field Diagnostic test will
be run when a Field Diagnostic test is initiated.

diagnostic start Starts Field Diagnostic testing on the line card.

diagnostic stop Stops an in-progress Field Diagnostic test.

show diagnostic content Shows the Field Diagnostic test list for a particular line card.

show diagnostic events Displays the history of Field Diagnostic events since the last
system reload.

show diagnostic ondemand settings Shows the diagnostic on-demand settings.

show diagnostic result Shows the results of the Field Diagnostic test.

show diagnostic ood-status Displays various status information, such as line card slot and
name, Field Diagnostic image status, and previous Field Diagnostic
test results.

Cisco CMTS Cable Command Reference

1100
 Cable Commands: d through h
diagnostic unload

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

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

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

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

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

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

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(16)BX This command was introduced.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The show diagnostic result output will be lost once a Field Diagnostic image is successfully unloaded off a
line card. If you want to retain the results of the Field Diagnostic test, enter show diagnostic result and copy
the output into a separate file before entering diagnostic unload to unload the Field Diagnostic image off the
line card.
Entering this command successfully will resume normal line card operation.
If a line card needs to be placed back online immediately and a Field Diagnostic test is in progress, enter
diagnostic stop to stop the in-progress Field Diagnostic test before entering diagnostic unload to unload the
Field Diagnostic image off the line card.

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

Router# diagnostic unload slot 2

******************************************************************************
WARNING:All Field Diagnostics test results and information will be

Cisco CMTS Cable Command Reference

1101
 Cable Commands: d through h
diagnostic unload

unavailable to both the "show diagnostic result <target>" and

"show diagnostic content <target>" commands.
To save the test results, cancel the unloading process and enter
the "show diagnostic result <target>" command. Copy the output
into a file, then re-enter the "diagnostic unload <target>" command
to restore normal line card operation.
******************************************************************************

% Are you sure that you want to perform this operation? [no]:y
FDIAG [slot 2]> Unloading the Field Diagnostics image and restoring the original run-time
image, please wait ...

FDIAG [slot 2]> Field Diagnostics image was successfully unloaded

Related Commands Command Description

diagnostic event-log size Sets the size of the event table.

diagnostic load Loads the Field Diagnostic image onto the line card.

diagnostic ondemand action-on-failure Sets the number of errors allowed in the Field Diagnostic test
before the Field Diagnostic test is stopped.

diagnostic ondemand iterations Sets the number of times each specific Field Diagnostic test will
be run when a Field Diagnostic test is initiated.

diagnostic start Starts Field Diagnostic testing on the line card.

diagnostic stop Stops an in-progress Field Diagnostic test.

show diagnostic content Shows the Field Diagnostic test list for a particular line card.

show diagnostic events Displays the history of Field Diagnostic events since the last
system reload.

show diagnostic ondemand settings Shows the diagnostic on-demand settings.

show diagnostic result Shows the results of the Field Diagnostic test.

show diagnostic ood-status Displays various status information, such as line card slot and
name, Field Diagnostic image status, and previous Field Diagnostic
test results.

Cisco CMTS Cable Command Reference

1102
 Cable Commands: d through h
disable-auto-restart

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

disable-auto-restart

no disable-auto-restart

Command Default None

Command Modes
Process restart configuration (config-process-restart)

Command History Release Modification

IOS-XE 3.18.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command disables the automatic process restart.

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

Router# configure terminal

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

Related Commands Command Description

lcha-preferred Selects the LCHA when it is possible

Cisco CMTS Cable Command Reference

1103
 Cable Commands: d through h
do-not-insert

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

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

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

all Do not insert standard descriptors for all ecm ids.

ecm-ids id Do not insert standard descriptors for specified ecm

ids.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

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

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

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

add-priv-data Adds private data to the descriptor

Cisco CMTS Cable Command Reference

1104
 Cable Commands: d through h
docsis-channel-id

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

docsis-channel-id dcid
no docsis-channel-id dcid

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

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

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

Command History Release Modification

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

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

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

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

Router(config)#controller integrated-Cable 3/0/0

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

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

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

Cisco CMTS Cable Command Reference

1105
 Cable Commands: d through h
docsis-policy

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

docsis-policy n
no docsis-policy

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

Command Default No default behavior or values.

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

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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

Router# configure terminal

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

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1106
 Cable Commands: d through h
docsis-version

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

[exclude] docsis-version docsis-version

no docsis-version docsis-version

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

docsis-version DOCSIS version for the CMTS tag. You can select one of the following DOCSIS versions
to match the DOCSIS modems:
• docsis10 - Matches DOCSIS 1.0 modems
• docsis11 - Matches DOCSIS 1.1 modems
• docsis20 - Matches DOCSIS 2.0 modems
• docsis30 - Matches DOCSIS 3.0 modems.

Command Default No default behavior or values.

Command Modes
CMTS tag mode (cmts-tag)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.

Router(config)# cable tag 1
Router(cmts-tag)# docsis-version docsis10

Related Commands Command Description

cable load-balance docsis-group To configure a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group To display real-time configuration, statistical and operational
information for load balancing operations on the router.

cable tag To configure a tag for a DOCSIS load balancing group on the
CMTS.

Cisco CMTS Cable Command Reference

1107
 Cable Commands: d through h
downstream

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

Cisco uBR7200 Series Routers

downstream cable {slot | /port}
no downstream cable {slot | /port}

Cisco uBR10012 Router

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

Cisco cBR Series Converged Broadband Routers

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

Syntax Description cable {slot/port} Specifies the CMTS interface slot and port numbers.

cable {slot/subslot/port} Specifies the CMTS interface slot, subslot, and port numbers.

Integrated-Cable{rf-channel group Specifies the integrated cable interface with the list of port numbers
list}{slot/subslot/bay} that range in the associated RF channel. Slot, subslot, and bay
numbers of the integrated cable interface is also specified.

Modular-Cable {rf-channel group Specifies the modular cable interface with the list of port numbers
list}} {slot/subslot/bay} that range in the associated RF channel. It also specifies slot, subslot,
and bay numbers of the modular cable interface.

Integrated-Cable {slot Specifies the downstream channels from a particular downstream

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

Command Default No default behavior or values.

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

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Cisco CMTS Cable Command Reference

1108
 Cable Commands: d through h
downstream

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

Router# configure terminal

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

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

Router# configure terminal

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

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1109
 Cable Commands: d through h
downstream cable

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

downstream cable {slot | /subslot | /port}

nodownstream cable {slot | /subslot | /port}

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

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

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

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

Command Modes
Cable fiber-node configuration

Command History Release Modification

12.3(21)BC This command was introduced for the uBR10012 router.

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines For each fiber node, a traditional DOCSIS downstream channel is used to carry MAC management and
signaling messages, and the associated traditional DOCSIS upstream channel is used for return data traffic
and signaling. The traditional DOCSIS downstream channel used in this way is called the primary downstream
channel .
The downstream cable command assigns a primary downstream channel for a fiber node. Each fiber node
must be assigned at least one primary downstream channel and can be assigned multiple primary downstream
channels. Cisco IOS software decides which primary downstream channel to use for the fiber node from the
set of channels assigned with downstream cable. Assigning more than one primary channel to a fiber node
with the downstream cable command can be useful for load-balancing purposes.

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

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

Cisco CMTS Cable Command Reference

1110
 Cable Commands: d through h
downstream cable

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

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

Router# configure terminal

Router(config)# cable fiber-node 5

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

Related Commands Command Description

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

description (cable fiber-node) Specifies a description for a fiber node.

downstream modular-cable rf-channel Specifies the RF channels that are available for wideband channels
on a fiber node.

upstream cable connector Specifies the upstream channel ports for a fiber node.

Cisco CMTS Cable Command Reference

1111
 Cable Commands: d through h
downstream downstream-cable

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

downstream downstream-cable slot/subslot/port

no downstream downstream-cable slot/subslot/port

Syntax Description slot/subslot/port Specifies the slot, subslot and port of the downstream controller.

Command Default None

Command Modes
Fiber node configuration (config-fiber-node)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

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

Examples The following example shows how to configure the downstream controller in the fiber node:
Router# configure terminal
Router(config)# cable fiber-node 1
Router(config-fiber-node)# downstream downstream-cable 3/0/0

Related Commands Command Description

cable fiber node Enters fiber node configuration mode.

upstream Configures the upstream controller in the fiber node.

upstream-cable

Cisco CMTS Cable Command Reference

1112
 Cable Commands: d through h
downstream downstream-cable rf-channel

downstream downstream-cable rf-channel

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

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

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

Syntax Description slot/subslot/port Specifies the slot, subslot and port of the downstream controller.

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

name Specifies the downstream controller profile.

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

Command Default None

Command Modes
Interface configuration (config-if)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

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

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

Router# configure terminal

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

Related Commands Command Description

interface cable Configures a cable interface.

upstream upstream-cable us-channel Associates a set of physical upstream channels with the Mac Domain.

Cisco CMTS Cable Command Reference

1113
 Cable Commands: d through h
downstream integrated-cable rf-channel (interface)

downstream integrated-cable rf-channel (interface)

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

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

Syntax Description slot Identifies the chassis slot where the Cisco cable interface line card resides.
• Cisco uBR10012 router—The valid range is from 5 to 8.
• Cisco uBR7225VXR router—The valid value is 1 or 2.
• Cisco uBR7246VXR router—The valid range is from 3 to 6.
• Cisco cBR Series Converged Broadband Routers— The valid ranges are from 0
to 3 and 6 to 9.

subslot (Cisco uBR10012 only) Secondary slot number of the cable interface line card. The
valid subslots are 0 or 1.
For Cisco cBR Series Converged Broadband Routers, the valid subslot is 0.

port Downstream port (controller) number.

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

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

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

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

Command Modes
Interface configuration (config-if)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Cisco CMTS Cable Command Reference

1114
 Cable Commands: d through h
downstream integrated-cable rf-channel (interface)

Release Modification

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

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

• Configuring the Cisco UBR-MC20X20V Cable Interface Line Card
• Configuring the Cisco uBR-MC88V Cable Interface Line Card

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

Router# configure terminal

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

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

Router# configure terminal

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

Related Commands Command Description

cable upstream max-ports Configures the maximum number of upstreams on a MAC domain on a line
card.

Cisco CMTS Cable Command Reference

1115
 Cable Commands: d through h
downstream local upstream

downstream local upstream

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

downstream local upstream grouplist

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

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

Command Modes
Interface configuration mode (config-if)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

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

Router# configure terminal

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

Related Commands Command Description

downstream cable Assigns a primary downstream channel for a fiber node.

Cisco CMTS Cable Command Reference

1116
 Cable Commands: d through h
downstream modular-cable rf-channel (channel group)

downstream modular-cable rf-channel (channel group)

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

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

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

Syntax Description modular-cable Specifies the modular-cable interface.

slot/subslot/port
• slot—Chassis slot number of the cable interface line card. The valid range is
from 5 to 8.
• subslot—Secondary slot number of the cable interface line card. The valid
range is from 0 to 1.
• port—Port number on the line card. The valid range is from 0 to 2.

rf-channel grouplist Specifies the list of downstream RF channels.

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

Command Default Downstream RF channels are not configured.

Command Modes Channel group configuration (config-ch-group)

Command History Release Modification

12.2(33)CX This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

The following example shows how to configure a downstream RF channel for a channel group:
Router# configure terminal
Router(config)# cable channel-group 1
Router(config-ch-group)# downstream Modular-Cable 7/1/0 rf-channel 0-15

Related Commands Command Description

cable channel-group Configures channel group.

show cable channel-group Displays the channel group information.

Cisco CMTS Cable Command Reference

1117
 Cable Commands: d through h
downstream modular-cable rf-channel (interface)

downstream modular-cable rf-channel (interface)

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

Cisco IOS Release 12.3(23)BC

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

Cisco IOS Release 12.2(33)SCB and later

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

Cisco IOS Release 12.2(33)SCE and later

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

Syntax Description slot Slot where a SIP resides. On the Cisco uBR10012 router, slots 1 and 3 can be used for SIPs.
For the Cisco uBR-MC3GX60V cable interface line card, the cable interface slot values range
from 5 to 8.

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

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

port Interface number on the SPA.

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

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

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

rf Range of RF channel physical ports on the SPA FPGA.

channels

upstream Specifies a set of ranges of upstream to allow association of a noncontiguous list of upstreams
to one or more SPA downstreams. If the range is not specified, all the upstreams in the MAC
domain are associated.

grouplist Number of upstreams with the modular cable downstream channel.

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

Command Modes
Interface configuration (config-if)

Cisco CMTS Cable Command Reference

1118
 Cable Commands: d through h
downstream modular-cable rf-channel (interface)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

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

12.2(33)SCE This command was modified to change the valid range of slot.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

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

Router# configure terminal

Router (config)# interface cable 5/1/0

Router(config-if)# downstream modular-cable 1/0/0

rf-channel 0-2
upstream 0-1 4-5

Related Commands Command Description

downstream modular-cable rf-channel Specifies the RF channels that are available for wideband
channels on a fiber node.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

Cisco CMTS Cable Command Reference

1119
 Cable Commands: d through h
downstream modular-cable rf-channel

downstream modular-cable rf-channel

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

Cisco IOS Release 12.3(23)BC

downstream modular-cable slot/subslot/bay rf-channel {rf-portlow-high}
no downstream modular-cable slot/subslot/bay rf-channel {rf-portlow-high}

Cisco IOS Release 12.2(33)SCB

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

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

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

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

port Specifies the interface number on the SPA.

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

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

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

Command Modes
Cable fiber-node configuration (fiber-node)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

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

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

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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

Cisco CMTS Cable Command Reference

1120
 Cable Commands: d through h
downstream modular-cable rf-channel

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

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

• For annex A and 256 QAM, each Wideband SPA supports 18 RF channels. In this case, valid values for
the rf-port argument are 0 to 17.
• For all other cases, the SPA supports 24 RF channels. In these cases, valid values for the rf-port argument
are 0 to 23.
A fiber node can be configured to have RF channels from one or both Wideband SPAs. However, a wideband
channel cannot be comprised of RF channels from two different SPAs.
Each time the downstream modular-cable rf-channel command is issued for a fiber node, the set of RF
channels that are available for use on that fiber node is added to in a cumulative manner. For example, if the
following downstream modular-cable rf-channel commands were issued, the set of RF channels available
for fiber node 1 is RF channels 0 to 10 on the Wideband SPA in slot/subslot/bay 1/0/0.

Router# configure terminal

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

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

Router# configure terminal

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

Related Commands Command Description

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

description (cable fiber-node) Specifies a description for a fiber node.

downstream cable Assigns a primary downstream channel for a fiber node.

upstream cable connector Specifies the upstream channel ports for a fiber node.

Cisco CMTS Cable Command Reference

1121
 Cable Commands: d through h
ds-channel

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

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

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

Syntax Description f-value Specifies the OOB downstream channel frequency value.

p-value Specifies the OOB downstream channel poweradjust value.

Command Default None

Command Modes
Profile configuration (config-profile)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the OOB downstream channel.

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

Router# configure terminal

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

Related Commands Command Description

controller downstream-oob 55d1-profile Configures the OOB downstream controller profile.

Cisco CMTS Cable Command Reference

1122
 Cable Commands: d through h
duration

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

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

Cisco cBR Series Converged Broadband Routers

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

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

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

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

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

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

upstream Specifies monitoring of traffic in the upstream direction.

downstream Specifies monitoring of traffic in the downstream direction.

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

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

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.3(9a)BC This command was introduced. This command replaces the monitoring-duration
command.

Cisco CMTS Cable Command Reference

1123
 Cable Commands: d through h
duration

Release Modification

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

12.2(33)SCD2 The penalty keyword option was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

Usage Guidelines

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

When you enable an enforce-rule, the CMTS router periodically checks the bandwidth being used by subscribers
to determine whether any subscribers are consuming more bandwidth than that specified by the avg-rate
configured in enforce-rule. The CMTS router keeps track of subscribers using a sliding window that begins
at each sample interval and continues for the duration period and average rate.
For example, with the default sample interval of 15 minutes and the default sliding window period of 360
minutes, the CMTS router samples the bandwidth usage every 15 minutes and counts the total bytes transmitted
at the end of each 360-minute period. Each sample interval begins a new sliding window period for which
the CMTS router keeps track of the total bytes transmitted.

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

When you change the configuration of a currently active enforce-rule, that rule begins using the new
configuration immediately to manage the cable modems tracked by this enforce-rule.
The penalty duration, which is configured using this command, is unique to weekdays, and takes precedence
over the global penalty duration configured using the penalty-period command.
When you use the show running-configuration command to display the configuration, the keyword options
for the duration command are truncated. In the following example, “pen” represents penalty, “do” represents
downstream, and “enf” represents enforce:

Router# show running-configuration

.
.
.
duration 10 avg-rate 1 sample-interval 10 pen 11 do enf

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

Cisco CMTS Cable Command Reference

1124
 Cable Commands: d through h
duration

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

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# duration 20 avg-rate 1 sample-interval 10 penalty 11 do enf

The following example shows an enforce-rule being configured on a Cisco cBR Series Converged
Broadband Router:
Router# configure terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# duration 10 avg-rate 2 sample-interval 1 penalty-period 20 downstream
enforce

Related Commands Command Description

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

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management on

a Cisco CMTS router.

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

monitoring-basics Specifies the type of monitoring for subscriber traffic management on a

Cisco CMTS router.

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

penalty-period Specifies the period for which an enforced quality of service (QoS) profile
should be in force for subscribers who violate their registered QoS profile.

qos-profile registered Specifies the registered QoS profile that should be used for this
enforce-rule. This command is applicable only for DOCSIS 1.0 cable
modems.

qos-profile enforced Specifies a QoS profile that should be enforced when users violate their
registered QoS profile. This command is applicable only for DOCSIS
1.0 cable modems.

service-class (enforce-rule) Specifies a service class (enforced or registered) that should be used for
cable modem monitoring in an enforce-rule. This command is applicable
for DOCSIS 1.1 or later cable modems.

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

weekend duration Configures different subscriber monitoring options over weekends on a

Cisco CMTS router.

Cisco CMTS Cable Command Reference

1125
 Cable Commands: d through h
dvb

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

dvb

Syntax Description This command has no keywords or arguments.

Command Modes
Video encryption configuration (config-video-encrypt)

Command History Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines Use this command to enter the DVB scrambling configuration mode.

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

Router# configure terminal

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

Cisco CMTS Cable Command Reference

1126
 Cable Commands: d through h
ecm-pid-source

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

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

auto lower_limit upper_limit ECM PID is determined internally by the system in

the range between lower limit and upper limit.

ecm-id ECM ID specified in the SCG will be used as the

ECM PID.

sid ECM PID is choosen automatically from the Service

ID PID Range.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines It is recommended to use auto option for the customers using:
• Session based scrambling by providing pids in the Scrambling Control Group (component based
scrambling)
• Tier based scrambling

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

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

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

auto-channel-id Enables automatic channel ID selection.

connection Configures the ECMG connection.

Cisco CMTS Cable Command Reference

1127
 Cable Commands: d through h
ecm-pid-source

Command Description

ca-system-id Configures the CA system ID.

type Configures the ECMG type.

mode Configures the application mode of ECMG.

desc-rule Configures the descriptor rule.

overrule Overrules the default settings.

Cisco CMTS Cable Command Reference

1128
 Cable Commands: d through h
ecmg

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

ecmg ecmg_name [id id]

no ecmg ecmg_name

ecmg_name Specifies the ECMG name.

id Specifies the ECMG ID.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

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

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

Related Commands Command Description

mode Configures the application mode of ECMG.

auto-channel-id Enables automatic channel ID selection.

connection Configures the ECMG connection.

ecm-pid-source Configures the source of ECM PID.

ca-system-id Configures the CA system ID.

type Configures the ECMG type.

desc-rule Configures the descriptor rule.

overrule Overrules the default settings.

Cisco CMTS Cable Command Reference

1129
 Cable Commands: d through h
ecmg (Tier-based)

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

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

no ecmg {id id | name name}

id id Specifies the ECMG ID.

name name Specifies the ECMG name.

access-criteria hex_access_criteria Specifies the access criteria per ECMG.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

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

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

Related Commands Command Description

tier-based Enters tier-based scrambling configuration mode.

enable Enables the tier-based scrambling.

Cisco CMTS Cable Command Reference

1130
 Cable Commands: d through h
eis

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

eis server_name [id id]

no eis server_name

server_name Specifies the EIS server name.

id Specifies the EIS connection ID.

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

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

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

Related Commands Command Description

overwrite-scg Enables Scrambling Control Group (SCG) overwrite.

listening-port Configures the listening TCP port.

cp-overrule Overrules and specifies the crypto period duration.

Cisco CMTS Cable Command Reference

1131
 Cable Commands: d through h
enable (Tier-based)

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

enable
no enable

Command Default None

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

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

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

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

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

Related Commands Command Description

tier-based Enters tier-based scrambling configuration mode.

ecmg Configures the tier-based scrambling.

Cisco CMTS Cable Command Reference

1132
 Cable Commands: d through h
enabled (enforce-rule)

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

enabled
no enabled

Syntax Description This commands has no keywords or arguments.

Command Default Enforce-rules are disabled.

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.2(15)BC1 This command was introduced.

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

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

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

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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

Examples The following example shows an enforce-rule being enabled:

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# enabled

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

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Cisco CMTS Cable Command Reference

1133
 Cable Commands: d through h
enabled (enforce-rule)

Router(enforce-rule)# no enabled

Related Commands Command Description

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

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

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

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

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

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1134
 Cable Commands: d through h
encrypt

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

encrypt
no encrypt

Command Default None.

Command Modes
Virtual carrier group configuration (config-video-vcg)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command enables encryption on a virtual carrier group.

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

Router# configure terminal

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

Related Commands Command Description

virtual-carrier-group Defines a virtual carrier group.

virtual-edge-input-ip Defines a virtual edge input.

service-type Specifies the service type of the virtual carrier group.

rf-channel Specifies the virtual RF channels in a virtual carrier group.

show cable video virtual-carrier-group Displays the virtual carrier group information.

Cisco CMTS Cable Command Reference

1135
 Cable Commands: d through h
enforced qos-profile

enforced qos-profile

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

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

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

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

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

no-persistence (Optional) Specifies that the enforced QoS profile should not remain in force when a cable
modem reboots. Instead, when a cable modem (CM) that is in the penalty period reboots,
it is automatically removed from the penalty period and assigned the QoS profile that is
specified in its DOCSIS configuration file.
The default is without this option, so that enforced QoS profiles remain in effect for cable
modems across reboots.

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

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.3(9a)BC This command was replaced by the qos-profile enforced command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Both the originally provisioned QoS profile and the enforced QoS profile must be created on the Cisco CMTS
router. This command does not support profiles that are created by the cable modem.
An enforce-rule can specify an enforced QoS profile, which is automatically applied to subscribers that transmit
more traffic than what is allowed by their registered QoS profile. The enforced QoS profile remains in effect
during the penalty time period (see the penalty-period command). At the end of the penalty period, the
subscriber returns to their registered QoS profile.
If a cable modem reboots while it is in its penalty time period, it continues using the enforced QoS profile,
unless the service provider has manually changed the cable modem’s registered QoS profile using the cable
modem qos profile command.

Cisco CMTS Cable Command Reference

1136
 Cable Commands: d through h
enforced qos-profile

When you change the enforced QoS profile for a currently active enforce-rule, any cable modems using this
rule that are currently in the penalty period continue using the previously configured enforced QoS profile.
Any cable modems that enter the penalty period after this configuration change, however, use the new enforced
QoS profile.
An enforced QoS profile must already have been created on the Cisco CMTS router before you can assign it
to an enforce-rule. If the rule does not exist, the system displays an error message.
When the no-persistence option is specified, the enforced QoS profile is still automatically applied to
subscribers that violate their bandwidth requirements. However, when the cable modem reboots, the Cisco
CMTS router allows the cable modem to use the QoS profile that is specified in its DOCSIS configuration
file.
The no-persistence option can be used when initially using subscriber traffic management to identify potential
problem applications and users. When repeat offenders are identified, they can then be assigned enforce-rules
that do not use the no-persistence option, so that they remain in the penalty period even if they reboot their
cable modems.

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

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

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# enforced qos-profile 12

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

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# enforced qos-profile 12 no-persistence

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

Router# configure terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# enforced qos-profile 98
The qos profile 98 doesn't exist or it's a cm created QoS profile

Cisco CMTS Cable Command Reference

1137
 Cable Commands: d through h
enforced qos-profile

Related Commands Command Description

activate-rule at-byte-count Specifies the number of bytes that a subscriber can transmit during the
monitoring period on a Cisco CMTS router.

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

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management on a

Cisco CMTS router.

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

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

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

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1138
 Cable Commands: d through h
event-profile

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

event-profile name

Syntax Description Command Description

name Name of the GQI announce event profile.

Command Default None.

Command Modes
Global configuration mode (config).

Command History Release Modification

Cisco IOS XE Everest 16.6.1 This command is introduced on the Cisco cBR Series Converged Broadband
Routers.

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

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

Related Commands Command Description

showcable video announce-event-profile Displays the configuration of the GQI announce event profile
and a list of LEDs that use the profile.

announce-event-profile Configures the GQI announce event profile.

Cisco CMTS Cable Command Reference

1139
 Cable Commands: d through h
exception pxf

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

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

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

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

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

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

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

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

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

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

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR10012 router.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines

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

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

Cisco CMTS Cable Command Reference

1140
 Cable Commands: d through h
exception pxf

Router# configure terminal

Router(config)# exception pxf style minimal

Router(config)# exception pxf core-file ubr10k-pxf

Router(config)# exception pxf flash disk1:

Router(config)#

Related Commands Command Description

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

Cisco CMTS Cable Command Reference

1141
 Cable Commands: d through h
facility-alarm (ubr10012)

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

facility-alarm {core-temperature | intake-temperature} {critical exceed-action shutdown | major

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

Cisco cBR Series Converged Broadband Routers

facility-alarm critical exceed-action shutdown
no facility-alarm critical exceed-action shutdown

Syntax Description core-temperature Specifies the temperature threshold for the temperature sensors near the center
of the PRE module.

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

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

major [temp] Specifies the temperature, in degrees Centigrade, at which the PRE module
generates a major alarm to warn of potential damage from excessive temperatures.
The valid range for temp is 20 to 67 degrees Centigrade, with a default of 58 for
the core temperature threshold and 54 for the intake-temperature threshold.

minor [temp] Specifies the temperature, in degrees Centigrade, at which the PRE module
generates a minor alarm to warn of potential damage from excessive temperatures.
The valid range for temp is 20 to 67 degrees Centigrade, with a default of 50 for
the core temperature threshold and 45 for the intake-temperature threshold.

Command Default If no specific temperature is given, that particular facility alarm is reset to its default value. The default core
temperature thresholds are 85 (critical), 58 (major), and 50 (minor). The default intake-temperature thresholds
are 72 (critical), 54 (major), and 45 (minor) degrees Centigrade.
In Cisco IOS releases previous to Cisco IOS Release 12.2(11)BC1, a critical alarm automatically shuts down
the router after two minutes to prevent temperature damage. In Cisco IOS Release 12.2(11)BC1 and later, a
critical alarm by default does not shut down the router.

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

Cisco CMTS Cable Command Reference

1142
 Cable Commands: d through h
facility-alarm (ubr10012)

Command Modes
Global configuration (config)

Command History Release Modification

12.2(1)XF1 This command was introduced for the Cisco uBR10012 router.

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

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

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

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines

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

The PRE module on the Cisco uBR10012 router contains temperature sensors that monitor the temperature
at the air intake slots and on the PRE module itself. The facility-alarm command configures the router for
the temperature thresholds that will generate a minor, major, or critical alarm, so as to notify the system
operators of the temperature problem before excessive heat can damage the router or any of its components.
Before Cisco IOS Release 12.2(11)BC1, a critical alarm would also automatically shut down the router after
two minutes. Cisco IOS Release 12.2(11)BC1 made this automatic shutdown a configurable option, so that
the system operators can decide whether or not a critical alarm should power down the router.
As a general rule, do not disable the automatic shutdown of the router unless you have a systems operator
available to immediately respond to any critical temperature alarms, because this could result in system
damage. Typically, the primary reason to disable the automatic shutdown would be if you are replacing the
fan tray assembly and want to ensure that the router does not power down if the procedure takes longer than
expected.

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

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

Router# configure terminal

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

Cisco CMTS Cable Command Reference

1143
 Cable Commands: d through h
facility-alarm (ubr10012)

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

Router# configure terminal

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

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

Router# configure terminal

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

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

Router# configure terminal

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

The following commands show how to disable critical temperature alarm on Cisco cBR Series
Converged Broadband Routers:
Router# configure terminal
Router(config)# facility-alarm critical exceed-action shutdown
Router(config)#
Router(config)# no facility-alarm critical exceed-action shutdown
Router(config)#

Related Commands Command Description

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

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

Cisco CMTS Cable Command Reference

1144
 Cable Commands: d through h
factory-reset all

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

Note • Partitions accessed by BinOS only have their file tables cleared; the file content is visible with a raw
device dump.
• The factory-reset all does not sanitize all the storage devices. To perfom factory reset and device
sanitization use the Secure Factory Reset command: factory-reset all secure.

factory-reset all

Syntax Description This command has no keywords or arguments.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

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

Cisco IOS XE Cupertino 17.9.1w In this release, the partitions are cleared, the device is repartitioned and
reformated.
In previous releases, the partitions are retained and each partition is cleared
and reformated.

Cisco IOS XE Everest 16.6.1 This command is introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines The following example shows how to perform Fast Factory Reset.

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

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

Cisco CMTS Cable Command Reference

1145
 Cable Commands: d through h
factory-reset all

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

The SUP will reload to perform factory reset.

The reset can take a while to finish with secure option.

1. DO NOT UNPLUG THE POWER OR INTERRUPT THE OPERATION!
2. DO NOT RELOAD PEER SUP!
3. DO NOT START FACTORY RESET ON PEER SUP!

Are you sure you want to continue? [confirm] Y

Enabling factory reset for this reload cycle

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

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

*Jan 01 00:46:24.952: %IOSXEBOOT-4-FACTORY_RESET: (rp/0): Factory reset

successful. Continuing with reboot ...
!
!

Cisco CMTS Cable Command Reference

1146
 Cable Commands: d through h
factory-reset all secure

factory-reset all secure

To perform factory reset and device sanitization use the factory-reset all secure command. This method is
called as Secure Reset. The following folders are cleared as part of this procedure:
• User info in ACT2 is cleared.
• NVRAM that stores IOS configuration and data. For CBR-8, NVRAM and its backup are partitions on
eUSB flash device.
• /bootflash/ - For CBR-8, bootflash is a partition on eUSB flash device.
• /obfl/ - For CBR8, OBFL folder is a partition on eUSB flash device.
• /csl_p/ - For CBR8, csl_p folder is a partition on eUSB flash device.
• /harddisk/ - For CBR8, the harddisk folder is a partition on SSD.

factory-reset all secure

Syntax Description This command has no keywords or arguments.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

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

Cisco IOS XE Cupertino 17.9.1w In this release, the partitions are cleared, the device is repartitioned and
reformated.
In previous releases, the partitions are retained and each partition is cleared
and reformated.

Usage Guidelines The following example shows how to perform Secure Reset.

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

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

Cisco CMTS Cable Command Reference

1147
 Cable Commands: d through h
factory-reset all secure

Current running image will be restored to bootflash after reset.

If current image is a private image with sensitive data, reload
with Cisco release image first.

The SUP will reload to perform factory reset.

The reset can take a while to finish with secure option.

1. DO NOT UNPLUG THE POWER OR INTERRUPT THE OPERATION!
2. DO NOT RELOAD PEER SUP!
3. DO NOT START FACTORY RESET ON PEER SUP!

Are you sure you want to continue? [confirm] Y

Enabling factory reset for this reload cycle

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

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

Cisco CMTS Cable Command Reference

1148
 Cable Commands: d through h
fail-to-clear

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

fail-to-clear
This command has no arguments or keywords.

Command Default By default, this feature is not enabled.

Command Modes Global configuration mode (config)

Command History Release Modification

Cisco IOS XE Everest 16.5.1 This command was introduced on the Cisco cBR
Series Converged Broadband Routers.

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

The following example shows how to configure fail-to-clear.

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

Cisco CMTS Cable Command Reference

1149
 Cable Commands: d through h
fail-to-clear-duration

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

fail-to-clear-duration duration in sec

Command Default By default the duration is set to 0.

Command Modes Global configuration mode (config)

Command History Release Modification

Cisco IOS XE Everest 16.5.1 This command was introduced on the Cisco cBR
Series Converged Broadband Routers.

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

The following example shows how to configure fail-to-clear-duration..

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

Cisco CMTS Cable Command Reference

1150
 Cable Commands: d through h
filter pid vcg

filter pid vcg

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

filter pid vcg vcg

Syntax Description vcg Specifies the virtual carrier group.

Command Default None.

Command Modes
Video configuration (config)

Command History Release Modification

IOS-XE 16.8.1 This command was introduced on the Cisco cBR Series Converged Broadband Router.

Examples The following example shows a filter rule for a table-based unicast session on input port number 1
with vei-ip 198.51.100.1
logical-edge-device led1 id 1
protocol table-based
virtual-edge-input-ip 198.51.100.1 input-port-number 1
vcg vcg1
active
table-based
vcg vcg1
rf-channel 2
session unicast input-port 1 start-udp-port 49152 processing-type passthru

The corresponding filter rule is shown below:

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

Cisco CMTS Cable Command Reference

1151
 Cable Commands: d through h
filter program vcg

filter program vcg

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

filter program vcg vcg

Syntax Description vcg Specifies the virtual carrier group.

Command Default None.

Command Modes
Video configuration (config)

Command History Release Modification

IOS-XE 16.8.1 This command was introduced on the Cisco cBR Series Converged Broadband Router.

Examples The following example shows a program filter rule for a table-based unicast session on input port
number 1 with vei-ip 198.51.100.1
logical-edge-device led1 id 1
protocol table-based
virtual-edge-input-ip 198.51.100.1 input-port-number 1
vcg vcg1
active
table-based
vcg vcg1
rf-channel 2
session unicast input-port 1 start-udp-port 49152 processing-type passthru

The corresponding filter rule is shown below:

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

Cisco CMTS Cable Command Reference

1152
 Cable Commands: d through h
freq-profile

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

freq-profile value

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

Command Default The default value is 0.

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

Command History Release Modification

Cisco IOS-XE Release 3.15.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to define the QAM profile number.

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

Related Commands Command Description

cable downstream freq-profile Set the frequency profile for the cable interface line card.

frequency Defines the RF channel radio frequency.

show cable freq-profile Displays information about the frequency profile.

Cisco CMTS Cable Command Reference

1153
 Cable Commands: d through h
frequency

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

frequency number

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

Command Default None.

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

Usage Guidelines This command is used to define the RF channel frequency.

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

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

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

Related Commands Command Description

controller integrated-cable Enters the controller configuration mode.

rf-chan To enter the RF channel sub configuration mode.

qam-profile Defines the QAM profile number.

rf-output Defines the QAM output mode.

type Defines the QAM data type.

power-adjust Defines the channel power level.

Cisco CMTS Cable Command Reference

1154
 Cable Commands: d through h
guardband-override (OFDM channel profile)

guardband-override (OFDM channel profile)

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

guardband-override value

no guardband-override

Syntax Description value 0 to 4000000 in 50000Hz increments.

Command Default None.

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

Command History Release Modification

IOS-XE 3.18.1SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

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

Examples The following example shows how to specify the guard band:

Router# configure terminal

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

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

cyclic-prefix Specify the channel cyclic-prefix.

description (OFDM channel profile) Specify a user defined description for the profile.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-control Specify default modulation or profile as the channel control profile.

profile-data Specify default modulation or profile as the channel data profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

roll-off Specify the channel roll-off value.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1155
 Cable Commands: d through h
guardband-override (OFDM channel profile)

Command Description

interleaver-depth Specify the channel interleaver-depth.

Cisco CMTS Cable Command Reference

1156
 Cable Commands: d through h
hccp authentication

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

hccp group authentication {md5 | text}

no hccp group authentication {md5 | text}

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

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

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

Command Default The default authentication algorithm is MD5.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

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

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

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

12.2(15)BC1 Support was added for the Cisco uBR-MC5X20U/S BPE on the Cisco uBR10012
router.

12.3(17a)BC2 Support was added for the Cisco uBR-MC5X20H BPE on the Cisco uBR10012
router.

12.3(21)BC This command is obsolete on the Cisco uBR7246VXR router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Cisco CMTS Cable Command Reference

1157
 Cable Commands: d through h
hccp authentication

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

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

Router(config-if)# hccp 1 authentication md5

Related Commands Command Description

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

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

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

Cisco CMTS Cable Command Reference

1158
 Cable Commands: d through h
hccp authentication key-chain

hccp authentication key-chain

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

hccp group authentication key-chain key-chain

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

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

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

Command Default No default behavior or values

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

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

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

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

12.2(15)BC1 Support was added for the Cisco uBR-MC5X20U/S BPE on the Cisco uBR10012
router.

12.3(17a)BC2 Support was added for the Cisco uBR-MC5X20H BPE on the Cisco uBR10012
router.

12.3(21)BC This command is obsolete on the Cisco uBR7246VXR router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

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

Cisco CMTS Cable Command Reference

1159
 Cable Commands: d through h
hccp authentication key-chain

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

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

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

Related Commands Command Description

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

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

key-chain Defines one or more key chains for authentication between the Working
CMTS or Protect CMTS.

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

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

Cisco CMTS Cable Command Reference

1160
 Cable Commands: d through h
hccp bypass version

hccp bypass version

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

hccp group bypass version

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

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

Command Modes
Privileged EXEC

Command History Release Modification

12.2(4)XF1, 12.2(4)BC1 This command was introduced for the Cisco uBR10012 router and Cisco
uBR-LCP-MC28C card with the Cisco RF Switch.

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

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

12.2(15)BC1 Support was added for the Cisco uBR-MC5X20U/S BPE on the Cisco uBR10012
router.

12.3(17a)BC2 Support was added for the Cisco uBR-MC5X20H BPE on the Cisco uBR10012
router.

12.3(21)BC This command is obsolete on the Cisco uBR7246VXR router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines By default, the Cisco CMTS verifies that the Working and Protect cable interfaces are using the same versions
of software and hardware, so as to avoid potential incompatibilities during a switchover. The hardware check
verifies that the Working and Protect cable interface line cards are compatible. The software check verifies
that the two cards are running the same major versions of software. If either of these two conditions is not
true, the CMTS by default does not perform the switchover.
You can override these version checks for a particular HCCP group by using the hccp bypass version
command. After you give this command, the Cisco CMTS does not check the hardware or software versions
of the two cable interfaces before performing a switchover. To return to normal HCCP operations, so that
version checks are made for a group, use the hccp check version command.

Cisco CMTS Cable Command Reference

1161
 Cable Commands: d through h
hccp bypass version

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

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

Router# hccp 20 bypass version

Router#

Related Commands Command Description

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

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

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

Cisco CMTS Cable Command Reference

1162
 Cable Commands: d through h
hccp channel-switch

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

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

position
hccp group channel-switch member-id switch-name rfswitch-module rfswitch-ip-address
module-number position
hccp group channel-switch member-id switch-name tty-switch [aux | console | vty] line-number port
hccp group channel-switch member-id switch-name {wavecom-hd | wavecom-ma} prot-ip-address
protect-module work-ip-address work-module
no hccp group channel-switch member-id switch-name

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

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

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

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

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

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

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

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

module-number Specifies the module number on the Cisco RF Switch. The valid range is 1 to 255.
Note
This setting must be configured on the Cisco RF Switch as well as the Cisco CMTS.

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

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

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

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

Cisco CMTS Cable Command Reference

1163
 Cable Commands: d through h
hccp channel-switch

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

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

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

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

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

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

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

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

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

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

Command Modes
Interface configuration—cable interface only (config-if)

Command History Release Modification

12.2(4)XF1, 12.2(4)BC1 This command was introduced for the Cisco uBR10012 router, replacing the hccp
ds-switch command for use with the Cisco RF Switch.

12.2(8)BC2 Support was added for the Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E,
and Cisco uBR-LCP-MC16S cards on the Cisco uBR10012 router.

12.2(11)BC1 Support was added for the Cisco uBR7246VXR router and Cisco uBR-MC16C,
Cisco uBR-MC16S, and Cisco uBR-MC28C cards.

12.3(21)BC This command is obsolete on the Cisco uBR7246VXR router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Cisco CMTS Cable Command Reference

1164
 Cable Commands: d through h
hccp channel-switch

Usage Guidelines You must configure each Working and Protect cable interface for use with the Cisco RF Switch, typically
specifying one hccp channel-switch command to configure the Cisco RF Switch information, and another
hccp channel-switch command to configure the upconverter.
The Protect interface is configured with the same hccp channel-switch commands as those that are used on
the Working interface. However, typically, the same Protect interface is configured with multiple hccp
channel-switch commands to protect multiple Working interfaces.

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

Router# configure terminal

Router(config)# interface cable8/1/0

Router(config-if)# hccp 1 working 1

Router(config-if)# hccp 1 channel-switch 1 uc wavecom-hd 10.97.1.21 2 10.97.1.21 16

Router(config-if)# hccp 1 channel-switch 1 rfswitch rfswitch-group 10.97.1.20 AA200000 1

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

Router# configure terminal

Router(config)# interface cable5/1/0

Router(config-if)# hccp 1 protect 1 10.97.1.8

Router(config-if)# hccp 1 channel-switch 1 uc wavecom-hd 10.97.1.21 2 10.97.1.21 16

Router(config-if)# hccp 1 channel-switch 1 rfswitch rfswitch-group 10.97.1.20 AA200000 1

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

Router# configure terminal

Router(config)# interface cable5/1/0

Router(config-if)# hccp 1 protect 2 10.97.1.8

Router(config-if)# hccp 1 channel-switch 2 uc wavecom-hd 10.97.1.21 2 10.97.1.21 14

Router(config-if)# hccp 1 channel-switch 2 rfswitch rfswitch-group 10.97.1.20 AA200000 2

Related Commands Command Description

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

Cisco CMTS Cable Command Reference

1165
 Cable Commands: d through h
hccp channel-switch

Command Description

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

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

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

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

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

Cisco CMTS Cable Command Reference

1166
 Cable Commands: d through h
hccp check version

hccp check version

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

hccp group check version

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

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

Command Modes
Privileged EXEC

Command History Release Modification

12.2(4)XF1, 12.2(4)BC1 This command was introduced for the Cisco uBR10012 router and Cisco
uBR-LCP-MC28C card with the Cisco RF Switch.

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

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

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines By default, the Cisco CMTS verifies that the Working and Protect cable interfaces are using the same versions
of software and hardware, so as to avoid potential incompatibilities during a switchover. The hardware check
verifies that the Working and Protect cable interface line cards are compatible. The software check verifies
that the two cards are running the same major versions of software. If either of these two conditions is not
true, the CMTS by default does not perform the switchover.
You can override these version checks for a particular HCCP group by using the hccp bypass version
command. After you give this command, the Cisco CMTS does not check the hardware or software versions
of the two cable interfaces before performing a switchover. To return to normal HCCP operations, so that
version checks are made for a group, use the hccp check version command.

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

Cisco CMTS Cable Command Reference

1167
 Cable Commands: d through h
hccp check version

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

Router# hccp 1 check version

Router#

Related Commands Command Description

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

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

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

Cisco CMTS Cable Command Reference

1168
 Cable Commands: d through h
hccp ds-switch

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

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

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

no hccp group ds-switch member

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

member The member number within the specified group.

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

host-ipaddr The IP address of the upconverter module12 to which the host CMTS is connected.

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

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

peer-module The upconverter module number to which the peer (or remote) CMTS is connected. This
location is expressed as a simple numeric designation.
12
The identification of the upconverter module is important to define when the host or peer CMTS is
connected to a channel switch housing multiple modules. For example, the Wavecom MA4040D
upconverter chassis offers a maximum of 10 independent frequency agile upconverters.

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

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

12.2(4)XF1, 12.2(4)BC1 This command was deprecated and replaced by the hccp channel-switch command.

Cisco CMTS Cable Command Reference

1169
 Cable Commands: d through h
hccp ds-switch

Release Modification

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

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

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

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

Related Commands Command Description

hccp channel-switch (replaces the hccp ds-switch command).

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

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

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

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

Cisco CMTS Cable Command Reference

1170
 Cable Commands: d through h
hccp lockout

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

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

hccp group lockout member

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

member The member number within the specified group.

Command Default By default, the hccp lockout command is inactive.

Command Modes
Privileged EXEC

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

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

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

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

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines Typically the hccp lockout command is used to disable HCCP switchovers before removing the HCCP
configuration on the Working interface. Otherwise, when you remove the HCCP configuration from the
Working interface, the Protect interface assumes the Working interface has failed and switches over.
You might also want to prevent a Working CMTS from automatically switching back to a Protect CMTS for
testing or additional configuration purposes. For example, you might want to fully test protecting cable
interfaces on your Cisco CMTS before returning it to protect status.

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

Cisco CMTS Cable Command Reference

1171
 Cable Commands: d through h
hccp lockout

Router# hccp 1 lockout

Related Commands Command Description

hccp unlockout Negates the effects of the hccp lockout EXEC command, making the CMTS available
for automatic switchover from a Working CMTS to a Protect CMTS.

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

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

Cisco CMTS Cable Command Reference

1172
 Cable Commands: d through h
hccp protect

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

hccp group protect member ipaddr

no hccp group protect member

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

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

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

Command Default No default behavior or values

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

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

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

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

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines The protect cable interface must be configured identically to the working cable interface, which typically
means the interfaces must be the same card type. However, when the Cisco uBR-MC16S card is used, it can
be used with either another Cisco uBR-MC16S card or a Cisco uBR-MC16C card.
The following table shows how a switchover affects the enhanced spectrum management features of the Cisco
uBR-MC16S card.

Cisco CMTS Cable Command Reference

1173
 Cable Commands: d through h
hccp protect

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

Working Cable Protect Cable Operation After Switchover

Interface Interface

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

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

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

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

Router(config)# interface cable 4/0

Router(config-if)# hccp 2 protect 2 1.1.11.2

Related Commands Command Description

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

hccp working Configures a specified cable interface to be a working member of a given

group.

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

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

Cisco CMTS Cable Command Reference

1174
 Cable Commands: d through h
hccp resync

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

hccp group resync member

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

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

Command Default No default behavior or values.

Command Modes
Privileged EXEC

Command History Release Modification

12.2(4)XF1, 12.2(4)BC1 This command was introduced for the Cisco uBR10012 router and Cisco
uBR-LCP-MC28C card with the Cisco RF Switch.

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

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

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

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

Note When a SYNC event command is occurring, CLI commands might be very slow to respond. In particular, if
you enter a show command at the same time a SYNC event is occurring, the command might respond produce
a blank display, or it might display an error message similar to the following:
%No response from slot 6/1. Command aborted

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

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

Cisco CMTS Cable Command Reference

1175
 Cable Commands: d through h
hccp resync

Router# hccp 13 resync 4

Router#

Related Commands Command Description

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

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

Cisco CMTS Cable Command Reference

1176
 Cable Commands: d through h
hccp revertive

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

hccp group revertive

no hccp group revertive

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

Command Default Enabled

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

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

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

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

12.3(21)BC This command is obsolete on the Cisco uBR7246VXR router.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

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

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

Using hccp track with hccp revertive

Cisco CMTS Cable Command Reference

1177
 Cable Commands: d through h
hccp revertive

As a general rule, if you are using the hccp track command on a cable interface, do not also configure the
hccp revertive command without also configuring no keepalive on the cable interface. Configuring both
commands on the same interface, along with keepalives, can cause multiple switchovers on the same fault.
If you want to use keepalives along with both the hccp track and hccp revertive commands,use the hccp
track command on both the Working and Protect interfaces, so that the Working interfaces on the same card
track each other and the Protect interfaces on the same card track each other. The following table summarizes
the guidelines for using these three commands:

Table 30: Possible hccp track and hccp revertive Configurations

hccp track hccp track hccp revertive keepalive Configuration

(Working I/Fs) (Protect I/Fs)

Yes No No keepalive or no keepalive

Yes No Yes no keepalive

Yes Yes Yes keepalive or no keepalive

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

router(config)# interface cable 4/0

router(config-if)# hccp 2 revertive

Related Commands Command Description

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

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

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

Cisco CMTS Cable Command Reference

1178
 Cable Commands: d through h
hccp reverttime

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

hccp group reverttime revert-time

no hccp group reverttime

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

revert-time The amount of time (in minutes) that a Protect interface waits before automatically switching
back to a Working interface following a system switchover. The allowable range in Cisco IOS
Release 12.2(15)BC2 and earlier releases is 1 to 65,535 minutes, with a default of 30 minutes.
In Cisco IOS Release 12.3(3)BC and later releases, the allowable range is 1 to 35791 minutes,
with a default of 30 minutes.

Command Default 30 minutes

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

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

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

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

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

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

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

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

Cisco CMTS Cable Command Reference

1179
 Cable Commands: d through h
hccp reverttime

The Working CMTS first counts down two minutes of suspend time before starting to count down the
revert-time. Any failures that occur within this two-minute suspend time are considered part of the same
failure.
This means that the actual time that the Working CMTS will attempt to switch back after a switchover is two
minutes plus the revert-time. For example, if the revert-time is set to its default of 30 minutes, the Working
CMTS will attempt to switch back into operation 32 minutes after the initial switchover to the Protect CMTS.
After the suspend time has occurred, a failure in the Protect CMTS will cause a switchover to the Working
CMTS, regardless of whether the revert-time has expired or not. You can force such a failure in the Protect
CMTS, and restore the Working CMTS to operation without waiting for the revert-time, by using the cable
power off and cable power on commands to turn off and turn on the protect interface on the Protect CMTS.
When choosing a revert-time, take into account all possible sources of failures, including third-party equipment.
For example, an upconverter failure can trigger a switchover to the Protect CMTS. You should configure the
revert-time so that the Working CMTS does not switch back into operation until technicians have had sufficient
time to fix the equipment failure.

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

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

router(config)# interface cable 3/0

router(config-if)# hccp 2 reverttime 15

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

router(config)# interface cable 5/1/0

router(config-if)# no hccp 2 reverttime

Related Commands Command Description

hccp revertive Configures a cable interface on a Protect CMTS to automatically revert back to a
Working CMTS.

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

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

Cisco CMTS Cable Command Reference

1180
 Cable Commands: d through h
hccp switch

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

hccp group switch member

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

member The member number for the specified interface. Valid values are any number from 1 to 255, inclusive.

Command Default No default behavior or values

Command Modes
Privileged EXEC

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

12.2(4)XF1, 12.2(4)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC28C card.

12.2(8)BC2 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco
uBR-LCP-MC16S cards.

12.2(11)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR7246VXR
router and Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards.

12.2(11)BC3 This command is automatically disabled for approximately 2 to 3 seconds after a

PRE module switches over to allow the system to stabilize before performing
another switchover.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines This command overrides any configuration you may have made on your Protect CMTS and Working CMTS
using the hccp revert and hccp reverttime commands. In addition, you can issue the hccp switch command
on either a Protect CMTS or a Working CMTS to force it to change places with its peer.

Examples The following example shows the host Protect CMTS being configured to assume traffic responsibility
for member 2 Working CMTS in group 2:

Router# hccp 2 switch 2R

Cisco CMTS Cable Command Reference

1181
 Cable Commands: d through h
hccp switch

Related Commands Command Description

hccp lockout Prevents a Working CMTS from automatically switching to a Protect CMTS in the
same group.

hccp unlockout Negates the effects of the hccp lockout command, making the CMTS available for
automatic switchover from a Working CMTS to a Protect CMTS.

show hccp Displays information for all cable interfaces on which one or more HCCP groups and
authentication modes have been configured.

show hccp interface Displays group information for a specific cable interface on which one or more groups
and authentication modes have been configured.

Cisco CMTS Cable Command Reference

1182
 Cable Commands: d through h
hccp timers

hccp timers
To configure HELLO packet interval and hold time for a specified group on a Protect CMTS, use the hccp
timers command in cable interface configuration mode. To erase the HELLO interval and hold time
configuration and to assume the default values for each parameter, use the no form of this command.

Note Issuing the no form of this command erases any manual HELLO interval and hold time values and automatically
resets them to their default values.

hccp group timers hello-time hold-time

no hccp group timers [hello-time hold-time]

Syntax Description group The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

hello-time The HELLO packet interval (in milliseconds) between subsequent HELLO packet transmissions.
The acceptable range is 1666 to 5,000 milliseconds, inclusive.

hold-time The time (in milliseconds) that a Protect CMTS will wait before assuming control of voice traffic
for a Working CMTS that has failed to acknowledge a series of HELLO packets. The acceptable
range is 5,000 to 25,000 milliseconds, inclusive.

Command Default The default HELLO interval is 2,000 milliseconds, and the default hold time is 6,000 milliseconds.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

12.2(4)XF1, 12.2(4)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC28C card.

12.2(8)BC2 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco
uBR-LCP-MC16S cards.

12.2(11)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR7246VXR
router and Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Examples The following example shows the HELLO interval and hold time on a Protect CMTS in group 2
being configured to 1,750 and 3,000 milliseconds, respectively:

Cisco CMTS Cable Command Reference

1183
 Cable Commands: d through h
hccp timers

Router(config)# interval c4/0

Router(config-if)# hccp 2 timers 1750 3000

Related Commands Command Description

hccp protect Configures a particular cable interface to protect another peer cable interface in the
same group.

hccp working Configures a specified cable interface to be a working member of a given group.

show hccp Displays information for all cable interfaces on which one or more HCCP groups and
authentication modes have been configured.

show hccp interface Displays group information for a specific cable interface on which one or more groups
and authentication modes have been configured.

Cisco CMTS Cable Command Reference

1184
 Cable Commands: d through h
hccp track

hccp track
To configure a cable interface on a Working CMTS or Protect CMTS to enable automatic switchover based
on the interface state, use the hccp track command in cable interface configuration mode. To disable the
automatic switchover based on interface state, use the no form of this command.

hccp group track [interface]

no hccp group track [interface]

Syntax Description group The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

interface Specifies another cable interface (the default is the current cable interface).

Command Default Enabled for the current interface

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

12.2(4)XF1, 12.2(4)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC28C card.

12.2(8)BC2 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco
uBR-LCP-MC16S cards.

12.2(11)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR7246VXR
router and Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines This command enables automatic switchover of one interface when a tracked interface switches over from
“up” to “down.”
Typically, this command is used to allow all interfaces on one card to track one another, so that if one interface
goes down and switches over to the Protect, all other interfaces can also switch over, allowing the Protect
card to assume full operation for these interfaces. This allows support engineers to troubleshoot the problem
on the Working interface, or to remove and replace the Working card, if necessary, without interfering with
traffic.
Using hccp track with hccp revertive
As a general rule, if you are using the hccp track command on a cable interface, do not also configure the
hccp revertive command without also configuring no keepalive on the cable interface. Configuring both
commands on the same interface, along with keepalives, can cause multiple switchovers on the same fault.

Cisco CMTS Cable Command Reference

1185
 Cable Commands: d through h
hccp track

If you want to use keepalives along with both the hccp track and hccp revertive commands,use the hccp
track command on both the Working and Protect interfaces, so that the Working interfaces on the same card
track each other and the Protect interfaces on the same card track each other. The following table summarizes
the guidelines for using these three commands:

Table 31: Possible hccp track and hccp revertive Configurations

hccp track hccp track hccp revertive keepalive Configuration

(Working I/Fs) (Protect I/Fs)

Yes No No keepalive or no keepalive

Yes No Yes no keepalive

Yes Yes Yes keepalive or no keepalive

Examples The following example shows switchover behavior being enabled on a Cisco CMTS in group 2:

Router(config)# interface c3/0

Router(config-if)# hccp 2 track

Router(config-if)# keepalive
Router(config-if)#

The following example shows two Cisco uBR-LCP2-MC28C cards being used in a Cisco uBR10012
router, with each downstream being configured for a separate HCCP group. The card in slot 5/1 is
being configured as the Working interfaces and the card in slot 6/1 is being configured as the Protect
interfaces.
The two downstreams on each card track each other, so if one downstream fails and switches over,
the other can do so as well, allowing the Protect card to assume full control of both interfaces.
Similarly, when the Working interfaces come back into service, both Protect interfaces switch back
at the same time.

Router(config)# interface cable c5/1/0

Router(config-if)# hccp 1 working 1

Router(config-if)# hccp 1 track c5/1/1

Router(config-if)# keepalive 3

Router(config-if)# exit

Router(config)# interface cable c5/1/1

Router(config-if)# hccp 2 working 1

Router(config-if)# hccp 2 track c5/1/0

Router(config-if)# keepalive 3
Router(config-if)# exit

Router(config)# interface cable c6/1/0

Router(config-if)# hccp 1 protect 1

Cisco CMTS Cable Command Reference

1186
 Cable Commands: d through h
hccp track

ip-address-of-mgmt-lan

Router(config-if)# hccp 1 track c6/1/1

Router(config-if)# keepalive 3

Router(config-if)# exit
Router(config)# interface cable c6/1/1

Router(config-if)# hccp 2 protect 1

ip-address-of-mgmt-lan

Router(config-if)# hccp 2 track c6/1/0

Router(config-if)# keepalive 3

Router(config-if)#

Related Commands Command Description

keepalive A global configuration command that allows you to specify the keepalive message
transmission interval on a Working CMTS or Protect CMTS.

show hccp Displays information for all cable interfaces on which one or more HCCP groups and
authentication modes have been configured.

show hccp interface Displays group information for a specific cable interface on which one or more groups
and authentication modes have been configured.

Cisco CMTS Cable Command Reference

1187
 Cable Commands: d through h
hccp unlockout

hccp unlockout
To reverse the effects of the hccp lockout command—that is, to make a Working CMTS available for automatic
switchover to Protect CMTS, use the hccp unlockout command in privileged EXEC mode.

hccp group unlockout member

Syntax Description group The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

member The member number within the specified group.

Command Default By default, the hccp unlockout command is active for all groups and members.

Command Modes
Privileged EXEC

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

12.2(4)XF1, 12.2(4)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC28C card.

12.2(8)BC2 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco
uBR-LCP-MC16S cards.

12.2(11)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR7246VXR
router and Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines This command reverses the effect of the hccp lockout command. Once you have reconfigured or tested your
Protect CMTS, issuing this command manually reintroduces the CMTS back into your 1+1 redundancy
protection scheme.

Note This command is applicable only on a Working CMTS in a given group. Issuing this command on a Protect
CMTS has no effect.

Examples The following example shows the lockout feature of a Working CMTS in group 1 being deactivated:

hccp 1 unlockout

Cisco CMTS Cable Command Reference

1188
 Cable Commands: d through h
hccp unlockout

Related Commands Command Description

hccp lockout Prevents a Working CMTS from automatically switching to a Protect CMTS in the
same group.

show hccp Displays information for all cable interfaces on which one or more HCCP groups and
authentication modes have been configured.

show hccp interface Displays group information for a specific cable interface on which one or more groups
and authentication modes have been configured.

Cisco CMTS Cable Command Reference

1189
 Cable Commands: d through h
hccp working

hccp working
To designate a cable interface on a CMTS in the specified group to be a Working CMTS, use the hccp working
command in cable interface configuration mode. To remove a Working CMTS assignment, use the no form
of this command.

hccp group working member

no hccp group working member

Syntax Description group The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

member The member number for the specified interface. Valid values are any number from 1 to 255, inclusive.

Command Default No default behavior or values

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3a)EC This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1 Support was added for the Cisco uBR-MC16S cable interface line card.

12.2(4)XF1, 12.2(4)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC28C card.

12.2(8)BC2 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router
and Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco
uBR-LCP-MC16S cards.

12.2(11)BC1 Support was added for the N+1 (1:n) RF Switch with the Cisco uBR7246VXR
router and Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards.

IOS-XE 3.15.OS This command is not supported on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines When N+1 HCCP redundancy is configured, the Protect interface switches over and becomes the active
interface when it detects a situation similar to the following:
• The Working interface is removed from the chassis, is powered down, or is reset
• The Working interface crashes
• The Working interface no longer sends out regular keepalive messages
• The Working interface loses connectivity with the cable network
The Protect cable interface must be configured identically to the Working cable interface, which typically
means the interfaces should be the same card type. However, when the Cisco uBR-MC16S is used, it can be
used with either another Cisco uBR-MC16S card or a Cisco uBR-MC16C card.
The table below shows how a switchover affects the enhanced spectrum management features of the Cisco
uBR-MC16S card.

Cisco CMTS Cable Command Reference

1190
 Cable Commands: d through h
hccp working

Table 32: Switchover Operation for a Cisco uBR-MC16C/Cisco uBR-MC16S Configuration

Working Cable Protect Cable Operation After Switchover

Interface Interface

Cisco uBR-MC16C Cisco uBR-MC16S The protect card (Cisco uBR-MC16S) uses the same upstream
frequency as the working card, but after the system stabilizes,
the protect card begins using the enhanced spectrum
management features of the Cisco uBR-MC16S card, as
configured on the protect CMTS.

Cisco uBR-MC16S Cisco uBR-MC16C The protect card (Cisco uBR-MC16C) uses the same upstream
frequency as the working card. If the upstream becomes
unstable, the Cisco uBR-MC16C performs only blind frequency
hopping.

Cisco uBR-MC16S Cisco uBR-MC16S The protect card initially uses the same upstream frequency as
the working card, but after the system stabilizes, the protect
card continues using the enhanced spectrum management
features of the Cisco uBR-MC16S card.

Examples The following example shows cable interface 4/0 being designated as a Working CMTS interface
as member number 2 of group 2:

Router(config)# interface cable 4/0

Router(config-if)# hccp 2 working 2

Related Commands Command Description

hccp protect Configures a particular cable interface to protect another cable interface in the same
group.

show hccp Displays information for all cable interfaces on which one or more HCCP groups and
authentication modes have been configured.

show hccp interface Displays group information for a specific cable interface on which one or more groups
and authentication modes have been configured.

Cisco CMTS Cable Command Reference

1191
 Cable Commands: d through h
hw-module bay reload

hw-module bay reload

To reload the software and restart a SPA, use the hw-module bay reload command in privileged EXEC mode.

Cisco IOS Releases 12.3(23)BC and 12.2(33)SCA

hw-module bay slot/subslot/bay reload

Cisco IOS Release 12.2(33)SCB

hw-module bay slot/bay/port reload

Syntax Description slot The slot where a SIP resides. On the Cisco uBR10012 router, slots 1 and 3 can be used for SIPs.

subslot The subslot where a SIP resides. On the Cisco uBR10012 router, subslot 0 is always specified.

bay The bay in a SIP where a SPA is located. Valid values are 0 (upper bay) and 1 (lower bay).

port Specifies the interface number on the SPA.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

12.2(33)SCB This command was modified to change the addressing format for a SPA from
slot/subslot/bay to slot/bay/port.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The hw-module bay reload command reloads the software and restarts a SPA.

Examples The following example shows how to reload the software for the Cisco Wideband SPA in slot 1,
subslot 0, and bay 1.

Router# hw-module bay 1/0/1 reload

Router#

Related Commands Command Description

hw-module shutdown Shuts down a PRE1 module, line card, SIP, or SPA.

Cisco CMTS Cable Command Reference

1192
 Cable Commands: d through h
hw-module shutdown (ubr10012)

hw-module shutdown (ubr10012)

To shut down a particular Performance Routing Engine (PRE1) module, line card, Wideband SIP or Wideband
SPA, use the hw-module shutdown (ubr10012) command in global configuration mode. To activate a specific
PRE1, line card, Wideband SIP or Wideband SPA, use the no form of this command.

hw-module {main-cpu | pre {A | B} | sec-cpu | slot slot-number | subslot slot/subslot | bay

slot/subslot/bay}shutdown [unpowered]
nohw-module {main-cpu | pre {A | B} | sec-cpu | slot slot-number | subslot slot/subslot | bay
slot/subslot/bay}shutdown [unpowered]

Syntax Description main-cpu Shuts down the PRE1 module that is currently acting as the active PRE1 module.

pre {A|B} Shuts down the PRE1 module that is physically in either PRE slot A (left slot) or PRE
slot B (right slot).

sec-cpu Shuts down the PRE1 module that is currently acting as the standby PRE1 module.

slot slot-number Shuts down the line cards that are physically present in the specified slot-number (valid
range is 1 to 8).

subslot slot/subslot Shuts down the line card or SIP that is physically present in the slot with the specified
slot and subslot numbers. The following are the valid values:
• slot = 1 to 8
• subslot = 0 or 1

bay Shuts down the SPA in the location specified by the slot/subslot/bay argument. The
slot/subslot/bay following are the valid values:
• slot = 1 to 3
• subslot = 0 or 1 (0 is always specified)
• bay = 0 (upper bay) or 1 (lower bay)

unpowered Used with the Wideband SPA, shuts down the SPA and its interfaces, and leaves them
in an administratively down state without power.

Command Default No default behavior or values

Command Modes
Global configuration

Command History Release Modification

12.2(4)XF This command was introduced for the Cisco uBR10012 router.

12.3(21)BC Support was added for the Cisco Wideband SIP and Cisco 1-Gbps Wideband SPA.

Cisco CMTS Cable Command Reference

1193
 Cable Commands: d through h
hw-module shutdown (ubr10012)

Usage Guidelines The hw-module shutdown (ubr10012) command shuts down in a controlled manner a particular Performance
Routing Engine (PRE1) module, line card, Wideband SIP or Wideband SPA. To activate a specific PRE1,
line card, Wideband SIP, or Wideband SPA, use the no form of this command.

Caution Shutting down the active PRE1 module will trigger a switchover, so that the standby PRE1 module becomes
the active PRE1 module.

Examples The following example shows the standby PRE1 module being shut down:

Router(config)# hw-module sec-cpu shutdown

Router(config)#

The following example shows the active PRE1 module being shut down (which will trigger a
switchover to the standby PRE1 module):

Router(config)# hw-module main-cpu shutdown

Router(config)#

The following example shows the PRE1 module in PRE1 slot B being shut down:

Router(config)# hw-module pre B shutdown

Router(config)#

Note The hw-module pre B shutdown command shuts down the PRE1 module that is physically present
in slot B, regardless of whether the module is the active or standby PRE1 module.

The following example shows how to deactivate and verify deactivation for the Cisco Wideband
SPA located in slot 1, subslot 0, bay 0. In the output of the show hw-module bay oir command,
notice the “admin down” in the Operational Status field.

Router# configure terminal

Router(config)# hw-module bay 1/0/0 shutdown unpowered
%SPAWBCMTS-4-SFP_MISSING: Wideband-Cable 1/0/0, 1000BASE-SX SFP missing from port 0
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:1, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:2, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:3, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:4, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:5, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:6, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:7, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:8, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:9, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:10, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:11, changed state to down
...
Router# show hw-module bay 1/0/0 oir
Module Model Operational Status
-------------- ------------------ -------------------------
bay 1/0/0 SPA-24XDS-SFP admin down

Cisco CMTS Cable Command Reference

1194
 Cable Commands: d through h
hw-module shutdown (ubr10012)

The following example shows how to activate and verify activation for the Cisco Wideband SPA
located in slot 1, subslot 0, bay 0. In the output of the show hw-module bay oir command, notice
the “ok” in the Operational Status field.

Router# configure terminal

Router(config)# no hw-module bay 1/0/0 shutdown
%SPAWBCMTS-4-SFP_OK: Wideband-Cable 1/0/0, 1000BASE-SX SFP inserted in port 0
%SPAWBCMTS-4-SFP_LINK_OK: Wideband-Cable 1/0/0, port 0 link changed state to up
%SNMP-5-LINK_UP: LinkUp:Interface Wideband-Cable1/0/0:0 changed state to up
%LINK-3-UPDOWN: Interface Cable1/0/0:0, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:1, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:2, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:3, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:4, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:5, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:6, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:7, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:8, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:9, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:10, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:11, changed state to up
%LINEPROTO-5-UPDOWN: Line protocol on Interface Wideband-Cable1/0/0:0, changed state to up
...
Router# show hw-module bay 1/0/0 oir
Module Model Operational Status
-------------- ------------------ -------------------------
bay 1/0/0 SPA-24XDS-SFP ok

Related Commands Command Description

hw-module reset Resets a PRE1 module or line card.

hw-module reload Reloads the software in and restarts a Cisco 1-Gbps Wideband SPA.

redundancy force-failover main-cpu Forces a manual switchover between the active and standby PRE1
modules.

Cisco CMTS Cable Command Reference

1195
 Cable Commands: d through h
hw-module slot

hw-module slot
To control a component in a slot, use the hw-module slot command in Privileged EXEC mode.

hw-module slot slot-inumber{ {logging onboard { disable | enable } } | { reload [ force ] }

| {start } | {stop [force ] } }

Syntax Description slot-number The line cards that are physically present in the specified slot. Valid range is 0 to 9, F0 to F1
and R0 to R1.

logging Specifies the logging commands.

onboard Specifies the onboard commands.

disable Disables the onboard logging commands.

enable Enables the onboard logging commands.

reload Restarts the line card.

force Proceeds without prompting for a confirmation.

start Activates the line card in the slot.

stop Deactivates the line card in the slot.

Command Default No default behavior or values.

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.16.OS

Usage Guidelines Use the hw-module slot command to power-on, shutdown and power-cycle the line card.

Examples The following example shows the status of line card in slot 4:
Router# show logging onboard slot 4 status
Status: Disabled

The following example shows how to enable onboard logging commands on line card in slot 2:

Router# hw-module slot 4 logging onboard enable

The following example shows how to reload a line card in slot 1:

Cisco CMTS Cable Command Reference

1196
 Cable Commands: d through h
hw-module slot

Warning All modems will go offline and all the services will be impacted.

Router# hw-module slot 4 reload

The following example shows how to start a line card in slot 2:

Router# hw-module slot 4 start

The following example shows how to stop a line card in slot 3:

Warning All modems will go offline and all the services will be impacted.

Router# hw-module slot 4 stop

Related Commands Command Description

show platform Displays platform information.

Cisco CMTS Cable Command Reference

1197
 Cable Commands: d through h
hw-module slot pos

hw-module slot pos

To configure a line card slot for Packet over SONET (POS) operation, use the hw-module slot pos command
in privileged EXEC mode. To remove the configuration for a line card slot, use the no form of this command.

hw-module slot slot-number pos

no hw-module slot slot-number pos

Syntax Description slot-number Resets the line cards that are physically present in the specified slot-number (valid range is 1
to 8).

Command Default None

Command Modes
Privileged EXEC

Command History Release Modification

12.2(11)BC3 This command was introduced for the Cisco uBR10012 OC-48 Dynamic Packet Transport
(DPT) Interface Module for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You must first use the hw-module slot pos command to preconfigure a line card slot for POS operation of
the Cisco uBR10012 OC-48 DPT card before you can configure the card with any further commands. You
must also use the card 1oc48dpt/pos-1 command to configure the card slot for the proper card type.

Note If you have previously used the hw-module slot srp command to configure line card slots for Spatial Reuse
Protocol (SRP) operation, you must first cancel that configuration using the no hw-module slot srp command
before you can configure the slots for POS operation using the hw-module slot pos command.

Examples The following example shows the Cisco uBR10012 OC-48 DPT line card in slot 3 being configured
for POS operation:

Router# hw-module slot 3 pos

Router# card 3/0 1oc48dpt/pos-1

The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 3 and 4 being
reconfigured from SRP operation to POS operation:

Router# no hw-module slot 3 srp

Router# no hw-module slot 4 srp

Router# hw-module slot 3 pos

Cisco CMTS Cable Command Reference

1198
 Cable Commands: d through h
hw-module slot pos

Router# card 3/0 1oc48dpt/pos-1

Router# hw-module slot 4 pos

Router# card 4/0 1oc48dpt/pos-1

Related Commands Command Description

hw-module reset Resets a PRE1 module or line card.

hw-module shutdown (ubr10012) Shuts down a PRE1 module or line card.

hw-module slot srp Configures a line card slot for SRP operation.

Cisco CMTS Cable Command Reference

1199
 Cable Commands: d through h
hw-module slot srp

hw-module slot srp

To configure a line card slot for Spatial Reuse Protocol (SRP) operation, use the hw-module slot srp command
in privileged EXEC mode. To remove the configuration for a line card slot, use the no form of this command.

hw-module slot slot-number srp

no hw-module slot slot-number srp

Syntax Description slot-number Resets the line cards that are physically present in the specified slot-number (valid range is 1
to 8).

Command Default None

Command Modes
Privileged EXEC

Command History Release Modification

12.2(11)BC3 This command was introduced for the Cisco uBR10012 OC-48 Dynamic Packet Transport
(DPT) Interface Module for the Cisco uBR10012 router.

12.2(33)SCB This command is obsolete.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You must first use the hw-module slot srp command to preconfigure a line card slot for SRP operation of a
pair of Cisco uBR10012 OC-48 DPT cards before you can configure the cards with any further commands.
You must also use the card 1oc48dpt/pos-1 command to configure each card slot for the proper card type.

Tip The Cisco uBR10012 OC-48 DPT line cards support SRP operation only when installed in adjacent odd- and
even-numbered slots (such as slots 1 and 2 or 3 and 4). You need to use the hw-module slot srp command
only for the lower-numbered (odd-numbered) slot to preconfigure both slots of the SRP pair.

Note If you have previously used the hw-module slot pos command to configure line card slots for Packet over
SONET (POS) operation, you must first cancel that configuration using the no hw-module slot pos command
before you can configure the slots for POS operation using the hw-module slot srp command.

Examples The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 1 and 2 being
configured for POS operation:

Router# hw-module slot 1 srp

Router# card 1/0 1oc48dpt/pos-1

Cisco CMTS Cable Command Reference

1200
 Cable Commands: d through h
hw-module slot srp

Router# card 2/0 1oc48dpt/pos-1

The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 3 and 4 being
reconfigured from POS operation to SRP operation:

Router# no hw-module slot 3 pos

Router# no hw-module slot 4 pos

Router# hw-module slot 3 srp
Router# card 3/0 1oc48dpt/pos-1

Router# card 4/0 1oc48dpt/pos-1

Related Commands Command Description

hw-module reset Resets a PRE1 module or line card.

hw-module shutdown (ubr10012) Shuts down a PRE1 module or line card.

hw-module slot pos Configures a line card slot for POS operation.

Cisco CMTS Cable Command Reference

1201
 Cable Commands: d through h
hw-module subslot

hw-module subslot
To control a component in subslot, use the hw-module subslot command in Privileged EXEC mode.

hw-module subslot card slot/subslot number { {reload [ force ] } | {start } | {stop [force ] }
}

Syntax Description reload Restarts the targeted subslot.

force Proceeds without prompting for a confirmation.

start Activates the targeted subslot.

stop Deactivates the targeted subslot.

Command Default No default behavior or values.

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.16.OS

Usage Guidelines Use the hw-module subslot command to enable, stop and restart the RF-PICs after upgrading the RF-PIC
firmware. This command does not support SUP-PIC command.

Examples The following example shows how to force reload a line card present in subslot 1:

Warning All modems will go offline and all the services will be impacted.

Router# hw-module subslot 0/1 reload force

The following example shows how to start a line card in subslot 2:

Router# hw-module subslot 0/2 start

The following example shows how to force stop a line card in subslot 3:

Warning All modems will go offline and all the services will be impacted.

Router# hw-module subslot 0/3 stop force

Cisco CMTS Cable Command Reference

1202
 Cable Commands: d through h
hw-module subslot

Related Commands Command Description

show platform Displays platform information.

Cisco CMTS Cable Command Reference

1203
 Cable Commands: d through h
hw-module subslot

Cisco CMTS Cable Command Reference

1204
Cable Commands: i through p
• identifier, on page 1209
• init-tech-list, on page 1210
• init-tech-ovr, on page 1211
• interface cable, on page 1213
• interface cable-modem, on page 1215
• interface integrated-cable, on page 1217
• interface modular-cable, on page 1219
• interface port-channel, on page 1221
• interface virtualportgroup, on page 1223
• interface wideband-cable, on page 1224
• interleaver-depth (QAM profile), on page 1227
• interleaver-depth (OFDM channel profile), on page 1229
• interval, on page 1230
• ip (virtual-arpd), on page 1231
• ip (virtual-om), on page 1232
• ip address, on page 1233
• ip address docsis, on page 1234
• ip-address (controller), on page 1236
• ip dhcp ping packet 0, on page 1238
• ip dhcp pool, on page 1241
• ipdr associate, on page 1244
• ipdr authorization , on page 1246
• ipdr collector, on page 1247
• ipdr exporter ack-timeout, on page 1249
• ipdr exporter connection active, on page 1250
• ipdr exporter keepalive, on page 1251
• ipdr exporter max-unacked, on page 1252
• ipdr exporter start, on page 1253
• ipdr session, on page 1254
• ipdr session (global configuration), on page 1255
• ipdr template, on page 1257
• ipdr type, on page 1260
• ipv6 address, on page ?

Cisco CMTS Cable Command Reference

1205
 Cable Commands: i through p

• issu linecard abortversion, on page 1263

• issu linecard acceptversion, on page 1265
• issu linecard changeversion, on page 1266
• issu linecard loadversion, on page 1268
• issu linecard prepareversion, on page 1269
• issu linecard process stop, on page 1271
• issu linecard reloadversion, on page 1273
• issu linecard runversion, on page 1275
• jitter, on page 1276
• join-group, on page 1277
• keepalive, on page 1278
• lacp fast-switchover, on page 1279
• lacp max-bundle, on page 1280
• lacp min-bundle, on page 1281
• lacp port-priority, on page 1282
• lacp system-priority, on page 1284
• lane start-freq, on page 1285
• lc-control-plane-timeout, on page 1286
• lc-us-scheduler-timeout, on page 1287
• lcha-preferred, on page 1288
• license feature evaluation disable, on page 1289
• license feature evaluation enable, on page 1291
• linecard, on page 1293
• linecard-group (redundancy), on page 1295
• listening-port, on page 1296
• logging cmts ipc-cable, on page 1297
• logging cmts sea, on page 1299
• logical-edge-device, on page 1301
• load-interval, on page 1302
• low-latency, on page 1303
• mac-addr-filter, on page 1304
• mac-address, on page 1305
• mgmt-intf virtualportgroup, on page 1307
• main-cpu, on page 1308
• maintenance-mode, on page 1310
• match, on page 1312
• match rule, on page 1313
• max-carrier, on page 1315
• max-comp-time, on page 1316
• max-ofdm-spectrum, on page 1318
• max-streams, on page 1319
• member slot , on page 1321
• method, on page 1323
• mgmt-ip, on page 1325
• mgmt-ip (DVB), on page 1327
• microcode (uBR10012), on page 1328

Cisco CMTS Cable Command Reference

1206
Cable Commands: i through p

• microcode reload (uBR10012), on page 1330

• min-cp-duration, on page 1332
• mode, on page 1334
• modular-host subslot, on page 1336
• modulation, on page 1338
• monitoring-basics, on page 1339
• monitoring-duration, on page 1341
• mute, on page 1344
• multicast-label, on page 1345
• multicast-pool, on page 1346
• multicast-uplink, on page 1347
• name, on page 1348
• nc, on page 1349
• network, on page 1350
• network-delay, on page 1352
• nls, on page 1353
• nls ag-id auth-key, on page 1354
• nls resp-timeout, on page 1355
• ofdm-freq-excl-band, on page 1356
• ofdm channel-profile, on page 1357
• onid, on page 1358
• oui, on page 1359
• output-rate, on page 1360
• override, on page 1362
• overrule, on page 1363
• overwrite-scg, on page 1365
• packetcable, on page 1366
• packetcable authorize vanilla-docsis-mta, on page 1368
• packetcable element-id, on page 1370
• packetcable gate maxcount, on page 1372
• packetcable gate send-subscriberID, on page 1374
• packetcable multimedia, on page 1375
• packetcable timer, on page 1376
• pcr-based-source-switch, on page 1378
• peak-time1, on page 1379
• penalty-period, on page 1383
• periodic-rel-pxf enable, on page 1387
• ping docsis, on page 1388
• ping docsis pnm, on page 1393
• platform power protection, on page 1394
• platform punt-policer, on page 1396
• platform punt-sbrl, on page 1398
• platform aom pending-thresh, on page 1401
• pilot-scaling, on page 1402
• pme cem, on page 1403
• pme mgmt-ip, on page 1405

Cisco CMTS Cable Command Reference

1207
 Cable Commands: i through p

• pme vodsid, on page 1406

• policy, on page 1407
• power-adjust, on page 1408
• power-tilt, on page 1409
• prefix, on page 1410
• principal, on page 1412
• privacy, on page 1413
• profile, on page 1415
• profile-control, on page 1416
• profile-data, on page 1418
• profile-description, on page 1420
• profile-ncp, on page 1421
• protect-tunnel, on page 1422
• protocol, on page 1423
• provider-name, on page 1424
• psi-interval, on page 1425
• show ptp clock running, on page 1426
• pxf-fail-switchover-trap enable, on page 1427

Cisco CMTS Cable Command Reference

1208
 Cable Commands: i through p
identifier

identifier
To configure the MAC address of the RPD, use the identifier command in RPD configuration mode. To void
the MAC address configuration, use the no form of this command.

identifier mac_address

no identifier

Syntax Description mac_address Specifies the MAC address of the RPD.

Command Default None

Command Modes RPD configuration (config-rpd)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the MAC address of the RPD.

The following example shows how to configure the MAC address of the RPD:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# identifier 0004.9f03.0214

Related Commands Command Description

cable rpd Enters the RPD configuration mode.

Cisco CMTS Cable Command Reference

1209
 Cable Commands: i through p
init-tech-list

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 Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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 terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# init-tech-list 1 ucc
Router(config-lb-group)#

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1210
 Cable Commands: i through p
init-tech-ovr

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 cableslot/subslot/port upstream cable slot/subslot/port upstreaminit-tech-listinit-tech-list0 -4
[ucc]

Cisco uBR7225VXR and Cisco uBR7246VXR Routers

init-tech-ovr cableslot/subslot/port upstream cable slot/subslot/port upstreaminit-tech-listinit-tech-list0 -4
[ucc]

Syntax Description cable slot/subslot/port Specifies the CMTS interface slot, subslot, port number, and upstream parameters
upstream that are to be overridden.
• slot—Slot where the line card resides. The permitted range is from 5 to 8.
• subslot—Subslot where the line card resides. The available slots are 0 or
1.
• port—The downstream controller number on the line card. The permitted
port range is from 0 to 4.

cable slot/subslot/port Specifies the CMTS interface slot, subslot, port number, and upstream channel
upstream ID parameters that will override the CMTS interface and upstream channel.

cable slot/port upstream Specifies the CMTS interface slot, port number, and upstream parameters that
are to be overridden.
• slot—Slot where the line card resides.
• Cisco uBR7225VXR router—The valid range is from 1 to 2.
• Cisco uBR7246VXR router—The valid range is from 3 to 6.
• port—Downstream controller number on the line card. The permitted port
values are 0 or 1.

cable slot/port upstream Specifies the CMTS interface slot, port number, and upstream parameters that
will override the CMTS interface and upstream channel.

init-tech-list 0-4 Specifies the DCC initialization technique list ranging from 0 to 4 for the upstream
channel pair.

ucc Determines whether Upstream Channel Change (UCC) can be used for modems
during dynamic upstream load balancing.

Command Default None

Command Modes
DOCSIS load balancing group mode (config-lb-group)

Cisco CMTS Cable Command Reference

1211
 Cable Commands: i through p
init-tech-ovr

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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 terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group
1
Router(config-lb-group)# init-tech-ovr cable
1/0 1 cable
1/1 2 1

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1212
 Cable Commands: i through p
interface cable

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 slot Slot where the line card resides.

• Cisco uBR7225VXR router—The valid value is 1 or 2.
• Cisco uBR7246VXR router—The valid range is from 3 to 6.
• Cisco uBR10012 router—The valid range is from 5 to 8.
• Cisco cBR Series Converged Broadband Routers— The valid range is from 0 to
3 and from 6 to 9.

subslot (Cisco uBR10012 only) Secondary slot number of the cable interface line card. The
valid subslots are 0 or 1.
For Cisco cBR Series Converged Broadband Routers, the valid value is 0.

port Downstream port number.

• Cisco uBR7225VXR router and Cisco uBR7246VXR router—The valid value is
0 or 1.
• Cisco uBR10012 router—The valid range is from 0 to 4 (depending on the cable
interface).

cable-interface-index Downstream port of the Cisco uBR10-MC5X20 and Cisco uBR-MC28 line cards, or
MAC domain index of the Cisco uBR-MC20X20V and Cisco uBR-MC3GX60V line
cards.
Cisco uBR7225VXR and Cisco uBR7246VXR routers—The valid port value is 0 or
1.
Cisco uBR10012 router—The valid range for the Cisco uBR-MC20X20V and Cisco
uBR-MC5X20 line cards is from 0 to 4. The valid range for the Cisco uBR-MC3GX60V
line card is from 0 to 14.
Cisco cBR Series Converged Broadband Routers— The valid range is from 0 to 15.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced.

12.3(23)BC This command was integrated into Cisco IOS Release 12.3(23)BC.

Cisco CMTS Cable Command Reference

1213
 Cable Commands: i through p
interface cable

Release Modification

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

12.2(33)SCB This command was integrated into Cisco IOS Release 12.2(33)SCB.

12.2(33)SCD This command was modified to support Cisco uBR7225VXR and Cisco uBR7246VXR
routers.

12.2(33)SCE This command was modified. The port parameter was changed to cable-interface-index
to indicate the MAC domain index for the Cisco uBR-MC20X20V and Cisco
uBR-MC3GX60V cable interface line cards.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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 terminal

Router(config)# interface cable 5/0

The following example shows how to configure a cable interface in slot 8, subslot 0, and port 0 on
a Cisco uBR10012 router:

Router# configure terminal

Router(config)# interface cable 8/0/0

The 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 terminal

Router(config)# interface cable 5/0/13

The following example shows how to configure a Cisco uBR-MC3GX60V cable interface line card
in slot 1, subslot 0, and cable interface index 13 (MAC domain index) on a Cisco cBR Series
Converged Broadband Routers:

Router# configure terminal

Router(config)# interface cable 1/0/13

Related Commands Command Description

interface integrated-cable Specifies a integrated cable interface.

interface modular-cable Specifies a modular cable interface.

interface wideband-cable Specifies a wideband cable interface.

Cisco CMTS Cable Command Reference

1214
 Cable Commands: i through p
interface cable-modem

interface cable-modem
To enter interface configuration mode for the cable interface on a router, use the interface cable-modem
command in global configuration mode.

Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
interface cable-modem number

Syntax Description number Identifies the cable interface (always 0).

Command Default Disabled

Command Modes
Global configuration

Command History Release Modification

11.3(4)NA This command was introduced for the Cisco uBR904 cable access router.

12.0(4)XI1 Support was added for the Cisco uBR924 cable access router.

12.1(3)XL Support was added for the Cisco uBR905 cable access router.

12.1(5)XU1 Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA Support was added for the Cisco uBR925 cable access router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines When this command is used, the router switches from global configuration mode to interface configuration
mode.

Examples The following example shows how to enter interface configuration mode for the router’s cable
interface and then to enter the available interface configuration commands:

Router(
config)#
interface cable-modem
0
Router(config-if)# cable-modem ?
compliant Enter compliant modes for interface
downstream Downstream channel characteristics
fast-search Enable/disable the DS fast search
upstream upstream channel characteristics
voip Options for Voice over IP traffic over the cable interface
Router(config-if)#

Related Commands Command Description

cable-modem compliant bridge Enables DOCSIS-compliant bridging on the cable interface.

Cisco CMTS Cable Command Reference

1215
 Cable Commands: i through p
interface cable-modem

Command Description

cable-modem downstream saved channel Modifies the saved downstream channel setting and upstream
power value on the cable interface.

cable-modem upstream preamble qpsk Enables the QPSK modulation scheme in the upstream direction
from the cable interface to the CMTS.

cable-modem voip best-effort Allows voice traffic to be transmitted on the upstream using a
best-effort QoS.

Cisco CMTS Cable Command Reference

1216
 Cable Commands: i through p
interface integrated-cable

interface integrated-cable
To configure integrated cable interface on a cable interface line card, 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/subslot/port:rf-channel

Cisco cBR Series Converged Broadband Routers

interface integrated-cable slot/subslot/port:rf-channel

Syntax Description slot Identifies the chassis slot where the cable interface line card resides.
• Cisco uBR10012 router—The valid range is from 5 to 8.
• Cisco uBR7225VXR router—The valid value is 1 or 2.
• Cisco uBR7246VXR router—The valid range is from 3 to 6.
• Cisco cBR Series Converged Broadband Routers— The valid range is from 0 to 3 and 6 to
9.

subslot (Cisco uBR10012 only) Secondary slot number of the cable interface line card. The valid subslots
are 0 or 1.
For Cisco cBR Series Converged Broadband Routers, the valid subslot is 0.

port Downstream port number.

• Cisco uBR7225VXR router and Cisco uBR7246VXR router—The valid value is 0 or 1.
• Cisco uBR10012 router—The valid range is from 0 to 4.
• Cisco cBR Series Converged Broadband Routers— The valid range is from 0 to 7.

rf-channel RF channel number. The valid range is from 0 to 162.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS-XE This command was modified on the Cisco cBR Series Converged Broadband Routers.
3.18.0SP The rf-channel range is 0 to 162 now.

Usage Guidelines The interface integrated-cable command is used to configure the following line cards:

Cisco CMTS Cable Command Reference

1217
 Cable Commands: i through p
interface integrated-cable

• Configuring the Cisco uBR-MC20X20V Cable Interface Line Card

• Configuring the Cisco uBR-MC88V Cable Interface Line Card
The interface integrated-cable command is supported on Cisco cBR Converged Broadband Routers and
also 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 terminal

Router(config)# interface integrated-cable 7/0/0:1

Related Commands Command Description

show interface integrated-cable Displays the current configuration and status for an integrated channel.

Cisco CMTS Cable Command Reference

1218
 Cable Commands: i through p
interface modular-cable

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-cableslot/subslot/bay:nb-channel-number

Cisco IOS Release 12.2(33)SCB

interface modular-cableslot/subslot/bay:nb-channel-number

Cisco IOS Release 12.2(33)SCE

interface modular-cableslot/subslot/bay:nb-channel-number

Syntax Description slot Identifies the chassis slot where the Cisco Cable line card, or Cisco Wideband Shared
Port Adaptor (SPA) is located.
• For the Cisco Cable line cards, the valid range is from 5 to 8.
• For the Cisco Wideband SPA, the valid values are:
• slot—1 or 3 (for SIP-600)
• slot—1 (for Wideband SIP)

Note
In Cisco IOS Release 12.2(33)SCE, support for configuring modular-cable interface
on the Cisco uBR-MC3GX60V cable line card is introduced.

subslot Identifies the subslot where the Cisco Cable line card is located.
• For the Cisco Cable line cards, the valid value is 0 or 1.
Note
In Cisco IOS Release 12.2(33)SCE, support for configuring modular-cable interface
on the Cisco uBR-MC3GX60V cable line card is introduced.

bay Identifies the bay where the Cisco Wideband SPA is located.
The valid range is from 0 to 3.

port Identifies the port on the Cisco Cable line card, or the Cisco Wideband SPA in the
specified slot/subslot or slot/bay.
• For the Cisco UBR-MC20X20V cable interface line card, the valid range for is
from 0 to 5.
• For the Cisco uBR-MC3GX60V cable interface line card, the valid range is from
0 to 2.
• For the Cisco Wideband SPA, the valid value is 0.

nb-channel-number Identifies the narrowband channel number.

interface-number Identifies the modular-cable interface number. The valid range is from 0 to 23.

Cisco CMTS Cable Command Reference

1219
 Cable Commands: i through p
interface modular-cable

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced.

12.3(23)BC This command was integrated into Cisco IOS Release 12.3(23)BC.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

12.2(33)SCB This command was modified to change the addressing format for the modular cable interface
from slot/subslot/bay:nb-channel-number to slot/bay/port:nb-channel-number.

12.2(33)SCE Support for configuring modular-cable interface on the Cisco uBR-MC3GX60V cable line
card was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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 terminal

Router(config)# interface modular-cable 1/3/0:23

The 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 terminal

Router(config)# interface modular-cable 5/1/2:0

Related Commands Command Description

cable attribute-mask Specifies an attribute mask value for a modular cable interface.

interface wideband-cable Specifies a wideband cable interface.

interface cable Specifies a cable interface.

Cisco CMTS Cable Command Reference

1220
 Cable Commands: i through p
interface port-channel

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.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(11)BC3 This command was introduced on the Cisco uBR7246VXR router.

12.2(9a)BC This command was introduced on the Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The first EtherChannel interface configured becomes the bundle primary 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 primary by default.
Repeat this configuration on every EtherChannel port to be bundled into:
• FastEtherChannel (FEC) or GigabitEtherChannel (GEC) group on the Cisco uBR10012 and Cisco
uBR7200 series routers.
• Ten Gigabit EtherChannel (Ten GEC) group on the Cisco cBR series routers.

This configuration must be present on all EtherChannel interfaces before the EtherChannel group can be
configured.

Examples The following example configures the port to have an EtherChannel port number of 1 within its
EtherChannel group. The EtherChannel group is defined with the channel-group command.

Router(config-if)# interface port-channel 1

Related Commands Command Description

channel-group Assigns an EtherChannel port to an EtherChannel group.

Cisco CMTS Cable Command Reference

1221
 Cable Commands: i through p
interface port-channel

Command Description

show interface port-channel Displays the EtherChannel interfaces and channel identifiers, with their mode
and operational status.

Cisco CMTS Cable Command Reference

1222
 Cable Commands: i through p
interface virtualportgroup

interface virtualportgroup
To configure a VirtualPortGroup interface, use the interface command in the global configuration mode. To
delete the VirtualPortGroup created, use the no form of the command.

interface virtualportgroup number

no interface virtualportgroup number

Syntax Description number Specifies the Virtual Port Group number. Valid range is 0 to 31.

Command Default None.

Command Modes Global configuration mode (config)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to configure a VirtualPortGroup interface. If a VirtualPortGroup interface is configured,
you will need to assign a primary IP address to it. You can also configure a secondary IP address on the
VirutalPortGroup interface, similar to a gigabit Ethernet interface IP address configuration. You can assign
only one secondary IP address.

The following example shows how to configure a VirtualPortGroup interface:

Router#configure terminal
Router(config)#interface VirtualPortGroup0
Router(config-if)#ip address 1.23.2.1 255.255.255.0
Router(config-if)#ip address 1.23.2.2 255.255.255.0 secondary
Router(config-if)#end

Related Commands Command Description

mgmt-intf Define a cable video management interface.

show run interface VirtualPortGroup Displays the VirtualPortGroup interface configuration.

show run | include mgmt-intf Displays the cable video management interface configuration.

show interfaces VirtualPortGroup Displays the VirtualPortGroup interface state.

Cisco CMTS Cable Command Reference

1223
 Cable Commands: i through p
interface wideband-cable

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 Releases 12.3(21)BC, 12.3(23)BC, and 12.2(33)SCB

interface wideband-cable slot/bay/port:wideband-channel

Cisco IOS Releases 12.3(21)BC, 12.3(23)BC, and 12.2(33)SCC

interface wideband-cable slot / {subslotbay}/port:wideband-channel

Cisco IOS Releases 12.3(21)BC, 12.3(23)BC, and 12.2(33)SCE

interface wideband-cable slot /subslot/controller:wideband-channel

Cisco uBR7225VXR and Cisco uBR7246VXR Universal Broadband Routers

Cisco IOS Releases 12.3(21)BC, 12.3(23)BC, and 12.2(33)SCD

interface wideband-cable slot //port:wideband-channel

Cisco cBR Series Converged Broadband Routers

interface wideband-cable slot /subslot/controller:wideband-channel

Syntax Description slot The slot where a SIP or cable line card resides.
• Cisco uBR7246VXR router—The valid range is from 3 to 6.
• Cisco uBR7225VXR router—The valid range is from 1 to 2.
• Cisco uBR10012 router—The valid range for:
• Cable line card is from 5 to 8
• SIP is 1 and 3
• Cisco cBR Series Converged Broadband Routers— The valid range is from 0 to 3
and 6 to 9.

subslot The subslot where a SIP or cable line card resides.

• Cisco uBR10012 router—The valid value for:
• Cable line card in slot 5 to 8 is 0 or 1
• SPAs in a SIP in slot 1 or 3, prior to Cisco IOS Release 12.2(33)SCB is 0 or 1.
For Cisco IOS Release 12.2(33)SCB and later, subslot is not specified.
• For Cisco cBR Series Converged Broadband Routers, the valid subslot is 0.

bay The bay in a SIP where a SPA is located. The valid range is from 0 to 3.

Cisco CMTS Cable Command Reference

1224
 Cable Commands: i through p
interface wideband-cable

controller Controller index for the modular cable. The valid range is from 0 to 2.
For Cisco cBR Series Converged Broadband Routers, the valid range is from 0 to 7.

port Specifies the port number.

• Cisco uBR7246VXR router and Cisco uBR7225VXR router—The valid range is
from 0 to 1.
• Cisco uBR10012 router—The valid value for:
• Slot 1 and 3 is 0
• Slot 5 to 8 is from 0 to 4

wideband-channel Represents the wideband channel number.

• Cisco uBR10012 router—The valid range for:
• Cisco UBR-MC20X20V cable interface line card is from 0 to 5.
• Cisco uBR-MC3GX60V cable interface line card and SPAs is from 0 to 31.
• Cisco uBR7246VXR and Cisco uBR7225VXR routers—The valid range is from 0
to 5.
• Cisco cBR Series Convereged Broadband Routers—The valid range is from 0 to
162.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.3(21)BC This command was introduced.

12.3(23)BC This command was integrated into Cisco IOS Release 12.3(23)BC.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

12.2(33)SCB This command was modified to change the addressing format for the wideband cable
interface from slot/subslot/bay:wideband-channel to slot/bay/port:wideband-channel.

12.2(33)SCD This command was modified. Support was added for Cisco uBR7225VXR and Cisco
uBR7246VXR routers.

12.2(33)SCE Support was added for Cisco uBR-MC3GX60V cable interface line card on the Cisco
uBR10012 router.

IOS-XE 3.15.0S This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco
cBR Series Converged Broadband Routers was added.

IOS-XE This command was modified on Cisco cBR Series Converged Broadband Routers. The
3.18.0SP wideband-channel range is 0 to 162 now.

Cisco CMTS Cable Command Reference

1225
 Cable Commands: i through p
interface wideband-cable

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 terminal

Router(config)# interface wideband-cable 1/3/0:0

The 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 terminal

Router(config)# interface wideband-cable 5/1/2:0

The 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 terminal

Router(config)# interface wideband-cable 1/0:0

Related Commands Command Description

cable downstream attribute-mask Specifies an attribute mask value for a wideband cable interface.

cable rf-channels Associates RF channels on the router with a wideband interface and
allocate bandwidth.

cable bundle Specifies bundle number for bundling of cable interfaces.

interface modular-cable Specifies a modular cable interface.

interface cable Specifies a cable interface.

Cisco CMTS Cable Command Reference

1226
 Cable Commands: i through p
interleaver-depth (QAM profile)

interleaver-depth (QAM profile)

To set the interleaver-depth for a specific QAM profile, use the interleaver-depth command in QAM profile
configuration mode.

interleaver-depth {I12-J17 | I128-J1 | I128-J2 | I128-J3 | I128-J4 | I128-J5 | I128-J6 | I128-J7 | I128-J8
| I16-J8 | I32-J4 | I64-J2 | I8-J16}

Syntax Description I12-J17 INTERLEAVER-I-12-J-17 for Annex A or

C

I128-J1 INTERLEAVER-I-128-J-1 for Annex B

I128-J2 INTERLEAVER-I-128-J-2 for Annex B

I128-J3 INTERLEAVER-I-128-J-3 for Annex B

I128-J4 INTERLEAVER-I-128-J-4 for Annex B

I128-J5 INTERLEAVER-I-128-J-5 for Annex B

I128-J6 INTERLEAVER-I-128-J-6 for Annex B

I128-J7 INTERLEAVER-I-128-J-7 for Annex B

I128-J8 INTERLEAVER-I-128-J-8 for Annex B

I16-J8 INTERLEAVER-I-16-J-8 for Annex B

I32-J4 INTERLEAVER-I-32-J-4 for Annex B

I64-J2 INTERLEAVER-I-64-J-2 for Annex B

I8-J16 INTERLEAVER-I-8-J-16 for Annex B

Command Default None

Command Modes
QAM profile configuration (config-qam-prof)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to set the interleaver-depth for a specific QAM profile.

Examples The following example shows how to set the interleaver-depth for a specific QAM profile:

Router# configure terminal

Cisco CMTS Cable Command Reference

1227
 Cable Commands: i through p
interleaver-depth (QAM profile)

Router(config)# cable downstream qam-profile 4

Router(config-qam-prof)# interleaver-depth I12-J17

Related Commands Command Description

cable downstream qam-profile Set the QAM profile for the cable interface line card.

annex Set the MPEG framing format.

modulation Set the QAM modulation format.

spectrum-inversion Set the spectrum-inversion on or off.

symbol-rate Set the symbol rate.

Cisco CMTS Cable Command Reference

1228
 Cable Commands: i through p
interleaver-depth (OFDM channel profile)

interleaver-depth (OFDM channel profile)

To specify the channel interleaver-depth, use the interleaver-depth command in OFDM channel profile
configuration mode. To undo the interleaver-depth assignment, use no form of this command.

interleaver-depth value

no interleaver-depth

Syntax Description value 1 to 16 for 25 KHz spacing, 1 to 32 for 50 KHz spacing.

Command Default 16

Command Modes
OFDM channel profile configuration (config-ofdm-chan-prof)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the channel interleaver-depth.

Examples The following example shows how to specify the channel interleaver-depth:

Router# configure terminal

Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)# interleaver-depth 3

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

cyclic-prefix Specify the channel cyclic-prefix.

description (OFDM channel profile) Specify a user defined description for the profile.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-control Specify default modulation or profile as the channel control profile.

profile-data Specify default modulation or profile as the channel data profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

roll-off Specify the channel roll-off value.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1229
 Cable Commands: i through p
interval

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 seconds The polling interval for the CMTS to determine the current load on each cable interface. The valid
range is from 1 to 1000. The default value is 10 seconds in Cisco IOS Release 12.2(33)SCE and
earlier. The default value is 30 seconds in Cisco IOS Release 12.2(33)SCE1 and later.

Command Default None

Command Modes
Load balancing group configuration (config-lb-group)

Command History Release Modification

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.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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 terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# interval
50
Router(config-lb-group)#

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1230
 Cable Commands: i through p
ip (virtual-arpd)

ip (virtual-arpd)
To configure the virtual advanced return path demodulator (ARPD) source IP address, use the ip command
in OOB virtual ARPD configuration mode. To void the virtual ARPD source IP configuration, use the no
form of this command.

ip ip subnet_mask [vrf]

no ip ip

Syntax Description ip Specifies the virtual ARPD source IP address.

subnet_mask Specifies the virtual ARPD source subnet mask.

Command Default None

Command Modes
OOB Virtual ARPD configuration (config-oob-varpd)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the virtual ARPD source IP address.

Examples The following example shows how to configure the virtual ARPD source IP address:

Router# configure terminal

Router(config)# cable oob
Router(config-oob)# virtual-arpd 1
Router(config-oob-varpd)# ip 225.225.225.225 255.255.255.0

Related Commands Command Description

virtual-arpd Defines a virtual ARPD configuration.

nc Configures the network controller for virtual ARPD.

source-id Configures the source ID for virtual ARPD.

Cisco CMTS Cable Command Reference

1231
 Cable Commands: i through p
ip (virtual-om)

ip (virtual-om)
To configure the virtual OOB modulator (OM) source IP address, use the ip command in OOB virtual OM
configuration mode. To void the virtual OM source IP configuration, use the no form of this command.

ip ip subnet_mask [vrf]

no ip ip

Syntax Description ip Specifies the virtual OM source IP address.

subnet_mask Specifies the virtual OM source subnet mask.

Command Default None

Command Modes
OOB Virtual OM configuration (config-oob-vom)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the virtual OM source IP address.

Examples The following example shows how to configure the virtual OM source IP address:

Router# configure terminal

Router(config)# cable oob
Router(config-oob)# virtual-om 1
Router(config-oob-vom)# ip 225.225.225.225 255.255.255.0

Related Commands Command Description

virtual-om Defines a virtual OM configuration.

join-group Joins multicast group address.

Cisco CMTS Cable Command Reference

1232
 Cable Commands: i through p
ip address

ip address
To specify the IP address range for multicast pool, use the ip address command in multicast pool configuration
mode. To void the IP address configuration, use the no form of this command.

ip address ip mask

no ip address

Syntax Description ip mask Specifies the IP address and subnet musk for the DEPI multicast pool.

Command Default None

Command Modes Multicast pool configuration (config-multicast-pool)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to specify the IP address range for multicast pool.

The following example shows how to specify the IP address range for multicast pool:
Router# configure terminal
Router(config)# cable depi multicast pool 1
Router(config-multicast-pool)# ip address 225.225.225.0 255.255.255.0

Related Commands Command Description

cable depi multicast pool Configures the DEPI multicast pool.

Cisco CMTS Cable Command Reference

1233
 Cable Commands: i through p
ip address docsis

ip address docsis
To specify that the cable access router should use the DHCP protocol, as required by the DOCSIS specification,
to assign an IP address for its cable interface, use the ip address docsis command in cable interface
configuration mode. To disable the use of DHCP, use the no form of this command.

Cisco uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
ip address docsis
no ip address docsis

Syntax Description There are no key words or arguments for this command.

Command Default The cable access router uses the DHCP protocol, as required by the DOCSIS specification, to assign an IP
address to its cable interface during system power-on.

Command Modes
Interface configuration (cable interface only)

Command History Release Modification

12.1(3)XL This command was introduced for the Cisco uBR905 cable access router.

12.1(4)T Support was added for the Cisco uBR924 cable access router.

12.1(3)XL Support was added for the Cisco uBR905 cable access router.

12.1(5)XU1 Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA Support was added for the Cisco uBR925 cable access router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The ip address docsis command configures the cable access router so that it obtains its IP address from a
DHCP server at system power-on, which is a requirement for DOCSIS operation. This is the default mode of
operation. If the configuration for the cable interface does not include any form of ip address command, the
cable access router defaults to configuring the cable interface with the ip address docsis command.
Configuring the cable interface with any other form of the ip address command or with the no ip address
docsis command prevents the cable access router from operating in DOCSIS networks. This mode of operation
should be used only in lab or test networks.

Note Earlier Cisco IOS software releases for the cable access routers used either the ip address negotiated or the
ip address dhcp command to specify that the cable interface should obtain its IP address from a DHCP server.
These commands should no longer be used to configure the router’s cable interface.

Examples The following example shows how to configure the cable access router so that it obtains the IP address
for its cable interface from a DHCP server:

Cisco CMTS Cable Command Reference

1234
 Cable Commands: i through p
ip address docsis

Router(config)# interface cable-modem 0

Router(config-if)# ip address docsis

Router(config-if)# exit

Router(config)#

Related Commands Command Description

cable-modem dhcp-proxy Specifies that a DHCP server should provide the IP address for the router’s
Ethernet interface or for a NAT address pool.

ip http dhcp Specifies the use of the DHCP protocol to obtain an IP address for any interface
except the cable interface at system power-on.

ip http negotiated Specifies that a serial interface should use the PPP/IPCP to obtain an IP address
at system power-on

Cisco CMTS Cable Command Reference

1235
 Cable Commands: i through p
ip-address (controller)

ip-address (controller)
To set the IP address of the Wideband SPA FPGA, use the ip-address (controller) command in controller
configuration mode. To remove the IP address of the Wideband SPA FPGA, use the no form of this command.

ip-address ip-address
no ip-address ip-address

Syntax Description ip-address IP address for the Wideband SPA FPGA.

Command Default No IP address is set for the Wideband SPA FPGA.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to set the IP address for the Wideband SPA FPGA. This address is used as the source IP
address for packets that the Wideband SPA transmits to the EQAM device.

Examples The following example shows how to set the IP address of the Wideband SPA FPGA. The SPA is
located in slot 1, subslot 0, bay 0.

Router(config)# controller modular-cable 1/0/0

Router(config-controller)# ip-address 192.168.200.6

Related Commands Command Description

annex modulation Sets the annex and modulation for the Wideband SPA.

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband

channel.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

modular-host subslot Specifies the modular-host line card.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address and UDP port for each RF
udp-port channel.

Cisco CMTS Cable Command Reference

1236
Cable Commands: i through p
ip-address (controller)

Command Description

rf-channel network delay Specifies the CIN delay for each RF channel.

rf-channel description Specifies the description for each RF channel.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

Cisco CMTS Cable Command Reference

1237
 Cable Commands: i through p
ip dhcp ping packet 0

ip dhcp ping packet 0

To instruct the DHCP server to assign an IP address from its pool without first sending an ICMP ping to test
whether a client is already currently using that IP address, use the ip dhcp ping packet 0 command in global
configuration mode. Use the no form of this command to remove this configuration.
ip dhcp ping packet 0
no ip dhcp ping packet 0

Syntax Description This command has no additional keywords or arguments.

Command Default By default, the DHCP server pings a pool address twice before assigning a particular address to a requesting
client. If the ping is unanswered, the DHCP server assumes that the address is not in use and assigns the
address to the requesting client.

Command Modes
Global configuration

Command History Release Modification

12.1 Command support introduced on the Cisco CMTS.

EC

Usage Guidelines Disabling the ping option can speed up address assignment when a large number of modems are trying to
connect at the same time. However, disabling the ping option can also result in duplicate IP addresses being
assigned if users assign unauthorized static IP addresses to their CPE devices.
For additional information about DHCP configuration on the Cisco CMTS, refer to the following documents
on Cisco.com:
• Filtering Cable DHCP Lease Queries on the Cisco CMTS
• DHCP and Time-of-Day Services on the Cisco CMTS

Examples The following example of the show version command illustrates configuration of this feature on the
Cisco CMTS:

version 12.1
no service pad
! provides nice timestamps on all log messages
service timestamps debug datetime msec localtime
service timestamps log uptime
! turn service password-encryption on to encrypt passwords
no service password-encryption
! provides additional space for longer configuration file
service compress-config
! supports a large number of modems / hosts attaching quickly
service udp-small-servers max-servers no-limit
!
hostname Router
!
boot system disk0:
!

Cisco CMTS Cable Command Reference

1238
Cable Commands: i through p
ip dhcp ping packet 0

no cable qos permission create

no cable qos permission update
cable qos permission modems
! permits cable modems to obtain Time of Day (TOD) from uBR7100
cable time-server
!
! High performance DOCSIS config file, additional options may be added
! 10 Mbit/sec download, 128 Kbit/sec upload speed, 10 Kbit/sec guaranteed upstream
! NOTE: cable upstream 0 admission-control 150 will prevent modems from
! connecting after 150% of guaranteed-bandwidth has been allocated to
! registered modems. This can be used for peek load balancing.
! max-burst 1600 prevents a modem with concatenation turned on from consuming
! too much wire time, and interfering with VoIP traffic.
! cpe max 8 limits the modem to 8 hosts connected before the CMTS refuses
! additional host MAC addresses.
! Timestamp option makes the config file only valid for a short period of time.
!
cable config-file platinum.cm
service-class 1 max-upstream 128
service-class 1 guaranteed-upstream 10
service-class 1 max-downstream 10000
service-class 1 max-burst 1600
cpe max 8
timestamp
!
! Medium performance DOCSIS config file, additional options may be added
! 5 Mbit/sec download, 128 Kbit/sec upload speed
!
cable config-file gold.cm
service-class 1 max-upstream 64
service-class 1 max-downstream 5000
service-class 1 max-burst 1600
cpe max 3
timestamp
!
! Low performance DOCSIS config file, additional options may be added
! 1 Mbit/sec download, 64 Kbit/sec upload speed
!
cable config-file silver.cm
service-class 1 max-upstream 64
service-class 1 max-downstream 1000
service-class 1 max-burst 1600
cpe max 1
timestamp
!
! No Access DOCSIS config file, used to correctly shut down an unused cable modem
! 1 kbit/sec download, 1 Kbit/sec upload speed, with USB/ethernet port shut down.
!
cable config-file disable.cm
access-denied
service-class 1 max-upstream 1
service-class 1 max-downstream 1
service-class 1 max-burst 1600
cpe max 1
timestamp
!
ip subnet-zero
! Turn on cef switching / routing, anything but process switching (no ip route-cache)
ip cef
ip cef accounting per-prefix
! Disables the finger server
no ip finger
! Prevents CMTS from looking up domain names / attempting to connect to
! machines when mistyping commands

Cisco CMTS Cable Command Reference

1239
 Cable Commands: i through p
ip dhcp ping packet 0

no ip domain-lookup
! Prevents issuance of IP address that is already in use.
ip dhcp ping packets 0

Related Commands Command Description

cable dhcp-giaddr policy Sets the DHCP giaddr field of DHCP request packets to the primary address
for cable modems and the secondary address for CPE devices, allowing the
use of separate address pools for the different clients.

cable dhcp-parse option Enables the parsing of certain DHCP options.

cable helper-address Enables load-balancing of DHCP requests from cable modems and CPE
devices by specifying different DHCP servers according to the cable interface
or subinterface.

ip dhcp ping packet 0 Instructs the DHCP server to assign an IP address from its pool without first
sending an ICMP ping to test whether a client is already currently using
that IP address.

ip dhcp relay information Configures the DHCP server to validate the relay agent information option
option in forwarded BOOTREPLY messages.

ip dhcp smart-relay Enables the DHCP relay agent on the CMTS to automatically switch a cable
modem or CPE device to a secondary DHCP server or address pool if the
primary DHCP server does not respond to three successive requests.

Cisco CMTS Cable Command Reference

1240
 Cable Commands: i through p
ip dhcp pool

ip dhcp pool
To create a DHCP address pool and enter DHCP pool configuration file mode, use the ip dhcp pool command
in global configuration mode. To remove a configured DHCP pool, use the no form of this command.

Syntax Description Provide a name for the DHCP address pool

name The name can be either an arbitrary string, such as service, or a number, such as 1.

Command Default DHCP pool names are not configured by default.

Command Modes
Global configuration

Command History Release Modification

12.1 Command support introduced on the Cisco CMTS.

EC

Usage Guidelines Disabling the ping option can speed up address assignment when a large number of modems are trying to
connect at the same time. However, disabling the ping option can also result in duplicate IP addresses being
assigned if users assign unauthorized static IP addresses to their CPE devices.
For additional information about DHCP configuration on the Cisco CMTS, refer to the following documents
on Cisco.com:
• https://www.cisco.com/c/en/us/td/docs/cable/cmts/config_guide/b_cbr_docsis_full_book_xe16_12/b_
cbr_docsis_full_book_xe16_12_chapter_0111001.pdf Filtering Cable DHCP Lease Queries on the Cisco
CMTS.
• http://www.cisco.com/en/US/docs/ios/cable/configuration/guide/cmts_services.html DHCP and
Time-of-Day Services on the Cisco CMTS

Examples The following example configures a DHCP pool with the name indicated, and enables additional
configuration in the DHCP pool configuration mode:

Router# configure terminal

Router(config)# ip dhcp pool local
Router(dhcp-config)#

The following examples illustrate additional configurations that are typical for a DHCP pool configured
when starting with the ip dhcp pool command, or with additional DHCP configuration commands.

ip dhcp pool cm-platinum

network 10.128.4.0 255.255.255.0
bootfile platinum.cm
next-server 10.128.4.1
default-router 10.128.4.1
option 2 hex ffff.8f80
option 4 ip 10.1.4.1
option 7 ip 10.1.4.1
lease 7 0 10
!

Cisco CMTS Cable Command Reference

1241
 Cable Commands: i through p
ip dhcp pool

ip dhcp pool cm-gold

network 10.129.4.0 255.255.255.0
bootfile gold.cm
next-server 10.129.4.1
default-router 10.129.4.1
option 2 hex ffff.8f80
option 4 ip 10.1.4.1
option 7 ip 10.1.4.1
lease 7 0 10
!
ip dhcp pool cm-silver
network 10.130.4.0 255.255.255.0
bootfile silver.cm
next-server 10.130.4.1
default-router 10.130.4.1
option 2 hex ffff.8f80
option 4 ip 10.1.4.1
option 7 ip 10.1.4.1
lease 7 0 10
!
ip dhcp pool DisabledModem(0010.aaaa.0001)
host 10.128.1.9 255.255.255.0
client-identifier 0100.10aa.aa00.01
bootfile disable.cm
!
ip dhcp pool DisabledModem(0020.bbbb.0002)
host 10.128.1.10 255.255.255.0
client-identifier 0100.20bb.bb00.02
bootfile disable.cm
!
ip dhcp pool DisabledModem(1010.9581.7f66)
host 10.128.1.11 255.255.255.0
client-identifier 0100.1095.817f.66
bootfile disable.cm
!
ip dhcp pool hosts
network 10.254.1.0 255.255.255.0
default-router 10.254.1.1
dns-server 10.254.1.1 10.128.1.1
domain-name ExamplesDomainName.com
lease 7 0 10
!

Related Commands Command Description

cable dhcp-giaddr policy Sets the DHCP giaddr field of DHCP request packets to the primary address
for cable modems and the secondary address for CPE devices, allowing the
use of separate address pools for the different clients.

cable dhcp-parse option Enables the parsing of certain DHCP options.

cable helper-address Enables load-balancing of DHCP requests from cable modems and CPE
devices by specifying different DHCP servers according to the cable interface
or subinterface.

ip dhcp ping packet 0 Instructs the DHCP server to assign an IP address from its pool without first
sending an ICMP ping to test whether a client is already currently using
that IP address.

Cisco CMTS Cable Command Reference

1242
Cable Commands: i through p
ip dhcp pool

Command Description

ip dhcp relay information Configures the DHCP server to validate the relay agent information option
option in forwarded BOOTREPLY messages.

ip dhcp smart-relay Enables the DHCP relay agent on the CMTS to automatically switch a cable
modem or CPE device to a secondary DHCP server or address pool if the
primary DHCP server does not respond to three successive requests.

Cisco CMTS Cable Command Reference

1243
 Cable Commands: i through p
ipdr associate

ipdr associate
To associate the Collector with a session, use the ipdr associate command in global configuration mode. To
remove the association, use the no form of this command.

ipdr associate session_id collector_name priority

no ipdr associate session_id collector_name

Syntax Description session_id The unique IPDR session ID.

collector_name The collector name. The name should not contain extra spaces.

priority The priority value between the session and the collector. The value range is 1 to 10. A value
of 1 indicates that the highest priority.

Command Default An association with the session will not be created.

Command Modes
Global configuration mode

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command allows the user to associate the Collector with a session. Once the Collector is configured, the
Exporter sends data to the Collector. IPDR supports redundant collector and consistent streaming continues
when a collector is down or not functioning.
The no form of the command will only remove the association for the stopped session.

Note The collector and the session should be configured before running this command.

Examples The following example configures a Collector.

Router# configure terminal

Router(config)#ipdr associate 1 federal 1

Related Commands Command Description

ipdr collector Configures the IPDR Collector details.

show ipdr collector Displays the collector information, message statistics and event for all the sessions
that are associated with the collector.

Cisco CMTS Cable Command Reference

1244
Cable Commands: i through p
ipdr associate

Command Description

ipdr session Adds a session to the IPDR Exporter.

Cisco CMTS Cable Command Reference

1245
 Cable Commands: i through p
ipdr authorization

ipdr authorization
To enable the Internet Protocol Detail Record (IPDR) authorization, use ipdr authorization command in
global configuration mode. To remove the configuration, use the no form of this command.

ipdr authorization
no ipdr authorization

Syntax Description This command has no arguments or keywords.

Command Default This IPDR authorization will be disabled by default.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCI2 This command was introduced.

Usage Guidelines The IPDR authorization is disabled by default. Use the ipdr authorization command to enable IPDR
authorization. You can include it in the start-up configuration file as well. Whether IPDR authorization is
enabled or not, any Collector coming from the bundle side will always be rejected.

Examples The following example shows how to enable IPDR authorization:

Router#configure terminal
Router(config)#ipdr authorization
IPDR authorization is enabled.
Router(config)#

Related Commands Command Description

ipdr collector Configures the Internet Protocol Detail Record (IPDR) Collector details.

Cisco CMTS Cable Command Reference

1246
 Cable Commands: i through p
ipdr collector

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

Cisco IOS Release 12.2(33)SCI2

ipdr collector collector_name ip_addr [port][nat-address ip_addr [port] ]
no ipdr collector collector_name

Syntax Description collector_name The collector name. The name should not contain extra spaces.

ip_addr The collector IP address.

port (Optional) The collector port value. The default port number will be considered if the
value is not entered.

nat-address ip_addr (Optional) The collector's Network Address Translation (NAT) in IP header.

Command Default A Collector will not be configured.

Command Modes
Global configuration mode

Command History Release Modification

12.2(33)SCB This command was introduced.

12.2(33)SCI2 This command was integrated into Cisco IOS Release 12.2(33)SCI2. The nat-address
keyword was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command allows the user to configure an IPDR Collector and authenticate the IPDR protocol. Once the
Collector is configured, the Exporter sends data to the Collector. User must provide the collector name and
the IP address. Port number is used when an exporter creates an active connection.
The no form of the command will remove a specific IPDR Collector. If the collector is associated with an
active session, you should stop the session before using the no command.

Examples The following example configures a Collector.

Router# configure terminal

Router(config)#ipdr collector federal 192.0.2.0

Cisco CMTS Cable Command Reference

1247
 Cable Commands: i through p
ipdr collector

Related Commands Command Description

show ipdr collector Displays the collector information, message statistics and event for all the sessions that
are associated with the collector.

ipdr session Adds a session to the IPDR Exporter.

Cisco CMTS Cable Command Reference

1248
 Cable Commands: i through p
ipdr exporter ack-timeout

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 Release Modification

12.3(33)SCG This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command allows you to set acknowledged records timeout value for a session.

Note Restart the IPDR Exporter for the timer values to take effect.

Examples The following example shows how to configure the acknowledged records timeout value on the
Cisco CMTS router:

Router# configure terminal

Router(config
)# ipdr exporter ack-timeout 60
Router(config)# ipdr exporter start

Related Commands Command Description

show ipdr exporter Displays information about the IPDR Exporter state on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

1249
 Cable Commands: i through p
ipdr exporter connection active

ipdr exporter connection active

To enable the IPDR exporter to start connection, use the ipdr exporter connection-active command in global
configuration mode. To enable collectors to start connection, use the no form of this command. It does not
support to change connection type when the exporter is started. Stop exporter then change to another type.

ipdr exporter connection-active [source-interface interface]

no ipdr exporter connection-active

Syntax Description source-interface Specifies the interface on which the connection is established.

Command Default By default, the IPDR exporter process will not be started.

Command Modes
Global configuration mode

Command History Release Modification

IOS XE Gibraltar This command was introduced on the Cisco cBR Series Converged Broadband
16.12.1 Routers.

Usage Guidelines This command allows the IPDR exporter to start connection.
The no form of the command will change the IPDR Exporter connection mode to default.

Examples The following example allows the IPDR Exporter to start connection on the TenGigabitEthernet port
4/1/0 of the CMTS.

Router# configure terminal

Router(config)#ipdr exporter connection-active source-interface TenGigabitEthernet4/1/0

Related Commands Command Description

show ipdr exporter Displays information about the IPDR Exporter state.

show ipdr collector Displays the collector information, message statistics and event for all the sessions that
are associated with the collector.

ipdr collector Configures the Internet Protocol Detail Record (IPDR) Collector details.

Cisco CMTS Cable Command Reference

1250
 Cable Commands: i through p
ipdr exporter keepalive

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 Release Modification

12.3(33)SCG This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command allows you to set the keeplive timeout value for a session.

Note Restart the IPDR Exporter for the keepalive timer values to take effect.

Examples The following example shows how to configure the keepalive value on the Cisco CMTS router:

Router# configure terminal

Router(config
)# ipdr exporter keepalive 300
Router(config)# ipdr exporter start

Related Commands Command Description

show ipdr exporter Displays information about the IPDR Exporter state on the Cisco CMTS.

Cisco CMTS Cable Command Reference

1251
 Cable Commands: i through p
ipdr exporter max-unacked

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 Release Modification

12.3(33)SCG This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command allows you to set the maximum number of unacknowledged records for a session.

Note Restart the IPDR Exporter for the number of records to take effect.

Examples The following example shows how to configure the number of unacknowledged records configured
on the Cisco CMTS router:

Router# configure terminal

Router(config
)# ipdr exporter max-unacked 200
Router(config)# ipdr exporter start

Related Commands Command Description

show ipdr exporter Displays information about the IPDR Exporter state on the Cisco CMTS router.

Cisco CMTS Cable Command Reference

1252
 Cable Commands: i through p
ipdr exporter start

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 [ipv6]

no ipdr exporter start

Syntax Description ipv6 Configure IPDR in IPv6

mode.

Command Default By default, the IPDR exporter process will not be started.

Command Modes
Global configuration mode

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.OS This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

IOS XE Gibraltar This command was updated to include ipv6 keyword.

16.12.1

Usage Guidelines This command allows the user to explicitly start the IPDR Exporter and connect to the collector. As a default
behavior, the command will initiate all the sessions configured in the Exporter to a "Start" state.
The no form of the command will stop the IPDR Exporter process. The command will also clear the connection
with the collector while retaining other configurations.

Examples The following example starts the IPDR Exporter process on the CMTS.

Router# configure terminal

Router(config)#ipdr exporter start

Related Commands Command Description

show ipdr exporter Displays information about the IPDR Exporter state.

show ipdr collector Displays the collector information, message statistics and event for all the sessions that
are associated with the collector.

ipdr collector Configures the Internet Protocol Detail Record (IPDR) Collector details.

Cisco CMTS Cable Command Reference

1253
 Cable Commands: i through p
ipdr session

ipdr session
To start or stop a specific session, use the ipdr session command in the privileged EXEC mode.

ipdr session session_id {start | stop}

Syntax Description session_id The unique IPDR session ID.

start The keyword to start the session.

stop The keyword to stop the session.

Command Default No sessions are started.

Command Modes
Privileged EXEC mode

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command allows the user to start or stop a specific session. This command can be executed only when
the IPDR exporter is started.

Note The user has to stop the session before configuring any tasks if the session is active.

Examples The following example enables the user to start a session.

Router# configure terminal

Router(config)#ipdr session 1 start

Related Commands Command Description

ipdr exporter start Starts the IPDR Exporter and connects to the collector.

show ipdr exporter Displays information about the IPDR Exporter state.

ipdr associate Associates the Collector with a session.

Cisco CMTS Cable Command Reference

1254
 Cable Commands: i through p
ipdr session (global configuration)

ipdr session (global configuration)

To enable the CMTS application to add a session to the Internet Protocol Detail Record (IPDR) exporter, use
the ipdr session command in global configuration mode. To remove the session, use the no form of this
command.

ipdr session session_id session_name session_descr

no ipdr session session_id

Syntax Description session_id The unique IPDR session ID.

session_name The session name. The name should not contain extra spaces.

session_descr The description of the session.

Command Default No sessions are added to the IPDR exporter. It depends on the status of the IPDR exporter. After configuring
one session;if the status of exporter is started, then the session is started automatically.

Command Modes
Global configuration mode

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command allows the user to add a session to the IPDR exporter. User should provide session ID, session
name and session description for every session.
The no form of the command will remove a specific session. Once a session is removed, the template and
other information associated with the session is also lost.

Note You can not update template details or other details when a session already created.

Examples The following example adds a session to the Exporter.

Router# configure terminal

Router(config)#ipdr session 1 test no_descr

Related Commands Command Description

ipdr exporter start Starts the IPDR exporter and connects to the collector.

show ipdr exporter Displays information about the IPDR exporter state.

Cisco CMTS Cable Command Reference

1255
 Cable Commands: i through p
ipdr session (global configuration)

Command Description

ipdr associate Associates the IPDR collector with a session.

Cisco CMTS Cable Command Reference

1256
 Cable Commands: i through p
ipdr template

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 session_id Unique IPDR Session ID.

template_name Template name.

Command Default The IPDR template is not added to the IPDR session.

Command Modes
Global configuration (config)

Command History Release Modification

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.

12.2(33)SCH5 A new template is defined for CM-STATUS and the old template is renamed as
CM-STATUS-2008.

12.2(33)SCI1 This command is integrated from Cisco IOS Release 12.2(33)SCH5.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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 You can only add the system-supported templates. The list can be viewed by entering “?” at the command
prompt.

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 ipdr

ipdr session 1 test test
ipdr session 2 event2 event2
ipdr session 3 ad-hoc3 ad-hoc3
ipdr type 1 time-interval 15
ipdr type 2 event

Cisco CMTS Cable Command Reference

1257
 Cable Commands: i through p
ipdr template

ipdr type 3 event

The following example shows the templates available in a timer-interval session.

Router# ipdr template 1 ?

CM-STATUS DOCSIS-CMTS-CM-REG-STATUS-TYPE template
CM-US DOCSIS-CMTS-CM-US-STATS-TYPE template
DIAGLOG-DETAIL DOCSIS-DIAG-LOG-DETAIL-TYPE template
SAMIS-TYPE1 DOCSIS-SAMIS-TYPE-1 template
SAMIS-TYPE2 DOCSIS-SAMIS-TYPE-2 template
SPECTRUM DOCSIS-SPECTRUM-MEASUREMENT-TYPE template
TEST Template for test

The following example shows how to add the SAMIS_TYPE1 template in a timer-interval session.

Router(config)# ipdr template 1 SAMIS-TYPE1

The 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 template
CPE-TYPE DOCSIS-CPE-TYPE template
DIAGLOG-DETAIL DOCSIS-DIAG-LOG-DETAIL-TYPE template
DIAGLOG-EVENT DOCSIS-DIAG-LOG-EVENT-TYPE template
DS-UTIL DOCSIS-CMTS-DS-UTIL-STATS-TYPE template
SAMIS OSSI2.0 SAMIS template
SERVICE-FLOW SERVICE-FLOW-TYPE template
TEST Template for test
TOPOLOGY DOCSIS-CMTS-TOPOLOGY-TYPE template
US-UTIL DOCSIS-CMTS-US-UTIL-STATS-TYPE template

The 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 template
CPE-TYPE DOCSIS-CPE-TYPE template
DIAGLOG-DETAIL DOCSIS-DIAG-LOG-DETAIL-TYPE template
DIAGLOG-EVENT DOCSIS-DIAG-LOG-EVENT-TYPE template
DS-UTIL DOCSIS-CMTS-DS-UTIL-STATS-TYPE template
SAMIS OSSI2.0 SAMIS template
SERVICE-FLOW SERVICE-FLOW-TYPE template
TEST Template for test
TOPOLOGY DOCSIS-CMTS-TOPOLOGY-TYPE template
US-UTIL DOCSIS-CMTS-US-UTIL-STATS-TYPE template

The following example shows the templates available in a timer-interval session for Cisco IOS
Release 12.2(33)SCH5:
Router(config)# ipdr template 1 ?

CM-STATUS DOCSIS-CMTS-CM-REG-STATUS-TYPE template

CM-STATUS-2008 DOCSIS-CMTS-CM-REG-STATUS-TYPE-2008 template
CPE-TYPE DOCSIS-CPE-TYPE template
DIAGLOG-DETAIL DOCSIS-DIAG-LOG-DETAIL-TYPE template
DIAGLOG-EVENT DOCSIS-DIAG-LOG-EVENT-TYPE template
DS-UTIL DOCSIS-CMTS-DS-UTIL-STATS-TYPE template
SAMIS OSSI2.0 SAMIS template

Cisco CMTS Cable Command Reference

1258
 Cable Commands: i through p
ipdr template

SERVICE-FLOW SERVICE-FLOW-TYPE template

TEST Template for test
TOPOLOGY DOCSIS-CMTS-TOPOLOGY-TYPE template
US-UTIL DOCSIS-CMTS-US-UTIL-STATS-TYPE template

Related Commands Command Description

ipdr exporter start Starts the IPDR Exporter on the Cisco CMTS and connects to the collector.

show ipdr exporter Displays information about the IPDR Exporter state on the Cisco CMTS.

ipdr session Adds a session to the IPDR Exporter on the Cisco CMTS.

Cisco CMTS Cable Command Reference

1259
 Cable Commands: i through p
ipdr type

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 session id IPDR session ID. Range is from 1 to 255.

ad-hoc The ad hoc session type.

event The event session type.

time-interval value The time-interval session type. Interval range is from 15 to 1440 minutes.

Command Default The IPDR session type is not defined.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCD2 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command allows the user to define the specific IPDR session type.

Note Once the IPDR session type is configured, the templates supported by this IPDR type are automatically
associated with it.

Examples The following example shows how to configure the IPDR “time-interval” session type for a time
interval of 15 minutes.

Router> enable
Router# configure terminal
Router(config)# ipdr type 1 time-interval 15

Related Commands Command Description

cable ipdr cm-us-status interval Displays a cable modem’s upstream channel status information.

Cisco CMTS Cable Command Reference

1260
 Cable Commands: i through p
ipdr type

Command Description

cable ipdr docs-spectrum interval Sets the interval between different spectrum measurements’ data for a
CMTS.

cable ipdr diaglog interval Sets the time interval between different diagnostic logs’ data for a
CMTS.

cable ipdr cm-status interval Displays the CMTS and cable modem registration status information.

Related Commands To configure IPv6 segment routing (SRv6), use the ipv6 address command in the global configuration mode.

ipv6 address {ipv6_address_prefixprefix_length} segment-routing

no ipv6 address {ipv6_address_prefixprefix_length} segment-routing

ipv6_address_prefix IPv6 prefix associated with a particular SAV group, specified in the X:X:X:X::/X
format.

prefix_length Length of the IPv6 prefix. The valid range is from 0 to 128

Command Default
None.

Command Modes
Global configuration mode (config)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines
This command is used to configure IPv6 Segment Routing. You can also configure multiple IPv6 addresses
for SRv6 under the same interface. An IPv6 address with a prefix SID can also be associated with SRv6. to
define a local prefix as an SID, use the following commands:
ipv6-sr prefix-sid

Use the no ipv6-sr prefix-sid command to disable the local prefix SID.

The following example shows how to configure IPv6 segment routing.

Router#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#inter Ether0/0
Router(config-if)#ipv6 address 2001::0DB8/32 segment-routing
Router(config-if-sr-ipv6)#ipv6-sr prefix-sid
Router(config-if-sr-ipv6)#exit
Router(config-if)#exit
Router(config)#exit

The following example shows how to configure multiple IPv6 addresses for SRv6 under the same
interface.

Cisco CMTS Cable Command Reference

1261
 Cable Commands: i through p
ipdr type

Router#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)#inter Ether 0/0
Router(config-if)# ipv6 address 110::110/64 segment-routing
Router(config-if)# ipv6 address 111::111/64 segment-routing
Router(config-if-sr-ipv6)#ipv6-sr prefix-sid
Router(config-if-sr-ipv6)#end

Related Commands
Command Description

ipv6-sr prefix-sid Defines a local prefix as an SID.

Cisco CMTS Cable Command Reference

1262
 Cable Commands: i through p
issu linecard abortversion

issu linecard abortversion

To roll back the current image version on a single line card or multiple line cards to the previous version, use
the issu linecard abortversion command in the privileged EXEC mode.

Note This command is used to roll back the versions on redundant line cards only.

issu linecard abortversion {alllc slot/subslot} [forced]

Syntax Description all All redundant line cards.

lc_slot The line card slot number.

subslot The line card sub slot number.

forced (Optional) The ISSU would ignore potential service outage and line card incompatibility errors and
proceed with abortversion instead of stopping and error handling.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to roll back to prior image on working or primary line card on a single or
multiple line cards to the previous versions.

Note The issu linecard reloadversion command is used to reload a line card with the original version of images.

The following example rolls back the specific redundant line card’s image version.

Router# configure terminal

Router(config)#issu linecard abortversion

Related Commands Command Description

issu linecard acceptversion Accepts the new image version on the working line card.

issu linecard loadversion Loads a specific image version on the primary line card.

Cisco CMTS Cable Command Reference

1263
 Cable Commands: i through p
issu linecard abortversion

Command Description

issu linecard prepareversion Determines if the image version on the line card has to be upgraded or
downgraded to the route processor’s image version.

issu linecard reloadversion Reloads the new loaded image on a working or a primary line card.

issu linecard runversion Runs the new loaded image on a working or a primary line card.

issu linecard changeversion Starts the upgrade or downgrade activity of the image version for a single
line card or multiple line cards.

Cisco CMTS Cable Command Reference

1264
 Cable Commands: i through p
issu linecard acceptversion

issu linecard acceptversion

To accept the new image version on the working line card, use the issu linecard acceptversion command in
the privileged EXEC mode.

issu linecard acceptversion lc slot [/subslot]

Syntax Description lc_slot The line card slot number.

subslot The line card sub slot number.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to accept the new image version on the working line card. The command also
indicates the completion of changing the image version for the specific line card and allows the ISSU of the
next line card in the queue.

Examples The following example indicates a command accepting the image version on the slot 7 of the line
card.

Router# configure terminal

Router(config)#issu linecard acceptversion 7/0

Related Commands Command Description

issu linecard abortversion Rolls back to the prior image on working/primary line card.

issu linecard loadversion Loads a specific image version on the primary line card.

issu linecard prepareversion Determines if the image version on the line card has to be upgraded or
downgraded to the route processor’s image version.

issu linecard reloadversion Reloads the new loaded image on a working or a primary line card.

issu linecard runversion Runs the new loaded image on a working or a primary line card.

issu linecard changeversion Starts the upgrade or downgrade activity of the image version for a single
line card or multiple line cards.

Cisco CMTS Cable Command Reference

1265
 Cable Commands: i through p
issu linecard changeversion

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.

Note Effective with Cisco IOS Release 12.2(33)SCH2, the issu linecard changeversion command is used to check
and upgrade the line card images automatically during the RP-only ISSU process.

issu linecard changeversion { all | stopslot_1 [/subslot_1]} ... [slot_n [/subslot_n]] [forced]

Syntax Description all All redundant line cards.

slot_1 The slot number for the first line card.

subslot_1 The sub slot number for the first line card.

slot_n The slot number for the n th line card.

subslot_n The sub slot number for the n th line card.

forced (Optional) The ISSU would ignore potential service outage and line card incompatibility errors
and proceed with changeversion instead of stopping and error handling.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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 stop the version change process for a line card.

Examples The following example displays the command and uses the all option.

Router# configure terminal

Router(config)#issu linecard changeversion all

The following example displays the command and uses the slot value of 6.

Cisco CMTS Cable Command Reference

1266
 Cable Commands: i through p
issu linecard changeversion

Router# configure terminal

Router(config)#issu linecard changeversion 6/0

Related Commands Command Description

issu linecard abortversion Rolls back to the prior image on working/primary line card.

issu linecard acceptversion Accepts the new image version on the working line card.

issu linecard loadversion Loads a specific image version on the primary line card.

issu linecard prepareversion Determines if the image version on the line card has to be upgraded or
downgraded to the route processor’s image version.

issu linecard reloadversion Reloads the new loaded image on a working or a primary line card.

issu linecard runversion Runs the new loaded image on a working or a primary line card.

Cisco CMTS Cable Command Reference

1267
 Cable Commands: i through p
issu linecard loadversion

issu linecard loadversion

To load a specific image version on the primary line card, use the issu linecard loadversion command in the
privileged EXEC mode.

issu linecard loadversion slot[/subslot]

Syntax Description slot The line card slot number.

subslot The line card sub slot number.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to load a specific image version on the working line card.

Examples The following example shows the command that loads the image version on a line card with the slot
number 7.

Router# configure terminal

Router(config)#issu linecard loadversion 7/0

Related Commands Command Description

issu linecard abortversion Rolls back to the prior image on working/primary line card.

issu linecard acceptversion Accepts the new image version on the working line card.

issu linecard prepareversion Determines if the image version on the line card has to be upgraded or
downgraded to the route processor’s image version.

issu linecard reloadversion Reloads the new loaded image on a working or a primary line card.

issu linecard runversion Runs the new loaded image on a working or a primary line card.

issu linecard changeversion Starts the upgrade or downgrade activity of the image version for a single
line card or multiple line cards.

Cisco CMTS Cable Command Reference

1268
 Cable Commands: i through p
issu linecard prepareversion

issu linecard prepareversion

To determine if the image version on the line card has to be upgraded or downgraded to the route processor’s
image version, use the issu linecard prepareversion command in the privileged EXEC mode.

issu linecard prepareversion lc_slot [/subslot] [forced]

Syntax Description lc_slot The line card slot number.

subslot The line card sub slot number.

forced (Optional) The ISSU would ignore potential service outage and line card incompatibility errors and
proceed with prepareversion instead of stopping and error handling.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to check if the image version on the line card has to be upgraded or downgraded
to the route processor’s image version.
This command also checks if the line card has a valid redundancy configuration. If the line card does not have
a valid configuration, then the user has to reload the line card using the issu linecard reloadversion command.

Examples The following example shows the command executed for a line card with a slot value of 7.

Router# configure terminal

Router(config)#issu linecard prepareversion 7/0

Related Commands Command Description

issu linecard abortversion Rolls back to the prior image on working/primary line card.

issu linecard acceptversion Accepts the new image version on the working line card.

issu linecard loadversion Loads a specific image version on the primary line card.

issu linecard reloadversion Reloads the new loaded image on a working or a primary line card.

issu linecard runversion Runs the new loaded image on a working or a primary line card.

Cisco CMTS Cable Command Reference

1269
 Cable Commands: i through p
issu linecard prepareversion

Command Description

issu linecard changeversion Starts the upgrade or downgrade activity of the image version for a single line
card or multiple line cards.

Cisco CMTS Cable Command Reference

1270
 Cable Commands: i through p
issu linecard process stop

issu linecard process stop

Note Effective with Cisco IOS Release 12,2(33)SCG and later, issu linecard process stop is no longer supported
on the Cisco CMTS router.

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 (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

12.2(33)SCG This command is obsolete.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the issu linecard process stop command to interrupt the automatic ISSU process continuing to the next
line card

Associated Features:
The issu linecard process stop command is associated with following features:
Cisco IOS In Service Software Upgrade Process
Example
The following example shows how to stop the ISSU process:

Router> enable
Router# issu linecard process stop

Related Commands Command Description

issu linecard abortversion Rolls back to the prior image on working/primary line card.

issu linecard acceptversion Accepts the new image version on the working line card.

issu linecard loadversion Loads a specific image version on the primary line card.

Cisco CMTS Cable Command Reference

1271
 Cable Commands: i through p
issu linecard process stop

Command Description

issu linecard prepareversion Determines if the image version on the line card has to be upgraded or
downgraded to the route processor’s image version.

issu linecard reloadversion Reloads the new loaded image on a working or a primary line card.

issu linecard runversion Runs the new loaded image on a working or a primary line card.

issu linecard changeversion Starts the upgrade or downgrade activity of the image version for a single
line card or multiple line cards.

Cisco CMTS Cable Command Reference

1272
 Cable Commands: i through p
issu linecard reloadversion

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 prepareversion {original | target} {all[slot_1 [subslot_1]... [slot_n [/subslot_n]]}

Syntax Description original The original image version.

all All redundant line cards.

slot_1 The slot number for the first line card.

subslot_1 The sub slot number for the first line card.

slot_n The slot number for the n th line card.

subslot_n The sub slot number for the n th line card.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to reload the new loaded image on a working or a primary line card.
This command can be used for the following line card conditions.
• Line cards that are not configured with redundancy, and do not support Minimal Disruptive Restart
(MDR.)
• Line cards which are capable of line card redundancy which were rolled back due to an unsuccessful
changeversion command.

Examples The following example shows the command executed with the original keyword.

Router# configure terminal

Router(config)#issu linecard reloadversion original 8/0

The following example shows the command executed with the target keyword.

Router# configure terminal

Router(config)#issu linecard reloadversion target 8/0

Cisco CMTS Cable Command Reference

1273
 Cable Commands: i through p
issu linecard reloadversion

Related Commands Command Description

issu linecard abortversion Rolls back to the prior image on working or primary line card.

issu linecard acceptversion Accepts the new image version on the working line card.

issu linecard loadversion Loads a specific image version on the primary line card.

issu linecard prepareversion Determines if the image version on the line card has to be upgraded or
downgraded to the route processor’s image version.

issu linecard runversion Runs the new loaded image on a working or a primary line card.

issu linecard changeversion Starts the upgrade or downgrade activity of the image version for a single
linecard or multiple line cards.

Cisco CMTS Cable Command Reference

1274
 Cable Commands: i through p
issu linecard runversion

issu linecard runversion

To run the new loaded image on a working or a primary line card, use the issu linecard runversion command
in the privileged EXEC mode.

issu linecard runversion lc_slot[/subslot] [forced]

Syntax Description lc_slot The line card slot number.

subslot The line card sub slot number.

forced (Optional) The ISSU would ignore potential service outage and line card incompatibility errors and
proceed with runversion instead of stopping and error handling.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command allows the user to run the new loaded image on a working or a primary line card.

Examples The following example displays the command executed to run the loaded image in the line card slot
7.

Router# configure terminal

Router(config)#issu linecard runversion 7/0

Related Commands Command Description

issu linecard abortversion Rolls back to the prior image on the working/primary line card.

issu linecard acceptversion Accepts the new image version on the working line card.

issu linecard loadversion Loads a specific image version on the primary line card.

issu linecard prepareversion Determines if the image version on the line card has to be upgraded or
downgraded to the route processor’s image version.

issu linecard reloadversion Reloads the new loaded image on a working or a primary line card.

issu linecard changeversion Starts the upgrade or downgrade activity of the image version for a single
linecard or multiple line cards.

Cisco CMTS Cable Command Reference

1275
 Cable Commands: i through p
jitter

jitter
To set session jitter, use the jitter command in cable video configuration mode. To disable session jitter, use
the no form of this command.

jitter {sdv | vod | broadcast | gaming | table-based}value

no jitter {sdv | vod | broadcast | gaming | table-based}value

Command Default None.

Command Modes
Cable video configuration (config-video)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Examples The following example shows how to set session jitter:

Router# configure terminal

Router(config)# cable video
Router(config-video)# jitter gaming 5

Related Commands Command Description

show cable video jitter Displays the session jitter information.

Cisco CMTS Cable Command Reference

1276
 Cable Commands: i through p
join-group

join-group
To join multicast group address, use the join-group command in OOB virtual OM configuration mode. To
void the virtual OM configuration, use the no form of this command.

join-group ip source-ip ip out-group ip

no join-group ip source-ip ip out-group ip

Syntax Description join-group ip Specifies the group IP address.

source-ip ip Specifies the SSM source IP address.

out-group ip Specifies the local OM group IP address.

Command Default None

Command Modes
OOB Virtual OM configuration (config-oob-vom)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to join multicast group address.

Examples The following example shows how to join multicast group address:

Router# configure terminal

Router(config)# cable oob
Router(config-oob)# virtual-om 1
Router(config-oob-vom)# join-group 235.1.1.1 source-ip 2.3.4.5 out-group 239.2.2.2

Related Commands Command Description

virtual-om Defines a virtual OM configuration.

ip Configures the virtual OM source IP address.

Cisco CMTS Cable Command Reference

1277
 Cable Commands: i through p
keepalive

keepalive
To set the default ONID number, use the default-onid command in the video configuration mode.

default-onid number

Syntax Description number The ONID number. By default, the system ONID is 0, which is commonly used in North America.
If the default value of the ONID is used, the TSID must be unique. If you change the ONID, the
TSID-ONID pair must be unique. The ONID must be in the range of 0 to 65535.

Command Default None.

Command Modes Video configuration mode (config-video)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to change the deault system ONID.

The following example shows how to change the default ONID number:
configure terminal
cable video
default-onid 1580

Cisco CMTS Cable Command Reference

1278
 Cable Commands: i through p
lacp fast-switchover

lacp fast-switchover
To enable Link Aggregation Control Protocol (LACP) 1:1 link redundancy, use the lacp fast-switchover
command in interface configuration mode. To disable LACP 1:1 link redundancy, use the no form of this
command.

lacp fast-switchover
no lacp fast-switchover

Syntax Description This command has no arguments or keywords.

Command Default LACP 1:1 link redundancy is disabled by default.

Command Modes Interface configuration (config-if)

Command History Release Modification

Cisco IOS 12.2(33)SCJ This command was introduced.

Usage Guidelines Prior to entering the lacp fast-switchover command, you must ensure the following:
• The port channel protocol type is LACP.
• The lacp max-bundle 1command has been entered on the port channel. The lacp fast-switchover
command will not affect the lacp max-bundle command.

When you enable LACP 1:1 link redundancy, based on the system priority and port priority, the port with the
higher system priority chooses the link as the active link and the other link as the standby link. When the
active link fails, the standby link is selected as the new active link without taking down the port channel.
When the original active link recovers, it reverts to its active link status. During this change-over, the port
channel is also up.

Note We recommend that you configure two ports only (one active and one hot-standby) in the bundle for optimum
performance.

Examples This example shows how to enable LACP 1:1 link redundancy:

Router(config-if)# lacp fast-switchover

Related Commands Command Description

lacp max-bundle Assigns and configures an EtherChannel interface to an EtherChannel group.

show etherchannel Displays the EtherChannel information for a channel.

Cisco CMTS Cable Command Reference

1279
 Cable Commands: i through p
lacp max-bundle

lacp max-bundle
To define the maximum number of active bundled Link Aggregation Control Protocol (LACP) ports allowed
in a port channel, use the lacp max-bundle command in interface configuration mode. To return to the default
settings, use the no form of this command.

lacp max-bundle max-bundles number

no lacp max-bundle

Syntax Description max-bundles Maximum threshold of active member links allowed in the LACP bundle. The range from
is 1 to 8. The maximum threshold value must be greater than or equal to the minimum
threshold value.

Command Default A maximum number of active bundled ports is not configured.

Command Modes Interface configuration (config-if)

Command History Release Modification

Cisco IOS 12.2(33)SCJ Support for this command was introduced.

Usage Guidelines The value specified in the max-bundles argument determines the number of active links that are bundled in
the port channel. The remaining links are in hot-standby mode.

Examples This example shows how to set 3 ports to bundle in port channel 2:

Router(config)# interface port-channel 2

Router(config-if)# lacp max-bundle 3
Router(config-if)#

Related Commands Command Description

interface port-channel Creates a port-channel virtual interface and puts the CLI in interface
configuration mode.

ip address Sets a primary or secondary IP address on an interface.

show etherchannel Displays the EtherChannel information for a channel.

show interfaces port-channel Displays traffic that is seen by a specific port channel.

Cisco CMTS Cable Command Reference

1280
 Cable Commands: i through p
lacp min-bundle

lacp min-bundle
To define the minimum number of active bundled LACP ports allowed in a port channel, use the lacp
min-bundle command in interface configuration mode. To return to the default settings, use the no form of
this command.

lacp min-bundle min-bundle

no lacp min-bundle

Syntax Description min-bundle Minimum threshold of active member links allowed in the LACP bundle. The range is from
1 to 8. The default is 1.

Command Default The port-channel operational state will be “Down” only when there are no active links in the channel. If there
are one or more active links, the port-channel state will be “Up.”

Command Modes Interface configuration (config-if)

Command History Release Modification

Cisco IOS 12.2(33)SCJ This command was introduced.

Usage Guidelines Use the lacp min-bundle command to configure the minimum number of active links allowed in an LACP
bundle. When the number of active links falls below this minimum threshold, the port channel shuts down.

Examples This example shows how to set the minimum number of active links to five ports:
Device(config-if)# lacp min-bundle 5

Related Commands Command Description

interface port-channel Creates a port-channel virtual interface and enters interface configuration
mode.

ip address Sets a primary or secondary IP address on an interface.

show etherchannel Displays the EtherChannel information for a channel.

show interfaces port-channel Displays traffic that is seen by a specific port channel.

Cisco CMTS Cable Command Reference

1281
 Cable Commands: i through p
lacp port-priority

lacp port-priority
To set the LACP priority for a physical interface, use the lacp port-priority command in interface configuration
mode. To return to the default setting, use the no form of this command.

lacp port-priority priority

no lacp port-priority

Syntax Description priority Integer that indicates the priority for the physical interface. The range is from 0 to 65535. The default
is 32768.

Command Default The default port priority is set.

Command Modes Interface configuration (config-if)

Command History Release Modification

Cisco IOS 12.2(33)SCJ This command was introduced.

Usage Guidelines You may assign a port priority to each port on a device running Link Aggregation Control Protocol (LACP).
You can specify the port priority by using the lacp port-priority command at the command-line interface
(CLI) or use the default port priority (32768) that is carried as part of the LACP protocol data unit (PDU)
exchanged with the partner. Port priority is used to decide which ports should be put in standby mode when
a hardware limitation or the lacp max-bundle command configuration prevents all compatible ports from
aggregating. Priority is supported only on port channels with LACP-enabled physical interfaces.

Note A high priority number means a low priority.

Port priority together with port number form a port identifier.

To verify the configured port priority, issue the show lacp command.

Examples This example shows how to set a priority of 23700 for an interface:

Device> enable
Device# configure terminal
Device(config)# interface ethernet 0/0
Device(config-if)# lacp port-priority 23700
Device(config-if)#

Related Commands Command Description

channel-group Assigns and configures an EtherChannel interface to an EtherChannel group.

debug lacp Enables debugging of LACP activities.

Cisco CMTS Cable Command Reference

1282
Cable Commands: i through p
lacp port-priority

Command Description

lacp max-bundle Defines the maximum number of active bundled LACP ports allowed in a port
channel.

lacp system-priority Sets the priority of the system.

show lacp Displays information about LACP activity on the device.

Cisco CMTS Cable Command Reference

1283
 Cable Commands: i through p
lacp system-priority

lacp system-priority
To set the priority for a system, use the lacp system-priority command in global configuration mode. To
return to the default setting, use the no form of this command.

lacp system-priority priority

no lacp system-priority

Syntax Description priority Integer that indicates the LACP priority for the system. The range is from 0 to 65535. The default
is 32768.

Command Default The default system priority is set.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS 12.2(33)SCJ This command was introduced.

Usage Guidelines You can assign a system priority to each device running Link Aggregation Control Protocol (LACP). You
can specify the system priority by using the lacp system-priority command at the command-line interface
(CLI) or use the default system priority (32768) that is carried as part of the LACP protocol data unit (PDU)
exchanged with the partner. System priority is used with the MAC address of the device to form the system
ID and also is used during negotiation with other systems. Priority is supported only on port channels with
LACP-enabled physical interfaces.

Note A high priority number means a low priority.

To verify the configured system priority, issue the show lacp command.

Examples The following example shows how to set a system priority of 25500 for a device:

Router> enable
Router# configure terminal
Router(config)# lacp system-priority 25500

Related Commands Command Description

channel-group Assigns and configures an EtherChannel interface to an EtherChannel group.

debug lacp Enables debugging of LACP activities.

lacp port-priority Sets the priority of a port.

show lacp Displays information about LACP activity on the device.

Cisco CMTS Cable Command Reference

1284
 Cable Commands: i through p
lane start-freq

lane start-freq
To set the start frequency for a specific lane, use the lane start-freq command from frequency profile
configuration mode.

lane lane_idstart-freq start-freq

Syntax Description lane_id Specifies the ID of the lane that the start frequency to be set.

start-freq Configures the start frequency for the lane.

Command Default None

Command Modes
Frequency profile configuration (config-freq-prof)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to set the start frequency for a specific lane.

Examples The following example shows how to set start frequency for a specific lane:

Router# Configure terminal

Router(config)# cable downstream freq-profile 4
Router(config-freq-prof)# lane 1 start-freq 45000000

Related Commands Command Description

cable downstream freq-profile Set the start frequency for a specific lane.

Cisco CMTS Cable Command Reference

1285
 Cable Commands: i through p
lc-control-plane-timeout

lc-control-plane-timeout
To set the interval of monitoring cable line card control plane process restart, use the lc-control-plane-timeout
time command in the process restart configuration mode.

lc-control-plane-timeout time

Syntax Description time Cable line card control plane process restart monitoring interval in seconds.

Command Default None

Command Modes
Process restart configuration (config-process-restart)

Command History Release Modification

IOS-XE 3.18.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the interval of monitoring cable line card control plane process restart.
The following example shows how to set the interval of monitoring cable line card control plane process
restart.

Router# configure terminal

Router(config)# process-restart
Router(config-process-restart)# lc-control-plane-timeout 200

Related Commands Command Description

lc-us-scheduler-timeout Sets the interval of monitoring cable line card upstream scheduler process restart.

restart-retry Sets the retrying times for process restart.

Cisco CMTS Cable Command Reference

1286
 Cable Commands: i through p
lc-us-scheduler-timeout

lc-us-scheduler-timeout
To set the interval of monitoring cable line card upstream scheduler process restart, use the
lc-us-scheduler-timeout time command in the process restart configuration mode.

lc-us-scheduler-timeout time

Syntax Description time Cable line card upstream scheduler process restart monitoring interval in seconds.

Command Default None

Command Modes
Process restart configuration (config-process-restart)

Command History Release Modification

IOS-XE 3.18.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the interval of monitoring cable line card upstream scheduler process restart.
The following example shows how to set the interval of monitoring cable line card upstream scheduler process
restart.

Router# configure terminal

Router(config)# process-restart
Router(config-process-restart)# lc-us-scheduler-timeout 200

Related Commands Command Description

lc-control-plane-timeout Sets the interval of monitoring cable line card control plane process restart.

restart-retry Sets the retrying times for process restart.

Cisco CMTS Cable Command Reference

1287
 Cable Commands: i through p
lcha-preferred

lcha-preferred
To select the LCHA when it is possible, use the lc-control-plane-timeout command in the process restart
configuration mode. To disable this function, use the no form of this command.

lcha-preferred

no lcha-preferred

Command Default None

Command Modes
Process restart configuration (config-process-restart)

Command History Release Modification

IOS-XE 3.18.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command selects the LCHA when it is possible.

The following example shows how to select the LCHA when it is possible.

Router# configure terminal

Router(config)# process-restart
Router(config-process-restart)# lcha-preferred

Related Commands Command Description

disable-auto-restart Disables the automatic process restart.

Cisco CMTS Cable Command Reference

1288
 Cable Commands: i through p
license feature evaluation disable

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 disable Disables an evaluation license for a cable interface line card.

DS_License Disables a downstream evaluation license for a cable interface line card.

US_License Disables an upstream evaluation license for a cable interface line card.

all Disables both downstream and upstream evaluation licenses for a cable interface line
card.

subslot slot/subslot • slot—Slot where the line card resides. The valid range is from 5 to 8.
• subslot—Secondary slot number of the cable interface line card. The valid value
is 0 or 1.

Command Default A cable interface line card evaluation license is disabled by default.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines 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.

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 terminal

Router(config)# license feature evaluation disable all subslot 5/0

The following example shows how to disable a downstream evaluation license for a cable interface
line card on the Cisco uBR10012 router:

Router# configure terminal

Router(config)# license feature evaluation disable DS_License subslot 6/0

Cisco CMTS Cable Command Reference

1289
 Cable Commands: i through p
license feature evaluation disable

The following example shows how to disable an upstream evaluation license for a cable interface
line card on the Cisco uBR10012 router:

Router# configure terminal

Router(config)# license feature evaluation disable US_License subslot 6/1

Related Commands Command Description

license feature evaluation enable Enables an evaluation license for Cisco uBR-MC3GX60V and Cisco
UBR-MC20X20V cable interface line cards.

Cisco CMTS Cable Command Reference

1290
 Cable Commands: i through p
license feature evaluation enable

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 enable Enables an evaluation license for a cable interface line card.

DS_License Enables a downstream evaluation license for a cable interface line card.

US_License Enables an upstream evaluation license for a cable interface line card.

all Enables both downstream and upstream evaluation licenses for a cable interface line
card.

subslot slot/subslot • slot—Slot where the cable interface line card resides. The valid range is from 5
to 8.
• subslot—Secondary slot number of the cable interface line card. The valid value
is 0 or 1.

Command Default A cable interface line card evaluation license is not enabled by default.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines 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.

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 terminal

Router(config)# license feature evaluation enable all subslot 5/0

The following example shows how to enable a downstream evaluation license for a cable interface
line card on the Cisco uBR10012 router:

Router# configure terminal

Router(config)# license feature evaluation enable DS_License subslot 6/0

Cisco CMTS Cable Command Reference

1291
 Cable Commands: i through p
license feature evaluation enable

The following example shows how to enable an upstream evaluation license for a cable interface
line card on the Cisco uBR10012 router:

Router# configure terminal

Router(config)# license feature evaluation enable US_License subslot 6/1

Related Commands Command Description

license feature evaluation disable Disables an evaluation license for Cisco uBR-MC3GX60V and Cisco
UBR-MC20X20V cable interface line cards.

Cisco CMTS Cable Command Reference

1292
 Cable Commands: i through p
linecard

linecard
To define the encryption type of a linecard, use the linecard command in the encryption configuration mode.
To remove the configuration, use the no form of this command.

linecard slot / bay

ca-system {pme scrambler dvs042 | powerkey scrambler des | powerkey scrambler dvb-csa | dvb
scrambler dvb-csa | dualcrypt scrambler dvb-csa}
no linecard slot / bay
ca-system {pme scrambler dvs042 | powerkey scrambler des | powerkey scrambler dvb-csa | dvb
scrambler dvb-csa | dualcrypt scrambler dvb-csa}

Syntax Description slot / bay • slot—Specifies the slot number. The valid range is from 0
to 9.
• bay—Specifies the bay number. The valid value is 0.

ca-system Specifies the encryption type of the virtual carrier group.

• pme—Sets to privacy mode encryption.
• powerkey—Sets to powerkey encryption.
• dvb—Sets to DVB encryption.
• dualcrypt—Sets to Dualcrypt encryption.

pme scrambler dvs042 Specifies the scrambler algorithm for privacy mode encryption.

powerkey scrambler des| dvb-csa Specifies the scrambler algorithm for powerkey encryption.

dvb scrambler dvb-csa Specifies the scrambler algorithm for DVB encryption.

dualcrypt scrambler dvb-csa Specifies the scrambler algorithm for DualCrypt encryption.

Command Default None.

Command Modes Encryption configuration (config-video-encrypt)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband
Routers.

Cisco IOS XE Everest This command was updated to support DualCrypt encryption on the Cisco cBR
16.5.1 Series Converged Broadband Routers.

Usage Guidelines This command defines the encryption type of a linecard.

Examples The following example shows how to configure the encryption for the linecard:

Cisco CMTS Cable Command Reference

1293
 Cable Commands: i through p
linecard

Router# configure terminal

Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#linecard 7/0 ca-system powerkey scrambler des

The following example shows how to configure the Dualcrypt encryption mode:
Router(config)#cable video
Router(config-video)#mgmt-intf VirtualPortGroup 0
Router(config-video)#encryption
Router(config-video-encrypt)#linecard 8/0 ca-system dualcrypt scrambler dvb-csa

Related Commands Command Description

encrypt Enables encryption on a virtual carrier group.

rf-channel Specifies the virtual RF channels in a virtual carrier group.

virtual-edge-input-ip Configures a virtual edge input.

virtual-carrier-group Defines a virtual carrier group.

Cisco CMTS Cable Command Reference

1294
 Cable Commands: i through p
linecard-group (redundancy)

linecard-group (redundancy)
To configure the redundancy group, use the linecard-group command in redundancy configuration mode.
To remove the configuration, use the no form of this command.

linecard-group group-id internal-switch

no linecard-group group-id internal-switch

Syntax Description group-id The line card group identifier. The valid value is 0 on the Cisco cBR-8 Router.

internal-switch Sets the redundancy type to internal switch.

Command Default None.

Command Modes Redundancy configuration (config-red)

Command History Release Modification

IOS-XE Release 3.16.0S This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines Line card group members must be removed before removing the redundancy group configuration.

Examples The following example shows how to configure the redundancy group:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# redundancy
Router(config-red)# linecard-group 0 internal-switch
Router(config-red-lc)#

Related Commands Command Description

class Configures redundancy class on the line card.

description Adds a description to the line card group.

member slot Adds a slot to the line card redundancy group.

redundancy Configures line card redundancy.

show redundancy linecard Displays information about a redundant line card or a line card group.

Cisco CMTS Cable Command Reference

1295
 Cable Commands: i through p
listening-port

listening-port
To configure the listening TCP port, use the listening-port command in the DVB scrambling EIS configuration
mode. To void the listening TCP port configuration, use the no form of this command.

listening-port port
no listening-port port

port Specifies the listening TCP port.

Command Default None

Command Modes DVB scrambling EIS configuration mode (config-video-encrypt-dvb-eis)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to configure the listening TCP port:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#eis EIS-1 id 1
Router(config-video-encrypt-dvb-eis)#listening-port 8890

Related Commands Command Description

cp-overrule Overrules and specifies the crypto period duration.

overwrite-scg Enables Scrambling Control Group (SCG) overwrite.

eis Enters the Event Information Scheduler configuration

mode.

Cisco CMTS Cable Command Reference

1296
 Cable Commands: i through p
logging cmts ipc-cable

logging cmts ipc-cable

To enable debug logging for the cable inter-processor communication (IPC) software, use the logging cmts
ipc-cable command from the global configuration mode. To disable logging of these messages, use the no
form of the command.

Note Use this command for debugging purpose only.

logging cmts ipc-cable log-level

[alertscriticaldebuggingemergencieserrorsinformationalnotificationswarnings]
no logging cmts ipc-cable log-level
[alertscriticaldebuggingemergencieserrorsinformationalnotificationswarnings]

Syntax Description log-level Configures the log severity level. Logs with severity equal to or higher than the specified
log-level are logged in log buffer.

level=emergencies Emergency severity level indicates system is unusable. The default severity level for
emergencies syslog messages is 0.

level=alerts Alerts severity level indicates that immediate action is needed. The default severity level
for alerts syslog messages is 1.

level=critical Critical severity level indicates the critical condition of the system. The default severity
level for critical syslog messages is 2.

level=errors Errors severity level indicates the error conditions. The default severity level for errors
syslog messages is 3.

level=warnings Warning severity level warns the network administrator. The default severity level for
warnings syslog messages is 4.

level=notifications Notification severity level indicates normal but significant condition of the system. The
default severity level for notification syslog messages is 5.

level=informational Informational severity level provides additional information about the system. The
default severity level for informational syslog messages is 6.

level=debugging Debugging severity level provides debugging messages. The default severity level for
debugging syslog messages is 7.

Command Default By default, the log-level is set to ‘errors’.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCF This command was introduced.

Cisco CMTS Cable Command Reference

1297
 Cable Commands: i through p
logging cmts ipc-cable

Usage Guidelines Each cable IPC debug log has a severity level. The logging cmts ipc-cable command allows you to selectively
enable cable IPC debug logs based on the log severities. Each debug log has a debug-enable flag that is set
by the debug cmts ipc-cable command in Privileged EXEC mode. A debug log is recorded only if its severity
is equal to or higher than the configured log-level, and if its debug enable flag is set.

Examples The following example shows how to enable all the cable IPC debug logs:

Router(config)# logging cmts ipc-cable log-level debugging

The following example shows how to disable debug logging for the cable IPC:

Router(config)# no logging cmts ipc-cable log-level debugging

Related Commands Command Description

debug cmts Sets the debug-enable flag for the cable IPC debug logs.
ipc-cable

show cmts ipc-cable Displays statistics of all IPC messages on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

1298
 Cable Commands: i through p
logging cmts sea

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

no logging cmts sea

Syntax Description syslog-level level (Optional) Configures the level of syslog messages inclusive of and above the
specified level which will be stored in the SEA log file.

Possible values for level are: Emergency security level indicates system is unusable. The default severity
level for emergency syslog messages is 0.
level=emergencies

level=alerts Alerts severity level indicates that immediate action is needed. The default
severity level for alerts syslog messages is 1.

level=critical Critical severity level indicates the critical condition of the system. The default
severity level for critical syslog messages is 2.

level=errors Errors severity level indicates the error conditions. The default severity level
for errors syslog messages is 3.

level=warnings Warning severity level warns the network administrator. The severity level
for warning syslog messages is 4.

level=notifications Notification severity level indicates normal but significant condition of the
system. By default severity level for syslog messages is configured as ‘normal’.
The default severity level for notification syslog messages is 5.

level=informational Informational severity level provides additional information about the system.
The default severity level for informational syslog messages is 6.

level=debugging Debugging severity level provides debugging messages. The default severity
level for debugging syslog messages is 7.

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 Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Cisco CMTS Cable Command Reference

1299
 Cable Commands: i through p
logging cmts sea

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 sea

The following example shows how to disable logging of syslog messages to SEA log file on the
Cisco uBR10012 router:

Router(config)# no logging cmts sea

The 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 warning

Related Commands Command Description

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.

Cisco CMTS Cable Command Reference

1300
 Cable Commands: i through p
logical-edge-device

logical-edge-device
To define a logical edge device, use the logical-edge-device command in video configuration mode. To delete
a logical edge device, use the no form of this command.

logical-edge-device name [id id]

no logical-edge-device name [id id]

Syntax Description logical-edge-device name Specifies the logical edge device name.

id id Specifies the logical edge device identifier.

Command Default None.

Command Modes
Video configuration (config-video)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command defines a logical edge device.

Examples The following example shows how to define a logical edge device:

Router# configure terminal

Router(config)# cable video
Router(config-video)# logical-edge-device vod id 1

Related Commands Command Description

protocol Specifies the protocol used in the logical edge device.

show cable video logical-edge-device Displays the logical edge device information.

Cisco CMTS Cable Command Reference

1301
 Cable Commands: i through p
load-interval

load-interval
To change the length of time for which data is used to compute load statistics, use the load-interval command
in MAC domain profile configuration mode, wideband-cable interface profile configuration mode, or
downstream profile configuration mode. To void the configuration, use the no form of this command.

load-interval seconds
no low-latency seconds

Command Default None.

Command Modes
MAC domain profile configuration (config-profile-md)

Wideband-cable interface profile configuration (config-profile-wb)

Downstream profile configuration (config-profile-ds)

Command History Release Modification

Cisco IOS XE Fuji 16.7.1 This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Cisco IOS XE Gibraltar 16.10.1c This command was modified to support downstream profile configuration
mode on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to set load interval:

Router# configure terminal

Router(config)# cable profile mac-domain MD
Router(config-profile-md)# load-interval 30

Cisco CMTS Cable Command Reference

1302
 Cable Commands: i through p
low-latency

low-latency
To set low latency VCG, use the low-latency command in virtual carrier group configuration mode. To disable
low latency VCG, use the no form of this command.

low-latency
no low-latency

Command Default None.

Command Modes
Virtual carrier group configuration (config-video-vcg)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Examples The following example shows how to set low latency VCG:

Router# configure terminal

Router(config)# cable video
Router(config-video)# virtual-carrier-group vod id 1
Router(config-video-vcg)# low-latency

Related Commands Command Description

show cable video low-latency linecard Displays the linecard low latency information

Cisco CMTS Cable Command Reference

1303
 Cable Commands: i through p
mac-addr-filter

mac-addr-filter
To configure MAC filtering, use the mac-addr-filter command in the interface configuration mode. To
disable MAC filtering, use the no form of this command.

mac-addr-filter
no mac-addr-filter

Command Default None

Command Modes
Interface configuration (config-if)

Command History Release Modification

IOS-XE 3.18.1SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to configure the MAC filtering for a backhaul interface:

Router# configure terminal

Router(config)# interface tenGigabitEthernet 4/1/0
Router(config-if)#mac-addr-filter
Router(config-if)#end

Related Commands Command Description

show platform software iomd Verifies the MAC filtering status.

Cisco CMTS Cable Command Reference

1304
 Cable Commands: i through p
mac-address

mac-address
To define the MAC address for a logical edge device, use the mac-address command in the logical edge
device protocol configuration mode. To reset to default configuration, use the no form of this command.

mac-address mac-address
no mac-address mac-address

Syntax Description mac-address Specifies the MAC address for a logical edge device.

Command Default None

Command Modes
Logical edge device protocol configuration (config-video-led-protocol)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Each logical edge device requires a unique MAC address. MAC address is required only when you configure
the logical edge device with GQI protocol.

Tip Use the following command to get the chassis MAC address:
show diag all eeprom detail | include MAC

Chassis MAC Address : 54a2.120e.3000

MAC Address block size : 1024

Increment the least significant digit of the Chassis MAC address to give a unique identifier (mac-address) for
each logical edge device. Example: 54a2.120e.3001.
The MAC address for a logical edge device should be unique with respect to the GQI server and it should not
relate to a real MAC address.

Examples The following example shows how to define the MAC address for a logical edge device:

Router# configure terminal

Router(config)# cable video
Router(config-video)#logical-edge-device vod id 1
Router#(config-video-led)protocol gqi
Router#(config-video-led-protocol)mac-address 0800.270e.25b8

Related Commands Command Description

logical-edge-device Defines a logical edge device.

Cisco CMTS Cable Command Reference

1305
 Cable Commands: i through p
mac-address

Command Description

protocol Specifies the protocol used in the logical edge device.

mgmt-ip Defines the local management IP address for a logical edge device.

server Defines the server IP address of the session resource manager.

vcg Specifies the virtual carrier group assigned to the logical edge
device.

virtual-edge-input-ip Defines a virtual edge input.

show cable video logical-edge-device Displays the logical edge device information.

show cable video gqi connections Displays the GQI connection information of the logical edge
device with the Session Resource Manager.

show diag all eeprom detail | include Displays the chassis MAC address information.
MAC

Cisco CMTS Cable Command Reference

1306
 Cable Commands: i through p
mgmt-intf virtualportgroup

mgmt-intf virtualportgroup
To configure the cable video management interface, use the mgmt-intf virtualportgroup command in the
video configuration mode. To delete the management interface created, use the no form of the command.

mgmt-intf virtualportgroup number

no mgmt-intf virtualportgroup number

Syntax Description VirtualPortGroup number Defines the specified Virtual Port Group as the management interface. Valid
range is 0 to 31.

Command Default None.

Command Modes Video configuration mode (config-video)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to configure the cable video management interface.

The following example shows how to change the default ONID number:
Router#configure terminal
Router(config)#cable video
Router(config-video)#mgmt-intf VirtualPortGroup0

Related Commands Command Description

interface virtualportgroup Defines a VirtualPortGroup interface.

show run interface virtualportgroup Displays the VirtualPortGroup interface configuration.

show run | include mgmt-intf Displays the cable video management interface configuration.

show interfaces virtualportgroup Displays the VirtualPortGroup interface state.

Cisco CMTS Cable Command Reference

1307
 Cable Commands: i through p
main-cpu

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 or Supervisor cards, use the main-cpu
command in redundancy configuration mode.

main-cpu

Syntax Description This command has no keywords or arguments.

Command Default No default behavior or values

Command Modes
Redundancy configuration (config-r)

Cisco RF Gateway 10

Redundancy configuration (config-red)

Command History Release Modification

12.2(4)XF This command was introduced for the Cisco uBR10012 router.

12.2(11)BC3 Support for the switchover timeout command was added.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

12.2(44)SQ This command was integrated into Cisco IOS Release 12.2(44)SQ. Support for the Cisco
RF Gateway 10 was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

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 or Supervisor cards. 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:

Cisco CMTS Cable Command Reference

1308
 Cable Commands: i through p
main-cpu

Router# config t

Router(config)# redundancy

Router(config-r)# main-cpu

Router(config-r-mc)# ?

Main Cpu redundancy configuration commands:

auto-sync Sync elements
exit Exit from main-cpu configuration mode
no Negate a command or set its defaults
switchover Configuration of switchover
Router(config-r-mc)#

Cisco RF Gateway 10
The following example shows how to enter main-CPU redundancy mode, and its associated commands:

Router# configure terminal

Router(config)# redundancy

Router(config-red)# main-cpu

Router(config-r-mc)# ?

Main CPU redundancy configuration commands:

auto-sync Sync elements
default Set a command to its defaults
exit Exit from main-cpu configuration mode
no Negate a command or set its defaults

Related Commands Command Description

associate slot Logically associate slots for APS processor redundancy

auto-sync Configures which files are synchronized between the active and standby PRE1 modules
or Supervisor cards.

redundancy Enters redundancy configuration mode.

switchover timeout Configures the switchover timeout period of the PRE1 module.

Cisco CMTS Cable Command Reference

1309
 Cable Commands: i through p
maintenance-mode

maintenance-mode
To configure the PRE1 modules on the router for maintenance mode, use the maintenance-mode command
in redundancy configuration mode. To return to normal operations, use the no form of this command.

maintenance-mode
no maintenance-mode

Syntax Description This command has no keywords or arguments.

Command Default Normal operations (no maintenance-mode)

Command Modes
Redundancy configuration

Command History Release Modification

12.2(4)XF This command was introduced for the Cisco uBR10012 router.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines When the Cisco uBR10012 router is configured with redundant PRE1 modules, the active PRE1 module
automatically synchronizes the configuration, network state information, and other information with the
standby PRE1 module, so that if a switchover occurs, the standby module can restore normal operations
quickly. You can use the maintenance-mode command to disable this automatic synchronization of the PRE1
modules, and to disable the reporting of any faults on the standby module to the active module.

Note The maintenance-mode command disables the ability of the Cisco uBR10012 router to switchover PRE1
modules and should be used only while upgrading the router or troubleshooting network problems.

Examples The following example shows how to disable the automatic PRE1 module synchronization on the
Cisco uBR10012 router and enter maintenance mode:

Router# config t

Router(config)# redundancy

Router(config-r)# maintenance-mode
Router(config-r)# exit
Router(config)#

The following example shows how to leave maintenance mode and return to normal operations,
which includes the automatic synchronization of the PRE1 modules:

Router# config t

Router(config)# redundancy

Cisco CMTS Cable Command Reference

1310
 Cable Commands: i through p
maintenance-mode

Router(config-r)# no maintenance-mode
Router(config-r)# exit
Router(config)#

Related Commands Command Description

auto-sync Configures which files are synchronized between the active and standby PRE1 modules.

redundancy Enters redundancy configuration mode.

Cisco CMTS Cable Command Reference

1311
 Cable Commands: i through p
match

match
To configure the matching option for the DHCP IPv4 profile, use the matchcommand in DHCP IPv4 profile
configuration mode. To void the configuration, use the noform of this command.

match option { 43 suboption type | hex value | | 60 hex value }

no match option { 43 suboption type | hex value | | 60 hex value }

Syntax Description option Specifies the matching option.

suboptiontype Specifies the suboption for the option 43.

hexvalue Specifies the HEX pattern

Command Default None.

Command Modes
DHCP IPv4 profile configuration (config-dhcpv4-profile)

Release Modification

IOS XE Fuji 16.8.1 Thiscommand was introduced on the Cisco cBR Series
Converged Broadband Routers.

Examples The following example shows how to configure the matching option:

Router# configure terminal

Router(config)# cable dhcp ipv4 profile DEVICE1
Router(config-dhcpv4-profile)# match option 43 suboption 100 hex 123456
Router(config-dhcpv4-profile)# match option 60 hex *efef*

Related Commands Command Description

cable dhcp ipv4 profile Enters the IPv4 DHCP profile configuration mode.

Cisco CMTS Cable Command Reference

1312
 Cable Commands: i through p
match rule

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 [ipv4ipv6] [source-prefix] [group-prefix] priority [priority-value] [permitdeny]

no match rule [ipv4ipv6] [source-prefix] [group-prefix] priority [priority-value] [permitdeny]

Syntax Description match rule [ipv4 | ipv6] Specifies the matching source rule.
Though CLI allows IPv6 to be configured, only IPv4 is supported in the CMTS.

source-prefix (Optional) Specifies the matching source address prefix.

Example: 223.1.1.1/16

group-prefix (Optional) Specifies the matching group address prefix.

Example: 223.1.1.1/16

priority [priority-value] Specifies the priority of the cable multicast authorization profile.
Priority value range is: 0-255.

permit The argument permit allows specified packets to be forwarded.

deny The argument deny allows to specified packets to be rejected.

Command Default Cable multicast authorization is disabled.

Command Modes
Interface configuration—cable interface only (config-mauth)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines This command specifies the cable multicast authorization profile match to be used.

Examples The following example shows how to use the selected multicast authorization profile match:

Router(config-mauth)# match rule rule1

Cisco CMTS Cable Command Reference

1313
 Cable Commands: i through p
match rule

Related Commands Command Description

cable multicast authorization enable This command enables the cable multicast authorization features.
default-action If the multicast authorization feature is disabled, all defined
authorization profiles are ineffective.

cable multicast authorization Defines the cable multicast authorization profile.

profile-name

show cable multicast authorization Displays the list of defined multicast authorization profiles and
all CMs associated with corresponding profiles.

Cisco CMTS Cable Command Reference

1314
 Cable Commands: i through p
max-carrier

max-carrier
To specify the maximum number of carriers, use the max-carrier command in the controller sub configuration
mode.

max-carrier value

Syntax Description value Value for the maximum number of carriers. Valid range is from 0 to 128.

Command Default The default value is 128.

Command Modes Controller sub configuration mode (config-controller).

Command History Release Modification

IOS-XE 3.15.0S This command was introduced.

Usage Guidelines This command is used to specify the maximum number of carriers on an RF port.

router#configure terminal
router (config)#controller Integrated-Cable 3/0/0
router (config-controller)#max-carrier 96
router (config-controller)#end
router #show controllers Integrated-Cable 3/0/0 rf-port

Admin: UP MaxCarrier: 96 BasePower: 32 dBmV Mode: normal

Cisco CMTS Cable Command Reference

1315
 Cable Commands: i through p
max-comp-time

max-comp-time
To configure the maximum time needed by ECMG to compute an ECM, use the max-comp-time command
in the DVB scrambling ECMG overrule configuration mode. To void the maximum time configuration, use
the no form of this command.

max-comp-time time
no max-comp-time

max-comp-time time Specifies the maximum computing time in

millisecond.

Command Default None

Command Modes DVB scrambling ECMG overrule configuration mode (config-video-encrypt-dvb-ecmg-overrule)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines This command specifies the maximum time needed by ECMG to compute an ECM in milliseconds. The valid
range is from 0 to 60000.

The following is an example of how to configure the maximum computing time:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#overrule
Router(config-video-encrypt-dvb-ecmg-overrule)#max-comp-time 10000

Related Commands Command Description

overrule Enters DVB scrambling configuration mode.

ac-start-delay Specifies the time between start of first CP after a

change in AC and start of ECM broadcast.

ac-stop-delay Specifies the time between end of last CP preceding

a change in AC and end of ECM broadcast.

max-streams Specifies the maximum number of simultaneous open

streams supported by the ECMG on a channel.

min-cp-duration Specifies the minimum crypto period.

Cisco CMTS Cable Command Reference

1316
Cable Commands: i through p
max-comp-time

Command Description

rep-period Specifies the time between two ECM packets at the

output.

start-delay Specifies the delay between the start of CP and ECM

broadcast.

stop-delay Specifies the delay between the end of CP and ECM

broadcast.

trans-start-delay Specifies the transition start delay.

trans-stop-delay Specifies the transition stop delay.

Cisco CMTS Cable Command Reference

1317
 Cable Commands: i through p
max-ofdm-spectrum

max-ofdm-spectrum
To specify the maximum spectrum used by all the OFDM channels on the given port, use the
max-ofdm-spectrum command in controller configuration mode. To undo the maximum spectrum assignment,
use no form of this command.

max-ofdm-spectrum value

no max-ofdm-spectrum

Syntax Description value Maximum OFDM spectrum value (Hz), in 1 MHz increments. Valid range is from 24000000 to
1170000000.

Command Default None.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the maximum spectrum used by all the OFDM channels on the given port.

Examples The following example shows how to specify the maximum spectrum used by all the OFDM channels
on the given port:

Router# configure terminal

Router(config)# controller integrated-cable 3/0/0
Router(config-controller)# max-ofdm-spectrum 24000000

Cisco CMTS Cable Command Reference

1318
 Cable Commands: i through p
max-streams

max-streams
To configure the maximum number of simultaneous open streams supported by the ECMG on a channel, use
the max-streams command in the DVB scrambling ECMG overrule configuration mode. To void the maximum
number configuration, use the no form of this command.

max-streams number
no max-streams

max-streams number Specifies the maximum number of simultaneous open

streams supported by the ECMG on a channel.

Command Default None

Command Modes DVB scrambling ECMG overrule configuration mode (config-video-encrypt-dvb-ecmg-overrule)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines This command specifies the maximum number of simultaneous open streams supported by the ECMG on a
channel. The valid range is from 0 to 30000.

The following is an example of how to configure the maximum number of simultaneous open streams
supported by the ECMG on a channel:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#overrule
Router(config-video-encrypt-dvb-ecmg-overrule)#max-streams 10000

Related Commands Command Description

overrule Enters DVB scrambling configuration mode.

ac-start-delay Specifies the time between start of first CP after a

change in AC and start of ECM broadcast.

ac-stop-delay Specifies the time between end of last CP preceding

a change in AC and end of ECM broadcast.

max-comp-time Specifies the maximum time needed by ECMG to

compute an ECM.

min-cp-duration Specifies the minimum crypto period.

Cisco CMTS Cable Command Reference

1319
 Cable Commands: i through p
max-streams

Command Description

rep-period Specifies the time between two ECM packets at the

output.

start-delay Specifies the delay between the start of CP and ECM

broadcast.

stop-delay Specifies the delay between the end of CP and ECM

broadcast.

trans-start-delay Specifies the transition start delay.

trans-stop-delay Specifies the transition stop delay.

Cisco CMTS Cable Command Reference

1320
 Cable Commands: i through p
member slot

member slot
To add a line card as a primary or secondary card in a redundancy group, use the member slot command in
line card redundancy configuration sub-mode. To remove the configuration, use the no form of this command.

member slot slot { primary | secondary }

no member slot slot { primary | secondary }

Syntax Description slot Slot number of the line card. The range is from 0 to 3 and 6 to 9 on the Cisco cBR-8 router.

primary Specifies the primary slot of the line card group.

secondary Specifies the secondary slot of the line card group.

Command Default None.

Command Modes Line card redundancy configuration (config-red-lc)

Command History Release Modification

IOS-XE Release 3.16.0S This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines We can only add the secondary card (protect card) after which there should be at least one primary member
in the group. You can add a single secondary card for multiple primary cards.

Note You cannot remove the last primary member if there is secondary member in redundancy group. You should
remove the secondary member first in such case. If the primary card is in Standby role, you must revert back
to it before removing.

When a line card is added as secondary card, the line card will be reloaded automatically. On the Cisco cBR-8
router, slot 3 and 6 cannot be configured as secondary card. Only the line card with CBR-RF-PROT-PIC
installed could be set as secondary card. In addition, only the line card with CBR-RF-PIC installed could be
set as primary card.
The CBR-RF-PROT-PIC can only send RF signals to lower slot (with larger slot number). So the slot number
of the secondary card must be the smallest one in the line card redundancy group.
It is recommended to install the PROT-PIC in slot 0 and make line card 0 as secondary. The RF signal can
only be relayed from upper slot to lower slot by CBR-RF-PIC. So, do not install any RF blank PICs between
the secondary and primary cards.

Examples The following example shows how to add the line card as a primary card in the redundancy group:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# redundancy
Router(config-red)# linecard-group 0 internal-switch

Cisco CMTS Cable Command Reference

1321
 Cable Commands: i through p
member slot

Router(config-red-lc)# member slot 1 primary

The following example shows how to add the line card as a primary card in the redundancy group:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# redundancy
Router(config-red)# linecard-group 0 internal-switch
Router(config-red-lc)# member slot 0 secondary

Related Commands Command Description

class Configures redundancy class on the line card.

description Adds a description to the line card group.

linecard-group internal-switch Creates a line card group for the line card.

redundancy Configures line card redundancy.

show redundancy linecard Displays information about a redundant line card or a line card group.

Cisco CMTS Cable Command Reference

1322
 Cable Commands: i through p
method

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.

Cisco uBR Series Router

method {modems | service-flows | utilization}us-method {modems | service-flows | utilization}
no method

Cisco cBR Series Router

method {modems | service-flows | utilization}us-method {modems | utilization}
no method

Syntax Description modems Specifies the load balancing method for the number of modems on the
CMTS.

service-flows Specifies the load balancing method for the number of service flows on
the CMTS.

utilization Specifies the load balancing method for the interface utilization on the
CMTS.

us-method {modems | Specifies the load balancing method for upstream (US) channels on
service-flows | utilization} modems, service-flows, or utilization.
Note
service-flows method is not supported in Cisco cBR-8 router.

Command Default No default behavior or values.

Command Modes
DOCSIS load balancing group mode (config-lb-group)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The service-flows keyword was removed.

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 terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1

Cisco CMTS Cable Command Reference

1323
 Cable Commands: i through p
method

Router(config-lb-group)# method modems us-method service-flows

Router(config-lb-group)#

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1324
 Cable Commands: i through p
mgmt-ip

mgmt-ip
To define the local management IP address for a logical edge device, use the mgmt-ip command in the logical
edge device protocol configuration mode. To reset to default configuration, use the no form of this command.

Note The mgmt-ip address should be in the same subnet as the IP address of interface VirtualPortGroup.

mgmt-ip ip-address
no mgmt-ip ip-address

Syntax Description ip-address Specifies the local management IP address.

Command Default None

Command Modes
Logical edge device protocol configuration (config-video-led-protocol)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command defines the local management IP address for a logical edge device.

Examples The following example shows how to define the local management IP address for a logical edge
device:

Router# configure terminal

Router(config)# cable video
Router(config-video)#logical-edge-device vod id 1
Router#(config-video-led)protocol gqi
Router#(config-video-led-protocol)mgmt-ip 172.16.0.1

Related Commands Command Description

logical-edge-device Defines a logical edge device.

protocol Specifies the protocol used in the logical edge device.

mac-address Defines the MAC address for a logical edge device.

server Defines the server IP address of the session resource manager.

vcg Specifies the virtual carrier group assigned to the logical edge
device.

virtual-edge-input-ip Defines a virtual edge input.

Cisco CMTS Cable Command Reference

1325
 Cable Commands: i through p
mgmt-ip

Command Description

show cable video logical-edge-device Displays the logical edge device information.

show cable video gqi connections Displays the GQI connection information of the logical edge
device with the Session Resource Manager.

show diag all eeprom detail | include Displays the chassis MAC address information.
MAC

Cisco CMTS Cable Command Reference

1326
 Cable Commands: i through p
mgmt-ip (DVB)

mgmt-ip (DVB)
To configure the manangement IP for EIS/Broadcast ECMG, use the mgmt-ip command in the DVB scrambling
configuration mode. To void the manangement IP configuration, use the no form of this command.

mgmt-ip ip_address
no mgmt-ip

ip_address Specifies the management IP for EIS and Broadcast

ECMG Connection.

Command Default None

Command Modes DVB scrambling configuration mode (config-video-encrypt-dvb)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to configure the manangement IP for EIS/Broadcast ECMG:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#mgmt-ip 1.24.2.10

Related Commands Command Description

dvb Enters DVB scrambling configuration mode.

strong-pairing-enforce Switches on the NDS strong pairing enforcement

check-scg-at-prov Enables Check SCG at provision time.

scramble-video-audio Scrambles only video and audio pids.

route-ecmg Configures the route to the ECMG server.

ca-interface Configures the conditional access interface.

tier-based Enters the tier-based scrambling configuration mode.

ecmg Enters the ECM Generator configuration mode.

eis Enters the Event Information Scheduler configuration

mode.

Cisco CMTS Cable Command Reference

1327
 Cable Commands: i through p
microcode (uBR10012)

microcode (uBR10012)
To reload the microcode software images on a Parallel eXpress Forwarding (PXF) processor or on all line
cards that support downloadable microcode, use the microcode command in global configuration mode.

microcode {pxf filename | reload}

Syntax Description pxf Reloads the microcode for the PXF processors on the Performance Routing Engine (PRE1) module.

filename Specifies the microcode software image for the PXF processors by device name and filename.

reload Reloads the microcode for all PRE1 modules and other line cards that support downloadable
microcode software images.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(1)XF1 This command was introduced for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines By default, the Cisco uBR10012 router automatically loads all required microcode on to the PXF processors
and other line cards when it loads the Cisco IOS software image. Also, the PRE1 module automatically reloads
the microcode on a card when certain faults occur, allowing the card to recover from the fault.
You can reload the microcode on the PRE1 module or on all line cards that support downloadable microcode
by using the microcode command. Typically, this is not needed and should be done only upon the advice of
Cisco TAC or field service engineers.

Tip You can also reload the microcode on the PXF processors or on all cards using the microcode reload command
in privileged EXEC mode. In particular, use the microcode reload command to reload the PXF processors
with the default microcode that was loaded along with the Cisco IOS software image.

Examples The following example shows how to reload the microcode on all PRE processors and line cards that
support downloadable microcode:

Router# configure terminal

Router(config)# microcode reload

Reload microcode? [confirm] yes

00:49:41: Downloading Microcode: file=system:pxf/ubr10k-ucode.1.2.3,

version=1.1.0, description=Release Software created Wed 17-Jul-02 16:58
<<list of interfaces going down or coming up>>

Cisco CMTS Cable Command Reference

1328
 Cable Commands: i through p
microcode (uBR10012)

00:49:42: !!pxf clients started, forwarding code operational!!

Router(config)#

The following example shows how to reload the microcode on the PXF processors on the PRE1
module, using a specific image that is stored in the Flash memory:

Router# configure terminal

Router(config)# microcode pxf flash:pxf/ubr10k-ucode.122.1.2.3

Reload microcode? [confirm] yes

1d04h: Downloading Microcode: file=flash:pxf/ubr10k-ucode.122.1.2.3, version=122.1.2.3,

description=Release Software created Thu 17-Oct-02 11:33
<<list of interfaces going down or coming up>>
1d04h: !!pxf clients started, forwarding code operational!!
Router(config)#

Related Commands Command Description

hw-module reset Resets a particular PRE1 module or a particular line card.

microcode reload Reloads the microcode software images on one or all line cards that support
downloadable microcode.

show pxf microcode Displays display identifying information for the microcode being used on the PXF
processors.

Cisco CMTS Cable Command Reference

1329
 Cable Commands: i through p
microcode reload (uBR10012)

microcode reload (uBR10012)

To reload the microcode software images on one or all line cards that support downloadable microcode, use
the microcode reload command in privileged EXEC mode.

microcode reload {all | pxf} device: [filename]

Syntax Description all Reloads the microcode for all Performance Routing Engine (PRE1) modules and other
line cards that support downloadable microcode software images.

pxf Reloads the microcode for the Parallel eXpress Forwarding (PXF) processors on the PRE1
module.

device: (Optional) Loads the PXF processors with the microcode software image that has the
[filename] specific filename on the specific device. If no filename is specified, the first image found
on the device is loaded by default.

Command Default For microcode reload pxf, defaults to loading the microcode image that was originally loaded when the Cisco
IOS software image was loaded.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(1)XF1 This command was introduced for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines By default, the Cisco uBR10012 router automatically loads all required microcode on to the PXF processors
and other line cards when it loads the Cisco IOS software image. Also, the PRE1 module automatically reloads
the microcode on a card when certain faults occur, allowing the card to recover from the fault.
You can reload the microcode on the PRE1 module or on all line cards that support downloadable microcode
by using the microcode reload command. Typically, this is not needed and should be done only upon the
advice of Cisco TAC or field service engineers.

Tip You can also reload the microcode on the PXF processors or on all cards using the microcode command in
global configuration mode.

Examples The following example shows how to reload the microcode on all PRE processors and line cards that
support downloadable microcode:

Router# microcode reload all

Reload microcode? [confirm] yes

00:49:41: Downloading Microcode: file=system:pxf/ubr10k-1-ucode.122.1.0, version=122.1.0,

Cisco CMTS Cable Command Reference

1330
 Cable Commands: i through p
microcode reload (uBR10012)

description=Release Software created Wed 17-Jul-02 16:58

<<list of interfaces going down or coming up>>
00:49:42: !!pxf clients started, forwarding code operational!!
Router#

The following example shows a typical list of devices that you can use when loading microcode for
the PXF processors. This list might vary, depending on whether a standby PRE1 module is installed
and depending on the version of Cisco IOS software being used.

Router# microcode reload pxf ?

bootflash: location of microcode

disk0: location of microcode
disk1: location of microcode
flash: location of microcode
ftp: location of microcode
null: location of microcode
nvram: location of microcode
rcp: location of microcode
scp: location of microcode
sec-bootflash: location of microcode
sec-disk0: location of microcode
sec-disk1: location of microcode
sec-nvram: location of microcode
sec-slot0: location of microcode
sec-slot1: location of microcode
slot0: location of microcode
slot1: location of microcode
system: location of microcode
tftp: location of microcode
<cr>
Router#

The following example shows how to reload the microcode on the PXF processors on the PRE1
module, using a specific image that is stored in the Flash memory:

Router# microcode reload pxf flash:pxf/ubr10k-1-ucode.122.1.0.4

Reload microcode? [confirm] yes

3d00h: Downloading Microcode: file=flash:pxf/ubr10k-1-ucode.122.1.0.4, version=122.1.0.4,

description=Release Software created Thu 27-Jun-02 16:05
<<list of interfaces going down or coming up>>
3d00h: !!pxf clients started, forwarding code operational!!
Router#

Related Commands Command Description

hw-module reset Resets a particular PRE1 module or a particular line card.

microcode Reloads the microcode software images on one or all line cards that support
downloadable microcode.

show pxf microcode Displays display identifying information for the microcode being used on the PXF
processors.

Cisco CMTS Cable Command Reference

1331
 Cable Commands: i through p
min-cp-duration

min-cp-duration
To configure the minimum crypto period, use the min-cp-duration command in the DVB scrambling ECMG
overrule configuration mode. To void the minimum crypto period configuration, use the no form of this
command.

min-cp-duration time
no min-cp-duration

min-cp-duration time Specifies the minimum crypto period in milliseconds.

Command Default None

Command Modes DVB scrambling ECMG overrule configuration mode (config-video-encrypt-dvb-ecmg-overrule)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines This command specifies the minimum crypto period in milliseconds. The valid range is from 1000 to 3600000.

The following is an example of how to configure the minimum crypto period in milliseconds:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#overrule
Router(config-video-encrypt-dvb-ecmg-overrule)#min-cp-duration 10000

Related Commands Command Description

overrule Enters DVB scrambling configuration mode.

ac-start-delay Specifies the time between start of first CP after a

change in AC and start of ECM broadcast.

ac-stop-delay Specifies the time between end of last CP preceding

a change in AC and end of ECM broadcast.

max-comp-time Specifies the maximum time needed by ECMG to

compute an ECM.

max-streams Specifies the maximum number of simultaneous open

streams supported by the ECMG on a channel.

Cisco CMTS Cable Command Reference

1332
Cable Commands: i through p
min-cp-duration

Command Description

rep-period Specifies the time between two ECM packets at the

output.

start-delay Specifies the delay between the start of CP and ECM

broadcast.

stop-delay Specifies the delay between the end of CP and ECM

broadcast.

trans-start-delay Specifies the transition start delay.

trans-stop-delay Specifies the transition stop delay.

Cisco CMTS Cable Command Reference

1333
 Cable Commands: i through p
mode

mode
To configure the application mode of ECMG, use the mode command in the DVB scrambling ECMG
configuration mode. To void the ECMG application mode configuration, use the no form of this command.

mode {broadcast | tier-based | vod linecard slot/bay}

no mode

broadcast Specifies the ECM application mode broadcast.

tier-based Specifies the ECM application mode tier-based.

vod Specifies the ECM application mode VOD.

slot/bay Specifies the slot and bay of the linecard.

Command Default None

Command Modes DVB scrambling ECMG configuration mode (config-video-encrypt-dvb-ecmg)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to configure the application mode of ECMG:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#mode vod linecard 7/0

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

auto-channel-id Enables automatic channel ID selection.

connection Configures the ECMG connection.

ecm-pid-source Configures the source of ECM PID.

ca-system-id Configures the CA system ID.

type Configures the ECMG type.

desc-rule Configures the descriptor rule.

Cisco CMTS Cable Command Reference

1334
Cable Commands: i through p
mode

Command Description

overrule Overrules the default settings.

Cisco CMTS Cable Command Reference

1335
 Cable Commands: i through p
modular-host subslot

modular-host subslot
To specify the modular-host line card that will be used foe DOCSIS 3.0 downstream or downstream channel
bonding operations, use the modular-host subslot command in controller configuration mode. To remove
the modular-host line card used for DOCSIS 3.0 downstream or downstream channel bonding operations, use
the no form of this command.

modular-host subslot slot/subslot

no modular-host subslot slot/subslot

Syntax Description slot/subslot The location of the modular-host line card.

Command Default No modular-host line card is configured for DOCSIS 3.0 downstream or downstream channel bonding
operations.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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 A maximum of 3 SPA controllers can be hosted on a single cable interface line card.

Examples The following example shows how to configure the modular-host line card for DOCSIS 3.0
downstream channel bonding operations for the Wideband SPA located in slot/subslot/bay 1/0/0:

Router(config)# controller modular-cable 1/0/0

Router(config-controller)# modular-host subslot 7/0

Related Commands Command Description

annex modulation Sets the annex and modulation for the Wideband SPA.

Cisco CMTS Cable Command Reference

1336
Cable Commands: i through p
modular-host subslot

Command Description

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband

channel.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

ip-address (controller) Sets the IP address of the Wideband SPA FPGA.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address and UDP port for each RF
udp-port channel.

rf-channel network delay Specifies the CIN delay for each RF channel.

rf-channel description Specifies the description for each RF channel.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

Cisco CMTS Cable Command Reference

1337
 Cable Commands: i through p
modulation

modulation
To set the QAM modulation format for a specific QAM profile, use the annex command in QAM profile
configuration mode.

modulation {256 | 64}

Syntax Description modulation {256| 64} Specifies the QAM modulation format:
• 256– 256-QAM modulation.
• 64– 64-QAM modulation.

Command Default None

Command Modes
QAM profile configuration (config-qam-prof)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to set the QAM modulation format for a specific QAM profile.

Examples The following example shows how to set the QAM modulation format for a specific QAM profile:

Router# configure terminal

Router(config)# cable downstream qam-profile 4
Router(config-qam-prof)# modulation 256

Related Commands Command Description

cable downstream qam-profile Set the QAM profile for the cable interface line card.

interleaver-depth Set the interleaver-depth.

annex Set the MPEG framing format.

spectrum-inversion Set the spectrum-inversion on or off.

symbol-rate Set the symbol rate.

Cisco CMTS Cable Command Reference

1338
 Cable Commands: i through p
monitoring-basics

monitoring-basics
To specify the type of monitoring for subscriber traffic management on a Cisco CMTS router, use the
monitoring-basics command in enforce-rule configuration mode. To disable the selected monitoring, use the
no form of this command.

monitoring-basics {legacy | peak-offpeak} {docsis10 | docsis11}

no monitoring-basics {legacy | peak-offpeak} {docsis10 | docsis11}

Syntax Description legacy Provides only one threshold and one monitoring duration.

peak-offpeak Allows the selection of two peak durations within a day.

docsis10 Specifies application of the enforce-rule to DOCSIS 1.0 cable modems.

docsis11 Specifies application of the enforce-rule to DOCSIS 1.1 cable modems.

Command Default The default for this command is legacy and docsis10.

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.3(9a)BC This command was introduced.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Legacy monitoring (using the legacy keyword) occurs 24 hours a day, with no distinction between peak and
offpeak hours. The available monitoring duration is between 10 minutes and 31 days.
Use the peak-offpeak keyword to set up monitoring duration and threshold for first peak, second peak, and
offpeak monitoring. Each one can be different. After setting up first peak and second peak durations, the
remaining hours are treated as offpeak. Monitoring happens during offpeak hours if the offpeak duration and
threshold are defined. Monitoring duration is between 60 minutes and 23 hours.

Examples The following example shows configuration of peak-offpeak monitoring for DOCSIS 1.1 cable
modems:

Router(enforce-rule)# monitoring-basics peak-offpeak docsis11

The following example shows configuration of legacy monitoring for DOCSIS 1.1 on a Cisco cBR
Series Converged Broadband Router:
Router(enforce-rule)#monitoring-basics legacy docsis11

Cisco CMTS Cable Command Reference

1339
 Cable Commands: i through p
monitoring-basics

Related Commands Command Description

cable qos enforce-rule Creates an enforce-rule to enforce a particular QoS profile for
subscriber traffic management and enters enforce-rule configuration
mode.

debug cable subscriber-monitoring Displays enforce-rule debug messages for subscriber traffic
management on the Cisco CMTS routers.

duration Specifies the time period and sample rate to be used for monitoring
subscribers.

peak-time1 Specifies peak and offpeak monitoring times.

qos-profile registered Specifies the registered QoS profile that should be used for this
enforce-rule.

qos-profile enforced Specifies a QoS profile that should be enforced when users violate
the registered QoS profiles.

service-class (enforce-rule) Identifies a particular service class for cable modem monitoring in an
enforce-rule.

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1340
 Cable Commands: i through p
monitoring-duration

monitoring-duration

Note Effective with Cisco IOS Release 12.3(9a)BC, the monitoring-duration command is replaced by the duration
command.

To specify the time period and sample rate to be used for monitoring subscribers, use the monitoring-duration
command in enforce-rule configuration mode. To reset an enforce-rule to its default values, use the no form
of this command.

monitoring-duration minutes [sample-rate minutes]

no monitoring-duration

Syntax Description minutes Specifies the time (in minutes). The valid range is 10 to 10080, with a default of 360
(6 hours).

sample-rate minutes (Optional) Rate of sampling, in minutes. The valid range is 1 to 30, with a default
value of 15.

Command Default The monitoring-duration value defaults to 360 minutes (6 hours), and the sample-rate value defaults to 15
minutes.

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.2(15)BC2 The minimum sample-rate was reduced to 1 minute. Also, the sample-rate is not allowed
to be set to a value greater than the monitoring-duration period. If you attempt to do so,
the command is ignored and both parameters remain set to their current values.

12.3(9a)BC This command was replaced by the duration command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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.

Cisco CMTS Cable Command Reference

1341
 Cable Commands: i through p
monitoring-duration

Note The sample-rate interval must be less than or equal to the monitoring-duration period. If you attempt to set
the sample-rate interval to a value greater than the monitor-duration period, the command is ignored and the
parameters are unchanged.

When you change the configuration of a currently active enforce-rule, that rule begins using the new
configuration immediately to manage the cable modems tracked by this enforce-rule.
For more information about the Subscriber Traffic Management feature and to see an illustration of a sample
monitoring window, refer to the Subscriber Traffic Management for the Cisco CMTS Routers feature document
on Cisco.com.

Examples The following example shows an enforce-rule being configured for a monitoring-duration period
that is 20 minutes in length, with a sampling rate of every 10 minutes:

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# monitoring-duration 20 sample-interval 10

The following example shows the error message that is displayed when the sample-rate interval is
configured to be greater than the monitoring-duration period. In this situation, the command is
ignored and the parameters remain unchanged.

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# monitoring-duration 20 sample-interval 30

Monitoring duration cannot be less than the Sampling interval -- so the values
would remain unchanged

Related Commands Command Description

activate-rule at-byte-count Specifies the number of bytes that a subscriber can transmit during the
monitoring period on a Cisco CMTS router.

cable qos enforce-rule Creates an enforce-rule to enforce a particular QoS profile for subscriber
traffic management and enters enforce-rule configuration mode.

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management on a

Cisco CMTS router.

penalty-period Specifies the time period that an enforced QoS profile should be in effect
for subscribers that violate their registered QoS profiles.

qos-profile enforced Specifies a QoS profile that should be enforced when users violate their
registered QoS profiles.

qos-profile registered Specifies the registered QoS profile that should be used for this enforce-rule.

Cisco CMTS Cable Command Reference

1342
Cable Commands: i through p
monitoring-duration

Command Description

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1343
 Cable Commands: i through p
mute

mute
To mute the port, use the mute command in the controller sub configuration mode. Use the no form of the
command to unmute the port.

[no] mute
This command has no keywords or arguments.

Command Default Default is no mute.

Command Modes Controller sub configuration mode (config-controller).

Command History Release Modification

Cisco IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines This command is used to mute the RF channel without changing any channel configuration.

The following example shows how to mute the RF channel:

router#configure terminal
router (config)#controller Integrated-Cable 3/0/1
router (config-controller)#rf-chan 15
router (config-rf-chan)#mute
router (config-rf-chan)#exit
router (config-controller)#exit
router (config)#exit

Related Commands Command Description

shutdown Disables or enables the interface on a line card.

Cisco CMTS Cable Command Reference

1344
 Cable Commands: i through p
multicast-label

multicast-label
To create a multicast label used for table-based session configuration when more than one multicast source
[S, G] is used as backup for the sessions, use the multicast-label command in cable video configuration mode.

multicast-label label group group-ip source source-ip source2 source-ip source3 source-ip source4 source-ip

Syntax Description

label Specifies the multicast label name.

group group-ip Identifies the multicast group for the label.

source source-ip source2 source-ip source3 source-ip Specifies the multicast sources for the label.
source4 source-ip

Command Default None

Command Modes Cable video configuration mode (config-video)

Command History

Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Examples
The following example shows how to configure a multicast label:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#table-based
Router(config-video-tb)#multicast-label mlabel1 group 236.0.1.1 source 175.10.5.2 source2
175.10.6.20 source3 175.10.7.2

Related Commands Command Description

cable video Enters cable video configuration mode.

table-based Enables table-based session configuration.

Cisco CMTS Cable Command Reference

1345
 Cable Commands: i through p
multicast-pool

multicast-pool
To specify the multicast pool for the downstream controller profile, use the multicast-pool command in
controller profile configuration mode. To void the multicast pool configuration, use the no form of this
command.

multicast-pool id

no multicast-pool

Syntax Description
Syntax Description id Specifies the multicast pool ID.

Command Default None

Command Modes
Controller profile configuration (config-controller-profile)

Command History
Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to specify the multicast pool for the downstream controller profile.

Examples The following example shows how to specify the multicast pool for the downstream controller profile:

Router# configure terminal

Router(config)# cable downstream controller-profile 1
Router(config-controller-profile)# multicast-pool 1

Related Commands Command Description

cable downstream controller-profile Configures the downstream controller profile.

Cisco CMTS Cable Command Reference

1346
 Cable Commands: i through p
multicast-uplink

multicast-uplink
To set a TenGigabit Ethernet port for multicast traffic, use the multicast-uplink command in cable video
configuration mode.

multicast-uplink interface-name [access-list access-list-name]

interface-name Specifies the interface for multicast traffic.

access-list access-list-name Specifies the access list for the multicast uplink.

Command Default None

Command Modes Cable video configuration mode (config-video)

Command History

Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Examples
The following example shows how to configure a multicast uplink:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#multicast-uplink TenGigabitEthernet4/1/2

The following example shows how to configure a multicast uplink with an access list:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#multicast-uplink Port-channel23 access-list all-multicasts

Related Commands Command Description

cable video Enters cable video configuration mode.

Cisco CMTS Cable Command Reference

1347
 Cable Commands: i through p
name

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 Release Modification

12.2(33)SCC This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows how to give name to a CMTS tag using the name command:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable tag 1
Router(cmts-tag)# name cisco

Related Commands Command Description

cable load-balance docsis-group To configure a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group To display real-time configuration, statistical and operational
information for load balancing operations on the router.

cable tag To configure a tag for a DOCSIS load balancing group on the
CMTS.

Cisco CMTS Cable Command Reference

1348
 Cable Commands: i through p
nc

nc
To configure the network controller for virtual ARPD, use the nc command in OOB virtual ARPD configuration
mode. To void the network controller configuration, use the no form of this command.

nc ip udp-port port_number

no nc ip udp-port port_number

Syntax Description ip Specifies the IP address of the network controller.

port_number Specifies the destination UDP port number.

Command Default None

Command Modes
OOB Virtual ARPD configuration (config-oob-varpd)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the network controller for virtual ARPD.

Examples The following example shows how to configure the network controller for virtual ARPD:

Router# configure terminal

Router(config)# cable oob
Router(config-oob)# virtual-arpd 1
Router(config-oob-varpd)# nc 225.225.225.225 udp-port 23411

Related Commands Command Description

virtual-arpd Defines a virtual ARPD configuration.

ip Configures the virtual ARPD source IP address.

source-id Configures the source ID for virtual ARPD.

Cisco CMTS Cable Command Reference

1349
 Cable Commands: i through p
network

network
To configure the DHCP address pool with the specified network-number and subnet mask, which are the
DHCP yiaddr field and Subnet Mask (DHCP option 1) field, use the network command in global configuration
mode. To remove this configuration, use the no form of this command.

network network-number [mask]

no network network-number [mask]

Syntax Description network-number The DHCP yiaddr field.

mask Subnet Mask (DHCP option 1). If you do not specify the mask value, it is supported to
255.255.255.255.

Command Default DHCP settings are not configured by default.

Command Modes
DHCP configuration

Command History Release Modification

Release 12.2(4)BC1 Supoported on the Cisco uBR7100 series, Cisco uBR7200 series, and Cisco uBR10012
routers.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines This command requires that you first use the dhcp ip dhcp pool name command in global configuration
mode to enter DHCP configuration mode.

Note To create an address pool with a single IP address, use the host command instead of network.

For additional information about DHCP support on the Cisco CMTS, refer to the following document on
Cisco.com:
• DHCP and ToD Servers on the Cisco CMTS

Examples The following example illustrates use of the network command with the ip dhcp pool name
command.

Router# configure terminal

Router(config)# ip dhcp pool name platinum
Router(dhcp-config)# network 10.10.10.0 255.255.0.0

Router(dhcp-config)#

Cisco CMTS Cable Command Reference

1350
 Cable Commands: i through p
network

Related Commands Command Description

ip dhcp pool name Creates a DHCP address pool and enters DHCP pool configuration file mode.

Cisco CMTS Cable Command Reference

1351
 Cable Commands: i through p
network-delay

network-delay
To configure the DEPI latency measurement, use the network-delay dlm command in core-interface
configuration mode. To void the DEPI latency measurement configuration, use the no form of this command.

network-delay dlm interval_in_seconds [measure-only]

no network-delay dlm

Syntax Description interval_in_seconds Specifies the sampling interval in seconds.

Command Default None

Command Modes Core-interface configuration (config-rpd-core)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the DEPI latency measurement.

The following example shows how to configure the DEPI latency measurement:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# core-interface tengigabitethernet 3/0/1
Router(config-rpd-core)# network-delay dlm 100

Related Commands Command Description

core-interface Configures the core-interface of the RPD.

Cisco CMTS Cable Command Reference

1352
 Cable Commands: i through p
nls

nls
To enable Network Layer signaliing (NLS) functionality, use the nls command in global configuration mode.
To disable NLS functionality, use the no form of this command.

nls [authentication]
no nls [authentication]

Syntax Description authentication (Optional) Enables NLS protocol security authentication.

Command Default Disabled.

Command Modes
Global configuaration

Command History Release Modification

12.3(21a)BC3 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Usage Guidelines It is recommended that NLS message authentication is enabled all the time.

Examples The following example shows nls enabled on a router:

router (config)# nls

Related Commands Command Description

cpd Enables the CPD feature.

nls ag-id auth-key Configures an Authorization Group Identifier (AG ID) for CMTS.

nls resp-timeout Configures NLS response timeout.

Cisco CMTS Cable Command Reference

1353
 Cable Commands: i through p
nls ag-id auth-key

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 ag-id number auth-key auth-key char

no nls ag-id auth-key

Syntax Description ag-id number Authorization Group Identifier. The valid range is 1- 4294967295.

auth-key Authentication key provisioned on CMTS. The valid range is 20-64 characters.
char

Command Default Disabled

Command Modes
Global configuaration

Command History Release Modification

12.3(21a)BC3 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows configuring the AG ID:

Router(config) # nls ag-id 345 auth-key aabbccddeeeeddccbbaa

Related Commands Command Description

cpd Enables CPD.

nls Enables Network Layer signaliing (NLS) functionality.

nls Configures NLS response timeout.

resp-timeout

Cisco CMTS Cable Command Reference

1354
 Cable Commands: i through p
nls resp-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 Controls the time CTMS will wait before getting a response for an NLS information request.
number The valid range is 1-60 seconds. Upon a response timeout, the CPD message is dropped.

Command Default The default timeout is 1 second.

Command Modes
Global configuration

Command History Release Modification

12.3(21a)BC3 This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Routers.
3.15.OS

Examples The following example shows configuring the NLS response timeout:

Router(config)#nls rssp-timeout 35

Related Commands Command Description

cpd Enables CPD.

nls Enables Network Layer signalling (NLS) functionality.

nls ag-id auth-key Configures an Authorization Group Identifier (AG ID) for CMTS.

Cisco CMTS Cable Command Reference

1355
 Cable Commands: i through p
ofdm-freq-excl-band

ofdm-freq-excl-band
To specify the range of frequencies on this port that are excluded from all OFDM channels, use the
ofdm-freq-excl-band command in controller configuration mode. To undo the frequency range assignment,
use no form of this command.

ofdm-freq-excl-band start-frequency frequency width value

no ofdm-freq-excl-band start-frequency frequency width value

Syntax Description frequency Frequency of the left edge of the exclusion band in Hz.

value Width of the exclusion band in Hz. Valid range is from 1000000 to 1110000000.

Command Default None.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the range of frequencies on this port that are excluded from all OFDM channels.

Examples The following example shows how to specify the range of frequencies on this port that are excluded
from all OFDM channels:

Router# configure terminal

Router(config)# controller integrated-cable 3/0/0
Router(config-controller)# ofdm-freq-excl-band start-frequency 108000000 width 1000000

Cisco CMTS Cable Command Reference

1356
 Cable Commands: i through p
ofdm channel-profile

ofdm channel-profile
To configure the OFDM RF channel, use the ofdm channel-profile command in RF-channel configuration
mode. To undo the configuration, use no form of this command.

ofdm channel-profile idstart-frequency frequency[ width value] [plc plc-spectrum-start-freq]

no ofdm channel-profile idstart-frequency frequency[ width value] [plc plc-spectrum-start-freq]

Syntax Description ofdm channel-profile id OFDM RF channel profile.

start-frequency frequency OFDM RF channel start frequency in Hz.

width value Channel width in Hz.

plc plc-spectrum-start-freq PLC spectrum start frequency in Hz.

Command Default None.

Command Modes
RF-channel configuration (config-rf-chan)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to configure the OFDM RF channel.

Examples The following example shows how to configure the OFDM RF channel:

Router# configure terminal

Router(config)# controller integrated-cable 3/0/0
Router(config-controller)# rf-chan 158
Router(config-rf-chan)# ofdm channel-profile 0 start-frequency 627000000 width 192000000
plc 720000000

Cisco CMTS Cable Command Reference

1357
 Cable Commands: i through p
onid

onid
To override the default ONID, use the onid command in the service distribution group configuration mode.
To revert back to the default ONID, use the no form of the command.

onid number

Syntax Description number Defines the new ONID value. By default, the system ONID is 0, which is commonly used in North
America.

Command Default None.

Command Modes Service distribution group configuration mode (config-video-sdg)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to override the default ONID value. If you perform this configuration, all channels
associated with the configured SDG will have the new ONID value.

The following example shows how to override the default ONID value:
router#configure terminal
router(config)#cable video
router(config-video)#service-distribution-group sdg id 1
router(config-video-sdg)#onid 100

Related Commands Command Description

service-distribution-group Defines a service distribution group.

rf-port integrated-cable Defines the physical slot/bay/port to be used in a video

service.

psi-interval Override the default PSI value.

show cable video service-distribution-group Displays the SDG configuration.

Cisco CMTS Cable Command Reference

1358
 Cable Commands: i through p
oui

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 None

Command Modes
CMTS tag mode (cmts-tag)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to configure the OUI for the CMTS tag using the oui command:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable tag 1
Router(cmts-tag)# oui 00.1a.c3

Related Commands Command Description

cable load-balance docsis-group To configure a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group To display real-time configuration, statistical and operational
information for load balancing operations on the router.

cable tag To configure a tag for a DOCSIS load balancing group on the
CMTS.

Cisco CMTS Cable Command Reference

1359
 Cable Commands: i through p
output-rate

output-rate

Note Starting with Cisco IOS Release 12.2(33)SCG, the output-rate command is not supported on the Cisco
uBR10012 router.

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 Release Modification

12.2(33)SCC This command was introduced.

12.2(33)SCG Support for this command was removed for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines 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 terminal

Router(config
)# interface gigabitethernet 1/0/0
Router(config-if
)# output-rate 100

Related Commands Command Description

show running-config interface Displays the configuration settings for the specified Gigabit
gigabitethernet Ethernet interface.

Cisco CMTS Cable Command Reference

1360
Cable Commands: i through p
output-rate

Command Description

show interfaces gigabitethernet Displays the status and configuration settings for Gigabit
Ethernet interfaces.

Cisco CMTS Cable Command Reference

1361
 Cable Commands: i through p
override

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 Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to override the TLV or SNMP when assigning a RLBG using
the override command:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable tag 1
Router(cmts-tag)# override

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

cable tag Configures a tag for a DOCSIS load balancing group on the CMTS.

Cisco CMTS Cable Command Reference

1362
 Cable Commands: i through p
overrule

overrule
To overrule the default settings, use the overrule command in the DVB scrambling ECMG configuration
mode. To void the overrule configuration, use the no form of this command.

overrule
no overrule

Command Default None

Command Modes DVB scrambling ECMG configuration mode (config-video-encrypt-dvb-ecmg)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to overrule the default settings:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#overrule
Router(config-video-encrypt-dvb-ecmg-overrule)#

Related Commands Command Description

ecmg Enters the ECM Generator configuration mode.

ac-start-delay Specifies the time between start of first CP after a

change in AC and start of ECM broadcast.

ac-stop-delay Specifies the time between end of last CP preceding

a change in AC and end of ECM broadcast.

max-comp-time Specifies the maximum time needed by ECMG to

compute an ECM.

max-streams Specifies the maximum number of simultaneous open

streams supported by the ECMG on a channel.

min-cp-duration Specifies the minimum crypto period.

rep-period Specifies the time between two ECM packets at the

output.

start-delay Specifies the delay between the start of CP and ECM

broadcast.

Cisco CMTS Cable Command Reference

1363
 Cable Commands: i through p
overrule

Command Description

stop-delay Specifies the delay between the end of CP and ECM

broadcast.

trans-start-delay Specifies the transition start delay.

trans-stop-delay Specifies the transition stop delay.

Cisco CMTS Cable Command Reference

1364
 Cable Commands: i through p
overwrite-scg

overwrite-scg
To enable Scrambling Control Group (SCG) overwrite, use the overwrite-scg command in the DVB scrambling
EIS configuration mode. To disable the SCG overwrite, use the no form of this command.

overwrite-scg
no overwrite-scg

Command Default None

Command Modes DVB scrambling EIS configuration mode (config-video-encrypt-dvb-eis)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to enable Scrambling Control Group (SCG) overwrite:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#eis EIS-1 id 1
Router(config-video-encrypt-dvb-eis)#overwrite-scg

Related Commands Command Description

eis Enters the Event Information Scheduler configuration

mode.

listening-port Configures the listening TCP port.

cp-overrule Overrules and specifies the crypto period duration.

Cisco CMTS Cable Command Reference

1365
 Cable Commands: i through p
packetcable

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 (config)

Command History Release Modification

12.2(8)BC2 This command was introduced for the Cisco uBR7200 series universal broadband router.

12.2(11)BC1 Support was added for automatically creating a random Element ID when PacketCable
operations are enabled.

12.2(15)BC1 Support was added for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command enables PacketCable operations on all cable interfaces and takes effect immediately. If you
do not need to change any parameters from their default values, this is the only command needed to enable
PacketCable operations.
In Cisco IOS Release 12.2(11)BC1 and later releases, this command also automatically creates a random
Element ID for the CMTS that is in the range of 0 and 99,999. To ensure that this Element ID is unique across
the entire PacketCable domain, you should use the packetcable element-id command.

Note PacketCable operations can be configured together with HCCP N+1 redundancy, but the PacketCable states
are not synchronized between the Working and Protect interfaces. If a switchover occurs, existing voice calls
continue, but when the user hangs up, PacketCable event messages are not generated because the Protect
interface is not aware of the previous call states. However, new voice calls can be made and proceed in the
normal fashion.

Channel Width Limitations

The 200,000 Hz channel width cannot be used on upstreams that support PacketCable voice calls, or on any
upstreams that use Unsolicited Grant Service (UGS) or UGS with Activity Detection (UGS-AD) service flows.
Using this small a channel width with voice and other UGS/UGS-AD service flows results in calls being
rejected because of “DSA MULTIPLE ERRORS”.

Examples The following example shows PacketCable operation being enabled:

Cisco CMTS Cable Command Reference

1366
 Cable Commands: i through p
packetcable

Router# configure terminal

Router(config)# packetcable
Router(config)#

The following example shows PacketCable operation being disabled (default):

Router# configure terminal

Router(config)# no packetcable
Router(config)#

Related Commands Command Description

clear packetcable gate counter commit Resets the counters that track the total number of committed gates.

packetcable authorize Allows Unsolicited Grant Service (UGS) service flows without a
vanilla-docsis-mta proper PacketCable gate ID when PacketCable operations are
enabled on the Cisco CMTS.

packetcable element-id Configures the PacketCable Event Message Element ID.

packetcable gate maxcount Changes the maximum number of PacketCable gate IDs in the
gate database on the Cisco CMTS.

packetcable timer Changes the value of the different PacketCable DQoS timers.

show packetcable gate Displays information about one or more gates in the gate database.

show packetcable gate counter commit Displays the total number of committed gates since system reset
or since the counter was last cleared.

show packetcable global Displays the current PacketCable configuration.

Cisco CMTS Cable Command Reference

1367
 Cable Commands: i through p
packetcable authorize vanilla-docsis-mta

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 (config)

Command History Release Modification

12.2(11)BC2 This command was introduced for the Cisco uBR7200 series universal broadband router.

12.2(15)BC1 Support was added for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines By default, when PacketCable operations are enabled (using the packetcable ccommand), CMs must follow
the PacketCable protocol when requesting UGS service flows. This prevents DOCSIS CMs that do not support
PacketCable operations from using DOCSIS-style UGS service flows.
If you have a mixed network that contains both PacketCable and non-PacketCable DOCSIS CMs, you can
allow DOCSIS CMs to request UGS service flows by using the packetcable authorize vanilla-docsis-mta
command. If, however, your CMTS is providing PacketCable services, use the no packetcable authorize
vanilla-docsis-mta command to disable DOCSIS-style service flows. This is the default configuration when
PacketCable operations are enabled, and it requires that CMs must provide a validly authorized gate ID before
being granted a UGS service flow.

Examples The following example shows PacketCable operation being enabled, while still allowing DOCSIS-style
UGS service flows:

Router# configure terminal

Router(config)# packetcable
Router(config)# packetcable authorize vanilla-docsis-mta

The show packetcable global command has also been enhanced to display whether non-PacketCable
DOCSIS-style UGS service flows are allowed.
The following is a sample output on the Cisco uBR10012 router:

Router# show packetcable global

Packet Cable Global configuration:

Cisco CMTS Cable Command Reference

1368
 Cable Commands: i through p
packetcable authorize vanilla-docsis-mta

Enabled : Yes
Element ID: 12456
Max Gates : 1048576
Allow non-PacketCable UGS
Default Timer value -
T0 : 30000 msec
T1 : 300000 msec
T2 : 2000 msec
T5 : 500 msec
Router#

The following is a sample output on a Cisco cBR series router:

Router# show packetcable global

Packet Cable Global configuration:
Packetcable DQOS Enabled : Yes
Packetcable Multimedia Enabled : No
Element ID: 88330
Max Gates : 512000
Allow non-PacketCable UGS
Default Multimedia Timer value -
T1 : 200000 msec
Persistent gate : 0 hour
Volume Limit : STOPPED
Default DQoS Timer value -
T0 : 30000 msec
T1 : 300000 msec
Client Accept Timer: Disabled
Client Accept Timer Expired: 0
Packetcable DQOS Gate Send SubscriberID Enabled: No

Router#

Related Commands Command Description

clear packetcable gate counter commit Resets the counters that track the total number of committed gates.

packetcable Enables PacketCable operations on the Cisco CMTS.

packetcable element-id Configures the PacketCable Event Message Element ID.

packetcable gate maxcount Changes the maximum number of PacketCable gate IDs in the
gate database on the Cisco CMTS.

packetcable timer Changes the value of the different PacketCable DQoS timers.

show packetcable gate Displays information about one or more gates in the gate database.

show packetcable gate counter commit Displays the total number of committed gates since system reset
or since the counter was last cleared.

show packetcable global Displays the current PacketCable configuration.

Cisco CMTS Cable Command Reference

1369
 Cable Commands: i through p
packetcable element-id

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 (config)

Command History Release Modification

12.2(11)BC1 This command was introduced for the Cisco uBR7200 series universal broadband router.

12.2(15)BC1 Support was added for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The PacketCable Event Message specification (PKT-SP-EM-I03-011221) requires that each trusted PacketCable
network element that generates an Event Message MUST identify itself with a static Element ID that is unique
across an entire PacketCable domain. This command allows you to configure the CMTS with an Element ID
that is unique for your particular network. If you do not manually configure this parameter with the packetcable
element-id command, it defaults to a random value between 0 and 99,999 when PacketCable operations is
enabled.
The CMTS includes the Element ID in its Event Messages, along with its timezone information. You can
display the current value using the show packetcable global command.

Examples The following example shows the Event Message Element ID for this particular CMTS being set to
12456:

Router# configure terminal

Router(config)# packetcable element-id 12456
Pktcbl: Configured element ID 12456
Router(config)#

Related Commands Command Description

packetcable Enables PacketCable operations on the Cisco CMTS.

Cisco CMTS Cable Command Reference

1370
Cable Commands: i through p
packetcable element-id

Command Description

packetcable authorize Allows Unsolicited Grant Service (UGS) service flows without a
vanilla-docsis-mta proper PacketCable gate ID when PacketCable operations are enabled
on the Cisco CMTS.

packetcable gate maxcount Changes the maximum number of PacketCable gate IDs in the gate
database on the Cisco CMTS.

packetcable timer Changes the value of the different PacketCable DQoS timers.

show packetcable global Displays the current PacketCable configuration, including the
Element ID.

Cisco CMTS Cable Command Reference

1371
 Cable Commands: i through p
packetcable gate maxcount

packetcable gate maxcount

To change the maximum number of PacketCable gate IDs in the gate database on the Cisco CMTS, use the
packetcable gate maxcount command in global configuration mode. To reset the counter to its default value,
use the no form of this command.

packetcable gate maxcount n

no packetcable gate maxcount

Syntax Description n Maximum number of gate IDs to be allocated in the gate database on the CMTS.
The valid range on the Cisco uBR10012 and Cisco uBR7200 series routers is 512 through 2097152, with
a default value of 2097152 (8 * 512 * 512), which is sufficient to support 8 cable interface line cards.
The valid range on the Cisco cBR series routers is 1 to 512000 and the default is 512000.

Command Default 2097152 gate IDs on the Cisco uBR10012 and Cisco uBR7200 series routers.
512000 gate IDs on the Cisco cBR series routers.

Command Modes
Global Configuration (config)

Command History Release Modification

12.2(8)BC2 This command was introduced for the Cisco uBR7200 series universal broadband router.

12.2(11)BC2 The maximum number of possible gates and the default number of gates were doubled
from 1,048,576 to 2,097,152 to accommodate a maximum of eight cable interface line
cards (where each cable interface line card can use a maximum of 512*512, or 262,144,
gates).

12.2(15)BC1 Support was added for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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, multiply this
number by 2 to get the maximum number of gates that can be created on the Cisco CMTS.

Note Each cable interface line card on the Cisco uBR10012 and Cisco uBR7200 series routers supports a maximum
of 512*512 (262,144) PacketCable gates, so ensure that you set the maximum number of gates to accommodate
all installed cable interface line cards.

Examples The following example shows the maximum number of gate IDs being set to 524288 on the Cisco
uBR10012 router, which is sufficient for two cable interface line cards:

Cisco CMTS Cable Command Reference

1372
 Cable Commands: i through p
packetcable gate maxcount

Router# configure terminal

Router(config)# packetcable gate maxcount 524288

The following example shows the maximum number of gate IDs being set to 10 on a Cisco cBR
series router:

Router# configure terminal

Router(config)# packetcable gate maxcount 10

Related Commands Command Description

packetcable Enables PacketCable operations on the Cisco CMTS.

packetcable authorize Allows Unsolicited Grant Service (UGS) service flows without a
vanilla-docsis-mta proper PacketCable gate ID when PacketCable operations are
enabled on the Cisco CMTS.

packetcable element-id Configures the PacketCable Event Message Element ID.

packetcable timer Changes the value of the different PacketCable DQoS timers.

show packetcable global Displays the current PacketCable configuration.

Cisco CMTS Cable Command Reference

1373
 Cable Commands: i through p
packetcable gate send-subscriberID

packetcable gate send-subscriberID

To include subscriber identification in GATE-OPEN and GATE-CLOSE gate control messages, use the
packetcable gate send-subscriberID command in global configuration mode. To remove subscriber
identification information from the gate control messages, use the no form of this command.

packetcable gate send-subscriberID

no packetcable gate send-subscriberID

Syntax Description This command has no arguments or keywords.

Command Default No subscriber identification information is provided in the GATE-OPEN and GATE-CLOSE gate control
messages.

Command Modes
Global configuration (config)

Command History Release Modification

12.3(23)BC1 This command was introduced.

12.2(33)SCB This command was integrated into Cisco IOS Release 12.2(33)SCB. Support for the Cisco
uBR7225VXR router was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example enables gate control subscriber identification information using the
packetcable gate send-subscriberID command:

Router(config)# packetcable gate send-subscriberID

Related Commands Command Description

packetcable Enables PacketCable operation.

show packetcable gate Displays information about one or more gates in the gate database.

show packetcable global Displays the current PacketCable configuration.

Cisco CMTS Cable Command Reference

1374
 Cable Commands: i through p
packetcable multimedia

packetcable multimedia

To enable the Cisco CMTS router to start or stop responding to PCMM COPS messages received from the
PCMM Policy Server, use the packetcable multimedia command in the Global Configuration (config) mode.

packetcable multimedia

no packet cable multimedia

To configure the SessionClassID that the Cisco CMTS router applies to high priority PCMM calls, use the
packetcable multimedia high-priority command in the Global Configuration (config) mode.

packetcable multimedia high-priority priority

Syntax Description high-priority To configure the SessionClassID for high priority calls.

priority SessionClassID of the high priority (911) calls.

Command Default The default SessionClassID of high priority (911) calls is 15.

Command Modes Global Configuration (config)

Command History Release Modification

IOS-XE 3.15.0S The packetcable multimedia command was implemented on the Cisco
cBR Series Converged Broadband Routers.

Cisco IOS XE Amsterdam 17.3.1x The packetcable multimedia high-priority command was introduced
on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Enable packetcable multimedia before you use packetcable multimedia high-priority priority.

Cisco CMTS Cable Command Reference

1375
 Cable Commands: i through p
packetcable timer

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 T0 timer-value Sets the T0 timer in milliseconds. The valid range is from 1 to 1,000,000,000
milliseconds, with a default value of 30000 milliseconds (30 seconds).

T1 timer-value Sets the T1 timer in milliseconds. The valid range is from1 to 1,000,000,000
milliseconds, with a default value of 200000 milliseconds (200 seconds).

multimedia T1 timer-value Sets the PacketCable multimedia T1 timer in milliseconds. The valid range is
1 to 1,000,000,000 milliseconds, with a default value of 200000 milliseconds
(200 seconds).

Command Default None

Command Modes
Global Configuration (config)

Command History Release Modification

12.2(8)BC2 This command was introduced for the Cisco uBR7200 series universal broadband router.

12.2(11)BC2 The T2 and T5 timers were removed to conform to the requirements of the PacketCable
DQoS Engineering Change Notice (ECN) 02148.

12.2(15)BC1 Support was added for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the following timers, which are defined in the PacketCable™ Dynamic Quality-of-Service
Specification (PKT-SP-DQOS-I03-020116):
• T0 specifies the amount of time that a gate ID can remain allocated without any specified gate parameters.
The timer begins counting when a gate is allocated with a Gate-Alloc command. The timer stops when
a Gate-Set command marks the gate as Authorized. If the timer expires without a Gate-Set command
being received, the gate is deleted.
• T1 specifies the amount of time that an authorization for a gate can remain valid. It begins counting when
the CMTS creates a gate with a Gate-Set command and puts the gate in the Authorized state. The timer
stops when the gate is put into the committed state. If the timer expires without the gate being committed,
the CMTS must close the gate and release all associated resources.

Cisco CMTS Cable Command Reference

1376
 Cable Commands: i through p
packetcable timer

Note The new timer values apply to all gates that are created after giving the command. Existing gates are not
affected.

Examples The following example shows the T0 timer being set to 20 seconds (20,000 milliseconds):

Router# configure terminal

Router(config)# packetcable timer T0 20000

Related Commands Command Description

packetcable Enables PacketCable operations on the Cisco CMTS.

packetcable authorize Allows Unsolicited Grant Service (UGS) service flows without a
vanilla-docsis-mta proper PacketCable gate ID when PacketCable operations are
enabled on the Cisco CMTS.

packetcable element-id Configures the PacketCable Event Message Element ID.

packetcable gate maxcount Changes the maximum number of PacketCable gate IDs in the gate
database on the Cisco CMTS.

show packetcable global Displays the current PacketCable configuration.show packetcable

global

Cisco CMTS Cable Command Reference

1377
 Cable Commands: i through p
pcr-based-source-switch

pcr-based-source-switch
To configure source switching of multicast SPTS streams to be based on PCR PID bitrate instead of stream
bitrate, use the pcr-based-source-switch command in video configuration mode. To disable the PCR PID
based source switch, use the no form of this command.

pcr-based-source-switch

no pcr-based-source-switch

Command Default None

Command Modes Video configuration (config-video)

Command History Release Modification

Cisco IOS XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.8.1

The following example shows how to enable PCR PID based source switch:
Router(config)#cable video
Router(config-video)#pcr-based-source-switch

Cisco CMTS Cable Command Reference

1378
 Cable Commands: i through p
peak-time1

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 {hourhour:minutes} duration minutes avg-rate rate

peak-time2 {hourhour:minutes} duration minutes avg-rate rate
duration offpeak-minutes avg-rate offpeak-minutes
sample-interval minutes]minutes [penalty minutes] {downstream | upstream}[enforce]
no peak-time1 {hourhour:minutes} duration minutes avg-rate rate
peak-time2 {hourhour:minutes} duration minutes avg-rate rate
duration offpeak-minutes avg-rate offpeak-minutes
sample-interval minutes]minutes [penalty minutes] {downstream | upstream}[enforce]

Cisco cBR Series Converged Broadband Routers

peak-time1 {hourhour:minutes} duration minutes avg-rate rate
peak-time2 {hourhour:minutes} duration minutes avg-rate rate
duration offpeak-minutes avg-rate offpeak-minutes
sample-interval minutesminutes [penalty-period minutes] {downstream | upstream}[enforce]
no peak-time1 {hourhour:minutes} duration minutes avg-rate rate
peak-time2 {hourhour:minutes} duration minutes avg-rate rate
duration offpeak-minutes avg-rate offpeak-minutes
sample-interval minutesminutes [penalty-period minutes] {downstream | upstream}[enforce]

Syntax Description hour | hour:minutes Specifies the time of day, in either hh or hh:mm format, during which monitoring
occurs for the peak time.
If the time is specified in hour (hh), the valid range is 1 to 23 using a 24-hour
clock.
If the time is specified in hour:minutes (hh:mm), the valid range for hour is 1 to
23 using a 24-hour clock, and the valid range for minutes is 0 to 59.

duration minutes Specifies the size of the sliding window (in minutes) during which the subscriber
usage is monitored for the first peak time, and optionally for a second peak time
when used with the peak-time2 keyword. The valid range is 60 to 1440.
For Cisco cBR Series Converged Broadband Routers, the valid range is 6 to 1440.

avg-rate rate Specifies the average sampling rate in kilobits per second for the specified
duration. The valid range is 1 to 400000 kilobits with no default.

duration offpeak-minutes (Optional) Specifies the size of the sliding window (in minutes) during which
the subscriber usage is monitored for the remaining offpeak time (time not
specified for peak monitoring). The valid range is 60 to 1440.
For Cisco cBR Series Converged Broadband Routers, the valid range is 6 to 1440.

avg-rate offpeak-rate Specifies the average sampling rate in kilobits per second for the specified offpeak
duration. The valid range is 1 to 400000 kilobits with no default.

Cisco CMTS Cable Command Reference

1379
 Cable Commands: i through p
peak-time1

peak-time2 hour | (Optional) Specifies the time of day during which monitoring occurs for a second
hour:minutes peak time. The time can be specified either in hour or hour:minutes format. The
valid range for hour is 1 to 23 using a 24-hour clock, and the valid range for
minutes is 0 to 59.

sample-interval minutes Specifies how often (in minutes) the CMTS router should sample a service flow
to get an estimate of subscriber usage. The valid range is 1 to 30, with a default
value of 15.

penalty minutes (Optional) Specifies the period (in minutes) during which a cable modem can be
under penalty. The valid range is 1 to 10080.

penalty-period minutes (Optional) Specifies the period during which an enforced quality of service (QoS)
profile should be in force for subscribers who violate their registered QoS profile.

downstream Specifies monitoring of traffic in the downstream direction.

upstream Specifies monitoring of traffic in the upstream direction.

enforce (Optional) Specifies that the enforce-rule QoS profile should be applied
automatically if a user violates their registered QoS profile.

Command Default Peak and offpeak monitoring is disabled. The only default value for the peak-time1 command is the 15-minute
sample interval.

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.3(9a)BC This command was introduced.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

12.2(33)SCD2 The minute-level granularity (hh:mm) for peak-time1and peak-time2 duration, and
the penalty keyword option were added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The penalty keyword option was removed. The penalty-period option was added.

Usage Guidelines

Note This command is applicable only after the monitoring-basics command is configured with the keyword
peak-offpeak.

Cisco CMTS Cable Command Reference

1380
 Cable Commands: i through p
peak-time1

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 enf

Examples 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 enforce

The following example shows an enforce-rulebeing configured on a Cisco cBR Series Converged
Broadband Router:
Router(enforce-rule)# peak-time1 1 duration 6 avg-rate 1 sample-interval 1 penalty-period
1 downstream enforce

Related Commands Command Description

cable qos enforce-rule Creates an enforce-rule to enforce a particular QoS profile for subscriber
traffic management and enters enforce-rule configuration mode.

debug cable Displays enforce-rule debug messages for subscriber traffic management
subscriber-monitoring on the Cisco CMTS routers.

duration Specifies the time period and sample rate to be used for monitoring
subscribers.

monitoring-basics Specifies the type of monitoring for subscriber traffic management on a

Cisco CMTS router.

penalty-period Specifies the period during which an enforced quality of service (QoS)
profile should be in force for subscribers who violate their registered
QoS profile.

qos-profile enforced Specifies a QoS profile that should be enforced when users violate their
registered QoS profiles. This command is applicable for DOCSIS 1.0
cable modems

qos-profile registered Specifies the registered QoS profile that should be used for this
enforce-rule. This command is applicable for DOCSIS 1.0 cable modems

Cisco CMTS Cable Command Reference

1381
 Cable Commands: i through p
peak-time1

Command Description

service-class (enforce-rule) Identifies a particular service class for cable modem monitoring in an
enforce-rule. This command is applicable for DOCSIS 1.1 or later cable
modems.

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

weekend peak-time1 Configures peak and offpeak subscriber monitoring over weekends on
a Cisco CMTS router.

Cisco CMTS Cable Command Reference

1382
 Cable Commands: i through p
penalty-period

penalty-period
To specify the time period that an enforced quality of service (QoS) profile should be in force for subscribers
that violate their registered QoS profile, use the penalty-period command in enforce-rule configuration mode.
To reset an enforce-rule to its default penalty period, use the no form of this command.

penalty-period minutes [time-of-day hour]

no penalty-period minutes [time-of-day hour]

Cisco cBR Series Converged Broadband Routers

penalty-period minutes [time-of-day {hourhour:minutes}monitoring-on]
no penalty-period minutes [time-of-day {hourhour:minutes}monitoring-on]

Syntax Description minutes Specifies a time period (in minutes) during which a cable modem (CM) can be under
penalty. The range is 1 to 10080, with a default value of 10080 (7 days).

time-of-day {hour | (Optional) Specifies the time of day (in hh or hh:mm format) when:
hour:minutes}
• A CM that is under penalty is released from the penalty period.
• A CM that is not under penalty has its subscriber monitoring counters reset.
If the time of day is specified in hour (hh), the valid range is 1 to 23 using a 24-hour
clock.
If the time of day is specified in hour:minutes (hh:mm), the valid range for hour is
1 to 23 using a 24-hour clock, and the valid range for minutes is 0 to 59.

monitoring-on (Optional) Specifies that monitoring should be turned on after the penalty release
time. If this keyword is not specified, by default, monitoring is turned off after the
release time, until the end of the day, that is 00:00 hrs.

Command Default The default time period is 10080 minutes (7 days).

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.3(9a)BC This command was integrated into Cisco IOS Release 12.3(9a)BC.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

12.3(23)BC2 The time-of-day keyword option was added.

12.2(33)SCB The time-of-day keyword option was integrated into Cisco IOS Release 12.2(33)SCB.

12.3(23)SCD2 The minute-level granuality for the time-of-day duration, and the monitoring-on keyword
option were added.

Cisco CMTS Cable Command Reference

1383
 Cable Commands: i through p
penalty-period

Release Modification

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines 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. The table below explains in detail the criteria for choosing the penalty
duration:

Table 33: Criteria for Choosing Penalty Duration

Global Weekday Weekend Applied Penalty Duration Applied Penalty Duration

Penalty- Penalty-Period Penalty-Period for Weekdays for Weekends
Period Configuration Configuration
Configured
(CLI: duration or (CLI: weekend
peaktime1) duration, or
weekend
peaktime1)

Yes Yes Yes Weekday Penalty Weekend Penalty

Configuration Configuration

Yes Yes No Weekday Penalty Global Penalty

Configuration Configuration

Yes No Yes Global Penalty Weekend Penalty

Configuration Configuration

Yes No No Global Penalty Global Penalty

Configuration Configuration

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 To manually move a DOCSIS 1.0 cable modem back to its registered profile before the end of the penalty
period, use the cable modem qos profile command. To manually move a DOCSIS 1.1(or later) cable modem
back to its registered profile before the end of the penalty period, use the cable modem {ip-address |
mac-address} service-class-name command.

Cisco CMTS Cable Command Reference

1384
 Cable Commands: i through p
penalty-period

When you change the configuration of a currently active enforce-rule, that rule begins using the new
configuration immediately to manage the cable modems tracked by this enforce-rule.

Note Before making any changes to an active enforce-rule, we recommend that you first disable the enforce rule
using the no enabled command.

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 terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# penalty-period 1440

The 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 terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# penalty-period 1440 time-of-day 23

The 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 terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# penalty-period 1440 time-of-day 23 monitoring-on

The following example shows an enforce-rule being configured with a penalty period on a Cisco
cBR Series Converged Broadband Router:
Router(enforce-rule)# penalty-period 1 time-of-day 1 monitoring-on

Related Commands Command Description

activate-rule at-byte-count Specifies the number of bytes that a subscriber can transmit during the
monitoring period on a Cisco CMTS router.

Cisco CMTS Cable Command Reference

1385
 Cable Commands: i through p
penalty-period

Command Description

cable qos enforce-rule Creates an enforce-rule to enforce a particular QoS profile for subscriber
traffic monitoring, and enters the enforce-rule configuration mode.

duration Specifies the time period and sample rate to be used for monitoring
subscribers.

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management on a

Cisco CMTS router.

qos-profile enforced Specifies a QoS profile that should be enforced when users violate their
registered QoS profiles. This command is applicable for only DOCSIS 1.0
cable modems.

qos-profile registered Specifies the registered QoS profile that should be used for this enforce-rule.
This command is applicable for only DOCSIS 1.0 cable modems.

service-class (enforce-rule) Specifies a service class (enforced or registered) that should be used for the
cable modem monitoring in an enforce-rule. This command is applicable for
DOCSIS 1.1 or later cable modems.

show cable qos enforce-rule Displays the QoS enforce-rules that are defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1386
 Cable Commands: i through p
periodic-rel-pxf enable

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 enable

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes
Redundancy configuration (config-red)

Command History Release Modification

12.2(33)SCG2 This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The periodic-rel-pxf enable command is used to enable the Reload PXF on Standby PRE Support feature.
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 terminal

Router(config)# redundancy
Router(config-red
)# periodic-rel-pxf enable
Router(config-red
)# end

Related Commands Command Description

redundancy Enters redundancy configuration mode.

Cisco CMTS Cable Command Reference

1387
 Cable Commands: i through p
ping docsis

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]

Cisco cBR Series Converged Broadband Routers

ping docsis {mac-addr ip-addr } [count] [repeat queue-intervals] [verbose]

Syntax Description mac-addr The 48-bit hardware (MAC) address of the CM. If you specify the MAC address of
a CPE device, the command will resolve it to the MAC address of the CM servicing
that CPE device and send the DOCSIS ping to the CM.

ip-addr IPv4 or IPv6 address of the CM. If you specify the IP address of a CPE device, the
command will resolve it to the IP address of the CM servicing that CPE device and
send the DOCSIS ping to the CM.

name fqdn Specifies the fully qualified domain name (FQDN) of the cable device to be displayed.
This option is only available if the show cable modem domain-name command has
been run for the first time to update the cable DNS cache on the CMTS router.

repeat (Optional) Specifies the number of maintenance intervals for a queue. Valid values
queue-intervals are from 1 to 2147483647.

verbose (Optional) Specifies verbose mode for the output, giving additional details about the
packets transmitted and received.

Command Default If no count is specified, five DOCSIS ping packets are sent.

Command Modes
Privileged EXEC (#)

Command History Release Modification

11.3 NA This command was introduced for the Cisco uBR7200 series router.

12.0(4)XI1 Support was added for the Cisco uBR924 cable access router.

12.1(3)XL Support was added for the Cisco uBR905 cable access router.

12.1(5)XU1 Support was added for the Cisco CVA122 Cable Voice Adapter.

12.1(1a)T1 The command output was enhanced.

12.1(3)XQ1 Support was added for wireless radio modems.

12.1(5)EC Support was added for the Cisco uBR7100 series routers.

12.2(2)XA Support was added for the Cisco uBR925 cable access router.

Cisco CMTS Cable Command Reference

1388
 Cable Commands: i through p
ping docsis

Release Modification

12.2(1)XF1 Support was added for the Cisco uBR10012 router.

12.2(4)BC1 This command was integrated into Cisco IOS Release 12.2(4)BC1.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA, with the following
changes:
• Support for the Cisco uBR7225VXR router was added.
• Support for specifying the IPv6 address of a CM or CPE device was added.
• The name keyword option was added for specifying the fully-qualified domain name
of a CM.

12.2(33)SCC The repeat keyword was added to specify maintenance intervals for queues.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The name keyword and fqdn variable were removed.

Usage Guidelines The DOCSIS ping is a unique Cisco patented technology that allows a cable operator to quickly diagnose the
health of a channel between the CMTS router and any particular DOCSIS cable CPE device. The DOCSIS
ping is similar in concept to the IP ping but uses the lower MAC layer instead of the datalink or transport
layers. Using the MAC layer has two major advantages:
• A DOCSIS ping uses only 1/64 of the bandwidth of an IP ping.
• A DOCSIS ping can be used with CMs that have not yet acquired an IP address. This allows cable
operators to ping CMs that were not able to complete registration or that were improperly configured at
the IP layer.
In addition to providing connectivity information, the ping docsis command provides a real-time view and
plot of requested power adjustments, frequency, timing offset adjustments, and a measure of optimal headend
reception power.
If a CM responds to the ping docsis command, but does not respond to an IP ping, the problem could be one
of the following:
• The CM is still in the registration process and has not yet come completely online. In particular, the CM
could be waiting for the DHCP server to assign it an IP address.
• Severe interference or other faults on the physical layer (either the upstream or downstream).
• Significant upstream signal error, distortion, or amplitude errors, often resulting in frequent power
adjustments (which are shown in the cable flap list).
• A non-DOCSIS compliant upstream carrier-to-noise power ratio (C/N) that is between 14 and 21 dB,
along with a mixed modulation profile, such as ranging request/response messages being sent in QPSK
mode and short and long data grants in 16-QAM mode.

Note The ping docsis command is a DOCSIS-compliant process that can be used with any two-way
DOCSIS-compliant CM; the CM does not require any special features or code. The ping docsis command
cannot be used with telco-return CMs.

Cisco CMTS Cable Command Reference

1389
 Cable Commands: i through p
ping docsis

Note In Cisco IOS Release 12.2(33)SCA, the show cable modem domain-name command must be run first on
the route processor (RP) of the CMTS router before any domain name can be used as part of a cable command.

The table below explains the different characters that can appear in the output for the ping docsis command:

Table 34: ping docsis Command Output Characters

Output Description
Character

! Indicates that a successful response was received from the ping request. This indicates that the
CM is reachable from the CMTS and can respond to CMTS requests at the DOCSIS MAC
layer.

. Indicates that a DOCSIS ping request was sent out but that the ping request timed out without
receiving a response. This indicates that the CM is having difficulties maintaining DOCSIS
MAC layer connectivity to the CMTS.
Note
If the ping docsis command displays a number of periods (.) along with exclamation points
(!), it strongly indicates the presence of RF noise or physical cable and plant issues that is
causing a loss of MAC layer connectivity.

a Indicates that a response was received but that an adjustment of frequency, power, or timing
was also made in the response. This indicates that, although the upstream channel is functional,
some sort of problem is forcing power averaging and other misreads of the upstream received
power signals.

f Indicates that the CMTS failed to send the DOCSIS ping request because the CM is offline,
and therefore MAC-layer communication is not possible. This indicates that the CM had
previously registered with the CMTS, but that at some point it stopped responding to the
DOCSIS station maintenance messages and that the CMTS eventually marked the CM as
offline. The CM might have lost power or might have been disconnected from the coaxial
cable.
Tip
Use the show cable modem command with the same MAC or IP address as you used with
the ping docsis command to show the current status of this CM.

Note If a CM is already in the flap list, the ping docsis command increments the hit, miss, and power-adjustment
fields for it in the cable flap list.

Examples

Note 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:

Cisco CMTS Cable Command Reference

1390
Cable Commands: i through p
ping docsis

Router# ping docsis 00d0.ba77.7595

Queueing 5 MAC-layer station maintenance intervals, timeout is 25 msec:

!!!!!
Success rate is 100 percent (5/5)
Router#

The following example shows the verbose output for the same command:

Router# ping docsis 00d0.ba77.7595 verbose

Queueing 5 MAC-layer station maintenance intervals, timeout is 25 msec:

Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0
Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0
Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0
Reply from 00d0.ba77.7595: 98 ms, tadj=-1, padj=0.25, fadj=0
Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.25, fadj=0
Success rate is 100 percent (5/5)
Router#

The following example shows that the CM at 192.168.100.10 is connected to the network and is
operational, but that one ping packet was lost and that several power adjustments were made during
the ping process:

router# ping docsis 192.168.100.10

Queueing 100 MAC-layer station maintenance intervals, timeout is 25 msec:

!!!!!a!!!!!!!a!a!!!!!!!!!!!!!!!!!!!!!aa!!!!!!!!!!a!!!a!a!!!aa!!!!!!.!!a!!!a!
a!a!!!!!!!!aa!!!!!!!aa!a
Success rate is 99 percent (99/100)

A CM that displays output such as that above (a higher percentage of successful pings but with a
number of power-adjustment readings) is most likely experiencing a problem that is not bad enough
to force the modem offline but that should be addressed.
If this problem is consistent for just a small number of CMs on an upstream receiver (such as a fiber
node within a combining group), then the problem is likely related to in-home wiring at those modem
locations. It could also be due to a cable TV network element that is on the same HFC segment.
If the problem occurs for all CMs on a single fiber node, then changing the upstream frequency or
reducing the number of homes passed per combining group might improve conditions. If this does
not help the situation, the problem could be due to a faulty cable drop, dirty optical connector on the
node, or other physical plant problem.
The ping docsis command cannot be used with a CM that has not yet registered with the CMTS.
The following example shows the responses for a CM that has not yet registered with the CMTS.

Router# ping docsis 192.168.100.111

Cable modem with IP address 192.168.100.111 not registered.

Please try using MAC address instead.
Router# ping docsis 0123.4567.89ab

Cable modem with MAC address 0123.4567.89ab not registered.

router#
The following example shows the output of the ping docsis
command with the repeat
keyword:
Router# ping docsis 192.168.100.10 repeat 22

Cisco CMTS Cable Command Reference

1391
 Cable Commands: i through p
ping docsis

Queueing 22 MAC-layer station maintenance intervals, timeout is 25 msec:

!!!!!!!!!!!!!!!!!!!!!!
Success rate is 100 percent (22/22)

Related Commands Command Description

cable flap-list aging Specifies the number of days to keep a CM in the flap-list table
before aging it out of the table.

cable flap-list insertion-time Sets the insertion time interval that determines whether a CM is
placed in the flap list.

cable flap-list miss-threshold Specifies miss threshold for recording a flap-list event.

cable flap-list power-adjust threshold Specifies the power-adjust threshold for recording a CM flap-list
event.

cable flap-list size Specifies the maximum number of CMs that can be listed in the
flap-list table.

clear cable flap-list Clears all the entries in the flap-list table.

ping Outputs one or more IP ping requests to a particular IP address.

show cable flap-list Displays the current contents of the flap list.

Cisco CMTS Cable Command Reference

1392
 Cable Commands: i through p
ping docsis pnm

ping docsis pnm

To send RxMER probes on OFDMA channel assigned to the modem, use the ping docsis pnm command in
privileged EXEC mode.

Cisco cBR Series Converged Broadband Routers

ping docsis pnm mac-address [ ignore | upstream us-channel [ ignore ] ]

Syntax Description mac-address MAC address of a specific CM to be displayed.

Command Default None.

Command Modes
Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Gibraltar 16.10.1c This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines The usage for each of the commands are listed below:
• ping docsis pnm mac-address : sends RxMER probes on each OFDMA channel assigned to the modem.
If enabled, auto profile management will analyze the results and potentially change the active profile.
• ping docsis pnm mac-address upstream us-channel : sends RxMER probes on a specified OFDMA
channel assigned to the modem. If enabled, auto profile management will analyze the results and potentially
change the active profile.
• ping docsis pnm mac-address ignore: sends RxMER probes on each OFDMA channel assigned to the
modem. Auto profile management will always ignore the results of the probe.
• ping docsis pnm mac-address upstream us-channel ignore: sends RxMER probes on a specified
OFDMA channel assigned to the modem. Auto profile management will always ignore the results of
the probe.

Examples The following example shows how to configure the system to send RxMER probes on OFDMA
channel assigned to the modem:

Router# ping docsis pnm 34bd.fa0c.b480

Related Commands Command Description

show cable modem prof-mgmt upstream Displays the results of RxMER probes.

Cisco CMTS Cable Command Reference

1393
 Cable Commands: i through p
platform power protection

platform power protection

To configure voltage thresholds to switch between different modes when power budget provided by AC PSMs
is not sufficient to power Field Replaceable Units (FRUs), use the platform power protection command in
global configuration mode. To use the default voltage thresholds, use theno form of the command.
By default, power protection action is disabled to avoid service outage. If protection action is disabled, any
online FRU is not powered down in the event of insufficient power budget, but any newly installed line card
is not powered up. To enable power protection action, use the platform power protection action shutdown
linecard command.

platform power protection ac220v voff von

no platform power protection ac220v

platform power protection action shutdown linecard

Syntax Description voff Specifies the hytersis threshold value value. The hystersis thresholds define when the PSM should switch
modes.
For example, if the voff value is configured as 180V, the PSM switches to the 120V mode with 1300W
capacity when input voltage drops below 180V.

von Specifies the hytersis threshold value value. The hystersis thresholds define when the PSM should switch
modes.
For example, if the von value is configured as 200V, the PSM switches to the 220V mode when input
voltage increases to more than 200V.

Command Default The default value of voff is 190V while the default value of von is 197V.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.7.1

Examples The following example shows a sample configuration:

Router# configure terminal

Router(config)# platform power protection ac220v 180 200
Router(config)#

The following example shows how to enable power protection action.

Router# configure terminal

Router(config)# platform power protection action shutdown linecard

Cisco CMTS Cable Command Reference

1394
Cable Commands: i through p
platform power protection

The following example shows how to verify the voltage threshold configuration.

Router# configure terminal

Router(config)# sh run | i protection
platform power protection ac220v 180 200

Cisco CMTS Cable Command Reference

1395
 Cable Commands: i through p
platform punt-policer

platform punt-policer
To rate-limit the aggregate punt-rate on a per-punt-cause basis, use the platform punt-policer command in
global configuration mode. Using the no form of the command returns the rate to the default value.

platform punt-policer { cable-snmp | punt-cause_value } rate_value [high]

no platform punt-policer

Syntax Description punt-policer punt-cause_value Specifies the punt cause value. punt-cause_value can be obtained from show
platform software punt-policer command.

cable-snmp This is the punt-cause assigned to SNMP packets destined to the CMTS.

rate_value Specifies the rate in packets/second. The range is from 10 to 300000.

Command Default The default rate is 512 packets/second.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

IOS XE Thiscommand was updated. cable-snmp was added as a new punt cause to rate-limit
16.12.1z1 SNMP packets destined to cBR-8.

Usage Guidelines In most cases, cable-snmp punts are normal priority.

Examples The following example shows a sample configuration:

Router# configure terminal

Router(config)# platform punt-policer cable-snmp 1000
Router(config)#

Related Commands Command Description

show platform software punt-policer Displays configuration and statistics for the per-cause
punt-policer.

show platform hardware qfp active Displays detailed configuration data and statistics for the
infrastructure punt-policer summary per-cause punt-policer.

show platform hardware qfp active Displays the punt summary statistics which includes a
infrastructure punt summary summary of punted packets and aggregate drop-counts
from CoPP, SBRL, the punt-policer and the global policer.

show platform hardware qfp active Displays the SBRL statistics.

infrastructure punt sbrl

Cisco CMTS Cable Command Reference

1396
Cable Commands: i through p
platform punt-policer

Command Description

platform punt-sbrl Rate-limit packet streams identified by the Source-Based

Rate-Limit (SBRL).

show policy-map control-plane Displays configuration and statistics for the control-plane
service-policy.

clear control-plane Clears the control-plane service-policy statistics.

show platform hardware qfp active Displays the global punt-policer statistics.
infrastructure punt statistics type global-drop

Cisco CMTS Cable Command Reference

1397
 Cable Commands: i through p
platform punt-sbrl

platform punt-sbrl
To rate-limit packet streams identified by the Source-Based Rate-Limit (SBRL), use the platform punt-sbrl
command in global configuration mode. To disable the rate-limiting, use the no form of the command.
Subscriber-side configuration before Cisco IOS XE Fuji 16.8.x

platform punt-sbrl subscriber rate { rate_value | no-drop }

platform punt-sbrl subscriber punt-cause punt-cause_value rate rate_value

Subscriber-side configuration in Cisco IOS XE Fuji 16.8.x

platform punt-sbrl subscriber punt-cause punt-cause_value rate-per-4-sec { no-drop | rate_value

[ quarantine-time q_time burst-factor b_value ] }
Subscriber-side configuration in Cisco IOS XE Fuji 16.9.x and later

platform punt-sbrl subscriber punt-cause punt-cause_value rate-per-4-sec { no-drop | rate_value

[ bucket-size b_size ] [ quarantine-time q_time burst-factor b_value ] }
WAN-side configuration before Cisco IOS XE Fuji 16.8.x

platform punt-sbrl wan punt-cause punt-cause_value rate rate_value [ quarantine-time q_time

burst-factor b_value ]
WAN-side configuration in Cisco IOS XE Fuji 16.8.x and later

platform punt-sbrl wan punt-cause punt-cause_value rate-per-1-sec rate_value [ quarantine-time

q_time burst-factor b_value ]

no platform punt-sbrl

Syntax Description punt-cause punt-cause_value Specifies the punt-cause value in number 1 to 107 or string.

rate rate_value Specifies the rate in packet per seconds. The range is from 1 to 256, specified
in powers-of-2.

no-drop Disables the rate-limiting.

rate-per-4-sec rate_value Specifies the rate in packet per 4 seconds. The range is from 1 to 255.

rate-per-1-sec rate_value Specifies the rate in packet per seconds. The range is from 1 to 256, specified
in powers-of-2.

quarantine-time q_time Specifies the quarantine time in minutes. The range is from 1 to 60.

bucket-size b_size Specifies the bucket size in packets. The range is from 1 to 255.

burst-factor b_value Specifies the quarantine burst factor in packets. The range is from 50 to 1000
.

Cisco CMTS Cable Command Reference

1398
 Cable Commands: i through p
platform punt-sbrl

Command Default The WAN-side default rate is zero, which means that rate-limiting does not occur. Using the no configuration
returns the rate to the default value.
The default subscriber-side global rate is zero. The default subscriber-side per-cause rate for
CABLE_L3_MOBILITY is 4 packets per second. Using the no configuration returns the rate to the default
value.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.
The platform punt-sbrl wan command replaces service divert-rate-limit ip and service
divert-rate-limit ipv6 commands. The platform punt-sbrl subscriber command replaces
service divert-limit and cable divert-rate-limit commands.

IOS XE Fuji The command platform punt-sbrl subscriber rate rate_value was deprecated.
16.8.1

IOS XE Fuji The keyword bucket-size was added in the command.

16.9.1

Usage Guidelines WAN-side configuration

WAN configuration consists of two parts:
1) Configure CoPP to specify which WAN-side packet streams are subject to SBRL. The policy-map action
set qos-group 99 specifies that packets matching that class are subject to SBRL.
2) Configure WAN-side SBRL to specify which punt-causes are rate-limited. Trusted sites are specified by
adding classes to the CoPP policy-map. ACLs are used to finely identify trusted streams. It is important to
understand the CoPP applies to all punted packets, so it may be necessary to ensure that subscriber-side packets
do not match the trusted-site ACLs. Quarantine can optionally be configured. When a packet-stream enters
quarantine, all punts from the stream are dropped for the configured period of time. When (burst-factor x
rate) packets arrive at a rate faster than rate, quarantine is activated for that stream.
For more information, see the WAN-side configuration example.
Subscriber-side configuration
The subscriber-side configuration is global. There is also a per-cause configuration which currently only
applies to the CABLE_L3_MOBILITY punt-cause. All subscriber-side packets go to SBRL, regardless of
the CoPP configuration.

Examples The following example shows the subscriber-side configuration:

Router# configure terminal

Router(config)# platform punt-sbrl subscriber punt-cause 99 rate 8
Router(config)#

Router# configure terminal

Router(config)# platform punt-sbrl subscriber rate 64
Router(config)#

Cisco CMTS Cable Command Reference

1399
 Cable Commands: i through p
platform punt-sbrl

The following example shows a simple CoPP configuration which sends all WAN-side punts to
SBRL:

Router# configure terminal

Router(config)# policy-map copp_policy
Router(config-pmap)# class class-default
Router(config-pmap-c)# set qos-group 99
Router(config-pmap-c)# exit
Router(config-pmap)# exit
Router(config)# control-plane
Router(config-cp)# service-policy input copp_policy
Router(config-cp)# exit
Router(config)# platform punt-sbrl wan punt-cause 11 rate 64 quarantine 5 burst-factor 500

Related Commands Command Description

show platform hardware qfp active Displays the punt summary statistics which includes a
infrastructure punt summary summary of punted packets and aggregate drop-counts
from CoPP, SBRL, the punt-policer and the global policer.

show platform hardware qfp active Displays the SBRL statistics.

infrastructure punt sbrl

platform punt-policer Configures the per-cause punt-policer.

show platform software punt-policer Displays configuration and statistics for the per-cause
punt-policer.

show platform hardware active qfp Displays detailed configuration data and statistics for the
infrastructure punt-policer summary per-cause punt-policer.

show policy-map control-plane Displays configuration and statistics for the control-plane
service-policy.

clear control-plane Clears the control-plane service-policy statistics.

show platform hardware qfp active Displays the global punt-policer statistics.
infrastructure punt statistics type global-drop

Cisco CMTS Cable Command Reference

1400
 Cable Commands: i through p
platform aom pending-thresh

platform aom pending-thresh

To configure a threshold value in seconds to notify that an AOM download is stuck, use the platform aom
pending-threshold command in the global configuration mode.
If you configure the no form of the command, the seconds-to-error and seconds-to-warning, revert to their
default values.

platform aom pending-thresh { seconds-to-error } { seconds-to-warning }

no platform aom pending-thresh { seconds-to-error } { seconds-to-warning }

Syntax Description seconds-to-error Allows you to configure a threshold value in seconds to notify that an AOM download
is stuck. The seconds-to-error specifies the threshold value in seconds to log an error
on the console.
The valid range is 60 to 3600 seconds and the default value is 1800 seconds

seconds-to-warning Specifies the threshold value in seconds to log a warning in the trace log when the AOM
download is stuck.
The valid range is 60 to 3600 seconds and the default value is 900 seconds

Command Default The default value for seconds-to-error is 1800 seconds and the default value for seconds-to-warning is 900
seconds.
If you configure the no form of the command, the seconds-to-error and seconds-to-warning, revert to their
default values.

Command Modes Global configuration (config)

Command History Release Modification

17.6.1z This command is
introduced.

Usage Guidelines The platform aom pending-thresh command allows you to configure a threshold value, in seconds, to notify
that an AOM download is stuck. When the specified threshold time is reached, an error and warning notification
is sent to the console and trace log, respectively. The valid range is 60–3600 seconds. Use the no form of the
command to remove the threshold value.

Examples The following example shows a sample configuration:

Router# configure terminal

Router(config)# platform aom pending-thresh 300 180
Router(config)#

In this example, 300 indicates the threshold value in seconds to log an error on the console and 180
specifies the threshold value in seconds to log an warning on the console.

Cisco CMTS Cable Command Reference

1401
 Cable Commands: i through p
pilot-scaling

pilot-scaling
To specify the value to calculate the number of continuous pilots, use the pilot-scaling command in OFDM
channel profile configuration mode. To undo the pilot-scaling value assignment, use no form of this command.

pilot-scaling value

no pilot-scaling

Syntax Description value Value to scale the number of continuous pilots. Valid range is from 48 to 120.

Command Default The default value is 48.

Command Modes
OFDM channel profile configuration (config-ofdm-chan-prof)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the value to calculate the number of continuous pilots.

Examples The following example shows how to specify the value to calculate the number of continuous pilots:

Router# configure terminal

Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)# pilot-scaling 50

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

cyclic-prefix Specify the channel cyclic-prefix.

description (OFDM channel profile) Specify a user defined description for the profile.

interleaver-depth Specify the channel interleaver-depth.

profile-control Specify default modulation or profile as the channel control profile.

profile-data Specify default modulation or profile as the channel data profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

roll-off Specify the channel roll-off value.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1402
 Cable Commands: i through p
pme cem

pme cem
To define parameters for the Cisco Edge QAM Manager server, use the pme cem command in the encryption
configuration mode. To reset the parameters to default value, use the no form of this command.

Note There can be only one entry for VODS-ID, CEM IP, CEM Port, and Management Interface IP. Defining any
configuration with newer values clears the previous configuration. The individual configurations can be cleared
with the no form of the command.

pme cem ip-address tcp-port

no pme cem ip-address tcp-port

Syntax Description ip-address Specifies the IP address of the Cisco Edge QAM Manager server.

tcp-port Specifies the TCP port number of the Cisco Edge QAM Manager server. The valid range is from
1024 to 65534.

Command Default None

Command Modes
Encryption configuration (config-video-encrypt)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command defines the parameters for the Cisco Edge QAM Manager server during privacy mode encryption
configuration.

Examples The following example shows how to define parameters for the Cisco Edge QAM Manager server:

Router# configure terminal

Router(config)# cable video
Router(config-video)# encryption
Router(config-video-encrypt)# pme cem 172.16.1.163 1024

Related Commands Command Description

encrypt Encrypts the virtual carrier group.

pme vodsid Configures the VODSID of Cisco Edge QAM Manager server.

pme mgmt-ip Configures the privacy mode encryption management IP to establish

Cisco Edge QAM Manager server connection.

show cable video encryption pme Displays the privacy mode encryption information.

Cisco CMTS Cable Command Reference

1403
 Cable Commands: i through p
pme cem

Command Description

show cable video encryption linecard Displays the encryption configuration information of the line card.

Cisco CMTS Cable Command Reference

1404
 Cable Commands: i through p
pme mgmt-ip

pme mgmt-ip
To define the privacy mode encryption management IP address for establishing Cisco Edge QAM Manager
server connection, use the pme mgmt-ip command in the encryption configuration mode. To reset to default
configuration, use the no form of this command.

pme mgmt-ip ip-address

no pme mgmt-ip ip-address

Syntax Description ip-address Specifies the management IP address.

Command Default None

Command Modes
Encryption configuration (config-video-encrypt)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command defines the privacy mode encryption management IP address.

Examples The following example shows how to define the privacy mode encryption management IP address:

Router# configure terminal

Router(config)# cable video
Router(config-video)#encryption
Router#(config-video-encrypt)pme mgmt-ip 172.16.1.164

Related Commands Command Description

encrypt Encrypts the virtual carrier group.

pme vodsid Configures the VODSID of Cisco Edge QAM Manager server.

pme cem Configures the parameters for the Cisco Edge QAM Manager server.

show cable video encryption pme Displays the privacy mode encryption information.

show cable video encryption linecard Displays the encryption configuration information of the line card.

Cisco CMTS Cable Command Reference

1405
 Cable Commands: i through p
pme vodsid

pme vodsid
To define VODSID of the Cisco Edge QAM Manager server, use the pme vodsid command in the encryption
configuration mode. To reset to default configuration, use the no form of this command.

pme vodsid id
no pme vodsid id

Syntax Description id Specifies the VODSID ID of the Cisco Edge QAM Manager server. The valid range is from 2 to
2147483647.

Command Default None

Command Modes
Encryption configuration (config-video-encrypt)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command defines the VODSID for the Cisco Edge QAM Manager server.

Examples The following example shows how to define VODSID for the Cisco Edge QAM Manager server:

Router# configure terminal

Router(config)# cable video
Router(config-video)# encryption
Router(config-video-encrypt)# pme vodsid 111

Related Commands Command Description

encrypt Encrypts the virtual carrier group.

pme cem Configures the parameters for the Cisco Edge QAM Manager server.

pme mgmt-ip Configures the privacy mode encryption management IP to establish

CEM connection.

show cable video encryption pme Displays the privacy mode encryption information.

show cable video encryption linecard Displays the encryption configuration information of the line card.

Cisco CMTS Cable Command Reference

1406
 Cable Commands: i through p
policy

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 pcmm Enables balancing of modems with active PCMM service flows.

ugs Enables balancing of modems with active UGS service flows.

us-across-ds Sets load balancing on upstream (US) groups across downstream (DS) and DS group methods
are ignored.

pure-ds-load Considers DS load and not US load when calculating DS utilization.

Command Default None

Command Modes
DOCSIS load balancing group mode (config-lb-group)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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 terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# policy
pure-ds-load
Router(config-lb-group)#

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1407
 Cable Commands: i through p
power-adjust

power-adjust
To adjust the channel's power level, use the power-adjust command in the RF channel sub configuration
mode.

power-adjust value

Syntax Description value Value for the power level. Valid range is -6.0 to 2.0 dBmV.

Command Default None.

Command Modes RF channel sub configuration mode (config-rf-chan)

Usage Guidelines This command is used to adjust the channel's power levels.

The following example shows how to change the channel's power level:
router#configure terminal
router(config)#controller integrated-cable 3/0/0
router(config-controller)#rf-chan 5 10
router(config-rf-chan)#type video
router(config-rf-chan)#frequency 723000000
router(config-rf-chan)#rf-output alt
router(config-rf-chan)#power-adjust 0
router(config-rf-chan)#exit
router(config-controller)#exit
router(config)#exit
router#show controller integrated-Cable 3/0/0 rf-channel 5 10
Chan State Admin Frequency Type Annex Mod srate Interleaver dcid power output
5 TEST UP 723000000 VIDEO B 256 5361 I32-J4 164 34 ALT
10 TEST UP 753000000 VIDEO B 256 5361 I32-J4 169 34 ALT

Related Commands Command Description

controller integrated-cable Enters the controller configuration mode.

frequency Defines the RF channel frequency.

qam-profile Defines the QAM profile number.

rf-chan Enters the RF channel sub configuration mode.

rf-output Defines the QAM output mode.

power-adjust Defines the channel power level.

Cisco CMTS Cable Command Reference

1408
 Cable Commands: i through p
power-tilt

power-tilt
To configure downstream power tilt for a controller port, use the power-tilt command in the controller sub
configuration mode.

power-tilt {cable-loss-approx | linear}tilt max-frequency frequency

Syntax Description tile Measured cable loss at frequency, specified in 1/10 dB.
frequency The maximum frequency for the RF channel.

Command Default None

Command Modes Controller sub configuration mode (config-controller).

Command History Release Modification

IOS XE Fuji This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.7.1

Usage Guidelines This command is used to configure downstream power tilt for a controller port.

The following example shows how to define the base channel power level:
router#configure terminal
router(config)#controller Integrated-Cable 3/0/0
router(config-controller)#max-ofdm-spectrum 192000000
router(config-controller)#max-carrier 32
router(config-controller)#base-channel-power 34
router(config-controller)#power-tilt linear 4.0 max-frequency 696000000
router(config-controller)#rf-chan 0 31
router(config-rf-chan)#type DOCSIS
router(config-rf-chan)#frequency 261000000
router(config-rf-chan)#rf-output NORMAL
router(config-rf-chan)#power-adjust -2.0
router(config-rf-chan)#qam-profile 1
router(config-rf-chan)#docsis-channel-id 1
router(config-rf-chan)#exit
router(config-controller)#rf-chan 158
router(config-rf-chan)#power-adjust 0
router(config-rf-chan)#docsis-channel-id 159
router(config-rf-chan)#ofdm channel-profile 20 start-frequency 600000000 width 96000000 plc
645000000

Related Commands Command Description

base-channel-power Sets the base channel power level.

power-adjust Adjusts the power levels of the RF channel.

Cisco CMTS Cable Command Reference

1409
 Cable Commands: i through p
prefix

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_lengthipv6_prefix/ipv6_prefix_length}
no prefix {ipv4_prefix/ipv4_prefix_lengthipv6_prefix/ipv6_prefix_length}

Syntax Description ipv4_prefix IPv4 prefix associated with a particular SAV group, specified in the X.X.X.X/X format.

ipv4_prefix_length Length of the IPv4 prefix. The valid range is from 0 to 32.

ipv6_prefix IPv6 prefix associated with a particular SAV group, specified in the X:X:X:X::/X format.

ipv6_prefix_length Length of the IPv6 prefix. The valid range is from 0 to 128.

Command Default None

Command Modes
SAV Configuration (config-sav)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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 sav1

Router(config-sav)# prefix 10.16.0.0/12
Router(config-sav)# prefix 10::/12
Router(config-sav)# exit

Related Commands Command Description

cable source-verify enable-sav-static Enables SAV prefix processing.

Cisco CMTS Cable Command Reference

1410
Cable Commands: i through p
prefix

Command Description

cable source-verify group Configures SAV groups.

Cisco CMTS Cable Command Reference

1411
 Cable Commands: i through p
principal

principal
To specify the principal core of the RPD, use the principal command in RPD core-interface configuration
mode. To void the principal core configuration, use the no form of this command.

principal

no principal

Command Default None

Command Modes RPD conre-interface configuration (config-rpd-core)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to specify the principal core of the RPD.

The following example shows how to specify the principal core of the RPD:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# core-interface tengigabitethernet 3/1/0
Router(config-rpd-core)# principal

Related Commands Command Description

core-interface Configures the core-interface of the RPD.

Cisco CMTS Cable Command Reference

1412
 Cable Commands: i through p
privacy

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 | rekey value}
no privacy grace-time {authorization | tek}
no privacy timeout {authorize | operational | re-authorize | reject | rekey}

Syntax Description authorization value Authorization grace time in seconds. Valid values are 1 to 1800 seconds. Default value
is 600 seconds.

tek value TEK grace time in seconds. Valid range is 1 to 1800 seconds. Default is 600 seconds.

authorize value Authorize wait timeout in seconds. Valid range is 1 to 30 seconds. Default value is 10
seconds.

operational value Operational Wait timeout in seconds. Valid range is 1 to 10 seconds. Default is 1
second.

re-authorize value Re-authorize wait timeout in seconds. Valid range is 1 to 20 seconds.

reject value Authorize reject wait timeout in seconds. Valid range is 1 to 600 seconds. Default is
60 seconds.

rekey value Rekey wait timeout in seconds. Valid range is 1 to 10 seconds. Default is 1 second.

Command Default None

Command Modes
Cable config-file configuration

Command History Release Modification

12.1(2)EC1 This command was introduced.

12.2(11)BC2 This command was supported on the Release 12.2 BC train.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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.

Cisco CMTS Cable Command Reference

1413
 Cable Commands: i through p
privacy

Note The privacy command appears and is supported only in images with support for BPI or BPI+ encryption.
This option configures the CM for BPI or BPI+ encryption. To use BPI encryption, the Cisco CMTS must
also be configured for BPI or BPI+ encryption, using the cable privacy command.

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.cm

router(config-file)# privacy grace-time tek 1200
router(config-file)# service-class 1 privacy

router(config-file)# exit

router(config)#

Related Commands Command Description

access-denied Disables access to the network.

cable Creates a DOCSIS configuration file and enters configuration file mode.
config-file

cable privacy Enables BPI or BPI+ encryption on the Cisco CMTS.

channel-id Specifies upstream channel ID.

cpe max Specifies CPE information.

download Specifies download information for the configuration file.

frequency Specifies downstream frequency.

option Provides config-file options.

service-class Specifies service class definitions for the configuration file.

snmp manager Specifies Simple Network Management Protocol (SNMP) options.

timestamp Enables time-stamp generation.

Cisco CMTS Cable Command Reference

1414
 Cable Commands: i through p
profile

profile
To bind the profile to the controller, use the profile command in controller configuration mode. To undo the
bind, use no form of this command.

profile id

no profile

Syntax Description id The ID of the configured controller profile.

Command Default None.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

Cisco IOS XE Fuji This command was introduced on the Cisco cBR Series Converged Broadband
16.7.1 Routers.

Usage Guidelines Use this command to bind the profile to the controller.

Examples The following example shows how to bind the profile to the controller:

Router#configure terminal
Router(config)#controller integrated-cable 1/0/1
Router(config-controller)#profile 1

Related Commands Command Description

cable downstream controller-profile Configures the downstream controller profile.

cable upstream controller-profile Configures the upstream controller profile.

Cisco CMTS Cable Command Reference

1415
 Cable Commands: i through p
profile-control

profile-control
To specify the control-plane profile used for MAC management and other control messages, use the
profile-control command in OFDM channel profile configuration mode. To undo the control-plane profile
assignment, use no form of this command.

profile-control {modulation-default value | modulation-profile id}

no profile-control

Syntax Description modulation-default value The default modulation. Valid values are 16-QAM, 64-QAM, 128-QAM,
256-QAM, 512-QAM, 1024-QAM, 2048-QAM, and 4096-QAM.

modulation-profile id Global modulation profile ID.

Command Default 1024-QAM

Command Modes
OFDM channel profile configuration (config-ofdm-chan-prof)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the control-plane profile used for MAC management and other control messages.

Examples The following example shows how to specify the control-plane profile used for MAC management
and other control messages:

Router# configure terminal

Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)# profile-control modulation-default 1024-qam

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

cyclic-prefix Specify the channel cyclic-prefix.

description (OFDM channel profile) Specify a user defined description for the profile.

interleaver-depth Specify the channel interleaver-depth.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-data Specify default modulation or profile as the channel data profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

Cisco CMTS Cable Command Reference

1416
Cable Commands: i through p
profile-control

Command Description

roll-off Specify the channel roll-off value.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1417
 Cable Commands: i through p
profile-data

profile-data
To specify the data-plane profiles used for data packets, use the profile-data command in OFDM channel
profile configuration mode. To undo the data-plane profile assignment, use no form of this command.

profile-data id {modulation-default value | modulation-profile id}

no profile-data id

Syntax Description profile-data id Channel data profile ID. Valid range is from 1 to 5.

modulation-default value The default modulation. Valid values are 16-QAM, 64-QAM, 128-QAM,
256-QAM, 512-QAM, 1024-QAM, 2048-QAM, and 4096-QAM.

modulation-profile id Global modulation profile ID.

Command Default None.

Command Modes
OFDM channel profile configuration (config-ofdm-chan-prof)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the data-plane profiles used for data packets.

Examples The following example shows how to specify the data-plane profiles used for data packets:

Router# configure terminal

Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)# profile-data 3 modulation-default 1024-qam

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

cyclic-prefix Specify the channel cyclic-prefix.

description (OFDM channel profile) Specify a user defined description for the profile.

interleaver-depth Specify the channel interleaver-depth.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-control Specify default modulation or profile as the channel control profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

Cisco CMTS Cable Command Reference

1418
Cable Commands: i through p
profile-data

Command Description

roll-off Specify the channel roll-off value.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1419
 Cable Commands: i through p
profile-description

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 Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines 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 terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable multicast auth profile-name
Router(config)# cable multicast auth profile-name gold
Router(config-mauth)# profile-description gold-configured-may

Related Commands Command Description

cable multicast authorization enable Enables the cable multicast authorization features.
default-action

cable multicast authorization profile-name Defines the cable multicast authorization profile.

show cable multicast authorization Displays the list of defined multicast authorization profiles
and all CMs associated with corresponding profiles.

show running-config interface cable Displays the running configuration for each of the cable
interfaces.

Cisco CMTS Cable Command Reference

1420
 Cable Commands: i through p
profile-ncp

profile-ncp
To specify the ncp profile, use the profile-ncp command in OFDM channel profile configuration mode. To
undo the ncp profile assignment, use no form of this command.

profile-ncp {modulation-default value | modulation-profile id}

no profile-ncp

Syntax Description modulation-default value The default modulation. Valid values are QPSK, 16-QAM, and 64-QAM.

modulation-profile id Global modulation profile ID.

Command Default None.

Command Modes
OFDM channel profile configuration (config-ofdm-chan-prof)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the ncp profile.

Examples The following example shows how to specify the ncp profile:

Router# configure terminal

Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)# profile-ncp modulation-default qpsk

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

cyclic-prefix Specify the channel cyclic-prefix.

description (OFDM channel profile) Specify a user defined description for the profile.

interleaver-depth Specify the channel interleaver-depth.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-control Specify default modulation or profile as the channel control profile.

profile-data Specify default modulation or profile as the channel data profile.

roll-off Specify the channel roll-off value.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1421
 Cable Commands: i through p
protect-tunnel

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 protect-tunnel-name DEPI tunnel name for the protect cable interface line card.

Command Default The N+1 DEPI redundancy feature is disabled.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines 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> enable
Router# configure terminal
Router(config)# depi-tunnel protect1
Router(config-depi-tunnel)# dest-ip 192.0.2.103
Router(config-depi-tunnel)# exit
Router(config)# depi-tunnel depi-tunnel working1
Router(config-depi-tunnel)# protect-tunnel protect1
Router(config-depi-tunnel)# end

Related Commands Command Description

depi-tunnel Specifies a template for DEPI tunnel configuration settings.

Cisco CMTS Cable Command Reference

1422
 Cable Commands: i through p
protocol

protocol
To specify the protocol used in the logical edge device, use the protocol command in logical edge device
configuration mode. To undo the protocol assignment, use the no form of this command.

protocol {GQI | table-based}

no protocol {GQI | table-based}

Command Default None.

Command Modes
Logical edge device configuration mode (config-video-led)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command specifies the protocol.

Examples The following example shows how to specify the protocol:

Router# configure terminal

Router(config)# cable video
Router(config-video)# logical-edge-device vod id 1
Router(config-video-led)# protocol table-based

Related Commands Command Description

logical-edge-device Defines a logical edge device.

show cable video logical-edge-device Displays the logical edge device information.

Cisco CMTS Cable Command Reference

1423
 Cable Commands: i through p
provider-name

provider-name
To specify the provider name as part of the service descriptor, use the provider-name command in the service
descriptor configuration mode. To revoke the configuration, use the no form of the command.

provider-name string

Syntax Description string Specifies the provider

name.

Command Default None.

Command Modes Service descriptor configuration mode (config-video-serv-desc)

Command History Release Modification

Cisco IOS XE Gibraltar 16.10.1c This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

The following example shows how to specify the provider name:

router#configure terminal
router(config)#cable video
router(config-video)#service-descriptor-default
router(config-video-serv-desc)#provider-name test

Related Commands Command Description

serving-area Configures the serving area which enables the set tops to discover VOD content.

service-descriptor-default Enables the operator to specify the default values for the service descriptor.

Cisco CMTS Cable Command Reference

1424
 Cable Commands: i through p
psi-interval

psi-interval
To override the default PSI value, use the psi-interval command in the service distribution group configuration
mode. To revert back to the default psi-interval value, use the no form of the command.

psi-interval number

Syntax Description number Defines the new psi-interval value.

Command Default None.

Command Modes Service distribution group configuration mode (config-video-sdg)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to override the default psi-interval value.

The following example shows how to override the default psi-interval:

router#configure terminal
router(config)#cable video
router(config-video)#service-distribution-group sdg id 1
router(config-video-sdg)#psi-interval 250

Related Commands Command Description

service-distribution-group Defines a service distribution group.

rf-port integrated-cable Defines the physical slot/bay/port to be used in a video

service.

onid Override the default ONID.

show cable video service-distribution-group Displays the SDG configuration.

Cisco CMTS Cable Command Reference

1425
 Cable Commands: i through p
show ptp clock running

show ptp clock running

To display the PTP clock, use the show ptp clock running command.

show ptp clock running

Command Default
Command Modes
Command History Release Modification
Cisco IOS XE 16.8.x This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to display the running PTP clock.

The following example shows how to display the PTP clock.

router# show ptp clock running
PTP Ordinary Clock [Domain 55]
State Ports Pkts sent Pkts rcvd Redundancy
Mode
PHASE_ALIGNED 1 68938 138822 Hot standby
PORT SUMMARY
PTP Master
Name Tx Mode Role Transport State Sessions
Port Addr
slave-from-903 unicast slave Lo1588 Slave 1
10.90.3.93

Cisco CMTS Cable Command Reference

1426
 Cable Commands: i through p
pxf-fail-switchover-trap enable

pxf-fail-switchover-trap enable
To enable the sending of ciscoRFSwactNotif trap which is encoded with extended switchover, that indicates
the Toaster SEU error triggered PRE switchover, use the pxf-fail-switchover-trap enable command in the
redundancy configuration mode.

Note This command is a hidden command.

pxf-fail-switchover-trap enable

Syntax Description This command has no keywords or arguments.

Command Default None.

Command Modes Redundancy configuration mode (config-red)

Command History Release Modification

12.2(33)SCJ1 This command was introduced in Cisco uBR10012 router.

Usage Guidelines Before configuring ciscoRFSwactNotif trap, use snmp-server enable traps rf to enable the sending of
ciscoRFSwactNotf trap for cable related events.

The following example shows how to enable to send the extended switchover reason (uses private
switchover reason 100) of ciscoRFSwactNotif trap:

router#configure terminal
router(config)#redundancy
router(config-red)#pxf-fail-switchover-trap enable
You need to notice the extended switchover reason is a private value (100), which is not
ciscoRFSwactNotif trap standard value, the trap receive utility in customer side may need to be
updated in order to understand the private switchover reason(100). The extended switchover reason
will be sent out after PRE switchover when old active PRE boots up.

Related Commands Command Description

snmp-server enable traps rf Enables the sending of SNMP traps for cable related events.

show redundancy switchover history Displays the redundancy switchover information.

Cisco CMTS Cable Command Reference

1427
 Cable Commands: i through p
pxf-fail-switchover-trap enable

Cisco CMTS Cable Command Reference

1428
Cable Commands: q through sg
• qos-profile enforced, on page 1432
• qos-profile registered, on page 1435
• qam-profile, on page 1437
• r-dti, on page 1438
• rcp-id, on page 1439
• receive-channel, on page 1440
• receive-module, on page 1442
• redundancy, on page 1444
• redundancy force-failover main-cpu, on page 1445
• redundancy force-switchover main-cpu, on page 1447
• redundancy linecard-group, on page 1449
• redundancy reload, on page 1454
• redundancy switch-activity, on page 1457
• registered qos-profile, on page 1459
• remap pid vcg, on page 1461
• rep-period, on page 1462
• report-stream-error cc-error, on page 1464
• report-stream-error input-stream-failure report-interval syslog, on page 1465
• request platform hardware diagnostic load, on page 1466
• request platform hardware diagnostic unload, on page 1467
• request platform software package expand, on page 1468
• request platform software package install node, on page 1469
• request platform software package install rp, on page 1471
• request platform software process restart , on page 1472
• reserve-pid-range, on page 1474
• reset-interval, on page 1475
• restart-retry, on page 1476
• restricted, on page 1477
• revertive, on page 1478
• rf-chan, on page 1479
• rf-channel, on page 1480
• rf-channel (Virtual Carrier Group), on page 1481
• rf-channel (table-based vcg), on page 1482

Cisco CMTS Cable Command Reference

1429
 Cable Commands: q through sg

• rf-channel cable downstream channel-id, on page 1483

• rf-channel depi-tunnel, on page 1486
• rf-channel description, on page 1487
• rf-channel frequency, on page 1489
• rf-channel group-address, on page 1492
• rf-channel ip-address mac-address udp-port, on page 1493
• rf-channel network-delay, on page 1496
• rf-channel rf-power, on page 1498
• rf-channel rf-shutdown, on page 1501
• rf-channel stacking, on page 1503
• rf-output, on page 1504
• rf-port integrated-cable, on page 1505
• rf-switch auxport enable, on page 1506
• roll-off, on page 1507
• route-ecmg, on page 1508
• routing-interface-ip, on page 1510
• routing-interface-vrf, on page 1511
• rpd-ds downstream-cable, on page 1512
• rpd-ds downstream-oob-vom, on page 1513
• rpd-event, on page 1514
• rpd-us upstream-cable, on page 1515
• rpd-us upstream-oob-varpd, on page 1516
• rpd downstream-cable, on page 1517
• sbfd, on page 1518
• scramble-video-audio, on page 1519
• secondary aux, on page 1520
• server, on page 1521
• service divert-limit, on page 1523
• service divert-rate-limit, on page 1524
• service divert-rate-limit ip, on page 1526
• service divert-rate-limit ipv6, on page 1528
• service divert-rate-limit ip trusted-site, on page 1531
• service divert-rate-limit max-rate us-cable, on page 1533
• service divert-rate-limit max-rate wan, on page 1535
• service divert-rate-limit non-ip, on page 1537
• service divert-rate-limit trusted-site, on page 1538
• service divert-rate-limit trusted-site-ipv6, on page 1540
• service instance, on page 1542
• service udp-small-servers max-servers no-limit, on page 1543
• service-class, on page 1545
• service-class (cmts-tag), on page 1547
• service-class (enforce-rule), on page 1548
• service-descriptor-default, on page 1550
• service-distribution-group, on page 1551
• service-id, on page 1552
• service-name, on page 1553

Cisco CMTS Cable Command Reference

1430
Cable Commands: q through sg

• service-type (service descriptor), on page 1554

• service-type (virtual carrier group), on page 1555
• service-type-id (load-balance), on page 1556
• service-type-id (cmts-tag), on page 1557
• serving-area, on page 1558
• session, on page 1559
• session name multicast-label , on page 1562
• session-range, on page 1564
• set clock, on page 1565

Cisco CMTS Cable Command Reference

1431
 Cable Commands: q through sg
qos-profile enforced

qos-profile enforced
To specify a quality-of-service (QoS) profile that should be enforced when users violate their registered QoS
profiles, use the qos-profile enforced command in enforce-rule configuration mode. To delete the enforced
QoS profile from the enforce-rule, use the no form of this command.

qos-profile enforced profile-id [no-persistence]

no qos-profile enforced profile-id [no-persistence]

Syntax Description profile-id Specifies the QoS profile to be enforced. The valid range is 0 to 16383, with a default of 0.

no-persistence (Optional) Specifies that the enforced QoS profile should not remain in force when a cable
modem reboots. Instead, when a cable modem that is in the penalty period reboots, it is
automatically removed from the penalty period and assigned the QoS profile that is specified
in its DOCSIS configuration file.
The default behavior is that enforced QoS profiles remain in force for cable modems across
reboots.

Command Default The value of profile-id defaults to 0, and enforced QoS profiles are persistent across cable modem reboots.

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.3(9a)BC This command was introduced. This command replaces the enforced qos-profile command.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Both the originally provisioned QoS profile and the enforced QoS profile must be created on the Cisco CMTS
router. The profile-id does not support QoS profiles that are created by the cable modem.
An enforce-rule can specify an enforced QoS profile, which is automatically applied to subscribers who
transmit more traffic than allowed by their registered QoS profile. The enforced QoS profile remains in effect
during the penalty time period (see the penalty-period command). At the end of the penalty period, the
subscriber returns to the registered QoS profile.
If a cable modem reboots while it is in its penalty time period, it continues using the enforced QoS profile,
unless the service provider has manually changed the cable modem’s registered QoS profile using the cable
modem qos profile command.
When you change the enforced QoS profile for a currently active enforce-rule, any cable modems using this
rule that are currently in the penalty period continue using the previously configured enforced QoS profile.
Any cable modems that enter the penalty period after this configuration change, however, use the new enforced
QoS profile.

Cisco CMTS Cable Command Reference

1432
 Cable Commands: q through sg
qos-profile enforced

An enforced QoS profile must already have been created on the Cisco CMTS router before you can assign it
to an enforce-rule. If the rule does not exist, the system displays an error message.
When the no-persistence option is specified, the enforced QoS profile is still automatically applied to
subscribers who violate their bandwidth requirements. However, when the cable modem reboots, the Cisco
CMTS router allows the cable modem to use the QoS profile that is specified in its DOCSIS configuration
file.
The no-persistence option can be used when initially using the Subscriber Traffic Management feature to
identify potential problem applications and users. When repeat offenders are identified, they can then be
assigned enforce-rules that do not use the no-persistence option, so that they remain in the penalty period
even if they reboot their cable modems.

Note The system automatically applies the enforced QoS profile to violators only if the enforce keyword has been
used with the activate-rule-at-byte-count command.

Examples The following example shows profile 12 being assigned as the enforced QoS profile to an enforce-rule:

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# qos-profile enforced 12

The following example shows profile 12 being assigned as the enforced QoS profile to an enforce-rule,
but with the no-persistence option specified, so that the enforced QoS profile does not remain in
force if the cable modem reboots:

Router# configure terminal

Router(config)# cable qos enforce-rule residential

Router(enforce-rule)# qos-profile enforced 12 no-persistence

The following example shows the error message that is displayed when the specified QoS profile
does not exist on the CMTS:

Router# configure terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# qos-profile enforced 98

The qos profile 98 doesn't exist or it's a cm created QoS profile

Related Commands Command Description

cable qos enforce-rule Creates an enforce-rule to enforce a particular QoS profile for
subscriber traffic management and enters enforce-rule configuration
mode.

Cisco CMTS Cable Command Reference

1433
 Cable Commands: q through sg
qos-profile enforced

Command Description

debug cable subscriber-monitoring Displays enforce-rule debug messages for subscriber traffic
management on the Cisco CMTS routers.

duration Specifies the time period and sample rate to be used for monitoring
subscribers.

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management

on a Cisco CMTS router.

monitoring-basics Specifies the type of monitoring for subscriber traffic management

on a Cisco CMTS router.

peak-time1 Specifies peak and offpeak monitoring times on a Cisco CMTS router.

qos-profile registered Specifies the registered QoS profile that should be used for this
enforce-rule.

service-class (enforce-rule) Identifies a particular service class for cable modem monitoring in an
enforce-rule.

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1434
 Cable Commands: q through sg
qos-profile registered

qos-profile registered
To specify the registered quality of service (QoS) profile that should be used for this enforce-rule, use the
qos-profile registered command in enforce-rule configuration mode. To remove the registered QoS profile
from the enforce-rule, use the no form of this command.

qos-profile registered profile-id

no qos-profile registered profile-id

Syntax Description profile-id Specifies the QoS profile to be monitored. This profile must be created on the Cisco CMTS router.
If you want to manage a cable modem that uses a modem-created QoS profile, you must first
create that exact QoS profile on the CMTS router before using this command. The valid range is
0 to 16383, with a default of 0.

Command Default The default profile ID is 0.

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.3(9a)BC This command was introduced. This command replaces the registered qos-profile
command.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You must specify a registered QoS profile for each enforce-rule. The Cisco CMTS router then uses the
registered profile ID to match subscribers’ service flows to the proper enforce-rules.
When you change the registered QoS profile for an active rule, the cable modems that had been using the
previous registered QoS profile are no longer managed by the Subscriber Traffic Management feature. Instead,
the rule begins managing those cable modems that use the new registered QoS profile.

Note The registered QoS profile must be created on the Cisco CMTS router before you can assign it to an
enforce-rule. If the rule does not exist, the system displays an error message. If you want to manage a cable
modem that is currently using a modem-created QoS profile, you must first manually create a new QoS profile
on the CMTS router that has the same QoS parameters as the modem-created profile. Then allow the modem
to come online using the manually created profile, before using the qos-profile registered command.

Examples The following example shows profile 50 being assigned as the registered QoS profile to an
enforce-rule:

Cisco CMTS Cable Command Reference

1435
 Cable Commands: q through sg
qos-profile registered

Router# configure terminal

Router(config)# cable qos enforce-rule enforce-rule

Router(enforce-rule)# qos-profile registered 50

The following example shows the error message that is displayed when the specified QoS profile
does not exist on the CMTS:

Router# configure terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# qos-profile registered 99

The qos profile 99 doesn't exist or it's a cm created QoS profile

Related Commands Command Description

cable qos enforce-rule Creates an enforce-rule to enforce a particular QoS profile for
subscriber traffic management and enters enforce-rule configuration
mode.

debug cable subscriber-monitoring Displays enforce-rule debug messages for subscriber traffic
management on the Cisco CMTS routers.

duration Specifies the time period and sample rate to be used for monitoring
subscribers.

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management

on a Cisco CMTS router.

monitoring-basics Specifies the type of monitoring for subscriber traffic management

on a Cisco CMTS router.

peak-time1 Specifies peak and offpeak monitoring times on a Cisco CMTS router.

qos-profile enforced Specifies a QoS profile that should be enforced when users violate
their registered QoS profiles.

service-class (enforce-rule) Enables the enforcing of QOS profiles according to service class.

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1436
 Cable Commands: q through sg
qam-profile

qam-profile
To define the QAM profile number, use the qam-profile command in the RF channel sub configuration mode.

qam-profile value

Syntax Description value Value for the QAM profile. The QAM profiles are defined before they are associated with rf-channels.
Valid range is 0 to 31.
• QAM profile ID 0 to 5
• System defined 6 to 31

Once defined, the rf-channel associated with that profile must match the correct qam-profile type.
For instance, qam-profile 4 is defined for video, and may be used with rf-channels of type VIDEO.

Command Default None.

Command Modes RF channel sub configuration mode (config-rf-chan)

Usage Guidelines This command is used to define the QAM profile number.

The following example shows how to define the QAM profile number:
router#configure terminal
router(config)#controller integrated-cable 3/0/0
router(config-controller)#rf-chan 5 10
router(config-rf-chan)#type video
router(config-rf-chan)#frequency 723000000
router(config-rf-chan)#rf-output alt
router(config-rf-chan)#power-adjust 0
router(config-rf-chan)#qam-profile 4
router(config-rf-chan)#exit
router(config-controller)#exit
router(config)#exit
router#show controller integrated-Cable 3/0/0 rf-channel 5 10
Chan State Admin Frequency Type Annex Mod srate Interleaver dcid power output
5 TEST UP 723000000 VIDEO B 256 5361 I32-J4 164 34 ALT
10 TEST UP 753000000 VIDEO B 256 5361 I32-J4 169 34 ALT

Related Commands Command Description

controller integrated-cable Enters the controller configuration mode.

frequency Defines the RF channel frequency.

qam-profile Defines the QAM profile number.

rf-chan Enters the RF channel sub configuration mode.

rf-output Defines the QAM output mode.

power-adjust Defines the channel power level.

Cisco CMTS Cable Command Reference

1437
 Cable Commands: q through sg
r-dti

r-dti
To specify the Remote DOCSIS Timing Interface (R-DTI) configuration ID to use in RPD, use the r-dti
command in RPD configuration mode. To void the R-DTI configuration specification, use the no form of this
command.

r-dti configuration_id

no r-dti

Syntax Description configuration_id Specifies the ID of the R-DTI configuration previously created.

Command Default None

Command Modes RPD configuration (config-rpd)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to specify the R-DTI configuration ID.

The following example shows how to specify the R-DTI configuration ID:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# r-dti 1

Cisco CMTS Cable Command Reference

1438
 Cable Commands: q through sg
rcp-id

rcp-id
To assign a receive channel profile (RCP) ID to a receive channel configuration (RCC) template, use the
rcp-id command in RCC template configuration mode. To remove the RCP ID, use the no form of this
command.

rcp-id rcp-id
no rcp-id rcp-id

Syntax Description rcp-id Specifies an RCP ID for the RCC template. The valid range is from 00 00 00 00 00 to FF FF FF FF
FF.

Command Default By default the RCP ID is set to 00 00 00 00 00. However, you must change the default value to a non-zero
RCP ID.

Command Modes
RCC template configuration (config-rcc-template)

Command History Release Modification

12.2(33)SCB This command was introduced.

Usage Guidelines A valid RCC template consists of a configured RCP ID, a receive module (RM) entry, and a receive channel
(RC) entry.
First, you define an RCC template for an RCP, and then assign the template to a cable interface to generate
RCCs based on the actual DS channel configuration.

Examples The following example shows how to assign an RCP ID to an RCC template:

Router# configure terminal

Router(config)# cable rcc-template
1
Router(config-rcc-template)# rcp-id 00 10 00 00 03

Related Commands Command Description

rcp-id Specifies an ID for the receive channel profile.

receive-module Specifies a receive module entry in the form of a numeric value.

receive-channel Specifies a receive channel entry in the form of a numeric value.

Cisco CMTS Cable Command Reference

1439
 Cable Commands: q through sg
receive-channel

receive-channel
To associate a receive channel to a receive module (RC), use the receive-channel command in RCC template
configuration mode. To restore the default value, use the no form of this command.

receive-channel index center-frequency Hz connected-receive-module index [primary]

no receive-channel index center-frequency Hz connected-receive-module index

Syntax Description index Specifies the index value for the receive channel. The valid range is 1 to 10.

center-frequency Specifies the center frequency for the receive channel.

Hz Specifies the center frequency value in Hz. The valid range is

55000000-858000000.

connected-receive-module Specifies a nested receive module in the RCC template.

Generally, only one receive module is configured for an RCC template.

index Specifies the index value for the connected receive module. The valid range is
1 to 10.

primary (Optional) Indicates that it is a CM primary channel and an RCC can be derived
from this channel.

Command Default None

Command Modes
RCC template configuration (config-rcc-template)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines A valid RCC template consists of a configured RCP ID, a receive module (RM) entry, and a receive channel
(RC) entry. First, you define an RCC template for an RCP, and then assign the template to a cable interface
to generate RCCs based on the actual DS channel configuration.
An RCC template configures the physical layer components described by an RCP, including receive modules
and receive channels to specific downstream frequencies, and specifies the interconnections among receive
modules or between receive modules and receive channels.
A receive module can include multiple receive channels. So we need to specify which receive channel belongs
to which receive module.

Examples The following example shows how to associate a receive channel to a receive module:

Router# configure terminal

Cisco CMTS Cable Command Reference

1440
 Cable Commands: q through sg
receive-channel

Router(config)# cable rcc-template

1
Router(config-rcc-template)# rcp-id 00 10 00 00 03
Router(config-rcc-template)# receive-module 1 first-channel-center-frequency 555000000
Router(config-rcc-template)# receive-channel 1 center-frequency 555000000
connected-receive-module 1 primary
Router(config-rcc-template)# receive-channel 2 center-frequency 561000000
connected-receive-module 1

Related Commands Command Description

cable rcc-template Defines a receive channel configuration (RCC) template for an RCP.

rcp-id Specifies an ID for the receive channel profile.

receive-module Specifies a receive module entry in the form of a numeric value.

Cisco CMTS Cable Command Reference

1441
 Cable Commands: q through sg
receive-module

receive-module
To associate a receive module (RC) to a Receive Channel Configuration (RCC) template, use the
receive-module command in RCC template configuration mode. To restore the default value, use the no form
of this command.

receive-module index first-channel-center-frequency Hz [connected-receive-module index]

no receive-module index first-channel-center-frequency Hz [connected-receive-module index]

Syntax Description index Specifies the index value for the receive module. The valid index range is
1 to 10.

first-channel-center-frequency Specifies the center frequency of the first channel of the receive module
channel block.

Hz Specifies the center frequency value in Hz. The valid range is 55000000 to
858000000.

connected-receive-module (Optional) Specifies a nested receive module in the RCC template.

Generally, only one receive module is configured for an RCC template.

index (Optional) Specifies the index value for the connected receive module. The
valid range is 1 to 10.

Command Default None

Command Modes
RCC template configuration (config-rcc-template)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines A valid RCC template consists of a configured RCP ID, a receive module (RM) entry, and a receive channel
(RC) entry. First, you define an RCC template for an RCP, and then assign the template to a cable interface
to generate RCCs based on the actual DS channel configuration.
An RCC template configures the physical layer components described by an RCP, including receive modules
and receive channels to specific downstream frequencies, and specifies the interconnections among receive
modules or between receive modules and receive channels.
A receive module can include multiple receive channels. So we need to specify which receive channel belongs
to which receive module.

Examples The following example shows how to associate a receive module to an RCC template:

Router# configure terminal

Cisco CMTS Cable Command Reference

1442
 Cable Commands: q through sg
receive-module

Router(config)# cable rcc-template

1
Router(config-rcc-template)# rcp-id 00 10 00 00 03
Router(config-rcc-template)# receive-module 1 first-channel-center-frequency 555000000
Router(config-rcc-template)# receive-channel 1 center-frequency 555000000
connected-receive-module 1 primary
Router(config-rcc-template)# receive-channel 2 center-frequency 561000000
connected-receive-module 1

Related Commands Command Description

cable rcc-template Defines a receive channel configuration (RCC) template for an RCP.

rcp-id Specifies an ID for the receive channel profile.

receive-channel Specifies a receive channel entry in the form of a numeric value.

Cisco CMTS Cable Command Reference

1443
 Cable Commands: q through sg
redundancy

redundancy
To configure line card redundancy, use the redundancy command in global configuration mode.

redundancy

Syntax Description This command has no arguments or keywords.

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

IOS-XE Release 3.16.0S This command was introduced on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines Use the redundancy command to enter the redundancy configuration mode.

Examples The following example shows how to configure line card redundancy:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# redundancy
Router(config-red)# linecard-group 0 internal-switch
Router(config-red-lc)# description RedundancyGroup0
Router(config-red-lc)# class 1:N
Router(config-red-lc)# revertive 60
Router(config-red-lc)# member slot 1 primary
Router(config-red-lc)# member slot 0 secondary

Related Commands Command Description

linecard-group internal-switch Creates a line card group for the line card.

description Adds a description to the line card group.

class Configures redundancy class on the line card.

Cisco CMTS Cable Command Reference

1444
 Cable Commands: q through sg
redundancy force-failover main-cpu

redundancy force-failover main-cpu

To force a switchover, so that the standby Performance Routing Engine (PRE1) module becomes the active
PRE1 module, use theredundancy force-failover main-cpu command in privileged EXEC mode.

redundancy force-failover main-cpu

Syntax Description This command has no keywords or arguments.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(4)XF1 This command was introduced for the Cisco uBR10012 router.

12.2(11)BC3 The active PRE1 module checks to see if a switchover is currently in progress before
implementing this command.

12.3(21)BC This command is replaced by the redundancy switch-activity command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The redundancy force-failover main-cpu command initiates a manual switchover, so that the standby PRE1
module becomes the active PRE1 module and assumes full responsibilities for router operations. This command
requires that both PRE1 modules are running a Cisco IOS software image that supports the Route Processor
Redundancy (RPR) feature.

Note The terms failover and switchover are interchangeable, but switchover is the term used across all Cisco
platforms capable of high-availability operation.

A manual switchover is typically done for one of the following reasons:

• You want to upgrade or replace the active PRE1 module.
• You have upgraded the Cisco IOS software on the standby PRE1 module and want the standby PRE1
module to begin using the new software image. This also allows you to upgrade the software on the
former active PRE1 module without interrupting systems operations.
• You want to test switchover operation on the system.
A switchover can also be manually initiated by removing the active PRE1 module from the chassis, but using
the redundancy force-failover main-cpu command provides a more graceful switchover, without generating
hardware alarms.

Cisco CMTS Cable Command Reference

1445
 Cable Commands: q through sg
redundancy force-failover main-cpu

Tip Do not perform a switchover immediately after you change the configuration and save it to the NVRAM.
Instead, wait a few minutes to allow the two PRE1 modules to synchronize the new configuration, and then
perform the switchover.

Tip Wait two to three minutes after a switchover before switching the system back to the original PRE1 module,
so as to allow the system to stabilize and so that both PRE1 modules are ready for the switch. In Cisco IOS
Release 12.2(11)BC3 and later releases, the active PRE1 module will not initiate a new switchover until a
current switchover is complete and the system has stabilized.

Examples The following example shows a switchover being manually initiated:

Router# redundancy force-failover main-cpu

Proceed with switchover to standby PRE? [confirm] y

Note Pressing enter or y confirms the action and begins the switchover. Pressing any other key cancels
the switchover and returns control to the current active PRE1 module.

The following example shows a switchover being attempted but failing because the standby PRE1
module is either not ready, not available, or not installed:

Router# redundancy force-failover main-cpu

Proceed with switchover to standby PRE? [confirm]

Standby PRE not ready, switchover aborted.
Router#

Note In some versions of Cisco IOS software, a failed software switchover will show the following message:
Unable to communicate with standby PRE, switchover aborted.

Related Commands Command Description

associate Associates two line cards for Automatic Protection Switching (APS)
redundancy protection.

redundancy Enters redundancy configuration mode so that the synchronization parameters

can be configured.

redundancy reload Resets the standby PRE1 module, or to reset both the active and standby PRE1
modules.

redundancy switch-activity Forces a switchover to the standby PRE module.

Cisco CMTS Cable Command Reference

1446
 Cable Commands: q through sg
redundancy force-switchover main-cpu

redundancy force-switchover main-cpu

To force a standby Performance Routing Engine (PRE) to assume the role of an active PRE, use the redundancy
force-switchovermain-cpu command in privileged EXEC mode.

redundancy force-switchovermain-cpu

Syntax Description None

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Before using this command, install the Cisco IOS software image (to ensure high availability), and configure
the Route Processor Redundancy (RPR) mode on both the PRE modules.

Note The terms failover and switchover are interchangeable, but switchover is the term used across all Cisco
platforms capable of high-availability operation.

Note We recommend you use the redundancy force-switchover main-cpu command only on the active PRE
module. The active PRE crashes used on the standby PRE.

Examples The following example shows a manual switchover:

Router# redundancy force-switchover main-cpu

Proceed with switchover to standby PRE? [confirm] y

Preparing to Switch Activity

Note Pressing enter or y confirms the action and begins the switchover. Pressing any other key cancels
the switchover and returns control to the currently active PRE module.

Cisco CMTS Cable Command Reference

1447
 Cable Commands: q through sg
redundancy force-switchover main-cpu

The following example shows a switchover being attempted but failing because the standby PRE
module is either not ready, not available, or not installed:

Router# redundancy force-switchover main-cpu

Proceed with switchover to standby PRE? [confirm] n

Standby PRE not ready, switchover aborted.

Router#

Related Commands Command Description

redundancy Enters the redundancy configuration mode so that the synchronization

parameters could be configured.

redundancy reload Resets the standby PRE module or resets both the active and standby PRE
modules.

redundancy switch-activity Forces a switchover to the standby PRE module.

show redundancy Displays the current active and standby Supervisor card redundancy status.

Cisco CMTS Cable Command Reference

1448
 Cable Commands: q through sg
redundancy linecard-group

redundancy linecard-group
To trigger a switchover from the working line card to the protect line card, or to revert from the protect line
card to the working line card on the Cisco uBR10012 and Cisco cBR series routers, use the redundancy
linecard-group command in privileged EXEC mode.

redundancy linecard-group {lockout | resync | revertback | switchover from | unlockout} slot/subslot

Cisco cBR Series Converged Broadband Routers
redundancy linecard-group switchover from slot

Syntax Description lockout Locks a line card switchover from the specified working slot and subslot.

resync Specifies static synchronization from the working line card to the protect line card.

revertback Reverts from the protect line card to the working line card.

switchover Triggers a switchover from the working line card to the protect line card.
from

slot (Cisco cBR series routers) Slot number of the interface card. The range is from 0 to 3 and
6 to 9 on the Cisco cBR-8 router.

unlockout Removes the switchover lockout from the specified working slot and subslot.

slot /subslot (Cisco uBR10012 router) Specifies the cable interface line card.
• slot—Chassis slot number of the cable interface line card. The valid range is from 5
to 8.
• subslot—(Cisco uBR10012 router only) Secondary slot number of the cable interface
line card. Valid subslots are 0 and 1.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(13a)BC This command was introduced.

12.2(33)SCE This command was modified. A new keyword, resync, was added to enable the Cisco
uBR10012 router to perform a manual synchronization from the working line card to the
protect line card.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The lockout, resync, revertback, and unlockout keywords were removed.

Usage Guidelines The redundancy linecard-group command is supported only on the Cisco uBR10012 and Cisco cBR series
routers.

Cisco CMTS Cable Command Reference

1449
 Cable Commands: q through sg
redundancy linecard-group

When the normal (system initiated) static line card synchronization fails, use the redundancy linecard-group
command with the resync keyword to enable the Cisco uBR10012 router to perform a manual synchronization
from the working line card to the protect line card.

Examples The following example shows how to lock a line card switchover from slot 5 and subslot 0 on the
Cisco uBR10012 router using the redundancy linecard-group command with the lockout keyword:

Router# redundancy linecard-group lockout 5/0

HCCP LC: 5/0 Working will be locked out, this operation will prevent all kinds of switchover.

The following example shows how to remove the switchover lockout from slot 5 and subslot 0 on
the Cisco uBR10012 router using the redundancy linecard-group command with the unlockout
keyword:

Router# redundancy linecard-group unlockout 5/0

The following example shows how to enable the Cisco uBR10012 router to perform a manual
synchronization from the working line card to the protect line card using the redundancy
linecard-group command with the resync keyword:

Router# redundancy linecard-group resync 5/0

*Nov 9 23:09:09.049: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U2, changed state to
administratively down
*Nov 9 23:09:09.049: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U1, changed state to
administratively down
*Nov 9 23:09:09.049: %SNMP-5-LINK_DOWN: LinkDown:Interface Cable5/1/1-upstream2 changed
state to down
*Nov 9 23:09:09.049: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U0, changed state to
administratively down
*Nov 9 23:09:09.057: %SNMP-5-LINK_DOWN: LinkDown:Interface Cable5/1/1-upstream1 changed
state to down
*Nov 9 23:09:09.057: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U0, changed state to up
*Nov 9 23:09:09.057: %SNMP-5-LINK_DOWN: LinkDown:Interface Cable5/1/1-upstream0 changed
state to down
*Nov 9 23:09:09.061: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U1, changed state to up
*Nov 9 23:09:09.061: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U2, changed state to up
*Nov 9 23:09:09.173: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/1/1-upstream0 changed state
to up
SLOT 5/1: Nov 9 23:09:09.057: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U2, changed state
to administratively down
SLOT 5/1: Nov 9 23:09:09.057: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U1, changed state
to administratively down
SLOT 5/1: Nov 9 23:09:09.057: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U0, changed state
to administratively down
SLOT 5/1: Nov 9 23:09:09.173: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U0, changed state
to up
SLOT 5/1: Nov 9 23:09:09.177: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U1, changed state
to up
SLOT 5/1: Nov 9 23:09:09.177: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U2, changed state
to up
*Nov 9 23:09:19.457: %HCCP-5-SWITCHOVERREADY: HCCP card 5/1 Mbr 50 Protect: ready to
switchover.
*Nov 9 23:09:19.457: %HCCP-5-SWITCHOVERREADY: HCCP card 5/0 Mbr 50 Working: ready to
switchover.

Cisco CMTS Cable Command Reference

1450
Cable Commands: q through sg
redundancy linecard-group

The following example shows how to enable the Cisco uBR10012 router to perform a switchover
from the working line card to the protect line card using the redundancy linecard-group command
with the switchover from keyword:
The following example shows how to enable the Cisco uBR10012 router to perform a switchover
from the working line card to the protect line card using theredundancy linecard-group command
with the switchover from keyword:

Router# redundancy linecard-group switchover from 5/0

*Nov 9 23:17:27.489: %HCCP-5-LC_ACTIVE: HCCP card 5/1 Mbr 50 Protect: change state to
active due to: CLI Switch.
*Nov 9 23:17:27.525: %HCCP-5-LC_STANDBY: HCCP card 5/0 Mbr 50 Working: change state to
standby due to: CLI Switch.
*Nov 9 23:17:27.525: %HCCP-5-CHANON: HCCP card 5/1 Mbr 50 Protect: turning on channel.
*Nov 9 23:17:27.525: %HCCP-6-HCCP_CHAN_RFSW_SNMP_INFO: HCCP_LC_CHAN: waits forsnmp response
asynchronously.
*Nov 9 23:17:27.541: %SNMP-5-LINK_UP: LinkUp:Interface Wideband-Cable5/1/1:0 changed state
to up
*Nov 9 23:17:27.541: %LINEPROTO-5-UPDOWN: Line protocol on Interface Wideband-Cable5/1/1:0,
changed state to up
*Nov 9 23:17:27.541: %SNMP-5-LINK_UP: LinkUp:Interface Wideband-Cable5/1/1:2 changed state
to up
*Nov 9 23:17:27.541: %LINEPROTO-5-UPDOWN: Line protocol on Interface Wideband-Cable5/1/1:2,
changed state to up
*Nov 9 23:17:27.541: %SNMP-5-LINK_UP: LinkUp:Interface Wideband-Cable5/1/1:4 changed state
to up
*Nov 9 23:17:27.541: %LINEPROTO-5-UPDOWN: Line protocol on Interface Wideband-Cable5/1/1:4,
changed state to up
*Nov 9 23:17:27.905: %HCCP-6-HCCP_CHAN_RFSW_SNMP_INFO: HCCP_LC_CHAN: snmp set to rf switch
is successful.
SLOT 5/1: Nov 9 23:17:27.597: %HCCP-6-LC_RPLC_CFGSYNC_CONFIG_RECOVER: HCCP 14 50 Protect:
LC critical rplc_cfgsync configuration recover is succeed.
SLOT 5/1: Nov 9 23:17:27.601: %HCCP-6-LC_RPLC_CFGSYNC_CONFIG_RECOVER: HCCP 15 50 Protect:
LC critical rplc_cfgsync configuration recover is succeed.
*Nov 9 23:17:28.121: %HCCP-3-DATA_PLANE_READY: HCCP data plane for card 5/1 member 50 is
ready.
*Nov 9 23:17:28.493: %LINEPROTO-5-UPDOWN: Line protocol on Interface Cable5/1/0, changed
state to up
*Nov 9 23:17:28.493: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/1/0 changed state to up
*Nov 9 23:17:28.497: %LINEPROTO-5-UPDOWN: Line protocol on Interface Cable5/1/1, changed
state to up
*Nov 9 23:17:28.497: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/1/1 changed state to up
*Nov 9 23:17:28.497: %LINEPROTO-5-UPDOWN: Line protocol on Interface Cable5/1/2, changed
state to up
*Nov 9 23:17:28.497: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/1/2 changed state to up
*Nov 9 23:17:37.801: %LINK-3-UPDOWN: Interface Modular-Cable5/1/1:0, changed state to up
*Nov 9 23:17:38.513: %HCCP-6-STATICSYNC_COMPLETED: HCCP static sync for card 5/1 member
50 is completed in 56 ms.
*Nov 9 23:17:38.801: %LINEPROTO-5-UPDOWN: Line protocol on Interface Modular-Cable5/1/1:0,
changed state to up
*Nov 9 23:17:48.513: %HCCP-5-SWITCHOVERREADY: HCCP card 5/0 Mbr 50 Working: ready to
switchover.
*Nov 9 23:17:48.513: %HCCP-5-SWITCHOVERREADY: HCCP card 5/1 Mbr 50 Protect: ready to
switchover.

The following example shows how to revert from the protect line card to the working line card using
the redundancy linecard-group command with the revertback keyword on the Cisco uBR10012
router:

Router# redundancy linecard-group revertback 5/0

Cisco CMTS Cable Command Reference

1451
 Cable Commands: q through sg
redundancy linecard-group

*Nov 9 23:21:33.277: %HCCP-5-LC_ACTIVE: HCCP card 5/0 Mbr 50 Working: change state to
active due to: CLI Switch.
*Nov 9 23:21:33.285: %HCCP-5-LC_STANDBY: HCCP card 5/1 Mbr 50 Protect: change state to
standby due to: CLI Switch.
*Nov 9 23:21:33.297: %HCCP-5-CHANON: HCCP card 5/0 Mbr 50 Working: turning on channel.
*Nov 9 23:21:33.301: %HCCP-5-CHANOFF: HCCP card 5/1 Mbr 50 Protect: turning off channel.
*Nov 9 23:21:33.301: %HCCP-6-HCCP_CHAN_RFSW_SNMP_INFO: HCCP_LC_CHAN: waits for snmp response
asynchronously.
*Nov 9 23:21:33.433: %UBR10000-5-UPDOWN: Interface Cable5/1/0 U2, changed state to
administratively down
*Nov 9 23:21:33.437: %UBR10000-5-UPDOWN: Interface Cable5/1/0 U1, changed state to
administratively down
*Nov 9 23:21:33.441: %UBR10000-5-UPDOWN: Interface Cable5/1/0 U0, changed state to
administratively down
*Nov 9 23:21:33.481: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U2, changed state to
administratively down
*Nov 9 23:21:33.481: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U2, changed state to
administratively down
Nov 9 23:21:33.585: %interface Cable5/1/0 U0 Docsis mode set to DOCSIS 1.x-only Nov 9
23:21:33.585: %Modulation profile set to 21
*Nov 9 23:21:34.277: %LINEPROTO-5-UPDOWN: Line protocol on Interface Cable5/0/0, changed
state to up
*Nov 9 23:21:34.277: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/0/0 changed state to up
*Nov 9 23:21:34.277: %LINEPROTO-5-UPDOWN: Line protocol on Interface Cable5/0/1, changed
state to up
*Nov 9 23:21:34.277: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/0/1 changed state to up
*Nov 9 23:21:34.277: %LINEPROTO-5-UPDOWN: Line protocol on Interface Cable5/0/2, changed
state to up
*Nov 9 23:21:34.277: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/0/2 changed state to up
*Nov 9 23:21:34.309: %LINEPROTO-5-UPDOWN: Line protocol on Interface Cable5/0/3, changed
state to up
*Nov 9 23:21:34.309: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/0/3 changed state to up
*Nov 9 23:21:34.309: %LINEPROTO-5-UPDOWN: Line protocol on Interface Cable5/0/4, changed
state to up
*Nov 9 23:21:34.309: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/0/4 changed state to up
*Nov 9 23:21:35.513: %LINK-3-UPDOWN: Interface Modular-Cable5/1/1:0, changed state to down
*Nov 9 23:21:36.513: %LINEPROTO-5-UPDOWN: Line protocol on Interface Modular-Cable5/1/1:0,
changed state to down
*Nov 9 23:21:46.537: %UBR10000-5-USFREQCHG: Interface Cable5/1/0 U0, changed to Freq 10.000
MHz
*Nov 9 23:21:46.545: %UBR10000-5-USFREQCHG: Interface Cable5/1/0 U1, changed to Freq 30.000
MHz
*Nov 9 23:21:46.549: %UBR10000-5-USFREQCHG: Interface Cable5/1/0 U2, changed to Freq 20.000
MHz
*Nov 9 23:21:46.581: %UBR10000-5-USFREQCHG: Interface Cable5/1/1 U0, changed to Freq 25.000
MHz
*Nov 9 23:21:46.585: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U0, changed state to up
*Nov 9 23:21:46.585: %UBR10000-5-USFREQCHG: Interface Cable5/1/1 U1, changed to Freq 15.000
MHz
*Nov 9 23:21:46.585: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U1, changed state to up
*Nov 9 23:21:46.589: %UBR10000-5-USFREQCHG: Interface Cable5/1/1 U2, changed to Freq 35.000
MHz
*Nov 9 23:21:46.589: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U2, changed state to up
*Nov 9 23:21:46.657: %SNMP-5-LINK_UP: LinkUp:Interface Cable5/1/1-upstream0 changed state
to up
Nov 9 23:21:46.669: %interface Cable5/1/0 U0 Docsis mode set to ATDMA-only (1.x CMs will
go offline)
Nov 9 23:21:46.669: %Modulation profile set to 221
SLOT 5/1: Nov 9 23:21:46.689: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U0, changed state
to up
SLOT 5/1: Nov 9 23:21:46.693: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U1, changed state
to up
SLOT 5/1: Nov 9 23:21:46.693: %UBR10000-5-UPDOWN: Interface Cable5/1/1 U2, changed state
to up

Cisco CMTS Cable Command Reference

1452
 Cable Commands: q through sg
redundancy linecard-group

*Nov 9 23:21:57.033: %HCCP-5-SWITCHOVERREADY: HCCP card 5/1 Mbr 50 Protect: ready to

switchover.
*Nov 9 23:21:57.033: %HCCP-5-SWITCHOVERREADY: HCCP card 5/0 Mbr 50 Working: ready to
switchover.

The following example shows how to trigger a switchover from working card to protect card on a
Cisco cBR-8 router:
Router# redundancy linecard-group switchover from slot 3

Related Commands Command Description

show hccp (Not for Cisco cBR Series Routers)

Displays Hot Standby Connection-to-Connection Protocol (HCCP) group information
for a specific cable interface.

show hccp interface (Not for Cisco cBR Series Routers)

Displays group information for a specific cable interface on which one or more groups
and authentication modes have been configured.

show hccp linecard (Not for Cisco cBR Series Routers)

Displays information about HCCP groups associated with a line card.

Cisco CMTS Cable Command Reference

1453
 Cable Commands: q through sg
redundancy reload

redundancy reload
To manually reload a standby Route Processor (RP) module, use the redundancy reload command in privileged
EXEC mode.

redundancy reload {peer | shelf}

Syntax Description peer Reloads only the standby PRE1 module or Supervisor card.

shelf Reloads both the active and standby PRE1 module or Supervisor card.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(4)XF1 This command was introduced for the Cisco uBR10012 router.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA This command was removed from Cisco IOS Release 12.2(33)SCA. It is replaced by the
hw-module standby-cpu reset command.

12.2(44)SQ This command was integrated into Cisco IOS Release 12.2(44)SQ. Support for the Cisco
RF Gateway 10 was added.

15.2(4)M This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The redundancy reload peer command is used to reset the standby RP module when there are any failures,
tracebacks, or functionality and behavior mismatches on either one or both active and standby RP modules.
This command does not have an impact on active device operations, assuming a switchover is not required
while the standby module is resetting.
The redundancy reload shelf command reloads the Cisco IOS software on both the active and standby RP
modules. This command interrupts services on the router until all the RP modules and the line cards initialize
and come back online.

Examples The following example shows how to manually reload the standby RP module:

Router# redundancy reload peer

Reload peer? [confirm] y

Preparing to reload peer

Cisco CMTS Cable Command Reference

1454
 Cable Commands: q through sg
redundancy reload

Note Pressing enter or y begins the reload. Pressing any other key cancels the reload and returns control
to the active RP module.

The following is sample output when a standby RP module is not installed on a router:

Router# redundancy reload peer

System is running in SIMPLEX mode, reload anyway? [confirm] n

Peer reload not performed.

The following example shows how to reload all RP modules:

Router# redundancy reload shelf

Reload the entire shelf [confirm] y

Preparing to reload entire shelf

Note Pressing enter or y begins the reload. Pressing any other key cancels the reload and returns control
to the current active PRE1 module.

Cisco RF Gateway 10
The following example shows the system response when a standby Supervisor card is not installed
in the Cisco RFGW-10:

Switch# redundancy reload peer

System is running in SIMPLEX mode, reload anyway? [confirm] n

Peer reload not performed.

The following example shows how to reload both Supervisor cards on the Cisco RFGW-10:

Switch# redundancy reload shelf

Reload the entire shelf [confirm] y

Preparing to reload entire shelf

Note Pressing Enter or y confirms the action and begins the reload of both cards. Pressing any other key
cancels the reload and returns control to the current active Supervisor card.

Related Commands Command Description

associate slot Associates slots for APS processor redundancy.

redundancy Enters redundancy configuration mode so that the synchronization

parameters can be configured.

Cisco CMTS Cable Command Reference

1455
 Cable Commands: q through sg
redundancy reload

Command Description

redundancy force-failover main-cpu Forces a switchover, so that the standby RP module becomes the
active RP module.

redundancy switch-activity Forces a switchover to the standby RP module.

Cisco CMTS Cable Command Reference

1456
 Cable Commands: q through sg
redundancy switch-activity

redundancy switch-activity
To force a switchover to the standby PRE module, use the redundancy switch-activity command in privileged
EXEC mode.

Note The terms failover and switchover are interchangeable, but switchover is the term used across all Cisco
platforms capable of high-availability operation.

redundancy switch-activity [force]

Syntax Description force (Optional) Forces a switchover immediately, overriding any checks in the code or configuration that
might prevent or delay a switchover.

Command Default None

Command Modes
Privileged EXEC

Command History Release Modification

12.2(4)XF1 This command was introduced for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The redundancy switch-activity command is similar to the redundancy force-failover main-cpu command,
except that it includes an option to force the switchover, overriding any configuration checks or other checks
in the software that could prevent the switchover. In all cases, this command verifies that the standby PRE
module is available and capable of performing the switchover before it transfers control to that PRE module.
This command also synchronizes the current running-config and client data before initiating the switchover.

Examples The following example shows a switchover being manually initiated, overriding any checks that
might prevent or delay the switchover:

Router# redundancy switch-activity force

Proceed with switchover to standby PRE? [confirm] y

Note Pressing enter or y confirms the action and begins the switchover. Pressing any other key cancels
the switchover and returns control to the current active PRE1 module.

Related Commands Command Description

associate Associates two line cards for Automatic Protection Switching (APS)
redundancy protection.

Cisco CMTS Cable Command Reference

1457
 Cable Commands: q through sg
redundancy switch-activity

Command Description

redundancy Enters redundancy configuration mode so that the synchronization

parameters can be configured.

redundancy reload Resets the standby PRE1 module or to reset both the active and standby
PRE1 modules.

redundancy force-failover Forces a switchover, so that the standby Performance Routing Engine
main-cpu (PRE1) module becomes the active PRE1 module.

Cisco CMTS Cable Command Reference

1458
 Cable Commands: q through sg
registered qos-profile

registered qos-profile

Note Effective with Cisco IOS Release 12.3(9a)BC, the registered qos-profile command is replaced by the
qos-profile registered command.

To specify the registered quality of service (QoS) profile that should be used for this enforce-rule, use the
registered qos-profile command in enforce-rule configuration mode. To remove the registered QoS profile
from the enforce-rule, use the no form of this command.

registered qos-profile profile-id

no registered qos-profile profile-id

Syntax Description profile-id Specifies the QoS profile to be monitored. This profile must be created on the Cisco CMTS router.
If you want to manage a cable modem that uses a modem-created QoS profile, you must first
create that exact QoS profile on the CMTS router before using this command. The range is 0 to
16383. The default of 0.

Command Default The default profile ID is 0.

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.2(15)BC1 This command was introduced.

12.3(9a)BC This command was replaced by the qos-profile registered command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You must specify a registered QoS profile for each enforce-rule. The Cisco CMTS router then uses the
registered profile ID to match subscribers’ service flows to the proper enforce-rules.
When you change the registered QoS profile for an active rule, the cable modems that had been using the
previous registered QoS profile are no longer managed by the Subscriber Traffic Management feature. Instead,
the rule begins managing those cable modems that use the new registered QoS profile.

Note The registered QoS profile must be created on the Cisco CMTS router before you can assign it to an
enforce-rule. If the rule does not exist, the system displays an error message. If you want to manage a CM
that is using a CM-created QoS profile, you must first create a QoS profile on the Cisco CMTS router that
matches the CM-created profile exactly. Then use the registered qos-profile command to assign that profile
to this enforce-rule.

Cisco CMTS Cable Command Reference

1459
 Cable Commands: q through sg
registered qos-profile

Examples The following example shows profile 50 being assigned as the registered QoS profile to an
enforce-rule:

Router# configure terminal

Router(config)# cable qos enforce-rule enforce-rule

Router(enforce-rule)# registered qos-profile 50

The following example shows the error message that is displayed when the specified QoS profile
does not exist on the CMTS:

Router# configure terminal

Router(config)# cable qos enforce-rule test

Router(enforce-rule)# registered qos-profile 99

The qos profile 99 doesn't exist or it's a cm created QoS profile

Related Commands Command Description

activate-rule at-byte-count Specifies the number of bytes that a subscriber can transmit during the
monitoring period on a Cisco CMTS router.

cable qos enforce-rule Creates an enforce-rule to enforce a particular QoS profile for subscriber
traffic management and enters enforce-rule configuration mode.

duration Specifies the time period and sample rate to be used for monitoring
subscribers.

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management on a

Cisco CMTS router.

penalty-period Specifies the time period that an enforced QoS profile should be in effect
for subscribers that violate their registered QoS profiles.

qos-profile enforced Specifies a QoS profile that should be enforced when users violate their
registered QoS profiles.

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1460
 Cable Commands: q through sg
remap pid vcg

remap pid vcg

To configure custom PID remapping, use the remap pid vcg command in video configuration mode. PID
remapping enables you to specify remap rules for all four types of processing types—data, pass-through,
remap, and remux sessions.

remap pid vcg vcg

Syntax Description vcg Specifies the virtual carrier group.

Command Default None.

Command Modes
Video configuration (config)

Command History Release Modification

IOS-XE 16.7.1 This command was introduced on the Cisco cBR Series Converged Broadband Router.

Examples The following example shows a PID remap rule for a table-based unicast session on input port number
1 with vei-ip 198.51.100.1
logical-edge-device led1 id 1
protocol table-based
virtual-edge-input-ip 198.51.100.1 input-port-number 1
vcg vcg1
active
table-based
vcg vcg1
rf-channel 20
session unicast input-port 1 start-udp-port 49152 processing-type passthru

The corresponding remap rule is shown below:

remap pid vcg vcg1
rf-channel 20
vei-ip 198.51.100.1 udp-port 49152
pid 100-200 101-201
pid 102-130 202-230
pid 131 240

Cisco CMTS Cable Command Reference

1461
 Cable Commands: q through sg
rep-period

rep-period
To configure the time between two ECM packets at the output, use the rep-period command in the DVB
scrambling ECMG overrule configuration mode. To void the ECM repetition period configuration, use the
no form of this command.

rep-period time
no rep-period

rep-period time Specifies the ECM repetition period in milliseconds.

Command Default None

Command Modes DVB scrambling ECMG overrule configuration mode (config-video-encrypt-dvb-ecmg-overrule)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines This command specifies the time between two ECM packets at the output in milliseconds. The valid range is
from 0 to 30000.

The following is an example of how to configure the ECM repetition period in milliseconds:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#overrule
Router(config-video-encrypt-dvb-ecmg-overrule)#rep-period 10000

Related Commands Command Description

overrule Enters DVB scrambling configuration mode.

ac-start-delay Specifies the time between start of first CP after a

change in AC and start of ECM broadcast.

ac-stop-delay Specifies the time between end of last CP preceding

a change in AC and end of ECM broadcast.

max-comp-time Specifies the maximum time needed by ECMG to

compute an ECM.

max-streams Specifies the maximum number of simultaneous open

streams supported by the ECMG on a channel.

Cisco CMTS Cable Command Reference

1462
Cable Commands: q through sg
rep-period

Command Description

min-cp-duration Specifies the minimum crypto period.

start-delay Specifies the delay between the start of CP and ECM

broadcast.

stop-delay Specifies the delay between the end of CP and ECM

broadcast.

trans-start-delay Specifies the transition start delay.

trans-stop-delay Specifies the transition stop delay.

Cisco CMTS Cable Command Reference

1463
 Cable Commands: q through sg
report-stream-error cc-error

report-stream-error cc-error
To enable Continuity Counter (CC) error reporting on the chassis level, use the report-stream-error cc-error
command in video configuration mode.

report-stream-error cc-error [[report-interval value ] threshold value

Syntax Description report-interval value Specifies the event report interval in minutes.

threshold value specifies the threshold value to report the event.

Command Default None

Command Modes Video configuration (config-video)

Command History Release Modification

IOS-XE Fuji This command is introduced on the Cisco cBR Series Converged Broadband Routers.
16.8.1

Examples This example shows how to enable CC error reporting on the chassis level:

Router#configure terminal
Router(config)#cable video
Router(config-video)# report-stream-error cc-error report-interval 10 threshold value 5

Cisco CMTS Cable Command Reference

1464
 Cable Commands: q through sg
report-stream-error input-stream-failure report-interval syslog

report-stream-error input-stream-failure report-interval syslog

To configure a timeout value and syslog message for input stream failure trap for multicast sources, use the
report-stream-error input-stream-failure report-interval syslog command in video configuration mode.

report-stream-error input-stream-failure report-interval timeout value syslog {enable | disable}

Syntax Description timeout value The interval after which input stream failure trap is sent if the input source down exceeds
the configured timeout value. The timeout value range is 5–1800 seconds.

syslog Enable or disable logging for for input stream stream failure trap.

Command Default None

Command Modes Video configuration (config-video)

Command History Release Modification

IOS-XE Fuji 16.8.1d This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Examples This example shows how to configure a timeout value and syslog message:

Router#configure terminal
Router(config)#cable video
Router(config-video)# report-stream-error input-stream-failure report-interval 10 syslog
enable

Related Commands Command Description

showcable video snmp-alarms Display the active alarms in the system.

show cable video snmp-alarm-config Display the alarm configuration in the system.

snmp-trap input-stream-failure multicast Disable input stream failure trap for EAS stream.

snmp-server enable traps video-cable Enable alarm event traps for cable related events.

Cisco CMTS Cable Command Reference

1465
 Cable Commands: q through sg
request platform hardware diagnostic load

request platform hardware diagnostic load

To load the field diagnostic image and start field diagnostic test, use the request platform hardware diagnostic
load slot slot-id image-path [autostart] command in Privileged EXEC mode.

request platform hardware diagnostic load slot slot-id image-path [autostart]

Syntax Description slot slot-id Specifies the slot to perform field diagnostic test.

image-path Specifies the path of the field diagnostic image, the image can be copied to hard disk, bootflash,
or USB disk.

autostart Automatically performs the default diagnostic test after loading the field diagnostic image.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.18.0S This command was introduced on Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The request platform hardware diagnostic load slot slot-id image-path [autostart] command loads the
field diagnostic image and starts field diagnostic test.

Examples The following example shows how to load the field diagnostic image and start field diagnostic test:

Router# request platform hardware diagnostic load slot 0 harddisk:field_diag autostart

Mar 2 16:00:51.933 CST: %IOSXE_OIR-6-REMCARD: Card (cc) removed from slot 0
Mar 2 16:00:51.934 CST: %CABLE_CLC-5-LOGGER_LC_REMOVED: Carrier Card 0 removed

Related Commands Command Description

request platform hardware diagnostic unload Removes the field diagnostic image from the line card.

show platform hardware diagnostic status Displays the field diagnostic tests status.

Cisco CMTS Cable Command Reference

1466
 Cable Commands: q through sg
request platform hardware diagnostic unload

request platform hardware diagnostic unload

To unload the field diagnostic image from the line card and reload the run-time image, use the request
platform hardware diagnostic unload slot slot-id command in Privileged EXEC mode.

request platform hardware diagnostic unload slot slot-id

Syntax Description slot Specifies the slot to unload the field diagnostic image.
slot-id

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.18.0S This command was introduced on Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The request platform hardware diagnostic unload slot slot-id command unloads the field diagnostic image
from the line card and reloads the run-time image.

Examples The following example shows how to unload the field diagnostic image:

Router# request platform hardware diagnostic unload slot 0

Mar 2 16:04:51.860 CST: %IOSXE_OIR-6-INSCARD: Card (cc) inserted in slot 0

Related Commands Command Description

request platform hardware diagnostic load Loads the field diagnostic image and starts field diagnostic
test.

show platform hardware diagnostic status Displays the field diagnostic tests status.

Cisco CMTS Cable Command Reference

1467
 Cable Commands: q through sg
request platform software package expand

request platform software package expand

To expand the package to bootflash, use the request platform software package expand command in
Privileged EXEC mode.

request platform software package expand file bootflash:[force | to bootflash:[force | wipe | [force]]
| wipe | [force]]

Syntax Description bootflash: Expand the package to bootflash. Cisco cBR-8 router only boot from bootflash.

force Proceed despite warnings.

wipe Wipe destination media content first.

to Location for contained files.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.16.0S This command was introduced on Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the request platform software package expand command in Privileged EXEC mode to expand the
package to bootflash.

Examples The following example shows hwo to expand the package to bootflash:

router# request platform software package expand file

bootflash:subpkg_3_16/cbrsup-universalk9.03.16.00.S.155-3.S-std.SPA.bin

Related Commands Command Description

request platform software package install Perform singe command ISSU install.

Cisco CMTS Cable Command Reference

1468
 Cable Commands: q through sg
request platform software package install node

request platform software package install node

To install the package for upgrade process, use the request platform software package install node command
in Privileged EXEC mode.

request platform software package install node {abort | attach | file bootflash:[linecard-delay
delay | [switchback] | noreload | [linecard]] | linecard-only {all | slot slot-number} | rollback}

Syntax Description abort Cancel the ISSU process.

attach Enables the users to view the last run log that contains the reports of all the stages of
the one-shot upgrade.

file Consolidated package file on active bootflash.

linecard-delay delay By default, all the line cards will be reloaded with 240s interval during the upgrade
procedure. Use linecard-delay delay option to specify the linecard reload interval.

switchback By default, the active SUP will change to standby SUP after the upgrade procedure
is complete. Use the switchback option to switchover the active and standby SUP
at the end of upgrade procedure, so that the active SUP remains to be the active SUP
after ISSU.

noreload With noreload option, both the SUP and linecard will not be reloaded during the
upgrade procedure. Upgrade will take effect by the next system reboot. With noreload
linecard option, only the linecard will not be reloaded during the upgrade procedure.

linecard-only Upgrade linecard only.

rollback Roll back the chassis to the previous image.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.16.0S This command was introduced on Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on Cisco cBR Series Converged Broadband Routers.
The abort, linecard-only and rollback keywords were added.

Usage Guidelines Use the request platform software package install node command in Privileged EXEC mode to install the
package for upgrade process, cancel the upgrade process, or rollback the chassis.

Examples The following example shows how to install the package file:

router# request platform software package install node file

bootflash:subpkg_3_16/cbrsup-universalk9.03.16.00.S.155-3.S-std.SPA.bin

Cisco CMTS Cable Command Reference

1469
 Cable Commands: q through sg
request platform software package install node

Related Commands Command Description

request platform software package expand Expand the package to bootflash.

Cisco CMTS Cable Command Reference

1470
 Cable Commands: q through sg
request platform software package install rp

request platform software package install rp

To rollback to old package or implement ISSU subpackages upgrade on single SUP, use the request platform
software package instal rp rp-slot rollback command in Privileged EXEC mode.

request platform software package install rp rp-slot {file bootflash:[interface-module-delay

delay-seconds] | rollback[as-booted]}

Syntax Description interface-module-delay delay-second Specify the interface module restart timeout delay.

rollback Un-do a previous install.

as-booted Return to software provisioned at boot.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.16.0S This command was introduced on Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the request platform software package instal rp rp-slot rollback command in Privileged EXEC mode
to rollback to old package.

Examples The following example shows how to rollback the upgrade:

router# request platform software package install rp 0 rollback

Related Commands Command Description

request platform software package install node Install the package for upgrade process.

Cisco CMTS Cable Command Reference

1471
 Cable Commands: q through sg
request platform software process restart

request platform software process restart

To restart processes in software platform, use the request platform software process restart command in
Privileged EXEC mode.

request platform software process restart [ interval secs |slot slot-number ]

Syntax Description interval secs The interval between line card reload in seconds. Valid range is from 0 to 500.

slot slot-number The line card slot number. The valid range is from 0 to 9.

Command Default This command takes effect if the new iosd and iosdb, and the us-scheduler sub-packages have been previously
installed on the Supervisor. Only line cards which are both active and primary will be affected.

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.16.OS

Usage Guidelines Use the request platform software process restart command only after installing new iosd, iosdb, and
us-scheduler sub-packages on the Supervisor. This command will install the new sub-packages on the line
cards and restarts the affected processes.

Examples This example shows how to restart an isod process with an interval of 10 seconds:
Router# request platform software process restart interval 10
Restarting the process ubrclc_k9lc_ms
SUCCESS: Finished Restarting the process ubrclc_k9lc_ms
Will automatically restart process iosdb

This example shows how to restart a us-scheduler process:

Router#request platform software process restart slot 6

Restarting the process us-scheduler on slot 6
SUCCESS: Finished Restarting the process us-scheduler on slot 6

Router#
*Jan 23 16:51:36.160 PDT: %CMCC_CBR-4-PROC_DOWN: CLC6: cmcc: Process us-sched (cdman) is
down
*Jan 23 16:51:36.506 PDT: %CMCC_CBR-4-PROC_RESTART: CLC6: cmcc: Process us-sched (cdman)
restarted. Please redo any config changes
made during process restart
*Jan 23 16:51:39.737 PDT: lcpr_enqueue_reco_event: lc_slot=6 peer=6
*Jan 23 16:51:39.881 PDT: %CBR-4-RECONCL_CM_FINISH: Reconciliation (clc->sup) for slot 6
finished: total 31, success 31, failed 0,
clc-only 0, sup-only 0, mismatch 0, offline 0

Cisco CMTS Cable Command Reference

1472
 Cable Commands: q through sg
request platform software process restart

Related Commands Command Description

request platform software package install Upgrades a consolidated package or an individual sub-package.

Cisco CMTS Cable Command Reference

1473
 Cable Commands: q through sg
reserve-pid-range

reserve-pid-range
To configure reserved output PID range, use the reserve-pid-range command in video configuration mode.
To delete the reserved output PID range, use the no form of this command.

reserve-pid-range start-pid-end-pid
no reserve-pid-range start-pid-end-pid

Syntax Description reserve-pid-range start-pid-end-pid Specifies a range of PIDs that will not be used as output for remapped
sessions.

Command Default None.

Command Modes
Video configuration (config-video)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command configures reserved output PID range.

Examples The following example shows how to configure reserved output PID range:

Router# configure terminal

Router(config)# cable video
Router(config-video)# reserve-pid-range 1-10

Related Commands Command Description

show cable video logical-edge-device Displays the logical edge device information.

Cisco CMTS Cable Command Reference

1474
 Cable Commands: q through sg
reset-interval

reset-interval
To set the default ONID number, use the default-onid command in the video configuration mode.

default-onid number

Syntax Description number The ONID number. By default, the system ONID is 0, which is commonly used in North America.
If the default value of the ONID is used, the TSID must be unique. If you change the ONID, the
TSID-ONID pair must be unique. The ONID must be in the range of 0 to 65535.

Command Default None.

Command Modes Video configuration mode (config-video)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to change the deault system ONID.

The following example shows how to change the default ONID number:
configure terminal
cable video
default-onid 1580

Cisco CMTS Cable Command Reference

1475
 Cable Commands: q through sg
restart-retry

restart-retry
To set the retry times for cable line card process restart, use the restart-retry times command in the process
restart configuration mode.

restart-retry times

Syntax Description times Cable line card process restart retry times.

Command Default None

Command Modes
Process restart configuration (config-process-restart)

Command History Release Modification

IOS-XE 3.18.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command sets the retry times for cable line card process restart.
The following example shows how to set the retry times for cable line card process restart.

Router# configure terminal

Router(config)# process-restart
Router(config-process-restart)# restart-retry 3

Related Commands Command Description

lc-control-plane-timeout Sets the interval of monitoring cable line card control plane process restart.

lc-us-scheduler-timeout Sets the interval of monitoring cable line card upstream scheduler process restart.

Cisco CMTS Cable Command Reference

1476
 Cable Commands: q through sg
restricted

restricted
To convert a general load balancing group (GLBG) to a restricted load balancing group (RLBG) for DOCSIS
load balancing, use the restricted command in the config-lb-group configuration mode. To revert to the
general group type for DOCSIS load balancing, use the no form of this command.

restricted
no restricted

Command Default By default, the general group type is selected for load balancing.

Command Modes
DOCSIS load balancing group mode (config-lb-group)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to convert a GLBG to a RLBG using the restricted command.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# restricted
Router(config-lb-group)#

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1477
 Cable Commands: q through sg
revertive

revertive
To enable the revert operation on a protect card, use the revertive command in line card redundancy group
mode. To disable the revert operation, use the no form of the command.

revertive time
no revertive time

Syntax Description time Specifies the revert operation time in seconds. The valid values are 1 to 35791.
The valid values on the Cisco cBR series routers are 10 to 86400 seconds.

Command Default None

Command Modes
Line card redundancy group (config-red-lc)

Command History Release Modification

12.2(33)SCA This command was introduced in Cisco IOS Release 12.2(33)SCA.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to specify the revert operation time for a protect card on a
uBR10012 router:

Router# configure terminal

Router(config)# redundancy
Router(config-red)# linecard-group 1 cable
Router(config-red-lc)# revertive 30

The following example shows how to specify the revert operation time on a Cisco cBR series router:

Router# configure terminal

Router(config)# redundancy
Router(config-red)# linecard-group 0 internal-switch
Router(config-red-lc)# revertive 30

Related Commands Command Description

linecard-group Creates a line card group for one-to-one line card redundancy.

redundancy Enters redundancy mode.

member Enables the redundancy role of a line card.

subslot

Cisco CMTS Cable Command Reference

1478
 Cable Commands: q through sg
rf-chan

rf-chan
To enter the RF channel sub configuration mode to configure an individual channel or a block of channels,
use the rf-chan command in the controller sub configuration mode.

rf-chan starting QAM id ending QAM id

Syntax Description starting QAM id The starting QAM ID. The valid range is 0 to 127.

ending QAM id The ending QAM ID. The valid range is 0 to 127.

Command Default None.

Command Modes Controller sub configuration mode (config-controller)

Command History Release Modification

IOS-XE 3.15.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is used to enter the RF channel configuration sub-mode. If an individual channel is specified,
only that channel's configuration is changed. If a block of channels is specified, the configuration change is
applied to all the channels in the block.

The following example shows how to enter into the RF channel configuration sub-mode:
router#configure terminal
router(config)#controller integrated-cable 3/0/0
router(config-controller)#rf-chan 0 2
router(config-rf-chan)#frequency 93000000
router(config-rf-chan)#exit
router(config-controller)#exit
router#show controller integrated-Cable 3/0/0 rf-channel 0-2

Chan State Admin Frequency Type Annex Mod srate Interleaver dcid power output
0 UP UP 93000000 DOCSIS B 256 5361 I32-J4 1 34 NORMAL
1 UP UP 99000000 DOCSIS B 256 5361 I32-J4 2 34 NORMAL
2 UP UP 105000000 DOCSIS B 256 5361 I32-J4 3 34 NORMAL

Related Commands Command Description

controller integrated-cable Enters the controller configuration mode.

frequency Defines the RF channel frequency.

qam-profile Defines the QAM profile number.

rf-output Defines the QAM output mode.

type Defines the QAM data type.

power-adjust Defines the channel power level.

Cisco CMTS Cable Command Reference

1479
 Cable Commands: q through sg
rf-channel

rf-channel
To enter the RF channel sub configuration mode to configure an individual channel, use the rf-channel
command in the controller sub configuration mode.

rf-channel number

number Identifies an RF channel and enters the RF channel

sub configuration mode. The valid values are

Command Default None

Command Modes Controller sub configuration mode (config-controller)

Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to enter the RF channel sub configuration mode:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#table-based
Router(config-video-tb)#vcg vcg1
Router(config-video-tb-vcg)#rf-channel 20

Related Commands Command Description

cable video Enters cable video configuration mode.

table-based Enables table-based session configuration.

vcg name Specifies the virtual carrier group assigned to a logical

edge device.

Cisco CMTS Cable Command Reference

1480
 Cable Commands: q through sg
rf-channel (Virtual Carrier Group)

rf-channel (Virtual Carrier Group)

To specify the virtual RF channels in a virtual carrier group, use the rf-channel command in virtual carrier
group configuration mode. To delete the virtual RF channels, use the no form of this command.

rf-channel start-channel-end-channel tsid start-tsid-end-tsid output-port-number start-port-end-port

no rf-channel start-channel-end-channel tsid start-tsid-end-tsid output-port-number
start-port-end-port

Syntax Description rf-channel start-channel-end-channel Specifies the RF channel range.

tsid start-tsid-end-tsid Specifies the tsid range.

output-port-number start-port-end-port Specifies the output port range.

Command Default None.

Command Modes
Virtual carrier group configuration (config-video-vcg)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command specifies the virtual RF channels.

Examples The following example shows how to specify the virtual RF channels:

Router# configure terminal

Router(config)# cable video
Router(config-video)# virtual-carrier-group vod id 1
Router(config-video-vcg)# rf-channel 1-11 tsid 1-11 output-port-number 1-11

Related Commands Command Description

virtual-carrier-group Defines a virtual carrier group.

virtual-edge-input-ip Specifies and configures a cable multicast QoS group.

encrypt Encrypts the virtual carrier group.

service-type Specifies the service type of the virtual carrier group.

show cable video virtual-carrier-group Displays the virtual carrier group information.

Cisco CMTS Cable Command Reference

1481
 Cable Commands: q through sg
rf-channel (table-based vcg)

rf-channel (table-based vcg)

To configure the rf channel in the table-based session, use the rf-channel command in the table-based VCG
configuration mode. To delete the configuration, use the no form of this command.

rf-channel start_channel[-end_channel]

start_channel-end_channel Specifies the range of rf channels for the table-based

session.

Command Default None

Command Modes Table-based VCG configuration mode (config-video-tb-vcg)

Release Modification

Cisco IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
16.5.1

The following is an example of how to configure the rf channel in the table-based session:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#table-based
Router(config-video-tb)#vcg vcg1
Router(config-video-tb-vcg)#rf-channel 0-7

Related Commands Command Description

vcg (table-based) Specifies the virtual carrier group associated with the
table-based session.

Cisco CMTS Cable Command Reference

1482
 Cable Commands: q through sg
rf-channel cable downstream channel-id

rf-channel cable downstream channel-id

To assign a downstream channel ID to an RF channel, use the rf-channel cable downstream channel-id
command in controller configuration mode. To remove a downstream channel ID for an RF channel, use the
no form of this command.

rf-channel rf-port cable downstream channel-id channel-id

no rf-channel rf-port cable downstream channel-id channel-id

Syntax Description rf-port Specifies the RF channel physical port on the Wideband SPA FPGA. Valid values for rf-port
depend on the configuration set with the annex modulation command.

channel-id A unique channel ID. Valid values for releases prior to Cisco IOS Release 12.2(33)SCB are
from 0 to 255 and the valid values for Cisco IOS Release 12.2(33)SCB and later are from 1 to
255 as 0 is reserved for network management.

Command Default If the rf-channel cable downstream channel-id command is not issued, Cisco IOS software assigns a unique
downstream channel ID to the RF channel.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

12.2(33)SCB1 The downstream channel ID scheme was changed.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines For the wideband channel to work correctly, each RF channel on the fiber node that the wideband channel
uses must have a unique downstream channel ID. By default, Cisco IOS software assigns a unique downstream
channel ID to the RF channel. Use the rf-channel cable downstream channel-id command to change the
default channel ID.
The downstream channel ID that is assigned to the RF channel must be unique on the fiber node.
• The ID cannot be the same ID as is used for another RF channel on the fiber node.
• The ID cannot be the same ID as is used for a primary downstream channel on the fiber node.
You can check downstream channel IDs that are being used by examining the CMTS router configuration
file.
Refer to cable downstream channel-id id command for the updated downstream channel ID scheme table.

Cisco CMTS Cable Command Reference

1483
 Cable Commands: q through sg
rf-channel cable downstream channel-id

Note If you assign a downstream channel ID that is not unique on the fiber node, the rf-channel cable downstream
channel-id command displays an error message. The command does assign the channel ID, but the status of
the fiber node becomes invalid.

The Cisco uBR10012 router supports two Wideband SPAs. Each Wideband SPA supports up to 24 RF channels
depending on how the SPA is configured with the annex modulation command.
• For annex A and 256 QAM, each Wideband SPA supports 18 RF channels. In this case, valid values for
the rf-port argument are 0 to 17.
• For all other cases, the SPA supports 24 RF channels. In these cases, valid values for the rf-port argument
are 0 to 23.

Note Effective with Cisco IOS Release 12.3(23)BC, the annex modulation command is obsolete and annex and
modulation are included as keyword options in the rf-channel frequency command. Also, for annex A and
256 QAM, each Wideband SPA supports up to 18 RF channels at full rate or up to 24 RF channels at less
than full rate.

Examples The following example shows how to assign a downstream channel ID of 123 to RF channel 3 on
the Wideband SPA located in slot/subslot/bay 1/0/1.

Router# configure terminal

Router(config)# controller modular-cable 1/0/1

Router(config-controller)# rf-channel 3 cable downstream channel-id 123

Related Commands Command Description

annex modulation Sets the annex and modulation for the Wideband SPA.

cable primary Specifies that a wideband channel is a primary wideband channel.

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband

channel.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

ip-address (controller) Sets the IP address of the Wideband SPA FPGA.

modular-host subslot Specifies the modular-host line card.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address and UDP port for each RF
udp-port channel.

rf-channel network delay Specifies the CIN delay for each RF channel.

Cisco CMTS Cable Command Reference

1484
Cable Commands: q through sg
rf-channel cable downstream channel-id

Command Description

rf-channel description Specifies the description for each RF channel.

Cisco CMTS Cable Command Reference

1485
 Cable Commands: q through sg
rf-channel depi-tunnel

rf-channel depi-tunnel
To bind the depi-tunnel, which inherits the configuration of the specified l2tp-class and depi-class, to an
rf-channel on a shared port adapter (SPA), use the rf-channel depi-tunnel command in controller configuration
mode. The tsid keyword is used to associate the logical rf-channel of the SPA to a physical quadrature
amplitude modulation (QAM) on the radio frequency gateway (RFGW-10). To unbind the depi-tunnel, use
the no form of this command.

rf-channel rf-channel depi-tunnel depi-tunnel-name tsid id

no rf-channel rf-channel depi-tunnel depi-tunnel-name tsid id

Syntax Description rf-channel RF channel physical port on the Wideband SPA. The allowed range is from 0 to 3.

depi-tunnel-name Name of the DEPI tunnel.

tsid id TS ID value.

Command Default None

Command Modes
Global configuration (config)

Subinterface configuration (config-subif)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines To configure DEPI on the M-CMTS, bind the depi-tunnel to an rf-channel on a SPA using the rf-channel
depi-tunnel command in controller configuration mode. To associate the logical rf-channel on the SPA to a
QAM on the RFGW, use the tsid keyword.

Examples The following example shows how to bind the depi-tunnel SPA0 to rf-channel 0 on a SPA and
associate tsid 100 to the QAM:

Router# configure terminal

Router(config)# controller modular-cable 1/0/0
Router(config-controller)# rf-channel 0 depi-tunnel SPA0 tsid 100

Related Commands Command Description

controller modular-cable Specifies the slot, bay, and port to be configured.

show interface modular-cable Displays the DEPI information for the modular cable.

Cisco CMTS Cable Command Reference

1486
 Cable Commands: q through sg
rf-channel description

rf-channel description
To configure the description of an RF channel on a Wideband SPA, use the rf-channel description command
in controller configuration mode. To remove an RF channel configuration, use the no form of this command.

rf-channel rf-port description description

no rf-channel rf-port description description

Syntax Description rf-port Specifies the RF channel physical port on the Wideband SPA FPGA. Allowed
range is 0 to 23. Valid values for rf-port depend on the configuration set with the
annex modulation command (see the Usage Guidelines section).

description description Specifies a description for the RF channel.

Command Default No default RF channel configuration values are set for the description.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The Cisco uBR10012 router supports two Wideband SPAs. Each Wideband SPA supports up to 24 RF channels
depending on how the SPA is configured with the annex modulation command. For annex A and 256 QAM,
each Wideband SPA supports up to 18 RF channels at full rate and up to 24 RF channels at less than full rate.
For all other cases, the SPA supports 24 RF channels.

Note In Cisco IOS Release 12.3(21)BC, annex and modulation parameters were set globally for each SPA using
the annex modulation command. Beginning in Cisco IOS Release 12.3(23)BC, annex and modulation values
are set for each RF channel using the rf-channel frequency command. The annex modulation command is
obsolete.

Examples The following example shows how to configure the description of the RF channel characteristics for
RF port 0:

Router# configure terminal

Router(config)# controller modular-cable 1/0/0

Router(config-controller)# rf-channel 0 description Primary downstream channel

Cisco CMTS Cable Command Reference

1487
 Cable Commands: q through sg
rf-channel description

Related Commands Command Description

cable primary Specifies that a wideband channel is a primary wideband

channel.

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband

channel.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

ip-address (controller) Sets the IP address of the Wideband SPA FPGA.

modular-host subslot Specifies the modular-host line card for Wideband protocol
operations.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address and UDP port for each RF
udp-port channel.

rf-channel network delay Configures the network delay for an RF channel.

Cisco CMTS Cable Command Reference

1488
 Cable Commands: q through sg
rf-channel frequency

rf-channel frequency
To configure the frequency of an RF channel on a wideband interface, use the rf-channel frequency command
in controller configuration mode. To remove the frequency of an RF channel configuration, use the no form
of this command.
Cisco IOS Releases 12.3(21)BC and 12.2(33)SCA

rf-channel rf-port frequency freq

no rf-channel rf-port frequency
Cisco IOS Releases 12.3(23)BC and 12.2(33)SCB

rf-channel rf-port frequency freq [annex {A | B} modulation {64 | 256} [interleave-depth {8 |

12 | 16 | 32 | 64 | 128}]]
no rf-channel rf-port frequency

Syntax Description rf-port Specifies the RF channel physical port on the Wideband
SPA FPGA. Allowed range is 0 to 23. Valid values for
rf-port depend on the configuration set with the annex
modulation command (see the Usage Guidelines
section).

freq Sets the center frequency for the RF channel. Allowed

range is 55000000 to 1050000000 MHz.

annex {A|B} Specifies the MPEG framing format for each RF

channel:
• A–Annex A. The downstream is compatible with
the European MPEG framing format specified in
ITU-TJ.83 Annex A.
• B–Annex B. The downstream is compatible with
the North American MPEG framing format
specified in ITU-TJ.83 Annex B.

modulation {64|256} Specifies the modulation rate for each RF channel:

• 64–64-QAM
• 256–256-QAM

interleave-depth{8 | 12 | 16 | 32 | 64| 128} Indicates the downstream interleave depth. The default
value is 32.

Command Default No default RF channel configuration values are set for frequency, annex, and modulation.

Command Modes
Controller configuration (config-controller)

Cisco CMTS Cable Command Reference

1489
 Cable Commands: q through sg
rf-channel frequency

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.3(23)BC The following keyword options were added:

• annex
• modulation
• interleave-depth

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. The annex,
modulation, and interleave-depth keyword options are not supported.

12.2(33)SCB The annex, modulation, and interleave-depth keyword options are supported.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Cisco IOS Release 12.3(21)BC and Cisco IOS Release 12.2(33)SCA
This command configures the frequency for an RF channel on a Wideband SPA.
The Cisco uBR10012 router supports two Wideband SPAs. Each Wideband SPA supports up to 24 RF channels
depending on how the SPA is configured with the annex modulation command. For annex A and 256 QAM,
each Wideband SPA supports up to 18 RF channels. For all other cases, the SPA supports up to 24 RF channels.

Note In Cisco IOS 12.3(21)BC and 12.3(21a)BC3 releases, annex and modulation parameters were set globally
for each SPA using the annex modulation command. Beginning in Cisco IOS Release 12.3(23)BC, annex
and modulation values are set for each RF channel using the rf-channel frequency command. The annex
modulation command is obsolete.

Cisco IOS Releases 12.3(23)BC and 12.2(33)SCB

This command configures the frequency for an RF channel on a Wideband SPA. The Cisco uBR10012 router
supports two Wideband SPAs. Each Wideband SPA supports up to 24 RF channels. For annex A and 256
QAM, each Wideband SPA supports up to 18 RF channels at full rate. For all other cases, the SPA supports
up to 24 RF channels.
For each RF channel, use the rf-channel frequency command in controller configuration mode to configure
RF-channel characteristics. For Cisco IOS Release 12.3(21)BC, for each RF channel (rf-port), the frequency
option must be configured with the rf-channel frequency command.
Uniqueness of frequency is required for all cable downstream channels on all cable interfaces and all Wideband
SPAs on the CMTS.

Note Be certain to verify that the RF channel values set with rf-channel frequency match the values configured
for the QAM outputs on the edge QAM device.The frequency value must match. If the value does not match,
the Wideband SPA will not successfully communicate with the edge QAM device.

Cisco IOS Release 12.2(33)SCE

Cisco CMTS Cable Command Reference

1490
 Cable Commands: q through sg
rf-channel frequency

In Cisco IOS Release 12.2(33)SCE and later, changing the frequency of a single RF channel in a controller
will change the frequency of all RF channels in that controller. In the event of the frequency change, all
DOCSIS 3.0 cable modems will start re-registering in downstream partial service mode (p-online).

Examples The following example shows how to configure RF channel frequency for RF port 0:

Router# configure terminal

Router(config)# controller modular-cable 1/0/0

Router(config-controller)# rf-channel 0 frequency 699000000 annex A modulation 256
interleave-depth 64

Related Commands Command Description

cable primary Specifies that a wideband channel is a primary wideband

channel.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

rf-channel description Specifies the description for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address and UDP port for each RF
udp-port channel.

rf-channel network-delay Configure the network delay for an RF channel.

Cisco CMTS Cable Command Reference

1491
 Cable Commands: q through sg
rf-channel group-address

rf-channel group-address
To configure the DEPI multicast group address for the RF channel, use the rf-channel group-address
command in controller configuration mode. To disable the configuration, use the no form of the command.

rf-channel rf-number group-address ip-address

no rf-channel rf-number group-address

Syntax Description rf-number RF channel number. The range is from 0 to 23.

ip-address DEPI multicast group IP address.

Command Default The DEPI multicast group address is not configured for the RF channel.

Command Modes Controller configuration (config-controller)

Command History Release Modification

12.2(33)CX This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The rf-channel group-address command provides upstream and downstream mapping information for a
specific channel group.

The following example shows how to configure the DEPI multicast group address for RF channel
0:
Router# configure terminal
Router# controller Modular-Cable 8/1/0
Router(config-controller)# rf-channel 0 group-address 224.0.0.1

Related Commands Command Description

controller modular-cable Configures the DEPI controller.

Cisco CMTS Cable Command Reference

1492
 Cable Commands: q through sg
rf-channel ip-address mac-address udp-port

rf-channel ip-address mac-address udp-port

To configure the IP address, MAC address, UDP port and DEPI remote ID of an RF channel on a Wideband
SPA, use the rf-channel ip-address mac-address udp-port command in controller configuration mode. To
remove the IP address, MAC address, UDP port and DEPI remote ID configuration of an RF channel, use the
no form of this command.
Cisco IOS Releases 12.3(21)BC and 12.2(33)SCA

rf-channel rf-port ip-address ip-address mac-address mac-address udp-port portnum

no rf-channel rf-port ip-address ip-address mac-address mac-address udp-port portnum
Cisco IOS Releases 12.3(23)BC and 12.2(33)SCB

rf-channel rf-port ip-address ip-address mac-address mac-address {udp-port portnum |

depi-remote-id session-id}
no rf-channel rf-port ip-address ip-address mac-address mac-address {udp-port portnum |
depi-remote-id session-id}

Syntax Description rf-port Specifies the RF channel physical port on the Wideband SPA FPGA. Allowed range is 0 to
23. Valid values for rf-port depend on the configuration set with the annex modulation
command (see the Usage Guidelines section).

ip-address Specifies the IP address of the Gigabit Ethernet interface on the edge QAM device for this RF
channel.

mac-address Specifies the MAC address of the next-hop interface or of the edge QAM device for this RF
channel.

portnum Specifies the UDP port number for the edge QAM device that will be used for this RF channel.
Allowed range is 0 to 65535.

session-id Specifies the DEPI remote session ID to be used for encapsulation of frames in DOCSIS-MPT
mode.

Command Default None

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router.

12.3(23)BC The depi-remote-id keyword option was added.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. The depi-remote-id
keyword option is not supported.

12.2(33)SCB The depi-remote-id keyword option is supported.

Cisco CMTS Cable Command Reference

1493
 Cable Commands: q through sg
rf-channel ip-address mac-address udp-port

Release Modification

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines For each RF channel, use the rf-channel ip-address mac-address udp-port command in controller
configuration mode to configure RF-channel characteristics.
The Cisco uBR10012 router supports two Wideband SPAs. Each Wideband SPA supports up to 24 RF channels
depending on how the SPA is configured with the annex modulation command. For annex A and 256 QAM,
each Wideband SPA supports up to18 RF channels. For all other cases, the SPA supports up to 24 RF channels.

Note In the Cisco IOS Release 12.3(21)BC and 12.3(21a)BC3 releases, annex and modulation options were set
globally for each SPA using the annex modulation command. Beginning in Cisco IOS Release 12.3(23)BC,
annex and modulation values are set for each RF channel using the rf-channel frequency command. The
annex modulation command is obsolete.

For each RF channel (rf-port), the following items must be configured with rf-channel ip-address mac-address
udp-port command:
Cisco IOS Release 12.3(21)BC and Cisco IOS Release 12.2(33)SCA
• IP address
• MAC address
• UDP port
• Associated wideband channel (see the cable rf-channel command)
Cisco IOS Releases 12.3(23)BC and 12.2(33)SCB
• IP address
• MAC address
• UDP port or DEPI remote ID
• Associated wideband channel (see the cable rf-channel command)
The value used for mac-address in the mac-address argument is as follows:
• If a Gigabit Ethernet router or Layer 3 switch is used between the Wideband SPA and the edge QAM
device, the value specified for mac-address is the MAC address for the next-hop interface on the router
or Layer 3 switch.
• If a Gigabit Ethernet router or Layer 3 switch is not used, the value specified for mac-address is the MAC
address for the Gigabit Ethernet interface on the edge QAM device.
The UDP port number set for the RF channel allows mapping an input UDP session to a specific QAM output
port. Wideband traffic from different Wideband SPAs cannot be mixed on the same QAM output ports.

Note Be certain to verify that the RF channel values set with rf-channel frequency match the values configured
for the QAM outputs on the edge QAM device. IP address, MAC address, UDP port, and DEPI remote ID
must match. If any of these values do not match, the Wideband SPA will not successfully communicate with
the edge QAM device.

Cisco CMTS Cable Command Reference

1494
 Cable Commands: q through sg
rf-channel ip-address mac-address udp-port

Examples The following example shows how to configure the RF channel IP address, MAC address UDP port
and DEPI remote ID characteristics for RF port 0:

Router# configure terminal

Router(config)# controller modular-cable 1/0/0

Router(config-controller)# rf-channel 0 ip-address 192.168.200.30 mac-address
0011-920e-a9ff udp-port 49152

Related Commands Command Description

cable primary Specifies that a wideband channel is a primary wideband channel.

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband

channel.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

ip-address (controller) Sets the IP address of the Wideband SPA FPGA.

modular-host sub-slot Specifies the modular-host line card for Wideband protocol
operations.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

rf-channel description Specifies the description for each RF channel.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel network delay Configures the network delay for an RF channel.

Cisco CMTS Cable Command Reference

1495
 Cable Commands: q through sg
rf-channel network-delay

rf-channel network-delay
To configure the network delay for an RF channel on a Wideband SPA, use the rf-channel network delay
command in controller configuration mode. To remove the network delay configuration for an RF channel,
use the no form of this command.

rf-channel rf-port network-delay delay [sampling-rate rate]

no rf-channel rf-port network-delay delay [sampling-rate rate]

Syntax Description rf-port RF channel physical port on the Wideband SPA FPGA. The allowed range is from 0 to
23. The valid values for rf-port depend on the configuration set with the annex
modulation command (see the Usage Guidelines section).

delay Converged Interconnect Network (CIN) delay. The default value is 550 us. The allowed
range is from 0 to 3000 us. The delay value auto determines the delay through DEPI
Latency Measurement (DLM) packets.

sampling-rate rate (Optional) Specifies how often the DLM is sent. The range is from 1 to 500 sec. The
default value is 10 sec. This option is available only when the delay value is set to auto.

Command Default None

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 universal broadband router.

12.2(33)SCB This command was integrated into Cisco IOS Release 12.2(33)SCB.

12.2(33)SCC This command was modified to include sampling-rate rate to specify how often the DLM
is sent.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The Cisco uBR10012 universal broadband router supports two Wideband SPAs. Each Wideband SPA supports
up to 24 RF channels depending on how the SPA is configured with the annex modulation command. For
annex A and 256 QAM, each Wideband SPA supports up to18 RF channels. For all other cases, the SPA
supports up to 24 RF channels.

Note In Cisco IOS releases 12.3(21) BC and 12.3(21a)BC3, annex and modulation parameters were set globally
for each SPA using the annex modulation command. From Cisco IOS Release 12.3(23)BC onwards, annex
and modulation values are set for each RF channel using the rf-channel frequency command. The annex
modulation command is obsolete.

Cisco CMTS Cable Command Reference

1496
 Cable Commands: q through sg
rf-channel network-delay

Examples The following example shows how to configure the RF channel network delay characteristics for
RF port 0:

Router# configure terminal

Router(config)# controller modular-cable 1/0/0

Router(config-controller)# rf-channel 0 network-delay 1000

The following example shows how to configure the RF channel network delay characteristics for
RF port 0 with a sampling-rate of 1sec:

Router# configure terminal

Router(config)# controller modular-cable 1/0/0

Router(config-controller)# rf-channel 0 network-delay auto sampling-rate 1

Related Commands Command Description

cable primary Specifies that a wideband channel is a primary wideband channel.

cable rf-channel Associates an RF channel on a Wideband SPA with a wideband

channel.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

ip-address (controller) Sets the IP address of the Wideband SPA FPGA.

modular-host subslot Specifies the modular-host line card for Wideband protocol
operations.

rf-channel cable downstream channel-id Assigns a downstream channel ID to an RF channel.

rf-channel description Specifies the description for each RF channel.

rf-channel frequency Sets the frequency for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address, and UDP port for each RF
udp-port channel.

Cisco CMTS Cable Command Reference

1497
 Cable Commands: q through sg
rf-channel rf-power

rf-channel rf-power
To set the RF power output level on Cisco UBR-MC20X20V and Cisco uBR-MC88V cable interface line
cards, use the rf-channel rf-power command in controller configuration mode. To reset the RF output power
level to its default value, use the no form of this command.

rf-channel rf-port rf-power power-level

no rf-channel rf-port rf-power power-level

Syntax Description rf-port RF channel physical port on the Wideband SPA FPGA. The range is from 0 to 3. The values
for rf-port depend on the configuration set with the annex modulation command.

power-level Desired RF output power level in dBmV. The range is dependent on the cable interface line
card. The format is XY.Z. By default, .Z is added as .0.

Command Default None

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.2(33)SCC This command was introduced.

12.2(33)SCD This command was modified. Added support for the controller interface configuration on
Cisco uBR7246VXR and Cisco uBR7225VXR universal broadband routers.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines For the Cisco UBR-MC20X20V cable interface line card, all the channels within a controller must have the
same RF power value. When the RF power value is changed on any one channel, the same value is applied
to all the channels within the controller. The recommended RF power range depends on the mode of the
upconverter. The mode of the upconverter is decided by the highest numbered channel that is enabled.

Note RF power value outside the recommended RF power range is accepted but is automatically adjusted. If the
input value exceeds the recommended RF power range, it is adjusted to a value lower than the upper limit of
the range and if it is less than the recommended range, it is adjusted to a value higher than the lower limit of
the range. The RF power level can be configured in decimals too.

Table below lists the recommended RF power range for different channel settings on the Cisco
UBR-MC20X20V line card.

Table 35: RF Power Range on the Cisco UBR-MC20X20V Line Card

Upconverter Mode Channel Setting Recommended RF Power Range

Single Only channel 0 is enabled 60.0 to 52.0 dBmV

Cisco CMTS Cable Command Reference

1498
 Cable Commands: q through sg
rf-channel rf-power

Upconverter Mode Channel Setting Recommended RF Power Range

Dual Channel 0 is either enabled or disabled. Channel 1 is 56.0 to 48.0 dBmV

enabled.
Channel 2 and channel 3 are disabled.

Triple Channel 0, and channel 1 are either enabled or 54.0 to 46.0 dBmV
disabled.
Channel 2 is enabled and channel 3 is disabled.

Quad Channels 0, 1, and 2 are either enabled or disabled. 52.0 to 44.0 dBmV
Channel 3 is enabled.

Table below lists the recommended RF power range for different channel settings on the Cisco uBR-MC88V
line card.

Table 36: RF Power Range on the Cisco uBR-MC88V Line Card

Upconverter Mode Channel Setting Recommended RF Power

Range

Single The RF channel stacking number equals to 1 in this mode. 45 to 63 dBmV

Channel 0 is enabled while the other channels are disabled.

Dual The RF channel stacking number equals to 2 in this mode. 48 to 56 dBmV

Channels 0 and 1 are enabled; channels 2 and 3 are disabled.

Triple The RF channel stacking number equals to 3 in this mode. 46 to 54 dBmV

Channels 0, 1, and 2 are enabled; channel 3 is disabled.

Quad The RF channel stacking number equals to 4. Channels 0, 44 to 52 dBmV

1, 2, and 3 are enabled.

Examples The following example shows how to configure RF power for RF port 0 in modular-cable controller
mode:

Router# configure terminal

Router(config)# controller modular-cable 1/0/0

Router(config-controller)# rf-channel 0 rf-power 50.6

The following example shows how to configure RF power for RF port 0 in integrated-cable controller
mode:

Router# configure terminal

Router(config)# controller integrated-cable 1/0/0

Router(config-controller)# rf-channel 0 rf-power 50.6

Cisco CMTS Cable Command Reference

1499
 Cable Commands: q through sg
rf-channel rf-power

Related Commands Command Description

cable primary Specifies that a wideband channel is a primary wideband

channel.

controller modular-cable Enters controller configuration mode to configure the Wideband

SPA controller.

controller integrated-cable Enters integrated-cable controller configuration mode.

rf-channel description Specifies the description for each RF channel.

rf-channel ip-address mac-address Sets the IP address, MAC address and UDP port for each RF
udp-port channel.

rf-channel frequency Configures the frequency for the RF channel.

rf-channel network-delay Configure the network delay for an RF channel.

rf-channel rf-shutdown Enables or disables RF output on a Wideband SPA.

Cisco CMTS Cable Command Reference

1500
 Cable Commands: q through sg
rf-channel rf-shutdown

rf-channel rf-shutdown
To disable the RF output on a wideband interface, use the rf-channel rf-shutdown command in controller
configuration mode. To enable the RF output, use the no form of this command.

rf-channel rf-port rf-shutdown

no rf-channel rf-port rf-shutdown

Syntax Description rf-port Specifies the RF channel physical port. The range is from 0 to 3. The valid values for rf-port depend
on the configuration set with the annex modulation command.

Command Default RF output is disabled.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Starting with Cisco IOS Release 12.2(33)SCE, when you use the rf-channel rf-shutdown command, all
DOCSIS 3.0 cable modems associated with the RF channel on a particular wideband interface will go offline
and start re-registering in downstream partial service mode (p-online). In Cisco IOS Release 12.2(33)SCD
and earlier, cable modems do not go offline while using the rf-channel rf-shutdown command.
For muting and unmuting the QAM on the Cisco RFGW-10, use the rf-channel rf-shutdown command in
the M-CMTS.

Note This command cannot be executed on a Cisco 1 Gbps Wideband Shared Port Adapter (SPA) configured with
manual DEPI.

Examples The following example enables RF output on the Cisco wideband SPA:

Router# enable

Router# configure terminal

Router(config)# controller integrated-cable 7/1/0
Router(config-controller)# no rf-channel 0 rf-shutdown

Related Commands Command Description

controller modular-cable Enters controller configuration mode to configure the Wideband SPA controller.

controller integrated-cable Enters integrated-cable controller configuration mode.

Cisco CMTS Cable Command Reference

1501
 Cable Commands: q through sg
rf-channel rf-shutdown

Command Description

rf-channel network-delay Configure the network delay for an RF channel.

rf-channel rf-power Sets the RF power output level on the Cisco UBR-MC20X20V cable interface
line card.

Cisco CMTS Cable Command Reference

1502
 Cable Commands: q through sg
rf-channel stacking

rf-channel stacking
To suppress a carrier or mute a radio frequency (RF) channel on the Cisco uBR-MC88V cable interface line
card, use the rf-channel stacking command in controller configuration mode. To remove the configuration,
use the no form of this command.

rf-channel stacking stacking-number

no rf-channel stacking stacking-number

Syntax Description stacking-number RF channel stacking number. The range is from 1 to 4. The default value is 4.

Command Default The RF channel stacking number is set to 4.

Command Modes
Controller configuration (config-controller)

Command History Release Modification

12.2(33)SCD This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines If you change the default stacking number configuration, traffic loss may occur on the active channels. For
example, if you change the stacking number from 4 to 2, traffic is interrupted on the RF channels 0 and 1.
However, traffic loss does not occur if you do not change the stacking number configuration when shutting
down an RF channel using the rf-channel rf-shutdownrf-channel rf-shutdown command.

Note We recommend that you do not change the default stacking number configuration. You can change the default
configuration when you want RF diagnostics performed on a particular channel. For example, if you want to
perform RF diagnostics on RF channel 2, you need to change the default stacking number configuration to 2
to completely mute this channel.

Examples The following example shows how to configure the RF channel stacking number for the Cisco
uBR-MC88V cable interface line card:

Router# configure terminal

Router(config)# controller integrated-cable 5/1

Router(config-controller)# rf-channel stacking 3

Related Commands Command Description

rf-channel rf-shutdown Disables the RF output on a Cisco Wideband SPA, or a cable interface line card.

Cisco CMTS Cable Command Reference

1503
 Cable Commands: q through sg
rf-output

rf-output
To define the output mode for the RF channel, use the rf-output command in the RF channel sub configuration
mode.

rf-output {normal | alt | cw | prbs}

Syntax Description normal Normal mode for production operation.

alt Alternating symbol (two-tone). Diagnostic mode for hardware testing.

cw Continuous Wave. Diagnostic mode for hardware testing.

prbs Pseudo Random Binary Sequence. Diagnostic mode for hardware testing.

Command Default None.

Command Modes RF channel sub configuration mode (config-rf-chan)

Usage Guidelines This command is used to define the output mode for the RF channel.

The following example shows how to change the output mode:

router#configure terminal
router(config)#controller integrated-cable 3/0/0
router(config-controller)#rf-chan 5 10
router(config-rf-chan)#frequency 723000000
router(config-rf-chan)#rf-output alt
router(config-rf-chan)#exit
router(config-controller)#exit
router(config)#exit
router#show controller integrated-Cable 3/0/0 rf-channel 5 10
Chan State Admin Frequency Type Annex Mod srate Interleaver dcid power output
5 TEST UP 723000000 DOCSIS B 256 5361 I32-J4 164 34 ALT
10 TEST UP 753000000 DOCSIS B 256 5361 I32-J4 169 34 ALT

Related Commands Command Description

controller integrated-cable Enters the controller configuration mode.

frequency Defines the RF channel frequency.

qam-profile Defines the QAM profile number.

rf-chan Enters the RF channel sub configuration mode.

type Defines the QAM data type.

power-adjust Defines the channel power level.

Cisco CMTS Cable Command Reference

1504
 Cable Commands: q through sg
rf-port integrated-cable

rf-port integrated-cable
To define the physical slot/bay/port to be used in a video service, to define the Service Distribution Group
(SDG) use the rf-port integrated-cable command in the service distribution group configuration mode. To
delete the physical slot/bay/port, use the no form of the command.

rf-port integrated-cable slot/bay/port

Syntax Description slot The line card slot number. Slot can be configured from 0-3 or 6-9. Slots 4 and 5 are the supervisor
slots.

bay The Cisco cBR-8 chassis number. This is always configured as 0.

port The RF port number. This can be configured from 1-8.

Command Default None.

Command Modes Service distribution group configuration mode (config-video-sdg)

Command History Release Modification

Cisco IOS-XE Release 3.18.0S This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command is used to define the physical slot/bay/port to be used in a video service, to define the SDG.
To configure QAM replication for service group size alignment between the DOCSIS and video services to
one or more ports, you can add more ports into the service distribution group configuration. Make sure that
the controller type is video for the slot/bay/port that you would use for the SDG. For more information, see
the Video QAM Carriers section here: http://www.cisco.com/c/en/us/td/docs/cable/cbr/configuration/guide/
b_cbr_basic_config_prov_construct/video_qam_carriers.html.

The following example shows how to define the physical slot/bay/port :

router#configure terminal
router(config)#cable video
router(config-video)#service-distribution-group sdgid 1
router(config-video-sdg)#rf-port integrated-cable 7/0/0
router(config-video-sdg)#rf-port integrated-cable 7/0/1

Related Commands Command Description

service-distribution-group Defines a service distribution group.

onid Override the default ONID.

psi-interval Override the default PSI value.

show cable video service-distribution-group Displays the SDG configuration.

Cisco CMTS Cable Command Reference

1505
 Cable Commands: q through sg
rf-switch auxport enable

rf-switch auxport enable

To enable the AUX port of the RF switch, use the rf-switch auxport enable command in redundancy mode.
To disable the AUX port, use the no form of this command.

rf-switch auxport enable

no rf-switch auxport

Syntax Description enable Enables the Cisco NGRFSW-ADV. In the default configuration, the Cisco NGRFSW-ADV is
disabled. When the Cisco NGRFSW-ADV is enabled, the Cisco CMTS router starts polling the Cisco
NGRFSW-ADV at a set interval to check its status.

Command Default The AUX port of the Cisco NGRFSW-ADV is disabled by default.

Command Modes
Redundancy mode (config-red)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to enable the AUX port of the Cisco NGRFSW-ADV:

Router> enable
Router# configure terminal
Router(config)# redundancy
Router(config-red)# linecard-group 1 cable
Router(config-red-lc)# rf-switch auxport enable

Command History The rf-switch auxport enable command is used to configure the Cisco uBR Advanced RF Switch
(NGRFSW-ADV). See Cisco uBR Advanced RF Switch Software Configuration Guide .

Related Commands Command Description

linecard-group id cable Assigns the Hot Standby Connection-to-Connection Protocol (HCCP) group
to all interfaces on the cable interface line card, or Cisco Broadband Processing
Engine.

show redundancy linecard Displays information about a redundant line card or line card group.

Cisco CMTS Cable Command Reference

1506
 Cable Commands: q through sg
roll-off

roll-off
To specify the channel roll-off value, use the roll-off command in OFDM channel profile configuration mode.
To undo the channel roll-off value assignment, use no form of this command.

roll-off value

no profile-control

Syntax Description value The channel roll-off value. Valid values are 64, 128, 192, and 256.

Command Default 128

Command Modes
OFDM channel profile configuration (config-ofdm-chan-prof)

Command History Release Modification

IOS-XE 3.18.0SP This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to specify the channel roll-off value.

Examples The following example shows how to specify the channel roll-off value:

Router# configure terminal

Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)# roll-off 128

Related Commands Command Description

cable downstream ofdm-chan-profile Define the OFDM channel profile on the OFDM channel.

cyclic-prefix Specify the channel cyclic-prefix.

description (OFDM channel profile) Specify a user defined description for the profile.

interleaver-depth Specify the channel interleaver-depth.

pilot-scaling Specify the value used to calculate the number of continuous pilots.

profile-data Specify default modulation or profile as the channel data profile.

profile-ncp Specify default modulation or profile as the channel ncp profile.

profile-control Specify default modulation or profile as the channel control profile.

subcarrier-spacing Specify the spacing for specific subcarriers configured in this profile.

Cisco CMTS Cable Command Reference

1507
 Cable Commands: q through sg
route-ecmg

route-ecmg
To configure the route to the ECMG server for session based scrambling, use the route-ecmg command in
the DVB scrambling configuration mode. To void the route configuration, use the no form of this command.

route-ecmg ip_address netmask interface forwarding_router_ip

no route-ecmg ip_address netmask interface forwarding_router_ip

ip_address Specifies the IP address of the ECMG server.

netmask Specifies the netmask of the connection.

interface Specifies the interface of the connection.

forwarding_router_ip Specifies the IP address of the forwarding router.

Command Default None

Command Modes DVB scrambling configuration mode (config-video-encrypt-dvb)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

The following is an example of how to configure the route to the ECMG server:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#route-ecmg 1.200.1.0 255.255.255.0 TenGigabitEthernet 4/1/2
1.200.1.1

Related Commands Command Description

dvb Enters DVB scrambling configuration mode.

strong-pairing-enforce Switches on the NDS strong pairing enforcement

check-scg-at-prov Enables Check SCG at provision time.

scramble-video-audio Scrambles only video and audio pids.

mgmt-ip Configures the manangement IP for EIS/Broadcast

ECMG.

ca-interface Configures the conditional access interface.

tier-based Enters the tier-based scrambling configuration mode.

Cisco CMTS Cable Command Reference

1508
Cable Commands: q through sg
route-ecmg

Command Description

ecmg Enters the ECM Generator configuration mode.

eis Enters the Event Information Scheduler configuration

mode.

Cisco CMTS Cable Command Reference

1509
 Cable Commands: q through sg
routing-interface-ip

routing-interface-ip

To automatically configure IP addresses of line card video interfaces from a pool of IP addresses that you
provide, use the routing-interface-ip command.

routing-interface-ip ip-address ip-mask { secondary ip-address ip-mask }

Syntax Description ip-address Specifies the starting IP address of the line card video interfaces.

ip-mask Specifies the IP mask IP address.

secondary Specifies the secondary interface of the line card video interfaces.

Command Modes Video configuration mode (config-video)

Command History Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Do not change the video interface IP configuration unless there are conflicts with customer subnets.
Video interface IP configuration is optional. By default, the Cisco cBR-8 uses 10.100.x.x subnets for primary
IP addresses and 10.101.x.x subnets for secondary IP addresses of video interfaces. By default, all video
interfaces are in the VRF Mgmt-MPEG-video-intf.
Configure the video interface IP before configuring any other video-specific configurations like logical edge
device and virtual service group configurations. Use the routing-interface-ip only when the default
configuration conflicts with the existing subnets in the network.

Cisco CMTS Cable Command Reference

1510
 Cable Commands: q through sg
routing-interface-vrf

routing-interface-vrf

To configure user-specific VRF to line card video interfaces, use the routing-interface-vrf command in video
configuration mode. To remove the user-specific VRF configuration, use the no form of this command.

routing-interface-vrf slot slot vrf-name vrf-name

Syntax Description slot Slot where the line card resides. The valid range is 0–3 and 6–9.

vrf-name Name of the user-specific VRF

Command Modes Video configuration mode (config-video)

Command History Release Modification

Cisco IOS XE Amsterdam 17.3.1x This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Virtual routing and forwarding configuration is optional. Use the routing-interface-vrf only when the video
interface participates in NX-MVPN profile 12 or profile 14.
Do not use the routing-interface-vrf command for legacy L3VPN.
By default, all video interfaces are in the VRF Mgmt-MPEG-video-intf.
Configure VRF separately for each line card that is participating in NX-MVPN.
Configure virtual routing and forwarding before configuring any other video-specific configurations like
logical edge device, virtual carrier group, or service distribution group configurations.

Cisco CMTS Cable Command Reference

1511
 Cable Commands: q through sg
rpd-ds downstream-cable

rpd-ds downstream-cable
To configure the downstream controller in the RPD, use the rpd-ds downstream-cable command in RPD
core-interface configuration mode. To void the downstream controller configuration in the RPD, use the no
form of this command.

rpd-ds 0 downsteam-cable slot/subslot/port profile id

no rpd-ds 0 downsteam-cable slot/subslot/port

Syntax Description slot/subslot/port Specifies the slot, subslot and port of the downstream controller.

Command Default None

Command Modes RPD conre-interface configuration (config-rpd-core)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the downstream controller in the RPD.

The following example shows how to configure the downstream controller in the RPD:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# core-interface tengigabitethernet 3/1/0
Router(config-rpd-core)# rpd-ds 0 downstream-cable 9/0/0 profile 0

Related Commands Command Description

core-interface Configures the core-interface of the RPD.

rpd-us upstream-cable Configures the upstream controller in the RPD.

Cisco CMTS Cable Command Reference

1512
 Cable Commands: q through sg
rpd-ds downstream-oob-vom

rpd-ds downstream-oob-vom
To specify the downstream virtual OM and OOB profile, use the rpd-ds downstream-oob-vom command
in RPD core-interface configuration mode. To void the downstream virtual OM and OOB profile assignment,
use the no form of this command.

rpd-ds 0 downstream-oob-vom o-id profile dp-id

no rpd-ds 0 downstream-oob-vom

Syntax Description o-id Specifies the ID of the virtual OM previously configured.

dp-id Specifies the ID of the downstream OOB profile previously configured.

Command Default None

Command Modes RPD conre-interface configuration (config-rpd-core)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to specify the downstream virtual OM and OOB profile.

The following example shows how to specify the downstream virtual OM and OOB profile:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# core-interface tengigabitethernet 3/1/0
Router(config-rpd-core)# rpd-ds 0 downstream-oob-vom 1 profile 3

Related Commands Command Description

virtual-om Defines a virtual OOB modulator configuration.

controller downstream-oob 55d1-profile Configures the OOB downstream controller profile.

Cisco CMTS Cable Command Reference

1513
 Cable Commands: q through sg
rpd-event

rpd-event
To specify the RPD event reporting profile to use in RPD, use the rpd-event command in RPD configuration
mode. To void the RPD event reporting profile specification, use the no form of this command.

rpd-event profile id

no rpd-event profile

Syntax Description id Specifies the ID of the RPD event reporting profile previously created.

Command Default None

Command Modes RPD configuration (config-rpd)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to specify the RPD event reporting profile.

The following example shows how to specify the RPD event reporting profile:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# rpd-event profile 1

Cisco CMTS Cable Command Reference

1514
 Cable Commands: q through sg
rpd-us upstream-cable

rpd-us upstream-cable
To configure the upstream controller in the RPD, use the rpd-us upstream-cable command in RPD
core-interface configuration mode. To void the upstream controller configuration in the RPD, use the no form
of this command.

rpd-us port upsteam-cable slot/subslot/port profile id

no rpd-us port upsteam-cable slot/subslot/port

Syntax Description slot/port/interface Specifies the slot, subslot and port of the upstream controller.

Command Default None

Command Modes RPD conre-interface configuration (config-rpd-core)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Description
Specifies a description for the upstream controller profile. The maximum length is 20 characters. This field
is set to NULL by default. Different upstream controller profiles on the RPD ports can be easily distinguished
if a description is specified.

Usage Guidelines Use this command to configure the upstream controller in the RPD.

The following example shows how to configure the upstream controller in the RPD:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# core-interface tengigabitethernet 3/1/0
Router(config-rpd-core)# rpd-us 0 upstream-cable 9/0/0 profile 122

Related Commands Command Description

core-interface Configures the core-interface of the RPD.

rpd-ds downstream-cable Configures the downstream controller in the RPD.

Cisco CMTS Cable Command Reference

1515
 Cable Commands: q through sg
rpd-us upstream-oob-varpd

rpd-us upstream-oob-varpd
To specify the upstream virtual ARPD and OOB profile, use the rpd-us upstream-oob-varpd command in
RPD core-interface configuration mode. To void the upstream virtual ARPD and OOB profile assignment,
use the no form of this command.

rpd-us port upstream-oob-varpda-id profile up-id

no rpd-us port upstream-oob-varpd

Syntax Description a-id Specifies the ID of the virtual ARPD previously configured.

up-id Specifies the ID of the upstream OOB profile previously configured.

Command Default None

Command Modes RPD conre-interface configuration (config-rpd-core)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to specify the upstream virtual ARPD and OOB profile.

The following example shows how to specify the upstream virtual ARPD and OOB profile:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# core-interface tengigabitethernet 3/1/0
Router(config-rpd-core)# rpd-us 0 upstream-oob-varpd 1 profile 3

Related Commands Command Description

virtual-arpd Defines a virtual ARPD configuration.

controller upstream-oob 55d1-profile Configures the OOB upstream controller profile.

Cisco CMTS Cable Command Reference

1516
 Cable Commands: q through sg
rpd downstream-cable

rpd downstream-cable
To specify the RPD in the SDG, use the rpd downstream-cable command in SDG configuration mode. To
void the RPD assignment in the SDG, use the no form of this command.

rpd downsteam-cable slot/bay/port

no rpd downsteam-cable slot/bay/port

Syntax Description slot/bay/port Specifies the slot, bay and port of the downstream cable interface.

Command Default None

Command Modes service distribution group configuration (config-video-sdg)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure the downstream controller in the RPD.

The following example shows how to configure the downstream controller in the RPD:
Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# core-interface tengigabitethernet 3/1/0
Router(config-rpd-core)# rpd-ds 0 downstream-cable 9/0/0 profile 0

Related Commands Command Description

core-interface Configures the core-interface of the RPD.

rpd-us upstream-cable Configures the upstream controller in the RPD.

Cisco CMTS Cable Command Reference

1517
 Cable Commands: q through sg
sbfd

sbfd
To configure the SBFD, use the sbfd command in RPD configuration mode. To void the SBFD configuration,
use the no form of this command.

sbfd {sbfd | inteval milliseconds multiplier value}

no sbfd {enable | interval}

Syntax Description milliseconds Specifies interval in milliseconds.

value Specifies the value to multiply the interval.

Command Default None

Command Modes RPD configuration (config-rpd)

Command History Release Modification

Cisco IOS XE Everest This command was introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines Use this command to configure SBFD.

The following example shows how to configure SBFD:

Router# configure terminal
Router(config)# cable rpd 1
Router(config-rpd)# no sbfd enable

Cisco CMTS Cable Command Reference

1518
 Cable Commands: q through sg
scramble-video-audio

scramble-video-audio
To scramble only video and audio pids, use the scramble-video-audio command in the DVB scrambling
configuration mode. To scramble all elementary streams, use the no form of this command.

scramble-video-audio
no scramble-video-audio

Command Default None

Command Modes DVB scrambling configuration mode (config-video-encrypt-dvb)

Release Modification

IOS-XE 16.4.1 This command was introduced on the Cisco cBR

Series Converged Broadband Routers.

Usage Guidelines When scramble-video-audio is configured, the elementary streams other than video and audio are not
scrambled.

The following is an example of how to scramble only video and audio pids:

Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#scramble-video-audio

Related Commands Command Description

dvb Enters DVB scrambling configuration mode.

strong-pairing-enforce Switches on the NDS strong pairing enforcement

check-scg-at-prov Enables Check SCG at provision time.

route-ecmg Configures the route to the ECMG server.

mgmt-ip Configures the manangement IP for EIS/Broadcast

ECMG.

ca-interface Configures the conditional access interface.

tier-based Enters the tier-based scrambling configuration mode.

ecmg Enters the ECM Generator configuration mode.

eis Enters the Event Information Scheduler configuration

mode.

Cisco CMTS Cable Command Reference

1519
 Cable Commands: q through sg
secondary aux

secondary aux
To enable the auxiliary port on the standby PRE1 module, use the secondary aux command in redundancy
configuration (main-cpu) mode. To disable the auxiliary port, use the no form of this command.

secondary aux
no secondary aux

Syntax Description This command has no keywords or arguments.

Command Default The auxiliary port on the standby PRE1 module is disabled.

Command Modes
Redundancy configuration, main-cpu mode

Command History Release Modification

12.2(11)BC3 This command was introduced for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to enable the auxiliary port on the standby PRE1 module.

Router# config t

Router(config)# redundancy

Router(config-r)# main-cpu

Router(config-r-mc)# secondary aux

Router(config-r-mc)# exit

Router(config-f)# exit

Router(config)#

Related Commands Command Description

main-cpu Enters main-CPU redundancy configuration mode, so that you can

configure the synchronization of the active and standby Performance
Routing Engine (PRE1) modules.

redundancy Configures the synchronization of system files between the active and
standby PRE1 modules.

redundancy force-failover Forces a manual switchover between the active and standby PRE1
main-cpu modules.

Cisco CMTS Cable Command Reference

1520
 Cable Commands: q through sg
server

server
To define the server IP address of the session resource manager, use the server command in the logical edge
device protocol configuration mode. To reset to default configuration, use the no form of this command.

server ip-address
no server ip-address

Syntax Description ip-address Specifies the server IP address of the session resource manager.

Command Default None

Command Modes
Logical edge device protocol configuration (config-video-led-protocol)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command defines the server IP address of the session resource manager.

Examples The following example shows how to define the server IP address of the session resource manager:

Router# configure terminal

Router(config)# cable video
Router(config-video)#logical-edge-device vod id 1
Router#(config-video-led)protocol gqi
Router#(config-video-led-protocol)server 172.16.3.75

Related Commands Command Description

logical-edge-device Defines a logical edge device.

protocol Specifies the protocol used in the logical edge device.

mgmt-ip Defines the local management IP address for a logical edge device.

mac-address Defines the MAC address for a logical edge device.

vcg Specifies the virtual carrier group assigned to the logical edge
device.

virtual-edge-input-ip Defines a virtual edge input.

show cable video logical-edge-device Displays the logical edge device information.

show cable video gqi connections Displays the GQI connection information of the logical edge
device with the Session Resource Manager.

Cisco CMTS Cable Command Reference

1521
 Cable Commands: q through sg
server

Command Description

show diag all eeprom detail | include Displays the chassis MAC address information.
MAC

Cisco CMTS Cable Command Reference

1522
 Cable Commands: q through sg
service divert-limit

service divert-limit
To set the layer 3 mobility threshold limit, use the service divert-limit command in global configuration
mode. To set the default value, use the no form of this command.

service divert-limit {l3-mobility-counter limit | l3-mobility-timeslot timeslot }

no service divert-limit {l3-mobility-counter limit | l3-mobility-timeslot timeslot }

Syntax Description l3-mobility-counter Sets the layer 3 CPE mobility counter threshold.

limit Specifies the mobility counter threshold limit in packets. The range is from 1 to 127.
The default is 16.

l3-mobility-timeslot Sets the layer 3 CPE mobility time slot configuration.

timeslot Specifies the mobility time slot in milliseconds. The range is from 1 to 4095. The
default is 300.

Command Default This divert-limit l3-mobility-counter default value is 16 packets and divert-limit l3-mobility-timeslot
default value is 300 ms.

Command Modes
Global configuration (config)

Command History 12.2(33)SCH2 The command was introduced.

IOS-XE 3.15.0S This command was replaced by the platform punt-sbrl subscriber command on the Cisco
cBR Series Converged Broadband Routers.

Usage Guidelines If the cable l3-mobility command is enabled, the service divert-limit command is also enabled by default.
This command is usually used to modify the default value.

Note This command does not work if cable l3-mobility command is disabled.

Examples The following example shows how to set the CPE mobility threshold and time slot:

Router # enable
Router # configure terminal
Router (config) # service divert-limit l3-mobility-counter 127
Router (config) # service divert-limit l3-mobility-timeslot 4095

Related Commands Command Description

cable l3-mobility Enables mobility for a particular IPv4 or IPv6 subnet.

Cisco CMTS Cable Command Reference

1523
 Cable Commands: q through sg
service divert-rate-limit

service divert-rate-limit

Note Effective with Cisco IOS Release 12.2(33)SCB, the service divert-rate-limit fib-rp-glean command is
replaced on the WAN-side by the service divert-rate-limit ip fib-rp-glean command. See the service
divert-rate-limit ip command for more information. The service divert-rate-limit fib-rp-glean command is
replaced on the WAN-side non-IP by service divert-rate-limit non-ip fib-rpf-glean command. See the service
divert-rate-limit non-ip command for more information. For cable-side DRL configuration, see the cable
divert-rate-limit command.

To configure PXF Divert-Rate-Limit, use the service divert-rate-limit command in global configuration
mode. To reset this feature to the default parameters, use the no form of this command.

service divert-rate-limit divert-code rate [limit limit]

no service divert-rate-limit divert-code

Syntax Description divert-code Configures the PXF Divert-Rate-Limit for the any of the following packets:
rate
• fwd-glean—Packets that hit a glean adjacency in the FIB.
• rpf-glean—Packets that hit a glean adjacency during the RPF check.
The range is from 1 to 255 packet-per-second.
The default rate is 20 packets-per-second.

limit limit (Optional) Sets the limit for the number of packets that will be diverted in an initial burst
of packets.
The range is from 4 to 255 packets.
The default limit is 5 packets.
Note
Setting the limit has a limited effect on the behavior of the algorithm, so this part of the
CLI is hidden.

Command Default Divert-Rate-Limit contains the following default behavior and values:
• Divert-Rate-Limit is always active.
• The default rate is 20 packets-per-second.
• The default limit is 5 packets.

Command Modes
Global configuration (config)

Command History 12.3(17a)BC The command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 universal
broadband routers.

12.2(33)SCA This command was integrated into Cisco IOS release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

Cisco CMTS Cable Command Reference

1524
 Cable Commands: q through sg
service divert-rate-limit

12.2(33)SCB This command was replaced by the service divert-rate-limit ip fib-rp-glean command
and service divert-rate-limit non-ip fib-rpf-glean command.

IOS-XE 3.15.0S This command was replaced by the platform punt-sbrl subscriber command on the Cisco
cBR Series Converged Broadband Routers.

Usage Guidelines Theservice divert-rate-limit command is used to configure the PXF Divert-Rate-Limit for fwd-glean and
rpf-glean packets in order to identify packet streams that will cause congestion of the FP-to-RP interface.

Examples The following example shows how to configure rate-limiting for fib-rp-glean, with a rate of 10
packets-per-second and a limit of 20 packets:

Router(config-if)# service divert-rate-limit fib-rp-glean 10 limit 20

The following example shows how to return rate-limiting for fib-rp-glean to the default values:

Router(config-if)# no service divert-rate-limit fib-rp-glean

Pass and fail counters are kept for fwd-glean, rpf-glean, and cable-ARP packets. To show the statistics
for the pass and fail counter, use the show pxf cpu statistics drl command:

Router(config-if)# show pxf cpu statistics drl

Divert-Rate-Limit statistics
code total diverted dropped
fib_rpf_glean 500 59 441
fib_rp_glean 500 54 446
arp_filter 0 0 0

Note The arp_filter stats shown above are global stats for PXF ARP Filtering. These stats cannot be cleared
by the CLI. However, they will reset to zero upon reload.

Packets dropped by Divert-Rate-Limit and the ARP Filter will be recorded in the regular PXF drop
statistics:

Router(config-if)# show pxf cpu statistics drop c5/0/0

FP drop statistics for Cable5/0/0

packets bytes
vcci undefined 0 0
vcci C
...
divert_rate_limit 441 28224
arp_filter_reply 0 0
arp_filter_request 0 0

Related Commands Command Description

show cable arp-filter Displays the total number of Address Resolution Protocol (ARP) offenders.

Cisco CMTS Cable Command Reference

1525
 Cable Commands: q through sg
service divert-rate-limit ip

service divert-rate-limit ip
To set DRL rate and limit for WAN-side IP packet streams, use the service divert-rate-limit ip command in
global configuration mode. To reset the rate and limit to the default values for all IP divert-codes, use the
no form of this command. Using no service divert-rate-limit ip divert-code will reset rate and limit to the
default values for the specified divert code.

service divert-rate-limit ip divert-code rate rate limit limit

no service divert-rate-limit ip

Syntax Description divert code Specifies the applicable divert code.

rate Specifies the divert rate in packets per second. Minimum rate is 1 packet per second. Maximum
rate is 65535 packets per second.
For WAN-side IP packets, the default rate is 4000 packets per second

limit Specifies the number of packets to be diverted in an initial burst of packets. Minimum limit is
4 packets. Maximum limit is 4194 packets.
For WAN-side IP packets, the default limit is 4000 packets.

Command Default For WAN-side IP packet streams, the default rate is 4000 packets per second and default limit is 4000 packets.
These defaults apply to each uniquely identified IP packet stream.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

The service divert-rate-limit ip fib-rp-glean command is the WAN-side replacement for
the service divert-rate limit fib-rp-glean command.

IOS-XE 3.15.0S This command was replaced by the platform punt-sbrl wan command on the Cisco cBR
Series Converged Broadband Routers.

Usage Guidelines You can configure a rate and limit for a particular IP divert-code for WAN-side IP packets. However, each
IP packet-stream is uniquely identified (using a hash of the VRF, the IP source address, and the divert-code),
and then packets in that stream are sent through a rate-limiter with the configured rate and limit.

Examples The following example shows how to set the rate and limit for the specified divert code:

Router(config)# service divert-rate-limit ip fib-rp-glean rate 1 limit 4

Related Commands Command Description

service divert-rate-limit non-ip This command configures DRL for WAN-side non-IP packet streams.

Cisco CMTS Cable Command Reference

1526
Cable Commands: q through sg
service divert-rate-limit ip

Command Description

service divert-rate-limit trusted-site This command adds entries to the trusted site list.

Cisco CMTS Cable Command Reference

1527
 Cable Commands: q through sg
service divert-rate-limit ipv6

service divert-rate-limit ipv6

To set the divert rate limit (DRL) rate and limit for WAN-side IPv6 packet streams, use the service
divert-rate-limit ipv6 command in global configuration mode.

service divert-rate-limit ipv6 divert-code rate rate limit limit

no service divert-rate-limit ipv6

Syntax Description divert-code Specifies the applicable divert code.

rate Specifies the divert rate in packets per second. Minimum rate is 1 packet per second. Maximum
rate is 65535 packets per second.
For WAN-side IPv6 packets, the default rate is 4000 packets per second.

limit Specifies the number of packets to be diverted in an initial burst of packets. Minimum limit is
4 packets. Maximum limit is 4194 packets.
For WAN-side IPv6 packets, the default limit is 4000 packets.

Command Default For WAN-side IPv6 packet streams, the default rate is 4000 packets per second and default limit is 4000
packets.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command was replaced by the platform punt-sbrl wan command on the Cisco cBR
Series Converged Broadband Routers.

Usage Guidelines You can configure rate and limit for a particular IPv6 divert-code for WAN-side IP packets. However, each
IP packet-stream is uniquely identified (using a hash of the VRF, the IP source address, and the divert-code),
and then packets in that stream are sent through a rate-limiter with the configured rate and limit.
This command is supported only on PRE4.
Use the diversion option of the show pxf cpu statistics command to troubleshoot the divert code, before
configuring the DRL.
To configure the correct divert code, refer to the list of divert codes.

Table 37: List of divert codes

Divert Code Description

6pe_dst_linklocal 6PE dst linklocal

6pe_dst_mcast 6PE dst multicast

Cisco CMTS Cable Command Reference

1528
 Cable Commands: q through sg
service divert-rate-limit ipv6

Divert Code Description

6pe_ttl 6PE ttl

icmpv6 IPv6 ICMP

ipv6_cable_filter_ds ipv6 cable filter ds

ipv6_dhcp_ucast IPv6 unicast DHCP

ipv6_hopopts IPv6 HopOpts

ipv6_lng_ext_hdr IPv6 long extension hdr

ipv6_mcast_rsvd IPv6 multicast

ipv6_nd_na_mcast IPv6 ND NA (multicast)

ipv6_nd_na_ucast IPv6 ND NA (unicast)

ipv6_nd_ns_mcast IPv6 ND NS (multicast)

ipv6_nd_ns_ucast IPv6 ND NS (unicast)

ipv6_nd_rs_mcast IPv6 ND RS (multicast)

ipv6_rp_dest IPv6 receive adjacency

ipv6_rp_glean IPv6 glean adjacency

ipv6_rp_pbr IPv6 RP PBR

ipv6_rp_punt IPv6 punt adjacency

ipv6_src_linklocal IPv6 SRC LinkLocal

ipv6_src_ver_lq_req IPv6 src ver leasequery request

ipv6_src_ver_mac_req IPv6 src ver MAC request

Note To reset the rate and limit to the default values for all IPv6 divert-codes, use the no form of this command.
Using no service divert-rate-limit ipv6 divert-code will reset rate and limit to the default values for the
specified divert code.

Examples The following example shows how to set the rate and limit for the specified divert code:

Router(config)# service divert-rate-limit ipv6 ipv6_rp_glean rate 20 limit 10

Router(config)#

Cisco CMTS Cable Command Reference

1529
 Cable Commands: q through sg
service divert-rate-limit ipv6

Related Commands Command Description

service divert-rate-limit trusted-site Adds IPv4-specific entries to the trusted site list.

service divert-rate-limit non-ip Configures DRL for WAN-side non-IP packet streams.

service divert-rate-limit trusted-site-ipv6 Adds IPv6-specific entries to the trusted site list.

show pxf cpu statistics Displays Parallel eXpress Forwarding (PXF) CPU statistics.

Cisco CMTS Cable Command Reference

1530
 Cable Commands: q through sg
service divert-rate-limit ip trusted-site

service divert-rate-limit ip trusted-site

To add entries to the trusted site list, use the service divert-rate-limit ip trusted-site command in the global
configuration mode. To remove all entries from the trusted site list, use the no form of this command.

service divert-rate-limit ip trusted-site ip-address mask ip-address tos tos-value mask tos-mask
vrf vrf-name
no service divert-rate-limit ip trusted-site ip-address mask ip-address tos tos-value mask tos-mask
vrf vrf-name

Syntax Description ip-address Specifies the source IP address that should be matched.

mask The mask to apply to the source IP address of the packet before testing if it matches. There
ip-address are no restrictions on the mask value.

tos tos-value The ToS value of the trusted site. There are no restrictions on the tos_value. Example:
0xD0

mask tos-mask The mask to apply to the IP ToS value and the trusted-site tos_value before testing if it
matches. There are no restrictions on the tos_mask value.
Example: 0xF3
Note
The ToS value can be wild-carded by setting the tos_mask to 0x00

vrf vrf-name The VRF that this trusted site applies to.
For the global VRF, use the global keyword. To apply the trusted-site to all VRFs (including
the global VRF), hit enter after specifying the tos-mask.
If a non-existent VRF is specified, the table entry is filled, but the information is not written
to toaster memory. If the specified VRF is subsequently created, the information is written
to toaster at that time.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The service divert-rate-limit ip trusted-site command is used to configure trusted site list that contains a
source IP address and mask, IP ToS value and mask, and a VRF. If no IP address is specified, the entire trusted
site list is cleared. The trusted site list contains a source IP address and mask, IP ToS value and mask, and a
VRF. The trusted site list applies only to WAN-IP IPv4 packets. There is a limitation of four trusted sites.

Cisco CMTS Cable Command Reference

1531
 Cable Commands: q through sg
service divert-rate-limit ip trusted-site

Examples The following example shows how to configure trusted site list:

Router(config
)# service divert-rate-limit trusted-site 192.0.13.2 255.255.255.0
tos 0xD0 mask 0xF3 vrf name1

Related Commands Command Description

service divert-rate-limit non-ip This command sets and limit default values for the specified divert code.

Cisco CMTS Cable Command Reference

1532
 Cable Commands: q through sg
service divert-rate-limit max-rate us-cable

service divert-rate-limit max-rate us-cable

To set per-divert-code rate limit on the upstream cable interface, use the service divert-rate-limit max-rate
us-cable command in global configuration mode. To reset the divert-rate-limit parameters to the default values
for all divert-codes, use the no form of this command.

service divert-rate-limit max-rate us-cable divert-code rate rate limit limit

Syntax Description divert-code Configures the divert-rate-limit for any of the following packets:
• mfib_224_0_0_x—The Packet whose destination IP is 224.0.0.x.
• icmpv6—IPv6 ICMP
• mfib_igmp—IGMP protocol packet
• ipv6_nd_na_mcast—IPv6 ND NA (multicast)
• ipv6_nd_na_ucast—IPv6 ND NA (unicast)
• ipv6_nd_ns_mcast—IPv6 ND NS (multicast)
• ipv6_nd_ns_ucast—IPv6 ND NS (unicast)
• fib_rp_dest— IPv4 packets targeting to CMTS.
• fib_rp_dest_precedence—The packet whose destination is RP and has non-zero precedence
value in IP header.
• fib_rp_glean—FIB glean adjacency used for IPv4 adjacency resolving.
• fib_rp_punt—FIB punt adjacency used for IPv4 adjacency resolving.
• src_ver_leasequery_req—Divert to RP due to zero MD and sid value and need to send lease
query to DHCP server for those packets.
• src_ver_unknown_ip_addr—Divert to RP due to zero MD and sid value and no adjacency
information for source IP address of those packets.
• ipv6_rp_dest—IPv4 packets targeting to CMTS.
• ipv6_rp_dest_precedence—The packet whose destination is RP and has non-zero precedence
value in IPV6 header.
• ipv6_rp_glean—IPv6 receive adjacency used for IPv4 adjacency resolving.
• ipv6_rp_punt—IPv6 punt adjacency used for IPv4 adjacency resolving.
• ipv6_src_linklocal—IPv6 SRC LinkLocal
• ipv6_src_ver_mac_req—Divert to RP due to zero MD and sid value.

rate Specifies the divert rate in packets/sec. The range is from 1 to 65535. The default value is 4194.

limit Specifies the limit for the number of packets that will be diverted in an initial burst of packets.
The range is from 4 to 4194.The default value is 4194.

Cisco CMTS Cable Command Reference

1533
 Cable Commands: q through sg
service divert-rate-limit max-rate us-cable

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCJ This command was introduced.

Usage Guidelines The service divert-rate-limit max-rate us-cable command can be configured when the DDos occurs and
the flooding packets have one of the support divert codes.

Note Before you configure the service divert-rate-limit max-rate command, it is recommended to configure the
source based DRL first.

Example
The following example shows how to set the rate and limit for the specified divert code:
Router(config)# service divert-rate-limit max-rate us-cable fib_rp_glean rate 5000 limit
100

Related Commands Command Description

show pxf cpu statistics drlmax-rate us-cable Verifies the drop counters for the DRL max-rate on the
upstream cable interface.

Cisco CMTS Cable Command Reference

1534
 Cable Commands: q through sg
service divert-rate-limit max-rate wan

service divert-rate-limit max-rate wan

To set per-divert-code rate limit on the WAN interface, use the service divert-rate-limit max-rate wan
command in global configuration mode. To reset the divert-rate-limit parameters to the default values for all
divert-codes, use the no form of this command.

service divert-rate-limit max-rate wan divert-code rate rate limit limit

Syntax Description divert-code Configures the divert-rate-limit for any of the following packets:
• fib_rp_dest— IPv4 packets targeting to CMTS.
• fib_rp_glean—FIB glean adjacency used for IPv4 adjacency resolving.
• fib_rp_punt—FIB punt adjacency used for IPv4 adjacency resolving.
• ipv6_rp_dest—IPv4 packets targeting to CMTS.
• ipv6_rp_glean—IPv6 receive adjacency used for IPv4 adjacency resolving.
• ipv6_rp_punt—IPv6 punt adjacency used for IPv4 adjacency resolving.
• mfib_224_0_0_x—The Packet whose destination IP is 224.0.0.x.
• icmpv6—IPv6 ICMP
• mfib_igmp—IGMP protocol packet
• ipv6_nd_na_mcast—IPv6 ND NA (multicast)
• ipv6_nd_na_ucast—IPv6 ND NA (unicast)
• ipv6_nd_ns_mcast—IPv6 ND NS (multicast)
• ipv6_nd_ns_ucast—IPv6 ND NS (unicast)
• ipv6_rp_dest_precedence—The packet whose destination is RP and has non-zero
precedence value in IPV6 header.
• ipv6_src_linklocal—IPv6 SRC LinkLocal
• fib_rp_dest_precedence—The packet whose destination is RP and has non-zero precedence
value in IP header.

rate Specifies the divert rate in packets/sec. The range is from 1 to 65535. The default value is 4194.

limit Specifies the limit for the number of packets that will be diverted in an initial burst of packets.
The range is from 4 to 4194.The default value is 4194.

Command Modes Global configuration (config)

Command History Release Modification

12.2(33)SCH3 This command was introduced.

Cisco CMTS Cable Command Reference

1535
 Cable Commands: q through sg
service divert-rate-limit max-rate wan

Release Modification
12.2(33)SCJ This command was updated to include more divert codes.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The service divert-rate-limit max-rate wan command can be configured when the DDos occurs and the
flooding packets have one of the support divert codes.

Note Before you configure the service divert-rate-limit max-rate command, it is recommended to configure the
source based DRL first.

Example
The following example shows how to set the rate and limit for the specified divert code:
Router(config)# service divert-rate-limit max-rate wan fib_rp_glean rate 5000 limit 100

Related Commands Command Description

show pxf cpu statistics drlmax-rate wan Verifies the drop counters for the DRL max-rate on the WAN
interface.

clear pxf statistics drl max-rate Clears the DRL max-rate statistics on the WAN interface.

Cisco CMTS Cable Command Reference

1536
 Cable Commands: q through sg
service divert-rate-limit non-ip

service divert-rate-limit non-ip

To set DRL for WAN-side non-IP packet streams, use the service divert-rate-limit non-ip command in
global configuration mode. To reset the rate and limit to the default values for all non-IP divert-codes, use
the no form of this command. Using no service divert-rate-limit non-ip divert-code will reset rate and limit
to the default values for the specified divert-code.

service divert-rate-limit non-ip divert-code rate rate limit limit

no service divert-rate-limit non-ip

Syntax Description divert-code Specifies the applicable divert code.

rate Specifies the rate in packets per second. Minimum rate is one packet per second. Maximum
rate is 65535 packets per second.
For WAN-side non-IP packets, the default rate is 2000 packets per second.

limit Specifies the number of packets to be diverted in an initial burst of packets. Minimum limit is
4 packets. Maximum limit is 4194 packets.
For WAN-non-IP packets, the default limit is 2000 packets.

Command Default For WAN-side non-IP packets, the default rate is 2000 packets per second and default limit is 2000 packets.

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

The service divert-rate-limit non-ip fib-rpf-glean command is the WAN-side non-IP
replacement for the service divert-rate-limit fib-rpf-glean command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You can configure a rate and limit for a particular non-IP divert-code, and all packets arriving with that
divert-code are sent through a single rate-limiter with the configured rate and limit. but the explanation is
fairly straightforward: there is a single rate-limiter for each non-IP divert-code. No attempt is made to uniquely
identify the source of the attacking packet stream.

Examples The following example shows how to set and limit default values for the specified divert code:

Router(config)# service divert-rate-limit non-ip fib-rp-glean 10 rate 1 limit 4

Related Commands Command Description

service divert-rate-limit ip This command configures DRL rate and limit for WAN-side IP packet streams.

Cisco CMTS Cable Command Reference

1537
 Cable Commands: q through sg
service divert-rate-limit trusted-site

service divert-rate-limit trusted-site

To add entries to the trusted site list, use the service divert-rate-limit trusted-site command in the global
configuration mode. To remove all entries from the trusted site list, use the no form of this command.

service divert-rate-limit trusted-site ip-address mask-ip-address tos tos-value mask tos-mask [global
| vrf vrf-name]
no service divert-rate-limit trusted-site

Syntax Description ip-address Specifies the source IP address that should be matched.

mask The mask to apply to the source IP address of the packet before testing if it matches. There
ip-address are no restrictions on the mask value.

tos tos-value The ToS value of the trusted site. There are no restrictions on the tos_value. Example:
0xD0

mask tos-mask The mask to apply to the IP ToS value and the trusted-site tos_value before testing if it
matches. There are no restrictions on the tos_mask value.
Example: 0xF3
Note
The ToS value can be wild-carded by setting the tos_mask to 0x00

vrf vrf-name The VRF that this trusted site applies to.
For the global VRF, use the global keyword. To apply the trusted-site to all VRFs (including
the global VRF), hit enter after specifying the tos-mask.
If a non-existent VRF is specified, the table entry is filled, but the information is not written
to toaster memory. If the specified VRF is subsequently created, the information is written
to toaster at that time.

Command Default None

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The service divert-rate-limit ip trusted-site command is used to configure trusted site list that contains a
source IP address and mask, IP ToS value and mask, and a VRF. The trusted site list contains a source IP
address and mask, IP ToS value and mask, and a VRF. The trusted site list applies only to WAN-IP IPv4
packets. There is a limitation of four trusted sites.

Cisco CMTS Cable Command Reference

1538
 Cable Commands: q through sg
service divert-rate-limit trusted-site

To remove specified entry from the trusted site list, use no service divert-rate-limit trusted-site ip-address
mask ip-address tos tos-value mask tos-mask [global | vrf vrf-name ]. If no IP address is specified, the
entire trusted site list is cleared.

Examples The following example shows how to configure trusted site list:

Router(config
)# service divert-rate-limit trusted-site 192.0.13.0 255.255.255.0
tos 0xD0 mask 0xF3 vrf name1

Related Commands Command Description

service divert-rate-limit non-ip This command sets and limit default values for the specified divert code.

Cisco CMTS Cable Command Reference

1539
 Cable Commands: q through sg
service divert-rate-limit trusted-site-ipv6

service divert-rate-limit trusted-site-ipv6

To add IPv6-specific entries to the trusted site list, use the service divert-rate-limit trusted-site-ipv6 command
in the global configuration mode. To remove all entries from the trusted site list, use the no form of this
command.

service divert-rate-limit trusted-site-ipv6 ip-address traffic-class tc_value mask tc-mask [global |

vrf vrf-name ]
no service divert-rate-limit trusted-site-ipv6

Syntax Description ip-address The source IPv6 address that should be matched.

traffic-classtc_value The 8-bit traffic-class of the trusted site. There are no restrictions on the tc_value.
Example: 0xD0

mask tc-mask The mask to apply to the packet traffic-class and the trusted-site tc_value before testing
if it matches. There are no restrictions on the tc-mask value. Example: 0xF3

vrf vrf-name The virtual route forwarding (VRF) instance to which this trusted site is being applied.
For the global VRF, use the global keyword. To apply the trusted-site to all VRFs
(including the global VRF), hit enter after specifying the tc-mask.

Command Default Disabled

Command Modes
Global configuration (config)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command is used to configure trusted site list that contains an IPv6 source-address/prefix-length, a
traffic-class value and mask, and a VRF. There is a limitation of four trusted sites.

Note The no form of the command is used to remove all entries from the trusted site list. To remove a specific entry
you should specify the matching source IP address. For example: no service divert-rate-limit trusted-site-ipv6
ip-address traffic-class tc_value masktc-mask [ global | vrf vrf-name ].

Examples The following example shows how to configure IPv6 trusted site list:

Router(config)# service divert-rate-limit trusted-site-ipv6 2001:420:3800:800:21F:29FF::1/128

2001:420:3800:800:21F:29FF::1/128 traffic-class 0x3 mask 0xFF global
Router(config)#

Cisco CMTS Cable Command Reference

1540
 Cable Commands: q through sg
service divert-rate-limit trusted-site-ipv6

Related Commands Command Description

show pxf cpu statistics drl us-cable Displays the number of upstream cable packets that are dropped from
the CMTS.

show pxf cpu statistics drl ipv6 Verifies the drop counters for WAN-IPv6 packets.

show pxf cpu statistics drl ipv4 Verifies the drop counters for WAN-IPv4 packets.

Cisco CMTS Cable Command Reference

1541
 Cable Commands: q through sg
service instance

service instance
To configure an Ethernet service instance, use the service instance command in Layer 2 VPN configuration
mode. To disable this configuration, use the no form of this command.

service instance id service-type

no service instance id service-type

Syntax Description id Service instance ID.

service-type Service type for the instance.

Command Default None

Command Modes
Layer 2 VPN configuration (config-l2vpn)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You must provision a Multiprotocol Label Switching (MPLS) pseudowire before configuring an Ethernet
service instance in Layer 2 VPN configuration mode.

Examples The following example shows how to configure an Ethernet service instance on a Cisco uBR10012
router:

Router # configure terminal

Router(config) # cable l2vpn 001e.6bfb.0f9e customer2
Router(config-l2vpn) # service instance 7000 ethernet

Related Commands Command Description

cable l2-vpn-service xconnect Enables the use of Layer 2 tunnels based on an MPLS pseudowire.

Cisco CMTS Cable Command Reference

1542
 Cable Commands: q through sg
service udp-small-servers max-servers no-limit

service udp-small-servers max-servers no-limit

To enable use of minor servers that use the UDP protocol (such as ToD, echo, chargen, and discard), use the
service udp-small-servers max-servers no-limit command in global configuration mode. To remove this
configuration, use the no form of this command.

service udp-small-servers max-servers no-limit

no service udp-small-servers max-servers no-limit

Command Default DHCP or ToD servers are not configured by default.

Command Modes
Global configuration

Command History Release Modification

12.1 EC Command support introduced on the Cisco CMTS.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Disabling the ping option can speed up address assignment when a large number of modems are trying to
connect at the same time. However, disabling the ping option can also result in duplicate IP addresses being
assigned if users assign unauthorized static IP addresses to their CPE devices.

Examples The following example illustrates configuration of this command:

Router# configure terminal

Router(config)# service udp-small-servers max-servers no-limit
Router(config)#

The following example shows a typical ToD server configuration:

service udp-small-servers max-servers no-limit

cable time-server

These are the only commands required to enable the ToD server.

Usage Guidelines The max-servers no-limit option allows a large number of cable modems to obtain the ToD server at one
time, in the event that a cable or power failure forces many cable modems offline. When the problem has been
resolved, the cable modems can quickly reconnect.

Note Do not disable the minor UDP servers if you are also enabling the other DHCP or TFTP servers.

For additional information about DHCP configuration on the Cisco CMTS, refer to the following documents
on Cisco.com:
• Filtering Cable DHCP Lease Queries on the Cisco CMTS
• DHCP and Time-of-Day Services on the Cisco CMTS

Cisco CMTS Cable Command Reference

1543
 Cable Commands: q through sg
service udp-small-servers max-servers no-limit

Related Commands Command Description

cable dhcp-giaddr policy Sets the DHCP giaddr field of DHCP request packets to the primary
address for cable modems and the secondary address for CPE devices,
allowing the use of separate address pools for the different clients.

cable dhcp-parse option (for Enables the parsing of certain DHCP options.
uBR series router)

cable helper-address Enables load-balancing of DHCP requests from cable modems and CPE
devices by specifying different DHCP servers according to the cable
interface or subinterface.

ip dhcp ping packet 0 Instructs the DHCP server to assign an IP address from its pool without
first sending an ICMP ping to test whether a client is already currently
using that IP address.

ip dhcp relay information Configures the DHCP server to validate the relay agent information option
option in forwarded BOOTREPLY messages.

ip dhcp smart-relay Enables the DHCP relay agent on the CMTS to automatically switch a
cable modem or CPE device to a secondary DHCP server or address pool
if the primary DHCP server does not respond to three successive requests.

Cisco CMTS Cable Command Reference

1544
 Cable Commands: q through sg
service-class

service-class
To create a DOCSIS configuration file that specifies the quality-of-service (QoS) service-class options for
the CM configuration file, use the service-class command in cable config-file configuration mode. To disable
the specification, use the no form of this command.

service-class {guaranteed-upstream us-bandwidth | max-burst burst-size | max-downstream

max-dsbandwidth | max-upstream max-usbandwidth | priority priority-num | privacy}
no service-class

Syntax Description class Specifies service class number. The range is 1 to 16. Default value is 1.

guaranteed-upstream Specifies the guaranteed upstream bandwidth in kbps. Valid range for
us-bandwidth us-bandwidth is 0 to 100000 kbps. Default value is 0.

max-burst Specifies the maximum upstream burst size in bytes. Valid range for burst-size
is 0 to 65535. Default value is 0, unlimited burst length. Recommended value
range is 1600 to 1800 bytes. Using a value of 0 or greater than 1800 bytes
can cause latency issues for Voice-over-IP. A value of less than 1500 bytes
prevents upstream transmission of large Ethernet frames for any modem or
CMTS not implementing fragmentation (an optional feature in DOCSIS 1.0).

burst-sizemax-downstream Specifies the downstream bandwidth in kbps. Valid range for

max-dsbandwidth max-dsbandwidth is 0 to 100000 kbps. Default value is 0.

max-upstream Specifies the upstream bandwidth in kbps. Valid range for max-usbandwidth
max-usbandwidth is 0 to 100000 kbps. Default value is 0.

priority priority-num Specifies the service class priority. Valid range for priority-num is 0 to 7,
where 7 is the highest-priority service-class setting.

privacy Enables baseline privacy interface (BPI).

Command Default Service-class is not set by default. A CM cannot register on a Cisco CMTS unless at least one parameter in a
service class is specified.

Command Modes
Cable config-file (config-file)

Command History Release Modification

12.1(2)EC1 This command was introduced.

12.2(4)BC1 This command was integrated into Cisco IOS Release 12.2(4)BC1.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Cisco CMTS Cable Command Reference

1545
 Cable Commands: q through sg
service-class

Usage Guidelines Default values can be used only if service-class class is specified. A single configuration file should not
contain multiple service-class ID numbers. Thus, all parameters should be set using a single service-class ID.
However, different configuration files can reuse the same service-class ID.

Note To enable Baseline Privacy Interface (BPI) operations on the cable command, you must specify both the
service-class privacy and privacy commands for the cable modem’s DOCSIS configuration file.

Examples The following example shows how to specify the service-class command for a DOCSIS configuration
file:

router(config)# cable config-file upgrade.cm

router(config-file)# service-class 1 priority 0
router(config-file)#service-class 1 max-upstream 3247
router(config-file)# service-class 1 max-downstream 10000
router(config-file)# service-class 1 max-burst 1600
router(config-file)# service-class 1 privacy
router(config-file)# privacy

router(config-file)# exit

Related Commands Command Description

cable Creates a DOCSIS configuration file and enters configuration file mode.
config-file

access-denied Disables access to the network.

channel-id Specifies upstream channel ID.

cpe max Specifies CPE information.

download Specifies download information for the configuration file.

frequency Specifies downstream frequency.

option Specifies vendor-specific information fields and other config-file options.

privacy Specifies privacy options for baseline privacy images.

snmp manager Specifies SNMP options.

timestamp Enables time-stamp generation.

Cisco CMTS Cable Command Reference

1546
 Cable Commands: q through sg
service-class (cmts-tag)

service-class (cmts-tag)
To configure the specified service class name for the CMTS tag, use the service-class command in the cmts-tag
configuration mode. To remove the configured service class name from the CMTS tag, use the no form of
this command.

[exclude] service-class service-class-name

no service-class service-class-name

Syntax Description exclude (Optional) Configures the CMTS tag to exclude the specified service class name.

service-class-name Service class name with matching rule

Command Default None

Command Modes
CMTS tag mode (cmts-tag)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to configure the specified service class name for the CMTS tag
using the service-class command:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable tag 1
Router(cmts-tag)# service-class uBR

Related Commands Command Description

cable load-balance docsis-group To configure a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group To display real-time configuration, statistical and operational
information for load balancing operations on the router.

cable tag To configure a tag for a DOCSIS load balancing group on the
CMTS.

Cisco CMTS Cable Command Reference

1547
 Cable Commands: q through sg
service-class (enforce-rule)

service-class (enforce-rule)
To identify a particular service class for cable modem monitoring in an enforce-rule, use the service-class
(enforce-rule) command in enforce-rule configuration mode. To remove the service class from the enforce-rule,
use the no form of this command.

service-class {enforced | registered} name

no service-class {enforced | registered} name

Cisco cBR Series Converged Broadband Routers

service-class { {enforced name [no-persistence] | {registered name } }
no service-class { {enforced name [no-persistence] | {registered name } }

Syntax Description enforced Specifies an enforced service class.

registered Specifies enforcing of QoS profiles for the registered service class.

name Specifies the name of the service class.

no-persistence (Optional) Specifies that the enforced QoS profile should not remain in force when a cable
modem reboots.

Command Default None

Command Modes
Enforce-rule configuration (enforce-rule)

Command History Release Modification

12.3(9a)BC This command was introduced.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.17.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The service-class (enforce-rule) command allows operators to identify the name of the initial registered
service class for a CM in an enforce-rule, and also the name of a new service class to be enforced if the CM
violates its registered service parameters.

Examples The following example shows specification of the enforced service class called “test” in an
enforce-rule:

Router(enforce-rule)# service-class enforced test

The following example shows service class being enforced with no-persistence option on a Cisco
cBR Series Converged Broadband Routers:

Cisco CMTS Cable Command Reference

1548
 Cable Commands: q through sg
service-class (enforce-rule)

Router(enforce-rule)# service-class enforced test1 no-persistence

Related Commands Command Description

cable qos enforce-rule (for uBR Creates an enforce-rule to enforce a particular QoS profile for
series router) subscriber traffic management and enters enforce-rule configuration
mode.

debug cable subscriber-monitoring Displays enforce-rule debug messages for subscriber traffic
management on the Cisco CMTS routers.

duration Specifies the time period and sample rate to be used for monitoring
subscribers.

enabled (enforce-rule) Activates an enforce-rule and begins subscriber traffic management

on a Cisco CMTS router.

monitoring-basics Specifies the type of monitoring desired for subscriber traffic

management on a Cisco CMTS router.

peak-time1 Specifies peak and offpeak monitoring times on a Cisco CMTS router.

qos-profile registered Specifies the registered QoS profile that should be used for this
enforce-rule.

show cable qos enforce-rule Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage Displays subscribers who are violating their registered QoS profiles.

Cisco CMTS Cable Command Reference

1549
 Cable Commands: q through sg
service-descriptor-default

service-descriptor-default
To enable the operator to specify the default values for the service descriptor that will be encoded as part of
the serving area table at chassis level, use the service-descriptor-default command in the video configuration
mode. To disable the feature, use the no form of the command.

service-descriptor-default

Command Default None.

Command Modes Video configuration mode (config-video)

Command History Release Modification

Cisco IOS XE Gibraltar 16.10.1c This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

The following example shows how to enable the feature:

router#configure terminal
router(config)#cable video
router(config-video)#service-descriptor-default
router(config-video-serv-desc)#

Related Commands Command Description

serving-area Configures the serving area which enables the set tops to discover VOD content.

cable video Enters the video configuration mode.

Cisco CMTS Cable Command Reference

1550
 Cable Commands: q through sg
service-distribution-group

service-distribution-group
To define a service distribution group, use the service-distribution-group command in video configuration
mode. To delete a service distribution group, use the no form of this command.

service-distribution-group name
id id
no service-distribution-group name
id id

Syntax Description service-distribution-group name Specifies the service distribution group name.

id id Specifies the service distribution group identifier.

Command Default None.

Command Modes
Video configuration (config-video)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command defines a service distribution group.

Examples The following example shows how to define a service distribution group:

Router#configure terminal
Router(config)#cable video
Router(config-video)#service-distribution-group west-region id 1

Related Commands Command Description

rf-port integrated-cable Specifies the RF port in a service distribution group.

onid Specifies the original network identifier in a service distribution

group.

psi-interval Specifies the program specific information interval in a service

distribution group.

show cable video Displays the service distribution group information.

service-distribution-group all

Cisco CMTS Cable Command Reference

1551
 Cable Commands: q through sg
service-id

service-id
To specify the service ID as part of the service descriptor, use the service-id command in the service descriptor
configuration mode. To revoke the configuration, use the no form of the command.

service-id value

Syntax Description value Specifies the service

ID.

Command Default None.

Command Modes Service descriptor configuration mode (config-video-serv-desc)

Command History Release Modification

Cisco IOS XE Gibraltar 16.10.1c This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

The following example shows how to specify the service ID:

router#configure terminal
router(config)#cable video
router(config-video)#service-descriptor-default
router(config-video-serv-desc)#service-id 1

Related Commands Command Description

serving-area Configures the serving area which enables the set tops to discover VOD content.

service-descriptor-default Enables the operator to specify the default values for the service descriptor.

Cisco CMTS Cable Command Reference

1552
 Cable Commands: q through sg
service-name

service-name
To specify the service name as part of the service descriptor, use the service-name command in the service
descriptor configuration mode. To revoke the configuration, use the no form of the command.

service-name string

Syntax Description string Specifies the service

name.

Command Default None.

Command Modes Service descriptor configuration mode (config-video-serv-desc)

Command History Release Modification

Cisco IOS XE Gibraltar 16.10.1c This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

The following example shows how to specify the service name:

router#configure terminal
router(config)#cable video
router(config-video)#service-descriptor-default
router(config-video-serv-desc)#service-name test

Related Commands Command Description

serving-area Configures the serving area which enables the set tops to discover VOD content.

service-descriptor-default Enables the operator to specify the default values for the service descriptor.

Cisco CMTS Cable Command Reference

1553
 Cable Commands: q through sg
service-type (service descriptor)

service-type (service descriptor)

To specify the service type as part of the service descriptor, use the service-type command in the service
descriptor configuration mode. To revoke the configuration, use the no form of the command.

service-type value

Syntax Description value Specifies the service

type.

Command Default None.

Command Modes Service descriptor configuration mode (config-video-serv-desc)

Command History Release Modification

Cisco IOS XE Gibraltar 16.10.1c This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

The following example shows how to specify the service type:

router#configure terminal
router(config)#cable video
router(config-video)#service-descriptor-default
router(config-video-serv-desc)#service-type 2

Related Commands Command Description

serving-area Configures the serving area which enables the set tops to discover VOD content.

service-descriptor-default Enables the operator to specify the default values for the service descriptor.

Cisco CMTS Cable Command Reference

1554
 Cable Commands: q through sg
service-type (virtual carrier group)

service-type (virtual carrier group)

To specify the service type of a virtual carrier group, use the service-type command in virtual carrier group
configuration mode. To undo the service type assignment, use the no form of this command.

service-type {narrowcast | broadcast}

no service-type {narrowcast | broadcast}

narrowcast Specifies video on demand and/or switched digital video service type. These narrowcast service
types can share the same virtual carrier group.

broadcast Specifies the broadcast service type.

Command Default Narrowcast service type

Command Modes
Virtual carrier group configuration (config-video-vcg)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command specifies the service type of a virtual carrier group to be enabled on the linecard.

Examples The following example shows how to specify the service type of a virtual carrier group:

Router# configure terminal

Router(config)# cable video
Router(config-video)# virtual-carrier-group vod id 1
Router(config-video-vcg)# service-type broadcast

Related Commands Command Description

virtual-carrier-group Defines a virtual carrier group.

virtual-edge-input-ip Defines a virtual edge input.

encrypt Enables encryption on the virtual carrier group.

rf-channel Specifies the virtual RF channels in a virtual carrier group.

show cable video virtual-carrier-group Displays the virtual carrier group information.

Cisco CMTS Cable Command Reference

1555
 Cable Commands: q through sg
service-type-id (load-balance)

service-type-id (load-balance)
To add a service type ID that is compared against the cable modem provisioned service type ID, to determine
an appropriate restricted load balancing group (RLBG), use the service-type-id command in the config-lb-group
configuration mode. To remove the service type ID, use the no form of this command.

service-type-id string
no service-type-id string

Syntax Description string Identifier of the service type that gets added to the load balancing group.

Command Default No default behavior or values.

Command Modes
DOCSIS load balancing group mode (config-lb-group)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines You can use the service-type-id command to add a service type ID only to a RLBG.

Examples The following example shows how to add a service type ID on the CMTS, using the service-type-id
command.

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# restricted
Router(config-lb-group)# service-type-id commercial
Router(config-lb-group)# no service-type-id commercial
Router(config-lb-group)#

Related Commands Command Description

cable load-balance docsis-group Configures a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group Displays real-time configuration, statistical, and operational
information for load balancing operations on the router.

Cisco CMTS Cable Command Reference

1556
 Cable Commands: q through sg
service-type-id (cmts-tag)

service-type-id (cmts-tag)
To configure the specified service type ID for the CMTS tag, use the service-type-id command in the cmts-tag
configuration mode. To remove the service type ID, use the no form of this command.

[exclude] service-type-id service-type-id

no service-type-id service-type-id

Syntax Description exclude (Optional) Configures the CMTS tag to exclude the specified service type ID.

service-type-id Sets a matching rule with the specified service type ID.

Command Default None

Command Modes
CMTS tag mode (cmts-tag)

Command History Release Modification

12.2(33)SCC This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows how to configure the specified service type ID for the CMTS tag using
the service-type-id command:

Router# configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable tag 1
Router(cmts-tag)# service-type-id commercial

Related Commands Command Description

cable load-balance docsis-group To configure a DOCSIS load balancing group on the CMTS.

show cable load-balance docsis-group To display real-time configuration, statistical and operational
information for load balancing operations on the router.

cable tag To configure a tag for a DOCSIS load balancing group on the
CMTS.

Cisco CMTS Cable Command Reference

1557
 Cable Commands: q through sg
serving-area

serving-area
To configure the serving area which enables the set tops to discover VOD content, use the serving-area
command in the service distribution group configuration mode. To revoke the configuration, use the no form
of the command.

serving-area value

Syntax Description value Specifies the serving-area at SDG level.

Command Default None.

Command Modes Service distribution group configuration mode (config-video-sdg)

Command History Release Modification

Cisco IOS XE Gibraltar 16.10.1c This command was introduced on the Cisco cBR Series Converged
Broadband Routers.

The following example shows how to configure the serving area:

router#configure terminal
router(config)#cable video
router(config-video)#service-distribution-group sdg id 1
router(config-video-sdg)#serving-area 100

Related Commands Command Description

service-distribution-group Defines a service distribution group.

show cable video service-distribution-group Displays the SDG configuration.

Cisco CMTS Cable Command Reference

1558
 Cable Commands: q through sg
session

session
To configure a table based video session, use the session command in session configuration mode. To disable
the configuration, use the no form of this command.

Note Before configuring the table-based video sessions, you must configure the physical and virtual constructs for
Cisco cBR-8. You must also configure the Logical Edge Device (LED), Service Distribution Group (SDG),
binding and Virtual Carrier Group (VCG).

session sess-name {input-port number | bundle-id number }start-udp-port number num-sessions-per-qam

number processing-type {programdata}start-program program-num [repeat]jitter ms [cbr | vbr]
no session sess-name {input-port number | bundle-id number }start-udp-port number
num-sessions-per-qam number processing-type {programdata}start-program program-num [repeat]
jitter ms [cbr | vbr]

Cisco cBR Series Converged Broadband Routers

session sess-name multicast-label multicast label input-port vei-number group group_ip source source_ip
processing-type {remappassthrudataremux}start-program program-num [bit-rate bit-rate_number ][jitter
ms ][cbr | vbr] input-program-num num output-program-num num
no session sess-name multicast-label multicast label input port vei-number group group_ip source source_ip
processing-type {remappassthrudataremux}start-program program-num [bit-rate bit-rate_number ][jitter
ms ][cbr | vbr] input-program-num num output-program-num num

Syntax Description sess-name Specifies the session name for the table-based session.

multicast label Specifies the multicast label name.

input-port vei-number Specifies the virtual edge input port number.

group group-ip Specifies the group name for the table-based session.

input-port number Specifies the input port number for the table-based session.

bundle-id number Specifies the virtual edge input bundle ID.

start-udp-port number Specifies the UDP port number.

num-sessions-per-qam number Specifies the number of sessions per QAM. The valid range is from 1 to
80.

Cisco CMTS Cable Command Reference

1559
 Cable Commands: q through sg
session

processing-type Specifies the processing type of session.

program—Configures video session as program.
data—Configures video streams that are not dejittered, and remapped.
remap—Configures video streams that are remapped.
passthru—Configures video streams that are passthrough.
remux—Configures video streams that are remultiplexed. This processing
type allows you to specify a program in a multi-program transport stream
(MPTS) input session, renumber it, and send it to an output session.

start-program program-num Specifies the starting program number. The valid range is from 1 to 65535.

bit-rate bit-rate-number Specified the bits per second.

jitter ms Specifies the jitter value in milliseconds. The valid range is from 10 to 200.

input-program-num num Specifies the input program number. This is applicable only for remux
sessions. The allowed range of program numbers is 1–65535.

output-program-num num Specifies the output program number. This is applicable for remap and
remux sessions. The allowed range of program numbers is 1–65535.

Command Default None

Command Modes Session configuration (config-video-tb-vcg-sess)

Command History Release Modification

IOS-XE 3.18.0S This command is introduced on the Cisco cBR Series Converged Broadband Routers.

IOS-XE This command was modified on the Cisco cBR Series Converged Broadband Routers.
3.18.0SP .

IOS-XE 16.8.1 The remux and the input-program-num keywords were added.

Usage Guidelines This command configures a table based video session.

Examples The following example shows how to configure the virtual carrier group and service distribution
group for replication:

Router# configure terminal

Router(config)# cable video
Router(config-video)# table-based
Router(config-video-tb)# vcg pme_tbv
Router(config-video-tb-vcg)# rf-channel 20-22
Router(config-video-tb-vcg-sess)# session bago_tbv input-port 10 start-udp-port 1
num-sessions-per-qam 2 processing-type remap start-program 1 jitter 100 cbr

The following example shows how to configure the virtual carrier group with passthru processing
type:

Cisco CMTS Cable Command Reference

1560
 Cable Commands: q through sg
session

Router#configure terminal
Router(config)#cable video
Router(config-video)#table-based
Router(config-video-tb)# multicast-label a2 group 232.5.6.7 source 175.2.5.6
Router(config-video-tb)#multicast-label exampleLabel group 232.2.1.6 source 175.6.1.13
source2 175.6.1.12 source3 180.1.1.1 source4 175.6.1.14
Router(config-video-tb)#vcg VCG_PME4
Router(config-video-tb-VCG_PME4)#rf-channel 24
Router(config-video-tb-VCG_PME4-sess)#session SESS_PME4 group 232.5.6.15 source 175.2.6.7
processing-type passthru

The following example shows how to configure a session with remux processing type:
Router# session remux1 group 209.165.200.225 source 192.0.2.1 processing-type remux
input-program-num 1 output-program-num 1

The following example shows how to see the remux sessions with input and output program numbers:
Router#sh cable video session log id 31
Total Sessions = 80

Session Output Frequency Streaming Sess Session Source UDP Input Output Input
Output Input Output Encrypt Encrypt Low PMV Session
Id Port Hz Type Type Ucast Dest IP Port Program Program State
State Bitrate Bitrate Type Status Lat NUM Name
/Mcast IP (S,G)

--------------------------------------------------------------------------------------------------------------------------------------------------------------
32505897 54 825000000 Remux SSM 192.0.2.1,234.1.1.1 0 1 1 ACTIVE-PSI
ON 65088810 65684765 CLEAR - N - remux1.9.5015
32505898 54 825000000 Remux SSM 192.0.2.1,234.1.1.1 0 2 2 ACTIVE-PSI
ON 65088810 65684765 CLEAR - N - remux2.9.5015
32505899 54 825000000 Remux SSM 192.0.2.1,234.1.1.1 0 3 3 ACTIVE-PSI
ON 65088810 65684765 CLEAR - N - remux3.9.5015
32505900 54 825000000 Remux SSM 192.0.2.1,234.1.1.1 0 4 4 ACTIVE-PSI
ON 65088810 65684765 CLEAR - N - remux4.9.5015
32505901 54 825000000 Remux SSM 192.0.2.1,234.1.1.1 0 5 5 ACTIVE-PSI
ON 65088810 65684765 CLEAR - N - remux5.9.5015

Related Commands Command Description

virtual-carrier-group Defines a virtual carrier group.

service-distribution-group Defines a service distribution group.

rf-port integrated-cable Specifies the RF ports in a service distribution group.

rf-channel Specifies the virtual RF channels in a virtual carrier group.

bind-vcg Binds a set of virtual RF-channels defined in the virtual carrier group to the
physical port in the service distribution group.

Cisco CMTS Cable Command Reference

1561
 Cable Commands: q through sg
session name multicast-label

session name multicast-label

The Cisco cBR Series Converged Broadband Routers supported two clock recovery modes: VBR and CBR.
Both VBR and CBR modes use one phase-locked loop (PLL) to recover the program clock, using all the PCR
packet identifiers (PIDs) found in content. Hence, for MPTS sessions with a large number of programs, the
PCRs may have different clock frequencies and be of poor quality. This lead to excessive overdue drops and
bad output video quality.
The Clock Recovery Mechanism is a new third clock recovery mode, supported from Cisco IOS XE Gibraltar
17.3.1x, and can handle this type of content with better results. The Clock Recovery Mechanism uses one
phase-locked loop (PLL) to recover the program clock, using only one PCR PID as the primary. All the other
PCR PIDs are subordinates and are re-timed using the clock recovered from the primary PCR PID. The output
will be good if the primary PCR is of good quality.

session name multicast-label label processing-type type primary-subordinate [ pcr-pid <pid> ]

Syntax Description Parameter Description

name Specifies the session name

label Specifies the multicast label name

type Specifies the processing type of session.

pcr-pid <pid> This is an optional parameter, and allows you to select

a desired PCR-pid to be used for the primary PCR
PID

Command Default None

Command Modes Service distribution group configuration mode (config-video-sdg)

Command History Release Modification

Cisco IOS XE Gibraltar 17.3.1x The Clock Recovery Mechanism command was introduced on the Cisco
cBR Series Converged Broadband Routers.

The keyword primary-subordinate selects primary-subordinate Clock Recovery Mechanism for the session.
One of the PCR PIDs is selected to serve as the primary PID. The selected PID is the first PCR PID found in
the content, or first one found after a buffer overflow or underflow handling. The Clock Recovery Mechanism
is available for both unicast and multicast sessions, for session of processing types remap, passhthru and
remux. They are not available for data-piping sessions.

Note If the primary PCR PID is not configured, or is absent in the content, one of the PCR PIDs is selected to serve
as the primary PID. The selected PID is the first PCR PID found in the content, or first one found after a buffer
overflow or underflow handling.

Usage Guidelines To recover the overdue drops, you can configure the Clock Recovery Mechanism.

Cisco CMTS Cable Command Reference

1562
 Cable Commands: q through sg
session name multicast-label

Examples The following example shows how to configure the Clock Recovery Mechanism under cable video
configuration:
Router# conf t
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# cable video
Router(config-video)# table-based
Router(config-video-tb)# $source3 175.10.3.2 source4 175.10.4.2
Router(config-video-tb)# vcg v2
Router(config-video-tb-vcg)# rf-channel 68
Router(config-video-tb-vcg-sess)#$ session check input-port 1 start-udp-port 1523
processing-type remux input-program-num 1 output-program-num 1 primary-subordinate pcr-pid
50
Router(config-video-tb-vcg-sess)# exit
Router(config-video-tb-vcg)# exit
Router(config-video-tb)# exit
Router(config-video)# exit
Router(config)#

Cisco CMTS Cable Command Reference

1563
 Cable Commands: q through sg
session-range

session-range
To identify the multicast QoS group session range, use the session-range command in multicast QoS
configuration mode. To disable the QoS group session range, use the no form of this command.

session-range ip-address ip-mask

no session-range ip-address ip-mask

Syntax Description ip-address Specifies the IP address of the multicast QoS group.

ip-mask Specifies the IP mask of the multicast QoS group.

Command Default A session range IP address and IP mask are not defined for a specific multicast QoS group.

Command Modes
Multicast QoS configuration (config-mqos)

Command History Release Modification

12.2(33)SCA This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the session-range command to configure the session range to specify the number of multicast sessions
to be admitted on a particular service flow. CMTS does not admit new sessions (no forwarding) if the current
number of sessions has reached the defined limit, and waits until a session ends to free up a slot for new
sessions. You can configure multiple session ranges.

Examples The following example defines a session range IP address and IP mask using the session-range
command:

Router(config)# cable multicast qos group 20 priority 55 global

Router(config-mqos)# session-range 224.10.10.01 255.255.255.254

Related Commands Command Description

cable multicast qos group Specifies and configures a cable multicast QoS group.

show interface bundle multicast-sessions Displays multicast session information for a specific virtual
cable bundle.

show interface cable multicast-sessions Displays multicast session information for a specific cable
interface.

Cisco CMTS Cable Command Reference

1564
 Cable Commands: q through sg
set clock

set clock
To set the system clock on the Cisco CMTS, use the set clock command in global configuration mode.

set clock time-date

Syntax Description time-date Time and date for which to set the clock on the Cisco CMTS.

Command Default Time-of-Day, DHCP, and TFTP server configuration not defined on the Cisco CMTS by default.

Command Modes
Global configuration

Command History Release Modification

12.0(4)XI This feature was introduced for the Cisco uBR7200 series routers.

12.1(5)EC This feature was supported on the Cisco uBR7100 series routers.

12.2(4)BC1 This feature was supported on the Release 12.2 BC train for all Cisco CMTS platforms.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines To supply an accurate clock, the system clock on the Cisco CMTS should be configured for the correct time,
either by using the set clock command or by configuring the Cisco CMTS to act as a Network Time Protocol
(NTP) or Simple Network Time Protocol (SNTP) client.
For proper operation of the DOCSIS network, especially a DOCSIS 1.1 network using BPI+ encryption and
authentication, the system clock on the Cisco CMTS must be set accurately. You can achieve this by manually
using the set clock command, or by configuring the CMTS to use either the Network Time Protocol (NTP)
or the Simple Network Time Protocol (SNTP).
For additional information about the set clock command, refer to the following documents on Cisco.com:
• http://www.cisco.com/en/US/docs/ios/cable/configuration/guide/cmts_services.html#wp1051747
Time-of-Day Server for the Cisco CMTS
• http://www.cisco.com/en/US/docs/ios/cable/configuration/guide/cmts_services.html DHCP, ToD, and
TFTP Services for the Cisco Cable Modem Termination System

Related Commands Command Description

cable dhcp-giaddr policy Sets the DHCP giaddr field of DHCP request packets to the primary address
for cable modems and the secondary address for CPE devices, allowing the
use of separate address pools for the different clients.

cable dhcp-parse option Enables the parsing of certain DHCP options.

cable helper-address Enables load-balancing of DHCP requests from cable modems and CPE
devices by specifying different DHCP servers according to the cable
interface or subinterface.

Cisco CMTS Cable Command Reference

1565
 Cable Commands: q through sg
set clock

Command Description

ip dhcp ping packet 0 Instructs the DHCP server to assign an IP address from its pool without
first sending an ICMP ping to test whether a client is already currently using
that IP address.

ip dhcp relay information Configures the DHCP server to validate the relay agent information option
option in forwarded BOOTREPLY messages.

ip dhcp smart-relay Enables the DHCP relay agent on the CMTS to automatically switch a cable
modem or CPE device to a secondary DHCP server or address pool if the
primary DHCP server does not respond to three successive requests.

Cisco CMTS Cable Command Reference

1566
Cable Commands: show a through show cable l
• show application-buckets, on page 1569
• show bridge cable-modem, on page 1571
• show cable acfe controller, on page 1573
• show cable acfe interface, on page 1576
• show cable acfe summary, on page 1579
• show cable active-reman, on page 1581
• show cable admission-control, on page 1584
• show cable admission-control fiber-node , on page 1592
• show cable arp-filter, on page 1593
• show cable asf-qos-profile, on page 1601
• show cable bgsync, on page 1603
• show cable bgsync sync-info cable, on page 1607
• show cable bundle, on page 1611
• show cable bundle multicast, on page 1614
• show cable burst-profile, on page 1616
• show cable calls, on page 1618
• show cable card , on page 1620
• show cable cgd-associations, on page 1623
• show cable channel-group, on page 1625
• show cable clock, on page 1628
• show cable clock dti counters, on page 1634
• show cable clock dti status, on page 1635
• show cable cmc, on page 1636
• show cable cmts-id, on page 1646
• show cable depi multicast, on page 1647
• show cable device access-group, on page 1649
• show cable downstream controller-profile, on page 1652
• show cable dp aqm, on page 1653
• show cable dp pfg, on page 1655
• show cable dp queue, on page 1656
• show cable dsg, on page 1658
• show cable dsg cfr, on page 1662
• show cable dsg host, on page 1667

Cisco CMTS Cable Command Reference

1567
 Cable Commands: show a through show cable l

• show cable dsg static-group bundle, on page 1669

• show cable dsg tg, on page 1671
• show cable dsg tunnel, on page 1674
• show cable dynamic-qos trace, on page 1681
• show cable dynamic-bonding-group, on page 1683
• show cable entropy status, on page 1690
• show cable fiber-node, on page 1691
• show cable filter, on page 1697
• show cable flap-list, on page 1702
• show cable flap-list reset-cm-list, on page 1713
• show cable flap-list wb-rf, on page 1714
• show cable freq-profile, on page 1717
• show cable hop, on page 1720
• show cable host access-group, on page 1725
• show cable ib-ipc, on page 1727
• show cable ipc-stats, on page 1728
• show cable ipv6 leasequery-filter, on page 1732
• show cable ipv6 leasequery-stats, on page 1733
• show cable l2-vpn dot1q-nsi-redundancy, on page 1734
• show cable l2-vpn dot1q-vc-map, on page 1736
• show cable l2-vpn vc-map, on page 1741
• show cable l2-vpn xconnect, on page 1743
• show cable leasequery-filter, on page 1748
• show cable leasequery-stats, on page 1752
• show cable licenses all, on page 1753
• show cable licenses cpb, on page 1756
• show cable license wan, on page 1758
• show cable load-balance, on page 1759
• show cable load-balance docsis-group, on page 1771
• show cable logging, on page 1804

Cisco CMTS Cable Command Reference

1568
 Cable Commands: show a through show cable l
show application-buckets

show application-buckets
To displays rules for any or all buckets supporting Service Flow Admission Control on the Cisco CMTS, use
the show application-buckets command in privileged EXEC mode. The configured rules for any given bucket
are displayed in order of precedence in the Rule field.

show application-buckets [bucket-no n]

Syntax Description bucket-no n You may specify a specific bucket number on the Cisco CMTS to display parameters for that
bucket and no others. Valid range is 1 to 8, or all buckets if no specific bucket is designated.

Command Default No default behavior or values for this command. However, Cisco IOS Release 12.3(21)BC supports default
operation and non-default configuration for feature on the Cisco CMTS.

Command Modes
Privileged EXEC

Command History Release Modification

12.3(21)BC This command was introduced for the Cisco uBR10012 router and the Cisco uBR7246VXR
router.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines For additional information for Service Flow Admission Control, commencing in Cisco IOS Release 12.3(21)BC,
refer to the following document on Cisco.com:
• Service Flow Admission Control for the Cisco Cable Modem Termination System

Examples The following example illustrates sample output of the show application-buckets command.

Router# show cable application-type

For bucket 1, Name PktCable

Packetcable normal priority gates
Packetcable high priority gates
For bucket 2, Name PCMM-Vid
PCMM gate app-id = 30
For bucket 3, Name Gaming
PCMM gate app-id = 40
For bucket 4, Name
For bucket 5, Name
For bucket 6, Name
For bucket 7, Name
For bucket 8, Name HSD
Best-effort (CIR) flows

Cisco CMTS Cable Command Reference

1569
 Cable Commands: show a through show cable l
show application-buckets

Related Commands Command Description

cable admission-control Sets minor, major and exclusive thresholds for downstream voice
ds-bandwidth or data bandwidth for each or all interfaces on the Cisco CMTS

cable admission-control preempt Changes the default PacketCable Emergency 911 call preemption
priority-voice functions on the Cisco CMTS, supporting throughput and bandwidth
requirements for Emergency 911 calls above all other buckets on
the Cisco CMTS.

cable admission-control Configures global or interface-level upstream bandwidth thresholds

us-bandwidth and exclusive or non-exclusive resources on the Cisco CMTS.

cable application-type include Associates an application type with a specific and prioritized bucket
on the Cisco CMTS.

cable application-type name Assigns an alpha-numeric name for the specified bucket.

debug cable admission-control Displays service flow categorization results, enabled when a service
flow-categorization flow is classified.

show application-buckets Displays rules for any or all buckets supporting Service Flow
Admission Control on the Cisco CMTS.

show interface cable Displays service flows, categorizations, and bandwidth consumption
admission-control reservation on the Cisco CMTS, for the specified interface, and the specified
service flow direction.

Cisco CMTS Cable Command Reference

1570
 Cable Commands: show a through show cable l
show bridge cable-modem

show bridge cable-modem

To display bridging information for the router’s cable interface, use the show bridge cable-modem command
in privileged EXEC mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter

show bridge cable-modem number

Syntax Description number Identifies the cable interface (always 0).

Command Default No default behavior or values.

Command Modes
Privileged EXEC

Command History Release Modification

11.3(4)NA This command was introduced for the Cisco uBR904 cable access router.

12.0(4)XI1 Support was added for the Cisco uBR924 cable access router.

12.1(3)XL Support was added for the Cisco uBR905 cable access router.

12.1(5)XU1 Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA Support was added for the Cisco uBR925 cable access router.

Examples The following example shows sample output for this show bridge cable-modem command:

Router#

show bridge cable-modem 0

Total of 300 station blocks, 298 free

Codes: P - permanent, S - self
Bridge Group 59:

Table 38: show bridge cable-modem Field Descriptions

Field Description

Total of 300 station Total number of forwarding database elements in the system. The memory to hold
blocks bridge entries is allocated in blocks of memory sufficient to hold 300 individual
entries. When the number of free entries falls below 25, another block of memory
sufficient to hold another 300 entries is allocated. Thus, the total number of
forwarding elements in the system is expanded dynamically, as needed, limited
by the amount of free memory in the router.

Bridge Group The number of the bridge group to which this interface is assigned.

Cisco CMTS Cable Command Reference

1571
 Cable Commands: show a through show cable l
show bridge cable-modem

Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using
the exec prompt timestamp command in line configuration mode.

Related Commands Command Description

show dhcp Displays the current DHCP settings on point-to-point interfaces.

show interfaces cable-modem Displays information about the cable interface.

Cisco CMTS Cable Command Reference

1572
 Cable Commands: show a through show cable l
show cable acfe controller

show cable acfe controller

To display fairness across DOCSIS interfaces controller statistics, use the show cable acfe controller command
in privileged EXEC mode.

show cable acfe controller modular-cable slot/subslot/unit [cluster cluster-index]

Cisco cBR Series Converged Broadband Routers

show cable acfe controller Integrated-Cable slot/subslot/unit [cluster cluster-index]

Syntax Description modular-cable Displays information for all controllers on the specified modular cable interface
slot/subslot/unit on a Cisco uBR10012 router, where:
• slot—Controller slot number. The range is from 0 to 8.
• subslot—Controller subslot number. The range is from 0 to 3.
• unit—Controller unit number. The valid value is 0.

Integrated-Cable Displays information for all controllers on the specified integrated cable interface
slot/subslot/port on a Cisco cBR series router, where:
• slot—Controller slot number. The range is from 0 to 3 and 6 to 9 on the
Cisco cBR-8 router.
• subslot—Controller subslot number. The valid value is 0 on the Cisco cBR-8
router.
• port—Controller port number. The range is from 0 to 7 on the Cisco cBR-8
router.

cluster cluster-index Displays information at the cluster level.

• cluster-index—Cluster index. The range is from 0 to 253 on a Cisco
uBR10012 router, and 0 to 1021 on a Cisco cBR series router.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The Integrated-Cable keyword was added and modular-cable keyword was removed.

Usage Guidelines Use the show cable acfe controller command to show fairness across DOCSIS interfaces status and statistics
for each controller interface.

Examples The following example shows a sample output of the show cable acfe controller command on a
Cisco uBR10012 router:

Router# show cable acfe controller modular-Cable 1/0/0

Cisco CMTS Cable Command Reference

1573
 Cable Commands: show a through show cable l
show cable acfe controller

EIR Rebalance invoked: 76476

Adaptive CIR granted: 0
Adaptive CIR rejected: 0
Total clusters: 2
RF FlexBW
0 28687
1 28687
RF FlexBW
2 28687
3 28687

The following example shows a sample output of the show cable acfe controller command with
the cluster keyword on a Cisco uBR10012 router:

Router# show cable acfe controller modular-Cable 1/0/0 cluster 1

EIR Rebalance invoked: 1810
Adaptive CIR granted: 0
Adaptive CIR rejected: 0
Total clusters: 2
RF FlexBW
2 28687
3 28687

The following example shows a sample output of the show cable acfe controller command on a
Cisco cBR-8 router:
Router# show cable acfe controller integrated-Cable 1/0/0
EIR Rebalance invoked: 450963
Adaptive CIR granted: 20
Adaptive CIR rejected: 1
Total clusters: 9
RF FlexBW
8 36376
9 36376
10 32625

The following example shows a sample output of the show cable acfe controller command with
the cluster keyword on a Cisco cBR-8 router:
Router# show controllers integrated-Cable 1/0/0 acfe cluster 0
Integrated-Cable 1/0/0 status:
Topology changed: No
========Cluster 0========
Number of RF: 2
RF FlexBW WB ExcessBW Quanta
0 35625 - 35438 35438
0 187 187
1 35250 0 35250 35250
Number of BG: 2
Intf Demand CIR Max CstrMin Alloc NBonus Ratio
WB0 1000 0 70875 35250 35437 35438 14855190400
IC0 1000 0 35625 0 35438 187 14855609600

Table 39: show cable acfe controller Field Descriptions

Field Description

EIR Rebalance invoked Number of EIR rebalance invoked.

Cisco CMTS Cable Command Reference

1574
 Cable Commands: show a through show cable l
show cable acfe controller

Field Description

Adaptive CIR granted Number of CIRs granted.

Adaptive CIR rejected Number of CIRs rejected.

Total Clusters Cluster numbers.

RF RF channel number.

FlexBW Flexible bandwidth.

Intf Interface number.

Demand EIR demand.

CIR CIR.

Max Maximum bonus bandwidth allocation.

CstrMin Minimum bonus bandwidth considering CIR.

Alloc Allocated bandwidth.

NBonus Non-guaranteed bonus bandwidth.

Ratio Ratio between allocated bandwidth and demand.

Related Commands Command Description

show cable acfe interface Displays fairness across DOCSIS interfaces statistics of a specific interface.

show cable acfe summary Displays fairness across DOCSIS interfaces status and statistics.

Cisco CMTS Cable Command Reference

1575
 Cable Commands: show a through show cable l
show cable acfe interface

show cable acfe interface

To display the fairness across DOCSIS interfaces statistics of a specific interface, use the show cable acfe
interface command in privileged EXEC mode.

Cisco uBR Series Router

show cable acfe interface {modular-cable | wideband-cable |

integrated-cable}slot/subslot/port:interface-num [verbose]

Cisco cBR Series Router

show cable acfe interface {wideband-cable | integrated-cable}slot/subslot/port:interface-num [verbose]

Syntax Description interface Specifies the cable interface.

• modular-cable—Specifies the modular cable interface.
• wideband-cable—Specifies the wideband cable interface.
• integrated-cable—Specifies the integrated cable interface.
• slot—Slot number of the cable interface. The valid range is from 5 to 8 for uBR series router,
0 to 9 for cBR series router.
• subslot—Subslot number of the cable interface. The valid values are 0 or 1 for uBR series
router, 0 for cBR series router.
• port—Port number. The valid values are 0 or 1 for uBR series router, 0 to 7 for cBR series
router.
• interface-num—Interface number.
• For uBR series router, the valid range is from 0 to 23 for modular interface, 0 to 31 for
the wideband interface, and 0 to 3 for the integrated interface.
• For cBR series router, the valid range is from 0 to 63 for the wideband interface, and 0
to 157 for the integrated interface.

verbose (Optional) Enables verbose mode for the output, giving additional details about the modular,
wideband or integrated interfaces.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The modular-cable was removed.

Cisco CMTS Cable Command Reference

1576
 Cable Commands: show a through show cable l
show cable acfe interface

Usage Guidelines Use the show cable acfe interface command to display the fairness across DOCSIS interfaces statistics on a
specific interface. For uBR series router, the command output also displays the route processor Service Flow
Admission Control (SFAC) shadow with thresholds and reservations.
For uBR series router, the integrated-cable option works only on the Cisco UBR-MC20X20V cable interface
line cards.

Examples The following examples show sample outputs of the show cable acfe interface command in uBR
series router:

Router# show cable acfe interface modular-Cable 1/0/0:1

Adaptive CIR granted: 0
Adaptive CIR rejected: 0
EIR Demand (raw/scale): 0/1
EIR Per-Flow BW (kbps): 18991
Guar Bonus BW (kbps): 18991
Non-guar Bonus BW (kbps): 9696
Reserved Bonus BW (kbps): 0
Router# show cable acfe interface wideband-Cable 1/0/0:1
Adaptive CIR granted: 0
Adaptive CIR rejected: 0
EIR Demand (raw/scale): 0/1
EIR Per-Flow BW (kbps): 18991
Guar Bonus BW (kbps): 19391
Non-guar Bonus BW (kbps): 37983
Reserved Bonus BW (kbps): 400
Router# show cable acfe interface integrated-Cable 6/1/0:0
Adaptive CIR granted: 0
Adaptive CIR rejected: 0
EIR Demand (raw/scale): 0/1
EIR Per-Flow BW (kbps): 20028
Guar Bonus BW (kbps): 20028
Non-guar Bonus BW (kbps): 10009
Reserved Bonus BW (kbps): 0

The following examples show sample outputs of the show cable acfe interface command in cBR
series router:

Router# show cable acfe interface integrated-Cable 1/0/0:16

EIR Demand (raw/scale): 1/1000
Per-Flow EIR BW (kbps): 7200
Guar Bonus BW (kbps): 7200
Non-guar Bonus BW (kbps): 0
Reserved Bonus BW (kbps): 0
Cir total (kbps): 0
Cir unicast (kbps): 0
Cir multicast (kbps): 0
Router# show cable acfe interface wideband-Cable 1/0/0:1
EIR Demand (raw/scale): 1/1000
Per-Flow EIR BW (kbps): 94800
Guar Bonus BW (kbps): 94800
Non-guar Bonus BW (kbps): 60302
Reserved Bonus BW (kbps): 0
Cir total (kbps): 224
Cir unicast (kbps): 224
Cir multicast (kbps): 0

This table describes the significant fields shown in the display.

Cisco CMTS Cable Command Reference

1577
 Cable Commands: show a through show cable l
show cable acfe interface

Table 40: show cable acfe interface Field Descriptions

Field Description

Adaptive CIR granted For uBR series router, number of adaptive CIRs granted.

Adaptive CIR rejected For uBR series router, number of adaptive CIRs rejected.

EIR Demand (raw/scale) Total EIR demand.

EIR Per-Flow BW (kbps) Expected saturated throughput of a priority 0 BE flow on this interface.

Guar Bonus BW (kbps) Guaranteed bonus bandwidth, in kilobytes per second.

Non-guar Bonus BW (kbps) Non-guaranteed bonus bandwidth, in kilobytes per second.

Reserved Bonus BW (kbps) Reserved bonus bandwidth, in kilobytes per second.

Related Commands Command Description

show cable acfe controller Displays fairness across DOCSIS interfaces controller statistics.

show cable acfe summary Displays fairness across DOCSIS interfaces status and statistics.

Cisco CMTS Cable Command Reference

1578
 Cable Commands: show a through show cable l
show cable acfe summary

show cable acfe summary

To display the fairness across DOCSIS interfaces status and statistics, use the show cable acfe summary
command in privileged EXEC mode.

show cable acfe summary

Syntax Description This command has no arguments or keywords.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The CIR Oversubscriptions item was added in the command output.

Usage Guidelines The show cable acfe summary command displays the global fairness across DOCSIS interfaces status and
statistics.

Examples The following example shows a sample output of the show cable acfe summary command for uBR
series router:

Router# show cable acfe summary

ACFE state: Enabled

EIR Rebalance period (secs): 5
EIR Rebalance invocations: 32416
CIR Acquire invocations: 1
CIR Acquire rate/limit: 100/100
CIR Acquire throttled: 0
Maximal EIR ratio: 16

The following example shows a sample output of the show cable acfe summary command for cBR
series router:

Router# show cable acfe summary

ACFE state: Enabled

EIR Rebalance period (secs): 5
EIR Rebalance invocations: 153243
CIR Acquire rate/limit: 100/100
CIR Acquire invocations: 0
CIR Acquire throttled: 0
CIR Oversubscriptions: 8
Maximal EIR ratio: 10

This table describes the significant fields shown in the display.

Cisco CMTS Cable Command Reference

1579
 Cable Commands: show a through show cable l
show cable acfe summary

Table 41: show cable acfe summary Field Descriptions

Field Description

ACFE state Fairness across DOCSIS interfaces state, enabled or disabled.

EIR Rebalance period (secs) EIR rebalance period, in seconds.

EIR Rebalance invocations Number of EIR rebalance invocations.

CIR Acquire invocations Number of CIR acquire invocations.

CIR Acquire rate/limit CIR acquire rate and limit.

CIR Acquire throttled Number of CIR acquisitions that failed because they reached the rate limit.

Maximal EIR ratio Maximum EIR ratio.

CIR Oversubscriptions For cBR series router, number of CIR oversubscription times.

Related Commands Command Description

cable acfe Enables Fairness Across DOCSIS Interfaces feature on the CMTS router.
enable

Cisco CMTS Cable Command Reference

1580
 Cable Commands: show a through show cable l
show cable active-reman

show cable active-reman

To display the line card high availability information, use the show cable active-reman command in privileged
EXEC mode.

show cable active-reman {allslot/subslot}

Syntax Description all Displays high availability information for all line card interfaces.

slot Cable interface line card slot. The valid range is from 5 to 8.

subslot Cable interface line card subslot. The valid range is 0 and 1.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCF This command was introduced in Cisco IOS Release 12.2(33)SCF.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following is a sample output of the show cable active-reman command that shows high availability
information for all cable interfaces on the Cisco uBR10012 router:

Router# show cable active-reman all

-------------------------------------------------------------
Active Reman info on LC 5/0:
[slot_index 0]: work_slot:1/0, active_slot:1/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 1]: work_slot:3/0, active_slot:3/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 2]: work_slot:5/0, active_slot:5/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 3]: work_slot:5/1, active_slot:5/1, is_protect:TRUE , is_standby
:TRUE
[slot_index 4]: work_slot:6/0, active_slot:6/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 5]: work_slot:6/1, active_slot:6/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 6]: work_slot:7/0, active_slot:7/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 7]: work_slot:7/1, active_slot:7/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 8]: work_slot:8/0, active_slot:8/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 9]: work_slot:8/1, active_slot:8/1, is_protect:FALSE, is_standby
:FALSE
-------------------------------------------------------------
Active Reman info on LC 5/1:
[slot_index 0]: work_slot:1/0, active_slot:1/0, is_protect:FALSE, is_standby

Cisco CMTS Cable Command Reference

1581
 Cable Commands: show a through show cable l
show cable active-reman

:FALSE
[slot_index 1]: work_slot:3/0, active_slot:3/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 2]: work_slot:5/0, active_slot:5/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 3]: work_slot:5/1, active_slot:5/1, is_protect:TRUE , is_standby
:TRUE
[slot_index 4]: work_slot:6/0, active_slot:6/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 5]: work_slot:6/1, active_slot:6/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 6]: work_slot:7/0, active_slot:7/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 7]: work_slot:7/1, active_slot:7/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 8]: work_slot:8/0, active_slot:8/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 9]: work_slot:8/1, active_slot:8/1, is_protect:FALSE, is_standby
:FALSE
-------------------------------------------------------------
Active Reman info on LC 6/0:
[slot_index 0]: work_slot:1/0, active_slot:1/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 1]: work_slot:3/0, active_slot:3/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 2]: work_slot:5/0, active_slot:5/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 3]: work_slot:5/1, active_slot:5/1, is_protect:TRUE , is_standby
:TRUE
[slot_index 4]: work_slot:6/0, active_slot:6/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 5]: work_slot:6/1, active_slot:6/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 6]: work_slot:7/0, active_slot:7/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 7]: work_slot:7/1, active_slot:7/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 8]: work_slot:8/0, active_slot:8/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 9]: work_slot:8/1, active_slot:8/1, is_protect:FALSE, is_standby
:FALSE
-------------------------------------------------------------
Active Reman info on LC 7/0:
[slot_index 0]: work_slot:1/0, active_slot:1/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 1]: work_slot:3/0, active_slot:3/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 2]: work_slot:5/0, active_slot:5/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 3]: work_slot:5/1, active_slot:5/1, is_protect:TRUE , is_standby
:TRUE
[slot_index 4]: work_slot:6/0, active_slot:6/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 5]: work_slot:6/1, active_slot:6/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 6]: work_slot:7/0, active_slot:7/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 7]: work_slot:7/1, active_slot:7/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 8]: work_slot:8/0, active_slot:8/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 9]: work_slot:8/1, active_slot:8/1, is_protect:FALSE, is_standby
:FALSE
-------------------------------------------------------------

Cisco CMTS Cable Command Reference

1582
Cable Commands: show a through show cable l
show cable active-reman

Active Reman info on LC 8/0:

[slot_index 0]: work_slot:1/0, active_slot:1/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 1]: work_slot:3/0, active_slot:3/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 2]: work_slot:5/0, active_slot:5/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 3]: work_slot:5/1, active_slot:5/1, is_protect:TRUE , is_standby
:TRUE
[slot_index 4]: work_slot:6/0, active_slot:6/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 5]: work_slot:6/1, active_slot:6/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 6]: work_slot:7/0, active_slot:7/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 7]: work_slot:7/1, active_slot:7/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 8]: work_slot:8/0, active_slot:8/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 9]: work_slot:8/1, active_slot:8/1, is_protect:FALSE, is_standby

The following is a sample output of the show cable active-reman command that shows high availability
information for slot 5 and subslot 0 on the Cisco uBR10012 router:

Router# show cable active-reman 5/0

-------------------------------------------------------------
Active Reman info on LC 5/0:
[slot_index 0]: work_slot:1/0, active_slot:1/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 1]: work_slot:3/0, active_slot:3/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 2]: work_slot:5/0, active_slot:5/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 3]: work_slot:5/1, active_slot:5/1, is_protect:TRUE , is_standby
:TRUE
[slot_index 4]: work_slot:6/0, active_slot:6/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 5]: work_slot:6/1, active_slot:6/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 6]: work_slot:7/0, active_slot:7/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 7]: work_slot:7/1, active_slot:7/1, is_protect:FALSE, is_standby
:FALSE
[slot_index 8]: work_slot:8/0, active_slot:8/0, is_protect:FALSE, is_standby
:FALSE
[slot_index 9]: work_slot:8/1, active_slot:8/1, is_protect:FALSE, is_standby
:FALSE

Cisco CMTS Cable Command Reference

1583
 Cable Commands: show a through show cable l
show cable admission-control

show cable admission-control

To display the current admission control (AC) configuration and status on a Cisco CMTS router, or on a
specified interface, use the show cable admission-control command in privileged EXEC mode.

show cable admission-control [global | interface | {slot/port slot/subslot/port }] [all | verbose]

Cisco IOS Release 12.2(33)SCE and later

show cable admission-control {global | interface | {cable slot/subslot/cable-interface-index |

{integrated-cable | modular-cable | wideband-cable}}}slot/subslot/port:interface-num [all | verbose]

Cisco cBR Series Router

show cable admission-control interface {cable slot/subslot/cable-interface-index | {integrated-cable |

wideband-cable}}slot/subslot/port:interface-num all

Syntax Description global For uBR series router, displays the following information:
• Parameters configured for AC.
• Number of requests that crossed minor, major, and critical levels for each resource.

interface Displays admission control information for the specified interface. For uBR series router,
slot/port | this includes the following:
slot/subslot/port
• slot—Slot on the interface. The valid range is from 5 to 8 for the Cisco uBR10012
router and from 3 to 6 for the Cisco uBR7200 series routers.
• subslot—Subslot on the interface. The valid values are 0 or 1.
• port—Port on the interface. The valid range is from 0 to 4 for the Cisco uBR10012
router and 0 or 1 for the Cisco uBR7200 series routers.
• cable-interface-index
• Cisco uBR7200 series routers—The valid values are 0 or 1.
• Cisco uBR10012 router—The valid range is from 0 to 4 for the Cisco
uBR-MC20X20V and Cisco uBR-MC5X20 line cards, and 0 to 14 for the Cisco
uBR-MC3GX60V line card.
• interface-num—Interface number. The valid range is from 0 to 23 for the modular
interface, 0 to 31 for the wideband interface, and 0 to 3 for the integrated interface.

all (Optional) Displays information for all interfaces configured for AC on the Cisco CMTS.

verbose (Optional) For uBR series router, displays detailed information for the wideband interface
configured for AC on the Cisco CMTS.

Command Modes
Privileged EXEC (#)

Cisco CMTS Cable Command Reference

1584
 Cable Commands: show a through show cable l
show cable admission-control

Command History Release Modification

12.3(13a)BC This command was introduced on the Cisco uBR10012 router and the Cisco uBR7246VXR
router.

12.3(23)BC This command was modified; new fields were added to the output.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

12.2(33)SCC This command was modified to display DS threshold values and reservations per bucket
on a modular cable, interface cable, or DS channel bonding.

12.2(33)SCE This command was modified. The port parameter was changed to cable-interface-index
to indicate the MAC domain index for the Cisco uBR-MC20X20V and Cisco
uBR-MC3GX60V cable interface line cards.

12.2(33)SCF This command was modified to display guaranteed and non-guaranteed bonus bandwidth
from the ACFE functionality.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The global, modular-cable and verbose keywords are removed.

Usage Guidelines The show cable admission-control command offers flexible syntax that enables display of the AC as
specifically configured on the Cisco CMTS. See the examples for additional information.

Examples The following example displays upstream and downstream AC information for the specified cable
interface:

Router# show cable admission-control interface cable 7/0/0

Interface Cable7/0/0

Resource - Upstream Bandwidth

-----------------------------
Thresholds applicable to upstream ports with no interface level
configurations in place
Bucket Minor Major Exclusive Non-Excls
No Level Level Level Level
1 0 0 0 0
2 0 0 0 0
3 0 0 0 0
4 0 0 0 0
5 0 0 0 0
6 0 0 0 0
7 0 0 0 0
8 0 0 0 0

Downstream Bit Rate (bits per second) = 24273316

Resource - Downstream Bandwidth

-------------------------------
Bkt Name Minor # of Major # of Excls # of Non-Ex Curr. Curr. Conf # of
No Level Times Level Times Level Times Level Resv Ovrsb Level Rej
1 0 0 0 0 0 0 100* 0.0 0.0 G 0
2 0 0 0 0 0 0 100* 0.0 0.0 G 0

Cisco CMTS Cable Command Reference

1585
 Cable Commands: show a through show cable l
show cable admission-control

3 0 0 0 0 0 0 100* 0.0 0.0 G 0

4 0 0 0 0 0 0 100* 0.0 0.0 G 0
5 0 0 0 0 0 0 100* 0.0 0.0 G 0
6 0 0 0 0 0 0 100* 0.0 0.0 G 0
7 0 0 0 0 0 0 100* 0.0 0.0 G 0
8 0 0 0 0 0 0 100* 12.3 0.0 G 0
Note: * indicates that the thresholds are implicit

Resource - Modular Downstream Bandwidth

-------------------------------
Interface Total(Kbps) Reservable(Kbps) Allocated(Kbps)
Mo1/0/0:0 19405 12424 3100

Effective from Cisco IOS Release 12.2(33)SCF, the show cable admission-control command output
for wideband cable interface was modified.
The following example displays the upstream and downstream AC information for the wideband-cable
interface:

Router# show cable admission-control interface wideband-Cable 1/0/0:1

Interface Wideband-Cable1/0/0:1
Configured AC Max Reservable Bandwidth = 600000 bps
Resource - Downstream Bandwidth
-------------------------------
Bkt Name Minor # of Major # of Excls # of Non-Ex Curr. Curr. Conf # of
No Level Times Level Times Level Times Level Resv Ovrsb Level Rej
1 0 0 0 0 0 0 0 * 0.0 0.0 G 0
2 0 0 0 0 0 0 0 * 0.0 0.0 G 0
3 0 0 0 0 0 0 0 * 0.0 0.0 G 0
4 0 0 0 0 0 0 0 * 0.0 0.0 G 0
5 0 0 0 0 0 0 0 * 0.0 0.0 G 0
6 0 0 0 0 0 0 0 * 0.0 0.0 G 0
7 0 0 0 0 0 0 0 * 0.0 0.0 G 0
8 0 0 0 0 0 0 100* 1333.31233.3 G 0
Note: * indicates that the thresholds are implicit

The following example displays the modified detailed upstream and downstream AC information
for the wideband-cable interface with the verbose keyword:

Router# show cable admission-control interface wideband-Cable 1/0/0:1 verbose

Interface Wideband-Cable1/0/0:0
Configured AC Max Reservable Bandwidth = 72000000 bps
Resource - Downstream Bandwidth
-------------------------------
Bkt Name Minor # of Major # of Excls # of Non-Ex Curr. Curr. Conf # of
No Level Times Level Times Level Times Level Resv Ovrsb Level Rej
1 DEF_MULTI 10 0 20 0 25 0 0 0.0 0.0 I 0
2 PKTCBL_N 2 0 3 0 5 0 0 0.0 0.0 I 0
3 PCMM_1 1 0 2 0 3 0 0 0.0 0.0 I 0
4 0 0 0 0 0 0 0 * 0.0 0.0 I 0
5 0 0 0 0 0 0 0 * 0.0 0.0 I 0
6 0 0 0 0 0 0 0 * 0.0 0.0 I 0
7 0 0 0 0 0 0 0 * 0.0 0.0 I 0
8 0 0 0 0 0 0 67 * 27.7 0.0 I 0
Note: * indicates that the thresholds are implicit
WB-NB CIR for Wideband-Cable1/0/0:0
CIR Values for Cable6/1/0
Bkt SFAC BW Rsvd CIR Reject #
1 4499750 0 0

Cisco CMTS Cable Command Reference

1586
Cable Commands: show a through show cable l
show cable admission-control

2 1800000 0 0
3 540000 0 0
4 0 0 0
5 0 0 0
6 0 0 0
7 0 0 0
8 34120000 20000000 0
Available Guaranteed Bonus BW (bps): 2531250
Available Non-guaranteed Bonus BW (bps): 10125000
CIR Values for Cable6/1/1
Bkt SFAC BW Rsvd CIR Reject #
1 4499750 0 0
2 1800000 0 0
3 540000 0 0
4 0 0 0
5 0 0 0
6 0 0 0
7 0 0 0
8 14120000 0 0
Available Guaranteed Bonus BW (bps): 2531250
Available Non-guaranteed Bonus BW (bps): 10125000
WB Multicast CIR Utilization
Bkt SFAC BW Rsvd CIR Reject #
1 9000500 1000 0
2 0 0 0
3 1080000 0 0
4 0 0 0
5 0 0 0
6 0 0 0
7 0 0 0
8 0 0 0
Available Guaranteed Bonus BW (bps):
5062500 Available Non-guaranteed Bonus BW (bps): 10125000

The verbose keyword is not applicable to integrated-cable and modular-cable interfaces.

Effective from Cisco IOS Release 12.2(33)SCF, the show cable admission-control command output
for modular cable interface was modified.
The following example displays upstream and downstream AC information for the specified modular
cable interface:

Router# show cable admission-control interface modular-Cable 1/0/0:1

Interface Mo1/0/0:1
Configured AC Max Reservable Bandwidth = 3000000 bps
Resource - Downstream Bandwidth
-------------------------------
Bkt Name Minor # of Major # of Excls # of Non-Ex Curr. Curr. Conf # of
No Level Times Level Times Level Times Level Resv Ovrsb Level Rej
1 0 0 0 0 0 0 100* 0.0 0.0 G 0
2 0 0 0 0 0 0 100* 0.0 0.0 G 0
3 0 0 0 0 0 0 100* 0.0 0.0 G 0
4 0 0 0 0 0 0 100* 0.0 0.0 G 0
5 0 0 0 0 0 0 100* 0.0 0.0 G 0
6 0 0 0 0 0 0 100* 0.0 0.0 G 0
7 0 0 0 0 0 0 100* 0.0 0.0 G 0
8 0 0 0 0 0 0 100* 0.0 0.0 G 0
Note: * indicates that the thresholds are implicit
Total Current Reservation = 0 bps
Guaranteed Bonus available/total = 13657000/13657000 bps
Non-guaranteed Bonus available/total = 13658000/13658000 bps

Cisco CMTS Cable Command Reference

1587
 Cable Commands: show a through show cable l
show cable admission-control

Effective from Cisco IOS Release 12.2(33)SCF, the show cable admission-control command output
for integrated cable interface was modified.
The following example displays upstream and downstream AC information for the specified integrated
cable interface:

Router# show cable admission-control interface integrated-Cable 6/1/0:0

Interface In6/1/0:0
Configured AC Max Reservable Bandwidth = 300000 bps
Resource - Downstream Bandwidth
-------------------------------
Bkt Name Minor # of Major # of Excls # of Non-Ex Curr. Curr. Conf # of
No Level Times Level Times Level Times Level Resv Ovrsb Level Rej
1 0 0 0 0 0 0 100* 0.0 0.0 G 0
2 0 0 0 0 0 0 100* 0.0 0.0 G 0
3 0 0 0 0 0 0 100* 0.0 0.0 G 0
4 0 0 0 0 0 0 100* 0.0 0.0 G 0
5 ACFE 0 0 0 0 0 0 100* 0.0 0.0 G 0
6 0 0 0 0 0 0 100* 0.0 0.0 G 0
7 0 0 0 0 0 0 100* 0.0 0.0 G 0
8 0 0 0 0 0 0 100* 0.0 0.0 G 0
Note: * indicates that the thresholds are implicit
Total Current Reservation = 0 bps
Guaranteed Bonus available/total = 20028000/20028000 bps
Non-guaranteed Bonus available/total = 10009000/10009000 bps

The following example displays upstream and downstream AC information for the specified cable
interface:

Router# show cable admission-control interface cable 6/1/0

Interface Cable6/1/0
Resource - Upstream Bandwidth
-----------------------------
Thresholds applicable to upstream ports with no interface level configurations in place
Bucket Name Minor Major Exclusive Non-Excls Config
No Level Level Level Level Level
1 DEF_MULTI 15 20 25 10 I
2 UGS 15 20 25 10 I
3 PCMM_1 0 0 0 0* I
4 0 0 0 0* I
5 0 0 0 0* I
6 0 0 0 0* I
7 0 0 0 0* I
8 10 15 20 15 I
Downstream Bit Rate (bits per second) = 34307436
Resource - Downstream Bandwidth
-------------------------------
Bkt Name Minor # of Major # of Excls # of Non-Ex Curr. Curr. Conf # of
No Level Times Level Times Level Times Level Resv Ovrsb Level Rej
1 DEF_MULTI 1 0 3 0 10 0 0 0.0 0.0 I 0
2 UGS 10 0 15 0 20 0 5 0.2 0.0 I 0
3 PCMM_1 0 0 0 0 0 0 70 * 0.0 0.0 I 0
4 0 0 0 0 0 0 70 * 0.0 0.0 I 0
5 0 0 0 0 0 0 70 * 0.0 0.0 I 0
6 0 0 0 0 0 0 70 * 0.0 0.0 I 0
7 0 0 0 0 0 0 70 * 0.0 0.0 I 0
8 0 0 0 0 0 0 70 * 58.7 0.0 I 0

The following example displays upstream and downstream AC information with the global keyword:

Cisco CMTS Cable Command Reference

1588
Cable Commands: show a through show cable l
show cable admission-control

Router# show cable admission-control global

CM registration event enabled
Dynamic service event enabled
Call preemption due to priority call enabled
Resource Minor #times Major #times Critical #times Current
cpu-5sec 50% 7 70% 0 99% 0 2
proc-mem 50% 0 80% 0 90% 0 11
io-mem 50% 1 60% 1 90% 0 75
total-mem 50% 0 80% 0 90% 0 36
Number of Packetcable voice calls = 80/100 (maximum)
Number of times voice count exceeded = 1
Resource - Upstream Bandwidth
-----------------------------
Thresholds applicable to upstream ports with no interface or port level configurations in
place
Bucket Name Minor Major Exclusive Non-Excls
No Level Level Level Level
1 DEF_MULTI 5 8 20 10
2 UGS 5 10 15 5
3 PCMM_1 0 0 0 0
4 0 0 0 0
5 0 0 0 0
6 40 45 50 5
7 0 0 0 0
8 0 0 0 0
Resource - Downstream Bandwidth
-------------------------------
Thresholds applicable to interfaces with no interface level configurations in place
Bucket Name Minor Major Exclusive Non-Excls
No Level Level Level Level
1 DEF_MULTI 0 0 0 0
2 UGS 0 0 0 0
3 PCMM_1 0 0 0 0
4 0 0 0 0
5 0 0 0 0
6 0 0 0 0
7 0 0 0 0
8 0 0 0 0

This table describes the significant fields for the show cable admission-control command for upstream
and downstream throughput.

Table 42: show cable admission-control Field Descriptions

Field Description

Bucket No Specific bucket number.

Names Bucket name.

Minor Level Minor threshold as currently defined in a percentage on the Cisco CMTS.

# of Times Number of times traffic has crossed this threshold since the counters on the Cisco
CMTS were last cleared.

Major Level Major threshold as currently defined in a percentage on the Cisco CMTS.

Excls Level Percentage of exclusive throughput that is reserved for the corresponding traffic
type on the Cisco CMTS. Applies to downstream or upstream traffic.

Cisco CMTS Cable Command Reference

1589
 Cable Commands: show a through show cable l
show cable admission-control

Field Description

Non-Ex Level Percentage of non-exclusive throughput configured on the Cisco CMTS. Commonly
used with Best Effort (lowest priority) traffic.

Curr Resv Percentage of throughput reserved exclusively for the corresponding flow type.

Conf Level Configuration level that indicates the scope of configuration is actually applied for
that US/ DS (whether the global, interface, or the upstream level is applied). The
values in this field can be as follows:
• U—Upstream
• I—Interface
• G—Global

# of Rejec Number of rejections.

Sched Type Available for upstream only. This field displays the following information:
• UGS—UGS thresholds configured and traffic rates.
• RTPS—RTPS thresholds configured and traffic rates.
• BE—Best Effort thresholds configured and traffic rates.

Flow Type Available for Downstream only. This field displays voice and data information:
• voice—Voice thresholds configured and traffic rates.
• data—Data thresholds configured and traffic rates.

Class Name Available for upstream only.

CM-Registration event Counter increments once for every cable modem that crosses a threshold during its
registration. For example, if the minor, major, and critical thresholds on the Cisco
CMTS are 60%, 70%, and 80% respectively, and a cable modem tries to register
when the current value is 80%, then the cable modem is allowed to register, but the
counters for minor, major and critical thresholds are each incremented by one.

Voice-Call event Counter increments if the resource check fails when a voice-call is made. For
example, assume both the MTAs are on the same Cisco CMTS, and minor, major,
and critical thresholds for I/O memory are 50%, 60%, and 70%, respectively. Then
assume the current I/O memory value is 75%. In this scenario, before the gate
creation, AC performs an I/O memory check. This results in the counters for minor,
major, and critical thresholds each being incremented by one, and the voice call
fails. No packetcable gates are created because the voice calls fail.

The following example displays the upstream and downstream AC information for the wideband-cable
interface:

Router# show cable admission-control interface wideband-Cable 8/0/0:0

Interface Wideband-Cable8/0/0:0

Resource - Downstream Bandwidth

-------------------------------
Max Reserved BW = 18000000 bps
Total Current Reservation = 1000000 bps

Cisco CMTS Cable Command Reference

1590
 Cable Commands: show a through show cable l
show cable admission-control

Guaranteed Bonus BW = 0 bps

Non-guaranteed Bonus BW = 0 bps

The following example displays the reserved and reservable bandwidth for a particular interface:
Router#show cable admission-control interface wideband-Cable 2/0/0:1

Interface Wi2/0/0:1
BGID: 8194

Resource - Downstream Bandwidth

-------------------------------
App-type Name Reservation/bps Maximum Rejected
1 4000 90% 0
2 0 N/A 0
3 0 90% 0
4 0 N/A 0
5 0 N/A 0
6 0 90% 0
7 0 N/A 0
8 0 87% 0
Max Reserved BW = 11424000 bps
Total Current Reservation = 4000 bps
Guaranteed Bonus BW = 884352000 bps
Non-guaranteed Bonus BW = 225904000 bps
Capacity BW = 1428000000 bps
Subset BGs: In2/0/0:0 In2/0/0:1 In2/0/0:2 In2/0/0:3 In2/0/0:4 In2/0/0:5 In2/0/0:6 In2/0/0:7
In2/0/0:158 Wi2/0/0:0
Superset BGs: N/A

Note Effective with Cisco IOS-XE Release 3.18.0SP, if an OFDM channel has both Control Profile (profile
A) and Data Profiles (profile B, C, and so on) configured, the lowest Data Profile rate is used for
admission control calculation. Otherwise, the Control Profile rate is used.

Related Commands Command Description

cable admission-control Configures the CPU and memory thresholds for the Cisco
CMTS and supporting broadband processing engines.

cable admission-control event Configures and enables AC event types.

cable admission-control ds-bandwidth Configures AC downstream bandwidth thresholds.

cable admission-control Defines the maximum reserved bandwidth per bonding group
max-reserved-bandwidth for all service flows that are allowed by the Cisco CMTS.

cable admission-control us-bandwidth Configures AC upstream bandwidth thresholds.

clear cable admission control counters Clears all AC resource counters.

debug cable admission-control Enables automatic AC troubleshooting processes.

Cisco CMTS Cable Command Reference

1591
 Cable Commands: show a through show cable l
show cable admission-control fiber-node

show cable admission-control fiber-node

To display Service Group Admission Control (SGAC) configuration information for a fiber-node, use show
cable admission-control fiber-node command in privileged EXEC mode.

show cable admission-control fiber-node node-id

Syntax Description node-id The cable fiber-node id. Valid range is from 1 to 512.

Command Default None.

Command Modes
Privileged EXEC(#)

Command History Release Modification

IOS-XE This command was introduced on the Cisco cBR Series Converged Broadband Routers.
3.16.0S

Usage Guidelines Use the show cable admission-control fiber-node command to verify admission-control configuration.

Examples The following example displays SGAC configuration information for an fiber-node:

Router# show cable admission-control fiber-node 2

Constraint Name Limit
1 15%

Router#

Related Commands Command Description

show cable admission-control interface Displays current reservation and other AC related information
for a specific interface.

Cisco CMTS Cable Command Reference

1592
 Cable Commands: show a through show cable l
show cable arp-filter

show cable arp-filter

To display the total number of Address Resolution Protocol (ARP) replies and requests that have been sent
and received, including the number of requests that have been filtered, use the show cable arp-filter command
in privileged EXEC mode.

Cisco uBR7246VXR Router

show cable arp-filter cable slot/port[ip-requests-filtered number] [requests-filtered number |

replies-filtered number]

Cisco uBR10012 Router

show cable arp-filter cable slot/subslot/port [ip-requests-filtered number] [requests-filtered

number | replies-filtered number]

Cisco cBR-8 Router

show cable arp-filter {cable slot/subslot/port | bundle number} [ip-requests-filtered number]

[requests-filtered number | replies-filtered number]

Syntax Description cable slot/port Displays information for all CMs on the specified cable interface and downstream
port on the Cisco uBR7246VXR router.
On the Cisco uBR7246VXR router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.

cable slot/subslot/port Displays information for all CMs on the specified cable interface on the router.
The following are the valid values:
• slot = 5 to 8 for uBR10012 router, 0 to 9 for cBR-8 router
• subslot = 0 or 1 for uBR10012 router, 0 for cBR-8 router
• port = 0 to 4 for uBR10012 router, 0 to 15 for cBR-8 router (depending on
the cable interface)

bundle number Bundle interface number. The value range for number is 1 to 255.

[ip-requests-filtered (Optional) Displays the Service IDs (SIDs) that are generating or forwarding more
number] filtered ARP requests for IP packets than the specified minimum number of
packets. The valid range for number is 1 to 65535, with no default.
Note
This field shows the modems that are forwarding IP traffic that could be an part
of an attack, such as TCP SYN floods, ping scans, and so forth.

[requests-filtered (Optional) Displays the Service IDs (SIDs) that are generating or forwarding more
number] filtered ARP requests than the specified minimum number of packets. The valid
range for number is 1 to 65535, with no default.

Cisco CMTS Cable Command Reference

1593
 Cable Commands: show a through show cable l
show cable arp-filter

[replies-filtered number] (Optional) Displays the Service IDs (SIDs) that are generating or filtering more
filtered ARP replies than the specified minimum number of packets. The valid
range for number is 1 to 65535, with no default.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(15)BC2 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 universal
broadband routers.

12.2(15)BC2b The ip-requests-filtered option was added to display the specific Service IDs (SIDs) that
are generating or forwarding a minimum number of ARP packets.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The value ranges for the slot/subslot/port variables were changed.

Usage Guidelines The cable arp filter command enables the filtering of ARP request and reply packets on a cable interface.
ARP packets might need to be filtered when a user on the cable network generates a large volume of ARP
traffic as part of a theft-of-service or denial-of-service attack, or when a virus is using ARP requests to find
other computers that it might infect.
The show cable arp-filter command displays the total number of ARP reply packets that have been received
and the number of ARP request packets that have been sent on the cable interface, as well as the number of
such packets that have been filtered.

Tip To clear the counters on all interfaces, use the clear counters command. To clear the counters on a specific
interface, use the clear counters cable interface command.

Examples The following example shows the typical output from the show cable arp-filter command on a Cisco
uBR10012 router. The displays for other Cisco CMTS platforms are similar.

Router# show cable arp-filter Cable6/0/0

ARP Filter statistics for Cable6/0/0:

Replies Rcvd: 177387 total, 1869 unfiltered, 8824 filtered
Requests Sent For IP: 68625 total, 964 unfiltered, 36062 filtered
Requests Forwarded: 7969175 total, 7213 unfiltered, 366167 filtered
Router#

Table 43: show cable arp-filter Field Descriptions in Cisco uBR10012 Router

Field Description

Replies Rcvd

Total Total number of ARP reply packets received on the cable interface since
power-on.

Cisco CMTS Cable Command Reference

1594
Cable Commands: show a through show cable l
show cable arp-filter

Field Description

Unfiltered Number of ARP reply packets that the cable interface received and
accepted while filtering was enabled using the cable arp filter
reply-accept command.

Filtered Number of ARP reply packets that the cable interface dropped while
filtering was enabled, because they would have otherwise exceeded the
allowable threshold value that was configured for the interface using the
cable arp filter reply-accept command.

Requests Sent For IP

Total Total number of ARP request packets that the cable interface was asked
to forward since power-on.

Unfiltered Number of ARP request packets that the cable interface sent while
filtering was enabled using the cable arp filter request-send command.

Filtered Number of ARP request packets that the cable interface dropped, because
they would have otherwise exceeded the allowable threshold value that
was configured for the interface using the cable arp filter request-send
command.

Requests Forwarded

Total Total number of ARP request packets that the cable interface was asked
to forward to the ARP proxy since power-on.

Unfiltered Number of ARP request packets that the cable interface sent to the ARP
proxy while filtering was enabled using the cable arp filter request-send
command.

Filtered Number of ARP request packets for the ARP proxy that the cable interface
dropped, because they would have otherwise exceeded the allowable
threshold value that was configured for the interface using the cable arp
filter request-send command.

Note
All counters are 16-bit counters,
with a maximum value of 65,535
packets. If the number of packets
exceeds this amount, the counter
wraps back to zero and begins
incrementing again.

Note The Total counts in the show cable arp-filter command continue to increment, regardless of whether
ARP filtering has been enabled. The Unfiltered and Filtered counts increment only when ARP filtering
has been enabled using the cable arp filter command. When cable ARP filtering is disabled, these
counters retain their current values until manually reset, using the clear counters command.

Cisco CMTS Cable Command Reference

1595
 Cable Commands: show a through show cable l
show cable arp-filter

The following example shows how to display the devices that are generating or filtering more than
100 ARP requests per reporting period. Repeat the command to see how quickly the device is
generating ARP packets.

Router# show cable arp-filter c6/0/0 requests-filtered 100

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

1 0006.2854.72d7 50.3.81.4 12407 0 0
Router# show cable arp-filter c6/0/0 requests-filtered 100

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

1 0006.2854.72d7 50.3.81.4 14597 0 0
Router#

The following example shows how to display the devices that are generating or filtering more than
200 ARP replies per reporting period. Repeat the command to see how quickly the device is generating
ARP packets.

Router# show cable arp-filter c6/0/0 replies-filtered 200

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

2 0006.53b6.562f 50.3.81.6 0 0 2358
Router# show cable arp-filter c6/0/0 replies-filtered 200

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

2 0006.53b6.562f 50.3.81.6 0 0 4016
Router#

The following example shows how to display the devices that are generating or filtering more than
10 ARP requests for IP packets per reporting period. Repeat the command to see how quickly the
device is generating ARP packets.

Router# show cable arp-filter c6/0/0 ip-requests-filtered 10

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

2 0006.2854.71e7 50.3.72.4 0 1926 0
Router#

Table 44: show cable arp-filter Detail Field Descriptions in Cisco uBR10012 Router

Field Description

SID Service ID (SID) of the device.

MAC Address Hardware (MAC-layer) address of the cable modem or

CPE device.

IP Address IP address of the cable modem or CPE device.

Req-Filtered Total number of ARP requests that the device has

generated or forwarded.

Req-For-IP-Filtered Total number of ARP requests that the device has

generated or forwarded for IP packets.

Rep-Filtered Total number of ARP replies that the device has generated
or forwarded.

Cisco CMTS Cable Command Reference

1596
Cable Commands: show a through show cable l
show cable arp-filter

Field Description

Note
The Req-Filter and Rep-Filtered counters are
16-bit counters, with a maximum value of 65,535
packets. If the number of packets exceeds this
amount, the counter wraps back to zero and
begins incrementing again.

The following example shows the typical output from the show cable arp-filter command on a Cisco
cBR-8 router.

Router# show cable arp-filter c9/0/0 requests-filtered 100

May 8 16:28:17.252 CST: %IP-4-ZERO_ADDR: Zero MAC address for 30.140.2.1 in ARP cache
Interface Cable9/0/0
SID CPE Mac CPE IP Modem Mac Modem IP M/S Rate Pro REQ
6 0000.af0e.26e4 30.141.0.2 c8fb.26a5.5954 30.140.1.3 MAC - RP 10849
6 0000.af0e.26e4 30.141.0.2 c8fb.26a5.5954 30.140.1.3 MAC - PXF 59705

The following example shows how to display the devices that are generating or filtering more than
200 ARP replies per reporting period. Repeat the command to see how quickly the device is generating
ARP packets.

Router# show cable arp-filter c9/0/0 requests-filtered 200

Interface Cable9/0/0
SID CPE Mac CPE IP Modem Mac Modem IP M/S Rate Pro REQ
6 0000.af0e.26e4 30.141.0.2 c8fb.26a5.5954 30.140.1.3 MAC - RP 10849
6 0000.af0e.26e4 30.141.0.2 c8fb.26a5.5954 30.140.1.3 MAC 934 PXF 352036

The following example shows how to display the devices that are generating or filtering more than
10 ARP requests for IP packets per reporting period. Repeat the command to see how quickly the
device is generating ARP packets.

Router# show cable arp-filter c9/0/0 ip-requests-filtered 100

Interface Cable9/0/0
SID CPE Mac CPE IP Modem Mac Modem IP M/S Rate Pro IP
1 0000.af0e.26e4 30.141.0.2 c8fb.26a5.5954 30.140.1.3 MAC - RP 1203

Table 45: show cable arp-filter Field Descriptions in Cisco cBR-8 Router

Field Description

SID Service ID (SID) of the device.

CPE MAC Hardware (MAC-layer) address of the cable CPE device.

CPE IP IP address of the CPE device.

Modem MAC Hardware (MAC-layer) address of the cable modem.

Cisco CMTS Cable Command Reference

1597
 Cable Commands: show a through show cable l
show cable arp-filter

Field Description

Modem IP IP address of the Cable Modem

M/S Type of filtering, M means per MAC filtering, S means per Sid filtering.

Rate The rate of filtered packets, olny hardware assist filtering has the value.

Pro Where is the filtering performed, with options RP and PXF(FP).

[REQ|REP|REQIP] REQ means arp request packets, REP means arp reply, REQIP means arp request for
IP.

Clearing the ARP Packet Counters

The following example shows the cable ARP counters being cleared by the clear counters cable
interface command. This can be useful because the ARP counters are 16-bit counters that can wrap
around to zero relatively quickly when large amounts of ARP traffic is being generated. Also, the
ARP packet counters could include SIDs that had forwarded large amounts of ARP traffic in the
past, but that are not currently forwarding such traffic. Clearing the counters allows you to clearly
see the SIDS that are currently forwarding the ARP traffic that is triggering the ARP filters.
For uBR series router:

Router# show cable arp cable 6/0/0

ARP Filter statistics for Cable6/0/0:

Replies Rcvd: 3278 total. 84 unfiltered, 3194 filtered
Requests Sent For IP: 941 total. 30 unfiltered, 911 filtered
Requests Forwarded: 941 total. 37 unfiltered, 904 filtered
Router# show cable arp-filter cable 6/0/0 requests-filtered 10

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

1 0006.2854.72d7 10.3.81.4 8 0 0
23 0007.0e02.b747 10.3.81.31 32 0 0
57 0007.0e03.2c51 10.3.81.31 12407 0 0
...
81 00C0.c726.6b14 10.3.81.31 23 0 0
Router# clear counter cable 6/0/0

Clear "show interface" counters on this interface [confirm] y

08:17:53.968: %CLEAR-5-COUNTERS: Clear counter on interface Cable6/0/0 by console

Router# show cable arp cable 6/0/0

ARP Filter statistics for Cable6/0/0:

Replies Rcvd: 0 total. 0 unfiltered, 0 filtered
Requests Sent For IP: 0 total. 0 unfiltered, 0 filtered
Requests Forwarded: 0 total. 0 unfiltered, 0 filtered
Router# show cable arp-filter cable 6/0/0 requests-filtered 10

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

Router# show cable arp-filter cable 6/0/0 requests-filtered 10

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

57 0007.0e03.2c51 10.3.81.31 20 0 0
81 00C0.c726.6b14 10.3.81.31 12 0 0

Cisco CMTS Cable Command Reference

1598
 Cable Commands: show a through show cable l
show cable arp-filter

Router# show cable arp-filter cable 6/0/0 requests-filtered 10

Sid MAC Address IP Address Req-Filtered Req-For-IP-Filtered Rep-Filtered

57 0007.0e03.2c51 10.3.81.31 31 0 0
81 00C0.c726.6b14 10.3.81.31 18 0 0
Router#

For cBR series router:

Router# show cable arp-filter c9/0/0

ARP Filter statistics for Cable9/0/0:

Replies Rcvd: 3868865 total. 0 unfiltered, 0 filtered
Requests Forwarded: 82364 total. 2707 unfiltered, 70878 filtered
Requests Sent For IP: 0 total. 0 unfiltered, 0 filtered

Router# show cable arp-filter c9/0/0 requests-filtered 1

Interface Cable9/0/0
SID CPE Mac CPE IP Modem Mac Modem IP M/S Rate Pro REQ
6 0000.af0e.26e4 30.141.0.2 c8fb.26a5.5954 30.140.1.3 MAC - RP 7480
6 0000.af0e.26e4 30.141.0.2 c8fb.26a5.5954 30.140.1.3 MAC - PXF 6987

Router# clear counter cable 9/0/0

Clear "show interface" counters on this interface [confirm]

Router# show cable arp-filter c9/0/0 requests-filtered 1

May 8 17:53:14.557 CST: %CLEAR-5-COUNTERS: Clear counter on interface Cable9/0/0 by console

Router# show cable arp-filter c9/0/0

ARP Filter statistics for Cable9/0/0:

Replies Rcvd: 6288 total. 0 unfiltered, 0 filtered
Requests Forwarded: 0 total. 0 unfiltered, 0 filtered
Requests Sent For IP: 0 total. 0 unfiltered, 0 filtered

Router# show cable arp-filter c9/0/0 requests-filtered 1

Interface Cable9/0/0 - none

Router# show cable arp-filter c9/0/0 requests-filtered 1

Interface Cable9/0/0 - none

Note The clear counters command clears all of the packet counters on an interface, not just the ARP
packet counters.

Related Commands Command Description

cable arp Activates cable Address Resolution Protocol (ARP).

cable arp filter Controls the number of ARP packets that are allowable for each Service ID (SID)
on a cable interface.

cable proxy-arp Activates cable proxy ARP on the cable interface.

Cisco CMTS Cable Command Reference

1599
 Cable Commands: show a through show cable l
show cable arp-filter

Command Description

clear arp Clears the ARP table on the router.

clear counters Clears the packet counters on all interfaces or on a specific interface.

debug cable arp filter Displays debugging messages about the filtering of ARP broadcasts.

Cisco CMTS Cable Command Reference

1600
 Cable Commands: show a through show cable l
show cable asf-qos-profile

show cable asf-qos-profile

To display Cable AQP Table, use the show cable asf-qos-profile [ name name | summary | verbose ]command
in privileged EXEC mode.

show cable asf-qos-profile [ name name | summary | verbose ]

Syntax Description name AQP Table Entry by Name

summary AQP Table Summary

verbose AQP Table Verbose

Summary

Command Default None.

Command Modes Global configuration (config)

Command History Release Modification

Cisco IOS XE Cupertino 17.9.1x This command is introduced on the Cisco cBR Series Converged Broadband
Routers.

The following example shows the output for cable asf-qos-profile summary and cable
asf-qos-profile summary gamingService:

Router# cable asf-qos-profile summary

Load for five secs: 4%/0%; one minute: 3%; five minutes: 3%
Time source is NTP, 08:49:16.556 EDT Tue Jan 10 2023

AQP Name Dir LLASF Classic SF SCN LL SF SCN

ultraUS US true MazBoostUS LL_US
ultraDS DS true MazBoostDS LL_DS
gamingService DS true gamerBoost gamerLL

Router# cable asf-qos-profile gamingService

Load for five secs: 3%/0%; one minute: 3%; five minutes: 3%
Time source is NTP, 09:01:17.556 EDT Tue Jan 10 2023

Name gamingService
Direction: Downstream
Traffic Priority: 0
Minimum Sustained Rate: 0 bits/sec
Max Burst: 3044 bytes
Minimum Reserved Rate: 0 bits/sec
Minimum Packet Size: 0 bytes
Peak Rate: 0 bits/sec
Low Latency ASF: true
Classic SF SCN: gamerboost
Low Latency SF SCN: gamerLL
AQM Coupling Factor: 20
Scheduling Weight: 230
Queue Protection (QP) Enable: true

Cisco CMTS Cable Command Reference

1601
 Cable Commands: show a through show cable l
show cable asf-qos-profile

QP Latency Threshold: 0
QP Score Threshold: 2000
QO Drain Rate Exponent> 19

Related Commands Command Description

cable asf-qos-profile Configure an ASF Qos

profile.

Cisco CMTS Cable Command Reference

1602
 Cable Commands: show a through show cable l
show cable bgsync

show cable bgsync

To display the statistics when SNMP background synchronization occurs on the Cisco CMTS, use the show
cable bgsync command in privileged EXEC mode.

show cable bgsync

Syntax Description This command has no keywords or arguments.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was replaced by the show cable snmp cache-status command on the Cisco
cBR Series Converged Broadband Routers.

IOS-XE 3.18.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the show cable bgsync command to view the SNMP synchronization information.

Examples The following is sample output of the show cable bgsync command on the Cisco cBR-8 router:

Router# show cable bgsync

Background Sync is active, uptime is 3 hours, 28 minutes, 34 seconds.
Background Sync last active time is 3 hours, 28 minutes, 34 seconds ago.
I-packet interval time is 1 day; P-packet interval time is 5 senconds.
Line Card with bg-sync: 9/0
Line Card working on I syncing:
Last clear cable bg sync counters Time:
Total bytes: 14197303
Total background sync packets: 565057
Ack packets: 0
Run Ctrl Msg packets: 1
Data packets: 0
Interval packets: 562554
I Type packets: 201
P Type packets: 562353
Bg sync data IPC lost packets: 0

Background Sync statistics for the last 03:30:43

===============================================================
ipc packets 0-30k: 2502
ipc packets 30-60k: 0
ipc packets 60-100k: 0
msg per packet average: 225
msg per packet max: 256
msg per packet min: 179
msg per packet under 3: 0
===============================================================

Cisco CMTS Cable Command Reference

1603
 Cable Commands: show a through show cable l
show cable bgsync

type packets cpu-total(ms) avg(us) max(us)

serv flow 527068 151 0 1000
sflog 0 0 0 0
cm 59 0 0 0
cmtx 10961 17 1 1000
paramset 68 1 14 1000
DXIF 9912 19 1 1000
sid 4603 2 0 1000
uschan 9883 5 0 1000
---------------------------------------------------------------
IPC PKTs 2502 365 0 ms 1 ms
================================================================================
=====
slot type packets bytes pps Bps wrong_len_
pkts
0 serv flow 0 0 0.0 0.0 0

0 sflog 0 0 0.0 0.0 0

0 cm 0 0 0.0 0.0 0

0 cmtx 0 0 0.0 0.0 0

0 paramset 0 0 0.0 0.0 0

0 DXIF 0 0 0.0 0.0 0

0 sid 0 0 0.0 0.0 0

0 uschan 0 0 0.0 0.0 0

1 serv flow 0 0 0.0 0.0 0

1 sflog 0 0 0.0 0.0 0

1 cm 0 0 0.0 0.0 0

1 cmtx 0 0 0.0 0.0 0

1 paramset 0 0 0.0 0.0 0

1 DXIF 0 0 0.0 0.0 0

1 sid 0 0 0.0 0.0 0

1 uschan 0 0 0.0 0.0 0

2 serv flow 0 0 0.0 0.0 0

2 sflog 0 0 0.0 0.0 0

2 cm 0 0 0.0 0.0 0

2 cmtx 0 0 0.0 0.0 0

2 paramset 0 0 0.0 0.0 0

2 DXIF 0 0 0.0 0.0 0

2 sid 0 0 0.0 0.0 0

2 uschan 0 0 0.0 0.0 0

3 serv flow 0 0 0.0 0.0 0

Cisco CMTS Cable Command Reference

1604
Cable Commands: show a through show cable l
show cable bgsync

3 sflog 0 0 0.0 0.0 0

3 cm 0 0 0.0 0.0 0

3 cmtx 0 0 0.0 0.0 0

3 paramset 0 0 0.0 0.0 0

3 DXIF 0 0 0.0 0.0 0

3 sid 0 0 0.0 0.0 0

3 uschan 0 0 0.0 0.0 0

6 serv flow 0 0 0.0 0.0 0

6 sflog 0 0 0.0 0.0 0

6 cm 0 0 0.0 0.0 0

6 cmtx 0 0 0.0 0.0 0

6 paramset 0 0 0.0 0.0 0

6 DXIF 0 0 0.0 0.0 0

6 sid 0 0 0.0 0.0 0

6 uschan 0 0 0.0 0.0 0

7 serv flow 0 0 0.0 0.0 0

7 sflog 0 0 0.0 0.0 0

7 cm 0 0 0.0 0.0 0

7 cmtx 0 0 0.0 0.0 0

7 paramset 0 0 0.0 0.0 0

7 DXIF 0 0 0.0 0.0 0

7 sid 0 0 0.0 0.0 0

7 uschan 0 0 0.0 0.0 0

8 serv flow 0 0 0.0 0.0 0

8 sflog 0 0 0.0 0.0 0

8 cm 0 0 0.0 0.0 0

8 cmtx 0 0 0.0 0.0 0

8 paramset 0 0 0.0 0.0 0

8 DXIF 0 0 0.0 0.0 0

8 sid 0 0 0.0 0.0 0

8 uschan 0 0 0.0 0.0 0

9 serv flow 527068 12729948 50.3 1210.8 0

Cisco CMTS Cable Command Reference

1605
 Cable Commands: show a through show cable l
show cable bgsync

9 sflog 0 0 0.0 0.0 0

9 cm 59 2067 0.0 0.0 0

9 cmtx 10961 319725 0.6 20.1 0

9 paramset 68 9827 0.0 0.0 0

9 DXIF 9912 697642 0.3 32.7 0

9 sid 4603 110974 0.0 6.3 0

9 uschan 9883 277056 0.7 20.6 0

================================================================================
=====
total stats:packets 562554 bytes 14147239 pps 52.4 Bps 1290.9 wrong_len_pkts 0
Router#

Related Commands Command Description

cable bgsync Sets the data intervals for background synchronization on the Cisco CMTS.

cable bgsync active Activates background synchronization process on the Cisco CMTS.

clear cable bgsync counters Clears the background synchronization counters on the Cisco CMTS.

Cisco CMTS Cable Command Reference

1606
 Cable Commands: show a through show cable l
show cable bgsync sync-info cable

show cable bgsync sync-info cable

To display all the SNMP background synchronization data on supervisor side (when executed on supervisor
IOSd) or line card side (when executed on line card IOSd), use the show cable bgsync sync-info cable
slot/subslot/port command in privileged EXEC mode.

show cable bgsync sync-info cable slot/subslot/port

Syntax Description cable slot/subslot/port Specifies the cable interface.

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.18.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the show cable bgsync sync-info cable slot/subslot/port command to view all the SNMP background
synchronization data on supervisor or line card side.

Examples The following is sample output of theshow cable bgsync sync-info cable slot/subslot/port command
on the Cisco cBR-8 router:

Router# show cable bgsync sync-info cable 9/0/1

part1 for srv template:
srv_tmp_id min_rate max_rate max_burst
0 0 0 0
1 0 64000 0
2 0 1000000 0
3 0 1000000 3044
4 0 0 3044
5 0 110000000 30000
6 0 0 3044
7 0 2000000000 5000000
8 0 0 3044
part2 for srv flow:
sfid prov_qos adm_qos act_qos wb_mode octets pkts delay_pkts
drop_pkts gate_id create_time total_active_time
1 0 0 0 0 0 0 0 0
0 0 0
2 0 0 0 0 0 0 0 0
0 0 0
15 3 3 3 0 0 0 0 0
0 3600 373
16 3 3 3 0 0 0 0 0
0 3600 373
17 3 3 3 0 0 0 0 0
0 3600 373
18 3 3 3 0 0 0 0 0
0 3600 373
19 3 3 3 0 0 0 0 0
0 3600 373
20 3 3 3 0 0 0 0 0
0 3600 373

Cisco CMTS Cable Command Reference

1607
 Cable Commands: show a through show cable l
show cable bgsync sync-info cable

21 3 3 3 0 0 0 0 0
0 3600 373
22 3 3 3 0 0 0 0 0
0 3600 373
23 3 3 3 0 0 0 0 0
0 3600 373
24 3 3 3 0 0 0 0 0
0 3600 373
25 3 3 3 0 0 0 0 0
0 3600 373
26 3 3 3 0 0 0 0 0
0 3600 373
27 4 5 5 0 16455 69 0 0
0 12700 282
28 6 7 7 3 0 0 0 0
0 12700 282
29 4 5 5 3 5171 26 0 0
0 11500 294
30 6 7 7 3 0 0 0 0
0 11500 294
31 8 8 8 3 370 5 0 0
0 11500 294
32 4 5 5 3 1277 11 0 0
0 12100 288
33 6 7 7 0 0 0 0 0
0 12100 288
34 4 5 5 0 5164 26 0 0
0 12300 286
35 6 7 7 3 0 0 0 0
0 12300 286
36 8 8 8 0 148 2 0 0
0 12100 288
37 4 5 5 0 5579 27 0 0
0 12700 287
38 6 7 7 3 0 0 0 0
0 12700 287
39 8 8 8 3 370 5 0 0
0 12300 291
40 4 5 5 3 5005 26 0 0
0 13100 283
41 6 7 7 3 0 0 0 0
0 13100 283
42 8 8 8 3 370 5 0 0
0 12700 287
43 8 8 8 3 370 5 0 0
0 12700 287
44 4 5 5 3 5032 27 0 0
0 13100 283
45 6 7 7 3 0 0 0 0
0 13100 283
46 8 8 8 3 444 6 0 0
0 13100 283
47 8 8 8 3 444 6 0 0
0 13100 283
48 4 5 5 3 211 5 0 0
0 14500 269
49 6 7 7 3 0 0 0 0
0 14500 269
50 8 8 8 3 296 4 0 0
0 14500 269
part3 for sid
sid_entry[1] sid 1 service_class 2 create_time 127 total_octets 16455
sid_entry[2] sid 2 service_class 2 create_time 115 total_octets 5579
sid_entry[3] sid 3 service_class 2 create_time 121 total_octets 1277

Cisco CMTS Cable Command Reference

1608
Cable Commands: show a through show cable l
show cable bgsync sync-info cable

sid_entry[4] sid 4 service_class 2 create_time 123 total_octets 5571

sid_entry[5] sid 5 service_class 2 create_time 127 total_octets 5579
sid_entry[6] sid 6 service_class 2 create_time 131 total_octets 5005
sid_entry[7] sid 7 service_class 2 create_time 131 total_octets 5032
sid_entry[8] sid 8 service_class 2 create_time 145 total_octets 211
part4 for cm and cmtx
cm_mac: 68ee.9633.0699, tcsbmp: 0x1, admin_status 1, md_sg_id 0x1510505, rcc_status_id
0x4, rcs_id 0x1520005, tcs_id 0x1, last_reg_time 1444372688, RCP ID:00 10 00 00 10
usch 1, modulation_type 2, rx_power 0, signal_noise 420, time_offset 2085
cm_mac: e448.c70c.96e7, tcsbmp: 0x4, admin_status 1, md_sg_id 0x1510505, rcc_status_id
0x4, rcs_id 0x1520005, tcs_id 0x3, last_reg_time 1444372678, RCP ID:00 10 00 00 08
usch 3, modulation_type 2, rx_power -15, signal_noise 390, time_offset 1785
cm_mac: 0019.474a.c126, tcsbmp: 0x1, admin_status 1, md_sg_id 0x1510505, rcc_status_id
0x0, rcs_id 0x22, tcs_id 0x1, last_reg_time 1444372682, RCP ID:00 00 00 00 00
usch 1, modulation_type 2, rx_power -15, signal_noise 381, time_offset 1792
cm_mac: e448.c70c.982b, tcsbmp: 0x1, admin_status 1, md_sg_id 0x1510505, rcc_status_id
0x4, rcs_id 0x1520005, tcs_id 0x1, last_reg_time 1444372685, RCP ID:00 10 00 00 08
usch 1, modulation_type 2, rx_power -10, signal_noise 390, time_offset 1786
cm_mac: e448.c70c.96d5, tcsbmp: 0x2, admin_status 1, md_sg_id 0x1510505, rcc_status_id
0x4, rcs_id 0x1520005, tcs_id 0x2, last_reg_time 1444372688, RCP ID:00 10 00 00 08
usch 2, modulation_type 2, rx_power -15, signal_noise 390, time_offset 1786
cm_mac: e448.c70c.9819, tcsbmp: 0x1, admin_status 1, md_sg_id 0x1510505, rcc_status_id
0x4, rcs_id 0x1520005, tcs_id 0x1, last_reg_time 1444372692, RCP ID:00 10 00 00 08
usch 1, modulation_type 2, rx_power -10, signal_noise 390, time_offset 1789
cm_mac: e448.c70c.980d, tcsbmp: 0x4, admin_status 1, md_sg_id 0x1510505, rcc_status_id
0x4, rcs_id 0x1520005, tcs_id 0x3, last_reg_time 1444372695, RCP ID:00 10 00 00 08
usch 3, modulation_type 2, rx_power -10, signal_noise 381, time_offset 1783
cm_mac: e448.c70c.96f3, tcsbmp: 0x1, admin_status 1, md_sg_id 0x1510505, rcc_status_id
0x4, rcs_id 0x1520005, tcs_id 0x1, last_reg_time 1444372723, RCP ID:00 10 00 00 04
usch 1, modulation_type 2, rx_power 0, signal_noise 390, time_offset 1798
part5 for dxif info
synced_dxif_cm_status_base[337][1]: cmstatusindex 2375681, cm_mac 68ee.9633.0699, cm_ip
0x5011961F, cm_ds_if 59881, cm_us_if 204952
cmregmode 2, cmmodultype 2, cmdocmode 2
synced_dxif_cm_status_base[337][2]: cmstatusindex 2375682, cm_mac e448.c70c.96e7, cm_ip
0x5011961D, cm_ds_if 59882, cm_us_if 204954
cmregmode 2, cmmodultype 2, cmdocmode 2
synced_dxif_cm_status_base[337][3]: cmstatusindex 2375683, cm_mac 0019.474a.c126, cm_ip
0x50119602, cm_ds_if 59914, cm_us_if 204952
cmregmode 2, cmmodultype 2, cmdocmode 2
synced_dxif_cm_status_base[337][4]: cmstatusindex 2375684, cm_mac e448.c70c.982b, cm_ip
0x50119612, cm_ds_if 59881, cm_us_if 204952
cmregmode 2, cmmodultype 2, cmdocmode 2
synced_dxif_cm_status_base[337][5]: cmstatusindex 2375685, cm_mac e448.c70c.96d5, cm_ip
0x5011960D, cm_ds_if 59881, cm_us_if 204953
cmregmode 2, cmmodultype 2, cmdocmode 2
synced_dxif_cm_status_base[337][6]: cmstatusindex 2375686, cm_mac e448.c70c.9819, cm_ip
0x5011961E, cm_ds_if 59881, cm_us_if 204952
cmregmode 2, cmmodultype 2, cmdocmode 2
synced_dxif_cm_status_base[337][7]: cmstatusindex 2375687, cm_mac e448.c70c.980d, cm_ip
0x5011961A, cm_ds_if 59882, cm_us_if 204954
cmregmode 2, cmmodultype 2, cmdocmode 2
synced_dxif_cm_status_base[337][8]: cmstatusindex 2375688, cm_mac e448.c70c.96f3, cm_ip
0x5011960E, cm_ds_if 59882, cm_us_if 204952
cmregmode 2, cmmodultype 2, cmdocmode 2
part6 uschan for md_idx 337
usport 1 micro_reflections 0 us_snr 420 snmp_sigq_unerroreds 0 snmp_sigq_correcteds 0
snmp_sigq_uncorrectables 0
usport 2 micro_reflections 0 us_snr 390 snmp_sigq_unerroreds 0 snmp_sigq_correcteds 0
snmp_sigq_uncorrectables 0
usport 3 micro_reflections 0 us_snr 381 snmp_sigq_unerroreds 0 snmp_sigq_correcteds 0
snmp_sigq_uncorrectables 0
usport 4 micro_reflections 0 us_snr 0 snmp_sigq_unerroreds 0 snmp_sigq_correcteds 0

Cisco CMTS Cable Command Reference

1609
 Cable Commands: show a through show cable l
show cable bgsync sync-info cable

snmp_sigq_uncorrectables 0
Router#

Related Commands Command Description

cable bgsync Sets the data intervals for background synchronization on the Cisco CMTS.

cable bgsync active Activates background synchronization process on the Cisco CMTS.

clear cable bgsync counters Clears the background synchronization counters on the Cisco CMTS.

Cisco CMTS Cable Command Reference

1610
 Cable Commands: show a through show cable l
show cable bundle

show cable bundle

To display the forwarding table for the specified interface, use the show cable bundle in user EXEC or
privileged EXEC mode.

show cable bundle n [forwarding-table | mobility]

Syntax Description n Specifies the bundle identifier. Valid range is from 1 to 255.

forwarding-table Displays the forwarding table for the specified interface.

mobility Displays the mobility subnet in the bundle interface.

Command Modes
User EXEC or Privileged EXEC

Command History Release Modification

12.0(7)XR2 This command was introduced.

12.0(8) SC This command was supported.

12.1(2) EC1 This command was supported.

12.2(4)BC1 Support was added to the Release 12.2 BC train.

12.1(13)EC, 12.2(11)BC1 The Flags, Location, link, and sublink fields were added to the display to aid in
debugging.

12.3(21)BC All cable bundles are now automatically converted and configured to be in a
virtual bundle, and standalone cable interfaces must be manually configured to
be in a virtual bundle to operate properly. Previously, new virtual interface
bundles and bundle members required reconfiguration, and there could also be
standalone interfaces not part of a bundle at all.

12.2(33)SCH2 This command was modified. The mobility parameter was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines • For uBR series router, beginning with Cisco IOS Release 12.3(21)BC, all cable bundles are automatically
converted and configured to be in a virtual bundle after loading the software image.
• For uBR series router, in releases prior to Cisco IOS Release 12.3(21)BC, if you delete the virtual bundle
interface, the virtual bundle disappears.
• For uBR series router, beginning with Cisco IOS Release 12.3(21)BC, standalone cable interfaces must
be manually configured to be in a virtual bundle to operate properly.
• The virtual bundle interface accumulates the counters from members; counters on member links are not
cleared when they are added to the bundle. If a bundle-only counter is desired, clear the bundle counter
on the members before adding them to the bundle, or before loading the image (for Cisco IOS Release
12.3(21)BC and later).

Cisco CMTS Cable Command Reference

1611
 Cable Commands: show a through show cable l
show cable bundle

Refer to the following document on Cisco.com for additional information about cable interface bundling and
virtual interface bundling on the Cisco CMTS:
• Cable Interface Bundling and Virtual Interface Bundling on the Cisco CMTS

Examples The following is a typical example of the show cable bundle command:

Router# show cable bundle 1 forwarding-table

MAC address Interface Flags Location link sublink
00c0.5e01.0203 Cable8/0/0 3 64E5BF60 0 64E5BE00
00c0.5e01.0203 Cable7/0/0 3 64E5BE00 0 0
00c0.5e01.0101 Cable8/0/0 3 64E5BEE0 0 64E5BE40
00c0.5e01.0101 Cable7/0/0 3 64E5BE40 0 0
00c0.a375.cc1c Cable8/0/0 1 64E5BEC0 0 0
00c0.0e01.a835 Cable8/0/0 1 64E5BEA0 0 0
00c0.0e01.a799 Cable8/0/0 1 64E5BDE0 0 0
00c0.0e01.a405 Cable8/0/0 1 64E5BF00 0 0
00c0.0e01.a5d1 Cable7/0/0 1 64E5BE20 0 0
00c0.0e01.a5d9 Cable8/0/0 1 64E5BE60 0 0
00c0.0e01.a5e1 Cable7/0/0 1 64E5BF40 0 0
00c0.0e01.a5f1 Cable7/0/0 1 64E5BE80 0 0
00c0.0eb4.0a41 Cable5/0/0 1 63704D1C 0 0
00c0.f03b.ed59 Cable6/1/0 1 6370427C 0 0
00c0.f03b.ed97 Cable6/1/0 1 63703F3C 0 0
00c0.0eb4.1373 Cable5/0/0 1 6370479C 0 0
00c0.f03b.edd3 Cable6/1/0 1 637042BC 0 0
00c0.7371.6df6 Cable5/0/0 1 63703DFC 0 0

The table describes the fields shown in the show cable bundle command display.

Table 46: show cable bundle Command Field Descriptions

Field Description

MAC address Identifies the MAC (hardware) address for each interface in the bundle.

Interface Identifies the cable interface slot and port number.

Flag The current value of the flag byte for this bundle entry. The following bits can be set:
• Bit 0 (0x01) = Bundle is active.
• Bit 1 (0x02) = Bundle is a static multicast group.
Note
If more than one bit is set, add the values together. For example, 3 indicates an active, static
multicast group.

Location The location in the router’s memory for the flags byte for this bundle entry. This value is
useful only to TAC engineers during debugging.

link The value of the link pointer for this bundle entry. This value is useful only to TAC engineers
during debugging.

sublink The value of the sublink pointer for this bundle entry. This value is useful only to TAC
engineers during debugging.

Cisco CMTS Cable Command Reference

1612
 Cable Commands: show a through show cable l
show cable bundle

Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp
to show commands using the exec prompt timestamp command in line configuration mode.

The following example shows typical output for the show cable bundle fowarding-table command,
supporting virtual interface bundling on the Cisco CMTS in later 12.3 BC Cisco IOS releases:

Router# show cable bundle 1 forwarding-tableMAC address Interface Flags

Location link sublink
00c0.5e01.0203 Cable8/0/0 3 64E5BF60 0 64E5BE00
00c0.5e01.0203 Cable7/0/0 3 64E5BE00 0 0
00c0.5e01.0101 Cable8/0/0 3 64E5BEE0 0 64E5BE40
00c0.5e01.0101 Cable7/0/0 3 64E5BE40 0 0
00c0.a375.cc1c Cable8/0/0 1 64E5BEC0 0 0
00c0.0e01.a835 Cable8/0/0 1 64E5BEA0 0 0
00c0.0e01.a799 Cable8/0/0 1 64E5BDE0 0 0
00c0.0e01.a405 Cable8/0/0 1 64E5BF00 0 0
00c0.0e01.a5d1 Cable7/0/0 1 64E5BE20 0 0
00c0.0e01.a5d9 Cable8/0/0 1 64E5BE60 0 0
00c0.0e01.a5e1 Cable7/0/0 1 64E5BF40 0 0
00c0.0e01.a5f1 Cable7/0/0 1 64E5BE80 0 0
00c0.0eb4.0a41 Cable5/0/0 1 63704D1C 0 0
00c0.f03b.ed59 Cable6/1/0 1 6370427C 0 0
00c0.f03b.ed97 Cable6/1/0 1 63703F3C 0 0
00c0.0eb4.1373 Cable5/0/0 1 6370479C 0 0
00c0.f03b.edd3 Cable6/1/0 1 637042BC 0 0
00c0.7371.6df6 Cable5/0/0 1 63703DFC 0 0
Total = 18, sublink total = 2
Free = 1016, low_mark = 1016

The following example shows typical output for the show cable bundle mobility command:
Router# show cable bundle 1 mobility

Interface IP/IPv6 Subnet

-------------------------------------------------------------------------------
Bundle1 ---
Bundle1.1 192.0.3.0/16
192.0.3.1/16
192.0.4.1/16
2001:DB:5:4:100::1/32
2001:DB:5:4:101::1/32
Bundle1.2 192.0.3.1/16

Related Commands Command Description

cable bundle Creates an interface bundle.

show ip interface brief Displays a brief summary of an interface's IP information and status,
to include virtual interface bundle information.

show pxf cable (for uBR series Displays multicast echo, packet intercept, or source-verify features
router) for one or all cable interfaces, to include information for virtual
interface bundles.

Cisco CMTS Cable Command Reference

1613
 Cable Commands: show a through show cable l
show cable bundle multicast

show cable bundle multicast

To display Multicast information for the specified virtual interface bundle, based on IGMPv3, use the show
cable bundle multicast command in privileged EXEC mode:

show cable bundle bundle#multicast group

show cable bundle bundle#multicast [MAC addr IP addr]

Syntax Description bundle# The alphanumeric identifier for the virtual interface bundle.

group Multicast group membership identifier.

MAC Optional parameter specifies the MAC address for which to return information.
addr

IP addr Optional parameter specifies the IP address for which to return information.

Command Modes
User EXEC or Privileged EXEC

Command History Release Modification

12.3(21)BC This command was introduced to support virtual interface bundling on the Cisco CMTS.
All cable bundles are now automatically converted and configured to be in a virtual bundle,
and standalone cable interfaces must be manually configured to be in a virtual bundle to
operate properly. Previously, new virtual interface bundles and bundle members required
reconfiguration, and there could also be standalone interfaces not part of a bundle at all.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines • For uBR series router, beginning with Cisco IOS Release 12.3(21)BC, all cable bundles are automatically
converted and configured to be in a virtual bundle after loading the software image.
• For uBR series router, in releases prior to Cisco IOS Release 12.3(21)BC, if you delete the virtual bundle
interface, the virtual bundle disappears.
• For uBR series router, beginning with Cisco IOS Release 12.3(21)BC, standalone cable interfaces must
be manually configured to be in a virtual bundle to operate properly.
• The virtual bundle interface accumulates the counters from members; counters on member links are not
cleared when they are added to the bundle. If a bundle-only counter is desired, clear the bundle counter
on the members before adding them to the bundle, or before loading the image (for Cisco IOS Release
12.3(21)BC and later).
Refer to the following document on Cisco.com for additional information about cable interface bundling and
virtual interface bundling on the Cisco CMTS:
• Cable Interface Bundling and Virtual Interface Bundling on the Cisco CMTS

Examples The following example illustrates this new command. This command translates the bundle’s multicast
MAC address to Multicast IP address information, including the associated multicast source.

Cisco CMTS Cable Command Reference

1614
 Cable Commands: show a through show cable l
show cable bundle multicast

Router# show cable bundle bundle1.1 multicast

CableBundle Interface Source IP Multicast IP MAC Address
1 Bundle1.1 * 230.1.1.1 0100.5e00.0001

The following example illustrates multicast information for the specified virtual bundle:

Router# sh cable bundle 1 multicast

CableBundle Interface Source IP Multicast IP MAC Address
1 Bundle1 * 239.0.0.100 0100.5e00.0001

To translate a MAC address back to Multicast IP address, use the following optional syntax:
show cable bundle bundle# multicast [ <MAC addr | IP addr > ]
The following example illustrates this enhanced show command:

Router# show cable bundle bundleID multicast 0100.5e00.0001

MAC address Interface Flags Location link sublink
0100.5e00.0001 Bundle1 1 646FE4D8 0 646FE4EC
0100.5e00.0001 Cable6/0/0 1 646FE4EC 0 0
^^^^^^^^^^^^^^

Related Commands Command Description

cable bundle Creates an interface bundle.

show ip interface brief Displays a brief summary of an interface's IP information and status,
to include virtual interface bundle information.

show pxf cable (for uBR series Displays multicast echo, packet intercept, or source-verify features
router) for one or all cable interfaces, to include information for virtual
interface bundles.

Cisco CMTS Cable Command Reference

1615
 Cable Commands: show a through show cable l
show cable burst-profile

show cable burst-profile

To display the upstream data burst profiles used to configure the upstream PHY, use the show cable
burst-profile command in privileged EXEC mode.

show cable burst-profile

Note This command has been deprecated and removed in the current versions of the Cisco IOS software for all
Cisco CMTS routers.

Syntax Description This command has no arguments or keywords.

Command Modes
Privileged EXEC

Command History Release Modification

11.3 NA This command was introduced.

11.3(5)NA, 12.0(5)T1, 12.0(6)SC, This command was removed and replaced with the show cable
12.1(2)EC1 modulation-profile command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines This command displayed configuration of the cable burst profiles, which were what DOCSIS initially used
to control the data, ranging, and station maintenance bursts. The Cisco CMTS routers now support a more
comprehensive set of modulation profiles, which are displayed by the show cable modulation-profile
command.

Note The show cable burst-profile command displayed fields and values that were supported only in the initial
versions of the DOCSIS specification. The current DOCSIS 1.0 and 1.1 specifications use different parameters
and values, as shown by the show cable modulation-profile command.

Examples The following example shows typical output from the show cable burst-profile command:

Router# show cable burst-profile

Burst Type Preamb Diff FEC err FEC Scrambl Max Guard Last Scrambl profile
number length size size shortened
1 1 48 no 0x0 0x6 0x152 1 16 1 yes
2 1 48 no 0x0 0x6 0x152 1 12 1 no
3 1 48 no 0x5 0x2C 0x152 0 48 1 yes
4 1 48 no 0x5 0x2C 0x152 0 48 1 yes
5 1 48 no 0x5 0x32 0x152 0 20 1 yes

Cisco CMTS Cable Command Reference

1616
 Cable Commands: show a through show cable l
show cable burst-profile

6 1 48 no 0x0 0x32 0x152 0 20 1 no

Router#

Table 47: show cable burst-profile Field Descriptions

Field Description

Burst profile number The number of the burst profile.

Type Type of burst profile.

Preamb length Length of the preamble.

Diff encode Shows if there is a diff encode.

FEC err correct Shows the forward error correction.

FEC codeword length Shows the length of the forward error correction codeword.

Scrambl seed Shows the seed of the scrambler.

Max size Designates the maximum burst size.

Guard size Indicates the guard time size.

Last codeword shortened Shows the last codeword shortened.

Scrambl Indicates whether scramble is enabled (yes) or not (no).

Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp
to show commands using the exec prompt timestamp command in line configuration mode.

Related Commands Command Description

cable upstream modulation-profile Configures a spectrum group to use a specified frequency.

show cable hop Displays CM configuration settings.

show cable modulation-profile Displays the currently defined modulation profiles.

show interface cable sid Displays cable interface information.

Cisco CMTS Cable Command Reference

1617
 Cable Commands: show a through show cable l
show cable calls

show cable calls

To display voice call history information and status for PacketCable Emergency 911 Services Listing and
History, use the show cable calls command in privileged EXEC mode. This command displays voice call
history information that is enabled with the cable high-priority-call-window command in global configuration
mode.

show cable calls [slot slot/subslot]

Syntax Description interface Selects the interface for which to enable PacketCable E911 call history.

slot Designates the slot or slot and port for a particular cable interface on the Cisco router.
The following are the valid values for the Cisco uBR7246VXR router:
• slot can range from 3 to 6

slot/subslot Designates the slot or slot and port for a particular cable interface on the Cisco router.
The following are the valid values for the Cisco uBR10012 router:
• slot = 5 to 8
• subslot = 0 or 1
The following are the valid values for the Cisco cBR-8 router:
• slot = 0 to 9
• subslot = 0

Command Modes
Privileged EXEC

Command History Release Modification

12.3(13a)BC This command was introduced supporting PacketCable Emergency 911 Services Listing
and History on the Cisco CMTS:
• Cisco uBR7246VXR router
• Cisco uBR10012 router

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.
The value ranges for slot/subslot variables were changed.

Usage Guidelines This command supports the PacketCable Emergency 911 Services Listing and History feature on the Cisco
CMTS. Cisco IOS release 12.3(13a)BC introduces enhanced informational support for PacketCable Emergency
911 calls on the Cisco CMTS, to include the following information and related history:
• active Emergency 911 calls
• recent Emergency 911 calls
• regular voice calls
• voice calls made after recent Emergency 911 calls

Cisco CMTS Cable Command Reference

1618
 Cable Commands: show a through show cable l
show cable calls

To set the call window (in minutes) during which the Cisco CMTS maintains records of Emergency 911 calls,
use the cable high-priority-call-window command. For more information on the cable
high-priority-call-window command, see Cisco IOS CMTS Cable Command reference.
Additional information for voice call support with PacketCable and PacketCable MultiMedia (PCMM) is
available in the following document on Cisco.com:
Cisco CMTS PacketCable and PacketCable Multimedia Features Configuration Guide, Release 12.2SC

Examples The following example illustrates call status on the Cisco CMTS:

Router# show cable calls

Interface ActiveHiPriCalls ActiveAllCalls PostHiPriCallCMs RecentHiPriCMs
Cable3/0 0 0 0 1
Cable3/1 0 0 0 0
Cable4/0 0 0 0 1
Cable4/1 0 0 0 0
Total 0 0 0 2
Router #

The following command example illustrates that one Emergency 911 call was made on the Cable8/1/1
interface on the Cisco uBR10012 router during the window set for high priority calls:

Router# show cable calls

Interface ActiveHiPriCalls ActiveAllCalls PostHiPriCallCMs RecentHiPriCMs
Cable5/0/0 0 0 0 0
Cable5/0/1 0 0 0 0
Cable5/1/0 0 0 0 0
Cable5/1/1 0 0 0 0
Cable5/1/2 0 0 0 0
Cable5/1/3 0 0 0 0
Cable5/1/4 0 0 0 0
Cable6/0/0 0 0 0 0
Cable6/0/1 0 0 0 0
Cable7/0/0 0 0 0 0
Cable7/0/1 0 0 0 0
Cable8/1/0 0 0 0 0
Cable8/1/1 1 1 0 0
Cable8/1/2 0 0 0 0
Cable8/1/3 0 0 0 0
Cable8/1/4 0 0 0 0
Total 1 1 0 0

Related Commands Command Description

cable high-priority-call-window Sets the call window (in minutes) during which the Cisco CMTS maintains
records of Emergency 911 calls.

show cable modem calls Displays voice call information for a particular cable modem.

Cisco CMTS Cable Command Reference

1619
 Cable Commands: show a through show cable l
show cable card

show cable card

To display various upstream/downstream phy and mac devices related information which are needed for
debugging upstream and down stream traffic related issues, use show cable card command in privileged
EXEC mode.

show cable card slot/sub-slot {{ds-mac {all} | {bg} | {index} | {links} | {resources} |
{state}} | {ds-phy{display | trigger}} | {memory [summary]} | {proc-cpu [history |
sorted ]} | {qam-repl {config-validate }| {group [group-id [counters | verbose]]} | {port
downstream port number {{group} | {pilot} | {rf-channel grouplist }}}} | {tech-support} |
{us-mac {config {bpi BPI index segment value } | {bwr physical channel number } | {gs MAC domain
number } | {hwflow physical channel number SID value segment value } | {swflow HW flow value
segment value }} | {counts {all} | {ccf} | {esi} | {frag} | {frame} | {global} | {ilk}
| {interrupt} | {pkt} | {uepi}}} | {us-phy {channel {MG device instance physical channel
number [clear] logical channel number {{all} | {get} | {show IUC number }}} | {fec-summary}}
| {driver [MG device instance ]} | {errors [MG device instance]}}}

Syntax Description slot/sub-slot The slot/sub-slot number. The slot value ranges from 0 to 9 and sub-slot value is
0.

ds-mac Specifies the ds-mac information.

all Specifies all ds-mac information.

bg Specifies ds-mac bg alloc information.

index Specifies ds-mac hw-flow, DSID and BPI index allocation information.

links Specifies ds-mac links information.

resources Specifies ds-mac resources (free/used jib/spr grps).

state Specifies ds-mac state information.

ds-phy Specifies DSPHY commands to collect and display DSPHY related information.

display Specifies DSPHY information collected from hardware.

trigger Specifies DSPHY hardware information collection trigger.

memory Specifies memory information.

summary (Optional) Specifies memory statistics information.

pro-cpu Specifies CPU information.

history (Optional) Displays CPU history in graph format.

sorted (Optional) Displays sorted output based on percentage of utilization.

qam-repl Specifies card level qam-repl information.

config-validate Specifies validate configuration for QAM replication

Cisco CMTS Cable Command Reference

1620
Cable Commands: show a through show cable l
show cable card

group Displays qam-repl group information.

group-id (Optional) The qam-repl group ID. The value ranges from 24576 to 25599.

counters (Optional) Displays counters for QAM replication group.

verbose (Optional) Displays detailed QAM replication group information.

pilot Specifies the pilot channels on the card.

port Specifies the downstream port.

downstream port number The downstream port number. The value ranges from 0 to 7.

rf-channel Displays RF channel information.

group list The list of rf-channels and range of rf-channels.

tech-support Displays technical support information.

us-mac Specifies important us-mac information.

config Specifies us-mac configuration information.

bpi Specifies us-mac BPI configuration information.

BPI index number The BPI index number. The value ranges from 0 to 32767.

segment value The segment value. The value ranges from 1 to 14.

bwr Specifies us-mac bw request configuration information.

physical channel number The physical channel number. The value ranges from 0 to 127.

gs Specifies us-mac gs configuration information.

MAC domain number The MAC domain number. The value ranges from 0 to 127.

hwflow Specifies us-mac HW flow configuration information.

SID value The SID value. The value ranges from 0 to 16383.

swflow Specifies us-mac SW flow configuration information.

HW flow value The HW flow value. The value ranges from 0 to 131071.

counts Displays us-mac count information.

all Displays all us-mac information.

ccf Displays us-mac ccf information.

esi Displays us-mac esi information.

frag Displays us-mac fragment proc information.

frame Displays us-mac frame proc information.

Cisco CMTS Cable Command Reference

1621
 Cable Commands: show a through show cable l
show cable card

global Displays us-mac global information.

ilk Displays us-mac ilk information.

interrupt Displays us-mac interrupt information.

pkt Displays us-mac packet proc information.

uepi Displays us-mac uepi/sgmii information.

us-phy Specifies us-phy related information.

channel Specifies 3142 channel counters.

MG device instance The MG device instance. The value ranges from 0 to 7.

clear Clears the channel counters.

logical channel number The logical channel number. The value ranges from 0 to 1.

get Specifies get IUC from Mg's.

show IUC number Displays dump IUC's.

fec-summary Displays all channels FEC errors.

driver Displays internal driver information.

errors Specifies 3142 error counters.

Command Default None.

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The show cable card command is used for debugging downstream related issues.

Examples The following example shows a typical display for the show cable card command:
Router# sh cab card 3/0 ds-mac ?
all show all ds-mac information
bg show ds-mac bg alloc information
index show ds-mac hw-flow index alloc information
links show ds-mac links information
resources show ds-mac resources (free/used jib/spr grps)
state show ds-mac state information

Cisco CMTS Cable Command Reference

1622
 Cable Commands: show a through show cable l
show cable cgd-associations

show cable cgd-associations

To display the Channel Group Domain (CGD) downstream associations on the Cisco CMTS, use the show
cable cgd-associations command in privileged EXEC mode.

show cable cgd-associations

Syntax Description This command has no arguments or keywords.

Command Modes
Privileged EXEC(#)

Command History Release Modification

12.2(33)SCG This command was introduced.

12.2(33)SCG4 This command was modified.

12.2(33)SCH The output field Active Remote DS was modified to Active DS

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following is a sample output of the show cable cgd-associations command displaying the Cisco
Wideband SPA downstream association with Cisco uBR-MC3GX60V and Cisco uBR-MC20X20V
line cards:

Router# show cable cgd-associations

CGD Host Resource DS Channels Upstreams (AllUS) Active DS
Ca7/1/0 7/1/0 4 0-3 Yes 4

Note In the AllUS field, Yes indicates all the upstream channels are associated with the downstream
channels in the MAC domain. If the AllUS field is blank, all the upstream channels are not associated
with the downstream channels.

This table describes the fields shown in the show cable cgd-associations command display.

Table 48: show cable cgd-associations Field Descriptions

Field Description

CGD Host MAC domain interface for CGD.

Resource Downstream cable interface line card.

DS Channels Downstream RF channels.

Upstreams Association of upstream channels in the MAC domain.

Cisco CMTS Cable Command Reference

1623
 Cable Commands: show a through show cable l
show cable cgd-associations

Field Description

(AllUS) Association of all upstream channels with downstream channels in the MAC domain.

Active Remote DS Active downstream channels.

Note
Effective with Cisco IOS Release 12.2(33)SCG4, the field Active Remote DS has been
modified to Active DS.

Active DS Effective with Cisco IOS Release 12.2(33)SCG4, this field displays active downstream
channels.

Related Commands Command Description

show cable mac-domain cable Displays the summary of the CGD associations for all cable
cgd-associations MAC domains.

show cable mac-domain cable Displays the MAC Domain Downstream Service Group
downstream-service-group information for a primary downstream channel.

Cisco CMTS Cable Command Reference

1624
 Cable Commands: show a through show cable l
show cable channel-group

show cable channel-group

To display the channel group information, use the show cable channel-group command in privileged EXEC
mode.

show cable channel-group {all group-id}

Syntax Description all Displays the channel group information for all channel groups.

group-id Channel group ID. The valid range is from 1 to 1000.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS Release 12.2(33)CX This command was introduced.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

The following is a sample output of the show cable channel-group all command:
Router# show cable channel-group all

--------------------------------------------------------------------------------
Channel Group 1
State: Valid
Host: 8/1/0

Upstream channels (total 1):

Cable8/1/0 channel 1

Downstream channels (total 15):

Modular-Cable 8/1/0 rf-channel 0-14

Associated CMC List (total/registered: 1/0):

MAC Address Registered Offset
0001.0002.0003 N -

--------------------------------------------------------------------------------
Channel Group 710
State: Valid
Host: 7/1/0

Upstream channels (total 4):

Cable7/1/0 channel 0-3

Downstream channels (total 16):

Modular-Cable 7/1/0 rf-channel 0-15

Associated CMC List (total/registered: 4/1):

MAC Address Registered Offset
0010.2024.7035 Y 0

Cisco CMTS Cable Command Reference

1625
 Cable Commands: show a through show cable l
show cable channel-group

badb.ad02.1cca N -
badb.ad02.1cc6 N -
badb.ad02.1cee N -

The following is a sample output of the show cable channel-group 710 command:
Router# show cable channel-group 710

--------------------------------------------------------------------------------
Channel Group 710
State: Valid
Host: 7/1/0

Upstream channels (total 4):

Cable7/1/0 channel 0-3

Downstream channels (total 16):

Modular-Cable 7/1/0 rf-channel 0-15

Associated CMC List (total/registered: 4/1):

MAC Address Registered Offset
0010.2024.7035 Y 0
badb.ad02.1cca N -
badb.ad02.1cc6 N -
badb.ad02.1cee N -

The table below describes the significant fields in the output of the show cable channel-group
command.

Table 49: show cable channel-group Field Descriptions

Field Description

Channel Group Channel group ID.

State State of the channel group.

Host Host name for the channel group.

Upstream channels (total number) Upstream channel information.

Downstream channels (total number) Downstream channel information.

Associated CMC List (total/registered: Information on the associated Cisco CMCs.

number/number)

MAC Address MAC address of the Cisco CMC.

Registered Indicates if the Cisco CMC is registered.

Offset Internal index of the Cisco CMC in the channel group.

Related Commands Command Description

cable channel-group Configures channel group.

Cisco CMTS Cable Command Reference

1626
Cable Commands: show a through show cable l
show cable channel-group

Command Description

upstream cable channel Configures upstream cable channel for a channel

group.

downstream modular-cable rf-channel Configures downstream modular cable RF channel

for a channel group.

cmc Configures Cisco CMC in a channel group.

Cisco CMTS Cable Command Reference

1627
 Cable Commands: show a through show cable l
show cable clock

show cable clock

To display clock reference status information for the clock card and to display information about displaying
Timing, Communicaton and Control (TCC) card DOCSIS Timimg Interface (DTI) client and server statistic
counts, use the show cable clock command in user EXEC or privileged EXEC mode.

Cisco uBR Series Router

show cable clock [slot] {client port id | server port id | counters}

Cisco cBR Series Router

show cable clock dti {client | server} slot/subslot

Syntax Description slot (Optional) Identifies a TCC interface on the Cisco RF Gateway 10. Valid TCC slots are 13
and 14.

client port id Specifies the DTI client port ID. Valid port values are 1 and 2.

server port Specifies the DTI server port ID. Valid port values are 1 and 2.
id

counters Specifies the DTI client counters.

slot/subslot Specifies the slot and subslot location of the DTCC ports. Valid values are 4/1 or 5/1.

Command Default Information on the TCC DTI client and server is displayed. Counters are not displayed.

Command Modes
User EXEC or Privileged EXEC

Command History Release Modification

12.1(1a)T1 This command was introduced.

12.1(2)EC1 This command was supported on the EC train.

12.2(1)XF1, 12.2(4)BC1 This command was supported for the Cisco uBR10012 universal broadband router.

12.3(23)BC This command was supported for DTI mode.

12.2(44)SQ This command was modified in Cisco IOS Release 12.2(44)SQ to support the
Cisco RF Gateway 10. The slot, client, server, and counters options were added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Routers. The dti keyword was added.

Usage Guidelines This command supports the Cisco CMTS clock feature set, which provides a synchronized clock for improved
Voice-over-IP (VoIP) operations. The clock feature set requires one of the following configurations:
• A Cisco uBR10012 router with one or two TCC+ cards that are connected to an external national clock
source.

Cisco CMTS Cable Command Reference

1628
 Cable Commands: show a through show cable l
show cable clock

Note Beginning in Cisco IOS Release 12.3(23)BC, TCC+ is replaced with DOCSIS Timing and Control Card
(DTCC).

• A Cisco uBR7246 VXR router using a Cisco uBR-MC16S, Cisco uBR-MC16E, Cisco uBR-MC28C, or
Cisco uBR-MC28C-BNC cable interface line card. The router must also be equipped with a Cisco cable
clock card and be running Cisco IOS 12.1(1a)T1, 12.1(2)EC1, or a later release. The Cisco cable clock
card should be connected to an external national clock source.
Only these cable interface cards support the external clock card reference from a clock card to distribute that
signal to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other cable
interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable interfaces will not
synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. For example, the Cisco
uBR924, running Cisco IOS Release 12.0(7)T or later, supports clock card feature automatically.

Note This command does not appear if a clock card is not installed in the system.

Examples The following sample output from the show cable clock command on a Cisco uBR7246VXR router
shows that both external sources are available and the clock card is providing the clock reference:

Router# show cable clock

Clockcard primary input is present

Clockcard secondary input is present
Cable clock reference is clockcard primary input
Cable3/0 Timestamp clock reference is from Clockcard
Cable4/0 Timestamp clock reference is from Clockcard

The following sample output from the show cable clock command on a Cisco uBR10012 router
shows that both external sources are available and that the TCC+ card in slot 1/1 is providing the
clock reference:

Router# show cable clock

Number of TCCplus Cards in the Chassis: 2

Active TCCplus Card is in slot: 1 subslot: 1
Backup TCCplus Card is in slot: 2 subslot: 1
Clock reference used by the active card is Primary T1
External T1 References:
Card: 1/1
Primary T1 : Available
Secondary T1: Available
Card: 2/1
Primary T1 : Available
Secondary T1: Available

The following sample output from the show cable clock command on a Cisco uBR10012 router
shows that the TCC+ card in slot 1/1 is in maintenance mode, and that the TCC+ card in slot 2/1 is
providing the clock reference:

Cisco CMTS Cable Command Reference

1629
 Cable Commands: show a through show cable l
show cable clock

Router# show cable clock

Number of TCCplus Cards in the Chassis: 2

TCCplus card in 1/1 under maintenance
Active TCCplus Card is in slot: 2 subslot: 1
Clock reference used by the active card is Primary T1
External T1 References:
Card: 2/1
Primary T1 : Available
Secondary T1: Available

Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp
to show commands using the exec prompt timestamp command in line configuration mode.

The following sample output from the show cable clock command on a Cisco uBR10012 router
shows that the DTCC card in slot 1/1 is in DTI mode.

Router# show cable clock

Number of TCC Cards in the Chassis: 1

Active TCC Card is in slot: 1 subslot: 1,(DTCC Eightbells card)
Clock reference used by the active card is DTI
Active TCC card in slot 1/1
TCC Card 1/1 DTI status:
-------------------------------------------
Active Client port : 2
Active Client status : normal
Active Client Server status : freerun
Active Client frame error rate : < 2%
Active Client CRC error count : 0xAD
Standby Client Signal detected : yes
No card in slot 2/1

Cisco RF Gateway 10
The following example shows the TCC DTI client and server statistic counts information:

Router# show cable clock

DTI Client status: TCC 13
-----------------
Client status : normal
Client clock type : ITU type 1
Client firmware version : 7
Client dti version : 0
Client timestamp : 657519453
Client phase correction : 65535
Client normal time : 65535
Client holdover time : 0
Client transition t3 count : 0
Client transition t4 count : 1
Client transition t6 count : 0
Client transition t7 count : 0
Client port switch count : 1
Client Integral Frequency Term : 64518
Client EFC Value : 63282
DTI Client Port 1 Status:

Cisco CMTS Cable Command Reference

1630
Cable Commands: show a through show cable l
show cable clock

-------------------------
Port Status : Active
Signal detected : yes
CRC error count : 2
Frame error rate : < 2%
Cable advance : 2560
-- Connected server information ---
Server status : Active free-run
Root Server clock type : ITU type 3
Root Server source : none
Server Type : Root
Client Performance Stable : yes
Client Cable advance Valid : yes
DTI Client Port 2 Status:
-------------------------
Port Status : Inactive
Signal detected : no
CRC error count : 66
Frame error rate : > 5%
Cable advance : 0
DTI Client status: TCC 14
-----------------
Client status : normal
Client clock type : ITU type 1
Client firmware version : 7
Client dti version : 0
Client timestamp : 672169320
Client phase correction : 65535
Client normal time : 65535
Client holdover time : 0
Client transition t3 count : 0
Client transition t4 count : 1
Client transition t6 count : 0
Client transition t7 count : 0
Client port switch count : 1
Client Integral Frequency Term : 64760
Client EFC Value : 63832
DTI Client Port 1 Status:
-------------------------
Port Status : Inactive
Signal detected : no
CRC error count : 26
Frame error rate : > 5%
Cable advance : 0

DTI Client Port 2 Status:

-------------------------
Port Status : Active
Signal detected : yes
CRC error count : 2
Frame error rate : < 2%
Cable advance : 1792
-- Connected server information ---
Server status : Active free-run
Root Server clock type : ITU type 3
Root Server source : none
Server Type : Root
Client Performance Stable : yes
Client Cable advance Valid : yes

The following is sample output of a TCC card in slot 13 on a Cisco RF Gateway 10:

Router#show cable clock 13 client 1

DTI Client Port 1 Status:

Cisco CMTS Cable Command Reference

1631
 Cable Commands: show a through show cable l
show cable clock

-------------------------
Port Status : Inactive
Signal detected : no
CRC error count : 63006
Frame error rate : > 5%
Cable advance : 0x0000

Table 50: show cable clock client Field Descriptions

Field Description

Port status Indicates the current status of the DTI port on the TCC card.

Signal detected Indicates whether the DTI signal was detected.

CRC error count The number of cyclic redundancy check (CRC) errors. It can indicate intermittent upstream,
laser clipping, or common-path distortion.

The following example shows the server status of the TCC card in slot 13 on a Cisco RFGW-10:

Router#show cable clock 13 server 2

TCC Card 13 port 2 DTI Server status:
--------------------------------------
Server signal detected : yes
Server status : free-run
Root Server clock type : ITU type 3
Root Server source : none
Server Type : Root
Client Performance Stable : yes
Client Cable advance Valid : yes
TOD Setting Mode : Short
TOD gpssec : 902825745
TOD leap seconds : 14

Table 51: show cable clock server Field Descriptions

Field Description

Server signal detected Indicates whether the server was detected.

Server status Indicates the state in which the serer is functioning. The states are warm-up, free-run
state, fast mode, normal, holdover, or bridge mode.

Root server source The server source such as internal, external, GPSor none.

Root server clock type The clock type. The types are 1, 2, 3 or ITU Stratum 3 or DTI Min. clock.

TOD setting mode Displays the time (user time, NTP, GPS) mode such as short or long.

The following is a sample output showing the counters on TCC card 13 on Cisco RFGW-10:

Router#show cable clock 13 counters

TCC Card 13 DTI counters:
-------------------------
Client Normal time : 0x1EB6
Client Holdover time : 0x0000
Client Phase Correction : 0
Client Freq Correction : 63213

Cisco CMTS Cable Command Reference

1632
 Cable Commands: show a through show cable l
show cable clock

Client EFC Correction : 61039

Client transition count t3 : 0
Client transition count t4 : 1
Client transition count t6 : 0
Client transition count t7 : 0
Client port switch count : 1

Related Commands Command Description

show controllers clock-reference Displays hardware information, register values, and current counters for
the cable clock card.

show cable clock dti status Displays information on the DOCSIS Timing Interface (DTI) Client
status.

cable clock free-run Allows the clock to be in free-run mode.

clear cable clock counters Clears DTI client transition counters of a TCC DTI client and server.

Cisco CMTS Cable Command Reference

1633
 Cable Commands: show a through show cable l
show cable clock dti counters

show cable clock dti counters

To display DTI counters for the clock card, use the show cable clock dti counters command in user EXEC
or privileged EXEC mode.

show cable clock dti counters slot/subslot

Syntax Description slot/subslot Specifies the slot and subslot location of the DTCC ports. Valid values are 1/1 or 2/1.

Command Modes
User EXEC or Privileged EXEC

Command History Release Modification

12.3(23)BC This command was supported for DTI mode.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following is a sample output from the show cable clock dti counters command in user EXEC
mode:

Router> show cable clock dti counters 1/1

TCC Card 1/1 DTI counters:
-------------------------------------------
Client Normal time : 0xFFFF
Client Holdover time : 0x0000
Client Phase Correction : 0x0000
Client Freq Correction : 0xFBD7
Client EFC Correction : 0xF7AD
Client transition count t3 : 0x00
Client transition count t4 : 0x01
Client transition count t6 : 0x00
Client transition count t7 : 0x00

Related Commands Command Description

cable clock dti clear-counters Resets the counters that are displayed with the show cable clock dti
counters command.

show cable clock dti status Displays information on the DOCSIS Timing Interface (DTI) Client status.

Cisco CMTS Cable Command Reference

1634
 Cable Commands: show a through show cable l
show cable clock dti status

show cable clock dti status

To display information on the DOCSIS Timing Interface (DTI) Client status, use the show cable clock dti
status command in privileged EXEC mode.

show cable clock dti status

Syntax Description This command has no arguments or keywords.

Command Modes
Privileged EXEC

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use this command to display information on the DTI Client status.

Examples The following is a sample output from the show cable clock dti command:

Router# show cable clock dti status

Status of DTI component:
Active TCC card in slot 1/1
TCC Card 1/1 DTI status:
-------------------------------------------
Active Client port : 2
Active Client status : normal
Active Client Server status : freerun
Active Client frame error rate : < 2%
Active Client CRC error count : 0x06
Standby Client Signal detected : no
No card in slot 2/1

Related Commands Command Description

show cable Displays clock reference status information for the clock card.
clock

Cisco CMTS Cable Command Reference

1635
 Cable Commands: show a through show cable l
show cable cmc

show cable cmc

To display the Cisco CMC information, use the show cable cmc command in privileged EXEC mode.

show cable cmc [summary | cmc-value {cap | dom | ds_cnt | frx_info | info | modem | spec-analysis
upstream_id low_freq high_freq | us_uepi_cnt | verbose}]

Syntax Description summary Optional. Displays a summary of the Cisco CMC.

cmc-value Optional. Specifies the details of the Cisco CMC.

• mac-address —MAC address of the Cisco CMC.
• ip-address—IP address of the Cisco CMC.
• cmc-index—Cisco CMC ID. The valid range is from 1 to 4096.

cap Displays the Cisco CMC capability information

dom Displays the digital diagnostic monitoring information of the optical transceivers
on Cisco CMC.

ds_cnt Displays the downstream counter information for Cisco CMC.

frx_info Displays the FRx information for the Cisco CMC.

info Displays the Cisco CMC information.

modem Displays the information for the cable modem associated with the Cisco CMC.

spec-analysis upstream_id Displays the spectrum monitoring information for the upstream of Cisco CMC.
low_freq high_freq
• upstream_id — ID of the upstream.
• low_freq— The lowest frequency of the spectrum. The valid range is from
5000 to 85000.
• high_freq— The highest frequency of the spectrum. The valid range is
from 5000 to 85000.

us_uepi_cnt Displays the upstream UEPI counter information for Cisco CMC.

verbose Displays the detailed information for Cisco CMC.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS Release 12.2(33)CX This command was introduced.

Cisco CMTS Cable Command Reference

1636
Cable Commands: show a through show cable l
show cable cmc

Release Modification

Cisco IOS Release 12.2(33)CY This command was modified. The dom and spec-analysis keyword was
added, the verbose keyword was modified.
Note
Cisco CMC image cmc-16x4-os-1.2.bin is required to use these command
options.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged
Broadband Routers.

The following is a sample output of the show cable cmc command:

Router# show cable cmc

MAC Address IP Address State Group Offset CMCID Conn ID IF

0010.2024.7035 192.168.0.4 online 710 1 2 0xF0000 Gi7/1/0

The table below describes the significant fields in the output of the show cable cmc command.

Table 52: show cable cmc Field Descriptions

Field Description

MAC Address MAC address of the Cisco CMC.

IP Address IP address assigned to the Cisco CMC.

State Current state of the Cisco CMC.

• Offline: CMC is not operational
• Reject(i): IP assign failed
• Init(d): DHCP discovery
• Init(g): GCP connection establishing
• Init(est): GCP connection established
• Init(c): Get CMC Capability
• Init(s): Download configuration to CMC
• Reject(c): Get CMC Capability failed
• Online: CMC is operational

Group Channel group ID to which the Cisco CMC is

assigned.

Offset Internal index of the Cisco CMC in the channel group.

CMC ID Cisco CMC ID.

Cisco CMTS Cable Command Reference

1637
 Cable Commands: show a through show cable l
show cable cmc

Field Description

Conn ID GCP connection ID per

Cisco uBR-MC3GX60V-RPHY line card.

IF Interface to which the Cisco CMC is connected.

The following is a sample output of the show cable cmc summary command:
Router# show cable cmc summary

Gi7/1/0 :1

The following is a sample output of the show cable cmc command, which displays the capability
information for the Cisco CMC with MAC address 0010.2024.7035:
Router# show cable cmc 0010.2024.7035 cap

cmcDsChanNum : 16
cmcUsChanNum : 4
IsFRxEmbeded : 0

The table below describes the significant fields in the output of the show cable cmc cap command.

Table 53: show cable cmc cap Field Descriptions

Field Description

cmcDsChanNum Number of downstream channels on the Cisco CMC.

cmcUsChanNum Number of upstream channels on the Cisco CMC.

IsFRxEmbeded Indicates if the FRx is installed in the Cisco CMC.

The following is a sample output of the show cable cmc command, which displays the digital
diagnostic monitoring information for the Cisco CMC with MAC address 0004.9f01.9100:
Router# show cable cmc 0004.9f01.9100 dom
Optical Optical
Temperature Voltage Current Tx Power Rx Power
Port (Celsius) (volts) (mA) (dBm) (dBm)
----- ---------- ------- ------ ------- -------
G0/0 30.01 3.29 7.24 -4.05 -33.00
Router# show cable cmc 0004.9f01.9100 dom detail
High Alarm High Warn Low Warn Low Alarm
Temperature Threshold Threshold Threshold Threshold
Port (Celsius) (Celsius) (Celsius) (Celsius) (Celsius)
----- ---------- --------- --------- --------- ---------
G0/0 30.05 109.00 103.00 -13.00 -29.00
High Alarm High Warn Low Warn Low Alarm
Voltage Threshold Threshold Threshold Threshold
Port (volts) (volts) (volts) (volts) (volts)
----- ---------- --------- --------- --------- ---------
G0/0 3.29 3.90 3.70 2.90 2.70
High Alarm High Warn Low Warn Low Alarm
Current Threshold Threshold Threshold Threshold
Port (mA) (mA) (mA) (mA) (mA)
----- ---------- --------- --------- --------- ---------

Cisco CMTS Cable Command Reference

1638
Cable Commands: show a through show cable l
show cable cmc

G0/0 7.18 15.00 12.00 2.00 1.00

Optical High Alarm High Warn Low Warn Low Alarm
Tx Power Threshold Threshold Threshold Threshold
Port (dBm) (dBm) (dBm) (dBm) (dBm)
----- ---------- --------- --------- --------- ---------
G0/0 -4.06 -1.09 -1.09 -11.00 -11.07
Optical High Alarm High Warn Low Warn Low Alarm
Rx Power Threshold Threshold Threshold Threshold
Port (dBm) (dBm) (dBm) (dBm) (dBm)
----- ---------- --------- --------- --------- ---------
G0/0 -33.09 0.09 -1.00 -18.00 -20.00

The table below describes the significant fields in the output of the show cable cmc dom command.

Table 54: show cable cmc dom Field Descriptions

Field Description

Temperature Internally measured transceiver temperature.

Voltage Internally measured transceiver supply voltage.

Current Measured transmitter bias current in μA.

Optical Tx Power Measured transmitter output power in mW.

Optical Rx Power Measured receiver received average optical power in

mW.

High Alarm Threshold Upper limit to trigger alarm.

High Warn Threshold Upper limit to trigger warning.

Low Alarm Threshold Lower limit to trigger alarm.

Low Warn Threshold Lower limit to trigger warning.

The following is a sample output of the show cable cmc command, which displays the downstream
counter information for the Cisco CMC with ID 2:
Router# show cable cmc 2 ds_cnt

IpVerErr : 0
IpLenErr : 0
IpChsmErr : 0
QamChanMismatchErr : 47523
SeqMismatchErr : 0
MpegLenErr : 0
L2TPv3HdrErr : 0
DLMPacketCounter : 0
DepiCtrlPacketCounter : 0
NonDepiPacketCounter : 255
GCPPacketCounter : 232
DepiChanPacketCounter QAMchaID : 0
DepiPacketCounter : 2303083
DepiChanPacketCounter QAMchaID : 1
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 2
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 3
DepiPacketCounter : 1063

Cisco CMTS Cable Command Reference

1639
 Cable Commands: show a through show cable l
show cable cmc

DepiChanPacketCounter QAMchaID : 4
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 5
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 6
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 7
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 8
DepiPacketCounter : 2302517
DepiChanPacketCounter QAMchaID : 9
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 10
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 11
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 12
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 13
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 14
DepiPacketCounter : 1063
DepiChanPacketCounter QAMchaID : 15
DepiPacketCounter : 1063

The table below describes the significant fields in the output of the show cable cmc ds_cnt command.

Table 55: show cable cmc ds_cnt Field Descriptions

Field Description

IpVerErr Number of IP version errors.

IpLenErr Number of IP length errors.

IpChsmErr Number of checksum errors in the IP header.

QamChanMismatchErr Number of QAM channel mismatch errors.

SeqMismatchErr Number of sequence mismatch errors.

MpegLenErr Number of MPEG length errors.

L2TPv3HdrErr Number of L2TPv3 header errors.

DLMPacketCounter Number of DEPI Latency Measurement (DLM)

packets.

DepiCtrlPacketCounter Number of DEPI control packets.

NonDepiPacketCounter Number of non-DEPI control packets.

GCPPacketCounter Number of GCP packets.

DepiChanPacketCounter QAMchaID Number of DEPI channel packets for the specified

QAM channel ID.

DepiPacketCounter Number of DEPI packets.

Cisco CMTS Cable Command Reference

1640
Cable Commands: show a through show cable l
show cable cmc

The following is a sample output of the show cable cmc command, which displays the FRx
information for the Cisco CMC with ID 1
Router# show cable cmc 1 frx_info

FrxControllerType : 8581
FrxSerialNumber : ABCDEFGHIJK
FrxPID : 12345678
FrxVID : V01
FrxHWVersion : 0.1
FrxSWId : FRx_0.00.06
FrxTemperature : 14.5 Celsius Degree
FrxTimeInService : 300 day
FrxOpticalStatus : No optical input
FrxAgcStatus : Out of range
FrxOpticalLevelInput : -16.0 dBm
FrxAtt : 0 dB
FrxEQ : 3 dB

The table below describes the significant fields in the output of the show cable cmc frx_info
command.

Table 56: show cable cmc frx_info Field Descriptions

Field Description

FrxControllerType Controller used to identify the FRx.

FrxSerialNumber Serial number of the FRx.

FrxPID Product Identifier (PID) of the FRx.

FrxVID Version Identifier (VID) of the FRx.

FrxHWVersion Hardware version of the FRx.

FrxSWId Software version of the FRx.

FrxTemperature Temperature of the FRx.

FrxTimeInService Time for which the FRx is in service.

FrxOpticalStatus Status of the optical input power on the FRx.

FrxAgcStatus Status of Automatic Gain Control (AGC) on the FRx.

FrxOpticalLevelInput Optical input power level of the FRx.

FrxAtt FRx attenuation value in dB.

FrxEQ FRx equalization value in dB.

The following is a sample output of the show cable cmc command, which displays the information
for the Cisco CMC with MAC address 0010.2024.7035:
Router# show cable cmc 0010.2024.7035 info

Load for five secs: 5%/0%; one minute: 6%; five minutes: 6%
Time source is NTP, 04:06:39.772 UTC Mon Feb 24 2014

Cisco CMTS Cable Command Reference

1641
 Cable Commands: show a through show cable l
show cable cmc

cmcModeName : DOCSIS-CMC-4P-FN
cmcDescription : 0
cmcVendorName : 0
cmcSerialNumber : CSJ13152101
cmcHWVersion : 1.0
cmcSWVersion : 0.10(Feb 18 10:40:03 CST 2014)
cmcTimeInService : 237616

The table below describes the significant fields in the output of the show cable cmc info command.

Table 57: show cable cmc info Field Descriptions

Field Description

cmcModeName Product number of the Cisco CMC.

cmcDescription Description of the Cisco CMC.

cmcVendorName Vendor name for the Cisco CMC.

cmcSerialNumber Serial number of the Cisco CMC.

cmcHWVersion Version number of the Cisco CMC hardware.

cmcSWVersion Version number of the Cisco CMC software.

cmcTimeInService Time for which the Cisco CMC is in service.

The following is a sample output of the show cable cmc command, which displays the modem
information for the Cisco CMC with MAC address 0010.2024.7035:
Router# show cable cmc 0010.2024.7035 modem
D
MAC Address IP Address I/F MAC Prim RxPwr Timing Num I
State Sid (dBmv) Offset CPE P
e448.c7bf.80aa 192.168.0.2 C7/1/0/UB w-online(pt) 1 !-3.00 2089 0 N

The table below describes the significant fields in the output of the show cable cmc modem command.

Table 58: show cable cmc modem Field Descriptions

Field Description

MAC Address MAC address of the cable modem.

IP Address IP address assigned to the cable modem.

I/F Interface to which the cable modem is connected.

MAC State State of the cable modem.

Prim Sid Primary service ID assigned to the cable modem.

RxPwr (dBmv) Power received at the cable modem in dBmV.

Cisco CMTS Cable Command Reference

1642
Cable Commands: show a through show cable l
show cable cmc

Field Description

Timing Offset Timing offset for the cable modem, in ticks, as

recognized on the Cisco CMTS. A tick is 6.25/64
microseconds. This is the delay between the time
when the cable modem is scheduled to make a
transmission and when the Cisco CMTS actually
receives it.

Num CPE Number of Customer Premises Equipments (CPE).

The following is a sample output of the show cable cmc command, which displays the spectrum
monitoring information for the Cisco CMC with MAC address 0004.9f01.9100:
Router# show cable cmc 0004.9f01.9100 spec-analysis 1 5000 85000
Spectrum Analysis Measurements for CMC spectrum-analysis upstream channel 1
Number of Bins: 251
Bin Spacing: 320 KHz
Resolution Bandwidth: 320 KHz
Amplitude Data:
Bin Num(spec)---------------------------dBmv---------------------------------
0000( 5000KHz) -49.00 -46.00 -48.00 -49.00 -49.00 -45.00 -48.00 -52.00
0008( 7560KHz) -52.00 -52.00 -60.00 -55.00 -49.00 -60.00 -52.00 -49.00
0016(10120KHz) -52.00 -55.00 -60.00 -60.00 -60.00 -52.00 -52.00 -55.00
0024(12680KHz) -49.00 -52.00 -49.00 -49.00 -55.00 -52.00 -55.00 -49.00
0032(15240KHz) -55.00 -55.00 -49.00 -48.00 -52.00 -60.00 -55.00 -52.00
0040(17800KHz) -49.00 -46.00 -48.00 -46.00 -45.00 -49.00 -43.00 -44.00
0048(20360KHz) -46.00 -48.00 -46.00 -55.00 -52.00 -55.00 -52.00 -52.00
0056(22920KHz) -48.00 -52.00 -52.00 -48.00 -55.00 -55.00 -55.00 -52.00
0064(25480KHz) -55.00 -52.00 -48.00 -49.00 -55.00 -60.00 -48.00 -46.00
0072(28040KHz) -55.00 -48.00 -44.00 -48.00 -55.00 -55.00 -49.00 -43.00
0080(30600KHz) -46.00 -55.00 -52.00 -52.00 -60.00 -48.00 -49.00 -49.00
0088(33160KHz) -46.00 -49.00 -49.00 -44.00 -46.00 -48.00 -49.00 -55.00
0096(35720KHz) -52.00 -48.00 -48.00 -46.00 -48.00 -55.00 -48.00 -45.00
0104(38280KHz) -45.00 -49.00 -48.00 -49.00 -55.00 -52.00 -46.00 -52.00
0112(40840KHz) -60.00 -52.00 -48.00 -52.00 -55.00 -48.00 -46.00 -48.00
0120(43400KHz) -52.00 -60.00 -52.00 -46.00 -48.00 -55.00 -48.00 -49.00
0128(45960KHz) -55.00 -55.00 -48.00 -52.00 -52.00 -60.00 -55.00 -52.00
0136(48520KHz) -55.00 -52.00 -52.00 -52.00 -60.00 -47.00 -48.00 -45.00
0144(51080KHz) -46.00 -49.00 -52.00 -55.00 -52.00 -60.00 -60.00 -55.00
0152(53640KHz) -55.00 -55.00 -60.00 -55.00 -60.00 -60.00 -55.00 -55.00
0160(56200KHz) -55.00 -52.00 -48.00 -52.00 -60.00 -60.00 -55.00 -52.00
0168(58760KHz) -52.00 -52.00 -55.00 -55.00 -48.00 -55.00 -55.00 -49.00
0176(61320KHz) -46.00 -46.00 -48.00 -55.00 -55.00 -49.00 -46.00 -46.00
0184(63880KHz) -49.00 -55.00 -55.00 -55.00 N/A N/A N/A N/A
0192(66440KHz) N/A N/A N/A N/A N/A N/A N/A N/A
0200(69000KHz) N/A N/A N/A N/A N/A N/A N/A N/A
0208(71560KHz) N/A N/A N/A N/A N/A N/A N/A N/A
0216(74120KHz) N/A N/A N/A N/A N/A N/A N/A N/A
0224(76680KHz) N/A N/A N/A N/A N/A N/A N/A N/A
0232(79240KHz) N/A N/A N/A N/A N/A N/A N/A N/A
0240(81800KHz) N/A N/A N/A N/A N/A N/A N/A N/A
0248(84360KHz) N/A N/A N/A

The following is a sample output of the show cable cmc command, which displays the upstream
UEPI count information for the Cisco CMC with MAC address 0010.2024.7035:
Router# show cable cmc 0010.2024.7035 us_uepi_cnt

logicChannelID: 0, CounterType: DataPacketCounter, CounterValue: 11

logicChannelID: 0, CounterType: DataByteCounter, CounterValue: 3715

Cisco CMTS Cable Command Reference

1643
 Cable Commands: show a through show cable l
show cable cmc

logicChannelID: 0, CounterType: RngReqPacketCounter, CounterValue: 274

logicChannelID: 0, CounterType: RngReqByteCounter, CounterValue: 56444
CounterType: BwReqPacketCount, CounterValue: 34
CounterType: BwReqByteCounter, CounterValue: 2176

The following is a sample output of the show cable cmc command, which displays the detailed
information for the Cisco CMC with MAC address 0010.2024.7035:
Router# show cable cmc 0002.3dfe.fe01 verbose

Primary Mac Address : 0002.3dfe.fe01

IP Address : 192.80.0.2
Last IP Address : 0.0.0.0
IP Mode : DHCP
State : online
Next Hop Hw Address : 0002.3dfe.fe01
Next Hop IP Address : 0.0.0.0
Online Time : 325285 seconds
ARP Enabled : FALSE
Reason : unknown
Ds8/0/0:0 Frequency: 626.000 MHz
Ds8/0/0:1 Frequency: 634.000 MHz
Ds8/0/0:2 Frequency: 642.000 MHz
Ds8/0/0:3 Frequency: 650.000 MHz
Ds8/0/0:4 Frequency: 658.000 MHz
Ds8/0/0:5 Frequency: 666.000 MHz
Ds8/0/0:6 Frequency: 674.000 MHz
Ds8/0/0:7 Frequency: 682.000 MHz
Us8/0/0:0 Frequency: 60.000 MHz
Us8/0/0:1 Frequency: 53.600 MHz
Us8/0/1:0 Frequency: 60.000 MHz

The table below describes the significant fields in the output of the show cable cmc verbose command.

Table 59: show cable cmc verbose Field Descriptions

Field Description

Primary MAC Address MAC address of the Cisco CMC.

IP Address IP address assigned to the Cisco CMC.

Last IP Address Previous IP address assigned to the Cisco CMC.

IP Mode IP mode of the Cisco CMC.

State State of the Cisco CMC.

Next Hop Hw Address The hardware address of the CMTS's next hop
between CMTS and CMC.

Next Hop IP Address The IP address of the CMTS's next hop between
CMTS and CMC.

Online Time Time, in seconds, for which the Cisco CMC is online.

ARP Enabled Indicates if ARP is enabled.

Reason Reason for the previous reset of the Cisco CMC.

Cisco CMTS Cable Command Reference

1644
 Cable Commands: show a through show cable l
show cable cmc

Related Commands Command Description

cable cmc Configures the downstream RF power and FRx on

the Cisco CMC.

clear cable cmc Clears the information on the Cisco CMC.

Cisco CMTS Cable Command Reference

1645
 Cable Commands: show a through show cable l
show cable cmts-id

show cable cmts-id

To display the configured CMTS ID, use the show cable cmts-id command in privileged EXEC mode.

show cable cmts-id

Syntax Description This command has no keywords or arguments.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Example
The following is a sample output of the show cable cmts-id command:
Router# show cable cmts-id

Configured CMTSID is:9000

Related Commands Command Description

cable cmts-id Configures the CMTS ID.

Cisco CMTS Cable Command Reference

1646
 Cable Commands: show a through show cable l
show cable depi multicast

show cable depi multicast

To display the DEPI multicast information, use the show cable depi multicast command in privileged EXEC
mode.

Cisco cBR Series Converged Broadband Router

show cable depi multicast [ counter { Downstream-Cable | interface | ip { ip_address | ipv6
ipv6_address ] ip { ip_address | all } | ipv6 { ipv6_address | all } | pool [ id id | ipv4 |
ipv6 [ id id ]]}

Syntax Description ip ip_address Assigned IP address.

ipv6 ipv6_address Assigned IPv6 address.

id id DEPI multicast pool ID.

ipv6 id id IPv6 DEPI multicast pool ID.

counter Statistics information of each group

Downstream-Cable Downstream-Cable controller

interface Interface of DPIC

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Bengaluru 17.6.1z This counter statement is introduced for the Cisco cBR Series Converged
Broadband Routers.

Cisco IOS XE Fuji 16.7.1 This command is introduced for the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use this command to display the DEPI multicast information.

The following example shows the IPv6 multicast DEPI pool:

Router#show cable depi multicast pool ipv6

Load for five secs: 8%/2%; one minute: 7%; five minutes: 8%
No time source, *06:57:11.898 UTC Sun Oct 22 2017
POOL ID IPv6 DESCRIPTION
22 FF3B::8000:0/100
50 FF3A::8000:0/126 zyq
100 FF39::8000:0/120 zyq

Infra_C05#show cable depi multicast pool ipv6 id 22

Load for five secs: 8%/2%; one minute: 8%; five minutes: 8%
No time source, *07:00:03.577 UTC Sun Oct 22 2017
POOL ID IPv6 DESCRIPTION

Cisco CMTS Cable Command Reference

1647
 Cable Commands: show a through show cable l
show cable depi multicast

22 FF3B::8000:0/100

The following example shows the assigned IPv6 multicast address:

Router#show cable depi multicast ipv6 all

Load for five secs: 10%/3%; one minute: 8%; five minutes: 8%
No time source, *07:01:33.659 UTC Sun Oct 22 2017
IPv6 POOL ID CONTROLLER
FF3A::8000:0 50 9/0/2(291)
FF3A::8000:1 50 9/0/28(317)
FF39::8000:0 100 9/0/29(318)
FF3A::8000:2 50 9/0/30(319)

The following example shows the statistics information of each group:

Router#show cable depi multicast counter

IP POOL ID pps bps IF
Controller
225.225.225.0 1 4686 39335848 Te3/1/0
DS3/0/1

Cisco CMTS Cable Command Reference

1648
 Cable Commands: show a through show cable l
show cable device access-group

show cable device access-group

To display a list of CMs and their customer premises equipment (CPE) devices, along with their access groups,
use the show cable device access group command in privileged EXEC mode.

show cable device [ip-address] access-group

Note The show cable device access-group command is not supported on the Cisco uBR10012 universal broadband
router.

Syntax Description ip-address (Optional) Specifies the IP address for a particular CM or host.

Command Modes
Privileged EXEC

Command History Release Modification

11.NA This command was introduced.

12.1(3a)EC1 Support was added to the Release 12.1 EC train.

12.2(4)BC1 Support was added to the Release 12.2 BC train for the Cisco uBR7100 series and Cisco
uBR7200 series routers. (This command might appear in the CLI for the Cisco uBR10012
router but is not functional.)

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command displays information about both CMs and their associated CPE devices. To display information
only for hosts and other CPE devices, use the show cable host access-group command. To display information
only for CMs, use the show cable modem access-group command.
If an SNMP manager is requesting information about CM or CPE devices at the same time that this command
is given, the command displays the following error message:

No information is available, please try later.

Wait until the SNMP retrieval is done and retry the CLI command.

Examples The following example shows how to display a list of the CMs and their hosts:

Router# show cable device access-group

MAC address IP address Type Access-group

00d0.ba77.7595 10.20.114.34 modem resident
0020.4065.828c 10.27.29.128 modem resident
0080.c6f9.b42e 24.168.220.52 host
0020.7806.defe 192.168.28.134 host
0020.4066.5c5c 10.27.33.128 modem resident

Cisco CMTS Cable Command Reference

1649
 Cable Commands: show a through show cable l
show cable device access-group

0050.baa0.5ccd 24.168.223.251 host

0020.4070.56d8 10.27.29.129 modem resident
0050.046f.f4cf 192.168.33.25 host
0020.40b4.0c80 10.27.33.129 modem resident
0050.bacf.5d89 192.168.37.113 host
0020.4071.698e 10.27.29.130 modem resident
0050.1800.a8cb 192.168.33.90 host
0020.407a.c196 10.27.33.130 modem resident
0040.d00f.44f0 192.168.34.128 host
0020.407f.0c2c 10.27.33.131 modem resident
0050.e456.9641 192.168.39.66 host
0020.4071.65de 10.27.29.131 modem resident
0050.badd.2883 192.168.32.230 host
0020.4071.64b4 10.27.29.132 modem resident
0050.badd.3b12 192.168.33.246 host
00D0.ba41.41fc 10.27.33.132 modem resident
0020.78c7.f887 192.168.32.32 host
00D0.ba3d.871e 10.27.29.133 modem resident
00e0.2969.a1a5 192.168.36.246 host
00D0.ba40.fff3 10.27.29.135 modem resident
0020.78d5.ddf0 192.168.32.107 host
00001.02c5.9936 192.168.38.233 host
00D0.ba40.fe30 10.27.33.157 modem resident
0020.78d0.fb32 192.168.28.45 host
00D0.ba3b.e08d 10.27.33.158 modem resident
0050.1800.f458 192.168.36.209 host
0002.e301.df8f 192.168.30.191 host
00D0.ba3e.7b9c 10.27.29.158 modem resident
00a0.2451.b7eb 24.168.223.41 host
00D0.ba3c.3ff2 10.27.29.160 modem resident
0080.c7db.afba 192.168.33.153 host
00D0.2717.1899 192.168.39.189 host
00D0.ba33.a164 10.27.33.161 modem resident
Router#

This table describes the fields that are shown in the show cable device access-group display:

Table 60: Descriptions for the show cable device access-group Fields

Field Description

MAC Address The MAC address for the CM or CPE device.

IP Address The IP address that the DHCP server has assigned to the CM or CPE device.

Type Identifies the type of device:

• host = CPE device
• modem = cable modem

Access-group Displays the access group name or number in use (if any) for this CM or CPE device.

Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp
to show commands using the exec prompt timestamp command in line configuration mode.

Cisco CMTS Cable Command Reference

1650
 Cable Commands: show a through show cable l
show cable device access-group

Related Commands Command Description

cable device Configures the access list for a CM device or host.

cable host access-group Configures the access list for the specified hosts.

clear cable host Clears the host from the table.

show cable host access-group Displays the hosts behind the CMs in the network, along with their
access groups.

show cable modem access-group Displays the access groups for the CMs on a particular cable interface.

Cisco CMTS Cable Command Reference

1651
 Cable Commands: show a through show cable l
show cable downstream controller-profile

show cable downstream controller-profile

To display the cable downstream controller profile, use the show cable downstream controllerprofile
command in privileged EXEC mode.

Cisco cBR Series Converged Broadband Router

show cable downstream controller profile id

Syntax Description profile id Profile

identifiler.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Fuji This command was introduced on the Cisco cBR Series Converged Broadband
16.7.1 Routers.

Usage Guidelines Use this command to verify the cable downstream controller profile.

The following example shows the sample output for the show cable downstream controllerprofile
command:

Router#show cable downstream controller-profile 100

Load for five secs: 24%/3%; one minute: 10%; five minutes: 8%
No time source, *07:10:28.074 UTC Sun Oct 22 2017

Downstream controller-profile 100, type RPHY

Description:
Downstream controller-profile 100 is being used by controller Downstream-Cable:
0/0/30,
Admin: UP
MaxOfdmSpectrum: 192000000
MaxCarrier: 158
Mode: normal
Free freq block list has 3 blocks:
45000000 - 449999999
594000000 - 602999999
795000000 - 1217999999
DS Splitting: Yes
Multicast Pool ID: 50
OFDM frequency exclusion bands: None

Configured RF Channels:
Chan Admin Frequency Type Annex Mod srate Qam-profile dcid output
0 UP 453000000 DOCSIS B 256 5361 1 1 NORMAL
1 UP 459000000 DOCSIS B 256 5361 1 2 NORMAL
2 UP 465000000 DOCSIS B 256 5361 1 3 NORMAL

Cisco CMTS Cable Command Reference

1652
 Cable Commands: show a through show cable l
show cable dp aqm

show cable dp aqm

To display cable dataplane aqm information, use the show cable dp aqmcommand in Privileged EXEC mode.

show cable dp aqm { Cable | Downstream-Cable | Integrated-Cable | Wideband-Cable }

slot/subslot/port:interface-number { hist | low-latency }

Syntax Description aqm Specifies cable dataplane aqm information.

Cable Specifies CMTS interface.

Downstream-Cable Specifies downstream cable interface.

Integrated-Cable Specifies integrated cable interface.

Wideband-Cable Specifies wideband CMTS interface.

slot/subslot/port:interface-number • slot/subslot - The slot/subslot where the linecard

resides.
• port - Downstream controller number on the
linecard.
• interface-number - The cable interface number.

hist Specifies the latency histogram stats, if available.

low-latency Specifies the low latency flow stats.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Dublin 17.12.1x You can used this command to view Queue protection Statistics.

Cisco IOS XE Cupertino 17.9.1x This command is introduced on Cisco cBR Series Converged Broadband
Routers.

Usage Guidelines The show cable dp aqm command displays queue information for the specified interface.

Examples The following example shows a typical display for the show cable dp aqm command:
Router# show cable dp aqm wi1/0/1:1
MAC Address I/F Sfid class-name Length/ Dequeues qDrops/ rDrops/ pDrops Marked
Target
Max Sanctions Sanctions
Latency(ms)
0cb9.3772.7c9c Ca1/0/1 16 class-default 34/255 425769 5952339 5904109 0 0
10

Cisco CMTS Cable Command Reference

1653
 Cable Commands: show a through show cable l
show cable dp aqm

0cb9.3772.7c9c Ca1/0/1 46 4class-map 35/255 3768835 10146943 6378108 0 0

10
Router# show cable dp aqm wi1/0/1:1 low-latency
MAC Address I/F Sfid class-name Length/ Dequeues qDrops/ rDrops/ Marked ECT(1) ECT(0)
Target
Max Sanctions Sanctions
Latency(ms)
0cb9.3772.7c9c Ca1/0/1 46 4class-map 35/255 3768835 10146943 6378108 0 0 3768835
10
Router# show cable dp aqm wi1/0/1:1 hist
MAC Address I/F Sfid class-name Dequeues qDrops/ Target updt_ Max Range Lo-
pac-
Sanctions Latency(ms) num (ms) Hi(ms)
kets
0cb9.3772.7c9c Ca1/0/1 46 4class-map 3987667 10736054 10 3.959M 0.00 - 0.20
18
0.20 - 0.40
0
0.40 - 0.60
3
0.60 - 0.80
30
0.80 - 1.00
57
1.00 - 1.20
89
1.20 - 1.40
97
1.40 - 1.60
3958731
1.60 - 1.80
5
1.80 - 2.00
5
2.00 - 2.20
4
2.20 - 2.40
1
2.40 - 2.60
2
2.60 - 2.80
6
2.80 - 3.00
8
3.00 - Inf.
87

Related Commands Command Description

show cable dp pfg Displays cable dataplane packet filter group information.

Cisco CMTS Cable Command Reference

1654
 Cable Commands: show a through show cable l
show cable dp pfg

show cable dp pfg

To display cable dataplane packet-filter-group information, use show cable dp pfg command in Privileged
EXEC mode.

show cable dp pfg group { group-id| all }

Syntax Description pfg Specifies cable dataplane packet-filter-group information.

group Specifies cable filter group number.

group-id Specifies the group-id. The valid range is from 1 to 255.

all Display information for all group-id values.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The show cable dp pfg command displays packet-filter-group information.

Examples The following example shows a typical display for the show cable dp pfg command:
CBR8#show cable dp pfg group 1
Extended IP access list CMTS_PKT_FILTER_GROUP_1
51200 permit ip any any (8 matches)
IPv6 access list CMTS_PKT_FILTER_GROUP_IPV6_1 (TCAM loaded) (hidden) (refcount: 1)
permit tcp any range 0 65535 any range 0 65535 flow-label 1111 sequence 200
permit udp any range 0 65535 any range 0 65535 flow-label 1111 sequence 201
permit ipv6 any any sequence 51200

Related Commands Command Description

show cable dp queue Displays cable dataplane queue information.

Cisco CMTS Cable Command Reference

1655
 Cable Commands: show a through show cable l
show cable dp queue

show cable dp queue

To display cable dataplane queue information, use show cable dp queue command in Privileged EXEC mode.

show cable dp queue { Integrated-Cable | Wideband-Cable }slot/subslot/port:interface-number

Syntax Description queue Specifies cable dataplane queue information.

Integrated-Cable Specifies integrated cable interface.

Wideband-Cable Specifies wideband CMTS interface.

slot/subslot/port:interface-number • slot/subslot - The slot/subslot where the linecard

resides.
• port - Downstream controller number on the
linecard.
• interface-number - The cable interface number.

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The show cable dp queue command displays queue information for the specified interface.

Examples The following example shows a typical display for the show cable dp queue command:
Router# sh cable dp queue wi2/0/2:2
MAC Address I/F Sfid Flg class-name Length/Max Dequeues qDrops
pDrops
0025.2e2d.7986 Ca2/0/10 190 class-default 0/63 0 0
0
0025.2e2d.7986 Ca2/0/10 205 16--class-map 0/63 0 0
0
0025.2e2d.7968 Ca2/0/10 192 class-default 0/63 7 0
0
0025.2e2d.7968 Ca2/0/10 206 16--class-map 0/63 0 0
0
0025.2e2d.762c Ca2/0/10 194 class-default 0/63 7 0
0
0025.2e2d.762c Ca2/0/10 207 16--class-map 0/63 0 0
0
0025.2e2d.762e Ca2/0/10 196 class-default 0/63 7 0
0
0025.2e2d.762e Ca2/0/10 208 16--class-map 0/63 0 0
0
0025.2e2d.7806 Ca2/0/10 198 class-default 0/63 7 0
0
0025.2e2d.7806 Ca2/0/10 210 16--class-map 0/63 0 0
0

Cisco CMTS Cable Command Reference

1656
 Cable Commands: show a through show cable l
show cable dp queue

0025.2e2d.7776 Ca2/0/10 200 class-default 0/63 7 0

0
0025.2e2d.7776 Ca2/0/10 209 16--class-map 0/63 0 0
0
0025.2e2d.77ea Ca2/0/10 202 class-default 0/63 7 0
0
0025.2e2d.77ea Ca2/0/10 211 16--class-map 0/63 0 0
0
0025.2e2d.7630 Ca2/0/10 204 class-default 0/63 7 0
0
0025.2e2d.7630 Ca2/0/10 212 16--class-map 0/63 0 0
0
Flags Legend:
$: Low Latency Queue (aggregated)
~: CIR Queue
#: Byte Queue Limit

Related Commands Command Description

show cable dp pfg Displays cable dataplane packet filter group information.

Cisco CMTS Cable Command Reference

1657
 Cable Commands: show a through show cable l
show cable dsg

show cable dsg

To display the current DOCSIS Set-Top Gateway (DSG) tunneling parameters, use the show cable dsg
command in privileged EXEC mode.

show cable dsg {stats | tunnel} [vendor CA-vendor-nametunnel-mac-address]

Syntax Description stats Displays configuration and run-time statistics about the currently-defined DSG
tunnels.

tunnel Displays the mapping of DSG tunnels to vendors or well-known MAC addresses.

vendor CA-vendor-name (Optional) Displays information about a specific Conditional Access (CA) vendor.
This parameter can be any arbitrary string up to 8 characters in length.

tunnel-MAC-address (Optional) Displays information for the specified well-known MAC address for
the DSG tunnel. If you specify a MAC address of 0000.0000.0000, the command
displays information for all DSG tunnels, which is the default display.

Command Default Displays information for all DSG tunnels.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(15)BC2 This command was introduced for the Cisco uBR7100 series and Cisco uBR7246VXR
routers.

12.3(9a)BC This command was introduced on the Cisco uBR10012 router.

12.3(13a)BC This command is obsolete and replaced by the show cable dsg tunnel command.

IOS-XE 3.15.0S This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples The following example shows a typical display for the show cable dsg tunnel form of the command:

Router# show cable dsg tunnel

Group-ip Src-ip Tunnel-MAC Interface Packets CA-vendor

225.2.2.2 * 0001.0002.0003 Cable3/0 1589 BBB
230.6.6.6 * 000d.000d.000d Cable3/0 12868464 abc
230.7.7.7 * 000e.000e.000e Cable3/0 24330138 abc
230.4.4.4 * 000b.000b.000b Cable3/0 22008648 cisco
230.5.5.5 * 000c.000c.000c Cable3/0 6424012 abc
229.1.1.1 * 0009.0009.0009 Cable3/0 12868440 cisco
228.1.1.1 * 0008.0008.0008 Cable3/0 6424012 cisco
230.1.1.1 * 000a.000a.000a Cable3/0 24370812 cisco
230.8.8.8 * 000f.000f.000f Cable3/0 23035116 abc
Router#

The following example shows a typical display for the show cable dsg stats command:

Cisco CMTS Cable Command Reference

1658
Cable Commands: show a through show cable l
show cable dsg

Router# show cable dsg stats

DSG statistics information

DSG keepalive is set
Vendor: DDD, Tunnel count: 1
Vendor: BBB, Tunnel count: 2
Vendor name is DDD, tunnel MAC is 0001.0002.0003
Group address is 226.2.2.2, source address is *
Interface is Cable5/1, mapping entry is used 1
Received 5968 packets, forwarded 5289 packets
Dropped 679 packets, last second rate 16878 bits/sec
Vendor name is BBB, tunnel MAC is 0009.0010.0011
Group address is 227.2.2.2, source address is *
Interface is Cable3/0, interface Cable3/0 is bundle master
mapping entry is used 2
Received 0 packets, forwarded 0 packets
Dropped 0 packets, last second rate 0 bits/sec
Vendor name is CCC, tunnel MAC is 0005.0006.0007
Group address is 228.3.3.3, source address is *
Interface is Cable5/1, mapping entry is used 2
Received 5970056 packets, forwarded 400333 packets
Dropped 5569723 packets, last second rate 96768 bits/sec
Router#

The following example shows a typical display for the show cable dsg stats command for an
individual vendor:

Router# show cable dsg stats vendor CCC

DSG statistics information

DSG keepalive is set
Vendor: CCC, Tunnel count: 1
Vendor name is CCC, tunnel MAC is 0005.0006.0007
Group address is 228.3.3.3, source address is *
Interface is Cable5/1, mapping entry is used 2
Received 5970056 packets, forwarded 400333 packets
Dropped 5569723 packets, last second rate 96768 bits/sec
Router#

Note The packet counters for both the stats and tunnel options for a particular DSG tunnel continue to
increase as long as traffic is received over that tunnel. If the tunnel does not receive any traffic for
three minutes or more, the counters are automatically reset to 0.

The following example shows a typical display for the show cable dsg stats command for an
individual vendor when the associated cable interface is shut down. The Received, Forwarded, and
Dropped counters are not displayed when an interface is shut down.

Router(config)# interface c5/1

Router(config-if)# shutdown

Router(config-if)# exit

Router(config)# exit

Router# show cable dsg stats vendor CCC

Cisco CMTS Cable Command Reference

1659
 Cable Commands: show a through show cable l
show cable dsg

DSG statistics information

DSG keepalive is set
Vendor: CCC, Tunnel count: 1
Vendor name is CCC, tunnel MAC is 0005.0006.0007
Group address is 228.3.3.3, source address is *
Interface is Cable5/1, mapping entry is used 2
Router#

Table 0-1 describes the major fields shown in the show cable dsg command:

Table 61: show cable dsg Field Descriptions

Field Description

DSG keepalive is set If keepalive messages have been enabled for an IP multicast group, using the cable
dsg keepalive command, this message is displayed.

Dest-ip, Group address Multicast group IP address for the DSG stream.

Src-ip, Source address Source IP address for the DSG stream. If an asterisk (*) appears as the source IP
address, it indicates that the source IP address is 0.0.0.0, which allows any IP
address as the source IP address.

Mapped-MAC, Well-known MAC address used for the DSG tunnel. If you configured the DSG
Tunnel-MAC tunnel with a MAC address of 0000.0000.0000 using the cable dsg command, this
field shows the MAC address that the CMTS derived using the MAC to IP multicast
addressing mapping that is specified in RFC 1112.

Interface Cable interface on which this DSG tunnel is configured.

mapping entry is used Number of times that this particular DSG tunnel mapping has been used to resolve
the well-known MAC address from the tunnel’s group address. This can be used
as a very rough approximation of the number set-top boxes (STBs) that have been
mapped to this DSG tunnel since the last time the counter was cleared.
Note
Use the clear cable dsg command to clear this counter.

Packets Number of packets transmitted over the DSG tunnel.

CA-vendor Name for the Conditional Access (CA) vendor that owns this tunnel.

Received Number of packets received by the multicast group. This counter includes all
interfaces that are receiving traffic for the multicast group. The field is not shown
when an interface is shut down, but the counter continues to increase as long as
the multicast group is receiving traffic. When the interface is reenabled, the counter
shows the latest number of packets received.

Forwarded Number of packets forwarded on the cable interface for the multicast group. This
counter is reset to 0 whenever an interface is shut down and reenabled. The field
is not shown when an interface is shut down.

Cisco CMTS Cable Command Reference

1660
 Cable Commands: show a through show cable l
show cable dsg

Field Description

Dropped Number of packets that were dropped that were for the multicast group. This counter
includes all interfaces that are receiving traffic for the multicast group. The field
is not shown when an interface is shut down, but the counter continues to increase
as long as the multicast group is receiving traffic and dropping packets. When the
interface is reenabled, the counter shows the latest number of packets dropped.

Note The Received and Dropped counters reflect activity for the multicast group and are not affected when
a cable interface is shut down and reenabled, as long as the multicast group continues to receive
traffic. The Forwarded counter reflects activity for the particular cable interface and is reset to zero
whenever the interface is shut down and reenabled. All packet counters are also automatically reset
to zero if the DSG tunnel does not receive traffic for three minutes or more.

Related Commands Command Description

cable dsg Enables the DOCSIS Set-Top Gateway (DSG) on a cable interface, and configures its
tunnel-mapping parameters.

cable dsg keepalive Enables keepalive messages over DOCSIS Set-Top Gateway (DSG) tunnels on a cable
interface.

clear cable dsg Resets counters related to DOCSIS Set-Top Gateway (DSG) tunnels.

debug cable dsg Enables the display of debugging messages for the operation of the DOCSIS Set-Top
Gateway (DSG) feature.

Cisco CMTS Cable Command Reference

1661
 Cable Commands: show a through show cable l
show cable dsg cfr

show cable dsg cfr

To display DOCSIS Set-Top Gateway (DSG) classifier details, such as the classifier state, source, and
destination IP addresses, use the show cable dsg cfr command in privileged EXEC mode.

show cable dsg cfr [index] [verbose]

Syntax Description index DSG classifier identification. The valid range is from 1 to 65535.

verbose Provides detailed output for DSG classifiers.

Command Default Displays details of all DSG classifiers.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples The following is a sample output of the show cable dsg cfr command that shows details of all DSG
classifiers:

Router# show cable dsg cfr

cfr id state resolved applied conflict dest-ip src-ip
-------------------------------------- ----------------- -----------------
1000 en yes yes no 232.10.10.0 dsg-server-a
(40.0.0.30)
1010 en yes yes no 232.10.10.10 dsg-server-b
(40.0.0.40)
2000 en yes yes no 232.10.11.0 dsg-server-c
(40.0.0.50)
2010 en no no no 232.10.11.10 non-exist-hostnam
(----)

The following is a sample output of the show cable dsg cfr command that shows details of a specified
DSG classifier:

Router# show cable dsg cfr 1010

cfr id state resolved applied conflict dest-ip src-ip
-------------------------------------- ----------------- ---------------
1010 en yes yes no 232.10.10.10 dsg-server-b
(40.0.0.40)

The following is a sample output of the show cable dsg cfr command with the verbose keyword that
shows detailed output for all DSG classifiers:

Router# show cable dsg cfr verbose

Cfr Id : 1000
State : enable

Cisco CMTS Cable Command Reference

1662
Cable Commands: show a through show cable l
show cable dsg cfr

Resolved : yes
Applied : yes
Conflict : no
Conflict Cfr Id : --
Error Code : 0(DSG_CFR_ERR_NONE)
Tunnel Id : 1000
Dest Hostname : ----
Dest Hostname IP : ----
Dest IP : 232.10.10.0
Src Hostname : dsg-server-a
Src Hostname IP : 40.0.0.30
Src IP : 40.0.0.30
Src Prefix Length : 32
Dest Port Start : 2000
Dest Port End : 13821
Priority : 1
In DCD : yes
Forwarded : 0
Received : 0
Cfr Id : 1010
State : enable
Resolved : yes
Applied : yes
Conflict : no
Conflict Cfr Id : --
Error Code : 0(DSG_CFR_ERR_NONE)
Tunnel Id : 1010
Dest Hostname : ----
Dest Hostname IP : ----
Dest IP : 232.10.10.10
Src Hostname : dsg-server-b
Src Hostname IP : 40.0.0.40
Src IP : 40.0.0.40
Src Prefix Length : 32
Dest Port Start : 2000
Dest Port End : 13821
Priority : 1
In DCD : yes
Forwarded : 0
Received : 0
Cfr Id : 2000
State : enable
Resolved : yes
Applied : yes
Conflict : no
Conflict Cfr Id : --
Error Code : 0(DSG_CFR_ERR_NONE)
Tunnel Id : 2000
Dest Hostname : ----
Dest Hostname IP : ----
Dest IP : 232.10.11.0
Src Hostname : dsg-server-c
Src Hostname IP : 40.0.0.50
Src IP : 40.0.0.50
Src Prefix Length : 32
Dest Port Start : 13822
Dest Port End : 13822
Priority : 1
In DCD : yes
Forwarded : 0
Received : 0
Cfr Id : 2010
State : enable
Resolved : no

Cisco CMTS Cable Command Reference

1663
 Cable Commands: show a through show cable l
show cable dsg cfr

Applied : no
Conflict : no
Conflict Cfr Id : --
Error Code : 0(DSG_CFR_ERR_NONE)
Tunnel Id : 2010
Dest Hostname : ----
Dest Hostname IP : ----
Dest IP : 232.10.11.10
Src Hostname : non-exist-hostname
Src Hostname IP : ----
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 2000
Dest Port End : 13821
Priority : 1
In DCD : yes
Forwarded : 0
Received : 0
Cfr Id : 3000
State : enable
Resolved : yes
Applied : yes
Conflict : no
Conflict Cfr Id : --
Error Code : 0(DSG_CFR_ERR_NONE)
Tunnel Id : 3000
Dest Hostname : ----
Dest Hostname IP : ----
Dest IP : 239.10.11.11
Src Hostname : ----
Src Hostname IP : ----
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 2000
Dest Port End : 13821
Priority : 1
In DCD : yes
Forwarded : 0
Received : 0

The following is a sample output of the show cable dsg cfr command with the verbose keyword that
shows detailed output for a single DSG classifier:

Router# show cable dsg cfr 1010 verbose

Cfr Id : 1010
State : enable
Resolved : yes
Applied : yes
Conflict : no
Conflict Cfr Id : --
Error Code : 0(DSG_CFR_ERR_NONE)
Tunnel Id : 1010
Dest Hostname : ----
Dest Hostname IP : ----
Dest IP : 232.10.10.10
Src Hostname : dsg-server-b
Src Hostname IP : 40.0.0.40
Src IP : 40.0.0.40
Src Prefix Length : 32
Dest Port Start : 2000
Dest Port End : 13821
Priority : 1
In DCD : yes

Cisco CMTS Cable Command Reference

1664
Cable Commands: show a through show cable l
show cable dsg cfr

Forwarded : 0
Received : 0

This table describes the significant fields shown in the show cable dsg cfr command display:

Table 62: show cable dsg cfr Field Description

Field Description

cfr id DSG classifier ID.

state DSG classifier state shown either as “enable” or “disable.”

resolved Indicates whether the destination and source IP addresses of a hostname are resolved or
not.

applied Indicates that a hostname is configured without any error.

conflict Indicates that the IP address of the hostname is changed after the hostname is configured,
and the DSG classifier cannot be updated due to an error.

dest-ip IP address configured as the destination IP address or the resolved hostname IP address.
This IP address might differ from the destination hostname IP address if the classifier is
not applied or in a conflict state.

src-ip IP address configured as the source IP address or the resolved hostname IP address. This
IP address might differ from the source hostname IP address if the classifier is not applied
or in a conflict state.

Conflict Cfr Id Indicates the classifier ID that conflicts with the new classifier due to an identical MAC
address or classifier ID.

Error Code Indicates why the classifier is resolved but cannot be applied.

Tunnel Id DSG tunnel ID.

Dest Hostname The hostname configured as the destination IP address.

Dest Hostname IP Resolved IP address of the destination hostname.

Src Hostname The hostname configured as the source IP address.

Src Hostname IP Resolved IP address of the source hostname.

Src Prefix Length Source prefix length of the source IP address.

Dest Port Start Start range for the Destination TCP/UDP port.

Dest Port End End range for the Destination TCP/UDP port.

Priority DSG classifier priority.

In DCD Indicates whether the DSG classifier is included or excluded from the downstream channel
descriptor (DCD) message.

Forwarded Forwarded statistics.

Cisco CMTS Cable Command Reference

1665
 Cable Commands: show a through show cable l
show cable dsg cfr

Field Description

Received Received statistics.

Related Commands Command Description

show cable dsg host Displays the mapping of the DSG host names and IP addresses on the Cisco CMTS
router.

Cisco CMTS Cable Command Reference

1666
 Cable Commands: show a through show cable l
show cable dsg host

show cable dsg host

To display the mapping of the hostnames and IP addresses on a Cisco CMTS router, use the show cable dsg
host command in privileged EXEC mode.

show cable dsg host [verbose]

Syntax Description verbose Provides verbose description on the mapping of the hostnames and IP addresses.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The show cable dsg host command is used for debugging of host IP addresses.

Examples The following is a sample output of the show cable dsg host command that shows the mapping of
the host names and IP addresses on a Cisco CMTS router:

Router# show cable dsg host

Host IP Address Reference Last Update Time
dsgserver1 232.1.1.10 2 21:41 08/01/2011
dsgserver2 234.3.2.1 1 21:41 08/01/2011
dsgserver3 ---- 1 never
dsgserver4 ---- 1 never
dsgserver5 ---- 1 never
dsgserver6 235.5.5.5 1 21:41 08/01/2011
dsgserver7 235.0.0.2 1 21:41 08/01/2011

The following is a sample output of the show cable dsg host command with the verbose keyword
on a Cisco CMTS router:

Router# show cable dsg host verbose

Host IP Address Reference Last Update Time
dsgserver1 232.1.1.10 2 21:41 08/01/2011
Cfrs:
cable dsg cfr 2 dest-ip 232.1.1.125 tunnel 1 priority 0 src-ip a.b.c.d d...
cable dsg cfr 3 dest-ip 232.1.1.125 tunnel 1 priority 10 src-ip a.b.c.d ...
dsgserver2 234.3.2.1 1 21:41 08/01/2011
Cfrs:
cable dsg cfr 4 dest-ip aaabbccc priority 0 src-ip cccdddeee disable
dsgserver3 ---- 1 never
Cfrs:
cable dsg cfr 4 dest-ip aaabbccc priority 0 src-ip cccdddeee disable
dsgserver4 235.0.0.2 1 21:41 08/01/2011
Cfrs:
cable dsg cfr 24 dest-ip g2 priority 0 disable
dsgserver5 235.0.0.3 1 21:41 08/01/2011

Cisco CMTS Cable Command Reference

1667
 Cable Commands: show a through show cable l
show cable dsg host

Cfrs:
cable dsg cfr 30 dest-ip g3 tunnel 1 priority 0 disable

This table describes the significant fields shown in the show cable dsg host command display:

Table 63: show cable dsg host Field Description

Field Description

Host Hostname of the DSG classifier.

IP Address IP address that is mapped to the hostname.

Reference DSG classifiers that use the host as a fully-qualified domain name (FQDN).

Last Update Time Last updated time of the DSG server.

Related Commands Command Description

show cable dsg cfr Displays DSG classifier details.

Cisco CMTS Cable Command Reference

1668
 Cable Commands: show a through show cable l
show cable dsg static-group bundle

show cable dsg static-group bundle

To display details of the DOCSIS Set-Top Gateway (DSG) static groups configured under a bundle interface,
use the show cable dsg static-group bundle command in privileged EXEC mode.

show cable dsg static-group bundle index

Syntax Description index Bundle interface number. The valid range is from 1 to 255.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCG This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines The IGMP static group IP address created automatically under a bundle interface at the time of DSG
configuration is not displayed in the show running-config interface command output in Cisco IOS Release
12.2(33)SCG and later. To display the DSG static groups configured under a bundle interface, use the show
cable dsg static-group bundle command in privileged EXEC mode in Cisco IOS Release 12.2(33)SCG and
later.

Examples The following is a sample output of the show cable dsg static-group bundle command that lists the
DSG static groups configured under a bundle interface on the Cisco uBR10012 router:

Router# show cable dsg static-group bundle 2

Bundle Interface Group Source
Bundle2 228.0.0.1 0.0.0.0
Bundle2 228.0.0.1 1.2.3.4
Bundle2 232.1.1.1 2.3.4.5

This table describes the significant fields shown in the show cable dsg static-group bundle command
display:

Table 64: show cable dsg static-group bundle Command Field Description

Field Description

Bundle Interface Bundle interface number.

Group DSG static group configured under the specified bundle interface.

Source SSM source address.

Cisco CMTS Cable Command Reference

1669
 Cable Commands: show a through show cable l
show cable dsg static-group bundle

Related Commands Command Description

cable dsg Enables Advanced-mode DOCSIS Set-Top Gateway (A-DSG) classifiers on the Cisco CMTS
cfr router.

Cisco CMTS Cable Command Reference

1670
 Cable Commands: show a through show cable l
show cable dsg tg

show cable dsg tg

To display information about the Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnel group
configuration on a Cisco CMTS router, use the show cable dsg tg command in privileged EXEC mode.

show cable dsg tg [tunnel-group-id {channel channel-id} [verbose]

Syntax Description tunnel-group-id (Optional) Alphanumeric identifier for a specified tunnel group.

channel channel-id Specifies the DSG tunnel group channel identifier.

verbose (Optional) Displays DSG tunnel group detail information.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(17a)BC This command was introduced to support A-DSG on the Cisco uBR10012
router and Cisco uBR7200 series routers.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.
Support for the Cisco uBR7225VXR router was added.

12.2(33)SCD5 This command was modified. The output of the show cable dsg tg
command was changed.

12.2(33)SCG The command output was changed.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Cisco IOS-XE Gibraltar 16.10.1f This command was enahnaced to support DSG configuration under
mac-domain with OPS md-profile.

Usage Guidelines This command displays information about all DSG tunnel groups. Beginning with Cisco IOS Release
12.2(33)SCG, the “TG state” field in the show cable dsg tg command output was replaced by “Channel state”
to indicate that a channel belonging to a tunnel group is either enabled or disabled. It is possible that a tunnel
group is enabled but a particular channel in that tunnel group is disabled.

Examples The following is a sample output from the show cable dsg tg command with the configured parameters
for all DSG tunnel groups in Cisco IOS Release 12.2(33)SCG and later:

Router# show cable dsg tg

TG Chan Chan Rule Vendor UCID
id id state I/F pri Param list
----- ----- ----- ------ ---- ------ ---------------
10 1 en C6/0 0

Cisco CMTS Cable Command Reference

1671
 Cable Commands: show a through show cable l
show cable dsg tg

10 2 en C6/0 0
10 3 en C6/1 0
10 4 en 0
10 5 en 0
10 6 en 0

The following is a sample output from the show cable dsg tg command with the configured parameters
for all DSG tunnel groups in Cisco IOS Release 12.2(33)SCE and earlier:

Router# show cable dsg tg

TG Chan TG Rule Vendor UCID
id id state I/F pri Param list
1 1 en C5/0 16 1 1 2 3 4
1 2 en 0
2 1 en C5/0 11 2
C5/1
2 2 en 0

The following is a sample output from the show cable dsg tg command with the configured parameters
for all DSG tunnel groups in Cisco cBR 16.10.1f and later:

Router# show cable dsg tg

TG Chan TG Rule Vendor UCID Service-group Profile
id id state I/F pri Param list profile chan state
–––––– –––––– ––––––– –––––––––– –––––– –––––––– –––––– –––––––––––––––––– ––––––––––––-
2000 1 en C1/0/0 0 SG1 en
4500 1 en C1/0/0 2 2 1 2 SG1 dis
4500 2 en 0 – -

The following is a sample output from the show cable dsg tg 1 channel 1 command with the
configured parameters for all DSG tunnel groups for the specified tunnel group and channel.

Router# show cable dsg tg 1 channel 1

TG Chan Chan Rule Vendor UCID
id id state I/F pri Param list
1 1 en C5/0 16 1 1 2 3 4

The following is a sample output from the show cable dsg tg 1 channel 1 verbose command with
the detailed information for the specified tunnel group.

Router# show cable dsg tg 1 channel 1 verbose

TG: 1 Chan: 1 state: en pri: 16 Vendor: 1 UCID: 1 2 3 4
rule tunnel cfr clients
I/F id state id state mac-addr id state dest-ip In-DCD listId
C7/0/0 1 en 1 en 0101.5e01.0001 1 en 230.1.0.1 yes 1
6 en 231.1.1.6 no
7 en 231.1.1.7 no
8 en 231.1.1.8 no
2 en 2 en 0101.5e01.0002 2 en 230.1.0.2 yes 2
3 en 3 en 0101.5e01.0003 3 en 230.1.0.3 yes 3

The following is sample output of the show cable dsg tg command that displays the ignore option,
introduced in Cisco IOS Release 12.2(33)SCD5, under the ‘In DCD’ column.

Router# show cable dsg tg 1 channel 1 verbose

TG: 1 Chan: 1 state: en pri: 16 Vendor: 1 UCID: 1 2 3 4
rule tunnel cfr clients
I/F id state id state mac-addr id state dest-ip In-DCD listId
------ -------- ------------------------ ------------------------- --- -------

Cisco CMTS Cable Command Reference

1672
 Cable Commands: show a through show cable l
show cable dsg tg

C7/0/0 1 en 1 en 0101.5e01.0001 1 en 230.1.0.1 ign 1

6 en 231.1.1.6 no
7 en 231.1.1.7 no
8 en 231.1.1.8 no
2 en 2 en 0101.5e01.0002 2 en 230.1.0.2 yes 2
3 en 3 en 0101.5e01.0003 3 en 230.1.0.3 yes 3

Table 1 describes the significant fields shown in the output.

Table 65: show cable dsg tg Field Descriptions

Field Description

TG id Tunnel group identifier.

Chan id Channel identifier.

TG state Current state of the cable interface.

Chan state Current state of the channel (enabled or disabled).

pri Traffic priority parameter.

Vendor Vendor name.

UCID Upstream channel identifier.

I/F Interface.

rule id Rule identifier.

tunnel state Tunnel state.

mac-addr MAC address.

cfr state Classifier state.

dest-ip Destination IP address.

In-DCD Downstream channel descriptor.

clients listId Client list identifier.

Related Commands Command Description

debug cable dsg Enables general, DCD, or packet-related debugging.

show cable dsg tunnel Displays information about A-DSG tunnel configuration on a Cisco
CMTS router.

show interface Displays general interface information for the specified or all
interfaces.

show interface cable dsg downstream Displays A-DSG configuration and status information for
downstream interfaces.

Cisco CMTS Cable Command Reference

1673
 Cable Commands: show a through show cable l
show cable dsg tunnel

show cable dsg tunnel

To display information about Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnel configuration on
a Cisco CMTS router, use the show cable dsg tunnel command in privileged EXEC mode.

show cable dsg tunnel tunnel-id [cfrs | clients | interfaces | statistics | verbose]

Syntax Description tunnel-id (Optional) Alphanumeric identifier for a specified tunnel.

cfrs Show DSG tunnel classifiers.

clients Show DSG tunnel clients.

interfaces Show DSG tunnel interfaces.

statistics Show DSG tunnel statistics.

verbose Show DSG tunnel detail information.

Command Default No default behaviors or values

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(13a)BC This command was introduced to support A-DSG 1.1 on the Cisco uBR10012 router and
Cisco uBR7200 series routers.

12.3(17a)BC The output was modified to support A-DSG 1.2.

• The “TG id” field was added to the show cable dsg tunnel and verbose forms of the
command.
• The “State” and “MAC Addr” fields switched places in the show cable dsg tunnel
verbose form of the command.
• The “vendor group” field was added to the show cable dsg tunnel clients form of
the command.

12.2SB This command was integrated into Cisco IOS Release 12.2SB. Support for the Cisco
uBR7225VXR router was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines This command replaces the show cable dsg form of command available in Cisco IOS Release 12.3(9a)BC.

Examples The following example displays CLI help for show cable dsg tunnel command syntax.

Router# show cable dsg tunnel 1 ?

cfrs Show DSG tunnel classifiers
clients Show DSG tunnel clients

Cisco CMTS Cable Command Reference

1674
Cable Commands: show a through show cable l
show cable dsg tunnel

interfaces Show DSG tunnel interfaces

statistics Show DSG tunnel statistics
verbose Show DSG tunnel detail information
| Output modifiers
<cr>

Examples: Displaying information about all A-DSG Tunnels

The following command displays tunnel MAC address, state, associated classifiers, and state
information for Advanced-mode DSG version 1.1 tunnels on a Cisco CMTS router. This output was
changed in Cisco IOS Release 12.3(17a)BC for A-DSG version 1.2 (see following example).

Router# show cable dsg tunnel

tunnel tunnel tunnel cfr cfr tunnel in rule rule client service
id state mac-addr id state interface id state listId class
1 en 0100.5e01.0114 1 en Cable6/0 1 en 2 SI
5 en 7 en 10
11 en 8 en 2
14 en 20 en 2
Cable6/1 1 en 4
3 en 3
4 en 4
11 en 2
2 en 0100.5e01.011e 2 en Cable6/0 2 en 2 NDS-CA
10 en
3 en 0100.5e01.0128 3 en Cable6/0 3 en 3 NDS-APP
4 en 0100.5e01.0132 4 en Cable6/0 4 en 4 MOTO-CA
5 en 0100.5e01.013c 9 en Cable6/0 5 en 5 MOTO-APP
Cable6/1 5 en 5
6 dis 0100.5e01.0146 Cable6/0 6 en 6 SA-CA
Cable6/1 6 en 6
7 dis 0100.5e01.0150 7 en Cable6/1 8 en 7 SA-APP
13 dis
8 en 0100.5e01.0119 8 en NDS-DNLD
9 en 0100.5e01.0133 MOTO-DNLD
10 en 0100.5e01.0147 SA-DNLD
11 en 2222.2222.2222
12 en 3333.3333.3333 12 en

Beginning in Cisco IOS Release 12.3(17a)BC, this output was modified to add the tunnel group ID
(“TG id”) field in support of A-DSG version 1.2 as shown below:

Router# show cable dsg tunnel

tunnel TG
cfr tunnel rule client service
id state mac-addr id
id state I/F id state listId class
1 en 0100.5e01.0001 1 1 en C5/0 1 en 1 DSG-Rate1
6 en
7 en
8 en
2 en 0100.5e01.0002 1 2 en C5/0 2 en 2
3 en 0100.5e01.0003 1 3 en C5/0 3 en 3
4 en 0002.0002.0001 2 4 en C5/0 4 en 1
C5/1 1 en 1
5 en 0002.0002.0002 2 5 en C5/0 5 en 2 DSG-Rate2
C5/1 2 en 2
6 en 0002.0002.0003 2 9 en C5/0 6 en 21
C5/1 3 en 21

Cisco CMTS Cable Command Reference

1675
 Cable Commands: show a through show cable l
show cable dsg tunnel

Examples: Displaying Information for a Specified A-DSG Tunnel

The following example displays the same information as the show cable dsg tunnel command, but
for a specified tunnel. The following example shows sample output for A-DSG version 1.1. This
output was changed in Cisco IOS Release 12.3(17a)BC for A-DSG version 1.2 (see following
example).

Router# show cable dsg tunnel 1

tunnel tunnel tunnel cfr cfr tunnel in rule rule client service
id state mac-addr id state interface id state listId class
1 en 0100.5e01.0114 1 en Cable6/0 1 en 2 SI
5 en 7 en 10
11 en 8 en 2
14 en 20 en 2
Cable6/1 1 en 4
3 en 3
4 en 4
11 en 2

Beginning in Cisco IOS Release 12.3(17a)BC, this output was modified to add the tunnel group ID
(“TG id”) field in support of A-DSG version 1.2 as shown below:

Router# show cable dsg tunnel 1

tunnel TG
cfr tunnel rule client service
id state mac-addr id
id state I/F id state listId class
1 en 0100.5e01.0001 1 1 en C5/0 1 en 1 DSG-Rate1
6 en
7 en
8 en

Examples: Displaying Information for A-DSG Tunnel Classifiers

The following example displays detailed information about all A-DSG classifiers associated with
the specified tunnel.

Router# show cable dsg tunnel 1 cfrs

tunnel cfr cfr cfr destination ip source ip srcPre d_port d_port
id id state pri address address length start end
1 1 en 1 230.1.1.20 0.0.0.0 32 0 65535
5 en 1 230.1.1.60 0.0.0.0 32 0 65535
11 en 1 224.25.25.134 0.0.0.0 32 0 65535
14 en 0 230.1.1.20 0.0.0.0 32 1000 2000

Examples: Displaying Information for A-DSG Tunnel Clients

The following example displays detailed information about all the clients associated with the specified
tunnel for A-DSG version 1.1. This output was changed in Cisco IOS Release 12.3(17a)BC for
A-DSG version 1.2 (see following example).

Router# show cable dsg tunnel 1 clients

tunnel client client client client
id listId id id type address

Cisco CMTS Cable Command Reference

1676
Cable Commands: show a through show cable l
show cable dsg tunnel

1 2 1 CA System ID 0X951
3 Broadcast
8 MAC Addr 1111.1111.1111
3 1 Application ID 0X1
4 1 CA System ID 0X701
10 1 Application ID 0X6

Beginning in Cisco IOS Release 12.3(17a)BC, this output was modified to add the “vendor group”
field in support of A-DSG version 1.2 as shown below:

Router# show cable dsg tunnel 1 clients

tunnel client client client client vendor
id listId id id type address group
1 1 1 MAC Addr 0100.5e00.0001
2 Application ID 0x0951
3 Broadcast Unspecified
4 Broadcast 4

Examples: Displaying Information for A-DSG Tunnel Interfaces

The following example displays all the interfaces and rules associated with a specified tunnel.

Router# show cable dsg tunnel 1 interfaces

tunnel downstream rule
id interface id
1 Cable6/0 1 7 8 20
Cable6/1 1 3 4 11

Examples: Displaying Information for A-DSG Tunnel Statistics

The following example displays the packets statistics information about the specified tunnel.

Router# sh cab dsg tunnel 1 statistics

tunnel cfr cfr destination ip source ip total total
id id state address address forwarded received
1 1 en 230.1.1.20 0.0.0.0 0 0
5 en 230.1.1.60 0.0.0.0 0 0
11 en 224.25.25.134 0.0.0.0 0 0
14 en 230.1.1.20 0.0.0.0 0 0

Examples: Displaying Detailed Information for a Specified A-DSG Tunnel

The following example shows all the detailed information about a specified tunnel for A-DSG version
1.1. This output was changed in Cisco IOS Release 12.3(17a)BC for A-DSG version 1.2 (see following
example).

Router# show cable dsg tunnel 1 verbose

Tunnel ID : 1
MAC Addr : 0100.5e01.0114
State : enable
Cfr Id : 1
State : enable
Priority : 1
Dest IP : 230.1.1.20
Src IP : 0.0.0.0

Cisco CMTS Cable Command Reference

1677
 Cable Commands: show a through show cable l
show cable dsg tunnel

Src Prefix Length : 32

Dest Port Start : 0
Dest Port End : 65535
Forwarded : 0
Received : 0
Cfr Id : 5
State : enable
Priority : 1
Dest IP : 230.1.1.60
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 0
Dest Port End : 65535
Forwarded : 0
Received : 0
Cfr Id : 11
State : enable
Priority : 1
Dest IP : 224.25.25.134
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 0
Dest Port End : 65535
Forwarded : 0
Received : 0
Cfr Id : 14
State : enable
Priority : 0
Dest IP : 230.1.1.20
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 1000
Dest Port End : 2000
Forwarded : 0
Received : 0
Client List Id : 2
Client Id : 1
Client Id Type : CA System ID: 0951
Client Id : 3
Client Id Type : Broadcast
Client Id : 8
Client Id Type : MAC Addr: 1111.1111.1111
Client List Id : 3
Client Id : 1
Client Id Type : Application ID: 0001
Client List Id : 4
Client Id : 1
Client Id Type : CA System ID: 0701
Client List Id : 10
Client Id : 1
Client Id Type : Application ID: 0006
Interface : Cable6/0
Rule Id : 1
Rule Id : 7
Rule Id : 8
Rule Id : 20
Interface : Cable6/1
Rule Id : 1
Rule Id : 3
Rule Id : 4
Rule Id : 11

Cisco CMTS Cable Command Reference

1678
Cable Commands: show a through show cable l
show cable dsg tunnel

Beginning in Cisco IOS Release 12.3(17a)BC, this output was modified to add the “TG id” field in
support of A-DSG version 1.2. The “State” and “MAC Addr” fields also switched positions in the
output.

Router# show cable dsg tunnel 1 verbose

Tunnel ID : 1
State : enable
MAC Addr : 0100.5e01.0001
TG Id : 1
Cfr Id : 1
State : enable
Priority : 0
Dest IP : 230.1.0.1
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 0
Dest Port End : 65535
Forwarded : 0
Received : 0
Cfr Id : 6
State : enable
Priority : 0
Dest IP : 231.1.1.6
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 0
Dest Port End : 65535
Forwarded : 0
Received : 0
Cfr Id : 7
State : enable
Priority : 0
Dest IP : 231.1.1.7
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 0
Dest Port End : 65535
Forwarded : 0
Received : 0
Cfr Id : 8
State : enable
Priority : 0
Dest IP : 231.1.1.8
Src IP : 0.0.0.0
Src Prefix Length : 32
Dest Port Start : 0
Dest Port End : 65535
Forwarded : 0
Received : 0
Client List Id : 1
Client Id : 1
Client Id Type : MAC Addr 0100.5e00.0001
Client Id : 2
Client Id Type : Application ID 0x0951
Client Id : 3
Client Id Type : Broadcast Unspecified
Client Id : 4
Client Id Type : Broadcast 4
Interface : Cable5/0
Rule Id : 1

Cisco CMTS Cable Command Reference

1679
 Cable Commands: show a through show cable l
show cable dsg tunnel

Related Commands Command Description

debug cable dsg Enables general, DCD or packet-related debugging.

show cable dsg tg Displays information about A-DSG tunnel groups on a Cisco CMTS
router.

show interface Displays general interface information for the specified or all
interfaces.

show interface cable dsg downstream Displays A-DSG configuration and status information for
downstream interfaces.

Cisco CMTS Cable Command Reference

1680
 Cable Commands: show a through show cable l
show cable dynamic-qos trace

show cable dynamic-qos trace

To display the number of subscribers for whom call trace is enabled on the Cisco CMTS router, use the show
cable dynamic-qos trace command in privileged EXEC mode.

show cable dynamic-qos trace

Syntax Description This command has no arguments or keywords.

Command Modes
Privileged EXEC (#)

Command History Release Modification

Cisco IOS Release 12.2(33)SCF This command was introduced.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged
Broadband Routers. The output of the command was changed.

Usage Guidelines Use the show cable dynamic-qos trace command after enabling the call trace functionality for PacketCable
or PacketCable Multimedia (PCMM) service subscribers using the cable dynamic-qos trace command.

Examples The following is a sample output of the show cable dynamic-qos trace command that shows the
number of subscribers for whom call trace is enabled on the Cisco uBR10012 router in Cisco IOS
Release 12.2(33)SCF:

Router# show cable dynamic-qos trace

Total number of subscribers: 0
Max configured number of subscribers: 12

The following is a sample output of the show cable dynamic-qos trace command that shows the
number of subscribers for whom call trace is enabled on the Cisco cBR-8 router:

Router# show cable dynamic-qos trace

Total number of subscribers: 0

This table describes the significant fields shown in the show packetcable cms command display.

Table 66: show packetcable cms Field Descriptions

Field Description

Total number of subscribers Number of subscribers for whom call trace is enabled. The number
ranges from 0 to the maximum configured number of subscribers.

Max configured number of subscribers Maximum number of subscribers for whom call trace can be enabled
at any point of time.

Cisco CMTS Cable Command Reference

1681
 Cable Commands: show a through show cable l
show cable dynamic-qos trace

Related Commands Command Description

cable dynamic-qos trace Enables the call trace functionality on the Cisco CMTS router for
PacketCable or PCMM service subscribers.

debug cable dynamic-qos subscriber Enables debugging of the call trace functionality on the Cisco CMTS
router for a particular subscriber.

debug cable dynamic-qos trace Enables call trace debugging on the Cisco CMTS router for all the
subscribers for whom call trace is configured.

Cisco CMTS Cable Command Reference

1682
 Cable Commands: show a through show cable l
show cable dynamic-bonding-group

show cable dynamic-bonding-group

To display the details of the dynamically created bonding groups, use the show cable dynamic-bonding-group
command in privileged EXEC mode.

show cable dynamic-bonding-group [ quota] [ reclaim-history] summary slot/subslot/controller

Syntax Description quota Shows the usage of bonding group resource.

reclaim-history Shows the the reclaimed bonding group

slot/subslot/controller Modular cable line card slot, subslot, and controller.

• slot—Modular cable line card slot.
• subslot—Modular cable line card subslot.
• controller—Modular cable line card controller.

Command Modes
Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Bengaluru 16.7.1a This command was implemented on the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines Use the show cable dynamic-bonding-group command to check the dynamic bonding group configuration
details.

Examples The following is a sample output of the show cable dynamic-bonding-group summary command
that shows the details of the dynamically created bonding groups:
Router# show cable dynamic-bonding-group summary
Dynamic bonding group: Enable
DBG operation with Registration: Enable
DBG operation with Load-Balance: Enable
BG ID BG Name BG Size CMs ServFlows Create Time Create Client BG State RFid list
33026 Wi6/0/1:1 33 2 2 Dec 22 16:03 MODEM_ONLINE OPERATIONAL 33024-33055
33282 Wi6/0/2:1 33 2 2 Dec 22 16:05 MODEM_ONLINE OPERATIONAL 33280-33311

The following is a sample output of the show cable dynamic-bonding-group slot command:
Router# show cable dynamic-bonding-group slot 6
Dynamic bonding group: Enable
BG ID BG Name BG Size CMs ServFlows Create Time Create Client BG State RFid list
33026 Wi6/0/1:1 33 2 2 Dec 22 16:03 MODEM_ONLINE OPERATIONAL 33024-33055
33282 Wi6/0/2:1 33 2 2 Dec 22 16:05 MODEM_ONLINE OPERATIONAL 33280-33311

The following is a sample output of the show cable dynamic-bonding-group controller command:
Router# show cable dynamic-bonding-group controller 6/0/1
Dynamic bonding group: Enable

Cisco CMTS Cable Command Reference

1683
 Cable Commands: show a through show cable l
show cable dynamic-bonding-group

BG ID BG Name BG Size CMs ServFlows Create Time Create Client BG State RFid list
33026 Wi6/0/1:1 33 2 2 Dec 22 16:03 MODEM_ONLINE OPERATIONAL 33024-33055
Router# show cable dynamic-bonding-group controller 6/0/2
Dynamic bonding group: Enable
BG ID BG Name BG Size CMs ServFlows Create Time Create Client BG State RFid list
33282 Wi6/0/2:1 33 2 2 Dec 22 16:05 MODEM_ONLINE OPERATIONAL 33280-3331

The following is a sample output of the show cable dynamic-bonding-group quota controller
command that shows the usage of bonding group resource:
Router# show cable dynamic-bonding-group quota controller 6/0/2
slot/subslot/ctrlr: 6/0/2
Total BG number: 128
Used BG number (static/dynamic): 2(1/1)
Available BG number: 126
Available BG list port: 2-127
Router# show cable dynamic-bonding-group quota controller 6/0/1
slot/subslot/ctrlr: 6/0/1
Total BG number: 128
Used BG number (static/dynamic): 2(1/1)
Available BG number: 126
Available BG list port: 2-127

The following is a sample output of the show cable dynamic-bonding-group quota slot command:
tb32-cbr8#show cable dynamic-bonding-group quota slot 6
slot/subslot/ctrlr: 6/0/0
Total BG number: 128
Used BG number (static/dynamic): 4(4/0)
Available BG number: 124
Available BG list port: 4-127
slot/subslot/ctrlr: 6/0/1
Total BG number: 128
Used BG number (static/dynamic): 2(1/1)
Available BG number: 126
Available BG list port: 2-127
slot/subslot/ctrlr: 6/0/2
Total BG number: 128
Used BG number (static/dynamic): 2(1/1)
Available BG number: 126
Available BG list port: 2-127
slot/subslot/ctrlr: 6/0/3
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 6/0/4
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 6/0/5
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 6/0/6
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 6/0/7
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)

Cisco CMTS Cable Command Reference

1684
Cable Commands: show a through show cable l
show cable dynamic-bonding-group

Available BG number: 127

Available BG list port: 1-127

The following is a sample output of the show cable dynamic-bonding-group quota summary
command:
Router# show cable dynamic-bonding-group quota summary
Available DSBG Interface:
slot/subslot/ctrlr: 6/0/0
Total BG number: 128
Used BG number (static/dynamic): 4(4/0)
Available BG number: 124
Available BG list port: 4-127
slot/subslot/ctrlr: 6/0/1
Total BG number: 128
Used BG number (static/dynamic): 2(1/1)
Available BG number: 126
Available BG list port: 2-127
slot/subslot/ctrlr: 6/0/2
Total BG number: 128
Used BG number (static/dynamic): 2(1/1)
Available BG number: 126
Available BG list port: 2-127
slot/subslot/ctrlr: 6/0/3
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 6/0/4
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 6/0/5
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 6/0/6
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 6/0/7
Total BG number: 128
Used BG number (static/dynamic): 1(1/0)
Available BG number: 127
Available BG list port: 1-127
slot/subslot/ctrlr: 7/0/0
Total BG number: 64
Used BG number (static/dynamic): 2(2/0)
Available BG number: 62
Available BG list port: 2-63
slot/subslot/ctrlr: 7/0/1
Total BG number: 64
Used BG number (static/dynamic): 1(1/0)
Available BG number: 63
Available BG list port: 1-63
slot/subslot/ctrlr: 7/0/2
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/3

Cisco CMTS Cable Command Reference

1685
 Cable Commands: show a through show cable l
show cable dynamic-bonding-group

Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/4
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/5
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/6
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/7
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/8
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/9
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/10
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/11
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/12
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/13
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/14
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/15
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63

Cisco CMTS Cable Command Reference

1686
Cable Commands: show a through show cable l
show cable dynamic-bonding-group

slot/subslot/ctrlr: 7/0/16
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/17
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/18
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/19
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/20
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/21
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/22
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/23
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/24
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/25
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/26
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/27
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/28
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64

Cisco CMTS Cable Command Reference

1687
 Cable Commands: show a through show cable l
show cable dynamic-bonding-group

Available BG list port: 0-63

slot/subslot/ctrlr: 7/0/29
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/30
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63
slot/subslot/ctrlr: 7/0/31
Total BG number: 64
Used BG number (static/dynamic): 0(0/0)
Available BG number: 64
Available BG list port: 0-63

The following is a sample output of the show cable dynamic-bonding-group reclaim-history

summary command that shows the the reclaimed bonding group:
Router# show cable dynamic-bonding-group reclaim-history summary
BG ID BG Name BG Size Create Time Create Client Reclaim Time Reclaim Client RFid list
33026 Wi6/0/1:1 33 Dec 22 16:03 MODEM_ONLINE Dec 22 16:09:48 DBG_INTERNAL 33024-33055

The following is a sample output of the show cable dynamic-bonding-group reclaim-history slot
command:
Router# show cable dynamic-bonding-group reclaim-history slot 6
BG ID BG Name BG Size Create Time Client Client Reclaim Time Reclaim Client RFid list
33026 Wi6/0/1:1 33 Dec 22 16:03 MODEM_ONLINE Dec 22 16:09 DBG_INTERNAL 33024-33055

The following is a sample output of the show cable dynamic-bonding-group reclaim-history

controller command:
Router# show cable dynamic-bonding-group reclaim-history controller 6/0/1
BG ID BG Name BG Size Create Time Create Client Reclaim Time Reclaim Client RFid list
33026 Wi6/0/1:1 33 Dec 22 16:03 MODEM_ONLINE Dec 22 16:09 DBG_INTERNAL 33024-33055

The following examples shows the DBG created with contiguous frequency channels for load balance
purpose.
Router#show cable dynamic-bonding-group summary
Dynamic bonding group: Enable
DBG operation with Registration: Enable
DBG operation with Load-Balance: Enable
BG ID BG Name BG Size CMs ServFlows Create Time Create Client BG
State RFid list
24578 Wi3/0/0:1 24 4 4 Sep 26 15:07:22.760 MODEM_ONLINE
OPERATIONAL 24576-24599
24577 Wi3/0/0:0 8 17 17 Sep 26 16:35:01.240 MODEM_ONLINE
OPERATIONAL 24584-24591
24579 Wi3/0/0:2 8 7 7 Sep 26 16:53:48.857 DYNAMIC_LOAD_BALANCE
OPERATIONAL 24577-24584
24580 Wi3/0/0:3 8 6 6 Sep 26 16:56:49.790 DYNAMIC_LOAD_BALANCE
OPERATIONAL 24588-24595

Router#show derived-config interface wideband-Cable 3/0/0:3

Building configuration...

Derived configuration : 141 bytes

!
interface Wideband-Cable3/0/0:3
cable bundle 255
cable rf-channels channel-list 12-19 bandwidth-percent 1
no snmp trap link-status

Cisco CMTS Cable Command Reference

1688
 Cable Commands: show a through show cable l
show cable dynamic-bonding-group

end

Router#show derived-config interface wideband-Cable 3/0/0:2

Building configuration...

Derived configuration : 139 bytes

!
interface Wideband-Cable3/0/0:2
cable bundle 255
cable rf-channels channel-list 1-8 bandwidth-percent 1
no snmp trap link-status
end

This table describes the significant fields shown in the show cable dynamic-bonding-group command
display.

Table 67: show cable dynamic-bonding-group summary — Field Descriptions

Field Description

BG ID Bonding group ID.

BG Name Name of the bonding group.

BG Size Size of the bonding group.

CMs Total number of CMs associated with the dynamic bonding group.

ServFlows The total number of service flows used on the dynamic bonding group.

Create Time The time when the dynamic bonding group was created.

Create Client that creates the dynamic bonding group. Client can be modem registration, static load
Client balance, or dynamic load balance.

BG State Current state of the dynamic bonding group.

RFid list RF ID associated to a specific bonding group.

Related Commands Command Description

cable dynamic-bonding-group Enables dynamic bonding group.

show cable load-balance docsis-group target wide Check the potential target bonding group for each of
the source bonding group.
show cable load-balance docsis-group target dbg

Cisco CMTS Cable Command Reference

1689
 Cable Commands: show a through show cable l
show cable entropy status

show cable entropy status

To view the status of the cBR-8 entropy sources, use the show cable entropy status command in user EXEC
or privileged EXEC mode. This command is only supported on SUP IOSd.

show cable entropy status

Syntax Description This command has no keywords or arguments.

Command Default None

Command Modes
User EXEC (>)

Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Dublin This command is introduced on the Cisco cBR-8 Converged Broadband
17.12.1 Routers.

Usage Guidelines The command displays the status of the cBR-8 entropy sources.

Examples The following example shows typical output:

Router#show cable entropy status

Load for five secs: 2%/0%; one minute: 4%; five minutes: 5%
Time source is NTP, 13:02:40.227 EDT Fri Apr 14 2023

Entropy source successes failures

============================================
RDRAND 473 0
CPU Jitter 457 0
ACT2 0 0

Here, ACT2 is the backup source for CPU jitter.

Cisco CMTS Cable Command Reference

1690
 Cable Commands: show a through show cable l
show cable fiber-node

show cable fiber-node

To display information about a fiber node, use the show cable fiber-node command in privileged EXEC
mode.

show cable fiber-node fiber-node-id [spectrum | mapping | derived]

Syntax Description fiber-node-id Specifies a fiber node ID. Valid values range from 1 to 256.
The valid values for the Cisco cBR router is 1 to 512.

spectrum Displays upstream channel frequency assignment information and the spectrum group number.

mapping Displays upstream and downstream channel mapping information.

derived Displays MAC domain and wideband interfaces assocated to this fiber-node.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3BC This command was introduced

12.2(33)SCC This command was integrated into Cisco IOS Release 12.2(33)SCC.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

IOS-XE 3.17.0S This command was modified. The mapping and derived keywords were added.

Usage Guidelines For each fiber node, a traditional DOCSIS downstream channel on a Cisco uBR10-MC5X20 cable interface
line card is used to carry MAC management and signaling messages. This traditional DOCSIS downstream
channel used for a MAC domain is called the primary downstream channel . The associated traditional DOCSIS
upstream channel is used for return data traffic and signaling.

Examples The following is a sample output of the show cable fiber-node command:

Router# show cable fiber-node 2

Fiber-Node Config Status
Fiber-Node 2
downstream Modular-Cable 1/0/0: 0-3
downstream Cable 7/1/0
upstream Cable 7/1: 10-19
FN Config Status: Configured (status flags = 0x01)
MDD Status: Valid
Router#

Cisco CMTS Cable Command Reference

1691
 Cable Commands: show a through show cable l
show cable fiber-node

Command Release Modification

History
Cisco IOS XE Cupertino 17.15.1w The output of the command is updated to display the RPD Alias
(RPD Name) and RPD mac.

The following is a sample output of the show cable fiber-node command on the Cisco cBR router:

Router# show cable fiber-node

Load for five secs: 8%/0%; one minute: 5%; five minutes: 5%
No time source, *07:11:31.689 EDT Fri Sep 13 2024

---------------------------------------------------------------------------------

Fiber-Node 1
Channel(s) : downstream Downstream-Cable 8/0/0: 0-31, 158
Channel ID(s): 1 2 3 4 5 6 7 8 9 10 11 12 13 14
15 16 17 18 19 20 21 22 23 24 25 26 27 28
29 30 31 32 159
Upstream-Cable 8/0/0
FN Config Status: Configured (status flags = 0x01)
MDD Status: Valid
RPD Details:
MAC Address Name
NA NA

---------------------------------------------------------------------------------

Fiber-Node 2
Channel(s) : downstream Downstream-Cable 8/0/0: 0-31, 158
Channel ID(s): 1 2 3 4 5 6 7 8 9 10 11 12 13 14
15 16 17 18 19 20 21 22 23 24 25 26 27 28
29 30 31 32 159
Upstream-Cable 8/0/1
FN Config Status: Configured (status flags = 0x01)
MDD Status: Valid
RPD Details:
MAC Address Name
9088.556b.a454 RPD_dev1

---------------------------------------------------------------------------------

Fiber-Node 3
Channel(s) : downstream Downstream-Cable 8/0/1: 0-31, 158
Channel ID(s): 1 2 3 4 5 6 7 8 9 10 11 12 13 14
15 16 17 18 19 20 21 22 23 24 25 26 27 28
29 30 31 32 159
Upstream-Cable 8/0/2
FN Config Status: Configured (status flags = 0x01)
MDD Status: Valid
RPD Details:
MAC Address Name
246c.84f4.1a60 RPD_dev2

---------------------------------------------------------------------------------

Fiber-Node 4
Channel(s) : downstream Downstream-Cable 8/0/1: 0-31, 158
Channel ID(s): 1 2 3 4 5 6 7 8 9 10 11 12 13 14
15 16 17 18 19 20 21 22 23 24 25 26 27 28
29 30 31 32 159
Upstream-Cable 8/0/3
FN Config Status: Configured (status flags = 0x01)

Cisco CMTS Cable Command Reference

1692
Cable Commands: show a through show cable l
show cable fiber-node

MDD Status: Valid

RPD Details:
MAC Address Name
246c.84f4.1a60 RPD_dev2

---------------------------------------------------------------------------------

Fiber-Node 5
Channel(s) : downstream Downstream-Cable 8/0/2: 0-31, 158
Channel ID(s): 1 2 3 4 5 6 7 8 9 10 11 12 13 14
15 16 17 18 19 20 21 22 23 24 25 26 27 28
29 30 31 32 159
Upstream-Cable 8/0/4
FN Config Status: Configured (status flags = 0x01)
MDD Status: Valid
RPD Details:
MAC Address Name
9088.556b.a40c RPD_dev3

---------------------------------------------------------------------------------

Fiber-Node 6
Channel(s) : downstream Downstream-Cable 8/0/2: 0-31, 158
Channel ID(s): 1 2 3 4 5 6 7 8 9 10 11 12 13 14
15 16 17 18 19 20 21 22 23 24 25 26 27 28
29 30 31 32 159
Upstream-Cable 8/0/5
FN Config Status: Configured (status flags = 0x01)
MDD Status: Valid
RPD Details:
MAC Address Name
9088.556b.a40c RPD_dev3

This table describes the fields shown in the show cable fiber-node command display.

Table 68: show cable fiber-node Field Descriptions

Field Description

Fiber-Node Displays the fiber nodes configured on the CM.

Config Status Displays the configuration status of the fiber node. Status flags are as follows:
• 0x01 - CMTS_FN_CONFIG
• 0x02 - CMTS_FN_FREQ_INVALID
• 0x04 - CMTS_FN_CHID_INVALID
• 0x08 - CMTS_FN_BUNDLE_INVALID
• 0x10 - CMTS_FN_BOND_CHID_INVALID
• 0x20 - CMTS_FN_US_FREQ_INVALID
• 0x40 - CMTS_FN_NO_US_CONFIGURED

MDD Status Displays the MAC Domain Descriptor (MDD) status. MDD status of a fiber node is set as
invalid in the following cases:
• Frequency is not unique.
• Channel ID is not unique.
• Bonding group ID is not unique.
• Bundle is mismatched.

Cisco CMTS Cable Command Reference

1693
 Cable Commands: show a through show cable l
show cable fiber-node

Router# show cable fiber-node 2 spectrum

Fiber Upstream Physical Frequency Spectrum

Node No. Port Port (MHz) Group No.
2 Cable7/1/0 U0 10 21.939 [1.6] 1
2 Cable7/1/0 U1 11 10.695 [1.6] 1
2 Cable7/1/0 U2 12 5.834 [1.6] 1
2 Cable7/1/0 U3 13 9.055 [1.6] 1
2 Cable7/1/4 U0 16 unassigned No
2 Cable7/1/4 U1 17 unassigned No
2 Cable7/1/4 U2 18 unassigned No
2 Cable7/1/4 U3 19 unassigned No

This example shows the output of the spectrum keyword on the Cisco cBR router:

Router# show cable fiber-node 2 spectrum

Fiber Upstream Physical Frequency Spectrum

Node No. Port Port (MHz) Group No.

2 UC3/0/1:U0 1 13.200 [6.4] No

2 UC3/0/1:U1 1 19.600 [6.4] No
2 UC3/0/1:U2 1 26.000 [6.4] No
2 UC3/0/1:U3 1 32.400 [6.4] No
2 UC3/0/1:U4 1 unassigned No
2 UC3/0/1:U5 1 unassigned No
2 UC3/0/1:U6 1 unassigned No
2 UC3/0/1:U7 1 unassigned No
2 UC3/0/1:U8 1 unassigned No
2 UC3/0/1:U9 1 unassigned No
2 UC3/0/1:U10 1 unassigned No
2 UC3/0/1:U11 1 unassigned No

This table describes the fields shown in the show cable fiber-node command display when the
spectrum keyword is used.

Table 69: show cable fiber-node Field Descriptions

Field Description

Upstream Port Displays the upstream port associated with the fiber node.

Physical Port Displays the physical port of the upstream channel.

Frequency Displays the upstream channel frequency of the CM.

Spectrum Group No. Displays the spectrum group number of the fiber node. A spectrum group is a list of
upstream frequencies and nominal power levels. Spectrum groups ranging from 1 to
32 can be created for each cable modem upstream port.

This example shows the output of the mapping keyword on the Cisco cBR router:

Router# show cable fiber-node 2 mapping

Fiber-node 2:
Upstream:

Cisco CMTS Cable Command Reference

1694
Cable Commands: show a through show cable l
show cable fiber-node

Sg chan Us-chan Op state

0 3/0/0 0 Up
1 3/0/0 1 Up
2 3/0/0 2 Up
3 3/0/0 3 Up
4 3/0/0 4 Up
5 3/0/0 5 Up
6 3/0/0 6 Up
7 3/0/0 7 Up
Downstream:
Sg chan Ds-rf-chan Op state
0 3/0/0:0 Up
1 3/0/0:1 Up
2 3/0/0:2 Up
3 3/0/0:3 Up
4 3/0/0:4 Up
5 3/0/0:5 Up
6 3/0/0:6 Up
7 3/0/0:7 Up
8 3/0/0:8 Up
9 3/0/0:9 Up
10 3/0/0:10 Up
11 3/0/0:11 Up
12 3/0/0:12 Up
13 3/0/0:13 Up
14 3/0/0:14 Up
15 3/0/0:15 Up

This table describes the fields shown in the show cable fiber-node command display when the
mapping keyword is used.

Table 70: show cable fiber-node Field Descriptions

Field Description

Sg chan Disaply the service group channel ID in service group profile.

Us-chan Physical upstream channel.

Op state Displays the state of the channel.

Ds-rf-chan Physical downstream RF channel

This example shows the output of the derived keyword on the Cisco cBR router:

Router# show cable fiber-node 2 derived

Fiber-node 2:
Assoc successed
mac-domain 0 interface Cable3/0/0 Y
Wideband 1 Wideband-Cable3/0/0:0 Y

This table describes the fields shown in the show cable fiber-node command display when the
derived keyword is used.

Cisco CMTS Cable Command Reference

1695
 Cable Commands: show a through show cable l
show cable fiber-node

Table 71: show cable fiber-node Field Descriptions

Field Description

Assoc Display the assocation infomation of mac domain and wideband interface in service group profile
which is assocated to this fiber-node.

succeeded Shows if all configuration of these interfaces are generated successfully.

Related Commands Command Description

show cable modem Displays information for registered and unregistered cable modems
(including wideband cable modems).

show cable modem wideband Displays information for registered and unregistered wideband cable
modems.

Cisco CMTS Cable Command Reference

1696
 Cable Commands: show a through show cable l
show cable filter

show cable filter

To display the DOCSIS 1.1 filter groups that are currently defined, use the show cable filter command in
user EXEC or privileged EXEC mode.

show cable filter [group group-index [index index-num]] [verbose]

Syntax Description group group-id (Optional) Specifies the filter group to be displayed. The valid range is 1 to 256.
For Cisco cBR-8 routers, the valid range is 1 to 254

index (Optional) Specifies the index of the particular filter within a group to be displayed. The
index-num valid range is 1 to 128 on a uBR7200 series router and 1 to 256 on a uBR10012 router.
For Cisco cBR-8 routers, valid range is 1 to 256.

verbose (Optional) Displays complete information about the filter groups in a format that is easier
to read than the default display.

Command Modes
User EXEC, Privileged EXEC (#)

Command History Release Modification

12.1(6)EC1 This command was introduced on the Cisco uBR7100 series and Cisco uBR7200
series routers.

12.2(2)XF, 12.2(4)BC1 This command was supported on the Cisco uBR10012 routers.

12.2(8)BC2 An option was added to the cable filter group command to allow filter groups to
be activated and deactivated without removing the filter group’s configuration.

12.2(33)SCA The output was changed to add fields for IPv6 information, including the “v6” field
in the show cable filter command, and the “Source IPv6 Address,” and “Destination
IPv6 Address” fields of the show cable filter verbose command.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband
Router.

Examples The following example shows a typical display of the show cable filter command:

Router# show cable filter

Filter SrcAddr/Mask DestAddr/Mask Prot ToS SPort DPort TCP Action Status
Grp Id Flags
1 1 256 137 0,0 drop active
1 2 10.37.11.151/24 6 23 2,0 drop active
1 3 17 68 67 0,0 drop active
1 4 256 161 0,0 drop active
1 5 256 53 0,0 drop active
1 6 10.37.11.151/29 256 accept active
1 7 10.37.11.196/29 10.11.0.98/32 256 accept active
1 8 10.37.11.195/32 10.11.0.98/32 6 drop active

Cisco CMTS Cable Command Reference

1697
 Cable Commands: show a through show cable l
show cable filter

1 9 10.37.11.195/32 10.11.0.98/32 256 accept active

1 10 10.37.11.194/32 10.11.0.98/16 6 accept active
1 11 10.37.11.193/32 10.11.0.98/8 17 drop active
1 12 10.37.11.192/32 10.11.0.98/32 6 F,F accept active
1 13 10.37.11.191/32 10.11.0.98/32 17 F,F accept active
1 14 10.37.11.190/32 10.11.0.98/24 17 8,F accept active
1 15 10.37.11.189/32 10.11.0.98/32 256 F,8 drop active
1 16 10.37.11.189/32 10.11.0.98/32 256 F,8 accept active
1 17 10.37.11.188/32 10.11.0.98/8 17 accept active
1 18 10.37.11.188/32 10.11.0.98/32 6 drop active
1 19 10.37.11.187/32 10.11.0.98/30 256 accept active
1 20 10.11.0.98/0 256 drop active
Router#

The following shows typical output for the verbose form of this command:

Router# show cable filter group 10 index 10 verbose

Filter Group : 1
Filter Index : 1
Matches : 0
Match action : accept
Status : active
Filter Group : 10
Filter Index : 10
Matches : 0
Source IP Address : 10.7.7.7/16
Destination IP Address : 10.8.8.8/16
IP Protocol type : 256
IP ToS (Mask, Value) : 1, 2
TCP/UDP Source Port : 2000
TCP/UDP Destination Port : 3000
TCP Flags (mask, value) : 0, 0
Match action : accept
Status : active
Router#

IPv6 Examples
The following examples show examples of output for the show cable filter commands with changes
beginning in Cisco IOS Release 12.2(33)SCA in support of IPv6 cable filter groups.

Router# show cable filter

Filter SrcAddr/Mask DestAddr/Mask Prot ToS SPort DPort TCP Action Status
Grp Id v6 Flags
254 128Y Use Verbose Use Verbose drop active
Router# show cable filter group 254
Filter SrcAddr/Mask DestAddr/Mask Prot ToS SPort DPort TCP Action Status
Grp Id v6 Flags
254 128Y Use Verbose Use Verbose drop active
Router# show cable filter group 254 index 128
Filter SrcAddr/Mask DestAddr/Mask Prot ToS SPort DPort TCP Action Status
Grp Id v6 Flags
254 128Y Use Verbose Use Verbose drop active

Cisco CMTS Cable Command Reference

1698
Cable Commands: show a through show cable l
show cable filter

Table 72: show cable filter Field Descriptions

Field Description

Filter Gp ID number of the filter group. Defined by the group-id argument of the cable filter group
command.

Filter Id Index number of the filter group. Defined by the index-num argument of the cable filter
group command.

v6 IP version 6 filter group type indicator. Defined by the ip-version keyword of the cable
filter group command. Possible values are Y or N.

SrcAddr/Mask • IP version 4—Filter source IP address and mask to be matched by the filter. Defined
by the src-ip and src-mask keywords of the cable filter group command..
• IP version 6—“Use Verbose” appears because IPv6 addresses will not fit in the output
display area; need to use the show cable filter group verbose command to view IPv6
addresses.

DestAddr/Mask • IP version 4—Filter destination IP address and mask to be matched by the filter.
Defined by the dest-ip and dest-mask keywords of the cable filter group command.
• IP version 6—“Use Verbose” appears because IPv6 addresses will not fit in the output
display area; need to use the show cable filter group verbose command to view IPv6
addresses.

Prot IP protocol number(s) to be matched by the filter. Defined by the ip-proto keyword of the
cable filter group command.

ToS Type of Service mask and value to be matched by the filter. Defined by the ip-tos keyword
of the cable filter group command.

SPort TCP/UDP source port number to be matched by the filter. Defined by the src-port keyword
of the cable filter group command.

DPort TCP/UDP destination port number to be matched by the filter. Defined by the dest-port
keyword of the cable filter group command.

TCP Flags TCP flag mask and value to be matched by the filter. Defined by the tcp-flags keyword of
the cable filter group command.

Action Action to be taken on packet (accept or drop) when filter match occurs. Defined by the
match-action keyword of the cable filter group command.

Status Filter group status (active or inactive). Defined by the status keyword of the cable filter
group command.

Router# show cable filter group 254 index 128 verbose

Filter Group : 254
Filter Index : 128
Filter Version : IPv6
Matches : 0
Source IPv6 address : 2001:33::20B:BFFF:FEA9:741F/128
Destination IPv6 address : 2001:1::224/128

Cisco CMTS Cable Command Reference

1699
 Cable Commands: show a through show cable l
show cable filter

Match action : drop

Status : active

Table 73: show cable filter verbose Field Descriptions

Field Description

Filter Group ID number of the filter group. Defined by the group-id argument of the
cable filter group command.

Filter Index Index number of the filter group. Defined by the index-num argument of
the cable filter group command.

Filter Version IP version of the filter group. Defined by the ip-version keyword of the
cable filter group command. Possible values are IPv4 or IPv6.

Matches: Source IP address or • Source IP address—IPv4 source IP address and mask to be matched
by the filter. Defined by the src-ip and src-mask keywords of the
Matches: Source IPv6 address
cable filter group command.
• Source IPv6 address—IPv6 source IP address and prefix to be matched
by the filter. Defined by the v6-src-address and v6-src-pfxlen
keywords of the cable filter group command.

Matches: Destination IP address • Destination IP address—IPv4 destination IP address and mask to be

or matched by the filter. Defined by the dest-ip and dest-mask keywords
of the cable filter group command.
Matches: Destination IPv6
address • Destination IPv6 address—IPv6 destination IP address and prefix to
be matched by the filter. Defined by the v6-dest-address and
v6-dest-pfxlen keywords of the cable filter group command.

Matches: IP Protocol type IP protocol number(s) to be matched by the filter. Defined by the ip-proto
keyword of the cable filter group command.

Matches: IP ToS (Mask, Value) Type of Service mask and value to be matched by the filter. Defined by
the ip-tos keyword of the cable filter group command.

Matches: TCP/UDP Source Port TCP/UDP source port number to be matched by the filter. Defined by the
src-port keyword of the cable filter group command.

Matches: TCP/UDP Destination TCP/UDP destination port number to be matched by the filter. Defined
Port by the dest-port keyword of the cable filter group command.

Matches: TCP Flags (mask, TCP flag mask and value to be matched by the filter. Defined by the
value) tcp-flags keyword of the cable filter group command.

Matches: Match action Action to be taken on packet (accept or drop) when filter match occurs.
Defined by the match-action keyword of the cable filter group command.

Matches: Status Filter group status (active or inactive). Defined by the status keyword of
the cable filter group command.

This example shows the output for the show cable filter command on the Cisco cBR-8 router:

Router#show cable filter

Cisco CMTS Cable Command Reference

1700
 Cable Commands: show a through show cable l
show cable filter

Grp Id v6 SrcAddr/Mask DestAddr/Mask Prot ToS Action Status

255 1 N drop active
Router#

Related Commands Command Description

cable filter group Creates, configures, and activates a DOCSIS 1.1 filter group that filters packets on the
basis of the TCP/IP and UDP/IP headers.

Cisco CMTS Cable Command Reference

1701
 Cable Commands: show a through show cable l
show cable flap-list

show cable flap-list

To display the cable flap-list on a Cisco CMTS, use the show cable flap-list command in user EXEC or
privileged EXEC mode.

show cable flap-list

show cable flap-list sort-interface [sort-flap | sort-int | sort-mac | sort-time]

Cisco cBR Series Converged Broadband Router

show cable flap-list
show cable flap-list [cable slot/subslot/cable-interface-index] [sort-flap | sort-interface | sort-time]

Syntax Description cable slot/port (Optional) Displays information for all CMs on the specified cable interface
and downstream port on the Cisco uBR7100 series and Cisco uBR7200
series routers:
• slot—Chassis slot number of the cable interface line card.
• port—Downstream port number.
Valid values for these arguments are dependent on your CMTS router and
cable interface line card. Refer to the hardware documentation for your
router chassis and cable interface line card for supported slot and port
numbering.

cable slot/subslot/port (Optional) Displays information for all CMs on the specified cable interface
on a Cisco uBR10012 router:
• slot —Chassis slot number of the cable interface line card. Valid slots
are from 5 to 8.
• subslot —Secondary slot number of the cable interface line card.
Valid subslots are 0 or 1.
• port —Downstream port number. Valid ports are 0 to 4, depending
on the cable interface line card.

cable (Optional) Displays information for all CMs on the specified cable interface
slot/subslot/cable-interface-index on a Cisco cBR router:
• slot —Chassis slot number of the cable interface line card. Valid slots
are from 0 to 3, and 6 to 9.
• subslot —Secondary slot number of the cable interface line card.
Valid subslot is 0.
• cable-interface-index —cable interface index number. Valid index
numbers are 0 to15.

upstream port (Optional) Displays the flap list for a particular upstream on the selected
cable interface.

sort-interface (Optional) Displays the flap list for all cable interfaces, sorted by interface.

sort-flap (Optional) Sorts the list by the number of times the CM has flapped.

Cisco CMTS Cable Command Reference

1702
 Cable Commands: show a through show cable l
show cable flap-list

sort-int (Optional) Sorts the list first by the Cisco CMTS cable interface.
This keyword is not supported on Cisco cBR-8 router

sort-mac (Optional) Sorts the list first by the Cisco CMTS cable interface and then
by the CM MAC (hardware) address.
This keyword is not supported on Cisco cBR-8 router

sort-time (Optional) Sorts the list by the most recent time the CM is detected to have
flapped.

Command Modes
User EXEC (>), Privileged EXEC (#)

Command History Release Modification

11.3 NA This command was introduced.

12.0(3)T This command was supported on the Cisco mainline release.

12.0(7)XR and 12.1(1a)T1 The output of this command was enhanced to show that the Cisco CMTS has
detected an unstable return path for a particular CM and has compensated with
a power adjustment. An asterisk (*) appears in the power adjustment field for a
modem when a power adjustment has been made; an exclamation point (!)
appears when the CM has reached its maximum power transmit level and cannot
increase its power level further.

12.3(9a)BC The sort-int and sort-mac options were added.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support
for the Cisco uBR7225VXR router was added.

12.2(33)SCC The output of this command was modified to show the aggregated data across
all upstream channels for each flap detector for CMs in the Multiple Transmit
Channel (MTC) mode on a Cisco uBR10012 router.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR-8 Converged Broadband
Router. The upstream and sort-mac keywords were removed.

Usage Guidelines The sort options operate differently on the different Cisco CMTS routers. On the Cisco uBR7100 series and
Cisco uBR7200 series routers, the sort options apply to all cable interface line cards and merge the output
into a single display.
On the Cisco uBR10012 router, the sort options apply to individual cable interfaces. For example, the sort-time
option sorts all of the flap entries on the first cable interface (c5/0/0), then the entries on the second cable
interface (c5/0/1), and so forth.

Cisco CMTS Cable Command Reference

1703
 Cable Commands: show a through show cable l
show cable flap-list

Note Occasionally, the show cable flap-list command might temporarily show duplicate entries for the same cable
modem. This can occur after a cable modem has gone offline and before it has completed the registration
process and come back online. When the cable modem does reach the online state, the duplicate entries
disappear.

Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to show
commands using the exec prompt timestamp command in line configuration mode.

Examples The following example shows the output of the show cable flap-list command:

router# show cable flap-list

MAC Address Upstream Ins Hit Miss CRC P-Adj Flap Time
0010.7bb3.fd19 Cable5/0/U1 0 2792 281 0 *45 58 Jul 27 16:54:50
0010.7bb3.fcfc Cable5/0/U1 0 19 4 0 !43 43 Jul 27 16:55:01
0010.7bb3.fcdd Cable5/0/U1 0 19 4 0 *3 3 Jul 27 16:55:01

Note The asterisk (*) in the P-Adj field indicates that a power adjustment has been made for that CM. The
exclamation point (!) indicates that the CM has reached its maximum power transmit level and cannot
increase its power level further.

The following example shows the display of flap-list tables sorted by MAC address:

router# show cable flap-list sort-flap

Mac Addr CableIF Ins Hit Miss CRC P-Adj Flap Time
0010.1eab.2c0b C6/0 U0 108 318 27 0 0 108 Sep 10 15:26:56
0010.1eb2.bb07 C6/0 U0 0 293 31 1 1 1 Sep 10 15:15:49
0010.7b6b.71cd C6/0 U0 1 288 32 0 0 1 Sep 10 15:12:13
0010.1eb2.bb8f C6/0 U0 1 295 30 0 0 1 Sep 10 15:11:44

The following example shows the display of flap-list tables sorted by time:

Router# show cable flap-list sort-time

Mac Addr CableIF Ins Hit Miss CRC P-Adj Flap Time
00e0.2222.2202 C4/0 U0 464 2069 242 0 421 885 Oct 16 22:47:23
0010.7b6b.57e1 C4/0 U0 0 2475 43 0 1041 1041 Oct 16 22:47:04

The following sample output of the show cable flap-list command provides the aggregated data
across all upstream channels for CMs in the MTC mode on a uBR10012 router in Cisco IOS Release
12.2(33)SCC:

router# show cable flap-listMAC Address Upstream Ins Hit Miss CRC P-Adj
Flap Time
001e.6bfb.0f9e C5/0/0/UB 0 62539 0 0 2 2 Apr 18 03:53:00
0050.f110.b277 C5/0/0/UB 0 10965 211 0 0 9 Apr 18 03:53:00

Cisco CMTS Cable Command Reference

1704
Cable Commands: show a through show cable l
show cable flap-list

Table 74: show cable flap-list Command Field Descriptions

Field Description

Mac Addr The MAC address for the CM.

CableIF The cable interface line card, including upstream, for this CM.

Ins The number of times the CM comes up and inserts itself into
the network. This counter is indicates the number of times the
RF link was abnormally reestablished into the network. This
counter is increased when the time between initial link
establishment and a reestablishment was less than the threshold
parameter configured using the cable flap-list insertion-time
command.
Normal modem activity uses the following sequence:
• Initial link insertion is followed by a station maintenance
message between the CMTS and cable modem.
• Power on
• Initial maintenance
• Station maintenance
• Power off
When the link is broken, initial maintenance is repeated to
reestablish the link.
• Initial maintenance @ Time T1
• Station maintenance
• Initial maintenance @ Time T2
The Ins and Flap counters in the flap list are incremented
whenever T2 – T1 < N where N is the insertion-time parameter
configured in the cable flap-list insertion-time command.
This count may indicate intermittent downstream
synchronization loss or DHCP or modem registration problems.
In the latter case, the Ins count tends to track the Flap count. If
the downstream is unstable (levels move outside the modem’s
range occasionally), insertions can occur. If the modem cannot
provision correctly, many insertions occur.
If link reestablishment happens too frequently, the modem
usually has a registration problem. To check for this potential
problem, check to see if the insertion counter is the same order
of magnitude as the Flap counter.

Hit The number of times the CM responds to MAC-layer station

maintenance (keepalive) messages. (The minimum hit rate is
once per 30 seconds. It can indicate intermittent upstream, laser
clipping, or common-path distortion.

Cisco CMTS Cable Command Reference

1705
 Cable Commands: show a through show cable l
show cable flap-list

Field Description

Miss The number of times the CM misses and does not respond to a
MAC-layer station maintenance (keepalive) message. An 8
percent miss rate is normal for the Cisco cable interface line
cards. It can indicate intermittent upstream, laser clipping, or
common-path distortion.

Cisco CMTS Cable Command Reference

1706
Cable Commands: show a through show cable l
show cable flap-list

Field Description

Cisco CMTS Cable Command Reference

1707
 Cable Commands: show a through show cable l
show cable flap-list

Field Description
Note
The Hit and Miss columns are keepalive
polling statistics between the CMTS and
the cable modem. The station maintenance
process occurs for every modem
approximately every 25 seconds. When the
CMTS receives a response from the
modem, the event is counted as a hit. If the
CMTS does not receive a response from
the cable modem, the event is counted as
a miss.
Ideally, the hit count should be much greater
than the miss count. If a modem has a hit
count much less than its miss count, then
registration is failing. Noisy links cause the
miss or hit ratio to deviate from a nominal
10 percent or less. High miss counts can
indicate:
• Intermittent upstream possibly due to
noise
• Laser clipping
• Common-path distortion
• Ingress or interference
• Too much or too little upstream
attenuation
A cable modem fails to respond either
because of noise or if it is down. Modems
that log only misses and zero hits are
assumed to be powered off. If noise caused
a poll to be missed, then the transition from
miss to hit is detected as a flap condition.
The poll rate is increased to 1 per second
whenever the modem misses a poll. This is
used to accelerate the offline state detection
and decrease station maintenance overhead.
Misses are not desirable, because they
usually indicate a return path problem;
however, having a small number of misses
is normal. After 16 misses, the modem is
assumed to have powered off and the link
is broken.
The flap count is incremented if there are
M consecutive misses, where M is
configured in the cable flap miss-threshold
command. The parameter value ranges from
1 to 12, with a default of 6.

Cisco CMTS Cable Command Reference

1708
Cable Commands: show a through show cable l
show cable flap-list

Field Description
Hit and miss analysis could be done after
the Ins count stops incrementing. In general,
if the hit and miss counts are about the same
order of magnitude, and the CRC count is
low or nonexistent, then the upstream is
experiencing noise.
If the miss count is greater, then the modem
is probably experiencing common-path
distortion and is dropping out frequently or
not completing registration. Check
grounding connections and if you see noise
disappear after breaking a cable connection,
but build back up again later, check the
end-of-line terminators. You may be using
a substandard frequency translator instead
of a Digital Signal Processor. If the line is
simply noisy, but not too noisy, you see an
increase in the percentage of misses. If it is
very noisy, then more than 80% of the
ranging responses (RNG-RSP) are missed
and the modem has many insertions.

CRC The number of cyclic redundancy check (CRC) errors for this
cable modem. CRC errors are calculated on per modem basis
and refer to upstream impairments. Cable modems with high
CRC errors either have bad upstream paths, or have in-home
wiring problems.
The CRC counter field indicates:
• Intermittent upstream
• Laser clipping
• Common-path distortion
• Impulsive noise or interference

Cisco CMTS Cable Command Reference

1709
 Cable Commands: show a through show cable l
show cable flap-list

Field Description

P-Adj The number of times the headend instructed the CM to adjust

transmit (TX) power more than 3 dB. It can indicate amplifier
degradation, poor connections, or thermal sensitivity.
* means the noise power-adjustment method is active for this
modem.
! means the modem has reached its maximum transmit power.
The station maintenance poll in the CMTS constantly adjusts
the modem transmit power, frequency, and timing. The
power-adjustment (P-Adj) column indicates the number of times
the modem’s power adjustment exceeded the threshold value.
The power adjustment threshold may be set using the cable
flap-list power-adjust threshold command with a value range
of 0 to 10 dB and a default value of 2 dB. Tuning this threshold
is recommended to decrease irrelevant entries in the flap list.
Power-adjustment values of 2 dB and below continuously
increment the P-Adj counter. The modem transmitter step size
is 1.5 dB, whereas the headend may command 0.25 dB step
sizes.
Power-adjustment flap strongly suggests upstream plant
problems such as:
• Amplifier degradation
• Poor connections
• Thermal sensitivity
• Attenuation problem
The P-Adj column is often watched as an indicator of plant
stability. It may give a forewarning of a future plant outage. If
the upstream path contains too much or too little loss, the
modem is undergoing many power adjustments.

Flap The total number of times a modem has flapped, which is the
sum of P-Adj and Ins values. This counter is incremented when
one of the following events is detected:
• Unusual modem insertion or re-registration attempts. The
Flap and the Ins counters are incremented when the modem
tries to reestablish the RF link with the CMTS within a
period of time that is less than the user-configured insertion
interval value.
• Abnormal miss or hit ratio. The Flap counter is
incremented when N consecutive misses are detected after
a hit where N can be user-configured with a default value
of 6.
• Unusual power adjustment. The Flap and P-Adj counters
are incremented when the modem’s upstream power is
adjusted beyond a user-configured power level.

Cisco CMTS Cable Command Reference

1710
Cable Commands: show a through show cable l
show cable flap-list

Field Description

Time Time is the most recent time that the modem dropped the
connection or flapped. The value is based on the clock
configured on the local CMTS. If no time is configured, this
value is based on the current uptime of the CMTS. When a cable
modem meets one of the three flap list criteria, the Flap counter
is incremental and Time is set to the current time.
Note
This field displays a value in brackets in the output of the show
cable modem flap command to indicate the duration
(milliseconds) between the cable interface to become active
and the first ranging success after a line card switchover (cable
modem recovery time).

Examples for the Cisco cBR Series Converged Broadband Router

This example shows the output of the show cable flap-list command on the Cisco cBR router:

Router#show cable flap-list

MAC Address Upstream Ins Hit Miss CRC P-Adj Flap Time
b0c2.87c2.830b C9/0/0/UB 0 3734 16 0 3 5 Jan 4 02:38:40
0010.18de.8134 C9/0/0/UB 0 4139 11 0 0 2 Jan 4 00:26:45
0025.2e2d.74e4 C9/0/0/U2 *** No data available *** Jan 3 23:33:00
Router#

This example shows the output of the show cable flap-list sort-flapcommand on the Cisco cBR
router:

Router#show cable flap-list sort-flap

MAC Address Upstream Ins Hit Miss CRC P-Adj Flap Time
b0c2.87c2.830b C9/0/0/UB 0 3749 16 0 3 5 Jan 4 02:38:40
0010.18de.8134 C9/0/0/UB 0 4154 11 0 0 2 Jan 4 00:26:45
0025.2e2d.74e4 C9/0/0/U2 *** No data available *** Jan 3 23:33:00
Router#

This example shows the output of the show cable flap-list sort-interfacecommand on the Cisco
cBR router:

Router#show cable flap-list sort-interface

MAC Address Upstream Ins Hit Miss CRC P-Adj Flap Time
b0c2.87c2.830b C9/0/0/UB 0 3753 16 0 3 5 Jan 4 02:38:40
0010.18de.8134 C9/0/0/UB 0 4158 11 0 0 2 Jan 4 00:26:45
0025.2e2d.74e4 C9/0/0/U2 *** No data available *** Jan 3 23:33:00
Router#

This example shows the output of the show cable flap-list sort-timecommand on the Cisco cBR
router:

Router#show cable flap-list sort-time

MAC Address Upstream Ins Hit Miss CRC P-Adj Flap Time

Cisco CMTS Cable Command Reference

1711
 Cable Commands: show a through show cable l
show cable flap-list

b0c2.87c2.830b C9/0/0/UB 0 3756 16 0 3 5 Jan 4 02:38:40

0010.18de.8134 C9/0/0/UB 0 4161 11 0 0 2 Jan 4 00:26:45
0025.2e2d.74e4 C9/0/0/U2 *** No data available *** Jan 3 23:33:00
Router#

Related Commands Command Description

cable flap-list aging Specifies the number of days to keep a CM in the flap-list table
before aging it out of the table.

cable flap-list insertion-time Sets the insertion time interval that determines whether a CM is
placed in the flap list.

cable flap-list miss-threshold Specifies the miss threshold for recording a flap-list event.

cable flap-list power-adjust threshold Specifies the power-adjust threshold for recording a CM flap-list
event.

cable flap-list size Specifies the maximum number of CMs that can be listed in the
flap-list table.

clear cable flap-list Clears all the entries in the flap-list table.

debug cable flap Displays information about the operation of the CM flap list that is
maintained for the cable interfaces.

ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters
as appropriate.

show cable modem Displays information about all CMs on an interface or about a
particular CM.

show cable modem flap Displays flap list statistics for one or more cable modems.

Cisco CMTS Cable Command Reference

1712
 Cable Commands: show a through show cable l
show cable flap-list reset-cm-list

show cable flap-list reset-cm-list

To display the Docsis 3.1 cable modem list that was reset by the partial service reset timer, use the show cable
flap-list reset-cm-list command in privileged EXEC mode.

show cable flap-list reset-cm-list

Command Modes
Privileged EXEC (#)

Command History Release Modification

Cisco IOS XE Everest This command is introduced on the Cisco cBR Series Converged Broadband
16.5.1 Routers.

Usage Guidelines None

Examples This example shows the output of the show cable flap-list reset-cm-list command:

router# show cable flap-list reset-cm-list

Related Commands Command Description

cable lcha partial-service-reset-timer Configures the timer to reset cable modems in partial service mode.

Cisco CMTS Cable Command Reference

1713
 Cable Commands: show a through show cable l
show cable flap-list wb-rf

show cable flap-list wb-rf

To display the wideband RF related data for all w-online cable modems, use the show cable flap-list wb-rf
command in privileged EXEC mode.

show cable flap-list [cable slot/subslot/port]wb-rf [modular-cable slot/bay/port | integrated-cable

slot/bay/port WB RF channel number] [QAM | MDD]

Cisco cBR Series Converged Broadband Router

show cable flap-list [cable slot/subslot/cable-interface-index]wb-rf integrated-Cable slot/subslot/port

Syntax Description cable slot/subslot/port (Optional) Displays information for all cable modems on the specified
cable interface on a Cisco uBR10012 router, where:
• slot —Specifies the chassis slot number of the cable interface line
card. Valid slots are 5 to 8.
• subslot —Specifies the secondary slot number of the cable interface
line card. Valid subslots are 0 or 1.
• port —Specifies the downstream port number. Valid ports are 0 to 4,
depending on the cable interface line card.

cable On a Cisco cBR-8 router:

slot/subslot/cable-interface-index
• slot —Specifies the chassis slot number of the cable interface line
card. Valid slots are 0 to 3, and 6 to 9.
• subslot —Specifies the secondary slot number of the cable interface
line card. Valid subslot is 0.
• cable-interface-index —Specifies the cable interface index. Valid
indices are 0 to 15.

modular-cable slot/bay/port (Optional) Displays information for all cable modems on the specified
modular cable interface on a Cisco uBR10012 router, where
• slot—The slot where a SIP resides. On the Cisco uBR10012 router,
slots 1 and 3 can be used for SIPs.
• bay—The bay in a SIP where a SPA is located. Valid values are 0
(upper bay) and 1 (lower bay).
• port—Specifies the interface number on the SPA.
This keyword is not supported on Cisco cBR-8 router.

integrated-cable (Optional) Displays information for all cable modems on the specified
slot/subslot/port integrated cable interface on a Cisco cBR-8 router, where
• slot—Valid slots are 0 to 3 and 6 to 9.
• subslot—Valid subslot is 0.
• port—Valid ports are 0 to 15.

Cisco CMTS Cable Command Reference

1714
 Cable Commands: show a through show cable l
show cable flap-list wb-rf

integrated-cable slot/bay/port (Optional) Displays information for all cable modems on the specified
integrated cable interface on a Cisco uBR10012 router, where
• slot—The slot where a SIP resides. On the Cisco uBR10012 router,
slots 1 and 3 can be used for SIPs.
• bay—The bay in a SIP where a SPA is located. Valid values are 0
(upper bay) and 1 (lower bay).
• port—Specifies the interface number on the SPA.

WB RF channel number (Optional) Specifies the wideband RF channel number.

QAM (Optional) Specifies the number of QAM flaps.

MDD (Optional) Specifies the number of MDD flaps.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCB This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Router.
3.15.0S The QAM and MDD keywords and WB-RF channel number variable were removed.

Usage Guidelines None

Examples This example shows the output of the show cable flap-list wb-rf command:

router# show cable flap-list wb-rf

RF Timeout Recover Failure Recover Flaps CM Percent

-------- ------- ------- ------- ------- ----- ------- -------
3/0/0 1 1 1 0 0 1 3 33
2 0 0 1 0 1 3 33

Examples for the Cisco cBR Series Converged Broadband Router

This example shows the output of the show cable flap-list wb-rf command on the Cisco cBR router:

Router#show cable flap-list wb-rf

MDD QAM/FEC
RF Timeout Recover Failure Recover Flaps CM Percent
-------- ------- ------- ------- ------- ----- ------- -------
1/0/0 158 0 0 1 0 0 2 0

Router#

Cisco CMTS Cable Command Reference

1715
 Cable Commands: show a through show cable l
show cable flap-list wb-rf

Related Commands Command Description

show cable flap-list Displays the cable flap-list on a Cisco CMTS.

clear cable flap-list Clears all the entries in the flap-list table.

debug cable flap Displays information about the operation of the CM flap list that is maintained for
the cable interfaces.

show cable modem flap Displays flap list statistics for one or more cable modems.

Cisco CMTS Cable Command Reference

1716
 Cable Commands: show a through show cable l
show cable freq-profile

show cable freq-profile

To display information about the frequency profile, use the show cable freq-profile command in privileged
EXEC mode.

show cable freq-profile freq-profile-id

Syntax Description freq-profile-id Specifies a freq-profile ID. Valid values range from 0 to 15.

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.15.0S This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines Use the show cable freq-profile command to display information about a qam-profile. If you specify the
freq-profile-id, the command displays the frequency profile with the specified ID.

Examples The following is a sample output of the show cable freq-profile command:

Router# show cable freq-profile

Frequency Profile ID 0 annex-b-low:
Lane 1 start-freq 90000000hz
Block 1 start-freq 90000000hz
Block 2 start-freq 138000000hz
Block 3 start-freq 186000000hz
Block 4 start-freq 234000000hz
Lane 2 start-freq 282000000hz
Block 1 start-freq 282000000hz
Block 2 start-freq 330000000hz
Block 3 start-freq 378000000hz
Block 4 start-freq 426000000hz
Lane 3 start-freq 474000000hz
Block 1 start-freq 474000000hz
Block 2 start-freq 522000000hz
Block 3 start-freq 570000000hz
Block 4 start-freq 618000000hz
Lane 4 start-freq 666000000hz
Block 1 start-freq 666000000hz
Block 2 start-freq 714000000hz
Block 3 start-freq 762000000hz
Block 4 start-freq 810000000hz

Frequency Profile ID 1 annex-b-high:

Lane 1 start-freq 234000000hz
Block 1 start-freq 234000000hz
Block 2 start-freq 282000000hz
Block 3 start-freq 330000000hz
Block 4 start-freq 378000000hz
Lane 2 start-freq 426000000hz
Block 1 start-freq 426000000hz
Block 2 start-freq 474000000hz
Block 3 start-freq 522000000hz

Cisco CMTS Cable Command Reference

1717
 Cable Commands: show a through show cable l
show cable freq-profile

Block 4 start-freq 570000000hz

Lane 3 start-freq 618000000hz
Block 1 start-freq 618000000hz
Block 2 start-freq 666000000hz
Block 3 start-freq 714000000hz
Block 4 start-freq 762000000hz
Lane 4 start-freq 810000000hz
Block 1 start-freq 810000000hz
Block 2 start-freq 858000000hz
Block 3 start-freq 906000000hz
Block 4 start-freq 954000000hz

Frequency Profile ID 2 annex-a-low:

Lane 1 start-freq 94000000hz
Block 1 start-freq 94000000hz
Block 2 start-freq 142000000hz
Block 3 start-freq 190000000hz
Block 4 start-freq 238000000hz
Lane 2 start-freq 286000000hz
Block 1 start-freq 286000000hz
Block 2 start-freq 334000000hz
Block 3 start-freq 382000000hz
Block 4 start-freq 430000000hz
Lane 3 start-freq 478000000hz
Block 1 start-freq 478000000hz
Block 2 start-freq 526000000hz
Block 3 start-freq 574000000hz
Block 4 start-freq 622000000hz
Lane 4 start-freq 670000000hz
Block 1 start-freq 670000000hz
Block 2 start-freq 718000000hz
Block 3 start-freq 766000000hz
Block 4 start-freq 814000000hz

Frequency Profile ID 3 annex-a-high:

Lane 1 start-freq 267000000hz
Block 1 start-freq 267000000hz
Block 2 start-freq 315000000hz
Block 3 start-freq 363000000hz
Block 4 start-freq 411000000hz
Lane 2 start-freq 459000000hz
Block 1 start-freq 459000000hz
Block 2 start-freq 507000000hz
Block 3 start-freq 555000000hz
Block 4 start-freq 603000000hz
Lane 3 start-freq 651000000hz
Block 1 start-freq 651000000hz
Block 2 start-freq 699000000hz
Block 3 start-freq 747000000hz
Block 4 start-freq 795000000hz
Lane 4 start-freq 843000000hz
Block 1 start-freq 843000000hz
Block 2 start-freq 891000000hz
Block 3 start-freq 939000000hz
Block 4 start-freq 987000000hz

The following is a sample output of the show cable freq-profile freq-profile-id command:

Router# show cable freq-profile 1

Frequency Profile ID 1 annex-b-high:
Lane 1 start-freq 234000000hz
Block 1 start-freq 234000000hz
Block 2 start-freq 282000000hz
Block 3 start-freq 330000000hz

Cisco CMTS Cable Command Reference

1718
 Cable Commands: show a through show cable l
show cable freq-profile

Block 4 start-freq 378000000hz

Lane 2 start-freq 426000000hz
Block 1 start-freq 426000000hz
Block 2 start-freq 474000000hz
Block 3 start-freq 522000000hz
Block 4 start-freq 570000000hz
Lane 3 start-freq 618000000hz
Block 1 start-freq 618000000hz
Block 2 start-freq 666000000hz
Block 3 start-freq 714000000hz
Block 4 start-freq 762000000hz
Lane 4 start-freq 810000000hz
Block 1 start-freq 810000000hz
Block 2 start-freq 858000000hz
Block 3 start-freq 906000000hz
Block 4 start-freq 954000000hz

Related Commands Command Description

cable downstream freq-profile Set the frequency profile for the cable interface line card.

Cisco CMTS Cable Command Reference

1719
 Cable Commands: show a through show cable l
show cable hop

show cable hop

To display cable-hop statistics on a Cisco CMTS, use the show cable hop command in privileged EXEC
mode.

show cable hop [cable slot/port] [upstream uport] [history] [threshold]

show cable hop [cable slot/subslot/port] [upstream uport] [history] [threshold]

Cisco cBR-8 Converged Broadband Router

show cable hop [upstream-cable slot/subslot/controller] [upstream uport] [history] [threshold]

Syntax Description cable slot/port (Optional) Specifies a cable interface on the Cisco uBR7100 series and Cisco
uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the Cisco
uBR7200 series router, slot can range from 3 to 6, and port can be 0 or 1, depending
on the cable interface.

cable slot/subslot/port (Optional) Specifies a cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot —Chassis slot number of the cable interface line card. Valid slots are from
5 to 8.
• subslot —Secondary slot number of the cable interface line card. Valid subslots
are 0 or 1.
• port —Downstream port number. Valid ports are from 0 to 4, depending on
the cable interface line card.

upstreamuport (Optional) Specifies an upstream port for which to display the frequency hop status.

upstream-cable (Optional) Specifies a cable interface on the Cisco cBR router. The following are
slot/subslot/controller the valid values:
• slot —Chassis slot number. Valid slots are from 0 to 3, and 6 to 9.
• subslot —Secondary slot number. Valid subslot is 0.
• controller —Upstream controller. Valid controllers are from 0 to 4, depending
on the cable interface line card.

history (Optional) Displays changes from one state to another, at any time and for any
reason, for frequency, modulation, and channel width.

summary (Optional) Displays summary of information for Cisco cBR router.

threshold (Optional) Displays the user defined thresholds and current carrier-to-noise ratio
(CNR), signal-to-noise ratio (SNR), correctable forward error correction (FEC)
percentage, uncorrectable FEC percentage, and missed station maintenances
percentage values of the upstreams.

Command Modes
Privileged EXEC (#)

Cisco CMTS Cable Command Reference

1720
 Cable Commands: show a through show cable l
show cable hop

Command History Release Modification

12.0(4)XI This command was introduced.

12.3(13a)BC This command was enhanced with the addition of two new keywords, history and threshold.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

12.3(23)BC7 The output of the show cable hop history command is modified to include more information
in the ‘change from’ and ‘change to’ fields of the output. Now, the modulation profile
number is displayed when a change occurs, instead of the modulation order.

12.2(33)SCC This command was integrated into Cisco IOS Release 12.2(33)SCC.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Router.
3.15.0S The summary and upstream-cable keywords were added.

Examples The following example shows typical output from the show cable hop command:

Router# show cable hop

Upstream Port Poll Missed Min Missed Hop Hop Corr Uncorr
Port StatusRate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
Cable4/0/U0 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U1 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U2 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U3 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U4 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U5 down 1000 * * * frequency not set * * * 0 0
Cable5/0/U0 down 1000 * * * interface is down * * * 0 0
Cable5/0/U1 down 1000 * * * frequency not set * * * 0 0
Cable5/0/U2 down 1000 * * * interface is down * * * 0 0
Cable5/0/U3 down 1000 * * * interface is down * * * 0 0
Cable5/0/U4 down 1000 * * * interface is down * * * 0 0
Cable5/0/U5 down 1000 * * * interface is down * * * 0 0
Cable6/0/U0 down 1000 * * * interface is down * * * 0 0
Cable6/0/U1 22.000 Mhz 1000 * * *set to fixed frequency * * * 31375 1912
Cable6/0/U2 26.000 Mhz 1000 * * *set to fixed frequency * * * 0 0
Cable6/0/U3 admindown 1000 * * * frequency not set * * * 0 0
The following example shows typical output from the show cable hop
upstream
command:
Router# show cable hop c2/0 upstream 2

Upstream Port Poll Missed Min Missed Hop Hop Corr Uncorr
Port Status Rate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
Cable2/0/U2 admindown 1000 * * * frequency not set * * * 0 0
Router#

Table 75: show cable hop Command Field Descriptions

Field Description

Upstream Port The upstream port for this information line.

Cisco CMTS Cable Command Reference

1721
 Cable Commands: show a through show cable l
show cable hop

Field Description

Port Status Lists the status of the port. Valid states are down if frequency
is unassigned or admindown if the port is shut down. If the port
is up, this column shows the center frequency of the channel.

Poll Rate The rate that station maintenance polls are generated (in
milliseconds).

Missed Poll Count The number of missing polls, per codeword/FEC block.

Min Poll Sample The number of polls in the sample, per codeword/FEC block.

Missed PollPcnt The ratio of missing polls to the number of polls, expressed as
a percentage.

Hop Thres Pcnt The level that the missed poll percentage must exceed to trigger
a frequency hop, expressed as a percentage.

Hop Period The maximum rate that frequency hopping will occur (in
seconds).

Corr FEC Errors The number of correctable forward error corrections (FEC) errors
on this upstream port, per codeword/FEC block.

Uncorr FEC Errors The number of uncorrectable FEC errors on this upstream port,
per codeword/FEC block.

Note
The show cable hop and show controllers
cable commands display FEC errors per
codewords, while the show interface
cable upstream command displays FEC
errors per packets, where a packet could
contain multiple codewords.

Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp
to show commands using the exec prompt timestamp command in line configuration mode.

The following example shows typical output from the show cable hop threshold command:

Router# show cable hop c6/0/0 threshold

Upstream SNR(dB) CNR(dB) CorrFEC% UncorrFEC% MissedSM%
Port Val Thre1 Thre2 Val Thre1 Thre2 Pcnt Thre Pcnt Thre Pcnt Thre
Ca6/0/0/U0 27 25 15 39 35 25 0 3 0 1 75 75
Ca6/0/0/U1 31 25 15 51 35 25 0 3 0 1 90 75
Ca6/0/0/U2 -- 35 25 -- 35 25 0 3 0 1 0 75
Ca6/0/0/U3 -- 35 25 -- 35 25 0 3 0 1 0 75

Cisco CMTS Cable Command Reference

1722
Cable Commands: show a through show cable l
show cable hop

Table 76: show cable hop threshold Command Field Descriptions

Field Description

Upstream Port The upstream port for this information line.

SNR (dB) The signal-to-noise ratio (SNR) for a particular cable modem (CM), in decibels (dB).

CNR (dB) The current upstream carrier-to-noise ratio (CNR) for a particular cable modem (CM),
in decibels (dB).

Corr FEC Errors The number of correctable forward error corrections (FEC) errors on this upstream port,
per codeword/FEC block.

Uncorr FEC Errors The number of uncorrectable FEC errors on this upstream port, per codeword/FEC
block.

Missed SM The number of missing station maintenance polls, per codeword/FEC block.

The following example shows typical output from the show cable hop history command:

Router# show cable hop c8/1/1 upstream 0 history

F = Frequency Hop, M = Modulation Change, C = Channel Width Change
Upstream Action Chg Chg Action
Port Time Code From To Reason
C8/1/1 U0 Feb 20 12:21:29 M 142 141 SNR 28>=28 CFEC 0<=3 UnCFEC 0<=1
Feb 20 12:09:08 F 0.000 24.000 Configuration changed

Table 77: show cable hop history Command Field Descriptions

Field Description

Upstream Port The upstream port for this information line.

Action Time The time of the spectrum management action.

Code The code associated with the type of hop.

Chg From The previous state of the spectrum management action.

Chg To The current state of the spectrum management action.

Action Reason The reason for changing the frequency.

This example shows the output of the show cable hop upstream-cable command on the Cisco cBR-8
Converged Broadband Router.

Router# show cable hop upstream-cable 1/0/0

Upstream Channel Poll Missed Min Missed Hop Hop Corr Uncorr
Channel Status Rate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
UC1/0/0:U0 13.200 MHz 1000 * * * set to fixed frequency * * * 0 0
UC1/0/0:U1 19.600 MHz 1000 * * * set to fixed frequency * * * 0 2
UC1/0/0:U2 26.000 MHz * * * us-channel is not binded to any MD * * * 0 0
UC1/0/0:U3 32.400 MHz * * * us-channel is not binded to any MD * * * 0 0
UC1/0/0:U4 admindown * * * us-channel is not binded to any MD * * * 0 0
UC1/0/0:U5 admindown * * * us-channel is not binded to any MD * * * 0 0

Cisco CMTS Cable Command Reference

1723
 Cable Commands: show a through show cable l
show cable hop

UC1/0/0:U6 admindown * * * us-channel is not binded to any MD * * * 0 0

UC1/0/0:U7 admindown * * * us-channel is not binded to any MD * * * 0 0
UC1/0/0:U8 admindown * * * us-channel is not binded to any MD * * * 0 0
UC1/0/0:U9 admindown * * * us-channel is not binded to any MD * * * 0 0
UC1/0/0:U10 admindown * * * us-channel is not binded to any MD * * * 0 0
UC1/0/0:U11 admindown * * * us-channel is not binded to any MD * * * 0 0

Router#

Related Commands Command Description

cable spectrum-group hop period Changes the minimum time between frequency hops.

cable spectrum-group hop threshold Specifies a frequency hop threshold for a spectrum group.

cable upstream hop-priority Configures the priority of the corrective actions to be taken when a
frequency hop is necessary due to ingress noise on the upstream.

cable upstream modulation-profile Configures up to three modulation profiles to an upstream port to

activate Dynamic Upstream Modulation.

cable upstream threshold Configures the upstream for the CNR and FEC threshold values to
be used in determining the allowable noise levels.

cable upstream threshold hysteresis Configures a hysteresis value to be used in conjunction with the
dynamic modulation upgrade thresholds.

clear cable hop Clears the forward error corrections (FEC) hop counters on one or
all cable interfaces on a Cisco CMTS.

show cable host access-group Displays the statistics for the host behind the CM.

show cable modem Displays CM configuration settings.

Cisco CMTS Cable Command Reference

1724
 Cable Commands: show a through show cable l
show cable host access-group

show cable host access-group

To display the hosts and other customer premises equipment (CPE) devices behind the CMs in the network,
along with their access groups, use the show cable host access-group command in privileged EXEC mode.

show cable host [ip-addressmac-address] access-group

Note The show cable host command is not supported on the Cisco uBR10012 universal broadband router.

Syntax Description mac-address (Optional) Specifies the 48-bit hardware address for a particular CM or host.

ip-address (Optional) Specifies the IP address for a particular CM or host.

Command Modes
Privileged EXEC

Command History Release Modification

11.NA This command was introduced.

12.1(3a)EC1 Support was added to the Release 12.1 EC train.

12.2(4)BC1 Support was added to the Release 12.2 BC train for the Cisco uBR7100 series and Cisco
uBR7200 series routers. (This command also appears in the CLI for the Cisco uBR10012
router but is not functional.)

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Router.
3.15.0S

Usage Guidelines This command displays information only for hosts and other CPE devices. To display information for CMs
and their associated CPE devices, use the show cable device access-group command. To display information
only for CMs, use the show cable device access-group command.
If an SNMP manager is requesting information about CM or CPE devices at the same time that this command
is given, the command displays the following error message:

No information is available, please try later.

Wait until the SNMP retrieval is done and retry the CLI command.

Examples The following example shows how to display all the hosts behind the CMs in the network:

Router# show cable host access-group

MAC address IP address Type Access-group
0080.c6f9.b42e 24.168.220.52 host
0020.7806.defe 192.168.28.134 host
0050.baa0.5ccd 24.168.223.251 host
0050.046f.f4cf 192.168.33.25 host

Cisco CMTS Cable Command Reference

1725
 Cable Commands: show a through show cable l
show cable host access-group

0050.bacf.5d89 192.168.37.113 host

0050.1800.a8cb 192.168.33.90 host
0040.d00f.44f0 192.168.34.128 host
0050.e456.9641 192.168.39.66 host
0050.badd.2883 192.168.32.230 host
0050.badd.3b12 192.168.33.246 host
0020.78c7.f887 192.168.32.32 host
00e0.2969.a1a5 192.168.36.246 host
0020.78d5.ddf0 192.168.32.107 host
00001.02c5.9936 192.168.38.233 host
0020.78d0.fb32 192.168.28.45 host
0050.1800.f458 192.168.36.209 host
0002.e301.df8f 192.168.30.191 host
00a0.2451.b7eb 24.168.223.41 host
0080.c7db.afba 192.168.33.153 host
00D0.2717.1899 192.168.39.189 host
Router#

This table describes the fields that are shown in the show cable host access-group display:

Table 78: show cable host access-group Field Descriptions

Field Description

MAC Address The MAC address for the CPE device.

IP Address The IP address that the DHCP server has assigned to the CPE device.

Type Identifies the type of device. With this command, this field should always be host to indicate
a CPE device. Use the show cable device access-group or show cable modem access-group
command to display information for CMs.

Access-group Displays the access group name or number in use (if any) for this CPE device.

Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp
to show commands using the exec prompt timestamp command in line configuration mode.

Related Commands Command Description

cable device Configures the access list for a CM device or host.

cable host access-group Configures the access list for the specified hosts.

clear cable host Clears the host from the table.

show cable device access-group Displays a list of CMs and their CPE devices, along with their access
groups.

show cable modem access-group Displays the access groups for the CMs on a particular cable interface.

Cisco CMTS Cable Command Reference

1726
 Cable Commands: show a through show cable l
show cable ib-ipc

show cable ib-ipc

To display the status of local IB IPC server and information on participating line cards, use the show cable
ib-ipc command in privileged EXEC mode.

show cable ib-ipc {status | ports}

Syntax Description status Displays status of local IB IPC server.

ports Displays information on participating line cards.

Command Modes
Privileged EXEC

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Router.
3.15.0S

Examples The following is sample output from the show cable ib-ipc command. The command show cable
ib-ipc ports displays the internal virtual channel identifiers and internal service flows for Ironbus
based IPC.

Router# show cable ib-ipc ports

6/0: LCP High Priority VCCI 135, SFID 32891
LCP Normal Priority VCCI 135, SFID 135
8/0: LCP High Priority VCCI 153, SFID 32909
LCP Normal Priority VCCI 153, SFID 153

Cisco CMTS Cable Command Reference

1727
 Cable Commands: show a through show cable l
show cable ipc-stats

show cable ipc-stats

To display statistics of all IPC messages on a Cisco CMTS router, use the show cable ipc-stats command in
privileged EXEC mode.

show cable ipc-stats

Syntax Description This command has no arguments or keywords.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

12.2(33)SCF The command output displays the IPC port information such as service type of the IPC
messages.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Router.
3.15.0S

Usage Guidelines You must enable the Cable IPC Statistics Collection tool using the cable ipc-stats command before using the
show cable ipc-stats command. When you use this show command, a separate shadow database buffer is
allocated, and the contents of the active database are copied into the shadow database to display the IPC
statistics. This ensures that all the statistics are frozen at the same time for easy comparison and analysis.

Examples The following is a sample output of the show cable ipc-stats command that shows statistics of all
IPC messages on a Cisco CMTS router:

Router# show cable ipc-stats

--- TIME ---
Start: 05:25:22 UTC Tue May 24 2011
End : 05:26:39 UTC Tue May 24 2011
Total: 0 days 00 hrs 01 mins 17 secs (77 seconds)
size : 2186112 bytes
--- CMTS MSG ---
entity app io s/s reqid idx dbg : pkts bytes lastEvt totalDur maxDur lastMax

(sec) (msec) (msec) (sec)

rp-lc c10k TxReq 1/0 10241 1 off : 2 48 58
rp-lc c10k TxReq 1/0 10 14 off : 15 960 4
rp-lc c10k TxReq 1/1 10 14 off : 15 960 4
rp-lc c10k TxReq 2/1 10 14 off : 16 1024 2
rp-lc c10k TxReq 4/1 10 14 off : 15 960 4
rp-lc c10k TxReq 5/1 10252 2 off : 24 1840 3
rp-lc c10k TxReq 5/1 10 14 off : 16 1024 0
rp-lc c10k TxReq 7/0 10252 2 off : 17 1112 4
rp-lc c10k TxReq 7/0 10 14 off : 15 960 4
rp-lc c10k TxReq 8/1 10252 2 off : 22 6080 2
rp-lc c10k TxReq 8/1 10 14 off : 15 960 2

Cisco CMTS Cable Command Reference

1728
Cable Commands: show a through show cable l
show cable ipc-stats

rp-lc c10k RxRsp 1/0 10241 1 off : 2 8 58 4 4

58
rp-lc c10k RxRsp 8/1 10252 2 off : 1 72 2 0 0
2
rp-lc c10k RxReq 1/0 10241 1 off : 2 64 58 0 0
58
rp-lc c10k RxReq 1/0 10 14 off : 15 960 4 0 0
4
rp-lc c10k RxReq 1/1 10241 1 off : 38 19684 1 0 0
1
rp-lc c10k RxReq 1/1 10 14 off : 15 960 4 0 0
4
rp-lc c10k RxReq 2/1 10241 1 off : 37 19166 1 0 0
1
rp-lc c10k RxReq 2/1 10 14 off : 16 1024 2 0 0
2
rp-lc c10k RxReq 4/1 10241 1 off : 32 2144 0 0 0
0
rp-lc c10k RxReq 4/1 10 14 off : 15 960 4 0 0
4
rp-lc c10k RxReq 5/1 10252 2 off : 242 733456 2 0 0
2
rp-lc c10k RxReq 5/1 10 14 off : 16 1088 0 0 0
0
rp-lc c10k RxReq 7/0 10252 2 off : 257 783364 1 0 0
1
rp-lc c10k RxReq 7/0 10 14 off : 15 1020 4 0 0
4
rp-lc c10k RxReq 8/1 10252 2 off : 241 714668 4 0 0
4
rp-lc c10k RxReq 8/1 10 14 off : 15 1020 2 0 0
2
rp-lc pnego TxReq 5/1 14 6 off : 1 30 77

entity app io s/s reqid idx dbg : pkts bytes lastEvt totalDur maxDur lastMax

(sec) (msec) (msec) (sec)

rp-lc pnego TxReq 7/0 14 6 off : 1 30 77
rp-lc pnego TxReq 8/1 14 6 off : 1 30 77
rp-lc plfm RxReq 5/1 24 17 off : 2 24 12 0 0
12
rp-lc plfm RxReq 5/1 27 20 off : 225 23400 2 36 4
12
rp-lc plfm RxReq 5/1 28 21 off : 9900 554400 2 1584 4
12
rp-lc plfm RxReq 7/0 24 17 off : 1 12 21 0 0
21
rp-lc plfm RxReq 7/0 27 20 off : 240 24960 1 72 4
1
rp-lc plfm RxReq 7/0 28 21 off : 10560 591360 1 3168 4
1
rp-lc plfm RxReq 8/1 24 17 off : 1 12 28 0 0
28
rp-lc plfm RxReq 8/1 27 20 off : 225 23400 4 32 4
4
rp-lc plfm RxReq 8/1 28 21 off : 9900 554400 4 1408 4
4
rp-lc docsis TxReq 5/1 118 109 off : 30 240 3
rp-lc docsis TxReq 7/0 118 109 off : 16 128 4
rp-lc docsis TxReq 8/1 118 109 off : 16 128 3
rp-lc docsis RxReq 5/1 153 144 off : 345 19320 2 184 4
7
rp-lc docsis RxReq 7/0 153 144 off : 384 21504 1 192 4
66

Cisco CMTS Cable Command Reference

1729
 Cable Commands: show a through show cable l
show cable ipc-stats

rp-lc docsis RxReq 8/1 153 144 off : 60 3360 4 80 4

9
rp-lc docsis RxReq 8/1 154 145 off : 15 480 4 20 4
9
rp-lc snmp RxReq 5/1 42 42 off : 2 32 5 4 4
5
rp-lc test TxReq 8/1 10 3 off : 1 16 2
rp-lc test TxReq 8/1 20 13 off : 100 1600 2
rp-lc test RxRsp 8/1 10 3 off : 1 16 2 0 0
2
--- CMTS TXQ ---
TXQ_5_1_default
enQ: 24 pkts max Q size 1 at 3 sec ago
deQ: 24 pkts max delay 0 msec at 3 sec ago
delay between ( 0, 10) msec: 24 pkts
delay between ( 0, 1) sec : 24 pkts
flush: 0 ptks 0 times
TXQ_7_0_default
enQ: 17 pkts max Q size 1 at 4 sec ago
deQ: 17 pkts max delay 0 msec at 4 sec ago
delay between ( 0, 10) msec: 17 pkts
delay between ( 0, 1) sec : 17 pkts
flush: 0 ptks 0 times
TXQ_8_1_default
enQ: 17 pkts max Q size 1 at 3 sec ago
deQ: 17 pkts max delay 0 msec at 3 sec ago
delay between ( 0, 10) msec: 17 pkts
delay between ( 0, 1) sec : 17 pkts
flush: 0 ptks 0 times
TXQ_8_1_inband
enQ: 5 pkts max Q size 5 at 2 sec ago
deQ: 5 pkts max delay 4 msec at 2 sec ago
delay between ( 0, 10) msec: 5 pkts
delay between ( 0, 1) sec : 5 pkts
flush: 0 ptks 0 times
--- CMTS WATERMARK ---
--- CMTS RXQ ---
CMTS rxq
enQ: 956 pkts max Q size 6 at 41 sec ago
deQ: 956 pkts max delay 4 msec at 69 sec ago
delay between ( 0, 10) msec: 956 pkts
delay between ( 0, 1) sec : 956 pkts
flush: 0 ptks 0 times
CMTS LP rxq
enQ: 742 pkts max Q size 6 at 41 sec ago
deQ: 742 pkts max delay 8 msec at 64 sec ago
delay between ( 0, 10) msec: 742 pkts
delay between ( 0, 1) sec : 742 pkts
flush: 0 ptks 0 times

This table describes the fields displayed by the show cable ipc-stats command.

Table 79: show cable ipc-stats Command Field Descriptions

Field Description

entity Route processor-to-line card connection or a line card-to-line card connection.

app Message group.

io Send request or a send response, or a receiver request or a receiver response.

s/s Slot/subslot

Cisco CMTS Cable Command Reference

1730
 Cable Commands: show a through show cable l
show cable ipc-stats

Field Description

reqid Nonsequential message ID for the original request.

idx Sequential message index for the original request.

pkts Number of messages.

bytes Number of bytes.

lastEvt (sec) Seconds since the last send or receive event.

totalDur (msec) Total time in milliseconds for the blocked send wait or received request process.

maxDur (msec) Maximum time in milliseconds for the blocked send wait or received request process.

lastMax (sec) Seconds since the last maxDur is recorded.

Related Commands Command Description

cable ipc-stats Enables the Cable IPC Statistics Collection tool on a Cisco CMTS router.

clear cable ipc-stats Clears the active database and resets all IPC statistics in the active database to zero.

Cisco CMTS Cable Command Reference

1731
 Cable Commands: show a through show cable l
show cable ipv6 leasequery-filter

show cable ipv6 leasequery-filter

On the Cisco cBR Series Converged Broadband Router, to view the subscriber information, use the show
cable ipv6 leasequery-filter command to view the leasequery filter statistics.

show cable ipv6 leasequery-filter[cableslot/subslot/cable-interface-index]

Syntax Description cableslot/subslot/cable-interface-index (Optional) For the Cisco cBR router—

• The valid range for the slot is 0 to 3 and 6 to 9.
• The valid value for the subslot is 0.
• The valid range for cable-interface-indexis 0 to
15.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines To view the leasequery filter statistics for a specific cable interface, use the
cableslot/subslot/cable-interface-index option.

Example for Cisco cBR router

This example shows the output for the show cable ipv6 leasequery-filter command on the Cisco
cBR router:

Router#show cable ipv6 leasequery-filter

Lease Query IPv6 Filter statistics for Unknown Sid
Requests Sent : 0 total. 0 unfiltered, 0 filtered

Router#

This example shows the output for the show cable ipv6 leasequery-filter command for a specific
cable interface on the Cisco cBR router:

Router#show cable ipv6 leasequery-filter cable 1/0/0

Lease Query IPV6 Filter statistics for Cable1/0/0:
Requests Sent : 0 total. 0 unfiltered, 0 filtered

Router#

Cisco CMTS Cable Command Reference

1732
 Cable Commands: show a through show cable l
show cable ipv6 leasequery-stats

show cable ipv6 leasequery-stats

To display the IPv6 cable leasequery packet processing statistics. Counters collect statistics and show the
queries that are sent to the DHCP server and the replies received by the cBR-8 routers. Use the show cable
ipv6 leasequery-stats command in the privileged EXEC mode.

show cable ipv6 leasequery-stats [ clear ]

Cisco cBR Series Converged Broadband Router

show cable ipv6 leasequery-stats [ clear ]

Syntax Description clear (Optional) Resets all DHCPv6 counters on the cBR-8 router to zero.

Command Modes
Privileged EXEC (#)

Release Modification

17.6.1z1 This command was introduced.

Usage Guidelines The show cableipv6 leasequery-stats command displays the IPv6 cable leasequery packet processing
statistics. The counters are grouped by queries and replies.

Examples The following example shows the IPv4 cable leasequery statistics output on the cBR-8 router:

Router# show cable ipv6 leasequery-stats

IPv4 Source Verify LeaseQuery Statistics:
Queries: 1 sent, 0 timed out
Replies: 1 allowed, 0 rogues, 0 dropped

Table 80: show cable leasequery-stats Field Descriptions

Field Description

Queries

Sent Number of leasequeries sent by cBR-8.

Timed out Number of leasequeries timed out before receiving replies.

Replies

Allowed Number of replies that are valid, so that the CPE traffic is allowed.

Rogue Number of replies that indicate a CPE is a rogue device, so that the CPE is
added into the rogue list.

Dropped No of replies that are invalid, so they are dropped without further processing.

Cisco CMTS Cable Command Reference

1733
 Cable Commands: show a through show cable l
show cable l2-vpn dot1q-nsi-redundancy

show cable l2-vpn dot1q-nsi-redundancy

The show cable l2-vpn dot1q-nsi-redundancy command in privileged EXEC mode displays the following
information:
• Configured primary and the backup DOT1Q Ethernet Network System Interface (NSI).
• Current active NSI, through which the traffic flows.
• Time elapsed from latest switchover.

show cable l2-vpn dot1q-nsi-redundancy

Command Default None

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(33) SCJ This command was introduced on
the Cisco uBR Series Universal
Broadband Routers

IOS-XE 3.18.0S This command was introduced on

the Cisco cBR Series Converged
Broadband Routers.

Usage Guidelines The following conditions trigger a restart as indicated by the Elapsed-after-SW field:
• When the backup pair is created for the first time.
• When the Active-NSI in the pair fails and triggers a switchover.
• When you manually switch over the current active uplink NSI port.

Example
The following example shows the DOT1Q NSI port backup pair details:

Router# show cable l2-vpn dot1q-nsi-redundancy

Primary-NSI Backup-NSI Active-NSI Elapsed-after-SW
Te4/0/1 Te4/0/7 Te4/0/1 31m9s
Te4/0/2 Te4/0/3 Te4/0/2 59s

When two uplink DOT1Q NSI ports are UP, you can manually switch over an active uplink port
from current active uplink port to another using cable l2-vpn dot1q-nsi-redundancy force-switchover
from Te4/0/1 command. The following example shows the current NSI uplink active port after
switchover:

Router# show cable l2-vpn dot1q-nsi-redundancy

Primary-NSI Backup-NSI Active-NSI Elapsed-after-SW

Cisco CMTS Cable Command Reference

1734
Cable Commands: show a through show cable l
show cable l2-vpn dot1q-nsi-redundancy

Te4/0/1 Te4/0/7 Te4/0/7 41m27s

Te4/0/2 Te4/0/3 Te4/0/2 10m17s

Cisco CMTS Cable Command Reference

1735
 Cable Commands: show a through show cable l
show cable l2-vpn dot1q-vc-map

show cable l2-vpn dot1q-vc-map

To display the mapping of one or all cable modems to IEEE 802.1Q Virtual Local Area Networks (VLANs)
on the router’s Ethernet interfaces, use the show cable l2-vpn dot1q-vc-map command in privileged EXEC
mode.

show cable l2-vpn dot1q-vc-map [mac-address [vpn vpnid] [verbose]] [customer cust-name] [vpn
vpnid]

Syntax Description mac-address (Optional) Displays the mapping for the cable modem with the specified hardware
MAC address.

vpn vpnid (Optional) Displays Layer 2 VPN information on a cable modem with the specified
MAC address, or for the specified VPN ID across all cable modems.

verbose (Optional) Displays additional information about the Layer 2 mapping, including the
number of packets and bytes received on the upstream and downstream.

customer cust-name (Optional) Displays the VLAN mappings for this particular customer name.

Command Default Displays information for all cable modems that have a defined IEEE 802.1Q VLAN mapping.

Command Modes
Privileged EXEC

Command History Release Modification

12.2(15)BC2 This command was introduced for Cisco uBR7246VXR universal broadband routers.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA on the Cisco
uBR7246VXR and Cisco uBR10012 universal broadband routers. Support for the Cisco
uBR7225VXR router was added. The vpn keyword was added and the output fields were
modified to display L2VPN information.

12.2(33)SCF This command is obsolete for Cisco uBR10012 Series Universal Broadband Routers.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Router.
3.15.0S

Usage Guidelines This command displays the cable modem to VLAN mappings that have been defined using the cable
dot1q-vc-map command. It displays the MAC address, service ID (SID), and cable interface being used by
the cable modem, and the interface and VLAN ID to which it has been mapped.

Tip The customer option displays only those VLAN mappings that have been configured with a particular customer
name, using the cable dot1q-vc-map command.

The command also displays L2VPN information for cable modem traffic and service flows on CMTS router
Ethernet interfaces that have been defined using the cable l2-vpn-service default-nsi command.

Cisco CMTS Cable Command Reference

1736
Cable Commands: show a through show cable l
show cable l2-vpn dot1q-vc-map

TLS in Cisco IOS Release 12.2BC Examples

The following example shows typical output for the show cable l2-vpn dot1q-vc-map command
for all cable modems that are mapped to IEEE 802.1Q VLANs:

Router# show cable l2-vpn dot1q-vc-map

MAC Address Ethernet Interface VLAN ID Cable Intf SID Priv Bits
0010.7bed.9c95 FE0/0.2 3 Cable4/0 3 0
0007.0e03.69f9 FE0/0.1 4 Cable4/0 1 0
Router#

The following example shows typical output for a particular cable modem with the MAC address of
0001.0203.0405:

Router# show cable l2-vpn dot1q-vc-map 0001.0203.0405

MAC Address Ethernet Interface VLAN ID Cable Intf SID Priv Bits
0010.7bed.9c91 GE2/0 5 Cable5/0 7 0
Router#

The following example shows a typical example for the verbose option:

Router# show cable l2-vpn dot1q-vc-map 0001.0203.0405 verbose

MAC Address : 0010.7bed.9c91

Prim Sid : 7
Cable Interface : Cable5/0
Ethernet Interface : GigabitEthernet2/0
DOT1Q VLAN ID : 5
Total US pkts : 6
Total US bytes : 1402
Total DS pkts : 71
Total DS bytes : 21975

This table describes the fields shown in the display.

Table 81: show cable l2-vpn dot1q-vc-map Field Descriptions

Field Description

MAC Address Hardware (MAC) address for the CM being mapped.

Ethernet Interface Destination interface (Ethernet, Fast Ethernet, or Gigabit Ethernet) for the VLAN being
used for the mapping.

VLAN ID Destination VLAN on the Ethernet, Fast Ethernet, or Gigabit Ethernet interface for the
traffic coming from the CM.

Cable Intf Cable interface to which the CM is connected.

SID Primary service ID (SID) for this cable modem.

Cisco CMTS Cable Command Reference

1737
 Cable Commands: show a through show cable l
show cable l2-vpn dot1q-vc-map

Field Description

Priv Bits Identifies the current settings of the two privacy bits in the extended header (EH) that
is used for BPI-encrypted packets.
• First bit = Enable bit. Set to 1 when BPI or BPI+ is enabled.
• Second bit = Toggle bit. Matches the least-significant bit (LSB) of the key sequence
number (KSN) in the EH.
For example, a value of “0” indicates that BPI is not enabled. A value of “10” indicates
that BPI is enabled and that the KSN is an even number. A value of “11” indicates that
BPI is enabled and that the KSN is an odd number.
Note
For more information on these bits, see the DOCSIS Baseline Privacy Interface Plus
Interface Specification (SP-BPI+-I08-020301 or later).

Total US pkts/bytes Total number of packets and bytes sent on the upstream to the Layer 2 tunnel by this
cable modem.

Total DS pkts/bytes Total number of packets and bytes received on the downstream from the Layer 2 tunnel
by this cable modem.

L2VPN over Cable in Cisco IOS Release 12.2SB Examples

The following example shows sample output of VLAN information for all cable modems configured
for L2VPN support:

Router# show cable l2-vpn dot1q-vc-map

MAC Address Ethernet Interface VLAN ID Cable Intf SID Customer Name/VPN ID
0014.f8c1.fd66 GigabitEthernet4/0/0 68 Cable6/0/0 3 0234560001

The following example shows sample output of VLAN information for a VPN with ID 0234560001:

Router# show cable l2 dot1q-vc-map vpn 0234560001

MAC Address Ethernet Interface VLAN ID Cable Intf SID Customer Name/VPNID
0014.f8c1.fd66 GigabitEthernet4/0/0 68 Cable6/0/0 3 0234560001

The following example shows sample output of VLAN information for a VPN with ID 0234560001
on the cable modem with MAC address 0014.f8c1.fd66:

Router# show cable l2-vpn dot1q-vc-map 0014.f8c1.fd66 vpn 0234560001

MAC Address Ethernet Interface VLAN ID Cable Intf SID Customer Name/VPNID
0014.f8c1.fd66 GigabitEthernet4/0/0 68 Cable6/0/0 3 0234560001

The following example shows sample output of detailed VLAN information for a VPN with ID
0234560001 on the cable modem with MAC address 0014.f8c1.fd66:

Router# show cable l2-vpn dot1q-vc-map 0014.f8c1.fd66 vpn 0234560001 verbose

MAC Address : 0014.f8c1.fd66
Prim Sid : 3
Cable Interface : Cable6/0/0
VPN ID : 0234560001

Cisco CMTS Cable Command Reference

1738
Cable Commands: show a through show cable l
show cable l2-vpn dot1q-vc-map

L2VPN SAID : 12294

Upstream SFID : 23
Downstream CFRID[SFID] : 2[24]
CMIM : 0x60
Ethernet Interface : GigabitEthernet4/0/0
DOT1Q VLAN ID : 68
Total US pkts : 1372
Total US bytes : 500226
Total US pkt Discards : 0
Total US byte Discards : 0
Total DS pkts : 1248
Total DS bytes : 415584
Total DS pkt Discards : 0
Total DS byte Discards : 0

The following example shows sample output of detailed VLAN information for a cable modem with
MAC address 0014.f8c1.fd66:

Router# show cable l2-vpn dot1q-vc-map 0014.f8c1.fd66 verbose

MAC Address : 0014.f8c1.fd66
Prim Sid : 3
Cable Interface : Cable6/0/0
L2VPNs provisioned : 1
DUT Control/CMIM : Enable/0xFFFFFFFF
VPN ID : 0234560001
L2VPN SAID : 12294
Upstream SFID : 23
Downstream CFRID[SFID] : 2[24]
CMIM : 0x60
Ethernet Interface : GigabitEthernet4/0/0
DOT1Q VLAN ID : 68
Total US pkts : 1374
Total US bytes : 501012
Total US pkt Discards : 0
Total US byte Discards : 0
Total DS pkts : 1250
Total DS bytes : 416250
Total DS pkt Discards : 0
Total DS byte Discards : 0

This table describes the fields shown in the display.

Table 82: show cable l2-vpn dot1q-vc-map with L2VPN Field Descriptions

Field Description

MAC Address Hardware (MAC) address for the CM being mapped.

Prim Sid Primary service ID for the CM.

Cable Interface Cable interface to which the CM is connected.

L2VPNs provisioned Number of L2VPNs supported by the CM.

DUT Control/CMIM State of Downstream Unencrypted Traffic (DUT) filtering and Cable Modem
Interface Mask (CMIM).

VPN ID Identification number of the Layer 2 VPN tunnel.

L2VPN SAID Layer 2 VPN Security Association Identifier (SAID).

Cisco CMTS Cable Command Reference

1739
 Cable Commands: show a through show cable l
show cable l2-vpn dot1q-vc-map

Field Description

Upstream SFID Upstream Service Flow Identifier (SFID).

Downstream CFRID [SFID] Downstream classifiers (classifier identifiers) and corresponding downstream
service flows identifiers for this L2VPN.

CMIM Cable Modem Interface Mask.

Ethernet Interface Ethernet Network System Interface (NSI).

DOT1Q VLAN ID Destination VLAN on the Ethernet, Fast Ethernet, or Gigabit Ethernet interface
for the traffic coming from the CM.

Total US pkts/bytes Total number of packets and bytes sent on the upstream to the Layer 2 tunnel
by this CM.

Total US pkt/byte Discards Total number of packets and bytes dropped on the upstream to the Layer 2
tunnel by this CM.

Total DS pkts/bytes Total number of packets and bytes received on the downstream from the Layer
2 tunnel by this CM.

Total DS pkt/byte Discards Total number of packets and bytes dropped on the downstream from the Layer
2 tunnel by this CM.

Related Commands Command Description

cable l2-vpn-service dot1q Enables the use of Layer 2 tunnels for the Customer Premises Equipment
(CPE) traffic that is behind cable modems so that individual CPE traffic
can be routed over a particular Virtual Local Area Network (VLAN).

cable dot1q-vc-map Maps a cable modem to a particular VLAN on a local outbound Ethernet
interface.

cable l2-vpn-service default-nsi Configures an Ethernet Network System Interface for Layer 2 VPN
support over cable.

debug cable l2-vpn Displays debugging messages for the Layer 2 mapping of cable modems
to particular PVCs or VLANs.

Cisco CMTS Cable Command Reference

1740
 Cable Commands: show a through show cable l
show cable l2-vpn vc-map

show cable l2-vpn vc-map

To display the mapping of one or all cable modems to permanent virtual connections (PVC) on Asynchronous
Transfer Mode (ATM) interfaces, use the show cable l2-vpn vc-map command in privileged EXEC mode.

show cable l2-vpn vc-map [mac-address] [customer cust-name]

Syntax Description mac-address (Optional) Displays the mapping for the cable modem with the specified hardware
(MAC).

customer cust-name (Optional) Displays the PVC mappings for this particular customer name.

Command Default Displays information for all cable modems that have a defined ATM PVC mapping.

Command Modes
Privileged EXEC

Command History Release Modification

12.2(11)BC3 This command was introduced for Cisco uBR7100 series and Cisco uBR7246VXR universal
broadband routers.

12.2(15)BC2 Support was added for the customer option.

IOS-XE This command is not supported on the Cisco cBR Series Converged Broadband Router.
3.15.0S

Usage Guidelines This command displays the cable modem to ATM PVC mappings that have been defined using the cable
vc-map command. It displays the MAC address, service ID (SID), and cable interface being used by the
cable modem, and the ATM interface and PVC/PVI to which it has been mapped.

Tip The customer option displays only those PVC mappings that have been configured with a particular customer
name, using the cable vc-map command.

Examples The following example shows typical output for the show cable l2-vpn vc-map command for all
cable modems that are mapped to ATM PVCs:

Router# show cable l2-vpn vc-map

MAC Address ATM Intf VPI/VCI Cable Intf SID Priv Bits
0010.7bed.9c95 ATM2/0.2 1/2 Cable4/0 3 0
0007.0e03.69f9 ATM2/0.1 1/1 Cable4/0 1 0
Router#

The following example shows typical output for a particular cable modem with the MAC address of
0001.0203.0405:

Router# show cable l2-vpn vc-map 0001.0203.0405

Cisco CMTS Cable Command Reference

1741
 Cable Commands: show a through show cable l
show cable l2-vpn vc-map

MAC Address ATM Intf VPI/VCI Cable Intf SID Priv Bits
0001.0203.0405 ATM3/0.2 1/2 Cable5/0 3 0
Router#

Table 83: show cable l2-vpn vc-map Field Descriptions

Field Description

MAC Address Hardware (MAC) address for the CM being mapped.

ATM Intf Destination ATM interface that contains the VPI/VCI being used for the mapping.

VPI/VCI Destination VPI/VCI on the ATM interface for the traffic coming from the CM.

Cable Intf Cable interface to which the CM is connected.

SID Primary service ID (SID) for this cable modem.

Priv Bits Identifies the current settings of the two privacy bits in the extended header (EH) that is used
for BPI-encrypted packets.
• First bit = Enable bit. Set to 1 when BPI or BPI+ is enabled.
• Second bit = Toggle bit. Matches the least-significant bit (LSB) of the key sequence
number (KSN) in the EH.
For example, a value of “0” indicates that BPI is not enabled. A value of “10” indicates that
BPI is enabled and that the KSN is an even number. A value of “11” indicates that BPI is
enabled and that the KSN is an odd number.
Note
For more information on these bits, see the DOCSIS Baseline Privacy Interface Plus Interface
Specification (SP-BPI+-I08-020301 or later).

Related Commands Command Description

cable l2-vpn-service atm-vc Enables the use of Layer 2 tunnels for the Customer Premises Equipment
(CPE) traffic that is behind cable modems, so that individual CPE traffic can
be routed to a particular PVC on an ATM interface.

cable vc-map Maps a cable modem to a particular PVC on an ATM interface.

debug cable l2-vpn Displays debugging messages for the Layer 2 mapping of cable modems to
particular PVC on an ATM interface.

Cisco CMTS Cable Command Reference

1742
 Cable Commands: show a through show cable l
show cable l2-vpn xconnect

show cable l2-vpn xconnect

To display details about the mapping between a Multiprotocol Label Switching (MPLS) pseudowire and its
virtual circuits, use the show cable l2-vpn xconnect command in privileged EXEC mode.

show cable l2-vpn xconnect {dot1q-vc-map | mpls-vc-map}[ customer customer-name |mac-address

| vpn vpn-id [verbose]

Syntax Description dot1q-vc-map Specifies the mapping of one or all cable modems to IEEE 802.1Q Virtual Local
Area Networks (VLANs) on the Ethernet interfaces of a router.

mpls-vc-map Specifies the mapping between an MPLS pseudowire and its virtual circuits.

mac-address (Optional) MAC address for a cable modem.

customer customer-name (Optional) Specifies the customer name.

state (Optional) Specifies the state of all virtual circuits.

vpn vpn-id (Optional) Displays Layer 2 VPN information on a cable modem with the specified
MAC address, or for the specified VPN ID across all cable modems.

verbose (Optional) Specifies verbose mode for the output, giving additional details about
the mapping between an MPLS pseudowire and its virtual circuits.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCC This command was introduced in Cisco IOS Release 12.2(33)SCC.

12.2(33)SCF This command was modified. The verbose keyword option was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Router.
3.15.0S

Examples

Example of the show cable l2-vpn xconnect Command for the Mapping Between an MPLS Pseudowire
and All Virtual Circuits
The following is a sample output of the show cable l2-vpn xconnect command that shows the
mapping between an MPLS pseudowire and all virtual circuits on a Cisco uBR10012 router:

Router# show cable l2-vpn xconnect mpls-vc-map

MAC Address Peer IP Address VCID CktID Cable Intf SID Customer
Name/VPNID
0000.396e.6a68 101.1.0.2 221 Bu254:221 Cable7/0/0 1 customer1

Cisco CMTS Cable Command Reference

1743
 Cable Commands: show a through show cable l
show cable l2-vpn xconnect

0014.f8c1.fd66 10.76.1.1 2004 Bu254:5121 Cable7/0/0 8

0019.474a.d566 10.76.1.1 2001 Bu254:5122 Cable7/0/0 4 0234560002
0019.474a.d42e 10.76.1.1 2002 Bu254:2003 Cable7/0/0 5 0234560003

Example of the show cable l2-vpn xconnect Command for a Particular MAC Address
The following sample output displays the mapping between an MPLS pseudowire and the virtual
circuit for a particular MAC address of a cable modem on a Cisco uBR10012 router:

Router# show cable l2-vpn xconnect mpls-vc-map 0000.396e.6a68

MAC Address Peer IP Address VCID CktID Cable Intf SID Customer
Name/VPNID
0000.396e.6a68 101.1.0.2 221 Bu254:221 Cable7/0/0 1 customer1

Example of the show cable l2-vpn xconnect Command for a Particular Customer
The following sample output displays the mapping between an MPLS pseudowire and all virtual
circuits configured for a particular customer on a Cisco uBR10012 router:

Router# show cable l2-vpn xconnect mpls-vc-map customer1

MAC Address Peer IP Address VCID CktID Cable Intf SID Customer
Name/VPNID
0000.396e.6a68 101.1.0.2 221 Bu254:221 Cable7/0/0 1 customer1

Example of the show cable l2-vpn xconnect Command that Shows Information About the State of
All Virtual Circuits
The following sample output displays the state of all virtual circuits associated with an MPLS
pseudowire on a Cisco uBR10012 router:

Router# show cable l2-vpn xconnect mpls-vc-map state

Peer IP Address VCID STATE MAC Address Customer Name/VPNID STATE
101.1.0.2 22 DOWN 0000.396e.6a68 customer1 UP
10.76.1.1 2004 UP 0014.f8c1.fd66 UP
10.76.1.1 2001 UP 0019.474a.d566 0234560002 UP
10.76.1.1 2002 UP 0019.474a.d42e 0234560003 UP

Example of the show cable l2-vpn xconnect Command for the Mapping Between an MPLS Pseudowire
and All Virtual Circuits in Cisco IOS Release 12.2(33)SCF
The following is a sample output of the show cable l2-vpn xconnect command that shows the details
of the mapping between an MPLS pseudowire and all virtual circuits on a Cisco uBR10012 router:

Router# show cable l2-vpn xconnect mpls-vc-map

54d4.6f88.7362 verbose
Load for five secs: 2%/0%; one minute: 1%; five minutes: 2%
Time source is hardware calendar, *16:46:29.139 pst Thu Mar 3 2011
MAC Address : 54d4.6f88.7362
Customer Name :
Prim Sid : 18
Cable Interface : Cable5/0/1
MPLS-EXP : 0

Cisco CMTS Cable Command Reference

1744
Cable Commands: show a through show cable l
show cable l2-vpn xconnect

PW TYPE : Ethernet
Backup enable delay : 0 seconds
Backup disable delay : 0 seconds
Primary peer
Peer IP Address (Active) : 10.8.8.8
XConnect VCID : 97
Circuit ID : Bu254:97
Local State : UP
Remote State : UP
Total US pkts : 418756
Total US bytes : 586227332
Total US pkts discards : 0
Total US bytes discards : 0
Total DS pkts : 417347
Total DS bytes : 591773612
Total DS pkts discards : 0
Total DS bytes discards : 0

The table describes the fields shown in the show cable l2-vpn xconnect command display.

Table 84: show cable l2-vpn xconnect Field Descriptions

Field Description

MAC Address MAC address of a cable modem.

Peer IP Address IP address of the remote provider edge router.

VCID Virtual circuit ID.

CktID Circuit ID.

Cable Intf/Interface Cable interface for the MPLS pseudowire.

SID Service ID.

STATE State of all virtual circuits.

Customer Name Customer name.

Prim Sid Primary service ID.

MPLS-EXP Multiprotocol Label Switching experimental bit value.

PW TYPE Pseudowire type.

Backup enable delay Interval to enable backup.

Backup disable delay Interval to disable backup.

Peer IP Adress (Active) IP address of the active peer router.

XConnect VCID Xconnect virtual circuit ID.

Circuit ID Circuit ID.

Local State Local state.

Remote State Remote state.

Cisco CMTS Cable Command Reference

1745
 Cable Commands: show a through show cable l
show cable l2-vpn xconnect

Field Description

Total US pkts Total number of packets sent on the upstream.

Total US bytes Total number of bytes sent on the upstream.

Total US pkts discards Total number of packets discarded on the upstream.

Total US bytes discards Total number of bytes discarded on the upstream.

Total DS pkts Total number of packets received on the downstream.

Total DS bytes Total number of bytes received on the downstream.

Total DS pkts discards Total number of packets discarded on the downstream.

Total DS bytes discards Total number of bytes discarded on the downstream.

The following examples show the output of the show cable l2-vpn xconnect command on the Cisco
cBR router:

Router# show cable l2-vpn xconnect mpls-vc-map

MAC Address Peer IP Address VCID Type Prio CktID Cable Intf SID Customer Name/VPNID
602a.d083.2e1c 123.1.1.1 60 Prim* Bu254:4102 Cable3/0/0 5
38c8.5cac.4a62 123.1.1.1 20 Prim* Bu254:4103 Cable3/0/0 4 000232303230
156.1.3.1 30 Bkup 3 Bu254:4103
123.1.1.1 50 Bkup 8 Bu254:4103
38c8.5cac.4a62 156.1.3.1 56 Prim* Bu254:4104 Cable3/0/0 4 000232303231
123.1.1.1 40 Bkup 1 Bu254:4104

This example shows the state of all virtual circuits associated with an MPLS pseudowire when
pseudowire redundancy is not configured, using the showcablel2-vpnxconnectmpls-vc-map state
command:

Router# show cable l2-vpn xconnect mpls-vc-map state

MAC Address Peer IP Address VCID Type Prio State Customer Name/VPNID State
602a.d083.2e1c 123.1.1.1 60 Prim* UP UP
38c8.5cac.4a62 123.1.1.1 20 Prim* UP 000232303230 UP
38c8.5cac.4a62 156.1.3.1 56 Prim* UP 000232303231 UP

This example shows the state of all virtual circuits associated with an MPLS pseudowire when
pseudowire redundancy is configured, use the showcablel2-vpnxconnectmpls-vc-map state command
:

Router# show cable l2-vpn xconnect mpls-vc-map state

MAC Address Peer IP Address VCID Type Prio State Customer Name/VPNID State
602a.d083.2e1c 123.1.1.1 60 Prim* UP UP
38c8.5cac.4a62 123.1.1.1 20 Prim* UP 000232303230 UP
156.1.3.1 30 Bkup 3 UP 000232303230 STDBY
123.1.1.1 50 Bkup 8 DOWN 000232303230 STDBY
38c8.5cac.4a62 156.1.3.1 56 Prim* UP 000232303231 UP
123.1.1.1 40 Bkup 1 UP 000232303230 STDBY

Cisco CMTS Cable Command Reference

1746
 Cable Commands: show a through show cable l
show cable l2-vpn xconnect

The following example shows the information for a modem for which pseudowires were configured
using backup peer command:

Router# show cable l2-vpn xconnect mpls-vc-map 0025.2e2d.7252 verbose

MAC Address : 0025.2e2d.7252
Customer Name :
Prim Sid : 1
Cable Interface : Cable8/0/3
MPLS-EXP : 0
PW TYPE : Ethernet
Backup enable delay : 0 seconds
Backup disable delay : 0 seconds
Primary peer
Peer IP Address (Active) : 10.76.2.1
XConnect VCID : 400
Circuit ID : Bu254:400
Local State : UP
Remote State : UP
Backup peers
Peer IP Address : 10.76.2.1
XConnect VCID : 600
Circuit ID : Bu254:600
Local State : STDBY
Remote State : UP
Priority : 4
Total US pkts : 0
Total US bytes : 0
Total US pkts discards : 0
Total US bytes discards : 0
Total DS pkts : 0
Total DS bytes : 0
Total DS pkts discards : 0
Total DS bytes discards : 0

Related Commands Command Description

show Displays information about attachment circuits and pseudowires.

xconnect

Cisco CMTS Cable Command Reference

1747
 Cable Commands: show a through show cable l
show cable leasequery-filter

show cable leasequery-filter

To display the number of Dynamic Host Configuration Protocol (DHCP) LEASEQUERY request messages
that have been filtered for all cable modems (CMs) or for a particular cable interface, use the show cable
leasequery-filter command in privileged EXEC mode.

show cable leasequery-filter [cable | {slot/portslot/subslot/port } | [requests-filtered [minimum-requests]]]

Cisco cBR Series Converged Broadband Router

show cable leasequery-filter cable slot/subslot/cable-interface-index[requests-filtered [minimum-requests]]

Syntax Description cable slot/port (Optional) Displays information for all CMs on the specified cable
interface and downstream port on the Cisco uBR7200 series routers.
• slot —3 to 6
• port —0 or 1 (depending on the cable interface)

cable slot/subslot/port (Optional) Displays information for all CMs on the specified cable
interface on the Cisco uBR10012 router. The following are the valid
values:
• slot —5 to 8
• subslot —0 or 1
• port —0 to 4 (depending on the cable interface)

cableslot/subslot/cable-interface-index (Optional) Displays information for all CMs on the specified cable
interface on the Cisco uBR10012 router. The following are the valid
values:
• slot —0 to 3 and 6 to 9
• subslot —0
• cable-interface-index — 0 to 15

requests-filtered (Optional) Displays the number of DHCP LEASEQUERY requests

that have been filtered for each particular cable modem on a cable
interface.
• minimum-requests —(Optional) Displays only those cable
modems for which the router has filtered at least this minimum
number of lease queries. The valid range is from 1 to 65535,
with a default of 1.

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(15)BC1d, 12.2(15)BC2b This command was introduced.

12.3BC This command was integrated into Cisco IOS Release 12.3BC.

Cisco CMTS Cable Command Reference

1748
 Cable Commands: show a through show cable l
show cable leasequery-filter

Release Modification

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA.

12.2(33)SCF1 This command was modified. The command output has been augmented to
display IPv6 data.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged
Broadband Router. The cable-interface-index variable is added.

Usage Guidelines The show cable leasequery-filter command displays the total number of DHCP LEASEQUERY requests
that have been filtered on a Cisco Cable Modem Termination System (CMTS) router and on a particular cable
interface. This command can also optionally display details for each particular cable modem on an interface
that has had DHCP lease queries filtered.

Examples The following examples show how to display the total number of DHCP LEASEQUERY requests
that have been filtered on the router and on a particular cable interface:

Router# show cable leasequery-filter

Lease Query Filter statistics for Unknown Sid
Requests Sent : 138 total. 41 unfiltered, 97 filtered
Router# show cable leasequery-filter cable 8/1/0

Lease Query Filter statistics for Cable8/1/0:

Requests Sent : 35 total. 25 unfiltered, 10 filtered

The following examples show how to display the total number of DHCP LEASEQUERY requests
that have been filtered on the router and on a particular cable interface in Cisco IOS Release
12.2(33)SCF1:

Router# show cable leasequery-filter

IPv4 Lease Query Filter statistics for Unknown Sid
Requests Sent : 0 total. 0 unfiltered, 0 filtered
IPv6 Lease Query Filter statistics for Unknown Sid
Requests Sent : 0 total. 0 unfiltered, 0 filtered
Router# show cable leasequery-filter cable 7/0/0

IPv4 Lease Query Filter statistics for Cable7/0/0:

Requests Sent : 0 total. 0 unfiltered, 0 filtered
IPv6 Lease Query Filter statistics for Cable7/0/0:
Requests Sent : 0 total. 0 unfiltered, 0 filtered

The following example shows how to display a list of cable modems on a cable interface and the
number of DHCP LEASEQUERY messages that have been filtered for each interface:

Router# show cable leasequery-filter cable 8/1/0 requests-filtered

Sid MAC Address IP Address Req-Filtered

1 0050.7366.1243 92.1.1.20 0
2 0007.0e06.953b 95.1.1.24 0
3 0007.0e06.97b5 93.1.1.24 2
4 00d0.ba45.4bd5 91.1.1.35 0
5 0007.0e06.9773 95.1.1.23 12
6 0001.42aa.737d 94.1.1.23 645
7 0001.42aa.738b 95.1.1.22 0

Cisco CMTS Cable Command Reference

1749
 Cable Commands: show a through show cable l
show cable leasequery-filter

8 00d0.ba45.4955 92.1.1.23 0
9 0007.0e06.51ef 94.1.1.25 0
10 00d0.ba77.743b 91.1.1.36 3
11 0001.42aa.6e6f 93.1.1.22 2
12 0007.0e06.512f 91.1.1.23 2
13 0007.0e06.5137 92.1.1.25 0
14 0007.0e06.9be7 92.1.1.24 0
15 0002.b970.0027 92.1.1.22 1
16 0001.42aa.738d 91.1.1.21 10

The following example shows how to display a list of cable modems on a cable interface and the
number of DHCP LEASEQUERY messages that have been filtered for each interface in Cisco IOS
Release 12.2(33)SCF1:

Router# show cable leasequery-filter cable 8/1/0 requests-filtered

Sid MAC Address IP Address Req-Filtered

1 0018.6835.2756 0.0.0.0 0
2 0025.2e2d.7440 0.0.0.0 0
Sid MAC Address IP Address Req-Filtered
1 0018.6835.2756 2001:DB8:1::1 0
2 0025.2e2d.7440 2001:DB8:1::2 0

The following example shows how to display a list of cable modems on a cable interface that have
had ten or more DHCP LEASEQUERY messages that have been filtered:

Router# show cable leasequery-filter cable 8/1/0 requests-filtered 10

Sid MAC Address IP Address Req-Filtered
5 0007.0e06.9773 95.1.1.23 12
6 0001.42aa.737d 94.1.1.23 645
16 0001.42aa.738d 91.1.1.21 10

This example shows the output of the show cable leasequery-filter command for the Cisco cBR
Series Converged Broadband Router:

Router#show cable leasequery-filter cable 1/0/0

IPv4 Lease Query Filter statistics for Cable1/0/0:
Requests Sent : 0 total. 0 unfiltered, 0 filtered
IPv6 Lease Query Filter statistics for Cable1/0/0:
Requests Sent : 0 total. 0 unfiltered, 0 filtered

Router#show cable leasequery-filter

IPv4 Lease Query Filter statistics for Unknown Sid
Requests Sent : 0 total. 0 unfiltered, 0 filtered

Table 85: show cable leasequery-filter Field Descriptions

Field Description

Sid Service ID (SID) of the device.

MAC Address Hardware (MAC-layer) address of the cable modem or CPE device.

IP Address IP address of the cable modem (CMs) or customer premises equipment (CPE).

Req-Filtered Total number of Address Resolution Protocol (ARP) requests that the device has generated
or forwarded.

Cisco CMTS Cable Command Reference

1750
 Cable Commands: show a through show cable l
show cable leasequery-filter

Related Commands Command Description

cable arp Activates the cable ARP.

cable arp filter Controls the number of ARP requests and replies that are forwarded
on a cable interface.

cable source-verify Enables verification of IP addresses for CMs and CPE devices on
the upstream.

cable source-verify leasequery-filter Controls the number of DHCP lease query messages that are sent
downstream for unknown IP addresses on all cable downstream interfaces on the
Cisco CMTS router.

cable source-verify leasequery-filter Controls the number of DHCP lease query messages that are sent
upstream for unknown IP addresses for each SID on an upstream.

Cisco CMTS Cable Command Reference

1751
 Cable Commands: show a through show cable l
show cable leasequery-stats

show cable leasequery-stats

To display the IPv4 cable leasequery packet processing statistics. Counters collect statistics and show the
queries that are sent to the DHCP server and the replies received by the cBR-8 routers. Use the show cable
leasequery-stats command in the privileged EXEC mode.

show cable leasequery-stats [ clear ]

Cisco cBR Series Converged Broadband Router

show cable leasequery-stats [ clear ]

Syntax Description clear (Optional) Resets all DHCPv4 counters on the cBR-8 router to zero.

Command Modes
Privileged EXEC (#)

Release Modification

17.6.1z This command was introduced.

Usage Guidelines The show cable leasequery-stats command displays the IPv4 cable leasequery packet processing statistics.
The counters are grouped by queries and replies.

Examples The following example shows the IPv4 cable leasequery statistics output on the cBR-8 router:

Router# show cable leasequery-stats

IPv4 Source Verify LeaseQuery Statistics:
Queries: 1 sent, 0 timed out
Replies: 1 allowed, 0 rogues, 0 dropped

Table 86: show cable leasequery-stats Field Descriptions

Field Description

Queries

Sent Number of leasequeries sent by cBR-8.

Timed out Number of leasequeries timed out before receiving replies.

Replies

Allowed Number of replies that are valid, so that the CPE traffic is allowed.

Rogue Number of replies that indicate a CPE is a rogue device, so that the CPE is
added into the rogue list.

Dropped No of replies that are invalid, so they are dropped without further processing.

Cisco CMTS Cable Command Reference

1752
 Cable Commands: show a through show cable l
show cable licenses all

show cable licenses all

To view license information as applied to RF channels on the CMTS chassis, use the show cable licenses all
command in the privileged EXEC mode.

show cable licenses all

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCE This command was introduced.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Router.
3.15.0S

Examples The following example indicates information about licenses applied to RF channels on the CMTS
chassis.

Router# show cable licenses all

Load for five secs: 0%/0%; one minute: 1%; five minutes: 1%
Time source is hardware calendar, *05:40:06.005 UTC Mon May 3 2010
Subslot 6/0 : License Configuration : 20X20
Subslot 7/0 : Downstream Licenses : Installed : 72 Consumed : 8 Available : 64
Subslot 7/0 : Upstream Licenses : Installed : 60 Consumed : 52 Available : 8
Subslot 7/1 : Downstream Licenses : Installed : 72 Consumed : 0 Available : 72
Subslot 7/1 : Upstream Licenses : Installed : 60 Consumed : 0 Available : 60
Subslot 8/0 : Downstream Licenses : Installed : 72 Consumed : 8 Available : 64
Subslot 8/0 : Upstream Licenses : Installed : 60 Consumed : 52 Available : 8
Subslot 8/1 : Downstream Licenses : Installed : 0 Consumed : 0 Available : 0
Subslot 8/1 : Upstream Licenses : Installed : 0 Consumed : 0 Available : 0
Router#

The following example indicates information about licenses that are loaded on the slot/subslot.

Router# show cable licenses 8/0

Load for five secs: 1%/0%; one minute: 1%; five minutes: 1%
Time source is hardware calendar, *05:59:18.633 UTC Mon May 3 2010
Subslot 8/0 : Downstream Licenses : Installed : 72 Consumed : 8 Available : 64
Subslot 8/0 : Upstream Licenses : Installed : 60 Consumed : 52 Available : 8
Router#

This example shows the output of the show cable licenses all command on the Cisco cBR Series
Converged Broadband Router.

Router#show cable licenses all

Cisco CMTS Cable Command Reference

1753
 Cable Commands: show a through show cable l
show cable licenses all

--------------------------------------------
Entitlement: Downstream License
Consumed count: 768
Consumed count reported to SmartAgent: 768
Forced-Shut count: 0
Enforced state: No Enforcement

License Shut Channels:

--------------------------------------------
Entitlement: Upstream License
Consumed count: 64
Consumed count reported to SmartAgent: 64
Forced-Shut count: 0
Enforced state: No Enforcement

--------------------------------------------
Entitlement: WAN License
Consumed count: 4
Consumed count reported to SmartAgent: 4
Forced-Shut count: 0
Enforced state: No Enforcement

--------------------------------------------
Entitlement: LCHA License
Consumed count: 0
Consumed count reported to SmartAgent: 0
Forced-Shut count: 0
Enforced state: No Enforcement

--------------------------------------------
Entitlement: Video Narrowcast License
Consumed count: 0
Consumed count reported to SmartAgent: 0
Forced-Shut count: 0
Enforced state: No Enforcement

--------------------------------------------
Entitlement: Video Narrowcast Replicate License
Consumed count: 0
Consumed count reported to SmartAgent: 0
Forced-Shut count: 0
Enforced state: No Enforcement

--------------------------------------------
Entitlement: Video Narrowcast PKEY License
Consumed count: 0
Consumed count reported to SmartAgent: 0
Forced-Shut count: 0
Enforced state: No Enforcement

--------------------------------------------
Entitlement: Video Narrowcast PME License
Consumed count: 0
Consumed count reported to SmartAgent: 0
Forced-Shut count: 0
Enforced state: No Enforcement

--------------------------------------------
Entitlement: Video Narrowcast DVB License
Consumed count: 0
Consumed count reported to SmartAgent: 0
Forced-Shut count: 0
Enforced state: No Enforcement

Cisco CMTS Cable Command Reference

1754
 Cable Commands: show a through show cable l
show cable licenses all

Router#

If you enable Core Peak Bandwidth (CPB), the show cable licenses all command displays only
the CPB usage information.
show cable licenses all
Entitlement: CPB License
Consumed count: 987
Consumed count reported to SmartAgent: 987
Enforced state: No Enforcement
Quarterly CPB is 987 (100Mbps) in the First quarter of 2018.
First monthly CPB is: 103585495480 bps, 987 (100Mbps).
Second monthly CPB is: 103595095264 bps, 987 (100Mbps).
Third monthly CPB is: 103595124064 bps, 987 (100Mbps).

Related Commands Command Description

show license call-home pak Displays the stock keeping unit (SKU) list and features available in a product
authorization key (PAK).

license call-home install pak Installs a license by using the Cisco License Call Home feature.

Cisco CMTS Cable Command Reference

1755
 Cable Commands: show a through show cable l
show cable licenses cpb

show cable licenses cpb

To view the Core Peak Bandwidth (CPB) license information on the Cisco cBR Series Converged Broadband
Router, use the show cable licenses cpb command in the privileged EXEC mode.

show cable licenses cpb

[show cable licenses cpb-records year <year> month <month> day <day>]

Syntax Description cpb-records Shows the history of CPB samples.

year <year> Enter the year.

month <month> Enter the month.

day <day> Enter the date.

This command has no arguments or keywords.

Command Default Disabled

Command Modes Privileged EXEC (#)

Command History Release Modification

IOS XE Fuji This command was introduced on the Cisco cBR Series Converged Broadband Router.
16.9.1

show cable licenses cpb

This example shows the output of the show cable licenses cpb command on the Cisco cBR Series
Converged Broadband Router.
show cable licenses cpb
Entitlement: CPB License
Consumed count: 987
Consumed count reported to SmartAgent: 987
Enforced state: No Enforcement
Quarterly CPB is 987 (100Mbps) in the First quarter of 2018.
First monthly CPB is: 103585495480 bps, 987 (100Mbps).
Second monthly CPB is: 103595095264 bps, 987 (100Mbps).
Third monthly CPB is: 103595124064 bps, 987 (100Mbps).

This example shows the output of the show cable licenses cpb-records year <year> month
<month> day <day> command on the Cisco cBR Series Converged Broadband Router.
show cable licenses cpb-records year 2018 month 4 day 28
index: 34626, timestamp: 28-April-2018 05:30:02 UTC, 5min rate: 105291741536 bps, 1004
(100Mbps)
index: 34627, timestamp: 28-April-2018 05:35:02 UTC, 5min rate: 104006310312 bps, 991
(100Mbps)
index: 34628, timestamp: 28-April-2018 05:40:02 UTC, 5min rate: 104006237736 bps, 991
(100Mbps)
index: 34629, timestamp: 28-April-2018 05:45:02 UTC, 5min rate: 104006156168 bps, 991

Cisco CMTS Cable Command Reference

1756
Cable Commands: show a through show cable l
show cable licenses cpb

(100Mbps)
index: 34650, timestamp: 28-April-2018 07:30:03 UTC, 5min rate: 47644177216 bps, 454
(100Mbps)
index: 34651, timestamp: 28-April-2018 07:35:03 UTC, 5min rate: 83840688424 bps, 799
(100Mbps)
----------------------------------------------
There are 6 cpb records in Apr 28 2018 UTC.

Cisco CMTS Cable Command Reference

1757
 Cable Commands: show a through show cable l
show cable license wan

show cable license wan

To display the WAN license information for the 100G and 10G ports on a Supervisor 250G.

show cable license wan

Syntax Description This command has no arguments or keywords.

Command Default Disabled

Command Modes
Privileged EXEC (#)

Release Modification

IOS-XE This command was introduced.

16.8.1

The command displays the following information, depending on the cable license 100G-conversion
configuration.
• With the cable license 100G-conversion, the show cable license wan would display:
Router(config)# show cable licenses wan
--------------------------------------------
Entitlement: WAN License
Consumed count: 20
Consumed count reported to SmartAgent: 20
Enforced state: No Enforcement

• With the no cable license 100G-conversion, the show cable license wan would display:
Router(config)# show cable license wan
--------------------------------------------
Entitlement: WAN License
Consumed count: 0
Consumed count reported to SmartAgent: 0
Enforced state: No Enforcement

Cisco CMTS Cable Command Reference

1758
 Cable Commands: show a through show cable l
show cable load-balance

show cable load-balance

To display real-time configuration, statistical and operational information for load balancing operations on
the router, use the show cable load-balance command in privileged EXEC mode.

show cable load-balance [[groupn ] | all | load | pending | {statistics error [detail | linecard slot
/subslot | summary]} | target | fiber-node-validation | vdoc]

Cisco cBR Series Converged Broadband Router

show cable load-balance [ all | fiber-node-validation | load | pending | statistics | target |
move-history cable slot/subslot/controller-interface-index ]

Syntax Description group n (Optional) Specifies the number of the load balancing group to be displayed. In
Cisco IOS Release 12.2(33)SCE3 and earlier, the valid range is from 1 to 336. The
range from 1 to 80 is reserved for legacy load balancing groups (LBG). The range
from 81 to 336 is reserved for DOCSIS LBGs.
In Cisco IOS Release 12.2(33)SCE4 and later, the valid range is from 1 to 256. This
range is reserved for legacy LBGs only.
In the Cisco cBR Series Converged Broadband Router, this option is not supported.

all (Optional) Displays all information about the LBG.

load (Optional) Displays the current interface load and load balancing group assignments.

pending (Optional) Displays the list of cable modems that are moved from one downstream
or upstream to another.

statistics (Optional) Displays cumulative statistics for load balancing operations.

error detail (Optional) Displays the error statistics of all the active line card in detail.
In the Cisco cBR Series Converged Broadband Router, this option is not supported.

error linecard slot (Optional) Displays the error statistics of the line card, which is located in the
/subslot specified slot/ subslot.
In the Cisco cBR Series Converged Broadband Router, this option is not supported.

error summary (Optional) Displays the error statistics summary for each of the active line cards.
In the Cisco cBR Series Converged Broadband Router, this option is not supported.

target (Optional) Displays the current and target interfaces (upstreams and downstreams)
used for load balancing.

fiber-node-validation (Optional) Displays DOCSIS LBG and channel information after checking if the
channel configuration in load balancing fits in the fiber node configuration.

vdoc (Optional) Displays information about all LBGs that have the rule
"video-over-DOCSIS (vdoc)-enabled" configured.
In the Cisco cBR Series Converged Broadband Router, this option is not supported.

Cisco CMTS Cable Command Reference

1759
 Cable Commands: show a through show cable l
show cable load-balance

Command Default Displays information for all load balancing groups for each cable interface and its current load and load
balancing status. Starting with Cisco IOS Release 12.2(33)SCE4, the show cable load-balance command
supports only the legacy LBGs.

Command Modes Privileged EXEC (#)

Command History Release Modification

12.2(15)BC1 This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.2(33)SCC This command was modified. The fiber-node-validation parameter was added to the
command.

12.2(33)SCF This command was modified. The vdoc keyword was added to the command.

12.2(33)SCE4 The valid range for the load balance group was changed.

12.2(33)SCG A new column in the output displays the group index for the legacy LBG.

12.2(33)SCH1 The output of this command (when used without any keyword) was modified.

12.2(33)SCI This command was modified. The error keyword was added.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Router.
3.15.0S The group, error (including detail, linecard and summary options), and vdoc keywords
were removed

IOS-XE The option move-history slot/subslot/controller-interface-index was added.

17.6.1w

Usage Guidelines Use the show cable load-balance command to display the current, real-time statistics for load balancing
operations.
Use this command to display the status of the cable load-balance docsis30-enable downstream-only
command.

Examples The following is a sample output from the show cable load-balance command:

Router# show cable load-balance

Group Interval Method DCC Init Threshold

Technique Minimum Static Enforce Ugs PCMM
1 10 service-flows 1 1 2% 2% --- ---
2 10 modems 0 5 10% --- --- ---

DOCSIS LB Enabled: No

Effective with Cisco IOS Release 12.2(33)SCG, a new column in the output for the show cable
load-balance command also displays the group index for the legacy LBG. The Group Index column
identifies the mapping between the legacy LBG ID and the internal group index of the legacy LBG.

Router# show cable load-balance

Legacy Group Interval Method DCC Init Threshold
Group Index Technique Minimum Static Enforce Ugs PCMM

Cisco CMTS Cable Command Reference

1760
Cable Commands: show a through show cable l
show cable load-balance

1 513 30 modems 0 5 10% --- --- ---

2 514 30 modems 0 5 10% --- --- ---
DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Enabled: No
DOCSIS Group Status Interval DCC mask Policy Method Threshold
Group Index /UCC DS/US M/E/U/P/S
2 1 GE 30 0xF8(0)/N 0 m/m 5/10/70/70/50
70 2 RE 30 0xF8(0)/N 0 m/m 1/1/70/70/50

Effective with Cisco IOS Release 12.2(33)SCH1, the output of the show cable load-balance
command was modified. This example shows the modified output:

Router#show cable load-balance

Load for five secs: 0%/0%; one minute: 0%; five minutes: 0%
Time source is NTP, 20:22:33.307 UTC Wed Jul 17 2013
Legacy Group Interval Method DCC Init Threshold
Group Index Technique Minimum Static Enforce Ugs
PCMM
1 513 30 modems 0 5 10% --- ---
---
DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Downstream Enabled: Yes DOCSIS 3.0 LB U
pstream Enabled: No
DOCSIS Group Status Interval DCC mask Policy Method Threshold
Group Index /UCC DS/US M/E/U/P/S
1 1 GE 30 0xF8(0)/N 5 m/m 5/10/70/70/50
2 2 RE 30 0x40(1)/N 1 m/m 2/2/70/70/50
DOCSIS 3.0 General LB
MD FN Group S Intv DCC mask Policy Mtd MD-CM-SG Threshold
Index /UCC D/U M/E/U/P/S
Ca5/0/0 1 32768 E 30 0xF8(0)/N 0 m/m 0x101 5/10/70/70/50
Router#

The following is a sample output from the all option of the show cable load-balance command. The
all option displays information of all options available for this command except the
fiber-node-validation option.

Router# show cable load-balance all

Group Interval Method DCC Init Threshold

Technique Minimum Static Enforce Ugs PCMM
1 10 service-flows 1 1 2% 2% --- ---
2 10 modems 0 5 10% --- --- ---

DOCSIS LB Enabled: No

Current load:

Interface State Group Utilization Reserved Modems Weight

Index
Cable5/0/3 (459 MHz) up 1 0%(0%/0%) 0% 7 37
Cable5/0/3/U0 up 1 0% 0% 2 1.2
Cable5/0/3/U1 up 1 0% 0% 3 1.2
Cable5/0/3/U2 up 1 0% 0% 1 1.2
Cable5/0/3/U3 up 1 0% 0% 1 1.2
Cable5/0/4 (465 MHz) up 1 0%(0%/0%) 0% 7 37
Cable5/0/4/U0 up 1 0% 0% 2 1.2
Cable5/0/4/U1 up 1 0% 0% 2 1.2
Cable5/0/4/U2 up 1 0% 0% 1 1.2
Cable5/0/4/U3 up 1 0% 0% 2 1.2
Mo1/0/0:0 (555 MHz) down 1 0%(0%/0%) 0% 0 0

Cisco CMTS Cable Command Reference

1761
 Cable Commands: show a through show cable l
show cable load-balance

Target assignments:

Interface State Group Target

Index
Cable5/0/3 (459 MHz) up 1 Cable5/0/4 (465 MHz) [enforce]
Cable5/0/3/U0 up 1 Cable5/0/3/U2
Cable5/0/3/U1 up 1 Cable5/0/3/U2 [enforce]
Cable5/0/3/U2 up 1
Cable5/0/3/U3 up 1
Cable5/0/4 (465 MHz) up 1
Cable5/0/4/U0 up 1 Cable5/0/4/U2
Cable5/0/4/U1 up 1 Cable5/0/4/U2 [enforce]
Cable5/0/4/U2 up 1
Cable5/0/4/U3 up 1 Cable5/0/4/U2
Mo1/0/0:0 (555 MHz) down 1

Statistics:

Target interface State Transfers

Complete Pending Retries Failures
Cable5/0/3 (459 MHz) up 3 1 0 0
Cable5/0/3/U0 up 0 0 0 0
Cable5/0/3/U1 up 0 0 0 0
Cable5/0/3/U2 up 0 0 0 0
Cable5/0/3/U3 up 0 0 0 0
Cable5/0/4 (465 MHz) up 0 0 0 0
Cable5/0/4/U0 up 0 0 0 0
Cable5/0/4/U1 up 0 1 0 0
Cable5/0/4/U2 up 0 0 0 0
Cable5/0/4/U3 up 0 0 0 0
Mo1/0/0:0 (555 MHz) down 0 0 0 0

Pending:

Modem Grp Idx Source interface Target interface Retries

001a.c30c.7e74 1 Cable5/0/4 Cable5/0/3 (459 MHz) 0
0000.ca45.9886 1 Cable5/0/4/U2 U1 0
Router#

Starting with Cisco IOS Release 12.2(33)SCG, a new column in the output for the show cable
load-balance all command also displays the group index for the legacy LBG.
The following is a sample output from the all option of the show cable load-balance command:

Router# show cable load-balance all

Legacy Group Interval Method DCC Init Threshold
Group Index Technique Minimum Static Enforce Ugs PCMM
1 513 30 modems 0 5 10% --- --- ---
2 514 30 modems 0 5 10% --- --- ---
DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Enabled: No
DOCSIS Group Status Interval DCC mask Policy Method Threshold
Group Index /UCC DS/US M/E/U/P/S
2 1 GE 30 0xF8(0)/N 0 m/m 5/10/70/70/50
70 2 RE 30 0xF8(0)/N 0 m/m 1/1/70/70/50
Current load:
DOCSIS load-balancing load
Interface State Group Utilization Rsvd NBCM WB/UB Weight
Index Total Total
In7/0/0:0 (573 MHz) up 2 0%(0%/0%) 0% 9 1 37
In7/0/0:0/U0 up 2 0% 0% 1 0 2.5
In7/0/0:0/U1 up 2 0% 0% 2 0 2.5
In7/0/0:0/U2 up 2 0% 0% 2 0 2.5
In7/0/0:0/U3 up 2 0% 0% 2 0 2.5

Cisco CMTS Cable Command Reference

1762
Cable Commands: show a through show cable l
show cable load-balance

In7/0/0:0/U4 up 2 0% 0% 2 0 2.5
In7/0/0:0/U5 up 2 0% 0% 2 0 2.5
In7/0/0:1 (579 MHz) down 2 0%(0%/0%) 0% 0 0
In7/0/0:2 (585 MHz) up 2 0%(0%/0%) 0% 1 0 37
In7/0/0:2/U0 up 2 0% 0% 1 0 2.5
In7/0/0:2/U1 up 2 0% 0% 2 0 2.5
In7/0/0:2/U2 up 2 0% 0% 2 0 2.5
In7/0/0:2/U3 up 2 0% 0% 2 0 2.5
In7/0/0:2/U4 up 2 0% 0% 2 0 2.5
In7/0/0:2/U5 up 2 0% 0% 2 0 2.5
In7/0/0:3 (591 MHz) down 2 0%(0%/0%) 0% 0 0
LEGACY load-balancing load
Interface State Group Utilization Rsvd Modem Weight
Index Total
Cable7/1/0 (0 MHz) down 513 0%(0%/0%) 0% 0 0
Cable7/1/0/U0 down 513 0% 0% 0 0.0
Cable7/1/0/U1 down 513 0% 0% 0 0.0
Cable7/1/0/U2 down 513 0% 0% 0 0.0
Cable7/1/0/U3 down 513 0% 0% 0 0.0
Cable7/1/1 (0 MHz) down 514 0%(0%/0%) 0% 0 0
Cable7/1/1/U0 down 514 0% 0% 0 0.0
Cable7/1/1/U1 down 514 0% 0% 0 0.0
Cable7/1/1/U2 down 514 0% 0% 0 0.0
Cable7/1/1/U3 down 514 0% 0% 0 0.0
Target assignments:
Interface State Group Target
Index
In7/0/0:0 (573 MHz) up 2 In7/0/0:2 (585 MHz) [enforce]
In7/0/0:0/U0 up 2
In7/0/0:0/U1 up 2 In7/0/0:0/U0
In7/0/0:0/U2 up 2 In7/0/0:0/U0
In7/0/0:0/U3 up 2 In7/0/0:0/U0
In7/0/0:0/U4 up 2 In7/0/0:0/U0
In7/0/0:0/U5 up 2 In7/0/0:0/U0
In7/0/0:1 (579 MHz) down 2
In7/0/0:2 (585 MHz) up 2
In7/0/0:2/U0 up 2
In7/0/0:2/U1 up 2 In7/0/0:2/U0
In7/0/0:2/U2 up 2 In7/0/0:2/U0
In7/0/0:2/U3 up 2 In7/0/0:2/U0
In7/0/0:2/U4 up 2 In7/0/0:2/U0
In7/0/0:2/U5 up 2 In7/0/0:2/U0
In7/0/0:3 (591 MHz) down 2
Cable7/1/0 (0 MHz) down 513
Cable7/1/0/U0 down 513
Cable7/1/0/U1 down 513
Cable7/1/0/U2 down 513
Cable7/1/0/U3 down 513
Cable7/1/1 (0 MHz) down 514
Cable7/1/1/U0 down 514
Cable7/1/1/U1 down 514
Cable7/1/1/U2 down 514
Cable7/1/1/U3 down 514
Statistics:
Target interface State Transfers
Complete Pending Retries Failures
In7/0/0:0 (573 MHz) up 1 0 0 0
In7/0/0:0/U0 up 0 0 0 0
In7/0/0:0/U1 up 0 0 0 0
In7/0/0:0/U2 up 0 0 0 0
In7/0/0:0/U3 up 0 0 0 0
In7/0/0:0/U4 up 0 0 0 0
In7/0/0:0/U5 up 0 0 0 0
In7/0/0:1 (579 MHz) down 0 0 0 0

Cisco CMTS Cable Command Reference

1763
 Cable Commands: show a through show cable l
show cable load-balance

In7/0/0:2 (585 MHz) up 14 1 0 0

In7/0/0:2/U0 up 0 0 0 0
In7/0/0:2/U1 up 0 0 0 0
In7/0/0:2/U2 up 0 0 0 0
In7/0/0:2/U3 up 0 0 0 0
In7/0/0:2/U4 up 0 0 0 0
In7/0/0:2/U5 up 0 0 0 0
In7/0/0:3 (591 MHz) down 0 0 0 0
Cable7/1/0 (0 MHz) down 0 0 0 0
Cable7/1/0/U0 down 0 0 0 0
Cable7/1/0/U1 down 0 0 0 0
Cable7/1/0/U2 down 0 0 0 0
Cable7/1/0/U3 down 0 0 0 0
Cable7/1/1 (0 MHz) down 0 0 0 0
Cable7/1/1/U0 down 0 0 0 0
Cable7/1/1/U1 down 0 0 0 0
Cable7/1/1/U2 down 0 0 0 0
Cable7/1/1/U3 down 0 0 0 0
Pending:
Modem Grp Idx Primary RF/RCC MD/TCS Action Active Retries
Src Target Src Target Time
54d4.6f88.659c 2 In7/0/0:0 In7/0/0:2 (585 MHz) 0

The following is a sample output from the fiber-node-validation option of the show cable
load-balance command:

Router# show cable load-balance fiber-node-validation

DOCSIS LBG ID Match Channel Fiber-node list
1 match Ca5/0/0/U0 {1}
Ca5/0/0/U1 {1}
Ca5/0/0/U2 {1}
Ca5/0/0/U3 {1}
Mo1/0/0:0 {1}
2 match Ca5/0/0/U0 {1}
Ca5/0/0/U1 {1}
Ca5/0/0/U2 {1}
Mo1/0/0:0 {1}

Table 87: show cable load-balance Field Descriptions (default display)

Field Description

Fields for the Default Displays and load Option

Group Index Identifies the mapping between the legacy LBG ID and the internal group index of the legacy LBG.

Interface Cable interface (downstream or upstream) that belongs to a load balancing group.

Group Number of the load balancing group to which the cable interface has been assigned.

Cisco CMTS Cable Command Reference

1764
 Cable Commands: show a through show cable l
show cable load-balance

Field Description

Utilization This field is a long-term average of the upstream utilization and displays current load usage of the cable
interface expressed as a percentage of the total bandwidth. For upstreams, this field shows a single
percentage value, which is the average percentage of bandwidth being used on the upstream.
For downstreams, this field shows a set of three percentage values:
• The percentage shows the load usage for the entire interface.
• The first percentage, within the parentheses, shows the load for the downstream.
• The second percentage, within the parentheses, shows the average load for all upstreams on the
downstream.
For example, if this field shows 18%(18%/12%), it indicates that downstream and upstream channels on
the interface are running on an average load of 18 percent. The downstream is running on an average
load of 18 percent and all upstreams for this downstream are running on an average load of 12 percent.
Note
To view the short-term average of the utilization, use the show interface cable mac-scheduler command.

State Current state of the cable interface.

The following states indicate normal operational states, depending on the configuration:
• down—Interface is shut down. The CMTS cannot use the interface for load balancing in this state.
• initial—Interface is currently in the initialization phase. The CMTS uses the interface for load
balancing after the initialization completes.
• up—Interface is up and passing traffic. The CMTS actively uses the interface for load balancing.
• testing—Interface is currently under a load balancing test. The CMTS is unable to use the interface
for normal load balancing operations until the test completes.
The following states indicate abnormal states. The CMTS does not use interfaces in these states for load
balancing operations, but continues to monitor and update the status every time the CMTS polls the
interfaces for their current load usage:
• suspicious—Interface is in an unknown state. The interface might be up and passing traffic, but is
not consistent enough to support load balancing operations. The CMTS attempts to reinitialize the
interface after a timeout period. If the interface has failed initialization more than 10 times, the
CMTS moves the interface to the disabled state.
• disabled—Interface has been disabled because a load balancing test is in-progress or because the
interface reinitialization failed after 10 attempts.
• unstable—Interface has failed repeated initialization attempts. The CMTS will attempt to reinitialize
the interface after a timeout period. If a load balance test is not in-progress and if reinitialization
fails, the CMTS moves it to the unstable state.

Reserved Percentage of bandwidth that is currently reserved by unsolicited grant service (UGS) service flows.

Modems Number of cable modems currently online on this cable interface.

Weight Interface bandwidth, in megabits per second (mbps), for the downstream or upstream. The system uses
this value in calculating whether the loads on the interfaces are balanced. Changing a channel parameter,
such as modulation profile or channel width, affects the channel bandwidth and weight value.

Additional Fields When Displaying Load Balancing Groups

Cisco CMTS Cable Command Reference

1765
 Cable Commands: show a through show cable l
show cable load-balance

Field Description

Interval Indicates in seconds, the current load on each cable interface in the LBG as configured using the cable
load-balance group interval command.

Method Load balancing method used for the LBG as configured using the cable load-balance group (global
configuration) command.

Threshold Thresholds configured for this load balancing group:

• M = Minimum
Minimum difference in the number of cable modems or service flows that can exist on two interfaces in
the group before cable modems are moved between the interfaces. If the imbalance between interfaces
is below this value, cable modems are not moved. This field contains a value only when the group is
configured for the modems or service flows method of load balancing. (This value is configured using
the load minimum option of the cable load-balance group threshold command.)
• S = Static
Minimum difference in the percentage of total load that must exist between interfaces in a load balancing
group before the Cisco CMTS performs static load balancing. When the load between interfaces is greater
than this value, cable modems that are in the process of registering with the CMTS are moved between
interfaces until the load difference is again below this value. (This value is configured using the load
option of the cable load-balance group threshold command.)
• E = Enforce
Minimum difference in the percentage of total load that must exist between interfaces in a load balancing
group before the Cisco CMTS performs dynamic load balancing and begins moving cable modems that
are currently online. When the difference in load between two interfaces falls below this value, the CMTS
stops dynamic load balancing and performs static load balancing. (This value is configured using the
enforce option of the cable load-balance group threshold command.)
• U = Ugs
Percentage of the bandwidth that is allocated for Unsolicited Grant Services (UGS) traffic, such as
Voice-over-IP (VoIP), that is in use on an interface because the CMTS moves cable modems that are
online with active UGS service flows. (This value is configured using the ugs option of the cable
load-balance group threshold command.)
• P = PacketCable MultiMedia (PCMM)
• Percentage of the reserved bandwidth threshold. Above this level, cable modems with active PCMM
service flows participate in load balancing. The default threshold is 70%.

Additional Fields for the target Option

Interface Source downstream or upstream interface that is part of a cable load balancing group. If the Target field
contains a value, it indicates that the source interface is currently oversubscribed. To reduce the cable
load, the CMTS moves cable modems from the source interface to the target interface.

Cisco CMTS Cable Command Reference

1766
 Cable Commands: show a through show cable l
show cable load-balance

Field Description

Target Downstream or upstream interface to which cable modems on the source interface are being moved as
part of load balancing operations. This field indicates the following:
• If it is a downstream interface, the display shows the center frequency of the downstream within
parentheses.
• If only a frequency is shown, it indicates that the CMTS is moving cable modems to a different
center frequency on the same downstream interface.
• When the display includes the words “enforce”, it indicates that the CMTS is performing dynamic
load balancing on the interfaces.
• If this field is blank, it indicates that the source interface is not oversubscribed.

Additional Fields for the statistics Option

Target interface Downstream or upstream interface. If this is a downstream interface, the display shows the center frequency
of the downstream within parentheses.

Transfers The following information is tracked for the indicated target interface:
• complete—Number of cable modems successfully moved to the target interface.
• pending—Number of cable modems in the process of being moved to the target interface.
• retries—Number of times that the CMTS unsuccessfully tried to move the same cable modem to
the target interface. This occurs when one or more MAC layer messages to the cable modem are
dropped due to radio frequency (RF) noise or because the modem is not DOCSIS-compliant. If the
number of retries exceeds five for a particular cable modem, the CMTS counts this as a failure.
• failures—Number of times that the CMTS exceeded the maximum number of allowable retries (5)
when trying to move a particular cable modem to the target interface. A large number of failures
could indicate one or more possible problems:
• The specific cable modems are not DOCSIS-compliant.
• One or both interfaces are having problems passing traffic.
• One or both interfaces are having persistent RF noise problems.
• The source and target interfaces are not combined in the same node and do not share the same
physical connectivity (which is required when interfaces are part the same load balancing
group).

Additional Fields for the pending Option

Modem Hardware (MAC) address of the cable modem that is moved as part of load balancing operations.

Source interface Downstream or upstream cable interface on which the cable modem is currently online.

Target interface Downstream or upstream cable interface to which the CMTS is trying to move the cable modem to load
balance the interfaces in this load balancing group. If the CMTS is moving the cable modem to a different
frequency on the same downstream interface, this field shows only the new center frequency.

Retries Number of times that the CMTS has attempted to move this cable modem to the target interface. The
CMTS attempts to move the cable modem 5 times before counting this load balancing move as a failure.

Additional Fields for the

fiber-node-validation
Option

Cisco CMTS Cable Command Reference

1767
 Cable Commands: show a through show cable l
show cable load-balance

Field Description

DOCSIS LBG ID The DOCSIS LBG ID.

Channel The upstream or downstream channel that is associated with the DOCSIS LBG.

Fiber-node list The list of all fiber nodes that include the channel.

Additional Fields for the move-history option

Modem The mac address of the moved cable modem

Host Interface The mac-domain of the cable modem.

Group ID The load balance group ID of cable modem.

Primary RF/RCC Source Old downstream information of the cable modem, including the primary downstream channel, RCC ID
before moving.

Primary RF/RCC Target New downstream information of the cable modem, including the new primary downstream channel, RCC
ID after moving.

MD/TCS Source Old upstream information of the cable modem including the index of mac-domain, the bitmap of the
upstream channel before moving.

MD/TCS Target New upstream information of the cable modem including the index of mac-domain, the bitmap of the
upstream channel after moving.

Action The action of the cable modem movement, such as DBC, DCC, UCC, REINIT(DCC with init-tech 0).

Trans-Start Time The trigger of the cable modem movement, such as D2.0 LB, D3.0 static LB, D3.0 dynamic LB.

Elapse Time (ms) The start time of the cable modem movement.

Client The elapsed time - how long the cable modem movement spent.

Result The result of the action on modem movement - success, faiure, and the internal confirmation code.

The following is a sample output from the vdoc keyword of the show cable load-balance command:

Router# show cable load-balance vdoc

Target interface State Group Util Total IGMP CIR High Low
Index Targeted Rep Init Util CIR
Cable7/0/0 (531 MHz) down 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:0 (453 MHz) up 81 0 9(5) 7(5) 2(0) 0 0
Mo3/0/0:1 (459 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:10 (513 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:11 (519 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:2 (465 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:3 (471 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:4 (477 MHz) initi 81 0 5(0) 0(0) 5(0) 0 0
Mo3/0/0:5 (483 MHz) up 81 0 7(7) 7(7) 0(0) 0 0
Mo3/0/0:6 (489 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:7 (495 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:8 (501 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:9 (507 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0

Cisco CMTS Cable Command Reference

1768
Cable Commands: show a through show cable l
show cable load-balance

The following is a sample output of the show cable load-balance error summary command:
Router# show cable load-balance statistics error summary
Load for five secs: 8%/0%; one minute: 9%; five minutes: 10%
Time source is NTP, 17:37:26.107 CST Thu Aug 14 2014
Total error on linecard 5/1 is 0
Total error on linecard 7/0 is 0
Total error on linecard 8/1 is 0

The following is a sample output of the show cable load-balance error linecard command:
Router# show cable load-balance statistics error linecard 5/1
Load for five secs: 8%/0%; one minute: 9%; five minutes: 10%
Time source is NTP, 17:37:11.844 CST Thu Aug 14 2014
Error counters for Wideband on linecard 5/1:
Unknown reason :0
No CM can be found :0
CM rejected the DBC-REQ :0
CM is not reachable :0
Invalid input parameters :0
Too many request in queue :0
Incompliance to D3.0 spec :0
DCC failure :0
Other :0
Total :0
Error counters for Narrowband on linecard 5/1:
Unknown reason :0
CM seen on other target :0
Candidate CM timeout :0
LBG removed :0
Target down :0
Target not in LBG :0
Total :0

The following is a sample output of the show cable load-balance error detail command:
Router# show cable load-balance statistics error detail
Load for five secs: 9%/0%; one minute: 9%; five minutes: 10%
Time source is NTP, 17:35:47.530 CST Thu Aug 14 2014

Error counters for Wideband on linecard 5/1:

Unknown reason :0
No CM can be found :0
CM rejected the DBC-REQ :0
CM is not reachable :0
Invalid input parameters :0
Too many request in queue :0
Incompliance to D3.0 spec :0
DCC failure :0
Other :0

Total :0

Error counters for Narrowband on linecard 5/1:

Unknown reason :0
CM seen on other target :0
Candidate CM timeout :0
LBG removed :0

Cisco CMTS Cable Command Reference

1769
 Cable Commands: show a through show cable l
show cable load-balance

Target down :0
Target not in LBG :0

Total :0

Error counters for Wideband on linecard 7/0:

Unknown reason :0
No CM can be found :0
CM rejected the DBC-REQ :0
CM is not reachable :0
Invalid input parameters :0
Too many request in queue :0
Incompliance to D3.0 spec :0
DCC failure :0
Other :0

Total :0

The following is a sample output of the show cable load-balance move-history cable
slot/subslot/controller-interface-index command:

Router# show cable load-balance move-history cable 3/0/1

Modem Host Grp Id Primary RF/RCC MD/TCS
Action Trans-Start Elapse Client Result
Interface Src Target Src Target
Time Time(ms)
c8fb.26a6.c4b4 Ca3/0/1 2147557888 Do3/0/0:1/0 Do3/0/0:4/0 145/0x2 145/0x2
DCC Aug 11 10:44:53 4727 D2.0 LB Success(13)
c8fb.26a6.c412 Ca3/0/1 2147557888 Do3/0/0:0/0 Do3/0/0:4/0 145/0x2 145/0x2
DCC Aug 11 10:44:53 4720 D2.0 LB Success(13)
c8fb.26a6.c53c Ca3/0/1 2147557888 Do3/0/0:0/0 Do3/0/0:0/0 145/0x2 145/0x1
DCC Aug 11 10:44:53 128 D2.0 LB Success(13)
c8fb.26a6.c178 Ca3/0/1 2147557888 Do3/0/0:1/1 Do3/0/0:5/2 145/0xF 145/0xF
DBC Aug 11 10:24:08 19788 D3.0 STATIC LB Success(1)
c8fb.26a6.c67c Ca3/0/1 2147557888 Do3/0/0:1/1 Do3/0/0:5/2 145/0xF 145/0xF
DBC Aug 11 10:23:55 17435 D3.0 STATIC LB Success(1)

Related Commands Command Description

cable load-balance group policy ugs Configures how the Cisco CMTS should load balance cable modems
with active unsolicited grant service (UGS) service flows.

cable load-balance group threshold Configures the threshold values that a load balancing group should
use for load balancing operations.

show cable load-balance docsis-group Displays real time configurational, statistical, and operational
information of the load balancing operations on the router.

Cisco CMTS Cable Command Reference

1770
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

show cable load-balance docsis-group

To display real-time configurational, statistical, and operational information of the load balancing (LB)
operations on the router, use the show cable load-balance docsis-group command in privileged EXEC mode.

Cisco uBR10012 Router

show cable load-balance docsis-group {docsis-group-id | FN fn-id MD cable slot /subslot
/controller-interface-index} [all | load | pending | restrict | statistics | target | modem-list | primary-load
| rcs-cm-list]

Cisco uBR7225VXR and Cisco uBR7246VXR Routers

show cable load-balance docsis-group {docsis-group-id | FN fn-id MD cable slot /port} [all |
init-tech-ovr | load | modem-list | pending | service-type-id | statistics | tag | target | vdoc]

Cisco cBR Series Converged Broadband Router

show cable load-balance docsis-group { docsis-group-id | FN fn-id MD cable slot /
subslot / controller-interface-index } [ all | pending | restrict | rfch-util | service-type-id | tag |
move-history ]
show cable load-balance docsis-group { docsis-group-id } [ load | modem-list | statistics |
target ] [ wideband | dbg ]

Syntax Description docsis-group-id DOCSIS load balancing group ID. The group ID is in the range of 1 to
2147483647.

FN fn-id Specifies the fiber node (FN) where certain DOCSIS 3.0 GLBG parameters,
such as disable, docsis-policy, init-tech-list, interval, method, policy,
and threshold, can be configured.

MD cable Specifies the MAC domain interface of the fiber node.

slot/subslot/cable-interface-index
• slot—Slot where the line card resides. The permitted range is from 5
to 8.
• subslot—Subslot where the line card resides. The available slots are
0 or 1.
• cable-interface-index—Downstream controller number on the line
card. The permitted range is from 0 to 4. For Cisco cBR Series
Converged Broadband Router, the valid range is 0 to 15.

MD cable slot/port Specifies the MAC domain interface of the fiber node on the Cisco
uBR7246VXR or Cisco uBR7225VXR routers.
• slot—Slot where the line card resides.
• Cisco uBR7225VXR router—The valid range is from 1 to 2.
• Cisco uBR7246VXR router—The valid range is from 3 to 6.
• port—The downstream controller port on the line card. The permitted
values are 0 or 1.

all (Optional) Displays all load balancing group information.

Cisco CMTS Cable Command Reference

1771
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

init-tech-ovr (Optional) Displays the initialization technique override rules associated

with this DOCSIS load balancing group (LBG).
Not supported on Cisco cBR Series Converged Broadband Router

load (Optional) Displays current interface load and LBG assignments.

modem-list (Optional) Displays cable modems assigned to the specified DOCSIS LBG.

move-history (Optional) Displays detailed information for every cable modem movement
triggered through load balance.

pending (Optional) Displays a list of cable modems that are pending movement
from one downstream or upstream to another.

primary-load (Optional) Displays the primary channel load information for specified
DOCSIS LBG.
Not supported on Cisco cBR Series Converged Broadband Router

restrict (Optional) Displays the restricted cable modem list associated with this
DOCSIS LBG.

rfch-util (Optional) Displays the RF channel utilization.

service-type-id (Optional) Displays information about the service type ID list associated
with this DOCSIS LBG.

statistics (Optional) Displays cumulative statistics of load balancing operations for

one group.

tag (Optional) Displays the tag list associated with this DOCSIS LBG.

target (Optional) Displays current and target interfaces (upstream and

downstream) used for load balancing.

vdoc (Optional) Displays information about the state of the video-over-DOCSIS

(VDOC) LB for the particular LBG.
Not supported on Cisco cBR Series Converged Broadband Router

rcs-cm-list (Optional) Displays the cable modems used for load balancing within the
RCS and the utilization of each wideband interface.
Not supported on Cisco cBR Series Converged Broadband Router

wideband (Optional) Displays the current wideband load, cable modem's associated
to wideband interface in the DOCSIS 3.0 load balancing group, wideband
target interface, and wideband interface statistics.

dbg (Optional) Displays the potential target dynamic bonding group for each
of the source bonding groups.

Command Default Displays information of all load balancing groups for each cable interface with its current load and load
balancing status.

Cisco CMTS Cable Command Reference

1772
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.2(33)SCC This command was introduced.

12.2(33)SCF The output for this command is enhanced to include more load balancing statistics for cable
modems (CMs) provisioned in the multiple receive channel (MRC) and multiple transmit
channel (MTC) mode.
The output for the load keyword includes information about narrowband and wideband
CMs.

12.2(33)SCH This command was modified. The primary-load keyword was added. The output for this
command is enhanced to include a new field MUPFXLR that provides more status
information for the modem-list keyword.

12.2(33)SCI This command was modified. The rcs-cm-list keyword was added. The output for the
statistics keyword was enhanced to support DOCSIS3.0 load balance.

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Router.
3.15.0S The init-tech-ovr, primary-load , rcs-cm-list and vdoc keywords are not supported

IOS-XE This command was implemented on the Cisco cBR Series Converged Broadband Router.
3.17.0S The rfch-util and wideband keyword was added.

IOS-XE 16.7.1 The command was modified. The dbg keyword was added.

IOS-XE The command was modified. The option move-history was added.
17.6.1w

Usage Guidelines Use the show cable load-balance docsis-group command to display the current, real-time statistics for load
balancing operations.
In Cisco IOS Release 12.2(33)SCH, the primary-load keyword was added to to display the primary channel
load information. The primary-load keyword is optional and is used with docsis-group-id.
The show cable load-balance docsis-group primary-load command is associated with Target RCS Selection
for Static Load Balancing feature.
Effective with Cisco IOS Release 12.2(33) SCI, the output of the statistics keyword was modified to display
the following additional parameters:
• Failure statistics for Dynamic Bonding Change (DBC).
• Load balancing total attempts

Examples Target RCS Selection for Static Load Balancing

The following is a sample output of the show cable load-balance docsis-group command:

Router# show cable load-balance docsis-group 1

DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Enabled: No
DOCSIS Group Status Interval DCC mask Policy Method Threshold

Cisco CMTS Cable Command Reference

1773
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Group Index /UCC DS/US M/E/U/P/S

1 82 RE 10 0x40(1)/Y 0 m/m 5/10/70/70/50

The following is a sample output of the show cable load-balance docsis-group load
command:

Router# show cable load-balance docsis-group 1 load

DOCSIS load-balancing load
Interface State Group Utilization Rsvd NBCM WB/UB Weight
Index Total Total
Cable7/0/0 (333 MHz) up 81 1%(0%/1%) 0% 3 8 37
Cable7/0/0/U0 up 81 1% 0% 21 2 7.6
Cable7/0/0/U1 up 81 1% 0% 19 3 7.6
Cable7/0/0/U2 up 81 1% 0% 20 1 7.6
Cable7/0/0/U3 up 81 1% 0% 21 1 7.6
Mo1/0/0:0 (501 MHz) up 81 1%(0%/1%) 0% 2 48 36
Mo1/0/0:0/U0 up 81 1% 0% 21 2 7.6
Mo1/0/0:0/U1 up 81 1% 0% 19 3 7.6
Mo1/0/0:0/U2 up 81 1% 0% 20 1 7.6
Mo1/0/0:0/U3 up 81 1% 0% 21 1 7.6
Mo1/0/0:1 (507 MHz) up 81 1%(0%/1%) 0% 2 47 36
Mo1/0/0:1/U0 up 81 1% 0% 21 2 7.6
Mo1/0/0:1/U1 up 81 1% 0% 19 3 7.6
Mo1/0/0:1/U2 up 81 1% 0% 20 1 7.6
Mo1/0/0:1/U3 up 81 1% 0% 21 1 7.6
Mo1/0/0:2 (513 MHz) up 81 1%(0%/1%) 0% 3 40 36
Mo1/0/0:2/U0 up 81 1% 0% 21 2 7.6
Mo1/0/0:2/U1 up 81 1% 0% 19 3 7.6
Mo1/0/0:2/U2 up 81 1% 0% 20 1 7.6
Mo1/0/0:2/U3 up 81 1% 0% 21 1 7.6
Mo1/0/0:3 (519 MHz) up 81 1%(0%/1%) 0% 2 47 36
Mo1/0/0:3/U0 up 81 1% 0% 21 2 7.6
Mo1/0/0:3/U1 up 81 1% 0% 19 3 7.6
Mo1/0/0:3/U2 up 81 1% 0% 20 1 7.6
Mo1/0/0:3/U3 up 81 1% 0% 21 1 7.6

The following is a sample output of the show cable load-balance docsis-group load
| in ln command displaying the load of all primary channels:

Router# show cable load-balance docsis-group fn 1 md c3/0/1 load | in In

Interface State Group Utilization Rsvd NBCM WB/UB Weight
In3/0/1:0(573 MHz) initial 2147557888 0%(0%/0%) 0% 0 17 37
In3/0/1:4(597 MHz) initial 2147557888 0%(0%/0%) 0% 0 17 37
In3/0/1:8(621 MHz) initial 2147557888 0%(0%/0%) 0% 0 13 37
In3/0/1:12(645 MHz) initial 2147557888 0%(0%/0%) 0% 0 13 37
In3/0/1:16(669 MHz) initial 2147557888 0%(0%/0%) 0% 0 13 37
In3/0/1:20(693 MHz) initial 2147557888 0%(0%/0%) 0% 0 13 37
In3/0/1:24(717 MHz) initial 2147557888 0%(0%/0%) 0% 0 13 37
In3/0/1:28(741 MHz) initial 2147557888 0%(0%/0%) 0% 0 13 37

The following is a sample output of the show cable load-balance docsis-group load command in
Cisco IOS Release 12.2(33)SCF and later releases displaying sample wideband (WB), narrowband
(NB), or mixed cable modem details. The NBCM and WB/upstream bonding (UB) columns display
information about DOCSIS 3.0 MRC-only and MTC CMs for DOCSIS static modem-count based
load balancing:

Router# show cable load-balance docsis-group 60 load

DOCSIS load-balancing load
Interface State Group Utilization Rsvd NBCM WB/UB Weight
Index Total Total
Mo1/0/0:0 (423 MHz) initial 81 0%(0%/0%) 0% 0 7 36

Cisco CMTS Cable Command Reference

1774
Cable Commands: show a through show cable l
show cable load-balance docsis-group

Mo1/0/0:0/U0 up 81 0% 0% 2 0 5.1
Mo1/0/0:0/U1 up 81 0% 0% 3 0 5.1
Mo1/0/0:0/U2 up 81 0% 0% 2 0 5.1
Mo1/0/0:0/U3 up 81 0% 0% 3 0 5.1
Mo1/0/0:4 (447 MHz) initial 81 0%(0%/0%) 0% 0 3 36
Mo1/0/0:4/U0 up 81 0% 0% 2 0 5.1
Mo1/0/0:4/U1 up 81 0% 0% 3 0 5.1
Mo1/0/0:4/U2 up 81 0% 0% 2 0 5.1
Mo1/0/0:4/U3 up 81 0% 0% 3 0 5.1

Table 88: DOCSIS 3.0 Load Balancing Counter Definition

Modem Operating Mode NBCM Total WB/UB Total

Downstream (DS) Upstream (US) DS US

Non-MRC mode (online, NB Count primary Count single US Not counted Not counted
CM)

MRC mode only (w-online, Not counted Count single US Count primary and Count single US
WB CM) secondary

MTC mode (UB online, UB Not counted Not counted Count primary and Count all TCS
CM) secondary channels

The following is a sample output of the show cable load-balance docsis-group pending command
in Cisco IOS Release 12.2(33)SCE and earlier releases.

Router# show cable load-balance docsis-group 70 pending

Modem Grp Idx Primary RF/RCC MD/TCS Action Active Retries
Src Target Src Target Time
001c.ea37.9bda 81 Mo1/0/0:2/1 Mo1/0/0:3/0 60/4 60/4 REINIT 00:44 0 DOCSIS
3.0 LB
001c.ea37.9ab0 81 Mo1/0/0:1/2 Mo1/0/0:2/0 60/4 60/2 REINIT 00:41 0 DOCSIS
3.0 LB
001c.ea37.9aa6 81 Mo1/0/0:0/1 Mo1/0/0:1/0 60/1 60/4 REINIT 00:50 0 DOCSIS
3.0 LB
001c.ea37.9b1e 81 Mo1/0/0:1/1 Mo1/0/0:0/0 60/2 60/2 REINIT 00:44 0 DOCSIS
3.0 LB
001c.ea37.9a8c 81 Mo1/0/0:3/2 Mo1/0/0:2/0 60/4 60/2 REINIT 00:41 0 DOCSIS
3.0 LB
001c.ea37.9aee 81 Mo1/0/0:3/2 Mo1/0/0:2/0 60/8 60/4 REINIT 00:52 0 DOCSIS
3.0 LB
001c.ea37.9a8a 81 Mo1/0/0:0/1 Mo1/0/0:3/0 60/8 60/1 REINIT 00:55 0 DOCSIS
3.0 LB

The following is a sample output of the show cable load-balance docsis-group pending command
for DOCSIS 3.0 cable modems with MTC mode in Cisco IOS Release 12.2(33)SCF and later releases:

Router# show cable load-balance docsis-group 81 pending

Modem GrpIdx Primary RF/RCC MD/TCS Action Active Retries
Src Target Src Target Time
0000.cad6.eece 81 In6/0/2:3/0 In6/0/0:0/0 DCC 00:01 0

The following is a sample output of the show cable load-balance docsis-group statistics command.

Cisco CMTS Cable Command Reference

1775
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Router# show cable load-balance docsis-group 1 statistics

Target interface State Transfers
Complete Pending Retries Failures
Cable1/0 (453 MHz) up 0 0 0 0
Cable1/0/U2 down 0 0 0 0
Cable1/1 (459 MHz) initial 0 0 0 0
Cable1/1/U0 initial 0 0 0 0
Cable1/1/U1 initial 0 0 0 0
Cable1/1/U2 initial 0 0 0 0
Cable1/1/U3 initial 0 0 0 0

The following is a sample output of the show cable load-balance docsis-group target command.

Router# show cable load-balance docsis-group 1 target

Interface State Group Target
Index
Cable1/0 (453 MHz) up 82 Cable1/1 (459 MHz) [enforce]
Cable1/0/U2 down 82
Cable1/1 (459 MHz) initial 82
Cable1/1/U0 initial 82
Cable1/1/U1 initial 82
Cable1/1/U2 initial 82
Cable1/1/U3 initial 82

The following is a sample output of the show cable load-balance docsis-group modem-list command
on the integrated cable configuration:

Router# show cable load-balance docsis-group 1 modem-list

Primary DS Grp Idx MAC Address RCC-ID Bad RfId Priority
Cable7/0/0/U0 81 (1)
001c.ea37.9b3e 2 0
Cable7/0/0/U1 81 (1)
001c.ea37.9b28 2 0
Cable7/0/0/U2 81 (1)
001c.ea37.9bf4 2 0
Cable7/0/0/U3 81 (1)
001c.ea37.9b5e 2 0
In8/1/0:0/U0 81 (2)
0014.f82f.74f6 !

Note The priority for an excluded modem is displayed as "!".

Effective from Cisco IOS Release 12.2(33)SCH, the output of the show cable load-balance
docsis-group command is modified to include an additional field MUPFXLR to display more status
information.
The following is a sample output of the show cable load-balance docsis-group rfch-util command
to verify QAM channel utilization:
Router# show cable load-balance docsis-group 1 rfch-util
Interface Pstate Pending-In Pending-Out Throughput(Kbps) Util
In9/0/0:0 NA No No 0 0
In9/0/0:1 up No No 10886 29
In9/0/0:2 initial No No 10470 27
In9/0/0:3 initial No No 10415 27

Cisco CMTS Cable Command Reference

1776
Cable Commands: show a through show cable l
show cable load-balance docsis-group

In9/0/0:4 initial No No 10791 28

In9/0/0:5 initial No No 12352 32
In9/0/0:6 initial No No 11883 31
In9/0/0:7 up No No 14402 38
In9/0/0:8 up No No 11336 30
In9/0/0:9 up No No 11233 29
In9/0/0:10 up No No 10601 28
In9/0/0:11 up No No 10652 28
In9/0/0:12 up No No 8363 22
In9/0/0:13 up No No 8165 21
In9/0/0:14 up No No 10128 27
In9/0/0:15 up No No 10637 28

Table 89: show cable load-balance docsis-group - Field Description for QAM channel utilization

Field Description

Interface Downstream channel interface name.

Pstate For primary capable channel downstream, the

following Pstate are present:
• initial
• up
• down
• disable
• moving

Pending-In The modem is moving in.

Pending-Out The modem is moving out.

Throughput (Kbps) The channel's current throughput.

Util The channel's current utilization in percentage.

The following example shows the modified output of the show cable load-balance docsis-group
command:

Router#show cable load-balance docsis-group

fn 1 md c6/0/0 modem-list
Load for five secs: 1%/0%; one minute: 2%; five minutes: 1%
Time source is NTP, 13:39:31.300 PDT Thu Mar 28 2013
Codes: M - Multicast, U - UGS, P - PCMM, F - Max-Failures, X - eXcluded
L - L2vpn, R - RSVP
Primary DS Grp Idx MAC Address RCC-ID Bad Rfid Priority MUPFXLR
In6/0/0:0/UB 40448 (6)
e448.c70c.98af 1 2 -------
e448.c70c.9b76 1 2 -------
e448.c70c.9c15 1 2 -------
e448.c70c.9a92 1 2 -------
e448.c70c.99e4 1 2 -------
e448.c70c.9a35 1 2 -------
In6/0/0:0/U0 40448 (0)
In6/0/0:0/U1 40448 (1)
e448.c70c.9915 2 -------
In6/0/0:0/U2 40448 (0)
In6/0/0:0/U3 40448 (0)
In6/0/0:1/UB 40448 (5)

Cisco CMTS Cable Command Reference

1777
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

e448.c70c.9abc 1 2 -------
e448.c70c.993f 1 2 -------
e448.c70c.9927 1 2 -------
e448.c70c.9b82 1 2 -------
4458.2945.2cb8 1 2 -------
In6/0/0:1/U0 40448 (0)
In6/0/0:1/U1 40448 (0)
In6/0/0:1/U2 40448 (0)
In6/0/0:1/U3 40448 (0)
In6/0/0:2/UB 40448 (5)
e448.c70c.9759 1 2 -------
e448.c70c.9a0e 1 2 -------
e448.c70c.992d 1 2 -------
e448.c70c.9a38 1 2 -------
0025.2ed9.9984 1 2 -----L-
In6/0/0:2/U0 40448 (0)
In6/0/0:2/U1 40448 (0)
In6/0/0:2/U2 40448 (0)
In6/0/0:2/U3 40448 (0)
In6/0/0:3/UB 40448 (5)
e448.c70c.9c00 1 2 -------
e448.c70c.99a5 1 2 -------
e448.c70c.9a5f 1 2 -------
e448.c70c.9a3b 1 2 -------
e448.c70c.96b1 1 2 -------
In6/0/0:3/U0 40448 (0)
In6/0/0:3/U1 40448 (0)
In6/0/0:3/U2 40448 (0)
In6/0/0:3/U3 40448 (0)

Table 90: show cable load-balance docsis-group - Field Description for MUPFXLR status field

Field Description

MUPFXLR field descriptions

Multicast (M) Multicast session operating on the modem. It indicates a host behind a cable modem that
has joined an IGMP group. Verify this status using the show cable modem verbose | in
Features Bitmask command.

UGS (U) Indicates that a cable modem has UGS service flows. This configuration can be verified
by show cable modem qos | in UGS

Packetcable (P) Indicates that a cable modem has one or more Packetcable gate. This status can be verified
by show packetcable gate summary and show cable modem cpe commands.

max-Failures (F) Indicates that a cable modem has reached maximum failure threshold. This status can be
verified by the show cable modem internal load command.

eXcluded (X) Indicates that a cable modem is listed in the list of excluded modems. This status can be
verified by the show running-config | begin load-balance exclude command.

L2VPN (L) Indicates that a cable modem is provisioned in L2VPN service. This status can be verified
by the show cable l2-vpn xconnect command.

RSVP (R) Indicates that a cable modem has RSVP flows. This status can be verified by the show
cable modem verbose | in Features Mask command.

Cisco CMTS Cable Command Reference

1778
Cable Commands: show a through show cable l
show cable load-balance docsis-group

The following is a sample output of the show cable load-balance docsis-group modem-list command
on the modular cable configuration:

Router# show cable load-balance docsis-group 23 modem-list

Primary DS Grp Idx MAC Address RCC-ID Bad RfId Priority
Mo6/1/0:0/U0 81 (0)
Mo6/1/0:0/U8 81 (0)
Mo6/1/0:0/U1 81 (0)
Mo6/1/0:0/U2 81 (0)
Mo6/1/0:0/U3 81 (0)
Mo6/1/0:0/U4 81 (0)
Mo6/1/0:0/U5 81 (0)
Mo6/1/0:0/U6 81 (0)
Mo6/1/0:0/U7 81 (0)
Mo6/1/0:1/U0 81 (0)
Mo6/1/0:1/U8 81 (0)
Mo6/1/0:1/U1 81 (0)
Mo6/1/0:1/U2 81 (1)
001a.c30c.7e9a 5 0
Mo6/1/0:1/U3 81 (0)
Mo6/1/0:1/U4 81 (0)
Mo6/1/0:1/U5 81 (0)
Mo6/1/0:1/U6 81 (0)
Mo6/1/0:1/U7 81 (0)

The following is a sample output of the show cable load-balance docsis-group modem-list command
on a fiber node topology configuration:

Router# show cable load-balance docsis-group fn 2 md cable 6/0/0 modem-list

CM List - LBG : 40449

Primary DS MAC Address RCC-ID
In6/0/0:2/UB (0)
In6/0/0:3/UB (1)
0025.2e2d.7322 2
In6/0/1:0/UB (2)
0025.2e2d.7326 1
0025.2e2d.7338 1

The following is a sample output for the show cable load-balance docsis-group modem-list command
for the DOCSIS 3.0 GLBG:

Router# show cable load-balance docsis-group fn 2 md cable 7/0/0 modem-list

Primary DS Grp Idx MAC Address RCC-ID Bad RfId Priority
Cable7/0/0/U0 48129 (0)
Cable7/0/0/U1 48129 (0)
Cable7/0/0/U2 48129 (0)
Cable7/0/0/U3 48129 (0)
Mo1/0/0:0/UB 48129 (6)
0025.2eaf.6bbc 1 0
001e.6bfb.000c 1 0
001a.c3ff.d354 1 0
0023.be50.e5aa 1 0
001e.6bfb.1a3a 1 0
Mo1/0/0:0/U0 48129 (0)
Mo1/0/0:0/U1 48129 (0)
Mo1/0/0:0/U2 48129 (0)
Mo1/0/0:0/U3 48129 (0)
Mo1/0/0:1/U0 48129 (0)

Cisco CMTS Cable Command Reference

1779
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Mo1/0/0:1/U1 48129 (0)

Mo1/0/0:1/U2 48129 (0)
Mo1/0/0:1/U3 48129 (0)
Mo1/0/0:2/UB 48129 (2)
001a.c3ff.d87a 1 0
001e.6bfb.71b0 2 0
Mo1/0/0:2/U0 48129 (0)
Mo1/0/0:2/U1 48129 (0)
Mo1/0/0:2/U2 48129 (0)
Mo1/0/0:2/U3 48129 (0)
Mo1/0/0:3/UB 48129 (1)
001e.6bff.8af2 1 0
Mo1/0/0:3/U0 48129 (0)
Mo1/0/0:3/U1 48129 (0)
Mo1/0/0:3/U2 48129 (0)
Mo1/0/0:3/U3 48129 (0)

The following is a sample output for the show cable load-balance docsis-group pending command:

Router# show cable load-balance docsis-group fn 2 md cable 7/0/0 pending

Modem Grp Idx Primary RF/RCC MD/TCS Action Active Retries
Src Target Src Target Time
001e.6bfb.000c 48129 Mo1/0/0:0/1 Mo1/0/0:3/2 60/12 60/12 REINIT 00:20 0
DOCSIS 3.0 LB
001e.6bfb.71b0 48129 Mo1/0/0:2/2 Mo1/0/0:2/1 60/12 60/5 REINIT 00:22 0
DOCSIS 3.0 LB
001e.6bfc.d030 48129 Mo1/0/0:0/1 Mo1/0/0:3/2 60/3 60/3 REINIT 00:03 0
DOCSIS 3.0 LB

The following is a sample output of the show cable load-balance docsis-group all command. This
command displays information of all options in this command.

Router# show cable load-balance docsis-group 1 all

DOCSIS LB Enabled: Yes
DOCSIS Group Status Interval DCC mask Policy Method Threshold
Group Index /UCC DS/US M/E/U/P/S
1 82 RE 10 0x40(1)/Y 0 m/m 5/10/70/70/50
Current load:
Interface State Group Utilization Reserved Modems Weight
Index
Cable1/0 (453 MHz) up 82 0%(0%/0%) 0% 13 26
Cable1/0/U2 down 82 0% 0% 0 0.0
Cable1/1 (459 MHz) initial 82 0%(0%/0%) 0% 0 26
Cable1/1/U0 initial 82 0% 0% 0 2.5
Cable1/1/U1 initial 82 0% 0% 0 2.5
Cable1/1/U2 initial 82 0% 0% 0 2.5
Cable1/1/U3 initial 82 0% 0% 0 2.5
Target assignments:
Interface State Group Target
Index
Cable1/0 (453 MHz) up 82 Cable1/1 (459 MHz) [enforce]
Cable1/0/U2 down 82
Cable1/1 (459 MHz) initial 82
Cable1/1/U0 initial 82
Cable1/1/U1 initial 82
Cable1/1/U2 initial 82
Cable1/1/U3 initial 82
Statistics:
Target interface State Transfers
Complete Pending Retries Failures
Cable1/0 (453 MHz) up 0 0 0 0

Cisco CMTS Cable Command Reference

1780
Cable Commands: show a through show cable l
show cable load-balance docsis-group

Cable1/0/U2 down 0 0 0 0
Cable1/1 (459 MHz) initial 0 0 0 0
Cable1/1/U0 initial 0 0 0 0
Cable1/1/U1 initial 0 0 0 0
Cable1/1/U2 initial 0 0 0 0
Cable1/1/U3 initial 0 0 0 0
Pending:
Modem Grp Idx Source interface Target interface Retries

The following is a sample output of the show cable load-balance docsis-group all command in
Cisco IOS Release 12.2(33)SCF and later releases:

Router# show cable load balance docsis-group 70 all

DOCSIS LB Enabled: Yes
DOCSIS Group Status Interval DCC mask Policy Method Threshold
Group Index /UCC DS/US M/E/U/P/S
1 81 RE 30 0x78(1)/N 0 m/m 1/1/70/70/50
Current load:
DOCSIS load-balancing load
Interface State Group Utilization Rsvd NBCM WB/UB Weight
Index Total Total
Cable7/0/0 (333 MHz) up 81 0%(0%/0%) 0% 3 8 37
Cable7/0/0/U0 up 81 0% 0% 22 10 7.6
Cable7/0/0/U1 up 81 0% 0% 19 13 7.6
Cable7/0/0/U2 up 81 0% 0% 22 8 7.6
Cable7/0/0/U3 up 81 0% 0% 22 7 7.6
Mo1/0/0:0 (501 MHz) up 81 0%(0%/0%) 0% 3 61 36
Mo1/0/0:0/U0 up 81 0% 0% 22 10 7.6
Mo1/0/0:0/U1 up 81 0% 0% 19 13 7.6
Mo1/0/0:0/U2 up 81 0% 0% 22 8 7.6
Mo1/0/0:0/U3 up 81 0% 0% 22 7 7.6
Mo1/0/0:1 (507 MHz) up 81 0%(0%/0%) 0% 1 59 36
Mo1/0/0:1/U0 up 81 0% 0% 22 10 7.6
Mo1/0/0:1/U1 up 81 0% 0% 19 13 7.6
Mo1/0/0:1/U2 up 81 0% 0% 22 8 7.6
Mo1/0/0:1/U3 up 81 0% 0% 22 7 7.6
Mo1/0/0:2 (513 MHz) up 81 0%(0%/0%) 0% 2 57 36
Mo1/0/0:2/U0 up 81 0% 0% 22 10 7.6
Mo1/0/0:2/U1 up 81 0% 0% 19 13 7.6
Mo1/0/0:2/U2 up 81 0% 0% 22 8 7.6
Mo1/0/0:2/U3 up 81 0% 0% 22 7 7.6
Mo1/0/0:3 (519 MHz) up 81 0%(0%/0%) 0% 1 60 36
Mo1/0/0:3/U0 up 81 0% 0% 22 10 7.6
Mo1/0/0:3/U1 up 81 0% 0% 19 13 7.6
Mo1/0/0:3/U2 up 81 0% 0% 22 8 7.6
Mo1/0/0:3/U3 up 81 0% 0% 22 7 7.6
Target assignments:
Interface State Group Target
Index
Cable7/0/0 (333 MHz) up 81 Mo1/0/0:1 (507 MHz) [enforce]
Cable7/0/0/U0 up 81 Cable7/0/0/U1 [enforce]
Cable7/0/0/U1 up 81
Cable7/0/0/U2 up 81 Cable7/0/0/U1 [enforce]
Cable7/0/0/U3 up 81 Cable7/0/0/U1 [enforce]
Mo1/0/0:0 (501 MHz) up 81 Mo1/0/0:1 (507 MHz) [enforce]
Mo1/0/0:0/U0 up 81 Mo1/0/0:0/U1 [enforce]
Mo1/0/0:0/U1 up 81
Mo1/0/0:0/U2 up 81 Mo1/0/0:0/U1 [enforce]
Mo1/0/0:0/U3 up 81 Mo1/0/0:0/U1 [enforce]
Mo1/0/0:1 (507 MHz) up 81
Mo1/0/0:1/U0 up 81 Mo1/0/0:1/U1 [enforce]
Mo1/0/0:1/U1 up 81

Cisco CMTS Cable Command Reference

1781
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Mo1/0/0:1/U2 up 81 Mo1/0/0:1/U1 [enforce]

Mo1/0/0:1/U3 up 81 Mo1/0/0:1/U1 [enforce]
Mo1/0/0:2 (513 MHz) up 81
Mo1/0/0:2/U0 up 81 Mo1/0/0:2/U1 [enforce]
Mo1/0/0:2/U1 up 81
Mo1/0/0:2/U2 up 81 Mo1/0/0:2/U1 [enforce]
Mo1/0/0:2/U3 up 81 Mo1/0/0:2/U1 [enforce]
Mo1/0/0:3 (519 MHz) up 81
Mo1/0/0:3/U0 up 81 Mo1/0/0:3/U1 [enforce]
Mo1/0/0:3/U1 up 81
Mo1/0/0:3/U2 up 81 Mo1/0/0:3/U1 [enforce]
Mo1/0/0:3/U3 up 81 Mo1/0/0:3/U1 [enforce]
Statistics:
Target interface State Transfers
Complete Pending Retries Failures
Cable7/0/0 (333 MHz) up 6 0 0 0
Cable7/0/0/U0 up 29 0 0 0
Cable7/0/0/U1 up 76 0 0 0
Cable7/0/0/U2 up 43 0 0 0
Cable7/0/0/U3 up 31 0 0 0
Mo1/0/0:0 (501 MHz) up 18 0 0 0
Mo1/0/0:0/U0 up 30 0 0 0
Mo1/0/0:0/U1 up 42 0 0 0
Mo1/0/0:0/U2 up 21 0 0 0
Mo1/0/0:0/U3 up 21 0 0 0
Mo1/0/0:1 (507 MHz) up 17 0 0 0
Mo1/0/0:1/U0 up 9 0 0 0
Mo1/0/0:1/U1 up 18 0 0 0
Mo1/0/0:1/U2 up 15 0 0 0
Mo1/0/0:1/U3 up 20 0 0 0
Mo1/0/0:2 (513 MHz) up 19 0 0 0
Mo1/0/0:2/U0 up 4 0 0 0
Mo1/0/0:2/U1 up 3 0 0 0
Mo1/0/0:2/U2 up 6 0 0 0
Mo1/0/0:2/U3 up 6 0 0 0
Mo1/0/0:3 (519 MHz) up 9 0 0 0
Mo1/0/0:3/U0 up 1 0 0 0
Mo1/0/0:3/U1 up 2 0 0 0
Mo1/0/0:3/U2 up 4 0 0 0
Mo1/0/0:3/U3 up 4 0 0 0
Pending:
Modem Grp Idx Primary RF/RCC MD/TCS Action Active Retries
Src Target Src Target Time

The following is a sample output of the show cable load-balance all command for load balancing
groups that belong to different cable line cards:

Router# show cable load-balance all

Group Interval Method DCC Init Threshold
Technique Minimum Static Enforce Ugs PCMM
1 30 modems 0 5 10% --- --- ---
41 30 utilization 4 --- 10% 20% --- ---
DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Enabled: No
DOCSIS Group Status Interval DCC mask Policy Method Threshold
Group Index /UCC DS/US M/E/U/P/S
1 81 RE 30 0x78(1)/N 0 m/m 1/1/70/70/50
3 82 RE 30 0x78(1)/N 0 m/m 1/1/70/70/50
5 83 RE 30 0x78(1)/N 0 m/m 1/1/70/70/50
23 84 GE 30 0xF8(0)/N 0 m/m 5/10/70/70/50
DOCSIS 2.0 LB Enabled: Yes DOCSIS 3.0 LB Enabled: No
MD FN Group S Intv DCC mask Policy Mtd MD-CM-SG Threshold
Index /UCC D/U M/E/U/P/S
Ca6/1/0 3 44290 E 30 0xF8(0)/N 0 m/m 0x2D0101 5/10/70/70/50

Cisco CMTS Cable Command Reference

1782
Cable Commands: show a through show cable l
show cable load-balance docsis-group

Ca7/0/0 2 48129 E 20 0xF8(0)/N 0 m/m 0x3C0101 5/10/70/70/50

Ca8/0/0 1 55808 E 30 0xF8(0)/N 0 m/m 0x5A0101 5/10/70/70/50
Current load:
DOCSIS load-balancing load
Interface State Group Utilization Rsvd NBCM WB/UB Weight
Index Total Total
Mo6/1/0:0 (405 MHz) initial 82 0%(0%/0%) 0% 0 0 36
Mo6/1/0:0 (405 MHz) initial 44290 0%(0%/0%) 0% 0 0 36
Mo6/1/0:0/U0 initial 82 0% 0% 0 0 7.6
Mo6/1/0:0/U0 initial 44290 0% 0% 0 0 7.6
Mo6/1/0:0/U1 initial 82 0% 0% 0 0 7.6
Mo6/1/0:0/U1 initial 44290 0% 0% 0 0 7.6
Mo6/1/0:0/U2 initial 82 0% 0% 0 0 7.6
Mo6/1/0:0/U2 initial 44290 0% 0% 0 0 7.6
Mo6/1/0:0/U3 initial 82 0% 0% 0 0 7.6
Mo6/1/0:0/U3 initial 44290 0% 0% 0 0 7.6
Mo6/1/0:1 (411 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/0:1 (411 MHz) down 44290 0%(0%/0%) 0% 0 0
Mo6/1/0:2 (417 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/0:2 (417 MHz) down 44290 0%(0%/0%) 0% 0 0
Mo6/1/0:3 (423 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/0:3 (423 MHz) down 44290 0%(0%/0%) 0% 0 0
Mo6/1/0:4 (429 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/0:4 (429 MHz) down 44290 0%(0%/0%) 0% 0 0
Mo6/1/0:5 (435 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/0:5 (435 MHz) down 44290 0%(0%/0%) 0% 0 0
Mo6/1/0:6 (441 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/0:6 (441 MHz) down 44290 0%(0%/0%) 0% 0 0
Mo6/1/0:7 (447 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/0:7 (447 MHz) down 44290 0%(0%/0%) 0% 0 0
Mo6/1/1:0 (453 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/1:0 (453 MHz) down 83 0%(0%/0%) 0% 0 0
Mo6/1/1:1 (459 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/1:1 (459 MHz) down 83 0%(0%/0%) 0% 0 0
Mo6/1/1:2 (465 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/1:2 (465 MHz) down 83 0%(0%/0%) 0% 0 0
Mo6/1/1:3 (471 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/1:3 (471 MHz) down 83 0%(0%/0%) 0% 0 0
Mo6/1/1:4 (477 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/1:4 (477 MHz) down 83 0%(0%/0%) 0% 0 0
Mo6/1/1:5 (483 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/1:5 (483 MHz) down 83 0%(0%/0%) 0% 0 0
Mo6/1/1:6 (489 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/1:6 (489 MHz) down 83 0%(0%/0%) 0% 0 0
Mo6/1/1:7 (495 MHz) down 82 0%(0%/0%) 0% 0 0
Mo6/1/1:7 (495 MHz) down 83 0%(0%/0%) 0% 0 0
DOCSIS load-balancing load
Interface State Group Utilization Rsvd NBCM WB/UB Weight
Index Total Total
Cable7/0/0 (333 MHz) up 81 0%(0%/0%) 0% 2 6 37
Cable7/0/0 (333 MHz) up 48129 0%(0%/0%) 0% 2 6 37
Cable7/0/0/U0 up 81 0% 0% 21 12 7.6
Cable7/0/0/U0 up 48129 0% 0% 21 12 7.6
Cable7/0/0/U1 up 81 0% 0% 21 11 7.6
Cable7/0/0/U1 up 48129 0% 0% 21 11 7.6
Cable7/0/0/U2 up 81 0% 0% 21 10 7.6
Cable7/0/0/U2 up 48129 0% 0% 21 10 7.6
Cable7/0/0/U3 up 81 0% 0% 21 9 7.6
Cable7/0/0/U3 up 48129 0% 0% 21 9 7.6
Mo1/0/0:0 (501 MHz) up 81 0%(0%/0%) 0% 2 62 36
Mo1/0/0:0 (501 MHz) up 48129 0%(0%/0%) 0% 2 62 36
Mo1/0/0:0/U0 up 81 0% 0% 21 12 7.6
Mo1/0/0:0/U0 up 48129 0% 0% 21 12 7.6
Mo1/0/0:0/U1 up 81 0% 0% 21 11 7.6

Cisco CMTS Cable Command Reference

1783
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Mo1/0/0:0/U1 up 48129 0% 0% 21 11 7.6

Mo1/0/0:0/U2 up 81 0% 0% 21 10 7.6
Mo1/0/0:0/U2 up 48129 0% 0% 21 10 7.6
Mo1/0/0:0/U3 up 81 0% 0% 21 9 7.6
Mo1/0/0:0/U3 up 48129 0% 0% 21 9 7.6
Mo1/0/0:1 (507 MHz) up 81 0%(0%/0%) 0% 1 57 36
Mo1/0/0:1 (507 MHz) up 48129 0%(0%/0%) 0% 1 57 36
Mo1/0/0:1/U0 up 81 0% 0% 21 12 7.6
Mo1/0/0:1/U0 up 48129 0% 0% 21 12 7.6
Mo1/0/0:1/U1 up 81 0% 0% 21 11 7.6
Mo1/0/0:1/U1 up 48129 0% 0% 21 11 7.6
Mo1/0/0:1/U2 up 81 0% 0% 21 10 7.6
Mo1/0/0:1/U2 up 48129 0% 0% 21 10 7.6
Mo1/0/0:1/U3 up 81 0% 0% 21 9 7.6
Mo1/0/0:1/U3 up 48129 0% 0% 21 9 7.6
Mo1/0/0:2 (513 MHz) up 81 0%(0%/0%) 0% 1 56 36
Mo1/0/0:2 (513 MHz) up 48129 0%(0%/0%) 0% 1 56 36
Mo1/0/0:2/U0 up 81 0% 0% 21 12 7.6
Mo1/0/0:2/U0 up 48129 0% 0% 21 12 7.6
Mo1/0/0:2/U1 up 81 0% 0% 21 11 7.6
Mo1/0/0:2/U1 up 48129 0% 0% 21 11 7.6
Mo1/0/0:2/U2 up 81 0% 0% 21 10 7.6
Mo1/0/0:2/U2 up 48129 0% 0% 21 10 7.6
Mo1/0/0:2/U3 up 81 0% 0% 21 9 7.6
Mo1/0/0:2/U3 up 48129 0% 0% 21 9 7.6
Mo1/0/0:3 (519 MHz) up 81 0%(0%/0%) 0% 2 62 36
Mo1/0/0:3 (519 MHz) up 48129 0%(0%/0%) 0% 2 62 36
Mo1/0/0:3/U0 up 81 0% 0% 21 12 7.6
Mo1/0/0:3/U0 up 48129 0% 0% 21 12 7.6
Mo1/0/0:3/U1 up 81 0% 0% 21 11 7.6
Mo1/0/0:3/U1 up 48129 0% 0% 21 11 7.6
Mo1/0/0:3/U2 up 81 0% 0% 21 10 7.6
Mo1/0/0:3/U2 up 48129 0% 0% 21 10 7.6
Mo1/0/0:3/U3 up 81 0% 0% 21 9 7.6
Mo1/0/0:3/U3 up 48129 0% 0% 21 9 7.6
DOCSIS load-balancing load
Interface State Group Utilization Rsvd NBCM WB/UB Weight
Index Total Total
In8/0/0:0 (555 MHz) initial 55808 0%(0%/0%) 0% 0 0 37
In8/0/0:0/U0 initial 55808 0% 0% 0 0 7.6
In8/0/0:0/U1 initial 55808 0% 0% 0 0 7.6
In8/0/0:0/U2 initial 55808 0% 0% 0 0 7.6
In8/0/0:0/U3 initial 55808 0% 0% 0 0 7.6
In8/0/0:1 (561 MHz) initial 55808 0%(0%/0%) 0% 0 0 37
In8/0/0:1/U0 initial 55808 0% 0% 0 0 7.6
In8/0/0:1/U1 initial 55808 0% 0% 0 0 7.6
In8/0/0:1/U2 initial 55808 0% 0% 0 0 7.6
In8/0/0:1/U3 initial 55808 0% 0% 0 0 7.6
In8/0/0:2 (567 MHz) initial 55808 0%(0%/0%) 0% 0 0 37
In8/0/0:2/U0 initial 55808 0% 0% 0 0 7.6
In8/0/0:2/U1 initial 55808 0% 0% 0 0 7.6
In8/0/0:2/U2 initial 55808 0% 0% 0 0 7.6
In8/0/0:2/U3 initial 55808 0% 0% 0 0 7.6
In8/0/0:3 (573 MHz) initial 55808 0%(0%/0%) 0% 0 0 37
In8/0/0:3/U0 initial 55808 0% 0% 0 0 7.6
In8/0/0:3/U1 initial 55808 0% 0% 0 0 7.6
In8/0/0:3/U2 initial 55808 0% 0% 0 0 7.6
In8/0/0:3/U3 initial 55808 0% 0% 0 0 7.6
In8/0/1:0 (579 MHz) initial 55808 0%(0%/0%) 0% 0 0 37
In8/0/1:0/U0 initial 55808 0% 0% 0 0 7.6
In8/0/1:0/U1 initial 55808 0% 0% 0 0 7.6
In8/0/1:0/U2 initial 55808 0% 0% 0 0 7.6
In8/0/1:0/U3 initial 55808 0% 0% 0 0 7.6
In8/0/1:1 (585 MHz) initial 55808 0%(0%/0%) 0% 0 0 37

Cisco CMTS Cable Command Reference

1784
Cable Commands: show a through show cable l
show cable load-balance docsis-group

In8/0/1:1/U0 initial 55808 0% 0% 0 0 7.6

In8/0/1:1/U1 initial 55808 0% 0% 0 0 7.6
In8/0/1:1/U2 initial 55808 0% 0% 0 0 7.6
In8/0/1:1/U3 initial 55808 0% 0% 0 0 7.6
In8/0/1:2 (591 MHz) initial 55808 0%(0%/0%) 0% 0 0 37
In8/0/1:2/U0 initial 55808 0% 0% 0 0 7.6
In8/0/1:2/U1 initial 55808 0% 0% 0 0 7.6
In8/0/1:2/U2 initial 55808 0% 0% 0 0 7.6
In8/0/1:2/U3 initial 55808 0% 0% 0 0 7.6
In8/0/1:3 (597 MHz) initial 55808 0%(0%/0%) 0% 0 0 37
In8/0/1:3/U0 initial 55808 0% 0% 0 0 7.6
In8/0/1:3/U1 initial 55808 0% 0% 0 0 7.6
In8/0/1:3/U2 initial 55808 0% 0% 0 0 7.6
In8/0/1:3/U3 initial 55808 0% 0% 0 0 7.6
Mo1/0/0:4 (525 MHz) up 55808 0%(0%/0%) 0% 2 0 36
Mo1/0/0:4/U4 up 55808 0% 0% 1 0 7.6
Mo1/0/0:4/U5 up 55808 0% 0% 2 0 7.6
Mo1/0/0:4/U6 up 55808 0% 0% 1 0 7.6
Mo1/0/0:4/U7 initial 55808 0% 0% 0 0 7.6
Mo1/0/0:5 (531 MHz) initial 55808 0%(0%/0%) 0% 0 0 36
Mo1/0/0:5/U4 up 55808 0% 0% 1 0 7.6
Mo1/0/0:5/U5 up 55808 0% 0% 2 0 7.6
Mo1/0/0:5/U6 up 55808 0% 0% 1 0 7.6
Mo1/0/0:5/U7 initial 55808 0% 0% 0 0 7.6
Mo1/0/0:6 (537 MHz) up 55808 0%(0%/0%) 0% 1 0 36
Mo1/0/0:6/U4 up 55808 0% 0% 1 0 7.6
Mo1/0/0:6/U5 up 55808 0% 0% 2 0 7.6
Mo1/0/0:6/U6 up 55808 0% 0% 1 0 7.6
Mo1/0/0:6/U7 initial 55808 0% 0% 0 0 7.6
Mo1/0/0:7 (543 MHz) up 55808 0%(0%/0%) 0% 1 0 36
Mo1/0/0:7/U4 up 55808 0% 0% 1 0 7.6
Mo1/0/0:7/U5 up 55808 0% 0% 2 0 7.6
Mo1/0/0:7/U6 up 55808 0% 0% 1 0 7.6
Mo1/0/0:7/U7 initial 55808 0% 0% 0 0 7.6
Target assignments:
Interface State Group Target
Index
Mo6/1/0:0 (405 MHz) initial 82
Mo6/1/0:0 (405 MHz) initial 44290
Mo6/1/0:0/U0 initial 82
Mo6/1/0:0/U0 initial 44290
Mo6/1/0:0/U1 initial 82
Mo6/1/0:0/U1 initial 44290
Mo6/1/0:0/U2 initial 82
Mo6/1/0:0/U2 initial 44290
Mo6/1/0:0/U3 initial 82
Mo6/1/0:0/U3 initial 44290
Mo6/1/0:1 (411 MHz) down 82
Mo6/1/0:1 (411 MHz) down 44290
Mo6/1/0:2 (417 MHz) down 82
Mo6/1/0:2 (417 MHz) down 44290
Mo6/1/0:3 (423 MHz) down 82
Mo6/1/0:3 (423 MHz) down 44290
Mo6/1/0:4 (429 MHz) down 82
Mo6/1/0:4 (429 MHz) down 44290
Mo6/1/0:5 (435 MHz) down 82
Mo6/1/0:5 (435 MHz) down 44290
Mo6/1/0:6 (441 MHz) down 82
Mo6/1/0:6 (441 MHz) down 44290
Mo6/1/0:7 (447 MHz) down 82
Mo6/1/0:7 (447 MHz) down 44290
Mo6/1/1:0 (453 MHz) down 82
Mo6/1/1:0 (453 MHz) down 83
Mo6/1/1:1 (459 MHz) down 82

Cisco CMTS Cable Command Reference

1785
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Mo6/1/1:1 (459 MHz) down 83

Mo6/1/1:2 (465 MHz) down 82
Mo6/1/1:2 (465 MHz) down 83
Mo6/1/1:3 (471 MHz) down 82
Mo6/1/1:3 (471 MHz) down 83
Mo6/1/1:4 (477 MHz) down 82
Mo6/1/1:4 (477 MHz) down 83
Mo6/1/1:5 (483 MHz) down 82
Mo6/1/1:5 (483 MHz) down 83
Mo6/1/1:6 (489 MHz) down 82
Mo6/1/1:6 (489 MHz) down 83
Mo6/1/1:7 (495 MHz) down 82
Mo6/1/1:7 (495 MHz) down 83
Cable7/0/0 (333 MHz) up 81 Mo1/0/0:1 (507 MHz) [enforce]
Cable7/0/0 (333 MHz) up 48129 Mo1/0/0:1 (507 MHz)
Cable7/0/0/U0 up 81
Cable7/0/0/U0 up 48129
Cable7/0/0/U1 up 81 Cable7/0/0/U0
Cable7/0/0/U1 up 48129
Cable7/0/0/U2 up 81
Cable7/0/0/U2 up 48129
Cable7/0/0/U3 up 81
Cable7/0/0/U3 up 48129
Mo1/0/0:0 (501 MHz) up 81
Mo1/0/0:0 (501 MHz) up 48129
Mo1/0/0:0/U0 up 81
Mo1/0/0:0/U0 up 48129
Mo1/0/0:0/U1 up 81 Mo1/0/0:0/U0
Mo1/0/0:0/U1 up 48129
Mo1/0/0:0/U2 up 81
Mo1/0/0:0/U2 up 48129
Mo1/0/0:0/U3 up 81
Mo1/0/0:0/U3 up 48129
Mo1/0/0:1 (507 MHz) up 81
Mo1/0/0:1 (507 MHz) up 48129
Mo1/0/0:1/U0 up 81
Mo1/0/0:1/U0 up 48129
Mo1/0/0:1/U1 up 81 Mo1/0/0:1/U0
Mo1/0/0:1/U1 up 48129
Mo1/0/0:1/U2 up 81
Mo1/0/0:1/U2 up 48129
Mo1/0/0:1/U3 up 81
Mo1/0/0:1/U3 up 48129
Mo1/0/0:2 (513 MHz) up 81
Mo1/0/0:2 (513 MHz) up 48129
Mo1/0/0:2/U0 up 81
Mo1/0/0:2/U0 up 48129
Mo1/0/0:2/U1 up 81 Mo1/0/0:2/U0
Mo1/0/0:2/U1 up 48129
Mo1/0/0:2/U2 up 81
Mo1/0/0:2/U2 up 48129
Mo1/0/0:2/U3 up 81
Mo1/0/0:2/U3 up 48129
Mo1/0/0:3 (519 MHz) up 81
Mo1/0/0:3 (519 MHz) up 48129
Mo1/0/0:3/U0 up 81
Mo1/0/0:3/U0 up 48129
Mo1/0/0:3/U1 up 81 Mo1/0/0:3/U0
Mo1/0/0:3/U1 up 48129
Mo1/0/0:3/U2 up 81
Mo1/0/0:3/U2 up 48129
Mo1/0/0:3/U3 up 81
Mo1/0/0:3/U3 up 48129
In8/0/0:0 (555 MHz) initial 55808

Cisco CMTS Cable Command Reference

1786
Cable Commands: show a through show cable l
show cable load-balance docsis-group

In8/0/0:0/U0 initial 55808

In8/0/0:0/U1 initial 55808
In8/0/0:0/U2 initial 55808
In8/0/0:0/U3 initial 55808
In8/0/0:1 (561 MHz) initial 55808
In8/0/0:1/U0 initial 55808
In8/0/0:1/U1 initial 55808
In8/0/0:1/U2 initial 55808
In8/0/0:1/U3 initial 55808
In8/0/0:2 (567 MHz) initial 55808
In8/0/0:2/U0 initial 55808
In8/0/0:2/U1 initial 55808
In8/0/0:2/U2 initial 55808
In8/0/0:2/U3 initial 55808
In8/0/0:3 (573 MHz) initial 55808
In8/0/0:3/U0 initial 55808
In8/0/0:3/U1 initial 55808
In8/0/0:3/U2 initial 55808
In8/0/0:3/U3 initial 55808
In8/0/1:0 (579 MHz) initial 55808
In8/0/1:0/U0 initial 55808
In8/0/1:0/U1 initial 55808
In8/0/1:0/U2 initial 55808
In8/0/1:0/U3 initial 55808
In8/0/1:1 (585 MHz) initial 55808
In8/0/1:1/U0 initial 55808
In8/0/1:1/U1 initial 55808
In8/0/1:1/U2 initial 55808
In8/0/1:1/U3 initial 55808
In8/0/1:2 (591 MHz) initial 55808
In8/0/1:2/U0 initial 55808
In8/0/1:2/U1 initial 55808
In8/0/1:2/U2 initial 55808
In8/0/1:2/U3 initial 55808
In8/0/1:3 (597 MHz) initial 55808
In8/0/1:3/U0 initial 55808
In8/0/1:3/U1 initial 55808
In8/0/1:3/U2 initial 55808
In8/0/1:3/U3 initial 55808
Mo1/0/0:4 (525 MHz) up 55808
Mo1/0/0:4/U4 up 55808
Mo1/0/0:4/U5 up 55808
Mo1/0/0:4/U6 up 55808
Mo1/0/0:4/U7 initial 55808
Mo1/0/0:5 (531 MHz) initial 55808
Mo1/0/0:5/U4 up 55808
Mo1/0/0:5/U5 up 55808
Mo1/0/0:5/U6 up 55808
Mo1/0/0:5/U7 initial 55808
Mo1/0/0:6 (537 MHz) up 55808
Mo1/0/0:6/U4 up 55808
Mo1/0/0:6/U5 up 55808
Mo1/0/0:6/U6 up 55808
Mo1/0/0:6/U7 initial 55808
Mo1/0/0:7 (543 MHz) up 55808
Mo1/0/0:7/U4 up 55808
Mo1/0/0:7/U5 up 55808
Mo1/0/0:7/U6 up 55808
Mo1/0/0:7/U7 initial 55808
Statistics:
Target interface State Transfers
Complete Pending Retries Failures
Mo6/1/0:0 (405 MHz) initial 0 0 0 0
Mo6/1/0:0/U0 initial 0 0 0 0

Cisco CMTS Cable Command Reference

1787
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Mo6/1/0:0/U1 initial 0 0 0 0
Mo6/1/0:0/U2 initial 0 0 0 0
Mo6/1/0:0/U3 initial 0 0 0 0
Mo6/1/0:1 (411 MHz) down 0 0 0 0
Mo6/1/0:2 (417 MHz) down 0 0 0 0
Mo6/1/0:3 (423 MHz) down 0 0 0 0
Mo6/1/0:4 (429 MHz) down 0 0 0 0
Mo6/1/0:5 (435 MHz) down 0 0 0 0
Mo6/1/0:6 (441 MHz) down 0 0 0 0
Mo6/1/0:7 (447 MHz) down 0 0 0 0
Mo6/1/1:0 (453 MHz) down 0 0 0 0
Mo6/1/1:1 (459 MHz) down 0 0 0 0
Mo6/1/1:2 (465 MHz) down 0 0 0 0
Mo6/1/1:3 (471 MHz) down 0 0 0 0
Mo6/1/1:4 (477 MHz) down 0 0 0 0
Mo6/1/1:5 (483 MHz) down 0 0 0 0
Mo6/1/1:6 (489 MHz) down 0 0 0 0
Mo6/1/1:7 (495 MHz) down 0 0 0 0
Cable7/0/0 (333 MHz) up 10 0 0 0
Cable7/0/0/U0 up 33 0 0 0
Cable7/0/0/U1 up 84 0 0 0
Cable7/0/0/U2 up 48 0 0 0
Cable7/0/0/U3 up 34 0 0 0
Mo1/0/0:0 (501 MHz) up 19 0 0 0
Mo1/0/0:0/U0 up 34 0 0 0
Mo1/0/0:0/U1 up 49 0 0 0
Mo1/0/0:0/U2 up 23 0 0 0
Mo1/0/0:0/U3 up 22 0 0 0
Mo1/0/0:1 (507 MHz) up 23 0 0 0
Mo1/0/0:1/U0 up 10 0 0 0
Mo1/0/0:1/U1 up 21 0 0 0
Mo1/0/0:1/U2 up 16 0 0 0
Mo1/0/0:1/U3 up 21 0 0 0
Mo1/0/0:2 (513 MHz) up 21 0 0 0
Mo1/0/0:2/U0 up 4 0 0 0
Mo1/0/0:2/U1 up 3 0 0 0
Mo1/0/0:2/U2 up 7 0 0 0
Mo1/0/0:2/U3 up 8 0 0 0
Mo1/0/0:3 (519 MHz) up 10 0 0 0
Mo1/0/0:3/U0 up 1 0 0 0
Mo1/0/0:3/U1 up 2 0 0 0
Mo1/0/0:3/U2 up 4 0 0 0
Mo1/0/0:3/U3 up 4 0 0 0
In8/0/0:0 (555 MHz) initial 0 0 0 0
In8/0/0:0/U0 initial 0 0 0 0
In8/0/0:0/U1 initial 0 0 0 0
In8/0/0:0/U2 initial 0 0 0 0
In8/0/0:0/U3 up 0 0 0 0
In8/0/0:0/U4 down 0 0 0 0
In8/0/0:0/U5 down 0 0 0 0
In8/0/0:0/U6 down 0 0 0 0
In8/0/0:0/U7 down 0 0 0 0
In8/0/0:1 (561 MHz) initial 0 0 0 0
In8/0/0:1/U0 initial 0 0 0 0
In8/0/0:1/U1 initial 0 0 0 0
In8/0/0:1/U2 initial 0 0 0 0
In8/0/0:1/U3 up 0 0 0 0
In8/0/0:1/U4 down 0 0 0 0
In8/0/0:1/U5 down 0 0 0 0
In8/0/0:1/U6 down 0 0 0 0
In8/0/0:1/U7 down 0 0 0 0
In8/0/0:2 (567 MHz) up 0 0 0 0
In8/0/0:2/U0 initial 0 0 0 0
In8/0/0:2/U1 initial 0 0 0 0

Cisco CMTS Cable Command Reference

1788
Cable Commands: show a through show cable l
show cable load-balance docsis-group

In8/0/0:2/U2 initial 0 0 0 0
In8/0/0:2/U3 up 0 0 0 0
In8/0/0:2/U4 down 0 0 0 0
In8/0/0:2/U5 down 0 0 0 0
In8/0/0:2/U6 down 0 0 0 0
In8/0/0:2/U7 down 0 0 0 0
In8/0/0:3 (573 MHz) initial 0 0 0 0
In8/0/0:3/U0 initial 0 0 0 0
In8/0/0:3/U1 initial 0 0 0 0
In8/0/0:3/U2 initial 0 0 0 0
In8/0/0:3/U3 up 0 0 0 0
In8/0/0:3/U4 down 0 0 0 0
In8/0/0:3/U5 down 0 0 0 0
In8/0/0:3/U6 down 0 0 0 0
In8/0/0:3/U7 down 0 0 0 0
In8/0/1:0 (579 MHz) initial 0 0 0 0
In8/0/1:0/U0 initial 0 0 0 0
In8/0/1:0/U1 initial 0 0 0 0
In8/0/1:0/U2 initial 0 0 0 0
In8/0/1:0/U3 up 0 0 0 0
In8/0/1:0/U4 down 0 0 0 0
In8/0/1:0/U5 down 0 0 0 0
In8/0/1:0/U6 down 0 0 0 0
In8/0/1:0/U7 down 0 0 0 0
In8/0/1:1 (585 MHz) initial 0 0 0 0
In8/0/1:1/U0 initial 0 0 0 0
In8/0/1:1/U1 initial 0 0 0 0
In8/0/1:1/U2 initial 0 0 0 0
In8/0/1:1/U3 up 0 0 0 0
In8/0/1:1/U4 down 0 0 0 0
In8/0/1:1/U5 down 0 0 0 0
In8/0/1:1/U6 down 0 0 0 0
In8/0/1:1/U7 down 0 0 0 0
In8/0/1:2 (591 MHz) initial 0 0 0 0
In8/0/1:2/U0 initial 0 0 0 0
In8/0/1:2/U1 initial 0 0 0 0
In8/0/1:2/U2 initial 0 0 0 0
In8/0/1:2/U3 up 0 0 0 0
In8/0/1:2/U4 down 0 0 0 0
In8/0/1:2/U5 down 0 0 0 0
In8/0/1:2/U6 down 0 0 0 0
In8/0/1:2/U7 down 0 0 0 0
In8/0/1:3 (597 MHz) initial 0 0 0 0
In8/0/1:3/U0 initial 0 0 0 0
In8/0/1:3/U1 initial 0 0 0 0
In8/0/1:3/U2 initial 0 0 0 0
In8/0/1:3/U3 up 0 0 0 0
In8/0/1:3/U4 down 0 0 0 0
In8/0/1:3/U5 down 0 0 0 0
In8/0/1:3/U6 down 0 0 0 0
In8/0/1:3/U7 down 0 0 0 0
Mo1/0/0:4 (525 MHz) up 0 0 0 0
Mo1/0/0:4/U0 down 0 0 0 0
Mo1/0/0:4/U1 down 0 0 0 0
Mo1/0/0:4/U2 down 0 0 0 0
Mo1/0/0:4/U3 down 0 0 0 0
Mo1/0/0:4/U4 up 0 0 0 0
Mo1/0/0:4/U5 up 0 0 0 0
Mo1/0/0:4/U6 up 0 0 0 0
Mo1/0/0:4/U7 initial 0 0 0 0
Mo1/0/0:5 (531 MHz) initial 0 0 0 0
Mo1/0/0:5/U0 down 0 0 0 0
Mo1/0/0:5/U1 down 0 0 0 0
Mo1/0/0:5/U2 down 0 0 0 0

Cisco CMTS Cable Command Reference

1789
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Mo1/0/0:5/U3 down 0 0 0 0
Mo1/0/0:5/U4 up 0 0 0 0
Mo1/0/0:5/U5 up 0 0 0 0
Mo1/0/0:5/U6 up 0 0 0 0
Mo1/0/0:5/U7 initial 0 0 0 0
Mo1/0/0:6 (537 MHz) up 0 0 0 0
Mo1/0/0:6/U0 down 0 0 0 0
Mo1/0/0:6/U1 down 0 0 0 0
Mo1/0/0:6/U2 down 0 0 0 0
Mo1/0/0:6/U3 down 0 0 0 0
Mo1/0/0:6/U4 up 0 0 0 0
Mo1/0/0:6/U5 up 0 0 0 0
Mo1/0/0:6/U6 up 0 0 0 0
Mo1/0/0:6/U7 initial 0 0 0 0
Mo1/0/0:7 (543 MHz) initial 0 0 0 0
Mo1/0/0:7/U0 down 0 0 0 0
Mo1/0/0:7/U1 down 0 0 0 0
Mo1/0/0:7/U2 down 0 0 0 0
Mo1/0/0:7/U3 down 0 0 0 0
Mo1/0/0:7/U4 up 0 0 0 0
Mo1/0/0:7/U5 up 0 0 0 0
Mo1/0/0:7/U6 up 0 0 0 0
Mo1/0/0:7/U7 initial 0 0 0 0
Pending:
Modem Grp Idx Primary RF/RCC MD/TCS Action Active Retries
Src Target Src Target Time
001c.ea37.9aa0 81 Mo1/0/0:2/1 Mo1/0/0:1/0 60/1 60/1 REINIT 02:05 0 DOCSIS
3.0 LB
001c.ea37.9b5e 81 Cable7/0/0/1 Mo1/0/0:1/0 60/4 60/8 REINIT 02:12 0 DOCSIS
3.0 LB
001c.ea37.9bb0 81 Cable7/0/0/2 Mo1/0/0:2/0 60/2 60/2 REINIT 02:17 0 DOCSIS
3.0 LB

The following is a sample output of the show cable load-balance docsis-group vdoc command:

Router# show cable load-balance docsis-group 1 vdoc

Target interface State Group Util Total IGMP CIR High Low
Index Targeted Rep Init Util CIR
Cable7/0/0 (531 MHz) down 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:0 (453 MHz) up 81 0 9(5) 7(5) 2(0) 0 0
Mo3/0/0:1 (459 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:10 (513 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:11 (519 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:2 (465 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:3 (471 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:4 (477 MHz) initi 81 0 5(0) 0(0) 5(0) 0 0
Mo3/0/0:5 (483 MHz) up 81 0 7(7) 7(7) 0(0) 0 0
Mo3/0/0:6 (489 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:7 (495 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:8 (501 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0
Mo3/0/0:9 (507 MHz) initi 81 0 0(0) 0(0) 0(0) 0 0

The following example shows the output of the show cable load-balance docsis-group
docsis-group-id with the primary-load command:

Router#show cable load-balance docsis-group fn

2 md
c7/0/0 primary-load
MD RCC-ID Interface In-RCC State Pending NBCM WBCM Weight
Ca7/0/0 1 Mo7/0/0:0 Y up 0 0 0 24.9
Ca7/0/0 1 Mo7/0/0:1 Y initial 0 0 0 24.9

Cisco CMTS Cable Command Reference

1790
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Ca7/0/0 1 Mo7/0/0:2 Y up 0 0 0 24.9

Ca7/0/0 1 Mo7/0/0:3 Y initial 0 0 0 24.9

Table 91: show cable load-balance docsis-group – Field Description

Field Description

Fields for the Default Display and all Option

DOCSIS Group Current number of DOCSIS groups created on the CMTS.

Group Index Number of the load balancing group to which the cable interface has been assigned.

Status Information about the DOCSIS LBG:

• R—Restricted load balancing group (RLBG).
• G—General load balancing group (GLBG).
• E—The DOCSIS LBG is enabled.
• D—The DOCSIS LBG is disabled.

Interval Minimum time period configured when cable modems can be moved to load balance the interfaces.
In Cisco IOS Release 12.2(33)SCE and earlier releases, the valid range is 1 to 1000 seconds, with a default
value of 10. In Cisco IOS Release 12.2(33)SCE1 and later releases, the default value of interval is 30.

DCC mask/UCC Downstream and upstream channel change masks associated with the DOCSIS group.
For example, in the output ‘0x40(1)/Y’, ‘0x40’ indicates that the user configured the dynamic channel
change (DCC) technique 1 for the DOCSIS LBG. Similarly, '0x80' indicates configured DCC technique
0 and '0x20' indicates configured DCC technique 2. '(1)' indicates the DCC technique 1 is used to move
the cable modem (CM). '/Y' indicates that load balancing sends upstream channel change (UCC) for
movement of US channel only.

Policy DOCSIS policy associated with the load balancing group.

Method Load balancing method used for the load balancing group. The following indicates what method is used
for DS and US modems:
• m = modem
Uses the number of active cable modems on an interface.
• s = service flow
Uses the number of active Service Flow IDs (SFIDs) on an interface.
• u = utilization
Uses the current percent of utilization of an interface.

Cisco CMTS Cable Command Reference

1791
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

Threshold Thresholds configured for this load balancing group:

• M = Minimum
Minimum difference in the number of cable modems or service flows that can exist on two interfaces in
the group before cable modems are moved between the interfaces. If the imbalance between interfaces is
below this value, cable modems are not moved. This field contains a value only when the group is configured
for the modems or service flows method of load balancing. (This value is configured using the load
minimum option of the cable load-balance group threshold command.)
• S = Stability.
Minimum allowable percentage of good periodic ranging requests that is acceptable. When the channel
has a lower percent of modems responding to the ranging requests in a one minute period, the Cisco CMTS
begins moving modems. The valid range is 0 to 100 percent, with a default of 50 percent.
• E = Enforce
Minimum difference in the percentage of total load that must exist between interfaces in a load balancing
group before the Cisco CMTS performs dynamic load balancing and begins moving cable modems that
are currently online. When the difference in load between two interfaces falls below this value, the CMTS
stops dynamic load balancing and performs static load balancing. (This value is configured using the
enforce option of the cable load-balance group threshold command.)
• U = Ugs
Percentage of the bandwidth that is allocated for Unsolicited Grant Services (UGS) traffic, such as
Voice-over-IP (VoIP), that is in use on an interface because the CMTS moves cable modems that are
online with active UGS service flows. (This value is configured using the ugs option of the cable
load-balance group threshold command.)
• P = PacketCable MultiMedia (PCMM)
Percentage of the reserved bandwidth threshold. Above this level, cable modems with active PCMM
service flows participate in load balancing. The default threshold is 70%.

Interface Cable interface (downstream or upstream) that belongs to a load balancing group.

Utilization Long-term average of the upstream utilization. Displays the current load usage of the cable interface
expressed as a percentage of the total bandwidth. For upstreams, this field shows a single percentage value,
which is the average percentage of bandwidth being used on the upstream.
For downstreams, this field shows a set of three percentage values:
• The percentage shows the load usage for the entire interface.
• The first percentage, within the parentheses, shows the load for the downstream.
• The second percentage, within the parentheses, shows the average load for all upstreams on the
downstream.
For example, if this field shows “ 18%(18%/12%) ”, it indicates that downstream and upstream channels
on the interface are running on an average load of 18 percent. The downstream is running on an average
load of 18 percent and all upstreams for this downstream are running on an average load of 12 percent.
Note
To view the short-term average of the utilization, use the show interface cable mac-scheduler command.

Cisco CMTS Cable Command Reference

1792
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

State Current state of the cable interface.

The following states indicate normal operational states, depending on the configuration:
• down—Interface is shut down. The CMTS cannot use the interface for load balancing in this state.
• initial—Interface is currently in the initialization phase. The CMTS uses the interface for load balancing
after the initialization completes.
• up—Interface is up and passing traffic. The CMTS actively uses the interface for load balancing.
• testing—Interface is currently under a load balancing test. The CMTS is unable to use the interface
for normal load balancing operations until the test completes.
The following states indicate abnormal states. The CMTS does not use interfaces in these states for load
balancing operations, but continues to monitor and update the status every time the CMTS polls the
interfaces for their current load usage:
• suspicious—Interface is in an unknown state. The interface might be up and passing traffic, but is
not consistent enough to support load balancing operations. The CMTS attempts to reinitialize the
interface after a time-out period. If the interface has failed initialization more than 10 times, the CMTS
moves the interface to the disabled state.
• disabled—Interface has been disabled because a load balancing test is in-progress or because the
interface reinitialization failed after 10 attempts.
• unstable—Interface has failed repeated initialization attempts. The CMTS will attempt to reinitialize
the interface after a time-out period. If a load balance test is not in-progress and if reinitialization
fails, the CMTS moves it to the unstable state.

Reserved Percentage of bandwidth that is currently reserved by unsolicited grant service (UGS) service flows.

Modems Number of cable modems currently online on this cable interface.

Weight Interface bandwidth, in megabits per second (mbps), for the downstream or upstream. The system uses
this value in calculating whether the loads on the interfaces are balanced. Changing a channel parameter,
such as modulation profile or channel width, affects the channel bandwidth and weight value.

Additional Fields for the target Option

Interface Source downstream or upstream interface that is part of a cable load balancing group. If the target field
contains a value, it indicates that the source interface is currently oversubscribed.
To reduce the cable load, the CMTS moves cable modems from the source interface to the target interface.

Target Downstream or upstream interface to which cable modems on the source interface are being moved as
part of load balancing operations. This field indicates the following:
• If it is a downstream interface, the display shows the center frequency of the downstream within
parentheses.
• If only a frequency is shown, it indicates that the CMTS is moving cable modems to a different center
frequency on the same downstream interface.
• When the display includes the words “enforce”, it indicates that the CMTS is performing dynamic
load balancing on the interfaces.
• If this field is blank, it indicates that the source interface is not oversubscribed.

Additional Fields for the statistics Option

Cisco CMTS Cable Command Reference

1793
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

Target interface Downstream or upstream interface. If this is a downstream interface, the display shows the center frequency
of the downstream within parentheses.

Transfers The following information is tracked for the indicated target interface:
• complete—Number of cable modems successfully moved to the target interface.
• pending—Number of cable modems in the process of being moved to the target interface.
• retries—Number of times that the CMTS unsuccessfully tried to move the same cable modem to the
target interface. This occurs when one or more MAC layer messages to the cable modem are dropped
due to radio frequency (RF) noise or because the modem is not DOCSIS-compliant. If the number
of retries exceeds five for a particular cable modem, the CMTS counts this as a failure.
• failures—Number of times that the CMTS exceeded the maximum number of allowable retries (5)
when trying to move a particular cable modem to the target interface. A large number of failures
could indicate one or more possible problems:
• The specific cable modems are not DOCSIS-compliant.
• One or both interfaces are having problems passing traffic.
• One or both interfaces are having persistent RF noise problems.
• The source and target interfaces are not combined in the same node and do not share the same
physical connectivity (which is required when interfaces are part the same load balancing group).

Additional Fields for the pending Option

Modem Hardware (MAC) address of the cable modem that is moved as part of load balancing operations.

Source interface Downstream or upstream cable interface on which the cable modem is currently online.

Target interface Downstream or upstream cable interface to which the CMTS is trying to move the cable modem to load
balance the interfaces in this load balancing group. If the CMTS is moving the cable modem to a different
frequency on the same downstream interface, this field shows only the new center frequency.

Retries Number of times that the CMTS has attempted to move this cable modem to the target interface. The
CMTS attempts to move the cable modem 5 times before counting this load balancing move as a failure.

Additional Fields for the modem-list option

US Upstream channels in the DOCSIS LBG.

MAC Address Total number (in parentheses) and MAC addresses of the modems connected to the upstream channels.

Additional fields for the primary-load option

MD MAC Domain.

RCC-ID RCC index per MAC domain.

Pending Number of pending modems on the channel.

Additional Fields for the move-history option

Modem The mac address of the moved cable modem

Cisco CMTS Cable Command Reference

1794
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

Host Interface The mac-domain of the cable modem.

Group ID The load balance group ID of cable modem.

Primary RF/RCC Old downstream information of the cable modem, including the primary downstream channel, RCC ID
Source before moving.

Primary RF/RCC Target New downstream information of the cable modem, including the new primary downstream channel, RCC
ID after moving.

MD/TCS Source Old upstream information of the cable modem including the index of mac-domain, the bitmap of the
upstream channel before moving.

MD/TCS Target New upstream information of the cable modem including the index of mac-domain, the bitmap of the
upstream channel after moving.

Action The action of the cable modem movement, such as DBC, DCC, UCC, REINIT(DCC with init-tech 0).

Trans-Start Time The trigger of the cable modem movement, such as D2.0 LB, D3.0 static LB, D3.0 dynamic LB.

Elapse Time (ms) The start time of the cable modem movement.

Client The elapsed time - how long the cable modem movement spent.

Result The result of the action on modem movement - success, faiure, and the internal confirmation code.

The following is a sample output of the show cable load-balance docsis-group rcs-cm-list command
in Cisco IOS Release 12.2(33)SCI and later releases:
Router# show cable load-balance docsis-group fn 11 md c7/0/0 rcs-cm-list

WB/RCC-TMPL(PRIM-IN) Size Util MAC Domain MAC Address Primary DS

Wi3/0/0:0 (Y) 4 96% Ca7/0/0 (13)
602a.d001.f9c0 Mo3/0/0:2
0025.2ed9.993e Mo3/0/0:3
0025.2eaf.7052 Mo3/0/0:2
7cb2.1b9c.8c60 Mo3/0/0:2
0025.2ed0.9288 Mo3/0/0:2
0025.2ed9.93ca Mo3/0/0:1
4458.2945.2d98 Mo3/0/0:3
7cb2.1b9c.8454 Mo3/0/0:2
0023.be77.ecfe Mo3/0/0:2
0025.2eaf.6e50 Mo3/0/0:0
0025.2eaf.6e98 Mo3/0/0:1
4458.2945.1e60 Mo3/0/0:0
7cb2.1b9c.8342 Mo3/0/0:0

The following is a sample output of the show cable load-balance docsis-group staticstics command
in Cisco IOS Release 12.2(33)SCI and later releases:
Router# show cable load-balance docsis-group fn 11 md c7/0/0 statistics

Target interface State Trans Fail Fail Total Max-

Cmple Pend Retry (NB) (WB) Attem Fail
Mo3/0/0:0 (351 MHz) initial 0 0 0 0 - 0 0

Cisco CMTS Cable Command Reference

1795
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Mo3/0/0:0/U0 up 0 0 0 0 - 0 0
Mo3/0/0:0/U1 initial 0 0 0 0 - 0 0
Mo3/0/0:0/U2 initial 0 0 0 0 - 0 0
Mo3/0/0:0/U3 up 0 0 0 0 - 0 0
Mo3/0/0:1 (357 MHz) initial 0 0 0 0 - 0 0
Mo3/0/0:1/U0 up 0 0 0 0 - 0 0
Mo3/0/0:1/U1 initial 0 0 0 0 - 0 0
Mo3/0/0:1/U2 initial 0 0 0 0 - 0 0
Mo3/0/0:1/U3 up 0 0 0 0 - 0 0
Mo3/0/0:2 (363 MHz) up 0 0 0 0 - 0 0
Mo3/0/0:2/U0 up 0 0 0 0 - 0 0
Mo3/0/0:2/U1 initial 0 0 0 0 - 0 0
Mo3/0/0:2/U2 initial 0 0 0 0 - 0 0
Mo3/0/0:2/U3 up 0 0 0 0 - 0 0
Mo3/0/0:3 (369 MHz) up 0 0 0 0 - 0 0
Mo3/0/0:3/U0 up 0 0 0 0 - 0 0
Mo3/0/0:3/U1 initial 0 0 0 0 - 0 0
Mo3/0/0:3/U2 initial 0 0 0 0 - 0 0
Mo3/0/0:3/U3 up 0 0 0 0 - 0 0

Wi3/0/0:0 up 0 0 - - 0 0 0

The following example shows the output of the show cable load-balance docsis-group target dbg
command:

Router# show cable load-balance docsis-group fn 320 md c3/0/0 target dbg

Interface Bg-Id Size Group Target
Wi3/0/0:0 24577 4 2147557695
Wi3/0/0:3 24580 4 2147557695
Wi3/0/0:4 24581 8 2147557695
Wi3/0/0:5 24582 8 2147557695
Wi3/0/0:6 24583 24 2147557695 33% [24576, 24584-24587, 24589-24607]
Wi3/0/0:7 24584 16 2147557695 30% [24576, 24586-24587, 24595-24607]
Wi3/0/0:8 24585 16 2147557695
Wi3/0/0:9 24586 32 2147557695
Wi3/0/0:10 24587 24 2147557695 33% [24576, 24584-24587, 24589-24607]
Wi3/0/0:11 24588 8 2147557695
Wi3/0/0:12 24589 8 2147557695 27% [24596-24603]
Wi3/0/0:13 24590 8 2147557695
Wi3/0/0:14 24591 4 2147557695

The following example shows the output of the show cable load-balance docsis-group target wide
command:

Router# show cable load-balance docsis-group fn 5 md c1/0/4 target wide

Interface Bg-Id State Group Target
Wi1/0/4:2 9219 up 2147510276 Wi1/0/4:4
Wi1/0/4:3 9220 up 2147510276
Wi1/0/4:4 9221 up 2147510276

The following example shows the output of the show cable load-balance docsis-group move-history
cable slot/subslot/controller-interface command:

Router# show cable load-balance docsis-group fn 1 md c3/0/1 move-history

Modem Host Grp Id Primary RF/RCC MD/TCS
Action Trans-Start Elapse Client Result
Interface Src Target Src Target
Time Time(ms)
C8fb.26a6.c612 Ca3/0/1 2147557888 Do3/0/0:0/1 Do3/0/0:4/2 145/0xF 145/0xF
DBC Aug 10 16:04:38 13295 D3.0 STATIC LB Success(1)

Cisco CMTS Cable Command Reference

1796
Cable Commands: show a through show cable l
show cable load-balance docsis-group

C8fb.26a6.bf68 Ca3/0/1 2147557888 Do3/0/0:0/1 Do3/0/0:5/2 145/0xF 145/0xF

DBC Aug 10 16:04:23 21941 D3.0 STATIC LB Success(1)
C8fb.26a6.c5c8 Ca3/0/1 2147557888 Do3/0/0:1/1 Do3/0/0:5/2 145/0xF 145/0xF
DBC Aug 10 16:04:10 25330 D3.0 STATIC LB Success(1)

The following example shows the output of the show cable load-balance docsis-group fn n mdcable
slot/subslot/controller-interfacestatisticswideband command:

Router# show cable load-balance docsis-group fn 1 md c3/0/1 statistics wideband

Target interface State Transfers
Complete Pending Total Failure
Disabled
Wi3/0/0:0 up 0 0 0 0
0
Wi3/0/0:1 up 3 0 3 0
0

Note • The show cable load-balance docsis-group target wide and show cable load-balance
docsis-group fn n md cable slot/subslot/controller-interface statistics wideband CLIs does
not support LCHA and LCPR.
• For the show cable load-balance docsis-group target wide and show cable load-balance
docsis-group fn n md cable slot/subslot/controller-interface statistics wideband CLIs, the
maximum number of modem movement entries per line card is 16000.

The following example shows the output of the show cable modem x.x.x verbose command in
DCC|DBC:

Router# show cable modem c8fb.26a6.bf68 verbose |in DCC|DBC

DBC req/rsp/ack : 1/1/1
DCC req/rsp/ack : 0/0/0

Table 92: show cable load-balance docsis-group – Field Description

Field Description

Fields for the Default Display and all Option

DOCSIS Group Current number of DOCSIS groups created on the CMTS.

Group Index Number of the load balancing group to which the cable interface has been
assigned.

Status Information about the DOCSIS LBG:

• R—Restricted load balancing group (RLBG).
• G—General load balancing group (GLBG).
• E—The DOCSIS LBG is enabled.
• D—The DOCSIS LBG is disabled.

Cisco CMTS Cable Command Reference

1797
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

Interval Minimum time period configured when cable modems can be moved to load
balance the interfaces.
In Cisco IOS Release 12.2(33)SCE and earlier releases, the valid range is 1
to 1000 seconds, with a default value of 10. In Cisco IOS Release
12.2(33)SCE1 and later releases, the default value of interval is 30.

DCC mask/UCC Downstream and upstream channel change masks associated with the
DOCSIS group.
For example, in the output ‘0x40(1)/Y’, ‘0x40’ indicates that the user
configured the dynamic channel change (DCC) technique 1 for the DOCSIS
LBG. Similarly, '0x80' indicates configured DCC technique 0 and '0x20'
indicates configured DCC technique 2. '(1)' indicates the DCC technique 1
is used to move the cable modem (CM). '/Y' indicates that load balancing
sends upstream channel change (UCC) for movement of US channel only.

Policy DOCSIS policy associated with the load balancing group.

Method Load balancing method used for the load balancing group. The following
indicates what method is used for DS and US modems:
• m = modem
Uses the number of active cable modems on an interface.
• s = service flow
Uses the number of active Service Flow IDs (SFIDs) on an interface.
• u = utilization
Uses the current percent of utilization of an interface.

Cisco CMTS Cable Command Reference

1798
Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

Threshold Thresholds configured for this load balancing group:

• M = Minimum
Minimum difference in the number of cable modems or service flows that
can exist on two interfaces in the group before cable modems are moved
between the interfaces. If the imbalance between interfaces is below this
value, cable modems are not moved. This field contains a value only when
the group is configured for the modems or service flows method of load
balancing. (This value is configured using the load minimum option of the
cable load-balance group threshold command.)
• S = Stability.
Minimum allowable percentage of good periodic ranging requests that is
acceptable. When the channel has a lower percent of modems responding to
the ranging requests in a one minute period, the Cisco CMTS begins moving
modems. The valid range is 0 to 100 percent, with a default of 50 percent.
• E = Enforce
Minimum difference in the percentage of total load that must exist between
interfaces in a load balancing group before the Cisco CMTS performs
dynamic load balancing and begins moving cable modems that are currently
online. When the difference in load between two interfaces falls below this
value, the CMTS stops dynamic load balancing and performs static load
balancing. (This value is configured using the enforce option of the cable
load-balance group threshold command.)
• U = Ugs
Percentage of the bandwidth that is allocated for Unsolicited Grant Services
(UGS) traffic, such as Voice-over-IP (VoIP), that is in use on an interface
because the CMTS moves cable modems that are online with active UGS
service flows. (This value is configured using the ugs option of the cable
load-balance group threshold command.)
• P = PacketCable MultiMedia (PCMM)
Percentage of the reserved bandwidth threshold. Above this level, cable
modems with active PCMM service flows participate in load balancing. The
default threshold is 70%.

Interface Cable interface (downstream or upstream) that belongs to a load balancing

group.

Cisco CMTS Cable Command Reference

1799
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

Utilization Long-term average of the upstream utilization. Displays the current load
usage of the cable interface expressed as a percentage of the total bandwidth.
For upstreams, this field shows a single percentage value, which is the average
percentage of bandwidth being used on the upstream.
For downstreams, this field shows a set of three percentage values:
• The percentage shows the load usage for the entire interface.
• The first percentage, within the parentheses, shows the load for the
downstream.
• The second percentage, within the parentheses, shows the average load
for all upstreams on the downstream.
For example, if this field shows “ 18%(18%/12%) ”, it indicates that
downstream and upstream channels on the interface are running on an average
load of 18 percent. The downstream is running on an average load of 18
percent and all upstreams for this downstream are running on an average
load of 12 percent.
Note
To view the short-term average of the utilization, use the show interface
cable mac-scheduler command.

Cisco CMTS Cable Command Reference

1800
Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

State Current state of the cable interface.

The following states indicate normal operational states, depending on the
configuration:
• down—Interface is shut down. The CMTS cannot use the interface for
load balancing in this state.
• initial—Interface is currently in the initialization phase. The CMTS
uses the interface for load balancing after the initialization completes.
• up—Interface is up and passing traffic. The CMTS actively uses the
interface for load balancing.
• testing—Interface is currently under a load balancing test. The CMTS
is unable to use the interface for normal load balancing operations until
the test completes.
The following states indicate abnormal states. The CMTS does not use
interfaces in these states for load balancing operations, but continues to
monitor and update the status every time the CMTS polls the interfaces for
their current load usage:
• suspicious—Interface is in an unknown state. The interface might be
up and passing traffic, but is not consistent enough to support load
balancing operations. The CMTS attempts to reinitialize the interface
after a time-out period. If the interface has failed initialization more
than 10 times, the CMTS moves the interface to the disabled state.
• disabled—Interface has been disabled because a load balancing test is
in-progress or because the interface reinitialization failed after 10
attempts.
• unstable—Interface has failed repeated initialization attempts. The
CMTS will attempt to reinitialize the interface after a time-out period.
If a load balance test is not in-progress and if reinitialization fails, the
CMTS moves it to the unstable state.

Reserved Percentage of bandwidth that is currently reserved by unsolicited grant service

(UGS) service flows.

Modems Number of cable modems currently online on this cable interface.

Weight Interface bandwidth, in megabits per second (mbps), for the downstream or
upstream. The system uses this value in calculating whether the loads on the
interfaces are balanced. Changing a channel parameter, such as modulation
profile or channel width, affects the channel bandwidth and weight value.

Additional Fields for the target Option

Interface Source downstream or upstream interface that is part of a cable load balancing
group. If the target field contains a value, it indicates that the source interface
is currently oversubscribed.
To reduce the cable load, the CMTS moves cable modems from the source
interface to the target interface.

Cisco CMTS Cable Command Reference

1801
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

Target Downstream or upstream interface to which cable modems on the source

interface are being moved as part of load balancing operations. This field
indicates the following:
• If it is a downstream interface, the display shows the center frequency
of the downstream within parentheses.
• If only a frequency is shown, it indicates that the CMTS is moving cable
modems to a different center frequency on the same downstream
interface.
• When the display includes the words “enforce”, it indicates that the
CMTS is performing dynamic load balancing on the interfaces.
• If this field is blank, it indicates that the source interface is not
oversubscribed.

Additional Fields for the statistics Option

Target interface Downstream or upstream interface. If this is a downstream interface, the

display shows the center frequency of the downstream within parentheses.

Transfers The following information is tracked for the indicated target interface:
• Cmple—Number of cable modems successfully moved to the target
interface.
• Pend—Number of cable modems in the process of being moved to the
target interface.
• Retry—Number of times that the CMTS unsuccessfully tried to move
the same cable modem to the target interface. This occurs when one or
more MAC layer messages to the cable modem are dropped due to radio
frequency (RF) noise or because the modem is not DOCSIS-compliant.
If the number of retries exceeds five for a particular cable modem, the
CMTS counts this as a failure.
• Fail (NB)—Number of cable modems failed to move to narrow band
interface.
• Fail (WB)—Number of cable modems failed to move to wideband
interface.
• Total Attem—Number of times that the CMTS tried to move the same
cable modem to the target interface.
• Max Fail—Number of times that the CMTS exceeded the maximum
number of allowable retries (3) when trying to move a cable modem to
the particular target interface. A large number of failures could indicate
one or more possible problems:
• The specific cable modems are not DOCSIS-compliant.
• One or both interfaces are having problems passing traffic.
• One or both interfaces are having persistent RF noise problems.
• The source and target interfaces are not combined in the same node
and do not share the same physical connectivity (which is required
when interfaces are part the same load balancing group).

Cisco CMTS Cable Command Reference

1802
 Cable Commands: show a through show cable l
show cable load-balance docsis-group

Field Description

Additional Fields for the pending Option

Modem Hardware (MAC) address of the cable modem that is moved as part of load
balancing operations.

Source interface Downstream or upstream cable interface on which the cable modem is
currently online.

Target interface Downstream or upstream cable interface to which the CMTS is trying to
move the cable modem to load balance the interfaces in this load balancing
group. If the CMTS is moving the cable modem to a different frequency on
the same downstream interface, this field shows only the new center
frequency.

Retries Number of times that the CMTS has attempted to move this cable modem
to the target interface. The CMTS attempts to move the cable modem 5 times
before counting this load balancing move as a failure.

Additional Fields for the modem-list option

US Upstream channels in the DOCSIS LBG.

MAC Address Total number (in parentheses) and MAC addresses of the modems connected
to the upstream channels.

Additional fields for the primary-load option

MD MAC Domain.

RCC-ID RCC index per MAC domain.

Pending Number of pending modems on the channel.

Related Commands Command Description

cable load-balance docsis-group Creates a DOCSIS LBG on the Cisco CMTS.

cable load-balance docsis-policy Creates a DOCSIS policy and associates an existing rule and
tag with the policy.

cable load-balance docsis-enable Enables or disables DOCSIS load balancing on the Cisco
CMTS.

cable Enables the DOCSIS 3.0 dynamic load balancing on the Cisco
load-balancedocsis30-dynamic-enable CMTS.

cable load-balance rule Creates a rule to prevent the CM from disabling or enabling
load balancing.

cable tag Creates a tag to associate it with DOCSIS policies and groups.

clear cable load-balance count Clears all of the load balance movement count statistics.

Cisco CMTS Cable Command Reference

1803
 Cable Commands: show a through show cable l
show cable logging

show cable logging

To display the log of messages about bad IP source addresses, downstream indexes, or DOCSIS-layer events
on the cable interfaces, use the show cable logging command in user EXEC or privileged EXEC mode.

show cable logging [badipsource | downstream-index | layer2events | summary] [slot]

Cisco cBR Series Converged Broadband Router

show cable logging [badipsource | downstream-index | layer2events | overlapip | summary]

Syntax Description badipsource Displays the contents of the error log buffer containing the error messages for bad IP
source addresses.

downstream-index Displays the contents of the message log buffer for downstream indexes.

layer2events Displays the contents of the message log buffer for DOCSIS-layer (Layer-2) events.

overlapip Displays the Cable OVERLAPIP messages on the Cisco cBR router.

summary Displays the status of the logging feature and its buffer.

slot (Optional) Slot of a particular cable interface on the Cisco uBR7200 series router. The
slot parameter can range from 3 to 6, depending on the cable interface.
Note
This option is supported only on the Cisco uBR-MC16U/X, Cisco uBR10-MC5X20U,
Cisco uBR10-MC5X20H, and Cisco uBR-MC28U/X cable interface line card.
This variable is not supported on the Cisco cBR router.

Command Modes
User EXEC (>)

Privileged EXEC (#)

Command History Release Modification

12.1(13)EC This command was introduced for the Cisco uBR7100 series and Cisco uBR7200 series
universal broadband routers.

12.2(11)CY Support was added for the Cisco uBR10012 universal broadband router.

12.2(11)BC2 Support was added to the Release 12.2 BC train for the Cisco uBR7100 series, Cisco
uBR7200 series, and Cisco uBR10012 routers.

12.2(15)CX Support was added to display the log buffer on an individual Cisco uBR-MC28U/X cable
interface line card on the Cisco uBR7200 series router.

12.2(15)BC2 Support was added for the Cisco uBR-MC16U/X, Cisco uBR10-MC5X20U, and Cisco
uBR10-MC5X20H cable interface line cards.

Cisco CMTS Cable Command Reference

1804
 Cable Commands: show a through show cable l
show cable logging

Release Modification

12.3(9a)BC The layer2events keyword was added.

12.3(21)BC This command was enhanced to support logging events tracked with the Cable Duplicate
MAC Address Reject feature on the Cisco CMTS, when configured. This supports the
detection of cloned cable modems.

12.2(33)SCA This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco
uBR7225VXR router was added.

12.3(23)BC5 The command output was modified to display the CPU revision number of the line card.

12.2(33)SCB This command was integrated into Cisco IOS Release 12.2(33)SCB.

12.2(33)SCG The downstream-index keyword was added.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines For additional information about the Cable Duplicate MAC Address Reject feature on the Cisco CMTS, or
enforced DOCSIS 1.1 security, see the Cable Duplicate MAC Address Reject for the Cisco CMTS.
The cable logging badipsource command creates a circular buffer that contains the BADIPSOURCE error
messages, which the Cisco CMTS generates when it discovers a CM or CPE device using an unauthorized
IP address. Similarly, the cable logging layer2events command creates a buffer to contain the system messages
that are generated for DOCSIS-layer (Layer2) events. If the BADIPSOURCE or DOCSIS-layer buffer becomes
full, the oldest messages are deleted to make room for the newer messages.
Use the show cable logging command to display the current contents of the BADIPSOURCE,
downstream-index, or DOCSIS-layer buffer. After you have viewed all of the error messages in the current
buffer, use the clear cable logging command to clear out the buffer to make room for newer messages.
Use the show cable logging summary command to check if the logging feature is enabled and also to view
the status of the logging buffer.
The Broadband Processing Engine (BPE) cable interface line cards (such as the Cisco uBR-MC16U/X and
Cisco uBR-MC28U/X) contain an onboard processor that also maintains its own log buffer. To display the
contents of this log, add the card slot number after the show cable logging command.

Note The BADIPSOURCE, downstream-index, and DOCSIS-layer messages are stored in separate buffers. Enabling,
clearing, or displaying one buffer does not affect the other buffer.

Examples This example shows the output of the show cable logging badipsource command. The oldest
messages are displayed first.

Router# show cable logging badipsource

00:01:19: %UBR10000-3-BADIPSOURCE: Interface Cable6/1/1, IP packet from invalid source.
IP=10.44.50.13, MAC=0050.0f02.1d15, Expected SID=1, Actual SID=1
00:01:26: %UBR10000-3-BADIPSOURCE: Interface Cable6/1/1, IP packet from invalid source.
IP=10.44.50.13, MAC=0050.0f02.1d15, Expected SID=1, Actual SID=1
01:49:33: %UBR10000-3-BADIPSOURCE: Interface Cable6/1/0, IP packet from invalid source.
IP=0.0.0.44, MAC=0030.eb00.029d, Expected Interface=Cable6/1/0 SID=2833

Cisco CMTS Cable Command Reference

1805
 Cable Commands: show a through show cable l
show cable logging

02:12:03: %UBR10000-3-BADIPSOURCE: Interface Cable6/1/0, IP packet from invalid source.

IP=0.0.0.44, MAC=0030.eb15.73bd, Expected Interface=Cable6/1/0 SID=2800
02:12:43: %UBR10000-3-BADIPSOURCE: Interface Cable6/1/0, IP packet from invalid source.
IP=0.0.0.44, MAC=00e0.ca01.287a, Expected Interface=Cable6/1/0 SID=3299
02:22:50: %UBR10000-3-BADIPSOURCE: Interface Cable6/1/0, IP packet from invalid source.
IP=0.0.0.44, MAC=0030.eb00.02a2, Expected Interface=Cable6/1/0 SID=394

This example shows the output of the show cable logging badipsource command when logging has
not been enabled with the cable logging badipsource command:

Router# show cable logging badipsource

Cable logging: BADIPSOURCE Disabled

This example shows the output for the downstream-index option, showing whether logging is
enabled, the total size of the buffer, how many bytes are currently used, and how many error messages
have been logged since the buffer was last cleared.

Router# show cable logging summary

Cable logging: Enabled

Total buffer size (bytes): 1000000
Used buffer size (bytes) : 36968
Logged messages : 231

This example shows the output for the summary option, showing whether logging is enabled, the
total size of the buffer, how many bytes are currently used, and how many error messages have been
logged since the buffer was last cleared.

Router# show cable logging summary

Cable logging: BADIPSOURCE Enabled

Total buffer size (bytes): 1000000
Used buffer size (bytes) : 36968
Logged messages : 231

This example shows the output for the summary option, indicating the CPU revision number of the
line card. The display given below is specific to the uBR7200 series routers.

Router# show cable logging summary slot 6

Current LC State Info for slot 6
CLC CPU: BCM1250(Rev A8/A10)
- Status - NO NPE/CLC OIR Timeout detected
Last Process Executed = Per-minute Jobs (4 ms count = 0ms)
Intr Busy Count = 0
Sched Flag Count = 2076
Status = 0x0
Late Poll Etime = 0
LC IPC Reply Status = 0
Interrupted PC/Level Trace
60475E5C/0x0 60475D98/0x0 60406D60/0x0 60406D70/0x0
604754E4/0x0 60335188/0x0 60406D38/0x0 60475E50/0x0
604761DC/0x0 60406D70/0x0 604761DC/0x0 60476994/0x0
60407810/0x0 6047101C/0x0 60470EFC/0x0 60475E5C/0x0
604759C0/0x0 60471014/0x0 60337F04/0x0 60406D4C/0x0
60475E50/0x0 60473EB0/0x0 60475E54/0x0 60476150/0x0
604761D4/0x0 604756FC/0x0 60407810/0x0 60337F80/0x0
60335230/0x0 60475E94/0x0 60406D60/0x0 604756FC/0x0
604761DC/0x0 60475694/0x0 60406CD4/0x0 60470EF0/0x0
60475DBC/0x0 60406D38/0x0 60476954/0x0 604077D0/0x0

Cisco CMTS Cable Command Reference

1806
Cable Commands: show a through show cable l
show cable logging

60406CDC/0x0 60406CE0/0x0 609FA0C0/0x0 60470EFC/0x0

604754DC/0x0 604077F0/0x0 60475E1C/0x0 60471018/0x0
60337F58/0x0 60406D38/0x0 60475694/0x0 60475E3C/0x0
60406D68/0x0 60337F50/0x0 60470EF0/0x0 60406D60/0x0
604756A8/0x0 60406D38/0x0 60475DC4/0x0 60406D48/0x0

Cable logging: BADIPSOURCE Disabled Slot 6

Cable logging: LAYER2EVENTS Disabled Slot 6
Cable logging: OVERLAPIP Disabled Slot 6

This example shows the output from the DOCSIS-layer buffer. This example shows the log buffer
on a BPE cable interface line card that is in slot 4:

Router# show cable logging layer2events slot 4

Cable logging: LAYER2EVENTS Enabled Slot 4

Total buffer size (bytes): 4096
Used buffer size (bytes) : 567
Logged messages : 3
SLOT 4/0: 02:11:42: %UBR7200-4-REG_REJ_AUTH_FAIL_CMTS_MIC_INVALID: <133>CMTS[DOC
SIS]:<73000500> Registration rejected authentication failure: CMTS MIC invalid.
CM Mac Addr <0002.b96f.ff05>
SLOT 4/0: 02:11:53: %UBR7200-4-REG_REJ_AUTH_FAIL_CMTS_MIC_INVALID: <133>CMTS[DOC
SIS]:<73000500> Registration rejected authentication failure: CMTS MIC invalid.
CM Mac Addr <0002.b96f.ff05>
SLOT 4/0: 02:12:05: %UBR7200-4-REG_REJ_AUTH_FAIL_CMTS_MIC_INVALID: <133>CMTS[DOC
SIS]:<73000500> Registration rejected authentication failure: CMTS MIC invalid.
CM Mac Addr <0002.b96f.ff05>

Examples for the Cisco cBR Series Converged Broadband Router

This example shows the output for the show cable logging badipsource command on the Cisco
cBR router:

Router#show cable logging badipsource

Cable logging: BADIPSOURCE Enabled
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: BADIPSOURCE Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Router#

This example shows the output for the show cable logging downstream-index command on the
Cisco cBR router:

Router#show cable logging downstream-index

Cable logging: DS_IDX Enabled
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: DS_IDX Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0

Cisco CMTS Cable Command Reference

1807
 Cable Commands: show a through show cable l
show cable logging

Router#

This example shows the output for the show cable logging layer2events command on the Cisco
cBR router:

Router#show cable logging layer2events

Cable logging: LAYER2EVENTS Enabled
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: LAYER2EVENTS Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 4096
Logged messages : 2380
T: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE: <133>CMTS[DOCSIS]:<73000403> Service unavailable
- Perman
ent. CM Mac Addr <c8fb.26a5.5866>
CLC 3/0: May 26 14:23:31.493 EDT: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.5866>
CLC 3/0: May 26 10:23:33.080 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.56ca>
CLC 3/0: May 26 10:23:33.080 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.56ca>
CLC 3/0: May 26 10:23:33.472 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.5580>
CLC 3/0: May 26 10:23:33.472 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.5580>
CLC 3/0: May 26 10:23:36.647 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.5792>
CLC 3/0: May 26 10:23:36.648 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.5792>
CLC 3/0: May 26 10:23:36.652 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.572e>
CLC 3/0: May 26 10:23:36.652 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.572e>
CLC 3/0: May 26 10:23:37.075 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.54e0>
CLC 3/0: May 26 10:23:37.075 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.54e0>
CLC 3/0: May 26 10:23:37.518 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.52f2>
CLC 3/0: May 26 10:23:37.518 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.52f2>
CLC 3/0: May 26 10:23:39.833 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.5400>
CLC 3/0: May 26 10:23:39.834 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.5400>

Cisco CMTS Cable Command Reference

1808
Cable Commands: show a through show cable l
show cable logging

CLC 3/0: May 26 10:23:40.564 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:

<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.5624>
CLC 3/0: May 26 10:23:40.564 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.5624>
CLC 3/0: May 26 10:23:41.032 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.5814>
CLC 3/0: May 26 10:23:41.032 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.5814>
CLC 3/0: May 26 10:23:41.993 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.56b6>
CLC 3/0: May 26 10:23:41.993 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.56b6>
CLC 3/0: May 26 10:23:42.755 PST: %CBR-4-SERVICE_PERMANENTLY_UNAVAILABLE:
<133>CMTS[DOCSIS]:<7300040
3> Service unavailable - Permanent. CM Mac Addr <c8fb.26a5.5384>
CLC 3/0: May 26 10:23:42.756 PST: %CBR-4-REG_REQ_PERMANENT_ADMINISTRATIVE:
<133>CMTS[DOCSIS]:<730201
03> REG REQ rejected - Permanent administrative . CM Mac Addr <c8fb.26a5.5384>
Router#

This example shows the output for the show cable logging overlapip command on the Cisco
cBR router:

Router#show cable logging overlapip

Cable logging: OVERLAPIP Enabled
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: OVERLAPIP Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Router#

This example shows the output for the show cable logging overlapip command on the Cisco
cBR router:

Router#show cable logging overlapip

Cable logging: OVERLAPIP Enabled
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: OVERLAPIP Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
bruschi#sh cable logging summary
Cable logging: BADIPSOURCE Enabled
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: LAYER2EVENTS Enabled
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0

Cisco CMTS Cable Command Reference

1809
 Cable Commands: show a through show cable l
show cable logging

Cable logging: OVERLAPIP Enabled

Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: DS_IDX Enabled
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: BADIPSOURCE Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: LAYER2EVENTS Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 4096
Logged messages : 2508
Cable logging: OVERLAPIP Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Cable logging: DS_IDX Enabled Slot 3 Subslot 0
Total buffer size (bytes): 4096
Used buffer size (bytes) : 0
Logged messages : 0
Router#

Related Commands cable logging badipsource Logs error messages about bad IP source addresses on the cable interfaces.

cable logging downstream-index Logs messages about the downstream indexes.

cable logging layer2events Logs system messages about DOCSIS-layer events on the Cisco CMTS
router.

cable source-verify Enables verification of IP addresses for CMs and CPE devices on the
upstream.

clear cable logging Removes all error and buffer messages on the cable interfaces from the
corresponding logs.

Cisco CMTS Cable Command Reference

1810
Cable Commands: show cable m to show cable
u
• show cable mac-domain cable forwarding, on page 1816
• show cable mac-domain cable cgd-associations, on page 1818
• show cable mac-domain cable downstream-service-group, on page 1821
• show cable mac-domain cable dpd ocd, on page 1825
• show cable mac-domain cable rcc, on page 1827
• show cable mac-domain cable rcc simplified, on page 1830
• show cable mac-domain cable upstream-service-group, on page 1832
• show cable mac-domain fiber-node , on page 1834
• show cable mac-domain docsis-mode, on page 1836
• show cable mcast-shadow, on page 1838
• show cable metering-status, on page 1840
• show cable modem, on page 1844
• show cable modem access-group, on page 1904
• show cable modem asf, on page 1908
• show cable modem asf sup, on page 1910
• show cable modem auth-profile, on page 1911
• show cable modem calls, on page 1913
• show cable modem classifiers, on page 1916
• show cable modem cnr, on page 1919
• show cable modem connectivity, on page 1928
• show cable modem counters, on page 1933
• show cable modem cpe, on page 1938
• show cable modem docsis device-class, on page 1942
• show cable modem docsis version, on page 1951
• show cable modem docsis version d31-capable, on page 1963
• show cable modem docsis version d40-capable, on page 1965
• show cable modem domain-name, on page 1967
• show cable modem errors, on page 1970
• show cable modem extended-power, on page 1974
• show cable modem fiber-node mac-domain, on page 1976
• show cable modem flap, on page 1977

Cisco CMTS Cable Command Reference

1811
 Cable Commands: show cable m to show cable u

• show cable modem internal load-balance, on page 1983

• show cable modem ipv6, on page 1985
• show cable modem ipv6 summary, on page 1995
• show cable load-balance move-history cable x/y/z, on page 1996
• show cable modem low-latency-capable, on page 1998
• show cable modem mac, on page 1999
• show cable modem maintenance, on page 2011
• show cable modem offline, on page 2017
• show cable modem partial-mode, on page 2027
• show cable modem partial-service, on page 2030
• show cable modem path-sel, on page 2033
• show cable modem phy normalized, on page 2036
• show cable modem phy, on page 2047
• show cable modem phy us-pwr, on page 2058
• show cable modem phy ofdm, on page 2064
• show cable modem phy ofdm-profile, on page 2065
• show cable modem primary-channel, on page 2068
• show cable modem primary-channel summary total, on page 2070
• show cable modem privacy, on page 2073
• show cable modem prof-mgmt, on page 2079
• show cable modem qos, on page 2109
• show cable modem reduction-mode energy-management-mode, on page 2116
• show cable modem reduction-mode energy-management-param, on page 2117
• show cable modem reduction-mode energy-management-status, on page 2118
• show cable modem reduction-mode mta-battery , on page 2119
• show cable modem registered, on page 2120
• show cable modem remote-query, on page 2127
• show cable modem resiliency, on page 2132
• show cable modem rogue, on page 2134
• show cable modem rbg-activity, on page 2138
• show cable modem rpd, on page 2140
• show cable modem rpd all summary, on page 2184
• show cable modem select, on page 2185
• show cable modem service-type-id, on page 2191
• show cable modem service-flow, on page 2193
• show cable modem smp, on page 2208
• show cable modem subscriber, on page 2209
• show cable modem summary, on page 2211
• show cable modem summary scn, on page 2218
• show cable modem summary wb-rf, on page 2219
• show cable modem sysDescr, on page 2222
• show cable modem tcs summary, on page 2225
• show cable modem tftp, on page 2228
• show cable modem timeline, on page 2230
• show cable modem type, on page 2233
• show cable modem unregistered, on page 2237

Cisco CMTS Cable Command Reference

1812
Cable Commands: show cable m to show cable u

• show cable modem vendor, on page 2248

• show cable modem verbose, on page 2255
• show cable modem voice, on page 2269
• show cable modem wideband, on page 2270
• show cable modem wideband phy, on page 2282
• show cable modem wideband primary-channel, on page 2285
• show cable modem wideband rcs-status, on page 2286
• show cable modulation-profile, on page 2291
• show cable multicast authorization, on page 2300
• show cable multicast db, on page 2304
• show cable multicast debug, on page 2310
• show cable multicast dsid, on page 2313
• show cable multicast qos, on page 2318
• show cable multicast ses-cache, on page 2321
• show cable multicast statistics, on page 2326
• show cable noise, on page 2331
• show cable ofdm-chan-profiles, on page 2332
• show cable ofdm-modulation-profiles, on page 2334
• show cable privacy, on page 2336
• show cable profile, on page 2338
• show cable qam-profile, on page 2340
• show cable qos enforce-rule, on page 2342
• show cable qos permission, on page 2347
• show cable qos profile, on page 2349
• show cable rate-adapt, on page 2352
• show cable rate-limit-ccf, on page 2354
• show cable rcp-id, on page 2356
• show cable rcps, on page 2357
• show cable redundancy, on page 2358
• show cable resil-rf-status, on page 2360
• show cable resiliency, on page 2362
• show cable resiliency counts, on page 2364
• show cable resiliency exclude, on page 2365
• show cable resiliency throttled-cm, on page 2366
• show cable rf-adapt, on page 2368
• show cable rf-status, on page 2371
• show cable rpd, on page 2373
• show cable rpd 55d1-us cpp-cache, on page 2377
• show cable rpd alloc-chan-resources, on page 2378
• show cable rpd auxiliary, on page 2379
• show cable rpd capability, on page 2381
• show cable rpd config, on page 2383
• show cable rpd core-ident, on page 2385
• show cable rpd depi, on page 2387
• show cable rpd depi session, on page 2392
• show cable rpd depi tunnel, on page 2396

Cisco CMTS Cable Command Reference

1813
 Cable Commands: show cable m to show cable u

• show cable rpd event, on page 2399

• show cable rpd gcp-session, on page 2400
• show cable rpd gcp-state, on page 2402
• show cable rpd gcp-transaction, on page 2404
• show cable rpd group, on page 2407
• show cable rpd host-resources, on page 2411
• show cable rpd lcce-chan-reach, on page 2413
• show cable rpd identification, on page 2414
• show cable rpd info, on page 2415
• show cable rpd ipv6, on page 2416
• show cable rpd lcha-cores, on page 2417
• show cable rpd location, on page 2419
• show cable rpd md-association, on page 2420
• show cable rpd name, on page 2422
• show cable rpd online, on page 2424
• show cable rpd offline, on page 2426
• show cable rpd pilot-tone, on page 2428
• show cable rpd principal, on page 2430
• show cable rpd sbfd-session, on page 2432
• show cable rpd spectrum-capture-capabilities, on page 2433
• show cable rpd slot, on page 2435
• show cable rpd summary, on page 2436
• show cable rpd tengigabitethernet, on page 2437
• show cable rpd topology, on page 2438
• show cable rpd us-phy channel, on page 2439
• show cable rpd verbose, on page 2441
• show cable rpd version, on page 2443
• show cable rpd sw-version, on page 2444
• show cable rsvp flow-db, on page 2445
• show cable service-class, on page 2447
• show cable service-voice downstream-type, on page 2451
• show cable service-flow summary, on page 2452
• show cable service-flow summary detail, on page 2456
• show cable signal-quality, on page 2458
• show cable snmp cache-status, on page 2462
• show cable spectrum-analysis, on page 2463
• show cable spectrum-group, on page 2466
• show cable subscriber-usage, on page 2469
• show cable tech-support, on page 2473
• show cable throttle-modem, on page 2477
• show cable upstream controller-profile, on page 2479
• show cable upstream service-flow summary, on page 2480
• show cable upstream ofdma mer-fec, on page 2482
• show cable upstream ofdma chan-util, on page 2483
• show cable urm, on page 2484
• show cable us-sg, on page 2490

Cisco CMTS Cable Command Reference

1814
Cable Commands: show cable m to show cable u

• show cable video announce-event-profile, on page 2492

• show cable video encryption, on page 2493
• show cable video encryption dvb, on page 2494
• show cable video encryption linecard, on page 2497
• show cable video encryption pme, on page 2499
• show cable video gqi connections, on page 2501
• show cable video jitter, on page 2502
• show cable video integrated-cable, on page 2503
• show cable video logical-edge-device, on page 2505
• show cable video low-latency linecard, on page 2507
• show cable video output-port, on page 2508
• show cable video scg, on page 2509
• show cable video service-distribution-group, on page 2511
• show cable video session all, on page 2512
• show cable video session logical-edge-device, on page 2514
• show cable video snmp-alarms, on page 2520
• show cable video snmp-alarm-config, on page 2522
• show cable video vei-bundle, on page 2523
• show cable video virtual-carrier-group, on page 2524

Cisco CMTS Cable Command Reference

1815
 Cable Commands: show cable m to show cable u
show cable mac-domain cable forwarding

show cable mac-domain cable forwarding

To display all the interfaces (wideband and modular) and statistics belonging to the Mac domain, use the
show cable mac-domain cable forwarding command in privileged EXEC mode.

show cable mac-domain cable slot/subslot/port forwarding

Syntax Description slot Specifies the chassis slot number of the cable interface line card. The range is from 5 to 8.

subslot Specifies the secondary slot number of the cable interface line card. The range is from 0 or 1.

port Specifies the port number. The range is from 0 to 4 (depending on the cable interface).

forwarding Displays the forwarding statistics for the cable line cards.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(23)BC This command was introduced.

12.2(33)SCA This command is integrated in Cisco IOS Release 12.2(33)SCA.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Usage Guidelines The show cable mac-domain cable forwarding command does not support wideband and modular interfaces.
However, if wideband and modular interfaces belong to the Mac domain, the interfaces are listed in the output
with the interface state.
Starting with Cisco IOS Release 12.2(33)SCF, for a chassis loaded with the UBR-MC20X20V or
uBR-MC3GX60V line cards, and legacy uBR-MC5X20 line cards, the show cable mac-domain cable
forwarding command shall not display the legacy downstream information for the UBR-MC20X20V and
the uBR-MC3GX60V line cards.

Examples The following is sample output of the show cable mac-domain cable forwarding command on the
cable interface at 1/0/0:

Router# show cable mac-domain cable 1/0/0 forwarding

Interface Output Interface Reserved/ Interface
Name Packets Rate Bandwidth Reservable State
(bytes) (bits/sec) (Kbps) Bandwidth
------------------------------------------------------------------------------
Ca1/0/0 201358 0 26000 6500/19500 UP
Mo1/0/0:0 344340 0 4160 1040/3120 UP
Mo1/0/0:1 252132 0 7800 1950/5850 UP
Mo1/0/0:2 252132 0 7800 1950/5850 UP
Wi1/0/0:0 198916 0 7803 1951/5852 UP
Wi1/0/0:1 1152 0 10404 2601/7803 UP

Cisco CMTS Cable Command Reference

1816
Cable Commands: show cable m to show cable u
show cable mac-domain cable forwarding

Table below describes the significant fields shown in the display.

Table 93: show cable mac-domain cable forwarding Field Descriptions

Field Description

Interface Name The name of the interface belonging to Mac domain.

Output Packets/Rate The cumulative packets output and output rate.

Interface Bandwidth The total interface bandwidth allocated.

Reserved/Reservable Bandwidth The total reserved and available bandwidth.

Interface State Indicates whether the interface is up or down.

Cisco CMTS Cable Command Reference

1817
 Cable Commands: show cable m to show cable u
show cable mac-domain cable cgd-associations

show cable mac-domain cable cgd-associations

To display a summary of the Channel Grouping Domain (CGD) associations for all cable MAC domains, use
the show cable mac-domain cgd-associations command in privileged EXEC mode.

Cisco uBR10012 Router

show cable mac-domain cable slot /subslot /port cgd-associations

Cisco uBR7225VXR and Cisco uBR7246VXR Routers

show cable mac-domain cable slot /port cgd-associations

Cisco cBR Series Converged Broadband Router

show cable mac-domain cable slot /port cgd-associations

Syntax Description cable slot /subslot /port Identifies the cable interface on the Cisco uBR10012 router.
• slot —Slot where the line card resides. The range is from 5 to 8.
• subslot —Subslot where the line card resides. The range is from0 or 1.
• port —Downstream controller number on the line card. The range is from 0
to 4.

cable slot /port Identifies the cable interface on the Cisco uBR7246VXR or Cisco uBR7225VXR
router.
• slot —Slot where the line card resides.
• Cisco uBR7246VXR router: The range is from 3 to 6.
• Cisco uBR7225VXR router: The range is from 1 to 2.
• port —Downstream port number on the line card. The range is from 0 or 1.

cable slot /subslot Identifies the cable interface on the Cisco cBR-8 router.
/cable-interface-index
• slot —Slot where the line card resides. The range is from 0 to 3 and 6 to 9.
• subslot —Subslot where the line card resides. The value is 0.
• cable-interface-index —Downstream cable interface index number on the
line card. The range is from 0 to 15.

Command Default None

Command Modes
Privileged EXEC (#)

Command History Release Modification

12.3(23)BC This command was introduced for the Cisco uBR10012 router.

12.2(33)SCB This command was integrated into Cisco IOS Release 12.2(33)SCB. Added support for
Cisco uBR7246VXR and Cisco uBR7225VXR routers.

IOS-XE 3.15.0S This command was implemented on the Cisco cBR Series Converged Broadband Router.

Cisco CMTS Cable Command Reference

1818
 Cable Commands: show cable m to show cable u
show cable mac-domain cable cgd-associations

Usage Guidelines The show cable mac-domain cgd-associations command displays the following information for each cable
MAC domain:
• Shared port adapter (SPA) downstream channels that have been added to each MAC domain.
• Upstream channels associated with each SPA downstream channel and the downstream channels of the
integrated cable interface line card.
If the All column in the command output indicates Y, then this indicates that all upstream channels associated
with the line card downstream channels or SPA downstream channels are configured using the upstream
cable connector command. If all upstream channels are not configured, then this column will not be displayed.
• The SPA downstream channels that are currently active.
A SPA downstream channel is active when the corresponding modular cable interface, which represents the
SPA downstream channel, and its line protocol are up. A SPA downstream channel that is considered active
is an operational primary downstream channel in the cable MAC domain.

Note For more information on Channe