cbl_cr_book

Cisco IOS CMTS Cable Command ReferenceOL-15510-15 July 2012

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

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCBs public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental. Cisco IOS CMTS Cable Command Reference 2007-2012 Cisco Systems, Inc. All rights reserved.

CONTENTS

Document Objectives AudienceCBL-2

CBL-1

Document Organization

CBL-2

Using the Command-Line Interface in Cisco IOS Software CBL-2 Initially Configuring a Device CBL-2 Using the CLI CBL-3 Understanding Command Modes CBL-3 Using the Interactive Help Feature CBL-6 Understanding Command Syntax CBL-7 Understanding Enable and Enable Secret Passwords CBL-8 Using the Command History Feature CBL-9 Abbreviating Commands CBL-10 Using Aliases for CLI Commands CBL-10 Using the no and default Forms of Commands CBL-10 Using the debug Command CBL-11 Filtering Output Using Output Modifiers CBL-11 Understanding CLI Error Messages CBL-12 Saving Changes to a Configuration CBL-12 Additional Information CBL-13 Related Documents CBL-13 Cisco CMTS Hardware Installation and Software Configuration Guides Obtaining Documentation and Submitting a Service Request Cable Commands: a through cable-modem access-deniedCBL-16 CBL-18 CBL-15 CBL-14 CBL-13

activate-rule at-byte-count annex modulation application-id auto-syncCBL-24 CBL-21 CBL-23

cable-modem compliant bridge cable-modem dhcp-proxy

CBL-26

CBL-28 CBL-32

cable-modem downstream saved channel cable-modem fast-searchCBL-34

Cisco IOS CMTS Cable Command Reference OL-15510-15

iii

Contents

cable-modem qos drop-ack cable-modem voip best-effort cable-modem voip clock-internal

CBL-36 CBL-38

cable-modem upstream preamble qpskCBL-39

CBL-41 CBL-43

Cable Commands: cable a through cable c cable acfe enableCBL-44 CBL-45

cable acfe max-bonus-bandwidth cable acfe max-eir-ratio cable admission-controlCBL-46 CBL-47

cable admission-control ds-bandwidth cable admission-control eventCBL-52

CBL-49

cable admission-control max-reserved-bandwidth cable admission-control preempt priority-voice cable admission-control us-bandwidth cable application-type include cable application-type name cable arpCBL-65 CBL-67 CBL-70 CBL-60 CBL-63 CBL-57

CBL-54 CBL-56

cable arp filter cable bgsync

cable attribute-maskCBL-71

cable bgsync active

CBL-72 CBL-74 CBL-77

cable bonding-group-id cable bundle cable clock dti cable clock force cable clock upgrade cable cm-status cable config-fileCBL-79

cable bonding-group-secondary cable clock clear-countersCBL-84

CBL-82

cable clock dti clear-countersCBL-86

CBL-85

cable clock source-midplaneCBL-90

CBL-88

cable cmcpe-list valid-timeCBL-93

CBL-91

cable cm-status enableCBL-98

CBL-95

Cisco IOS CMTS Cable Command Reference

iv

OL-15510-15

Contents

Cable Commands: cable d cable dci-response cable dci-upstream-disable cable default-phy-burst cable deviceCBL-109

CBL-101

CBL-103 CBL-105

CBL-107

cable dfo-retry-count cable dhcp-giaddr cable dhcp-insert

CBL-111

CBL-112 CBL-115 CBL-117 CBL-118 CBL-119

cable dhcp-parse option cable divert-rate-limit cable dot1q-vc-map

cable docsis30-voice downstream req-attr-maskCBL-121 CBL-123 CBL-125

cable downstream annex

cable downstream attribute-mask cable downstream channel-id cable downstream dsg chan-list cable downstream dsg dcd-enable cable downstream dsg disable cable downstream dsg rule cable downstream dsg tg

CBL-126 CBL-128

cable downstream-channel-id automaticCBL-129

CBL-131

CBL-133

CBL-134 CBL-136 CBL-138

cable downstream dsg tg channel cable downstream dsg timer cable downstream frequency cable downstream if-output cable downstream modulation cable downstream override cable downstream rate-limit cable downstream rf-power cable dsgCBL-162 CBL-166

CBL-140 CBL-141

cable downstream dsg vendor-paramCBL-143 CBL-146

cable downstream interleave-depthCBL-151

CBL-148

CBL-150

cable downstream qos wfq weight

CBL-152

CBL-153 CBL-156 CBL-160

cable downstream rf-shutdown cable dsg cfr


v

Contents

cable dsg chan-list cable dsg client-list cable dsg keepalive cable dsg tg

CBL-169 CBL-171 CBL-173 CBL-175

cable dsg name-update-intervalCBL-176 CBL-178

cable dsg tg channel

cable dsg tg channel ucid cable dsg tg default-priority cable dsg tg priority cable dsg timer cable dsg tunnel

CBL-180 CBL-182

cable dsg tg channel vendor-paramCBL-185

CBL-184

CBL-186 CBL-188 CBL-190 CBL-192

cable dsg tunnel srv-class cable dsg vendor param cable ds-max-burst cable ds-resiliency

CBL-194 CBL-196 CBL-197 CBL-199 CBL-200 CBL-207 CBL-209

cable dynamic-bw-sharing cable dynamic-qos trace cable dynamic-secret

cable dynamic-secret exclude

cable dynamic-secret tftp insert-upgrade-server Cable Commands: cable e through cable i cable enable-trap cable event priorityCBL-212 CBL-214 CBL-217 CBL-220

CBL-211

cable event syslog-server cable event throttle-interval

cable event throttle-adminStatus cable event throttle-threshold cable fiber-node cable filter group cable flap-list agingCBL-226 CBL-229 CBL-234

CBL-222 CBL-224

cable flap-list insertion-time cable flap-list miss-threshold cable flap-list sizeCBL-242

CBL-236 CBL-238 CBL-240

cable flap-list power-adjust threshold


vi

OL-15510-15

Contents

cable freq-range

CBL-244 CBL-248 CBL-251 CBL-253

cable helper-address

cable host access-group cable igmp static-group cable init-channel-timeout cable insertion-interval cable intercept cable ip-initCBL-260 CBL-263

cable high-priority-call-windowCBL-255

CBL-257

CBL-258

cable ip-broadcast-echo cable ip-multicast-echo cable ipc-statsCBL-268

CBL-264 CBL-266

cable ipv6 source-verifyCBL-274

CBL-269 CBL-272

cable ipv6 source-verify leasequery-filter downstream

Cable Commands: cable l cable l2vpnCBL-277

CBL-275

cable l2-vpn-service atm-vc cable l2-vpn-service dot1q

CBL-278 CBL-279

cable l2-vpn-service default-nsi cable l2-vpn-service xconnect

CBL-281 CBL-283 CBL-284

cable l2-vpn xconnect backup force-switchover cable linecard auto-rommon-downgrade cable linecard auto-rommon-upgrade cable linecard critical-event-poweroff cable load-balance d20-ggrp-default cable load-balance d30-ggrp-default cable load-balance docsis-enable cable load-balance docsis30-enable cable load-balance docsis-group cable load-balance docsis-policy cable load-balance groupCBL-286 CBL-287 CBL-289 CBL-290 CBL-291 CBL-292

CBL-285

CBL-294 CBL-297

CBL-298 CBL-303 CBL-306

cable load-balance group (interface) cable load-balance group interval

cable load-balance group (Supporting Dynamic Channel Change)CBL-308


vii

Contents

cable load-balance group policy

CBL-310 CBL-312 CBL-314 CBL-319

cable load-balance group policy ugs cable load-balance group threshold

cable load-balance group threshold (Supporting Dynamic Channel Change) cable load-balance modem max-failures cable load-balance restrict modem cable load-balance rule cable logging badipsource cable logging layer2events Cable Commands: cable m cable map-advance cable match address cable max-hostsCBL-323 CBL-325 CBL-328 CBL-321 CBL-322

cable logging downstream-index

CBL-330 CBL-333

CBL-335 CBL-337

CBL-339 CBL-341

cable metering data-per-session cable metering destination cable metering filesystem cable metering ipdr cable metering ipdr-d3

CBL-342 CBL-346

CBL-349 CBL-351 CBL-353

cable metering source-interface cable modem access-group cable modem max-cpe cable modem max-hosts cable modem qos profile cable modem remote-query cable modem vendor cable modem change-frequencyCBL-358 CBL-360

CBL-356 CBL-357

CBL-362 CBL-364 CBL-367

cable modem service-class-nameCBL-369 CBL-371

cable modulation-profile cable monitor cable mrc-mode cable mtc-modeCBL-381 CBL-385 CBL-386

cable modulation-profile global-scheme

CBL-379

cable multicast auth enable default-action cable multicast auth profile-nameCisco IOS CMTS Cable Command Reference

CBL-388

CBL-389

viii

OL-15510-15

Contents

cable multicast group-encryption cable multicast group-qos cable multicast mdf-disable cable multicast qos group cable multicast source cable multicast group-qos default

CBL-390

CBL-391 CBL-393

CBL-395 CBL-397

CBL-399 CBL-401

Cable Commands: cable p through cable r cable powerCBL-403 CBL-406 CBL-409

cable pre-equalization exclude cable primary-sflow-qos11 keep cable privacyCBL-411

cable privacy bpi-plus-enforce cable privacy bpi-plus-exclude cable privacy bpi-plus-policy cable privacy clone-detect cable privacy eae-exclude cable privacy eae-policy cable privacy hotlist cable privacy kek

CBL-414 CBL-416 CBL-417

CBL-419 CBL-420 CBL-421 CBL-423

cable privacy encrypt-alg-priorityCBL-425 CBL-427

cable privacy revocation crl skip-sig-check cable privacy revocation enableCBL-430

CBL-429

cable privacy revocation ocsp skip-sig-check cable privacy revocation skip-cm-cert cable privacy tek cable proxy-arpCBL-433 CBL-435

CBL-431

CBL-432

cable privacy revocation timeoutCBL-436 CBL-438 CBL-441

cable qos enforce-rule cable qos permission

cable qos pre-registration cable qos pro max-ds-burst cable queue-limit cable rcc-template cable rcp-controlCBL-447

CBL-443 CBL-444

cable rate-limit-algorithm min-plus-excessCBL-451 CBL-452

CBL-449


ix

Contents

cable redundancy hashfilter cable redundancy myid cable redundancy node cable redundancy target cable registration-timeout cable relay-agent-option cable resiliency ds-bonding cable rf-adapt timer cable rf-bandwidth-percent cable rf-change-dampen-time cable rf-channelCBL-470

CBL-453

CBL-455 CBL-456 CBL-457

cable redundancy node frequencyCBL-458

cable redundancy threshold

CBL-460 CBL-461 CBL-462 CBL-464

CBL-465 CBL-467 CBL-469

cable rsvp default-scn cable rf-change-triggerCBL-477

CBL-474 CBL-475

Cable Commands: cable s

CBL-479 CBL-480 CBL-482 CBL-484

cable service attribute ds-bonded downstream-type bonding-enabled cable service attribute non-ds-bonded legacy-ranging downstream-type cable service attribute voice-enabled cable service attribute withhold-TLVs cable service classCBL-490 CBL-495 CBL-497 CBL-499 CBL-486 CBL-488

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

cable service flow activity-timeout cable service-flow inactivity-timeout cable service type cable sflogCBL-501

cable service flow inactivity-threshold

cable set mpls-experimentalCBL-503

CBL-502

cable shared-secondary-secret cable shared-secretCBL-508 CBL-511

CBL-505

cable sid-cluster-group cable source-route cable source-verify

cable sid-cluster-switchingCBL-515 CBL-516

CBL-513


x

OL-15510-15

Contents

cable source-verify enable-sav-static cable source-verify groupCBL-523

CBL-521

cable source-verify leasequery-filter downstream cable source-verify leasequery-filter upstream cable spectrum-group (global) cable spectrum-group (interface) cable spectrum-group hop period cable spectrum-group hop threshold cable spectrum-group shared cable submgmt default cable sync-intervalCBL-547 CBL-549 CBL-542 CBL-529 CBL-533 CBL-535 CBL-537

CBL-525 CBL-527

CBL-540

Cable Commands: cable t cable tagCBL-550

cable telco-return enable cable telco-return interval

CBL-552 CBL-554 CBL-556 CBL-558

cable telco-return registration-ip cable telco-return spd dhcp-server cable telco-return spd dial-timer cable telco-return spd manual-dial cable telco-return spd password cable telco-return spd phonenum cable telco-return spd radius-realm cable telco-return spd threshold cable telco-return spd username cable tftp-enforceCBL-582 CBL-587 CBL-589

cable telco-return spd dhcp-authenticateCBL-562

CBL-560

cable telco-return spd factory-default

CBL-564 CBL-566

CBL-568 CBL-570 CBL-572

cable telco-return spd ppp-authenticate cable telco-return spd service-provider

CBL-574 CBL-576

CBL-578 CBL-580

cable throttle-modem cable throttle-ranging cable time-server cable trustCBL-591

CBL-590

cable tx-power-headroom

CBL-593


xi

Contents

Cable Commands: cable u through cable w cable upstream active-codes cable upstream attribute-mask cable upstream bonding-group cable upstream channel-width cable upstream concatenation cable upstream connector cable upstream data-backoff cable upstream description cable upstream docsis-mode cable upstream dponCBL-623 CBL-597 CBL-598

CBL-595

cable upstream admission-control

CBL-602 CBL-603 CBL-604 CBL-608

cable upstream codes-per-minislotCBL-610

CBL-609

CBL-614 CBL-616 CBL-617

cable upstream differential-encodingCBL-618

cable upstream equalization-coefficient cable upstream ext-power cable upstream fec cable upstream fec-strength cable upstream fragmentation cable upstream fragment-force cable upstream frequency cable upstream hop-priorityCBL-631

CBL-625 CBL-629

cable upstream equalization-error-recoveryCBL-632 CBL-633 CBL-634 CBL-636 CBL-639

cable upstream freq-adj averagingCBL-640

cable upstream hopping blind

CBL-643 CBL-645 CBL-647

cable upstream ingress-noise-cancellation cable upstream load-balance group cable upstream maintain-psdCBL-652

CBL-650

cable upstream max-channel-power-off cable upstream max-codes-per-subframe cable upstream max-interleave-step cable upstream max-logical-chans cable upstream max-ports cable upstream minislot-sizeCBL-661 CBL-663

CBL-654 CBL-655

CBL-656 CBL-658

cable upstream modulation-profile

CBL-666


xii

OL-15510-15

Contents

cable upstream power-adjust cable upstream power-level cable upstream qos wfq cable upstream range-backoff cable upstream ranging-poll

CBL-672 CBL-676

CBL-678 CBL-679 CBL-681

cable upstream ranging-init-techniqueCBL-682

cable upstream rate-adapt (global) cable upstream rate-adapt (interface) cable upstream rate-limitCBL-688

CBL-684 CBL-686

cable upstream rate-limit-bwreq exempted-priority cable upstream rate-limit-ccf cable upstream resiliency cable upstream rf-adaptCBL-691 CBL-693 CBL-695 CBL-697

CBL-690

cable upstream rf-adapt (logical channel) cable upstream scheduling type cable upstream scrambler cable upstream shutdown cable upstream snr-pollingCBL-699 CBL-701 CBL-703 CBL-705 CBL-707

cable upstream spectrum-group cable upstream spreading-interval cable upstream threshold

CBL-709

CBL-710 CBL-715 CBL-717

cable upstream threshold hysteresis cable upstream threshold rf-adapt cable upstream timing-adjust cable util-interval cable vc-mapCBL-722

CBL-719 CBL-721

cable upstream unfrag-slot-jitterCBL-723

cable vrf-steering cable-modem cable wideband auto-reset

CBL-725

CBL-726 CBL-729

Cable Commands: ca through cr channel-groupCBL-731

channel-id (cable configuration file) clear cable arp-filterCBL-736 CBL-738

CBL-733 CBL-735

clear cable admission control counters clear cable bgsync counters


xiii

Contents

clear cable dsg clear cable hop clear cable host

CBL-739 CBL-741

clear cable flap-list

CBL-743 CBL-745 CBL-747 CBL-748

clear cable ipc-stats clear cable logging

clear cable load-balance

CBL-750 CBL-752

clear cable modem attribute-masks clear cable modem cm-status clear cable modem counters clear cable modem delete clear cable modem lock clear cable modem name clear cable modem reset clear cable modem rf-adapt clear cable modem voice clear cable rf-status

CBL-754 CBL-756

CBL-758 CBL-761

clear cable modem flap-countersCBL-763 CBL-766

clear cable modem rcs-counts

CBL-768

CBL-770 CBL-773 CBL-775

clear cable modem service-type-idCBL-777

clear cable multicast statistics counterCBL-780 CBL-781

CBL-779

clear cable secondary-ip clear facility-alarm clear hccp counters clear hccp linecard clear packetcable rks clear pxfCBL-793

clear cable modem service-type-idCBL-785 CBL-787 CBL-789 CBL-790

CBL-783

clear packetcable gate counter commit clear pxf statistics drl cable-wan-ip clear pxf statistics drl wan-non-ip clear redundancyCBL-797 CBL-798 CBL-800

CBL-791

CBL-795 CBL-796

controller integrated-cable controller modular-cable cops ip dscpCBL-802


xiv

OL-15510-15

Contents

cops listeners access-list cops tcp window-size cpdCBL-810 CBL-811 CBL-812

CBL-806

CBL-808

cpd cr-id cpe max

Cable Commands: d through h depi cin-failover depi-class depi-tunnel depi eqam-statsCBL-817 CBL-818 CBL-820

CBL-815

CBL-821 CBL-823 CBL-825

description (bonding-group) description (cable fiber-node) dest-ipCBL-826 CBL-827

diagnostic load

diagnostic ondemand action-on-failure diagnostic ondemand iterations diagnostic unload docsis cvc mfg docsis cvc mso docsis cvc test docsis-policy docsis-version download downstreamCBL-835 CBL-837 CBL-839 CBL-841 CBL-843 CBL-844

CBL-830

CBL-832

CBL-845 CBL-847 CBL-849 CBL-851

downstream cable

downstream integrated-cable rf-channel (interface) downstream local upstreamCBL-853

downstream modular-cable rf-channel (interface) downstream modular-cable rf-channel durationCBL-858 CBL-861 CBL-863 CBL-856

CBL-854

enabled (enforce-rule) enforced qos-profile exception pxfCBL-866

facility-alarm (ubr10012) hccp authentication

CBL-868

CBL-871


xv

Contents

hccp authentication key-chain hccp bypass version hccp channel-switch hccp check version hccp ds-switch hccp lockout hccp protect hccp resync hccp revertive hccp reverttime hccp switch hccp timers hccp trackCBL-875 CBL-877 CBL-880

CBL-873

CBL-882 CBL-884 CBL-886

CBL-888 CBL-890 CBL-892

CBL-894 CBL-896 CBL-898 CBL-901 CBL-903 CBL-905 CBL-907 CBL-908

hccp unlockout hccp working hold-queue

hw-module bay reload hw-module slot pos hw-module slot srp

hw-module shutdown (ubr10012)CBL-911 CBL-913

Cable Commands: i through p init-tech-list init-tech-ovr interface cableCBL-918 CBL-919 CBL-921

CBL-915

interface cable-modem interface gigabitethernet interface integrated-cable interface modular-cable interface port-channel interface usb intervalCBL-931

CBL-923 CBL-925 CBL-926 CBL-928

CBL-930

interface wideband-cableCBL-936

CBL-933

ip-address (controller) ip address docsis ip http cable-monitor

CBL-937

CBL-939 CBL-941


xvi

OL-15510-15

Contents

ip http ezvpn ipdr associate ipdr collector

CBL-944 CBL-946

ip-address (controller)CBL-948 CBL-949

ipdr exporter ack-timeout ipdr exporter keepalive ipdr exporter start ipdr session ipdr template ipdr type ipdr exporter max-unacked

CBL-950 CBL-951 CBL-952

CBL-953

CBL-954 CBL-955

ipdr session (global configuration)CBL-956 CBL-958 CBL-960

issu linecard abortversion issu linecard acceptversion issu linecard changeversion issu linecard loadversion issu linecard reloadversion issu linecard runversion issu linecard prepareversion


CBL-970 CBL-971 CBL-973

license feature evaluation disable license feature evaluation enable logging cmts sea mac-address main-cpu match rule methodCBL-979 CBL-981 CBL-975 CBL-977

maintenance-modeCBL-983

member subslotCBL-988

CBL-985

microcode (uBR10012) mode (redundancy) modular-host subslot monitoring-basics monitoring-duration nameCBL-1002

CBL-990 CBL-992

microcode reload (uBR10012)CBL-994 CBL-996

CBL-998 CBL-1000


xvii

Contents

network nls

CBL-1003

CBL-1004 CBL-1005 CBL-1006

nls ag-id auth-key nls resp-timeout ouiCBL-1007

output-rate override option

CBL-1008

CBL-1009 CBL-1010 CBL-1015 CBL-1017

packetcable

packetcable authorize vanilla-docsis-mta packetcable element-idCBL-1019 CBL-1021

packetcable gate maxcount packetcable timer peak-time1 ping docsis policy prefix penalty-periodCBL-1024

packetcable gate send-subscriberIDCBL-1026 CBL-1029

CBL-1023

CBL-1032 CBL-1037

plim qos input mapCBL-1041 CBL-1042

profile-description protect-tunnel privacyCBL-1047

CBL-1044

CBL-1046

Cable Commands: q through sg qos-profile enforced qos-profile registered rcp-idCBL-1056 CBL-1057 CBL-1059 CBL-1051

CBL-1049

CBL-1054

receive-channel receive-module

redundancy force-failover main-cpu redundancy linecard-group redundancy reload redundancy switch-activity registered qos-profile restrictedCBL-1074 CBL-1063 CBL-1068 CBL-1070

CBL-1061

CBL-1072


xviii

OL-15510-15

Contents

revertive

CBL-1075 CBL-1076

rf-channel cable downstream channel-id rf-channel depi-tunnel rf-channel description rf-channel frequencyCBL-1078 CBL-1080 CBL-1082

rf-channel ip-address mac-address udp-port rf-channel network-delay rf-channel rf-power rf-channel stacking secondary aux rf-channel rf-shutdownCBL-1096 CBL-1097 CBL-1098 CBL-1088 CBL-1090 CBL-1093

CBL-1085

CBL-1095

service-class (cmts-tag) service divert-rate-limit service divert-rate-limit ip

service-class (enforce-rule)


service divert-rate-limit ipv6

service divert-rate-limit ip trusted-site service divert-rate-limit trusted-site-ipv6 service divert-rate-limit non-ip service instance service-class service-type-id session-range set clockCBL-1114

CBL-1110 CBL-1112

service divert-rate-limit trusted-site

service udp-small-servers max-servers no-limitCBL-1117 CBL-1119 CBL-1120

CBL-1115

service-type-id (cmts-tag)CBL-1121 CBL-1122

Cable Commands: show a through show cable l show application-buckets show bridge cable-modem show cable acfe controller show cable acfe interface show cable acfe summary show cable active-remanCBL-1127 CBL-1129 CBL-1131 CBL-1133 CBL-1135 CBL-1137 CBL-1140

CBL-1125

show cable admission-control


xix

Contents

show cable arp-filter show cable bgsync show cable bundle

CBL-1148 CBL-1153 CBL-1155 CBL-1158

show cable bundle multicast show cable burst-profile show cable calls show cable clockCBL-1162

CBL-1160

show cable cgd-associationsCBL-1166

CBL-1164

show cable clock dti counters show cable clock dti status show cable dsgCBL-1177 CBL-1181 CBL-1186

CBL-1172 CBL-1173 CBL-1174

show cable device access-group show cable dsg cfr show cable dsg host show cable dsg tg show cable dsg tg

show cable dsg static-group bundleCBL-1190 CBL-1193

CBL-1188

show cable dsg tunnel show cable dsg tunnel show cable fiber-node show cable filter show cable flap-list show cable hop show cable ib-ipc show cable ipc-stats

CBL-1199 CBL-1202 CBL-1209

show cable dynamic-qos traceCBL-1214 CBL-1219

CBL-1211

show cable flap-list wb-rfCBL-1228

CBL-1226

show cable host access-groupCBL-1234 CBL-1235

CBL-1232

show cable l2-vpn dot1q-vc-map show cable l2-vpn vc-map show cable l2-vpn xconnect show cable leasequery-filter show cable licenses all show cable load-balance

CBL-1239

CBL-1244 CBL-1246 CBL-1250

CBL-1253 CBL-1255 CBL-1264

show cable load-balance docsis-group


xx

OL-15510-15

Contents

show cable loggingCBL-1292

CBL-1289

Cable Commands: show cable m through show cable u show cable mac-domain cable forwarding show cable mac-domain cgd-associations show cable mac-domain rcc show cable metering-status show cable modemCBL-1312 CBL-1344 CBL-1348 CBL-1305 CBL-1297 CBL-1299

CBL-1293

show cable mac-domain downstream-service-group show cable mac-domain upstream-service-groupCBL-1309

CBL-1302

CBL-1307

show cable modem access-group show cable modem auth-profile show cable modem calls show cable modem cnr show cable modem classifiers show cable modem connectivity show cable modem counters show cable modem cpeCBL-1372 CBL-1350

CBL-1353

CBL-1356 CBL-1364

CBL-1368

show cable modem docsis device-class show cable modem docsis version show cable modem domain-name show cable modem errors show cable modem flap show cable modem ipv6 show cable modem mac show cable modem offline show cable modem extended-powerCBL-1402 CBL-1407 CBL-1415

CBL-1375

CBL-1381 CBL-1393

CBL-1396 CBL-1400

show cable modem maintenance show cable modem partial-mode show cable modem partial-service show cable modem phyCBL-1443

CBL-1425

CBL-1430 CBL-1439 CBL-1441

show cable modem primary-channel show cable modem privacy show cable modem qosCBL-1454

CBL-1450 CBL-1452

show cable modem primary-channel summary totalCBL-1459


xxi

Contents

show cable modem registered show cable modem resiliency show cable modem rf-adapt show cable modem rogue

CBL-1465 CBL-1471

show cable modem remote-query

CBL-1474 CBL-1476

CBL-1479 CBL-1483 CBL-1485

show cable modem service-type-id show cable modem service-flow show cable modem summary show cable modem summary wb-rf show cable modem tcs summary show cable modem type show cable modem vendor show cable modem voice show cable modem wideband show cable modem unregisteredCBL-1502

CBL-1492 CBL-1498 CBL-1500

CBL-1505


show cable modem wideband phy

show cable modem wideband primary-channel show cable modem wideband rcs-status show cable modulation-profile show cable multicast db show cable multicast dsid show cable multicast qos show cable noise show cable privacyCBL-1535 CBL-1543

CBL-1533

show cable multicast authorizationCBL-1547

show cable multicast debug

CBL-1554 CBL-1557 CBL-1561 CBL-1564

show cable multicast statistics failureCBL-1565 CBL-1566

show cable qos enforce-rule show cable qos permission show cable qos profile show cable rate-adapt show cable rate-limit-ccf show cable redundancy show cable resiliency show cable rf-adaptCBL-1575 CBL-1578

CBL-1568

CBL-1573

CBL-1580 CBL-1582

CBL-1584 CBL-1586


xxii

OL-15510-15

Contents

show cable rf-status

CBL-1589 CBL-1591 CBL-1593 CBL-1597

show cable rsvp flow-db show cable service-class show cable signal-quality

show cable service-voice downstream-typeCBL-1598 CBL-1601 CBL-1603 CBL-1606

show cable spectrum-analysis show cable spectrum-group show cable subscriber-usage show cable tech-support show cable throttle-modem show cable urmCBL-1618 CBL-1620

CBL-1610 CBL-1614 CBL-1616

show cable upstream service-flow summary show cable us-sg

Cable Commands: show ch through show cr show checkpointCBL-1625 CBL-1628 CBL-1634 CBL-1636

CBL-1623

show cmts ipc-cable client base show controller gigabitethernet show controller integrated-cable show controllers cableCBL-1664

show controllers cable jib

CBL-1683 CBL-1690

show controllers cable upstream spectrum show controllers cable-modemCBL-1694

show controllers cable-modem bpkm show controllers cable-modem cmcert show controllers cable-modem filters show controllers cable-modem mac show controllers cable-modem phs show controllers cable-modem phy show controllers cable-modem qos show controllers cable-modem tuner

CBL-1700 CBL-1706

show controllers cable-modem classifiers show controllers cable-modem crypto des show controllers cable-modem lookup-table show controllers cable-modem manuf-cert

CBL-1711 CBL-1713

CBL-1716 CBL-1719

CBL-1723 CBL-1739

CBL-1741 CBL-1745 CBL-1748 CBL-1755

show controllers cable-modem service-flows

CBL-1761


xxiii

Contents

show controllers clock-reference show controllers jacket show controllers usb show cops servers show cpdCBL-1789 CBL-1790 CBL-1769

CBL-1763

show controllers modular-cableCBL-1784 CBL-1787

CBL-1771

show cr10k-rp cable show cr10k-rp queue show cr10k-rp slots

show cr10k-rp controller

CBL-1794


show crypto ca certificates show crypto ca trustpoints

Cable Commands: show d through show i show debug show depiCBL-1811 CBL-1813 CBL-1815 CBL-1823

show depi session show depi tunnel show dhcp

CBL-1826 CBL-1829 CBL-1830 CBL-1834

show diagnostic bootup show diagnostic content show diagnostic result

show diagnostic ood-status show diagnostic schedule show facility-alarm status show frame-clocks show hccp show hccp interface show hccp group show hccp linecard show hw-module bayCBL-1850

CBL-1838 CBL-1843 CBL-1846

CBL-1849

CBL-1861


show hw-module bay oir show interface bundle show interface cable

show hw-module bay transceiverCBL-1880 CBL-1884

show interface cable admission-control reservationCisco IOS CMTS Cable Command Reference

CBL-1890

xxiv

OL-15510-15

Contents

show interface cable cable-monitor show interface cable downstream show interface cable dsg downstream


show interface cable dsg downstream tg show interface cable intercept show interface cable modem show interface cable monitor

show interface cable dynamic-service statisticsCBL-1909

show interface cable mac-schedulerCBL-1920 CBL-1928

CBL-1911

show interface cable multicast-sessions show interface cable privacyCBL-1935

CBL-1930 CBL-1933

show interface cable packetcable statistics show interface cable qos paramset show interface cable service-flow show interface cable sid show interface cable sidCBL-1955 CBL-1964

CBL-1939 CBL-1943

show interface cable signal-quality show interface cable upstream show interface gigabitethernet show interface integrated-cable show interface modular-cable show interface cable upstream debug

CBL-1973

CBL-1975 CBL-1986

CBL-1988 CBL-1990 CBL-1994

show interface integrated-cable queueCBL-1999

show interface modular-cable accounting show interface modular-cable description show interface modular-cable dlm show interface modular-cable downstream show interface modular-cable intercept show interface modular-cable stats

CBL-2001 CBL-2003

CBL-2005 CBL-2007

CBL-2009 CBL-2011

show interface modular-cable multicast-sessionsCBL-2014 CBL-2016 CBL-2018

show interface modular-cable summary show interface modular-cable switching show interface multicast-gcr show interface port-channel show interface rf-statusCBL-2020 CBL-2022

CBL-2025


xxv

Contents

show interface wideband-cable

CBL-2027 CBL-2035

show interface wideband-cable multicast-sessions show interface wideband-cable queue show interfaces cable-modem show ip arp vrfCBL-2050 CBL-2052 CBL-2038 CBL-2043

show ip interface brief show ipdr collector show ipdr exporter show ipdr session

CBL-2054 CBL-2055 CBL-2056 CBL-2058 CBL-2059 CBL-2061

show ipdr session collector show ipdr session template

Cable Commands: show m through show z show nlsCBL-2063 CBL-2064 CBL-2065 CBL-2066 CBL-2069 CBL-2071

show nls ag-id show nls flow

show packetcable cms show packetcable event show packetcable gate

show packetcable gate counter commit show packetcable gate ipv6 show packetcable global show pxf cableCBL-2083 CBL-2088 CBL-2091 CBL-2093 CBL-2096 CBL-2076

CBL-2074

show packetcable gate multimediaCBL-2081

CBL-2079

show pxf cable controller show pxf cable feature show pxf cable interface show pxf cable multicast show pxf cpuCBL-2097

show pxf cpu drl-trusted-sites show pxf cpu queue show pxf cpu statisticsCBL-2117

CBL-2115

show pxf cpu queue wb-spa show pxf cpu statistics drl ipv4 show pxf cpu statistics drl ipv6

CBL-2122

CBL-2125 CBL-2132 CBL-2134 CBL-2136

show pxf cpu statistics drl us-cableCisco IOS CMTS Cable Command Reference

xxvi

OL-15510-15

Contents

show pxf dma show pxf xcm

CBL-2138 CBL-2145

show pxf microcode


show redundancy (ubr10012) show redundancy config-sync show redundancy platform show tech-support show voice port

show running-config interface cableCBL-2165 CBL-2169

Cable Commands: snmp through w snmp managerCBL-2175

CBL-2173

snmp-server enable traps cable

CBL-2177 CBL-2180 CBL-2182

snmp-server enable traps docsis-cm snmp-server enable traps docsis-cmts switchover pxf restart switchover timeout tagCBL-2188 CBL-2184 CBL-2186

test cable dcc (Supporting Dynamic Channel Change) test cable voiceCBL-2192 CBL-2193 CBL-2194 CBL-2195 CBL-2196 CBL-2197 CBL-2198

CBL-2189

test packetcable gate create test packetcable gc gate-alloc

test packetcable gc client-accept test packetcable gc gate-delete test packetcable gc gate-info test packetcable gc initiate threshold timestamp tosCBL-2200 CBL-2201

test packetcable gc gate-set multimediaCBL-2199

CBL-2203 CBL-2204 CBL-2205

tos (multicast qos) upgrade fpga file upstream

upgrade fpga auto-upgradeCBL-2207 CBL-2209

upstream (config-lb-group) upstream cable connector

CBL-2210 CBL-2212


xxvii

Contents

upstream freq-range voice-portCBL-2216

CBL-2214

vrf (multicast qos) weekend duration weekend off weekend peak-time1

CBL-2217 CBL-2218

CBL-2220 CBL-2221 CBL-2223

Appendix A: Cable Debug Commands debug c10k-jacket debug cable debug cable acfeCBL-2225 CBL-2227 CBL-2229 CBL-2233

debug cable acfe filter

debug cable admission-control debug cable arpCBL-2239 CBL-2240 CBL-2242 CBL-2244

CBL-2235 CBL-2237

debug cable admission-control flow-categorization debug cable arp filter debug cable bpiatp debug cable bundle debug cable cm-status debug cable classifiers debug cable cm-ctrl debug cable dbs debug cable dcc debug cable dci debug cable dhcp debug cable dsg debug cable config-file

CBL-2246 CBL-2247

CBL-2249 CBL-2251


debug cable dynamic-qos subscriber debug cable dynamic-qos trace debug cable dynamic-secret debug cable dynsrv debug cable encap debug cable envm debug cable error debug cable flap debug cable fnCBL-2285 CBL-2287 CBL-2289 CBL-2291 CBL-2292 CBL-2294

CBL-2274 CBL-2281


xxviii

OL-15510-15

Contents

debug cable freqhop debug cable interface debug cable ipv6 debug cable l2-vpn debug cable keyman

CBL-2296 CBL-2297

debug cable hw-spectrumCBL-2300

CBL-2298


debug cable load-balance debug cable mac-address debug cable mac-protocol debug cable mac-scheduler debug cable map debug cable mdd debug cable md-sgCBL-2314

debug cable metering

CBL-2316


debug cable multicast counter clear debug cable multicast counter start debug cable multicast counter stop debug cable multicast forwarding debug cable multicast latency debug cable phs debug cable phy debug cable qos debug cable range debug cable receiveCBL-2330 CBL-2331 CBL-2332

CBL-2328

debug cable privacy


debug cable registration debug cable remote-query debug cable reset debug cable rfmib

CBL-2343 CBL-2344 CBL-2346

debug cable service-ds-selection debug cable specmgmt debug cable startalloc debug cable telco-returnCBL-2347 CBL-2348

debug cable subscriber-monitoringCBL-2351

CBL-2349

debug cable telco-return msg

CBL-2352


xxix

Contents

debug cable tlvs debug cable tod debug cable ubg debug cable ucc debug cable ucd

CBL-2353 CBL-2357 CBL-2358

debug cable transmit

CBL-2359 CBL-2361 CBL-2362 CBL-2365 CBL-2366 CBL-2368 CBL-2370

debug cable upconverter debug cable us-adm-ctrl debug cable wbcmts

debug cable wbcmts admission-control debug cable wbcmts resiliency debug cable-modem bpkm debug cable-modem bridge debug cable-modem errorCBL-2373 CBL-2375 CBL-2377 CBL-2379 CBL-2381

CBL-2372

debug cable-modem interrupts debug cable-modem mac log

debug cable-modem mac messages debug cable-modem map debug cable-modem up-dis debug checkpointCBL-2396 CBL-2397 CBL-2392 CBL-2394

CBL-2384 CBL-2389

debug cable-modem mac messages dynsrv

debug cmts ipc-cable base debug cmts ipc-cable client debug cpdCBL-2406 CBL-2407

CBL-2401

debug cr10k-rp debug docsis ssd debug ehsa

debug cr10k-rp dbs-queueCBL-2414 CBL-2416

CBL-2413

debug hccp authentication debug hccp channel-switch debug hccp docsis-recovery debug hccp events debug hccp inter-db debug hccp plane

CBL-2419 CBL-2421 CBL-2423

CBL-2425 CBL-2427

debug hccp fast-failure-detectionCBL-2429 CBL-2431


xxx

OL-15510-15

Contents

debug hccp sync debug hccp timing

CBL-2434 CBL-2437 CBL-2440

debug hw-module all upgrade debug hw-module bay debug nlsCBL-2444

CBL-2442

debug packetcable all debug packetcable cops debug packetcable gate debug packetcable hccp debug packetcable ipc debug pxfCBL-2465


debug packetcable subscriber debug pxf atom debug redundancy debug usbCBL-2470 CBL-2472

CBL-2475 CBL-2477

Appendix B: CMTS Router ROM Monitor Commands

Entering the ROM Monitor CBL-2477 Using the BREAK Signal CBL-2478 Using the Configuration Register CBL-2479 Using the Configuration Register in Global Configuration Mode CBL-2479 Using the Configuration Register in ROM Monitor Mode CBL-2479 Command Conventions ROM Monitor Commands alias boot break confreg cont context dev dir dis frame helpCBL-2482 CBL-2484 CBL-2488 CBL-2490 CBL-2480 CBL-2480

CBL-2493 CBL-2495 CBL-2497

cpu_card_typeCBL-2498 CBL-2500 CBL-2501 CBL-2503 CBL-2505


xxxi

Contents

history meminfo repeat reset set stack sync unalias unset sysreset

CBL-2507 CBL-2509 CBL-2510 CBL-2512

CBL-2514 CBL-2516

show_spd



xxxii

OL-15510-15

IntroductionRevised: July 2012, OL-15510-15

This introduction explains the objectives, intended audience, and organization of the Cisco IOS CMTS Cable Command Reference. It provides the following sections:

Document Objectives, page 1 Audience, page 2 Document Organization, page 2 Using the Command-Line Interface in Cisco IOS Software, page 2 Related Documents, page 13 Obtaining Documentation and Submitting a Service Request, page 14

Document ObjectivesNote

Some of these products have reached End of Sale (EOS) or End of Life (EOL). For more information, refer to the Video, Cable, and Content Delivery End-of-Sale and End-of-Life Products site at: http://www.cisco.com/en/US/products/hw/video/prod_category_end_of_life.html This guide describes the commands necessary to configure, maintain, and troubleshoot the following cable platforms:

Cisco Cable Modem Termination Systems (CMTS) Cisco uBR7200 series universal broadband routers, which include the Cisco uBR7246, the

Cisco uBR7246 VXR, and the Cisco uBR7225VXR routers. Cisco uBR10012 universal broadband router.

Cisco Cable Modems (CMs) and other Cable CPE Devices Cisco uBR904, Cisco uBR905, Cisco uBR924, and Cisco uBR925 cable access routers. Cisco CVA122 and Cisco CVA122E cable voice adapters.

Note

This guide documents only cable-specific commands. For information about all Cisco IOS commands, use the Command Lookup Tool or the Cisco IOS Master Command List, All Releases.


CBL-1

Introduction

AudienceThis book is intended for system administrators and support engineers who configure and maintain the cable CMTS and CM devices.

Document OrganizationThis book is organized alphabetically. The first page of each chapter provides a command summary of all commands included in that chapter, as well as identification of any new, modified, obsolete, or replaced commands. Debug commands and ROM monitor commands are included in separate appendixes at the end of the book.

Using the Command-Line Interface in Cisco IOS SoftwareThis section provides basic information about the command-line interface (CLI) in Cisco IOS software and how you can use some of the CLI features.

Initially Configuring a Device, page 2 Using the CLI, page 3 Saving Changes to a Configuration, page 12 Additional Information, page 13

For more information about using the CLI, see the Using the Cisco IOS Command-Line Interface section of the Cisco IOS Configuration Fundamentals Configuration Guide. For information about the software documentation set, see the About Cisco IOS Software Documentation document.

Initially Configuring a DeviceInitially configuring a device varies by platform. For information about performing an initial configuration, see the hardware installation documentation that is provided with the original packaging of the product or go to the Product/Technologies Support area of Cisco.com at http://www.cisco.com/go/techdocs. After you have performed the initial configuration and connected the device to your network, you can configure the device by using the console port or a remote access method, such as Telnet or Secure Shell (SSH), to access the CLI or by using the configuration method provided on the device, such as Security Device Manager.


CBL-2

OL-15510-15

Introduction

Changing the Default Settings for a Console or AUX Port

There are only two changes that you can make to a console port and an AUX port:

Change the port speed with the config-register 0x command. Changing the port speed is not recommended. The well-known default speed is 9600. Change the behavior of the port; for example, by adding a password or changing the timeout value.

Note

The AUX port on the Route Processor (RP) installed in a Cisco ASR 1000 series router does not serve any useful customer purpose and should be accessed only under the advisement of a customer support representative.

Using the CLIThis section describes the following topics:

Understanding Command Modes, page 3 Using the Interactive Help Feature, page 6 Understanding Command Syntax, page 7 Understanding Enable and Enable Secret Passwords, page 8 Using the Command History Feature, page 9 Abbreviating Commands, page 10 Using Aliases for CLI Commands, page 10 Using the no and default Forms of Commands, page 10 Using the debug Command, page 11 Filtering Output Using Output Modifiers, page 11 Understanding CLI Error Messages, page 12

Understanding Command ModesThe CLI command mode structure is hierarchical, and each mode supports a set of specific commands. This section describes the most common of the many modes that exist. Table 1 lists common command modes with associated CLI prompts, access and exit methods, and a brief description of how each mode is used.


CBL-3

Introduction

Table 1

CLI Command Modes

Command Mode User EXEC

Access Method Log in.

PromptRouter>

Exit Method Issue the logout or exit command.

Mode Usage

Change terminal settings. Perform basic tests. Display device status. Issue show and debug commands. Copy images to the device. Reload the device. Manage device configuration files. Manage device file systems.

Privileged EXEC From user EXEC mode, issue the enable command.

Router#

Issue the disable command or the exit command to return to user EXEC mode.

Global configuration

From privileged EXEC Router(config)# mode, issue the configure terminal command. From global configuration mode, issue the interface command.Router(config-if)#

Issue the exit command Configure the device. or the end command to return to privileged EXEC mode. Issue the exit command Configure individual interfaces. to return to global configuration mode or the end command to return to privileged EXEC mode. Issue the exit command Configure individual terminal lines. to return to global configuration mode or the end command to return to privileged EXEC mode.

Interface configuration

Line configuration

From global configuration mode, issue the line vty or line console command.

Router(config-line)#


CBL-4

OL-15510-15

Introduction

Table 1

CLI Command Modes (continued)

Command Mode ROM monitor

Access Method From privileged EXEC mode, issue the reload command. Press the Break key during the first 60 seconds while the system is booting.

Promptrommon # >

Exit Method Issue the continue command.

Mode Usage

The # symbol represents the line number and increments at each prompt.

Run as the default operating mode when a valid image cannot be loaded. Access the fall-back procedure for loading an image when the device lacks a valid image and cannot be booted. Perform password recovery when a Ctrl-Break sequence is issued within 60 seconds of a power-on or reload event. Inspect various states on the router, including the Cisco IOS state. Replace or roll back the configuration. Provide methods of restarting the Cisco IOS software or other processes. Reboot hardware (such as the entire router, an RP, an ESP, a SIP, a SPA) or other hardware components. Transfer files into or off of the router using remote access methods such as FTP, TFTP, and SCP.

Diagnostic (available only on Cisco ASR 1000 series routers)

Router(diag)# The router boots or enters diagnostic mode in the following scenarios. When a Cisco IOS process or processes fail, in most scenarios the router will reload.

If a Cisco IOS process failure is the reason for entering diagnostic mode, the failure must be resolved and the router must be rebooted to exit diagnostic mode. If the router is in diagnostic mode because of a transport-map configuration, access the router through another port or use a method that is configured to connect to the Cisco IOS CLI. If the RP auxiliary port was used to access the router, use another port for access. Accessing the router through the auxiliary port is not useful for customer purposes.

A user-configured access policy was configured using the transport-map command, which directed the user into diagnostic mode. The router was accessed using an RP auxiliary port. A break signal (Ctrl-C, Ctrl-Shift-6, or the send break command) was entered, and the router was configured to enter diagnostic mode when the break signal was received.


CBL-5

Introduction

EXEC commands are not saved when the software reboots. Commands that you issue in a configuration mode can be saved to the startup configuration. If you save the running configuration to the startup configuration, these commands will execute when the software is rebooted. Global configuration mode is the highest level of configuration mode. From global configuration mode, you can enter a variety of other configuration modes, including protocol-specific modes. ROM monitor mode is a separate mode that is used when the software cannot load properly. If a valid software image is not found when the software boots or if the configuration file is corrupted at startup, the software might enter ROM monitor mode. Use the question symbol (?) to view the commands that you can use while the device is in ROM monitor mode.rommon 1 > ? alias boot confreg cont context cookie . . . rommon 2 > set and display aliases command boot up an external process configuration register utility continue executing a downloaded image display the context of a loaded image display contents of cookie PROM in hex

The following example shows how the command prompt changes to indicate a different command mode:Router> enable Router# configure terminal Router(config)# interface ethernet 1/1 Router(config-if)# ethernet Router(config-line)# exit Router(config)# end Router#

Note

A keyboard alternative to the end command is Ctrl-Z.

Using the Interactive Help FeatureThe CLI includes an interactive Help feature. Table 2 describes the purpose of the CLI interactive Help commands.Table 2 CLI Interactive Help Commands

Command help ? partial command? partial command command ? command keyword ?

Purpose Provides a brief description of the Help feature in any command mode. Lists all commands available for a particular command mode. Provides a list of commands that begin with the character string (no space between the command and the question mark). Completes a partial command name (no space between the command and ). Lists the keywords, arguments, or both associated with the command (space between the command and the question mark). Lists the arguments that are associated with the keyword (space between the keyword and the question mark).


CBL-6

OL-15510-15

Introduction

The following examples show how to use the help commands:helpRouter> help Help may be requested at any point in a command by entering a question mark '?'. If nothing matches, the help list will be empty and you must backup until entering a '?' shows the available options. Two styles of help are provided: 1. Full help is available when you are ready to enter a command argument (e.g. 'show ?') and describes each possible argument. 2. Partial help is provided when an abbreviated argument is entered and you want to know what arguments match the input (e.g. 'show pr?'.)

?Router# ? Exec commands: access-enable access-profile access-template alps archive

Create a temporary access-List entry Apply user-profile to interface Create a temporary access-List entry ALPS exec commands manage archive files

partial command?Router(config)# zo? zone zone-pair

partial commandRouter(config)# we webvpn

command ?Router(config-if)# pppoe ? enable Enable pppoe max-sessions Maximum PPPOE sessions

command keyword ?Router(config-if)# pppoe enable ? group attach a BBA group

Understanding Command SyntaxCommand syntax is the format in which a command should be entered in the CLI. Commands include the name of the command, keywords, and arguments. Keywords are alphanumeric strings that are used literally. Arguments are placeholders for values that a user must supply. Keywords and arguments may be required or optional. Specific conventions convey information about syntax and command elements. Table 3 describes these conventions.


CBL-7

Introduction

Table 3

CLI Syntax Conventions

Symbol/Text < > (angle brackets) A.B.C.D.

Function Indicate that the option is an argument. Indicates that you must enter a dotted decimal IP address. Indicates that you must enter one word. Indicates that you must enter more than one word.

Notes Sometimes arguments are displayed without angle brackets. Angle brackets (< >) are not always used to indicate that an IP address is an argument. Angle brackets (< >) are not always used to indicate that a WORD is an argument. Angle brackets (< >) are not always used to indicate that a LINE is an argument.

WORD (all capital letters)

LINE (all capital letters)

(carriage return)

Indicates the end of the list of available keywords and arguments, and also indicates when keywords and arguments are optional. When is the only option, you have reached the end of the branch or the end of the command if the command has only one branch.

The following examples show syntax conventions:Router(config)# ethernet cfm domain WORD domain name Router(config)# ethernet cfm domain level Router(config)# ethernet cfm domain maintenance level number Router(config)# ethernet cfm domain ? dname ? dname level ? dname level 7 ?

Router(config)# snmp-server file-transfer access-group 10 ? protocol protocol options Router(config)# logging host ? Hostname or A.B.C.D IP address of the syslog server ipv6 Configure IPv6 syslog server

Understanding Enable and Enable Secret PasswordsSome privileged EXEC commands are used for actions that impact the system, and it is recommended that you set a password for these commands to prevent unauthorized use. Two types of passwords, enable (not encrypted) and enable secret (encrypted), can be set. The following commands set these passwords and are issued in global configuration mode:

enable password enable secret password


CBL-8

OL-15510-15

Introduction

Using an enable secret password is recommended because it is encrypted and more secure than the enable password. When you use an enable secret password, text is encrypted (unreadable) before it is written to the config.text file. When you use an enable password, the text is written as entered (readable) to the config.text file. Each type of password is case sensitive, can contain from 1 to 25 uppercase and lowercase alphanumeric characters, and can start with a numeral. Spaces are also valid password characters; for example, two words is a valid password. Leading spaces are ignored, but trailing spaces are recognized.

Note

Both password commands have numeric keywords that are single integer values. If you choose a numeral for the first character of your password followed by a space, the system will read the number as if it were the numeric keyword and not as part of your password. When both passwords are set, the enable secret password takes precedence over the enable password. To remove a password, use the no form of the commands: no enable password or no enable secret password. For more information about password recovery procedures for Cisco products, see the following: http://www.cisco.com/en/US/products/sw/iosswrel/ps1831/ products_tech_note09186a00801746e6.shtml

Using the Command History FeatureThe command history feature saves, in a command history buffer, the commands that you enter during a session. The default number of saved commands is 10, but the number is configurable within the range of 0 to 256. This command history feature is particularly useful for recalling long or complex commands. To change the number of commands saved in the history buffer for a terminal session, issue the terminal history size command:Router# terminal history size num

A command history buffer is also available in line configuration mode with the same default and configuration options. To set the command history buffer size for a terminal session in line configuration mode, issue the history command:Router(config-line)# history [size num]

To recall commands from the history buffer, use the following methods:

Press Ctrl-P or the Up Arrow keyRecalls commands beginning with the most recent command. Repeat the key sequence to recall successively older commands. Press Ctrl-N or the Down Arrow keyRecalls the most recent commands in the history buffer after they have been recalled using Ctrl-P or the Up Arrow key. Repeat the key sequence to recall successively more recent commands.

Note

The arrow keys function only on ANSI-compatible terminals such as the VT100.

Issue the show history command in user EXEC or privileged EXEC modeLists the most recent commands that you entered. The number of commands that are displayed is determined by the setting of the terminal history size and history commands.


CBL-9

Introduction

The command history feature is enabled by default. To disable this feature for a terminal session, issue the terminal no history command in user EXEC or privileged EXEC mode or the no history command in line configuration mode.

Abbreviating CommandsTyping a complete command name is not always required for the command to execute. The CLI recognizes an abbreviated command when the abbreviation contains enough characters to uniquely identify the command. For example, the show version command can be abbreviated as sh ver. It cannot be abbreviated as s ver because s could mean show, set, or systat. The sh v abbreviation also is not valid because the show command has vrrp as a keyword in addition to version. (Command and keyword examples are from Cisco IOS Release 12.4(13)T.)

Using Aliases for CLI CommandsTo save time and the repetition of entering the same command multiple times, you can use a command alias. An alias can be configured to do anything that can be done at the command line, but an alias cannot move between modes, type in passwords, or perform any interactive functions. Table 4 shows the default command aliases.Table 4 Default Command Aliases

Command Alias h lo p s u or un w

Original Command help logout ping show undebug where

To create a command alias, issue the alias command in global configuration mode. The syntax of the command is alias mode command-alias original-command. Following are some examples:

Router(config)# alias exec prt partitionprivileged EXEC mode Router(config)# alias configure sb source-bridgeglobal configuration mode Router(config)# alias interface rl rate-limitinterface configuration mode

To view both default and user-created aliases, run the show alias command.

Using the no and default Forms of CommandsMost configuration commands have a no form that is used to reset a command to its default value or to disable a feature or function. For example, the ip routing command is enabled by default. To disable this command, you would issue the no ip routing command. To re-enable IP routing, you would issue the ip routing command. Configuration commands may also have a default form, which returns the command settings to their default values. For commands that are disabled by default, using the default form has the same effect as using the no form of the command. For commands that are enabled by default and have default settings,


CBL-10

OL-15510-15

Introduction

the default form enables the command and returns the settings to their default values. To see what default commands are available on your system, enter default ? in the appropriate command mode of the command-line interface. The no form is documented in the command pages of Cisco IOS command references. The default form is generally documented in the command pages only when the default form performs a function different than that of the plain and no forms of the command. Command pages often include a Command Default section as well. The Command Default section documents the state of the configuration if the command is not used (for configuration commands) or the outcome of using the command if none of the optional keywords or arguments is specified (for EXEC commands).

Using the debug CommandA debug command produces extensive output that helps you troubleshoot problems in your network. These commands are available for many features and functions within Cisco IOS software. Some debug commands are debug all, debug aaa accounting, and debug mpls packets. To use debug commands during a Telnet session with a device, you must first enter the terminal monitor command. To turn off debugging completely, you must enter the undebug all command. For more information about debug commands, see the Cisco IOS Debug Command Reference: http://www.cisco.com/en/US/docs/ios/debug/command/reference/db_book.html

Caution

Debugging is a high priority and high CPU utilization process that can render your device unusable. Use debug commands only to troubleshoot specific problems. The best times to run debugging are during periods of low network traffic and when few users are interacting with the network. Debugging during these periods decreases the likelihood that the debug command processing overhead will affect network performance or user access or response times.

Filtering Output Using Output ModifiersMany commands produce lengthy output that may use several screens to display. Using output modifiers, you can filter this output to show only the information that you want to see. The following three output modifiers are available:

begin regular-expressionDisplays the first line in which a match of the regular expression is found and all lines that follow. include regular-expressionDisplays all lines in which a match of the regular expression is found. exclude regular-expressionDisplays all lines except those in which a match of the regular expression is found.

To use one of these output modifiers, type the command followed by the pipe symbol (|), the modifier, and the regular expression that you want to search for or filter. A regular expression is a case-sensitive alphanumeric pattern. It can be a single character or number, a phrase, or a more complex string. The following example illustrates how to filter output of the show interface command to display only lines that include the expression protocol.Router# show interface | include protocol FastEthernet0/0 is up, line protocol is up Serial4/0 is up, line protocol is up Serial4/1 is up, line protocol is up


CBL-11

Introduction

Serial4/2 is administratively down, line protocol is down Serial4/3 is administratively down, line protocol is down

Understanding CLI Error MessagesYou may encounter some error messages while using the CLI. Table 5 shows the common CLI error messages.Table 5 Common CLI Error Messages

Error Message % Ambiguous command: show con

Meaning

How to Get Help

You did not enter enough Reenter the command followed by a characters for the command to space and a question mark (?). The be recognized. keywords that you are allowed to enter for the command appear. You did not enter all the keywords or values required by the command. Reenter the command followed by a space and a question mark (?). The keywords that you are allowed to enter for the command appear. Enter a question mark (?) to display all the commands that are available in this command mode. The keywords that you are allowed to enter for the command appear.

% Incomplete command.

% Invalid input detected at ^ You entered the command inmarker. correctly. The caret (^) marks the point of the error.

For more system error messages, see the Cisco IOS Release 12.4T System Message Guide.

Saving Changes to a ConfigurationTo save changes that you made to the configuration of a device, you must issue the copy running-config startup-config command or the copy system:running-config nvram:startup-config command. When you issue these commands, the configuration changes that you made are saved to the startup configuration and saved when the software reloads or power to the device is turned off or interrupted. The following example shows the syntax of the copy running-config startup-config command:Router# copy running-config startup-config Destination filename [startup-config]?

You press Enter to accept the startup-config filename (the default), or type a new filename and then press Enter to accept that name. The following output is displayed indicating that the configuration was saved.Building configuration... [OK] Router#

On most platforms, the configuration is saved to NVRAM. On platforms with a Class A flash file system, the configuration is saved to the location specified by the CONFIG_FILE environment variable. The CONFIG_FILE variable defaults to NVRAM.


CBL-12

OL-15510-15

Introduction

Additional Information

Using the Cisco IOS Command-Line Interface section of the Cisco IOS Configuration Fundamentals Configuration Guide http://www.cisco.com/en/US/docs/ios/fundamentals/configuration/guide/cf_cli-basics.html

Cisco Product/Technology Support http://www.cisco.com/go/techdocs Support area on Cisco.com (also search for documentation by task or product) http://www.cisco.com/en/US/support/index.html Software Download Center (downloads; tools; licensing, registration, advisory, and general information) (requires Cisco.com user ID and password) http://www.cisco.com/kobayashi/sw-center/ Error Message Decoder, a tool to help you research and resolve error messages for Cisco IOS software http://www.cisco.com/pcgi-bin/Support/Errordecoder/index.cgi Command Lookup Tool, a tool to help you find detailed descriptions of Cisco IOS commands (requires Cisco.com user ID and password) http://tools.cisco.com/Support/CLILookup Output Interpreter, a troubleshooting tool that analyzes command output of supported show commands https://www.cisco.com/pcgi-bin/Support/OutputInterpreter/home.pl

Related DocumentsThis section lists the other documents that provide more detailed hardware and software information about the Cisco CMTS routers and Cisco Cable CPE devices documented in this guide. These documents are available on Cisco.com and the customer documentation CD-ROM.

Cisco CMTS Hardware Installation and Software Configuration GuidesFor detailed information about the Cisco CMTS platforms, see the following documents:

Cisco uBR7200 Series Universal Broadband Router Hardware Installation Guide Cisco uBR7200 Series Software Configuration Guide Cisco uBR10012 Universal Broadband Router Hardware Installation Guide Cisco uBR10012 Universal Broadband Router Software Configuration Guide Cisco IOS CMTS Cable Software Configuration Guide Cisco Cable Modem Termination System Feature Guide Network Processing Engine and Network Services Engine Installation and Configuration Upgrading to the Cisco uBR7246 VXR Universal Broadband Router


CBL-13

Introduction

Obtaining Documentation and Submitting a Service RequestFor information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly Whats New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html Subscribe to the Whats New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.


CBL-14

OL-15510-15

Cable Commands: a through cable-modemRevised: July 2012, OL-15510-15 New Commands

Command application-idObsolete Commands

Cisco IOS Software Release 12.2(33)SCA

Command activate-rule-at-byte-count auto-syncReplaced Commands

Effective Cisco IOS Release 12.3(9a)BC 12.2(33)SCA

Command annex modulation

Replacement Command rf-channel frequency

Effective Cisco IOS Release 12.3(23)BC


CBL-15

Cable Commands: a through cable-modem access-denied

access-deniedTo 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-denied command 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 (no access-denied).

Command Modes

Cable config-file configuration (config-file)

Command History

Release 12.1(2)EC1

Modification This command was introduced.

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

Usage Guidelines

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 cable config-file channel-id cpe max download

Description Creates a DOCSIS configuration file and enters configuration file mode. Specifies upstream channel ID. Specifies customer premise equipment information. Specifies download information for the configuration file.


CBL-16

OL-15510-15

Cable Commands: a through cable-modem access-denied

Command frequency option privacy service-class snmp manager timestamp

Description Specifies the downstream frequency. Specifies vendor-specific information fields in a DOCSIS configuration file. Specifies privacy options for baseline privacy images. Specifies service class definitions for the configuration file. Specifies Simple Network Management Protocol (SNMP) options. Enables time-stamp generation.


CBL-17

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

activate-rule at-byte-countNote

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 upstream enforce

Specifies that the kilobyte count applies to traffic in the downstream direction. Specifies that the kilobyte count applies to traffic in the upstream direction. The default value is upstream. (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 12.3(9a)BC

Modification This command was removed.

12.2(15)BC1 This command was introduced.

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.


CBL-18

OL-15510-15


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 enforced command). 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 rules 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

Related Commands

Command cable qos enforce-rule

Description Creates an enforce-rule to enforce a particular QoS profile for subscriber traffic management and enters enforce-rule configuration mode. Activates an enforce-rule and begins subscriber traffic management on a Cisco CMTS router. Specifies the time period and sample rate to be used for monitoring subscribers.

enabled (enforce-rule) duration


CBL-19


Command penalty-period qos-profile enforced qos-profile registered show cable qos enforce-rule

Description Specifies the time period that an enforced QoS profile should be in effect for subscribers that violate their registered QoS profiles. Specifies a QoS profile that should be enforced when users violate their registered QoS profiles. Specifies the registered QoS profile that should be used for this enforce-rule. Displays the QoS enforce-rules that are currently defined.

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


CBL-20

OL-15510-15

Cable Commands: a through cable-modem annex modulation

annex modulationNote

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:

AAnnex A. The downstream is compatible with the European MPEG framing format specified in ITU-TJ.83 Annex A. BAnnex B. The downstream is compatible with the North American MPEG framing format specified in ITU-TJ.83 Annex B. 64qam64-QAM modulation. 256qam256-QAM modulation.

{64qam | 256qam}

Specifies the modulation rate:

rf-start-index rf-end-index

(Optional) Specifies the start and end indexes for RF channels. The following values are allowed:

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

Command History

Release 12.3(21)BC 12.3(23)BC

Modification This command was introduced for the Cisco uBR10012 router. This command was made obsolete and annex and modulation were included as keyword options in the rf-channel frequency command.

Usage Guidelines

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

Annex (MPEG framing format)


CBL-21

Cable Commands: a through cable-modem annex modulation

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 cable rf-channel controller modular-cable ip-address (controller) modular-host subslot rf-channel frequency

Description Associates an RF channel on a Wideband SPA with a wideband channel. Enters controller configuration mode to configure the Wideband SPA controller. Sets the IP address of the Wideband SPA FPGA. Specifies the modular-host line card. Sets the frequency for each RF channel.

rf-channel ip-address mac-address udp-port Sets the IP address, MAC address and UDP port for each RF channel. rf-channel network delay rf-channel description rf-channel cable downstream channel-id Specifies the CIN delay for each RF channel. Specifies the description for each RF channel. Assigns a downstream channel ID to an RF channel.


CBL-22

OL-15510-15

Cable Commands: a through cable-modem application-id

application-idTo 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 165535.

Command Default

Multicast QoS group application type is not identified.

Command Modes

Multicast QoS configuration (config-mqos)

Command History

Release 12.2(33)SCA

Modification This command was introduced.

Usage Guidelines

In order 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

Related Commands

Command cable multicast qos group show interface bundle multicast-sessions show interface cable multicast-sessions

Description Specifies and configures a cable multicast QoS group. Displays multicast session information for a specific virtual cable bundle. Displays multicast session information for a specific cable interface.


CBL-23

Cable Commands: a through cable-modem auto-sync

auto-syncTo enable automatic synchronization of the configuration files in NVRAM, use the auto-sync command in main-cpu redundancy configuration mode. To disable automatic synchronization, use the no form of this command. auto-sync {startup-config | config-register | bootvar | running-config | standard} no auto-sync {startup-config | config-register | bootvar | standard}

Syntax Description

startup-config config-register bootvar

Specifies synchronization of the startup configuration files. Specifies synchronization of the configuration register values. Specifies synchronization of the following boot variables:

BOOTSet by the boot system device:filename command. CONFIG_FILESet by the boot config device:filename command. BOOTLDRSet by the boot bootldr device:filename command.

running-config standard

Specifies synchronization of the running configuration files. Specifies synchronization of all of the system files (startup configuration, boot variables, and config configuration registers).

Defaults

For the Performance Routing Engines (PREs) on the Cisco uBR10012 universal broadband router, the system defaults to synchronizing all system files on the (auto-sync standard). For the Supervisor Engines on the Cisco 7600 series routers, the system defaults to synchronizing the running configuration. (running-config).

Command Modes

Redundancy configuration (config-r)

Command History

Release 12.2(4)XF1 12.2(14)SX 12.2(17d)SXB 12.2(18)SXD 12.3BC 12.2(33)SCA

Modification This command was introduced on the Cisco uBR10012 universal broadband router. This command was integrated into the Supervisor Engine 720. Support was added for the Supervisor Engine 2. Support for this command on the Cisco 7600 series routers was removed. This command was integrated into Cisco IOS Release 12.3BC for the Cisco uBR10012 router. This command is obsolete on the Cisco uBR10012 universal broadband router.

Usage Guidelines

Cisco 7600 Series Routers

If you enter the no auto-sync standard command, no automatic synchronizations occur. If you want to enable any of the keywords, you have to enter the appropriate command for each keyword. The auto-sync command is not supported in RPR+ mode.


CBL-24

OL-15510-15

Cable Commands: a through cable-modem auto-sync

Cisco uBR10012 Universal Broadband Router

By default, the system synchronizes all system files, which is the typical setting for most applications. However, you might want exclude certain files from synchronization for specialized applications. For example, if you have configured the active and standby PRE1 (or PRE2) modules to run different versions of Cisco IOS software, you might want to use different configuration files as well. In this case, you would not synchronize the startup configuration file.

Examples

Cisco 7600 Series Routers

The following example shows how (from the default configuration) to enable automatic synchronization of the configuration register in the main CPU:Router# configure terminal Router (config)# redundancy Router (config-r)# main-cpu Router (config-r-mc)# no auto-sync standard Router (config-r-mc)# auto-sync config-register

Cisco uBR10012 Universal Broadband Router

The following example shows the syst