BSR 64000 Command Reference Guide (Rel 4.2.0) 1

Descargar como pdf o txt
Descargar como pdf o txt
Está en la página 1de 1486

BSR 64000

Command
Reference Guide

Compass ID: 188656176 Version 5


Release 4.2.0
MGBI
Notice
Copyright © 2006
Motorola, Inc.
All rights reserved

No part of this publication my be reproduced in any form or by any means or used to make any derivative work (such
as translation, transformation or adaptation) without written permission from Motorola, Inc.

Motorola reserves the right to revise this publication and to make changes in content from time to time without
obligation on the part of Motorola to provide notification of such revision or change. Motorola provides this guide
without warranty of any kind, either implied or expressed, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose. Motorola may make improvements or changes in the product(s)
described in this manual at any time.

Motorola and the stylized M logo are registered trademarks of Motorola, Inc. Broadband Services Router, BSR, BSR
64000, RiverDelta, and SmartFlow are trademarks of Motorola, Inc. All other trademarks and registered trademarks
are the property of their respective owners.

Compass ID: 188656176 Version 5


Release 4.2.0
MGBI
Published: 12/06
Caring for the Environment by Recycling
When you see this symbol on a Motorola product, do not dispose of the product with residential or commercial
waste.
Recycling your Motorola Equipment
Please do not dispose of this product with your residential or commercial waste. Some countries or regions,
such as the European Union, have set up systems to collect and recycle electrical and electronic waste items.
Contact your local authorities for information about practices established for your region. If collection systems
are not available, call Motorola Customer Service for assistance.

Recyclage pour le respect de l'environnement


Lorsque vous voyez ce symbole sur un produit Motorola, ne le jetez pas avec vos ordures ménagères ou vos
rebuts d'entreprise.
Recyclage de votre équipement Motorola
Veuillez ne pas jeter ce produit avec vos ordures ménagères ou vos rebuts d'entreprise. Certains pays ou
certaines régions comme l'Union Européenne ont mis en place des systèmes de collecte et de recyclage des
produits électriques et électroniques mis au rebut. Veuillez contacter vos autorités locales pour vous informer
des pratiques instaurées dans votre region. Si aucun système de collecte n'est disponible, veuillez appeler
le Service clientèle de Motorola qui vous apportera son assistance.

Umweltschutz durch Recycling


Wenn Sie dieses Zeichen auf einem Produkt von Motorola sehen, entsorgen Sie das Produkt bitte nicht als
gewöhnlichen Haus- oder Büromüll.
Recycling bei Geräten von Motorola
Bitte entsorgen Sie dieses Produkt nicht als gewöhnlichen Haus- oder Büromüll. In einigen Ländern und Ge-
bieten, z. B. in der Europäischen Union, wurden Systeme für die Rücknahme und Wiederverwertung von Ele-
ktroschrott eingeführt. Erkundigen Sie sich bitte bei Ihrer Stadt- oder Kreisverwaltung nach der geltenden
Entsorgungspraxis. Falls bei Ihnen noch kein Abfuhr- oder Rücknahmesystem besteht, wenden Sie sich bitte
an den Kundendienst von Motorola.

Cuidar el medio ambiente mediante el reciclaje


Cuando vea este símbolo en un producto Motorola, no lo deseche junto con residuos residenciales o com-
erciales.
Reciclaje de su equipo Motorola
No deseche este producto junto con sus residuos residenciales o comerciales. Algunos países o regiones,
tales como la Unión Europea, han organizado sistemas para recoger y reciclar desechos eléctricos y elec-
trónicos. Comuníquese con las autoridades locales para obtener información acerca de las prácticas vi-
gentes en su región. Si no existen sistemas de recolección disponibles, solicite asistencia llamando el
Servicio al Cliente de Motorola.
Cuidando do meio ambiente através da reciclagem
Quando você ver este símbolo em um produto Motorola, não descarte o produto junto com lixo residencial
ou comercial.
Reciclagem do seu equipamento Motorola
Não descarte este produto junto com o lixo residencial ou comercial. Alguns países ou regiões, tais como a
União Européia, criaram sistemas para colecionar e reciclar produtos eletro-eletrônicos. Para obter infor-
mações sobre as práticas estabelecidas para sua região, entre em contato com as autoridades locais. Se
não houver sistemas de coleta disponíveis, entre em contato com o Serviço ao Cliente da Motorola para ob-
ter assistência.

Dbałość o środowisko – recycling


Produktów Motorola oznaczonych tym symbolem nie należy wyrzucać do komunalnych pojemników na
śmieci.
Recykling posiadanego sprzętu Motorola
Produktu nie należy wyrzucać do komunalnych pojemników na śmieci. W niektórych krajach i regionach, np. w
Unii Europejskiej, istnieją systemy zbierania i recyklingu sprzętu elektrycznego i elektronicznego. Informacje o
utylizacji tego rodzaju odpadów należy uzyskać od władz lokalnych. Jeśli w danym regionie nie istnieją sys-
temy zbierania odpadów elektrycznych i elektronicznych, informacje o utylizacji należy uzyskać od biura
obsługi klienta firmy Motorola (Motorola Customer Service).

Beskyttelse af miljøet med genbrug


Når du ser dette symbol på et Motorola-produkt, må produktet ikke bortskaffes sammen med husholdning-
saffald eller erhvervsaffald.
Genbrug af dit Motorola-udstyr
Dette produkt må ikke bortskaffes sammen med husholdningsaffald eller erhvervsaffald. Nogle lande eller
områder, f.eks. EU, har oprettet systemer til indsamling og genbrug af elektriske og elektroniske affald-
sprodukter. Kontakt de lokale myndigheder for oplysninger om gældende fremgangsmåder i dit område. Hvis
der ikke findes tilgængelige indsamlingssystemer, kan du kontakte Motorola Kundeservice.

Milieubewust recycleren
Als u dit symbool op een Motorola-product ziet, gooi het dan niet bij het huishoudelijk afval of het bedrijfsafval.
Uw Motorola-materiaal recycleren.
Gooi dit product niet bij het huishoudelijk afval het of bedrijfsafval. In sommige landen of regio's zoals de Eu-
ropese Unie, zijn er bepaalde systemen om elektrische of elektronische afvalproducten in te zamelen en te
recycleren. Neem contact op met de plaatselijke overheid voor informatie over de geldende regels in uw re-
gio. Indien er geen systemen bestaan, neemt u contact op met de klantendienst van Motorola.
Var rädd om miljön genom återvinning
När du ser den här symbolen på en av Motorolas produkter ska du inte kasta produkten tillsammans med det
vanliga avfallet.
Återvinning av din Motorola-utrustning
Kasta inte denna produkt tillsammans med det vanliga avfallet. Vissa länder eller regioner, som t.ex. EU, har
satt upp ett system för insamling och återvinning av el- och elektronikavfall. Kontakta dina lokala myndigheter
för information om vilka regler som gäller i din region. Om det inte finns något insamlingssystem ska du kon-
takta Motorolas kundtjänst för hjälp.

Újrahasznosítással a környezet védelméért


Ha ezt a jelzést látja egy Motorola terméken, ne dobja ki azt lakossági vagy ipari hulladékba.
Motorola termékének újrahasznosítása
Kérjük ne dobja ki ezt a terméket lakossági vagy ipari hulladékba. Egyes országok ill. régiók, mint az Európai
Unió is, már kialakították az elektronikai hulladékok begyûjtésének rendszerét. Lépjen kapcsolatba a helyi
hatóságokkal a lakóhelyén alkalmazott gyakorlattal kapcsolatos információért. Amennyiben gyûjtõrendszer
nem elérhetõ, hívja a Motorola Ügyfélszolgálatot segítségért.

Kujdesja per ambientin rrethues me ane te perdorimit te perseritur.


Neqoftese shikoni kete simbol ne produktin Motorola, mos e hidhni tej produktin, duke prishur keshtu ambi-
entin e duke shkaktuar humbje komerciale.
Perdorimi i perseritur i pajisjeve Motorola.
Ju lutemi te mos e hidhni tej kete produkt, duke shkaktuar prishjen e ambientit dhe humbje komerciale. Disa
vende e regjione, te tilla si Bashkimi Europjan, kane krijuar rrjetin e grumbullimit dhe perdorimit serish te de-
tajeve elektrike dhe elektronike te panevojshme. Lidhuni me autoritetet tuaja lokale per te marr vesh, si ve-
prohet ne regjionin tuaj. Neqoftese nje rrjet i tille nuk ekziston, drejtojuni per ndihme Sherbimit te Motorolas
per lidhje me bleresit.

リサイクルによる環境保護

モトローラ製品にこの記号が表示されている場合、製品を家庭または商業廃棄物として処分しないでくだ
さい。

モトローラ装置のリサイクル

本製品を家庭または商業廃棄物として処分しないでください。欧州連合などの国または地域によっては、
電気的・電子的廃棄物を収集およびリサイクルするシステムがあります。お住まいの地域で決められてい
る方法についての情報は、地方自治体にお問い合わせください。収集システムがない場合、モトローラ・
カスタマーサービスまでお問い合わせください
Motorola

Motorola

, ,

Motorola

Motorola

Motorola

Motorola

Motorola ,
.

Motorola
.

. .
, Motorola .
Contents

Preface
Scope ............................................................................................................................................xli
Audience.......................................................................................................................................xli
Documentation Set .......................................................................................................................xli
Conventions................................................................................................................................xliii
Notes, Cautions, Warnings .........................................................................................................xliv
If You Need Help........................................................................................................................xliv

1 System Administration Commands


Introduction .................................................................................................................................1-1
System Administration Command Descriptions .........................................................................1-2
aaa accounting commands default....................................................................................1-3
aaa accounting exec default..............................................................................................1-5
aaa authentication enable default......................................................................................1-7
aaa authentication fail-message........................................................................................1-8
aaa authentication local-override......................................................................................1-9
aaa authentication login default......................................................................................1-10
aaa authorization commands default ..............................................................................1-11
aaa authorization exec default ........................................................................................1-13
aaa console authentication..............................................................................................1-14
aaa console authorization commands default .................................................................1-15
aaa new-model................................................................................................................1-16
alias.................................................................................................................................1-17
banner motd ....................................................................................................................1-18

Compass ID: 188656176 Version 5 MGBI vii


BSR 64000 Command Reference Guide Release 4.2.0

batch ...............................................................................................................................1-19
boot system.....................................................................................................................1-20
broadcast.........................................................................................................................1-21
chassis alias ....................................................................................................................1-22
chassis assetid.................................................................................................................1-23
chkdsk.............................................................................................................................1-24
clear core log ..................................................................................................................1-25
clear evt ..........................................................................................................................1-26
clear log ..........................................................................................................................1-28
clear redundancy stats.....................................................................................................1-29
clock set ..........................................................................................................................1-30
clock timezone................................................................................................................1-31
configure.........................................................................................................................1-33
console authentication radius .........................................................................................1-34
copy ................................................................................................................................1-35
delete...............................................................................................................................1-37
description ......................................................................................................................1-38
dir....................................................................................................................................1-39
disable.............................................................................................................................1-40
duplex .............................................................................................................................1-41
enable..............................................................................................................................1-42
enable authentication radius ...........................................................................................1-43
enable password..............................................................................................................1-44
enable rdn-process ..........................................................................................................1-45
enable secret ...................................................................................................................1-46
encapsulation snap..........................................................................................................1-47
erase ................................................................................................................................1-48
exception.........................................................................................................................1-49
exit ..................................................................................................................................1-50
forced-download.............................................................................................................1-51
format .............................................................................................................................1-52
help .................................................................................................................................1-53
history size......................................................................................................................1-54
hostname.........................................................................................................................1-55

viii MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

icp keepalive...................................................................................................................1-56
ip ftp password ...............................................................................................................1-58
ip ftp username ...............................................................................................................1-59
ip netmask-format...........................................................................................................1-60
ip tacacs source-interface ...............................................................................................1-61
ip tftp source-interface loopback ....................................................................................1-62
ldap client .......................................................................................................................1-63
ldap search-base..............................................................................................................1-64
ldap server ......................................................................................................................1-65
load-interval....................................................................................................................1-66
logging............................................................................................................................1-68
logging admin-status ......................................................................................................1-69
logging buffered .............................................................................................................1-71
logging console...............................................................................................................1-73
logging control docsis.....................................................................................................1-75
logging default................................................................................................................1-76
logging disable bpi_auth_invalid_messages ..................................................................1-77
logging disable bpi_auth_reject_messages.....................................................................1-78
logging disable bpi_map_reject_messages.....................................................................1-79
logging disable cm_ranging_fail_r103_0.......................................................................1-80
logging evt clear .............................................................................................................1-81
logging evt set.................................................................................................................1-82
logging facility................................................................................................................1-83
logging on.......................................................................................................................1-84
logging rate-limit ............................................................................................................1-85
logging reporting ............................................................................................................1-86
logging reporting default ................................................................................................1-89
logging session ...............................................................................................................1-90
logging snmp-trap...........................................................................................................1-91
logging source-interface loopback .................................................................................1-93
logging trap.....................................................................................................................1-94
login................................................................................................................................1-96
logout..............................................................................................................................1-97
macro ..............................................................................................................................1-98

Compass ID: 188656176 Version 5 MGBI ix


BSR 64000 Command Reference Guide Release 4.2.0

memory checkzero..........................................................................................................1-99
message.........................................................................................................................1-100
network-clock-select.....................................................................................................1-101
network-clock-select revertive .....................................................................................1-103
more ..............................................................................................................................1-104
page...............................................................................................................................1-106
password .......................................................................................................................1-107
privilege restricted ........................................................................................................1-108
radius-server .................................................................................................................1-109
radius-server source-interface loopback....................................................................... 1-111
redundancy cmts ...........................................................................................................1-112
redundancy force-switchover cmts...............................................................................1-114
redundancy force-switchover srm ................................................................................1-116
reload ............................................................................................................................1-117
reload switched.............................................................................................................1-118
repeat ............................................................................................................................1-122
reset...............................................................................................................................1-123
service password-encryption ........................................................................................1-124
session-timeout .............................................................................................................1-125
session-window set.......................................................................................................1-126
set bandwidth-factor .....................................................................................................1-127
set stats poll ..................................................................................................................1-128
show aliases ..................................................................................................................1-130
show boot......................................................................................................................1-132
show chassis alias .........................................................................................................1-133
show chassis assetid .....................................................................................................1-134
show chassis serial-num ...............................................................................................1-135
show chassis status .......................................................................................................1-136
show clock ....................................................................................................................1-140
show core log................................................................................................................1-141
show evt........................................................................................................................1-142
show forced-download .................................................................................................1-146
show history..................................................................................................................1-148
show keepalive .............................................................................................................1-150

x MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

show log........................................................................................................................1-152
show logging evt...........................................................................................................1-154
show logging reporting.................................................................................................1-155
show logging syslog .....................................................................................................1-158
show macro...................................................................................................................1-159
show memory ...............................................................................................................1-160
show network-clocks ....................................................................................................1-163
show pool......................................................................................................................1-164
show process.................................................................................................................1-166
show process cpu..........................................................................................................1-168
show process memory ..................................................................................................1-172
show process msg-q-info..............................................................................................1-175
show process semaphores.............................................................................................1-176
show process stack .......................................................................................................1-178
show redundancy cmts .................................................................................................1-180
show reload...................................................................................................................1-184
show running-config.....................................................................................................1-185
show srm alias ..............................................................................................................1-187
show srm assetid...........................................................................................................1-188
show srm serial-num.....................................................................................................1-189
show startup-config ......................................................................................................1-190
show stats summary error.............................................................................................1-191
show stats xfabric .........................................................................................................1-192
show system..................................................................................................................1-193
show system alarms......................................................................................................1-197
show system fans..........................................................................................................1-200
show tacacs...................................................................................................................1-202
show tacacs statistics ....................................................................................................1-203
show tech ......................................................................................................................1-204
show update ..................................................................................................................1-206
show user-group ...........................................................................................................1-207
show users ....................................................................................................................1-209
show vectron slot..........................................................................................................1-211
show version.................................................................................................................1-213

Compass ID: 188656176 Version 5 MGBI xi


BSR 64000 Command Reference Guide Release 4.2.0

show xfabric .................................................................................................................1-216


slot ................................................................................................................................1-218
speed .............................................................................................................................1-219
srm alias........................................................................................................................1-220
srm assetid ....................................................................................................................1-221
sync file ........................................................................................................................1-223
tacacs reset-connections ...............................................................................................1-224
tacacs-server host..........................................................................................................1-225
tacacs-server key ..........................................................................................................1-227
tacacs-server port..........................................................................................................1-228
tacacs-server retry.........................................................................................................1-229
tacacs-server timeout ....................................................................................................1-230
telnet .............................................................................................................................1-231
telnet authentication radius...........................................................................................1-232
telnet session-limit........................................................................................................1-233
update bypass................................................................................................................1-234
update chassis ...............................................................................................................1-235
username.......................................................................................................................1-236
username privilege........................................................................................................1-238
username user-group ....................................................................................................1-239
xfabric keepalive ..........................................................................................................1-240

2 IP Commands
Introduction .................................................................................................................................2-1
IP Command Descriptions ..........................................................................................................2-2
arp .....................................................................................................................................2-3
arp timeout........................................................................................................................2-5
cable helper-address .........................................................................................................2-6
clear arp-cache..................................................................................................................2-8
clear counters....................................................................................................................2-9
clear host.........................................................................................................................2-10
clear ip route ...................................................................................................................2-11
clear ip traffic .................................................................................................................2-12
host authorization ...........................................................................................................2-13

xii MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

interface ..........................................................................................................................2-15
ip access-group ...............................................................................................................2-17
ip address ........................................................................................................................2-18
ip broadcast-address .......................................................................................................2-21
ip dhcp relay information ...............................................................................................2-22
ip domain-list..................................................................................................................2-24
ip domain-lookup............................................................................................................2-25
ip domain-name ..............................................................................................................2-26
ip forward-protocol udp..................................................................................................2-27
ip forwarding ..................................................................................................................2-28
ip helper-address.............................................................................................................2-29
ip host .............................................................................................................................2-30
ip irdp..............................................................................................................................2-31
ip mask-reply ..................................................................................................................2-33
ip mtu..............................................................................................................................2-34
ip name-server ................................................................................................................2-35
ip proxy-arp ....................................................................................................................2-36
ip rarp-server ..................................................................................................................2-37
ip redirects ......................................................................................................................2-38
ip route............................................................................................................................2-39
ip routing ........................................................................................................................2-40
ip source-route ................................................................................................................2-41
ip unreachables ...............................................................................................................2-42
passive-interface .............................................................................................................2-43
ping .................................................................................................................................2-44
show arp..........................................................................................................................2-46
show controllers..............................................................................................................2-48
show host authorization..................................................................................................2-50
show host authorization cpe ...........................................................................................2-51
show host authorization interface cable .........................................................................2-53
show host authorization summary ..................................................................................2-55
show host unauthorized cpe............................................................................................2-57
show hosts ......................................................................................................................2-58
show interfaces ...............................................................................................................2-59

Compass ID: 188656176 Version 5 MGBI xiii


BSR 64000 Command Reference Guide Release 4.2.0

show ip arp .....................................................................................................................2-62


show ip dhcp stats...........................................................................................................2-64
show ip filters .................................................................................................................2-65
show ip filters summary .................................................................................................2-69
show ip forwarding-table................................................................................................2-72
show ip interface.............................................................................................................2-74
show ip irdp ....................................................................................................................2-77
show ip protocols............................................................................................................2-79
show ip route ..................................................................................................................2-81
show ip traffic.................................................................................................................2-84
show l2-cam....................................................................................................................2-86
show sntp ........................................................................................................................2-89
show tcp brief .................................................................................................................2-90
show tcp statistics ...........................................................................................................2-91
shutdown.........................................................................................................................2-95
sntp authenticate .............................................................................................................2-96
sntp authentication-key...................................................................................................2-97
sntp broadcastdelay ........................................................................................................2-98
sntp broadcast client .......................................................................................................2-99
sntp disable ...................................................................................................................2-100
sntp server.....................................................................................................................2-101
sntp timer ......................................................................................................................2-103
sntp trusted-key ............................................................................................................2-104
traceroute ......................................................................................................................2-105
trap-enable-if ................................................................................................................2-107
trap-enable-rdn .............................................................................................................2-108
tunnel destination..........................................................................................................2-109
tunnel mode ..................................................................................................................2-110
tunnel source................................................................................................................. 2-111
unresolved-ip-packet-throttle .......................................................................................2-112

xiv MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

3 SNMP Commands
Introduction .................................................................................................................................3-1
SNMP Command Descriptions ...................................................................................................3-2
show snmp ........................................................................................................................3-3
snmp-server access ...........................................................................................................3-9
snmp-server chassis-id....................................................................................................3-11
snmp-server community .................................................................................................3-12
snmp-server community-table ........................................................................................3-13
snmp-server contact........................................................................................................3-16
snmp-server context........................................................................................................3-17
snmp-server convert .......................................................................................................3-18
snmp-server docs-trap-control........................................................................................3-19
snmp-server enable informs ...........................................................................................3-21
snmp-server enable traps ................................................................................................3-22
snmp-server engineID ....................................................................................................3-24
snmp-server group ..........................................................................................................3-25
snmp-server host.............................................................................................................3-26
snmp-server location ......................................................................................................3-29
snmp-server manager response-timeout .........................................................................3-30
snmp-server notify..........................................................................................................3-31
snmp-server notify-filter.................................................................................................3-33
snmp-server notify-filter-profile.....................................................................................3-35
snmp-server packetsize...................................................................................................3-37
snmp-server port number................................................................................................3-38
snmp-server shutdown....................................................................................................3-39
snmp-server sysname......................................................................................................3-40
snmp-server target-addr..................................................................................................3-41
snmp-server target-params .............................................................................................3-44
snmp-server trap rate-limit .............................................................................................3-47
snmp-server trap-source loopback..................................................................................3-48
snmp-server user.............................................................................................................3-49
snmp-server view............................................................................................................3-51

Compass ID: 188656176 Version 5 MGBI xv


BSR 64000 Command Reference Guide Release 4.2.0

4 Debug Commands
Introduction .................................................................................................................................4-1
Debug Command Descriptions ...................................................................................................4-1
debug aps ..........................................................................................................................4-2
debug arp ..........................................................................................................................4-3
debug cable err .................................................................................................................4-4
debug cable keyman .........................................................................................................4-5
debug cable mac ...............................................................................................................4-6
debug cable map ...............................................................................................................4-7
debug cable modem-select ...............................................................................................4-8
debug cable privacy..........................................................................................................4-9
debug cable qos ..............................................................................................................4-10
debug cable range ...........................................................................................................4-11
debug cable reg...............................................................................................................4-12
debug cable remote-query ..............................................................................................4-13
debug cable ucc ..............................................................................................................4-14
debug ip access-list.........................................................................................................4-15
debug ip bgp ...................................................................................................................4-16
debug ip dvmrp...............................................................................................................4-18
debug ip icmp .................................................................................................................4-19
debug ip igmp .................................................................................................................4-20
debug ip mfm..................................................................................................................4-21
debug ip mrtm.................................................................................................................4-22
debug ip ospf ..................................................................................................................4-23
debug ip packet...............................................................................................................4-25
debug ip pim ...................................................................................................................4-26
debug ip policy ...............................................................................................................4-28
debug ip redistribute to...................................................................................................4-29
debug ip rip.....................................................................................................................4-31
debug ip rip database ......................................................................................................4-32
debug ip rip events..........................................................................................................4-33
debug ip rip trigger .........................................................................................................4-34
debug ip tcp transactions ................................................................................................4-35
debug ip udp ...................................................................................................................4-36

xvi MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

debug ip vrrp...................................................................................................................4-37
debug ipsec .....................................................................................................................4-38
debug mpls forwarding...................................................................................................4-40
debug mpls rsvp..............................................................................................................4-41
debug packet-cable .........................................................................................................4-43
debug ppp fsm ................................................................................................................4-44
debug ppp packet............................................................................................................4-45
debug radius....................................................................................................................4-46
debug snmp.....................................................................................................................4-47
debug sntp.......................................................................................................................4-48
debug specmgr................................................................................................................4-49
debug ssh ........................................................................................................................4-50
debug tacacs....................................................................................................................4-51
debug tacacs events ........................................................................................................4-52
debug task monitor .........................................................................................................4-53
debug tunnel ...................................................................................................................4-57
show debugging..............................................................................................................4-58
undebug all .....................................................................................................................4-59

5 Access List Commands


Introduction .................................................................................................................................5-1
Access List Command Descriptions ...........................................................................................5-1
access-class in...................................................................................................................5-2
access-list (standard) ........................................................................................................5-3
access-list (extended)........................................................................................................5-4
ip access-group ...............................................................................................................5-11
ip access-list....................................................................................................................5-12
show access-lists.............................................................................................................5-13

6 Routing Policy Commands


Introduction .................................................................................................................................6-1
Routing Policy Command Descriptions ......................................................................................6-1
default-information originate............................................................................................6-2
default-metric ...................................................................................................................6-4

Compass ID: 188656176 Version 5 MGBI xvii


BSR 64000 Command Reference Guide Release 4.2.0

ip local policy route-map..................................................................................................6-5


ip policy route-map...........................................................................................................6-6
match as-path....................................................................................................................6-7
match community .............................................................................................................6-8
match ip address ...............................................................................................................6-9
match ip next-hop ...........................................................................................................6-10
match ip route-source .....................................................................................................6-11
match metric ...................................................................................................................6-12
match route-type external ...............................................................................................6-13
match route-type internal................................................................................................6-14
match tag ........................................................................................................................6-15
route-map........................................................................................................................6-16
set as-path prepend .........................................................................................................6-18
set automatic-tag.............................................................................................................6-19
set comm-list ..................................................................................................................6-20
set community ................................................................................................................6-22
set default interface.........................................................................................................6-24
set interface.....................................................................................................................6-25
set ip default next-hop ....................................................................................................6-26
set ip diff-serv.................................................................................................................6-27
set ip next-hop ................................................................................................................6-29
set ip qos queue ..............................................................................................................6-30
set local-preference.........................................................................................................6-31
set metric ........................................................................................................................6-32
set metric-type ................................................................................................................6-33
set origin .........................................................................................................................6-34
set tag..............................................................................................................................6-35
set weight........................................................................................................................6-36
show ip redistribute ........................................................................................................6-37
show ip traffic.................................................................................................................6-39
show route-map ..............................................................................................................6-40

xviii MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

7 RIP Commands
Introduction .................................................................................................................................7-1
RIP Command Descriptions........................................................................................................7-1
auto-summary ...................................................................................................................7-2
clear ip rip statistics ..........................................................................................................7-3
default-information originate............................................................................................7-4
default-metric ...................................................................................................................7-5
distance .............................................................................................................................7-6
distribute-list in.................................................................................................................7-7
distribute-list out...............................................................................................................7-8
graceful-restart-period ......................................................................................................7-9
ip rip authentication key .................................................................................................7-10
ip rip host-routes.............................................................................................................7-11
ip rip message-digest-key md5.......................................................................................7-12
ip rip receive version ......................................................................................................7-13
ip rip send version ..........................................................................................................7-14
ip split-horizon................................................................................................................7-15
maximum-paths ..............................................................................................................7-16
network ...........................................................................................................................7-17
offset-list.........................................................................................................................7-18
output-delay....................................................................................................................7-20
passive-interface .............................................................................................................7-21
redistribute......................................................................................................................7-22
router rip .........................................................................................................................7-24
show ip rip database .......................................................................................................7-25
source-port 520...............................................................................................................7-27
timers basic.....................................................................................................................7-28
version ............................................................................................................................7-30

8 OSPF Commands
Introduction .................................................................................................................................8-1
OSPF Command Descriptions ....................................................................................................8-1
area authentication............................................................................................................8-2
area default-cost................................................................................................................8-3

Compass ID: 188656176 Version 5 MGBI xix


BSR 64000 Command Reference Guide Release 4.2.0

area nssa............................................................................................................................8-4
area range..........................................................................................................................8-5
area stub............................................................................................................................8-6
area virtual-link ................................................................................................................8-7
auto-cost reference-bandwidth .........................................................................................8-9
auto-virtual-link..............................................................................................................8-10
clear ip ospf ....................................................................................................................8-11
default-information originate..........................................................................................8-12
default-metric .................................................................................................................8-13
distance ...........................................................................................................................8-14
distance ospf ...................................................................................................................8-15
distribute-list...................................................................................................................8-17
graceful-restart................................................................................................................8-18
helper-mode ....................................................................................................................8-19
ip ospf authentication-key ..............................................................................................8-21
ip ospf cost......................................................................................................................8-22
ip ospf database-filter all out ..........................................................................................8-23
ip ospf dead-interval .......................................................................................................8-24
ip ospf hello-interval.......................................................................................................8-25
ip ospf message-digest-key.............................................................................................8-26
ip ospf network ...............................................................................................................8-27
ip ospf priority ................................................................................................................8-28
ip ospf retransmit-interval ..............................................................................................8-29
ip ospf transmit-delay .....................................................................................................8-30
maximum-paths ..............................................................................................................8-31
moto-nsf..........................................................................................................................8-32
network area ...................................................................................................................8-34
passive-interface .............................................................................................................8-35
redistribute......................................................................................................................8-36
rfc1583-compatible.........................................................................................................8-38
router-id ..........................................................................................................................8-39
router ospf.......................................................................................................................8-40
show ip ospf....................................................................................................................8-41
show ip ospf border-routers............................................................................................8-43

xx MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

show ip ospf database.....................................................................................................8-44


show ip ospf interface.....................................................................................................8-47
show ip ospf memory .....................................................................................................8-49
show ip ospf neighbor ....................................................................................................8-51
show ip ospf network......................................................................................................8-53
show ip ospf virtual-links ...............................................................................................8-54
summary-address ............................................................................................................8-55
timers spf ........................................................................................................................8-56

9 IGMP Commands
Introduction .................................................................................................................................9-1
IGMP Command Descriptions ....................................................................................................9-2
clear ip igmp counters ......................................................................................................9-3
ip igmp access-group........................................................................................................9-4
ip igmp querier-timeout ....................................................................................................9-5
ip igmp query-interval ......................................................................................................9-6
ip igmp query-max-response-time....................................................................................9-7
ip igmp static-group..........................................................................................................9-8
ip igmp version .................................................................................................................9-9
ip igmp version1-querier ................................................................................................9-10
show ip igmp groups ......................................................................................................9-11
show ip igmp interface ...................................................................................................9-13
show ip igmp statistics....................................................................................................9-15

10 VRRP Commands
Introduction ...............................................................................................................................10-1
VRRP Command Descriptions..................................................................................................10-1
clear ip vrrp.....................................................................................................................10-2
ip vrrp .............................................................................................................................10-3
ip vrrp (virtual router ID) ...............................................................................................10-4
ip vrrp address ................................................................................................................10-5
ip vrrp authentication key...............................................................................................10-6
ip vrrp authentication type..............................................................................................10-7
ip vrrp enable..................................................................................................................10-8

Compass ID: 188656176 Version 5 MGBI xxi


BSR 64000 Command Reference Guide Release 4.2.0

ip vrrp preempt ...............................................................................................................10-9


ip vrrp priority ..............................................................................................................10-10
ip vrrp primary-ip .........................................................................................................10-11
ip vrrp timer..................................................................................................................10-12
ip vrrp verify-availability .............................................................................................10-13
show ip vrrp..................................................................................................................10-14

11 IP Multicast Commands
Introduction ...............................................................................................................................11-1
MRTM Command Descriptions ................................................................................................11-1
ip mroute.........................................................................................................................11-2
ip mroute static distance .................................................................................................11-3
ip mroute unicast distance .............................................................................................. 11-4
ip multicast-routing ........................................................................................................11-5
show ip rpf......................................................................................................................11-6
MFM Command Descriptions...................................................................................................11-7
clear ip multicast fwd-cache........................................................................................... 11-8
clear ip multicast proto-cache.........................................................................................11-9
mtrace ...........................................................................................................................11-10
show ip multicast cache-summary................................................................................ 11-11
show ip multicast fwd-cache ........................................................................................11-12
show ip multicast interface...........................................................................................11-13
show ip multicast oi-fwd-cache....................................................................................11-14
show ip multicast no-oi-fwd-cache ..............................................................................11-15
show ip multicast proto-cache ......................................................................................11-16

12 DVMRP Commands
Introduction ...............................................................................................................................12-1
DVMRP Command Descriptions..............................................................................................12-1
ip dvmrp accept-filter .....................................................................................................12-2
ip dvmrp default-information originate ..........................................................................12-3
ip dvmrp metric-offset ....................................................................................................12-4
ip dvmrp output-report-delay .........................................................................................12-5
ip dvmrp out-report-filter ...............................................................................................12-6

xxii MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

ip dvmrp probe-interval..................................................................................................12-7
ip dvmrp reject-non-pruners ...........................................................................................12-8
ip dvmrp summary-address ............................................................................................12-9
network .........................................................................................................................12-10
router dvmrp .................................................................................................................12-11
show ip dvmrp information ..........................................................................................12-12
show ip dvmrp interface ...............................................................................................12-13
show ip dvmrp neighbor...............................................................................................12-14
show ip dvmrp network ................................................................................................12-15
show ip dvmrp route .....................................................................................................12-16
show ip dvmrp route hold-down...................................................................................12-17
show ip dvmrp summary-route.....................................................................................12-18
show ip dvmrp tunnels..................................................................................................12-19

13 CMTS Commands
Introduction ...............................................................................................................................13-1
CMTS Command Descriptions .................................................................................................13-1
arp timeout......................................................................................................................13-2
balance............................................................................................................................13-3
band ................................................................................................................................13-4
bind cmts ........................................................................................................................13-5
cable bind........................................................................................................................13-6
cable bundle....................................................................................................................13-7
cable bundle master ........................................................................................................13-8
cable cmts type ...............................................................................................................13-9
cable concatenation docsis-1.0 .....................................................................................13-10
cable deny ip.................................................................................................................13-11
cable dhcp force-unicast ...............................................................................................13-12
cable dhcp-giaddr primary............................................................................................13-13
cable dhcp leasequery message-type ............................................................................13-14
cable disable 3140-nbpwr-adjustment ..........................................................................13-16
cable disable bpi-cmcert ...............................................................................................13-17
cable downstream carrier-only .....................................................................................13-18
cable downstream description ......................................................................................13-19

Compass ID: 188656176 Version 5 MGBI xxiii


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream frequency ........................................................................................13-20


cable downstream interleave-depth ..............................................................................13-22
cable downstream loadbalance-group ..........................................................................13-24
cable downstream modulation......................................................................................13-25
cable downstream power-level .....................................................................................13-26
cable downstream rate-limit .........................................................................................13-27
cable downstream schedule ..........................................................................................13-28
cable downstream scrambler on ...................................................................................13-29
cable downstream shutdown.........................................................................................13-30
cable downstream threshold .........................................................................................13-31
cable downstream trap-enable-if ..................................................................................13-33
cable downstream trap-enable-rdn ...............................................................................13-34
cable flap-list aging ......................................................................................................13-35
cable flap-list insertion-time.........................................................................................13-37
cable flap-list miss-threshold........................................................................................13-38
cable flap-list percentage threshold ..............................................................................13-39
cable flap-list power-adjust threshold ..........................................................................13-40
cable flap-list size .........................................................................................................13-41
cable flap-list trap-enable .............................................................................................13-42
cable helper-address .....................................................................................................13-43
cable host authorization range ......................................................................................13-45
cable insert-interval ......................................................................................................13-46
cable intercept...............................................................................................................13-47
cable loadbalance-group ...............................................................................................13-49
cable loadbalance-policy ..............................................................................................13-50
cable loadbalance-restricted .........................................................................................13-51
cable loadbalance-rule ..................................................................................................13-53
cable load-balance loadbalance-group .........................................................................13-56
cable load-balance spectrum-group..............................................................................13-57
cable modem-aging-timer.............................................................................................13-58
cable modem dcc ..........................................................................................................13-59
cable modem deny........................................................................................................13-61
cable modem disable loadbalancing.............................................................................13-62
cable modem qos dsa....................................................................................................13-63

xxiv MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

cable modem qos dsc....................................................................................................13-65


cable modem qos dsd....................................................................................................13-66
cable modem max-hosts ...............................................................................................13-67
cable modem max-hosts-all..........................................................................................13-68
cable modem remote-query ..........................................................................................13-69
cable modem ucc ..........................................................................................................13-71
cable modem updis .......................................................................................................13-73
cable modulation-profile ..............................................................................................13-74
cable modulation-profile copy......................................................................................13-78
cable modulation-profile description............................................................................13-79
cable modulation-profile reset......................................................................................13-80
cable multicast ..............................................................................................................13-81
cable multi-ds-override.................................................................................................13-83
cable privacy auth life-time ..........................................................................................13-84
cable privacy cert..........................................................................................................13-85
cable privacy cm-auth life-time....................................................................................13-86
cable privacy cm-auth reset ..........................................................................................13-87
cable privacy cm-tek life-time......................................................................................13-89
cable privacy cm-tek reset ............................................................................................13-90
cable privacy mcast ......................................................................................................13-91
cable privacy mcast access ...........................................................................................13-92
cable privacy tek life-time ............................................................................................13-93
cable qos-profile ...........................................................................................................13-94
cable shared-secret........................................................................................................13-95
cable shared-secondary-secret ......................................................................................13-96
cable spectrum-group ...................................................................................................13-97
cable sync-interval........................................................................................................13-98
cable ucd-interval .........................................................................................................13-99
cable upstream active-codes .......................................................................................13-100
cable upstream channel-type ......................................................................................13-101
cable upstream channel-width ....................................................................................13-103
cable upstream codes-minislot ...................................................................................13-105
cable upstream concatenation.....................................................................................13-107
cable upstream data-backoff.......................................................................................13-109

Compass ID: 188656176 Version 5 MGBI xxv


BSR 64000 Command Reference Guide Release 4.2.0

cable upstream description ......................................................................................... 13-111


cable upstream force-frag ...........................................................................................13-113
cable upstream frequency ...........................................................................................13-115
cable upstream hopping-seed .....................................................................................13-117
cable upstream ingress-canceller enable ....................................................................13-119
cable upstream ingress-canceller idle-interval ...........................................................13-121
cable upstream invited-range-interval ........................................................................13-123
cable upstream iuc11-grant-size .................................................................................13-125
cable upstream loadbalance-group .............................................................................13-127
cable upstream maintain-power-density on................................................................13-129
cable upstream map-interval.......................................................................................13-131
cable upstream max-calls ...........................................................................................13-133
cable upstream minislot-size ......................................................................................13-135
cable upstream modem-ranging-delay .......................................................................13-137
cable upstream modulation-profile.............................................................................13-139
cable upstream physical-delay....................................................................................13-141
cable upstream power-level ........................................................................................13-145
cable upstream power-level default............................................................................13-148
cable upstream pre-equalization .................................................................................13-151
cable upstream range-backoff.....................................................................................13-153
cable upstream range-forced-continue .......................................................................13-155
cable upstream range-power-override ........................................................................13-156
cable upstream rate-limit ............................................................................................13-157
cable upstream shutdown ...........................................................................................13-159
cable upstream snr-offset............................................................................................13-161
cable upstream spectrum-group..................................................................................13-163
cable upstream spread-interval ...................................................................................13-164
cable upstream trap-enable-cmts ................................................................................13-165
cable upstream trap-enable-if .....................................................................................13-167
cable upstream trap-enable-rdn ..................................................................................13-169
cable utilization-interval .............................................................................................13-171
channel-type ...............................................................................................................13-172
clear cable dcc-stats....................................................................................................13-173
clear cable flap-list .....................................................................................................13-174

xxvi MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

clear cable modem......................................................................................................13-175


clear cable modem offline ..........................................................................................13-176
clear cable modem sync..............................................................................................13-177
clear cable qos svc-flow statistics...............................................................................13-178
clear cable ucc-stats....................................................................................................13-179
clear counters cable ....................................................................................................13-180
clear interfaces cable upstream signal-quality............................................................13-181
codes-subframe...........................................................................................................13-182
collect interval ............................................................................................................13-183
collect resolution ........................................................................................................13-184
dhcp leasequery authorization on ...............................................................................13-185
differential-encoding on .............................................................................................13-186
docstest .......................................................................................................................13-187
docstest type ...............................................................................................................13-188
fec-codeword ..............................................................................................................13-189
fec-correction..............................................................................................................13-190
fft display....................................................................................................................13-191
fft setup .......................................................................................................................13-193
fft start ........................................................................................................................13-194
fft store........................................................................................................................13-195
guard-band..................................................................................................................13-196
hop action band...........................................................................................................13-197
hop action channel-width ...........................................................................................13-198
hop action frequency ..................................................................................................13-199
hop action modulation-profile ....................................................................................13-200
hop action power-level ...............................................................................................13-201
hop action roll-back....................................................................................................13-203
hop period...................................................................................................................13-204
hop threshold error .....................................................................................................13-205
hop threshold flap .......................................................................................................13-206
interface cable.............................................................................................................13-207
interleaver-block-size .................................................................................................13-208
interleaver-depth.........................................................................................................13-209
interleaver-step-size....................................................................................................13-210

Compass ID: 188656176 Version 5 MGBI xxvii


BSR 64000 Command Reference Guide Release 4.2.0

ip address ....................................................................................................................13-211
ip dhcp relay information option ................................................................................13-214
iuc ...............................................................................................................................13-215
last-codeword-length ..................................................................................................13-218
load-balancing ............................................................................................................13-219
load-balancing static ...................................................................................................13-220
max-burst....................................................................................................................13-221
modulation-type..........................................................................................................13-222
ping docsis ..................................................................................................................13-224
policy rule...................................................................................................................13-225
preamble-length..........................................................................................................13-226
preamble-type .............................................................................................................13-227
scrambler-mode ..........................................................................................................13-228
scrambler-seed ............................................................................................................13-229
show bindings.............................................................................................................13-230
show cable binding .....................................................................................................13-231
show cable dcc-stats ...................................................................................................13-233
show cable downstream..............................................................................................13-235
show cable flap-list.....................................................................................................13-237
show cable insert-interval...........................................................................................13-239
show cable loadbalance-group ...................................................................................13-240
show cable loadbalance-policy...................................................................................13-242
show cable loadbalance-restricted..............................................................................13-244
show cable loadbalance-rule.......................................................................................13-245
show cable modem .....................................................................................................13-246
show cable modem cpe...............................................................................................13-250
show cable modem detail ...........................................................................................13-252
show cable modem hosts ............................................................................................13-255
show cable modem loadbalance-group ......................................................................13-257
show cable modem mac..............................................................................................13-259
show cable modem maintenance ................................................................................13-263
show cable modem offline..........................................................................................13-266
show cable modem phy ..............................................................................................13-268
show cable modem registered ....................................................................................13-271

xxviii MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

show cable modem remote-query...............................................................................13-274


show cable modem stats .............................................................................................13-278
show cable modem summary .....................................................................................13-281
show cable modem summary total .............................................................................13-283
show cable modem svc-flow-id..................................................................................13-285
show cable modem svc-flow-id detail........................................................................13-287
show cable modem time-registered ............................................................................13-290
show cable modem timing-offset ...............................................................................13-293
show cable modem unregistered ................................................................................13-297
show cable modulation-profile ...................................................................................13-299
show cable modulation-profile brief ..........................................................................13-302
show cable modulation-profile description ................................................................13-303
show cable privacy auth .............................................................................................13-304
show cable privacy cm-auth .......................................................................................13-305
show cable privacy cm-tek .........................................................................................13-306
show cable privacy cmts.............................................................................................13-308
show cable privacy tek ...............................................................................................13-309
show cable qos profile ................................................................................................13-310
show cable qos profile user-defined ...........................................................................13-313
show cable qos svc-flow classifier .............................................................................13-316
show cable qos svc-flow dynamic-stat .......................................................................13-318
show cable qos svc-flow log.......................................................................................13-319
show cable qos svc-flow param-set............................................................................13-320
show cable qos svc-flow phs ......................................................................................13-322
show cable qos svc-flow statistics..............................................................................13-323
show cable qos svc-flow summary.............................................................................13-325
show cable qos svc-flow upstream-stat ......................................................................13-326
show cable spectrum-group........................................................................................13-327
show cable spectrum-group load-balance summary...................................................13-329
show cable sync-interval ............................................................................................13-330
show cable ucc-stats ...................................................................................................13-331
show cable ucd-interval..............................................................................................13-333
show cable upstream...................................................................................................13-334
show docsis-version....................................................................................................13-338

Compass ID: 188656176 Version 5 MGBI xxix


BSR 64000 Command Reference Guide Release 4.2.0

show docstest..............................................................................................................13-339
show interfaces cable..................................................................................................13-340
show interfaces cable bandwidth voice ......................................................................13-345
show interfaces cable configuration ...........................................................................13-347
show interfaces cable downstream .............................................................................13-349
show interfaces cable intercept...................................................................................13-351
show interfaces cable service-class ............................................................................13-353
show interfaces cable stats..........................................................................................13-356
show interfaces cable upstream ..................................................................................13-358
show stats cmts ...........................................................................................................13-364
show stats summary error...........................................................................................13-367
snr display...................................................................................................................13-369
snr loop .......................................................................................................................13-370
snr setup......................................................................................................................13-372
snr setup-get................................................................................................................13-374
snr start .......................................................................................................................13-375
snr store ......................................................................................................................13-376
spreader on..................................................................................................................13-377
tcm-encoding on .........................................................................................................13-378
time band ....................................................................................................................13-379
time delete ..................................................................................................................13-380

14 QoS Commands
Introduction ...............................................................................................................................14-1
QoS Command Descriptions .....................................................................................................14-1
qos bw default.................................................................................................................14-2
qos queue bw ..................................................................................................................14-3
show qos queue config ...................................................................................................14-4

15 POS Commands
Introduction ...............................................................................................................................15-1
POS Command Descriptions.....................................................................................................15-2
aps force..........................................................................................................................15-3
aps group ........................................................................................................................15-4

xxx MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

aps lockout......................................................................................................................15-5
aps manual ......................................................................................................................15-6
aps protect.......................................................................................................................15-7
aps revert ........................................................................................................................15-8
aps signal-degrade ber threshold ....................................................................................15-9
aps signal-fail ber threshold..........................................................................................15-10
aps unidirectional..........................................................................................................15-11
aps working ..................................................................................................................15-12
crc .................................................................................................................................15-13
interface pos..................................................................................................................15-14
ip address ......................................................................................................................15-15
peer default ip address ..................................................................................................15-16
pos ais-shut ...................................................................................................................15-17
pos flag .........................................................................................................................15-18
pos framing...................................................................................................................15-20
pos internal-clock .........................................................................................................15-21
pos report ......................................................................................................................15-22
pos scramble .................................................................................................................15-24
pos signal mode ............................................................................................................15-25
pos threshold.................................................................................................................15-26
ppp magic-number........................................................................................................15-28
ppp negotiation-count...................................................................................................15-29
ppp timeout...................................................................................................................15-30
show aps .......................................................................................................................15-31
show controllers pos .....................................................................................................15-32
show interfaces pos.......................................................................................................15-34
show ppp info ...............................................................................................................15-37
show ppp statistics ........................................................................................................15-38

16 BGP Commands
Introduction ...............................................................................................................................16-1
BGP Command Descriptions ....................................................................................................16-1
aggregate-address ...........................................................................................................16-2
auto-summary .................................................................................................................16-3

Compass ID: 188656176 Version 5 MGBI xxxi


BSR 64000 Command Reference Guide Release 4.2.0

bgp always-compare-med...............................................................................................16-4
bgp client-to-client reflection .........................................................................................16-5
bgp cluster-id ..................................................................................................................16-6
bgp confederation identifier ...........................................................................................16-7
bgp confederation peers..................................................................................................16-8
bgp dampening ...............................................................................................................16-9
bgp default ....................................................................................................................16-11
bgp permit.....................................................................................................................16-12
bgp router-id .................................................................................................................16-13
clear ip bgp ...................................................................................................................16-14
clear ip bgp dampening ................................................................................................16-15
clear ip bgp flap-statistics.............................................................................................16-16
default-information originate........................................................................................16-17
default-metric ...............................................................................................................16-18
distance bgp ..................................................................................................................16-19
distribute-list in.............................................................................................................16-21
distribute-list out...........................................................................................................16-22
ip as-path access-list .....................................................................................................16-23
ip community-list..........................................................................................................16-24
match as-path................................................................................................................16-26
match community .........................................................................................................16-27
maximum-paths ............................................................................................................16-28
neighbor advertisement-interval...................................................................................16-29
neighbor confed-segment .............................................................................................16-30
neighbor default-originate ............................................................................................16-31
neighbor description .....................................................................................................16-32
neighbor distribute-list..................................................................................................16-33
neighbor ebgp-multihop ...............................................................................................16-34
neighbor filter-list .........................................................................................................16-35
neighbor maximum-prefix............................................................................................16-37
neighbor next-hop-self..................................................................................................16-39
neighbor password........................................................................................................16-40
neighbor peer-group (assigning members)...................................................................16-41
neighbor peer-group (creating).....................................................................................16-42

xxxii MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

neighbor remote-as .......................................................................................................16-43


neighbor remove-private-as..........................................................................................16-45
neighbor route-map ......................................................................................................16-46
neighbor route-reflector-client......................................................................................16-47
neighbor route-refresh ..................................................................................................16-48
neighbor send-community ............................................................................................16-49
neighbor shutdown .......................................................................................................16-50
neighbor soft-reconfiguration inbound.........................................................................16-51
neighbor timers.............................................................................................................16-52
neighbor update-source loopback.................................................................................16-54
neighbor weight ............................................................................................................16-55
network .........................................................................................................................16-56
redistribute....................................................................................................................16-57
route-map......................................................................................................................16-59
router bgp......................................................................................................................16-61
set as-path prepend .......................................................................................................16-62
set comm-list ................................................................................................................16-63
set community ..............................................................................................................16-65
set ip next-hop ..............................................................................................................16-67
set local-preference.......................................................................................................16-68
set metric-type ..............................................................................................................16-69
set origin .......................................................................................................................16-70
set tag............................................................................................................................16-71
set weight......................................................................................................................16-72
show ip as-path-access-list ...........................................................................................16-73
show ip bgp...................................................................................................................16-74
show ip bgp cidr-only ...................................................................................................16-76
show ip bgp community ...............................................................................................16-77
show ip bgp community-list .........................................................................................16-79
show ip bgp dampened-paths .......................................................................................16-80
show ip bgp flap-statistics ............................................................................................16-81
show ip bgp ipv4 unicast ..............................................................................................16-83
show ip bgp memory ....................................................................................................16-87
show ip bgp neighbors..................................................................................................16-89

Compass ID: 188656176 Version 5 MGBI xxxiii


BSR 64000 Command Reference Guide Release 4.2.0

show ip bgp next-hops..................................................................................................16-91


show ip bgp paths .........................................................................................................16-92
show ip bgp peer-group ................................................................................................16-93
show ip bgp regexp.......................................................................................................16-95
show ip bgp summary...................................................................................................16-96
show ip community-list ................................................................................................16-98
synchronization.............................................................................................................16-99
timers bgp ...................................................................................................................16-100

17 PIM Commands
Introduction ...............................................................................................................................17-1
PIM Command Descriptions .....................................................................................................17-1
ip pim border ..................................................................................................................17-2
ip pim bsr-candidate .......................................................................................................17-3
ip pim bsr-candidate ip-address......................................................................................17-4
ip pim dr-priority ............................................................................................................17-5
ip pim message-interval..................................................................................................17-6
ip pim query-interval ......................................................................................................17-7
ip pim rp-candidate.........................................................................................................17-8
ip pim rp-candidate group-list ........................................................................................17-9
ip pim rp-candidate interval..........................................................................................17-10
ip pim rp-candidate ip-address .....................................................................................17-11
ip pim rp-candidate priority..........................................................................................17-12
ip pim spt-threshold lasthop .........................................................................................17-13
ip pim spt-threshold rp..................................................................................................17-14
network .........................................................................................................................17-15
pim accept-rp ................................................................................................................17-16
pim register-checksum..................................................................................................17-17
pim rp-address ..............................................................................................................17-18
pim unicast-route-lookup..............................................................................................17-20
router pim .....................................................................................................................17-21
show ip pim ..................................................................................................................17-22

xxxiv MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

18 MPLS Commands
Introduction ...............................................................................................................................18-1
About RSVP ...................................................................................................................18-3
MPLS Command Descriptions..................................................................................................18-3
clear ip rsvp statistics......................................................................................................18-4
clear mpls traffic.............................................................................................................18-5
debug mpls forwarding...................................................................................................18-6
debug mpls rsvp..............................................................................................................18-7
ip rsvp .............................................................................................................................18-9
mpls create-lsp rsvp......................................................................................................18-11
mpls create-lsp rsvp explicit-route identifier................................................................18-12
mpls create-lsp rsvp next-hop.......................................................................................18-13
mpls create-lsp static ....................................................................................................18-14
mpls ip ..........................................................................................................................18-16
mpls label range............................................................................................................18-17
mpls rsvp restart-lsp .....................................................................................................18-19
mpls ttl ..........................................................................................................................18-20
show ip rsvp explicit-routed-lsps..................................................................................18-21
show ip rsvp interface...................................................................................................18-22
show ip rsvp lsp ............................................................................................................18-23
show ip rsvp neighbor ..................................................................................................18-24
show ip rsvp reservation...............................................................................................18-25
show ip rsvp sender ......................................................................................................18-26
show ip rsvp statistics...................................................................................................18-27
show mpls filters...........................................................................................................18-28
show mpls forwarding-table .........................................................................................18-30
show mpls label range ..................................................................................................18-33
show mpls lsp ...............................................................................................................18-34
show mpls lsp interface ................................................................................................18-37
show mpls rsvp refresh-time ........................................................................................18-39
show mpls traffic ..........................................................................................................18-40

Compass ID: 188656176 Version 5 MGBI xxxv


BSR 64000 Command Reference Guide Release 4.2.0

19 Service Class Commands


Introduction ...............................................................................................................................19-1
Entering Service Class Configuration Mode..................................................................19-2
Service Class Command Descriptions ......................................................................................19-2
activity-timeout...............................................................................................................19-3
admission-timeout ..........................................................................................................19-4
admitted-bw-threshold....................................................................................................19-5
allow-share .....................................................................................................................19-6
cable service-class ..........................................................................................................19-7
cap...................................................................................................................................19-8
clear cable srvclass-stats.................................................................................................19-9
enforce-cmts-qos ..........................................................................................................19-10
grant-interval ................................................................................................................19-11
grant-jitter .....................................................................................................................19-12
grant-size ......................................................................................................................19-13
grants-per-interval ........................................................................................................19-14
mab ...............................................................................................................................19-15
max-burst......................................................................................................................19-17
max-concat-burst ..........................................................................................................19-18
max-latency ..................................................................................................................19-19
max-rate........................................................................................................................19-20
min-pkt-size..................................................................................................................19-21
min-rate.........................................................................................................................19-22
name .............................................................................................................................19-23
over-max-rate ...............................................................................................................19-24
poll-interval ..................................................................................................................19-25
poll-jitter .......................................................................................................................19-26
req-trans-policy.............................................................................................................19-27
restricted admission disabled........................................................................................19-29
schedpriority .................................................................................................................19-30
show cable service-class...............................................................................................19-31
show cable srvclass-stats ..............................................................................................19-34
tos-overwrite.................................................................................................................19-35
trafpriority.....................................................................................................................19-36

xxxvi MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

20 Secure Shell Server Commands


Introduction ...............................................................................................................................20-1
Secure Shell Server Command Descriptions ............................................................................20-1
password ssh-passphrase ................................................................................................20-2
show ssh config ..............................................................................................................20-3
show ssh hostkey-fingerprint..........................................................................................20-6
show users ssh ................................................................................................................20-7
ssh ciphers ......................................................................................................................20-8
ssh enable......................................................................................................................20-10
ssh-keygen2 ..................................................................................................................20-11
ssh load-host-key-files..................................................................................................20-13
ssh logout session-id.....................................................................................................20-14
ssh message-authentication ..........................................................................................20-15
ssh password-authentication radius ..............................................................................20-16
ssh password-guesses ...................................................................................................20-17
ssh port..........................................................................................................................20-18
ssh session-limit............................................................................................................20-19
ssh timeout....................................................................................................................20-20

21 PacketCable Commands
Overview ...................................................................................................................................21-1
Command Descriptions .............................................................................................................21-1
cable dynamic-service authorization-mode ....................................................................21-2
cable dynamic-service active-timeout ............................................................................21-4
clear configuration..........................................................................................................21-5
clear cops pdp-ip all........................................................................................................21-6
clear counters ipsec.........................................................................................................21-7
clear packet-cable cops...................................................................................................21-8
clear packet-cable gate ...................................................................................................21-9
clear packet-cable statistics ..........................................................................................21-10
cmts-ip ..........................................................................................................................21-11
cops client-timer ...........................................................................................................21-12
cops pdp-ip ...................................................................................................................21-13
cops pep-id....................................................................................................................21-14

Compass ID: 188656176 Version 5 MGBI xxxvii


BSR 64000 Command Reference Guide Release 4.2.0

cops status-trap-enable .................................................................................................21-15


dqos emergency-trap-enable.........................................................................................21-16
dqos res-req-trap-enable ...............................................................................................21-17
dqos shutdown ..............................................................................................................21-18
dqos t0-timer/t1-timer...................................................................................................21-19
em element-number ......................................................................................................21-20
em event-disable-mask .................................................................................................21-21
em event-priority ..........................................................................................................21-22
em flag-override ...........................................................................................................21-23
em max-batch-events....................................................................................................21-24
em max-batch-time.......................................................................................................21-25
em qos-descriptor-disable.............................................................................................21-26
em retry-count ..............................................................................................................21-27
em retry-interval ...........................................................................................................21-28
em shutdown.................................................................................................................21-29
em udp-port ..................................................................................................................21-30
es...................................................................................................................................21-31
ike client-addr...............................................................................................................21-32
ike phase1 .....................................................................................................................21-33
ike phase2 .....................................................................................................................21-34
ike retries ......................................................................................................................21-35
ike timeout ....................................................................................................................21-36
ipsec ..............................................................................................................................21-37
ipsec shutdown .............................................................................................................21-38
mm shutdown ...............................................................................................................21-39
mm t1-timer ..................................................................................................................21-40
packet-cable..................................................................................................................21-41
show cable dynamic-service.........................................................................................21-42
show ipsec ....................................................................................................................21-43
show packet-cable configuration..................................................................................21-46
show packet-cable cops ................................................................................................21-51
show packet-cable gate.................................................................................................21-53
show packet-cable statistics..........................................................................................21-56
spd allow-dynamic-rsp .................................................................................................21-59

xxxviii MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Contents

spd override ..................................................................................................................21-60


spd policy......................................................................................................................21-61
spd preshared-key.........................................................................................................21-63

22 VLAN Tagging Commands


Introduction ...............................................................................................................................22-1
VLAN Tagging Command Descriptions...................................................................................22-1
bridge cable intercept .....................................................................................................22-2
bridge cable modem .......................................................................................................22-3
bridge mode trunk...........................................................................................................22-4
cable privacy mandatory.................................................................................................22-5
clear bridge vlan counters...............................................................................................22-6
encapsulation dot1q ........................................................................................................22-7
show bridge vlan.............................................................................................................22-8

23 DSG Commands
Introduction ...............................................................................................................................23-1
Command Descriptions .............................................................................................................23-1
cable downstream dsg.....................................................................................................23-2
cable downstream dsg enable .........................................................................................23-3
cable dsg .........................................................................................................................23-4
channel-list .....................................................................................................................23-5
classifier..........................................................................................................................23-6
client-list .........................................................................................................................23-8
group-map.....................................................................................................................23-10
show cable dsg..............................................................................................................23-12
show cable dsg channel-list ..........................................................................................23-14
show cable dsg classifier ..............................................................................................23-15
show cable dsg client-list..............................................................................................23-16
show cable dsg downstream .........................................................................................23-17
show cable dsg group-map ...........................................................................................23-18
show cable dsg timer ....................................................................................................23-19
show cable dsg tunnel...................................................................................................23-20
show cable dsg tunnel-group ........................................................................................23-21

Compass ID: 188656176 Version 5 MGBI xxxix


BSR 64000 Command Reference Guide Release 4.2.0

show cable dsg vendor-param ......................................................................................23-22


timer..............................................................................................................................23-23
tunnel ............................................................................................................................23-25
vendor-param................................................................................................................23-27

Index

xl MGBI Compass ID: 188656176 Version 5


Preface

Scope
This document describes how to install and configure the Motorola™ Broadband
Services Router™ 64000 (BSR 64000™).

Audience
This document is for use by those persons who will install and configure the
BSR 64000™ product. Only trained service personnel should install, maintain, or
replace the BSR 64000.

Documentation Set
The following documents comprise the BSR 64000 documentation set:

■ BSR 64000 Quick Start Guide


The quick start guide provides a "roadmap" to the tasks involved in physically
installing the BSR 64000 product, physically connecting it to your network/HFC
infrastructure, and performing configuration tasks to enable the BSR 64000 to
operate in your networking environment.
■ BSR 64000 Installation Guide
This guide provides detailed instructions for physically installing the BSR 64000
product including: procedures for rack mounting, making physical network cable
connections, connecting DC power, and for determining the status of the BSR
64000 after applying power to it. This document also provides a description of the
BSR 64000 chassis, its hardware components and modules.

Compass ID: 188656176 Version 5 MGBI xli


BSR 64000 Command Reference Guide Release 4.2.0

■ BSR 64000 Resource and I/O Module Installation Guide


This guide contains procedures for installing additional and replacement
Resource and I/O Modules in a BSR 64000 chassis and for making physical cable
connections to the modules.
■ BSR 64000 Command Line Interface User’s Guide
For users, this guide describes the structure of the BSR 64000 Command Line
Interface (CLI) and its various command modes. It also provides rules and
guidelines for navigating through the CLI.
■ BSR 64000 Command Reference Guide
This guide contains individual descriptions of the entire set of commands that
comprise the BSR 64000 Command Line Interface (CLI). These commands are
used to interface with, configure, manage, and maintain the BSR 64000.
■ BSR 64000 System Administration Guide
For system administrators, this guide provides detailed procedures for performing
initial configuration tasks including setting up: user accounts and passwords;
telnet and console access; system logging; and associated servers such as DHCP,
DNS, etc.
■ BSR 64000 CMTS Configuration and Management Guide
This guide provides the instructions and procedures for configuring and
managing BSR 64000 CMTS operation.
■ BSR 64000 Routing Configuration and Management Guide
This guide contains the instructions and procedures for configuring and managing
BSR 64000 routing operation, including RIP, OSPF, and BGP.
■ BSR 64000 SNMP Configuration and Management Guide
This guide provides the instructions and procedures for configuring and
managing BSR 64000 Simple Network Management Protocol (SNMP) operation.
It also describes SNMP MIBs; provides information that describes standard and
proprietary MIB support; describes how to walk MIBs; and how to compile and
load SNMP MIBs.
■ BSR 64000 BGP/MPLS VPN Configuration Guide

xlii MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Preface

This guide provides the instructions and procedures for configuring and
managing the BSR 64000 to support and implement Border Gateway Protocol/
MultiProtocol Label Switching Virtual Private Networks (BGP/MPLS VPNs).
■ BSR 64000 Troubleshooting Guide
This guide contains instructions and procedures for troubleshooting typical
configuration problems that might be encountered using the BSR 64000. It also
offers suggestions for information to record, and have available should the need
arise to call Motorola support for assistance with BSR 64000 operational
problems.
■ BSR 64000 Release Notes
These documents are specific to each release of the BSR 64000 product (software
and hardware). Release notes provide information about features not documented
or incorrectly documented in the main documentation set; known problems and
anomalies; product limitations; and problem resolutions.

Conventions
This document uses the conventions in the following table:

Convention Example Explanation


angle brackets < > ping <ip-address> Arguments in italic and enclosed by angle
ping 54.89.145.71 brackets must be replaced by the text the
argument represents. In the example,
54.89.145.71 replaces <ip-address>. When
entering the argument, do not type the angle
brackets.
bar brackets [ ] disable [level] Bar brackets enclose optional arguments. The
example indicates you can use the disable
command with or without specifying a level.
Some commands accept more than one
optional argument. When entering the
argument, do not type the bar brackets.
bold text cable relay-agent-option Boldface text must be typed exactly as it
appears.

Compass ID: 188656176 Version 5 MGBI xliii


BSR 64000 Command Reference Guide Release 4.2.0

Convention Example Explanation


brace brackets {} page {on | off} Brace brackets enclose required text. The
example indicates you must enter either on or
off after page. The system accepts the
command with only one of the parameters.
When entering the text, do not type the brace
brackets.
italic text boot system <filename> Italic type indicates variables for which you
supply values in command syntax descriptions.
It also indicates file names, directory names,
document titles, or emphasized text.
screen display Wed May 6 17:01:03 This font indicates system output.
2000
vertical bar | page {on | off} A vertical bar separates the choices when a
parameter is required. The example indicates
you can enter either command:
page on or page off
When entering the parameter, do not type the
vertical bar or the brace brackets.

Notes, Cautions, Warnings


The following icons and associated text may appear in this document.

Note: A note contains tips, suggestions, and other helpful information, such
as references to material not contained in the document, that can help you
complete a task or understand the subject matter.

Caution: The exclamation point, within an equilateral triangle, is intended to


alert the user to the presence of important installation, servicing, and
operating instructions in the documents accompanying the equipment.

Warning: This symbol indicates that dangerous voltage levels are present
within the equipment. These voltages are not insulated and may be of
sufficient strength to cause serious bodily injury when touched. The symbol
may also appear on schematics.

xliv MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Preface

If You Need Help


If you need assistance while working with the BSR 64000 HD or BSR 64000, contact
the Motorola Technical Response Center (TRC):

Inside the U.S. 1-888-944-HELP


1-888-944-4357
Outside the U.S. +1-215-323-0044
Motorola Online http://businessonline.motorola.com

The TRC is on call 24 hours a day, 7 days a week. In addition, Motorola Online offers
a searchable solutions database, technical documentation, and low-priority issue
creation and tracking.

Compass ID: 188656176 Version 5 MGBI xlv


1
System
Administration Commands

Introduction
This chapter describes the following types of commands for the BSR 64000™:
User management commands which establish authentication and to protect the
network from unauthorized users.
Configuration file commands that handle the operating system and the system
software for the BSR. The configuration file commands allow you to customize the
operating system configuration at system startup, and to modify and store the
configuration file for later use.
System services commands that globally configure IP system services used with the
BSR, such as protocols, NVRAM, IP parameters, the operating system, and the
system clock
Lightweight Directory Access Protocol (LDAP) commands that are used with the
BSR to access online directory services over the TCP/IP network protocol. The BSR
becomes an LDAP client and connects to an LDAP server to requests services and/or
information.

Compass ID: 188656176 Version 5 MGBI 1-1


BSR 64000 Command Reference Guide Release 4.2.0

Logger commands which provide a way to configure system event reporting


intended for diagnostics. The information in the report contains actions such as
system startup, status, and event classes.

System Administration Command Descriptions


This section contains an alphabetized list and descriptions of the system
administration commands supported by the BSR.

1-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

aaa accounting commands default


The aaa accounting commands default command enables command use accounting
on the BSR. Enabling command use accounting provides resource usage data for
commands used at a specified privilege level by creating a default list of methods
used for accounting services. The no aaa accounting commands command disables
command use accounting.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


aaa accounting commands {exec | isp-ro | isp-rw | mso-ro | mso-rw | sysadmin}
default {none | start-stop | stop-only | wait-start} {local | none | radius | tacacs}
no aaa accounting commands [exec | isp-ro | isp-rw | mso-ro | mso-rw | sysadmin]

Command Syntax

exec commands in the User EXEC privilege level


isp-ro commands in the ISP Read/Only privilege
level
isp-rw commands in the ISP Read/Write privilege
level
mso-ro commands in the MSO Read/Only privilege
level
mso-rw commands in the MSO Read/Write privilege
level
sysadmin commands in the SYSADMIN privilege level
none disables accounting services

Compass ID: 188656176 Version 5 MGBI 1-3


BSR 64000 Command Reference Guide Release 4.2.0

start-stop sends a "start" accounting notice at the


beginning of a process and a "stop"
accounting notice at the end of a process - the
requested user process begins regardless of
whether the "start" accounting notice was
received by the accounting server
stop-only sends a "stop" accounting notice at the end of
the requested user process - does not send a
"start" accounting request at the start of the
process
wait-start sends a "start" accounting notice at the
beginning of a process and a "stop"
accounting notice at the end of a process - the
requested user process does not begin until
the "start" accounting notice is received by
the server
local local database to be used as the accounting
method
none no method is specified as the accounting
method
radius RADIUS to be used as the accounting
method.
tacacs TACACS+ to be used as the accounting
method.

1-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

aaa accounting exec default


The aaa accounting exec default command enables terminal session accounting on
the BSR. Enabling terminal session accounting provides resource usage data for a
specified terminal session and creates a default list of methods used for accounting
services. The no aaa accounting exec command disables terminal session
accounting.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


aaa accounting exec {none | start-stop | stop-only | wait-start} default {local |
none | tacacs}
no aaa accounting exec

Command Syntax

none disables accounting services


start-stop sends a "start" accounting notice at the
beginning of a process and a "stop"
accounting notice at the end of a process - the
requested user process begins regardless of
whether the "start" accounting notice was
received by the accounting server
stop-only sends a "stop" accounting notice at the end of
the requested user process - does not send a
"start" accounting request at the start of the
process

Compass ID: 188656176 Version 5 MGBI 1-5


BSR 64000 Command Reference Guide Release 4.2.0

wait-start sends a "start" accounting notice at the


beginning of a process and a "stop"
accounting notice at the end of a process - the
requested user process does not begin until
the "start" accounting notice is received by
the server
local local database to be used as the authorization
method.
none no method is specified as the accounting
method
radius RADIUS to be used as the accounting
method.
tacacs TACACS+ to be used as the accounting
method.

1-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

aaa authentication enable default


The aaa authentication enable default command enables AAA authentication to
determine if a user can access the privilege level 15 (system administrator). The aaa
authentication enable default command enables a specific authentication method or
list of methods The no aaa authentication enable command disables AAA
authentication.

Note: If multiple authentication methods are specified, the methods are


invoked in the sequence they are configured.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


aaa authentication enable default {enable | local | none | radius | tacacs}
no aaa authentication enable

Command Syntax

enable enable password command setup to be used


as the authentication method
local local database to be used as the authentication
method
none no method is specified as the authentication
method
radius RADIUS to be used as the authentication
method

tacacs TACACS+ to be used as the authentication


method

Compass ID: 188656176 Version 5 MGBI 1-7


BSR 64000 Command Reference Guide Release 4.2.0

aaa authentication fail-message


The aaa authentication fail-message command allows you to configure an error
message to display when a TACACS login has failed. The no aaa authentication
login default command disables the error message.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


aaa authentication fail-message [<LINE>]
no aaa authentication fail-message

Command Syntax

LINE the text message to display for the failed


login/authentication

1-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

aaa authentication local-override


The aaa authentication local-override command enables local authentication. This
command overrides any configured default authentication method. A configured
default authentication method will be used only if local authentication fails. The no
aaa authentication local-override disables local authentication.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


aaa authentication local-override
no aaa authentication local-override

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 1-9


BSR 64000 Command Reference Guide Release 4.2.0

aaa authentication login default


The aaa authentication login default command enables AAA authentication to
determine if a user can login to the BSR. The no aaa authentication login default
command disables AAA login authentication.

Note: If multiple authentication methods are specified, the methods are


invoked in the sequence they are configured.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


aaa authentication login default {enable | line | local | none | radius | tacacs}
no aaa authentication login

Command Syntax

enable enable password command setup to be used


as the authentication method
line line password to be used as the authentication
method
local local database to be used as the authentication
method

none no method is specified as the authentication


method
radius RADIUS to be used as the authentication
method
tacacs TACACS+ to be used as the authentication
method

1-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

aaa authorization commands default


The aaa authorization commands default command enables command
authorization on the BSR. Command authorization determines if a user is allowed to
run commands at a specified privilege level by creating a default list of methods used
for authorization services. The no aaa authorization commands default command
disables command authorization.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


aaa authorization commands {exec | isp-ro | isp-rw | mso-ro | mso-rw | sysadmin}
default {local | none | tacacs}
no aaa authentication commands {exec | isp-ro | isp-rw | mso-ro | mso-rw |
sysadmin}

Command Syntax

exec commands in the User EXEC privilege level


isp-ro commands in the ISP Read/Only privilege
level
isp-rw commands in the ISP Read/Write privilege
level
mso-ro commands in the MSO Read/Only privilege
level
mso-rw commands in the MSO Read/Write privilege
level
sysadmin commands in the SYSADMIN privilege level
local local database to be used as the authorization
method

Compass ID: 188656176 Version 5 MGBI 1-11


BSR 64000 Command Reference Guide Release 4.2.0

none no method is specified as the authorization


method
tacacs TACACS+ to be used as the authorization
method

1-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

aaa authorization exec default


The aaa authorization exec default command enables privilege level authorization
on the BSR. Privilege level authorization determines if a user is allowed to run an
EXEC shell (user session) by creating a default list of methods used for authorization
services. The no aaa authorization exec default command disables privilege level
authorization.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


aaa authorization exec default {local | none | tacacs}
no aaa authorization exec

Command Syntax

local local database to be used as the authorization


method
none no method is specified as the authorization
method
tacacs TACACS+ to be used as the authorization
method

Compass ID: 188656176 Version 5 MGBI 1-13


BSR 64000 Command Reference Guide Release 4.2.0

aaa console authentication


The aaa console authentication command enables TACACS authentication for the
console if AAA is configured. The no aaa console authentication command disables
login authentication for the console.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


aaa console authentication
no aaa console authentication

Command Default
Enabled

1-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

aaa console authorization commands default


The aaa console authorization commands default command enables command
authorization for the console if AAA is configured. The no aaa console
authorization commands default command disables command authorization for the
console.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


aaa console authorization commands default
no aaa console authorization commands default

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 1-15


BSR 64000 Command Reference Guide Release 4.2.0

aaa new-model
The aaa new model command enables the AAA network security model. The AAA
network security model provides a software mechanism or framework for consistent
authentication, authorization and accounting on the BSR. The no aaa new model
disables the AAA network security model.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


aaa new model
no aaa new model

Command Default
Disabled

1-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

alias
The alias command allows you to specify an alias for a CLI command in a specific
command mode (User EXEC, Privileged EXEC, or Global Configuration). The no
alias command deletes a specific alias defined within the command mode.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


alias {all | exec | priv | conf} <WORD> <WORD>
no alias {all | exec | priv | conf} <WORD>

Command Syntax

all alias visible in all modes


exec User EXEC mode alias command
priv Privileged EXEC mode alias
command
conf Global Configuration mode alias
command
WORD name of alias
WORD the command that is aliased

Compass ID: 188656176 Version 5 MGBI 1-17


BSR 64000 Command Reference Guide Release 4.2.0

banner motd
The banner motd command allows you to create a message-of the-day (motd) that
displays before the login prompt. The no banner motd command deletes the message
of the day.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


banner motd [<1-25>] [...<WORD> ]
no banner motd

Command Syntax

1-25 message line number


WORD text of the message

1-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

batch
The batch command executes a series of commands from a batch file stored in Flash
memory or NVRAM.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


batch {flash: | nvram:} [acknowledge]

Command Syntax

flash: execute a batch file from Flash memory


nvram: execute a batch file from NVRAM

acknowledge acknowledge the execution of each command

Compass ID: 188656176 Version 5 MGBI 1-19


BSR 64000 Command Reference Guide Release 4.2.0

boot system
The boot system command lets you boot the BSR using a boot image file stored in
either Flash memory, NVRAM on the Supervisory Routing Module (SRM), or an
FTP or TFTP server.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


boot system {flash: | nvram:|} {<filename>}

Command Syntax

flash: specifies flash memory as the location of the


boot image file
nvram: specifies Non-volatile Random Access
Memory (NVRAM) as the location of the
boot image file
filename filename of the boot image stored in Flash,
NVRAM, or an FTP or TFTP server

1-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

broadcast
The broadcast command is used to send a message to all connected users.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


broadcast <WORD>

Command Syntax

WORD The text message intended for broadcast

Compass ID: 188656176 Version 5 MGBI 1-21


BSR 64000 Command Reference Guide Release 4.2.0

chassis alias
The chassis alias command is used to configure an alias name for the BSR 64000
chassis.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


chassis alias <string>

Command Syntax

string the chassis alias name - enclose the


alias name within quotation marks if
the string contains spaces

1-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

chassis assetid
The chassis assetid command is used to configure your organization’s asset ID
number that is assigned to the BSR 64000 chassis.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


chassis assetid <string>

Command Syntax

string the BSR 64000 chassis asset ID


number - enclose the asset ID name
within quotation marks if the string
contains spaces

Compass ID: 188656176 Version 5 MGBI 1-23


BSR 64000 Command Reference Guide Release 4.2.0

chkdsk
The chkdsk command checks for and corrects any file system errors found in files
stored in Flash memory or NVRAM.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


chkdsk {flash: | nvram: }

Command Syntax

flash: check the Flash memory file system


nvram: check the NVRAM filesystem

1-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

clear core log


The clear core log command clears the core.log file.

Group Access
All

Command Mode
All mores except for User EXEC

Command Line Usage


clear core log

Compass ID: 188656176 Version 5 MGBI 1-25


BSR 64000 Command Reference Guide Release 4.2.0

clear evt
The clear evt command resets the event count to "0" for all groups on all slots, groups
on a specified slot, a specified group, or specified events.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear evt [<NUM> | <WORD>]

Command Syntax

NUM the chassis slot number


WORD the name of an EVT group - refer to Table 1-2

1-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Table 1-1 EVT Event Subsystems


memchk Memory Check drmr DOCSIS Redundancy accdhc ACC DHCP
net Network Manager SRM reg REG
ipevt IP Event System swr Switched Reload range Range
tpt Testpoint Facility tacacs TACACS+ dpm Data Path Mapping
arp ARP vrfmgr VRF Manager dra DOCSIS Redundancy
rpt SRM Repeater ipsec Agent
IPSEC
im Interface Manager ubsha
sys SYS UTIL Upstream Scheduler RTR
icp ICP
snmpa SNMP Agent ubsbst Upstream Scheduler Burst
evtm EVT Manager
dsgmib SNMP DSG ubsmac UBS CMTS MAC RTR
evta EVT Agent
bufmgr Buffer Manager ubs Upstream Scheduler
rmbind RM Bind
rm Resource Manager eth8 Ethernet Switch ubsim UBS IM SYNC
crmbpi CRM BPI fei FEI ubsmap UBS MAP
crm CRM srpcmt SRM Reporter CMTS macmr MAC MGR
crmsub CRM SubMgt maccfg MAC CFG docsif DOCS IF
crmfft CRM FFT cmtbuf CMTS Buffer macrtr MACRTR
crmsnr CRM SNR fpga CMTS FPGA brgtag BRG TAG
crmutl CRM Util bcm Broadcom Driver brg BRG
crmdtm CRM DOCSTEST bcmpkt Broadcam Driver Per brgrtr BRG RTR
crmcli CRM CLI Packet Spectrum Agent FFT
spafft
crmdsg CRM DSG
frm FRM spasnr Spectrum Agent SNR
dsgif DSG Interface
ard ARD rssi Spectrum Agent RSSI
csm Certificate Storage
ardpkt ARD PKT spasc Spectrum Agent SC
Module
brmtag BRM VLAN Tagging que QUE Manager ardrtr ARD RTR
rsm Redundancy SRM upc Upconverter acctrt ACC RTR
rdb Run Time Database res RES btp Boot Uptime
fpevt FP EVT resrtr RES RTR mcns MCNS
spcmgr Spectrum Manager resaut RES AUTH red CMTS Redundancy ICP
dgm DQM ressf RES SF ucc Upstream Channel Change
dqos PacketCable DQOS resmgr RES MGR dcc Dynamic Channel Change
pcmm PacketCable lbm Load Balancing dsx Dynamic Service
Multimedia lbm2 Load Balancing 2nd svcflo Service Flow
em PacketCable Event cra
Table CRA
Message
lbmsnr Load Balacing SNR cra2 CRA SNR
lbgmgr Load Balance Manage
drm cms Cable Modem bcm1 Broadcom 3138 Driver
DOCSIS Redundancy
Selector bcmmac Broadcom 3212 Driver
Manager
acc ACC pream Preamble
drme DOCSIS Redundancy
accpkt ACC Packet upcmot Upconverter Motorola
Manager Engine

Compass ID: 188656176 Version 5 MGBI 1-27


BSR 64000 Command Reference Guide Release 4.2.0

clear log
The clear log command deletes buffered log data.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear log

1-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

clear redundancy stats


The clear redundancy stats command clears redundancy statistics.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


clear redundancy stats [<0-15>]

Command Syntax

0-15 the chassis slot number

Compass ID: 188656176 Version 5 MGBI 1-29


BSR 64000 Command Reference Guide Release 4.2.0

clock set
The clock set command sets the system clock.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


clock set <hh:mm:ss> {<1-31> <MONTH> | <MONTH> <1-31>} <1993-2035>

Command Syntax

hh:mm:ss current time in 24-hour format


1-31 numeric notation for the current day
MONTH three letter abbreviated name of the current
month
1993-2035 numeric notation for the current year

1-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

clock timezone
The clock timezone command allows you to set the time zone for the system. The no
clock timezone command changes the system time to Universal Time Coordinated
(UTC).

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


clock timezone <WORD > <Hours_offset> [<Minute_offset>] [daylightsavings] [on
| off]
no clock timezone

Note: The daylightsavings option has no effect on the setting of time on the
BSR. It is present only to satisfy a requirement for Packetcable. Packetcable
has a field in a network bound event message that must be set to whether or
not daylight savings time is in effect. To satisfy this, the user must manually
configure this parameter when daylight savings time begins and also when it
ends. For automatic setting of the time, the BSR can be configured to obtain
its time via SNTP (Simple Network Time Protocol). Since SNTP has no way
of indicating whether daylight savings time is in effect, the operator must use
the daylightsavings option for compliance with Packetcable.

Compass ID: 188656176 Version 5 MGBI 1-31


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

WORD time zone listed when standard time is in effect


Hours_offset hours corrected from UTC, range -23 to 23
Minute_offset non-negative difference in minutes corrected
from UTC, range 0 to 59
daylightsavings configure daylight savings
on | off daylight savings on or off

Command Default
UTC

1-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

configure
The configure command lets you enter Global Configuration mode from Privileged
EXEC mode.

Note: To return to Privileged EXEC mode, enter exit, end, or Control-Z at


the Global Configuration Mode prompt.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


configure

Compass ID: 188656176 Version 5 MGBI 1-33


BSR 64000 Command Reference Guide Release 4.2.0

console authentication radius


The console authentication radius command enables RADIUS authentication for
user console logins. The no console authentication radius command disables this
feature.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


console authentication radius [ local-password | username <WORD>]
no console authentication radius [ local-password | username ]

Command Syntax

local-password authenticate with a locally configured


password if there is no response from the
RADIUS server
username configure a console username to use for
authentication
WORD the text of the console username - maximum
of 64 characters

1-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

copy
The copy command copies a local or network file from one location to another, either
locally or on the network.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


copy {flash: | ftp: | nvram: | running-config | startup-config | system: | tftp:} |
{flash: | nvram: | running-config | startup-config | system:}

Command Syntax

flash: copy the configuration file from


flash
ftp: copy the configuration file from a
File Transport Protocol (FTP) server
nvram: copy the configuration file from
NVRAM
running-config copy from a currently running
system configuration
startup-config copy from the startup configuration
in NVRAM
system: copy from the system
tftp: copy the configuration file from a
Trivial File Transport Protocol
(TFTP) server
flash: copy the configuration file to flash
ftp: copy the configuration file to a File
Transport Protocol (FTP) server

Compass ID: 188656176 Version 5 MGBI 1-35


BSR 64000 Command Reference Guide Release 4.2.0

nvram: copy the configuration file to


NVRAM
running-config copy to the currently running system
configuration

startup-config copy to the startup configuration in


NVRAM
system: copy to the system
tftp: copy the configuration file to a
Trivial File Transport Protocol
(TFTP) server

1-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

delete
The delete command deletes a file stored in Flash memory or NVRAM or deletes the
startup configuration file.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


delete {flash: | nvram: | startup-config}

Command Syntax

flash: delete all files from Flash memory


nvram: delete all files from NVRAM

startup-config delete the startup-configuration file

Compass ID: 188656176 Version 5 MGBI 1-37


BSR 64000 Command Reference Guide Release 4.2.0

description
The description command is used to specify descriptive information for any interface
on the BSR. This information is limited to 79 characters. Use the characters: _ or - to
separate words. For example, if a particular CMTS interface served a certain section
of a city, the MSO could assign the following description:
MOT:7A(config-if)#description charlestown_1

Note: The entered description can be seen in the running configuration, and
in the command output of show commands such as the show ip interface
and show running-config commands.

You can also use SNMP to view the descriptions. However, if you use SNMP
to view the descriptions, be aware that SNMP has a display limit of 63
characters. Descriptions beyond this length will appear truncated when
viewed via SNMP.

Command Mode
Interface Configuration (all interface types)

Command Line Usage


description <WORD> [<WORD>...]

Command Syntax

WORD is the text that describes this interface.

1-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

dir
The dir command lists directories and files on a filesystem.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


dir [all [time]] [flash: [time]] [nvram: [time]] [time]

Command Syntax

all list all directories and files


flash: list all directories and files in flash
nvram: list all directories and files in
NVRAM
time sort by modification time

Command Default
NVRAM

Compass ID: 188656176 Version 5 MGBI 1-39


BSR 64000 Command Reference Guide Release 4.2.0

disable
The disable command allows you to enter User EXEC mode from the Privileged
EXEC mode.

Note: To return to Privileged EXEC mode, enter enable at the User EXEC
prompt and, if required, a password.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


disable

1-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

duplex
The duplex command configures an Ethernet interface for duplex mode (full or half)
and enables/disables auto-negotiation

Group Access
ISP

Command Mode
Interface Configuration (Ethernet interface only)

Command Line Usage


duplex {half | full | auto}
no duplex {half | full | auto}

Command Syntax

half configures the interface for half-duplex


operation. Half-duplex operation allows the
interface to send and receive signals, but not
at the same time.
full configures the interface for full-duplex
operation. Full-duplex operation allows the
interface to send and receive signals at the
same time.
auto configures the interface to auto negotiate its
operational mode (either full-duplex or
half-duplex) with the device to which it is
physically connected.

Command Default
Auto negotiation enabled

Compass ID: 188656176 Version 5 MGBI 1-41


BSR 64000 Command Reference Guide Release 4.2.0

enable
The enable command allows you to enter Privileged EXEC mode from User EXEC
mode. If the system prompts you for a password, enter the password. After entering
Privileged EXEC mode, the prompt changes from the User EXEC mode prompt
(hostname>) to the privileged EXEC mode prompt (hostname#).

Group Access
System Administrator

Command Mode
User EXEC

Command Line Usage


enable

1-42 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

enable authentication radius


The enable authentication radius command enables RADIUS authentication for
user logins. The no enable authentication radius command disables this feature.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


enable authentication radius [ local-password ]
no enable authentication radius [ local-password ]

Command Syntax

local-password authenticate with a locally configured


password if there is no response from the
RADIUS server

Compass ID: 188656176 Version 5 MGBI 1-43


BSR 64000 Command Reference Guide Release 4.2.0

enable password
The enable password command allows you to specify a password associated with the
enable command. After specifying the password, entering the enable command at the
User EXEC prompt causes the system to prompt you for the password. You must
supply the password to enter the Privileged EXEC mode. The no enable password
command deletes the password.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


enable password <LINE>
enable password {0 | 7 } <WORD>
no enable password

Command Syntax

LINE the password (31 character


maximum) - enclosed with double
quotes if the password contains
spaces). The "%" and "!" characters
must not be used.
0 specifies an UNENCRYPTED
password
7 specifies a HIDDEN password
WORD the UNENCRYPTED or HIDDEN
'enable' password

1-44 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

enable rdn-process
This enable rdn-process command enables the process for collecting CPU utilization
statistics.The no enable rdn-process command disables the collection of CPU
utilization statistics.

Note: This feature is enabled by default, and must remain enabled if you
intend to use it in conjunction with SNMP polling of the BSR.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


enable rdn-process
no enable rdn-process

Command Default
enabled

Compass ID: 188656176 Version 5 MGBI 1-45


BSR 64000 Command Reference Guide Release 4.2.0

enable secret
The enable secret command allows you to provide an encrypted password that
supersedes the enabled password. The no enable secret command removes the secret.
Use the enable secret command to provide an encrypted password for entering
Privileged EXEC mode in the running configuration file when then no service
password-encryption command is in effect.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


enable secret [5] <WORD>
no enable secret

Command Syntax

5 specifies an ENCRYPTED secret


WORD the secret (31 character maximum) -
enclosed with double quotes if the
secret contains spaces). The "%" and
"!" characters must not be used.

1-46 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

encapsulation snap
The encapsulation snap command specifies SNAP as the encapsulation method for
Ethernet or Gigabit Ethernet interfaces. The SNAP encapsulation method, as
specified in RFC 1042, allows Ethernet protocols to run on the IEEE 802.2 media.
The no encapsulation snap command returns the interface encapsulation method to
the default method which is ARPA.

Group Access
All

Command Mode
Interface Configuration (Ethernet and Gigabit Ethernet notifies only)

Command Line Usage


encapsulation snap
no encapsulation snap

Compass ID: 188656176 Version 5 MGBI 1-47


BSR 64000 Command Reference Guide Release 4.2.0

erase
The erase command erases a file system stored in Flash memory or NVRAM or the
contents of the startup-configuration file.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


erase {flash: | nvram: | startup-config}

Command Syntax

flash: erase all files in Flash memory


nvram: erase all files in NVRAM

startup-config erase the startup-configuration file

1-48 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

exception
The exception command enables the Exception Handler. The Exception Handler is a
set of processes that are invoked when errors (exceptions) are caused by another
process that is executing when the particular exception occurs. Exceptions can be
reported or the BSR can be configured to automatically reboot if an exception occurs.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


exception {extended <0-1>| reboot <0-1>}

Command Syntax

extended 0-1 perform Extended Exception Reporting:


1 = enable Extended Exception Reporting
0 = disable Extended Exception Reporting
reboot 0-1 reboot on Exception:
1 = enable reboot
0 = disable reboot

Compass ID: 188656176 Version 5 MGBI 1-49


BSR 64000 Command Reference Guide Release 4.2.0

exit
The exit command (used from the Router Configuration, Interface Configuration, and
Global Configuration modes) accesses the previous command mode in the command
mode hierarchy. For example: using the exit command in Interface Configuration
mode accesses Global Configuration mode.
Using the exit command in Privileged EXEC or User EXEC modes, ends the
command line session.

Group Access
All

Command Mode
All modes

Command Line Usage


exit

1-50 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

forced-download
The forced-download command ensures that boot images are properly downloaded
to modules in the BSR 64000 chassis.
Use the forced-download command to ensure that all modules receive the correct
boot image before performing an upgrade process or to ensure that a specific module
receives the correct boot image before performing an upgrade process.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


forced-download [<0-15>]
no forced-download [<0-15>]

Command Syntax

0-15 BSR 64000 slot number

Compass ID: 188656176 Version 5 MGBI 1-51


BSR 64000 Command Reference Guide Release 4.2.0

format
The format command formats a filesystem in flash or NVRAM.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


format {flash: | nvram:}

Command Syntax

flash: format flash


nvram: format NVRAM

1-52 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

help
The help command displays instructions for using the CLI help functionality. Refer to
the BSR 64000 Configuration and Management Guide for additional instructions on
using the CLI help functionality.

Group Access
All

Command Mode
All modes

Command Line Usage


help

Compass ID: 188656176 Version 5 MGBI 1-53


BSR 64000 Command Reference Guide Release 4.2.0

history size
The history command enable and controls the command history function. The
history size command lets you specify the size of the history buffer by number of
lines. The no history command deletes the history buffer.

Group Access
All

Command Mode
All modes

Command Line Usage


history [size <1-256>]
no history

Command Syntax

1-256 the number of lines in the history


buffer

Command Default
10

1-54 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

hostname
The hostname command configures the name for the system host.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


hostname <WORD>

Command Syntax

WORD the system’s alphanumeric network hostname

Compass ID: 188656176 Version 5 MGBI 1-55


BSR 64000 Command Reference Guide Release 4.2.0

icp keepalive
The icp keepalive command allows you to set the threshold for missed ICP
keepalives after which the SRM module will be reset. The icp keepalive command
also configures console or system logging of event messages related to missed ICP
keepalives.
The Resource Manager (RM) software component of the SRM module sends an ICP
“SRM_READY” message as a poll every 2.5 seconds to all modules in the BSR
chassis. If any module fails to respond after 10 “SRM_READY” messages (25
seconds), the SRM generates an “RM.35” log message and the module is reset.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


icp keepalive { debug | monitor | slot-reset} [threshold <1-255>]
no icp keepalive [ debug | monitor | slot-reset] [threshold ]

Command Syntax

debug enables the display of ICP keepalive log


reports to the SRM console
monitor enables the display of ICP keepalive log
reports to the system logger

slot-reset the number of missed ICP keepalive


responses after which the SRM will
reset the slot.
initiate a slot recovery reset if the switch
fabric is not operational

1-56 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

threshold <1-255> configures number of ICP keepalive


retransmits until an action is taken
threshold restores the default threshold value for the no
icp keepalive debug, monitor, and slot-reset
commands

Command Defaults

icp keepalive debug Disabled


icp keepalive monitor Disabled
icp keepalive slot-reset Disabled
icp keepalive debug threshold 10 messages
icp keepalive monitor threshold 10 messages
icp keepalive slot-reset threshold 10 messages

Compass ID: 188656176 Version 5 MGBI 1-57


BSR 64000 Command Reference Guide Release 4.2.0

ip ftp password
The ip ftp password command displays the password to use to connect to the
network using FTP. The no ip ftp password command deletes the password for an
FTP connection.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


ip ftp password {0 <LINE>| 7 <LINE> | <LINE>}
no ip ftp password

Command Syntax

0 specifies an unencrypted password will


follow
7 specifies a hidden password will follow
LINE the password (31 character minimum, 78
character maximum for option 7) - enclosed
with double quotes if the password contains
spaces). The "%" and "!" characters must not
be used.

1-58 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

ip ftp username
The ip ftp username command configures the connection to the network for using
FTP. The no ip ftp username command configures the router anonymously for FTP.
Use the ip ftp username command that is related to an account on the server.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


ip ftp username <WORD>
no ip ftp username

Command Syntax

WORD username (31 character maximum)

Compass ID: 188656176 Version 5 MGBI 1-59


BSR 64000 Command Reference Guide Release 4.2.0

ip netmask-format
The ip netmask-format command lets you specify the format in which netmask
values appear in show command output. The no ip netmask format command sets
the output format back to the default.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip netmask-format {bit-count | decimal | hexadecimal}
no ip netmask-format {bit-count | decimal | hexadecimal}

Command Syntax

bit-count displays netmask as number of


significant bits
decimal displays netmask in dotted decimal
hexadecimal displays the netmask in hexadecimal

Command Default
bitcount

1-60 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

ip tacacs source-interface
The ip tacacs source-interface command allows an operator to control the source IP
address of TACACS+ packets generated by the BSR by specifying an Ethernet or
loopback interface as the source IP address for TACACS+ packets. The normal
convention for generated TACACS+ packets is to set the source IP address equal to
the IP address of the outgoing interface. The ip tacacs source-interface command
overrides this convention and instead uses the IP address of a specified Ethernet or
loopback interface. This command facilitates the use of one IP address entry
associated with the TACACS+ client instead of maintaining a list of all IP addresses
and is useful in cases where the a router has many interfaces and an operator wants to
ensure that all TACACS+ packets from a particular router have the same IP address.
The no ip tacacs source-interface command removes the specified source interface.

Note: Before using the ip tacacs source-interface command, the interface


must be configured, assigned an IP address, and up and running. Any
configuration change with this command will not take effect until after the next
BSR connection attempt.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


ip tacacs source-interface {ethernet <X/Y> | loopback <1-255>}
no ip tacacs source-interface

Command Syntax

ethernet X/Y the Ethernet interface slot and port number


loopback 1-255 the loopback interface number

Compass ID: 188656176 Version 5 MGBI 1-61


BSR 64000 Command Reference Guide Release 4.2.0

ip tftp source-interface loopback


The ip tftp source-interface loopback command allows an operator to control the
source IP address of TFTP packets generated by the BSR by specifying a loopback
interface as the source IP address for TFTP packets. The normal convention for
generated TFTP packets is to set the source IP address equal to the IP address of the
outgoing interface. The ip tftp source-interface loopback command overrides this
convention and instead uses the IP address of the specified loopback interface. The no
ip tftp source-interface loopback command removes the loopback source interface.

Note: Before using the ip tftp source-interface loopback command, the


loopback interface must be configured and assigned an IP address.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


ip tftp source-interface loopback <1-255>
no ip tftp source-interface loopback

Command Syntax

1-255 the loopback interface number

1-62 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

ldap client
The ldap client command enables the LDAP client. The no ldap client command
disables the LDAP client.

Note: Configure a primary or secondary LDAP server addresses before


enabling the LDAP client.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


ldap client
no ldap client

Compass ID: 188656176 Version 5 MGBI 1-63


BSR 64000 Command Reference Guide Release 4.2.0

ldap search-base
The ldap search-base command specifies the base distinguished name of the starting
point for a search of the LDAP database. The no ldap search-base ends the search of
the LDAP database.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


ldap search-base WORD
no ldap search-base WORD

Command Syntax

WORD Distinguished name of entry to where the


search will start

1-64 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

ldap server
The ldap server command configures LDAP server parameters. The no ldap server
command clears the LDAP server parameters.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


ldap server {<WORD> [binddn <WORD>] [nobinddn] [nopassword] [password
<WORD>}
no ldap server <WORD>

Command Syntax

WORD the primary LDAP server


binddn WORD distinguished name
nobinddn distinguished name not required to bind to
this server
nopassword password not required
password WORD password

Compass ID: 188656176 Version 5 MGBI 1-65


BSR 64000 Command Reference Guide Release 4.2.0

load-interval
The load-interval command specifies the load interval timer value in minutes. The
load interval timer captures bandwidth utilization information on a per-port basis for
both received and transmitted data. Bandwidth utilization information can then be
displayed with the show interfaces command. The following is typical load interval
information as displayed with the show interfaces command:

Cable2/0 is up, line protocol is up


Hardware is BCM3210 ASIC, address is 0030.7b74.3238 (bia 0030.7b74.3238)
Internet address is 10.10.128.1/17
MTU 1500 bytes, BW 27000 Kbit, DLY 1000 usec,
reliability 255/255, txload 1/255, rxload 20/255
Encapsulation MCNS, loopback not set
Keepalive not set
ARP type: ARPA, ARP Timeout 04:00:00
Last input 00:00:00, output 00:00:00, output hang never
Last clearing of "show interface" counters never
Queueing strategy: fifo
Output queue 0/40, 69 drops; input queue 0/75, 7 drops
5 minute input rate 2202000 bits/sec, 416 packets/sec
Load Interval
5 minute output rate 120000 bits/sec, 13 packets/sec
Bandwidth Utilization
1125177443 packets input, 14081732 bytes, 25 no buffer
Information
Received 3125750 broadcasts, 0 runts, 0 giants, 0 throttles
1018 input errors, 87 CRC, 0 frame, 0 overrun, 0 ignored, 0 abort
25006326 packets output, 1183354279 bytes, 0 underruns
0 output errors, 0 collisions, 4 interface resets
0 output buffer failures, 0 output buffers swapped out

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


load-interval <1-300>

1-66 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Syntax

1-300 the load interval timer value in minutes

Command Default
5 minutes

Compass ID: 188656176 Version 5 MGBI 1-67


BSR 64000 Command Reference Guide Release 4.2.0

logging
The logging command specifies the IP address of a remote SYSLOG server. The no
logging command clears the IP address specification of a remote SYSLOG server.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging <A.B.C.D>
no logging <A.B.C.D>

Command Syntax

A.B.C.D. SYSLOG server IP address

1-68 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging admin-status
The logging admin-status command controls the transmission of traps and SYSLOG
messages with respect to the threshold specified with the logging rate-limit
command. The logging admin-status command is only relevant if DOCSIS logging
control has been specified with the logging control docsis command.
In CLI logging control mode, the logging admin-status command will be ignored by
the system and a warning message will display if it is used. In this mode, only the
logging rate-limit command is relevant. In DOCSIS logging control mode, both the
logging admin-status and logging rate-limit commands are needed to specify
throttling.

Note: An event is always treated as a single event for threshold counting. For
example: an event causing both a trap and a SYSLOG message is still
treated as a one event.

Command Line Usage


logging admin-status {inhibited | maintainBelowThreshold | stopAtThres |
unconstrained}
no logging admin-status {inhibited | maintainBelowThreshold | stopAtThres |
unconstrained}

Command Syntax

inhibited causes all trap transmission and SYSLOG


messages to be suppressed - if a threshold has
been specified with the logging rate-limit
command, a warning message will be
displayed
maintainBelowThreshold causes trap transmission and SYSLOG
messages to be suppressed if the number of
traps/messages would exceed the threshold
specified with the logging rate-limit
command

Compass ID: 188656176 Version 5 MGBI 1-69


BSR 64000 Command Reference Guide Release 4.2.0

stopAtThres causes trap transmission SYSLOG messages


to cease at the threshold specified with the
logging rate-limit command - transmission
will not resume until the logging
admin-status command is reset to an option
other than "stopAtThres" or the threshold is
set to a higher value
unconstrained causes all traps and SYSLOG messages to be
transmitted - if a threshold has been specified
with the logging rate-limit command, a
warning message will be displayed

1-70 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging buffered
The logging buffered command sets the size of the logging buffer and the severity
level. The no logging buffered command returns to the default buffer size (256 KB).

Note: Use the show log command, in Privileged EXEC mode, to display
logged messages with the newest message displayed first.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging buffered <4096 -16777216> [alerts | critical | emergencies | errors |
informational | notifications | warnings]
no logging buffered <4096 -16777216> [alerts | critical | emergencies | errors |
informational | notifications | warnings]

Command Syntax

4096 -16777216 logging buffer size in bytes

Severity Levels and Descriptions

emergencies emergency conditions where the system is


unusable - reserved for vendor-specific, fatal
hardware or software errors that prevents
normal system operation and causes reporting
system to reboot (severity level = 0)
alert conditions where immediate action is needed
- a serious failure which causes the reporting
system to reboot but is not caused by
hardware or software malfunctioning
(severity level = 1)

Compass ID: 188656176 Version 5 MGBI 1-71


BSR 64000 Command Reference Guide Release 4.2.0

critical critical conditions - a serious failure that


requires immediate attention and prevents the
device from transmitting data but the system
could recover without rebooting
(severity level = 2)
error error conditions - a failure occurred that could
interrupt the normal data flow
(severity level = 3)
warnings warning conditions - a failure occurred that
could interrupt the normal data flow
(severity level = 4)
notifications normal but significant conditions - an event of
importance occurred which is not a failure
(severity level = 5)
information informational descriptive system messages -
an unimportant event, which could be helpful
for tracing normal operations
(severity level = 6)

Command Default
notifications, log file is 256 Kbytes

1-72 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging console
The logging console command enables the sending of system logging messages to the
console. Additionally, the logging of messages displayed on the console terminal can
be limited to a specified severity level. Use the no logging console command to
disable console logging.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging console [alerts | critical | debugging | emergencies | errors | informational
| notifications | warnings]
no [alerts | critical | debugging | emergencies | errors | informational |
notifications | warnings]

Command Syntax

Severity Levels and Descriptions

emergencies emergency conditions where the system is


unusable - reserved for vendor-specific, fatal
hardware or software errors that prevents
normal system operation and causes reporting
system to reboot (severity level = 0)
alert conditions where immediate action is needed
- a serious failure which causes the reporting
system to reboot but is not caused by
hardware or software malfunctioning
(severity level = 1)

Compass ID: 188656176 Version 5 MGBI 1-73


BSR 64000 Command Reference Guide Release 4.2.0

critical critical conditions - a serious failure that


requires immediate attention and prevents the
device from transmitting data but the system
could recover without rebooting (severity
level = 2)
error error conditions - a failure occurred that could
interrupt the normal data flow
(severity level = 3)
warnings warning conditions - a failure occurred that
could interrupt the normal data flow
(severity level = 4)
notifications normal but significant conditions - an event of
importance occurred which is not a failure
(severity level = 5)
information informational descriptive system messages -
an unimportant event, which could be helpful
for tracing normal operations
(severity level = 6)

Command Default
notifications

1-74 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging control docsis


The logging control docsis command allows the DOCSIS docsDevEvControlTable to
determine which severity logs go to which destinations.

Note: Any of the various logging <destination> <severity> commands in


place are overridden with this command.

The no logging control docsis disables the docsDevEvControlTable and


re-establishes CLI logging control. Any configurations previously set with the
logging <destination> <severity> command will now control which severity logs go
to which destinations.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging control docsis
no logging control docsis

Command Default
no logging control docsis

Compass ID: 188656176 Version 5 MGBI 1-75


BSR 64000 Command Reference Guide Release 4.2.0

logging default
The logging default command restores the default settings for all logging, including
logging <destination> <severity>, logging reporting, and EVT configurations.
■ The docsDevEvControlTable is restored to its DOCSIS-specified default values.
■ CLI logging control is re-established.
■ All logging evt configuration lines are removed from the running configuration
file.
■ Any logging <A.B.C.D> (for SYSLOG server) commands are unaffected.
■ The logging rate-limit command is unaffected.
■ The logging buffered <size> command is restored to its default size.
■ The command restores the following entries to the running configuration file:
no logging control docsis
logging buffered notifications
logging console error
no logging trap
no logging snmp-trap
logging facility local7

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging default

1-76 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging disable bpi_auth_invalid_messages


The logging disable bpi_auth_invalid_messages command disables logging of the
"BPI authorization invalid" DOCSIS error message. The no logging disable
bpi_auth_invalid_messages enables the logging of this error message. This
command is useful in situations where a high volume of this error message is being
generated and logged.

Group Access

System Administrator

Command Mode

Global Configuration

Command Line Usage

logging disable bpi_auth_invalid_messages


no logging disable bpi_auth_invalid_message

Command Default
Logging of BPI authorization invalid messages is enabled by default.

Compass ID: 188656176 Version 5 MGBI 1-77


BSR 64000 Command Reference Guide Release 4.2.0

logging disable bpi_auth_reject_messages


The logging disable bpi_auth_reject_messages command disables logging of the
"BPI authorization reject" DOCSIS error message. The no logging disable
bpi_auth_reject_messages enables the logging of this error message. This command
is useful in situations where a high volume of this error message is being generated
and logged.

Group Access

System Administrator

Command Mode

Global Configuration

Command Line Usage

logging disable bpi_auth_reject_messages


no logging disable bpi_auth_reject_messages

Command Default
Logging of BPI authorization reject messages is enabled by default.

1-78 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging disable bpi_map_reject_messages


The logging disable bpi_map_reject_messages command suppresses Map Reject
DOCSIS error messages being printed to the console but the error messages will still
be logged through the EVT system. The no logging disable
bpi_map_reject_messages command enables the console printing of Map Reject
error messages. This command is useful in situations where large numbers of these
error messages are being generated.

Group Access

System Administrator

Command Mode

Global Configuration

Command Line Usage

logging disable bpi_map_reject_messages


no logging disable bpi_map_reject_messages

Command Default
Logging of Map Reject messages is disabled by default.

Compass ID: 188656176 Version 5 MGBI 1-79


BSR 64000 Command Reference Guide Release 4.2.0

logging disable cm_ranging_fail_r103_0


The logging disable cm_ranging_fail_r103_0 command disables logging of the
"Unable to Successfully Range CM Retries Exhausted" DOCSIS error message. The
no logging disable cm_ranging_fail_r103_0 enables the logging of this error
message. This command is useful in situations where a high volume of this error
message is being generated and logged.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


logging disable cm_ranging_fail_r103_0
no logging disable cm_ranging_fail_r103_0

Command Default
Logging of these error messages is enabled by default.

1-80 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging evt clear


The logging evt clear command disables logging of all EVTs or disables EVT
logging for a specific logging destination (s). The no logging evt clear command
restores the default EVT logging configuration.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging evt clear {l|t|s|c} {<slot:group>} [<range>]
no logging evt clear {l|t|s|c} {<slot:group>} [<range>]

Command Syntax

l|t|s|c the log message destination:


l = local
t = trap
s = SYSLOG
c = console
slot the chassis slot number
group the name of an EVT group

range specific EVTs in the specified EVT group


such as '1+5+8-13'

Compass ID: 188656176 Version 5 MGBI 1-81


BSR 64000 Command Reference Guide Release 4.2.0

logging evt set


The logging evt set command configures EVT logging to log messages to a different
destination. The EVT messages logged can also be configured on a per-slot, per
group, or single, per-event basis. The no logging evt set command with no specified
EVT group name restores the original logging configuration changed with one or
more logging evt set commands.

Command Line Usage


logging evt set {l|t|s|c} {<slot:group>} [<range>]
no logging evt set {l|t|s|c} {<slot:group>} [<range>]

Command Syntax

l|t|s|c the log message destination:


l = local
t = trap
s = SYSLOG
c = console
slot the chassis slot number
group the name of an EVT group
range specific EVTs in the specified EVT group
such as '1+5+8-13'

1-82 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging facility
The logging facility command specifies the SYSLOG facility to which error
messages are sent. The no logging facility command reverts to the default of
"local7".
Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging facility {local 0 | local 1 | local 2 | local 3 | local 4 | local 5 | local 6 | local 7}
no logging facility

Command Syntax

local 0-7 local facility 0 through 7

Command Default
local 7

Compass ID: 188656176 Version 5 MGBI 1-83


BSR 64000 Command Reference Guide Release 4.2.0

logging on
The logging on command starts and stops the SYSLOG, and sends debug and error
messages to a logging process. The no logging on command stops sending debug or
error messages to a logging process.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging on
no logging on

Command Default
Disabled

1-84 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging rate-limit
The logging rate-limit command limits the rate of system messages and SNMP traps
logged per second. The no logging rate-limit command disables the rate limit.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging rate-limit <0-2147483647> <1-2147483647>
no logging rate-limit

Command Syntax

0-2147483647 the number of logged messages


1-2147483647 the rate of messages logged per second

Compass ID: 188656176 Version 5 MGBI 1-85


BSR 64000 Command Reference Guide Release 4.2.0

logging reporting
The logging reporting command specifies the recording mechanism for logging
reports.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging reporting {alert | critical | debug | default | emergency | error |
information | notice | warning} {all-clear | all-set | local | local-syslog | local-trap |
local-trap-syslog}
no logging reporting {alert | critical | debug | default | emergency | error |
information | notice | warning} {all-clear | all-set | local | local-syslog | local-trap |
local-trap-syslog}

Command Syntax

Severity Levels and Descriptions

emergency emergency conditions where the system is unusable


- reserved for vendor-specific, fatal hardware or
software errors that prevents normal system
operation and causes reporting system to reboot
(severity level = 0)
alert conditions where immediate action is needed - a
serious failure which causes the reporting system to
reboot but is not caused by hardware or software
malfunctioning
(severity level = 1)

1-86 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

critical critical conditions - a serious failure that requires


immediate attention and prevents the device from
transmitting data but the system could recover
without rebooting
(severity level = 2)
error error conditions - a failure occurred that could
interrupt the normal data flow
(severity level = 3)
warnings warning conditions - a failure occurred that could
interrupt the normal data flow
(severity level = 4)
notice normal but significant conditions - an event of
importance occurred which is not a failure
(severity level = 5)
information informational descriptive system messages - an
unimportant event, which could be helpful for
tracing normal operations
(severity level = 6)
debug debugging messages (severity level = 7)
default set all the severity levels to default

Logging Location Options

local log messages to local-nonvolatile memory


(NVRAM)
local-syslog log messages to local NVRAM and the SYSLOG
server

local-trap log messages, excluding the specified trap level, to


local NVRAM
local-trap-syslog log messages, excluding the specified trap level, to
local NVRAM and a SYSLOG server

Compass ID: 188656176 Version 5 MGBI 1-87


BSR 64000 Command Reference Guide Release 4.2.0

all-clear unsets all logging locations for the report.


all-set sets all logging locations for the report.

Note: Debug messages will not be reported unless debugging has been
turned on for a subsystem with the corresponding CLI debug command (e.g.
debug snmp).

1-88 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging reporting default


The logging reporting default command is used to return to the default destination/
severity log reporting configuration.

Note: The default destination/severity log reporting configuration depends on


which logging control mode is enabled.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging reporting default

Compass ID: 188656176 Version 5 MGBI 1-89


BSR 64000 Command Reference Guide Release 4.2.0

logging session
The logging session command enables the transmission of system logging messages
to the current login session. The no logging session command disables the
transmission of system logging messages to the current login session.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


logging session
no logging session

1-90 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging snmp-trap
The logging snmp-trap command logs all SNMP traps or logs SNMP traps of a
specified severity level and higher.

Note: The logging snmp-trap command limits SNMP trap logging to SNMP
traps with a level up to and including the severity level specified with this
command.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging snmp-trap [alerts | critical | emergencies | errors | informational |
notifications | warnings]
no logging snmp-trap [alerts | critical | emergencies | errors | informational |
notifications | warnings]

Command Syntax

Severity Levels and Descriptions

emergencies emergency conditions where the system is unusable -


reserved for vendor-specific, fatal hardware or software
errors that prevents normal system operation and causes
reporting system to reboot (severity level = 0)
alert conditions where immediate action is needed - a serious
failure which causes the reporting system to reboot but is
not caused by hardware or software malfunctioning
(severity level = 1)

Compass ID: 188656176 Version 5 MGBI 1-91


BSR 64000 Command Reference Guide Release 4.2.0

critical critical conditions - a serious failure that requires


immediate attention and prevents the device from
transmitting data but the system could recover without
rebooting
(severity level = 2)
error error conditions - a failure occurred that could interrupt
the normal data flow (severity level = 3)
warnings warning conditions - a failure occurred that could
interrupt the normal data flow
(severity level = 4)
notifications normal but significant conditions - an event of
importance occurred which is not a failure
(severity level = 5)
information informational descriptive system messages - an
unimportant event, which could be helpful for tracing
normal operations
(severity level = 6)

1-92 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logging source-interface loopback


The logging source-interface loopback command allows an operator to control the
source IP address of SYSLOG packets generated by the BSR by specifying a
loopback interface as the source IP address for SYSLOG packets. The normal
convention for generated SYSLOG packets is to set the source IP address equal to the
IP address of the outgoing interface. The logging source-interface loopback
command overrides this convention and instead uses the IP address of the specified
loopback interface. The no logging source-interface loopback command removes
the loopback source interface.

Note: Before using the logging source-interface loopback command, the


loopback interface must be configured and assigned an IP address.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


logging source-interface loopback<1-255>
no logging source-interface loopback

Command Syntax

1-255 the loopback interface number

Compass ID: 188656176 Version 5 MGBI 1-93


BSR 64000 Command Reference Guide Release 4.2.0

logging trap
The logging trap command filters messages logged to the SYSLOG servers based on
severity. The command limits the log messages sent to a SYSLOG server to messages
with a severity level up to and including the severity level specified with this
command. The no logging trap command disables the logging of these messages to
the SYSLOG servers.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


logging trap {alerts | critical | emergencies | errors | informational | notifications
| warnings}
no logging trap {alerts | critical | emergencies | errors | informational |
notifications | warnings}

Command Syntax

Severity Levels and Descriptions

emergencies emergency conditions where the system is


unusable - reserved for vendor-specific, fatal
hardware or software errors that prevents
normal system operation and causes reporting
system to reboot
(severity level = 0)
alert conditions where immediate action is needed
- a serious failure which causes the reporting
system to reboot but is not caused by
hardware or software malfunctioning
(severity level = 1)

1-94 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

critical critical conditions - a serious failure that


requires immediate attention and prevents the
device from transmitting data but the system
could recover without rebooting
(severity level = 2)
error error conditions - a failure occurred that could
interrupt the normal data flow
(severity level = 3)
warnings warning conditions - a failure occurred that
could interrupt the normal data flow
(severity level = 4)
notifications normal but significant conditions - an event of
importance occurred which is not a failure
(severity level = 5)
information informational descriptive system messages -
an unimportant event, which could be helpful
for tracing normal operations
(severity level = 6)

Command Default
notifications level (severity=5)

Compass ID: 188656176 Version 5 MGBI 1-95


BSR 64000 Command Reference Guide Release 4.2.0

login
The login command logs a user on to the system.

Group Access
All

Command Mode
User EXEC

Command Line Usage


login [<WORD>]

Command Syntax

WORD 1 to 16 character username

1-96 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

logout
The logout command logs a user out of the system. Use the logout command to end
the current session. The logout command is used the same way as the exit command.
In Privileged EXEC mode, use the logout command with a character argument to log
a particular user out of the system. Only users with administrative privileges can log
other users out.

Group Access
All

Command Mode
User EXEC and Privileged EXEC

Command Line Usage


logout [<session-id> | <username>] (Privileged EXEC mode only)
logout (User EXEC mode only)

Command Syntax

session-id the session ID number of the user to


log out
username the name of the user to log out

Compass ID: 188656176 Version 5 MGBI 1-97


BSR 64000 Command Reference Guide Release 4.2.0

macro
The macro command defines a group of existing CLI commands that can be executed
by entering the macro name at the command line. The no macro command removes a
macro from the macro list.

Group Access
All

Command Mode
All modes except User EXEC and Privileged EXEC

Command Line Usage


macro <WORD> {Variable | <WORD>} ... [Variable | <WORD>]}}
no macro <WORD>

Command Syntax

WORD the macro name


Variable macro variables
WORD the CLI commands - CLI commands must be
added one at a time

1-98 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

memory checkzero
The memory checkzero command enables memory checking on the BSR.

Note: Memory checking can use considerable BSR system resources.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


memory checkzero <0-1>

Command Syntax

0-1 1 = enable Memory Checking


0 = disable Memory Checking

Compass ID: 188656176 Version 5 MGBI 1-99


BSR 64000 Command Reference Guide Release 4.2.0

message
The message command sends a message to a specified active user.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


message <WORD> <WORD>

Command Syntax

WORD session number or username


WORD message to send

1-100 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

network-clock-select
The network-clock-select command configures network timing parameters. The no
network-clock-select command disables network timing parameters.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


network-clock-select {1 | 2 } {bits | pos <X/Y>} {e1 {pcm31-crc | pcm31-hdb3 |
pcm31-nocrc}} {a | b}}} {t1 {esf-b8zs | sf-d4 | slc96 | t1dm }} {a | b}}}
no network-clock-select {1 | 2 } {bits | pos <X/Y>} {e1 {pcm31-crc | pcm31-hdb3
| pcm31-nocrc}} {a | b}}} {t1 {esf-b8zs | sf-d4 | slc96 | t1dm }} {a | b}}}

Command Syntax

1 primary priority
2 secondary priority
bits E1/T1 BITS clock
pos <X/Y> BSR POS interface slot and port
e1 configure interface as E1
pcm31-crc PCM-31 framing with AMI line coding, CRC
Multiframe

pcm31-hdb3 PCM-31 framing with HDB3 line coding,


CRC Multiframe

pcm31-nocrc PCM-31 framing with AMI line coding, No


CRC Multiframe

a select port A
b select port B

Compass ID: 188656176 Version 5 MGBI 1-101


BSR 64000 Command Reference Guide Release 4.2.0

t1 configure interface as T1
esf-b8zs ESF framing with B8ZS line coding
sf-d4 SF-D4 framing with AMI line coding
slc96 SLC96 framing with AMI line coding
t1dm T1DM framing with AMI line coding

1-102 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

network-clock-select revertive
The network-clock-select revertive command enables revertive mode. The no
network-clock-select revertive command disables revertive mode.
Revertive mode enables the automatic switch-over to the highest priority clock source
available if the current clock goes offline

Note: In order for revertive mode to work properly, you must configure both
the primary and secondary clock sources. If there are no clock sources
configured, the Stratum 3 module on the SRM will remain in free-running
mode.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


network-clock-select revertive
no network-clock-select revertive

Compass ID: 188656176 Version 5 MGBI 1-103


BSR 64000 Command Reference Guide Release 4.2.0

more
The more command displays the contents of a specified file.
Use the more nvram:startup-config command to view the startup configuration file
in NVRAM. The config_file environmental table will be displayed if the startup
configuration file is not displayed. The user can determine the status of the file which
is either a complete or a distilled version of the configuration file.
Use the more system:running-config command to view the running configuration
file. The more system:running-config command displays the version of the software
and any changes that were previously made.

Note: You can use the more command to view files on remote systems.

Group Access
System Administrator

Command Mode
All modes except User EXEC

Command Line Usage


more {flash: <filename> | ftp: <filename> | nvram: <filename> |
nvram:startup-config | startup-config | system:startup-config } [ | {begin |
exclude | include} {<WORD>} | {count | count-only}]
more {flash: <filename> | ftp: <filename> | nvram: <filename> |
nvram:startup-config | startup-config | system:startup-config } [ | {count |
count-only}]

Command Syntax

filename file name

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string

1-104 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

exclude filter for output that excludes the specified


string
include filter for output that includes the specified
string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-105


BSR 64000 Command Reference Guide Release 4.2.0

page
The page command controls the scrolling of system output displays.

Group Access
All

Command Mode
All modes

Command Line Usage


page {off | on}

Command Syntax

off scrolling continues until the end of


the display without stopping
on controlled scrolling through the use
of the Enter/Return key and spacebar

Command Default
on

1-106 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

password
The password command establishes a password that must be specified by users
attempting to establish a console or telnet session with the BSR. A console or telnet
session will not be established if the correct password is not specified by the user. The
no password command removes the password.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


password {console | telnet}[0 | 7] <WORD>
no password {console | telnet}

Command Syntax

console password for console connections


telnet password for telnet connections
0 specifies an UNENCRYPTED
password
7 specifies a HIDDEN password
WORD the password (31 character
maximum, 78 character maximum
for option 7) - enclosed with double
quotes if the key contains spaces).
The "%" and "!" characters must not
be used.

Compass ID: 188656176 Version 5 MGBI 1-107


BSR 64000 Command Reference Guide Release 4.2.0

privilege restricted
The privilege restricted command designates a specific CLI command or group of
commands as belonging to the "restricted" user group. Only users in the "restricted"
user group have read-write access to commands designated as "restricted".

Note: By default, users in the "restricted" user group will not be able to
execute any commands unless they have been specified as "restricted" with
the privilege restricted command.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


privilege restricted {<WORD> [<...WORD>] | all}
no privilege {<WORD> [<...WORD>] | all}

Command Syntax

WORD the command whose privilege level is to be


changed to "restricted" - multiple commands
can be specified separated by spaces
all changes the privilege level to "restricted" for
all of the sub-options of a given command

1-108 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

radius-server
The radius-server command configures a RADIUS client to allow communication
with a RADIUS server. Configuring a RADIUS client involves the following tasks:
■ specifying the RADIUS server
■ defining the shared encryption key for authentication between the RADIUS
server and the RADIUS client
■ specifying the number of retry attempts if there is no response from an active
RADIUS server
■ specifying the time interval between retry attempts if there is no response from
from an active RADIUS server

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


radius-server host {<A.B.C.D>|<Hostname>} [auth-port <0-65535> [primary]]
radius-server key <WORD>
radius-server retransmit <0-100>
radius-server timeout <1-1000>

no radius-server host {<A.B.C.D>|<Hostname>} [auth-port]


no radius-server key
no radius-server retransmit
no radius-server timeout

Command Syntax

host specifies a RADIUS server


A.B.C.D the IP address of the RADIUS server

Compass ID: 188656176 Version 5 MGBI 1-109


BSR 64000 Command Reference Guide Release 4.2.0

Hostname the hostname of the RADIUS server


auth-port 0-65535 specify a UDP port number for RADIUS
authentication - default port number is 1812
primary select this server as the primary RADIUS
server
key WORD text of the encryption key shared between the
RADIUS client and the RADIUS servers -
Motorola recommends a 22 character
minimum
retransmit 0-100 specify the number of retry attempts if there is
no response from an active RADIUS server -
default is 3 retries
timeout 1-1000 specify the time interval in seconds between
retry attempts if there is no response from
from an active RADIUS server - default is 5
seconds

1-110 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

radius-server source-interface loopback


The radius-server source-interface loopback command allows an operator to
control the source IP address of Radius authentication protocol packets generated by
the BSR by specifying a loopback interface as the source IP address for Radius
authentication protocol packets. The normal convention for generated Radius
authentication protocol packets is to set the source IP address equal to the IP address
of the outgoing interface. The radius-server source-interface loopback command
overrides this convention and instead uses the IP address of the specified loopback
interface. The no radius-server source-interface loopback command removes the
loopback source interface.

Note: Before using the radius-server source-interface loopback


command, the loopback interface must be configured and assigned an IP
address.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


radius-server source-interface loopback <1-255>
no radius-server source-interface loopback

Command Syntax

1-255 the loopback interface number

Compass ID: 188656176 Version 5 MGBI 1-111


BSR 64000 Command Reference Guide Release 4.2.0

redundancy cmts
The redundancy cmts command enables CMTS redundancy protection for a primary
CMTS. The slot number of the primary CMTS must be in the range 0..5 or 9..14. Slot
15 may not be used for CMTS redundancy.
The no redundancy cmts command disables CMTS redundancy protection for a
slot.The slot number must be a primary slot number in the range 0..5 or 9..14. By
default, redundancy is automatically enabled for all installed CMTS modules.

Note: It is important to save any configuration changes made to a primary


CMTS interface in the running configuration to the startup configuration with
the copy running-config startup-config command. This ensures that any
configuration changes are guaranteed to be maintained when a Primary
CMTS Module switches over service to the Standby CMTS Module or the
Standby CMTS Module gives back service to a Primary CMTS Module.

If a CPE that is statically configured with an IP address instead of obtaining


and IP address via DHCP registers on an active CMTS card, then a
switchover occurs, the arp entry will not be deleted if the CM de-registers. If
the CM attempts to re-register, the CPE will not pass data until the arp
timeout expires.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


redundancy cmts <NUM>
no redundancy cmts <NUM>

Command Syntax

NUM the BSR 64000 CMTS slot number

1-112 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Default
redundancy enabled

Compass ID: 188656176 Version 5 MGBI 1-113


BSR 64000 Command Reference Guide Release 4.2.0

redundancy force-switchover cmts


The redundancy force-switchover cmts command forces a CMTS to switchover to
the CMTS that provides redundancy for it. For a primary slot in the range 0..5, 9..14,
the spare CMTS in slot 6 takes over. For slot 6, the spare CMTS gives back operation
to whatever primary CMTS for which it was operating.

Note: After the first administrative (manual) switchover you perform for BSR
64000 systems employing Redundant SRMs, Redundant CMTS modules, or
both; wait a minimum of 5 minutes for SRMs and 60 seconds for CMTS
modules before initiating another administrative switchover.

It is important to save any configuration changes made to a primary CMTS


interface in the running configuration to the startup configuration with the
copy running-config startup-config command. This ensures that any
configuration changes are guaranteed to be maintained when a Primary
CMTS Module switches over service to the Standby CMTS Module or the
Standby CMTS Module gives back service to a Primary CMTS Module.

If a CPE that is statically configured with an IP address instead of obtaining


and IP address via DHCP registers on an active CMTS card, then a
switchover occurs, the arp entry will not be deleted if the CM de-registers. If
the CM attempts to re-register, the CPE will not pass data until the arp
timeout expires.

Only users with read/write privileges are allowed to use the redundancy
force-switchover cmts command. If a user has read-only privileges, the
command is not executed and a message is displayed informing the user of
insufficient privileges.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


redundancy force-switchover cmts <NUM>

1-114 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Syntax

NUM the BSR 64000 CMTS slot number

Compass ID: 188656176 Version 5 MGBI 1-115


BSR 64000 Command Reference Guide Release 4.2.0

redundancy force-switchover srm


The redundancy force-switchover srm command allows an administrative
switchover from the active SRM to the standby SRM and will cause control of the
BSR 64000 to pass from the active SRM to the standby SRM.

Note: After the first administrative (manual) switchover you perform for BSR
64000 systems employing Redundant SRMs, Redundant CMTS modules, or
both; wait a minimum of 5 minutes for SRMs and 60 seconds for CMTS
modules before initiating another administrative switchover.

It is important to save any configuration changes made to a primary SRM


interface in the running configuration to the startup configuration with the
copy running-config startup-config command. This ensures that any
configuration changes are guaranteed to be maintained when a Primary SRM
Module switches over service to the Standby SRM Module or the Standby
SRM Module gives back service to a Primary SRM Module.

Only users with read/write privileges are allowed to use the redundancy
force-switchover srm command. If a user has read-only privileges, the
command is not executed and a message is displayed informing the user of
insufficient privileges.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


redundancy force-switchover srm

1-116 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

reload
The reload command reloads the operating system. The reload command is most
often used to reload upgraded software.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


reload [ at <hh:mm:> <LINE> <MONTH> | cancel | fast | in countdown | reason
<LINE>]

Command Syntax

at reloads at a specific time


hh:mm specific hour and minute to reload
MONTH name of the month
cancel cancels a pending reload
fast reloads the system immediately
in reloads after a time interval

countdown time interval in mm or hh:mm


reason LINE text of the reason to reload

Compass ID: 188656176 Version 5 MGBI 1-117


BSR 64000 Command Reference Guide Release 4.2.0

reload switched
A Hitless Upgrade is performed by distributing new software image(s) to all modules
in the BSR 64000 chassis via the update chassis command and then using the reload
switched command to sequentially reload the image to all modules in the chassis.
The reload switched command performs a sequential reload of every module resident
in the BSR chassis as part of a hitless upgrade. While each module is reloading, its
operation will be performed by another module.

Note: The reload switched command can be used by itself (without the
update chassis command) to perform a hitless reload (not upgrade) of the
chassis.

The reload switched command will not be executed in the following circumstances:
■ a non-switched reload is currently pending.
■ there are modules cards in the BSR chassis that are not in either the RUN or
STBY state.
■ the BSR chassis does not support both SRM and CMTS redundancy.

Warning: If a user attempts a Hitless Upgrade between archives having


different HU Software Group numbers, the following warning message is
displayed:

WARNING - Attempting Hitless Upgrade between two


incompatible archives.
Recommended aborting the "reload switched" command
Abort the "switched reload" ? [yes/no]:

The user is given the choice of proceeding with the Hitless Upgrade or
aborting the operation with the recommendation being to abort.

1-118 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

CLI commands that would interfere with operation of the reload switched command
will not be executed during the switched reload procedure. These commands are:
■ balance
■ boot
■ copy
■ download (debug mode command)
■ update
■ redundancy cmts enable/disable
■ redundancy force srm/cmts
■ reload (except reload cancel)
■ reset
■ shutdown (if configuring an HSIM interface)
■ no shutdown (if configuring HSIM interface)
During a switched hitless upgrade reload, the above commands will not execute even
if the command does not apply to the module currently being reloaded. If an attempt is
made to use these commands, the system will display a message similar to the
following:

This command may not be performed while a switched reload is in progress. Enter
.
‘show reload’ to display the current progress of the switched reload. Enter ‘reload
cancel’ to cancel the switched reload.

Group Access
System Administrator

Command Mode
Prviledged EXEC

Command Line Usage


reload switched [check | hsim-delay <15-120> | resume [ hsim-delay <15-120>]]

Compass ID: 188656176 Version 5 MGBI 1-119


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

check check the system to see if Hitless Upgrade is


supported
hsim-delay 15-120 the number of seconds (15-120) that Hitless
Upgrade waits between the end of the reload
of one HSIM card and the start of the reload
of the next HSIM card - this time allows the
routing tables to be populated before
reloading the next HSIM card
resume resume a cancelled or terminated switched
reload

The following is an example of typical output from the reload switched check
command:\

Switched reload validation summary:

System card types and states meet requirements of Hitless Upgrade.

Please verify the software compatibility between the current and


target application archives by checking the Hitless Upgrade Group
numbers and making sure that they are the same in both the archives.

eg - archive 4.1.0T00P48H04KRAU.Z - HU group is 04

For boot rom upgrade refer to release documentation to verify


suitablity for Hitless Upgrade.

Please check user documentation to insure that hardware revision


numbers meet the requirements of the new software archive.

It is the user's responsibility to insure that multi-path routes


to the desired destinations have been configured.
The software does not verify this.

1-120 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Note: For the reload switched resume command, the hsim-delay option
has the same functionality as described above with one important difference;
If the hsim-delay option is not specified with the reload switched resume
command, then the hsim-delay value used during Hitless Upgrade will be
the hsim-delay value specified with the previous reload switched
hsim-delay command or the default hsim-delay value of 15 seconds.

For example, the reload switched command is started with an hsim-delay


of 35 secondS.

reload switched hsim-delay 35

For some reason Hitless Upgrade is either aborted by the user or terminates
due to some issue. When the issue has been addressed and Hitless Upgrade
is resumed, the following scenarios will apply:

• if the reload switched resume hsim-delay command is used without


explicitly specifying an hsim-delay value, Hitless Upgrade uses the
previous value of 35 seconds for the hsim-delay.
• if the reload switched resume command is used with an hsim-delay
value of 25 seconds (reload switched resume hsim-delay 25),
Hitless Upgrade will use the new specified value of 25 seconds for the
hsim-delay.

Command Default
hsim-delay = 15 seconds

Compass ID: 188656176 Version 5 MGBI 1-121


BSR 64000 Command Reference Guide Release 4.2.0

repeat
The repeat command repeats a command or series of commands

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


repeat {<NUM>} {<WORD> [...<WORD>] | delay <NUM> {<WORD>
[...<WORD>]}}

Command Syntax

NUM the number of times to repeat the command or


series of commands
WORD the command or series of commands
delay NUM the delay (in seconds) between the execution
of each command

1-122 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

reset
The reset command resets all slots or a specific slot in the BSR 64000 chassis.

Note: It is important to save any configuration changes made in the running


configuration to the startup configuration with the copy running-config
startup-config command before resetting a slot. This ensures that any
configuration changes are guaranteed to be maintained after a slot is reset.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


reset {all | slot <0-6, 8-15>}

Command Syntax

all reset all slots in the BSR 64000 chassis


slot 0-6, 8-15 reset a specific slot

Compass ID: 188656176 Version 5 MGBI 1-123


BSR 64000 Command Reference Guide Release 4.2.0

service password-encryption
The service password-encryption command enables password encryption. The no
service password-encryption disables password encryption.
The service password-encryption command will also encrypt previously specified
passwords in the running-config file that are currently unencrypted.

Note: Once passwords appearing in the running configuration file are


encrypted, they cannot be unencrypted using the no service
password-encryption command.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


service password-encryption
no service password-encryption

Command Default
No encryption

1-124 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

session-timeout
The session-timeout command lets you specify the length of time (in minutes) before
the BSR terminates any inactive session. An inactive session is a session has received
no user input or system output during the specified time interval.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


session-timeout {console | telnet} <0-30>

Command Syntax

console specifies console sessions


telnet specifies telnet sessions
0-30 length of time in minutes before the
session is terminated automatically
by the BSR

Command Default
5 minutes for telnet sessions
0 for console sessions (session maintained indefinitely)

Compass ID: 188656176 Version 5 MGBI 1-125


BSR 64000 Command Reference Guide Release 4.2.0

session-window set
The session-window set command specifies the height and width parameters of the
current CLI session window.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


session-window set {height <4-128> | width <16-384>}

Command Syntax

height 4-128 sets window height in number of lines


width 16-384 sets window width in number of columns

1-126 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

set bandwidth-factor
The set bandwidth-factor command configures the percentage of bandwidth that
may be used by a Ethernet or Gigabit Ethernet interface. The no set
bandwidth-factor command restores the default bandwidth factor of 100%.

Group Access
All

Command Mode
Interface Configuration (Ethernet and Gigabit Ethernet interfaces only)

Command Line Usage


set bandwidth-factor <10-100>
no set bandwidth-factor

Command Syntax

10-100 the percentage of bandwidth that can be used


(min 10 Mbps)

Command Default
100%

Compass ID: 188656176 Version 5 MGBI 1-127


BSR 64000 Command Reference Guide Release 4.2.0

set stats poll


The set stats poll command specifies a polling interval in seconds for various BSR
slot statistics. The no set stats poll command disables slot statistics polling.

Group Access
All

Command Mode
Slot Configuration

Command Line Usage


For the SRM module in slot 7:
set stats poll update <1-3600>
no set stats poll update <1-3600>

For all Ethernet or Gigabit Ethernet slots:


set stats poll {bmeth | fastpath {ip | mpls} | gige | lcpu | update | xfabric}
{<1-3600>}
no set stats poll {bmeth | fastpath {ip | mpls} | gige | lcpu | update | xfabric}
{<1-3600>}

For all CMTS slots:


set stats poll {cmts | update | xfabric} {<1-3600>}
no set stats poll {cmts | update | xfabric} {<1-3600>}

Command Syntax

bmeth buffer manager Ethernet statistics


cmts CMTS Statistics
fastpath ip Fastpath forwarding IP statistics
fastpath mpls Fastpath forwarding MPLS statistics

1-128 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

gige Gigabit Ethernet statistics


lcpu local CPU Ethernet statistics
update report statistics to SRM
xfabric switch fabric statistics
1-3600 poll time in seconds

Compass ID: 188656176 Version 5 MGBI 1-129


BSR 64000 Command Reference Guide Release 4.2.0

show aliases
The show aliases command displays any one of the following:
■ Aliases for commands in all modes
■ Aliases for commands in a specific mode.
■ Aliases for all commands that begin with, include, or exclude a specified string.
■ Aliases for a specific mode that begin with, include, or exclude a specified string.
The following is an example of typical screen output from the show aliases
command:

Privilege mode aliases:


getHa22 copy ftp://150.21.2.61/pub/tter/tterHa22.Z nvram:
getSf copy ftp://10.14.37.103/pub/tter/tter.Z nvram:tter.Z
ccm clear cable modem all reset
ccmoff clear cable modem offline
getElf copy ftp://10.14.37.103/pub/tter/vxWorks.Z.elf nvram:vxWorks.Z.elf
getVtag copy ftp://10.14.37.103/pub/tter/tterVtag.Z nvram:tterVtag.Z

System-wide aliases:
scmst show cable modem summary total
scm show cable modem

Group Access
All

Command Mode
All except User EXEC

Command Line Usage


show alias [conf | exec | priv] [ | {begin | exclude | include} {<WORD>} | {count |
count-only}]
show alias [conf | exec | priv] [ | {count | count-only}]

1-130 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Syntax

conf specifies aliases for Global


Configuration mode
exec specifies aliases for User EXEC
mode
priv specifies aliases for Privileged
EXEC mode
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 1-131


BSR 64000 Command Reference Guide Release 4.2.0

show boot
The show boot command lists the boot parameters. Use the show boot command to
display the contents of the BOOT environment variables and the configuration
register setting. The following is an example of typical screen output from the show
boot command:

Boot location currently set to nvram:tter.Z

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show boot [ | {begin | exclude | include} {<WORD>} | {count | count-only}]
show boot [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)

begin filter for output that begins with the


specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

1-132 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show chassis alias


The show chassis alias command to show the alias name for the BSR chassis.

Group Access
All

Command Mode
All modes

Command Line Usage


show chassis alias

Compass ID: 188656176 Version 5 MGBI 1-133


BSR 64000 Command Reference Guide Release 4.2.0

show chassis assetid


The show chassis assetid command is used to view the asset ID number assigned to
the BSR.

Group Access
All

Command Mode
All modes

Command Line Usage


show chassis assetid

1-134 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show chassis serial-num


The show chassis serial-num command is used to view the serial number assigned to
your BSR 64000.

Group Access
All

Command Mode
All modes

Command Line Usage


show chassis serial-num

Compass ID: 188656176 Version 5 MGBI 1-135


BSR 64000 Command Reference Guide Release 4.2.0

show chassis status


The show chassis status command is used to learn the operational status of the
individual modules and upper and lower fan trays on the BSR 64000. This command
also allows you to determine where modules are populated on the BSR. The following
is an example of typical screen output from the show chassis status command:

Current Time: 10/27-07:54:45


Running archive: NVRAM:archive3.Z

Slot Type Sub Red State RM IO UpTime LastUpTime Success Failure


0 - - - - 0 0
1 CMTS 2x8(2.0) 6 RUN x x 19:06:40 1 1
2 CMTS 2x8 - RUN x - 19:06:30 1 1
3 - - - - 0 0
4 - - - - 0 0
5 CMTS 1x8 6 RUN x x 19:08:48 1 1
6 CMTS 2x8(2.0) - stby x x 19:06:30 0 1
7 SRM3 - RUN x x 19:11:32 0 0
8 - - - - 0 0
9 - - - - 0 0
10 - - - - 0 0
11 - - - - 0 0
12 - - - - 0 0
13 - - - - 0 0
14 - - - - 0 0
15 HSIM ETH8 - RUN x x 19:09:25 1 1

The table below describes the displayed fields:

Slot module slot number from 0 to 15


Type the type of module inserted into the BSR 64000. HSIM indicates
either the POS or Gigabit Ethernet Network Interface modules
(NIMs)- CMTS indicates the DOCSIS module - SRM indicates
the Supervisory Routing Module (SRM3 or SRM4)
Sub the module subtype - 1X4, ETH1, ETH8, etc.

1-136 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Red indicates the slot number of the redundant backup module


State indicates the current operational state of the module. RUN
indicates that the module is fully operational. Flash indicates
that the module is updating its FLASH memory. boot indicates
that the module is currently in a boot state
RM resource module. An x indicates that this module is operational.
A - (dash) indicates that this module is not currently operational
I/O physical module (IO module). An x indicates that this module is
operational. A - (dash) indicates that this module is not currently
operational
UpTime if the system clock has been set using the clock set command,
the UpTime field displays the amount of time that the module
has been operational. The time is expressed in hh:mm:ss format
LastUpTime if the module is down, the last operational time for the module
displays.
Success the module booted successfully.
Failure the module failed the boot process.

Compass ID: 188656176 Version 5 MGBI 1-137


BSR 64000 Command Reference Guide Release 4.2.0

Note: The value displayed with the sysUpTime SNMP MIB object and the
"UpTime" field as displayed in the show chassis status command output
represent different system up time values.

The sysUpTime MIB object represents the amount of time that the SNMP
Agent has been running. This is relative to the time that the SNMP Agent was
last restarted. Initially, this will be close to the time that the SRM module last
restarted because the SNMP Agent resides on the SRM module. However, if
the SNMP Agent itself is restarted with the snmp-server shutdown or
snmp-server enable CLI commands, the sysUpTime will be reset to zero.

The "UpTime" value displayed in the show chassis status command output
represents the amount of time that the modules have been running relative to
the last reboot of the chassis or last reset of the modules. These system time
values may be different for each module, even after a reboot of the entire
chassis, because not all modules complete their initialization at the same
time. Also, the system time values will be different if individual modules are
restarted via the CLI or are manually inserted at a later time. However, the
per-module 'UpTime" values displayed in the show chassis status
command output are NOT affected by the snmp-server shutdown and
snmp-server enable commands because these values are relative to the
module’s boot time not to the SNMP Agent’s boot time.

Group Access
All

Command Mode
All modes

Command Line Usage


show chassis status [ | {begin | exclude | include} {<WORD>} | {count |
count-only}]
show chassis status [ | {count | count-only}]

1-138 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Note: Do not truncate the show chassis status command (ex. sh ch st)
when in Interface Configuration Mode. Truncating the show chassis status
command when in Interface Configuration Mode will produce the expected
command output but will also place the CLI into Global Configuration Mode.

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 1-139


BSR 64000 Command Reference Guide Release 4.2.0

show clock
The show clock command shows the system clock. The following is an example of
typical screen output from the show clock command:

TUE JAN 24 10:05:05 2006


Timezone eastern, -5 hr 0 min offset from UTC

Group Access
All

Command Mode
All modes

Command Line Usage


show clock [ | {begin | exclude | include} {<WORD>} | {count | count-only}]
show clock [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)

begin filter for output that begins with the


specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

1-140 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show core log


The show core log command addresses the problem of logged exception data being
removed from a log file as other logged data is added and the log file’s capacity is
exceeded before the exception log data can retrieved. In addition to logging exception
data in the regular log file, the exception data is stored in a core log file. This log file
can be viewed with the show core log command and cleared with the clear core log
command.
■ The core log file stores up to 400 lines of exception data, occupying a maximum
102.4 KB file size in FLASH. The filename is core.log.
■ After a reload, a new core.log file is created, and the old core.log file is
backed up to a file named core.old.
■ The core.old file can be viewed in a text editor.
The following displays typical output from the show core log command:

Preparing log file for reading ...


[07/21-18:14:22.4807/21-18:13:41.89- 08:EXC]-E- Reformating Exception Storage
[07/21-18:14:22.3607/21-18:13:41.89- 08:EXC]-E- tRDNc Timeout:0
[07/21-18:14:22.3407/21-18:13:41.89- 08:EXC]-E- Tasks blocked on semaphore 0xfffff80:
[07/21-18:14:22.3307/21-18:13:41.89- 08:EXC]-E- tTnetRDNtd Timeout:0
[07/21-18:14:22.2907/21-18:13:41.89- 08:EXC]-E- Tasks blocked on semaphore 0xb17d88c:
[07/21-18:14:22.2807/21-18:13:41.89- 08:EXC]-E- EventMgr Timeout:28

Group Access
All

Command Mode
All mores except for User EXEC

Command Line Usage


show core log

Compass ID: 188656176 Version 5 MGBI 1-141


BSR 64000 Command Reference Guide Release 4.2.0

show evt
The show evt command displays EVT counts for all EVT groups, a specific EVT
group, EVT group counts that only occur on a specific BSR slot, or individual event.
By default, only EVT groups with non-zero event counts are displayed. The following
is an example of typical screen output from the show evt command:

Slot 0: CRA - Cra event system EVT Base : 4608


Num Title Count Sv Logging
--- ---------------------------------------- ---------- -- --------
1 rcvd crm msg 144 D
14 Received CA Certificate SET request 3 D
18 Sent GET CA Cert. message to CRM 1 D
23 cmtsSendCrmCmAdd 12 D
24 cmtsSendCrmCmDel 8 D
25 cmtsSendCrmCmReg 12 D

Slot 0: MACCFG - macCfg event system EVT Base : 9984


Num Title Count Sv Logging
--- ---------------------------------------- ---------- -- --------
1 Flap tree add success 3 D
3 Flap tree delete success 3 D
8 FlapListAdd success 3 D
10 FlapListDel success 3 D
15 FlapListAgeout success 2 D
18 set cmh flap rowstatus to active 3 D
19 set cmh flap rowstatus to destroy 3 D
22 set cmh flap mac addr 4 D

In addition to the BSR 64000 slot number, EVT group name, and EVT base number,
the following information is displayed

Num the EVT number - EVTs are numbered from 1


to 255 (maximum)
Title the title of the individual event

1-142 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Count the number of times the EVT has occurred


since the count was last reset
Sv the severity level of the event - in order of
increasing severity, the abbreviations are:

D = Debug
I = Informational
N = Notice
W = Warning
E = Error
C = Critical
A = Alert
E = Emergency
Logging indicates to which logging subsystems EVT
messages are forwarded:

L = Local log file


T = Trap to SNMP
S = SYSLOG
C = Console

Group Access
All

Command Mode
All modes

Command Line Usage


show evt [<NUM> | <WORD>]

Compass ID: 188656176 Version 5 MGBI 1-143


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the chassis slot number


WORD the name of an EVT group - refer to Table 1-2

1-144 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Table 1-2 EVT Event Subsystems


memchk Memory Check drmr DOCSIS Redundancy accdhc ACC DHCP
net Network Manager SRM reg REG
ipevt IP Event System swr Switched Reload range Range
tpt Testpoint Facility tacacs TACACS+ dpm Data Path Mapping
arp ARP vrfmgr VRF Manager dra DOCSIS Redundancy
rpt SRM Repeater ipsec Agent
IPSEC
im Interface Manager ubsha
sys SYS UTIL Upstream Scheduler RTR
icp ICP
snmpa SNMP Agent ubsbst Upstream Scheduler Burst
evtm EVT Manager
dsgmib SNMP DSG ubsmac UBS CMTS MAC RTR
evta EVT Agent
bufmgr Buffer Manager ubs Upstream Scheduler
rmbind RM Bind
rm Resource Manager eth8 Ethernet Switch ubsim UBS IM SYNC
crmbpi CRM BPI fei FEI ubsmap UBS MAP
crm CRM srpcmt SRM Reporter CMTS macmr MAC MGR
crmsub CRM SubMgt maccfg MAC CFG docsif DOCS IF
crmfft CRM FFT cmtbuf CMTS Buffer macrtr MACRTR
crmsnr CRM SNR fpga CMTS FPGA brgtag BRG TAG
crmutl CRM Util bcm Broadcom Driver brg BRG
crmdtm CRM DOCSTEST bcmpkt Broadcam Driver Per brgrtr BRG RTR
crmcli CRM CLI Packet Spectrum Agent FFT
spafft
crmdsg CRM DSG
frm FRM spasnr Spectrum Agent SNR
dsgif DSG Interface
ard ARD rssi Spectrum Agent RSSI
csm Certificate Storage
ardpkt ARD PKT spasc Spectrum Agent SC
Module
brmtag BRM VLAN Tagging que QUE Manager ardrtr ARD RTR
rsm Redundancy SRM upc Upconverter acctrt ACC RTR
rdb Run Time Database res RES btp Boot Uptime
fpevt FP EVT resrtr RES RTR mcns MCNS
spcmgr Spectrum Manager resaut RES AUTH red CMTS Redundancy ICP
dgm DQM ressf RES SF ucc Upstream Channel Change
dqos PacketCable DQOS resmgr RES MGR dcc Dynamic Channel Change
pcmm PacketCable lbm Load Balancing dsx Dynamic Service
Multimedia lbm2 Load Balancing 2nd svcflo Service Flow
em PacketCable Event cra
Table CRA
Message
lbmsnr Load Balacing SNR cra2 CRA SNR
lbgmgr Load Balance Manage
drm cms Cable Modem bcm1 Broadcom 3138 Driver
DOCSIS Redundancy
Selector bcmmac Broadcom 3212 Driver
Manager
acc ACC pream Preamble
drme DOCSIS Redundancy
accpkt ACC Packet upcmot Upconverter Motorola
Manager Engine

Compass ID: 188656176 Version 5 MGBI 1-145


BSR 64000 Command Reference Guide Release 4.2.0

show forced-download
The show forced-download command shows information about which slots are set
for forced download from the SRM.
The following is an example of typical screen output from the show
forced-download command:

Slot 0 is forced to always download from the SRM


Slot 1 is forced to always download from the SRM
Slot 2 is forced to always download from the SRM
Slot 3 is forced to always download from the SRM
Slot 4 is forced to always download from the SRM
Slot 5 is forced to always download from the SRM
Slot 6 is forced to always download from the SRM
Slot 7 is forced to always download from the SRM
Slot 8 is forced to always download from the SRM
Slot 9 is forced to always download from the SRM
Slot 10 is forced to always download from the SRM
Slot 11 is forced to always download from the SRM
Slot 12 is forced to always download from the SRM
Slot 13 is forced to always download from the SRM
Slot 14 is forced to always download from the SRM
Slot 15 is forced to always download from the SRM

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show forced-download [ | {begin | exclude | include} {<WORD>} | {count |
count-only}]
show forced-download [ | {count | count-only } {<WORD>}]

1-146 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 1-147


BSR 64000 Command Reference Guide Release 4.2.0

show history
The show history command displays a list of commands executed during a session.
The list size is determined by the setting of the history size command. The following
is an example of typical screen output from the show history command:

show ip bgp next-hops


show ip bgp summary
show ip bgp community
show boot
show aliases
show boot
show chassis alias
show chassis asset-id
show clock
show history

Group Access
All

Command Mode
All modes

Command Line Usage


show history [ | {begin | exclude | include} {<WORD>} | {count | count-only}]
show history [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string

1-148 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

include filter for output that includes the


specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 1-149


BSR 64000 Command Reference Guide Release 4.2.0

show keepalive
The show keepalive command displays keepalive status and configuration
information for all switch fabric or ICP keepalives. The following is an example of
typical screen output from the show keepalive command:

Status : xfabric keepalive enabled


: icp keepalive enabled
Features : xfabric(monitor, 880-recover, slot-recover, cmts-rebind)
: icp(monitor, slot-reset )
Thresholds: xfabric (monitor 3, 880-recover 10, slot-recover 60, cmts-rebind 5)
: icp (monitor 10, slot-reset 10)

Keepalive Retransmit Counts:


Slot xfabric ICP
----------------------
10 : 1 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show keepalive [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show keepalive [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters or


counters)
begin filter for output that begins with the
specified string

1-150 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

exclude filter for output that excludes the


specified string
include filter for output that includes the
specified string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 1-151


BSR 64000 Command Reference Guide Release 4.2.0

show log
The show log command displays message logging in the log file the newest message
first.The show log command displays log file contents and information about users
who have logged into the BSR. The following is an example of typical screen output
from the show log command:

Preparing log file for reading ...


[02/11-10:39:08- 07:telnet01]-N-user enabled-user authenticated
[02/11-10:39:04- 07:telnet01]-N-connection made from 10.14.11.218 on session 01
[02/10-18:41:11- 07:RMs]-N-Module state RUNNING CMTS slot 1
[02/10-18:41:11- 07:RMs]-I-Slot 1 booted with version 2.1.0T00P39.KRBU
[02/10-18:41:09- 07:SPECMGR]-N-No shut down succeed for channel ifIndex = 98561
.
[02/10-18:41:09- 07:CRMTASK]-N-link up notification, ifIndex = 98561.
[02/10-18:41:08- 07:CRMTASK]-N-link up notification, ifIndex = 98305.
[02/10-18:41:08- 07:IM]-N-IP Interface cable 1/0 on 150.31.41.1 is up
[02/10-18:41:08- 07:IM]-N-Interface cable 1/0 is up
[02/10-18:41:07- 07:RMsc]-N-configuration change by [hotswapper]: cable downstre
am schedule priority-wfq
[02/10-18:41:07- 07:RMsc]-I-restoring: cable downstream schedule priority-wfq
[02/10-18:41:07- 07:RMsc]-E-bad return value 0 from parse() in loadInterfaceConf
iguration(), for config line:' cable dynamic-service authorization-mode disable'
[02/10-18:41:07- 07:RMsc]-I-restoring: cable dynamic-service authorization-mode
disable
[02/10-18:41:07- 07:RMsc]-N-configuration change by [hotswapper]: cable upstream
3 shutdown
[02/10-18:41:07- 07:RMsc]-I-restoring: cable upstream 3 shutdown
[02/10-18:41:07- 07:RMsc]-N-configuration change by [hotswapper]: cable upstream
2 shutdown
[02/10-18:41:07- 07:RMsc]-I-restoring: cable upstream 2 shutdown
[02/10-18:41:07- 07:RMsc]-N-configuration change by [hotswapper]: cable upstream
1 shutdown
[02/10-18:41:07- 07:RMsc]-I-restoring: cable upstream 1 shutdown
[02/10-18:41:07- 07:RMsc]-N-configuration change by [hotswapper]: no cable upstr
eam 0 shutdown
[02/10-18:41:07- 07:RMsc]-I-restoring: no cable upstream 0 shutdown
[02/10-18:41:07- 07:RMsc]-N-configuration change by [hotswapper]: cable upstream

Group Access
All

1-152 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Mode
All modes except User EXEC

Command Line Usage


show log [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show log [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 1-153


BSR 64000 Command Reference Guide Release 4.2.0

show logging evt


The show logging evt command displays the EVT configuration entries in the
running configuration file. The following is an example of typical screen output from
the show logging evt command:

EVT RUNNING CONFIG:


logging evt set c drme 82
logging evt set c rdb 197
logging evt set c dra 121

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show logging evt

1-154 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show logging reporting


The show logging reporting command displays the recording mechanism for logging
messages based on their severity level. The display output is in the format: logging
reporting <severity> <logging location> e.g. logging reporting alert local. The
following is an example of typical screen output from the show logging reporting
command:

no logging control docsis


logging reporting emergency local
logging reporting alert local
logging reporting critical local-trap-syslog
logging reporting error local-trap-syslog
logging reporting warning local-trap-syslog
logging reporting notice local-trap-syslog
logging reporting information all-clear
logging reporting debug all-clear

The following information is displayed:

Severity Levels and Descriptions

emergency emergency conditions where the system is unusable -


reserved for vendor-specific, fatal hardware or software
errors that prevents normal system operation and causes
reporting system to reboot
(severity level = 0)
alert conditions where immediate action is needed - a serious
failure which causes the reporting system to reboot but is
not caused by hardware or software malfunctioning
(severity level = 1)
critical critical conditions - a serious failure that requires
immediate attention and prevents the device from
transmitting data but the system could recover without
rebooting
(severity level = 2)

Compass ID: 188656176 Version 5 MGBI 1-155


BSR 64000 Command Reference Guide Release 4.2.0

error error conditions - a failure occurred that could interrupt


the normal data flow
(severity level = 3)
warnings warning conditions - a failure occurred that could
interrupt the normal data flow
(severity level = 4)

notice normal but significant conditions - an event of


importance occurred which is not a failure
(severity level = 5)
information informational descriptive system messages - an
unimportant event, which could be helpful for tracing
normal operations
(severity level = 6)
debug debugging messages
(severity level = 7)
default set all the severity level to default

Logging Location Options

local log messages for the report go to local-nonvolatile


memory (NVRAM)
local-syslog log messages for the report go to local NVRAM and the
SYSLOG server

local-trap log messages for the report go to local NVRAM. SNMP


traps are also sent to an SNMP manager
local-trap-syslog log messages for the report go to local NVRAM and a
SYSLOG server - SNMP traps are also sent to an SNMP
manager
all-clear unsets all logging locations for the report
all-set sets all logging locations for the report

1-156 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show logging reporting

Compass ID: 188656176 Version 5 MGBI 1-157


BSR 64000 Command Reference Guide Release 4.2.0

show logging syslog


The show logging syslog command displays a counter of the total number of log
messages sent to the SYSLOG server and the number of messages dropped if a
logging threshold has been exceeded. The following is an example of typical screen
output from the show logging syslog command:

Syslog Messages Sent: 654


Syslog Messages Dropped due to throttling: 0

The following information is displayed:

Syslog Messages Sent: the number of log messages logged


to the SYSLOG server
Syslog Messages Dropped due to throttling: the number of log messages that
were to be logged to the SYSLOG
server but were discarded because
the threshold set with the logging
rate-limit command was exceeded

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show logging syslog

1-158 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show macro
The show macro command lists all configured macros on the BSR.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show macro [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show macro [ | {count | count-only}}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 1-159


BSR 64000 Command Reference Guide Release 4.2.0

show memory
The show memory command displays the memory content of the starting address.
Use the show memory command to view information about memory available after
the system image decompresses and loads. The following is an example of typical
screen output from the show memory command with the fastpath argument:

Fast Path memory usage as follows:

Category # Of Bytes
-------- ----------

Buffer Manager L2 Cam Total size : 1559084


Buffer Manager L2 CAM mapping table size : 1245232
Buffer Manager L2 CAM hash table size : 2040
Buffer Manager L2 CAM MAC address tables size : 311808
Buffer Manager L2 CAM Miscellaneous size : 4
Flow Classification Total size : 5127504
Icmp Filter FC mapping/hashing table size : 52
Policy FC mapping/hashing table size : 144
Flow Classification CAM/SRAM mapping table size : 5127304
Flow Classification Miscellaneous size : 4
Unicast Routing Total size : 12630540
Unicast Routing local route mapping : 49152
Unicast Routing LME/SRAM mapping table size : 12581384

Total : 19317128

1-160 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

The following is an example of typical screen output from the show memory
command with the information argument:

FREE LIST:
num addr size
--- ---------- ----------
1 0x6ea6718 72
2 0x6ee8248 32
3 0x6ea67e0 40
4 0x6ee8d60 32
5 0x6ea6a10 40
6 0x6ea6960 24

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show memory [<address> <1-4294967295> | byte | end <address> | long | short ] [
fastpath [brief] ] [ information [brief] [slot <NUM>] ] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show memory [<address> <1-4294967295> | byte | end <address> | long | short ] [
fastpath [brief] ] [ information [brief] [slot <NUM>] ] [ | {count | count-only}]

Command Syntax

address the starting memory address expressed in


hexadecimal notation
1-4294967295 the number of bytes to dump
byte display in byte format
end the ending memory address expressed in
hexadecimal notation
long display in long format

Compass ID: 188656176 Version 5 MGBI 1-161


BSR 64000 Command Reference Guide Release 4.2.0

short display in short format


fastpath the number of bytes used to program the
HSIM FastPath
brief display only the summary
information displays free memory statistics and a
summary of memory usage
slot displays free memory statistics and a
summary of memory usage for a specified
slot in the BSR chassis
NUM the BSR slot number
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines

count-only count the number of lines while suppressing


screen output

Command Default
32 bit

1-162 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show network-clocks
The show network-clocks command displays the network clock configuration. The
following is an example of typical screen output from the show network-clocks
command:

Priority 1 clock source: Reference not configured


Priority 2 clock source: Reference not configured

Current clock status: Out of Range Unlocked Free-running


Non-revertive mode selected

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show network-clocks

Compass ID: 188656176 Version 5 MGBI 1-163


BSR 64000 Command Reference Guide Release 4.2.0

show pool
The show pool command displays information on data buffering including all
memory buffer pools, application-specific pools, the network pool, system physical
structures, and all mBuf pool names. The following is an example of typical screen
output from the show pool command:

Statistics for pool: network


number of FREE mbufs: 38271
number of mbufs: 38272
number of times failed to find space: 0
number of times waited for space: 0
number of times drained protocols for space: 0
high water mark: 9
__________________
CLUSTER POOL TABLE
_____________________________________________________
size clusters free usage highwater mark
-----------------------------------------------------
64 16384 16383 44153 6
128 32768 32768 22520 2
256 4096 4096 64 1
512 2048 2048 25 1
1024 2048 2048 647 3
2048 512 512 0 0
-----------------------------------------------------

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show pool [<WORD> | all | application | icp | names | network | system ] [ |
{begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show pool [<WORD> | all | application | icp | names | network | system ] [ |
{count | count-only}]

1-164 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Syntax

WORD the name of the buffer pool


all view all memory buffer pools
application view all application-specific pools

icp view chassis control messages in the ICP pool


names view the network pool where network data
transfer information for the stack is located
network view the network pool where network data
transfer information for the stack is located
system view system pool physical structures such as
the number of sockets, routes, interface
addresses, PCB, and multicast addresses
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-165


BSR 64000 Command Reference Guide Release 4.2.0

show process
The show process command displays information about software processes that are
running on the router. The following is an example of typical screen output from the
show process command:

All CPU accounting is approximate, there are 103 ticks per second

NAME TID PRI total % (ticks) delta % (ticks)


-------- ------- --- ------------------ ------------------
tExcTask f7fbb60 0 000.00%( 8 000.00%( 0)
TaskMon 7925f38 1 000.00%( 12 000.00%( 0)
ctrlMon 7928958 2 000.00%( 0 000.00%( 0)
tPCCARD f69d078 20 000.00%( 0 000.00%( 0)
BgpTask 6a566e0 30 000.01%( 68 000.00%( 0)
DiagTask 76af6b0 30 000.00%( 0 000.00%( 0)
DvmrpTask 609d888 30 000.00%( 2 000.00%( 0)
EventMgr b17caf8 30 000.00%( 8 000.00%( 0)
FpMsgHndlr 9118668 30 000.00%( 32 000.00%( 0)
IcpTask a29e4d8 30 000.11%( 1289 000.10%( 2)
OspfTask 637da80 30 000.02%( 203 000.00%( 0)
PimTask 61afd80 30 000.00%( 8 000.00%( 0)
SntpTask 76a9a68 30 000.00%( 2 000.00%( 0)
SonetBoardAP 76b20d0 30 000.00%( 0 000.00%( 0)
SonetTimingT 76b4af0 30 000.00%( 12 000.00%( 0)
StatsMgrTask ae05e80 30 000.00%( 13 000.00%( 0)
VrrpTask 79ba698 30 000.00%( 27 000.05%( 1)
fanStatus 76ac558 30 000.18%( 2173 000.25%( 5)

Group Access
All

Command Mode
All modes except User EXEC

1-166 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Line Usage


show process [cpu | memory | msg-q-info | semaphores | stack] [ | {begin | exclude
| include} {<WORD>} [ | {count | count-only}]]
show process [cpu | memory | msg-q-info | semaphores | stack] [ | {count |
count-only}]

Command Syntax

cpu cpu utilization by each process


memory memory information per process
msg-q-info information about current message queues
semaphores display state of semaphore(s)
stack process stack usage and interrupt routines,
including the reason for the last system reboot
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-167


BSR 64000 Command Reference Guide Release 4.2.0

show process cpu


The show process cpu command displays detailed CPU usage statistics for active
SRM and CMTS modules in the BSR 64000 chassis. The module type (for example:
1x8 CMTS slot <NUM>) is displayed along with the CPU usage statistics for that
module. For HSIM modules, the module sub type (for example: Sub Type: SMGE)
is displayed.

Note: CPU usage statistics for HSIM or standby SRM modules will not be
displayed using this command.

The following is an example of typical screen output from the show process cpu
command:

Slot: 4 Module Type: 1x8 CMTS

All CPU accounting is approximate, there are 503 ticks per second

NAME TID PRI total % (ticks) delta % (ticks)


-------- ------- --- ------------------ ------------------
tExcTask fbfd6d8 0 000.00%( 0 000.00%( 0)
TaskMon eea6498 1 000.00%( 119 000.00%( 119)
tShell eee0168 1 000.00%( 0 000.00%( 0)
ctrlMon eea8eb8 2 000.00%( 0 000.00%( 0)
tKADEBUG 8b8c720 2 000.00%( 32 000.00%( 32)
tWdbTask eee2388 3 000.00%( 0 000.00%( 0)
DiagTask ec0acd0 30 000.00%( 0 000.00%( 0)
EventMgr f081f78 30 000.00%( 9 000.00%( 9)
tCmdHdlQ ee72b60 30 000.00%( 38 000.00%( 38)
tRdnCollectT 8d65288 30 000.03%( 1516 000.03%( 1516)
tRdnReportTa 8d638f8 30 000.00%( 0 000.00%( 0)
tRmIomLedTas 8d6b888 30 000.00%( 50 000.00%( 50)
tUbs c4d1598 40 004.31%( 260069 004.31%( 260069)
redMonitorTa ec08248 50 000.00%( 268 000.00%( 268)
redSyncTask a7ea9f8 50 000.15%( 9299 000.15%( 9299)
tFtpdTask f077380 55 000.00%( 0 000.00%( 0)

1-168 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show process cpu [frequency <30-200> | restart | slot <NUM> | stop] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show process cpu [frequency <30-200> | restart | slot <NUM> | stop] [ | {count |
count-only}]

Command Syntax

frequency 30-200 how many times per second a CPU statistic


measurement is taken in 30-200 Hz
restart restart the utilization measurement process on
any or all slots containing a CMTS or active
SRM

Compass ID: 188656176 Version 5 MGBI 1-169


BSR 64000 Command Reference Guide Release 4.2.0

slot NUM displays detailed CPU usage statistics for a


CMTS or SRM module specified by the
module’s slot number (0-15)

Note: CPU usage statistics are not displayed


for a standby NIM or standby SRM module

if the specified slot is an HSIM module, the


following message displays:

This command does NOT accept


HSIM slot

if the specified slot does not contain a


module, the following message displays:

No data available for slot


<NUM>

stop stops the utilization measurement process


| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

1-170 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Default
frequency = 60 Hz

Compass ID: 188656176 Version 5 MGBI 1-171


BSR 64000 Command Reference Guide Release 4.2.0

show process memory


The show process memory command displays per process memory usage
information about software processes that are running on the BSR. The following
screen output is displayed:
NAME TID STATUS Memory Requested Overhead HW mark
--------------- --------- -------- --------- --------- --------- ---------
tRootTask bfffdf8 61713912 61706523 7389 61713936
tShell aeea888 PEND 3248 2981 267 3248
ctrlMon aeb20e8 PEND 152 128 24 152
tCmdHdlQ ae92450 READY 3712 3548 164 14016
tLogTask aeb7308 PEND+T 136 108 28 136
DiagTask ac2fd28 PEND 1928 1856 72 1928
redMonitorTask ac2d2a0 DELAY 379008 378976 32 379008
redSyncMsgTask ac2c018 DELAY 380664 380584 80 380664
redIcpTask ac2ad90 PEND 380696 380600 96 380696
redSTSIHTask ac28a70 PEND 48 32 16 48
IcpTask ac42d78 READY 65832 65772 60 74528
tEVTA ac3d3f0 PEND 2952 2920 32 4440
StatsMgrTask ac32dd8 PEND+T 528 464 64 528
tUpc aafe4d0 PEND 1680 1616 64 12520
fpgaDsTask 908f280 READY 48 32 16 48
tDftTask 908a570 DELAY 48 32 16 48
tArdTim 8583fb8 DELAY 48 32 16 48
dpsDsTask 8582b00 PEND 104 60 44 16144
resMgrTask 853e440 PEND 22240 22072 168 22768
tSftTask 853c088 PEND 48 32 16 48
tUbs 8446a40 READY 563368 562880 488 563896
tMcns2 8436000 PEND 48 32 16 48
tMacTask 842a5c0 READY 34793632 34792500 1132 34795744
rdnBpiMain 843e7b8 PEND+T 4048960 4048228 732 4048960
tMcnsLogTask 8434de0 PEND 6344 6284 60 6344
tRcyc 84223a0 READY 352 288 64 352
tCmacStats 8420180 PEND 262440 262368 72 262440
tSrmReporter 841df60 PEND+T 112 80 32 112
tRLimit 841bd40 DELAY 352 288 64 352
tMacRtr 8419b20 PEND 409352 408640 712 409880
tAccDhcp 8293c48 DELAY 48 32 16 48
tSPA 8292a28 PEND 148232 148188 44 148232
tDra 8286e18 PEND+T 184224 183832 392 185280
tCRA 5c26998 PEND 395976 395784 192 396632
tDownloadTask 5bbc540 PEND 15528 15480 48 15528
tRdb005 5bb1eb0 PEND+T 16352 16216 136 16880
tMcnsTask 842c7e0 READY 56 28 28 56

37 tasks used 103802408 103789516 12892

1-172 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show process memory {<process-id> [ bytes | kilobytes | megabytes ]} |
{<process-name> [ bytes | kilobytes | megabytes ]} | {slot <NUM>} {sorted [bytes |
high-water-mark [bytes | kilobytes | megabytes ] | kilobytes | megabytes | name
[bytes | kilobytes | megabytes ] | no-sort [bytes | kilobytes | megabytes ] | use [bytes
| kilobytes | megabytes ]} [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show process memory {<process-id> [ bytes | kilobytes | megabytes ]} |
{<process-name> [ bytes | kilobytes | megabytes ]} | {slot <NUM>} {sorted [bytes |
high-water-mark [bytes | kilobytes | megabytes ] | kilobytes | megabytes | name
[bytes | kilobytes | megabytes ] | no-sort [bytes | kilobytes | megabytes ] | use [bytes
| kilobytes | megabytes ]} [ | {count | count-only}]

Command Syntax

process-id A process identifier in hexadecimal format


bytes Display total sizes in bytes

kilobytes Display total sizes in kilobytes


megabytes Display total sizes in megabytes
process-name The alphanumeric process name up to 15
characters
slot NUM Displays detailed memory usage statistics for
a CMTS module specified by the module’s
slot number
sorted Display sorted memory information for all
processes

high-water-mark Sort by maximum memory used

Compass ID: 188656176 Version 5 MGBI 1-173


BSR 64000 Command Reference Guide Release 4.2.0

name Sort by name


no-sort Display the first memory request order
use Sort by memory used now
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Command Defaults
All display output is shown in bytes
Sorting is disabled

1-174 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show process msg-q-info


The show process msg-q-info command displays information about current message
queues.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show process msg-q-info [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show process msg-q-info [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-175


BSR 64000 Command Reference Guide Release 4.2.0

show process semaphores


The show process semaphores command creates a message when an attempt to
unlock a semaphore when it is already unlocked. The following is an example of
typical screen output from the show process semaphores command:

B - Binary, M - Mutex, C - Counting, O - Old


* - new from last show

Creator Id(Hex) Type/sub Queue #Pend State Blocked-Task TIMEOUT


------------ -------- ----------- ----- ----- ---------- ------------ -------
tRootTask ef1808 B-ShowSem FIFO 0 FULL
tRootTask c724b0 B-Init PRIOR 0 FULL
tRootTask c7258c M-Init PRIOR 0 OWNER:NONE
tRootTask ec02d8 M-Spl PRIOR 0 OWNER:NONE
tRootTask ec1c64 B-Mux PRIOR 0 FULL
tRootTask ec26e8 B-NetBuf PRIOR 0 EMPTY
tRootTask ec2708 B-NetBuf PRIOR 0 EMPTY
tRootTask ec2728 B-NetTask PRIOR 1 EMPTY tNetTask 5
tRootTask ec9f98 M-PppHook PRIOR 0 OWNER:NONE
tRootTask eca058 M-PppSecret PRIOR 0 OWNER:NONE
tRootTask eca69c M-Evt PRIOR 0 OWNER:NONE
tRootTask eca6bc M-Evt PRIOR 0 OWNER:NONE
tRootTask eca6d8 M-Evt PRIOR 0 OWNER:NONE
tRootTask eca6f8 M-Evt PRIOR 0 OWNER:NONE
tLogTask eca7c4 M-LogCtrl PRIOR 0 OWNER:NONE
tRootTask eeb7b8 B-Icp FIFO 0 FULL
tRootTask eeb7dc M-FIO PRIOR 0 OWNER:NONE
tRootTask ef14f8 B-MemCheck FIFO 0 FULL

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show process semaphores [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show process semaphores [ | {count | count-only}]

1-176 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-177


BSR 64000 Command Reference Guide Release 4.2.0

show process stack


The show process stack command monitors the stack utilization of processes and
interrupt routines. The following is an example of typical screen output from the show
process stack command:

NAME ENTRY TID SIZE CUR HIGH MARGIN


------------ ------------ -------- ----- ----- ----- ------
tExcTask excTask f7fbb60 7976 248 1520 6456
TaskMon 0x000089987c 7925f38 10224 1112 1288 8936
ctrlMon ctrlKeyTask 7928958 10224 208 2040 8184
tPCCARD pcd f69d078 3984 216 280 3704
tLogTask logTask f6a3ba8 20456 464 5512 14944
EventMgr EventMgrMain b17caf8 15336 216 5272 10064
tRtmMgrTask RtmMgrTask ae850e8 10216 256 3232 6984
tNetTask netTask ae2eb38 19976 336 5264 14712
igmpTask igmpTask ae29af8 19976 296 2128 17848
StatsMgrTask statsMgrTask ae05e80 10216 272 2104 8112
statsMgrIcp statsMgrIcpT a82eb80 10216 232 2120 8096
tEvtHdlr 0x000081103c a6898c0 10216 728 4520 5696
IcpTask IcpTask a29e4d8 10224 296 4416 5808
tEVTM 0x00000b4b00 a27d508 32752 320 4312 28440
tEVTA 0x00000b4d00 a2752e8 32752 320 2288 30464
tDRM drm_main a2633d0 10224 544 3592 6632
tCRM crmTaskMain a2609b0 32752 2216 6576 26176
tCsm CsmMain 963bcc8 16368 1696 4848 11520
tRM_elect RM_election_ 9634750 40936 168 2184 38752
tDownloadTas DownloadTask 919c498 10216 248 3216 7000
tRM_sm RM_sm 917f278 40944 584 20112 20832

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show process stack [ procID | procName ] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show process stack [ procID | procName ] [ | {count | count-only}]

1-178 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Syntax

procID process identifier in decimal or hexadecimal


format (0x is required)
procName the name of the process
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-179


BSR 64000 Command Reference Guide Release 4.2.0

show redundancy cmts


The show redundancy cmts command displays the BSR 64000 redundancy
configuration for CMTS modules in the BSR 64000 chassis. The following
information is displayed:

CMTS Slot the CMTS slots configured for CMTS


redundancy
Sub Type the type of CMTS module installed in the
slot- either 1x4, 1x8, 2x8, or 2x8(2.0)
Slot Status indicates whether the module is in the RUN
(active) state or stby (standby) state - the
stby state indicates that the module is ready to
accept a switch-over from another slot
Red Slot the redundant slot to which this chassis slot
switches over
Primary Slot the context in which this Primary CMTS
module slot is active - the chassis slot number
is the same as a Primary CMTS module slot
when a Primary CMTS module slot is active
and when the Standby CMTS module slot is
active, the Primary slot for which it is running
is indicated

1-180 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Logging Status full indicates that CMTS information has


been fully replicated to the Standby CMTS
module for this slot

inactive indicates that the CMTS is not


running or has no redundant slot to which to
replicate.

partial indicates that replication is currently


underway - a CMTS cannot be forced to
switchover until it has completed replication.
If a failure occurs in this situation,
auto-takeover will still takeover - only
manual takeover will not work.
Manual Takeovers the number of operator-requested takeovers
Auto-takeovers the number of takeovers prompted by a
CMTS module failure, reset, or de-insertion -
each takeover count represents the number of
times that a slot has been taken over for (For
example, the takeover counts for slot 3 gives
the number of times that slot 6 (Standby
CMTS Module) has taken over for slot 3 - the
takeover counts for slot 6 give the number of
givebacks from slot 6)
Unavailable Time the time in dd:mm:ss since the last chassis
boot when the Primary CMTS Module was
not active and the Standby CMTS Module did
not takeover for it
Time Since Failover the time in dd:mm:ss since the Standby
CMTS Module has taken over for the Primary
CMTS Module

The following is an example of typical screen output from the show redundancy
cmts command:

Compass ID: 188656176 Version 5 MGBI 1-181


BSR 64000 Command Reference Guide Release 4.2.0

Pri- Manual Auto Time


CMTS Sub Slot Red mary Logging Take- Take- Unavail Since
Slot Type Status Slot Slot Status overs overs Time Failover

5 2x8(2.0) boot - 5 inactive 0 0 0:00:00 0:00:00


6 2x8 boot - - inactive 0 0 0:00:00 0:00:00
9 1x8 boot - 9 inactive 0 0 0:00:00 0:00:00

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show redundancy cmts [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show redundancy cmts [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

1-182 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-183


BSR 64000 Command Reference Guide Release 4.2.0

show reload
The show reload command displays the status of a Hitless Upgrade in progress after a
software reload of all modules in the BSR chassis has been initiated with the reload
switched command.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show reload

1-184 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show running-config
The show running-config command displays configuration information currently
running on the BSR.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show running-config [interface [cable <X/Y> ethernet <X/Y> | gigaether <X/Y> | |
pos <X/Y> | loopback <1-255> | tunnel <0-255>]] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show running-config [interface [cable <X/Y> ethernet <X/Y> | gigaether <X/Y> | |
pos <X/Y> | loopback <1-255> | tunnel <0-255>]] [ | {count | count-only}]
show running-config verbose [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show running-config verbose [ | {count | count-only}]

Command Syntax

interface display running configuration information on all


interfaces or a specific interface card

cable X/Y the CMTS slot and MAC Domain number on the BSR
ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot and port
number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on the BSR
loopback 1-255 the loopback interface number
pos X/Y the Packet over SONET slot and port number on the
BSR
tunnel 0-255 the tunnel interface number

Compass ID: 188656176 Version 5 MGBI 1-185


BSR 64000 Command Reference Guide Release 4.2.0

verbose runs the show running-config command in verbose


mode
| turns on output modifiers (filters)
begin filter for output that begins with the specified string
exclude filter for output that excludes the specified string
include filter for output that includes the specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing screen
output

1-186 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show srm alias


The show srm alias command is used to show the alias name for the SRM module.

Group Access
All

Command Mode
All except User EXEC

Command Line Usage


show srm alias

Compass ID: 188656176 Version 5 MGBI 1-187


BSR 64000 Command Reference Guide Release 4.2.0

show srm assetid


The show srm assetid command is used to view the asset ID number assigned to the
SRM.

Group Access
All

Command Mode
All except User EXEC

Command Line Usage


show srm assetid

1-188 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show srm serial-num


The show srm serial-num command is used to view the serial number assigned to
your SRM.

Group Access
All

Command Mode
All except User EXEC

Command Line Usage


show srm serial-num

Compass ID: 188656176 Version 5 MGBI 1-189


BSR 64000 Command Reference Guide Release 4.2.0

show startup-config
The show startup-config command displays the contents of the system startup
configuration file.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


show startup-config [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show startup-config [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

1-190 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show stats summary error


The show stats summary error command displays FEC error counts and ratios. The
following is an example of typical screen output from the show stats summary error
command:

MAC Address I/F SID CorrFec CorrFec UnCorrFec UnCorrFec


Count Ratio Count Ratio
0008.0e16.e6e2 0/0/U1 2 0 0.00000000 0 0.00000000
0008.0e16.f954 0/0/U1 1 0 0.00000000 0 0.00000000
00e0.0c60.02b4 0/0/U1 3 0 0.00000000 0 0.00000000

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show stats summary error [sid <1-2049> | slot <NUM>]

Command Syntax

sid 1-2049 display cable modem service flow


identifier (SID) Forward Error
Correction (FEC) error counts and
ratios
slot NUM display FEC error counts and ratios
for a particular chassis slot

Compass ID: 188656176 Version 5 MGBI 1-191


BSR 64000 Command Reference Guide Release 4.2.0

show stats xfabric


The show stats xfabric command displays downstream and upstream successfully
transmitted packet counts and dropped or aborted packet counts for the switch fabric.
The following is an example of typical screen output from the show stats xfabric
command:

Downstream
---------
Packet Count : 44907
Drop Count : 0

Upstream
---------
Packet Count : 44907
Abort Count : 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show stats <NUM> xfabric

Command Syntax

NUM the BSR slot number

1-192 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show system
This show system command displays various operating information for the BSR
64000. The following is an example of typical screen output from the show stats
system command:

Station-ID (mac) Uptime h:m:s


-------------------- -------------
00:30:b8:c6:5c:00 3:49:04

Model Serial # HW SW
--------- ---------- ------------ ----------
BSR 64000 027006554 CHS-0009-01 4.2.0T00P43.H14.KRBU

Module Status Temperature Low High


---------- --------- ----------- ----- -----
SRM (750) ok 25C 77F 0C 65C
SRM (DIMM) ok 29C 84F 0C 65C
SRM (DC2DC) ok 28C 82F 0C 65C
SRM (XFAB) ok 42C 107F 0C 80C
Fan Temp ok 28C 82F 0C 50C

CO Alarm Severity Number Active


------------------- -------------
Critical 0
Major 0
Minor 0

Compass ID: 188656176 Version 5 MGBI 1-193


BSR 64000 Command Reference Guide Release 4.2.0

The following information is provided:

Station-ID a proper indication of which MAC address is


being used for the system and can be either
the SRM7/SRM8 or Chassis MAC ID
Uptime the routing module’s uptime in hh:mm:ss
format - use the show chassis status
command for information on other modules

Model/Serial # Motorola identifiers that can also be retrieved


with the show version command for the
current master SRM

Module temperature and status and the number of each class of alarms are also
displayed.

1-194 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Note: The value displayed with the sysUpTime SNMP MIB object and the
"UpTime" field as displayed in the show system command output represent
different system up time values.

The sysUpTime MIB object represents the amount of time that the SNMP
Agent has been running. This is relative to the time that the SNMP Agent was
last restarted. Initially, this will be close to the time that the SRM module last
restarted because the SNMP Agent resides on the SRM module. However, if
the SNMP Agent itself is restarted with the snmp-server shutdown or
snmp-server enable CLI commands, the sysUpTime will be reset to zero.

The "UpTime" value displayed in the show system command output


represents the amount of time that the modules have been running relative to
the last reboot of the chassis or last reset of the modules. These system time
values may be different for each module, even after a reboot of the entire
chassis, because not all modules complete their initialization at the same
time. Also, the system time values will be different if individual modules are
restarted via the CLI or are manually inserted at a later time. However, the
per-module 'UpTime" values displayed in the show system command output
are NOT affected by the snmp-server shutdown and snmp-server enable
commands because these values are relative to the module’s boot time not to
the SNMP Agent’s boot time.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show system [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show system [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 1-195


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

1-196 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show system alarms


The show system alarms command provides a summary of alarm information for the
entire BSR 64000. The alarm summary display can be filtered according to whether
the alarm is active, critical, major, or minor. The following is an example of typical
screen output from the show stats alarms command:

CO Alarm Severity Number Active


------------------- -------------
Critical 0
Major 0
Minor 0
BSR64K-9:7A#sho sys
BSR64K-9:7A#sho system al
BSR64K-9:7A#sho system alarms
Alarm Summary
Alarms Active Disabled Severity Error
-------------- ------ -------- -------- -----------------------
Power A - - -
Power B - - -
Top Fan - - -
Bot Fan - - -
Fan Temp - - -
Temp 750 - - -
Temp DIMM - - -
Temp DC2DC - - -
Temp XFab - - -
SRM I2C - - -
FAN I2C - x -

The following information is provided:

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 1-197


BSR 64000 Command Reference Guide Release 4.2.0

Alarms the BSR component for which the alarm is


valid:
Power A
Power B
Top Fan
Bot Fan
Temp Fans
Temp 750
Temp DIMM
Temp DC2DC
Temp XFab
SRM I2C
FAN I2C
Active indicates if there is an active alarm per
component - an "x" is present in the Active
column if the current alarm is triggered
Disabled an "x"' is present in the Disabled column if
the current alarm will suppress an audio/
visual event, SYSLOG, and/or SNMP traps
Severity the severity level of the alarm - depending on
severity, the severity column will indicate
"Critical", "Major", or "Minor" matching the
led (s) on the front of the BSR 64000 chassis
Error the Error column is used to display a message
sent to the central alarm component when an
error occurs - two examples of possible error
messages are:
2. "Fan Tray Communication Failed" - upon
FAN I2C failure
3. "General Failure" - for Power A failure
representing a case where a specific
message was not supplied to the
subsystem at the time of the alarm

1-198 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Line Usage


show system alarms [active | critical | major | minor] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show system alarms [active | critical | major | minor] [ | {count | count-only}]

Command Syntax

active display active alarms


critical display critical alarms
major display major alarms
minor display minor alarms
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-199


BSR 64000 Command Reference Guide Release 4.2.0

show system fans


This show system fans command displays the current state of the fan tray subsystem.
It is used for troubleshooting and operational verification. All alarm events are
indicated with as corresponding error messages. The following is an example of
typical screen output from the show stats fans command:

Fan Tray Alarm Status


GLB: [ 0] Fan Trays Good
Top: [ 0] No Current Alarms
Top: [ 0] All Fans Good
Bot: [ 0] No Current Alarms
Bot: [ 0] All Fans Good

Top Fan Readings:


ROM Rev# = 0x83
Status = [ 00]
Alarm 1 = [ 00]
Status 1 = [ 00]
ThermOff1 = [ 4]
Therm 1 = [ 137] 28C 82F

Fan1Speed = [ 94] 2144rpms


Fan3Speed = [ 95] 2122rpms
Fan4Speed = [ 95] 2122rpms
Buck PWM1 = [ 92]
Buck PWM3 = [ 97]
Buck PWM4 = [ 97]

AckCnt 1 = [ 0]
MaxAckCnt1= [ 255]

SetPnt 1 = [ 0] 0rpms
SetPnt = [ 94] 2144rpms

Group Access
All

Command Mode
All modes except User EXEC

1-200 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Line Usage


show system fans [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show system fans [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-201


BSR 64000 Command Reference Guide Release 4.2.0

show tacacs
The show tacacs command displays statistics for all TACACS+ servers on the
network including the IP address of the servers, connections, failed connection
attempts, and packets sent and received. If there is more than one TACACS+ server
configured, the command output displays statistics for all servers in the order in which
they were configured. The following is an example of typical screen output from the
show tacacs command:

Tacacs+ Server : 11.14.162.80/49


Number of Sessions: 1
Socket opens: 3
Socket closes: 3
Socket aborts: 0
Socket errors: 0
Socket Timeouts: 0
Failed Connect Attempts: 0
No current connection
Session 1 Statistics
Total Packets Sent: 7
Total Packets Recv: 7
Expected Replies: 0

Note: TACACS+ statistics can also be displayed with the show ip traffic
command.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show tacacs

1-202 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show tacacs statistics


The show tacacs statistics command displays overall TACACS+ statistics including
the total number of access (AAA) requests, the number of denied requests, and the
number of allowed requests. The following is an example of typical screen output
from the show tacacs statistics command:

TACACS+ Overall Statistics


Number of access requests : 7
Number of access deny responses : 1
Number of access allow responses: 6

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show tacacs statistics

Compass ID: 188656176 Version 5 MGBI 1-203


BSR 64000 Command Reference Guide Release 4.2.0

show tech
The show tech command displays statistics and log information from the output of
the following technical support related show commands:

■ show version
■ show running-config
■ show interfaces
■ show ip traffic
■ show L2-cam ip
■ show L2-cam label
■ show L2-cam mac
■ show log
■ show stats cmts
■ show controllers cable
■ show process memory
■ show memory information
■ show pool
■ show process cpu
■ show process msg-q-info
■ show process semaphores
■ show process stack
■ show ip route summary
■ show evt
■ show cable modem summary

The screen output of the show tech command is a compilation of the above show
commands and can take several minutes to display on the screen. The output can also
be saved to a file for later viewing. For a sample display of the output of the show
tech command, see the individual show commands listed above.

Group Access
All

1-204 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Mode
All modes except User EXEC

Command Line Usage


show tech [flash: | nvram:]

Command Syntax

flash: output to a file on the Flash memory file


system
nvram: output to a file on the NVRAM file system

Compass ID: 188656176 Version 5 MGBI 1-205


BSR 64000 Command Reference Guide Release 4.2.0

show update
The show update command displays bypassed Resource Manager behaviors or
ongoing or prior upgrade status for each slot on the BSR.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show update {bypass | status} [ | {begin | exclude | include} {<WORD>} [ | {count
| count-only}]]
show update {bypass | status} [ | {count | count-only}}]

Command Syntax

bypass display bypassed Resource Manager


behaviors
status display ongoing or prior upgrade
status
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

1-206 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show user-group
The show user-group command displays the group access level for a specific CLI
command. The group access levels are as follows:

SYSADMIN access for users with System Administrator


privileges
ISP access for users with Internet Service
Provider privileges
MSO access for users with Multiple Service
Operator privileges
RESTRICTED access for users with "restricted" privileges
ALL access for all users

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show user-group <WORD>

For example, entering the following:


show user-group password telnet 0 test
would return the following:
The command "password telnet 0 test" is set to SYSADMIN access

Compass ID: 188656176 Version 5 MGBI 1-207


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

WORD the command name - the complete command


syntax must be entered otherwise the system
will return an "is not a valid command" error
message

1-208 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show users
The show users command displays information about active Telnet sessions including
the username, user group and privilege level, the IP address of the originating host,
and the session ID. The following is an example of typical screen output from the
show users command:

Active connections
user group/privilege origin session
------------------------------------------------------------------
console sysadmin/rw console 0
enabled-user sysadmin/rw 10.14.37.103 1*

Group Access
All

Command Mode
Privileged EXEC and Global Configuration

Command Line Usage


show users [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show users [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string

WORD the specified string

Compass ID: 188656176 Version 5 MGBI 1-209


BSR 64000 Command Reference Guide Release 4.2.0

count count the number of outputted lines


count-only count the number of lines while
suppressing screen output

1-210 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show vectron slot


The show vectron slot command displays the version of the Vectron TRU clock/data
recovery chip resident on a specified slot in the BSR chassis. The following is an
example of typical screen output from the show vectron slot command:

Vectron time module version


CL 4/27/2005 *
BL 10/19/2004*
FL 10/19/2004*
GA 10/19/2004*

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show vectron slot <0-15> [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show vectron slot <0-15> [ | {count | count-only}]

Command Syntax

0-15 the BSR chassis slot number


| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string

include filter for output that includes the


specified string
WORD the specified string

Compass ID: 188656176 Version 5 MGBI 1-211


BSR 64000 Command Reference Guide Release 4.2.0

count count the number of outputted lines


count-only count the number of lines while
suppressing screen output

1-212 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

show version
The show version command displays the configuration of the system hardware, the
software version, the names and sources of configuration files, and the boot images.
The following is typical screen output from the show version command:

Slot07 Master SRM3 Versions:


Boot ROM: RDN 4.1.0.02 Created: Mon Sep 13 13:27:33 EDT 2004
System Image: 4.2.0T00P35.H11.KRAU
Date Built: Wed Oct 26 10:48:32 EDT 2005
CPU: MPC750-MPC8260
Memory Size: 256 MB
Format Version: 4
Assembly Type : 1
Part Number : PCA-0005-03
HW Revision : R
Serial Number : 027004822
Mac Address : 00:30:b8:01:bc:00
Product Number: BSR 64000
SFB FPGA Version: 1015

The table below describes the displayed fields:

Slot <number> the type of module present in the slot such as


1X4 Domestic CMTS, 1X8 Domestic CMTS,
2X8 Domestic CMTS, Gigabit Ethernet,
Ethernet, POS OC12/ POS OC3, Supervisory
Routing Module (SRM3 or SRM4), etc.
Boot ROM: the boot version
System Image: the current software version running on the
module
Date Built: the date the above version was built
CPU: the processor type name
Memory Size: the processor memory size

Compass ID: 188656176 Version 5 MGBI 1-213


BSR 64000 Command Reference Guide Release 4.2.0

Depending on the module type, the remaining output in each show version display
shows the format version, assembly type, hardware revision, serial, part, and product
numbers, FPGA Version number, and buffer management information.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show version [slot <0-15>] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show version [slot <0-15>] [ | {count | count-only}]

1-214 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Command Syntax

slot slot in the BSR 64000 chassis


0-15 slot number from which version information
is to be displayed
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 1-215


BSR 64000 Command Reference Guide Release 4.2.0

show xfabric
The show xfabric command displays keepalive status and configuration information
for all switch fabric keepalives and the status of all operational slots.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show xfabric {keepalive | status} [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]
show xfabric {keepalive | status} [ | {count | count-only}}]

Command Syntax

keepalive display the switch fabric keepalive


configuration
status display status of operational slots
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines

count-only count the number of lines while


suppressing screen output

1-216 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

The following is an example of typical screen output from the show xfabric
keepalive command:

Status : xfabric keepalive enabled


: icp keepalive enabled
Features : xfabric(monitor, 880-recover, slot-recover, cmts-rebind)
: icp(monitor, slot-reset )
Thresholds: xfabric (monitor 3, 880-recover 10, slot-recover 60, cmts-rebind 5)
: icp (monitor 10, slot-reset 10)

Keepalive Retransmit Counts:


Slot xfabric ICP
----------------------
1 : 1 0

The following is an example of typical screen output from the show xfabric status
command:

Slot Sync Status


1 normal ok
14 normal ok
10 normal ok
0 normal ok
15 normal ok
7 normal ok

Compass ID: 188656176 Version 5 MGBI 1-217


BSR 64000 Command Reference Guide Release 4.2.0

slot
The slot command enters Slot Configuration mode for a specified BSR slot from
Global Configuration mode. To return to Global Configuration mode, use the end
command.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


slot <NUM>

Command Syntax

NUM the specified BSR slot number

1-218 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

speed
The speed command specifies the speed at which the Ethernet interface operates. The
default speed is auto-negotiated but the speed can be manually set to either 10 Mbps
or 100 Mbps.

Group Access
ISP

Command Mode
Interface Configuration (Ethernet interface only)

Command Line Usage


speed {100 | 10 | auto}
no speed {100 | 10 | auto}

Command Syntax

100 100 Mbps


10 10 Mbps
auto autonegotiate the connection speed (100
Mbps or 10 Mbps) with the device at the other
end of the physical connection.

Command Default
Auto negotiation enabled

Compass ID: 188656176 Version 5 MGBI 1-219


BSR 64000 Command Reference Guide Release 4.2.0

srm alias
The srm alias command is used to configure an alias name for the SRM module.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


srm alias <string>

Command Syntax

string the SRM alias name - enclose the


alias name within quotation marks if
the string contains spaces

1-220 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

srm assetid
The srm assetid command is used to configure your organization’s asset ID number
that is assigned to the SRM module.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


srm assetid <string>

Command Syntax

string the SRM alias name - enclose the


alias name within quotation marks if
the string contains spaces

Compass ID: 188656176 Version 5 MGBI 1-221


BSR 64000 Command Reference Guide Release 4.2.0

srm assetid
The srm assetid command is used to configure your organization’s asset ID number
that is assigned to the SRM module.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


srm assetid <string>

Command Syntax

string the SRM asset ID number - enclose


the alias name within quotation
marks if the string contains spaces

1-222 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

sync file
The sync file command synchronizes all files stored in Flash memory or NVRAM
between an Active SRM and a Standby SRM including the startup and running
configuration files.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


sync file {flash: | nvram:}

Command Syntax

flash: synchronize files from Flash memory


nvram: synchronize files from NVRAM

Compass ID: 188656176 Version 5 MGBI 1-223


BSR 64000 Command Reference Guide Release 4.2.0

tacacs reset-connections
The tacacs reset-connections command is used to reset all the TACACS+ server
connections and associated sessions. After reset, all connections will be
re-established. The tacacs reset-connections command is useful to initiate a reset and
re-establish the existing connections after making any connection-specific
configuration changes.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


tacacs reset-connections

1-224 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

tacacs-server host
The tacacs-server host command is used to specify and configure individual
TACACS+ servers. The command can also be used to configure multiple TACACS+
servers. The TACACS+ client will contact the servers in the order in which they are
specified.The no tacacs-server host command removes a TACACS+ server from the
list.

Note: Since the key, port, retry, and timeout parameters specified with the
tacacs-server host command override any global settings made by the
tacacs-server key, tacacs-server port, tacacs-server retry, and
tacacs-server timeout commands, the tacacs-server host command can be
used to enhance network security by uniquely configuring individual
TACACS+ servers.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


tacacs-server host {<hostname> | <A.B.C.D>} [key <WORD> | port <0-65535>|
retry <0-100> | single-connection | timeout <1-1000>]
no tacacs-server host [<hostname> | <A.B.C.D>]

Command Syntax

key WORD specifies an authentication and encryption


key - specifying a key with this command
overrides the global key specified by the
tacacs-server key command for this
TACACS+ server only
port 0-65535 specifies a server port number - this value
overrides the global port number value set
with the tacacs-server port command for this
TACACS+ server only

Compass ID: 188656176 Version 5 MGBI 1-225


BSR 64000 Command Reference Guide Release 4.2.0

retry 0-100 specifies a retry value - this value overrides


the global retry value set with the
tacacs-server retry command for this
TACACS+ server only
single-connection opens a new TCP connection for every
TACACS session established
timeout 1-1000 specifies a timeout value in seconds - this
value overrides the global timeout value set
with the tacacs-server timeout command for
this TACACS+ server only

1-226 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

tacacs-server key
The tacacs-server key command is used to specify a global authentication encryption
key used for all TACACS+ communications between the TACACS+ client and the
TACACS+ server. A global encryption key is used if no encryption key is specifically
configured for this TACACS+ server. The no tacacs-server key disables
authentication encryption.

Note: The key entered must match the key used on the TACACS+ server. All
leading spaces are ignored; spaces within and at the end of the key are not. If
spaces are used within the key, the key should not be enclosed in quotation
marks unless the quotation marks themselves are part of the key.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


tacacs-server key <WORD>
no tacacs-server key

Command Syntax

WORD specifies an authentication and encryption


key - this key must match the key used by the
TACACS+ server

Compass ID: 188656176 Version 5 MGBI 1-227


BSR 64000 Command Reference Guide Release 4.2.0

tacacs-server port
The tacacs-server port command to specify a global port number for all
communication between the TACACS+ server and the TACACS client. A global port
number is used if no port number is specifically configured for this TACACS+ server.
The no tacacs-server port command restores the default port number value of 49.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


tacacs-server port <0-65536>
no tacacs-server port

Command Syntax

0-65536 specifies the global port number used for all


communication between the TACACS+
server and the TACACS client.

Command Default
49

1-228 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

tacacs-server retry
The tacacs-server retry command is used to globally specify a retry count for all
TACACS+ servers. A global retry count is used if no retry count is specifically
configured for this TACACS+ server. The no tacacs-server retry command restores
the global default value of 3 retries.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


tacacs-server retry <0-100>
no tacacs-server retry

Command Syntax

0-100 the retry count

Command Default
3 retries

Compass ID: 188656176 Version 5 MGBI 1-229


BSR 64000 Command Reference Guide Release 4.2.0

tacacs-server timeout
The tacacs-server timeout command is used to specify a global timeout interval for
all TACACS+ servers. A global timeout value is used if no timeout value is
specifically configured for this TACACS+ server. The no tacacs-server timeout
command restores the global default timeout value or specifies another value.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


tacacs-server timeout <1-1000>
no tacacs-server timeout [<1-1000>]

Command Syntax

1-1000 timeout value in seconds.

Command Default
10 seconds

1-230 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

telnet
The telnet command establishes a telnet connection between the BSR and a remote
system.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


telnet {<A.B.C.D> | <WORD>}

Command Syntax

A.B.C.D the IP address of a remote system


WORD the hostname of a remote system

Compass ID: 188656176 Version 5 MGBI 1-231


BSR 64000 Command Reference Guide Release 4.2.0

telnet authentication radius


The telnet authentication radius command enables RADIUS authentication for
telnet access. The no telnet authentication radius command disables this feature.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


telnet authentication radius [ fail-message <LINE> | local-password ]
no telnet authentication radius [ fail-message | local-password ]

Command Syntax

fail-message LINE specify message to display for a failed login/


authentication
local-password authenticate with a locally configured
password if there is no response from the
RADIUS server

1-232 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

telnet session-limit
The telnet session-limit command specifies a limit on the number of concurrent
telnet sessions allowed to the BSR. Setting the session-limit to "0" will disallow any
telnet sessions from being accepted. Setting a session-limit value will not affect any
currently open telnet sessions.
The no telnet session-limit command restores the default session limit of 16
concurrent telnet sessions.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


telnet session-limit <0-16>
no telnet session-limit [<0-16>]

Command Syntax

0-16 the telnet session limit number

Command Default
16

Compass ID: 188656176 Version 5 MGBI 1-233


BSR 64000 Command Reference Guide Release 4.2.0

update bypass
The update bypass command bypasses specified Resource Manager behaviors.

Group Access
All

Command Mode
Privileged EXEC and Global Configuration

Command Line Usage


update bypass {all | boot | download | format | reset} [<0-15>]
no update bypass {all | boot | download | format | reset} [<0-15>]

Command Syntax

all bypass all configurable behaviors


boot bypass boot command to daughter card
download bypass behavior for default and forced
download
format bypass slot format - causes the spare SRM to
format the target boot device before receiving
a new application image
reset bypass slot reset
0-15 slot number of the BSR 64000 chassis

1-234 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

update chassis
The update chassis command allows a runtime upgrade of the BSR 64000 I/O
module bootrom, the FPGA, and applications.

Note: Using the update chassis command may result in an audible loss of
voice-over-IP data for up to 20 seconds

Group Access
All

Command Mode
Privileged EXEC and Global Configuration

Command Line Usage


update chassis {flash: <filename> | ftp:<filename> | nvram: <filename>| tftp:
<filename>} [reload]

Command Syntax

flash: upgrade from archive in flash:


ftp: copy to nvram: and upgrade
nvram: upgrade from archive in nvram:
tftp: copy to nvram: and upgrade
filename filename of the boot image stored in flash,
NVRAM, or an FTP or TFTP server
reload set bootfile and perform reload

Compass ID: 188656176 Version 5 MGBI 1-235


BSR 64000 Command Reference Guide Release 4.2.0

username
The username command establishes a login authentication system based on a
username.
Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


username <WORD> password [ 0 | 7 ]<WORD>
username <WORD> nopassword

Command Syntax

WORD the username, up to 16 characters


nopassword no password is required for the user
to log in
password specify a password for the user (31
character maximum) - enclosed with
double quotes if the key contains
spaces). The "%" and "!" characters
must not be used.
0 specifies an UNENCRYPTED
password
7 specifies a HIDDEN password will
follow
WORD the UNENCRYPTED (cleartext)
user password (31 character
maximum) - enclosed with double
quotes if the key contains spaces).
The "%" and "!" characters must not
be used.

1-236 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

Note: Refer to Defining a User Name with an Encrypted Password in the


BSR 64000 Configuration and Management Guide for Release 3.1 for details
on encrypting passwords.

Compass ID: 188656176 Version 5 MGBI 1-237


BSR 64000 Command Reference Guide Release 4.2.0

username privilege
The username privilege command sets a privilege level for a user.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


username <WORD> privilege {ro | rw}

Command Syntax

WORD the username, up to 16 characters


privilege the user privilege level
ro read-only privilege
rw read and write privilege

1-238 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

username user-group
The username user-group command assigns a user to a user group. The no
username user-group command removes a user from a user group.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


username <WORD> user-group {isp <1-1> | mso | restricted | sysadmin}
no username <WORD> user-group {isp <1-1> | mso | restricted | sysadmin}

Command Syntax

WORD the username, up to 16 characters


user-group assigns the user group name
isp provides this user access to most CLI
commands including routing
commands but excluding cable
commands
1-1 the number of the virtual ISP
mso provides this user access to most CLI
commands including cable
commands but excluding routing
commands
restricted only provides this user access to CLI
commands with a designated
privilege level of "restricted" as
defined with the privilege restricted
CLI command.

sysadmin provides this user access to all CLI


commands

Compass ID: 188656176 Version 5 MGBI 1-239


BSR 64000 Command Reference Guide Release 4.2.0

xfabric keepalive
The xfabric keepalive command enables the switch fabric keepalive timer and
specifies the type of system reaction in the event of a switch fabric failure. The no
xfabric keepalive command disables the switch fabric keepalive timer.

Note: Motorola recommends always enabling the xfabric keepalive


slot-recover command and copying the running configuration to the startup
configuration. This causes the BSR to reset a slot which fails to respond to a
1-second switch fabric keepalive message for 10 consecutive intervals. If for
any reason a customer's configuration or traffic level results in undesirably
frequent slot resets, the threshold number of intervals can be increased to
<1-255> intervals with the xfabric keepalive slot-recover threshold
<1-255> command.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


xfabric keepalive { 880-recover | cmts-rebind | monitor | slot-recover }
[threshold <1-255>]
no xfabric keepalive [880-recover | cmts-rebind | monitor | slot-recover ]
[threshold]
no xfabric keepalive threshold

Command Syntax

880-recover initiate 880-recover if switch fabric is not


operational
cmts-rebind rebind all CMTS modules to available HSIM
modules if the data path is not operational
monitor system logger notification only

1-240 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 System Administration Commands

slot-recover initiate a slot recovery reset if the switch


fabric is not operational
threshold <1-255> configures the number of 1 second timeouts
until an action is taken

threshold restores the default threshold value for the no


xfabric keepalive 880-recover,
cmts-rebind, monitor, and slot-recover
commands - the no xfabric keepalive
threshold command restores all default
threshold values

Command Defaults

880-recover Disabled
cmts-rebind Disabled
monitor Disabled
slot-recover Disabled
880-recover threshold 3 seconds
cmts-rebind threshold 15 seconds
monitor threshold 10 seconds
slot-recover threshold 60 seconds

Compass ID: 188656176 Version 5 MGBI 1-241


2
IP Commands

Introduction
This chapter describes the following types of commands for the BSR:
Interface commands not associated with a specific protocol can be used to configure
interface features with any device on the network.
Transmission Control Protocol/Internet Protocol (TCP/IP) commands handle
network communications between network nodes. This includes network addressing
information, control information that enables packets to be routed, and reliable
transmission of data.
Address Resolution Protocol (ARP) commands dynamically maps IP addresses to
physical hardware addresses. An ARP cache is used to maintain a correlation between
each MAC address and its corresponding IP address.
Domain Name System (DNS) commands are used to map hostnames to IP addresses,
and to control Internet routing information. Lists of domain names and IP addresses
are distributed throughout the Internet with DNS servers.
Simple Network Time Protocol (SNTP) commands are used to synchronize
computer clocks in the global internet. SNTP operates in unicast, broadcast, and IP
multicast modes.

Compass ID: 188656176 Version 5 MGBI 2-1


BSR 64000 Command Reference Guide Release 4.2.0

Tunneling commands provide a way to encapsulate packets inside of a


transport protocol. IP in IP Encapsulation for tunnel interfaces is supported by
the BSR.

IP Command Descriptions
This section contains an alphabetized list and descriptions of the IP commands
supported by the BSR.

2-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

arp
The arp command adds a permanent entry in the ARP cache. The no arp command
removes the entry in the ARP cache. The arp command can also specify the type of
ARP packet that is used, whether to use an alias if proxy arp is enabled, and to specify
a cable bundle interface if cable bundling is being used.

Note: Proxy ARP is not enabled by default. ARP cache entries translate
32-bit addresses into 48-bit hardware addresses. If the host supports
dynamic resolution, static entries are usually not needed. Use the clear
arp-cache command to remove all dynamically learned entries.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


arp <A.B.C.D> <H.H.H> {arpa | snap} [alias | cablebundle cable <X/Y> |
cm-hardware-address <H.H.H>]
no arp <A.B.C.D> <H.H.H> {arpa | snap} [alias | cablebundle cable <X/Y> |
cm-hardware-address <H.H.H>]

Command Syntax

A.B.C.D four-part dotted-decimal format matching the


local data link
H.H.H 48-bit local data link address
arpa standard Ethernet-style ARP, RFC 826
snap IEEE 802.3 usage of ARP packets
conforming to RFC 1042
alias responds to ARP as if it owns the specified
address, if proxy arp is enabled
cablebundle cable specify the cable bundle physical interface

Compass ID: 188656176 Version 5 MGBI 2-3


BSR 64000 Command Reference Guide Release 4.2.0

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
cm-hardware-address specify the cable modem that this host is
attached to
H.H.H the MAC address of cable modem

Command Default
no entries in table
arpa (ethernet ARP)

2-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

arp timeout
The ARP timeout feature is used to prevent unnecessary flooding of traffic over the
cable network. ARP resolution requests are terminated after a defined interval when
attempts to resolve addressing information, for a device entry in the ARP cache table.
The arp timeout command configures the amount of time an entry stays in the ARP
cache. The no arp timeout command restores the default ARP timeout condition. The
show interfaces command displays the current ARP timeout value.

Note: When the arp timeout value is changed, the change affects all the
existing entries in addition to the entries subsequently created.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


arp timeout <1-6000>
no arp timeout <1-6000>

Command Syntax

1-6000 The expiration value in minutes for the


amount of time an entry is allowed to stay in
the ARP cache

Command Default
60 minutes

Compass ID: 188656176 Version 5 MGBI 2-5


BSR 64000 Command Reference Guide Release 4.2.0

cable helper-address
The cable helper address function disassembles a DHCP broadcast packet, and
reassembles it into a unicast packet so that the packet can traverse the router and
communicate with the DHCP server. The cable helper-address command enables
broadcast forwarding for User Datagram Protocol (UDP) packets.

The cable helper-address command is also used to bind a cable helper address to a
secondary IP subnet of a CM which is connected to CPEs belonging to a particular
ISP. This allows CPEs to have their IP address assigned from the DHCP server
belonging to the corresponding ISP.

Note: The isp-bind option is only available after selecting the host or mta
options. It is not available for the cable modem option.

Group Access
ISP

Command Mode
Interface Configuration (cable and loopback interfaces only)

Command Line Usage


cable helper-address <A.B.C.D> {cable-modem | host | mta} [isp-bind <A.B.C.D>]
no cable helper-address <A.B.C.D> {cable-modem | host | mta} [isp-bind
<A.B.C.D>]

Command Syntax

A.B.C.D the IP address of the destination DHCP


server.
cable-modem specifies that only CM UDP broadcasts are
forwarded.
host specifies that only CPE UDP broadcasts are
forwarded.

2-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

mta specifies that only CPE MTA broadcasts are


forwarded.
isp-bind A.B.C.D specifies the secondary IP subnet to which the
cable-helper is bound.

Compass ID: 188656176 Version 5 MGBI 2-7


BSR 64000 Command Reference Guide Release 4.2.0

clear arp-cache
The clear arp-cache command clears dynamic entries from ARP cache.

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


clear arp-cache [<A.B.C.D>]

Command Syntax

A.B.C.D the IP address for ARP table entry to be


cleared

2-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

clear counters
The clear counters command is used to clear a specific counter or all interface
counters.

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


clear counters [ethernet <X/Y>| cable <X/Y> gigaether <X/Y> | ipsec | loopback
<1-255> | pos <X/Y> | tunnel <0-255> ]

Command Syntax

cable X/Y clears the cable counters for the specified slot
and port
ethernet X/Y clears the Ethernet or for the specified slot
and port
gigaether X/Y clears the Gigabit Ethernet counters for the
specified slot and port
ipsec clears the IPSEC counters
loopback 1-255 clears the loopback for the specified loopback
interface number
tunnel 0-255 clears the tunnel interface counters for the
specified tunnel interface number
pos X/Y clears the Packet over SONET (POS)
counters for the specified slot and port

Compass ID: 188656176 Version 5 MGBI 2-9


BSR 64000 Command Reference Guide Release 4.2.0

clear host
The clear host command deletes DNS host entries from the
host-name-and-address cache.
Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


clear host {<WORD> | *}

Command Syntax

WORD deletes a specific DNS host entry


* deletes all DNS host entries

2-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

clear ip route
The clear ip route command deletes route table entries.

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


clear ip route {* | <A.B.C.D> [<A.B.C.D>]}

Command Syntax

* Deletes all routes.


A.B.C.D Destination network IP address.
A.B.C.D Destination network subnet mask.

Compass ID: 188656176 Version 5 MGBI 2-11


BSR 64000 Command Reference Guide Release 4.2.0

clear ip traffic
The clear ip traffic command resets the IP traffic statistic counters to zero.

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


clear ip traffic

2-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

host authorization
The host authorization feature is used for security purposes on the cable network.
When enabled, host authorization denies access to any hacker who tries to take or
“spoof” an IP address from any legitimate user on the same cable network. A hacker
takes the IP address from this user to steal their data service. The hacker accomplishes
this by changing the IP address on their PC to the IP address that the DHCP server
assigned to a legitimate user’s CPE. Cable operators can create static entries to deny
hackers from stealing service from users. Through static entries, cable operators can
manually bind the CPE MAC (hardware) and IP address to a particular cable modem.
This command may be used in circumstances when DHCP is not used to assign the
CPE IP addresses
The host authorization command is used to enforce the binding of the CM and CPE
MAC addresses to the IP address assigned to them (statically or through DHCP). The
no host authorization command disables host authorization on the cable interface.

Group Access
ISP

Command Mode
Interface Configuration mode (cable interface only)

Command Line Usage


host authorization {<mac> {cpe <mac> <prefix> | cpr <mac> <prefix>}} | on}
no host authorization on {<mac> {cpe <mac> <prefix> | cpr <mac> <prefix>}} |
on}

Command Syntax

mac the cable modem mac address in the form of


xxxx.xxxx.xxxx
cpe specify customer premise equipment
mac the MAC address of the customer premises
equipment (CPE) or customer premises router
(CPR)
prefix the CPE or CPR’s IP address

Compass ID: 188656176 Version 5 MGBI 2-13


BSR 64000 Command Reference Guide Release 4.2.0

cpr specify a customer premise router


on enable host authorization

Command Default
Disabled

2-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

interface
The interface command specifies an interface for further configuration. Once the
interface is selected you enter Interface configuration mode.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


interface {cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> | loopback <1-255> | pos
<X/Y> | tunnel <0-255>}

Command Syntax

cable X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
ethernet on the SRM module, Ethernet interface 0 is a
10 Mbps management interface that does not
support the negotiation feature and is
associated with its corresponding port on the
SRM I/O module.
Ethernet ports 1 and 2 are typically used to
support an external T1/E1 BITS clock and are
associated with their corresponding ports on
the SRM I/O module.
On the 8-port Ethernet module, there are 8 10/
100 Mbps Ethernet ports
gigaether provides one 1000 Mbps optical Ethernet
interface

Compass ID: 188656176 Version 5 MGBI 2-15


BSR 64000 Command Reference Guide Release 4.2.0

pos provides two high speed OC3/OC12 SONET


interfaces.
X/Y the slot and port number
loopback 1-255 loopback interfaces are used to act as inbound
logical interfaces when physical interfaces go
down - up to 255 loopback interfaces are
supported
tunnel 0-255 tunnel are logical interfaces used to make
point-to-point links between two devices - up
to 255 tunnels are supported

2-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip access-group
The ip access-group command configures an interface to use an access list. The no ip
access-group command does not allow incoming or outgoing packets.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip access-group {<1-199> | <1300-2699>} {in | out}
no ip access-group {<1-199> | <1300-2699>} {in | out}

Command Syntax

1-199 Standard number range from 1 to 199.


1300-2699 Extended number range from 1300 to 2699.
in Incoming packet is processed only if the
source-address is in the access-list.

out Same as in, outgoing packet is processed only


if access-list permits the packet.

Command Default
No access groups defined.

Compass ID: 188656176 Version 5 MGBI 2-17


BSR 64000 Command Reference Guide Release 4.2.0

ip address
The ip address command configures a primary or secondary IP address for an
interface or defines the Gateway IP address (giaddr) for Customer Premises
Equipment (CPE), Multimedia Telephone Adapter (MTA), or cable modem DHCP
requests. The no ip address command is used to remove an IP address from the
interface.
When configuring a cable or loopback interface’s IP address, two additional options
are supported; the host and mta options. The host and mta options are only available
from cable or loopback interface configuration mode when selecting an IP address.
During the DHCP process, the relay agent requests an IP address in a particular subnet
by inserting the IP address of the interface into the DHCP requests from CMs, hosts,
and MTAs. The primary address is always inserted in cable modem DHCP requests. If
a secondary address or a secondary host address is defined, then the first secondary or
secondary host IP address in the list is inserted into DHCP requests from hosts. If one
or multiple secondary mta IP address are defined, then the first secondary mta IP
address defined is inserted into DHCP requests from secondary MTA devices. The ip
dhcp relay information option command must be enabled to allow the BSR to
determine what type of device originated the DHCP request. By default, the primary
address will be inserted into DHCP requests.
The ip address command is also used to bind a secondary IP address to a secondary
IP subnet of a CM which is connected to CPEs belonging to a particular ISP. This
allows the BSR to set the giaddr of the CPE's DHCP packets to the secondary
address of the CM to which the secondary addresses of the CPE are bound.

Note: You must configure a primary IP address before configuring any


secondary IP addresses.

2-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

Note: The BSR supports 256 secondary IP subnets per CMTS module.The
maximum number of secondary IP subnets that can be configured on the
entire BSR chassis is 1024.

If you are running a BCM 3140-based DOCSIS 2.0 2:8 CMTS module as two
1:4 configurations, the limit is still 256 secondary IP subnets for the entire 2:8
CMTS module. The total number of secondary IP subnets between MAC
Domain 0 and MAC Domain 1 can only equal 256. Also, if you apply the
same cable bundle to each MAC domain even though the secondary IP
subnets are the same they must be counted twice.

For example, if you have 256 secondary IP subnets in a cable bundle and
you apply that cable bundle to two MAC domains, the total number of
secondary IP subnets would be 512 which exceeds the limit for the DOCSIS
2.0 CMTS module. In this example, there can be no more than 128
secondary IP subnets on the cable bundle.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip address <A.B.C.D> <A.B.C.D> [secondary]
no ip address <A.B.C.D> <A.B.C.D> [secondary]

Cable or Loopback interfaces only:


ip address <A.B.C.D> <A.B.C.D> [ secondary [ host | mta ][isp-bind <A.B.C.D>]]]
no ip address <A.B.C.D> <A.B.C.D> [ secondary [ host | mta ][isp-bind
<A.B.C.D>]]]

Compass ID: 188656176 Version 5 MGBI 2-19


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D the IP address


A.B.C.D the subnetwork mask for the IP address - the
BSR supports up to a 30-bit subnetwork IP
address mask
secondary designates the specified IP address as a
secondary IP address - on a cable interface,
defines this IP address as the IP address to be
inserted into host DHCP requests
host defines the IP address for the cable interface
as the giaddr for host DHCP requests - on the
cable interface, defines this IP address as the
IP address to be inserted into host DHCP
requests (this option is only available on the
cable interface)
mta defines the IP address for the cable interface
as the giaddr for all MTA DHCP requests - on
the cable interface, defines this IP address as
the IP address to be inserted into MTA DHCP
requests (this option is only available on the
cable interface)
isp-bind A.B.C.D specifies the secondary IP subnet to which
this secondary address is bound.

2-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip broadcast-address
The ip broadcast-address command creates a broadcast address for an interface. The
no ip broadcast-address command deletes the broadcast address for an interface.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip broadcast-address <A.B.C.D>
no ip broadcast-address <A.B.C.D>

Command Syntax

A.B.C.D broadcast IP address assigned to the interface

Compass ID: 188656176 Version 5 MGBI 2-21


BSR 64000 Command Reference Guide Release 4.2.0

ip dhcp relay information


The ip dhcp relay information command enables the BSR to insert DHCP relay
information option (option-82) into received DHCP client messages being forwarded
to a DHCP server (configured using the cable helper command). Support for DHCP
Option-82, sub-option 2 (Agent Remote ID), which is enabled by the ip dhcp relay
information option command, allows the relay agent in the BSR to insert the MAC
address of the modem that the DHCP client is behind into outbound DHCP client
requests (i.e., DHCP Discovers and DHCP Requests as they traverse the BSR). This
enables the receiving DHCP server to identify the user sending the request and to treat
that client appropriately.
Support for DHCP Option-82, sub-option 1 (Agent Circuit ID), which is enabled by
the ip dhcp relay information spectrum-group-name command, allows the relay
agent in the BSR to insert, when available, the Spectrum Group name associated with
the upstream channel that the DHCP client is using into outbound DHCP client
requests (i.e., DHCP Discovers and DHCP Requests as they traverse the BSR).

Note: If you are configuring two MAC domains on the 2x8 CMTS module, the
ip dhcp relay information option command must be entered for each MAC
domain. If this command is not entered in for each domain, CMs cannot
register in that domain.

Note: If a DHCP client on a particular subnet is using an upstream frequency


that is not configured as a member of a Spectrum Group, the Spectrum
Group name is not inserted by the DHCP relay agent into the DHCP discover
packet.

Group Access
ISP

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


ip dhcp relay information {option | spectrum-group-name}
no ip dhcp relay information {option | spectrum-group-name}

2-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

Command Syntax

option insert a MAC address (Agent Remote ID)


only into a client’s DHCP discover packets
spectrum-group-name insert the Spectrum Group name into all
DHCP outbound requests

Compass ID: 188656176 Version 5 MGBI 2-23


BSR 64000 Command Reference Guide Release 4.2.0

ip domain-list
The ip domain-list command provides up to six domain names to resolve unqualified
host names when the primary domain, specified by the ip domain-name command,
fails to resolve.
Use the ip domain-list command to define a list of secondary domain names.
Secondary domain names are used if the primary domain name fails to resolve.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip domain-list <WORD> [<WORD>] [<WORD>] [<WORD>] [<WORD>]
[<WORD>]
no ip domain-list <WORD...>

Command Syntax

WORD Domain name.

2-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip domain-lookup
The ip domain-lookup command enables the IP Domain Name System (DNS) based
host name-to-address translation. The no ip domain-lookup command disables the IP
DNS-based name-to-address translation.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip domain-lookup
no ip domain-lookup

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 2-25


BSR 64000 Command Reference Guide Release 4.2.0

ip domain-name
For each BSR, you should configure the name of the domain in which the BSR is
located. This is the default domain name that is appended to host names that are not
fully qualified. The ip domain-name command is used to configure a domain name.
The no ip domain-name command removes the domain name.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip domain-name <WORD>
no ip domain-name <WORD>

Command Syntax

WORD name of domain being established

Command Default
No domain is configured.

2-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip forward-protocol udp
The ip forward-protocol udp command controls what type of UDP packet to
forward when broadcasting packets or allows all types of UDP packets to be
forwarded. The no ip forward-protocol udp command disables IP forwarding.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip forward-protocol udp [<0-65535> | bootpc | bootps | domain | netbios-dgm |
netbios-ns | tacacs | tftp | time]
no ip forward-protocol udp [<0-65535> | bootpc | bootps | domain | netbios-dgm |
netbios-ns | tacacs | tftp | time]

Command Syntax

0-65535 Specific UDP port number.


bootpc Bootstrap Protocol (BOOTP) client (68)
bootps Bootstrap Protocol (BOOTP) server (67)
domain Domain Name Service (DNS, 53)
netbios-dgm NetBios datagram service (138)
netbios-ns NetBios name service (137)
tacacs TAC Access Control System (49)
tftp Trivial File Transfer Protocol (69)
time Time (37)

Compass ID: 188656176 Version 5 MGBI 2-27


BSR 64000 Command Reference Guide Release 4.2.0

ip forwarding
The ip forwarding command neutralizes virus or hacking attacks by forwarding the
offending traffic on Transmission Control Protocol (TCP) or User Datagram Protocol
(UDP) source or destination port zero (depending where this traffic is coming from),
where it is then discarded through the BSR’s hardware.
Once the hacking or virus problem is resolved, the no ip forwarding command is
used to stop discarding TCP or UDP packets on their respective source port 0 or
destination port 0.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip forwarding {tcp | udp}{dst-zero | src-zero}
no ip forwarding {tcp | udp}{dst-zero | src-zero}

Command Syntax

tcp TCP port type


udp UDP port type
dest-zero destination port is 0
src-zero source port is 0

Command Default
Disabled

2-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip helper-address
The ip helper-address command determines the destination IP address of the DHCP
server for where broadcast packets are forwarded. The no ip helper-address
command removes the IP address where broadcast packets are forwarded.
Use the ip-helper address command to forward broadcast packets received on an
interface.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip helper-address <A.B.C.D>
no ip helper-address <A.B.C.D>

Command Syntax

A.B.C.D Destination broadcast/host address to be used.

Compass ID: 188656176 Version 5 MGBI 2-29


BSR 64000 Command Reference Guide Release 4.2.0

ip host
The ip host command is used to add a static, classless DNS host entry to the ip
hostname table by matching the host IP address to its DNS host name mapping. The
no ip host command deletes the host address-to-name mapping in the host cache.

Note: The initial character of the name must be a letter.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip host <WORD> <A.B.C.D>
no ip host <WORD> <A.B.C.D>

Command Syntax

WORD name of host


A.B.C.D IP address

Command Default
No hosts configured

2-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip irdp
The ip irdp command enables the ICMP Router Discovery Protocol (IRDP) on an
interface. The no ip irdp command disables the ICMP IRDP on an interface.

Group Access
ISP

Command Mode
Interface Configuration (Ethernet and Gigabit Ethernet interfaces only)

Command Line Usage


ip irdp [address <A.B.C.D> | holdtime <1-9000> | maxadvertinterval <4-1800> |
minadvertinterval <3-1800> | multicast | preference <-2147483648-2147483647>]
no ip irdp [address <A.B.C.D> | holdtime <1-9000> | maxadvertinterval <4-1800>
| minadvertinterval <3-1800> | multicast | preference
<-2147483648-2147483647>]

Command Syntax

address IP addresses to proxy-advertise, preference


value.
A.B.C.D IP address to advertise.
holdtime amount of time, in seconds, advertisements
hold valid
1-9000 value in seconds
maxadvertinterval maximum time between advertisements
4-1800 value in seconds
minadvertinterval minimal time between advertisement in
seconds
multicast advertisements are sent with multicast

Compass ID: 188656176 Version 5 MGBI 2-31


BSR 64000 Command Reference Guide Release 4.2.0

preference preference value for this interface, -231 to 231,


higher value increases performance, preferred
router
-2147483648-2147483647 preference for this address (higher values
preferred)

Command Default

holdtime = 1800 seconds


maxadvertinterval = 600 seconds
minadvertinterval = 450 seconds
preference = -2147483648-2147483647

2-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip mask-reply
The ip mask-reply command enables Internet Control Message Protocol (ICMP)
netmask reply messages. The no ip mask-reply command disables ICMP netmask
reply messages.

Group Access
ISP

Command Mode
Interface Configuration

Command Mode
ip mask-reply
no ip mask-reply

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 2-33


BSR 64000 Command Reference Guide Release 4.2.0

ip mtu
The ip mtu command configures the Maximum Transmission Unit (MTU) packet
size allowed on the interface. The no ip mtu command resets the default.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip mtu <68-4000>
no ip mtu

Command Syntax

68-4000 MTU size in bytes

Command Default
1496 bytes

2-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip name-server
The ip name-server command is used to enter the IP address of one or more Domain
Name Servers (DNS). Up to six DNS can be configured on the BSR. The no ip
name-server command deletes a DNS entry.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip name-server <A.B.C.D> [<...A.B.C.D>]
no ip name-server <A.B.C.D> [<...A.B.C.D>]

Command Syntax

A.B.C.D IP addresses of your DNS.

Compass ID: 188656176 Version 5 MGBI 2-35


BSR 64000 Command Reference Guide Release 4.2.0

ip proxy-arp
The ip proxy-arp command enables proxy ARP on the interface. The no ip
proxy-arp command disables proxy ARP on an interface.

Note: If a host in the local network is incapable of responding to an ARP


request for some reason, the router will respond on behalf of the host when
proxy arp is enabled and the IP-to-MAC address mapping of the host is
stored in the router with a static arp command, with the alias option specified.

To verify ARP status, use the show running-config command.

The BSR will also respond to an ARP request for a network on a different
interface when proxy ARP is turned on.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip proxy-arp
no ip proxy-arp

Command Default
Disabled

2-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip rarp-server
The ip rarp-server command is used to enable the router to act as a RARP server.
The no ip rarp-server command disables the router to act as a RARP server.
The RARP server can be configured on each interface to ensure that the router does
not affect RARP traffic on other subnetworks that do not need RARP assistance. The
following conditions must be satisfied before receiving RARP support:
■ The ip rarp-server command must be configured on the requesting interface
■ A static entry, must exist in the IP ARP table, mapping the MAC address in the
RARP request to an IP address
The IP address should be set to whatever address the user configures as the primary
address for the interface.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip rarp-server <ip-address>
no ip rarp-server <ip-address>

Command Syntax

A.B.C.D The IP address that is provided as the source


protocol address field of the RARP response
packet.

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 2-37


BSR 64000 Command Reference Guide Release 4.2.0

ip redirects
The ip redirects command enables messages to be redirected if a packet needs to be
resent through the interface that received the packet. The no ip redirects command
disables messages that are redirected if a packet needs to be resent through the
interface that received the packet.

Group Access
ISP

Command Mode
Interface Configuration (not supported for Cable interfaces)

Command Line Usage


ip redirects
no ip redirects

2-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip route
The ip route command is used to configure a static route when the router cannot
dynamically build a route to the specific destination or if the route must be in place
permanently. The no ip route command remove a static route.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip route <A.B.C.D> <A.B.C.D> {<A.B.C.D> | null <0-0> | pos <X/Y> | tunnel
<0-255>} [<1-255> | [tag <1-4294967295>]
no ip route <A.B.C.D> <A.B.C.D> {<A.B.C.D> | null <0-0> | pos <X/Y> | tunnel
<0-255>} [<1-255> | [tag <1-4294967295>]

Command Syntax

A.B.C.D static route destination prefix


A.B.C.D static route destination prefix mask
A.B.C.D the forwarding router's IP address
null 0-0 null slot and port, valid values 0 and 0
pos X/Y POS slot and port number
tunnel 0-255 tunnel interface number
1-255 administrative distance, default value 1
tag 1-4294967295 match value to control route-map
redistribution, valid values 1 to 4294967295

Command Default
Administrative distance = 1

Compass ID: 188656176 Version 5 MGBI 2-39


BSR 64000 Command Reference Guide Release 4.2.0

ip routing
The ip routing command enables IP routing. The no ip routing command disables IP
routing.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip routing
no ip routing

Command Default
Enabled

2-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

ip source-route
The ip source-route command allows the BSR to handle IP datagrams with source
routing header options. The no ip source-route command discards any IP datagram
containing a source-route option.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip source-route
no ip source-route

Compass ID: 188656176 Version 5 MGBI 2-41


BSR 64000 Command Reference Guide Release 4.2.0

ip unreachables
The ip unreachables command enables processing of an ICMP unreachable message
when the BSR cannot deliver a received packet. The no ip unreachables command
disables ICMP unreachable message processing when the router cannot deliver a
received a packet.

Group Access
ISP

Command Mode
Global Configuration and Interface Configuration

Command Line Usage


ip unreachables
no ip unreachables

Command Default
Enabled

2-42 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

passive-interface
The passive-interface command suppresses routing updates from being transmitted
over a specific ethernet or cable routing interface. The no passive-interface
re-enables route updates to be transmitted over the routing interface.

Note: Updates from routers that are directly connected to the passive
interface continue to be received and processed.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


passive-interface {cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>}
no passive-interface {cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> |
pos <X/Y>}

Command Syntax

cable X/Y cable interface slot and MAC Domain


number
ethernet X/Y Ethernet interface slot and port number
gigaether X/Y Gigabit Ethernet interface slot and port
number
pos X/Y Packet-Over-SONET interface slot and port
number

Command Default
Routing updates are transmitted over the router.

Compass ID: 188656176 Version 5 MGBI 2-43


BSR 64000 Command Reference Guide Release 4.2.0

ping
The Packet Internet Groper (PING) ping command sends an Internet Control
Message Protocol (ICMP) echo request to a remote host that reports errors and
provides information relevant to IP packet addressing.
Use the ping command to check host reach ability and network connectivity, or to
confirm basic network connectivity.

Note: The address of the source in an echo message will be the destination
of the echo reply message. To form an echo reply message, the source and
destination addresses are simply reversed, the type code changed to 0, and
the checksum recomputed.

ICMP is used to report problems with delivery of IP datagrams within an IP


network. It can also show when a particular node is not responding, when an
IP network is not reachable, when a node is overloaded, when an error
occurs in the IP header information, etc. The protocol is also frequently used
by Internet managers to verify correct operations of nodes and to check that
routers are correctly routing packets to the specified destination address.

Group Access
All

Command Mode
User EXEC and Privileged EXEC

Command Line Usage


ping {<A.B.C.D> | Hostname}[size <40-65515] [<1-65535>]
[timeout <1-1024>] [source <A.B.C.D>] [tos <0-255>] [ttl <0-255>] [df]

Command Syntax

A.B.C.D IP address of the remote system to ping


Hostname name of the remote system to ping
size 1-165535 size of the echo message in bytes,

2-44 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

1-65535 number of ping requests to send


timeout 1-1024 timeout in seconds
source A.B.C.D source IP address to use to send the ping
request
tos 0-255 the type of service of the ping packets
ttl 0-255 Time to live value in seconds
df sets the "don’t fragment" IP flag in the
outgoing ping IP header

Compass ID: 188656176 Version 5 MGBI 2-45


BSR 64000 Command Reference Guide Release 4.2.0

show arp
The show arp command displays static and dynamic entries in the ARP table. The
following is an example of typical screen output from the show arp command:

Protocol Address Age(min) Hardware Address Type Interface


Internet 10.10.10.10 - 0030.b801.c5f4 ARPA ethernet 15/4
Internet 10.255.4.1 - 0000.0000.0004 ARPA
Internet 10.255.5.1 - 0000.0000.0005 ARPA
Internet 10.255.6.1 - 0000.0000.0006 ARPA
Internet 10.255.7.1 - 0000.0000.0007 ARPA
Internet 150.31.60.1 41 00e0.6367.99b1 ARPA ethernet 7/0
Internet 150.31.60.10 - 0030.b801.c570 ARPA ethernet 7/0
Internet 150.31.60.99 - 0000.0000.9999 ARPA ethernet 7/0
Internet 150.31.61.23 21 0008.0ee4.84e8 ARPA cable 0/0
Internet 150.31.61.27 31 0008.0ee4.d550 ARPA cable 0/0
Internet 150.31.61.28 3 0020.4026.77c0 ARPA cable 0/0
Internet 150.31.61.29 3 0020.4027.a028 ARPA cable 0/0
Internet 150.31.61.34 3 0020.4026.d5dc ARPA cable 0/0
Internet 150.31.61.37 3 0020.4026.77bc ARPA cable 0/0
Internet 150.31.61.80 3 0020.4029.19dc ARPA cable 0/0
Internet 150.31.61.81 3 0020.4027.a038 ARPA cable 0/0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show arp [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show arp [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string

2-46 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

exclude filter for output that excludes the


specified string
include filter for output that includes the
specified string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 2-47


BSR 64000 Command Reference Guide Release 4.2.0

show controllers
The show controllers command displays detailed hardware and configuration
information for each module on installed in the BSR chassis.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show controllers cable <X/Y> [upstream <0-7> | downstream | mac ] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show controllers cable <X/Y> [upstream <0-7> | downstream | mac ] [ | {count |
count-only}]
show controllers ethernet [<X/Y>]
show controllers gigaether [<X/Y>]
show controllers pos [<X/Y>]}

Command Syntax

cable X/Y display cable interface controller


information for the specified BSR
chassis slot and MAC Domain
number including RF signal
information, the type of hardware
installed, FEC information for both
corrected and uncorrected packets,
the spectrum group and the status of
the cable interface
downstream display information for the
downstream port including
downstream modulation type,
frequency (label), and symbol rate

2-48 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

mac display MAC layer (layer 2)


information for all cable modems on
this specific CMTS module
upstream 0-7 display information for an upstream
port including the upstream
modulation type, channel width,
frequency, and modulation profile
information (i.e minislots, interleave,
preamble, etc.)
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output
ethernet X/Y display Ethernet interface controller
information for the entire BSR
chassis or the optional, specified
BSR chassis slot and port number
gigaether X/Y display Gigabit Ethernet interface
controller information for the entire
BSR chassis or the optional,
specified BSR chassis slot and port
number
pos X/Y display POS interface controller
information for the entire BSR
chassis or the optional, specified
BSR chassis slot and port number

Compass ID: 188656176 Version 5 MGBI 2-49


BSR 64000 Command Reference Guide Release 4.2.0

show host authorization


The show host authorization command displays the host authorization enabled state
and displays all cable host entries in the ARP authorization table. The following is an
example of typical screen output from the show host authorization command:

Device Type State Seconds Modem MAC Addr Host IP Addr Host MAC Addr
Host Dyn Ack 90000 0008.0e72.bf70 150.31.43.3 0008.0e72.bf72
Modem Dyn Ack-TD-TF 90000 0008.0e72.bf70 150.31.42.2 0008.0e72.bf70
Host Dyn Learned 90000 0008.0e73.1dba 150.31.43.2 0008.0e73.1dbc
Modem Dyn Ack-TD-TF 90000 0008.0e73.1dba 150.31.42.3 0008.0e73.1dba

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show host authorization <0-15>

Command Syntax

0-15 the CMTS slot number

2-50 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show host authorization cpe


The show host authorization cpe command is used to display the dynamic or static
ARP entries for CPEs only. The following is an example of typical screen output from
the show host authorization cpe command:

Type Host IP Address Host MAC Address


Dynamic 150.31.43.3 0008.0e72.bf72
Dynamic 150.31.43.2 0008.0e73.1dbc

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show host authorization cpe {leased | static} [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show host authorization cpe {leased | static} [ | {count | count-only}]

Command Syntax

leased display dynamically configured host


authorization entries
static display statically configured host
authorization entries
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string

include filter for output that includes the


specified string

Compass ID: 188656176 Version 5 MGBI 2-51


BSR 64000 Command Reference Guide Release 4.2.0

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

2-52 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show host authorization interface cable


The show host authorization interface cable displays host authorization
configuration information for a cable interface. The following is an example of typical
screen output from the show host authorization interface cable command:

Device Type State Seconds Modem MAC Addr Host IP Addr Host MAC Addr
Modem Dyn Ack-TD-TF 90000 0008.0e72.bf70 150.31.42.2 0008.0e72.bf70

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show host authorization interface cable <X/Y> [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show host authorization interface cable <X/Y> [ | {count | count-only}]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string

Compass ID: 188656176 Version 5 MGBI 2-53


BSR 64000 Command Reference Guide Release 4.2.0

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

2-54 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show host authorization summary


The show host authorization summary command is used to display the dynamic or
static ARP entries for CPEs only. The following is an example of typical screen
output from the show host authorization summary command:

Interface Total Total Total Dynamic Static Total


Modems Hosts Routers Entries Entries Entries
Cable 4/0 2 2 0 4 0 4

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show host authorization summary [<0-15>] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show host authorization summary [<0-15>] [ | {count | count-only}]

Command Syntax

0-15 the CMTS slot number


| turns on output modifiers (filters)

begin filter for output that begins with the specified


string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

Compass ID: 188656176 Version 5 MGBI 2-55


BSR 64000 Command Reference Guide Release 4.2.0

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

2-56 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show host unauthorized cpe


The show host unauthorized cpe command displays the list of hosts/CPEs that are
unauthorized due to a failed DHCP lease query response. The following is an example
of typical screen output from the show host unauthorized cpe command:

Type Host IP Address


Dyn 150.31.42.2

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show host unauthorized cpe

Compass ID: 188656176 Version 5 MGBI 2-57


BSR 64000 Command Reference Guide Release 4.2.0

show hosts
The show hosts command displays the cache list of host names and addresses, and the
lookup service type.

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


show hosts

2-58 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show interfaces
Use the show interfaces command to display the status and statistics for the network
interfaces. Use the show interfaces command without the slot and interface argument
to display all interfaces. The following is an example of typical screen output from the
show interfaces command:

ethernet 7/0 is up, line protocol is up


Hardware address is 00:30:b8:c6:5c:70
Internet address is 150.31.90.10/24
MTU 1500 bytes, BW 10000 Kbits
Encapsulation Arpa
(Auto) Half-duplex, (Auto) 10Mb/s, 10BaseT
ARP Timeout 01:00:00
Last input 00:00:00, output 00:00:00
Last clearing of
"show interface
" counters never
Last state change never, 0 interface resets
Queueing strategy: FIFO
Output queue 0/100, 0 drops; input queue 0/0, 0 drops
5 minute Input rate 22 bytes/sec, 0 packets/sec
5 minute Output rate 21 bytes/sec, 0 packets/sec
963 packets input, 60742121 bytes
Received 931 broadcasts, 157816 multicasts
0 input errors, 0 CRC, 0 overruns
0 runts, 0 giants, 0 alignments
652840 packets output, 58690119 bytes
55 output errors, 0 collisions, 0 underruns
0 late collisions, 55 deferred, 0 lost carrier

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 2-59


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show interfaces [ethernet <X/Y> | gigaether <X/Y> | cable <X/Y> | pos <X/Y> |
loopback <1-255> | tunnel <0-255>] [accounting] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show interfaces [ethernet <X/Y> | gigaether <X/Y> | cable <X/Y> | pos <X/Y> |
loopback <1-255> | tunnel <0-255>] [accounting] [ | {count | count-only}]

Command Syntax

ethernet X/Y Ethernet interface slot and port number


gigaether X/Y Gigabit Ethernet interface slot and port
number
cable X/Y Cable interface slot and port number
pos X/Y Packet-over-SONET interface slot and port
number
loopback 1-255 Loopback interface number
tunnel 0-255 Tunnel interface number
accounting Displays the number of packets for each
protocol type that has been sent through an
interface
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

WORD the specified string

2-60 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 2-61


BSR 64000 Command Reference Guide Release 4.2.0

show ip arp
The show ip arp command displays the Internet Protocol (IP) Address Resolution
Protocol (ARP) cache table entries for individual interfaces or all interfaces on the
BSR. Each ARP entry describes the protocol type, IP address to MAC address
binding, age time, ARP type, and interface location and type. Use the additional
command arguments to filter the output information you want to receive. The
following is an example of typical screen output from the show ip arp command:

Protocol Address Age(min) Hardware Address Type Interface


Internet 150.31.90.1 0 00e0.6367.99b1 ARPA ethernet 7/0
Internet 150.31.90.10 - 0030.b8c6.5c70 ARPA ethernet 7/0
Internet 150.31.93.10 21 0011.1aca.1388 ARPA cable 11/1
Internet 150.31.93.12 10 0011.1ac9.2094 ARPA cable 11/1
Internet 150.31.93.13 13 0011.8061.3f0e ARPA cable 4/0
Internet 150.31.93.14 8 0011.1aca.13a6 ARPA cable 11/0
Internet 150.31.93.15 20 0011.1aca.1394 ARPA cable 11/0
Internet 150.31.93.16 28 00c0.4f5e.e476 ARPA cable 11/1
Internet 150.31.93.17 3 0011.805f.fd30 ARPA cable 4/0
Internet 150.31.94.10 1 0011.1ac9.2096 ARPA cable 11/1
Internet 150.31.94.11 1 0011.1aca.138a ARPA cable 11/1
Internet 150.31.94.12 6 0011.1aca.1396 ARPA cable 11/0
Internet 150.31.94.13 1 0011.8061.3f10 ARPA cable 4/0
Internet 150.31.94.14 0 0011.1aca.13a8 ARPA cable 11/0
Internet 150.31.94.15 2 0011.805f.fd32 ARPA cable 4/0
Internet 150.31.98.10 - 0030.b8c6.5cf2 ARPA ethernet 15/2
Internet 150.31.98.100 0 00c0.4f63.482c ARPA ethernet 15/2
Internet 150.31.99.7 - 0030.b800.0701 ARPA ethernet 7/1

Group Access
All

Command Mode
All modes except for User EXEC

Command Line Usage


show ip arp [<A.B.C.D> | <H.H.H> | Hostname | cable <X/Y> | ethernet <X/Y> |
gigaether <X/Y> | loopback <0-255>] [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]

2-62 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show ip arp [<A.B.C.D> | <H.H.H> | Hostname | cable <X/Y> | ethernet <X/Y> |


gigaether <X/Y>] [ | {count | count-only}]

Command Syntax

A.B.C.D Displays entries matching IP address


H.H.H Displays entries showing a 48 bit MAC
address.
Hostname Displays entries matching a hostname
cable X/Y cable interface ARP entries for a specified
BSR slot and MAC Domain number.
ethernet X/Y Ethernet interface ARP entries for a specified
BSR slot and port number.
gigaether X/Y Gigabit Ethernet interface ARP entries for a
specified BSR slot and port number.
loopback 0-255 loopback interface ARP entries for a specified
BSR loopback interface number
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 2-63


BSR 64000 Command Reference Guide Release 4.2.0

show ip dhcp stats


The show ip dhcp stats command displays DHCP server statistical information.
including memory usage, counters, and DHCP messages sent and received for a
specified slot or all slots on the BSR. The following is an example of typical screen
output from the show ip dhcp stats command:

DHCP statistics:
CMTS Slot Upstream Downstream
4 30238 30234
6 0 0
9 0 0
11 40174 40160

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dhcp stats [<NUM>]

Command Syntax

NUM the BSR CMTS slot number

2-64 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show ip filters
The show ip filters command displays a variety of filter and routing policy
configuration information. Filters provide a mechanism for determining whether or
not to process IP packets received over the BSR 64000 POS OC-3/C12, Multi-Mode
Gigabit Ethernet (SX), Single-Mode Gigabit Ethernet (LX), or 10/100 Ethernet
Network Interface Modules (NIMs). When an IP packet matches one of the patterns in
a filter, the filter determines whether the packet is discarded or passed to the IP
routing module for forwarding. Filtering decisions can be based on combinations of
source address, destination address, TCP/UDP port and protocol.
The following is an example of typical screen output from the show ip filters
command:

NL = Null Filter, SM = Send To Srm, UA = Unresolved ARP,


AP = Access List Permit, AD = Access List Deny, PR = ACL Permit Range,
DR = ACL Deny Range, IR = ICMP Redirect, IU = ICMP Unreachable,
TL = Ip Tunnel Loopback, TE = Ip Tunnel Decap, TN = Ip Tunnel Encap,
PP = Policy Route Permit, PD = Policy Route Deny, PT = Policy Tunnel,
IG = Ignore CAM use LME, PU = Ip to Mpls Push

Type VRF Dest Ip Address Src Ip Address Pro SP / DP / DS Interface FT QId


Type Code
InF 134.33.90.99 150.31.98.100 ip - - 0 - - IU
InF 172.50.1.100 150.31.94.11 ip - - 0 - - IU

The show ip filters command displays the following filter configuration information
for the acl, icmp, policy, qos, srm, and tunnel command options:

Dest Ip Address the Destination IP address for this


filter
Src Ip Address the source IP address for this filter
Pro displays the first three characters
routing protocol acronym for this
filter. For example, OSPF would be
displayed as OSP.

Compass ID: 188656176 Version 5 MGBI 2-65


BSR 64000 Command Reference Guide Release 4.2.0

SP the source IP port for this filter


DP the Destination IP port for this filter
FT FT displays the Flow (classification)
Type (FT).Flow types include the
following:
AP = Access List Permit
AD = Access List Deny
PR = ACL Permit Range
DR = ACL Deny Range
II = IP Ingress
IR = ICMP Redirect
IU = ICMP Unreachable
TL = IP Tunnel Loopback
TE = IP Tunnel Egress
TN = IP Tunnel
PP = Policy Route Permit
PD = Policy Route Deny
QS = QoS
SM = Send To Srm
NL = Drop
QId displays the outgoing QoS queue ID
number

The following additional filter configuration information is displayed for the policy
command option:

In If the incoming TCP/UDP port number


associated with this filter entry
Out If the outgoing TCP/UDP port number
associated with this filter entry
DS Diff-serv Code Point (differentiated
services)

2-66 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

Def displays if this filter is the default


filter or policy
Mac the MAC address for the interface
Mtu the Maximum Transmission Unit
(MTU) packet size allowed on the
interface

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip filters [acl | icmp | policy | qos | srm | summary | tunnel] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show ip filters [acl | icmp | policy | qos | srm | summary | tunnel] [ | {count |
count-only}]

Compass ID: 188656176 Version 5 MGBI 2-67


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

acl display access list filters


icmp display ICMP filters
policy display policy routing filters

qos display QoS routing filters


srm send filters to the SRM to
troubleshoot problems - for example,
this can be used in instances when
ARP is unresolved
summary display summary of all Fast Path
filters - refer to show ip filters
summary
tunnel display IP tunneling filters
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

2-68 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show ip filters summary


The show ip filters summary command displays a summary of filter and routing
policy statistics for IP filters for the BSR 64000 POS OC-3/C12, Multi-Mode Gigabit
Ethernet (SX), Single-Mode Gigabit Ethernet (LX), or 10/100 Ethernet Network
Interface Modules (NIMs). The show ip filters summary command displays the
following filter summary statistics:

Flow Classification Type displays a list of the following Flow


Classification Types:
Null Filter
Access List Permit
Access List Deny
IP Ingress
IP Tunnel Egress
IP Tunnel Loopback
ICMP Redirect
ICMP Unreachable
IP Tunnel
Policy Route Permit
Policy Route Deny
Qos
Send To Srm
Number of Filters displays the number of filters applied
to each Flow Classification Type
Slot displays which BSR 64000 slots are
being filtered
Number of Filters displays the number of filters applied
to the corresponding BSR 64000 slot

The following is an example of typical screen output from the show ip filters
summary command:

Compass ID: 188656176 Version 5 MGBI 2-69


BSR 64000 Command Reference Guide Release 4.2.0

Flow Classification Type Number of Filters


------------------------- -----------------

Null Filter 0
Send To Srm 0
Unresolved ARP 0
Access List Permit 0
Access List Deny 0
ACL Permit Range 0
ACL Deny Range 0
ICMP Redirect 0
ICMP Unreachable 1
Ip Tunnel Loopback 0
Ip Tunnel Decap 0
Ip Tunnel Encap 0
Policy Route Permit 0
Policy Route Deny 0
Policy Tunnel 0
Ignore CAM use LME 0
Ip to Mpls Push 0
------------------------- --------
total 1

Slot Number of Filters


---- -----------------

15 1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip filters summary [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip filters summary [ | {count | count-only}]

2-70 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 2-71


BSR 64000 Command Reference Guide Release 4.2.0

show ip forwarding-table
The show ip forwarding-table command displays all Unicast Route entries in the
HSIM IP forwarding table. The following is an example of typical screen output from
the show ip forwarding-table command:

NL = Null Route, LI = Local Interface, BC = Subnet Broadcast,


NA = Directly Connected Need ARP, WA = Directly Connected With ARP,
GW = Gateway Route, CH = Cmts Host Route, CI = Cmts Interface Route,
LN = Local Interface Network Route, CR = Cmts Route, TL = Tunnel Route,
PU = Ip to Mpls Push, 2P = Ip to Mpls 2 Push, LS

VRF Ip Address/Prefix Phys If RT Gateway MAC Address HitCnt


------ ------------------ ------------- -- --------------- -------------- ------
150.31.83.0/24 eth 7/0 LN -- -- 0
150.31.83.3/32 eth 7/0 LI -- -- 9808
150.31.83.0/32 eth 7/0 BC -- -- 0
150.31.83.255/32 eth 7/0 BC -- -- 0
150.31.85.0/24 eth 7/0 LN -- -- 0
150.31.89.255/32 eth 7/1 BC -- -- 0
10.14.0.0/16 eth 7/0 LN -- -- 5
0.0.0.0/0 eth 7/0 LN -- -- 0
150.31.91.0/24 eth 7/0 LN -- -- 0
150.31.83.15/32 cab 2/0 CH 150.31.83.3 -- 0
150.31.1.0/24 eth 7/0 LN -- -- 546

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip forwarding-table [<A.B.C.D> | hitCount [<NUM>] | summary ] [ | {begin
| exclude | include} {<WORD>} | {count | count-only}]
show ip forwarding-table [<A.B.C.D> | hitCount [<NUM>] | summary ] [ | {count
| count-only }]

2-72 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show ip forwarding-table [mpls | tunnel | vrf {<word>}] [hitCount [<NUM>]] [ | [


| {begin | exclude | include} {<WORD>} | {count | count-only}]
show ip forwarding-table [mpls | tunnel | vrf {<word>}] [hitCount [<NUM>]] [ |
{count | count-only }]

Command Syntax

hitCount NUM the access list hit count and optional BSR
chassis slot number
summary summary of all MPLS Fast Path filters
mpls
vrf word select a VPN Routing/Forwarding instance
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

Compass ID: 188656176 Version 5 MGBI 2-73


BSR 64000 Command Reference Guide Release 4.2.0

show ip interface
The show ip interface command displays the status, statistical information, and
configuration for the network interfaces. The show ip interface command without
any command arguments displays status, statistical information, and configuration for
all interfaces. The following is an example of typical screen output from the show ip
interface command:

ethernet 7/0 is up, line protocol is up


Internet address is 150.31.90.10/24
Broadcast address is 255.255.255.255
MTU 1500 bytes
Directed broadcast forwarding is disabled
Outgoing access list is not set
Inbound access list is not set
Policy routing is disabled
Proxy ARP is disabled
Split horizon is enabled
ICMP redirects are always sent
ICMP unreachables are always sent
ICMP mask replies are always sent
Router Discovery is disabled
loopback 3 is up, line protocol is up
Internet address is 150.31.93.1/24
Destination address is 150.31.93.1
MTU 1514 bytes
Cable cable-modem helper addresses are: 150.31.1.100 global
Cable host helper addresses are: 150.31.1.100 global
Cable mta helper addresses are: 150.31.1.100 global
Directed broadcast forwarding is disabled
Outgoing access list is not set
Inbound access list is not set
Policy routing is disabled
Split horizon is enabled
ICMP redirects are never sent
ICMP unreachables are always sent
ICMP mask replies are always sent
Router Discovery is disabled
Secondary address 150.31.94.1/24

2-74 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


show ip interface [ brief | cable <X/Y> | ethernet <X/Y> | | gigaether <X/Y> |
loopback <1-255> | pos <X/Y> | tunnel <0-255>] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show ip interface [ brief | cable <X/Y> | ethernet <X/Y> | | gigaether <X/Y> |
loopback <1-255> | pos <X/Y> | tunnel <0-255>] [ | {count | count-only}]

Command Syntax

brief Provides a brief summary of IP status and


configuration information for a specific
interface or all interfaces.
cable X/Y cable interface slot and MAC Domain
number.
ethernet X/Y Ethernet interface slot and port number.
gigaether X/Y Gigabit Ethernet interface slot and port
number.
loopback 1-255 Loopback interface number.

pos X/Y Packet-over-SONET interface slot and port


number.
tunnel 0-255 Tunnel interface number.
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string

Compass ID: 188656176 Version 5 MGBI 2-75


BSR 64000 Command Reference Guide Release 4.2.0

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

2-76 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show ip irdp
The show ip irdp command displays ICMP Router Discovery Protocol information
including interface holdtime values, configured preface values, and advertisement
values for specified Ethernet or Gigabit Ethernet interfaces or all Ethernet or Gigabit
Ethernet interfaces on the BSR. The following is an example of typical screen output
from the show ip irdp command:

ethernet 7/0 has router discovery disabled

ethernet 7/1 has router discovery disabled

ethernet 15/0 has router discovery disabled

ethernet 15/1 has router discovery disabled

ethernet 15/2 has router discovery disabled

ethernet 15/3 has router discovery disabled

ethernet 15/4 has router discovery disabled

ethernet 15/5 has router discovery disabled

ethernet 15/6 has router discovery disabled

ethernet 15/7 has router discovery disabled

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


show ip irdp [ethernet <X/Y> | gigaether <X/Y>] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show ip irdp [ethernet <X/Y> | gigaether <X/Y>] [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 2-77


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

ethernet Ethernet interface slot and port number.


gigaether Gigabit Ethernet interface slot and port
number.
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

2-78 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show ip protocols
The show ip protocols command is used for debugging routing activity and processes
by displaying the status of routing protocol processes currently on the system. The
following is an example of typical screen output from the show ip protocols
command:

Routing Protocol is
"bgp 4
"
Bgp default capabilities: ipv4-unicast route-refresh
Timers: keepalive 60 hold 180
Client-to-client reflection is enabled
Default local-preference 100
Routing Process OSPF with ID 150.31.94.1
Supports only single TOS(TOS0) routes
This is an autonomous system boundary router
SPF schedule delay 5 secs, Hold time between two SPFs 10 secs
Minimum LSA interval 5 secs. Minimum LSA arrival 1 secs
Number of external LSA 63
Number of areas in this router is 1. 1 normal 0 stub 0 nssa
Area 0.0.0.0
Number of interfaces in this area is 6
Area has no authentication
SPF algorithm executed 215 times
Routing for Networks:
150.31.0.0/16
Distance: 110 (default is 110)

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


show ip protocols [summary] [ | {begin | exclude | include} {<WORD>} [ | {count
| count-only}]]

Compass ID: 188656176 Version 5 MGBI 2-79


BSR 64000 Command Reference Guide Release 4.2.0

show ip protocols [summary] [ | {count | count-only}]

Command Syntax

summary display a summary of system routing protocol


processes
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

2-80 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show ip route
The show ip route command displays active entries in the BSR routing table. The
following is typical screem output from the show ip route command:

Codes: C - connected, S - static, R - RIP, B - BGP


i - IS-IS derived L1- IS-IS level-1, L2- IS-IS level 2
route O - OSPF, IA - OSPF inter area, N1 - OSPF NSSA external type 1
N2 - OSPF NSSA external type 2, E1 - OSPF external type 1
E2 - OSPF external type 2, * - candidate default
U - per-user static route, P - periodic downloaded static route
T - traffic engineered route
Gateway of last resort is 150.31.90.1 to network 0.0.0.0

*S 0.0.0.0/0 [1/0] via 150.31.90.1, ethernet 15/1


O E2 150.31.1.0/24 [110/1] via 150.31.90.1, ethernet 15/1
O E2 150.31.2.0/24 [110/1] via 150.31.90.1, ethernet 15/1
O 150.31.10.0/24 [110/21] via 150.31.90.1, ethernet 15/1
O 150.31.11.0/24 [110/31] via 150.31.90.1, ethernet 15/1
O 150.31.17.0/24 [110/31] via 150.31.90.1, ethernet 15/1
O 150.31.19.0/24 [110/22] via 150.31.90.1, ethernet 15/1
O 150.31.20.0/24 [110/21] via 150.31.90.1, ethernet 15/1
O 150.31.21.0/24 [110/31] via 150.31.90.1, ethernet 15/1
O 150.31.22.0/24 [110/31] via 150.31.90.1, ethernet 15/1
O 150.31.24.0/24 [110/22] via 150.31.90.1, ethernet 15/1
O 150.31.26.0/24 [110/31] via 150.31.90.1, ethernet 15/1
O 150.31.30.0/24 [110/21] via 150.31.90.1, ethernet 15/1
O 150.31.31.0/24 [110/31] via 150.31.90.1, ethernet 15/1
O 150.31.32.0/24 [110/31] via 150.31.90.1, ethernet 15/1
O 150.31.39.0/24 [110/22] via 150.31.90.1, ethernet 15/1

Compass ID: 188656176 Version 5 MGBI 2-81


BSR 64000 Command Reference Guide Release 4.2.0

"Rep" in the show ip route command display ouptut indicates a replicated route. For
example:

10.1.6.0/24 [110/2] via 8.8.8.50, ethernet 12/2 (Rep)


186.1.1.0/24 [110/2] via 8.8.8.50, ethernet 12/2 (Rep)

Replicated routes are removed after an OSPF graceful restart function completes and
routes are recalculated after an SRM switchover by the new active SRM or if the
OSPF graceful restart process fails to complete.

Note: The IP route information displayed reflects the routes that the routing
table has exported after being filtered by each routing protocol’s export
routing policy statements.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip route [<A.B.C.D> [<A.B.C.D> | longer-prefixes]] [ bgp | connected |
hostname | ospf | rip | static | summary] [ | {begin | exclude | include} {<WORD>}
[ | {count | count-only}]]
show ip route [<A.B.C.D> [<A.B.C.D> | longer-prefixes]] [ bgp | connected |
hostname | ospf | rip | static | summary] [ | {count | count-only}]

2-82 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

Command Syntax

A.B.C.D display routes for an IP address


A.B.C.D the subnet mask for the specified IP address
to filter routes from a specific subnetwork
longer-prefixes display routes matching the specified
network/mask pair only
bgp display Border Gateway Protocol routes
connected display connected routes
hostname display routes for the internet hostname
ospf display OSPF routes
rip display RIP routes
static display static routes
summary display a summary of routes in the BSR
routing table
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 2-83


BSR 64000 Command Reference Guide Release 4.2.0

show ip traffic
The show ip traffic command displays IP, ICMP, UDP, TCP, ARP, OSPF, IGMP,
DVMRP, PIM, and RADIUS protocol packet statistics, depending on what protocols
are in use on the BSR. The following is an example of typical screen output from the
show ip traffic command:

IP statistics:
Rcvd: 497436 total, 415835 local destination
0 no ip address configured on vrf
0 incoming interface with no ip addresses, 0 null incoming interface
0 packet received on a cable bundle i/f with master, 0 packets with
local src addr
0 packets with src addr = 0xffffffff, 0 packets with src addr = 0
0 format errors, 0 checksum errors, 0 bad hop count
0 unknown protocol, 0 not a gateway
0 security failures, 0 bad options, 0 with options
Opts: 0 end, 0 nop, 0 basic security, 0 loose source route
0 timestamp, 0 extended security, 0 record route
0 streamID, 0 strict source route, 0 alert, 0 cipso
0 policy-based routing forward, 0 other
Frags: 0 reassembled, 0 timeouts, 0 couldn't reassemble
0 fragmented, 0 couldn't fragment
Bcast: 65542 received, 0 sent
Mcast: 158252 control pkt received, 720724 control pkt sent
0 data pkt received, 0 data pkt sent
Sent: 1772348 generated, 58728 forwarded
Drop: 0 encapsulation failed, 0 unresolved, 0 no adjacency
0 Mcast In Drop, 0 Mcast Out Drop
4 no route, 0 unicast RPF, 0 forced drop
0 acces-list inbound, 0 access-list outbound
0 policy-based routing drop

Group Access
All

Command Mode
All modes except User EXEC

2-84 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

Command Line Usage


show ip traffic [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show ip traffic [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 2-85


BSR 64000 Command Reference Guide Release 4.2.0

show l2-cam
The show l2-cam command displays the BSR’s Layer 2 Content Addressable
Memory (L2 CAM). The following is typical output from the show l2-cam command:

Index PID IP Address/Mask PRI/CFI/VLAN EN PT TOS VRF IIID ILID


------ --------- ------------------- ------------ -- -- --- ------ ------ ------
256 eth 15/1 150.31.90.10/32 0/ 0/ 0 1 0 0 eth 15/1 2
257 eth 15/2 150.31.98.10/32 0/ 0/ 0 1 0 0 eth 15/2 3
260 eth 15/1 150.31.90.0/24 0/ 0/ 0 1 0 0 eth 15/1 2
261 eth 15/2 150.31.98.0/24 0/ 0/ 0 1 0 0 eth 15/2 3
8059 eth 15/2 0.0.0.0/0 0/ 0/ 0 1 0 0 eth 15/2 3
8061 eth 15/1 0.0.0.0/0 0/ 0/ 0 1 0 0 eth 15/1 2

The following provides descriptions of the various show l2-cam command output
fields:

Index the label specified by this router


PID Port ID. The BSR module slot and port
number
IP Address/Mask IP address
Type identifies either the Provider (P) or Provider
Edge (PE) router
Label MPLS label
PRI shows the frame priority level which is used
for prioritizing traffic and is capable of
representing 8 levels (0-7)
CFI Canonical Format Indicator (CFI) is a 1 bit
field. If the value of this field is 1 then the
MAC address is in non canonical format and
if the value is 0 then the MAC address is in
Canonical format

2-86 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

VLAN VLAN ID number


TP This field is reserved by Motorola.
BEN Layer 2 Bridge enabled. 0 indicates disabled.
1 indicates enabled.
EN Routing is enabled. 0 indicates disabled. 1
indicates enabled.
PT Enabled (Preserve) Type of Service (TOS). 0
indicates disabled. 1 indicates enabled.
TOS Type of Service value.
VRF the VRF name
EIID/IIID Egressing or Ingressing Interface ID
IIID Ingressing Interface ID
ILID Ingressing Logical ID
MAC Address the MAC address (not valid for POS) of the
BSR module slot and port number.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show l2-cam {ip | label | mac [<NUM>]} [ { | begin | exclude | include}
{<WORD>} [ | count | count-only}]]
show l2-cam {ip | label | mac [<NUM>]} [ | {count | count-only}]

Note: The "l2" portion of the command syntax command contains a lower
case "L" not a 1.

Compass ID: 188656176 Version 5 MGBI 2-87


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

ip display the Internet Protocol table,


including bridging (VLAN tagging)
entries
label display leased host authorization
entries for a CPE
mac display the MAC address table,
including VRF host authorization
entries for all leased CPEs
<NUM> BSR module number - displays
MAC entries associated with this
module or VRF host authorization
entries for leased CPEs associated
with this module
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
count Count lines outputted
count-only Count lines outputted while
surpressing output
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string

2-88 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show sntp
The Simple Network Time Protocol (SNTP) provides system time with high accuracy.
The show sntp command output displays the following SNTP information for the
BSR:
SNTP server Configured SNRP to request NTP packets or
broadcast NTP server address
stratum Number of NTP hops a machine is from an
authoritative time source
version NTP server version
last receive When the last update was received
trusted server "Yes" - if an authentication was attempted and
succeeded; "No" - otherwise

The following is an example of typical screen output from the show sntp command:

Polling interval is 100 seconds.


SNTP server Stratum Version Last Recvd. Trusted Server?
150.31.1.32 14 3 0 hours 0 min 21 sec No

Group Access
All

Command Mode
All modes excpet User EXEC

Command Line Usage


show sntp [detail]

Command Syntax

detail displays transaction details even if no SNTP


server is configured

Compass ID: 188656176 Version 5 MGBI 2-89


BSR 64000 Command Reference Guide Release 4.2.0

show tcp brief


The show tcp brief command displays a brief summary of TCP status and
configuration. The following is an example of typical screen output from the show
tcp brief command:

Active TCP connections (including servers)


PCB Proto Recv-Q Send-Q Local Address Foreign Address (state) VPN
-------- ----- ------ ------ ---------------- ------------------ ----------- ---
d2bf708 TCP 0 0 150.31.90.10.23 10.14.37.103.41479 ESTABLISHED global
d2bf460 TCP 0 0 0.0.0.0.179 0.0.0.0.0 LISTEN all vpns
d2be4f8 TCP 0 0 0.0.0.0.23 0.0.0.0.0 LISTEN all vpns

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


show tcp brief

2-90 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

show tcp statistics


The show tcp statistics command displays the Transmission Control Protocol (TCP)
statistics. The show tcp statistics command displays the following information:

rcvd Statistics in this section refer to packets


received by the router.
total Packets received.
no port Number of packets received with no port.
checksum error number of packets received with checksum
error
bad offset number of packets received with bad offset to
data
too short number of packets received that were too
short
packets in sequence number of data packets received in sequence
dup packets number of duplicate packets received
partially dup packets number of packets received with partially
duplicated data
out-of-order packets number of packets received out of order
packets with data after number of packets received with data that
window exceeds the receiver window size
packets after close number of packets received after the
connection has been closed
window probe packets number of window probe packets received
window update number of window update packets received
dup ack packets number of duplicate acknowledgment packets
received
ack packets with unsent number of acknowledgment packets with
data unsent data received

Compass ID: 188656176 Version 5 MGBI 2-91


BSR 64000 Command Reference Guide Release 4.2.0

ack packets number of acknowledgment packets received


sent statistics for packets sent by the router
total total number of packets sent
urgent packets number of urgent packets sent
control packets number of control packets (SYN, FIN, or
RST) sent
data packets number of data packets sent
data packets number of data packets retransmitted
retransmitted
ack only packets number of packets sent that are
acknowledgments only
window probe packets number of window probe packets sent
window update packets number of window update packets sent
connections initiated number of connections initiated
connections accepted number of connections accepted
connections established number of connections established
connections closed number of connections closed
total rxmt timeout number of times the router tried to retransmit,
but timed out
connections dropped in number of connections dropped in retransmit
rxmit timeout timeout
keepalive timeout number of keepalive packets in timeout
keepalive probe number of keepalive probes
connections dropped in number of connections dropped in keepalive
keepalive

The following is an example of typical screen output from the show tcp statistics
command:

2-92 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

TCP:
20117 packets sent
11990 data packets (399789 bytes)
0 data packet (0 byte) retransmitted
8116 ack-only packets (4 delayed)
0 URG only packet
0 window probe packet
0 window update packet
14 control packets
22949 packets received
11896 acks (for 399790 bytes)
2921 duplicate acks
0 ack for unsent data
11794 packets (12305 bytes) received in-sequence
2 completely duplicate packets (1 byte)
0 packet with some dup. data (0 byte duped)
0 out-of-order packet (0 byte)
0 packet (0 byte) of data after window
0 window probe
5573 window update packets
0 packet received after close
0 discarded for bad checksum
0 discarded for bad header offset field
0 discarded because packet too short
0 connection request
9 connection accepts
8 connections established (including accepts)
9 connections closed (including 8 drops)
1 embryonic connection dropped
11895 segments updated rtt (of 11903 attempts)
1 retransmit timeout
0 connection dropped by rexmit timeout
0 persist timeout
2916 keepalive timeouts
2915 keepalive probes sent
0 connection dropped by keepalive
0 pcb cache lookup failed

Group Access
All

Compass ID: 188656176 Version 5 MGBI 2-93


BSR 64000 Command Reference Guide Release 4.2.0

Command Mode
Privileged EXEC

Command Line Usage


show tcp statistics

2-94 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

shutdown
The shutdown command disables an interface. An interface is in a shutdown state
when some configuration tasks must be performed on the interface.
All interfaces on the BSR are shutdown by default. The no shutdown command is
used to enable a disabled interface.

Note: Use the show interfaces command to display which interfaces are
enabled or disabled.

Group Access
System Administrator

Command Mode
Interface Configuration

Command Line Usage


shutdown
no shutdown

Compass ID: 188656176 Version 5 MGBI 2-95


BSR 64000 Command Reference Guide Release 4.2.0

sntp authenticate
The sntp authenticate command enables authentication for SNTP. The no sntp
authenticate command disables authentication for SNTP.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp authenticate
no sntp authenticate

2-96 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

sntp authentication-key
The sntp authentication-key command enables authentication for SNTP. The no
sntp authentication-key command disables authentication for SNTP.
Use the sntp authentication-key command to authenticate SNTP sources for
additional security.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp authentication-key <1-4294967295> [md5 <WORD>]
no sntp authentication-key <1-4294967295>

Command Syntax

1-4294967295 Key number.


md5 Use the md5 algorithm (presently this is the
only algorithm supported).
WORD Key value, up to 8 characters.

Compass ID: 188656176 Version 5 MGBI 2-97


BSR 64000 Command Reference Guide Release 4.2.0

sntp broadcastdelay
The sntp broadcastdelay command establishes the length of a round trip between the
system and a broadcast server. The no sntp broadcastdelay command removes the
length of a round trip between the system and a broadcast server and returns it to the
default.
Use the sntp broadcastdelay command to set the exact time between the router as a
broadcast client and the network.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp broadcastdelay <1-999999>
no sntp broadcastdelay <1-999999>

Command Syntax

1-999999 Microseconds calculated on round-trip time


for SNTP transactor.

Command Default
3000 microseconds

2-98 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

sntp broadcast client


The sntp broadcast client command configures a router to listen for SNTP
broadcasts. The no sntp broadcast client command blocks the router from receiving
SNTP broadcast traffic.
Use the sntp broadcast client command to receive NTP traffic from a broadcast
server.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp broadcast client
no sntp broadcast client

Compass ID: 188656176 Version 5 MGBI 2-99


BSR 64000 Command Reference Guide Release 4.2.0

sntp disable
The sntp disable command disables SNTP on an interface. The no sntp disable
command enables the interface to accept NTP traffic from other servers.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp disable
no sntp disable

Command Default
Enabled

2-100 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

sntp server
The sntp server command configures a router for SNTP to accept NTP traffic. The
no sntp server command disables the router receiving NTP traffic.

Note: When the server address is set to 224.0.1.1, the assigned multicast
address for NTP, the BSR operates in unicast mode. It transmits a request to
this multicast address and waits for replies. It then "binds" to the first server
who replies. All subsequent transactions happen in a unicast mode. This way,
the server address need not be known beforehand.

If you configure the BSR to operate in authenticated mode, you must also
configure an authentication key (sntp authentication-key command) and a
trusted key (trusted-key command).

Caution: If the sntp server configuration command is specified, the clock


timezone command must also be specified. Otherwise, the timezone may not
be initialized properly on the standby SRM and wildly fluctuating time
changes may be recorded when switching from the primary to the standby
SRM.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp server {224.0.1.1 | <A.B.C.D> | Hostname} [key <1-4294967295>]
no sntp server

Command Syntax

224.0.1.1 NTP Multicast group


A.B.C.D Server IP address.

Compass ID: 188656176 Version 5 MGBI 2-101


BSR 64000 Command Reference Guide Release 4.2.0

Hostname Host server name.


key 1-4294967295 Key number for authentication purpose.

Command Default
SNTP traffic not accepted from a time server

2-102 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

sntp timer
The sntp timer command specifies the time interval between queries to the SNTP
server. The no sntp timer command remove the time interval.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp timer <1-86400>
no sntp timer

Command Syntax

1-86400 the time interval in seconds

Compass ID: 188656176 Version 5 MGBI 2-103


BSR 64000 Command Reference Guide Release 4.2.0

sntp trusted-key
The sntp trusted-key command authorizes synchronization and authenticates system
identity. The no ntp trusted-key command disables synchronization and removes
system identity.
Use the sntp trusted-key command to establish a key or keys following the sntp
authentication-key command to synchronize the system. The sntp trusted-key
command synchronizes with only those systems that are trusted delivering additional
security.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp trusted-key <1-4294967295>
no sntp trusted-key <1-4294967295>

Command Syntax

1-4294967295 Trusted authentication key-number for trusted


time source.

Command Default
No trusted keys defined

2-104 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

traceroute
The traceroute command is used to trace the route that packets take through the
network from their source to their destination. The BSR sends out a sequence of User
Datagram Protocol (UDP) datagrams to an invalid port address at the remote host to
trace the route through the network, as follows:
■ First, three UDP datagrams are sent, each with a TTL field value set to 1. The
TTL value of 1 causes the datagram to "timeout" as soon as it reaches the first
router in the path. The router responds with an ICMP "time exceeded" message
indicating that the datagram has expired.
■ Next, three more UDP datagrams are sent, each with the TTL value set to 2. This
causes the second router in the path to the destination to return an ICMP "time
exceeded" message.
This process continues until the UDP datagrams reach the destination and the system
originating the traceroute has received an ICMP "time exceeded" message from every
router in the path to the destination. Since the UDP datagrams are trying to access an
invalid port at the destination host, the host responds with an ICMP "port
unreachable" message which signals the traceroute program to finish. The following
is typical screen output from the traceroute command:

traceroute to 150.31.40.10 : 1-64 hops, 38 byte packets


1 172.17.103.65 0.000 ms 0.000 ms 0.000 ms
2 172.17.1.1 0.000 ms 0.000 ms 0.000 ms
3 150.31.1.21 0.000 ms 16.7 ms 0.000 ms
4 150.31.40.10 0.000 ms 0.000 ms 0.000 ms

Trace complete

Group Access
All

Command Mode
User EXEC and Privileged EXEC

Command Line Usage


traceroute {<A.B.C.D> | Hostname} [Source <A.B.C.D>] [timeout <1-1024>]
[nprobes <1-1024>] [minhops <1-64>] [maxhops <2-1024>] [port <0-65535>] [tos
<0-255>] [df ]

Compass ID: 188656176 Version 5 MGBI 2-105


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D the source IP address.


Hostname the Domain Name Server (DNS) hostname.
Source A.B.C.D the IP address of the source interface

timeout 1-1024 the number of seconds to wait for a response to a


probe packet
nprobes 1-1024 the number of probes to send
minhops 1-64 the TTL value for the first probe - the default
value is 1 but can be set to a higher value to
suppress the display of known hops
maxhops 2-1024 the largest TTL value that can be used - the
traceroute command terminates when the
destination or this value is reached
port 0-65535 the destination port used by the UDP probe
messages
tos 0-255 the type of service value
df set the "Don’t Fragment" flag in the IP header

Command Defaults
timeout = 3 seconds
nprobes = 3
minhops = 1
maxhops = 64
port = 32868
tos = 0
df = disabled

2-106 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

trap-enable-if
The trap-enable-if command enables the ifLinkUpDownTrapEnable trap. The
ifLinkUpDownTrapEnable trap indicates whether a link up or link down trap should
be generated for an interface. The no trap-enable-if command disables the
ifLinkUpDownTrapEnable trap.

Group Access
All

Command Mode
Interface Configuration

Command Syntax
trap-enable-if
no trap-enable-if

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 2-107


BSR 64000 Command Reference Guide Release 4.2.0

trap-enable-rdn
The trap-enable-rdn command enables the rdnCardIfLinkUpDownEnable trap. The
rdnCardIfLinkUpDownEnable trap indicates whether a link up or link down trap
should be generated for a BSR module. The no trap-enable-rdn command disables
the rdnCardIfLinkUpDownEnable trap.

Group Access
All

Command Mode
Interface Configuration

Command Syntax
trap-enable-rdn
no trap-enable-rdn

Command Default
Disabled

2-108 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

tunnel destination
The tunnel destination command provides a tunnel interface destination. The no
tunnel destination command removes a tunnel interface destination.

Note: The tunnel destination command specifies the endpoint of the tunnel.
If a hostname is specified, DNS must have already been configured. The host
name-to-address translation is done following the command only once. If
mapping changes occur, the command needs to be reissued and is stored as
an IP address in the configuration files.

Group Access
ISP

Command Mode
Interface Configuration (tunnel interface only)

Command Line Usage


tunnel destination {<A.B.C.D> | Hostname}
no tunnel destination

Command Syntax

A.B.C.D IP address of the tunnel interface destination


Hostname DNS name of tunnel interface destination

Compass ID: 188656176 Version 5 MGBI 2-109


BSR 64000 Command Reference Guide Release 4.2.0

tunnel mode
The tunnel mode command specifies the tunnel encapsulation method to be used
when configuring a tunnel interface.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


tunnel mode {dvmrp | gre | ipip}

Command Syntax

dvmrp Distance Vector Multicast Routing Protocol


(DVMRP) - routes multicast datagrams only
within a single Autonomous System.
gre Generic Routing Encapsulation (GRE) is a
transport layer tunneling protocol that
encapsulates a wide variety of protocol packet
types inside IP tunnels
ipip IP in IP (IPIP) - is an IP-within-IP
encapsulation protocol in which an outer IP
header is added before the original IP header.
The outer IP header Source and Destination
addresses identify the "endpoints" of the
tunnel. The original IP header Source and
Destination addresses identify the original
sender and recipient of the datagram.

2-110 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Commands

tunnel source
The tunnel source command specifies a source address for a tunnel interface. The no
tunnel source command removes a source address for a tunnel interface.

Group Access
ISP

Command Mode
Interface Configuration (tunnel interface only)

Command Line Usage


tunnel source {<A.B.C.D> | cable <X/Y> | default | ethernet <X/Y> | gigaether
<X/Y> | loopback <1-255> | pos <X/Y>}
no tunnel source {<A.B.C.D> | cable <X/Y> | default | ethernet <X/Y> | gigaether
<X/Y> | loopback <1-255> | pos <X/Y>}

Command Syntax
-
A.B.C.D source IP address
cable X/Y CMTS interface slot and MAC Domain
number
default the source interface based on the destination
IP address
ethernet X/Y Ethernet interface slot and port number

gigaether X/Y Gigabit Ethernet interface slot and port


number
loopback 1-255 loopback interface number
pos X/Y Packet Over SONET interface slot and port
number

Compass ID: 188656176 Version 5 MGBI 2-111


BSR 64000 Command Reference Guide Release 4.2.0

unresolved-ip-packet-throttle
The unresolved-ip-packet-throttle command provides a throttling mechanism to
prevent problems such as voice packet drops or latency that can be caused by short
bursts of a large number of packets which require ARP resolutions being sent to the
CMTS at a rate higher than the CMTS can process. The
unresolved-ip-packet-throttle command prevents such problems from occurring
regardless of configuration or traffic load by preventing the CMTS from being
overrun but still allowing normal ARP resolution traffic to occur

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


unresolved-ip-packet-throttle { burst-rate <1-8000> | rate <1-4000>}
no unresolved-ip-packet-throttle

Command Syntax

burst-rate 1-8000 configures the unresolved IP packet throttling


burst-rate in packets/second

rate 1-4000 configures the unresolved IP packet throttling


packet rate in packets/second

Command Defaults
Enabled
burst-rate = 20 packets/second
rate = 200 packets/second

2-112 MGBI Compass ID: 188656176 Version 5


3
SNMP Commands

Introduction
This chapter describes the Simple Network Management Protocol (SNMP)
commands used to manage the BSR 64000.
Since it was developed in 1988, SNMP has become the de facto standard for
internetwork management. SNMP is an application layer protocol and is based on the
manager/agent model. SNMP is referred to as simple because the agent requires
minimal software. Most of the processing power and the data storage resides on the
management system, with a subset of those functions residing in the managed system.
A typical agent usually implements the SNMP protocol, stores and retrieves
management data (as defined by the MIB); can asynchronously signal an event to the
manager; and can be a proxy for some non-SNMP network node.
A typical manager implemented as a Network Management Station (NMS)
Network-management stations implements the SNMP protocol; learns of problems by
receiving event notifications, called traps, from network devices implementing
SNMP; is able to query agents; gets responses from agents; sets variables in agents;
and acknowledges synchronous events from agents.
The primary protocols that SNMP runs on are the User Datagram Protocol (UDP) and
IP. SNMP also requires Data Link Layer protocols such as Ethernet to implement the
communication channel from the management to the managed agent.

Compass ID: 188656176 Version 5 MGBI 3-1


BSR 64000 Command Reference Guide Release 4.2.0

SNMP Command Descriptions


This section contains an alphabetized list and descriptions of the SNMP commands
supported by the BSR.

3-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

show snmp
The show snmp command displays SNMP statistics, determine the running status,
and display configuration information such as chassis ID, system description, and
system location, chassis ID, and counter information for the SNMP process. The
show snmp command, without arguments, displays the following information:

SNMP In Packets total number of SNMP packets received by


the SNMP agent
Bad SNMP version number of bad SNMP packets received with
errors bad SNMP version errors
Unknown community number of SNMP packets received with
names unknown community names
Illegal operations for number not allowed
community names
supplied
ASN parse errors number incorrectly encoded
Requested variables variables requested by SNMP managers
Changed variables variables altered by SNMP managers
Get requests numberof get-request PDUs received
Get-next requests number of get-next PDUs received
Get responses number of get-response PDUs received
Set requests number of set request PDUs received
SNMP Out Packets number of SNMP packets sent by the agent
Get-next requests number of get-next PDUs sent by the agent
Get responses number of get-response PDUs sent by the
agent
Set requests number of set request PDUs sent by the agent
Timeouts number of out PDU timeouts

Compass ID: 188656176 Version 5 MGBI 3-3


BSR 64000 Command Reference Guide Release 4.2.0

Packets too big larger than maximum packet size sent by the
agent
No such name errors name errors nonexistent number, undefinable
Management Information Base (MIB)

Bad values number of set requests that detail an invalid


value for a MIB object
General errors number of requests failed due to some other
error, excluding a noSuchName error,
badValue error, or any of the other specific
errors
Responses number of responses
Traps number of traps sent
Traps Dropped due to number of traps dropped due to exceeding a
throttling throttling rate limit
Informs number of inform requests sent
Notification Errors number of notification errors sent
Probes number of probes sent
Inform Retries number of inform retries sent
Probe Retries number of probe retries sent

3-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

The following is an example of typical screen output from the show snmp command:

SNMP Information:
Status: running
Port Number: 161
Contact: Tom Terrific ([email protected])
Description: BSR 64000(tm) << HW_REV: Hardware Revision: CHS-000
otorola Inc, BOOTR: RDN 4.1.0.10, SW_REV: SW Version: 4.2.0T00P43
opyright(c) 2001 Motorola, Compiled: Tue Jan 3 14:37:10 EST 2006
MPC750-MPC8260, Memory: 256MB
Location: Location not set
0 SNMP In Packets
0 Bad SNMP version errors
0 Unknown community names
0 Illegal operations for community names supplied
0 ASN parse errors
0 Requested variables
0 Changed variables
0 Get requests
0 Get-next requests
0 Get responses
0 Set requests
0 SNMP Out Packets
0 Get requests
0 Get-next requests
0 Set requests
0 Timeouts
0 Packets too big
0 No such name errors
0 Bad values
0 General errors
0 Responses
0 Traps
0 Traps Dropped due to no memory
0 Traps Queued, waiting linkUp
0 Traps Dropped, queue full
0 Informs
0 Notification Errors

Compass ID: 188656176 Version 5 MGBI 3-5


BSR 64000 Command Reference Guide Release 4.2.0

Group Access
All

Command Mode
show snmp without arguments - all modes
show snmp with arguments - all modes except User EXEC

Command Line Usage


show snmp [access | chassis-id | community | contact | context | description |
engineID | group | host | location | packetsize | port | sysname | traps | users | view]

3-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

Command Syntax

access Displays SNMPv3 access rights for SNMP


groups and users with security models and
levels. It also displays the associations
between SNMP views and these security
parameters.
chassis-id Displays SNMP chassis-id information
community Displays information about configured
SNMP communities.
contact Displays SNMP system contact information
from the MIB object sysContact.
context Displays SNMPv3 context information from
the MIB object sysContext.
description Display SNMP system description from MIB
object sysDescr.
engineID Displays the local and remote SNMPv3
engines that were configured on the BSR.
group Displays SNMPv3 groups.
host Displays the hosts configured to receive
SNMP notifications - both SNMP Traps and
Informs.
location Displays SNMP system location information
from ther sysLocation MIB object.
packetsize Displays the maximum SNMP packet size
that the SNMP agent can send and receive.
The maximum packet size is 484-17940
bytes.
port Displays the UDP port number on which the
SNMP agent is configured.
sysname Displays the system information from the
sysName MIB object.

Compass ID: 188656176 Version 5 MGBI 3-7


BSR 64000 Command Reference Guide Release 4.2.0

traps Displays a list of SNMP traps.


users Displays a list of configured SNMPv3 users
stored in the SNMP group username table and
their associated access privileges, such as
engineID and security level.
view Displays the SNMPv3 view-name and the
object-identifier subtrees associated with it

3-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server access
The snmp-server access command defines access policy information. The no
snmp-server access command clears the SNMP access policies..

Note: Community Name Access Method is used predominantly with SNMPv1


and v2c.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server access <WORD> {v1 | v2c | v3 {noauth | auth | priv }} [match {exact |
prefix} | notify <WORD>] [prefix <WORD>] [read <WORD> [notify | write]]
[write <WORD> [notify]]
no snmp-server access <WORD> {v1 | v2c | v3 {noauth | auth | priv }} [prefix
<WORD>]

Command Syntax

WORD SNMP group name


v1 access group using v1 security model
v2c access group using v2c security model
v3 access group using v3 security model (USM)
noauth no authentication
auth authentication
priv privacy
match specify match parameters

Compass ID: 188656176 Version 5 MGBI 3-9


BSR 64000 Command Reference Guide Release 4.2.0

exact match exact


prefix match prefix
notify WORD specify a notify view name from 0 to 32 bits
in length
prefix WORD specify a prefix name from 0 to 32 bits in
length
read WORD specify a read view name from 0 to 32 bits in
length
notify specify a notify view for this access group
write specify a write view for this access group
write WORD specify a write view name from 0 to 32 bits in
length

3-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server chassis-id
The snmp-server chassis-id command specifies a new chassis ID to uniquely
identify the SNMP server’s chassis. The no snmp-server chassis-id command
returns the chassis ID to the default value which is the serial number of the chassis.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server chassis-id <string>
no snmp-server chassis-id <string>

Command Syntax

string a unique ID string which overwrites the MIB


object chassisId

Command Default
Defaults to chassis serial number

Compass ID: 188656176 Version 5 MGBI 3-11


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server community
The snmp-server community command enables SNMP and sets community strings
and access privileges. The no snmp-server community command removes
community strings and access privileges to a particular SNMP community.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server community <WORD> [<1-199> | ro | rw | view <WORD>]
no snmp-server community <WORD>

Command Syntax

1-199 IP access list allowed access with this


community string
ro set read-only access with this community
string
rw sets read-write access; authorized
management stations can retrieve and modify
MIB objects
view WORD MIB view to restrict community

3-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server community-table
The snmp-server community-table command configures the snmpCommunityTable
which is part of the snmpCommunityMIB (RFC 2576). The snmpCommunityMIB
defines objects to help support coexistence between SNMPv1, SNMPv2c, and
SNMPv3.
The snmpCommunityTable contains a database of community strings and provides
mappings between community strings and the parameters required for View-based
Access Control.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server community-table <octet-string> <octet-string> [access-list <num> |
active | context-name | eng-id | index | nonvolatile | not-in-service | transport-tag |
volatile ]
no snmp-server community-table <octet-string>

Command Syntax

octet-string the community string


(snmpCommunityName) whose configuration
is represented by a row in this
community-table
octet-string a string representing the corresponding value
of snmpCommunityName in a Security Model
independent format
access-list num the number (1-199) of the IP access-list
allowed access with this community string
active set the snmpCommunityStatus object to
"active"

Compass ID: 188656176 Version 5 MGBI 3-13


BSR 64000 Command Reference Guide Release 4.2.0

context-name the context in which management information


is accessed when using the community string
specified by the snmpCommunityName
eng-id specifies the context EngineID
(snmpCommunityContextEngineID)
indicating the location of the context in which
management information is accessed when
using the community string specified by the
corresponding value of the
snmpCommunityName object
index the unique index value of a row in the
snmpCommunityTable
nonvolatile specifies the storage type
(snmpCommunityStorageType) as nonvolatile
which is defined as having persistent memory
so that the storage content remains after the
device is turned off and on again
not-in-service sets the snmpCommunityStatus object to
"notInService"
transport-tag specifies the transport tag
(snmpCommunityTransportTag) which is a
set of transport endpoints from which a
SNMP command responder application will
accept management requests - if a
management request containing this
community is received on a transport
endpoint other than the transport endpoints
identified by this object, the request is
deemed unauthentic
volatile specifies the storage type
(snmpCommunityStorageType) as volatile
which is the defined as having temporary
memory and so that the storage content is
deleted if the device is turned off

3-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

Command Default
snmpCommunityStatus = active
snmpCommunityStorageType = nonvolatile

Compass ID: 188656176 Version 5 MGBI 3-15


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server contact
The snmp-server contact command specifies the contact information in the
sysContact MIB object

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server contact <string>

Command Syntax

string name of system contact person- provides text


for the MIB object sysContact

Command Default
no contact set

3-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server context
The snmp-server context defines or updates a context record. The no snmp-server
context command clears a context record.

Note: By defining a context record, an access policy can be specified that


includes the context. The context record identifies object resources that are
accessible.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server context <WORD>
no snmp-server context <WORD>

Command Syntax

WORD the name of context record - provides text for


the MIB object sysContext

Compass ID: 188656176 Version 5 MGBI 3-17


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server convert
The snmp-server convert command converts a key or password to a localized
authentication key.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server convert {key <WORD> | password <WORD> } {md5 | sha} [eng-id
<HEX>]

Command Syntax

key WORD specify the key to convert to a localized


authentication key
password WORD specify the password to convert to a localized
authentication key
md5 use MD5 Authentication

sha use SHA Authentication


eng-id HEX specify the engine-id- if not specified the
local engine ID is used

3-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server docs-trap-control
The snmp-server docs-trap-control command enables various CMTS traps. The no
snmp-server docs-trap-control disables the CMTS trap.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server docs-trap-control {cmtsBPKMTrap | cmtsBpiInitTrap |
cmtsDCCAckFailTrap | cmtsDCCReqFailTrap | cmtsDCCRspFailTrap |
cmtsDynServAckFailTrap | cmtsDynServReqFailTrap |
cmtsDynServRspFailTrap | cmtsDynamicSATrap | cmtsInitRegAckFailTrap |
cmtsInitRegReqFailTrap | cmtsInitRegRspFailTrap}
no snmp-server docs-trap-control {cmtsBPKMTrap | cmtsBpiInitTrap |
cmtsDCCAckFailTrap | cmtsDCCReqFailTrap | cmtsDCCRspFailTrap |
cmtsDynServAckFailTrap | cmtsDynServReqFailTrap |
cmtsDynServRspFailTrap | cmtsDynamicSATrap | cmtsInitRegAckFailTrap |
cmtsInitRegReqFailTrap | cmtsInitRegRspFailTrap}

Command Syntax

cmtsBPKMTrap the failure of a BPKM operation detected on


the CMTS side
cmtsBpiInitTrap the failure of a BPI initialization attempt
happened during the CM registration process
and detected on the CMTS side
cmtsDCCAckFailTrap the failure of a dynamic channel change
acknowledgement that happened during the
dynamic channel change process on the
CMTS side

Compass ID: 188656176 Version 5 MGBI 3-19


BSR 64000 Command Reference Guide Release 4.2.0

cmtsDCCReqFailTrap the failure of a dynamic channel change


request that happened during the dynamic
channel change process on the CM side and
detected on the CMTS side
cmtsDCCRspFailTrap the failure of a dynamic channel change
response that happened during the dynamic
channel change process on the CMTS side
cmtsDynServAckFailTrap the failure of a dynamic service
acknowledgement that happened during the
dynamic services process and detected on the
CMTS side
cmtsDynServReqFailTrap the failure of a dynamic service request that
happened during the dynamic services
process and detected on the CMTS side
cmtsDynServRspFailTrap the failure of a dynamic service response that
happened during the dynamic services
process and detected on the CMTS side
cmtsDynamicSATrap the failure of a dynamic security association
operation detected on the CMTS side
cmtsInitRegAckFailTrap the failure of a registration acknowledgement
from the CM that happened during the CM
initialization process and was detected on the
CMTS side
cmtsInitRegReqFailTrap the failure of a registration request from the
CM happened during the CM initialization
process and was detected on the CMTS side
cmtsInitRegRspFailTra the failure of a registration response happened
during the CM initialization process and was
detected on the CMTS side

3-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server enable informs


The snmp-server enable informs command enables SNMP informs and allows this
SNMP management station to send SNMP informs to hosts also configured to accept
informs using this command.
The snmp-server host command configures a host or hosts to accept SNMP informs.
At least one SNMP-server host must be configured. For a host to receive an inform,
an snmp-server host informs command must be configured for that host, and the
inform must then be enabled globally through the use of the snmp-server enable
informs command.
The no snmp-server enable informs command disables sending inform notification
messages from this SNMP management station.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server enable informs
no snmp-server enable informs

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 3-21


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server enable traps


The snmp-server enable traps command enables SNMP traps and allows the SNMP
agent to send an unsolicited notification to one or more pre-configured management
stations. The no snmp-server enable traps command disables all SNMP traps or a
specific trap type.The snmp-server enable traps command enables all SNMP traps
or specific types of traps and allows this SNMP management station to send SNMP
traps to hosts identified to receive traps with the snmp-server host command. At least
one SNMP-server host must be configured.

Note: The snmp-server enable traps command without arguments enables


BGP, OSPF, SNMP, and VRRP state change traps.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server enable traps [bgp | docsdevcmts | entity | flap | ospf | pim |
registration | remote-query | snmp | snr | vrrp]
no snmp-server enable traps [bgp | docsdevcmts | entity | flap | ospf | pim |
registration | remote-query | snmp | snr | vrrp]

Command Syntax

bgp enable BGP state change traps


docsdevcmts enable docs device cmts traps
entity enable entity state change traps
flap enable flap state change traps
ospf enable OSPF state change traps

3-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

pim enable PIM state change traps


registration enable CM (de)registration traps
remote-query enable remote query traps
snmp enable SNMP state change traps
snr enable Signal/Noise Ratio measurement traps

vrrp enable VRRP state change traps

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 3-23


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server engineID
The snmp-server engineID command specifies an identification name (ID) for
a local or remote SNMPv3 engine. The no snmp-server engineID command returns
the local agent engineID to the default, or deletes a remote engineID from the agent.

Note: A local SNMP Engine ID must be configured to use SNMPv3.The


SNMP agent is configured with a default Engine ID equal to the MAC address
of the chassis.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server engineID {local <HEX>} {remote <A.B.C.D> [udp-port <0-65535>]
<HEX>}
no snmp-server engineID {local <HEX>} {remote <A.B.C.D> [udp-port
<0-65535>] <HEX>}

Command Syntax

local sets local engine identification


HEX engine ID octet string
remote change or add remote engine id parameters
A.B.C.D IP address of remote SNMP notification host
udp-port configures a remote engine-ID
0-65535 UDP port number

3-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server group
The snmp-server group command associates (or maps) SNMP groups to SNMP
users. Use the no snmp-server group command to delete the group or a table to
match SNMP users with SNMP groups.
The snmp-server group command is used to create an SNMP group, associate it with
an SNMP user, and define a security level (SNMPv1, v2c, v3) for use with the group.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server group <WORD> <WORD> [v1 | v2c | v3]
no snmp-server group <WORD> <WORD> [v1 | v2c | v3]]

Command Syntax

WORD security name belonging to this group


WORD name of user creating group - user (security
name) belonging to this group
v1 provides the least security
v2c provides the next level of security
v3 provides the most security

Compass ID: 188656176 Version 5 MGBI 3-25


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server host
The snmp-server host command configures the SNMP agent to send notifications to
a remote host.You configure an SNMP inform or trap host with the snmp-server host
command by specifying the receiver of specific inform or trap types. All informs or
raps are sent if one is not specified. Each time the snmp-server host command is
used, one host acting as a inform or trap recipient is configured. The no snmp-server
host clears the host recipient from receiving SNMP notification activity.

Note: A maximum of 40 remote hosts can be specified with the snmp-server


host command.

Note: If the community-string is not defined using snmp-server community


command prior to using the snmp-server host command, the default form of
the snmp-server community command is automatically inserted into the
configuration. The password (community-string) used for this default
configuration is the same as that specified in the snmp-server host
command.

When removing an SNMP trap host from the trap host list with the no
snmp-server host command, the community name that is specified in the
command must exist. If the community name does not exist, the command
will fail.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server host <A.B.C.D> {<WORD>} {informs {<WORD> | version {1 | 2c | 3
{auth | noauth | priv}}} {traps {<WORD> | version {1 | 2c | 3 {auth | noauth |
priv}}} {version {1 | 2c | 3 {auth | noauth | priv} {<WORD>}}} [bgp |
docsdevcmts | entity | environ | flap | ospf | pim | registration | remote-query |
snmp | udp-port<0-65535>| vrrp]

3-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

no snmp-server host <A.B.C.D> {<WORD>} {informs {<WORD> | version {1 | 2c


| 3 {auth | noauth | priv}}} {traps {<WORD> | version {1 | 2c | 3 {auth | noauth |
priv}}} {version {1 | 2c | 3 {auth | noauth | priv} {<WORD>}}} [bgp |
docsdevcmts | entity | environ | flap | ospf | pim | registration | remote-query
|snmp | udp-port<0-65535>| vrrp]

Command Syntax

A.B.C.D IP address of SNMP notification host


WORD 1 to 32 alphabetic characters specifying an
SNMP community
informs enable SNMP informs
version version to use for notification messages
1 lowest security level
2c second level, more than security level 1
auth most secure level, authenticates without
encryption
no auth no authentication, unscrambled packet

priv privileged level, authenticates and scrambles


packet
traps enable SNMP traps
bgp send BGP state change informs or traps
docsdevcmts send docsdevicecmts change informs or traps
entity send entity state change informs or traps

environ send SNMP environment change informs or


traps
flap send flap state change informs or traps
ospf send OSPF state change informs or traps
pim send PIM state change informs or traps

Compass ID: 188656176 Version 5 MGBI 3-27


BSR 64000 Command Reference Guide Release 4.2.0

registration send CM (de)registration traps


remote-query send remote query traps
snmp send SNMP state change informs or traps
udp-port 0-65535 the UDP port number for the host to use
vrrp send VRRP state change informs or traps

Command Default
No hosts configured

3-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server location
The snmp-server location command specifies the system location information in the
sysLocation MIB object.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server location <string>

Command Syntax

string text for MIB object sysLocation; identifies the


physical location of the SNMP server, using 1
to 255 alphanumeric characters including
spaces

Compass ID: 188656176 Version 5 MGBI 3-29


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server manager response-timeout


The snmp-server manager response-timeout command specifies the number of
milliseconds that the SNMP manager running on the BSR waits for an SNMP
response from a cable modem polled by the Remote Query feature.

Note: Increasing the response-timeout value increases the probability of


receiving a cable modem remote query response under high upstream load
conditions, but also increases the overall polling cycle time when cable
modems completely fail to respond.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server manager response-timeout <10-60000>
no snmp-server manager response-timeout <10-60000>

Command Syntax

10-60000 the number of milliseconds

Command Default
2000 milliseconds

3-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server notify
The snmp-server notify command specifies the target addresses for notifications by
setting the snmpNotifyName object in the snmpNotifyTable and the snmpNotifyTag
object in the snmpTargetAddrTable.
The snmpNotifyTable contains entries which are used to select which entries in the
snmpTargetAddrTable should be used for generating notifications and the type of
notifications to be generated.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server notify <octet-string> <octet-string> {inform | trap} {nonvolatile |
volatile} [active | not-in-service ]
no snmp-server notify <octet-string>

Command Syntax

octet-string specifies the snmpNotifyName (index into the


snmpNotifyTable) which is a unique identifier
associated with this snmpNotifyEntry
octet-string specifies the snmpNotifyTag object which is
used to select entries in the
snmpTargetAddrTable
inform send Inform notification messages to the host
identified in the snmpTargetAddrTable
through the corresponding snmpNotifyTag

trap send Trap notification messages to the host


identified in the snmpTargetAddrTable
through the corresponding snmpNotifyTag

Compass ID: 188656176 Version 5 MGBI 3-31


BSR 64000 Command Reference Guide Release 4.2.0

nonvolatile specifies the storage type


(snmpNotifyStorageType) as nonvolatile
which is defined as having persistent memory
so that the storage content remains after the
device is turned off and on again
volatile specifies the storage type
(snmpNotifyStorageType) as volatile which is
the defined as having temporary memory and
so that the storage content is deleted if the
device is turned off
active sets the snmpNotifyRowStatus object to
"active"
not-in-service sets the snmpNotifyRowStatus object to
"notInService"

Command Default
snmpNotifyRowStatus = active
snmpNotifyStorageType = nonvolatile

3-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server notify-filter
The snmp-server notify-filter configures the snmpNotifyFilterTable.The
snmpNotifyFilterTable is a table containing filter profiles. Filter profiles are used to
determine whether a particular management target should receive particular
notifications. When a notification is generated, it must be compared to the filters
associated with each management target that is configured to receive notifications in
order to determine whether the notification can be sent to that management target.
Entries in the snmpNotifyFilterTable are created and deleted using the
snmpNotifyFilterRowStatus object.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server notify-filter <octet-string> <OID> <octet-string> {excluded |
included} {nonvolatile | volatile} [active | not-in-service ]
no snmp-server notify-filter <octet-string> <OID>

Command Syntax

octet-string the name of the filter profile


(snmpNotifyFilterProfileName) to be used
when generating notifications using the
corresponding entry in the
snmpTargetAddrTable
OID the MIB subtree (snmpNotifyFilterSubtree)
which, when combined with the
corresponding value of the
snmpNotifyFilterMask object, defines a
family of subtrees which are included in or
excluded from the filter profile

Compass ID: 188656176 Version 5 MGBI 3-33


BSR 64000 Command Reference Guide Release 4.2.0

octet-string the bit mask (snmpNotifyFilterMask) which,


in combination with the corresponding OID
value of the snmpNotifyFilterSubtree object,
defines a family of subtrees which are
included in or excluded from the filter profile
excluded indicates whether the family of filter subtrees
defined by the snmpNotifyFilterSubtree and
snmpNotifyFilterMask objects are excluded
from a filter
included indicates whether the family of filter subtrees
defined by the snmpNotifyFilterSubtree and
snmpNotifyFilterMask objects are included in
a filter
nonvolatile specifies the storage type
(snmpNotifyFilterStorageType) as nonvolatile
which is defined as having persistent memory
so that the storage content remains after the
device is turned off and on again
volatile specifies the storage type
(snmpNotifyFilterStorageType) as volatile
which is the defined as having temporary
memory and so that the storage content is
deleted if the device is turned off
active sets the snmpNotifyFilterRowStatus object to
"active"
not-in-service sets the snmpNotifyFilterRowStatus object to
"notInService"

Command Default
snmpNotifyFilterMask = empty
snmpNotifyFilterRowStatus = active
snmpNotifyFilterStorageType = nonvolatile

3-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server notify-filter-profile
The snmp-server notify-filter-profile command configures the
snmpNotifyFilterProfileTable. The snmpNotifyFilterProfileTable is used to associate a
notification filter profile with a particular set of target parameters. An entry in this
table indicates the name of the filter profile to be used when generating notifications
using the corresponding entry in the snmpTargetParamsTable.
Entries in the snmpNotifyFilterProfileTable are created or deleted using the
snmpNotifyFilterProfileRowStatus object.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server notify-filter-profile <octet-string> <octet-string> {nonvolatile |
volatile} [active | not-in-service]
no snmp-server notify-filter-profile <octet-string>

Command Syntax

octet-string specifies the snmpTargetParamsName (index


into the snmpTargetParamsTable) which is a
unique identifier associated with this
snmpTargetParamsEntry
octet-string specifies the snmpNotifyFilterProfileName
which is the name of the filter profile to be
used when generating notifications using the
corresponding entry in the
snmpTargetAddrTable

Compass ID: 188656176 Version 5 MGBI 3-35


BSR 64000 Command Reference Guide Release 4.2.0

nonvolatile specifies the storage type


(snmpNotifyFilterProfileStorType) as
nonvolatile which is defined as having
persistent memory so that the storage content
remains after the device is turned off and on
again
volatile specifies the storage type
(snmpNotifyFilterProfileStorType) as volatile
which is the defined as having temporary
memory and so that the storage content is
deleted if the device is turned off
active set the snmpNotifyFilterProfileRowStatus
object to "active"
not-in-service set the snmpNotifyFilterProfileRowStatus
object to "notInService"

Command Default
snmpNotifyFilterProfileRowStatus = active
snmpNotifyFilterProfileStorType = nonvolatile

3-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server packetsize
The snmp-server packetsize command sets the maximum SNMP packet size that the
server sends or receives. The no snmp-server packetsize command sets SNMP
packet size back to the default.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server packetsize <484-17940>
no snmp-server packetsize

Command Syntax

484-17940 maximum packet size in bytes

Command Default
1400 bytes

Compass ID: 188656176 Version 5 MGBI 3-37


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server port number


The snmp-server port number sets the UDP port number the SNMP agent is to use.
The no snmp-server port number sets the UDP port number the SNMP agent is to
use back to the default.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server port number <0-65535>
no snmp-server port number <0-65535>

Command Syntax

0-65535 port number for the SNMP agent to listen

Command Default
161

3-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server shutdown
The snmp-server shutdown command shuts down the SNMP Agent, preventing it
from further processing SNMP packets, while retaining all SNMP configuration data
in the event the agent is restarted. The snmp-server shutdown delete command shuts
down the SNMP Agent and deletes all SNMP configuration data (all SNMP
configuration data is lost).

Note: The snmp-server shutdown command is identical to the no


snmp-server command.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server shutdown [delete]

Command Syntax

delete deletes all SNMP configuration data upon


shutting down (without this option all SNMP
configuration data is retained and the agent is
suspended).

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 3-39


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server sysname
The snmp-server sysname command specifies the system name information in the
sysLocation MIB object.

Note: The sysName MIB variable is the name of the node. The show snmp
sysname command gets the sysName MIB variable.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server sysname <string>

Command Syntax

string text for the MIB object sysName

3-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server target-addr
The snmp-server target-addr command configures the SNMP target address entries
in the snmpTargetAddressTable. The snmpTargetAddrTable contains information
about transport domains and addresses to be used in the generation of SNMP
operations. It also contains the snmpTargetAddrTagList object which provides a
mechanism for grouping table entries.
Entries in the snmpTargetAddrTable are created or deleted using the
snmpTargetAddrRowStatus object.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server target-addr <octet-string> <A.B.C.D> udp-port <0-65535>
<0-2147483647> <0-255> <octet-string> <octet-string> <octet-string> {0 |
<484-2147483647>} {nonvolatile | volatile} [active | not-in-service ]
no snmp-server target-addr <octet-string>

Command Syntax

octet-string specifies the snmpTargetAddrName (index


into the snmpTargetAddrTable) which is a
unique identifier associated with this
snmpTargetAddrEntry
A.B.C.D the IP address of the SNMP notification host
udp-port 0-65535 specifies the SNMP notification host's UDP
port number

0-2147483647 the expected maximum round trip time


(snmpTargetAddrTimeout) for
communicating with the transport address
defined by this row

Compass ID: 188656176 Version 5 MGBI 3-41


BSR 64000 Command Reference Guide Release 4.2.0

0-255 specifies a default number of retries


(snmpTargetAddrRetryCount) to be attempted
when a response is not received for a
generated message - if an application
provides its own retry count, the value of this
object is ignored
octet-string sets the snmpTargetAddrTagList object
which is a list of tag values which are
used to select target addresses for a
particular operation - if there is more than
one tag, use quotation marks to separate each
tag
octet-string sets the snmpTargetAddrParams object which
identifies an entry in the
snmpTargetParamsTable - the identified entry
contains SNMP parameters to be used when
generating messages to be sent to this
transport address
octet-string sets the snmpTargetAddrTMask object which
is the mask associated with
snmpTargetParamsTable
0 | 484-2147483647 the maximum message size in bytes specified
by the snmpTargetAddrMMS object - "0" = an
empty message
nonvolatile specifies the storage type
(snmpTargetAddrStorageType) as nonvolatile
which is defined as having persistent memory
so that the storage content remains after the
device is turned off and on again
volatile specifies the storage type
(snmpTargetAddrStorageType) as volatile
which is the defined as having temporary
memory so that the storage content is deleted
if the device is turned off

3-42 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

active sets the snmpTargetAddrRowStatus object to


"active"
not-in-service sets the snmpTargetAddrRowStatus object to
"notInService"

Command Default
snmpTargetAddrMMS = 484
snmpTargetAddrRowStatus = active
snmpTargetAddrStorageType = nonvolatile

Compass ID: 188656176 Version 5 MGBI 3-43


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server target-params
The snmp-server target-params configures the snmpTargetParamsTable. The
snmpTargetParamsTable contains information about SNMP version and security
information to be used when sending messages to particular transport domains and
addresses.
Entries in the snmpTargetParamsTable are created or deleted using the
snmpTargetParamsRowStatus object.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server target-params <octet-string> <0-3> <0-3> <octet-string>
{authNoPriv | authPriv | noAuthNoPriv} {nonvolatile | volatile} [active |
not-in-service ]

no snmp-server target-params <octet-string>

3-44 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

Command Syntax
octet-string specifies the snmpTargetParamsName (index
into the snmpTargetParamsTable) which is a
unique identifier associated with this
snmpTargetParamsEntry
0-3 the message processing model
(snmpTargetParamsMPModel) to be used
when generating SNMP messages using this
entry

0 = SNMPv1,
1 = SNMPv2c
2 = SNMPv2u and SNMPv2
3 = SNMPv3
0-3 the security model
(snmpTargetParamsSecurityModel) to be
used when generating SNMP messages using
this entry - an implementation may choose to
return an "inconsistentValue" error if an
attempt is made to set this variable to a value
for a security model which the
implementation does not support

0 = any
1 = SNMPv1
2 = SNMPv2c
3 = USM (User-Based Security)
octet-string the security name
(snmpTargetParamsSecurityName) for
generating notifications which identifies
the principal on whose behalf SNMP
messages will be generated using this
entry
authNoPriv set the snmpTargetParamsSecurityLevel
object to "authorization/no privilege"

Compass ID: 188656176 Version 5 MGBI 3-45


BSR 64000 Command Reference Guide Release 4.2.0

authPriv set the snmpTargetParamsSecurityLevel


object to "authorization/privilege"
noAuthNoPriv set the snmpTargetParamsSecurityLevel
object to "no authorization/no privilege"

nonvolatile specifies the storage type


(snmpTargetParamsStorageType) as
nonvolatile which is defined as having
persistent memory so that the storage content
remains after the device is turned off and on
again
volatile specifies the storage type
(snmpTargetParamsStorageType) as volatile
which is the defined as having temporary
memory and so that the storage content is
deleted if the device is turned off
active set snmpTargetParamsRowStatus to "active"
not-in-service set snmpTargetParamsRowStatus to
"notInService"

Command Default
snmpTargetParamsRowStatus = active
snmpTargetParamsStorageType = nonvolatile

3-46 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server trap rate-limit


The snmp-server trap rate-limit command constricts the rate of SNMP messages
and log messages sent to a remote host and used by the agent to send an unsolicited
notification to one or more pre-configured management stations. The no snmp-server
trap rate-limit clears the SNMP agent and increases the number of traps sent to a
remote host.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server trap rate-limit <0-2147483647> <1-2147483647>
no snmp-server trap rate-limit <0-2147483647> <1-2147483647>

Command Syntax

0-2147483647 number of SNMP traps; affects both trap and


SYSLOG
1-2147483647 per unit time in seconds

Compass ID: 188656176 Version 5 MGBI 3-47


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server trap-source loopback


The snmp-server trap-source loopback command allows an operator to control the
source IP address of SNMP traps generated by the BSR by specifying a loopback
interface as the source IP address for SNMP traps. The normal convention for
generated SNMP traps is to set the source IP address equal to the IP address of the
outgoing interface. The snmp-server trap-source loopback command overrides this
convention and instead uses the IP address of the specified loopback interface. The no
snmp-server trap-source loopback command removes the loopback source
interface.

Note: Before using the snmp-server trap-source loopback command, the


loopback interface must be configured and assigned an IP address.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server trap-source loopback <1-255>
no snmp-server trap-source loopback <1-255>

Command Syntax

1-255 the loopback interface number

3-48 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server user
The snmp-server user command adds a new user to an SNMP group. The no
snmp-server user command removes a user from an SNMP group.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server user <WORD> [auth {sha | md5} {key <string> [eng-id <HEX>| priv
des56 <string> | public <octet-string>] | local <string> [eng-id <HEX>| priv des56
<string> | public <octet-string>] | password <string> [eng-id <HEX>| priv des56
<string> | public <octet-string>] | <string> [eng-id <HEX>| priv des56 <string>]}]
no snmp-server user <WORD> [eng-id <HEX>]

Command Syntax

WORD username
auth authentication parameters for user
md5 uses HMAC/MD5 algorithm for
authentication
sha uses HMAC/SHA algorithm for
authentication
key string specifies a non-localized authentication key
(SHA = 20 octets, MD5 = 16 octets)
local string specifies a localized authentication key (SHA
= 20 octets, MD5 = 16 octets)
password string specifies a password string (must be at least 8
characters)
string specifies an authentication password string
for this user

Compass ID: 188656176 Version 5 MGBI 3-49


BSR 64000 Command Reference Guide Release 4.2.0

eng HEX specifies engine-id with this user; local value


of engine ID
priv des56 provides DES-56 bit encryption with
authentication based on the CBC-DES
(DES-56) standard
public octet-string sets the usmUserPublic MIB object

3-50 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

snmp-server view
The snmp-server view command defines an SNMPv2 MIB view. The no
snmp-server view command removes the defined view. You can assign MIB views to
SNMP Groups or community strings to limit the MIB objects that an SNMP manager
can access. You can use a predefined view or create your own view. Other SNMP
commands, such as snmp-server community, can use the view to create records
associated with a view.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


snmp-server view <WORD> [<OID> | at | bgp | directory | docsif | dod | dot3 | egp
| experimental | icmp | ifmib | igmp | interfaces | internet | ip | iso | mgmt | mib-2 |
org | ospf | ppp | private | rip2 | riverdelta | security | snmp | snmpv2 | sonet |
system | tcp | transmission | udp | vrrp ] {included | excluded}
no snmp-server view <WORD> [<OID> | at | bgp | directory | docsif | dod | dot3 |
egp | experimental | icmp | ifmib | igmp | interfaces | internet | ip | iso | mgmt |
mib-2 | org | ospf | ppp | private | rip2 | riverdelta | security | snmp | snmpv2 | sonet
| system | tcp | transmission | udp | vrrp ] {included | excluded}

Command Syntax

WORD used for reference identification to view


record being generated or removed reference
identification
OID subtree of MIB view family name (ex:
1.3.6.1.= internet, 1.3.6.1.2.1.1 = system)
at AT MIB group
bgp BGP MIB group
directory directory MIB group

Compass ID: 188656176 Version 5 MGBI 3-51


BSR 64000 Command Reference Guide Release 4.2.0

docsif docsisIf MIB group


dod DOD MIB group
dot3 ether-like MIB group
egp EGP MIB group
experimental experimental MIB group

icmp ICMP MIB group


ifmib ifMib MIB group
igmp IGMP MIB group
interfaces interfaces MIB group
internet internet MIB group
ip IP MIB group
iso ISO MIB group
mgmt mgmt MIB group
mib-2 MIB-2 MIB group
org org MIB group
ospf OSPF MIB group
ppp PPP MIB group

private private MIB group


rip2 RIP2 MIB group
riverdelta RiverDelta Networks proprietary MIB groups
security security MIB group
snmp SNMP MIB group
snmpv2 SNMPv2 MIB group
sonet SONET MIB group
system System MIB group

3-52 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 SNMP Commands

tcp TCP MIB group


transmission transmission MIB group
udp UDP MIB group
vrrp VRRP MIB group
included specifies MIB group is included from view

excluded specifies MIB group is excluded from view

Compass ID: 188656176 Version 5 MGBI 3-53


4
Debug Commands

Introduction
This chapter describes the debug commands supported by the BSR 64000. Debug
commands help to isolate the source of a system failure. The output provides
diagnostic information, protocol status, and network activity which can be used to
diagnose and resolve networking problems.

Debug Command Descriptions


This section contains an alphabetized list and descriptions of the debug commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 4-1


BSR 64000 Command Reference Guide Release 4.2.0

debug aps
The debug aps command enables APS debugging. The no debug aps command turns
APS debugging off.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug aps {all {all | slot <0-15>}} {switching {all | slot <0-15>}}
no debug aps {all {all | slot <0-15>}} {switching {all | slot <0-15>}}

Command Syntax

all debug all APS commands, actions and


configurations
switching debug only APS switch commands and
actions
all debug all valid slots
slot 0-15 select slot number to debug

4-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug arp
The debug arp command displays Address Resolution Protocol (ARP) information
exchanges between the BSR and other devices on the network. The no debug arp
command turns off ARP debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug arp
no debug arp

Compass ID: 188656176 Version 5 MGBI 4-3


BSR 64000 Command Reference Guide Release 4.2.0

debug cable err


The debug cable err command displays miscellaneous error conditions.\

Note: The debug cable err command is only supported on the 1:4, 1:8, and
2:8 CMTS modules and is available through the NUM (chassis slot) option on
the command line. This command is not supported on the 2:8 (2.0) CMTS
module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> err
no debug cable <NUM> err

Command Syntax

NUM the BSR 64000 chassis slot number


containing the CMTS module

4-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug cable keyman


The debug cable keyman command activates debugging of TEK and KEK baseline
privacy key activity. The no debug cable keyman turns off this debugging operation.

Note: The debug cable keyman command is only supported on the 1:4, 1:8,
and 2:8 CMTS modules and is available through the NUM (chassis slot)
option on the command line. This command is not supported on the 2:8 (2.0)
CMTS module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> keyman
no debug cable <NUM> keyman

Command Syntax

NUM the BSR 64000 chassis slot number


containing the CMTS module

Compass ID: 188656176 Version 5 MGBI 4-5


BSR 64000 Command Reference Guide Release 4.2.0

debug cable mac


The debug cable mac command displays dynamic service messages and/or MAC
layer management information MAC-layer information. The no debug cable mac
command turns off MAC-layer debugging.

Note: The debug cable mac command is only supported on the 1:4, 1:8, and
2:8 CMTS modules and is available through the NUM (chassis slot) option on
the command line. This command is not supported on the 2:8 (2.0) CMTS
module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> mac {dynsrv | information}
no debug cable <NUM> mac {dynsrv | information}

Command Syntax

NUM the BSR 64000 chassis slot number


containing the CMTS module

4-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug cable map


The debug cable map command displays map debugging messages. The no debug
cable map command turns off this debugging operation.

Note: The debug cable map command is only supported on the 1:4, 1:8,
and 2:8 CMTS modules and is available through the NUM (chassis slot)
option on the command line. This command is not supported on the 2:8 (2.0)
CMTS module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> map
no debug cable <NUM> map

Command Syntax

NUM the BSR 64000 chassis slot number


containing the CMTS module

Compass ID: 188656176 Version 5 MGBI 4-7


BSR 64000 Command Reference Guide Release 4.2.0

debug cable modem-select


The debug cable modem-select command lets you select a specific cable modem for
debug tracing. The no debug cable modem-select command turns off this debugging
operation.

Note: The debug cable modem-select command is only supported on the


1:4, 1:8, and 2:8 CMTS modules and is available through the NUM (chassis
slot) option on the command line. This command is not supported on the 2:8
(2.0) CMTS module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> modem-select <mac>
no debug cable <NUM> modem-select <mac>

Command Syntax

mac MAC address of a specific cable modem


NUM the BSR 64000 chassis slot number
containing the CMTS module

4-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug cable privacy


The debug cable privacy command activates debugging of baseline privacy. The no
debug cable privacy command turns off this debugging operation.

Note: The debug cable privacy command is only supported on the 1:4, 1:8,
and 2:8 CMTS modules and is available through the NUM (chassis slot)
option on the command line. This command is not supported on the 2:8 (2.0)
CMTS module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> privacy
no debug cable <NUM> privacy

Command Syntax

NUM the BSR 64000 chassis slot number


containing the CMTS module

Compass ID: 188656176 Version 5 MGBI 4-9


BSR 64000 Command Reference Guide Release 4.2.0

debug cable qos


The debug cable qos command activates debugging of Quality of Service (QoS). The
no debug cable qos command turns off this debugging operation.

Note: The debug cable qos command is only supported on the 1:4, 1:8, and
2:8 CMTS modules and is available through the NUM (chassis slot) option on
the command line. This command is not supported on the 2:8 (2.0) CMTS
module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> qos
no debug cable <NUM> qos

Command Syntax

NUM the BSR 64000 chassis slot number


containing the CMTS module

4-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug cable range


The debug cable range command displays ranging messages exchanged between
cable modems and the CMTS. The no debug cable range command turns off this
debugging operation.

Note: The debug cable range command is only supported on the 1:4, 1:8,
and 2:8 CMTS modules and is available through the NUM (chassis slot)
option on the command line. This command is not supported on the 2:8 (2.0)
CMTS module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> range
no debug cable <NUM> range

Command Syntax

NUM the BSR 64000 chassis slot number


containing the CMTS module

Compass ID: 188656176 Version 5 MGBI 4-11


BSR 64000 Command Reference Guide Release 4.2.0

debug cable reg


The debug cable reg command displays registration messages exchanged between
cable modems and the CMTS. The no debug cable reg command turns off this
debugging operation.

Note: The debug cable reg command is supported on the 1:4, 1:8, 2:8, and
2:8 (2.0) CMTS modules and is only available through the X/Y (chassis slot
and MAC Domain) option on the command line. The debug cable reg
command is not available through the NUM (chassis slot) option on the
command line.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <X/Y> reg
no debug cable <X/Y> reg

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"

4-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug cable remote-query


The debug cable remote-query command enables console logging of messages for
each SNMP packet sent and received by the Remote Query polling feature.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug cable remote-query

Compass ID: 188656176 Version 5 MGBI 4-13


BSR 64000 Command Reference Guide Release 4.2.0

debug cable ucc


The debug cable ucc command displays upstream channel change (UCC) messages
generated when cable modems request or are assigned a new channel. The no debug
cable ucc command turns of this debugging operation.

Note: The debug cable ucc command is only supported on the 1:4, 1:8, and
2:8 CMTS modules and is available through the NUM (chassis slot) option on
the command line. This command is not supported on the 2:8 (2.0) CMTS
module.

To determine which CMTS modules are installed in the BSR 64000, use the
show chassis status command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug cable <NUM> ucc
no debug cable <NUM> ucc

Command Syntax

NUM the BSR 64000 chassis slot number


containing the CMTS module

4-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip access-list
The debug ip access-list command enables IP access-list debugging. The no debug
ip access-list command turns IP access-list debugging off.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip access-list {in | out }
no debug ip access-list {in | out }

Command Syntax

in debug inbound packets


out debug outbound packets

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-15


BSR 64000 Command Reference Guide Release 4.2.0

debug ip bgp
The debug ip bgp command displays Border Gateway Protocol (BGP) transactions.
The no debug ip bgp command turns off this debugging operation. Use the debug ip
bgp command to:
■ Show events that change the state of the BGP session with any peer
■ Show open messages sent and received between peers
■ Show keepalive messages sent and received between peers
■ Show update messages sent and received between peers including advertised
routes and withdrawn routes
■ Show notification messages sent and received between peers
■ Troubleshoot BGP peer sessions and route exchanges

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip bgp [<A.B.C.D> | dampening | events | inbound-connection [access-list
[<1-199> | <1300-2699> ]] | keepalives [ in | out ] | message-dump [ in | keepalive |
notify | open | others | out | refresh | update ] | notifies [ in | out ] | rules [ in | out ]
| soft-reconfiguration-inbound | updates [ in | out ]]
no debug ip bgp [<A.B.C.D> | dampening | events | inbound-connection
[access-list [<1-199> | <1300-2699> ]] | keepalives [ in | out ] | message-dump [ in |
keepalive | notify | open | others | out | refresh | update ] | notifies [ in | out ] | rules
[ in | out ] | soft-reconfiguration-inbound | updates [ in | out ]]

Command Syntax

A.B.C.D neighbor IP address to debug


dampening BGP dampening
events enables logging of BGP state transitions

4-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

inbound-connection information about peers trying to make a


connection
access-list select the peer from which inbound to display
inbound connections

1-199 access list number


1300-2699 access list number (expanded range)
keepalives BGP keepalives
in incoming information
out outgoing information
message dump displays contents of messages
keepalive display contents of KEEPALIVE messages
notify display contents of NOTIFY messages
open display contents of OPEN messages
others display contents of any other messagesd
refresh display contents of ROUTE-REFRESH
messages
update display contents of UPDATE messages
notifies BGP notification messages
rules display an explanation of the treatment of
update messages
soft-reconfiguration-inbound process clear ip bgp soft in updates
updates generates per update messages

Compass ID: 188656176 Version 5 MGBI 4-17


BSR 64000 Command Reference Guide Release 4.2.0

debug ip dvmrp
The debug ip dvmrp command displays information on Distance Vector Multicast
Routing Protocol (DVMRP) packets received and transmitted. The no debug ip
dvmrp command turns off this debugging operation.

Note: The debug ip dvmrp command uses considerable bandwidth to


output debugging information. This may interrupt router activities.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip dvmrp
no debug ip dvmrp

Command Default
Disabled

4-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip icmp
The debug ip icmp command displays Internet Control Message Protocol (ICMP)
information exchanges between the BSR and other devices on the network. The no
debug ip icmp turns off ICMP debugging.
Use the debug ip icmp command to determine whether the BSR is sending or
receiving ICMP messages.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip icmp
no debug ip icmp

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-19


BSR 64000 Command Reference Guide Release 4.2.0

debug ip igmp
The debug ip igmp command displays all Internet Group Management Protocol
(IGMP) packets, and all IGMP host-related actions. The no debug ip igmp command
turns off the IGMP debugging.
Use the debug ip igmp command to target IGMP protocol messages and mtrace
messages.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip igmp
no debug ip igmp

Command Default
Disabled

4-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip mfm
The debug ip mfm command displays Multicast Forwarding Manager (MFM)
control packet activity. The no debug ip mfm command turns off MFM debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip mfm {all | general}
no debug ip mfm {all | general}

Command Syntax

all all MFM processing information


general general, non-specific MFM application
information

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-21


BSR 64000 Command Reference Guide Release 4.2.0

debug ip mrtm
The debug ip mrtm command displays changes made to the IP multicast routing
table made by the Multicast Routing Table Manager. The no debug ip mrtm
command turns off MRTM debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip mrtm {all | general}
no debug ip mrtm {all | general}

Command Syntax

all all MRTM processing information


general general, non-specific MRTM application
information

Command Default
Disabled

4-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip ospf
The debug ip ospf command displays Open Shortest Path First (OSPF)-related
activity. The no debug ip ospf command turns off OSPF-related debugging. Use the
debug ip ospf command to turn on debugging for IP OSPF.
The debug ip ospf command can be used to do the following:
■ Confirm that the routers match the same IP mask
■ Verify same hello interval
■ Verify same dead interval
■ Verify neighbors are part of the same area

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip ospf {adj | dr | events | graceful-restart | lsa | packet | retransmission | spf
[detail] }
no debug ip ospf {adj | dr | events | graceful-restart | lsa | packet | retransmission |
spf [detail] }

Command Syntax

adj debug OSPF adjacency events


dr debug OSPF DR election events
events debug all OSPFevents
graceful-restart debug OSPF graceful-restart |
lsa debug OSPF LSA rx/tx events

packet debug OSPF packets reception events


retransmission debug OSPF retransmission events

Compass ID: 188656176 Version 5 MGBI 4-23


BSR 64000 Command Reference Guide Release 4.2.0

spf debug OSPF SPF calculation events


detail display detailed SPF calculation events debug
information

Command Default
Disabled

4-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip packet
The debug ip packet command displays general IP debugging information including
packets received, generated, and forwarded. The no debug ip packet command turns
IP debugging operations.

Note: The debug ip packet command uses considerable bandwidth to


output debugging information. This may interrupt router activities.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip packet [<1-199> | <1300-2699> | detail ]
no debug ip packet

Command Syntax

1-199 access list number


1300-2699 extended access list number
detail display more detailed IP packet; debugging
information

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-25


BSR 64000 Command Reference Guide Release 4.2.0

debug ip pim
The debug ip pim command enables PIM debugging. The no debug ip pim
command turns PIM debugging off.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ip pim {all | assert | bsr | cache | general | hello | join-prune | register | rp |
rp-db | rt-change }
no debug ip pim

Command Syntax

all debug all pim processing information


assert debug assert processing information
bsr debug BSR-RP processing information

cache debug internal cache maintenance


information
general debug non-specific PIM application
information
hello debug hello processing information
join-prune debug Join/Prune processing information
register debug register processing information
rp debug RP processing information
rp-db debug RPSet Database processing
information
rt-change debug route change processing information

4-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-27


BSR 64000 Command Reference Guide Release 4.2.0

debug ip policy
The debug ip policy command displays IP policy routing packet activity. The debug
ip policy command displays information about whether a packet matches the routing
policy criteria and the resulting routing information for the packet.The no debug ip
policy command turns off IP policy debugging.

Note: The debug ip policy command uses considerable bandwidth to output


debugging information. This may interrupt router activities.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip policy
no debug ip policy

Command Default
Disabled

4-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip redistribute to
The debug ip redistribute to command displays route redistribution information
from one routing domain to another routing domain. The no debug ip redistribute to
command turns off IP redistribute debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip redistribute to {all | bgp | ospf | rip} from {all | bgp | connected | ospf |
rip | static}
no debug ip redistribute to {all | bgp | ospf | rip} from {all | bgp | connected | ospf
| rip | static}

Command Syntax

to to protocols
all all supported protocols
bgp routes redistributed into BGP
ospf routes redistributed into OSPF
rip routes redistributed into RIP
from from protocols
all all supported protocols
bgp routes redistributed from BGP
connected routes redistributed connected
ospf routes redistributed from OSPF

Compass ID: 188656176 Version 5 MGBI 4-29


BSR 64000 Command Reference Guide Release 4.2.0

rip routes redistributed from RIP


static routes redistributed static

Command Default
Disabled

4-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip rip
The debug ip rip command displays Routing Information Protocol (RIP) send and
receive information. The no debug ip rip turns off RIP debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip rip [database | events | trigger]
no debug ip rip [database | events | trigger]

Command Syntax

database RIP database events


events RIP protocol events
trigger RIP triggered events

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-31


BSR 64000 Command Reference Guide Release 4.2.0

debug ip rip database


The debug ip rip database command displays information on RIP route entry events;
additions, deletions, and changes. The no debug ip rip database command turns off
RIP database debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip rip database
no debug ip rip database

4-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip rip events


The debug ip rip events command displays information on RIP-related events. The
no debug ip rip events turns off RIP-related event debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip rip events
no debug ip rip events

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-33


BSR 64000 Command Reference Guide Release 4.2.0

debug ip rip trigger


The debug ip rip trigger command displays RIP routing events that occur as a result
of RIP trigger extensions. The no debug ip rip trigger command turns off RIP
triggered events debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip rip trigger
no debug ip rip trigger

Command Default
Disabled

4-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip tcp transactions


The debug ip tcp transactions command displays information on significant
TCP activity such as state changes, retransmissions, and duplicate packets.
The no debug tcp transactions command turns off TCP debugging.

Note: The debug ip tcp transactions command reports output for packets
the BSR 64000 transmits and receives, but does not display output for
packets it forwards.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip tcp transactions
no debug ip tcp transactions

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-35


BSR 64000 Command Reference Guide Release 4.2.0

debug ip udp
The debug ip udp command displays UDP-based transactions.The debug output
shows whether packets are being received from the host. The no debug ip udp
command turns off UDP debugging.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ip udp [dhcp [<mac>]]
no debug ip udp [dhcp [<mac>]]

Command Syntax

dhcp display Dynamic Host Configuration Protocol


(DHCP) packet information
mac client hardware/MAC address in the form of
xxxx.xxxx.xxxx

Command Default
Disabled

4-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ip vrrp
The debug ip vrrp command displays Virtual Router Redundancy Protocol (VRRP)
transactions. The no debug ip vrrp command turns off VRRP debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ip vrrp
no debug ip vrrp

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-37


BSR 64000 Command Reference Guide Release 4.2.0

debug ipsec
The debug ipsec command displays all realtime IP security (IPSec) debugging
information to the console. The no debug ipsec command turns off this debugging
function.

Note: Debugging for IPSec can only occur when IPSec is not shutdown.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ipsec {ike [chan-agent | del-msg | info-msg | key-exg | main | quick] | ipsec |
sadb | spd}
no debug ipsec {ike [chan-agent | del-msg | info-msg | key-exg | main | quick] |
ipsec | sadb | spd}

Command Syntax

ike enables the debugging of the Internet Key


Exchange (IKE) channel agent information,
delete messages, informational messages, key
exchanges, main mode (IKE phase 1) and
quick mode (IKE phase 2) information to the
console. Disabling this parameter shuts down
all six of the IKE debug printing categories.

chan-agent enables the debugging of the channel agent


information and prints it to the console
del-msg enables the debugging of delete messages and
prints them to the console

4-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

info-msg enables the debugging of informational


messages and prints them to the console
key-exg enables the debugging of key exchanges and
prints them to the console

main enables the debugging Internet Security


Association Key Management Protocol
(ISAKMP) exchange statements and prints
them to the console

quick enables the debugging of ISAKMP IKE


Security Association (SA) exchange
statements and prints them to the console
ipsec enables the debugging of IPSec information
and prints it to the console
sadb enables the debugging of Security
Association Database (SADB) information
and prints it to the console
spd enables the debugging of the IPSec Security
Policy Database (SPD) information and
prints it to the console

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-39


BSR 64000 Command Reference Guide Release 4.2.0

debug mpls forwarding


The debug mpls forwarding command enables debugging for MPLS forwarding.
The no debug mpls forwarding disables debugging for MPLS forwarding.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug mpls forwarding
no debug mpls forwarding

4-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug mpls rsvp


The debug mpls rsvp command enables various debugging functions for MPLS
RSVP protocol messages. The no debug mpls rsvp command disables debugging for
MPLS RSVP protocol messages.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug mpls rsvp {all | path | resv | ptear | rtear | error}
no debug mpls rsvp {all | path | resv | ptear | rtear | error}

Command Syntax

all debug all MPLS RSVP protocol messages


path debug MPLS RSVP protocol Path messages -
each sender transmits Path messages
downstream along the routes provided by the
unicast and multicast routing protocols
resv debug MPLS RSVP protocol Resv messages -
each receiver sends reservation request
(Resv) messages upstream toward senders
and sender applications and follow the
reverse route of Path messages
ptear debug MPLS RSVP protocol PathTear
messages - PathTear messages remove path
states and dependent reservation states in any
routers along a path and follow the same route
as Path messages.

Compass ID: 188656176 Version 5 MGBI 4-41


BSR 64000 Command Reference Guide Release 4.2.0

rtear debug MPLS RSVP protocol ResvTear


messages - ResvTear messages remove
reservation states along a path and travel
upstream toward senders of the session
error debug MPLS RSVP protocol PathErr and
ResvErr error messages

4-42 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug packet-cable
The debug packet-cable command enables Packet Cable debugging. The no debug
packet-cable command disables debugging output.

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


debug packet-cable {gate | trace [cops | em]}
no debug packet-cable {gate | trace [cops | em]}

Command Syntax

gate displays DQoS and Multimedia gate state


transition information
trace enable packet trace
trace cops enables COPS packet trace - dumps COPS
messages in hexidecimal format to the
console
trace em enable Event Message PCES packet trace -
dumps event messages in hexidecimal format
to the console

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-43


BSR 64000 Command Reference Guide Release 4.2.0

debug ppp fsm


The debug ppp fsm command turns debugging on for the PPP finite state machine
(FSM). The no debug ppp fsm command turns off PPP FSM debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ppp fsm
no debug ppp fsm

Command Default
Disabled

4-44 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug ppp packet


The debug ppp packet command displays PPP packets being transmitted and
received. The no debug ppp packet command turns off PPP debugging. The debug
ppp packet command to displays low-level packet dumps and is useful in identifying
the following information and error conditions:
■ Network Control Protocols (NCPs) that are supported on either end of a PPP
connection
■ any loops that might exist in a PPP internetwork
■ nodes that are (or are not) properly negotiating PPP connections
■ errors that have occurred over the PPP connection

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug ppp packet
no debug ppp packet

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-45


BSR 64000 Command Reference Guide Release 4.2.0

debug radius
The debug radius command displays RADIUS client authentication transactions.
The no debug radius command turns off RADIUS debugging.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug radius
no debug radius

4-46 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug snmp
The debug snmp command display detailed information about every SNMP packet
transmitted or received by the BSR 64000. The no debug snmp command turns off
SNMP debugging.

Group Access
All

Command Mode
All modes

Command Line Usage


debug snmp {headers | packets}
no debug snmp {headers | packets}

Command Syntax

headers display SNMP packet headers


packets display SNMP packets

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-47


BSR 64000 Command Reference Guide Release 4.2.0

debug sntp
The debug sntp command displays information on Simple Network Time Protocol
(SNTP) activity. The no debug sntp command turns off SNTP debugging.

Group Access
System Administrator

Command Mode
All modes except User EXEC

Command Line Usage


debug sntp
no debug sntp

4-48 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug specmgr
The debug specmgr command enables the display of spectrum management
debugging messages. The command output displays a time stamp, the error rate, the
number of word errors, total word count, and the upstream noise power level in
one-tenth of a dBmV. The no debug specmgr stops displaying spectrum management
debugging messages.

Note: The debug cable reg command is supported on the 1:4, 1:8, 2:8, and
2:8 (2.0) CMTS modules.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


debug specmgr [cable <X/Y> [ upstream <NUM>]]
no debug specmgr [cable <X/Y> [ upstream <NUM>]]

Command Syntax

cable display cable information


X/Y the slot and MAC Domain number of the
CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
upstream display upstream information
NUM upstream port number

Compass ID: 188656176 Version 5 MGBI 4-49


BSR 64000 Command Reference Guide Release 4.2.0

debug ssh
The debug ssh command enables debugging for SSH. The no debug ssh command
turns SSH debugging off.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ssh [verbose]
no debug ssh [verbose]

Command Syntax

verbose display detailed SSH debug information

4-50 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug tacacs
The debug tacacs command displays debug information associated with TACACS+
Client operations.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


debug tacacs

Compass ID: 188656176 Version 5 MGBI 4-51


BSR 64000 Command Reference Guide Release 4.2.0

debug tacacs events


The debug tacacs events command displays debug information related to TACACS+
server events generated as a result of interaction with a client. This command can
produce substantial amount of output on the console. The debug tacacs events
command is generally used as a tool to collect data to analyze a problem reported by
users.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


debug tacacs events

4-52 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug task monitor


The debug task monitor command enables task-based debugging through the Task
Monitor. The Task Monitor monitors task resource contention. The no debug task
monitor command disables debugging output.
The Task Monitor operates in two modes: background and foreground. In both modes
it monitors the amount of available memory (for SRM only and only if configured)
and performs reboot or switchover to a redundant SRM if the amount of available
memory falls below the configured threshold.The background mode is the default
mode of operation for all boards and the Task Monitor will run on all boards after
boot. The foreground mode is used for debugging purposes.
In background mode the Task Monitor checks to see if there has been ICP activity on
the board during the configured delay-interval. If ICP activity has been detected, no
other checking is done. Otherwise it checks to see if there have been non-zero idle
ticks. If there have been non-zero idle ticks, the checking is done. Otherwise it
displays brief information about all tasks that consumed non-zero CPU ticks during
the previous delay-interval, and detailed information about tasks that consumed the
maximum number of CPU ticks. If such tasks consumed more than 99% of the CPU
ticks and suspension of such tasks has been requested with the ‘Ctrl-@’ key sequence,
and suspension of such tasks is permitted, then those tasks will be suspended.

Note: The following tasks are never suspended: tRDNc, tExcTask, tShell, TaskMon,
ctrlMon, DiagTask, tNetTask and all telnet tasks. Also note that the ‘Ctrl-@’ request
will be canceled if no task consumed more than 99% of the CPU ticks during the
delay-interval.

The following applies only to the background mode on active SRM. If the same task
consumed more than ‘threshold-percent’ of CPU time within the ‘threshold-interval’
during consecutive checks and ‘suspend-task’ has been requested and suspension of
such task is permitted, then those tasks will be suspended. If the ‘switchover-reboot’
has been requested, then the SRM will be rebooted if there is no running redundant
SRM, or switched over otherwise.

Compass ID: 188656176 Version 5 MGBI 4-53


BSR 64000 Command Reference Guide Release 4.2.0

In foreground mode the Task Monitor checks to see if idle ticks have fallen below the
idle-trigger value. If so, it will display detailed information about all tasks that
consumed non-zero CPU ticks during the delay-interval. If one of the tasks consumed
more than 99% of the CPU ticks and suspension of such task has been requested with
‘Ctrl-@’ key, and suspension of such task is permitted, then that task will be
suspended. In foreground mode the Task Monitor performs its checks during
‘num-times’ delay-intervals and after that will automatically revert to the background
mode of operation.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug task monitor {<NUM>| all} background [delay-interval <1-86400> |
mem-switchover <0-1> | registers | suspend-task | switchover-reboot <0-1> |
threshold-interval <10-3600> | threshold-mem-low <0-128000000> |
threshold-percent <50-100>]
debug task monitor {<NUM>| all} [delay-interval <1-86400> | idle-trigger
<1-100>| num-times <1-24000> | registers]
no debug task monitor {<NUM>| all}

Command Syntax

NUM run Task Monitor for the specified slot


number
all run Task Monitor for all operational slots
background run Task Monitor in the background
delay-interval 1-86400 the number of seconds between data
collection intervals

4-54 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

mem-switchover 0-1 If system memory falls below the value


specified by the threshold-mem-low
parameter on the SRM, then switch-over or
reboot and switch-over.
registers Display registers for running tasks
suspend-task Suspend task if it consumes more than the
percentage of CPU time specified by the
threshold-percent parameter during the time
interval specified by the threshold-interval
parameter.
switchover-reboot 0-1 If a single task consumes more than the
percentage of CPU time specified by the
threshold-percent parameter during the time
interval specified by the threshold-interval
parameter, switchover to redundant SRM if it
is available, otherwise reboot.
threshold-interval 10- Time interval in seconds during which if a
3600 single task spends more than the percentage
of CPU time specified by the threshold-
percent parameter, special actions will be
taken depending on the values of the
suspend-task and switchover-reboot
parameters.
threshold-mem-low 0- If the memory on the primary SRM falls
128000000 below the set amount, a reboot and/or switch-
over will be initiated. The frequency of this
check is in accordance with the task monitor
threshold-interval.
threshold-percent 50- If a single task consumes more than this value
100 of CPU time during the time interval
specified by the threshold-interval
parameter, special actions will be taken
depending on the values of the suspend-task
and switchover-reboot parameters.

Compass ID: 188656176 Version 5 MGBI 4-55


BSR 64000 Command Reference Guide Release 4.2.0

delay-interval 1-86400 the number of seconds between data


collection intervals
idle-trigger 1-100 the idle-trigger percentage - Task Monitor
displays running tasks if the idle tick
percentage is less than or equal to the
specified idle-trigger percentage
num-times 1-24000 the number of times to run Task Monitor
registers display registers for running tasks

Command Default Values


Task Monitor is running in background mode for all boards
delay-interval = 20 seconds for the SRM, 5 seconds for all other modules
mem-switchover = do both (switch-over, then reboot and switch-over)
registers = no display
suspend-task = no
switchover-reboot = yes
threshold-interval = 180 seconds
threshold-mem-low = 16000000 bytes
threshold-percent = 99 percent
idle-trigger = 10 percent

4-56 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

debug tunnel
The debug tunnel command displays IP-in-IP encapsulated packets as they are
transmitted and received on a tunnel interface in real time and displays debugging
information on the tunnel interface. The no debug tunnel command turns off tunnel
debugging.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug tunnel
no debug tunnel

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 4-57


BSR 64000 Command Reference Guide Release 4.2.0

show debugging
The show debugging command displays enabled debugging operations and other
types of debugging functions on the system.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show debugging [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show debugging [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

4-58 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Debug Commands

undebug all
The undebug all command disables all debugging functions on the system.

Group Access
System Administrator

Command Mode
All modes except User EXEC

Command Line Usage


undebug all

Compass ID: 188656176 Version 5 MGBI 4-59


5
Access List Commands

Introduction
This chapter describes the access list commands used with the BSR 64000™.
Access lists are used on the BSR to control entry or exit access to or from the BSR.
Access lists are also used within a route-map statement that is part of the routing
configuration. Access lists can be configured for all routed network protocols to filter
packets as the packets pass through the BSR. The access list criteria can be defined by
the source or the destination address, upper-layer protocol, or other routing
information.
There are many reasons to configure access lists including to restrict contents of
routing updates or to provide traffic flow control. One of the most important reasons
to configure access lists is to provide a basic level of security on the network. All
packets passing through the BSR can be allowed onto all parts of the network if an
access list is not part of the router configuration.

Access List Command Descriptions


This section contains an alphabetized list and descriptions of the access list
commands supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 5-1


BSR 64000 Command Reference Guide Release 4.2.0

access-class in
The access-list in command filters incoming connections based on an IP access list.
The no access-class command disables incoming connection filtering.

Group Access
System Administrator

Command Mode
Gloval Configuration

Command Line Usage


access-class {<1-99> | <1300-1999>} in
no access-class

Command Syntax

1-99 the IP access-list number


1300-1999 the IP access-list number (expanded range)

5-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Access List Commands

access-list (standard)
The standard access-list command defines a standard access list to configure and
control the flow of routing information and traffic by matching a packet with a permit
or deny result. The no access-list command deletes the access-list.
Use the access-list command to restrict routing update information; control the
transmission of packets on an interface, or control virtual terminal line access.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


access-list <1-99> <1300-1999> {deny | permit} {<A.B.C.D> [<A.B.C.D>] | any |
host <A.B.C.D>}
no access-list <1-99> <1300-1999>

Command Syntax

1-99 standard access list


1300-1999 standard IP access list (expanded range)
deny deny access if conditions are matched
permit permit access if conditions are matched
A.B.C.D address to match
A.B.C.D wildcard bits
any any source host
host A.B.C.D a single source host

Compass ID: 188656176 Version 5 MGBI 5-3


BSR 64000 Command Reference Guide Release 4.2.0

access-list (extended)
The extended access-list command defines an extended access list to configure and
control the flow of routing information and network traffic by matching a packet with
a permit or deny result. The no access-list command deletes the access-list.
Use the access-list command to restrict routing update information, control the
transmission of packets on an interface, or control virtual terminal line access.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


To configure an extended access list for AHP, ESP, GRE, IP, IPINIP, OSPF, PCP, and
PIM, use the following command:
access-list <100-199> <2000-2699> {deny | permit} {<0-255> | ahp | esp | gre | ip |
ipinip | ospf | pcp | pim} {<A.B.C.D> <A.B.C.D> | any | host <A.B.C.D>}
{<A.B.C.D> <A.B.C.D> | any | host <A.B.C.D>} [diff-serv <0-63>]

To configure an extended access list for ICMP, use the following command:
access-list <100-199> <2000-2699> {deny | permit} icmp {<A.B.C.D> <A.B.C.D> |
any | host <A.B.C.D>} {<A.B.C.D> <A.B.C.D> | any | host <A.B.C.D>} [<0-255> |
administratively-prohibited | alternate-address | dod-host-prohibited |
dod-net-prohibited | echo | echo-reply | general-parameter-problem |
host-isolated | host-precedence-unreachable | host-redirect | host-tos-redirect |
host-tos-unreachable | host-unknown | host-unreachable | information-reply |
information-request | mask-reply | mask-request | net-redirect | net-tos-redirect |
net-tos-unreachable | net-unreachable | network-unknown | no-room-for-option |
option-missing | packet-too-big | parameter-problem | port-unreachable |
precedence-unreachable | protocol-unreachable | reassembly-timeout | redirect |
router-advertisement | router-solicitation | source-quench | source-route-failed |
time-exceeded | timestamp-reply | timestamp-request | ttl-exceeded |
unreachable]

5-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Access List Commands

To configure an extended access list for IGMP, use the following command:
access-list <100-199> <2000-2699> {deny | permit} igmp {<A.B.C.D> <A.B.C.D> |
any | host <A.B.C.D>} {<A.B.C.D> <A.B.C.D> | any | host <A.B.C.D>} [<0-255> |
diff-serv | dvmrp | host-query | host-report | pim ]

To configure an extended access list for TCP, use the following command:
access-list <100-199> <2000-2699> {deny | permit} tcp {<A.B.C.D> <A.B.C.D> |
any | host <A.B.C.D>} {<A.B.C.D> <A.B.C.D> | any | eq | gt | host <A.B.C.D> | lt |
neq | range} [diff-serv <0-63> | <0-65535> | bgp | chargen | cmd | daytime |
discard | domain | echo | exec | finger | ftp | ftp-data | gopher | hostname | ident |
irc | klogin | kshell | login | lpd | nntp | pim-auto-rp | pop2 | pop3 | smtp | sunrpc |
talk | telnet | time | uucp | whois | www]

To configure an extended access list for UDP, use the following command:
access-list <100-199> <2000-2699> {deny | permit} udp {<A.B.C.D> <A.B.C.D> |
any | host <A.B.C.D>} {<A.B.C.D> <A.B.C.D> | any | eq | gt | host <A.B.C.D> | lt |
neq | range} [diff-serv <0-63> | <0-65535> | biff | bootpc | discard | domain | echo |
mobile-ip | netbios-dgm | netbios-ns | netbios-ss | ntp | pim-auto-rp | rip | snmp |
snmptrap | sunrpc | syslog | talk | tftp | time | who | xdmcp]

To remove an access list, use the following command:


no access-list <100-199> <2000-2699>

Command Syntax

100-199 extended access list


2000-2699 extended IP access list (expanded range)
deny deny access if conditions are matched
permit permit access if conditions are matched

Compass ID: 188656176 Version 5 MGBI 5-5


BSR 64000 Command Reference Guide Release 4.2.0

name or number of an IP protocol

0-255 the number of an IP protocol


ahp Authentication Header Protocol (51)
esp Encapsulation Security Payload (50)
gre General Routing Encapsulation (47)
icmp Internet Control Message Protocol (1)
igmp Internet Group Management Protocol (2)
ip Any Internet protocol (0)
ipinip IP in IP tunneling (4)
ospf OSPF routing protocol (89)
pcp Payload Compression Protocol (108)
pim Protocol Independent Multicast (103
tcp Transmission Control Protocol (6)
udp User Datagram Protocol (17)
vrrp Virtual Router Redundancy Protocol (112)
A.B.C.D source address
A.B.C.D source wildcard bits
any any source host
host A.B.C.D a single source host
A.B.C.D destination address
A.B.C.D destination wildcard bits
any any destination host
host A.B.C.D a single destination host
diff-serv 0-63 value of IP Diff-Serv

5-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Access List Commands

filter ICMP packets by message


type number (0-255) or message
type name

0-255 filter by message type number


administratively-prohibited Administrativelyprohibited
alternate-address Alternate address
diff-serv Diff-Serv Code Point
dod-host-prohibited Host prohibited
dod-net-prohibited Network prohibited
echo Echo - ping
echo-reply Echo reply
general-parameter-problem Parameter problem
host-isolated Host isolated
host-precedence-unreachable Host unreachable for precedence
host-redirect Host redirect
host-tos-redirect Host redirect for TOS
host-tos-unreachable Host unreachable for TOS
host-unknown Host unknown
host-unreachable Host unreachable
information-reply Information replies
information-request Information requests
mask-reply Mask replies
mask-request Mask requests
net-redirect Network redirect
net-tos-redirect Network redirect for TOS
net-tos-unreachable Network unreachable for TOS
net-unreachable Network unreachable
network-unknown Network unknown
no-room-for-option Parameter required but no room
option-missing Parameter required but not present
packet-too-big Fragmentation needed and DF set
parameter-problem All parameter problems
port-unreachable Port unreachable

Compass ID: 188656176 Version 5 MGBI 5-7


BSR 64000 Command Reference Guide Release 4.2.0

precedence-unreachable Precedence cutoff


protocol-unreachable Protocol unreachable
reassembly-timeout Reassembly timeout
redirect All redirects
router-advertisement Router discovery advertisements
router-solicitation Router discovery solicitations
source-quench Source quenches
source-route-failed Source route failed
time-exceeded All time exceededs
timestamp-reply Timestamp replies
timestamp-request Timestamp requests
ttl-exceeded TTL exceeded
unreachable All unreachables
filter IGMP packets by message
type number (0-255) or message
type name

0-255 filter by message type number


diff-serv Diff-Serv Code Point
dvmrp Distance Vector Multicast Routing Protocol
(0x13)
host-query Host query (0x11)
host-report Host report (0x12)
pim Protocol Independent Multicast (0x14)

only match packets on a TCP or


UDP port number or range of port
numbers

eq match only packets on a given port number


gt match only packets with a greater port number
lt match only packets with a lower port number
neq match only packets not on a given port number
range match only packets in a range of port numbers

5-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Access List Commands

0-65535 a TCP port number


bgp Border Gateway Protocol (179)
chargen Character generator (19)
cmd Remote commands - rcmd (514)
daytime Daytime (13)
discard Discard (9)
domain Domain Name Service (53)
echo Echo (7)
exec Exec - rsh (512)
finger Finger (79)
ftp File Transfer Protocol (21)
ftp-data File Transfer [Default Data] (20)
gopher Gopher (70)
hostname NIC hostname server (101)
ident Authentication Service (113)
irc Internet Relay Chat (194
klogin Kerberos login (543)
kshell Kerberos shell (544)
login Login - rlogin (513)
lpd Printer service (515)
nntp Network News Transport Protocol (119)
pim-auto-rp PIM Auto-RP (496)
pop2 Post Office Protocol v2 (109)
pop3 Post Office Protocol v3 (110)

Compass ID: 188656176 Version 5 MGBI 5-9


BSR 64000 Command Reference Guide Release 4.2.0

smtp Simple Mail Transport Protocol (25)


sunrpc Sun Remote Procedure Call (111)
talk Talk (517)
telnet Telnet (23)
time Time (37)
uucp Unix-to-Unix Copy Program (540)
whois Nickname (43)
www World Wide Web - HTTP (80)
the number or name of a UDP port

0-65535 a UDP port number


biff Biff - mail notification (512)
bootpc Bootstrap Protocol Client (68)
bootps Bootstrap Protocol Server (67)
discard Discard (9)
domain Domain Name Service (53)
echo Echo (7)
mobile-ip Mobile IP registration (434)
netbios-dgm NetBios Datagram Service (138)
netbios-ns NetBios Name Service (137)
netbios-ss NetBios Session Service (139)
ntp Network Time Protocol (123)
pim-auto-rp PIM Auto-RP (496)
rip Routing Information Protocol (520)
snmp Simple Network Management Protocol (161)
snmptrap SNMP Traps (162)
sunrpc Sun Remote Procedure Call (111)
syslog Syslog (514)
talk Talk (517)
tftp Trivial File Transfer Protocol (69)
time Time (37)
who Who service - rwho (513)
xdmcp X Display Manager Control Protocol (177)

5-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Access List Commands

ip access-group
Use the ip access-group command to assign an access list to an interface and
determine if the interface accepts inbound or outbound packets, or both from this
access list. The no ip access-group command removes the access list or disables
inbound or outbound packets.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip access-group <1-199> <1300-2699> {in | out}
no ip access-group <1-199> <1300-2699> {in | out}

Command Syntax

1-199 access list number


1300-2699 access list number (expanded range)
in inbound packets
out outbound packets

Compass ID: 188656176 Version 5 MGBI 5-11


BSR 64000 Command Reference Guide Release 4.2.0

ip access-list
The ip access-list command adds a standard or extended access-list entry. The no ip
access-list command removes the entry.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip access-list {standard <1-99> | extended <100-199>}
no ip access-list {standard <1-99> | extended <100-199>}

Command Syntax

standard 1-99 standard access list number


extended 100-199 extended access list number

5-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Access List Commands

show access-lists
The show access-lists command displays an access list, or all access lists, without
displaying the entire configuration file. The following is an example of typical screen
output from the show tcp statistics command:

Standard IP access list 10


deny host 150.31.91.71
permit any
Extended IP access list 113
permit tcp any lt 200 any

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show access-lists [<1-199> <1300-2699>] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show access-lists [<1-199> <1300-2699>] [ | {count | count-only}]

Command Syntax

1-199 access list number


1300-2699 access list number (expanded range)
| turns on output modifiers (filters)
begin filter for output that begins with the specified string
exclude filter for output that excludes the specified string
include filter for output that includes the specified string
WORD the specified string

Compass ID: 188656176 Version 5 MGBI 5-13


BSR 64000 Command Reference Guide Release 4.2.0

count count the number of outputted lines


count-only count the number of lines while suppressing screen
output

Command Default
All access lists are displayed.

5-14 MGBI Compass ID: 188656176 Version 5


6
Routing Policy Commands

Introduction
This chapter contains the Routing Policy and Policy-Based Routing commands used
with the BSR 64000™.
Routing Policy allows the control of information that is imported from or exported
into different routing domains or Autonomous Systems (AS).
BSR Routing Policy allows the filtering and altering of routing information so that
some of them can be advertised to other routers. The BSR Routing Policy is quite
versatile and flexible.
The BSR also supports Policy-based routing. The BSR also supports Policy-based
routing is a set of rules that define the criteria for obtaining specific routing paths for
different users to give some users better-routed Internet connections than others.
Policy-based routing is established by the source information of the packets, rather
than the destination information that traditional routing protocols use. The network
administrator determines and implements routing policies to allow or deny router
paths.

Routing Policy Command Descriptions


This section contains an alphabetized list and descriptions of the routing policy
commands supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 6-1


BSR 64000 Command Reference Guide Release 4.2.0

default-information originate
The default-information originate command injects the default network in a routing
domain such as Border Gateway Protocol (BGP).The no default-information
originate command disables the default network redistribution in the routing domain.
The network 0.0.0.0 command in Router Configuration mode performs the same
function as the default-information originate command. In the Routing Information
Protocol (RIP) the metric is always set to 1. In BGP, the default route needs to exist in
the BGP routing database. BGP uses the metric associated with the default entry in its
database.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


default-information originate [always] [metric <0-16777214>] [metric-type
<1-2>]
no default-default-information originate [always] [metric <0-16777214>]
[metric-type <1-2>]

Command Syntax

originate software generates a default external route


into an Open Shortest Path First (OSPF)
domain to propagate another route if a default
route exists
always advertises the default route even when the
default route does not exist (OSPF only)
metric 0-16777214 metric for generating the default route,
default is 1 if no metric-value value specified
(OSPF only)
metric-type 1-2 1- external type 1 (OSPF only)
2- external type 2 (OSPF only)

6-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 6-3


BSR 64000 Command Reference Guide Release 4.2.0

default-metric
The default-metric command sets the default metric value for redistribution of routes
from one domain into another. The no default-metric command removes the set
default value for metric.
Use the default-metric command with the redistribute command to enforce the
same metric value for all redistributed routes.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


default-metric <1-4294967295>
no default-metric [<1-4294967295>]

Command Syntax

1-4294967295 default metric value; the range of values


depends on the routing protocol for which this
is configured; for RIP 1 to 16, OSPF from 1
to 16777214, and BGP from 1 to 4294967295

Command Default
A built-in automatic metric translation for each routing protocol

6-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

ip local policy route-map


The ip local policy route-map command enables local policy routing for a specified
route map. The no ip local policy route-map command disables local policy routing
for a specified route map.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip local policy route-map <WORD>
no ip local policy route-map <WORD>

Command Syntax

WORD the route map name

Compass ID: 188656176 Version 5 MGBI 6-5


BSR 64000 Command Reference Guide Release 4.2.0

ip policy route-map
The ip policy route-map command identifies the route-map used on an interface to
perform policy-based routing. The no ip policy route-map command removes the
route-map on an interface, and disables policy-based routing on that interface.
Use the ip policy route-map command for paths other than the shortest path. This
command has associated match and set commands: match commands specify policy
routing rules, set commands perform tasks

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip policy route-map <WORD>
no ip policy route-map <WORD>

Command Syntax

WORD route-map name that must match a specified


map tag

Command Default
No policy routing

6-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

match as-path
The match as-path command matches a BGP autonomous system path access list to
a match entry or appends new list numbers to the existing match entry. The no match
as-path command removes the list numbers from the match entry used in the
command.
Use the match as-path command to match a BGP autonomous system path to
advertise on the route-map. Values can be set using the match as-path command.
Use the match as-path command to match at least one BGP autonomous system path
to ensure advertisement on the route-map.
Use the match as-path command to globally replace values matched and set with the
match as-path command and the set weight command to supersede weights
established with the neighbor weight and the neighbor filter-list commands.
The values set by the match and set commands override global values. For example,
the weights assigned with the match as-path and set weight route-map commands
override the weights assigned using the neighbor weight and neighbor filter-list
commands. The implemented weight is established by the initial autonomous system
match.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match as-path [<1-199>]
no match as-path [<1-199>]
Command Syntax

1-199 as-path list number - you can specify a


single number or multiple numbers
separated by a space

Compass ID: 188656176 Version 5 MGBI 6-7


BSR 64000 Command Reference Guide Release 4.2.0

match community
The match community command creates a BGP autonomous system community
access list match entry or appends new list numbers to the existing match entry. The
no match community command removes the match entry completely. The no match
community command removes the list numbers or the exact-match attribute from the
match entry.
Use the match community-list command to ensure that the route is advertised for
outbound and inbound route-maps. If a change to some of the information is to match
is needed, configure a second route-map with specifics.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match community [<1-99> | <100-199> | exact-match]
no match community [<1-99> | <100-199> | exact-match]

Command Syntax

1-99 standard community list number


100-199 extended community list number
exact-match exact match required; all of the communities
and only those communities in the
community list must be present

6-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

match ip address
The match ip address command matches the destination and source IP address or
other fields of the IP header on packets with a standard or extended access list
allocated. The no match ip address command disables policy routing on packets.
This command can also be used for filtering routes based on the destination network
of the route.
Use the match ip address command to match any routes that have a source network
number and a destination network number address that a standard or extended access
list permits. To match both source and destination numbers, use an extended access
list. The match ip address command can also be used to filter routing information.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match ip address [<1-199> | <1300-2699>]
no match ip address [<1-199> | <1300-2699>]

Command Syntax

1-199 standard access list number


1300-2699 extended access list number

Compass ID: 188656176 Version 5 MGBI 6-9


BSR 64000 Command Reference Guide Release 4.2.0

match ip next-hop
The match ip next-hop command establishes the condition for the next hop IP
address of a route to match against the specified access lists. The no match ip
next-hop command removes the access-list from the match condition.
Use the match ip next-hop command to match any routes that have a next-hop router
address permitted one of the specified access lists.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match ip next-hop [<1-199> | <1300-2699>]
no match ip next-hop [<1-199> | <1300-2699>]

Command Syntax

1-199 standard access list number


1300-2699 extended access list number

6-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

match ip route-source
The match ip route-source command specifies match conditions for the source IP
address of a route to match against the specified address list(s). The no match ip
route-source command removes access lists from such a match statement.
The match ip route-source command is used to match routes where source IP
addresses are permitted by specified access lists.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match ip route-source [<1-199> | <1300-2699>]
no match ip route-source [<1-199> | <1300-2699>]

Command Syntax

1-199 standard access list number


1300-2699 extended access list number

Compass ID: 188656176 Version 5 MGBI 6-11


BSR 64000 Command Reference Guide Release 4.2.0

match metric
The match metric command matches routes imported or otherwise with specified
metric value. The no match metric command disables matching imported routes with
specified metric values.
Use the match metric command to match a route for the specified metric value(s).

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match metric [<0-4294967295>]
no match metric [<0-4294967295>]

Command Syntax

0-4294967295 metric value

6-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

match route-type external


The match route-type external command is used to match the type of OSPF routes.
The no match route-type external clears the match condition.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match route-type external [level-1 | level-2 | type-1 | type-2]
no match route-type external [level-1 | level-2 | type-1 | type-2]

Command Syntax

type 1 matches only type 1 external route (OSPF)


type 2 matches only type 2 external route (OSPF)
level-1 IS-IS level-1 route
level-2 IS-IS level-2 route

Compass ID: 188656176 Version 5 MGBI 6-13


BSR 64000 Command Reference Guide Release 4.2.0

match route-type internal


The match route-type internal command matches and redistributes OSPF routes of
an internal type. The no match route-type internal command clears the condition.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match route-type internal [level-1 | level-2]
no match route-type internal [level-1 | level-2]

Command Syntax

level-1 IS-IS level-1 route


level-2 IS-IS level-2 route

6-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

match tag
The match tag command redistributes routes in the routing table that match a
specified tag value. Use the no match tag command to disable redistributing routes in
the routing table that match a specified tag.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


match tag [<0-4294967295>]
no match tag

Command Syntax

0-4294967295 tag value

Compass ID: 188656176 Version 5 MGBI 6-15


BSR 64000 Command Reference Guide Release 4.2.0

route-map
The route-map command defines the conditions for redistributing routes from one
protocol to another, or to configure routing policies. The no route-map command
removes some or all of the instances of the route map.
Use the route-map command and the match and set commands, to define the
conditions for redistributing routes from one routing protocol into another, or for
accepting routes from a neighboring router. Each route-map command has an
associated list of match and set commands. The match commands specify the
conditions under which redistribution is allowed for the current route-map command.
The set commands specify the particular redistribution actions to perform if the
criteria enforced by the match commands are met. The no route-map command
deletes the route-map, or an instance.
The set commands specify the redistribution set actions when all of a route-map's
match criteria are met. When all match criteria are met, all set actions are performed.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


route-map <WORD> [permit | deny] [0-65535]
no route-map <WORD> [permit | deny] [0-65535]

6-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

Command Syntax

WORD tag name, more than one instance of the


route-map can share name
permit distributes route as controlled by set actions
when permit is specified and the match
criteria are met, the route is specified by the
specific actions
deny distributes route as controlled by set actions,
if criteria not met, route not distributed
0-65535 position a new instance will have in the list of
route-map instances already established with
the same map name.

Compass ID: 188656176 Version 5 MGBI 6-17


BSR 64000 Command Reference Guide Release 4.2.0

set as-path prepend


The set as-path prepend command modifies AS system path attributes for the
matched BGP routes. The no set as-path prepend command ends modification of a
system path for BGP routes.
Use the set as-path prepend command to guide the path information to control the
BGP decision process.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set as-path prepend <1-65535> [...<1-65535>]
no set as-path prepend <1-65535> [...<1-65535>]

Command Syntax

1-65535 prepend string - you can specify a single


number or multiple numbers separated
by a space

6-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

set automatic-tag
The set automatic-tag command enables the automatic computing of tag values. The
no set automatic-tag command disables the automatic computing of tag values.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set automatic-tag
no set automatic-tag

Compass ID: 188656176 Version 5 MGBI 6-19


BSR 64000 Command Reference Guide Release 4.2.0

set comm-list
The set comm-list command deletes communities from the community attribute of an
inbound or outbound update. The no set comm-list command deletes the entry.
Use the set comm-list command to delete communities from the community attribute
of inbound or outbound updates using a route map to filter and determine the
communities to be deleted.
If the standard list is referred in the set comm-list delete command, only the elements
with the single community number or no community number in them will be used. All
others will be quietly ignored. Any element specified with the 'internet' keyword is
equivalent to element without community number.
If the set community comm and set comm-list list-num delete commands are
configured in the same sequence of a route-map attribute, the deletion operation (set
comm-list list-num delete) is performed before the set operation (set community
comm).

Note: If the set community and set comm-list delete commands are
configured in the same sequence of a route-map attribute, the deletion
operation (set comm-list delete) is performed before the set operation (set
community).

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set comm-list {<1-99> | <100-199>} delete
no set comm-list {<1-99> | <100-199>} delete

Command Syntax

1-99 standard community list number

6-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

100-199 extended community list number


delete delete inbound or outbound communities from the
community attribute

Compass ID: 188656176 Version 5 MGBI 6-21


BSR 64000 Command Reference Guide Release 4.2.0

set community
The set community command adds or replaces communities from the community
attribute of an inbound or outbound update. Use the no set community command
removes the specified communities from the set.
Use the route-map command, and the match and set commands to configure the
rules for redistributing routes from one routing protocol to another. Each route-map
command has a list of match and set commands associated with it. The match
commands specify the match criteria, which are the conditions under which
redistribution is allowed for the current route-map command. The set commands
specify the set actions, the particular redistribution actions to perform if the criteria
enforced by the match commands are met. The no route-map command deletes the
route map.

Note: The communities could be specified as numbers; the result will be the
same; none removes community attribute from the update unless additive is
specified for the set entry. In this case it doesn't modify update community
attributes.

In other words, the no set community command, if the entry had some
community numbers in it before removal, and as the result of the removal no
numbers are left, then the entry itself is deleted.

The command set community none removes all community numbers from
set entry, if any, but leaves the value of the additive attribute intact.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set community {<1-4294967295> | local-AS | no-advertise | no-export | additive |
none}
no set community {<1-4294967295> | local-AS | no-advertise | no-export |
additive | none}

6-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

Command Syntax

1-4294967295 community number


additive add to the existing community
local-AS do not advertise this route to peers outside of
the local autonomous system
no-advertise do not advertise this route to any peer
internal or external
no-export routes with this community are sent to
peers in other sub-autonomous systems
within a confederation
none no community attribute

Compass ID: 188656176 Version 5 MGBI 6-23


BSR 64000 Command Reference Guide Release 4.2.0

set default interface


The set default interface command sets a default output interface for a packet in the
default destination-based routing process. The no set default interface command
disables this function.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set default interface {null0 | pos <X/Y> | tunnel <0-255>}
no set default interface {null0 | pos <X/Y> | tunnel <0-255>}

Command Syntax

null0 forces packets to be dropped and not routed to


the default destination-based routing process
pos X/Y the POS interface slot and port number
tunnel 0-255 the tunnel interface number

Command Default
Disabled

6-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

set interface
The set interface command sets the output interface for a packet in the
destination-based routing process. The no set interface command disables this
function.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set interface {null0 | pos <X/Y> | tunnel <0-255>}
no set interface {null0 | pos <X/Y> | tunnel <0-255>}

Command Syntax

null0 sets the last entry in the interface list to force


packets to be dropped and not routed to the
default destination-based routing process
pos X/Y the POS interface slot and port number
tunnel 0-255 the tunnel interface number

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 6-25


BSR 64000 Command Reference Guide Release 4.2.0

set ip default next-hop


The set ip default next-hop command specifies a default next hop IP address that
indicates where the BSR sends packets that pass a match clause in a route map for
policy routing but have no route to the destination. The no set ip default next-hop
removes the default next hop IP address.

Note: The presence of a default route in the routing table will ensure that
destination-based forwarding will always be applied and policy will be
ignored.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set ip default next-hop <A.B.C.D>
no set ip default next-hop <A.B.C.D>

Command Syntax

A.B.C.D the IP address of the next hop

6-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

set ip diff-serv
The set ip diff-serv command assigns a differentiated service value which is placed
in the IP packet header that determines which packets are given transmission priority.
When these packets are received by another router, they are transmitted based on the
precedence value. A higher precedence value indicates a higher priority. The no set ip
diff-serv command disables assigning a differentiated service value.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set ip diff-serv <0-63>
no set ip diff-serv [<0-63>]

Command Syntax

0-63 IP packet precedence value.

The following table describes the number and name values for IP Precedence:

Number Name
0 routine
1 priority
2 immediate
3 flash
4 flash-override
5 critical
6 internet

7 network

Compass ID: 188656176 Version 5 MGBI 6-27


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
0

6-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

set ip next-hop
The set ip next-hop command establishes a next-hop value for the AS path. The no ip
next-hop command deletes the entry.
Use the ip policy route-map interface configuration command, the route-map global
configuration command, and the match and set route-map configuration commands,
to define the conditions for policy routing packets. The ip policy route-map
command identifies a route map by name. Each route-map command has a list of
match and set commands associated with it. The match commands specify the match
criteria---the conditions under which policy routing occurs. The set commands
specify the set actions---the particular routing actions to perform if the criteria
enforced by the match commands are met.
If the interface associated with the first next hop specified with the set ip next-hop
command is down, the optionally specified IP addresses are tried in turn.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set ip next-hop <A.B.C.D>
no set ip next-hop

Command Syntax

A.B.C.D IP address of the next hop to which packets


are output; address of the adjacent router

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 6-29


BSR 64000 Command Reference Guide Release 4.2.0

set ip qos queue


The set ip qos queue command specifies Quality Of Service (QoS) queue number.

Group Access
All

Command Mode
Route Map Configuration

Command Line Usage


set ip qos queue <0-7>

Command Syntax

0-7 the QoS queue number

6-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

set local-preference
The set-local preference command establishes a preference value for the AS system
path. Use the set local-preference command to send the local-preference to all
routers in the local autonomous system.
Use the no set-local preference form of this command to delete the entry.

Note: In the no set-local preference command, the optional


<0-4294967295> argument has no effect.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set local-preference <0-4294967295>
no set local-preference <0-4294967295>

Command Syntax

0-4294967295 local preference value

Compass ID: 188656176 Version 5 MGBI 6-31


BSR 64000 Command Reference Guide Release 4.2.0

set metric
The set metric command sets the metric value for a routing protocol. The no set
metric command changes the metric value for a routing protocol to the default value.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set metric <0-4294967295>
no set metric <0-4294967295>

Command Syntax

0-4294967295 metric value or bandwidth in Kbytes per


second

Command Default
Metric value dynamically learned or a default value

6-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

set metric-type
The set metric-type command sets the metric type for the destination routing
protocol. The no set metric-type command disables the metric type set for the
destination routing protocol.
Use the route-map command to set the type of metric for the route imported by OSPF
into its domain.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set metric-type {external | internal | type-1 | type-2}
no set metric-type {external | internal | type-1 | type-2}

Command Syntax

external IS-IS external metric


internal use IGP metric as the MED for BGP
type-1 OSPF external type 1 metric
type-2 OSPF external type 2 metric

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 6-33


BSR 64000 Command Reference Guide Release 4.2.0

set origin
The set origin command configures the conditions for redistributing routes from any
protocol to any protocol. The no set origin command deletes the BGP origin code.
When the set origin command configures redistributing routes from any protocol to
any protocol, any match clause is necessary which includes pointing to a “permit
everything” to set tags.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set origin {egp | igp | incomplete}
no set origin {egp | igp | incomplete}

Command Syntax

egp EGP
igp remote IGP
incomplete unknown history

6-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

set tag
The set tag command sets the value of the destination routing protocol. The no set tag
command removes the value.
The route-map global configuration command and the match and set route-map
configuration commands are used together to define the conditions for redistributing
routes from one routing protocol into another. Each route-map command has a list of
match and set commands associated with it. The match commands specify the
conditions for redistribution for the current route-map command. The set commands
specify the particular redistribution actions to perform if the criteria enforced by the
match commands are met. The no route-map command deletes the route map.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set tag <0-4294967295>
no set tag <0-4294967295>

Command Syntax

0-4294967295 tag value

Command Default
if not specified, tag is forwarded to the new destination protocol

Compass ID: 188656176 Version 5 MGBI 6-35


BSR 64000 Command Reference Guide Release 4.2.0

set weight
The set-weight command to set the route weight on the network. The first
autonomous system match determines the weight to be set.
Use the set weight command to set the route weight on the network. The first AS
match determines the weight to be set. The route with the highest weight is chosen as
the choice route when multiple routes are available on the network. Weights spoken
when an as path is matched, override any weight set by the neighbor command. Any
match clause is necessary which includes pointing to a “permit everything” to set tags

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set weight <0-65535>
no set weight

Command Syntax

0-65535 weight value

6-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

show ip redistribute
The show ip redistribute command displays the routing protocols that are being
redistributed to other routing domains. The following is an example of typical screen
output from the show ip redistribute command:

To ospf in ipv4
redistribute connected subnets

Group Access
All

Command Mode
All except User EXEC

Command Line Usage


show ip redistribute [bgp | ospf | rip] [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]
show ip redistribute [bgp | ospf | rip] [ | {count | count-only}]

Command Syntax

bgp displays routing domains redistributed into


BGP
ospf displays routing domains redistributed into
OSPF
rip displays routing domains redistributed into
RIP
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string

Compass ID: 188656176 Version 5 MGBI 6-37


BSR 64000 Command Reference Guide Release 4.2.0

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

6-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Routing Policy Commands

show ip traffic
The show ip traffic command displays the number of routing policy forwards and
routing policy drops.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip traffic [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show ip traffic [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 6-39


BSR 64000 Command Reference Guide Release 4.2.0

show route-map
The show route-map command displays route maps.

Group Access
All

Command Mode
All except User EXEC

Command Line Usage


show route-map [<WORD>] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show route-map [<WORD>] [ | {count | count-only}]

Command Syntax

WORD specified route-map


| turns on output modifiers (filters)
begin filter for output that begins with the specified
string

exclude filter for output that excludes the specified


string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

6-40 MGBI Compass ID: 188656176 Version 5


7
RIP Commands

Introduction
This chapter contains the Routing Information Protocol (RIP) commands used with
the BSR 64000™.
RIP exchanges routing information to resolve routing errors. RIP coordinates routers
on the network to broadcast their routing database periodically and determine the
route with the least number of hops relative to the active routing table. Each hop
determination message lists each destination with a distance in number of hops to the
destination.

RIP Command Descriptions


This section contains an alphabetized list and descriptions of the RIP commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 7-1


BSR 64000 Command Reference Guide Release 4.2.0

auto-summary
The auto-summary command restores automatic summarization of subnet routes into
network-level routes. The no auto summary command disables automatic
summarization.

Note: RIP Version 1 always uses automatic summarization. RIP Version 2


when routing between disconnected subnets, requires automatic
summarization to be off which is the default state.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


auto summary
no auto summary

Command Default
Disabled

7-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

clear ip rip statistics


The clear ip rip statistics command clears all routes from the RIP routing table. This
is the same route information displayed with the show ip rip database command.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ip rip statistics

Compass ID: 188656176 Version 5 MGBI 7-3


BSR 64000 Command Reference Guide Release 4.2.0

default-information originate
The default-information originate command generates a default route into the RIP
database. The no default-information originate command disables default route
generation.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


default-information originate
no default-information originate

Command Default
Disabled

7-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

default-metric
The default-metric command specifies a new RIP default metric value. The no
metric command returns the metric value to the default.
Use the default-metric command to set the current protocol to the same metric value
for all distributed routes. The default-metric command is used with the redistribute
command to obtain the same metric value for all distributed protocol-specific routes.

Note: This command assures that metrics are compatible during route
redistribution. The default metric delivers an alternate for successful
distribution if the network metrics are not converted.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


default metric <1-16>
no default metric <1-16>

Command Syntax

1-16 the metric value

Command Default
Automatic metric translations given for each routing protocol

Compass ID: 188656176 Version 5 MGBI 7-5


BSR 64000 Command Reference Guide Release 4.2.0

distance
The distance command sets the administrative distances for routes. The no distance
command disables the administrative distance for routes.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distance <1-255>
no distance <1-255>

Command Syntax

1-255 administrative distance for setting routes

Command Default
120

7-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

distribute-list in
The distribute-list in command filters networks received in routing updates. The no
distribute-list in command changes or cancels the filters received in updates.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distribute-list <1-199> <1300-2699> in
no distribute-list <1-199> <1300-2699> in

Command Syntax

1-199 access list number


1300-2699 extended access list number
in applies access list to incoming route updates

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 7-7


BSR 64000 Command Reference Guide Release 4.2.0

distribute-list out
The distribute-list out command prevents networks from being advertised in
updates. The no distribute-list out command enables update advertisements.
Use the distribute-list out command to apply the access list to outgoing route
updates.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distribute-list <1-199> <1300-2699> out
no distribute-list <1-199> <1300-2699> out

Command Syntax

1-199 pre-defined access list number


1300-2699
out applies access list to outgoing route updates

Command Default
Disabled

7-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

graceful-restart-period
The graceful-restart-period command enables RIP graceful restart. Graceful restart
allows a RIP router to stay on the forwarding path even as its RIP software is being
restarted. As the graceful restart procedure executes, the RIP routing table is updated
with recalculated route entries that replace older entries in the routng table which are
marked with a “replicated” flag. RIP graceful restart has a configurable time period
(in seconds) that must elapse before routing table updates are completed and entries
with the “replicated” flag are flushed from the routing table and the Fast Path
database. The no graceful-restart-period command disables RIP graceful restart.

Group Access
ISP

Command Mode
Routing Configuration

Command Line Usage


graceful-restart-period <0-360>
no graceful-restart-period <0-360>

Command Syntax

0-360 the time period, in seconds, for


completion of RIP graceful restart
following an SRM switchover

Command Default
180 seconds

Compass ID: 188656176 Version 5 MGBI 7-9


BSR 64000 Command Reference Guide Release 4.2.0

ip rip authentication key


The ip rip authentication key command enables RIP authentication on an interface
by specifying a password or group of passwords that can be used on that interface.
The no rip authentication key command deletes the associated password(s).

Note: Only RIP version 2 supports authentication.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip rip authentication key { 7 <WORD> | <Password>}
no ip rip authentication key <Password>

Command Syntax

7 specifies a that HIDDEN password will


follow
WORD the ENCRYPTED password: 18-50 hex digits
(even number of digits)
Password a plain text password with a 16 character
maximum

7-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

ip rip host-routes
The ip rip host-routes command enables sending or receiving host routes with RIP
version 1 for an interface. The no ip rip host-routes command disables sending or
receiving host routes with RIP version 1 for an interface.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip rip host-routes
no ip rip host-routes

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 7-11


BSR 64000 Command Reference Guide Release 4.2.0

ip rip message-digest-key md5


The ip rip message-digest-key md5 command enables RIP MD5 authentication. The
no ip rip message-digest-key command disables RIP MD5 authentication.
Use the ip rip message-digest-key md5 command to generate authentication
information when sending packets and to authenticate incoming packets. Neighbor
routers must have the same key identifier.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip rip message-digest-key <1-255> md5 { 7 <WORD> | <WORD>}
no ip rip message-digest-key <1-255> [md5 <WORD>]

Command Syntax

1-255 key identifier


7 WORD specifies a hidden RIP password will follow -
a RIP password is a string between 1 and 16
alphanumeric characters
WORD specifies a RIP password which is a string
between 1 and 16 alphanumeric characters

Command Default
Disabled

7-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

ip rip receive version


The ip rip receive version command configures an interface to only receive
packets from a specific version of the RIP protocol. Use the ip rip receive
version command to configure the interface to receive one or both RIP versions. The
no ip rip receive version command resets the RIP protocol version to RIP version 1
and 2.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip rip receive version {0, 1, 2}
no ip rip receive version {0, 1, 2}

Command Syntax

0 RIP version 1 and 2


1 RIP version 1 only
2 RIP version 2 only

Command Default
0

Compass ID: 188656176 Version 5 MGBI 7-13


BSR 64000 Command Reference Guide Release 4.2.0

ip rip send version


The ip rip receive version command configures an interface to only transmit
packets from a specific version of the RIP protocol. Use the ip rip receive
version command to configure the interface to transmit one or both RIP versions. The
no ip rip receive version command resets the RIP protocol version to RIP version 2.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip rip send version {0, 1, 2, 3}
no ip rip send version {0, 1, 2, 3}

Command Syntax

0 RIP 2 compatible
1 RIP version 1 only
2 RIP version 2 only
3 none

Command Default
2

7-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

ip split-horizon
The ip split-horizon command blocks route information from being advertised by a
router out any interface from which that information originated. Enabling
split-horizon optimizes communications among multiple routers, particularly when
links are broken. The no ip split-horizon disables split-horizon.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip split-horizon
no ip split-horizon

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 7-15


BSR 64000 Command Reference Guide Release 4.2.0

maximum-paths
The maximum-paths command specifies the maximum number of parallel routes an
IP routing protocol can support. The no maximum-paths command changes or
cancels the number of maximum paths.

Group Access
RESTRICTED

Command Mode
Router Configuration

Command Line Usage


maximum-paths <1-2>
no maximum-paths

Command Syntax

1-2 the maximum number of parallel routes

7-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

network
The RIP version of the network command enables networks for the routing process.
The no network command disables networks for the RIP routing process.

Note: If a network with RIP is not specified, the system does not advertise
the network in any RIP routes.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


network <A.B.C.D> [<A.B.C.D>]
no network <A.B.C.D [<A.B.C.D>]

Command Syntax

A.B.C.D IP address of directly connected networks


A.B.C.D associated IP address of the removed routes,
subnet mask

Compass ID: 188656176 Version 5 MGBI 7-17


BSR 64000 Command Reference Guide Release 4.2.0

offset-list
The offset-list command adds an offset to incoming and outgoing metrics to routes
learned via RIP. The offset value is added to the routing metric. An offset-list with an
interface slot/port is considered extended and takes precedence over an offset-list that
is not extended. The no offset-list command removes the offset for incoming and
outgoing metrics to routes learned via RIP.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


offset-list {1-99} [any] {in | out} <0-16> [cable <X/Y> | ethernet <X/Y >| gigaether
<X/Y> | pos <X/Y>]
no offset-list {1-99} [any] {in | out} <0-16> [cable <X/Y> | ethernet <X/Y >|
gigaether <X/Y> | pos <X/Y>]

Command Syntax

1-99 standard access-list-number, if 0, no action is


taken

any apply offset to all networks


in apply the offset to incoming metrics
out apply the offset list to outgoing metrics
0-16 positive offset to be applied to metrics for
networks matching the access list, if set to 0,
no action is taken
cable X/Y cable interface slot and MAC Domain
number to which the offset-list is applied
ethernet X/Y Ethernet interface slot number and port
number to which the offset-list is applied

7-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

gigaether X/Y Gigabit Ethernet interface slot number and


port number to which the offset-list is applied
pos X/Y POS interface slot number and port number to
which the offset-list is applied

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 7-19


BSR 64000 Command Reference Guide Release 4.2.0

output-delay
The output-delay command changes the inter-packet delay for RIP updates to ensure
that transmitted information is received by lower-speed routers. The no output delay
command removes the inter-packet delay for RIP updates.

Note: This command helps prevent the loss of routing table information.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


output-delay <8-50>
no output delay <8-50>

Command Syntax

8-50 time, in milliseconds, of multiple-packet RIP


update

Command Default
0

7-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

passive-interface
The passive-interface command disables an interface from sending route updates by
prohibiting packets from being transmitted from a specified port. When disabled, the
subnet continues advertising to other interfaces. The no passive-interface command
enables the interface to send route updates.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


passive-interface {cable <X/Y> | default | ethernet <X/Y> | gigaether <X/Y> |
loopback <1-255> | pos <X/Y>}
no passive-interface {cable <X/Y> | default | ethernet <X/Y> | gigaether <X/Y> |
loopback <1-255> | pos <X/Y>}

Command Syntax

cable X/Y cable interface slot and MAC Domain


number
default suppresses routing updates on all interfaces
ethernet X/Y Ethernet interface slot and port number
gigaether X/Y Gigabit Ethernet interface slot and port
number
loopback 1-255 Loopback interface number
pos X/Y POS interface slot and port number

Compass ID: 188656176 Version 5 MGBI 7-21


BSR 64000 Command Reference Guide Release 4.2.0

redistribute
The redistribute command redistributes routes from one protocol domain to another
routing domain. The no redistribute command disables route distribution from one
protocol domain to another routing domain.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


redistribute {bgp | connected | ospf [match {internal | external | external 1 |
external 2}] | static} [metric <1-16>] [route-map <WORD>]
no redistribute {bgp | connected | ospf [match {internal | external | external 1 |
external 2}] | static} [metric <1-16>] [route-map <WORD>]

Command Syntax

bgp BGP source protocol


connected established routes as result of IP enabled on
an interface
ospf OSPF source protocol
match the criteria by which OSPF routes are
redistributed into RIP.
internal routes that are internal to an autonomous
system
external routes external to an autonomous system, but
are imported into OSPF as either Type 1 or
Type 2 external route
external 1 routes that are external to an autonomous
system, but are imported into OSPF as Type 1
external route

7-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

external 2 routes that are external to an autonomous


system, but are imported into OSPF as Type 2
external route
static IP or RIP static routes
metric metric used for the redistributed route.
1-16 the RIP default metric
route-map route-map used to conditionally control the
route redistribution
WORD the name of the route-map

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 7-23


BSR 64000 Command Reference Guide Release 4.2.0

router rip
The router rip command enables the routing process for RIP. The no router rip
command disable the RIP routing process.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


router rip
no router rip

7-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

show ip rip database


The show ip rip database command displays RIP database routing table
information.The following is an example of typical screen output from the show ip
rip database command:

172.19.13.0 255.255.255.0 redistributed 172.17.1.1 m:1 t:0


10.10.0.0 255.255.255.0 redistributed 58.58.58.2 m:1 t:0
172.22.251.0 255.255.255.0 redistributed 58.58.58.2 m:1 t:0
172.22.244.0 255.255.252.0 redistributed 58.58.58.2 m:1 t:0
10.10.10.0 255.255.255.0 via 58.58.58.2 m:2 t:12
12.12.12.0 255.255.255.0 redistributed 172.17.1.1 m:1 t:0
50.0.0.0 255.0.0.0 auto summary 50.50.50.4 m:1 t:0
21.21.21.0 255.255.255.0 directly connected 21.21.21.1 m:1 t:0
58.0.0.0 255.0.0.0 auto summary 58.58.58.1 m:1 t:0
80.0.0.0 255.0.0.0 auto summary 80.80.80.4 m:1 t:0
4.4.4.0 255.255.255.0 directly connected 4.4.4.4 m:1 t:0
80.80.80.0 255.255.255.0 directly connected 80.80.80.4 m:1 t:0
172.22.0.0 255.255.0.0 redistributed 58.58.58.2 m:1 t:0
10.0.0.0 255.0.0.0 via 58.58.58.2 m:1 t:0
4.0.0.0 255.0.0.0 auto summary 4.4.4.4 m:1 t:0
58.58.58.0 255.255.255.0 directly connected 58.58.58.1 m:1 t:0
12.0.0.0 255.0.0.0 redistributed 172.17.1.1 m:1 t:0
172.19.0.0 255.255.0.0 redistributed 172.17.1.1 m:1 t:0
172.168.0.0 255.255.0.0 redistributed 58.58.58.2 m:1 t:0
21.0.0.0 255.0.0.0 auto summary 21.21.21.1 m:1 t:0
50.50.50.0 255.255.255.0 directly connected 50.50.50.4 m:1 t:0

Note: The show ip route rip command can be used to display RIP routes in
the routing table.

Group Access
ISP

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 7-25


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show ip rip database [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip rip database [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

7-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

source-port 520
The source-port 520 command enables UDP port 520 to be used by the RIP routing
process. The no source-port 520 command disables UDP port 520.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


source port 520
no source port 520

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 7-27


BSR 64000 Command Reference Guide Release 4.2.0

timers basic
The timers basic command configures RIP network timers. The no timers basic
command resets the network timer default.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


timers basic <update> <invalid> <flush>
no timers basic <update> <invalid> <flush>

Command Syntax

update clocks the interval between periodic routing


updates, generally set to 30 seconds - small
number of seconds added every time the timer
is sent, to prevent collisions.

1-4294967295

rate (in seconds) at which updates are sent.


This is the fundamental timing parameter of
the routing protocol.

7-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 RIP Commands

invalid interval in seconds, routing updates

1-4294967295

Interval of time (in seconds) after which a


route is declared invalid; it should be at least
three times the value of the update argument.
A route becomes invalid when there is an
absence of updates that refresh the route. The
route then enters into a holddown state. The
route is marked inaccessible and advertised as
unreachable. However, the route is still used
for forwarding packets.
flush number of seconds used before route removed
from routing

1-4294967295

Amount of time (in seconds) that must pass


before the route is removed from the routing
table; the interval specified should be greater
than the value of the invalid argument. If it is
less than this sum, the proper holddown
interval cannot elapse, which results in a new
route being accepted before the holddown
interval expires.

Command Default
update = 30 seconds
invalid = 180 seconds
flush = 300 seconds

Compass ID: 188656176 Version 5 MGBI 7-29


BSR 64000 Command Reference Guide Release 4.2.0

version
The version command specifies the routing RIP version. The no version command
disables the routing RIP version and resets the default.
Use the ip rip receive version and the ip rip send version commands to specify
versions per interface.

Note: The basic timers for RIP are adjustable, but must be the same for all
routers and servers on the network to execute a distributed, asynchronous
routing algorithm. When the route-timeout timer expires, the route is marked
invalid but is retained in the table until the route-flush timer expires.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


version {1 | 2}
no version

Command Syntax

1 RIP version 1
2 RIP version 2

Command Default
RIP receives version 1 and 2, but sends only version 1

7-30 MGBI Compass ID: 188656176 Version 5


8
OSPF Commands

Introduction
This chapter describes the Open Shortest Path First (OSPF) commands used with the
BSR 64000™.
OSPF is a link-state routing protocol that runs internally to a single Autonomous
System, such as an enterprise network. At the core of the OSPF protocol is a
distributed, replicated link-state database.
OSPF specifies a Link-state Advertisements (LSAs) that allow OSPF routers to
update each other about the LAN and WAN links to which they connected. OSPF
ensures that each OSPF router has an identical link-state database, except during
period of convergence. Using the link-state database, each OSPF router calculates its
IP routing table with the best routes through the network.

OSPF Command Descriptions


This section contains an alphabetized list and descriptions of the OSPF commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 8-1


BSR 64000 Command Reference Guide Release 4.2.0

area authentication
Use the area authentication command to enable authentication for an OSPF area to
Type 1, Type 2, simple password, as specified in RFC 1247, while specification of
Type 0 is assumed. Authentication type must match all routers and access servers in a
particular area. The no authentication command disables authentication for the
specified OSPF area.

Note: Ensure that the ip ospf authentication-key command is used to


specify a password, which must be the same for all OSPF routers on a
network, for communication to take place before the area authentication
command is issued. If area authentication is enabled with MD5 authentication
message-digest keyword, which is a type of password that must be
configured using the ip ospf message-digest-key command.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


area {<0-4294967295> | <A.B.C.D>} authentication [message-digest]
no area {<0-4294967295> | <A.B.C.D>} authentication [message-digest]
no area {<0-4294967295> | <A.B.C.D>}

Command Syntax

0-4294967295 OSPF area ID number in decimal format.


A.B.C.D OSPF area ID in IP address format
message-digest Enables MD5 authentication only on the area
specified by the area ID or IP address.

Command Default
No authentication

8-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

area default-cost
Use the area default-cost command to specify a cost metric for the default summary
route sent into the stub area by an area border router (ABR) only. The no area
default-cost command removes the specified cost for the default summary route sent
into a stub area.

Note: The area stub command is used in conjunction with the area
default-cost command to define a specified area as a stub area for all
routers and access servers attached to the area.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


area {<0-4294967295> | <A.B.C.D>} default-cost <0-65535>
no area {<0-4294967295> | <A.B.C.D>} default-cost <0-65535>

Command Syntax

0-4294967295 OSPF area ID number in decimal format.


A.B.C.D OSPF area ID in IP address format
0-65535 Outgoing OSPF cost metric for packets sent
from an interface, which is an unsigned 16-bit
integer from 0 to 65535.

Compass ID: 188656176 Version 5 MGBI 8-3


BSR 64000 Command Reference Guide Release 4.2.0

area nssa
Use the area nssa command to configure an area as a Not So Stubby Area (NSSA).
The no nssa command removes the NSSA configuration of an area.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


area {<0-4294967295> | <A.B.C.D>} nssa [default-information-originate]
[no-redistribution] [no-summary]
no area {<0-4294967295> | <A.B.C.D>} nssa [default-information-originate]
[no-redistribution] [no-summary]
no area {<0-4294967295> | <A.B.C.D>}

Command Syntax

0-4294967295 OSPF area ID number in decimal format.


A.B.C.D OSPF area ID in IP address format
default-information-originate Originates a Type 7 default into the NSSA
area on an NSSA Area Border Router (ABR)
only.
no-redistribution When router is NSSA ABR, the redistribute
command imports routes into normal areas,
but not into the NSSA area.
no-summary Does not send summary LSAs into NSSA.

Command Default
No NSSA area is defined.

8-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

area range
Use the area range command to consolidate routes for an Area Border Router (ABR)
only by advertising a single summary route that is advertised for each address range
that is external to the area. The no area range command removes summarized routes
for the ABR.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


area {<0-4294967295> | <A.B.C.D>} range <A.B.C.D> <A.B.C.D> [advertise |
not-advertise | <cr>]
no area {<0-4294967295> | <A.B.C.D>} range <A.B.C.D> <A.B.C.D> [advertise |
not-advertise ]
no area {<0-4294967295> | <A.B.C.D>}

Command Syntax

0-4294967295 OSPF area ID number in decimal format.


A.B.C.D OSPF area ID in IP address format
A.B.C.D IP address to match.
A.B.C.D Subnet mask.
advertise Sets address range status to advertise,
generates a Type 3 summary LSA.

not-advertise Sets address range status to DoNotAdvertise,


Type 3 summary LSA is suppressed, and the
component networks remain hidden from
other networks.

Compass ID: 188656176 Version 5 MGBI 8-5


BSR 64000 Command Reference Guide Release 4.2.0

area stub
Use the area stub command to configure an OSPF area as a stub area. A stub area
allows a default route, intra-area routes, and inter-area routes, but disallows
autonomous system (AS) external routes, virtual links, and Autonomous System
Boundary Router (ASBR) routes.

Note: If there is more than one router within a stub area, ensure that the area
that you are creating as a stub area is defined as a stub area on each of
these routers.

The optional area stub no-summary command argument is used to prevent an area
border router (ABR) from sending further Type 3 link-state advertisements (Lases)
into the stub area. Use the no area stub command to return the area that you defined
as a stub area to a non-stub OSPF area.

Group Access
ISP

Command Mode
Router configuration

Command Line Usage


area {<0-4294967295> | <A.B.C.D>} stub [no-summary]
no area {<0-4294967295> | <A.B.C.D>} stub
no area {<0-4294967295> | <A.B.C.D>}

Command Syntax

0-4294967295 OSPF area ID number in decimal format.


A.B.C.D OSPF area ID in IP address format
no-summary Prevents ABR from sending summary link
advertisements into the stub area.

8-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

area virtual-link
Use the area virtual link command to create a virtual link that connects an OSPF
area to the backbone area (area 0.0.0.0) without being physically connected to the
OSPF backbone area. Use the no area virtual-link command to delete the defined
OSPF virtual link.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


area {<0-4294967295> | <A.B.C.D>} virtual-link <A.B.C.D> [authentication-key
<WORD> | dead-interval <1-65535> | hello-interval <1-65535> |
message-digest-key <1-255> | retransmit-interval <1-65535> | transmit-delay
<1-8192>]
no area {<0-4294967295> | <A.B.C.D>} virtual-link <A.B.C.D>
[authentication-key <WORD> | dead-interval <1-65535> | hello-interval
<1-65535> | message-digest-key <1-255> | retransmit-interval <1-65535> |
transmit-delay <1-8192>]

Command Syntax

0-4294967295 OSPF area ID number in decimal format.


A.B.C.D OSPF area ID in IP address format
A.B.C.D Router ID IP address that associated with the
virtual link neighbor, 32-bit address.
authentication-key WORD Unencrypted cleartext password that is 1 to 8
characters in length.
dead-interval 1-65535 Number of seconds that the router does not
receive hello packets from its neighbor before
declaring the neighbor is down.

Compass ID: 188656176 Version 5 MGBI 8-7


BSR 64000 Command Reference Guide Release 4.2.0

hello-interval 1-65535 Time in seconds between hello packets on an


interface, value must be the same for all
routers and access servers attached to a
common network.
message-digest-key 1-255 OSPF MD5 authentication key.
retransmit-interval 1-65535 Expected round-trip delay between two
routers on the attached network, value must
be more than expected delay.

transmit-delay 1-8192 Approximate time to transmit an LSA packet.

Command Defaults

hello-interval = 10 seconds
retransmit-interval = 5 seconds
transmit-delay = 1 second
dead-interval = 40 seconds

8-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

auto-cost reference-bandwidth
The BSR OSPF routing process calculates the OSPF cost metric for an interface
according to the bandwidth of this interface. The cost of an interface depends on the
type of interface. OSPF uses a reference bandwidth of 100 Mbps for cost calculation.
The formula to calculate the cost is the reference bandwidth divided by interface
bandwidth.
Use the auto-cost reference-bandwidth command to set the automatic cost metric
that the OSPF routing process uses to differentiate the cost of multiple
high-bandwidth links.
Use the no auto-cost reference-bandwidth command to remove the OSPF cost
metric for a link.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


auto-cost reference-bandwidth <1-4294967>
no auto-cost reference-bandwidth <1-4294967>

Command Syntax

1-4294967 The reference bandwidth in Mbps.

Command Default
10 Mbps

Compass ID: 188656176 Version 5 MGBI 8-9


BSR 64000 Command Reference Guide Release 4.2.0

auto-virtual-link
Use the auto-virtual-link command to automatically detect and create OSPF virtual
links. The no auto-virtual-link command disables automatic detection and creation
of OSPF virtual links.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


auto-virtual-link
no auto-virtual-link

Command Default
Disabled

8-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

clear ip ospf
The clear ip ospf command resets an OSPF connection using a soft reconfiguration.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear ip ospf

Compass ID: 188656176 Version 5 MGBI 8-11


BSR 64000 Command Reference Guide Release 4.2.0

default-information originate
The default-information originate command generates a default route into an OSPF
routing domain by configuring the metric for redistributed routes and is used with the
redistribute command to redistribute routes into an OSPF routing domain so they are
included in an automatic Autonomous System Border Router (ASBR) summary.
The no default-information originate command removes default routes from the
OSPF routing domain.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


default-information originate [always | metric <0-16777214> | metric-type <1-2>]
no default-information originate [always] [metric <0-16777214>] [metric-type
<1-2>]

Command Syntax

always Always advertises the default route into the


OSPF domain regardless of whether the
routing table has a default route.
metric 0-16777214 OSPF default metric to generate a default
route.

metric type 1-2 External link type associated with the default
route advertised into the OSPF routing
domain, values are 1 and 2, 1 being
comparable to the link state metric and 2
larger than the cost of intra-AS path.

Command Default
Disabled

8-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

default-metric
The default metric feature is used to eliminate the need for separate metric definitions
for each routing protocol redistribution.The default-metric command forces the
OSPF routing protocol to use the same metric value for all distributed routes from
other routing protocols. The no default-metric command removes or changes the
default metric value for the OSPF routing protocol.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


default-metric <1-4294967295>
no default-metric

Command Syntax

1-4294967295 Default metric value.

Compass ID: 188656176 Version 5 MGBI 8-13


BSR 64000 Command Reference Guide Release 4.2.0

distance
The distance command sets all 3 OSPF distances for routes to the same
administrative value. The no distance command disables the administrative distance
for routes.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distance <1-255>
no distance <1-255>

Command Syntax

1-255 administrative distance for setting routes

Command Default
120

8-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

distance ospf
The distance ospf command defines OSPF route administrative distances based on
route type. The no distance ospf command deletes OSPF route administrative
distances based on route type.
Use the distance ospf command to set a distance for a group of routers, as opposed to
any specific route passing an access list. The distance ospf command serves the same
function as the distance command used with an access list.
Use the distance ospf command when OSPF processes have mutual redistribution, to
choose internal routes from one external route to another.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distance ospf intra-area <1-255> inter-area <1-255> external
<1-255>
no distance ospf intra-area <1-255> inter-area <1-255> external
<1-255>

Command Syntax

intra-area 1-255 sets distance for all routes within an area,


default value 110
inter-area 1-255 sets distance for all routes from one area to
another area, default value 110
external 1-255 sets distance for routes learned by
redistribution from other routing domains

Compass ID: 188656176 Version 5 MGBI 8-15


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
intra-area distance = 110
inter-area distance = 110
external distance = 110

8-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

distribute-list
Use the distribute-list command to filter networks received and sent in routing
updates and networks suppressed in routing updates by using access lists. The
networks that are permitted or denied are defined in access lists. The no
distribute-list command removes access list from an incoming or outgoing routing
update.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distribute-list {<1-199> | <1300-2699>} {in | out}
no distribute-list {<1-199> | <1300-2699>} {in | out}

Command Syntax

1-199 Access list number that is used to filter


incoming and outgoing routing updates.
1300-2699 Expanded range access list number that is
used to filter incoming and outgoing routing
updates.
in Filters incoming routing updates.
out Filters outgoing routing updates.

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 8-17


BSR 64000 Command Reference Guide Release 4.2.0

graceful-restart
The graceful-restart command enables the OSPF graceful restart feature.The
graceful restart feature allows an OSPF router to stay on the forwarding path even as
its OSPF software is being restarted. The no graceful-restart command disables
OSPF graceful restart.

Group Access
ISP

Command Mode
Routing Configuration

Command Line Usage


graceful-restart [restart-interval <1-1800>]
no graceful-restart [restart-interval <1-1800>]

Command Syntax

restart-interval 1-1800 the time period, in seconds, for


completion of the OSPF graceful
restart following an SRM switchover

8-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

helper-mode
The helper-mode command enables OSPF graceful restart helper mode on the BSR.
The no helper-mode command disables graceful restart helper mode on the BSR.
The BSR’s neighbors must cooperate in order for the OSPF restart to be graceful.
During graceful restart, the neighbor routers are running in "helper mode".
The helper mode relationship is on a per network segment basis. The BSR or another
router acting in helper mode monitors the network for topology changes, and as long
as there are none, continues to advertise its LSAs as if the restarting router had
remained in continuousoperation. If the restarting router was also the Designated
Router on the network segment when the helper relationship began, the helper router
assumes the Designated Router until the helping relationship is terminated and the
restarting router is re-established as the Designated Router.

Note: The helper mode command only enables/disables helper mode on the
BSR. Neighboring routers must support helper mode and have helper mode
enabled locally for graceful restart to be fully operational on the network.

Helper mode and OSPF graceful restart are independent. You can disable
graceful restart in the configuration, but still allow the router to cooperate with
a neighbor attempting to restart gracefully.

Group Access
ISP

Command Mode
Routing Configuration

Command Line Usage


helper-mode [<A.B.C.D> | grace-period <1-1800> | strict-lsa-checking ]
no helper-mode [<A.B.C.D> | grace-period <1-1800> | strict-lsa-checking ]

Compass ID: 188656176 Version 5 MGBI 8-19


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D neighbor router ID


grace-period 1-1800 specifies the helper mode grace
period in seconds - a grace period is
set to specify the time period for
which the neighbors should consider
the restarting router as part of the
topology
strict-lsa-checking specifies helper mode strict LSA
checking - strict LSA checking
indicates whether or not an OSPF
restart helper should terminate
graceful restart when there is a
change to an LSA that would be
flooded to the restarting router or
when there is a changed LSA on the
restarting router's retransmission list
when graceful restart is initiated

Command Default
Enabled

8-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

ip ospf authentication-key
The ip ospf authentication-key command assigns a password for use by neighboring
OSPF routers that are using OSPF simple password authentication. The no ip ospf
authentication-key command deletes the password assigned for use by neighboring
OSPF routers that are using OSPF simple password authentication.

Note: All neighbor routers on the same network need the same password to
exchange OSPF information.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf authentication-key <WORD>
no ip ospf authentication-key <WORD>

Command Syntax

WORD character string up to 8 bytes in length

Compass ID: 188656176 Version 5 MGBI 8-21


BSR 64000 Command Reference Guide Release 4.2.0

ip ospf cost
The ip ospf cost command establishes a precise cost metric value for sending a packet
on an OSPF interface. The no ip ospf cost command disables a precise cost metric
value for sending the path cost to the default.
Use the ip ospf cost command to assign a cost metric value for a particular interface.
The user can set the metric manually if the default needs to be changed.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf cost <1-65535>
no ip ospf cost

Command Syntax

1-65535 the link state metric

8-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

ip ospf database-filter all out


The ip ospf database-filter all out command filters OSPF LSAs during
synchronization and flooding on the specified interface. The no ip ospf
database-filter all out command disables filtering OSPF LSAs during
synchronization and flooding on the specified interface.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf database-filter all out
no ip ospf database-filter all out

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 8-23


BSR 64000 Command Reference Guide Release 4.2.0

ip ospf dead-interval
The ip ospf dead-interval command sets the number of seconds during which the
router hello packets are not seen before the neighboring routers consider the router to
be down. The no ip ospf dead-internal removes the number of seconds set during
which the router hello packets are not seen before the neighboring routers consider the
router to be down.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf dead-internal <1-65535>
no ip ospf dead-internal

Command Syntax

1-65535 integer that specifies the interval - the value


must be the same for all routers on the
network

Command Default
40

8-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

ip ospf hello-interval
The ip ospf hello-interval command sets the number of seconds between hello
packets send by a router on the interface. The no ip ospf hello-interval command
resets the number of seconds between hello packets sent by a router on an interface to
the default value.
Use the ip ospf hello-interval command as a form of keepalive used by routers in
order to acknowledge their existence on a segment.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf hello-interval <1-65535>
no ip ospf hello-interval

Command Syntax

1-65535 integer that specifies the interval, value must


be the same for all nodes on the network

Command Default
10

Compass ID: 188656176 Version 5 MGBI 8-25


BSR 64000 Command Reference Guide Release 4.2.0

ip ospf message-digest-key
The ip ospf message-digest-key command enables OSPF MD5 authentication. The
no ip ospf message-digest-key command disables OSPF MD5 authentication.
Use the ip ospf message-digest-key md5 command to generate authentication
information when sending packets and to authenticate incoming packets. Neighbor
routers must have the same key identifier.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf message-digest-key <1-255> md5 <WORD>
no ip ospf message-digest-key <1-255>

Command Syntax

1-255 key identifier


WORD OSPF password, string between 1 and 16
alphanumeric characters

Command Default
Disabled

8-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

ip ospf network
The ip ospf network command configures the OSPF network type to a type other
than the default for a given media. The no ip ospf network command returns to the
default network type.

Group Access

All

Command Mode

Interface Configuration

Command Line Usage

ip ospf network [ broadcast | point-to-point]


no ip ospf network

Command Syntax

broadcast specifies an OSPF broadcast multi-access


network
point-to-point specifies an OSPF point-to-point network -
OSPF point-to-point networks reduces the
time it takes for designated router election
and peering

Command Default

Dependant upon the network type.

Compass ID: 188656176 Version 5 MGBI 8-27


BSR 64000 Command Reference Guide Release 4.2.0

ip ospf priority
The ip ospf priority command sets router priority to aid in determining the OSPF
designated router for a network. The no ip ospf priority command changes priority to
aid in determining the OSPF designated router for a network to the default value.
Use the ip ospf priority command value to configure OSPF broadcast networks. The
router with a higher priority takes precedence when attempting to become the
designated router. If the routers share the same priority, router ID takes precedence.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf priority <0-255>
no ip ospf priority <0-255>

Command Syntax

0-255 the priority value

Command Default
1

8-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

ip ospf retransmit-interval
The ip ospf retransmit-interval command establishes the number of seconds
between LSAs retransmissions for adjacencies belonging to an OSPF interface. The
no ip ospf retransmit-interval command changes the number of seconds between
LSA retransmissions for adjacencies belonging to an OSPF interface to the default
value.
Use the ip ospf retransmit-interval command to establish the time a router sends an
LSA to its neighbor. The neighbor keeps the LSA until it receives the
acknowledgement.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf retransmit-interval <1-3600>
no ip ospf retransmit-interval

Command Syntax

1-3600 the amount of time between LSA


retransmissions in seconds

Command Default
5

Compass ID: 188656176 Version 5 MGBI 8-29


BSR 64000 Command Reference Guide Release 4.2.0

ip ospf transmit-delay
The ip ospf transmit-delay command sets the approximate amount of time to
transmit an LSA retransmissions for adjacencies belonging to an OSPF interface. The
no ip ospf transmit-delay command changes the approximate amount of time set to
transmit an LSA retransmissions for adjacencies belonging to an OSPF interface.
Use the ip ospf transmit-delay command to enable the delay over a link. The delay is
defined as the time that it takes for the LSA to propagate over a link.
Before transmission, LSAs in the update packet must have their ages incremented by
the amount specified in the seconds argument. The value should take into account the
transmission and propagation delays for the interface.
If the delay is not added before transmission over a link, the time in which the LSA
propagates over the link is not considered. Significance is greater on low-speed links.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf transmit-delay <1-3600>
no ip ospf transmit-delay

Command Syntax

1-3600 the time it takes to transmit an LSA in


seconds

Command Default
1

8-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

maximum-paths
The maximum-paths command specifies the maximum number of parallel routes an
IP routing protocol can support. The no maximum-paths command changes or
cancels the number of maximum paths.

Group Access
RESTRICTED

Command Mode
Router Configuration

Command Line Usage


maximum-paths <1-2>
no maximum-paths

Command Syntax

1-2 the maximum number of parallel routes

Compass ID: 188656176 Version 5 MGBI 8-31


BSR 64000 Command Reference Guide Release 4.2.0

moto-nsf
The BSR 64000 supports Non Stop Forwarding (NSF) of network traffic during an
SRM switchover based on its High Availability Routing architecture. NSF is required
to maintain data integrity for critical applications such as streaming video and voice.
If OSPF has been selected to route video and voice traffic, the BSR’s OSPF graceful
restart feature and NSF architecture would be the optimal choice to ensure no packet
loss during an SRM switchover. However, in a network that includes devices that do
not support OSPF graceful restart, there would be an interruption in network traffic
during an SRM switchover.
The moto-nsf command enables the moto-nsf feature which allows a router that does
not support OSPF graceful restart to continue forwarding data as its OSPF software is
being restarted. Like OSPF graceful restart, the moto-nsf restart process prevents the
router running OSPF from losing adjacency, maintains the protocol’s previous state,
and allows OSPF routes to be relearned after the SRM switchover is completed. The
no moto-nsf command disables the moto-nsf feature.

Note: If OSPF graceful restart and/or its helper mode is enabled on the BSR
with the graceful-restart and/or helper-mode commands, moto-nsf must be
disabled. If moto-nsf is enabled on the BSR, OSPF graceful restart and/or its
helper mode must be disabled. A warning notifying a user of this rule will be
printed to the console.

Group Access
ISP

Command Mode
Routing Configuration

Command Line Usage


moto-nsf [restart-interval <1-1800>]
no moto-nsf [restart-interval <1-1800>]

8-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

Command Syntax

restart-interval 1-1800 the time period, in seconds, for


completion of the OSPF restart
process following an SRM
switchover

Command Defaults
Disabled
restart-interval = 120 seconds

Compass ID: 188656176 Version 5 MGBI 8-33


BSR 64000 Command Reference Guide Release 4.2.0

network area
The network area command defines the interfaces and area ID on which OSPF runs.
The no network area command deletes the interfaces and area ID on which OSPF
runs.
Use the network area command to cover IP address(es) for OSPF to operate on an
interface. Use the address and wildcard-mask as one command to define one or more
interfaces for an intended area.
A subnet address may be designated as the area ID if associated areas are used with IP
subnets. Each IP subnet is associated with a single area only.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


network <A.B.C.D> <A.B.C.D> area {<0-4294967295> | <A.B.C.D>}
no network <A.B.C.D> <A.B.C.D> area {<0-4294967295> | <A.B.C.D>}

Command Syntax

A.B.C.D Network IP address.


A.B.C.D IP address type mask with wild card bits
0-4294967295 OSPF area ID as a decimal value
A.B.C.D OSPF area ID as an IP address if OSPF areas
are associated with IP subnets

Command Default
Disabled

8-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

passive-interface
The passive-interface command disables an interface from sending route updates by
prohibiting packets from being transmitted from a specified port. When disabled, the
subnet continues advertising to other interfaces. The no passive-interface command
enables the interface to send route updates.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


passive-interface {cable <X/Y> | ethernet <X/Y> | gigaether <X/Y>| loopback
<1-255> | pos <X/Y>}
no passive-interface {cable <X/Y> | ethernet <X/Y> | gigaether <X/Y>| loopback
<1-255> | pos <X/Y>}

Command Syntax

cable X/Y cable interface slot and MAC Domain


number
ethernet X/Y Ethernet interface slot and port number
gigaether X/Y Gigabit Ethernet interface slot and port
number
loopback 1-255 Loopback interface number
pos X/Y POS interface slot and port number

Compass ID: 188656176 Version 5 MGBI 8-35


BSR 64000 Command Reference Guide Release 4.2.0

redistribute
The redistribute command redistributes routes from one protocol domain to another
routing domain. The no redistribute command disables route distribution from one
protocol domain to another routing domain.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


redistribute {bgp | connected | rip | static} [metric <1-16777215>] [metric-type
{1 | 2}] [route-map <WORD>] [subnets] [tag <0-4294967295>]
no redistribute {bgp | connected | rip | static} [metric <1-16777215>]
[metric-type {1 | 2}] [route-map <WORD>] [subnets] [tag <0-4294967295>]

Command Syntax

bgp BGP source protocol


connected established routes as result of IP enabled on
an interface
rip RIP source protocol
static IP or OSPF static routes

metric 1-16777215 metric used for the redistributed route.


metric-type 1 OSPF exterior metric type for redistributed
metric-type 2 routes

route-map WORD the name of the route-map used to


conditionally control the route redistribution
subnets consider subnets for redistribution into OSPF
tag 0-4294967295 set a 32-bit tag value for routes redistributed
into OSPF

8-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 8-37


BSR 64000 Command Reference Guide Release 4.2.0

rfc1583-compatible
The rfc1583-compatible enables RFC1583 preference rules on choosing
AS-External-LSAs during shortest path first (SPF) calculation according to RFC2328,
section 16.4. The no rfc1583-compatible command disables RFC1583 preference
rules on choosing AS-External-LSAs during SPF calculation according to RFC2238,
section 16.4.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


rfc1583-compatible
no rfc1583-compatible

Command Default
Disabled

8-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

router-id
The router-id command overrides a configured OSPF router identifier (IP address)
by manually configuring a new identifier. The no router-id command restores the
initial configuration.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


router-id <A.B.C.D>
no router-id

Command Syntax

A.B.C.D the new OSPF router identifier (IP


address)

Compass ID: 188656176 Version 5 MGBI 8-39


BSR 64000 Command Reference Guide Release 4.2.0

router ospf
The router ospf command enables an OSPF routing process. The no router ospf
command disables the OSPF routing process.
Use the router ospf command to designate an OSPF routing process with a unique
value.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


router ospf
no router ospf

8-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

show ip ospf
To display general information about OSPF routing processes, use the show ip ospf
command. The following is an example of typical screen output from the show ip
ospf command:

Routing Process OSPF with ID 150.31.94.1


Supports only single TOS(TOS0) routes
This is an autonomous system boundary router
SPF schedule delay 5 secs, Hold time between two SPFs 10 secs
Minimum LSA interval 5 secs. Minimum LSA arrival 1 secs
Number of external LSA 63
Number of areas in this router is 1. 1 normal 0 stub 0 nssa
Area 0.0.0.0
Number of interfaces in this area is 6
Area has no authentication
SPF algorithm executed 215 times
Routing for Networks:
150.31.0.0/16
Distance: 110 (default is 110)

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip ospf [network] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip ospf [network] [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 8-41


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

network shows IP OSPF network; displays network


area information
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

8-42 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

show ip ospf border-routers


The show ip ospf border-routers command displays the internal OSPF routing table
to an Autonomous System Boundary Router (ASBR), and an area border router
(ABR).

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip ospf border-routers [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip ospf border-routers} [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 8-43


BSR 64000 Command Reference Guide Release 4.2.0

show ip ospf database


The show ip ospf database command displays list of information related to the OSPF
database. The following is an example of typical screen output from the show ip ospf
database command:

OSPF Router with ID (150.31.94.1)

Router Link States (Area 0.0.0.0)

Link ID ADV Router Age Seq# Checksum Link count


150.31.1.21 150.31.1.21 1298 0x8000002B 0x4B90 11
150.31.11.1 150.31.11.1 1016 0x800000F2 0x68F 3
150.31.22.1 150.31.22.1 603 0x8000099D 0xFADD 5
150.31.39.7 150.31.39.7 1551 0x80000A19 0xCF11 4
150.31.62.1 150.31.62.1 49 0x800005BE 0xEA93 4

Network Link States (Area 0.0.0.0)

Link ID ADV Router Age Seq# Checksum


150.31.10.10 150.31.11.1 1685 0x800000B2 0x3F50
150.31.20.10 150.31.22.1 495 0x80000022 0x8F7
150.31.30.10 150.31.39.7 1951 0x80000022 0xD3F3
150.31.60.10 150.31.62.1 1413 0x80000022 0x9EE8
150.31.70.10 150.31.70.10 1717 0x800000E6 0xDABB

Type-5 AS External Link States


Link ID ADV Router Age Seq# Checksum Tag
150.31.1.0 150.31.1.21 1455 0x80000026 0x1C4F 3221225472
150.31.2.255 150.31.1.21 1392 0x80000026 0x1159 3221225472
150.31.40.255 150.31.1.21 63 0x80000027 0x6BD7 3221225472

Group Access
All

Command Mode
All Modes except User EXEC

8-44 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

Command Line Usage


show ip ospf [<0-4294967295>] database [A.B.C.D | adv-router <A.B.C.D> |
asbr-summary | database-summary | external | network | nssa-external | router |
self-originate | summary] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip ospf [<0-4294967295>] database [A.B.C.D | adv-router <A.B.C.D> |
asbr-summary | database-summary | external | network | nssa-external | router |
self-originate | summary] [ | {count | count-only}]

Command Syntax

0-4294967295 Assigned OSPF area ID number.

A.B.C.D router links, link state ID always the same as


the advertising router, network IP address,
value dependent upon advertisement LSA
type
adv-router Displays all LSAs for the specified
advertising router.
A.B.C.D Specifies the advertised router ID.
asbr-summary Autonomous System Boundary Router
(ASBR) summary.
database-summary summary of the OSPF database
external external LSAs
network network LSAs
nssa-external NSSA external LSA information
router router LSAs
self-originate LSAs from the local router

summary summary LSAs


| turns on output modifiers (filters)

Compass ID: 188656176 Version 5 MGBI 8-45


BSR 64000 Command Reference Guide Release 4.2.0

begin filter for output that begins with the specified


string
exclude filter for output that excludes the specified
string

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

8-46 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

show ip ospf interface


The show ip ospf interface command displays OSPF-related interface information.
The following is an example of typical screen output from the show ip ospf interface
command:

ethernet 7/0 is up, line protocol is up


Internet Address 150.31.90.10/24, Area 0.0.0.0
Router ID 150.31.94.1, Network Type BROADCAST, Cost: 10
Transmit Delay is 1 sec, State DR, Priority 1
Designated Router (ID) 150.31.94.1, Interface address 150.31.90.10
Backup Designated Router (ID) 150.31.1.21, Interface address 150.31.90.1
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Neighbor Count is 1, Adjacent neighbor count is 1
Adjacent with neighbor 150.31.1.21 (Backup Designated Router)

loopback 2 is up, line protocol is up


Internet Address 150.31.92.1/24, Area 0.0.0.0
Router ID 150.31.94.1, Network Type BROADCAST, Cost: 10
Transmit Delay is 1 sec, State DR, Priority 1
Designated Router (ID) 150.31.94.1, Interface address 150.31.92.1
Backup Designated Router (ID) 0.0.0.0, Interface address 0.0.0.0
Timer intervals configured, Hello 10, Dead 40, Wait 40, Retransmit 5
Neighbor Count is 0, Adjacent neighbor count is 0

Group Access
All

Command Mode
All Modes except User EXEC

Command Line Usage


show ip ospf interface [<A.B.C.D> | cable <X/Y> | ethernet <X/Y> | gigaether
<X/Y> | loopback <1-255>| pos <X/Y> | tunnel <0-255>] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show ip ospf interface [<A.B.C.D> | cable <X/Y> | ethernet <X/Y> | gigaether
<X/Y> | loopback <1-255>| pos <X/Y> | tunnel <0-255>] [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 8-47


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D Interface IP address


cable X/Y OSPF information over the cable interface
slot and MAC Domain number
ethernet OSPF information over the Ethernet/
FastEthernet 802.3 interface
gigaether OSPF information over the Gigabit Ethernet
interface

loopback 1-255 OSPF information over the loopback


interface
pos OSPF information over the Packet Over
SONET interface
tunnel 0-255
X/Y BSR slot and port number (all interfaces
except the cable interface slot and MAC
Domain)
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

8-48 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

show ip ospf memory


The show ip ospf memory command displays OSPF memory usage information. The
following is an example of typical screen output from the show ip ospf memory
command:

OSPF Memory Usage


Mem Pool Free In-Use Hi-Water Mark
-----------------------------------------------------------
Gen256 499 1 69
Gen512 500 0 9
Gen1k 500 0 0
Gen2k 494 6 7
Gen16k 8 0 1
Lsd256 412 88 142
Lsa256 437 63 113
Lsa2k 191 9 15
Lsa16k 6 10 13

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip ospf memory [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip ospf memory [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 8-49


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

8-50 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

show ip ospf neighbor


The show ip ospf neighbor command displays information about all OSPF
neighbors. The following is an example of typical screen output from the show ip
ospf neighbor command:

Neighbor ID Pri State Dead Time Address


150.31.1.21 1 FULL/BDR 00:00:30 150.31.90.1

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


show ip ospf neighbor [<A.B.C.D>] [detail] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show ip ospf neighbor [<A.B.C.D>] [detail] [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 8-51


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D specific OSPF neighbor ID


detail list of neighbor information in detail
| turns on output modifiers (filters)

begin filter for output that begins with the specified


string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

8-52 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

show ip ospf network


The show ip ospf network command displays information about OSPF network
areas. The following is an example of typical screen output from the show ip ospf
network command:

network 150.31.0.0 0.0.255.255 area 0.0.0.0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip ospf network [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip ospf network [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 8-53


BSR 64000 Command Reference Guide Release 4.2.0

show ip ospf virtual-links


The show ip ospf virtual-links command displays parameters regarding the current
state of the OSPF virtual links.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip ospf virtual-links [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip ospf virtual-links [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

8-54 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 OSPF Commands

summary-address
The summary-address aggregates external routes at the border of the OSPF domain.
The no summary-address command deletes aggregated external routes at the border
of the OSPF domain.
Use the summary-address command to summarize routes from other routing
protocols that are redistributed to OSPF. The area range command summarizes
routes between OSPF areas.
The summary address command is responsible for an OSPF autonomous system
boundary router to advertise one external route as an aggregate. This applies to all
redistributed routes that the address covers.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


summary-address <A.B.C.D> <A.B.C.D> [tag <0-4294967295>]
no summary-address <A.B.C.D> <A.B.C.D> [tag <0-4294967295>]

Command Syntax

A.B.C.D summary address of range of addresses

A.B.C.D IP subnet mask for the summary route


tag 0-4294967295 tag value, can be used as a match value to
control redistribution

Command Default
All redistributed routes advertised separately

Compass ID: 188656176 Version 5 MGBI 8-55


BSR 64000 Command Reference Guide Release 4.2.0

timers spf
The timers spf command configures the amount of time between OSPF topology
change receipt and when it starts a shortest path first (SPF) calculation. This includes
the hold time between two consecutive SPF calculations. The no timers spf command
changes the configuration of the amount of time between OSPF topology changes
receipt and when it starts an SPF calculation and returns it to the default value.
Use the timers spf command to set the delay time and hold time to change routing to
a faster path.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


timers spf <0-65535> <0-65535>
no timers spf <0-65535> <0-65535>

Command Syntax

0-65535 time in seconds between receipt and SPF


0-65535 minimum time in seconds between two
consecutive SPF calculations

Command Default
SPF delay = 5 seconds
SPF hold time = 10 seconds

8-56 MGBI Compass ID: 188656176 Version 5


9
IGMP Commands

Introduction
This chapter describes the Internet Group Management Protocol (IGMP) commands
used with the BSR 64000™.
Internet Group Management Protocol (IGMP), part of the Internet Protocol (IP) suite,
is used between hosts and routers to report dynamic multicast group membership. IP
multicasting is the transmission of an IP datagram to a "host group" identified by a
single IP destination address. Multicasting directs the same information packets to
multiple destinations at the same time, versus unicasting, which sends a separate copy
to each individual destination. Because the destinations receive the same source
packet at once, delivery of the information takes place in a more timely manner.
As stated in RFC 1112, the membership of a host group is dynamic; that is, hosts may
join and leave groups at any time. There is no restriction on the location or number of
members in a host group, and a host may be a member of more than one group at a
time.
There are three types of messages structures supported by IGMP to communicate with
each other about the multicast traffic: “queries”, “reports”, and “leave group”
messages. Query messages are used to discover which hosts are in which multicast
groups. In response, the hosts sends a report message to inform the querier of a host’s
membership. (Report messages are also used by the host to join a new group). Leave
group messages are sent when the host wishes to leave the multicast group.

Compass ID: 188656176 Version 5 MGBI 9-1


BSR 64000 Command Reference Guide Release 4.2.0

Applications that implement IGMP effectively eliminate multicast traffic on segments


that are not destined to receive this traffic, thus limiting the overall amount of traffic
on the network.

IGMP Command Descriptions


This section contains an alphabetized list and descriptions of the IGMP commands
supported by the BSR.

9-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IGMP Commands

clear ip igmp counters


The clear ip igmp counters command clears IGMP statistics counters on a specific
router.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ip igmp counters

Compass ID: 188656176 Version 5 MGBI 9-3


BSR 64000 Command Reference Guide Release 4.2.0

ip igmp access-group
The ip igmp access-group command controls multicast groups that hosts can join.
The no ip igmp access-group command removes control and allows the hosts to join
all groups.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp access-group <1-99> <1300-1999>
no ip igmp access-group <1-99> <1300-1999>

Command Syntax

1-99 standard access list


1300-1999 standard access-list number (expanded range)

Command Default
any group allowed on interface

9-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IGMP Commands

ip igmp querier-timeout
The ip igmp querier-interval command configures the timeout prior to the time the
router takes over as the interface querier. The no ip igmp querier-timeout removes
the configured timeout prior to the time the router takes over as the interface querier,
and returns it to the default.

Note: Only after the querier has completed the last query, does the router
take over as the interface querier after a no ip igmp querier-timeout
command is issued.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp querier-timeout <1-3600>
no ip igmp querier-timeout <1-3600>

Command Syntax

1-3600 querier timeout value in seconds

Command Default
query value x 2

Compass ID: 188656176 Version 5 MGBI 9-5


BSR 64000 Command Reference Guide Release 4.2.0

ip igmp query-interval
The igmp query-interval command sets the interval in which the router sends out
IGMP queries for that interface. The no ip igmp query-interval command removes
the set interval in which the router send out IGMP queries for an interface and returns
it to the default value.
Use the ip igmp query-interval command to configure how often the router solicits
the IGMP report responses from all of the multicast hosts on the network.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp query-interval <1-3600>
no ip igmp query-interval <1-3600>

Command Syntax

1-3600 query interval in seconds

Command Default
125 seconds

9-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IGMP Commands

ip igmp query-max-response-time
The ip igmp query-max-response-time command sets the maximum response time
advertised in query. Use the no ip igmp query-max-response-time
command to remove the set maximum response time advertised in query
and return it to the default.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp query-max-response-time <1-255>
no ip igmp query-max-response-time <1-255>

Command Syntax

1-255 query response value in seconds

Command Default
10 seconds

Compass ID: 188656176 Version 5 MGBI 9-7


BSR 64000 Command Reference Guide Release 4.2.0

ip igmp static-group
The ip igmp static-group command connects, or configures, the router as a member
of a particular group on the interface. The no ip igmp static-group disassociates the
router from the group.
The ip igmp static-group command is used to give a host (that does not run IGMP)
membership in a multicast group.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp static-group <A.B.C.D>
no ip igmp static-group <A.B.C.D>

Command Syntax

A.B.C.D IP multicast group address that the router is


configured to be a member of

Command Default
Disabled

9-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IGMP Commands

ip igmp version
The ip igmp version command configures specific the IGMP version used on an
interface. The no ip igmp version removes the specific version used by the
interface and returns it to the default IGMP version.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp version { 1 | 2 | 3 }
no ip igmp version { 1 | 2 | 3 }

Command Syntax

1 IGMP Version 1
2 IGMP Version 2
3 IGMP Version 3

Command Default
Version 2

Compass ID: 188656176 Version 5 MGBI 9-9


BSR 64000 Command Reference Guide Release 4.2.0

ip igmp version1-querier
The ip igmp version1-querier command configures the router to act as the querier
for IGMPv1. This is done by manually assigning the IGMP querier. The no ip igmp
version1-querier command disables the router from acting as the querier.

Note: The interface is not effected when IGMPv2 is running on the interface.
It is recommended that only one querier is enabled in a network segment.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp version1-querier
no ip igmp version1-querier

Command Default
Disabled

9-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IGMP Commands

show ip igmp groups


The show ip igmp groups command displays multicast groups connected to a
specific router using IGMP. The show ip igmp groups command displays the
following IGMP group information:

Group Address multicast address


Interface interface reachable
Uptime hours, minutes, and seconds multicast known
Expires hours, minutes, and seconds until the entry is
removed from IGMP groups table
Last Reporter last host of multicast group

The following is an example of typical screen output from the show ip igmp groups
command:

IGMP Connected Group Membership

Group Address Interface Uptime Expires Last Reporter

150.255.255.254 Ethernet 3/0 1w0d 00:02:19 177.21.200.159

150.0.1.40 Ethernet 3/1 1w0d 00:02:15 177.21.200.1

150.0.1.40 Ethernet 9/0 1w0d never 179.69.214.251

150.0.1.1 Ethernet 9/1 1w0d 00:02:11 179.21.200.11

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 9-11


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show ip igmp groups [summary] [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]
show ip igmp groups [summary] [ | {count | count-only}]

Command Syntax

summary shows summary report of IGMP groups


| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

9-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IGMP Commands

show ip igmp interface


The show ip igmp interface command displays the multicast information for an
interface. The following is an example of typical screen output from the show ip
igmp interface command:

loopback 2
IGMP is disabled on interface 150.31.92.1

loopback 3
IGMP is disabled on interface 150.31.93.1

IGMP is disabled on interface 150.31.94.1

ethernet 7/0
IGMP is disabled on interface 150.31.90.10

ethernet 7/1
IGMP is disabled on interface 150.31.99.7

ethernet 15/0
IGMP is disabled on interface
ethernet 15/1
IGMP is disabled on interface
ethernet 15/2
IGMP is disabled on interface 150.31.98.10

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip igmp interface [groups | brief] [ | {begin | exclude | include} {<WORD>}
[ | {count | count-only}]]
show ip igmp interface [groups | brief] [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 9-13


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

groups multicast groups that are joined on each


interface
brief brief summary of IGMP interface
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

9-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IGMP Commands

show ip igmp statistics


The show ip igmp statistics command displays statistics for a specified IGMP
interface. The following is an example of typical screen output from the show ip
igmp statistics command:

IGMP statistics: Sent/Received


Total: 0/0, Format errors: 0/0, Checksum errors: 0/0
Host Queries: 0/0, Host Reports: 0/0
Bad Queries: 0/0, Bad Reports: 0/0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip igmp statistics [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip igmp statistics [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 9-15


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

9-16 MGBI Compass ID: 188656176 Version 5


10
VRRP Commands

Introduction
This chapter contains the Virtual Router Redundancy Protocol (VRRP) commands.
for the BSR 64000™.
VRRP specifies an election protocol that dynamically assigns responsibility for a
virtual router to one of the VRRP routers on a LAN. The VRRP router controlling the
IP address or addresses associated with a virtual router is called the Master, and
forwards packets sent to these IP addresses. The election process provides dynamic
failover in the forwarding responsibility if the Master becomes unavailable. This
allows any of the virtual router IP addresses on the LAN to be used as the default
first-hop router by end-hosts. VRRP provides a higher-availability default path
without requiring configuration of dynamic routing or router discovery protocols on
every end host.

VRRP Command Descriptions


This section contains an alphabetized list and descriptions of the VRRP commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 10-1


BSR 64000 Command Reference Guide Release 4.2.0

clear ip vrrp
The clear ip vrrp command resets all statistic counters of all virtual routers on all
interface, or on specific interfaces with specific Virtual Router ID (VRID).

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ip vrrp {* } {ethernet <X/Y> | gigaether <X/Y>} [<1-255>]

Command Syntax

* resets all statistics counters for all virtual


routers on all interfaces on this router
ethernet X/Y Ethernet interface slot and port number
gigaether X/Y Gigabit Ethernet interface slot and port
number
1-255 virtual router ID value

10-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VRRP Commands

ip vrrp
The ip vrrp command activates the VRRP protocol on all interfaces that are
configured to run VRRP. The no ip vrrp command de-activates the VRRP protocol
on all interfaces that are configured to run VRRP.
Use the ip vrrp command to enable all interfaces so that multiple virtual routers can
be enabled or disabled all at once.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip vrrp
no ip vrrp

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 10-3


BSR 64000 Command Reference Guide Release 4.2.0

ip vrrp (virtual router ID)


The ip vrrp (virtual router ID) command creates a virtual router. The no ip vrrp
(virtual router ID) command deletes the virtual router with ID from the interface.
Use the ip vrrp (virtual router ID) command to specify and associate the virtual
router.
Each virtual router group selects its own Master and Backups independently of other
virtual router groups. Each individual virtual router has a unique virtual MAC address
and virtual IP addresses.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255>
no ip vrrp <1-255>

Command Syntax

1-255 the ID of the virtual router to configure

10-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VRRP Commands

ip vrrp address
The ip vrrp address command specifies virtual IP address or addresses for a virtual
router. The no ip vrrp removes the specified virtual IP address or addresses for a
virtual router.
Use the ip vrrp address command to configure IP addresses for virtual routers.
VRRP is not enabled for the virtual router until at least one IP address has been
specified. If one or more IP addresses are specified, then the addresses will be used as
the designated ip addresses among routers associating with the virtual router.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> address <A.B.C.D> [...<A.B.C.D>]
no ip vrrp <1-255> address [<A.B.C.D>] [...<A.B.C.D>]

Command Syntax

1-255 identification number of a configured virtual


router
A.B.C.D specifies one virtual IP address
...A.B.C.D specifies additional virtual IP addresses

Compass ID: 188656176 Version 5 MGBI 10-5


BSR 64000 Command Reference Guide Release 4.2.0

ip vrrp authentication key


The ip vrrp authentication key command specifies the authentication string for use
with the authentication type, text only. The no ip vrrp authentication key command
removes the specified authentication string for use with the authentication type, text
only.
Use the ip vrrp authentication key command to set a simple text key in VRRP
messages. The unencrypted authentication string is transmitted for authentication type
simple text in all VRRP protocol messages. The same authentication string must be
configured on all routers for a virtual router. Authentication mismatch will not prevent
a router from taking over as the designated Master. Authentication mismatch will
cause VRRP to stop working properly for a virtual router due to authentication failure,
and results in lack of communication between virtual routers.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> authentication key <WORD>
no ip vrrp <1-255> authentication key

Command Syntax

1-255 the identification number of a configured


virtual router
WORD an authentication key string of up to 8
characters

10-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VRRP Commands

ip vrrp authentication type


The ip vrrp authentication type command specifies the type of authentication to use
for the given virtual router on the configured interface. The no ip vrrp
authentication type command removes the specified type of authentication to use for
the given virtual router on the configured interface.
The same authentication type must be configured on all routers for a given virtual
router. Authentication mismatch will not prevent a router from taking over as the
designated Master. Authentication mismatch may cause VRRP not to work properly
for a given virtual router due to authentication failure, and results in lack of
communication between virtual routers.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> authentication type {text}
no ip vrrp <1-255> authentication type

Command Syntax

1-255 the identification number of a configured


virtual router
text ip vrrp 4 authentication type authentication
type can be simple text

Command Default
No authentication

Compass ID: 188656176 Version 5 MGBI 10-7


BSR 64000 Command Reference Guide Release 4.2.0

ip vrrp enable
The ip vrrp enable command enables a given virtual router on a configured interface.
The no vrrp enable command disables a given virtual router on a configured
interface.
Use the ip vrrp enable command to bring up a specific VRRP router on the given
interface if the interface is being enabled. This command brings the VRRP router to
either Backup or Master when the router is being enabled (if at least one IP address is
configured for the virtual router).

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> enable
no ip vrrp <1-255> enable

Command Syntax

1-255 the identification number of a configured


virtual router

Command Default
Enabled

10-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VRRP Commands

ip vrrp preempt
The ip vrrp preempt command indicates whether a higher priority Backup can
pre-empt a lower priority Master. The no ip vrrp preempt command disables
pre-emption of a lower priority Master by a higher priority Backup.
If the router owns the IP address or addresses associated with the virtual router, the
Master will always pre-empt, regardless of this command setting.
To determine which of the routers should be allowed to pre-empt, use the ip vrrp
preempt command for virtual routers that have IP addresses that do not belong to any
router interface.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> preempt
no ip vrrp <1-255> preempt

Command Syntax

1-255 the identification number of a configured


virtual router

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 10-9


BSR 64000 Command Reference Guide Release 4.2.0

ip vrrp priority
The ip vrrp priority command specifies the priority of the router to act as Master for
a given virtual router. The no ip vrrp priority command restores the default priority
value of the router.
Use the ip vrrp priority command to select a Master when multiple routers are
associated with the same virtual router. If two routers have the same priority, their
primary IP address is compared, and the router with the higher IP address value takes
precedence. A priority of 255 is reserved for VRRP routers that own the virtual IP
address. Therefore, during configuration, if the router owns that IP address, priority is
automatically set to 255 and cannot be changed. Value 0 is also reserved for Master to
indicate the relinquishing of responsibility of the virtual router, and cannot be
configured either.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> priority <1-254>
no ip vrrp <1-255> priority

Command Syntax

1-255 the identification number of a configured


virtual router
priority 1-254 priority value to set for the virtual router

Command Default
100

10-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VRRP Commands

ip vrrp primary-ip
The ip vrrp primary-ip command configures the primary IP address for a virtual
router. The no ip vrrp primary-ip command resets the primary IP address to the
smallest value among all real interface addresses for the given interface.
Use the ip vrrp primary-ip to configure the primary IP address for a virtual router.

Note: VRRP advertisements are always sent using the primary IP address as
the source of the IP packet.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> primary-ip <A.B.C.D>
no ip vrrp <1-255> primary-ip

Command Syntax

1-255 the identification number of a configured


virtual router
A.B.C.D IP address to be set as source of outgoing IP
packet

Command Default
The smallest IP address value among all valid IP addresses of the given interface

Compass ID: 188656176 Version 5 MGBI 10-11


BSR 64000 Command Reference Guide Release 4.2.0

ip vrrp timer
The ip vrrp timer command specifies the time interval that the Master should send
VRRP advertisement messages. The no ip vrrp timer command restores the default.
All VRRP routers are associated with a particular virtual router, and must use the
same advertisement interval to have VRRP run properly.

Note: The system is configured to send VRRP advertisements every 3


seconds for the virtual router on the configured interface Ethernet 1/0, if the
router is configured as the Master for the virtual router 1. If not, this interval is
used as the factor to determine if the Master is down, if the router is
configured as Backup for virtual router 1.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> timer <1-255>
no ip vrrp <1-255> timer

Command Syntax

1-255 the identification number of a configured


virtual router
timer 1-255 advertisement interval in seconds

Command Default
1 second

10-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VRRP Commands

ip vrrp verify-availability
The ip vrrp verify-availability command configures one or more ip addresses for a
virtual router to monitor as critical link states. The no ip vrrp verify-availability
command deletes one or more of the designated IP address from the virtual router.
Use the ip vrrp verify-availability command to configure a virtual router to monitor
a link state of another interface. If a virtual router is not monitoring any link state
where no IP address is configured for verify-availability, the virtual router will
continue as usual. If one or more IP addresses is configured for monitoring, and all of
the monitored links are down, the virtual router is brought down automatically. The
Master relinquishes responsibility by sending an advertisement 0. If at least one link
of all monitored IP addresses being monitored comes back up, the associated virtual
router will be brought back up automatically.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip vrrp <1-255> verify-availability <A.B.C.D> [...<A.B.C.D>]
no ip vrrp <1-255> verify-availability <A.B.C.D> [...<A.B.C.D>]

Command Syntax

1-255 the identification of a configured virtual


router number
A.B.C.Ds IP address this virtual router monitors
...A.B.C.D additional IP addresses that this virtual router
monitors

Compass ID: 188656176 Version 5 MGBI 10-13


BSR 64000 Command Reference Guide Release 4.2.0

show ip vrrp
The show ip vrrp command displays detailed status information on all virtual routers
that are configured for VRRP. The following is an example of typical screen output
from the show ip vrrp command:

VRRP Global Statistic:


Recv: 0 checksum errors, 0 bad version
0 bad vrid, 0 bad packet size

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


show ip vrrp [ethernet <X/Y> [<1-255>]] [ gigaether <X/Y> [1-255>]] [summary]

Command Syntax

ethernet X/Y Ethernet interface slot and port number


gigaether X/Y Gigabit Ethernet interface slot and port
number
1-255 identification number of a configured virtual
router
summary summary information for all VRRP routers
configured on all interfaces

10-14 MGBI Compass ID: 188656176 Version 5


11
IP Multicast Commands

Introduction
This chapter describes the IP Multicast Protocol commands used with the BSR. This
chapter contains the following sections on the Multicast Routing Table Manager
(MRTM), and Multicast Forwarding Manager (MFM) protocols.
■ MRTM Command Descriptions
■ MFM Command Descriptions

MRTM Command Descriptions


Unlike traditional Internet traffic that requires separate connections for each
source-destination pair, IP Multicasting allows many recipients to share the same
source. The IP Multicast protocol sends data to distributed servers on the multicast
backbone, and MRTM allows different IP protocols to work together on the same
router. This means that just one set of packets is transmitted for all destinations.
MRTM also manages Distance Vector Multicast Routing Protocol (DVMRP) and
Multicast Open Shortest Path First (MOSPF), and provides multicast routing support
for Resource Reservation Protocol (RSVP). For large amounts of data, IP Multicast is
more efficient than normal Internet transmissions because the server can broadcast a
message to many recipients simultaneously. This section contains an alphabetized list
and descriptions of the MRTM IP multicast commands supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 11-1


BSR 64000 Command Reference Guide Release 4.2.0

ip mroute
The ip mroute command configures an IP multicast static route. The no ip mroute
command removes the configuration of an IP multicast static route.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip mroute <A.B.C.D> <A.B.C.D> <A.B.C.D> [<1-255>]
no ip mroute <A.B.C.D> <A.B.C.D> <A.B.C.D> [<1-255>]

Command Syntax

A.B.C.D static source address


A.B.C.D static network mask
A.B.C.D RPF neighbor address or route
1-255 administrative distance for mroute

11-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Multicast Commands

ip mroute static distance


The ip mroute static distance command configures a static multicast route. The
no ip mroute static distance command removes the route.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip mroute static distance <1-255>
no ip mroute static distance <1-255>

Command Syntax

1-255 the administrative distance for the multicast


route - a lower distance has preference

Compass ID: 188656176 Version 5 MGBI 11-3


BSR 64000 Command Reference Guide Release 4.2.0

ip mroute unicast distance


The ip mroute unicast distance command configures a unicast multicast route.
The no ip mroute unicast distance command removes the route.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip mroute unicast distance <1-255>
no ip mroute unicast distance <1-255>

Command Syntax

1-255 the administrative distance for the multicast


route - a lower distance has preference

11-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Multicast Commands

ip multicast-routing
The ip multicast-routing command enables IP multicast routing. The no ip
multicast-routing command disables IP multicast routing. This command is used
with multicast routing protocols, such as DVMRP.

Note: Multicast packets are not forwarded unless IP multicast routing is


enabled.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip multicast-routing
no ip multicast-routing

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 11-5


BSR 64000 Command Reference Guide Release 4.2.0

show ip rpf
The show ip rpf command displays how IP multicast routing does Reverse Path
Forwarding (RPF).

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip rpf <A.B.C.D>

Command Syntax

A.B.C.D displays RPF information for a specified


source address

11-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Multicast Commands

MFM Command Descriptions


MFM supports multicast tools for tracing routes, maintains a multicast forwarding
cache and forwards multicast traffic. To forward multicast traffic, each multicast
routing protocol must register with the MFM with the APIs for inbound check and
outbound check. Parameters such as cache age for the flow, and a time-to-live value
for the interface being registered, is included. When MFM receives a data packet that
does not have a multicast forwarding cache, the MFM will call the protocol check
inbound function, and check the outbound function to the registered protocol to
determine the cache.
This section contains an alphabetized list and descriptions of the MFM commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 11-7


BSR 64000 Command Reference Guide Release 4.2.0

clear ip multicast fwd-cache


The clear ip multicast fwd-cache command clears the IP multicast forwarding cache
table.
Use the clear ip multicast fwd-cache command to clear the multicast forwarding
table which is built from the multicast forwarding cache, and then used for forwarding
traffic. Once cleared, the Multicast Forwarding Manager regenerates the cache when
multicast traffic is received.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ip multicast fwd-cache

11-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Multicast Commands

clear ip multicast proto-cache


The clear ip multicast proto-cache command clears the IP multicast protocol cache
and also clears the IP multicast forwarding cache.

Note: The MFM manager regenerates the multicast protocol cache when
multicast traffic is received.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ip multicast proto-cache

Compass ID: 188656176 Version 5 MGBI 11-9


BSR 64000 Command Reference Guide Release 4.2.0

mtrace
The mtrace command traces the path from a multicast source to a multicast
destination branch of a multicast distribution tree.

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


mtrace [<A.B.C.D (group)> | <A.B.C.D (hostname)> | <A.B.C.D (hostname)>]

Command Syntax

A.B.C.D (group) group address or group hostname


A.B.C.D (hostname) destination IP address or destination
hostname
A.B.C.D (hostname) source IP address or source hostname

Command Default
group address or group hostname = 224.2.0.1

11-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Multicast Commands

show ip multicast cache-summary


The show ip multicast cache-summary command displays the number of multicast
flows currently passing through the router. The following is an example of typical
screen output from the show ip multicast cache-summary command:

Total number of protocol cache: 0


Total number of forwarding cache: 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip multicast cache-summary

Compass ID: 188656176 Version 5 MGBI 11-11


BSR 64000 Command Reference Guide Release 4.2.0

show ip multicast fwd-cache


The show ip multicast fwd-cache command displays all of the multicast forwarding
cache on a source group basis.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip multicast fwd-cache [<A.B.C.D>] [<A.B.C.D>] [ physical ]

Command Syntax

A.B.C.D only displays the cache for this source or


group address
A.B.C.D only displays the cache for this specified
source and group address
physical displays the cache only in relation to the
physical interface - if "physical" is not
specified, it will show up with relation to the
logical interface.

11-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Multicast Commands

show ip multicast interface


The show ip multicast interface command is used to list the IP address, multicast
protocol (PIM, DVMRP, or IGMP), and time-to-live (TTL) information that is
associated with each multicast interface.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip multicast interface [<A.B.C.D>]

Command Syntax

A.B.C.D display information only for this interface


address

Compass ID: 188656176 Version 5 MGBI 11-13


BSR 64000 Command Reference Guide Release 4.2.0

show ip multicast oi-fwd-cache


The show ip multicast oi-fwd-cache command is used to display multicast
forwarding cache entries that have outgoing interfaces (OIs).

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


show ip multicast oi-fwd-cache

11-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 IP Multicast Commands

show ip multicast no-oi-fwd-cache


The show ip multicast no-oi-fwd-cache command is used to display multicast
forwarding cache entries, which have no outgoing interfaces (OIs).

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip multicast no-oi-fwd-cache

Compass ID: 188656176 Version 5 MGBI 11-15


BSR 64000 Command Reference Guide Release 4.2.0

show ip multicast proto-cache


The show ip multicast proto-cache command is used to display multicast protocol
cache entries.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip multicast proto-cache [<A.B.C.D>] [<A.B.C.D>]

Command Syntax

A.B.C.D only displays the cache for this source or


group address
A.B.C.D only displays the cache for this specified
source and group address

11-16 MGBI Compass ID: 188656176 Version 5


12
DVMRP Commands

Introduction
This chapter contains the Distance Vector Multicast Routing Protocol (DVMRP)
commands used with the BSR 64000™.
DVMRP is the original IP Multicast routing protocol. It was designed to run over both
multicast LANs as well as non-multicast routers. In this case, the IP Multicast packets
are tunneled through the routers as unicast packets. This replicates the packets and
affects performance, but provides intermediate solution for IP Multicast routing on
the Internet while router vendors decide to support native IP Multicast routing.

DVMRP Command Descriptions


This section contains an alphabetized list and descriptions of the DVMRP commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 12-1


BSR 64000 Command Reference Guide Release 4.2.0

ip dvmrp accept-filter
The ip dvmrp accept-filter command configures a filter for incoming DVMRP
reports. The no ip dvmrp accept-filter command removes configuration of a filter
for incoming DVMRP reports.
Use the ip dvmrp accept-filter command to configure filters to accept and deny
DVMRP routes learned from this interface. The accepted routes are added to the
Multicast Routing Table.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dvmrp accept-filter <1-99>
no ip dvmrp accept-filter <1-99>

Command Syntax

1-99 accept filter number

Command Default
Accepts destination reports from all neighbors.

12-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

ip dvmrp default-information originate


The ip dvmrp default-information originate command advertises network 0.0.0.0
to DVMRP neighbors and the multicast backbone. The no ip dvmrp
default-information originate command prevents network 0.0.0.0. from being
advertised to DVMRP neighbors and the multicast backbone.
Use the ip dvmrp default-information originate command with the ip dvmrp
metric-offset command to configure the metric used when advertising the default
route 0.0.0.0.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dvmrp default-information originate [only]
no ip dvmrp default-information originate

Command Syntax

only the default DVMRP route is distributed to


neighbors only

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 12-3


BSR 64000 Command Reference Guide Release 4.2.0

ip dvmrp metric-offset
The ip dvmrp metric-offset command modifies the metrics of the advertised
DVMRP routes. The no ip dvmrp metric-offset sets the modified metrics of the
advertised DVMRP routes to the default.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dvmrp metric-offset [in | out] <0-31>
no ip dvmrp metric-offset [in | out] <0-31>

Command Syntax

in 0-31 added increment value for incoming DVMRP


routes
out 0-31 added increment value for outgoing reports
for routes from the DVMRP routing table

Command Default
in = 1
out = 0

12-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

ip dvmrp output-report-delay
The ip dvmrp output-report-delay command configures transmission delays of a
DVMRP report. The no ip dvmrp output-report-delay command removes
configuration of transmission delays of a DVMRP report.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dvmrp output-report-delay <1-10> [<1-100>]
no ip dvmrp output-report-delay <1-10> [<1-100>]

Command Syntax

1-10 delay between each route report burst in


seconds
1-100 number of DVMRP reports in each burst

Command Default
Delay between each route report burst = 1 second
Number of DVMRP reports in each burst = 2

Compass ID: 188656176 Version 5 MGBI 12-5


BSR 64000 Command Reference Guide Release 4.2.0

ip dvmrp out-report-filter
The ip dvmrp out-report-filter command uses the assigned access list to filter the
outgoing DVMRP route report for the interface. The no ip dvmrp out-report-filter
command disables the use of the assigned access list to filter the outgoing DVMRP
route report for the interface.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dvmrp out-report-filter <1-99>
no ip dvmrp out-report-filter <1-99>

Command Syntax

1-99 out report filter number

Command Default
Disabled

12-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

ip dvmrp probe-interval
The ip dvmrp probe-interval command configures how often a query is sent to
neighboring multicast routers for DVMRP multicast routes. The no ip dvmrp
probe-interval command disables sending queries.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dvmrp probe-interval <5-3600>
no ip dvmrp probe-interval <5-3600>

Command Syntax

5-3600 probe interval in seconds

Compass ID: 188656176 Version 5 MGBI 12-7


BSR 64000 Command Reference Guide Release 4.2.0

ip dvmrp reject-non-pruners
The ip dvmrp reject-non-pruners command prevents peering with neighbors that do
not support DVMRP pruning or grafting. The no ip dvmrp reject-non-pruners
command enables peering with neighbors that do not support DVMRP pruning or
grafting.
Use the ip dvmrp reject-non-pruners command to configure the router for
nonpeering without the prune-capable flag set.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dvmrp reject-non-pruners
no ip dvmrp reject-non-pruners

Command Default
Disabled

12-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

ip dvmrp summary-address
The ip dvmrp summary-address command configures a DVMRP summary address
to be advertised out of the interface. The no ip dvmrp summary-address command
removes the configuration of a DVMRP summary address that is advertised out of the
interface.
Use the ip dvmrp summary-address command to advertise the summary address if
there is a more specific route in the multicast routing table that matches. The summary
is advertised with the metric value when specified.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dvmrp summary-address <A.B.C.D> <A.B.C.D> [metric <1-31>]
no ip dvmrp summary-address <A.B.C.D> <A.B.C.D> [metric <1-31>]

Command Syntax

A.B.C.D summary IP address advertised rather than a


more specific route
A.B.C.D mask on summary IP address
metric 1-31 metric value advertised with the summary
address

Command Default
metric = 1

Compass ID: 188656176 Version 5 MGBI 12-9


BSR 64000 Command Reference Guide Release 4.2.0

network
The network command specifies which IP interface should enable DVMRP. The no
network command removes the specified IP address to enable DVMRP.
Use the network command to be able to use a single command to define one or
multiple interfaces to be associated with DVMRP using both the prefix and
wildcard-mask arguments.
For DVMRP to operate on the interface, the specific IP address on the interface must
be covered by the network command.
This software sequentially evaluates the address/wildcard-mask pair for each
interface as follows:
■ The wildcard-mask is logically ORed with the interface IP address.
■ The wildcard-mask is logically ORed with address in the network command.
The software compares the two resulting values, and, if they match, DVMRP is
enabled on the associated interface.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


network <A.B.C.D> <A.B.C.D>
no network <A.B.C.D> <A.B.C.D>

Command Syntax

A.B.C.D IP address prefix, network type to broadcast


A.B.C.D IP address-type mask that includes don’t care
bits

12-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

router dvmrp
The router dvmrp command configures the DVMRP routing process. The no router
dvmrp command removes the DVMRP configured routing process.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


router dvmrp
no router dvmrp

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 12-11


BSR 64000 Command Reference Guide Release 4.2.0

show ip dvmrp information


The show ip dvmrp information command displays global DVMRP information.
The following is an example of typical screen output from the show ip dvmrp
information command:

DVMRP Summary Information


-------------------------

Full Update Interval : 60


Trigger Update Interval : 5
Route Expiration Timeout : 140
Number of Multicast Routes : 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dvmrp information

12-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

show ip dvmrp interface


The show ip dvmrp interface command displays information about interfaces with
DVMRP enabled.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dvmrp interface [statistics]

Command Syntax

statistics display DVMRP interface statistical


information

Compass ID: 188656176 Version 5 MGBI 12-13


BSR 64000 Command Reference Guide Release 4.2.0

show ip dvmrp neighbor


The show ip dvmrp neighbor command displays information about neighbors
discovered by DVMRP.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dvmrp neighbor [detail]

Command Syntax

detail detailed information about DVMRP


neighbors including neighbor address,
interface through which the neighbor is
reachable, and the number of routes learned
from the neighbor

12-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

show ip dvmrp network


The show ip dvmrp network command shows the DVMRP network configuration as
entered by the network command.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dvmrp network

Compass ID: 188656176 Version 5 MGBI 12-15


BSR 64000 Command Reference Guide Release 4.2.0

show ip dvmrp route


The show ip dvmrp route command displays the DVMRP routing table.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dvmrp route [entry <A.B.C.D> | neighbor <A.B.C.D>] [detail]

Command Syntax

entry A.B.C.D IP address of an entry in the routing table


neighbor A.B.C.D IP address of a neighbor in the routing table
detail displays detailed information

12-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

show ip dvmrp route hold-down


The show ip dvmrp route hold-down command displays all of the routes in the
DVMRP hold-down table.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dvmrp route hold-down

Compass ID: 188656176 Version 5 MGBI 12-17


BSR 64000 Command Reference Guide Release 4.2.0

show ip dvmrp summary-route


The show ip dvmrp summary-route command displays the configured DVMRP
summary address that is advertised for each interface.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dvmrp summary-route

12-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DVMRP Commands

show ip dvmrp tunnels


The show ip dvmrp tunnels command displays information about DVMRP
configured tunnels.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip dvmrp tunnels

Compass ID: 188656176 Version 5 MGBI 12-19


13
CMTS Commands

Introduction
This chapter describes the commands used to configure and manage the Cable
Modem Termination System (CMTS). The CMTS permits data to be transmitted and
received over a broadband cable TV (CATV) network. Downstream network data
traffic flows from the CMTS to connected cable modems (CMs), and upstream
network data traffic flows from the CMs to the CMTS.

CMTS Command Descriptions


This section contains an alphabetized list and descriptions of the CMTS commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 13-1


BSR 64000 Command Reference Guide Release 4.2.0

arp timeout
The arp timeout command configures the amount of time an entry stays in the ARP
cache. The no arp timeout command removes the time configuration an entry stays
in the ARP cache.
Use the show interfaces command in Privileged EXEC mode to view the ARP
time-out value.

Note: If the ARP time-out value is changed, the new value affects all the
existing entries in the ARP cache and any entries subsequently added to the
ARP cache.

Group Access
MSO

Command Mode
Interface Configuration

Command Line Usage


arp time-out <1-6000>
no arp timeout <1-6000>

Command Syntax

1-6000 amount of time, in minutes, that an entry is


allowed to stay in the ARP cache

Command Default
60 minutes

13-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

balance
The balance command automatically redistributes CMTS modules across the
available HSIM modules in the BSR chassis. Binding re-distributes CMTS traffic to
optimize network efficiency. The BSR allows for both manual and automatic binding.
For example; if there are 7 CMTS modules in the BSR, and 3 have been manually
bound, issuing the balance command will redistribute the remaining 4 CMTS
modules while leaving the manually bound modules unaffected.

Group Access
All

Command Mode
Privileged EXEC and Global Configuration

Command Line Usage


balance

Compass ID: 188656176 Version 5 MGBI 13-3


BSR 64000 Command Reference Guide Release 4.2.0

band
The band command is used to define the start and end frequency band for the
Spectrum Group.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


band <5000000-42000000> <5000000-42000000>
no band <5000000-42000000> <5000000-42000000>

Command Syntax

5000000-42000000 The start upstream frequency in Hertz.


5000000-42000000 The end upstream frequency in Hertz.

13-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

bind cmts
The bind cmts command manually binds or unbinds a CMTS module to an HSIM
module. Binding re-distributes CMTS traffic to optimize network efficiency.The no
bind cmts command manually unbinds a CMTS module to an HSIM module.

Group Access
All

Command Mode
Slot Configuration

Command Line Usage


bind cmts <NUM>
no bind cmts <NUM>

Command Syntax

NUM the number of the slot to bind the CMTS


module to

Compass ID: 188656176 Version 5 MGBI 13-5


BSR 64000 Command Reference Guide Release 4.2.0

cable bind
After using the interface cable command in Global Configuration mode to select a
cable interface and MAC Domain, use the cable bind command to modify the MAC
Domain definition for the module.
Each MAC Domain must have at least one downstream and one upstream channel
associated (bound) to it. Using the cable bind command, a user can associate (bind)
either one or both of the two downstream channels and a specific group of the eight
upstream channels on the module to either of the two MAC Domains available on the
module. When installed in an operating BSR chassis, the 2:8 Primary CMTS
Resource Module sets up MAC Domains based on the default definition in the startup
configuration file.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable bind {downstream <NUM> | upstream <NUM>}

Command Syntax
downstream NUM binds a single downstream port (0,1) to a MAC Domain
(0,1)
upstream NUM specifies a single upstream port number, a subset of
upstream port numbers (0,1,2,3 or 4,5,6,7) separated by
commas, or all the upstream port numbers on the module
(0,1,2,3,4,5,6,7) separated by commas

Command Default
A MAC Domain definition is defined for each resource module slot in which a 2x8
Primary CMTS Module can be installed (slots 0-7, 9-15) in the BSR startup
configuration file. When a 2:8 Primary CMTS Resource Module is installed into an
operating BSR chassis, the module, after booting, has one MAC Domain (0). MAC
Domain 0 comprises downstream port 0 and upstream ports 0, 1, 2, 3, 4, 5, 6, and 7.

13-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable bundle
Cable bundling allows you to group multiple cable interfaces into a single IP subnet.
The cable bundle command is used to assign the cable interface as the slave cable
interface and assign the bundle the same number as the master cable interface.

Group Access
MSO

Command Mode
Interface Configuration (cable and loopback interfaces only)

Command Line Usage


cable bundle <1-255>

Command Syntax

1-255 the number of the cable bundle

Compass ID: 188656176 Version 5 MGBI 13-7


BSR 64000 Command Reference Guide Release 4.2.0

cable bundle master


The cable bundle master command is used to assign a cable or loopback interface as
the master cable interface and assign the cable bundle a number. Cable bundling
allows you to group multiple cable interfaces into a single IP subnet. Cable bundling
simplifies network management and conserves IP addresses.
A cable bundle comprises two or more cable interfaces: one cable interface is
configured as the master, while the remaining interfaces are configured as slaves to
the master. If one CMTS module is configured as the master, the other CMTS
modules can become slaves. The master cable interface is assigned IP addresses and
the slaves share the same IP address with the master. The bundling feature eliminates
the need for an IP subnet for each cable interface.
Configuring a loopback interface as a cable bundle master provides a mechanism for
configuring the IP parameters of a cable bundle in a “virtual” interface which is
independent of physical cable interfaces. The advantage of configuring a virtual
interface as the cable bundle master is that IP configuration information will be
always available regardless of the state of the CMTS hardware. The slave cable
interfaces of a bundle whose master is a virtual interface will not lose their IP
information when the hardware module for one of the cable interface’s has either
failed or been removed.

Group Access
MSO

Command Mode
Interface Configuration (cable and loopback interfaces only)

Command Line Usage


cable bundle <1-255> master

Command Syntax

1-255 the cable bundle identifying number

13-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable cmts type


The cable cmts type command specifies the DOCSIS type supported by all CMTS
modules resident in the BSR chassis.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable cmts type {Domestic | Japan}
no cable cmts type {Domestic | Japan}

Command Syntax

Domestic specifies the CMTS module type to the North


American DOCSIS or Euro-DOCSIS
standards
Japan specifies the CMTS module types to the
Japan DOCSIS (J-DOCSIS) Standard

Command Default
Domestic

Compass ID: 188656176 Version 5 MGBI 13-9


BSR 64000 Command Reference Guide Release 4.2.0

cable concatenation docsis-1.0


The cable concatenation docsis-1.0 command enables or disables concatenation for
DOCSIS 1.0 cable modems. The no cable concatenation docsis-1.0 command
disables concatenation for DOCSIS 1.0 cable modems.

Note: Concatenation must be enabled globally with the cable upstream


concatenation command before any setting specified with the cable
concatenation command is valid. Once concatenation is enabled globally,
the cable concatenation command will enable or disable concatentation for
DOCSIS 1.0 cable modems only and concatenation will always be enabled
for DOCSIS 1.1 and DOCSIS 2.0 cable modems regardless of any setting
specified with this command.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable concatenation docsis-1.0
no cable concatenation docsis-1.0

Command Syntax

docsis-1.0 concatenation is enabled for DOCSIS 1.0


cable modems only

Command Default
Concatenation is enabled for DOCSIS 1.0, 1.1, and 2.0 cable modems if
concatenation is globally enabled with the cable upstream concatenation command.

13-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable deny ip
The cable deny ip command allows operators to filter (drop) worm/virus packets on
both the upstream and downstream cable interfaces by specifying the IP protocol used
by the virus or worm and its packet length (in bytes) to enable a filter for a particular
threat. The no cable deny ip command disables the filter.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable deny ip <0-255> <20-65535>
no cable deny ip <0-255> <20-65535>

Command Syntax

0-255 a numeric value indicating which IP protocol


number to drop
20-65535 the length in bytes indicating the size of the
IP packet to drop

Compass ID: 188656176 Version 5 MGBI 13-11


BSR 64000 Command Reference Guide Release 4.2.0

cable dhcp force-unicast


The cable dhcp force-unicast command forces downstream DHCP traffic to be
unicasted regardless of the setting of the DHCP broadcast bit.
The initial DHCP exchange for a cable modem occurs before the cable modem
completes DHCP. Therefore the packets for that DHCP exchange must be sent
unencrypted. If the downstream DHCP responses are broadcasted, then they must be
broadcasted unencrypted. These downstream broadcasts will then "leak" onto the
CPE LAN of all cable modems on that MAC Domain. The cable dhcp force-unicast
command can be used to prevent this leakage.
When the cable dhcp force-unicast command is present in the running configuration,
the BSR’s DHCP relay agent ignores the "broadcast bit" in downstream cable modem
DHCP responses and always sends unicasted downstream DHCP responses to cable
modems. These broadcasts will be encrypted using the appropriate SAID.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable dhcp force-unicast
no cable dhcp force-unicast

13-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable dhcp-giaddr primary


This cable dhcp-giaddr primary command forces the BSR to always set the giaddr
in host DHCP requests to the primary cable interface IP address.
The no cable dhcp-giaddr primary command sets the giaddr field in DHCP host
requests to the default. When set to the default, the first secondary address, if one is
defined, is used in DHCP host requests, otherwise the primary IP address is used.

Group Access
ISP

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable dhcp-giaddr primary
no cable dhcp-giaddr primary

Command Default
The giaddr for cable modems is the primary IP address on the cable interface.
The giaddr for Hosts is the first secondary IP address on the cable interface.

Compass ID: 188656176 Version 5 MGBI 13-13


BSR 64000 Command Reference Guide Release 4.2.0

cable dhcp leasequery message-type


The cable dhcp leasequery message-type command sets the DHCP Leasequery
message type values that the BSR uses. The default DHCP Leasequery message types
are defined by RFC4388 DHCP Leasequery. The no cable dhcp leasequery
message-type command re-establishes the default DHCP Leasequery message type
values.

Guidelines for Configuring DHCP Leasequery Message Types


RFC4388 defines the DHCP Leasequery protocol. Various DHCP server and CMTS
vendors have implemented draft revisions of the DHCP Leasequery protocol prior to
the publication of RFC4388. The main difference between these vendor specific
drafts and RFC4388 is the specification of the message type value for each of the
DHCP Leasequery message types.
These inconsistencies have led to interoperability problems. To address this issue,
Motorola now supports configurable DHCP Leasequery message type values
(through the cable dhcp leasequery message-type command) to support
non-compliant implementations of the DHCP Leasequery protocol.

Note: If a DHCP server allows configurable DHCP Leasequery message


types, Motorola recommends that the message type values specified in
RFC4388 be used. Some implementations of the DHCP Leasequery protocol
may not use all four DHCP Leasequery message types. In such cases, any
unused message type value may be configured for the unimplemented
message types.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable dhcp leasequery message-type <10-254>
no cable dhcp leasequery message-type <10-254>

13-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Syntax

10-254 DHCPLEASEQUERY message type

Command Default
10

Compass ID: 188656176 Version 5 MGBI 13-15


BSR 64000 Command Reference Guide Release 4.2.0

cable disable 3140-nbpwr-adjustment


The cable disable 3140-nbpwr-adjustment command allows an operator to enable
NB-PWR adjustments for the BCM3140. The command configures upstream nominal
power levels to be 3dB lower which eliminates any US TX power discrepancies for
the DOCSIS 2.0 2x8 CMTS module. A US TX power discrepancy could potentially
cause cable modem registration/ranging issues for cable modems operating at a
maximum US TX power level. The no cable disable 3140-nbpwr-adjustment
disables NB-PWR adjustment.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable disable 3140-nbpwr-adjustment
no cable disable 3140-nbpwr-adjustment

Command Default
Disabled

13-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable disable bpi-cmcert


The cable disable bpi-cmcert command bypasses the cable modem (CM) certificate
verification during the BPI authentication key exchange. Using the cable disable
bpi-cmcert command is similar to provisioning a cable modem certificate. The
difference is that provisioning a cable modem certificate is on a per cable modem
basis whereas the cable disable bpi-cmcert command is for all cable modems with
the same Manufacturer ID. The no cable disable bpi-cmcert command disables
bypassing cable modem certificate verification

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable disable <mac> <mac> bpi-cmcert
no cable disable <mac> <mac> bpi-cmcert

Command Syntax

mac the cable modem Vendor MAC address in the


form of xxxx.xxxx.xxxx - the first 3 bytes
have to be 0xFF (ffff.ffxx.xxxx) in
order to extract the Manufacturer ID from
Vendor MAC Address
mac the mask to specify a particular cable modem
or a range of cable modems in the form
yyyy.yyyy.yyyy

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 13-17


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream carrier-only


The downstream carrier-only function is disabled by default and is used for testing
purposes only to control downstream output. The cable downstream carrier-only
command is used optionally as a test function to enable the modulation to the RF
carrier of the downstream output. The no cable downstream carrier-only command
disables the modulation to the RF carrier of the downstream output.

Note: If the cable downstream carrier-only command is used, set the


rfModulation to 1.

If the no cable downstream carrier-only command is used, set the


rfModulation to 0.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> carrier-only
no cable downstream <NUM> carrier-only

Command Syntax

NUM the downstream port number

Command Default
Modulation to the RF carrier is disabled.

13-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable downstream description


The cable downstream description command is used to specify descriptive
information for a downstream port on the BSR. This information is limited to 80
characters and single word descriptions are not allowed. Use the characters: _ or - to
separate words. For example, if a downstream port served a certain section of a city,
the MSO could assign the following description:
MOT:7A(config-if)#cable downstream 0 description charlestown_1D

Note: The entered description can be seen in the running configuration, and
in the command output of show commands such as the show ip interface
and show running-config commands.

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> description <LINE>

Command Syntax

NUM the downstream port number


LINE the text that describes the interface

Compass ID: 188656176 Version 5 MGBI 13-19


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream frequency


The cable downstream frequency command is used to set the fixed center
downstream frequency for RF output. The no cable downstream command returns
the fixed center downstream frequency of RF output to the default..

Note: The Japan DOCSIS Standard must be specified with the cable cmts
type command before a downstream frequency can be selected for any
Japan DOCSIS Standard CMTS module.

Note: The digital carrier frequency cannot be the same as the video carrier
frequency.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage

North American DOCSIS/Euro-DOCSIS Standard


cable downstream <NUM> frequency <91000000-857000000>
no cable downstream <NUM> frequency <91000000-857000000>

Japan DOCSIS (J-DOCSIS) Standard


cable downstream <NUM> frequency <91000000-860000000>
no cable downstream <NUM> frequency <91000000-860000000>

13-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Syntax

NUM the downstream port number.


91000000-857000000 The downstream carrier center frequency.
Valid values are from 91000000 to
857000000 Hertz (Hz) for North American
DOCSIS and from 112000000 to 858000000
Hz for EuroDOCSIS.
91000000-860000000 The downstream carrier center frequency for
the Japan DOCSIS (J-DOCSIS) Standard

Command Default
555000000 Hz

Compass ID: 188656176 Version 5 MGBI 13-21


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream interleave-depth


The cable operator can protect the downstream path from excess noise or decrease
latency on the downstream path by setting the interleave depth. A higher interleave
depth provides more protection from noise on the HFC network, but increases
downstream latency. A lower interleave depth decreases downstream latency, but
provides less protection from noise on the HFC network.
The cable downstream interleave-depth command sets the downstream port
interleave depth criteria.

Note: A higher interleave depth provides more protection from bursts of noise
on the HFC network; however, it increases downstream latency.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> interleave-depth {8 | 16 | 32 | 64 | 128}
no cable downstream <NUM> interleave-depth {8 | 16 | 32 | 64 | 128}

Command Syntax

NUM the downstream port number

13-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Review Table 13-1 to determine the appropriate interleave-depth.

Table 13-1 Interleave Depth Criteria

Depth # of Taps Increments


8 8 16
12 12 17
16 16 8
32 32 4
64 64 2
128 128 1

Note: The Euro DOCSIS standard requires an interleave depth of 12.

Command Default
The command default is 8 for North American DOCSIS.

Compass ID: 188656176 Version 5 MGBI 13-23


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream loadbalance-group


The cable downstream loadbalance-group command assigns a downstream channel
to a load balancing group. The no cable downstream loadbalance-group command
removes the downstream channel from the load balancing group.

Note: The same downstream channel may be assigned to multiple load


balancing groups.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> loadbalance-group <WORD>
no cable downstream <NUM> loadbalance-group <WORD>

Command Syntax

NUM the downstream channel number


WORD the name of the load balancing group to be
created or modified

13-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable downstream modulation


The cable downstream modulation command sets the modulation rate for a
downstream port. The no cable downstream modulation command returns the
modulation rate setting to the default.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> modulation {256 | 64}
no cable downstream <NUM> modulation {256 | 64}

Command Syntax

NUM the downstream port number


256 the modulation rate, 8 bits per downstream
symbol
64 the modulation rate, 6 bits per downstream
symbol

Command Default
64 QAM

Compass ID: 188656176 Version 5 MGBI 13-25


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream power-level


The cable downstream power-level command sets the power level of a downstream
channel. The no cable downstream power-level changes the power level setting of a
downstream channel to the default.
Use the cable downstream power-level command to set the absolute power level in
tenths of dBmV. Use cable downstream power-level default setting to set the receive
power based on the automatic calculation of the necessary power level.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> power-level <450-630>
no cable downstream <NUM> power-level <450-630>

Command Syntax

NUM the downstream port number


450-630 An integer between 450 and 630; unit is in
tenth-dBmV

Command Default
550 dBmV

13-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable downstream rate-limit


The cable downstream rate-limit command controls whether rate limiting is applied
to downstream traffic on a given downstream interface. The no cable upstream
rate-limit command disables downstream rate limiting. The token-bucket algorithm
is used for rate limiting.

Note: If the rate-limit is enabled, downstream traffic is rate-limited according


to the cable modems configured. Packets may be buffered at times when any
cable modem or the hosts behind the cable modems transmit data exceeding
the permitted bandwidth.

Group Access
MSO

Command Mode
Interface Configuration

Command Line Usage


cable downstream <NUM> rate-limit
no cable downstream <NUM> rate-limit

Command Syntax

NUM the downstream port number

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 13-27


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream schedule


The cable downstream schedule command is used to configure the type of
scheduling to be applied on downstream ports.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream schedule {priority-only | priority-wfq}

Command Syntax

priority-only specifies the use of straight priority-based


scheduling
priority-wfq specifies the use of priority-based weighted
fair queuing scheduling

13-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable downstream scrambler on


The cable downstream scrambler on command enables the scrambler for a
downstream port. The no cable downstream scrambler on command disables the
scrambler for a downstream port.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> scrambler on
no cable downstream <NUM> scrambler on

Command Syntax

NUM the downstream port number

Compass ID: 188656176 Version 5 MGBI 13-29


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream shutdown


The cable downstream shutdown command is used to disable an enabled
downstream port when certain downstream parameters require that the downstream
port is disabled before these parameters are configured.
The downstream port is disabled by default. Use the no cable downstream shutdown
command to enable the downstream port after the required downstream parameters
are configured for the BSR. The downstream port is not active for data transmission
until it is enabled.

Group Access
MSO

Command Mode
Interface Configuration

Command Line Usage


cable downstream <NUM> shutdown
no cable downstream <NUM> shutdown

Command Syntax

NUM the downstream port number

Command Default
The downstream port(s) on the cable interface is disabled or "shut down" by default.

13-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable downstream threshold


The cable downstream threshold command specifies downstream channel upper and
lower queue thresholds. This command allows an operator to configure "back
pressure" parameters for various applications. For example, if the BSR is running
both a time critical application (such as Voice Over IP) and best effort service, the
cable downstream threshold command guarantees that the downstream scheduler
can only release bandwidth within a certain specified range to the downstream
channel. When a higher priority VOIP packet arrives, the VOIP packet will move
ahead of the previously queued downstream non-VOIP data.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> threshold {bytes <500-65535> [<500-65535>] | pdu
<16-256> <16-256>}
no cable downstream <NUM> threshold {bytes <500-65535> [<500-65535>] | pdu
<16-256> <16-256>}

Command Syntax

NUM the downstream channel number


bytes use the byte count as a threshold unit
500-65535 specify the upper byte threshold
500-65535 specify the optional lower byte threshold
pdu use the PDU count as a threshold unit
16-256 specify the upper PDU threshold
16-256 specify the lower PDU threshold

Compass ID: 188656176 Version 5 MGBI 13-31


BSR 64000 Command Reference Guide Release 4.2.0

Command Defaults
For 2x8 CMTS modules
upper byte threshold = 1000 bytes
lower byte threshold = 500 bytes
upper pdu threshold = 32 PDUs
lower pdu threshold = 16 PDUs

For 1x8 CMTS modules


upper byte threshold = 10626 bytes
lower byte threshold = 9108
upper pdu threshold = 256
lower pdu threshold = 256

For 1x4 CMTS modules


upper byte threshold = 10626 bytes
lower byte threshold = Not applicable
upper pdu threshold = Not applicable
lower pdu threshold = Not applicable

Note: When using the byte count parameter as the threshold unit with a 2x8
CMTS module, you must specify a value for the lower byte threshold. If the
lower byte threshold is not specified, the BSR will automatically use one half
of the upper byte threshold value as the lower byte threshold value.

When using the byte count parameter as the threshold unit wit 1x4 CMTS
module, a lower byte threshold value is not required and will be ignored if
specified. The PDU count threshold parameter is not applicable for 1x4
CMTS modules.

13-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable downstream trap-enable-if


The cable downstream trap-enable-if command enables the
ifLinkUpDownTrapEnable trap for a downstream channel. The
ifLinkUpDownTrapEnable trap indicates whether a link up or link down trap should
be generated. The cable downstream no trap-enable-if command disables the
ifLinkUpDownTrapEnable trap.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> trap-enable-if
no cable downstream <NUM> trap-enable-if

Command Syntax

NUM the downstream port number

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 13-33


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream trap-enable-rdn


The cable downstream trap-enable-rdn command enables the
rdnCardIfLinkUpDownEnable trap for a downstream channel. The
rdnCardIfLinkUpDownEnable trap indicates whether a link up or link down trap
should be generated. The no cable downstream trap-enable-rdn command disables
the rdnCardIfLinkUpDownEnable trap.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> trap-enable-rdn
no cable downstream <NUM> trap-enable-rdn

Command Syntax

NUM the downstream port number

Command Default
Disabled

13-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable flap-list aging


The cable flap-list aging command specifies the cable flap-list aging in terms of
maximum number of minutes a cable modem is kept in the flap-list. Use the no cable
flap-list aging command to disable cable flap-list aging.
Use this command to keep track of cable modem mac address upstream and
downstream traffic for every cable modem having communication problems.
Problems can be detected when the cable is inactive. This command will show cable
modem registration events, missed ranging packets, upstream power adjustments, and
the CMTS physical interface. Monitoring the flap list can not affect cable modem
communications.
The user can get the following information with the cable flap-list aging number of
days command:

Upstream performance data.


Quality control installation data.
Cable modem problem isolation and location.
CMTS problems based upon high activity.
Unreliable upstream paths based on high CRC errors.
Unreliable in-home wiring problems based on high CRC errors.

Group Access
MSO

Command Mode
Global Configuration and Interface Configuration (cable interface only)

Command Line Usage


cable flap-list aging <1-86400>
no cable flap-list aging <1-86400>

Command Syntax

1-86400 maximum number of minutes a cable modem


is kept in the flap-list

Compass ID: 188656176 Version 5 MGBI 13-35


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
1440 minutes

13-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable flap-list insertion-time


The cable flap-list insertion-time command sets the insertion time interval in
seconds. Use the no form of this command to disable insertion time.
Use the cable flap-list insertion-time command to manage the flapping
modem detector and place the cable modem on the flap list if the connection time is
outside the insertion time interval.

Note: The insertion-time is the time taken by cable modems to complete their
registration.

Group Access
MSO

Command Mode
Global Configuration and Interface Configuration (cable interface only)

Command Line Usage


cable flap-list insertion-time <1-86400>
no cable flap-list insertion-time <1-86400>

Command Syntax

1-86400 insertion time interval in seconds

Command Default
60 seconds

Compass ID: 188656176 Version 5 MGBI 13-37


BSR 64000 Command Reference Guide Release 4.2.0

cable flap-list miss-threshold


The cable flap-list miss-threshold command specifies the threshold for missing
consecutive polling messages which triggers the polling flap detector. The no cable
flap-list miss-threshold removes the specified threshold.

Group Access
MSO

Command Mode
Global Configuration and Interface Configuration (cable interface only)

Command Line Usage


cable flap-list miss-threshold <1-12>
no cable flap-list miss-threshold <1-12>

Command Syntax

1-12 missing consecutive polling messages

Command Default
6

13-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable flap-list percentage threshold


The cable flap-list percentage-threshold command specifies the CM miss
percentage threshold. The no cable flap-list percentage-threshold command restores
the default threshold value.
If CM miss percentage exceeds the flapListPercentageThreshold and the flapListTrap
is enabled with the cable flap-list trap-enable command, a flapListTrap will be sent
to the CMTS by the SNMP agent.

Group Access
MSO

Command Mode
Global Configuration and Interface Configuration (cable interface only)

Command Line Usage


cable flap-list percentage-threshold <1-100>
no cable flap-list percentage-threshold

Command Syntax

1-100 the CM miss threshold percentage

Command Default
10 percent

Compass ID: 188656176 Version 5 MGBI 13-39


BSR 64000 Command Reference Guide Release 4.2.0

cable flap-list power-adjust threshold


The cable flap-list power-adjust threshold specifies the flap-list power adjustment
parameters in dBmV for recording a flap-list event. The no cable flap-list
power-adjust threshold command disables power-adjust thresholds.
Use the cable flap-list power-adjust threshold to manage the flapping modem
detector and place the cable modem on the flap-list if the connection exceeds the
parameters.

Group Access
MSO

Command Mode
Global Configuration and Interface Configuration (cable interface only)

Command Line Usage


cable flap-list power-adjust threshold <1-10>
no cable flap-list power-adjust threshold <1-10>

Command Syntax

1-10 threshold in dBmV

Command Default
2 dBmV

13-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable flap-list size


The cable flap-list size command specifies the flap-list size, the maximum number of
cable modems in the flap-list. The no cable flap-list size command sets the default
flap-list table size.
Use the cable flap-list size number command to set the number of modems that the
cable flap-list table can record.

Group Access
MSO

Command Mode
Global Configuration and Interface Configuration (cable interface only)

Command Line Usage


cable flap-list size <1-8191>
no cable flap-list size <1-8191>

Command Syntax

1-8191 number of cable modems that can register to


the flap-list table

Command Default
256 cable modems

Compass ID: 188656176 Version 5 MGBI 13-41


BSR 64000 Command Reference Guide Release 4.2.0

cable flap-list trap-enable


The cable flap-list trap-enable command controls whether a flapListTrap will be
sent to the CMTS by the SNMP agent if the CM miss percentage exceeds the
flapListPercentageThreshold specified with the cable flap-list percentage threshold
command. The no cable flap-list percentage-threshold command disables sending
the flapListTrap.

Group Access
MSO

Command Mode
Global Configuration and Interface Configuration (cable interface only)

Command Line Usage


cable flap-list trap-enable
no cable flap-list trap-enable

Command Default
Enabled

13-42 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable helper-address
The cable helper address function disassembles a DHCP broadcast packet, and
reassembles it into a unicast packet so that the packet can traverse the router and
communicate with the DHCP server. The cable helper-address command enables
broadcast forwarding for User Datagram Protocol (UDP) packets.
The cable helper-address command can also be used to define the cable helper
address to be used for all CPEs whose CMs have an IP address in a particular subnet’s
address space. This forces the BSR relay agent to forward DHCP requests from a CPE
using a selected ISP to a DHCP server configured for that selected ISP.

Note: The isp-bind option is only available after selecting the host or mta
options. It is not available for the cable modem option.

Note: The cable helper-address command allows operators to support


multiple CM subnets bound to a single cable helper-address. Any DHCP
requests from clients that are attached to CMs that are part of the Multiple
ISP configuration will have their requests relayed to any defined ip
helper-addresses.

Group Access
ISP

Command Mode
Interface Configuration (cable and loopback interfaces only)

Command Line Usage


cable helper-address <A.B.C.D> {cable-modem | host [isp-bind <A.B.C.D>] | mta
[isp-bind <A.B.C.D>]}

no cable helper-address <A.B.C.D> {cable-modem | host [isp-bind <A.B.C.D>] |


mta [isp-bind <A.B.C.D>]}

Compass ID: 188656176 Version 5 MGBI 13-43


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D the IP address of the destination DHCP


server.
cable-modem specifies that only CM UDP broadcasts are
forwarded.
host specifies that only CPE UDP broadcasts are
forwarded.
mta specifies that only CPE MTA broadcasts are
forwarded.
isp-bind A.B.C.D specifies the secondary IP subnet to which the
cable-helper is bound.

13-44 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable host authorization range


The cable host authorization range command configures an authorization IP
address range for Customer Premise’s Equipment (CPE) access to the BSR. The no
cable host authorization range command disables IP address range authorization.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable host authorization range <prefix> <prefix>
no cable host authorization range <prefix> <prefix>

Command Syntax

prefix starting CPE IP address range


prefix ending CPE IP address range

Compass ID: 188656176 Version 5 MGBI 13-45


BSR 64000 Command Reference Guide Release 4.2.0

cable insert-interval
The cable insert-interval command sets the interval at which Initial Maintenance
intervals are scheduled in the upstream.These intervals are used by cable modems to
send ranging request messages when attempting to join the network. The no cable
insert-interval command is used to set the default insertion interval.

Note: Ensure that the upstream port is down before setting the insertion
interval.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable insert-interval <0-200>
no cable insert-interval <0-200>

Command Syntax

0-200 The insert interval in hundredths of a second.

Command Default
The default insertion interval is 20 hundredths of a second.

13-46 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable intercept
The BSR provides a way to monitor and intercept data originating from a DOCSIS
network through the Cable Intercept feature, which provides Multiple System
Operators (MSOs) with Lawful Intercept capabilities required by the
Communications Assistance for Law Enforcement Act (CALEA) for electronic
surveillance. Lawful Intercept capabilities are used by law enforcement agencies to
conduct electronic surveillance of circuit and data communications.

Warning: Lawful Intercept capabilities to intercept customer traffic are


authorized by either a judicial means to support local laws or through an
administrative order governed by service level agreements (SLAs). The
proper legal or administrative persons must be contacted first before
customer traffic is intercepted and examined.

When the Cable Intercept feature is initiated, copies of the data transmissions from
and to a specified Customer Premises Equipment (CPE) MAC address (such as a PC)
are sent to an intercept collector, which is a server at a specified IP address and UDP
port number.
Each CMTS resource module supports a maximum of 16 cable intercept entries in the
startup configuration and running configuration files. Only one MAC address per
CPE device, such as a PC can be intercepted and only packets from these CPEs are
intercepted.
Use the cable intercept command to create a cable intercept on the CMTS interface
to respond to CALEA requests from law enforcement for traffic regarding a specific
user. Use the no cable intercept command to delete a cable intercept on the CMTS
interface.

Group Access
MSO

Command Mode
Interface Configuration

Command Line Usage


cable intercept <mac> <prefix> <0-65535>
no cable intercept <mac> <prefix> <0-65535>

Compass ID: 188656176 Version 5 MGBI 13-47


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

mac The intercept source, which is the MAC address from


which traffic is intercepted. Packets with a source or
destination MAC address that matches this address
are copied and forwarded to the data collection server.
Most often, this MAC address is the user's CPE
device (such as a PC or VoIP phone), and not the
MAC address of the user's CM.
prefix Specifies the destination IP address for the data
collection server that receives copies of the forwarded
traffic.

0-65535 The destination User Datagram Port (UDP) port


number, which is used exclusively by the data
collection server. A default UDP port number is not
provided.

Command Default
None

13-48 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable loadbalance-group
The cable loadbalance-group command accesses Load Balancing Group
Configuration mode. Load Balancing Group Configuration mode allows you to create
a new load balancing group or modify an existing load balancing group. The no cable
loadbalance-group command removes a load balancing group.

Group Access
MSO

Command Mode
Global Configuration and Load Balancing Configuration Group Mode

Command Line Usage


cable loadbalance-group <WORD> [snmp-index <0-4294967295>]
no cable loadbalance-group <WORD> [snmp-index <0-4294967295>]

Command Syntax

WORD the name of the load balancing group to be


created or modified
snmp-index the SNMP index value
0-4294967295

Compass ID: 188656176 Version 5 MGBI 13-49


BSR 64000 Command Reference Guide Release 4.2.0

cable loadbalance-policy
The cable loadbalance-policy command enters Load Balancing Policy Configuration
mode for a specified load balancing policy. Load Balancing Policy Configuration
mode allows you to create a new load balancing policy or modify an existing load
balancing policy. Load balancing policies provide control over the autonomous load
balancing process on a per-CM basis. A load balancing policy is described by a set of
conditions (rules) that govern the autonomous load balancing process for the CM. The
no cable loadbalance-policy command removes a load balancing policy.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable loadbalance-policy <WORD> [snmp-index <0-4294967295>]
no cable loadbalance-policy <WORD> [snmp-index <0-4294967295>]

Command Syntax

WORD the name of the load balancing policy to be


created or modified

snmp-index the SNMP index value


0-4294967295

13-50 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable loadbalance-restricted
The cable loadbalance-restricted command allows you to designate a particular CM
or a range of CMs in a Load Balancing Group as restricted. A Restricted Load
Balancing Group is associated with a specific, provisioned set of cable modems.
Restricted Load Balancing Groups are used to accommodate a topology specific
or provisioning specific restriction such as a set of channels reserved exclusively
for business customers.
The no cable loadbalance-restricted command allows you to remove the restricted
designation.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable loadbalance-restricted [<1-256> | <WORD> [ snmp-index
<0-4294967295>]] no-move [<1-100> [<mac> [<mac>]]]
no cable loadbalance-restricted [<1-256> | <WORD> [ snmp-index
<0-4294967295>]] no-move [<1-100> [<mac> [<mac>]]]

Command Syntax

1-256 the load balancing group ID


WORD the load balancing group name
snmp-index the SNMP index value
0-4294967295
no-move restricted cable modems that cannot be
moved to another channel
1-100 the restricted cable modem index that cannot
be moved to another channel

Compass ID: 188656176 Version 5 MGBI 13-51


BSR 64000 Command Reference Guide Release 4.2.0

mac the MAC address of the CM to be restricted


from load balancing in the form of
xxxx.xxxx.xxxx
mac the mask to specify a particular CM or a range
of CMs in the form of xxxx.xxxx.xxxx

Note: The cable modem index refers to an index of the Restricted List not the
index of the CM record.

13-52 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable loadbalance-rule
The cable loadbalance-rule command creates a new load balancing rule or modifies
an existing load balancing rule. The no cable loadbalance-rule command removes a
load balancing rule.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable loadbalance-rule <WORD> {dis-period <0-86400> <0-86400> | disable |
ds-util {min <0-100> delta <0-100> stop <0-100} | enable | interval <0-480> |
rem-dsx | us-reg modem-count-thresh <1-50> | us-util {min <0-100> delta
<0-100> stop <0-100}} [snmp-index <0-4294967295>]
no cable loadbalance-rule <WORD> dis-period <0-86400> <0-86400> | disable |
ds-util {min <0-100> delta <0-100> stop <0-100} | enable | interval <0-480> |
us-reg modem-count-thresh <1-50> | us-util {min <0-100> delta <0-100> stop
<0-100}} [snmp-index <0-4294967295>]

Command Syntax

WORD the policy rule name


dis-period disable load balancing for a specified time
period
0-86400 dis-period start time in seconds after 12:00
AM
0-86400 dis-period length in seconds
disable disable the load balancing rule
ds-util min 0-100 minimum threshold percentage of
downstream utilization before load-balancing
starts

Compass ID: 188656176 Version 5 MGBI 13-53


BSR 64000 Command Reference Guide Release 4.2.0

ds-util delta 0-100 delta percentage of downstream utilization


between load-balancing channels to start load
balancing
ds-util stop 0-100 delta percentage of downstream utilization
between load-balancing channels to stop load
balancing
enable enable the load balancing rule
interval 0-480 periodic interval for load balancing in
minutes
rem-dsx remote DSX resource failure load-balancing
us-reg the maximum allowed difference in the cable
modem-count-thresh modem count between the cable modem's
1-50 initial upstream channel and the least loaded
upstream channel in the load balance group
us-util min 0-100 minimum threshold percentage of upstream
utilization before load-balancing starts

us-util delta 0-100 delta percentage of upstream utilization


between load-balancing channels to start load
balancing
us-util stop 0-100 delta percentage of upstream utilization
between load-balancing channels to stop load
balancing
snmp-index the SNMP index value
0-4294967295

Note: Only the maximum utilized channel must meet the minimum threshold
value before load balancing starts within a load balancing group.

13-54 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Note: The load balancing disable period (dis-period) that is entered in a load
balancing rule cannot span AM to PM (i.e. 4 PM through 9 AM).

For example, to disable load balancing for this time period, you would need to
enter two separate command strings, 4 PM to 11:59:59 PM and 00:00:01 AM
to 9 AM, as follows:

cable loadbalance-rule <WORD> dis-period 57600 28799

cable loadbalance-rule <WORD> dis-period 1 32400

Command Default
us-reg modem-count-thresh = 5

Compass ID: 188656176 Version 5 MGBI 13-55


BSR 64000 Command Reference Guide Release 4.2.0

cable load-balance loadbalance-group


The cable load-balance loadbalance-group command balances cable modems
across all upstream channels within the same load balancing group. This command
can be used for one specific load balancing group or for all load balancing groups.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable load-balance loadbalance-group [<WORD>]

Command Syntax

WORD only balance the specified load balancing group

13-56 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable load-balance spectrum-group


The cable load-balance spectrum-group command balances cable modems across
all upstream channels within the same Spectrum Group. This command can be used
for one specific Spectrum Group or for all Spectrum Groups.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable load-balance spectrum-group [<WORD>]

Command Syntax

WORD only balance the specified Spectrum Group

Note: If load balancing is disabled for a Spectrum Group, that specific


Spectrum Group can still be load balanced by including the Spectrum Group
name with the cable load-balance spectrum-group command. If the cable
load-balance spectrum-group command is used without a specific
Spectrum Group name, any Spectrum Groups that have load balancing
disabled will not be load balanced.

Compass ID: 188656176 Version 5 MGBI 13-57


BSR 64000 Command Reference Guide Release 4.2.0

cable modem-aging-timer
The cable modem-aging-timer command specifies a cable modem aging timer in
minutes. Cable modems that go off-line are automatically removed from the network
after the configured time period.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable modem-aging-timer {<10-30240> | off}

Command Syntax

10-30240 the cable modem aging timer number in


minutes (10 minutes to 21 days)
off disables the cable modem aging timer

Command Default
Disabled

13-58 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modem dcc


The cable modem dcc command allows an operator to manually move DOCSIS 1.1
and 2.0 cable modems or MTAs to a specified upstream and/or downstream port and
logical channel using DOCSIS Dynamic Channel Change (DCC).

Note: The upstream channel must be physically connected for DOCSIS 1.1
and 2.0 cable modems to be manually moved.

When moving a CM or MTA to a different downstream or upstream channel ,


the upstream channel must be specified first followed by the downstream
channel.

The same init-tech must be specified for both the upstream and downstream
channels.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable modem {<mac> | <prefix>} dcc [downstream <0-1> [init-tech <0-4>] |
init-tech <0-4>| upstream <0-7>/<0-3> [init-tech <0-4>| [downstream [init-tech
<0-4>]]]

Command Syntax

mac the cable modem MAC address in the form of


xxxx.xxxx.xxxx
prefix the cable modem IP address
downstream 0-1 the downstream port number

Compass ID: 188656176 Version 5 MGBI 13-59


BSR 64000 Command Reference Guide Release 4.2.0

init-tech 0-4 the ranging technique used for DCC:


0 = re-initialize the MAC
1 = perform broadcast intitial ranging on the
new channel before normal operation
2 = perform unicast ranging on the new
channel before normal operation
3 = perform either broadcast or unicast
ranging on the new channel before normal
operation
4 = use the new channel directly without
re-intializing or ranging
upstream 0-7/0-3 the upstream port/logical channel

13-60 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modem deny


The cable modem deny command removes a specified cable modem from the
network and denies it future entry. The no cable modem deny command removes the
restriction from the specified cable modem.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable modem deny <mac>
no cable modem deny <mac>

Command Syntax

mac CM MAC address.

Compass ID: 188656176 Version 5 MGBI 13-61


BSR 64000 Command Reference Guide Release 4.2.0

cable modem disable loadbalancing


The cable modem disable loadbalancing command disables Dynamic Load
Balancing on all BSR CMTS modules. If disabled on the BSR, Dynamic Load
Balancing operations are only allowed from an external management station. The no
cable modem disable loadbalancing command enables Dynamic Load Balancing on
all BSR CMTS modules.

Group Access
MSO

Command Mode
All modes except User EXEC

Command Line Usage


cable modem disable loadbalancing
no cable modem disable loadbalancing

Command Default
Enabled

13-62 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modem qos dsa


The cable modem qos dsa command triggers a dynamic service change (DSC)
initiated by the CMTS for a specified cable modem. The DSC is in a binary file that
conforms to the DOCSIS cable modem configuration file format. This configuration
file is saved in the TFTP "boot" directory on a TFTP server with a known IP address.
The current implementation has only the change of service based on service-flow (not
the flow classifier, nor the payload-header-suppression).

Note: The definition of the dynamic service is defined in a binary file that
conforms to the DOCSIS 1.1 cable modem’s configuration file format. This
configuration file is saved in the TFTP "boot" directory on a TFTP server with
known IP address.

Warning: This command should be used with extreme caution as the


dynamic service definition in the configuration file will be overwritten.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable modem {<mac> | <prefix>} qos dsa <prefix> <string>

Command Syntax

mac The CM Dynamic Service Addition MAC


address of the specified cable modem.
prefix Specified cable modem IP address to create or
delete a SID.
prefix IP address of TFTP server.
string File name to be configured.

Compass ID: 188656176 Version 5 MGBI 13-63


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
none

13-64 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modem qos dsc


The cable modem qos dsc command triggers a Dynamic Service Change (DSC)
initiated by the CMTS for a specified cable modem (CM).The cable modem qos dsc
command triggers a dynamic service change (DSC) initiated by the CMTS for a
specified cable modem. The definition of the dynamic service is defined in a binary
file that conforms to the DOCSIS cable modem’s configuration file format. This
configuration file is saved in /tftpboot directory on a TFTP server with known IP
address. The current implementation only the change of service based on service-flow
(not the flow classifier, nor the payload-header-suppression).
The definition of the dynamic service is defined in a binary file that conforms to the
DOCSIS cable modem configuration file format. This configuration file is saved in
the /tftpboot directory on a TFTP server with a known IP address. The current
implementation only is the change of service based on service-flow (not the flow
classifier, nor the payload-header-suppression).

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable modem {<mac> | <prefix>} qos dsc <prefix> <string>

Command Syntax

mac The CM Dynamic Service Addition MAC


address of the specified cable modem.
prefix Specified cable modem IP address to create or
delete a SID.
prefix IP address of TFTP server.

string File name to be configured.

Compass ID: 188656176 Version 5 MGBI 13-65


BSR 64000 Command Reference Guide Release 4.2.0

cable modem qos dsd


The cable modem qos dsd command triggers a dynamic service deletion (DSD)
initiated by the CMTS for a specified service flow.

Note: The cable modem qos dsd command should be used with extreme
caution as the correct service-flow identifier must be specified.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable modem qos dsd <X/Y> <1-262143>

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
1-262143 Service Flow Identifier (not all values are
valid at all times in a running system)

Command Default
none

13-66 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modem max-hosts


The cable modem max-hosts command sets the limit for the maximum Customer
Premises Equipment (CPE) hosts behind a particular cable modem. The no cable
modem max-hosts sets the limit to the default value.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable modem {<mac> | <prefix>} max-hosts <0-32>
no cable modem {<mac> | <prefix>} max-hosts <0-32>

Command Syntax

mac Cable modem MAC address.


prefix Cable modem IP address.
0-32 Number of CPE hosts.

Compass ID: 188656176 Version 5 MGBI 13-67


BSR 64000 Command Reference Guide Release 4.2.0

cable modem max-hosts-all


The cable modem max-hosts-all command sets the limit for the maximum Customer
Premises Equipment (CPE) hosts behind all cable modems on the network. The no
cable modem max-hosts-all sets the limit to the default value.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable modem max-hosts-all <0-32>
no cable modem max-hosts-all <0-32>

Command Syntax

0-32 Number of CPE hosts.

13-68 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modem remote-query


The cable modem remote-query command enables the Remote Query feature’s
polling operation, configures the polling interval to use when querying each cable
modem, and specifies the SNMP community name to use when to reading a cable
modem’s RF parameters. The new polling interval starts immediately when specified
with this command. The no cable modem remote-query command disables Remote
Query polling.

Note: The Remote Query feature polls cable modems using SNMPv1 only.
The MSO must configure CMs to accept the SNMPv1 community string
specified with the cable modem remote-query command.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable modem remote-query <1-86400> <snmp-community-name>
no cable modem remote-query <1-86400> <snmp-community-name>

Compass ID: 188656176 Version 5 MGBI 13-69


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

1-86400 configures the interval, in seconds,


that the Remote Query task waits
after completing one full polling
cycle of all cable modems and then
starting the next polling cycle
snmp-community-name the SNMPv1 community name that
the Remote Query task uses to read a
cable modem’s RF parameters - an
example value is “public”

Note: An operator can force the immediate execution of a Remote Query


polling cycle by entering the following sequence of commands:

1) cable modem remote-query <1-86400> <snmp-community-name>


2) no cable modem remote-query
3) show cable modem remote-query (check the status of the polling cycle)

The frequency of Remote Query polling should be selected with care so as


not to introduce excessive overhead that would degrade performance.

The cable modem remote-query command is the only command required to


enable the Remote Query feature. No additional SNMP commands are
required.

Command Default
Disabled

13-70 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modem ucc


The cable modem ucc command allows an operator to manually move a DOCSIS 1.0
or 1.1 CM or MTA to a different upstream channel within the same MAC domain.

Note: The cable modem will not be moved if the old and new upstream
channels are associated to two different Spectrum Groups.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable modem {<mac> | <prefix>} ucc <0-7> [init-tech <0-4> | logical <0-3>]

Command Syntax

mac cable modem MAC address in the form of


xxxx.xxxx.xxxx
prefix cable modem IP address
0-7 the upstream physical channel

Compass ID: 188656176 Version 5 MGBI 13-71


BSR 64000 Command Reference Guide Release 4.2.0

init-tech 0-4 the ranging technique used for UCC:


0 = re-initialize the MAC
1 = perform broadcast intitial ranging on the
new channel before normal operation
2 = perform unicast ranging on the new
channel before normal operation
3 = perform either broadcast or unicast
ranging on the new channel before normal
operation
4 = use the new channel directly without
re-intializing or ranging
logical 0-3 the upstream logical channel

13-72 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modem updis


The cable modem updis command enables the transmission of an an Upstream
Transmitter Disable (UP-DIS) MAC layer message that disables a specified cable
modem’s upstream transmitter. Upon receipt of an UP-DIS message, the cable modem
autonomously disables its upstream transmitter. Once disabled through an UP-DIS
message, the cable modem’s upstream transmitter can only be re-enabled by power
cycling the cable modem.
The cable modem updis command is not intended to be a replacement for existing
mechanisms for controlling a subscriber’s service. The cable modem updis
command provides an additional tool to protect against some forms of denial of
service, such as a virus propagated across the Internet, that cannot be controlled with
existing management mechanisms.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable modem updis <mac>

Command Syntax

mac the cable modem MAC address in the form of


xxxx.xxxx.xxxx

Compass ID: 188656176 Version 5 MGBI 13-73


BSR 64000 Command Reference Guide Release 4.2.0

cable modulation-profile
The cable modulation-profile command navigates to Modulation Profile
Configuration Mode. Modulation Profile Configuration Mode provides a series of
modulation profile commands that allow an MSO to create or modify a modulation
profile.

Warning: Motorola does not recommend modification of modulation profile


parameters without a thorough understanding of modulation changes and
DOCSIS interface specifications. Modulation profile parameters will affect the
physical layer and may cause disruption or degradation of services.

Note: Modulation profiles 1-4, 101-116, 201-205, and 301-310 are


pre-configured modulation profiles. To view the configuration of these
profiles, use the show cable modulation-profile command.

Motorola recommends that user-created modulation profiles use the


numbering range of 401-600 to ensure better future portability.

For a complete list and configuration of all 35 pre-defined modulation profiles,


refer to Appendix A, Pre-Defined Modulation Profiles in the BSR 64000
Configuration and Management Guide.

For guidelines on modifying modulation profile parameters, refer to Appendix


B, Understanding and Modifying Modulation Profiles in the BSR 64000
Configuration and Management Guide.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable modulation-profile {<1-600>} [a-long | a-short | a-ugs]
cable modulation-profile {<1-600>} [initial | long | request | short | station]
[<0-10>] <16-253> <0-255> {16qam | qpsk} {scrambler | no-scrambler} <0x0000
- 0x7fff> {diff | no-diff} <64-256> {fixed | shortened}

13-74 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

no cable modulation-profile {<1-600>} [a-long | a-short | a-ugs]


no cable modulation-profile {<1-600>} [initial | long | request | short | station]
[<0-10>] <16-253> <0-255> {16qam | qpsk} {scrambler | no-scrambler} <0x0000
- 0x7fff> {diff | no-diff} <64-256> {fixed | shortened}

Command Syntax

1-600 specify a modulation profile number and


enter Modulation Profile Configuration Mode
for that modulation profile - the default IUC
submode is request
a-long enter the Modulation Profile Configuration
Mode a-long IUC submode for the specified
cable modulation profile number for
configuring the advanced PHY long data
grant
a-short enter the Modulation Profile Configuration
Mode a-short IUC submode for the specified
cable modulation profile number for
configuring the advanced PHY short data
grant
a-ugs enter the Modulation Profile Configuration
Mode a-ugs IUC submode for the specified
cable modulation profile number for
configuring the Unsolicited Grant Service

initial enter the Modulation Profile Configuration


Mode initial IUC submode for the specified
cable modulation profile number for
configuring the Initial Ranging Burst
long enter the Modulation Profile Configuration
Mode long IUC submode for the specified
cable modulation profile number for
configuring the Long Grant Burst

Compass ID: 188656176 Version 5 MGBI 13-75


BSR 64000 Command Reference Guide Release 4.2.0

request enter the Modulation Profile Configuration


Mode request IUC submode for the specified
cable modulation profile number for
configuring the Request Burst
short enter the Modulation Profile Configuration
Mode short IUC submode for the specified
cable modulation profile number for
configuring the Short Grant Burst
station enter the Modulation Profile Configuration
Mode station IUC submode for the specified
cable modulation profile number for
configuring the Station Ranging Burst
0-10 the FEC correction value - 0 indicates no
Forward Error Correction
16-253 the FEC codeword length in kilobytes
0-255 the maximum burst length in minislots - "0"
means no limit
16qam | qpsk the modulation type
scrambler | enable or disable scrambler
no-scrambler
0x0000 - 0x7fff the scrambler seed in hexadecimal format.

13-76 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

diff | no-diff enable or disable differential encoding


Note: If a modulation profile is in use, differential
encoding cannot be enabled or disabled for any
of the burst types. To enable or disable
differential encoding for a burst type, an operator
must copy the modulation profile to a new
modulation profile number, enable or disable
differential encoding for the new modulation
profile, and assign the new modulation profile to
the desired upstream channel. Attempting to
enable or disable differential encoding for a
modulation profile that is in use will generate the
following error message:

[10/07-10:26:06.59-
07:CRMTASK]-E-mod profile in use,
cannot change diff encoding

64-256 the preamble length in bits


fixed | shortened the handling of FEC for last codeword length

Compass ID: 188656176 Version 5 MGBI 13-77


BSR 64000 Command Reference Guide Release 4.2.0

cable modulation-profile copy


The cable modulation-profile copy command copies an existing modulation profile
from a source modulation profile number to a destination modulation profile number.
The destination modulation profile is overwritten by the source modulation profile.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable modulation-profile copy {<1-600>} {<1-600>}
no cable modulation-profile copy {<1-600>} {<1-600>}

Command Syntax

1-600 source modulation profile number


1-600 destination modulation profile number

13-78 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable modulation-profile description


The cable modulation-profile description command sets the description of the
specified modulation profile to the given string. A string that contains spaces must be
enclosed within quotation marks.The no cable modulation-profile description form
of this command clears the description and resets it to the default.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable modulation-profile <1-600> description {<string>}
no cable modulation-profile <1-600> description

Command Syntax

1-600 the modulation profile number


string the description text for the modulation profile

Compass ID: 188656176 Version 5 MGBI 13-79


BSR 64000 Command Reference Guide Release 4.2.0

cable modulation-profile reset


The cable modulation-profile reset command resets a modified, pre-defined
modulation profile back to the system default.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable modulation-profile reset {<1-4> | <101-116> | <201-205> | <301-310>}

Command Syntax

1-4, 101-116, 201-205, the pre-defined modulation profile number


301-310

13-80 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable multicast
The cable multicast command creates a static multicast downstream service flow and
assigns the service flow to a service class. Creating a static multicast downstream
service flow and assigning the service flow to a service class allows the BSR to limit
the amount of multicast traffic (including DVMRP or PIM) on the downstream
channel. The cable multicast command allows an MSO to balance the bandwidth
requirements of IP-based video streaming services with other bandwidth critical
services such as voice traffic or high-priority business traffic. The no cable multicast
command disables the downstream multicast traffic limiting.
This feature is configurable as a percentage of the total bandwidth available on the
downstream channel through the service class to which it is assigned. The cable
multicast command can be used to optionally specify a service class with the new
downstream service flow. If a service class is not specified, the downstream service
flow defaults to the DefMCDown service class.

Note: The BSR supports the configuration of 256 downstream multicast


service flows specified by unique combinations of a destination IP multicast
address and destination IP multicast address mask {ipAddr, ipMask}. The
BSR supports the mapping of different downstream multicast service flows to
a specific user defined service class for a maximum of 256 mappings.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable multicast <A.B.C.D> <A.B.C.D> [<WORD>]
no cable multicast <A.B.C.D> <A.B.C.D> [<WORD>]

Compass ID: 188656176 Version 5 MGBI 13-81


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D destination IP multicast address


A.B.C.D destination IP multicast address mask
WORD the service class name

Command Defaults
Disabled
Service Class = DefMCDown

13-82 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable multi-ds-override
The cable multi-ds-override commands enables downstream frequency override
during ranging. Downstream frequency override allows an MSO to instruct a cable
modem to move to a specific downstream/upstream pair during ranging by sending an
RNG-RSP message with a downstream frequency override that tells a specific cable
modem to move to a specific downstream channel. The no cable multi-ds-override
command disables downstream frequency override during ranging.

Note: The downstream override feature is supported between any 2:8


Primary CMTS Resource Modules that share a downstream path. It is also
supported between any 1:8 and 1:4 Primary CMTS Resource Modules that
share a downstream path. The feature is not supported between a mix of 2:8
and 1:8 or 1:4 Primary CMTS Resource Modules sharing the same
downstream path.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable multi-ds-override
no cable multi-ds-override

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 13-83


BSR 64000 Command Reference Guide Release 4.2.0

cable privacy auth life-time


The cable privacy auth life-time command sets the authorization key (AK) life-time
values for baseline privacy. The no cable privacy auth life-time command changes
the AK life-time values for baseline privacy back to the default.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable privacy auth life-time <300-6048000>
no cable privacy auth life-time <300-6048000>

Command Syntax

300-6048000 Length of the key encryption life-time, valid


values 300 seconds (5 minutes) to 6048000
seconds (70 days).

Command Default
604800 seconds (7 days)

13-84 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable privacy cert


The cable privacy cert command allows cable modems to register using self-signed
manufacturer certificates, as opposed to a manufacturer certificate that is chained to
the DOCSIS root certificate. The no cable privacy cert command disables this
feature.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable privacy cert {trust [trusted | untrusted] | valid [false | true]}
no cable privacy cert {trust [trusted | untrusted] | valid [false | true]}

Command Syntax

trust set trust for all self-signed manufacturer


[trusted | untrusted] certificates - default is untrusted

valid enable/disable the checking for a certificate's


validity period
false disable certificate validity checking
true enable certificate validity checking (default)

Command Default
trust is set to "untrusted"
certificate validity checking is enabled

Compass ID: 188656176 Version 5 MGBI 13-85


BSR 64000 Command Reference Guide Release 4.2.0

cable privacy cm-auth life-time


The cable privacy cm-auth life-time command sets AK life-time values for a cable
modem. The no cable privacy cm-auth life-time changes the setting of AK life-time
values for a cable modem back to the default.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable privacy cm-auth life-time <mac> [<300-6048000>]
no cable privacy cm-auth life-time <mac>

Command Syntax

mac cable modem physical address (MAC) in the


form xxxx.xxxx.xxxx
300-6048000 length of key encryption life-time in seconds

Command Default
604800 seconds (7 days)

13-86 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable privacy cm-auth reset


The cable privacy cm-auth reset command resets a Traffic Encryption Key (TEK)
before expiration on a grace-time or a life-time value. The no cable privacy cm-auth
reset command changes the TEK expiration back to the default.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable privacy cm-auth reset <mac> <1-4>
no cable privacy cm-auth reset

Command Syntax

mac cable modem MAC address of 6 bytes


1-4 number representing an action:
1 noReset requested - causes CMTS to do
nothing
2 invalidateAuth - causes CMTS to invalidate
current CM authorization key, does not
transmit an Authorization Invalid message to
the CM, does not invalidate unicast TEKs
3 sendAuthInvalid - causes CMTS to
invalidate current CM authorization key, does
not transmit an Authorization invalid message
to CM, does not invalidate unicast TEKs
4 invalidateTeks - causes CMTS to invalidate
current CM authorization key, to transmit an
Authorization Invalid message to the CM,
and to invalidate all unicast TEKs related to
this CM authorization

Compass ID: 188656176 Version 5 MGBI 13-87


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
profile 1

13-88 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable privacy cm-tek life-time


The cable privacy cm-tek life-time command sets the TEK life-time value for
baseline privacy. The no cable privacy cm-tek life-time command returns the TEK
life-time value to the default value.

Group Access
MSO

Command Mode
Interface Configuration

Command Line Usage


cable privacy cm-tek life-time <0-16383> <1800-604800>
no cable privacy cm-tek life-time <0-16383> <1800-604800>

Command Syntax

0-16383 CM primary SID.


1800-604800 Traffic encryption life-time value in seconds.

Command Default
43200 seconds

Compass ID: 188656176 Version 5 MGBI 13-89


BSR 64000 Command Reference Guide Release 4.2.0

cable privacy cm-tek reset


The cable privacy cm-tek reset command resets a CM Traffic Encryption Key
(TEK).

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable privacy cm-tek reset [<1-16383>]

Command Syntax

1-16383 the primary Service Identifier (SID) of the


cable modem

13-90 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable privacy mcast


The cable privacy mcast command enables the encryption of multicast traffic from a
specific IP address.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable privacy mcast access <A.B.C.D> <A.B.C.D> [<8192-16381>]
no cable privacy mcast access <A.B.C.D> <A.B.C.D> [<8192-16381>]

Command Syntax

A.B.C.D the multicast IP address


A.B.C.D the multicast subnet mask
8192-16381 the multicast SAID number

Compass ID: 188656176 Version 5 MGBI 13-91


BSR 64000 Command Reference Guide Release 4.2.0

cable privacy mcast access


The cable privacy mcast access command configures a multicast access list by
specifying a cable modem MAC address and the corresponding multicast IP address.

Note: A cable modem MAC address and the corresponding multicast IP


address is required.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable privacy mcast access <H.H.H> <A.B.C.D> [<8192-16381>]
no cable privacy mcast access <H.H.H> <A.B.C.D> [<8192-16381>

Command Syntax

H.H.H cable modem physical address (MAC) in the


form xxxx.xxxx.xxxx
A.B.C.D multicast IP address.

8192-16381 the multicast SAID number

13-92 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable privacy tek life-time


The cable privacy tek life-time command sets the cable privacy Traffic Encryption
Key (TEK) life-time value. The no cable privacy tek life-time command returns the
cable privacy TEK life-time value to the default value.

Note: Baseline privacy is configured with key encryption keys (KEKs), and
the TEKs are configured based on the 40 or 56-bit data encryption standard
(DES).

A life-time or a grace-time TEK value expires based on a life-time or


grace-time value, but a cable modem has to renew its TEK grace-time value
before it expires. If a lasting TEK lifetime is needed, use a life-time key.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable privacy tek life-time <30-604800>
no cable privacy tek life-time

Command Syntax

30-604800 minimum and maximum traffic encryption


life-time value in seconds

Command Default
43200 seconds

Compass ID: 188656176 Version 5 MGBI 13-93


BSR 64000 Command Reference Guide Release 4.2.0

cable qos-profile
The cable qos-profile command accesses QoS Profile Configuration mode. QoS
Profile Configuration mode allows you to create or modify a QoS Profile. The no
cable qos-profile command deletes a QoS Profile.

Group Access
MSO

Command Mode
Global Configuration and QoS Profile Configuration

Command Line Usage


cable qos-profile <prof-num>
no cable qos-profile <prof-num>

Command Syntax

prof-num the QoS Profile identifying number

Note: Only QoS Profile numbers 1-16 can be configured by the user.

13-94 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable shared-secret
The cable shared-secret command activates or deactivates cable modem
authentication with a shared-secret key. The no cable shared-secret command sets
the cable shared-secret back to the default.
Use the cable shared-secret command to authenticate the cable modem such that all
cable modems must return a text string to register for access to the network.
If the no cable shared-secret command is enabled on the CMTS, secret key checking
is not available on any cable modem. If shared-secret is configured on CMTS, cable
modems have to use the secret key obtained from the CM configuration files obtained
from the TFTP server.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable shared-secret {0 <string> | 7 <hex-dump-string> | <string>}
no cable shared-secret {0 <string> | 7 <hex-dump-string> | <string>}

Command Syntax

0 Specifies an UNENCRYPTED key will follow

7 Specifies an ENCRYPTED key will follow


hex-dump-string The authentication key in hex number format.
string The authentication key (enclosed with double
quotes if the key contains spaces). The "%" and
"!" characters must not be used.

Command Default
null string

Compass ID: 188656176 Version 5 MGBI 13-95


BSR 64000 Command Reference Guide Release 4.2.0

cable shared-secondary-secret
The cable shared-secondary-secret command activates or deactivates cable modem
authentication with a shared-secondary-secret key. The no cable
shared-secondary-secret command sets the cable shared-secondary-secret back to
the default.
Use the cable shared-secondary-secret command to authenticate the cable modem
such that all cable modems must return a text string to register for access to the
network.
If the no cable shared-secondary-secret command is enabled on the CMTS, secret
key checking is not available on any cable modem. If shared-secondary-secret is
configured on CMTS, cable modems have to use the secret key obtained from the CM
configuration files obtained from the TFTP server.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable shared-secondary-secret {0 <string> | 7 <hex-dump-string> | <string>}
no cable shared-secondary-secret {0 <string> | 7 <hex-dump-string> | <string>}

Command Syntax

0 Specifies an UNENCRYPTED key will follow


7 Specifies an ENCRYPTED key will follow
hex-dump-string The authentication key in hex number format.
string The authentication key (enclosed with double
quotes if the key contains spaces). The "%" and
"!" characters must not be used.

Command Default
null string

13-96 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable spectrum-group
The cable spectrum-group command is used to create a cable spectrum group and
enter Cable Spectrum Group mode in which to configure a cable spectrum group. All
of the cable spectrum parameters are configured from Cable Spectrum Group mode.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable spectrum-group <WORD>
no cable spectrum-group <WORD>

Command Syntax

WORD The cable spectrum group name.

Compass ID: 188656176 Version 5 MGBI 13-97


BSR 64000 Command Reference Guide Release 4.2.0

cable sync-interval
The synchronization message interval is the interval between successive
synchronization message transmissions from the BSR CMTS interface to the CMs.
The cable sync-interval command sets the synchronization interval between
transmission of successive SYNC messages from the CMTS to CMs. The no cable
sync-interval returns the interval setting to transmit SYNC messages to the default.

Note: Ensure that you disable the cable interface using the cable shutdown
command before using the cable sync-interval command.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable sync-interval <0-200>
no cable sync-interval

Command Syntax

0-200 synchronization interval in milliseconds.

Command Default
200

13-98 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable ucd-interval
The cable ucd-interval command sets the interval between transmission of
successive Upstream Channel Descriptor (UCD) messages. The no cable
ucd-interval changes the interval setting to transmit UCD messages back to the
default.

Note: Ensure that you disable the cable interface using the cable shutdown
command before using the cable ucd-interval command.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable ucd-interval <0-2000>
no cable ucd-interval

Command Syntax

0-2000 UCD interval in milliseconds

Command Default
1000

Compass ID: 188656176 Version 5 MGBI 13-99


BSR 64000 Command Reference Guide Release 4.2.0

cable upstream active-codes


The cable upstream active-codes command specifies the number of active codes
allowed for an S-CDMA channel type. The active codes value must be a non prime
number. Increasing the number of allowed active codes provides more transmission
channel capacity. Reducing the number of active codes takes advantage of the
S-CDMA spreader processing gain at the expense of channel capacity.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} active-codes <64-128>
no cable upstream {<NUM> | <X/Y>} active-codes <64-128>

Note: When using the cable upstream active-codes command, both the
NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream active-codes command is only applicable for
an upstream port and logical channel and will only be available through the
X/Y argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port and logical channel number
(0-3)

64-128 the total number of allowed active codes

13-100 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream channel-type


The cable upstream channel-type command allows you to specify the channel type
for the default upstream channel (0) or specify the channel type for up to four logical
channels (0-3).

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} channel-type {tdma | atdma | mtdma | scdma}
no cable upstream {<NUM> | <X/Y>} channel-type {tdma | atdma | mtdma |
scdma}

Note: When using the cable upstream channel-type command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0
2:8 CMTS. The cable upstream channel-type command is only applicable
to an upstream port on the BCM 3138-based 2:8 CMTS module or an
upstream port and logical channel on the BCM 3140-based DOCSIS 2.0 2:8
CMTS module.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-101


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
tdma DOCSIS 1.0 or 1.1 channel type
atdma DOCSIS 2.0 channel type
mtdma DOCSIS 1.0, 1.1, 2.0 TDMA channel type
scdma DOCSIS 2.0 channel type only used for
logical channel configurations

13-102 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream channel-width


The cable upstream channel-width command specifies an upstream channel width
for an upstream port. The no cable upstream channel-width command returns the
default value.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} channel-width [1600000 | 200000 | 3200000 |
400000 | 800000]
no cable upstream {<NUM> | <X/Y>} channel-width [1600000 | 200000 | 3200000
| 400000 | 800000]

Note: When using the cable upstream channel-width command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for a BCM 3140-based DOCSIS
2.0 2:8 CMTS. The cable upstream channel-width command is only
applicable for an upstream port and will only be available through the NUM
argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-103


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
1600000 1600000 - channel width 1600 kHz
200000 200000 - channel width 200 kHz
3200000 3200000 - channel width 3200 kHz
400000 - channel width 400 kHz
400000
800000 - channel width 800 kHz
800000

13-104 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream codes-minislot


The cable upstream codes-minislot command specifies the number of active codes
allowed for each minislot on an S-CDMA channel. The number active codes allowed
for each minislot determines the minislot capacity and sets the granularity of the
upstream grants.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} codes-minislot <2-32>
no cable upstream {<NUM> | <X/Y>} codes-minislot <2-32>

Note: When using the cable upstream codes-minislot command, both the
NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream codes-minislot command is only applicable for
an upstream port and logical channel and will only be available through the
X/Y argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-105


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port and logical channel number
(0-3)
2-32 the number of codes allowed per minislot

13-106 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream concatenation


The cable upstream concatenation command enables CMTS concatenation
capabilities. The no cable upstream concatenation command disables CMTS
concatenation capabilities.

Note: Concatenation must be enabled globally with the cable upstream


concatenation command before any setting specified with the cable
concatenation command is valid. Once concatenation is enabled globally,
the cable concatenation command will enable or disable concatentation for
DOCSIS 1.0 cable modems only and concatenation will always be enabled
for DOCSIS 1.1 and DOCSIS 2.0 cable modems regardless of any setting
specified with the cable concatenation command.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} concatenation
no cable upstream {<NUM> | <X/Y>} concatenation

Note: When using the cable upstream concatenation command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for a BCM 3140-based DOCSIS
2.0 2:8 CMTS. The cable upstream concatenation command is only
applicable for an upstream port and will only be available through the NUM
argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-107


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

Command Default
Enabled

13-108 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream data-backoff


Use the cable upstream data-backoff command sets data back-off value to assign
automatic or fixed start and stop values. The no cable upstream data-backoff
command returns to the default data back-off value.

Note: The automatic setting is recommended.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} data-backoff {<0-15> <0-15> | automatic}
no cable upstream {<NUM> | <X/Y>} data-backoff {<0-15> <0-15> | automatic}

Note: When using the cable upstream data-backoff command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0
2:8 CMTS. The cable upstream data-backoff command is applicable to
both an upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-109


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
0-15 Start of data backoff
0-15 End of data backoff
automatic Automatic data-backoff.

13-110 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream description


The cable upstream description command is used to specify descriptive information
for a upstream port on the BSR. This information is limited to 80 characters and single
word descriptions are not allowed. Use the characters: _ or - to separate words. For
example, if a upstream port served a certain section of a city, the MSO could assign
the following description:
MOT:7A(config-if)#cable upstream 0 description charlestown_1U

Note: The entered description can be seen in the running configuration, and
in the command output of show commands such as the show ip interface
and show running-config commands.

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} description <LINE>

Note: When using the cable upstream description command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for a BCM 3140-based DOCSIS
2.0 2:8 CMTS. The cable upstream description command is only applicable
for an upstream port and will only be available through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-111


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM is the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
LINE is the text that describes the interface

13-112 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream force-frag


The cable upstream force-frag command is used as a traffic shaping tool that forces
the CM to fragment large upstream packets. When a CM sends a request to the CMTS
for a large data grant that exceeds the configured minislot threshold, the CMTS grants
the CM the configured minislot threshold, which forces the CM to make another data
grant request for the remaining data, thereby causing data packets in the original grant
to be fragmented by the CM.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} force-frag <0-255>
no cable upstream {<NUM> | <X/Y>} force-frag <0-255>

Note: When using the cable upstream force-frag command, only the NUM
option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules. Both
the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream force-frag command is applicable to both an
upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-113


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
0-255 the configured minislot threshold without
fragmentation for large data grants

Command Default
The force fragmentation feature is set to 0 for no forced fragmentation of large data
grants.

13-114 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream frequency


The cable upstream frequency command sets the fixed frequency for the upstream
cable port in Hz. The no cable upstream frequency command returns the default
upstream frequency value. The cable interface does not operate until a fixed upstream
frequency is set. The RF upstream frequency must comply with the expected CM
output frequency.

Note: The Japan DOCSIS Standard must be specified with the cable cmts
type command before an upstream frequency can be selected for any Japan
DOCSIS Standard CMTS module.

Note: Make sure that the upstream frequency selected does not interfere
with the frequencies used for any other upstream applications running in the
cable plant.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage

North American DOCSIS/Euro-DOCSIS Standard


cable upstream {<NUM> | <X/Y>} frequency <5000000-65000000>
no cable upstream {<NUM> | <X/Y>} frequency <5000000-65000000>

Japan DOCSIS (J-DOCSIS) Standard


cable upstream {<NUM> | <X/Y>} frequency <10000000-55000000>
no cable upstream {<NUM> | <X/Y>} frequency <10000000-55000000>

Compass ID: 188656176 Version 5 MGBI 13-115


BSR 64000 Command Reference Guide Release 4.2.0

Note: When using the cable upstream frequency command, only the NUM
option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules. Both
the NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream frequency command is only applicable for an
upstream port and will only be available through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
5000000-42000000 the upstream frequency value; valid entries
are from 5000000 to 42000000 Hertz (Hz) for
DOCSIS or 5000000 to 65000000 Hz for
Euro-DOCSIS
10000000-55000000 the upstream frequency value for the Japan
DOCSIS (J-DOCSIS) Standard

Command Default
None

13-116 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream hopping-seed


The cable upstream hopping-seed command specifies the 15 bit S-CDMA hopping
seed value used for the code hopping sequence initialization.

Note: The logical channel must be disabled to specify a new hopping seed
value.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} hopping-seed <0-32767>
no cable upstream {<NUM> | <X/Y>} hopping-seed <0-32767>

Note: When using the cable upstream hopping-seed command, both the
NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream hopping-seed command is only applicable for
an upstream port and logical channel and will only be available through the
X/Y argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-117


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port and logical channel number
(0-3)
0-32767 the hopping seed value (0 disables code
hopping)

13-118 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream ingress-canceller enable


The cable upstream ingress-canceller enable command enables the ingress
canceller feature for an upstream cable port. Ingress cancellation is a DOCSIS 2.0
feature that protects against worst case plant impairments such as common path
distortion (CPD), citizen band (CB), short-wave radio, and ham radio by opening
unused portions of the upstream Spectrum. The no cable upstream ingress-canceller
enable command disables the ingress canceller feature for an upstream cable port.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} ingress-canceller enable
no cable upstream {<NUM> | <X/Y>} ingress-canceller enable

Note: When using the cable upstream ingress-canceller enable


command, only the NUM option displays for a 1:4, 1:8 or BCM 3138-based
2:8 CMTS modules. Both the NUM and X/Y arguments display for a BCM
3140-based DOCSIS 2.0 2:8 CMTS. The cable upstream
ingress-canceller enable command is only applicable for an upstream port
and will only be available through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-119


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

Command Default
Enabled

13-120 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream ingress-canceller idle-interval


The cable upstream ingress-canceller idle-interval command configures the idle
interval for the ingress canceller feature.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} ingress-canceller idle-interval <256-512>
frequency <1-20>
no cable upstream {<NUM> | <X/Y>} ingress-canceller idle-interval <256-512>
frequency <1-20>

Note: When using the cable upstream ingress-canceller idle-interval


command, only the NUM option displays for a 1:4, 1:8 or BCM 3138-based
2:8 CMTS modules. Both the NUM and X/Y arguments display for a BCM
3140-based DOCSIS 2.0 2:8 CMTS. The cable upstream ingress-canceller
idle-interval command is only applicable for an upstream port and will only
be available through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-121


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
256-512 the range of the idle interval in symbols
frequency 1-20 the range of the idle frequency

13-122 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream invited-range-interval


The cable upstream invited-range-interval command is used to define the amount
of time in milliseconds allowed by the CMTS between ranging requests transmitted
by the cable modem (CM). The no cable upstream invited-range-interval command
returns to the default value.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} invited-range-interval <0-30000>
no cable upstream {<NUM> | <X/Y>} invited-range-interval <0-30000>

Note: When using the cable upstream invited-range-interval command,


only the NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS
modules. Both the NUM and X/Y arguments display for a BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream invited-range-interval
command is only applicable for an upstream port and will only be available
through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-123


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
0-30000 the time in milliseconds allowed by the
CMTS between ranging requests transmitted
by the cable modem

Command Default
10000 milliseconds

13-124 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream iuc11-grant-size


The cable upstream iuc11-grant-size command specifies the size of the Interval
Usage Code (IUC) 11 Advanced Unsolicited Grant burst descriptor when configuring
a DOCSIS 2.0 upstream logical channel.

Note: If a modulation profile for an upstream channel does not support IUC
11, the configuration of the IUC 11 byte size will be not be allowed. If a
modulation profile for an upstream channel is changed and the new
modulation profile does not support IUC 11, the IUC 11 byte size muset be
reset to "0".

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} iuc11-grant-size [<0-1024>]
no cable upstream {<NUM> | <X/Y>} iuc11-grant-size [<0-1024>]

Note: When using the cable upstream iuc11-grant-size command, both the
NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream iuc11-grant-size command is only applicable
for an upstream port and logical channel and will only be available through
the X/Y argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-125


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port and logical channel number
(0-3)
0-1024 the grant size in bytes

Command Default
0 bytes

13-126 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream loadbalance-group


The cable upstream loadbalance-group command assigns an upstream channel to a
load balancing group. The no cable upstream loadbalance-group command
removes an upstream channel from a load balancing group.

Note: The upstream channel can not be assigned to multiple load balancing
groups unless the load balancing groups are defined as restricted.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} loadbalance-group <WORD>
no cable upstream {<NUM> | <X/Y>} loadbalance-group <WORD>

Note: When using the cable upstream loadbalance-group command, only


the NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS
modules. Both the NUM and X/Y arguments display for a BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream loadbalance-group
command is only applicable for an upstream port and will only be available
through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-127


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
WORD the load balancing group name

13-128 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream maintain-power-density on


The cable upstream maintain-power-density on command enables the Maintain
Power Spectral Density feature for each logical channel. If Maintain Power Spectral
Density is enabled and the modulation rate is different from the previous UCD, the
cable modem must change its transmit power level to keep the power spectral density
as close as possible to what it was prior to the modulation rate change. The no cable
upstream maintain-power-density on command disables the Maintain Power
Spectral Density feature. If Maintain Power Spectral Density is disabled, the cable
modem maintains the same power level that it was using prior to the modulation rate
change.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} maintain-power-density on
no cable upstream {<NUM> | <X/Y>} maintain-power-density on

Note: When using the cable upstream maintain-power-density on


command, both the NUM and X/Y arguments display for a BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream maintain-power-density on
command is only applicable for an upstream port and logical channel and will
only be available through the X/Y argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

Compass ID: 188656176 Version 5 MGBI 13-129


BSR 64000 Command Reference Guide Release 4.2.0

NUM the upstream port number


X/Y the upstream port and logical channel number
(0-3)

13-130 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream map-interval


The cable upstream map-interval command is used to determine the time interval in
microseconds for bandwidth maps messages (MAP) to be used by the CM to allocate
upstream time slots. The no cable upstream map-interval command resets the
upstream interval to the default.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} map-interval <2000-16000>
no cable upstream {<NUM> | <X/Y>} map-interval <2000-16000>

Note: When using the cable upstream map-interval command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0
2:8 CMTS. The cable upstream map-interval command is applicable to
both an upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

2000-16000 Interval value in microseconds.

Compass ID: 188656176 Version 5 MGBI 13-131


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
4000 microseconds

13-132 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream max-calls


The Maximum Assigned Bandwidth (MAB) feature is used on the cable interface to
regulate the number of Voice-over-IP (VOIP) calls that are available on a particular
upstream channel for Unsolicited Grant Service (UGS) and Unsolicited Grant Service
with Activity Detection UGS-AD constant bit rate (CBR) data flows. A definitive
limit on the number of voice calls ensures that bandwidth resources are not overused
on an upstream channel.
Use the cable upstream max-calls command to configure the maximum number of
voice calls for an upstream channel. The no cable upstream max-calls command
returns the maximum number of voice calls to the default value.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} max-calls <0-255>
no cable upstream {<NUM> | <X/Y>} max-calls <0-255>

Note: When using the cable upstream max-calls command, only the NUM
option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules. Both
the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream max-calls command is applicable to both an
upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-133


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
0-255 Number of voice calls permitted on the
upstream channel.

Command Default
The default maximum number of calls is 0.

13-134 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream minislot-size


Use the cable upstream minislot-size command to set the number of 6.25
microsecond ticks in each upstream minislot. The no cable upstream minislot-size
command returns the minislot size to the default value.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} minislot-size [2 | 4 | 8 | 16 | 32 | 64 | 128]
no cable upstream {<NUM> | <X/Y>} minislot-size [2 | 4 | 8 | 16 | 32 | 64 | 128]

Note: When using the cable upstream minislot-size command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0
2:8 CMTS. The cable upstream minislot-size command is applicable to
both an upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-135


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
2 Channel Width Valid Minislot Sizes
4 3200000 Hz 2,4,8 ticks
8 1600000 Hz 4,8,16 ticks
16 800000 Hz 8,16,32 ticks
32 400000 Hz 16,32,64 ticks
64 200000 Hz 32,64,128 ticks
128

Command Defaults
Channel Width Minislot Size
3200000 Hz 4 ticks
1600000 Hz 8 ticks
800000 Hz 16 ticks
400000 Hz 32 ticks
200000 Hz 64 ticks

13-136 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream modem-ranging-delay


The cable upstream modem-ranging-delay command specifies the maximum cable
modem ranging delay in microseconds (usec). The ranging delay of a modem is the
timing adjustment that would be sent to the modem if it were located next to the
CMTS. For example, if a modem is located next to the CMTS and the show cable
modem command indicates a timing offset of 1800 (10MHz clock units), the ranging
delay for the modem is (1800 x 100)/1024 = 175-microseconds. The maximum
modem ranging delay is used in sizing Initial Maintenance intervals in the upstream
and is used for no other purpose. Initial Maintenance is the upstream interval that a
cable modem uses to send its initial ranging request message when it wants to join the
network. The no cable upstream modem-ranging-delay command restores the
default value.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} modem-ranging-delay <0-600>
no cable upstream {<NUM> | <X/Y>} modem-ranging-delay

Note: When using the cable upstream modem-ranging-delay command,


only the NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS
modules. Both the NUM and X/Y arguments display for a BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream modem-ranging-delay
command is only applicable for an upstream port and will only be available
through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-137


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
0-600 the maximum ranging timing offset in
microseconds

Command Default
250 microseconds

13-138 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream modulation-profile


The cable upstream modulation-profile is used to apply an upstream modulation
profile to an upstream channel. The no cable upstream modulation-profile
command returns the modulation profile to modulation profile 1.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} modulation-profile <1-600>
no cable upstream {<NUM> | <X/Y>} modulation-profile <1-600>

Note: When a modulation profile is assigned to an upstream channel, the


assignment will be rejected if any of the following rules are violated:

• Differential encoding can only be enabled for TDMA, MTDMA, and


ATDMA channel types not the SCDMA channel type.
• Differential encoding can only be enabled for bursts using the QPSK and
16QAM modulation types.
• For the TDMA and MTDMA channel types, the differential encoding
setting (enabled or disabled) must be the same for IUC's 1, 3, 4, 5, and 6.
• For the ATDMA channel type, the differential encoding setting (enabled or
disabled) must be the same for IUC's 1, 3, and 4.
• For the MTDMA and ATDMA channel types, the differential encoding
setting (enabled or disabled) must be the same for IUC's 9, 10, and (if
defined) IUC 11.

Compass ID: 188656176 Version 5 MGBI 13-139


BSR 64000 Command Reference Guide Release 4.2.0

Note: When using the cable upstream modulation-profile command, only


the NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS
modules. Both the NUM and X/Y arguments display for BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream modulation-profile command
is applicable to both an upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
1-600 the modulation profile number

Command Default
modulation profile 1

13-140 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream physical-delay


The CMTS physical delay function is used to specify the maximum round-trip
propagation delay between the CMTS and cable modems (CMs). The CMTS can
optionally set the physical delay automatically.
The cable upstream physical-delay command is used to set fixed or automatic
physical delay parameters. You can use the following options to adjust the physical
delay function:
■ A single fixed time can be set for physical delay.
■ Physical delay parameters can be configured so that they are adjusted
automatically by the BSR when you specify the automatic option with a
specified minimum and maximum microsecond range.
■ If you do not want to specify a range for the automatic option, select the
automatic option only.
The no cable upstream physical-delay command changes the physical delay setting
back to the default value.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} physical-delay {<10-1600> | automatic
[<10-1600> <10-1600>]}
no cable upstream {<NUM> | <X/Y>} physical-delay {<10-1600> | automatic
[<10-1600> <10-1600>]}

Compass ID: 188656176 Version 5 MGBI 13-141


BSR 64000 Command Reference Guide Release 4.2.0

Note: When using the cable upstream physical-delay command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for a BCM 3140-based DOCSIS
2.0 2:8 CMTS. The cable upstream physical-delay command is only
applicable for an upstream port and will only be available through the NUM
argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

10-1600 the fixed physical delay in microseconds


automatic the automatic physical delay in microseconds
10-1600 the automatic minimum physical delay in
microseconds - the default is 200
microseconds
10-1600 the automatic maximum physical delay in
microseconds - the default is 1600
microseconds

Command Default
The fixed physical delay is 800 microseconds
The 800 microsecond default setting is an optimal setting for HFC networks with a
radius of not more than 50 miles (i.e., distance to the farthest cable modem).

13-142 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

However, when the default setting of 800 microseconds is in force on HFC plants
with a radius larger than 50 miles, cable modems may not be able to register or pass
data reliably since the round-trip propagation delay exceeds the configured value for
the physical delay (i.e, cable modems are not given enough time to register).

Note: Setting a physical delay value larger than required is allowed, although
data passing performance will not be optimized. However, do not set a
physical delay value smaller than required since this might cause some cable
modems to become inoperable.

Should you need to change the default value for the physical delay, refer to the
guidelines in the table that follows or calculate a setting value using the formulas that
follow the table.

BSR
Physical
Delay One-way One-Way Round trip Round trip
Transit Delay Setting distance Distance distance distance
(microsecon (microsecs) (miles) (kilometers) (miles) (kilometers)
800 1,600 100.0 160.9 200.0 321.9
700 1,400 87.5 140.8 175.0 281.6
600 1,200 75.0 120.7 150.0 241.4
500 1,000 62.5 100.6 125.0 201.2
400 800 50.0 80.5 100.0 160.9
300 600 37.5 60.4 75.0 120.7
200 400 25.0 40.2 50.0 80.5
100 200 12.5 20.1 25.0 40.2

To calculate a setting value for your HFC plant, follow these steps using one of the
formulas provided in Step 2:
1. Determine the distance from the BSR 64000 (i.e, CMTS) to the most distant cable
modem measured in miles (or kilometers) of HFC (i.e, physical cable length).
2. Calculate the value for the physical delay using one of the following formulas:
For HFC measured in miles:

Compass ID: 188656176 Version 5 MGBI 13-143


BSR 64000 Command Reference Guide Release 4.2.0

16 x L = PD
where
L is the value determined in Step 1.
PD is the value to specify for the command cable upstream physical-delay
For HFC measured in kilometers:
9.95 x L = PD

where
L is the value determined in Step 1.
PD is the value to specify for the command cable upstream physical-delay

Note: The physical delay cannot be configured to a value less than 10


microseconds.

13-144 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream power-level


The BSR CMTS interface controls CM output power levels to meet the desired
CMTS upstream input power level. Input power level adjustments to an upstream port
compensate for CMTS signal degradation between the optical receiver and the
upstream RF port.
The cable upstream power-level command is used to set the upstream input power
level in absolute mode. In absolute mode, the input power level does not change when
the upstream channel width is changed. Defining the input power level in absolute
mode could possibly cause upstream return lasers to clip on a completely populated
upstream channel.

Caution: If the power level is not explicitly set on the upstream interfaces,
they default to 0 dBmV in absolute mode with a 3.2 MHz, 2560 kilosymbols
per second rate. Ensure that the correct power level is set on each upstream
channel.

Table 13-2 describes how the upstream channel bandwidth corresponds to the input
power-level range and default power-level range for a specific upstream channel.

Table 13-2 Upstream Input Power Level Range Parameters

Modulation Upstream Channel Default Power-level


Rate Bandwidth Power-level Range
160 ksym/s 200 kHz -1 dBmV -16 to +14 dBmV
320 ksym/s 400 kHz +2 dBmV -13 to +17 dBmV
640 ksym/s 800 kHz +5 dBmV -10 to +20 dBmV
1280 ksym/s 1600 kHz +8 dBmV -7 to +23 dBmV
2560 ksym/s 3200 kHz +11 dBmV -4 to +26 dBmV
5120 ksym/s 6400 kHz -1 to +29 dBmV

Caution: Use caution when increasing the input power level in absolute
mode. The CMs on the HFC network increase their transmit power level by 3
dB for every incremental upstream channel bandwidth change, causing an
increase in the total power on the upstream channel. This may violate the
upstream return laser design parameters

Compass ID: 188656176 Version 5 MGBI 13-145


BSR 64000 Command Reference Guide Release 4.2.0

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} power-level <200-3200>
no cable upstream {<NUM> | <X/Y>} power-level <200-3200>

Note: When using the cable upstream power-level command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for a BCM 3140-based DOCSIS
2.0 2:8 CMTS. The cable upstream power-level command is only
applicable for an upstream port and will only be available through the NUM
argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number

X/Y the upstream port number and logical channel


number (0-3)
200-3200 the input power level, expressed in dB

Command Default
0 dB

13-146 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Example
The following example shows how to use the cable upstream power-level command
to set the upstream input power level to +5 dBmV in absolute mode, which keeps the
input power level at +5 dBmV regardless of the upstream channel bandwidth setting,
as shown below:

MOT(config-if)#cable upstream 0 power-level 50

Compass ID: 188656176 Version 5 MGBI 13-147


BSR 64000 Command Reference Guide Release 4.2.0

cable upstream power-level default


The BSR CMTS interface controls CM output power levels to meet the desired
CMTS upstream input power level. Input power level adjustments to an upstream port
compensate for CMTS signal degradation between the optical receiver and the
upstream RF port.
The cable upstream power-level default command is used to set the upstream input
power level in relative mode, which means that the input power level changes when
the upstream channel width is changed. For example, if the input power level is +11
dBmV for a DOCSIS 3.2 MHz upstream channel bandwidth setting in relative mode
and is changed to 1.6 MHz, the default receive power is +8 dBmV. The default power
levels for the 3.2 MHz and 1.6 MHz channels are equal relative to their respective
channel bandwidth settings

Caution: If the power level is not explicitly set on the upstream interfaces,
they default to 0 dBmV in absolute mode with a 3.2 MHz, 2560 kilosymbols
per second rate. Ensure that the correct power level is set on each upstream
channel.

Table 13-3 describes how the upstream channel bandwidth corresponds to the input
power-level range and default power-level range for a specific upstream channel.

Table 13-3 Upstream Input Power Level Range Parameters

Upstream Channel Default Power-level Power-level


Bandwidth Range Range
200 KHz -1 dBmV -16 to +14 dBmV
400 KHz +2 dBmV -13 to +17 dBmV
800 KHz +5 dBmV -10 to +20 dBmV
1.6 MHz +8 dBmV -7 to +23 dBmV
3.2 MHz +11 dBmV -4 to +26 dBmV

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

13-148 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Line Usage


cable upstream {<NUM> | <X/Y>} power-level default {<-150 - +150>}
no cable upstream {<NUM> | <X/Y>} power-level default {<-150 - +150>}

Note: When using the cable upstream power-level default command, only
the NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS
modules. Both the NUM and X/Y arguments display for a BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream power-level default command
is only applicable for an upstream port and will only be available through the
NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
-150 - +150 the number of dB above or below the default
input power level

Command Default
0 dB

Command Example
The following example shows how to use the cable upstream power-level default
command to set the input power level for a 3.2 MHz channel in relative mode from
+11 dBmV to +5 dBmV:
MOT(config-if)#cable upstream 0 power-level default -60
The default input power level is reduced by 6 dB. The power level is now +5 dBmV.

Compass ID: 188656176 Version 5 MGBI 13-149


BSR 64000 Command Reference Guide Release 4.2.0

The following example shows how to use the cable upstream power-level default
command to set the input power level for a 3.2 MHz channel in relative mode from
+11 dBmV to 0 dBmV, as shown below:
MOT(config-if)#cable upstream 0 power-level default -110
The default input power level is reduced by 11 dB.

13-150 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream pre-equalization


The cable upstream pre-equalization command enables pre-equalization adjustment
on the upstream port that includes sending pre-equalization coefficients in a ranging
response to a CM to compensate for impairment over the transmission line. The no
cable upstream pre-equalization command disables the pre-equalization function.

Note: Not all CMs support the pre-equalization adjustment. If a CM does not
support this adjustment, the BSR CMTS interface may not be able to receive
upstream data correctly from the CM.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} pre-equalization
no cable upstream {<NUM> | <X/Y>} pre-equalization

Note: When using the cable upstream pre-equalization command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for a BCM 3140-based DOCSIS
2.0 2:8 CMTS. The cable upstream pre-equalization command is only
applicable for an upstream port and will only be available through the NUM
argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-151


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

13-152 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream range-backoff


Use the cable upstream range-backoff command to set the start and end upstream
range-backoff values for a CM or re-establish a CM if a power outage occurs. Use the
no cable upstream range-backoff command return the ranging back-off default
value. If you choose automatic, the system sets the upstream data-backoff start and
end values.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} range-backoff {<0-15> <0-15> | automatic}
no cable upstream {<NUM> | <X/Y>} range-backoff {<0-15> <0-15> | automatic}

Note: When using the cable upstream range-backoff command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0
2:8 CMTS. The cable upstream range-backoff command is applicable to
both an upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

0-15 start of range backoff

Compass ID: 188656176 Version 5 MGBI 13-153


BSR 64000 Command Reference Guide Release 4.2.0

0-15 end of range backoff


automatic the automatic range backoff.

Command Default
start 0, end 4

13-154 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream range-forced-continue


The cable upstream range-forced-continue command forces a ranging response to
continue for all CMs. The no cable upstream range-forced-continue command
disables forcing a ranging response/

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} range-forced-continue
no cable upstream {<NUM> | <X/Y>} range-forced-continue

Note: When using the cable upstream range-forced-continue command,


only the NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS
modules. Both the NUM and X/Y arguments display for a BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream range-forced-continue
command is only applicable for an upstream port and will only be available
through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

Compass ID: 188656176 Version 5 MGBI 13-155


BSR 64000 Command Reference Guide Release 4.2.0

cable upstream range-power-override


The cable upstream range-power-override command enables CM power
adjustment. The no cable upstream range-power-override command disables CM
power adjustment.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} range-power-override
no cable upstream {<NUM> | <X/Y>} range-power-override

Note: When using the cable upstream range-power-override command,


only the NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS
modules. Both the NUM and X/Y arguments display for a BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream range-power-override
command is only applicable for an upstream port and will only be available
through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

13-156 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream rate-limit


The cable upstream rate-limit command controls whether rate-limiting is applied to
any CM sending upstream data to the CMTS on a given upstream interface. The no
cable upstream rate-limit command changes the rate limit applied to a cable modem
sending upstream data to the CMTS back to the default which is disabled. The
token-bucket algorithm is used for rate-limiting.

Note: If the rate-limit is enabled, data received from cable modems are
rate-limited according to the cable modems configured. Packets may be
buffered at times when any cable modem or the hosts behind the cable
modems transmit data exceeding the permitted bandwidth.

Group Access
MSO

Command Mode
Interface Configuration

Command Line Usage


cable upstream {<NUM> | <X/Y>} rate-limit
no cable upstream {<NUM> | <X/Y>} rate-limit

Note: When using the cable upstream rate-limit command, only the NUM
option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules. Both
the NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream rate-limit command is only applicable for an
upstream port and will only be available through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-157


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

Command Default
Disabled

13-158 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream shutdown


The cable upstream shutdown command administratively disables the upstream
port. The no cable upstream shutdown command enables an upstream port.

Note: Verify that each upstream port is enabled after the port is properly
configured and ready for use.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} shutdown
no cable upstream {<NUM> | <X/Y>} shutdown

Note: When using the cable upstream shutdown command, only the NUM
option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules. Both
the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream shutdown command is applicable to both an
upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-159


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

Command Default
Each upstream port is disabled.

13-160 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream snr-offset


The cable upstream snr-offset command configures the display an SNR value with
an offset. The offset can be configured for each upstream port up to a value of 100 (10
dB) in 10 (1 dB) increments. The offset value will be added to the SNR value when it
is displayed with the show controllers and show interfaces cable upstream
signal-quality CLI commands and through SNMP. The offset value will not be added
to the actual SNR reading that is used by critical tasks such as Spectrum Management.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} snr-offset {10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 |
100}
no cable upstream {<NUM> | <X/Y>} snr-offset {10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 |
90 | 100}

Note: When using the cable upstream snr-offset command, only the NUM
option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules. Both
the NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream snr-offset command is only applicable for an
upstream port and will only be available through the NUM argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Compass ID: 188656176 Version 5 MGBI 13-161


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
the offset value in increments of 10 (1 dB):

10 offset SNR value by 10


20 offset SNR value by 20
30 offset SNR value by 30
40 offset SNR value by 40
50 offset SNR value by 50
60 offset SNR value by 60
70 offset SNR value by 70
80 offset SNR value by 80
90 offset SNR value by 90
100 offset SNR value by 100

13-162 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream spectrum-group


The cable upstream spectrum-group command is used to apply a spectrum group
to an upstream port. The no cable upstream spectrum-group command removes
the spectrum group.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} spectrum-group <WORD>
no cable upstream {<NUM> | <X/Y>} spectrum-group <WORD>

Note: When using the cable upstream spectrum-group command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for a BCM 3140-based DOCSIS
2.0 2:8 CMTS. The cable upstream spectrum-group command is only
applicable for an upstream port and will only be available through the NUM
argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
WORD the exact group name applied to the upstream
port

Compass ID: 188656176 Version 5 MGBI 13-163


BSR 64000 Command Reference Guide Release 4.2.0

cable upstream spread-interval


The cable upstream spread-interval specifies the spreading interval for an S-CDMA
frame. A spreading interval is the time that it takes to transmit one symbol per code
across all 128 codes in an S-CDMA frame. The time duration of an S-CDMA frame is
determined by a configurable number of spreading intervals and the signaling rate.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} spread-interval <1-32>
no cable upstream {<NUM> | <X/Y>} spread-interval <1-32>

Note: When using the cable upstream spread-interval command, both the
NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS. The cable upstream spread-interval command is only applicable for
an upstream port and logical channel and will only be available through the
X/Y argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port and logical channel number
(0-3)
1-32 the spreading interval value

13-164 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream trap-enable-cmts


The cable upstream trap-enable-cmts command enables the
rdnCmtsLinkUpDownTrapEnable trap for an upstream port. The
rdnCmtsLinkUpDownTrapEnable trap indicates whether a CMTS link up or link
down trap should be generated. The no cable upstream trap-enable-rdn command
disables the rdnCmtsLinkUpDownTrapEnable trap.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} trap-enable-cmts
no cable upstream {<NUM> | <X/Y>} trap-enable-cmts

Note: When using the cable upstream trap-enable-cmts command, only


the NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS
modules. Both the NUM and X/Y arguments display for BCM 3140-based
DOCSIS 2.0 2:8 CMTS. The cable upstream trap-enable-cmts command is
applicable to both an upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

Compass ID: 188656176 Version 5 MGBI 13-165


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
Disabled

13-166 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream trap-enable-if


The cable upstream trap-enable-if command enables the ifLinkUpDownTrapEnable
trap for an upstream port. The ifLinkUpDownTrapEnable trap indicates whether a link
up or link down trap should be generated. The cable upstream no trap-enable-if
command disables the ifLinkUpDownTrapEnable trap.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} trap-enable-if
no cable upstream {<NUM> | <X/Y>} trap-enable-if

Note: When using the cable upstream trap-enable-if command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0
2:8 CMTS. The cable upstream trap-enable-if command is applicable to
both an upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number.


X/Y the upstream port number and logical channel
number (0-3)

Compass ID: 188656176 Version 5 MGBI 13-167


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
Disabled

13-168 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable upstream trap-enable-rdn


The cable upstream trap-enable-rdn command enables the
rdnCardIfLinkUpDownEnable trap for an upstream port. The
rdnCardIfLinkUpDownEnable trap indicates whether a link up or link down trap
should be generated. The no cable upstream trap-enable-rdn command disables the
rdnCardIfLinkUpDownEnable trap.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} trap-enable-rdn
no cable upstream {<NUM> | <X/Y>} trap-enable-rdn

Note: When using the cable upstream trap-enable-rdn command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for BCM 3140-based DOCSIS 2.0
2:8 CMTS. The cable upstream trap-enable-rdn command is applicable to
both an upstream port or upstream port and logical channel.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number.


X/Y the upstream port number and logical channel
number (0-3)

Compass ID: 188656176 Version 5 MGBI 13-169


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
Disabled

13-170 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable utilization-interval
The cable utilization-interval command specifies the upstream or downstream
channel utilization calculation interval. The no cable utilization-interval returns the
channel utilization calculation interval to the default value of "0" (disabled).

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable utilization-interval <0-86400>
no cable utilization-interval <0-86400>

Command Syntax

0-86400 the channel utilization interval in seconds, 0


is disabled

Command Default
0 = disabled

Compass ID: 188656176 Version 5 MGBI 13-171


BSR 64000 Command Reference Guide Release 4.2.0

channel-type
The channel-type command specifies the channel type for a modulation profile.
There are four possible channel-types:
■ TDMA - DOCSIS 1.1 channel type
■ ATDMA - DOCSIS 2.0 channel type
■ MTDMA - DOCSIS 1.1 or DOCSIS 2.0 channel type
■ S-CDMA - DOCSIS 2.0 channel type only used for logical channel
configurations

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


channel-type {tdma | atdma | scdma | mtdma}
no channel-type {tdma | atdma | scdma | mtdma}

Command Syntax

tdma TDMA, Time Division Multiple Access -


valid for initial, long, request, short, and
station IUC codes
atdma Advanced TDMA, Time Division Multiple
Access - valid for a-long, a-short, a-ugs,
initial, request, and station IUC codes
scdma S-CDMA Synchronous CDMA, Code
Division Multiple Access - valid for a-long,
a-short, a-ugs, initial, request, and station
IUC codes
mtdma TDMA-A-TDMA - valid for a-long, a-short,
a-ugs, initial, request, and station IUC codes

13-172 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

clear cable dcc-stats


The clear cable dcc-stats command clears all Dynamic Channel Change (DCC)
statistics for all CMTS modules in the BSR chassis or a CMTS module in a specified
slot.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear cable dcc-stats [<X/Y>]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"

Compass ID: 188656176 Version 5 MGBI 13-173


BSR 64000 Command Reference Guide Release 4.2.0

clear cable flap-list


The clear cable flap-list command clears the cable flap-list. You can either clear the
flap-list of a specific cable modem by specifying its MAC address or clear the
flap-lists of all the cable modems by using the all option.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


clear cable flap-list {<mac> | all}

Command Syntax

mac MAC address in the form of xxxx.xxxx.xxxx


all apply to all MAC addresses

13-174 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

clear cable modem


The clear cable modem command is used to either clear the traffic counters or reset a
single cable modem or all cable modems connected to the BSR. The clear cable
modem command options can be used to do the following:
■ Clear or reset a single cable modem by using its MAC address or IP address.
■ Clear or reset specific group of cable modems.
■ Clear or reset all cable modems.

Note: Only users with read/write privileges are allowed to clear cable
modems with the following exception - read only users can clear cable
modems by MAC address or IP address. The clear cable modem all
{counters | reset} command requires read/write privileges.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


clear cable modem {<mac> [<mac>] | <prefix> | all } {counters | reset }

Command Syntax

mac the cable modem’s MAC address


mac a MAC address mask that specifies a group of
cable modems
prefix the cable modem’s IP address
all clear the cable modem traffic counters or
reset all cable modems

counters clear the cable modem traffic counters


reset reset the cable modem

Compass ID: 188656176 Version 5 MGBI 13-175


BSR 64000 Command Reference Guide Release 4.2.0

clear cable modem offline


The clear cable modem offline command removes a cable modem from the list of
offline cable modems. This command allows you to do the following:
■ remove a single offline cable modem from the offline list
■ remove all offline cable modems in a single CMTS from the offline list
■ remove all offline cable modems from the offline list

Note: The cable modem aging timer removes offline cable modems from
the list after the configured timeout period has expired. The clear cable
modem offline command is useful if you need to remove a modem before
the cable modem aging timer has expired or if you are not using the cable
modem aging timer feature.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


clear cable modem offline [<mac> | <X/Y> | slot <NUM>]

Command Syntax

mac the cable modem’s MAC address


X/Y the slot and MAC Domain number of the
CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
slot NUM a CMTS slot number (0-5, 9-14)

13-176 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

clear cable modem sync


The clear cable modem sync command provides a means of updating the SRM’s
cable modem database if the SRM becomes out of synchronization with the CMTS
modules in regard to what cable modems are registered. The clear cable modem sync
command is useful when the show cable modem command is not displaying all of the
cable modems on the system or is displaying duplicate cable modems.
The clear cable modem sync command causes the SRM to clear its cable modem
database and then query each CMTS about their cable modems. The response from
each CMTS is used to rebuild the SRM’s cable modem database.

Note: There is no reason to use the clear cable modem sync command
unless an operator suspects a problem with the display results from the show
cable modem command.

It may take several seconds to completely rebuild the SRM’s cable modem
database.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


clear cable modem sync [slot <NUM>]

Command Syntax

slot NUM specifies a CMTS slot (0-5, 9-14)

Command Defaults
Disabled

Compass ID: 188656176 Version 5 MGBI 13-177


BSR 64000 Command Reference Guide Release 4.2.0

clear cable qos svc-flow statistics


The clear cable qos svc-flow statistics command clears all statistics relating to
downstream rate-limiting for a particular service flow. This is the same information
displayed with the show cable qos svc-flow statistics command.

Group Access
MSO

Command Mode
All modes except User EXEC

Command Line Usage


clear cable qos svc-flow statistics [<X/Y>] [<1-4292967295>]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
1-4292967295 service flow ID

13-178 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

clear cable ucc-stats


The clear cable ucc-stats command clears all UCC statistics for all CMTS modules
in the BSR chassis or a CMTS module in a specified slot.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear cable ucc-stats [<X/Y>]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"

Compass ID: 188656176 Version 5 MGBI 13-179


BSR 64000 Command Reference Guide Release 4.2.0

clear counters cable


The clear counters cable clears counters for a cable interface.

Group Access
All

Command Mode
All modes except User EXEC.

Command Line Usage


clear counters cable <X/Y>

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"

13-180 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

clear interfaces cable upstream signal-quality


The clear interfaces cable upstream signal-quality command clears the unerroreds,
correctables and uncorrectables counters in the show controllers cable upstream
command output.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear interfaces cable <X/Y> upstream {<NUM>} signal-quality

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module:
• the 1:4 or 1:8 CMTS modules
will have a MAC Domain
number of "0"
• the 2:8 and 2:8 (2.0) CMTS
modules will have a MAC
Domain number of "0" or "1"
NUM the upstream port number

Compass ID: 188656176 Version 5 MGBI 13-181


BSR 64000 Command Reference Guide Release 4.2.0

codes-subframe
The codes-subframe command specifies the sub-frame size for an S-CDMA channel
type. The sub-frame size establishes the boundaries over which interleaving is
accomplished

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


codes-subframe <1-128>
no codes-subframe <1-128>

Command Syntax

1-128 the sub-frame size

13-182 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

collect interval
The collect interval command configures the interval rate at which data collection is
performed by the spectrum manager.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


collect interval <60-65535>

Command Syntax

60-65535 The time interval in seconds

Compass ID: 188656176 Version 5 MGBI 13-183


BSR 64000 Command Reference Guide Release 4.2.0

collect resolution
The collect resolution command is used to configure the frequency resolution rate
that the spectrum manager performs.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


collect resolution <200000-400000>

Command Syntax

200000-400000 The resolution in Hertz.

Command Default
200000 Hz

13-184 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

dhcp leasequery authorization on


The dhcp leasequery authorization on command enables the exchange of DHCP
lease query messages between the CMTS and a DHCP server. The no dhcp
leasequery authorization on command disables this exchange.
When an IP packet is either received from or destined to a Host/CPE which does not
have an entry in the BSR’s DHCP Lease table, the DHCP Lease Query feature will
attempt to identify the Host/CPE. If the DHCP Lease Query attempt fails, packets
associated with this Host/CPE are discarded.

Note: For the DHCP Lease Query feature to function properly, host
authorization must also be enabled with the host authorization command.
Host authorization is used for security purposes on a cable network.

Group Access
System Administrator

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


dhcp leasequery {authorization {on}}
no dhcp leasequery {authorization {on}}

Command Syntax

authorization Authorization configuration


on Turn on the authorization (Disables Proxy
ARP)

Compass ID: 188656176 Version 5 MGBI 13-185


BSR 64000 Command Reference Guide Release 4.2.0

differential-encoding on
The differential-encoding on command specifies whether or not differential
encoding is used in this modulation profile. Differential encoding is a technique
where data is transmitted according to the phase change between two modulation
symbols instead of by the absolute phase of a symbol. Differential encoding makes
the absolute phase of the received signal insignificant and has the effect of doubling
the BER for the same C/N. The no differential-encoding on command disables
differential encoding for this modulation profile.

Note: If a modulation profile is in use, differential encoding cannot be enabled


or disabled for any of the burst types. To enable or disable differential
encoding for a burst type, an operator must copy the modulation profile to a
new modulation profile number, enable or disable differential encoding for the
new modulation profile, and assign the new modulation profile to the desired
upstream channel. Attempting to enable or disable differential encoding for a
modulation profile that is in use will generate the following error message:

[10/07-10:26:06.59- 07:CRMTASK]-E-mod profile in use, cannot


change diff encoding

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


differential-encoding on
no differential-encoding on

13-186 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

docstest
The docstest command globally enables or disables DOCSIS 2.0 test mode on the
BSR through the DOCSIS 2.0 Testing MIB (SP-TestMIBv2.0-D02-030530). The
DOCSIS 2.0 Testing MIB is used to test DOCSIS 2.0 protocol compliance through a
set of objects used to manage DOCSIS 2.0 Cable Modem (CM) and Cable Modem
Termination System (CMTS) programmable test features.

Note: The DOCSIS 2.0 Testing MIB is considered to be an adjunct to the


DOCSIS 2.0 Specification rather than a part of that specification. Support for
this MIB does not indicate compliance with the DOCSIS 2.0 specification.
Conversely, lack of support for this MIB does not indicate non-compliance
with the DOCSIS 2.0 specification. However, support for this MIB is
mandatory for all DOCSIS 2.0 compliant CMs and CMTSs that are submitted
for Certification and Qualification by CableLabs.

Once DOCSIS 2.0 test mode is enabled with the docstest enable command,
the BSR remains in DOCSIS 2.0 test mode until the test mode is disabled
with the docstest disable command or the system is rebooted.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


docstest {disable | enable }

Command Syntax

disable disable DOCSIS 2.0 test mode


enable enable DOCSIS 2.0 test mode

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 13-187


docstest type
The docstest type command allows you to specifiy the type of DOCSIS 2.0 test to be
used through a series of enumerated test modes. The enumerated test mode selected
with the docstest type command corresponds to an integer "TYPE" field in the
DOCSIS 2.0 Testing MIB’s CM/CMTS TLV Table.

Note: DOCSIS 2.0 test mode must be enabled with the docstest enable
command before a DOCSIS 2.0 test type can be specified.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


docstest type {<1-112>{<Slot/Port>}} [LINE]
no docstest type {<1-112>{<Slot/Port>}} [LINE]

Command Syntax

1-112 the enumerated test mode corresponding to an


integer "TYPE" field in the DOCSIS 2.0
Testing MIB’s CM/CMTS TLV Table
Slot/Port the slot and port number in the BSR chassis
containing an installed DOCSIS 2.0 2:8
CMTS module
LINE specifies the data required for the test - up to
510 characters can be entered with first two
characters being the length and value of the
data that follows - the length and value
correspond to the LENGTH and VALUE
fields from the DOCSIS 2.0 Testing MIB’s
CM/CMTS TLV Table
Release 4.2.0 CMTS Commands

fec-codeword
This fec codeword command specifies the number of information bytes for each FEC
codeword.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


fec-codeword <16-253>
no fec-codeword <16-253>

Command Syntax

16-253 the number of information bytes for each FEC


codeword

Compass ID: 188656176 Version 5 MGBI 13-189


BSR 64000 Command Reference Guide Release 4.2.0

fec-correction
The fec-correction command specifies the number of bytes that can be corrected per
Forward Error Correction (FEC) code word. This is the number of bytes that the FEC
decoder can correct within a codeword. A FEC codeword consists of information and
parity bytes for error correction. The number of parity bytes is equal to two times the
number of correctable errors. The size of correctable errors is dictated by channel
impairments.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


fec-correction <0-16>
no fec-correction <0-16>

Command Syntax

0-16 the FEC correction value - 0 indicates no


Forward Error Correction

13-190 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

fft display
The fft display command displays the FFT power level measurement data to the
console or telnet session in one of the two formats: table or graph (ASCII plot).
Power level measurement data is retrieved either from an operational CMTS module
or a file system. The user specifies a frequency range for which power level
measurement data is to be displayed.

Caution: Running the fft display command can impact voice performance.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


fft display {Slot/Port | nvram: <WORD> | flash: <WORD>} startfreq
{<0-81920000>} endfreq {<0-81920000>} {table | graph}

Command Syntax

Slot/Port operational 2:8 CMTS slot number and valid


upstream port number
nvram: retrieve the power level measurement data
from the NVRAM file system
flash: retrieve the power level measurement data
from the flash file system
WORD power level measurement data filename -
limit of 20 characters excluding the ".fft"
filename extension
startfreq 0-81920000 start of the frequency range (0 Hz - 81.92
MHz)

Compass ID: 188656176 Version 5 MGBI 13-191


BSR 64000 Command Reference Guide Release 4.2.0

endfreq 0-81920000 end of the frequency range (0 Hz - 81.92


MHz)
table | graph specify table or graph display format

13-192 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

fft setup
The fft setup command can be used to configure the FFT processor on the BCM3138/
BCM3140 chip set or to display the current FFT processor configuration.

Caution: Running the fft setup command can impact voice performance.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


fft setup <Slot/Port> [sample {<256-2048>} mode {Tap-in} window {blackman |
blackman-harris | hamming | hanning | rectangular}]

Command Syntax

Slot/Port operational 2:8 CMTS slot number and a


valid upstream port number

sample 256-2048 number of samples of the power level


measurement
mode Tap-in RF Sentry operational mode
window window coefficient to shape the output of the
power level measurement (rectangular,
hamming, hanning, blackman, or
blackman-harris)

Command Defaults
sample = 2048
window = rectangular

Compass ID: 188656176 Version 5 MGBI 13-193


BSR 64000 Command Reference Guide Release 4.2.0

fft start
The fft start command initiates the power level measurement using the FFT
algorithm via the RF Sentry.

Note: The sample, mode, and window arguments are optional with the fft
start command but can be used to override the current FFT processor
configuration specified with the fft setup command and initiate power level
measurement with a new FFT processor configuration.

Caution: Running the fft start command can impact voice performance.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


fft start <Slot/Port> [sample {<256-2048>}] [mode {Tap-in}] [window
{rectangular | hamming | hanning | blackman | blackman-harris}]

Command Syntax

Slot/Port operational 2:8 CMTS slot number and a


valid upstream port number
sample 256-2048 number of samples of the power level
measurement
mode Tap-in RF Sentry operational mode
window window coefficient to shape the output of the
power level measurement (rectangular,
hamming, hanning, blackman, or
blackman-harris)

13-194 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

fft store
The fft store command saves the latest FFT power level measurement data for a
CMTS module to a file system. The user specifies a particular slot and port, the file
system (NVRAM or Flash), and a file name without any extension to be used to store
the FFT power level measurement data. An extension of ".fft" will be automatically
added to the file name.

Caution: Running the fft store command can impact voice performance.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


fft store Slot/Port {nvram: <WORD> | flash: <WORD>}

Command Syntax

Slot/Port operational 2:8 CMTS slot number and valid


upstream port number
nvram: store the power level measurement data to the
NVRAM file system
flash: store the power level measurement data to the
Flash file system
WORD power level measurement data filename -
limit of 20 characters not including any
filename extension

Compass ID: 188656176 Version 5 MGBI 13-195


BSR 64000 Command Reference Guide Release 4.2.0

guard-band
The guard-band command is used to define the minimum spectrum separation or
spacing between upstream channels in the same spectrum group.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


guard-band {<0-37000000> | <0-60000000>}
no guard-band {<0-37000000> | <0-60000000>}

Command Syntax

0-37000000 The guard band separation size in Hertz for


North America.
0-60000000 The guard band separation size in Hertz for
Europe.

Command Default
North America = 0 Hz
Europe = 0 Hz

13-196 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

hop action band


The hop action band command is used to determine the search order for each
frequency band during the frequency hop action.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop action band <5000000-42000000> <5000000-42000000> [priority <1-255>]
no hop action band <5000000-42000000> <5000000-42000000> [priority
<1-255>]

Command Syntax

5000000-42000000 The start upstream frequency band in Hertz.


5000000-42000000 The end upstream frequency band in Hertz.
1-255 The upstream band priority number.The
lower number takes precedence.

Command Default
upstream band priority = 128

Compass ID: 188656176 Version 5 MGBI 13-197


BSR 64000 Command Reference Guide Release 4.2.0

hop action channel-width


The hop action channel-width command is used to change the upstream
channel-width setting before a frequency hop action.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop action channel-width {1600000 | 200000 | 3200000 | 400000 | 800000}
[priority <1-255>]
no hop action channel-width {1600000 | 200000 | 3200000 | 400000 | 800000}
[priority <1-255>]

Command Syntax

The upstream channel width setting.

1600000 1600000 = Channel width of 1600 kHz


200000 200000 = Channel width of 200 kHz
3200000 3200000 = Channel width of 3200 kHz
400000 400000 = Channel width of 400 kHz
800000 800000 = Channel width of 800 kHz
1-255 The upstream band priority number.The
lower number takes precedence.

Command Default
upstream band priority = 128

13-198 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

hop action frequency


The hop action frequency command is used to determine the frequency search order
for either discrete center frequencies or frequency bands during the frequency hop
action.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop action frequency <5000000-42000000> [priority <1-255>]
no hop action frequency <5000000-42000000> [priority <1-255>]

Command Syntax

5000000-42000000 The upstream frequency in Hertz


1-255 The upstream band priority number.The
lower number takes precedence.

Command Default
upstream band priority = 128

Compass ID: 188656176 Version 5 MGBI 13-199


BSR 64000 Command Reference Guide Release 4.2.0

hop action modulation-profile


The hop action modulation-profile command is used to change the modulation
profile setting before a frequency hop action.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop action modulation-profile <1-600> [priority <1-255>]
no hop action modulation-profile <1-600> [priority <1-255>]

Command Syntax

1-16 The modulation profile number.


1-255 The upstream band priority number.The
lower number takes precedence.

Command Default
modulation profiles = 1 or 2
upstream band priority = 128

13-200 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

hop action power-level


The hop action power-level command is used to change the power-level setting before
a frequency hop action.Table 13-4 describes how the upstream channel bandwidth
corresponds to the input power-level range and default power-level range for a
specific upstream channel.

Table 13-4 Upstream Input Power Level Range Parameters

Upstream Channel Default Power-level Power-level


Bandwidth Range Range
200 KHz -1 dBmV -16 to +14 dBmV
400 KHz +2 dBmV -13 to +17 dBmV
800 KHz +5 dBmV -10 to +20 dBmV
1.6 MHz +8 dBmV -7 to +23 dBmV
3.2 MHz +11 dBmV -4 to +26 dBmV

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop action power-level {<200-3200> | default < -150 - +150>} [priority <1-255>]
no hop action power-level {<200-3200> | default < -150 - +150>} [priority
<1-255>]

Command Syntax

200 - 3200 The input power level, expressed in kHz.


default -150 - +150 The number in tenths of a dB above or below
the default input power level.
1-255 The upstream band priority number.The
lower number takes precedence.

Compass ID: 188656176 Version 5 MGBI 13-201


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
upstream band priority = 128

13-202 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

hop action roll-back


The hop action roll-back command is used to return the upstream channel width or
modulation profile setting, that was adjusted during a hop action, to the original
configuration when upstream channel conditions improve.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop action roll-back
no hop action roll-back

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 13-203


BSR 64000 Command Reference Guide Release 4.2.0

hop period
The hop period command is used to prevent excessive frequency hops on an
upstream port.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop period <30-3600>
no hop period <30-3600>

Command Syntax

30-3600 The rate at which the frequency hop takes


place in seconds.

Command Default
300 seconds

13-204 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

hop threshold error


A frequency hopping error threshold is configured to prevent unnecessary frequency
hops in instances when a minimal number of errors are generated. The frequency
hopping error threshold is determined by an error percentage. The hop threshold
error command is used to trigger the hop error threshold.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop threshold error <1-1000>
no hop threshold error <1-1000>

Command Syntax

1-1000 the threshold percentage of errors that can


generated before the hop threshold flap is
triggered - the error rate as a fraction of 1000,
for example, an error rate of 1 implies 0.1%

Command Default
Enabled
10, 1%

Compass ID: 188656176 Version 5 MGBI 13-205


BSR 64000 Command Reference Guide Release 4.2.0

hop threshold flap


A frequency hopping threshold is configured to prevent unnecessary frequency hops
in instances when one or a minimal number of cable modems (CMs) lose their
connection with the BSR. The frequency hopping threshold is determined by the
percentage of CMs that lose their connectivity. The hop threshold flap command is
used to trigger the hop threshold flap when the number of CMs greater than a set
percentage lose their connectivity.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop threshold flap <1-100>
no hop threshold flap <1-100>

Command Syntax

1-100 the threshold percentage of CMs that can lose


connectivity before the hop threshold flap is
triggered

Command Default
Disabled

13-206 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

interface cable
The interface cable command is used to enter cable interface configuration mode.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


interface cable <X/Y>

Command Syntax

X/Y the BSR CMTS slot and port number

Compass ID: 188656176 Version 5 MGBI 13-207


BSR 64000 Command Reference Guide Release 4.2.0

interleaver-block-size
The interleaver-block-size command specifies the interleaver block size for an
ATDMA or MTDMA channel. Interleaving is a technique which improves the error
correction of channel noise such as burst errors. The interleaver re-arranges
transmitted data and distributes it among different interleaver blocks. At the receiver
end, the interleaved data is arranged back into the original sequence by a
de-interleaver. By intermixing the transmitted data and reassembling it on the receiver
end, any transmission errors are spread out over a greater transmission time.
Forward error correction (FEC) is very effective on errors that are spread out.
Interleaving spreads bursts of errors over several blocks so that the maximum number
of errors in each block stays within the number of correctable errors. Since most
errors occur in bursts, this is an efficient way to improve the error rate. Interleaver
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. This allows the FEC algorithm a greater chance of
detecting and correcting any transmission errors.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


interleaver-block-size <32-2048>
no interleaver-block-size <32-2048>

Command Syntax

32-2048 the ATDMA or MTDMA interleaver block


size value

13-208 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

interleaver-depth
The interleaver-depth command specifies the interleaver depth for an ATDMA or
MTDMA channel. This command sets the interleaver minimum latency. A higher
interleaver depth provides more protection from bursts errors by spreading out the bits
for each codeword over a greater transmission time. However, a higher depth also
increases downstream latency, which may slow TCP/IP throughput for some
configurations.
DOCSIS 2.0 specifies five different interleaver depths - 128:1 is the highest amount
of interleaving and 8:16 is the lowest.
■ 128:1 indicates that 128 codewords made up of 128 symbols each will be
intermixed on a 1 for 1 basis
■ 8:16 indicates that 16 symbols will be kept in a row per codeword and intermixed
with 16 symbols from 7 other codewords.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


interleaver-depth <0-128>
no interleaver-depth <0-128>

Command Syntax

0-128 the ATDMA or MTDMA interleaver depth


value

Compass ID: 188656176 Version 5 MGBI 13-209


BSR 64000 Command Reference Guide Release 4.2.0

interleaver-step-size
The interleaver-step-size command specifies the interleaver step size for an
S-CDMA channel. The interleaver step size is the amount time that symbols are
dispersed in time within the frame due to interleaving .

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


interleaver-step-size <1-31>
no interleaver-step-size <1-31>

Command Syntax

1-31 the interleaver step size value

13-210 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

ip address
The ip address command configures a primary or secondary IP address for an
interface or defines the Gateway IP address (giaddr) for Customer Premises
Equipment (CPE), Multimedia Telephone Adapter (MTA), or cable modem DHCP
requests. The no ip address command is used to remove an IP address from the
interface. When configuring the cable interface IP address two additional options are
supported; the host and mta options.
The additional options are only available from cable interface configuration mode
when selecting an IP address. During the DHCP process, the relay agent requests an
IP address in a particular subnet by inserting the IP address of the interface into the
DHCP requests from CMs, hosts, and MTAs. The primary address is always inserted
in cable modem DHCP requests. If a secondary address or a secondary host address is
defined, then the first secondary or secondary host IP address in the list is inserted into
DHCP requests from hosts. If one or multiple secondary mta IP address are defined,
then the first secondary mta IP address defined is inserted into DHCP requests from
secondary MTA devices. The ip dhcp relay information option command must be
enabled to allow the BSR to determine what type of device originated the DHCP
request. By default, the primary address will be inserted into DHCP requests.
When an operator wants to support multiple ISP providers, the ip address command
can be used to group secondary subnets together. Basically one secondary is defined
for CMs and another secondary subnet is defined for CPEs. The CM subnet and the
CPE subnet are bound through the use of the isp-bind option of the ip address
command. First the secondary subnet for CMs is defined and then the secondary
subnet for CPE's is defined using isp-bind option. To bind the CPE subnet with the
CM subnet, the CM subnet address is entered after the isp-bind option is entered
while configuring the secondary subnet for CPE's.

Note: Supporting multiple ISPs on the BSR requires significant coordination


between the operator provisioning system and the configuration of the BSR.
Refer to Selecting a Specific ISP in the BSR 64000 Configuration and
Management Guide.

Note: You must configure a primary IP address before configuring a


secondary IP address.

Compass ID: 188656176 Version 5 MGBI 13-211


BSR 64000 Command Reference Guide Release 4.2.0

Note: The host or mta optional parameters can be specified with a


secondary IP address on a loopback interface. However, these parameters
will have no effect unless the loopback interface is configured as a virtual
cable bundle master.

Group Access
System Administrator

Command Mode
Interface Configuration (cable or loopback interfaces only)

Command Line Usage


ip address <A.B.C.D> <A.B.C.D> [ secondary [ host | mta ][isp-bind <A.B.C.D>]]]
no ip address <A.B.C.D> <A.B.C.D> [ secondary [ host | mta ][isp-bind
<A.B.C.D>]]]

Command Syntax

A.B.C.D the IP address

A.B.C.D the subnetwork mask for the IP address - the


BSR supports up to a 30-bit subnetwork IP
address mask
secondary designates the specified IP address as a
secondary IP address - on a cable interface,
defines this IP address as the IP address to be
inserted into host DHCP requests
host defines the IP address for the cable interface
as the giaddr for host DHCP requests - on the
cable interface, defines this IP address as the
IP address to be inserted into host DHCP
requests

13-212 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

mta defines the IP address for the cable interface


as the giaddr for all MTA DHCP requests - on
the cable interface, defines this IP address as
the IP address to be inserted into MTA DHCP
requests
isp-bind A.B.C.D specifies the secondary IP subnet to which
this secondary address is bound.

Compass ID: 188656176 Version 5 MGBI 13-213


BSR 64000 Command Reference Guide Release 4.2.0

ip dhcp relay information option


The IP DHCP relay function is used only when multiple subnetworks are configured
on the same cable interface. The IP DHCP relay function gathers broadcast DHCP
MAC discovery packets from a DHCP host, such as a CM or Customer Premises
Equipment (CPE), and redirect the packets to their corresponding DHCP server or
DHCP server profile if there is only one DHCP server. The DHCP server assigns an
IP address to the CM or CPE that requested the IP address.
Use the ip dhcp relay information option command to enable the DHCP option-82
relay-agent on the cable interface. Use the no ip dhcp relay information option
command to disable the DHCP option-82 relay-agent on the cable interface.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip dhcp relay information option
no ip dhcp relay information option

Command Default
DHCP option-82 disabled

13-214 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

iuc
The iuc command is used to completely configure a modulation profile without
having to enter individual IUC submodes.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


iuc {a-long | a-short | a-ugs | initial | long | request | short | station} [atdma |
mtdma | scdma | tdma] {128qam | 16qam | 256qam | 32qam | 64qam | 8qam |
qpsk} {<0-16>} {<16-253>} {fixed | short} {<0-255>} {off | on} {<0x0-0x7fff>}
{off | on} {none | qpsk0 | qpsk1} {<0-1536>} {<0-2048>} {<0-2048>} {<0-32>}
{off | on} {<0-128>} {off | on}
no iuc {a-long | a-short | a-ugs | initial | long | request | short | station} [atdma |
mtdma | scdma | tdma] {128qam | 16qam | 256qam | 32qam | 64qam | 8qam |
qpsk} {<0-16>} {<16-253>} {fixed | short} {<0-255>} {off | on} {<0x0-0x7fff>}
{off | on} {none | qpsk0 | qpsk1} {<0-1536>} {<0-2048>} {<0-2048>} {<0-32>}
{off | on} {<0-128>} {off | on}

Command Syntax

a-long Advanced PHY long data grant


a-short Advanced PHY short data grant
a-ugs Unsolicited Grant Service
initial Initial Ranging Burst
long Long Grant Burst
request Request Burst
short Short Grant Burst
station Station Ranging Burst

Compass ID: 188656176 Version 5 MGBI 13-215


BSR 64000 Command Reference Guide Release 4.2.0

128qam 128qam is used for DOCSIS 2.0 ATDMA or


16qam S-CDMA channel types only - creates a
256qam default 128 -QAM modulation type where all
bursts are sent using 128-QAM
32qam
64qam
256qam is used for DOCSIS 2.0 ATDMA or
8qam
S-CDMA channel types only - creates a
qpsk default 256 -QAM modulation type where all
bursts are sent using 256-QAM

16qam creates a default 16-QAM modulation


type where all bursts are sent using 16-QAM

32qam is used for DOCSIS 2.0 ATDMA or


S-CDMA channel types only - creates a
default 32-QAM modulation type where all
bursts are sent using 32-QAM

64qam used for DOCSIS 2.0 ATDMA or


S-CDMA channel types only - creates a
default 64-QAM modulation type where all
bursts are sent using 64-QAM

8qam is used for DOCSIS 2.0 ATDMA or


S-CDMA channel types only - creates a
default 8-QAM modulation type where all
bursts are sent using 8-QAM

qpsk creates a default QPSK modulation type


where all bursts are sent using QPSK
16-253 the FEC code word length
fixed fixed handling of FEC for last code word
short shortened handling of FEC for last code word
0-255 the maximum burst length in minislots
off | on disable/enable scrambler

13-216 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

0x0-0x7fff the scrambler seed in hexadecimal format


off | on disable/enable differential encoding
Note: If a modulation profile is in use, differential
encoding cannot be enabled or disabled for any
of the burst types. To enable or disable
differential encoding for a burst type, an operator
must copy the modulation profile to a new
modulation profile number, enable or disable
differential encoding for the new modulation
profile, and assign the new modulation profile to
the desired upstream channel. Attempting to
enable or disable differential encoding for a
modulation profile that is in use will generate the
following error message:

[10/07-10:26:06.59-
07:CRMTASK]-E-mod profile in use,
cannot change diff encoding

none the preamble type


qpsk0 low power QPSK preamble
qpsk1 high power QPSK preamble
0-1536 the preamble length in bits
0-2048 the interleaver depth value
0-2048 the interleaver block size value
0-32 the interleaver step size
off | on turn spreader off/on (S-CDMA only)
0-128 the codes subframe value (S-CDMA only)
off | on turn TCM encoding off/on - indicates
whether trellis code modulation (TCM) is
enabled for (S-CDMA only)
16-253 the FEC code word length

Compass ID: 188656176 Version 5 MGBI 13-217


BSR 64000 Command Reference Guide Release 4.2.0

last-codeword-length
The last-codeword-length command specifies fixed or shortened handling of FEC
for last code word.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


last-codeword-length {fixed | shortened}
no last-codeword-length {fixed | shortened}

Command Syntax

fixed fixed handling of FEC for last code word


shortened shortened handling of FEC for last code word

13-218 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

load-balancing
The load-balancing command is used to configure a load balancing group.

Group Access
MSO

Command Mode
Load Balancing Group Configuration

Command Line Usage


load-balancing {init-tech <1-31> | mode {disabled | enabled} | policy <WORD>} |
restricted {false | true}}
no load-balancing {init-tech <1-31> | mode {disabled | enabled} | policy
<WORD>} | restricted {false | true}}

Command Syntax

init-tech 1-31 configures a default initialization technique


bitmap for a load balancing group
mode the load balancing mode; disabled or
enabled - enabled means the load balancing
will occur autonomously (based on policy
rules) between channels that are assigned to
this group
policy WORD the load balancing group's policy name
restricted the load balancing group’s restricted status:

false - load-balancing group type is general


true - load-balancing group type is restricted

Command Defaults
mode = disabled
policy = 0
restricted = false

Compass ID: 188656176 Version 5 MGBI 13-219


BSR 64000 Command Reference Guide Release 4.2.0

load-balancing static
Static upstream load balancing evenly distributes cable modems across multiple
upstream channels serving the same geographical community or Spectrum Group.
Load balancing is based on the cable modem count on each upstream channel. Static
load balancing means that the BSR will only attempt to move a cable modem to
another upstream channel after the modem’s registration process is complete.
The load-balancing static command enables static load balancing for a Spectrum
Group. The no load-balancing static command disables static load balancing.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


load-balancing static
no load-balancing static

Command Default
Disabled

Note: The load-balancing static command cannot move cable modems


registered with a TLV type 2. To move cable modems registered with a TLV
type 2, you must use the cable modem ucc command.

13-220 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

max-burst
The max-burst command is used to specify the maximum burst length in minislots.
The maximum burst length is used to determine the breakpoint between packets that
use the short data grant burst profile and packets that use the long data grant burst
profile. If the required upstream time to transmit a packet is greater than this value,
the long data grant burst profile is used. If the time is less than or equal to this value,
the short data grant burst profile is used.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


max-burst <0-255>
no max-burst <0-255>

Command Syntax

0-255 the maximum burst value in minislots

Compass ID: 188656176 Version 5 MGBI 13-221


BSR 64000 Command Reference Guide Release 4.2.0

modulation-type
The modulation-type command specifies the digital frequency modulation technique
used in a modulation profile.
■ Quadrature Phase Shift Keying (QPSK) is a digital frequency modulation
technique is used primarily for sending data from the cable subscriber upstream.
■ Quadrature Amplitude Modulation (QAM) is a digital frequency modulation
technique is primarily used for sending data downstream.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


modulation-type {qpsk | 16qam | 8qam | 32qam | 64qam | 128qam | 256qam}
no modulation-type {qpsk | 16qam | 8qam | 32qam | 64qam | 128qam | 256qam}

13-222 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Syntax

qpsk qpsk creates a default QPSK modulation type


16qam where all bursts are sent using QPSK
8qam
32qam 16qam creates a default 16-QAM modulation
64qam type where all bursts are sent using 16-QAM
128qam
256qam 8qam is used for DOCSIS 2.0 ATDMA or
S-CDMA channel types only - creates a
default 8-QAM modulation type where all
bursts are sent using 8-QAM

32qam is used for DOCSIS 2.0 ATDMA or


S-CDMA channel types only - creates a
default 32-QAM modulation type where all
bursts are sent using 32-QAM

64qam used for DOCSIS 2.0 ATDMA or


S-CDMA channel types only - creates a
default 64-QAM modulation type where all
bursts are sent using 64-QAM

128qam is used for DOCSIS 2.0 ATDMA or


S-CDMA channel types only - creates a
default 128 -QAM modulation type where all
bursts are sent using 128-QAM.

256qam is used for DOCSIS 2.0 ATDMA or


S-CDMA channel types only - creates a
default 256 -QAM modulation type where all
bursts are sent using 256-QAM.

Compass ID: 188656176 Version 5 MGBI 13-223


BSR 64000 Command Reference Guide Release 4.2.0

ping docsis
The ping docsis command is used to “ping” a cable modem (CM) on the network at
the MAC layer to determine if the CM is online by entering the CM’s MAC or IP
address.
When a DOCSIS ping is initiated, the BSR sends a test packet downstream towards
the CM to test its connection. In most instances, this command is used to determine if
a particular CM is able to communicate at the MAC address layer when a cable
modem has connectivity problems at the network layer. For example, if a CM is
unable to register and obtain an IP address, the ping DOCSIS command can help you
determine if there are provisioning problems associated with the CM.

Group Access
MSO

Command Mode
Privileged EXEC and Interface Configuration

Command Line Usage


ping docsis {<mac> | <prefix>} [<1-100>]

Command Syntax

mac The MAC address of the CM in the form of


xxxx.xxxx.xxxx.
prefix The IP address of the CM.
1-100 The number of ping test packets to be sent to
the cable modem.

13-224 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

policy rule
The policy rule command adds an existing policy rule to a load balancing policy. The
no policy rule command removes a policy rule from a load balancing policy.

Group Access
MSO

Command Mode
Load Balancing Policy Configuration

Command Line Usage


policy rule <WORD> [snmp-index <0-4294967295>]
no policy rule <WORD> [snmp-index <0-4294967295>]

Command Syntax

WORD the rule name


snmp-index the SNMP index
0-4294967295

Compass ID: 188656176 Version 5 MGBI 13-225


BSR 64000 Command Reference Guide Release 4.2.0

preamble-length
The preamble-length command is used to specify the preamble length in bits. The
preamble length is used to define a synchronizing string of modulation symbols that is
used to allow the receiver to find the phase and timing of the transmitted burst.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


preamble-length <0-1536>
no preamble-length <0-1536>

Command Syntax

0-1536 the preamble length in bits - 0 indicates no


preamble:
0-1536 is used for DOCSIS 2.0 bursts
0-1024 is used for DOCSIS 1.x bursts

13-226 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

preamble-type
The preamble-type command specifies the preamble format for DOCSIS ATDMA.
MTDMA, and S-CDMA channel type modulation profiles. The preamble format is
specified through the Quadrature Phase-Shift Keying (QPSK) digital modulation
technique.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


preamble-type {qpsk0 | qpsk1}
no preamble-type {qpsk0 | qpsk1}

Command Syntax

qpsk0 low power QPSK preamble

qpsk1 high power QPSK preamble

Compass ID: 188656176 Version 5 MGBI 13-227


BSR 64000 Command Reference Guide Release 4.2.0

scrambler-mode
The scrambler-mode command enables or disables the scrambler. The scrambler is
used to generate an almost random sequence of transmission symbols. This ensures an
even distribution of transmissions through the channel.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


scrambler-mode {off | on}
no scrambler-mode {off | on}

Command Syntax

off disable the scrambler


on enable the scrambler

13-228 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

scrambler-seed
The scramber-seed command specifies a scrambler seed value as a hexidecimal
number. The scrambler seed is the initial value that is used to start the scrambler’s
pseudo-randomizer to scramble the bits. As the transmitter and receiver know the
scrambler seed value, scrambling can be reversed at the receiver leaving only the
original data.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


scrambler-seed <0x00-0x7fff>
no scrambler-seed <0x00-0x7fff>

Command Syntax

0x00-0x7fff the scrambler seed value

Compass ID: 188656176 Version 5 MGBI 13-229


BSR 64000 Command Reference Guide Release 4.2.0

show bindings
The show bindings command shows bindings, or mapping, between CMTS and
HSIM. The following is an example of typical screen output from the show bindings
command:

CMTS slot 3 is automatically mapped to HSIM slot 9


CMTS slot 4 is automatically mapped to HSIM slot 15

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show bindings [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]
show bindings [ | {count | count-only}]]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

13-230 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable binding


The show cable binding command displays downstream and upstream binding
information. The binding information displayed can include:
■ a single CMTS slot and its associated MAC domain (0).
■ all MAC domains associated with a single CMTS slot which would include
binding information for two MAC domains if a 2:8 Primary CMTS Resource
Module is installed in that slot and two MAC domains have been configured on
the module.
■ all CMTS slot and MAC domain associations for the entire BSR chassis.
The following is typical screen output from the show cable binding command
displaying CMTS slot and MAC domain associations for the entire BSR chassis:

Cable 0/0: downstream 0; upstream 0,1,2,3


Cable 0/1: downstream 1; upstream 4,5,6,7
Cable 1/0: downstream 0; upstream 0,1,2,3
Cable 1/1: downstream 1; upstream 4,5,6,7
Cable 2/0: downstream 0; upstream 0,1,2,3,4,5,6,7
Cable 4/0: downstream 0; upstream 0,1,2,3,4,5,6,7
Cable 9/0: downstream 0; upstream 0,1,2,3
Cable 10/0: downstream 0; upstream 0,1,2,3
Cable 11/0: downstream 0; upstream 0,1,2,3
Cable 12/0: downstream 0; upstream 0,1,2,3

Note: Use the show chassis status command to determine what CMTS
modules are installed in the BSR chassis.

Group Access
MSO

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 13-231


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show cable binding [cable <X/Y> | slot <NUM>]

Command Syntax

cable X/Y display binding information for a single MAC


domain associated with a CMTS slot
slot NUM display binding information for all MAC
domains associated with a single CMTS slot -
binding information for two MAC domains
may be displayed if a 2:8 Primary CMTS
Resource Module is installed in that slot and
more than one MAC domain has been
configured on the module

13-232 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable dcc-stats


The show cable dcc-stats command displays DOCSIS Dynamic Channel Change
(DCC) statistics for a MAC domain. The following is an example of typical screen
output from the show cable dcc-stats command:

CMTS Slot: 0 MAC Domain: 0 Interface index: 32513


Number of DCC Reqs : 0
Number of DCC Rsps : 0
Number of DCC Rsps(Depart) : 0
Number of DCC Rsps(Arrive) : 0
Number of DCC Acks : 0
Number of DCC : 0
Number of DCC Fails : 0

CMTS Slot: 3 MAC Domain: 0 Interface index: 229121


Number of DCC Reqs : 0
Number of DCC Rsps : 0
Number of DCC Rsps(Depart) : 0
Number of DCC Rsps(Arrive) : 0
Number of DCC Acks : 0
Number of DCC : 0
Number of DCC Fails : 0

CMTS Slot: 3 MAC Domain: 1 Interface index: 229122


Number of DCC Reqs : 0
Number of DCC Rsps : 0
Number of DCC Rsps(Depart) : 0
Number of DCC Rsps : 0
Number of DCC Rsps(Depart) : 0
Number of DCC Rsps(Arrive) : 0
Number of DCC Acks : 0
Number of DCC : 0
Number of DCC Fails : 0

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Compass ID: 188656176 Version 5 MGBI 13-233


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show cable dcc-stats [<X/Y>]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"

13-234 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable downstream


The show cable downstream command displays the following downstream cable
information:

ifIndex interface index


annex the downstream MPEG framing format
frequency radio frequency carrier center frequency
rfModulation radio frequency enabled
interleaveDepth depth of interleaving to provide protection
from noise
qamMode downstream modulation type
channelWidth radio frequency channel width
powerLevel downstream transmit power level in units of
whole dB to one decimal place
Reserved BW the amount of reserved downstream
bandwidth configured
Spectrum Group the associated Spectrum Group names
rate limit: On indicates whether rate limiting has been
enabled

The following is an example of typical screen output from the show cable
downstream command:

Compass ID: 188656176 Version 5 MGBI 13-235


BSR 64000 Command Reference Guide Release 4.2.0

ifIndex: 98305
description:
annex: B
frequency: 327000000
rfModulation: true
interleaveDepth: 32
qamMode: 256
channelWidth: 6000000
powerLevel: 600 (10th of dB)
Spectrum Group:
rate limit: On

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


show cable downstream [<NUM>]

Command Syntax

NUM MAC domain identification

13-236 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable flap-list


The show cable flap-list command displays the cable flap-list and provides the
following information:.

MAC ID Customer account or street address.


Cable IF Upstream port.
Hit Number of times modem responds to mac
layer keep alive messages, minimum hit rate
one time/30 seconds, can indicate intermittent
upstream, laser clipping, or common-path
distortion. Count should be much higher than
Miss count, if not, modem having problem
maintaining the connection due to upstream
problem, flap count increments each time the
system transitions from a Hit to a Miss.
Miss Number of times modem misses the mac
layer keep-alive message, 8% normal, can
indicate intermittent upstream, laser clipping,
common path distortion.
Ins Number of times the modem comes up and
connect to the network, number of times RF
link reestablished more frequently than time
period configured in the cable flap-list
insertion time command.
P-Adj Number of times the CMTS instructed the
modem to adjust transmit (TX) power beyond
threshold configured with the cable flap-list
power-adjust threshold command, can
indicate unacceptable connections, thermal
sensitivity.
Flap Total of P-Adj and Ins values, high flap-count
modems have high SIDs and may not register.
Rng Number of times the modem exceeded the
missed ranging threshold.

Compass ID: 188656176 Version 5 MGBI 13-237


BSR 64000 Command Reference Guide Release 4.2.0

Type Specifies the type of flap (ranging, timing, or


power)
Time Most recent time modem dropped connection.

The following is an example of typical screen output from the show cable flap-list
command:

MAC ID CableIF Hit Miss Ins Pow Rng Flap Type Time
000b.0643.3b60 4/0 U1 1469 7 0 0 1 1 Rng FRI NOV 05 11:59:39
000b.0643.36c8 4/0 U1 1469 7 0 0 1 1 Rng FRI NOV 05 11:59:40
000b.0643.3b78 4/0 U1 1469 6 0 0 1 1 Rng FRI NOV 05 11:59:40

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable flap-list [sort-flap | sort-interface | sort-time]

Command Syntax

sort-flap Sort by number of times cable modem


flapped.
sort-interface Sort cable modem flaps by interface.
sort-time Sort most recent time cable modem flapped.

13-238 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable insert-interval


The show cable insert-interval command shows the period (in hundredths of a
second) with which Initial Maintenance intervals are scheduled in the upstream. The
following is an example of typical screen output from the show cable insert-interval
command:

Cable insert-interval: 20

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


show cable insert-interval

Compass ID: 188656176 Version 5 MGBI 13-239


BSR 64000 Command Reference Guide Release 4.2.0

show cable loadbalance-group


The show cable loadbalance-group command displays configuration information for
all load balancing groups or a specific load balancing group. The following is an
example of typical output from the show cable loadbalance-group command:

Load Balance Group: lbg-1


SnmpIdx: 1
Id: 1

Member channels:
Cable 11/0 U0
Cable 11/0 U2
Cable 11/0 U3
Cable D0
Cable D1

Configuration:
load-balance mode enabled
load-balance restricted false
load-balance interval 5
load-balance initTech 248
Tech 0: 1
Tech 1: 1
Tech 2: 1
Tech 3: 1
Tech 4: 1
load-balance policy lbp-11

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable loadbalance-group [<WORD>]

13-240 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Syntax

WORD the load balancing group name

Compass ID: 188656176 Version 5 MGBI 13-241


BSR 64000 Command Reference Guide Release 4.2.0

show cable loadbalance-policy


The show cable loadbalance-policy command displays configuration information for
all load balancing policies or a specific load balancing policy. The following is an
example of typical output from the show cable loadbalance-policy command:

Load Balance Policy: lbp-1


SnmpIdx: 1
Id: 1

Rule List:

SnmpIdx: 1
Id: 1
load-balancing is enabled

Load Balance Policy: lbp-2


SnmpIdx: 2
Id: 2

Rule List:

SnmpIdx: 1
Id: 2
load-balancing is disabled for 300 seconds starting at 0 seconds after
12:00 A.M.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable loadbalance-policy [<WORD>]

13-242 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Syntax

WORD the load balancing policy name

Compass ID: 188656176 Version 5 MGBI 13-243


BSR 64000 Command Reference Guide Release 4.2.0

show cable loadbalance-restricted


The show cable loadbalance-restricted command lists all cable modems associated
with a particular restricted load balancing group or all restricted load balancing
groups. The following is an example of typical output from the show cable
loadbalance-restricted command

Cable Load Balance Restricted List:

Group name = test, cm-index = 1:


Mac address: 0000.1111.2222
Mac mask: ffff.ffff.ffff

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable loadbalance-restricted [<1-256> | <WORD>] [snmp-index
<0-4294967295>] [ungrouped]

Command Syntax

1-256 the load balancing group ID


WORD the load balancing group name
snmp-index the SNMP index value
0-4294967295
ungrouped display the ungrouped restricted list

13-244 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable loadbalance-rule


The show cable loadbalance-rule command displays configuration information for
all load balancing rules or a specific load balancing rule. The following is an example
of typical output from the show cable loadbalance-rule command:

Load Balance Rule: lbr-10


SnmpIdx: 10
Id: 1

load-balancing is enabled

Load Balance Rule: lbr-20


SnmpIdx: 20
Id: 2

load-balancing is disabled

Load Balance Rule: lbr-30


SnmpIdx: 30
Id: 3

load-balancing is disabled for 300 seconds starting at 0 seconds after


12:00 A.M.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable loadbalance-rule [<WORD>]

Command Syntax

WORD the load balancing rule name

Compass ID: 188656176 Version 5 MGBI 13-245


BSR 64000 Command Reference Guide Release 4.2.0

show cable modem


The show cable modem command is used to gather a variety of cable modem (CM)
statistical information used to evaluate network performance, troubleshoot
registration problems, and learn specific registration and ranging information on
modems connected to a specific interface.
Use the show cable modem command to see detailed modem configuration
information for a specific head-end modem. The following information is provided:

Interface CM interface with active connection


Upstream IF Index Upstream interface to which the cable
modem belongs.
Downsteam IF Index Downstream interface to which the cable
modem belongs.
Prim SID Primary Service Identifier number.
Connectivity State Describes the connectivity state of a cable
modem. The table below describes the 20
cable modem connectivity states
supported on the BSR.
Timing offset CM current timing adjustment.
Rec Power CM receive downstream receive power
level in units of whole dB to one decimal
place
IP address CM IP address
MAC address Media Access Control layer address

Cable modem connectivity states are as follows:

init(o) Option file transfer was started.


init(t) Time-of-day (TOD) exchange was started.
init(r1) CM sent initial ranging parameters.
init(r2) CM is ranging.
init(rc) Ranging is complete.

13-246 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

dhcp(d) DHCP Discover was sent by CM.


dhcp(o) DHCP Offer was received.
dhcp(req) DHCP Request was sent by CM.
dhcp(ack) DHCP Ack was received, IP address was
assigned by DHCP server.
online CM registered; enabled for data.
online(d) CM registered, but network access for the
CM is disabled.
online(un) CM registered, but not enabled data. Fail
to verify modem's identity by BPI module.
online(pk) CM registered; baseline privacy interface
(BPI) enabled, and key encryption key
(KEK) is assigned.
online(pt) CM registered; BPI enabled, and traffic
encryption key (TEK) is assigned.
reject(m) CM did attempt to register; registration
was refused due to bad mic.
reject(c) CM did attempt to register; registration
was refused due to bad COS.
reject(r) CM did attempt to register, registration
was refused due to unavailable resource.
reject(pk) KEK modem key assignment is rejected.
reject(pt) TEK modem key assignment is rejected.
offline CM is considered to be offline.

The following is an example of typical screen output from the show cable modem
command:

Compass ID: 188656176 Version 5 MGBI 13-247


BSR 64000 Command Reference Guide Release 4.2.0

Interface Prim Connect Timing Rec Ip Address Mac Address


Sid State Offset Power
Cable 4/1/D1U1 5 online(pt) 572 0.0 150.31.101.14 000b.0643.36c8
Cable 4/1/D1U1 1 online(pt) 573 -.2 150.31.101.44 000b.0643.3716
Cable 4/1/D1U1 4 online(pt) 576 0.0 150.31.101.45 000b.0643.3b60
Cable 4/1/D1U1 3 online(pt) 586 0.0 150.31.101.46 000b.0643.3b72
Cable 4/1/D1U1 9 online(pt) 581 0.2 150.31.101.50 000b.0643.3b78
Cable 4/1/D1U1 7 online(pt) 573 0.3 150.31.101.21 000b.0643.3b84
Cable 4/1/D1U1 8 online(pt) 581 0.3 150.31.101.17 000b.0643.3b90
Cable 4/1/D1U1 10 online(pt) 583 0.1 150.31.101.12 000b.0643.3b9a
Cable 4/1/D1U1 2 online(pt) 578 0.3 150.31.101.15 000b.0643.3bb2

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem [subinterface] [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]
show cable modem [subinterface] [ | {count | count-only}]

Command Syntax

subinterface show subinterface information


| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string

13-248 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

count count the number of outputted lines


count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 13-249


BSR 64000 Command Reference Guide Release 4.2.0

show cable modem cpe


The show cable modem cpe command displays the following Customer Premises
Equipment (CPE) information for all cable interfaces, a particular upstream port, or a
specific CPE:

Interface the downstream cable interface and upstream


port the cable modem is connected to
PSID the upstream Primary SID number associated
with this cable modem
CM MAC the cable modem’s MAC address
CM IP the cable modem’s IP address
CPE Count the CPE count per cable modem

The following is an example of typical screen output from the show cable modem
cpe command:

Interface PSID CM MAC CM IP CPE Count


Cable 1/0/D0/U1/C0 1 0020.4026.78a0 150.31.61.54 0

Interface PSID CM MAC CM IP CPE Count


Cable 1/0/D0/U1/C0 2 0020.4028.a230 150.31.61.38 0

Group Access
All

Command Mode
All modes except User EXEC

13-250 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Line Usage


show cable modem <mac> cpe [subinterface] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}] ]
show cable modem <mac> cpe [subinterface] [ | {count | count-only}]
show cable modem cpe <X/Y> [subinterface |upstream <NUM>] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show cable modem cpe <X/Y> [subinterface | upstream <NUM>] [ | {count |
count-only}]

Command Syntax

mac the cable modem’s MAC address


subinterface show subinterface information
X/Y the slot and MAC Domain number of the
CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
upstream NUM the upstream port number
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 13-251


BSR 64000 Command Reference Guide Release 4.2.0

show cable modem detail


The show cable modem detail command displays information for a SID assigned to a
cable modem on a specific CMTS interface or a specific CM connected to a specific
interface. The QoS Profile the cable modem used for registration is displayed in the
"QoS Profile Index" field. The device type is displayed in the device type field: CM =
cable modem, eSTB = embedded Set Top Box. The following is typical output from
the show cable modem detail command.

13-252 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

CM Record (index 1) Dump:


Psid 1
Config 0x2
Status regComplete
BPI Enabled No
MAC Address 0012.2503.52ac
IP Addr 150.31.83.15
US Chan 1
DS Chan 0
Vendor Id 00 00 00
MAX Classifier 0
MAX CPEs 1
Qos Profile 0
Device type CM
--Ranging State--
State 0x4
Retry 0
NoReqCount 0
Pending 0
Rx Power 2
Freq Offset 26
Timing Offset 1791
Last Invited 1567669(ms)
Max Interval 10003(ms)
Max Req Delay 398(ticks)
Equalization Data:
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
##CM Capability:##
Concatenation: 1
DOCSIS Version: DOCSIS 2.0
Fragmentation: 1
PHS: 1
BPI: 1
US SIDs: 4
Transmit Equalizer: 1(Taps/Symbol)
Xmit Equalizer Taps: 24
DCC Support: 1

Compass ID: 188656176 Version 5 MGBI 13-253


BSR 64000 Command Reference Guide Release 4.2.0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem detail {<X/Y> <NUM>} {<MAC>} [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show cable modem detail {<X/Y> <NUM>} {<MAC>} [ | {count | count-only}]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
NUM The Service Identifier assigned to a CM.
MAC The cable modem’s MAC address.
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

13-254 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem hosts


The show cable modem hosts command displays the number of Customer Premises
Equipment (CPE) hosts connected to a specific CM.

MAC Address MAC Prim Ver Frag Concat PHS Priv DS US


State SID Saids Sids
0090.833d.bba0 online 6 DOC1.0 no yes no BPI 0 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem {<mac> | <prefix>} hosts [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem {<mac> | <prefix>} hosts [{count | count-only}]

Command Syntax

mac cable modem MAC address


prefix cable modem IP address
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

Compass ID: 188656176 Version 5 MGBI 13-255


BSR 64000 Command Reference Guide Release 4.2.0

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

13-256 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem loadbalance-group


The show cable modem loadbalance-group command displays cable modem load
balancing group assignments. The following is typical output from the show cable
modem loadbalance-group command:

Cable Mac Address Load Balance


Interface Group Name
Cable 1/0/D0/U0/C0 0008.0e10.3cb2 lbg-1
Cable 1/0/D0/U1/C0 0010.1848.2004 lbg-1
Cable 1/0/D0/U3/C0 0010.9518.f403 lbg-1
Cable 1/0/D0/U3/C0 0012.c90b.cff8 lbg-1
Cable 1/0/D0/U0/C0 0020.4094.e238 lbg-1
Cable 1/0/D0/U1/C0 0050.04b2.f8e0 Not Assigned

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem loadbalance-group [ | {begin | exclude | include} {<WORD>}
| {count | count-only}]
show cable modem loadbalance-group [ | {count | count-only } {<WORD>}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
count count the number of outputted lines

Compass ID: 188656176 Version 5 MGBI 13-257


BSR 64000 Command Reference Guide Release 4.2.0

count-only count the number of lines while


suppressing screen output
exclude filter for output that excludes the
specified string

include filter for output that includes the


specified string
WORD the specified string

13-258 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem mac


The show cable modem mac command displays the following MAC layer (layer 2)
information for all cable modems attached to the BSR, cable modems on a specific
CMTS module, or a specific cable modem:

MAC Address the cable modem’s MAC address


MAC State the stage of connectivity that the cable
modem has achieved with the CMTS - offline
or in one of a number of online, init, or reject
states
Prim SID the Primary SID number associated with this
cable modem
Version the version of the DOCSIS specification that
this cable modem supports (DOC1.0,
DOC1.0+, DOC1.1, DOC2.0) - this field does
not indicate the DOCSIS version that a cable
modem is running. If the modem is offline, a
default version of DOCSIS 1.0 is displayed.

QoS Prov the version of DOCSIS for which the cable


modem is registered and provisioned
Frag yes indicates that this cable modem is capable
of performing DOCSIS 1.1 style
fragmentation
Concat yes indicates that this cable modem is capable
of performing concatenation
PHS yes indicates that this cable modem is capable
of performing DOCSIS 1.1 style Payload
Header Suppression (PHS)
Priv BPI+ indicates that this Cable Modem is
capable of supporting BPI+ encryption if not,
it displays BPI

Compass ID: 188656176 Version 5 MGBI 13-259


BSR 64000 Command Reference Guide Release 4.2.0

DS Saids the number of BPI+ style downstream


Security Association Identifiers (SAIDs) that
this cable modem supports (DOCSIS 1.1
modems only)
US Sids the number of upstream Service IDentifiers
(SIDs) that this cable modem supports
(DOCSIS 1.1 modems only)
Dev the device type field:
CM = cable modem
eSTB = embedded Set Top Box

Note: If the cable modem supports DOCSIS 1.0+, it will be displayed in the
"Version" field of the command output.

The following is typical screen output from the show cable modem mac command:

MAC Address MAC Prim DOC Qos Frag Con PHS Priv DCC DS US Dev
State SID Ver Prov Saids Sids
0011.805f.fd30 online 2 2.0 1.1 yes yes yes BPI+ yes 15 16 eCM
0011.8061.3f0e online 1 2.0 1.1 yes yes yes BPI+ yes 15 16 eCM
000b.0643.33fc online 195 1.0 1.0 no yes no BPI no 0 0 CM
000b.0643.3718 online 203 1.0 1.0 no yes no BPI no 0 0 CM
0020.409a.24c8 online 194 1.1 1.0 no no no BPI no 0 0 CM
00e0.0c60.2854 online 213 1.0 1.0 no no no BPI no 0 0 CM
0011.1ac9.2094 offline 0 1.0 1.0 no no no BPI no 0 0 CM
0011.1aca.1394 online 1 2.0 1.1 yes yes yes BPI+ yes 15 16 eCM
0011.1aca.13a6 online 2 2.0 1.1 yes yes yes BPI+ yes 15 16 eC

Group Access
All

13-260 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem <mac> mac [subinterface] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem <mac> mac [subinterface] [ | {count | count-only}]
show cable modem mac [<X/Y> [subinterface]] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem mac [<X/Y> [subinterface]] [ | {count | count-only}]

Command Syntax

mac the cable modem’s MAC address


subinterface show subinterface information
X/Y the slot and MAC Domain number of the
CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

Compass ID: 188656176 Version 5 MGBI 13-261


BSR 64000 Command Reference Guide Release 4.2.0

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

13-262 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem maintenance


The show cable modem maintenance command displays the following station
maintenance error statistics for all cable modems attached to the BSR, cable modems
on a specific CMTS module, or a specific cable modem:

Mac Address the MAC address of the cable modem


I/F the interface on which the cable modem has
an active connection
Prime Sid the primary service identifier assigned to the
modem
SM Exhausted the number of times a CM was dropped
Count - Time because it did not reply to station
maintenance requests
SM Aborted the number of times the CM was dropped
Count - Time because its operational parameters were
unacceptable including power level outside of
the acceptable range, or the timing offset
changes

The following is typical output from the show cable modem maintenance command:

MAC Address I/F Prim SM Exhausted SM Aborted


Sid Count - Time Count - Time
000b.0643.36c8 4/1/U1 5 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
000b.0643.3716 4/1/U1 1 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
000b.0643.3b60 4/1/U1 4 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
000b.0643.3b72 4/1/U1 3 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
000b.0643.3b78 4/1/U1 9 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
000b.0643.3b84 4/1/U1 7 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
000b.0643.3b90 4/1/U1 8 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
000b.0643.3b9a 4/1/U1 10 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
000b.0643.3bb2 4/1/U1 2 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx

Compass ID: 188656176 Version 5 MGBI 13-263


BSR 64000 Command Reference Guide Release 4.2.0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem <mac> maintenance [subinterface] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show cable modem <mac> maintenance [subinterface] [ | {count | count-only}]
show cable modem maintenance [<X/Y> [subinterface]] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show cable modem maintenance [<X/Y> [subinterface]] [ | {count | count-only}]

Command Syntax

mac the cable modem’s MAC address


subinterface show subinterface information
X/Y the slot and MAC Domain number of the
CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

13-264 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 13-265


BSR 64000 Command Reference Guide Release 4.2.0

show cable modem offline


The show cable modem offline command provides the following information about
cable modems that are offline:

Interface cable modem interface with active


connection
Prim Sid Primary Service Identifier number
Mac address cable modem Media Access Control layer
address
DeRegistration Timestamp the time at which the modem deregistered
in month,date,hh:mm:ss format
lastTxBytes the size of the last transmitted data
lastRxBytes the size of the last received data

The following is an example of typical screen output from the show cable modem
offline command:

Cable Prim Mac Address DeRegistration Last Tx Last Rx


Interface Sid TimeStamp Bytes Bytes
Cable 11/0/D1/U6/C0 0 0011.1ac9.2094 000:00:00:00 0 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem offline [<0-15> | <X/Y> | <mac>] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem offline [<0-15> | <X/Y> | <mac>] [ | {count | count-only}]

13-266 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Syntax

0-15 the BSR 64000 CMTS slot number


X/Y the slot and MAC Domain number of the
CMTS module:
• the 1:4 or 1:8 CMTS modules will
have a MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
mac the cable modem MAC address
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 13-267


BSR 64000 Command Reference Guide Release 4.2.0

show cable modem phy


The show cable modem phy command displays the following physical hardware
information for or all cable modems attached to the BSR, cable modems on a specific
CMTS module, or a specific cable modem:

Mac Address the MAC address of the cable modem


I/F the channel number
USPwr (dBmV) the upstream power level in dBmV as
measured at the CMTS upstream port for this
cable modem
USSNR (tenthdB) the estimated upstream signal to noise ratio of
signals generated by this cable modem as
measured at the CMTS upstream port
Timing Offset the ranging time offset for the cable modem
Mod Type the modulation type for the cable modem -
possible types are:
TDMA - DOCSIS 1.X capable modems or
DOCSIS 2.0 modems with TLV39 DOCSIS
2.0 Mode disabled
ATDMA - DOCSIS 2.0 modems on an
ATDMA or MTDMA channel.
SCDMA - DOCSIS 2.0 modems on an
SCDMA channel

The following is an example of typical screen output from the show cable modem
phy command:

13-268 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

MAC Address I/F USPwr USSNR Timing Mod


(dBmV) (tenthdB) Offset Type
0008.0e10.3cb2 1/0/U0 2 323 1494 TDMA
0010.1848.2004 1/0/U1 2 343 1788 TDMA
0010.9518.f403 1/0/U3 1 356 1872 TDMA
0012.c90b.cff8 1/0/U3 2 356 1787 TDMA
0020.4094.e238 1/0/U0 0 321 1908 TDMA
0050.04b2.f8e0 1/0/U1 -1 343 2088 TDMA

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem <mac> phy [subinterface] [ | {begin | exclude | include}
{<WORD>} | {count | count-only}]
show cable modem <mac> phy [subinterface] [ | {count | count-only }
{<WORD>}]
show cable modem phy [<X/Y> [subinterface]] [ | {begin | exclude | include}
{<WORD>} | {count | count-only}]
show cable modem phy [<X/Y> [subinterface]] [ | {count | count-only }
{<WORD>}]

Command Syntax

mac the cable modem’s MAC address


subinterface show subinterface information

Compass ID: 188656176 Version 5 MGBI 13-269


BSR 64000 Command Reference Guide Release 4.2.0

X/Y the slot and MAC Domain number of


the CMTS module:
• the 1:4 or 1:8 CMTS modules
will have a MAC Domain
number of "0"
• the 2:8 and 2:8 (2.0) CMTS
modules will have a MAC
Domain number of "0" or "1"
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output
exclude filter for output that excludes the
specified string

include filter for output that includes the


specified string
WORD the specified string

13-270 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem registered


The show cable modem registered command displays the following information
about registered cable modems:

Interface cable modem interface with active


connection
Prim Sid Primary Service Identifier number
Connect State describes the connectivity state of a cable
modem. The table below describes the 20
cable modem connectivity states
supported on the BSR
Timing Offset current cable modem timing adjustment.
Rec Power cable modem receive downstream power
level in dbmv
Ip address cable modem IP address
Mac address cable modem Media Access Control layer
address

The following is an example of typical screen output from the show cable modem
registered command:

Interface Prim Connect Timing Rec Ip Address Mac Address


Sid State Offset Power
Cable 4/1/D1U1 4 online(pt) 580 0.2 150.31.101.14 000b.0643.36c8
Cable 4/1/D1U1 6 online(pt) 581 0.1 150.31.101.44 000b.0643.3716
Cable 4/1/D1U1 9 online(pt) 581 0.0 150.31.101.45 000b.0643.3b60
Cable 4/1/D1U1 7 online(pt) 580 0.0 150.31.101.46 000b.0643.3b72
Cable 4/1/D1U1 5 online(pt) 579 0.1 150.31.101.50 000b.0643.3b78
Cable 4/1/D1U1 1 online(pt) 583 0.4 150.31.101.21 000b.0643.3b84
Cable 4/1/D1U1 2 online(pt) 583 0.2 150.31.101.17 000b.0643.3b90
Cable 4/1/D1U1 3 online(pt) 579 0.1 150.31.101.12 000b.0643.3b9a
Cable 4/1/D1U1 8 online(pt) 581 0.0 150.31.101.15 000b.0643.3bb2

Compass ID: 188656176 Version 5 MGBI 13-271


BSR 64000 Command Reference Guide Release 4.2.0

Cable modem connectivity states are as follows:

online CM registered; enabled for data.


online(d) CM registered, but network access for the
CM is disabled.
online(un) CM registered, but not enabled data. Fail
to verify modem's identity by BPI module.
online(pk) CM registered; baseline privacy interface
(BPI) enabled, and key encryption key
(KEK) is assigned.
online(pt) CM registered; BPI enabled, and traffic
encryption key (TEK) is assigned.
reject(r) CM did attempt to register, registration
was refused due to unavailable resource.
reject(pk) KEK modem key assignment is rejected.
reject(pt) TEK modem key assignment is rejected.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem registered [subinterface] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem registered [subinterface] [ | {count | count-only}]

Command Syntax

subinterface show subinterface information


| turns on output modifiers (filters)

13-272 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

begin filter for output that begins with the


specified string
exclude filter for output that excludes the
specified string

include filter for output that includes the


specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 13-273


BSR 64000 Command Reference Guide Release 4.2.0

show cable modem remote-query


The show cable modem remote-query command displays the polled RF parameters
for each cable modem that has registered on the BSR. The show cable modem
remote-query command groups the cable modem's RF parameters in a transmitter/
receiver/channel order, allowing operators to easily determine when upstream or
downstream attenuation on any port needs to be adjusted.
The following is an example of typical screen output from the show cable modem
remote-query command:

Remote Query Polling: Enabled Poll Cycle: Complete

Last Poll Cycle Started: THU APR 14 01:02:05 2005


Last Poll Cycle Completed: THU APR 14 01:02:06 2005

Cable DS US DS Tx Micro Modem


Interface IP Address Mac Address S/N Pwr Pwr Offs Refln State
----------- --------------- -------------- ---- ---- ----- ----- ----- -------
0/0/D0U0C0 172.22.160.80 0008.0e72.49da 39.0 18.0 2.0 3452 28 online
0/0/D0U0C0 172.22.160.81 0008.0e72.bf88 39.2 19.5 3.5 3452 43 online
4/0/D0U0C0 172.22.160.77 0008.0e29.f14a 37.1 43.0 8.7 3465 90 offline
4/0/D0U0C0 172.22.160.79 0008.0e29.f214 37.7 42.0 8.2 3467 28 offline
4/0/D0U0C0 172.22.160.76 0008.0e67.5b2e 36.6 42.0 9.5 3467 92 offline
4/0/D0U0C0 172.22.160.78 0008.0e67.5b3a 37.2 43.0 6.7 3467 91 offline
4/0/D0U0C1 172.22.160.75 000c.e518.7606 0.0 0.0 0.0 0 0 offline
4/1/D1U4C0 172.22.160.18 0010.9507.92d8 38.6 37.2 8.5 3458 23 online
4/1/D1U4C0 172.22.160.22 0010.9507.92e8 36.8 36.2 8.2 3458 23 online
4/1/D1U4C0 172.22.160.23 0010.9507.9320 38.2 37.2 6.1 3459 24 online
4/1/D1U4C0 172.22.160.20 0010.9507.934c 38.7 37.2 6.3 3456 23 online

13-274 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

The show cable modem remote-query command groups the cable modem’s RF
parameters in a transmitter/receiver/channel order which allows an operator to easily
determine when the upstream or downstream attenuation on any port needs to be
adjusted. The following information is displayed:.

Remote Enabled indicates that the Remote Query feature is enabled


Query Disabled indicates that the Remote Query feature is disabled
Polling
Poll Cycle: Complete indicates that Remote Query polling is enabled and no
current polling cycle is in progress
In Progress indicates that Remote Query polling is enabled and the
current poll cycle is in progress
Disabled indicates that Remote Query polling is disabled
Last Poll the date and time at which the last Remote Query polling cycle was
Cycle started - if the Remote Query feature has never been enabled, the field
Started: is not displayed
Last Poll displays the date and time at which the last Remote Query polling
Cycle cycle was completed - if the Remote Query feature has never been
Completed: enabled or the first Remote Query polling cycle has not yet completed,
the field is not displayed
Cable the slot/port/downstream channel number/upstream channel number/
Interface logical channel number of the cable modem
IP Address the IP address of the cable modem
Mac the MAC address of the cable modem
Address
DS S/N the downstream signal to noise ratio in dB - this represents the last
polled value of the cable modems docsIfSigQSignalNoise MIB object
US Pwr the cable modem’s upstream transmit power level, in dBmv, which
represents the last polled value of the cable modem’s
docsIfCmStatusTxPower MIB object - DOCSIS specifies this power
level to be between 8.0 and 54.0 dbMv
DS Pwr the received downstream power level at the cable modem, in dbMv,
which represents the last polled value of the cable modem’s
docsIfdownChannelPower MIB object - DOCSIS specifies this power
level to be between +5.0 and -15.0 dBmv

Compass ID: 188656176 Version 5 MGBI 13-275


BSR 64000 Command Reference Guide Release 4.2.0

Tx Offs the cable modem’s estimate of the current round trip time obtained
from the ranging offset (initial ranging offset + ranging offset
adjustments) which represents the last polled value of the cable
modem’s docsIfUpChannelTxTimingOffset MIB object - the cable
modem uses this offset for timing upstream transmissions to ensure
synchronized arrivals at the CMTS - units are in terms of DOCSIS tick
sixty-fourths with a duration of 6.25 microseconds/64+
Micro Refln estimate of the total microreflections including in-channel responses
perceived on the downstream interface, measured in dBc below the
signal level, which represents the last polled value of the cable
modem’s docsIfSigQMicroreflections MIB object
Modem online indicates that the cable modem is registered properly
State offline indicates that the cable modem is not registered

Note: this field does not display the same set of modem states as the
show cable modem command

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem remote-query [ | {begin | exclude | include} {<WORD>} |
{count | count-only}]
show cable modem remote-query [ | {count | count-only } {<WORD>}]

13-276 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
count count the number of outputted lines

count-only count the number of lines while suppressing


screen output
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

Compass ID: 188656176 Version 5 MGBI 13-277


BSR 64000 Command Reference Guide Release 4.2.0

show cable modem stats


The show cable modem stats command displays the following statistics for each
cable modem on a CMTS module. This includes cable modems that are off-line. The
following information is provided:

Interface cable modem interface with active


connection
Prim Sid Primary Service Identifier number
Connect State describes the connectivity state of a cable
modem. The table below describes the 20
cable modem connectivity states
supported on the BSR.
Mac Address cable modem Media Access Control layer
address
Registration Time the length of time a cable modem has been
registered in ddd:hh:mm:ss format
TxKbytes the number of unicast Kbytes that have
been transmitted
RxKbytes the number of unicast Kbytes that have
been received

The following is an example of typical screen output from the show cable modem
stats command:

Interface Prim Connect Mac Address Registration Tx Rx


Sid State Time Kbytes Kbytes
Cable 4/1/D1U1 8 online(pt) 000b.0643.3bb2 000:19:08:35 154 269

Cable modem connectivity states are as follows:

init(r1) CM sent initial ranging parameters.


init(r2) CM is ranging.
init(rc) ranging is complete.
dhcp(d) DHCP Discover was sent by CM.

13-278 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

dhcp(o) DHCP Offer was received.


dhcp(req) DHCP Request was sent by CM.
dhcp(ack) DHCP Ack was received, IP address was
assigned by DHCP server.
init(o) option file transfer was started.
init(t) Time-of-day (TOD) exchange was started.
online CM registered; enabled for data.
online(d) CM registered, but network access for the
CM is disabled.
online(un) CM registered, but not enabled data. Fail
to verify modem's identity by BPI module.
online(pk) CM registered; baseline privacy interface
(BPI) enabled, and key encryption key
(KEK) is assigned.
online(pt) CM registered; BPI enabled, and traffic
encryption key (TEK) is assigned.
reject(m) CM did attempt to register; registration
was refused due to bad mic.
reject(c) CM did attempt to register; registration
was refused due to bad COS.
reject(r) CM did attempt to register, registration
was refused due to unavailable resource.
reject(pk) KEK modem key assignment is rejected.
reject(pt) TEK modem key assignment is rejected.
offline CM is considered to be offline.

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 13-279


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show cable modem {<X/Y> | <mac> | <prefix>} stats [subinterface] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show cable modem {<X/Y> | <mac> | <prefix>} stats [subinterface] [ | {count |
count-only}]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
mac the cable modem MAC address
prefix the IP address

subinterface show subinterface information


| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

13-280 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem summary


The show cable modem summary command displays cable modem information for
each cable interface on the BSR. The following is an example of typical screen output
from the show cable modem summary command and descriptions of the output
fields:

Interface Cable Modem


Total Registered Unregistered Offline SpecGrp
Cable 1/0/U0 227 134 3 90 Mansfield
Cable 1/0/U1 163 130 0 33 Mansfield
Cable 1/0/U2 151 137 0 14 Mansfield
Cable 1/0/U3 286 230 2 54 Mansfield
Cable 4/0/U0 57 45 0 12 Tewksbury
Cable 4/0/U1 83 49 0 34 Tewksbury

Interface the BSR 64000 CMTS slot, port, and


upstream port number
Total the total number of active, registered, and
offline cable modems
Registered the number of cable modems which have
reached the Online(d), Online (pk),
Online(pt) or Online(un) states
Unregistered the number of cable modems in any Init,
DHCP, Reject state or substate
Offline the number of cable modems which have no
state and are not communicating but were
previously provisioned - these modems are
assumed to be powered off
SpecGrp the Spectrum Group name for each upstream
channel.

Group Access
All

Compass ID: 188656176 Version 5 MGBI 13-281


BSR 64000 Command Reference Guide Release 4.2.0

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem summary [<X/Y> [downstream <NUM> | total ] | subinterface
| total} [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show cable modem summary [<X/Y> [downstream <NUM> | total ] | subinterface
| total} [ | {count | count-only}]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
subinterface show subinterface information
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

13-282 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem summary total


The show cable modem summary total command displays cable modem
information for each cable interface on the BSR. The following is an example of
typical screen output from the show cable modem summary total command and
descriptions of the output fields:

Interface Total Active Registered SpecGrp


Modems Modems Modems Name
Cable 2/0/U0 5 0 5 Mansfield
Cable 2/0/U1 2 0 2 Mansfield
Cable 3/0/U1 1 0 1 Tewksbury
Cable 3/0/U2 1 0 1 Tewksbury
Total 9 0 9

Interface the BSR 64000 CMTS slot and port number


Total Modems the total number of active, registered, and
offline cable modems
Active Modems the number of cable modems in any Init,
DHCP, Reject state or substate
Registered Modems the number of cable modems which have
reached the Online(d), Online (pk),
Online(pt) or Online(un) states
SpecGrp the Spectrum Group name for each upstream
channel.

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 13-283


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show cable modem summary total [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]
show cable modem summary total [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

13-284 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem svc-flow-id


The show cable modem svc-flow-id command displays the following information for
all of the service flows associated with a specific MAC address:

Service flow id the service flow identifier number


Interface cable modem interface with active
connection
Flow Direction the flow direction for this service flow
Flow Max Rate the maximum sustained traffic rate
allowed for this service flow in bits/sec -
no traffic rate limit for this service flow is
indicated by "no restriction"

The following is an example of typical screen output from the show cable modem
svc-flow-id command:

Service flow id Interface Flow Direction Flow Max Rate


9 cable 4/1 Upstream 96000
10 cable 4/1 Downstream 10

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem <mac> svc-flow-id [ | {begin | exclude | include} {<WORD>} [
| {count | count-only}]]
show cable modem <mac> svc-flow-id [ | {count | count-only}]

Command Syntax
mac cable modem Media Access Control layer address
| turns on output modifiers (filters)
begin filter for output that begins with the specified string
exclude filter for output that excludes the specified string

Compass ID: 188656176 Version 5 MGBI 13-285


BSR 64000 Command Reference Guide Release 4.2.0

include filter for output that includes the specified string


WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing screen
output

13-286 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem svc-flow-id detail


The show cable modem svc-flow-id detail command provides detailed information
on all of the service flows associated with a specific MAC address. The following
information is provided:

Dir the flow direction for this service flow


SFID the service flow identifier number
SID the service ID assigned to the cable
modem
Type the service flow type - possible service
flow types are as follows:
• Stat - Static Flow
• Stat* - Static Flow Primary
• DQoS - Dynamic DQoS Flow
Normal Priority
• DQoSE - Dynamic DQoS Flow
Emergency Priority
• Dyn - Dynamic non-DQoS Flow
Normal Priority
• PCMM - PacketCable Multimedia
Flow Normal Priority
• Unknw - Unknown
State the service flow state - possible service
flow states are as follows:
• Activ - the service flow is in an
Active state
• Admit - the service flow is in an
Admitted state
• Prov - the service flow is in a
Provisioned state
• Defer - the service flow is in a
Deferred state

Compass ID: 188656176 Version 5 MGBI 13-287


BSR 64000 Command Reference Guide Release 4.2.0

Sched the upstream service flow scheduling type


- possible upstream service flow
scheduling types are as follows:
• Rsvd - Reserved (for future use)
• Undef - Undefined
• BE - Best Effort
• NRTPS - Non Real Time Polling
Service
• RTPS - Real Time Polling Service
• UGSAD - Usolicited Grant Service
with Activity Detection
• UGS - Unsolicited Grant Service
• Unknwn - Unknown
for downstream service flow scheduling
types this field displays "n/a"
Min-Rate the minimum sustained traffic rate
allowed for this service flow in bits/sec -
no traffic rate limit for this service flow is
indicated by "none"
Max-Rate the maximum sustained traffic rate
allowed for this service flow in bits/sec -
no traffic rate limit for this service flow is
indicated by "none"
Packets the total number of packets for this service
flow
Bytes the total number of bytes for this service
flow

The following is typical output from the show cable modem svc-flow-id detail
command:

13-288 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Dir SFID SID Type State Sched Min-Rate Max-Rate Packets Bytes

Up 17 6 Stat* Activ BE none 64000 105 18747


Up 18 13 Stat Activ BE none 1000000 0 0
Down 19 n/a Stat* Activ n/a none 64000 0 0
Down 20 n/a Stat Activ n/a none 10000000 100 19397
Up 37 19 DQoSE Activ UGS 117600 117600 104723 14451774
Down 38 n/a DQoSE Activ n/a 110400 110400 104724 14451912
Up 41 21 Dyn Activ UGSAD 117600 117600 0 0
Down 42 n/a Dyn Activ n/a 1024 102400 0 0
Up 43 22 Dyn Activ RTPS none none 0 0
Down 44 n/a Dyn Activ n/a 1024 102400 0 0

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem <mac> svc-flow-id detail [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem <mac> svc-flow-id detail [ | {count | count-only}]

Command Syntax

mac cable modem Media Access Control layer address


| turns on output modifiers (filters)
begin filter for output that begins with the specified string
exclude filter for output that excludes the specified string
include filter for output that includes the specified string
WORD the specified string
count count the number of outputted lines

count-only count the number of lines while suppressing screen


output

Compass ID: 188656176 Version 5 MGBI 13-289


BSR 64000 Command Reference Guide Release 4.2.0

show cable modem time-registered


The show cable modem time-registered command displays how long a cable
modem has been registered. This command can be used to specify individual cable
modems, cable modems associated with a particular BSR 64000 chassis slot, or cable
modems associated with a particular Spectrum Group. The following is an example of
typical screen output from the show cable modem time-registered command:

Interface Connect Mac Address Registration


State Time
Cable 4/0/D0/U1/C0 online(pt) 0011.805f.fd30 000:04:24:34
Cable 4/0/D0/U1/C0 online(pt) 0011.8061.3f0e 000:04:24:35

The following information is provided:

Interface cable modem interface with active


connection
Connect State describes the connectivity state of a cable
modem. The table below describes the 20
cable modem connectivity states
supported on the BSR.
Mac Address cable modem Media Access Control layer
address
Registration Time the length of time a cable modem has been
registered in ddd:hh:mm:ss format
Spectrum Group the associated Spectrum Group name

Cable modem connectivity states are as follows:

online CM registered; enabled for data.


online(d) CM registered, but network access for the
CM is disabled.
online(un) CM registered, but not enabled data. Fail
to verify modem's identity by BPI module.

13-290 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

online(pk) CM registered; baseline privacy interface


(BPI) enabled, and key encryption key
(KEK) is assigned.
online(pt) CM registered; BPI enabled, and traffic
encryption key (TEK) is assigned.
reject(m) CM did attempt to register; registration
was refused due to bad mic.
reject(c) CM did attempt to register; registration
was refused due to bad COS.
reject(r) CM did attempt to register, registration
was refused due to unavailable resource.
reject(pk) KEK modem key assignment is rejected.
reject(pt) TEK modem key assignment is rejected.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem time-registered {<mac> [subinterface] | <X/Y> | slot [<NUM>
| subinterface] | subinterface] | spectrum-group [<WORD>[subinterface] |
subinterface ]} [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show cable modem time-registered {<mac> [subinterface] | <X/Y> | slot [<NUM>
| subinterface] | subinterface] | spectrum-group [<WORD>[subinterface] |
subinterface ]} [ | {count | count-only}]

Command Syntax

mac the MAC address of a particular cable modem


subinterface show subinterface information

Compass ID: 188656176 Version 5 MGBI 13-291


BSR 64000 Command Reference Guide Release 4.2.0

X/Y the slot and MAC Domain number of the CMTS


module:
• the 1:4 or 1:8 CMTS modules will have a MAC
Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will have
a MAC Domain number of "0" or "1"
slot NUM the BSR 64000 chassis slot number
spectrum-group WORD the Spectrum Group name
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified string
include filter for output that includes the specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing screen
output

13-292 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem timing-offset


This show cable modem timing-offset command allows the user to select which
cable modems are displayed on the console based on their timing offset value. The
timing offset stored at the cable modem is the accumulation of all the timing
adjustments sent to the cable modem. The cable modem starts at an initial timing
offset which takes into account the cable modem’s internal delays. The BSR cannot
determine at what timing offset a particular cable modem starts and therefore the
values stored and displayed by the BSR are the summation of the adjustments from
the cable modem’s initial timing offset. Since most manufacturers use a different
initial timing offset value, the values stored by the BSR will vary per cable modem
based on the manufacturer.

Note: The true timing offset that a CM is using should be read at the CM
using SNMP. A CM with the highest recorded timing offset could be the
furthest unit away from the BSR and be functioning correctly.

The show cable modem timing-offset command displays the following information
about a cable modem:

Interface cable modem interface with active


connection
Prim Sid Primary Service Identifier number
Connect State describes the connectivity state of a cable
modem. The table below describes the 20
cable modem connectivity states
supported on the BSR
Timing Offset current cable modem timing adjustment
Rec Power cable modem receive downstream power
level in dbmv
Ip address cable modem IP address
Mac address cable modem Media Access Control layer
address

Compass ID: 188656176 Version 5 MGBI 13-293


BSR 64000 Command Reference Guide Release 4.2.0

The following is typical output from the show cable modem timing-offset command:

Interface Prim Connect Timing Rec Ip Address Mac Address


Sid State Offset Power
Cable 4/1/D1U1 6 online(pt) 581 0.1 150.31.101.44 000b.0643.3716
Cable 4/1/D1U1 9 online(pt) 581 0.1 150.31.101.45 000b.0643.3b60
Cable 4/1/D1U1 1 online(pt) 583 0.3 150.31.101.21 000b.0643.3b84
Cable 4/1/D1U1 2 online(pt) 583 0.1 150.31.101.17 000b.0643.3b90
Cable 4/1/D1U1 8 online(pt) 581 0.0 150.31.101.15 000b.0643.3bb2

Cable modem connectivity states are as follows:

init(r1) CM sent initial ranging parameters.


init(r2) CM is ranging.
init(rc) ranging is complete.
dhcp(d) DHCP Discover was sent by CM.
dhcp(o) DHCP Offer was received.
dhcp(req) DHCP Request was sent by CM.
dhcp(ack) DHCP Ack was received, IP address was
assigned by DHCP server.
init(o) option file transfer was started.
init(t) Time-of-day (TOD) exchange was started.
online CM registered; enabled for data.
online(d) CM registered, but network access for the
CM is disabled.
online(un) CM registered, but not enabled data. Fail
to verify modem's identity by BPI module.
online(pk) CM registered; baseline privacy interface
(BPI) enabled, and key encryption key
(KEK) is assigned.
online(pt) CM registered; BPI enabled, and traffic
encryption key (TEK) is assigned.
reject(m) CM did attempt to register; registration
was refused due to bad mic.

13-294 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

reject(c) CM did attempt to register; registration


was refused due to bad COS.
reject(r) CM did attempt to register, registration
was refused due to unavailable resource.
reject(pk) KEK modem key assignment is rejected.
reject(pt) TEK modem key assignment is rejected.
offline CM is considered to be offline.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem timing offset {above | below} <0-500000> [<X/Y>
[subinterface] | subinterface] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show cable modem timing offset {above | below} <0-500000> [<X/Y>
[subinterface] | subinterface] [ | {count | count-only}]

Command Syntax

above identify all cable modems with a timing offset above


the entered number
below identify all cable modems with a timing offset below
the entered number
0-500000 the timing offset value

Compass ID: 188656176 Version 5 MGBI 13-295


BSR 64000 Command Reference Guide Release 4.2.0

X/Y the slot and MAC Domain number of the CMTS


module:
• the 1:4 or 1:8 CMTS modules will have a MAC
Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will have a
MAC Domain number of "0" or "1"
subinterface show subinterface information
| turns on output modifiers (filters)
begin filter for output that begins with the specified string
exclude filter for output that excludes the specified string
include filter for output that includes the specified string
WORD the specified string
count count the number of outputted lines

count-only count the number of lines while suppressing screen


output

13-296 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modem unregistered


The show cable modem unregistered command displays the following information
about unregistered cable modems:

Interface cable modem interface with active


connection
Prim Sid Primary Service Identifier number
Connect State describes the connectivity state of a cable
modem. The table below describes the 20
cable modem connectivity states
supported on the BSR.
Timing Offset current cable modem timing adjustment
Rec Power cable modem receive downstream power
level in dbmv
Ip address cable modem IP address
Mac address cable modem Media Access Control layer
address

Cable modem connectivity states are as follows:

init(r1) CM sent initial ranging parameters.


init(r2) CM is ranging.
init(rc) ranging is complete.
dhcp(d) DHCP Discover was sent by CM.
dhcp(o) DHCP Offer was received.
dhcp(req) DHCP Request was sent by CM.
dhcp(ack) DHCP Ack was received, IP address was
assigned by DHCP server.
init(o) option file transfer was started.
init(t) Time-of-day (TOD) exchange was started.
offline CM is considered to be offline.

Compass ID: 188656176 Version 5 MGBI 13-297


BSR 64000 Command Reference Guide Release 4.2.0

The following is an example of typical screen output from the show cable modem
unregistered command:

Cable 11/0/D0/U6/C0 0 offline 0.0.0.0 0011.1ac9.2094

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem unregistered [subinterface] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem unregistered [subinterface] [ | {count | count-only}]

Command Syntax

subinterface show subinterface information


| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

13-298 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modulation-profile


The show cable modulation-profile command displays all configured modulation
profiles on the BSR. A modulation profile contains six burst profiles sent out in a
UCD message to configure CM transmit parameters. The following is an example of
typical screen output from the show cable modulation-profile command:

Cable Modulation Profile 1


+--------------+------+------+------+------+------+------+------+------+
| | 1 | 3 | 4 | 5 | 6 | 9 | 10 | 11 |
| IUC | Req | Init | Per | Short| Long | Adv | Adv | Adv |
| | | Maint| Maint| Data | Data | Short| Long | UGS |
+--------------+------+------+------+------+------+------+------+------+
Modulation qpsk qpsk qpsk 16qam 16qam 64qam 64qam XXXX
Diff Encoding OFF OFF OFF OFF OFF OFF OFF XXXX
Preamble Len 64 128 128 384 384 120 120 XXXX
FEC Err CRC 0 5 5 5 10 12 16 XXXX
FEC CW Len 16 34 34 78 235 75 220 XXXX
Scrambler Seed 338 338 338 338 338 338 338 XXXX
Max Burst 0 0 0 8 0 6 0 XXXX
Guard Time 8 48 48 8 8 8 8 XXXX
Last Codeword FIXED FIXED FIXED SHORT SHORT SHORT SHORT XXXX
Scrambler ON ON ON ON ON ON ON XXXX
Intlv Depth 1 1 1 1 1 1 1 XXXX
Intlv Blk Sz 1536 1536 1536 0 0 1536 1536 XXXX
Preamble Type QPSK0 QPSK0 QPSK0 NONE NONE QPSK1 QPSK1 XXXX
SCDMA Spreader OFF OFF OFF OFF OFF OFF OFF XXXX
Codes Subfrm 0 0 0 0 0 0 0 XXXX
Intlv Stp Sz 0 0 0 0 0 0 0 XXXX
TCM Encoding OFF OFF OFF OFF OFF OFF OFF XXXX
Channel Type mtdma mtdma mtdma mtdma mtdma mtdma mtdma XXXX

Compass ID: 188656176 Version 5 MGBI 13-299


BSR 64000 Command Reference Guide Release 4.2.0

The show cable modulation-profile command displays the following modulation


profile group information::

Modulation the upstream modulation type


Diff Encoding indicates if differential encoding is enabled/disabled
Preamble Len the preamble length in bits
FEC Err CRC the number of corrected Forward Error Correction (FEC) errors
FEC CW Len the FEC code word length in bytes
Scrambler Seed the scrambler seed in decimal format
Max Burst the maximum burst length in minislots
Guard Time Guard time size
Last Codeword Last codeword shortened
Scrambler Scramble enabled indication
Intlv Depth the interleaver depth value
Intlv Blk Sz the interleaver block size value
Preamble Type the preamble type: NONE, QPSK0, QPSK1
SCDMA enabled/disabled SCDMA spreader
Spreader
Codes Subfrm the codes subframe value
Intlv Stp Sz the interleaver step size value
TCM Encoding enabled/disabled TCM encoding
Channel Type the channel type: atdma, mtdm, scdma, tdma

Note: For a complete list and configuration of all 35 pre-defined modulation


profiles, refer to Appendix A, Pre-Defined Modulation Profiles of the BSR
64000 Configuration and Management Guide.

Group Access
All

13-300 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Mode
All modes except User EXEC

Command Line Usage


show cable modulation-profile [<1-600> [<1-11>]]

Command Syntax

1-600 the modulation profile number


1-11 a specific IUC code:
1 = Request Burst
3 = Initial Maintenance
4 = Station Maintenance
5 = Short Grant Burst
6 = Long Grant Burst
9 = Advanced PHY Short Data Grant
10 = Advanced PHY Long Data Grant
11 = Unsolicited Grant Service

Compass ID: 188656176 Version 5 MGBI 13-301


BSR 64000 Command Reference Guide Release 4.2.0

show cable modulation-profile brief


The show cable modulation-profile brief command displays cursory
information for all configured modulation profiles on the BSR. The show cable
modulation-profile brief command displays which modulation profiles are
pre-defined, pre-defined but modified by the user, or user configured as shown in
the sample commnad output below:

Profile Chan-type Config-status In-use


1 tdma pre-defined yes
2 to 4 tdma pre-defined
5 tdma user-configured
6 tdma user-configured
101 mtdma pre-defined, changed
102 to 104 mtdma pre-defined
201 to 205 atdma pre-defined
301 to 310 scdma pre-defined

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modulation-profile brief

13-302 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable modulation-profile description


The show cable modulation-profile description command displays a description of
the specified modulation profile. The profile number is optional, and if none is
specified, a list of all of the profile descriptions is displayed. The following is an
example of typical screen output from the show cable modulation-profile
description command:

+----+-----------------------------------------------------------------------+
| Id | Profile Description |
+----+-----------------------------------------------------------------------+
1 DOCSIS 1.X-TDMA 16-QAM & Transmit POST-EQ & FEC - for linear distortion
and impulse noise

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modulation-profile description [<1-600>]

Command Syntax

1-600 the modulation profile number

Compass ID: 188656176 Version 5 MGBI 13-303


BSR 64000 Command Reference Guide Release 4.2.0

show cable privacy auth


The show cable privacy auth command displays the AK grace time and life time
values, in seconds. The following is an example of typical screen output from the
show cable privacy auth command:

Interface Cable 3/0


Auth grace time: 600
Auth life time: 604800

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable privacy auth

13-304 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable privacy cm-auth


The show cable privacy cm-auth command displays baseline privacy (BPI)
authorization key (AK) information for an individual cable modem (CM) using its
MAC address. The following is an example of typical screen output from the show
cable privacy cm-auth command:

Version: 1
authCmMacAddr: 0011.805f.fd30
authCmPubKey: 30.81.89.02.81.81.00.AC.2D.1C.37.2D.60.07.43.BC.93.A8.7D.C9.AB.14
.09.CB.C4.37.88.56.09.ED.89.4D.BC.11.17.C8.4F.21.EE.FD.C5.B3.D6.51.A2.67.0E.80.8
E.E1.67.DE.F8.E1.2B.9E.A4.C6.4C.D6.52.76.5F.D5.AB.E6.DD.99.82.D5.5F.1D.99.1A.37.
B6.0D.FC.15.E6.77.3A.70.99.84.EB.D1.BD.E0.1A.3C.33.B0.E3.FD.10.61.89.18.24.F9.2E
.84.AA.73.81.52.9E.24.0A.B4.1D.EC.41.7E.B4.A3.85.F8.09.54.2C.CB.50.E7.FE.97.F0.C
E.BC.5D.D0.8C.7A.D7.02.03.01.00.01
authKeySeqNum: 1
authGraceTime: 600 seconds
authLifeTime: 604800 seconds
authCmReset: 1
authCmReqs: 1
authCmReplys: 1
authCmRejects: 0
authCmInvalids: 0
authRejectErrCode: 1

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


show cable privacy cm-auth [<mac>]

Command Syntax

mac cable modem’s MAC address in the form of


xxxx.xxxx.xxxx.

Compass ID: 188656176 Version 5 MGBI 13-305


BSR 64000 Command Reference Guide Release 4.2.0

show cable privacy cm-tek


The show cable privacy cm-tek command displays Traffic Encryption Key (TEK)
information for a cable modem. The following is an example of typical screen output
from the show cable privacy cm-tek command:

sid: 1
tekLifeTime: 43200
tekGraceTime: 3600
tekReset: 2
keyCmReqs: 24
keyCmReplys: 24
keyCmRejects: 0
tekCmInvalids: 0
keyRejectErrCode: 1
keyRejectErrStr:
tekInvalidErrCode: 1
tekInvalidErrStr:

sid: 2
tekLifeTime: 43200
tekGraceTime: 3600
tekReset: 2
keyCmReqs: 24
keyCmReplys: 24
keyCmRejects: 0
tekCmInvalids: 0
keyRejectErrCode: 1
keyRejectErrStr:
tekInvalidErrCode: 1
tekInvalidErrStr:

Group Access
All

Command Mode
Interface Configuration (cable interface only)

13-306 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Line Usage


show cable privacy cm-tek [<1-8192>]

Command Syntax

1-8192 cable modem’s Service ID number

Compass ID: 188656176 Version 5 MGBI 13-307


BSR 64000 Command Reference Guide Release 4.2.0

show cable privacy cmts


The show cable privacy cmts command displays all the baseline privacy statistics
specified by the MIB for the cable interface.
The following is an example of typical screen output from the show cable privacy
cmts command:

authGraceTime: 600
authLifeTime: 604800
tekGraceTime: 3600
tekLifeTime: 43200
certTrust: 2
certVerPeriod: 1
authCmtsReqs: 9
authCmtsReplys: 9
authCmtsRejects: 0
authCmtsInvalids: 0
authenInfos: 0
saMapReqs: 0
saMapReplys: 0
saMapRejects: 0

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


show cable privacy cmts

13-308 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable privacy tek


The show cable privacy tek command shows Traffic Encryption Key (TEK) grace
time and life-time values.
The following is an example of typical screen output from the show cable privacy
tek command:

Interface Cable 3/0


Tek grace time: 3600
Tek life time: 43200

Interface Cable 4/0


Tek grace time: 3600
Tek life time: 43200

Interface Cable 4/1


Tek grace time: 3600
Tek life time: 43200

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable privacy tek

Compass ID: 188656176 Version 5 MGBI 13-309


BSR 64000 Command Reference Guide Release 4.2.0

show cable qos profile


The show cable qos profile command displays information about all the QoS Profiles
in use for each slot.

Note: This command is only valid for DOCSIS 1.0, DOCSIS 1.0+, and
Euro-DOCSIS 1.0 cable modems.

Slot the slot number


Prof Idx the QoS Profile identifying number
Pri the relative priority number assigned to
upstream traffic by this QoS profile with 7
being the highest priority.
Max UP BW the maximum upstream bandwidth
Guar UP BW the guaranteed minimum upstream bandwidth
Max DOWN BW the maximum downstream bandwidth.
Max Tx burst the maximum transmit burst size in bytes -
valid range is from 0 (the default) to the
largest 16-bit integer
BPI Mode "true" indicates that Baseline Privacy is
enabled for this QoS profile - "false" indicates
that Baseline Privacy is not enabled for this
Qos profile
Flow Count the number of cable modems that have
registered using this QoS Profile - active Qos
Profiles are those with Flow Count = 0
Tos Mask overwrites the Type of Service (TOS) field in
IP datagrams received on the upstream before
forwarding them downstream if the value is
not "0"

13-310 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Tos Value the overwrite value substituted for the


received TOS value.
Created By "Oper" indicates a user configured QoS
Profile and "Modem" indicates a QoS Profile
learned from the cable modem during
registration

The following is an example of typical screen output from the show cable qos profile
command:

Slot Prof Pri Max Guar Max Max BPI Flow Tos Tos Created
Idx UP UP DOWN Tx Mode Cnt Mask Value By
BW BW BW Burst
5 17 0 10000000 0 10000000 0 false 2 0 0 Modem
5 18 0 5000000 0 5000000 0 false 2 0 0 Modem
10 17 0 5000000 0 5000000 0 false 2 0 0 Modem

Note: The "Prof Idx" field output indicates a user defined QoS Profile’s
unique identifying number in the range of 1-16. All QoS Profile identifying
numbers in the range of 17-32 indicate a QoS Profile that was learned from
cable modem registrations.

When using the show cable qos profile command to view the class of service
configuration for DOCSIS 1.0, DOCSIS 1.0+, and Euro-DOCSIS 1.0 cable modems,
you will obtain inconsistent results under the following conditions:
■ If you have not given each user configurable QoS Profile a unique identifying
number (in the range of 1 through 16) in the CM configuration file.
■ When you modify a CM’s configuration file and specify parameter values that are
already in use by other registered modems and fail to change the QoS Profile
identifying number to a unique value.

Note: All registered CMs are using the QoS parameters as defined in their
respective configuration files and only the output from the show cable qos
profile command is inconsistent.

Compass ID: 188656176 Version 5 MGBI 13-311


BSR 64000 Command Reference Guide Release 4.2.0

Once all DOCSIS 1.0, DOCSIS 1.0+, and Euro-DOCSIS 1.0 cable modems have a a
unique QoS Profile number, the display of the show cable qos profile command is
accurate.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos profile [<NUM> [<1-32> [mac]]]

Note: The show cable qos profile command without any arguments
displays all user-defined QoS profiles on the BSR regardless of whether they
are in use. The show cable qos profile command without arguments does
not display any QoS profiles that have been learned via modem registration.

The show cable qos profile command with the <NUM> argument displays
all active Qos Profiles either user-configured or learned via modem
registration for the specified CMTS slot.

Command Syntax

NUM the BSR slot number

1-32 the QoS Profiles’s identifying number based


on a valid range of defined service classes -
numbers 1-16 are user configured and
numbers 17-32 are learned by the CMTS
during cable modem registration
mac adds the MAC addresses of the cable modems
to the display

13-312 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable qos profile user-defined


The show cable qos profile user-defined command displays information about all
QoS Profiles or a selected user defined QoS Profile.

Note: This command is only valid for DOCSIS 1.0, DOCSIS 1.0+, and
Euro-DOCSIS 1.0 cable modems.

Prof Idx the QoS Profile identifying number


Pri the relative priority number assigned to
upstream traffic by this QoS profile with 7
being the highest priority.
Max UP BW the maximum upstream bandwidth
Guar UP BW the guaranteed minimum upstream bandwidth
Max DOWN BW the maximum downstream bandwidth.
Max Tx burst the maximum transmit burst size in bytes -
valid range is from 0 (the default) to the
largest 16-bit integer
BPI Mode "true" indicates that Baseline Privacy is
enabled for this QoS profile - "false" indicates
that Baseline Privacy is not enabled for this
Qos profile
Flow Count the number of cable modems that have
registered using this QoS Profile - active Qos
Profiles are those with Flow Count = 0
Tos Mask overwrites the Type of Service (TOS) field in
IP datagrams received on the upstream before
forwarding them downstream if the value is
not "0"

Compass ID: 188656176 Version 5 MGBI 13-313


BSR 64000 Command Reference Guide Release 4.2.0

Tos Value the overwrite value substituted for the


received TOS value.
Created By "Oper" indicates a user configured QoS
Profile and "Modem" indicates a QoS Profile
learned from the cable modem during
registration

The following is an example of typical screen output from the show cable qos profile
user-defined command:

Slot Prof Pri Max Guar Max Max BPI Flow Tos Tos Created
Idx UP UP DOWN Tx Mode Cnt Mask Value By
BW BW BW Burst
2 10 1 2500000 0 10000000 0 false 4 0 0 Oper
4 12 1 2500000 0 10000000 0 false 2 0 0 Oper

Note: The "Prof Idx" field output indicates a user defined QoS Profile’s
unique identifying number in the range of 1-16. All QoS Profile identifying
numbers in the range of 17-32 indicate a QoS Profile that was learned from
cable modem registrations.

When using the show cable qos profile user-defined command to view the class of
service configuration for DOCSIS 1.0, DOCSIS 1.0+, and Euro-DOCSIS 1.0 cable
modems, you will obtain inconsistent results under the following conditions:
■ If you have not given each user configurable QoS Profile a unique identifying
number (in the range of 1 through 16) in the CM configuration file.
■ When you modify a CM’s configuration file and specify parameter values that are
already in use by other registered modems and fail to change the QoS Profile
identifying number to a unique value.

Note: All registered CMs are using the QoS parameters as defined in their
respective configuration files and only the output from the show cable qos
profile user-defined command is inconsistent.

13-314 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Once all DOCSIS 1.0, DOCSIS 1.0+, and Euro-DOCSIS 1.0 cable modems have a a
unique QoS Profile number, the display of the show cable qos profile user-defined
command is accurate.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos profile user-defined

Note: The show cable qos profile user-defined command displays all
user-defined QoS profiles on the BSR regardless of whether they are in use.
The show cable qos profile user-defined command does not display any
QoS profiles that have been learned via modem registration.

Compass ID: 188656176 Version 5 MGBI 13-315


BSR 64000 Command Reference Guide Release 4.2.0

show cable qos svc-flow classifier


A service flow classifier matches a packet to a service flow using a service flow
reference. The service flow reference associates a packet classifier encoding with a
service flow encoding to establish a SFID. Classifiers have the following features:
■ Classifiers are loosely ordered by priority.
■ Several classifiers can refer to the same service flow.
■ More than one classifier may have the same priority.
■ The CMTS uses a downstream classifier to assign packets to downstream service
flows.
■ The CM uses an upstream classifier to assign packets to upstream service flows.
The show cable qos svc-flow classifier command is used to display the packet
classifiers of a service flow configured on the cable interface. The following isan
example of typical screen output from the show cable qos svc-flow classifier
command:

Interface index: 75431936


Service flow id: 2
Packet class id: 1
packet class direction: 2
packet class priority: 1
packet class Ip tos slow: 80
packet class Ip tos high: 80
packet class Ip tos mask: E0
Packet class Ip protocol: 258
Packet class Ip source addr: 0.0.0.0
Packet class Ip source mask: 255.255.255.255
Packet class Ip dest addr: 0.0.0.0
packet class Ip dest mask: 255.255.255.255
packet class source port start: 0
packet class source port end: 65535
packet class dest port start: 0
packet class dest port end: 65535
packet class state: Active

Group Access
All

13-316 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos svc-flow classifier [<X/Y> [<1-4292967295> [<1-65535>]]]

Note: If the Classifier ID is not given, all the classifiers with the given SFID
are listed.

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
1-4292967295 SFID
1-65535 Classifier identification

Compass ID: 188656176 Version 5 MGBI 13-317


BSR 64000 Command Reference Guide Release 4.2.0

show cable qos svc-flow dynamic-stat


The show cable qos svc-flow dynamic-stat command displays the statistics for
dynamic service additions, deletions, and changes for both upstream and downstream
service flows. The following is and example of typical screen output from the show
cable qos svc-flow dynamic-stat command:

Interface index: 294658


Qos DS Direction: 1
Qos DSA Reqests: 0
Qos DSA Rsps: 0
Qos DSA Acks: 0
Qos DSC Reqs: 0
Qos DSC Rsps: 0
Qos DSC Acks: 0
Qos DSD Reqs: 0
Qos DSD Rsps: 0
Qos dynamic adds: 0
Qos dynamic add fails: 0
Qos dynamic changes: 0
Qos dynamic change fails: 0
Qos dynamic deletes: 0
Qos dynamic delete fails: 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos svc-flow dynamic-stat

13-318 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable qos svc-flow log


The show cable qos svc-flow log command displays the time that the service flow
was created or deleted, the total number of packets counted, and the MAC address of
the cable modem (CM) that used the service flow. The following is and example of
typical screen output from the show cable qos svc-flow log command:

Qos service flow log index: 2415919105


Qos service flow log interface index: 159318272
Qos service flow log service flow id: 7
Qos service flow log cm mac: 00e0.0c60.2854
Qos service flow log packets: 1727
Qos service flow log octets: 329836
Qos service flow log time deleted: 5085076
Qos service flow log time created: 21666
Qos service flow log time active: 50634
Qos service flow log control: 1

Qos service flow log index: 2415919106


Qos service flow log interface index: 159318272
Qos service flow log service flow id: 8
Qos service flow log cm mac: 00e0.0c60.2854
Qos service flow log packets: 12
Qos service flow log octets: 4152
Qos service flow log time deleted: 5085076
Qos service flow log time created: 21666
Qos service flow log time active: 50634
Qos service flow log control: 1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos svc-flow log

Compass ID: 188656176 Version 5 MGBI 13-319


BSR 64000 Command Reference Guide Release 4.2.0

show cable qos svc-flow param-set


The show cable qos svc-flow param-set command displays parameter settings for all
service classes configured on an individual CMTS slot and port or all CMTS modules
on the BSR.
The following is typical output from the show cable qos svc-flow param-set
command:

Interface index: 294658


Qos service flow id: 1
Qos parameter set type: Active
Qos parameter set bit map: 0xdc800000
Qos active timeout: 0
Qos admitted timeout: 200
Qos scheduling type: Best Effort
Qos traffic priority: 5
Qos max traffic rate: 96000
Qos max traffic burst: 3044
Qos min reserved rate: 64000
Qos min reserved pkt size: 300
Qos max concatenated burst: 1522
Qos tos AND mask: 0xff
Qos tos OR mask: 0x0
Qos req/trans policy: 0x0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos svc-flow param-set [X/Y] [<1-4292967295>]

13-320 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
1-4292967295 service flow ID

Compass ID: 188656176 Version 5 MGBI 13-321


BSR 64000 Command Reference Guide Release 4.2.0

show cable qos svc-flow phs


The show cable qos svc-flow phs command displays the payload header suppression
(PHS) configured for an interface that is used for a specific service flow.

Note: If the PHS is not specified, all PHS entries with the specified SFIDs are
listed.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos svc-flow phs [<X/Y> [<1-4292967295> [<1-65535>]]]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
1-4292967295 SFID
1-65535 Classifier identification

13-322 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable qos svc-flow statistics


The show cable qos svc-flow statistics command is used to determine the number of
dropped packets due to downstream rate-limiting for a particular service flow.
The following is an example of typical screen output from the show cable qos
svc-flow statistics command:

Interface index: 75431936


Qos service flow id: 4
Qos service flow packets: 0
Qos service flow octets: 0
Qos service flow time created: 7971
Qos service flow time active: 585676
Qos service flow PHS unknowns: 0
Qos service flow policed drop packets: 0
Qos service flow policed delay packets: 0
Qos service flow class: DefRRDown
Qos service flow admit status: Success
Qos service flow admit restrict time: 0
Qos service flow PHS octets: 0
Qos service flow PHS packets: 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos svc-flow statistics [<X/Y> [<1-4292967295>]]

Compass ID: 188656176 Version 5 MGBI 13-323


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
1-4292967295 SFID

13-324 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable qos svc-flow summary


The show cable qos svc-flow summary command displays the service flow
information, including the SID, and QoS parameters sets associated with the service
flow. The following is an example of typical screen output from the show cable qos
svc-flow summary command:

Interface index: 294658


Qos service flow id: 1
Qos service flow SID: 2
Qos service flow direction: Upstream
Qos service flow primary: True

Interface index: 294658


Qos service flow id: 2
Qos service flow SID: 0
Qos service flow direction: Downstream
Qos service flow primary: True

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos svc-flow summary [<X/Y> [<1-4292967295>]]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"

1-4292967295 SFID

Compass ID: 188656176 Version 5 MGBI 13-325


BSR 64000 Command Reference Guide Release 4.2.0

show cable qos svc-flow upstream-stat


The show cable qos svc-flow upstream-stat command is used to display the number
of fragmented packets, incomplete fragmented packets, and the number of
concatenated bursts counted on the service flow. The following is an example of
typical screen output from the show cable qos svc-flow upstream-stat command:

Interface index: 294658


Qos service flow SID: 1
Qos upstream frag packets: 0
Qos upstream incomplete packets: 0
Qos upstream concat bursts: 0

Interface index: 294658


Qos service flow SID: 2
Qos upstream frag packets: 0
Qos upstream incomplete packets: 0
Qos upstream concat bursts: 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable qos svc-flow upstream-stat [<X/Y> [<1-16383>]]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
1-16383 Classifier identification

13-326 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable spectrum-group


The show cable spectrum-group command is used to verify if the spectrum group
that you assigned is activated for the upstream port. The following is an example of
typical screen output from the show cable qos svc-flow spectrum-group command:

Spectrum Group: sg1


Member channels:

Schedule Band Schedule


Id (Mhz) From Time To Time
1 5.000 - 42.000

The following is an example of typical screen output from the show cable qos
svc-flow spectrum-group schedule command:

Spectrum Group : spectrum1


start Frequency (Hz) stop Frequency (Hz) Timer Info (if any)
0000000 12000000

25000000 35000000
ADD TIMER DAILY THU JUL 26 16:00:00 2004
DEL TIMER DAILY THU JUL 26 20:00:00 2004

21000000 29000000
ADD TIMER WEEKLY THU JUL 26 10:00:00 2004
DEL TIMER WEEKLY THU JUL 26 11:00:00 2004

17000000 22000000

26000000 30000000

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable spectrum-group [<WORD> [map | schedule ]]

Compass ID: 188656176 Version 5 MGBI 13-327


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

WORD the Spectrum Group name applied to the


upstream port
map display the Spectrum Group allocation map
schedule display the Spectrum Group schedule

13-328 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable spectrum-group load-balance summary


This show cable spectrum-group load-balance summary command displays a
summary of cable modem distribution and load balancing statistics for the spectrum
group. The following is an example of typical screen output from the show cable
spectrum-group load-balance summary command:

Spectrum Group: Mansfield


Static Load Balancing: enabled
Interface Registered Move Move
Modems Success Failure
Cable 2/0/U0 3 1 0
Cable 2/0/U1 1 1 0
Cable 2/0/U2 6 3 0
Cable 2/0/U3 2 1 0
Total 12 6 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable spectrum-group <WORD> load-balance summary

Command Syntax

WORD The Spectrum Group name.

Compass ID: 188656176 Version 5 MGBI 13-329


BSR 64000 Command Reference Guide Release 4.2.0

show cable sync-interval


The show cable sync-interval command shows the configured sync-interval value
between CMTS transmission of successive SYNC messages.
The following is an example of typical screen output from the show cable
sync-interval command:

Cable sync-interval: 10

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


show cable sync-interval

13-330 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable ucc-stats


The show cable ucc-stats command displays DOCSIS Upstream Channel Change
(UCC) statistics for a MAC domain. The following is an example of typical screen
output from the show cable ucc-stats command:

CMTS Slot: 3 MAC Domain: 1 Interface index: 58654976


Number of UCC Reqs : 0
Number of UCC Rsps : 0
Number of UCC : 0
Number of UCC Fails : 0

CMTS Slot: 10 MAC Domain: 0 Interface index: 176095232


Number of UCC Reqs : 0
Number of UCC Rsps : 0
Number of UCC : 0
Number of UCC Fails : 0

CMTS Slot: 10 MAC Domain: 1 Interface index: 176095488


Number of UCC Reqs : 0
Number of UCC Rsps : 0
Number of UCC : 0
Number of UCC Fails : 0

CMTS Slot: 14 MAC Domain: 0 Interface index: 243204096


Number of UCC Reqs : 0
Number of UCC Rsps : 0
Number of UCC : 0
Number of UCC Fails : 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable ucc-stats [<X/Y>]

Compass ID: 188656176 Version 5 MGBI 13-331


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"

13-332 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show cable ucd-interval


The show cable usd-interval command shows configured ucd-interval between
transmission of successive UCD messages.
The following is an example of typical screen output from the show cable
ucd-interval command:

Cable ucd-interval: 1000

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


show cable ucd-interval

Compass ID: 188656176 Version 5 MGBI 13-333


BSR 64000 Command Reference Guide Release 4.2.0

show cable upstream


The show cable upstream command displays the following upstream cable
information:
ifIndex interface index
description displays the user-defined description of the
upstream port
centerFreq center frequency for cable modem use
rng_back_st initial ranging backoff fixed start value
rng_back_en initial ranging backoff fixed end value
data_back_st initial data backoff fixed start value
data_back_en initial data backoff fixed end value
channelWidth radio frequency channel width
powerLevel power level in units of whole dB to one
decimal place
slotSize port minislot size in number of time ticks
force-frag forced fragmentation enabled
map-interval configured map interval value
pre-equalization pre-equalization adjustment enabled
invited-range-interval the number of invited range interval requests
configured for this upstream channel
range-forced-continue range forced continue enabled
range-power-override specifies whether range power override is
enabled (true) or disabled (false)
concatenation specifies whether concatenation is on (true) or
off (false).
physical-delay the upstream physical delay configuration
rate-limit upstream data transmission rate-limit

13-334 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

modulation-profile physical layer profile characteristics


max-calls the maximum number of voice calls
configured for this upstream channel
Spectrum Group displays the associated Spectrum Group name
modem ranging delay the maximum ranging timing offset for a
modem that is co-located with (next to) the
CMTS, in microseconds.The range, 0 to 600
(with a default of 250), corresponds to
ranging timing offsets in REFCLK units of 0
to 6144 (with a default of 2560).

The following is an example of typical screen output from the show cable upstream
command:

Compass ID: 188656176 Version 5 MGBI 13-335


BSR 64000 Command Reference Guide Release 4.2.0

ifIndex: 295173
description:
centerFreq: 22800000
rng_back_st: 0
rng_back_en: 4
data_back_st: 2
data_back_en: 8
channelWidth: 3200000
powerLevel: 0 (10th of dB)
slotSize: 4
force-frag: 0
map-interval: 4000
pre-equalization: 0
invited-range-interval: 10000
range-forced-continue: 0
range-power-override: false
concatenation: true
physical-delay: Mode 0, Min 400, Max 1600
rate-limit: 0
modulation-profile: 1
max-calls: 0
Spectrum Group:
modem ranging delay: 250 (usec)

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


show cable upstream {<NUM> | <X/Y>}

13-336 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Note: When using the show cable upstream command, both the NUM and
X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8 CMTS. |

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Syntax

NUM the upstream port number


X/Y the upstream port and logical channel number
(0-3)

Compass ID: 188656176 Version 5 MGBI 13-337


BSR 64000 Command Reference Guide Release 4.2.0

show docsis-version
The show docsis-version command displays the DOCSIS version of a slot in the BSR
64000 chassis. Returned values are DOCSIS 1.X (DOCSIS 1.0 or DOCSIS 1.1) and
DOCSIS 2.0.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show docsis-version <0-15>

Command Syntax

0-15 the BSR slot number

13-338 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show docstest
The show docstest command displays DOCSIS 2.0 testing information. A displayed
value of "0" indicates that no test has been initiated.

Note: DOCSIS 2.0 test mode must be enabled with the docstest enable
command before DOCSIS 2.0 testing information can be displayed.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


show docstest

Compass ID: 188656176 Version 5 MGBI 13-339


BSR 64000 Command Reference Guide Release 4.2.0

show interfaces cable


The show interfaces cable command displays the following cable interface
information:

cable port up/ cable modem active or taken down by


administratively down administrator
up/administratively determines if software processes handling
down lineup/protocol down interface is operational
or taken down by the administrator
hardware hardware type and address
internet address internet address then subnet mask
MTU interface maximum transmission unit (MTU)
BW bandwidth (BW) in kilobits per second
received broadcast total number of broadcast or multicast packets
that interface receives
cable downstream interface location
downstream up/ interface administrative state
administratively down
packets output number of packets transmitted from the
interface

bytes number of bytes transmitted from the


interface
discarded number of packets discarded
output errors errors that prevented downstream
transmission of packets from the interface
cable upstream cable location
upstream up/ upstream interface administrative status
administratively down
received broadcasts upstream interface broadcast packets received

13-340 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

multicasts upstream interface multicast packets received


unicasts upstream interface unicast packets received
discards upstream interface discarded packets
errors total errors preventing upstream interface
transmission through interface
unknown protocol upstream interface packets received through
interface
packets input upstream interface packets received through
interface with no errors
corrected upstream interface packets that were
uncorrected
uncorrectable upstream interface packets that were
corrected
noise corrupted packet as a result of line noise
microreflections corrupted packets as a result of
microreflections
guaranteed-rate number of bandwidth requests queued in the
guarantee-rate queue from modems that have
minimum upstream rates for their class of
service
best-effort service number of bandwidth requests queued in the
best-effort queue depth queue from modems
without a reserved rate on the upstream
interface
total modems modems, active or inactive, sharing upstream
channel on this channel
current total reserved for modems sharing an upstream
channel interface

Compass ID: 188656176 Version 5 MGBI 13-341


BSR 64000 Command Reference Guide Release 4.2.0

bandwidth requiring the QoS for that modem. Each time


the modem connects to an upstream channel,
the value for the guaranteed upstream value
increments by the QoS rate.
snmp out packets number of SNMP packets sent by the other
router modem
packets too big larger than maximum packet size sent by the
router modem

no such name errors name errors non-existent number, undefinable


MIB
bad values errors number of set requests that detail an invalid
value for a MIB object
general errors number of requests failed due to some other
error, excluding a noSuchName error,
badValue error, or any of the other specific
errors
response number of responses
trap number of traps sent

The following is an example of typical screen output from the show interfaces cable
command:

13-342 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

cable 4/0 is up, line protocol is up


Hardware is Cable, Mac address is 00:30:b8:c6:5c:40
snmpIndex=0x47f0000(75431936)
MTU 1500 bytes
Last clearing of
"show interface
" counters 04:49:28
5 minute Input rate 12 bytes/sec, 0 packets/sec
5 minute Output rate 13 bytes/sec, 0 packets/sec
2772 packets input, 456998 bytes
Received 940 broadcasts+multicasts
0 input errors,
3985 packets output, 505174 bytes
0 output errors
Length of output packet queue 0
downstream port 0, snmpIndex=0x4800000
upstream port 0, snmpIndex=0x4810000
upstream port 1, snmpIndex=0x4810001
upstream port 2, snmpIndex=0x4810002
upstream port 3, snmpIndex=0x4810003
upstream port 4, snmpIndex=0x4810004
upstream port 5, snmpIndex=0x4810005
upstream port 6, snmpIndex=0x4810006
upstream port 7, snmpIndex=0x4810007

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show interfaces cable <X/Y> [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show interfaces cable <X/Y> [ | {count | count-only}]]

Compass ID: 188656176 Version 5 MGBI 13-343


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

13-344 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show interfaces cable bandwidth voice


The show interface cable bandwidth voice command displays voice bandwidth
statistics for a specified interface.
The following is typical output from the show interface cable bandwidth voice
command:

Cable Interface Voice Bandwidth Statistics:

Channel Normal Calls Emergency Calls

Cable Total Peak Allow Curr Curr Allow Curr Curr


Interface Alloc #Calls BW Alloc #Calls BW Alloc #Calls
----------------------- ---------------------- -----------------------
2/0/D0 0.00% 0 20% 0.00% 0 25% 0.00% 0
2/0/U0 0.00% 0 81% 0.00% 0 81% 0.00% 0
2/0/U1 0.00% 0 81% 0.00% 0 81% 0.00% 0
2/0/U2 0.00% 0 81% 0.00% 0 81% 0.00% 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show interface cable <X/Y> bandwidth voice [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show interface cable <X/Y> bandwidth voice [ | {count | count-only}]]

Compass ID: 188656176 Version 5 MGBI 13-345


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

13-346 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show interfaces cable configuration


The show interfaces cable configuration command displays cable interface
configuration information. The following is an example of typical screen output from
the show interfaces cable configuration command:

Invited Ranging Attempts: 16


--US PORT 0--
Max Tx Timing Offset: 0
Forced Continue Ranging: 0
Ranging Interval: 10000(ms)
Power Offset Threshold: 24
Power Desired: 1500(linear)
--CHAN 0--
Channel Type: tdma
Rx Pwr Lvl Config: 0(10th of dB)
Max SM Power Adj: 8
AdjCtrlFlag: 8
--US PORT 1--
Max Tx Timing Offset: 1659
Forced Continue Ranging: 0
Ranging Interval: 10000(ms)
Power Offset Threshold: 24
Power Desired: 1500(linear)
--CHAN 0--
Channel Type: tdma
Rx Pwr Lvl Config: 0(10th of dB)
Max SM Power Adj: 8
AdjCtrlFlag: 8

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show interfaces cable <X/Y> configuration [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show interfaces cable <X/Y> configuration [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 13-347


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module:
• the 1:4 or 1:8 CMTS modules
will have a MAC Domain
number of "0"
• the 2:8 and 2:8 (2.0) CMTS
modules will have a MAC
Domain number of "0" or "1"
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

13-348 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show interfaces cable downstream


The show interfaces cable downstream command displays the following
downstream cable information:
cable downstream cable location
upstream up/ downstream interface administrative status
administratively down
packets output number of packets transmitted from the
interface
bytes number of bytes transmitted from the
interface
discarded number of packets discarded
total active modems total active cable modems on this downstream
channel
Spectrum Group the associated upstream Spectrum Group
names

The following is an example of typical screen output from the show interfaces cable
downstream command:

Cable 3/0: Downstream 0 is administratively down


0 packet output, 0 bytes, 0 discarded
0 total active modems
Spectrum Group: N/A

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 13-349


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show interfaces cable <X/Y> downstream [<0-0>] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show interfaces cable <X/Y> downstream [<0-0>] [ | {count | count-only}]

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module:
• the 1:4 or 1:8 CMTS modules
will have a MAC Domain
number of "0"
• the 2:8 and 2:8 (2.0) CMTS
modules will have a MAC
Domain number of "0" or "1"
0-0 downstream port number
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines

count-only count the number of lines while


suppressing screen output

13-350 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show interfaces cable intercept


Use the show interfaces cable intercept command to view statistical information for
each intercepted Customer Premises Equipment (CPE) MAC address.
The show interfaces cable intercept command displays the following CPE
information:
MAC Address MAC (hardware) address of a CPE, such as a
customer’s PC or VoIP phone.
Destination IP Address IP address of the data collection server.
Destination UDP Port UDP Port number that is used exclusively by the data
collection server.
Packets The total number of packets that have been
intercepted from each specified CPE on this CMTS
interface.
Bytes The total number of bytes that have been intercepted
from each specified CPE on this CMTS interface.

The following is an example of typical screen output from the show interfaces cable
intercept command:

Type: R - Layer 3 Intercept, B - Layer 2 (Bridged) Intercept


Destination Destination
MAC Address IP Address UDP Port Type Packets Bytes
00c0.4f5e.e476 150.31.98.100 10000 R 0 0

Group Access
MSO

Command Mode
All modes except User EXEC mode.

Command Line Usage


show interfaces cable <X/Y> intercept

Compass ID: 188656176 Version 5 MGBI 13-351


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

X/Y the slot and MAC Domain number of the CMTS


module:
• the 1:4 or 1:8 CMTS modules will have a MAC
Domain number of "0"
• the 2:8 and 2:8 (2.0) CMTS modules will have a
MAC Domain number of "0" or "1"

Command Default
None

13-352 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show interfaces cable service-class


The show interfaces cable service-class command displays interface level service
class information for all downstream and upstream service classes, downstream
service classes, or upstream service classes. The following is an example of typical
screen output from the show interfaces cable service-class command:

Dir Ch ClassName Pri Thr CAP MAB FreeBW Defer Succe Restr HighPri
=================================================================
Dn 0 DefBEDown 1 0 0 1 100% 0 0 0 0
Dn 0 DefRRDown 1 0 0 1 100% 0 0 0 0
Dn 0 DefEMDown 1 0 0 1 100% 0 0 0 0
Dn 0 mass11 1 0 0 48 100% 0 0 0 0
Dn 0 mass12 1 0 0 30 100% 0 0 0 0
Dn 0 mass13 1 0 0 18 100% 0 0 0 0
-----------------------------------------------------------------
Up 0 DefBEUp 1 0 0 1 100% 0 0 0 0
Up 0 DefRRUp 1 0 100 1 100% 0 0 0 0
Up 0 DefUGS 1 20 100 1 100% 0 0 0 0
Up 0 DefUGSAD 1 0 80 1 100% 0 0 0 0
Up 0 DefRTPS 1 0 100 1 100% 0 0 0 0
Up 0 DefNRTPS 1 0 100 1 100% 0 0 0 0
Up 0 DefEMUp 1 0 100 1 100% 0 0 0 0
Up 0 mass1 1 0 0 49 100% 0 0 0 0
Up 0 mass2 1 0 0 30 100% 0 0 0 0
Up 0 mass3 1 0 0 14 100% 0 0 0 0
-----------------------------------------------------------------
Up 1 DefBEUp 1 0 0 1 100% 0 0 0 0
Up 1 DefRRUp 1 0 100 1 100% 0 0 0 0
Up 1 DefUGS 1 20 100 1 100% 0 0 0 0
Up 1 DefUGSAD 1 0 80 1 100% 0 0 0 0
Up 1 DefRTPS 1 0 100 1 100% 0 0 0 0
Up 1 DefNRTPS 1 0 100 1 100% 0 0 0 0
Up 1 DefEMUp 1 0 100 1 100% 0 0 0 0
Up 1 mass1 1 0 0 49 100% 0 0 0 0
Up 1 mass2 1 0 0 30 100% 0 0 0 0
Up 1 mass3 1 0 0 14 100% 0 0 0 0

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 13-353


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show interfaces cable <X/Y> service-class [all | downstream | upstream] [ | {begin
| exclude | include} {<WORD>} [ | {count | count-only}]]
show interfaces cable <X/Y> service-class [all | downstream | upstream] [ | {count
| count-only}]

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module:
• the 1:4 or 1:8 CMTS modules
will have a MAC Domain
number of "0"
• the 2:8 and 2:8 (2.0) CMTS
modules will have a MAC
Domain number of "0" or "1"
all display both upstream and
downstream service class
information
downstream display downstream service class
information only
upstream display upstream service class
information only
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string

13-354 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

count count the number of outputted lines


count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 13-355


BSR 64000 Command Reference Guide Release 4.2.0

show interfaces cable stats


The show interfaces cable stats command displays upstream statistical information
for all ports. The following is typical screen output from the show interfaces cable
stats command:

Channel Reg Rng Abort Denied IP Cmp


0 0 0 0 0 0
1 5 0 0 0 0
2 0 0 0 0 0
3 0 0 0 0 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show interfaces cable <X/Y> stats [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]
show interfaces cable <X/Y> stats [ | {count | count-only}]

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module:
• the 1:4 or 1:8 CMTS modules
will have a MAC Domain
number of "0"
• the 2:8 and 2:8 (2.0) CMTS
modules will have a MAC
Domain number of "0" or "1"
| turns on output modifiers (filters)

13-356 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

begin filter for output that begins with the


specified string
exclude filter for output that excludes the
specified string

include filter for output that includes the


specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 13-357


BSR 64000 Command Reference Guide Release 4.2.0

show interfaces cable upstream


The show interfaces cable upstream command displays the following upstream
cable interface information:

Cable upstream cable location


Upstream up/ upstream interface administrative status
administratively down
Received broadcasts upstream interface broadcast packets received
Received multicasts upstream interface multicast packets received
Received unicasts upstream interface unicast packets received
discarded upstream interface discarded packets
errors total errors preventing upstream transmission
of packets
unknown protocol packets received that were generated using a
protocol unknown to the BSR 64000
Avg upstream channel the average percentage of upstream channel
utilization utilization
packets input total packets received through the upstream
interface with no errors
Total Modems On This active or inactive cable modems on this
Upstream Channel upstream channel
Spectrum Group the associated Spectrum Group name

The following is an example of typical screen output from the show interfaces cable
upstream command:

13-358 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Cable 4/1: Upstream 1 is up


Received 0 broadcasts, 0 multicasts, 0 unicasts
0 discarded, 0 errors, 0 unknown protocol
Avg upstream channel utilization : 0
0 packets input
Spectrum Group:
LB Group: N/A

The following is an example of typical screen output from the show interfaces cable
upstream signal-quality command:

Upstream 3 channel 0
ifIndex 46989452
includesContention 0
unerroreds 0
correctables 0
uncorrectables 0
signalToNoise 0
microReflections 0
equalData

The following is an example of typical screen output from the show interfaces cable
upstream spectrum command:

Compass ID: 188656176 Version 5 MGBI 13-359


BSR 64000 Command Reference Guide Release 4.2.0

Frequency (Hz) Voltage (microvolt) Power (dBmV)


5000000 0 -60.0
5200000 0 -60.0
5400000 0 -60.0
5600000 0 -60.0
5800000 0 -60.0
6000000 0 -60.0
6200000 0 -60.0
6400000 0 -60.0
6600000 0 -60.0
6800000 0 -60.0
7000000 0 -60.0
7200000 0 -60.0
7400000 0 -60.0
7600000 0 -60.0
7800000 0 -60.0
8000000 0 -60.0
8200000 0 -60.0
8400000 0 -60.0
8600000 0 -60.0
8800000 0 -60.0
9000000 0 -60.0
9200000 0 -60.0

The following is an example of typical screen output from the show interfaces cable
upstream stats command:

Channel Reg Rng Abort Denied IP Cmp


0 0 0 0 0 0
1 5 0 0 0 0
2 0 0 0 0 0
3 0 0 0 0 0

Group Access
All

13-360 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

Command Mode
All modes except User EXEC

Note: When using the show cable interfaces upstream command, only the
NUM option displays for a 1:4, 1:8 or BCM 3138-based 2:8 CMTS modules.
Both the NUM and X/Y arguments display for a BCM 3140-based DOCSIS
2.0 2:8 CMTS.

The show cable interfaces upstream signal-quality, show cable


interfaces upstream spectrum, and show cable interfaces upstream
stats commands are applicable for an upstream port and will be available
through the NUM argument.

The show cable interfaces upstream signal-quality and show cable


interfaces upstream stats commands are also applicable for an upstream
port and logical channel and will be available through the X/Y argument.

To determine which 2:8 CMTS module is installed in the BSR 64000, use the
show chassis status command. For BCM 3138-based 2:8 CMTS modules,
the command display reads “2:8 CMTS”, and for the BCM 3140-based
DOCSIS 2.0 2:8 CMTS, the display reads, “2:8 CMTS (DOCSIS 2.0)”

Command Line Usage


show interfaces cable <X/Y> upstream {<NUM> | <X/Y>} [signal-quality |
spectrum <5000000-42000000> <5000000-42000000>| stats] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show interfaces cable <X/Y> upstream {<NUM> | <X/Y>} [signal-quality |
spectrum <5000000-42000000> <5000000-42000000>| stats] [ | {count |
count-only}]

Compass ID: 188656176 Version 5 MGBI 13-361


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module:
• the 1:4 or 1:8 CMTS modules
will have a MAC Domain
number of "0"
• the 2:8 and 2:8 (2.0) CMTS
modules will have a MAC
Domain number of "0" or "1"
NUM the upstream port number
X/Y the upstream port and logical
channel number (0-3)
signal-quality display signal-quality information
spectrum view the noise power level for the
whole spectrum
5000000-42000000 start frequency in Hz
5000000-42000000 end frequency in Hz
stats display upstream statistical
information
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string

13-362 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

count count the number of outputted lines


count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 13-363


BSR 64000 Command Reference Guide Release 4.2.0

show stats cmts


The show stats cmts command displays the following upstream and downstream
statistical information:

Upstream Statistics

cable upstream cable location


upstream up/ upstream interface administrative status
administratively down
Received broadcasts upstream interface broadcast packets received
Received multicasts upstream interface multicast packets received
Received unicasts upstream interface unicast packets received
discarded upstream interface discarded packets
errors total errors preventing upstream transmission
of packets
unknown protocol packets received that were generated using a
protocol unknown to the BSR 64000
Total Modems On This total active or inactive cable modems on this
Upstream Channel upstream channel
Spectrum Group the associated Spectrum Group name

Downstream Statistics

cable downstream cable location


downstream up/ downstream interface administrative status
administratively down
packets output number of packets transmitted from the
interface
bytes number of bytes transmitted from the
interface

13-364 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

discarded number of packets discarded


total active modems total active cable modems on this downstream
channel
Spectrum Group the associated upstream Spectrum Group
names

The following is an example of typical screen output from the show stats cmts
command:

CMTS Statistics for slot 4:

Downstream Statistics:

Cable 4/0: Downstream 0 is up


16770244 packet output, 866426355 bytes, 0 discarded
Avg downstream channel utilization : 0
2 total active modems
Spectrum Group: N/A
Group Id: 0

Upstream Statistics:

Cable 4/0: Upstream 0/0 is up


Received 0 broadcasts, 0 multicasts, 0 unicasts
0 discarded, 0 errors, 0 unknown protocol
Avg upstream channel utilization : 0
0 packets input
Total Modems On This Upstream Channel: 0
Spectrum Group:
Group Id: 0

Group Access
All

Compass ID: 188656176 Version 5 MGBI 13-365


BSR 64000 Command Reference Guide Release 4.2.0

Command Mode
All modes except User EXEC

Command Line Usage


show stats <NUM> cmts [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show stats <NUM> cmts [ | {count | count-only}]

Command Syntax

NUM the BSR 64000 CMTS slot number


| turns on output modifiers (filters)
begin filter for output that begins with the
specified string

exclude filter for output that excludes the


specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

13-366 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

show stats summary error


The show stats summary error command displays the following statistical
information on FEC (forward error correction) errors:

MAC Address MAC Address of the cable modem


I/F interface on which the cable modem has an
active connection
SID Service ID number
CorrFec Count the number of correctable forward error
correction (FEC) errors
CorrFec Ratio correctable forward error correction ratio

UnCorrFec Count the number of uncorrectable forward error


correction (FEC) errors
UnCorrFec Ratio correctable forward error correction ratio

The following is an example of typical screen output from the show stats summary
error command:

Compass ID: 188656176 Version 5 MGBI 13-367


BSR 64000 Command Reference Guide Release 4.2.0

MAC Address I/F SID CorrFec CorrFec UnCorrFec UnCorrFec


Count Ratio Count Ratio
000b.0643.36c8 4/0/U2 5 0 0.00000000 0 0.00000000
000b.0643.3716 4/0/U2 8 0 0.00000000 6330272 0.00000000
000b.0643.375a 4/0/U3 20 0 0.00000000 0 0.00000000
000b.0643.3766 4/0/U3 6 0 0.00000000 0 0.00000000
000b.0643.3ac6 4/0/U3 11 0 0.00000000 0 0.00000000
000b.0643.3b60 4/0/U0 12 0 0.00000000 0 0.00000000
000b.0643.3b72 4/0/U2 10 0 0.00000000 6330272 0.00000000
000b.0643.3b78 4/0/U1 7 0 0.00000000 0 0.00000000
000b.0643.3b84 4/0/U1 15 0 0.00000000 0 0.00000000
000b.0643.3b90 4/0/U1 13 0 0.00000000 0 0.00000000
000b.0643.3b9a 4/0/U0 14 0 0.00000000 0 0.00000000
000b.0643.3bb2 4/0/U0 9 0 0.00000000 0 0.00000000
000b.063b.b320 4/1/U7 7 0 0.00000000 0 0.00000000
000b.0643.33fc 4/1/U4 2 0 0.00000000 0 0.00000000
000b.0643.361a 4/1/U5 19 0 0.00000000 0 0.00000000
000b.0643.3718 4/1/U4 5 0 0.00000000 0 0.00000000
000b.0643.3bb0 4/1/U5 4 0 0.00000000 0 0.00000000
0020.4027.a15c 4/1/U7 6 0 0.00000000 0 0.00000000
0020.409a.24f0 4/1/U6 3 0 0.00000000 0 0.00000000
0020.409a.760c 4/1/U6 17 0 0.00000000 0 0.00000000

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


show stats summary error [sid <1-2049> | slot <NUM>]

Command Syntax

sid 1-2049 the Service ID number


slot NUM the BSR slot number

13-368 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

snr display
The snr display command displays SNR measurement data to a console or telnet
session. SNR measurement data is retrieved either from an operational CMTS module
or a file system.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


snr display {<NUM>{<NUM>}} | flash:<filename> <WORD> | loop-data
{<NUM>{<NUM>}} | nvram:<filename> <WORD>}

Command Syntax

NUM operational 2:8 CMTS slot number


NUM valid upstream port number
flash:<filename> retrieve the SNR measurement data from the
Flash file system

loop-data displays SNR loop measurement data


nvram:<filename> retrieve the SNR measurement data from the
NVRAM file system
WORD SNR measurement data filename - limit of 20
characters excluding the ".snr" filename
extension

Compass ID: 188656176 Version 5 MGBI 13-369


BSR 64000 Command Reference Guide Release 4.2.0

snr loop
The snr loop command allows an operator to perform SNR measurements for a
specified number of times on one particular frequency.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


snr loop {<NUM>} {<NUM>}{<NUM>}{<NUM>}{<frequency>} {1600000 |
200000 | 3200000 | 400000 | 6400000 | 800000} [<mac> | equalization {off | on} |
ingress-cancel {off | on} | modulation-type {16qam | qpsk}]

Command Syntax

NUM the slot number of an operational 2:8 CMTS


module (0-5, 9-15)
NUM valid upstream port number (0-7)
NUM the number SNR measurement repetitions
(1-100)
NUM a ranging pattern number used to look up a
certain pattern to be used for SNR
measurement
frequency the particular frequency to perform SNR
measurements on
1600000 channel width 1600 kHz
200000 channel width 200 kHz
3200000 channel width 3200 kHz
400000 channel width 400 kHz
6400000 channel width 6400 kHz
800000 channel width 800 kHz

13-370 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

mac the MAC address, in the form of


xxxx.xxxx.xxxx, of a device to perform SNR
measurements on
equalization off - perform SNR measurements without
equalization
on - eperform SNR measurements with
equalization
ingress-cancel off - perform SNR measurements without
ingress cancellation
on - perform SNR measurements with ingress
cancellation
modulation-type 16qam - perform SNR measurements for
16qam mode
qpsk - perform SNR measurements for QPSK
mode

Compass ID: 188656176 Version 5 MGBI 13-371


BSR 64000 Command Reference Guide Release 4.2.0

snr setup
The snr setup command is used to configure SNR measurement on the BCM3138/
BCM3140 chip set.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


snr setup {<NUM>{<NUM>}} {<5000000-42000000> | <5000000-65000000> |
<5000000-55000000>} {<5000000-42000000> | <5000000-65000000> |
<5000000-55000000>} {1600000 | 200000 | 3200000 | 400000 | 6400000 | 800000}
[equalization {auto | off | on}| ingress-cancel {auto | off | on} | modulation-type
{16qam | auto | qpsk}]

Note: Depending on the configuration of the installed 2:8 CMTS Resource


Module, the start and end frequencies will reflect the North American
DOCSIS, EURODOCSIS, or J-DOCSIS standards

Command Syntax

NUM operational 2:8 CMTS slot number


NUM valid upstream port number
5000000-42000000 is the North America standard start frequency
in Hz
5000000-42000000 is the North America standard end frequency
in Hz.
5000000-65000000 is the EURODOCSIS standard start
frequency in Hz
5000000-65000000 is the EURODOCSIS standard start
frequency in Hz

13-372 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

5000000-55000000 is the J-DOCSIS standard start frequency in


Hz
5000000-55000000 is the J-DOCSIS standard end frequency in
Hz.

1600000 channel width 1600 kHz


200000 channel width 200 kHz
3200000 channel width 3200 kHz
400000 channel width 400 kHz
6400000 channel width 6400 kHz
800000 channel width 800 kHz
equalization auto - evaluate the SNR with and without
equalization
off - evaluate the SNR without equalization
on - evaluate the SNR with equalization
ingress-cancel auto evaluate the SNR with and without
ingress cancellation
off - evaluate the SNR without ingress
cancellation
on - evaluate the SNR with ingress
cancellation
modulation-type 16qam - evaluate the SNR for 16qam mode
auto - evaluate the SNR for both QPSK and
16QAM modes
qpsk - evaluate the SNR for QPSK mode

Compass ID: 188656176 Version 5 MGBI 13-373


BSR 64000 Command Reference Guide Release 4.2.0

snr setup-get
The snr setup-get command dispalys the current SNR measurement feature
configuration.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


snr setup-get [<NUM> [<NUM>]]

Command Syntax

NUM operational 2:8 CMTS slot number


NUM valid upstream port number

13-374 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

snr start
The snr start command initiates SNR measurement via the RF Sentry

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


snr start {<NUM>{<NUM>}} [<mac>]

Command Syntax

NUM operational 2:8 CMTS slot number


NUM valid upstream port number
mac MAC address of the reference modem in the
form of xxxx.xxxx.xxxx

Compass ID: 188656176 Version 5 MGBI 13-375


BSR 64000 Command Reference Guide Release 4.2.0

snr store
The snr store command saves the latest SNR measurement data for a 2x8 CMTS
module to a file system. The user specifies a particular slot and port, the file system
(NVRAM or Flash), and a file name without any extension to be used to store the
SNR measurement data. An extension of ".snr" will be automatically added to the file
name.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


snr store {<NUM>{<NUM>}} {flash:<filename> <WORD> | nvram:<filename>
<WORD>}

Command Syntax

NUM operational 2:8 CMTS slot number


NUM valid upstream port number
flash:<filename> store the SNR measurement data from the
Flash file system
nvram:<filename> store the SNR measurement data from the
NVRAM file system

WORD SNR measurement data filename - limit of 20


characters excluding the ".snr" filename
extension

13-376 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

spreader on
The spreader on command enables or disables the spreader for this S-SDMA
channel.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


spreader on
no spreader on

Compass ID: 188656176 Version 5 MGBI 13-377


BSR 64000 Command Reference Guide Release 4.2.0

tcm-encoding on
The tcm encoding on command enables trellis-coded modulation (TCM) for this
S-CDMA channel. The trellis-coded modulation technique partitions the constellation
into subsets called cosets so as to maximize the minimum distance between pairs of
points in each coset. The no tcm encoding on command disables trellis-coded
modulation (TCM) for this S-CDMA channel.

Group Access
MSO

Command Mode
Modulation Profile Configuration

Command Line Usage


tcm encoding on
no tcm encoding on

13-378 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 CMTS Commands

time band
The time band command is used to schedule when a spectrum group band is
available. The spectrum group band can be made available on either a daily or weekly
schedule.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


time {<day> | <hh:mm:ss>} band <5000000-42000000> <5000000-42000000>
no time {<day> | <hh:mm:ss>} band <5000000-42000000> <5000000-42000000>

Command Syntax

day the three letter abbreviation for day of the


week
hh:mm:ss the time during the day when the band
becomes available
5000000-42000000 the start upstream frequency in Hertz
5000000-42000000 the end upstream frequency in Hertz

Compass ID: 188656176 Version 5 MGBI 13-379


BSR 64000 Command Reference Guide Release 4.2.0

time delete
The time delete command can be used to schedule the time when the spectrum group
band is removed on a daily or weekly basis.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


time {<day> <hh:mm:ss>} delete <5000000-42000000> <5000000-42000000>
no time {<day> <hh:mm:ss>} delete <5000000-42000000> <5000000-42000000>

Command Syntax

day the three letter abbreviation for day of the


week
hh:mm:ss the time during the day when the band is
removed
5000000-42000000 the start upstream frequency in Hertz
5000000-42000000 the end upstream frequency in Hertz

13-380 MGBI Compass ID: 188656176 Version 5


14
QoS Commands

Introduction
Quality of Service (QoS) addresses consistent, predictable delivery of data to satisfy
customer application requirements during periods of congestion. QoS commands let
you define a level of system performance consistent with negotiated service level
agreements (SLAs).

QoS Command Descriptions


This section contains an alphabetized list and descriptions of the QoS commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 14-1


BSR 64000 Command Reference Guide Release 4.2.0

qos bw default
The qos bw default command sets all the queues in an interface to a specific default
bandwidth.

Group Access
MSO

Command Mode
Interface Configuration (Ethernet or Gigabit Ethernet interfaces only)

Command Line Usage


qos bw default

Command Default
the default bandwidth is 25%

14-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 QoS Commands

qos queue bw
The qos queue bw command sets the percentage of bandwidth for the specified queue
of an interface.
Use the qos queue bw command to manage traffic such that higher bandwidth is
appropriated to the high priority traffic. The remaining percentage bandwidth is
shared among the other queues, which have not been set by this command. If all of the
queues have been set and if the total of all bandwidth allocated does not match 100%,
an error message is displayed.

Note: Each queue has to carry a minimum of 1% and a maximum of 93%, in


order for all 8 queue to acheive the 100% bandwidth goal.

Group Access
MSO

Command Mode
Interface Configuration (Ethernet or Gigabit Ethernet interfaces only)

Command Line Usage


qos queue <0-7> bw <0-100>
no qos queue <0-7> bw <0-100>

Command Syntax

0-7 the queue number belonging to a physical


interface
0-100 the percentage of total bandwidth allocated to
the queue

Compass ID: 188656176 Version 5 MGBI 14-3


BSR 64000 Command Reference Guide Release 4.2.0

show qos queue config


The show qos queue config command displays QoS queue configuration status. The
following is an example of typical screen output from the show qos queue config
command:

ethernet 15/0:
queue bandwidth (%) quantum (in bytes)
0 12 2048
1 12 2048
2 12 2048
3 12 2048
4 12 2048
5 12 2048
6 12 2048
7 12 2048
ethernet 15/1:
queue bandwidth (%) quantum (in bytes)
0 12 2048
1 12 2048
2 12 2048
3 12 2048
4 12 2048
5 12 2048
6 12 2048
7 12 2048

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show qos queue config [ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>]

14-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 QoS Commands

Command Syntax

ethernet X/Y Ethernet interface slot and port number


gigaether X/Y Gigabit Ethernet interface slot and port
number
pos X/Y POS interface slot and port number

Compass ID: 188656176 Version 5 MGBI 14-5


15
POS Commands

Introduction
The Synchronous Optical Network (SONET) standard provides for data transmission
over fiber optic cable and high-bandwidth utilization and efficiency over Internet
links. The SONET standard defines industry interface standards at the physical layer
of the OSI seven-layer model. This standard defines a hierarchy of interface rates that
allow data streams at different rates to be multiplexed. SONET establishes Optical
Carrier (OC) levels from 51.8 Mbps to 2.48 Gbps. Prior rate standards used by
different countries specified rates that were not compatible for multiplexing.
Synchronous Digital Hierarchy (SDH), the international equivalent of SONET,
defines a standard rate of transmission at 155.52 Mbps. With the implementation of
SONET/SDH, communication carriers throughout the world can interconnect existing
digital carrier and fiber optic systems.
The APS feature provides redundancy for BSR 64000 POS modules and allows for a
switchover of POS circuits in the event of a circuit failure.
There are two types of redundancy supported using APS on a POS module:
■ Port Level Redundancy - a port on a POS module is backed by another port on the
same module
■ Module Level Redundancy - all of the ports on a POS module are backed by all of
the ports on another POS module

Compass ID: 188656176 Version 5 MGBI 15-1


BSR 64000 Command Reference Guide Release 4.2.0

For both of these redundancy types, the active ports and the redundant ports have to
be the same speed and have APS enabled.
Switchover to a different POS circuit is dynamic and is not saved in the configuration.
If the BSR 64000 reboots because of a power failure or some other reason after a
switchover has occurred, the initial startup configuration will be re-applied after the
BSR is back online.

POS Command Descriptions


This section contains an alphabetized list and descriptions of the POS commands
supported by the BSR.

15-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

aps force
The aps force command manually switches the specified circuit to a protect
(working) port. The no aps force command cancels the switch.
Use the aps force configuration command unless a request of equal or higher priority
is in effect. Use the aps force command to manually switch the port to the protect port
when you are not using the aps revert command.

Note: The aps force command has a higher priority than any of the signal
failures or the aps manual command.

The aps force command is configured on protect or working ports.

The aps force command takes effect immediately and is not saved with the
configuration.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface) and Slot Configuration

Command Line Usage


aps force <0-15>
no aps force <0-15>

Command Syntax

0-15 the board/port number

Compass ID: 188656176 Version 5 MGBI 15-3


BSR 64000 Command Reference Guide Release 4.2.0

aps group
The aps group command assigns a specific board to a board group.The no aps group
command removes a specific board from a board group. Four APS board groups are
available (0-3).

Note: A protection board and a working board must be assigned to a group in


order for APS to work correctly.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface) and Slot Configuration

Command Line Usage


aps group <0-3>
no aps group <0-3>

Command Syntax

0-3 the APS group number

15-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

aps lockout
The aps lockout command prevents a working board from switching to a protection
board. The no aps lockout command removes the lockout.

Note: The aps lockout command is configured only on protection boards.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface) and Slot Configuration

Command Line Usage


aps lockout
no aps lockout

Compass ID: 188656176 Version 5 MGBI 15-5


BSR 64000 Command Reference Guide Release 4.2.0

aps manual
The aps manual command manually switches all ports from the specified working
board to a protection board. The no aps manual command cancels this switch.
Use the aps manual command to manually switch the working board to the
protection board when you are not using the aps revert command. The aps manual
command to reverts all ports back to the working board before the wait to restore
(WTR) time has expired. The WTR time period is set by the aps revert command.

Note: The aps manual command is a lower priority than any of the signal
failures or the aps force command.

The aps manual command is configured on protection or working boards.

The aps manual command takes effect immediately and is not saved with
the configuration.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface) and Slot Configuration

Command Line Usage


aps manual <0-15>
no aps manual <0-15>

Command Syntax

0-15 the APS board/port number

15-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

aps protect
The aps protect command configures an port as a protection port. The no aps protect
command disables the protection.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface) and Slot Configuration

Command Line Usage


aps protect
no aps protect

Compass ID: 188656176 Version 5 MGBI 15-7


BSR 64000 Command Reference Guide Release 4.2.0

aps revert
The aps revert command enables and sets the time period for automatic switchover
from the protect port to the working port after the working port becomes available. If
revertive mode is selected, the BSR will wait a specified amount of time before
switching back from a protection port to a working port. The no aps revert command
disables automatic switchover.

Note: The aps revert command is configured only on protection ports.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface) and Slot Configuration

Command Line Usage


aps revert <1-255> <0-3>
no aps revert <1-255> <0-3>

Command Syntax

1-255 the number of minutes until the protection


port is switched back to the working port after
the working port becomes available (wait to
restore)
0-3 the number of the port group that is to be
configured for revertive switching (refer to
the aps group command)

15-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

aps signal-degrade ber threshold


The aps signal-degrade ber threshold command sets the BER threshold for b2
signal degrade alarms. The no aps signal-degrade ber threshold command removes
the BER threshold.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface)

Command Line Usage


aps signal-degrade ber threshold <5-9>
no aps signal-degrade ber threshold <5-9>

Command Syntax

5-9 10E-5 to 10E-9 rate

Compass ID: 188656176 Version 5 MGBI 15-9


BSR 64000 Command Reference Guide Release 4.2.0

aps signal-fail ber threshold


The aps signal-fail ber threshold command sets the BER threshold for b2 signal
failure alarms. The no aps signal-fail ber threshold command removes the BER
threshold.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface)

Command Line Usage


aps signal-fail ber threshold <3-5>
no aps signal-fail ber threshold <3-5>

Command Syntax

3-5 10E-3 to 10E-5 rate

15-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

aps unidirectional
The aps unidirectional command initially configures a port for the type of Automatic
Protection Switching that will be used, The BSR64000 supports linear 1+1
unidirectional or bi-directional operation, and can be configured for either revertive or
non-revertive switching.
Use the aps unidirectional configuration command to configure APS for
unidirectional operation.
Use the no aps unidirectional command to configure APS for bi-directional
operation.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface) and Slot Configuration

Command Line Usage


aps unidirectional <0-3>
no aps unidirectional <0-3>

Command Syntax

0-3 the APS group number

Compass ID: 188656176 Version 5 MGBI 15-11


BSR 64000 Command Reference Guide Release 4.2.0

aps working
The aps working command configures a board or port as working. The no aps
working command disables a working board or port.

Group Access
System Administrator

Command Mode
Interface Configuration (POS interface) and Slot Configuration

Command Line Usage


aps working <1-15>
no aps working <1-15>

Command Syntax

1-15 the APS switching priority number

15-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

crc
The crc command sets the mode of the cyclic redundancy check (CRC).
Use the crc command supports four checksum formats. The checksum formats are: 16
bits, 16 bits big-endian, 32 bits, and 32 bits big-endian. The checksum format must be
synchronized on both ends of a PPP link for the link to come up.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


crc {16 | 32} [big-endian]

Command Syntax

16 16 bits
32 32 bits
big-endian use big-endian byte ordering

Command Default
16

Compass ID: 188656176 Version 5 MGBI 15-13


BSR 64000 Command Reference Guide Release 4.2.0

interface pos
The interface pos command accesses Interface Configuration mode for a POS
interface.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


interface pos <X/Y>

Command Syntax

X POS module slot in the BSR chassis


Y POS port number on the POS module

15-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

ip address
The ip address command assigns an IP address and subnet mask for the POS
interface.

Note: An IP address is necessary for the PPP link to be established.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip address {<A.B.C.D> <A.B.C.D>} [secondary]
no ip address {<A.B.C.D> <A.B.C.D>} [secondary]

Command Syntax

A.B.C.D IP address to assign


A.B.C.D subnet address to assign
secondary secondary IP address; secondary subnet-mask

Compass ID: 188656176 Version 5 MGBI 15-15


BSR 64000 Command Reference Guide Release 4.2.0

peer default ip address


The peer default ip address command specifies a default IP address for a remote
peer connecting to this interface. The no peer default ip address command removes
the default IP address from the configuration.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


peer default ip address {A.B.C.D}
no peer default ip address

Command Syntax

A.B.C.D the default IP address for remote end of this interface

15-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

pos ais-shut
The pos ais-shut command sends the LAIS when the POS interface is placed in
administrative shut down state. The no pos ais-shut command disables the sending of
LAIS.
Use the pos ais-shut command to send the LAIS.

Note: In Automatic Protection Switching (APS) environment, AIS-L can be


used to force a protection switch.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


pos ais-shut
no pos ais-shut

Command Default
no LAIS is sent

Compass ID: 188656176 Version 5 MGBI 15-17


BSR 64000 Command Reference Guide Release 4.2.0

pos flag
The pos flag command sets SONET overhead bytes in the SONET frame. The no pos
flag command removes the setting, and sets it back to the default.
This command can be used to assign values for specific elements of the frame header.
Use the pos flag command to ensure communications other vendor equipment or to
meet specific standards.

Note: Although the j1 64byte <string> command is labeled as a 64 byte


string, the user can only enter 62 characters because the last two characters
are reserved for framing.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


pos flag {c2 <hexnum> | c2-exp <hexnum> | j0 <hexnum> | j0 16byte <string> | j1
<hexnum> | j1 16byte <string> | j1 64byte <string> | s1 <hexnum>}
no pos flag {c2 <hexnum> | c2-exp <hexnum> | j0 <hexnum> | j0 16byte <string> |
j1 <hexnum> | j1 16byte <string> | j1 64byte <string> | s1 <hexnum>}

Command Syntax

c2 hexnum path signal identifier used to identify the payload content type,
value is 0xCF for PPP or HDLC without scrambling;
0x16 for PPP or HDLC with scrambling
c2-exp hexnum
j0 hexnum the section trace byte, value is 0x1 for interoperability with
some SDH devices in Japan

15-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

j0 16 byte string the section trace byte sequence, a character string of 15


characters may be entered for interface labeling. (The first byte
contains a calculated CRC-7 byte.
j1 hexnum the path trace byte, default value of 0x0.

j1 16 byte string the path trace byte sequence, a character string of 15 characters
may be entered for STS Channel labeling. The last two bytes
are set to CR and LF for framing purposes
j1 64 byte string the path trace byte sequence, a character string of 62 characters
may be entered for STS Channel labeling. The last two bytes
are set to CR and LF for framing purposes.
s1 hexnum for synchronous status messaging.

Command Default
for c2, 0xCF
for j0, -xCC
for s1 0x0

Compass ID: 188656176 Version 5 MGBI 15-19


BSR 64000 Command Reference Guide Release 4.2.0

pos framing
The pos framing command sets framing to SONET STS-3C or 12C, or SDH STM-1
or STM-4 framing. This is based upon the pos signal mode command. The no pos
framing command resets the default.

Note: If in OC3-C mode, STS-3C or STM-1 applies; if OC12-C then STS-12C


or STM-4 applies.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


pos framing {sdh | sonet}
no pos framing {sdh | sonet}

Command Default
SONET

15-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

pos internal-clock
The pos internal-clock command sets the SONET clock to use a local timing source,
either from the STRATUM 3 clock on the SRM or the Local PLL device on the HSIM
board. The no pos internal-clock command enables loop timing, so that the SONET
interface recovers its clock from the received SONET signal of another piece of Line
Terminating SONET equipment.

Note: STRATUM represents clock types used for network synchronization.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


pos internal-clock
no pos internal-clock

Command Default
internal clock enabled

Compass ID: 188656176 Version 5 MGBI 15-21


BSR 64000 Command Reference Guide Release 4.2.0

pos report
The pos report command enables selected SONET alarms for console logging for a
POS interface. The no pos report command disables selected SONET alarms for
console logging for a POS interfaces.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


pos report {all | b1-tca | b2-tca | b3-tca | lais | lrdi | pais | plop | prdi | rdool | sd-ber
| sf-ber | slof | slos}
no {all | b1-tca | b2-tca | b3-tca | lais | lrdi | pais | plop | prdi | rdool | sd-ber
| sf-ber | slof | slos}

Command Syntax

all enables/disables all possible alarm reporting


b1-tca B1 Bit Error Rate (BER) threshold crossing alarm errors
b2-tca B2 BER threshold crossing alarm errors
b3-tca B3 BER threshold crossing alarm errors
lais line alarm indication signal
lrdi line remote defect indication
pais path alarm indication signal
plop path loss of pointer errors

prdi path remote defect indication


rdool receive data out of lock errors
sd-ber signal degradation BER errors (for APS)

15-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

sf-ber signal failure BER errors (for APS)


slof section loss of frame errors
slos section loss of signal errors

Command Default
All error reporting disabled

Compass ID: 188656176 Version 5 MGBI 15-23


BSR 64000 Command Reference Guide Release 4.2.0

pos scramble
The pos scramble command enables POS Synchronous Payload Envelope (SPE)
scrambling. The no pos scramble command disables POS SPE scrambling.

Note: The show interfaces pos command or the more


nvram:startup-config command displays scrambling status on the system.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


pos scramble
no pos scramble

Command Default
Enabled

15-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

pos signal mode


The pos signal mode command changes ports on the High Speed I/O Module (HSIM)
board to OC3-C or OC12-C
Use the pos signal mode command to change the ports on the HSIM board to either
OC3-C or OC12-C. If you select a mode that is already configured, it notifies the user
and does not reset the mode.

Note: To change to OC12-C mode, this command must be executed from


POS Interface 0.

When switched to OC12-C mode, all of the other three SONET ports are
disabled and are inaccessible through the CLI. The only way to access these
other three ports is to switch back to OC3-C mode.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


pos signal mode {oc3 | oc12}

Command Syntax

oc3 OC3-C mode, 155M


oc12 OC12-C mode, 622M

Compass ID: 188656176 Version 5 MGBI 15-25


BSR 64000 Command Reference Guide Release 4.2.0

pos threshold
The pos threshold command sets the Bit Error Rate (BER) threshold values of
specific alarms on the POS interface. The no pos threshold command sets the rate to
the default setting.

Note: For B1-TCA, the bit interleaved parity error report is calculated by
comparing the BIP-8 code with the BIP-8 code extracted from the B1 byte of
the following frame for B1. Differences indicate that section level bit errors
have occurred.

For B2-TCA, the bit interleaved parity error report is calculated by comparing
the BIP-8/24 code with the BIP-8 code extracted from the B2 byte of the
following frame for B2. Differences indicate that line level bit errors have
occurred.

For B3-TCA, the bit interleaved parity error report is calculated by comparing
the BIP-8 code with the BIP-8 code extracted from the B3 byte of the
following frame for B3. Differences indicate that path level bit errors have
occurred.

SF-BER and SD-BER are directly related to B2 BIP-8 error counts (as is
B2-TCA). SF-BER and SD-BER feed into the APS state machine and can
lead to a protection switch if APS is configured.

B1-TCA, B2-TCA, and B3-TCA print a log message to the console if reports
for them are enabled.

To determine the BER thresholds configured on the interface, use the show
controllers pos command.

Group Access
ISP

Command Mode
Interface Configuration

15-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

Command Line Usage


pos threshold {b1-tca <3-9> | b2-tca <3-9> | b3-tca <3-9>}
no pos threshold {b1-tca | b2-tca | b3-tca}

Command Syntax

b1-tca B1 BER threshold crossing alarm


b2-tca B2 BER threshold crossing alarm
b3-tca B3 BER threshold crossing alarm

3-9 1E-3 to 1E-9 Rate

Command Default
b2-tca
pos threshold 3 (10e-3)
all others default at 6

Compass ID: 188656176 Version 5 MGBI 15-27


BSR 64000 Command Reference Guide Release 4.2.0

ppp magic-number
The ppp magic-number command sends a magic number in a negotiation request.
The no ppp magic-number command disables sending a magic number in a
negotiation request.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ppp magic-number
no ppp magic-number

15-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

ppp negotiation-count
The ppp negotiation-count command sets the number of times to send the
negotiation request to the peer in order to bring a PPP link up. The no ppp
negotiation-count command reverts to the default of continuous sending requests to
bring the PPP link up.

Note: Defaults to continuous sending of negotiation requests to bring up PPP


link.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ppp negotiation-count <1-100>
no ppp negotiation-count

Command Syntax

1-100 number of allowed attempts to try negotiating


with a peer

Command Default
Continuous

Compass ID: 188656176 Version 5 MGBI 15-29


BSR 64000 Command Reference Guide Release 4.2.0

ppp timeout
The ppp timeout command sets the maximum timeout period from the start of a PPP
negotiation request to a response from the remote host. The no ppp timeout
command restores the default maximum timeout period.
Use the ppp timeout command to set the timeout period for PPP negotiation.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ppp timeout {ncp 1-2147483> | retry 0-2147483>}
no ppp timeout {ncp | retry}

Command Syntax

ncp 1-2147483 amount of time, in seconds, configured before


timing out from lack of response at the NCP
layer
retry 0-2147483 amount of time, in seconds, configured before
timing out from lack of response at the LCP
layer

Command Default
10 seconds

15-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

show aps
The show aps command provides APS configuration and statistics information for
groups containing working and protection ports.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show aps

Compass ID: 188656176 Version 5 MGBI 15-31


BSR 64000 Command Reference Guide Release 4.2.0

show controllers pos


The show controllers pos command displays high level information on the POS
controllers.
Use the show controllers pos command for troubleshooting. The following POS
controller information is provided:

SECTION: section portion of the SONET link errors; a section can be


between the Customer Premise Equipment (CPE) and SONET
Service Provider Equipment (SPE)

B1_ERRORS = B1 BER threshold crossing alarm


LINE: line portion errors; a line can be between a SONET SPE,
regenerators and another SONET SPE

B2_ERRORS = B2 BER threshold crossing alarm


REI_ERRORS = Remote Error Indicator
PATH: errors that occur on the path portion of the SONET link; a path
can be between a CPE, SONET SPE, regenerators and another
SONET SPE and CPE

B3_ERRORS = B3 BER threshold crossing alarm


GI_ERRORS = G1 threshold crossing alarm
Active Defects: list of all active SONET defects
Active Alarms: list of current alarms as enforce by SONET alarm hierarchy
Alarm reporting alarms enabled through the pos report command
enabled for:
APS: Rx(K1/K2)/Tx(K1/K2) = contents of the received and
transmitted K1 and K2 bytes.
PATH SIGNAL C2 = received value from the SONET path signal label byte
LABEL:

15-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

SYNCHRONOUS S1 = lower 4 bits of S1 byte.


STATUS
MESSAGE:
CLOCK SONET clock recovered using information in the SONET
RECOVERY: overhead. RDOOL = an inexact count of the number of
times Receive Data Out Of Lock has been detected.
PATH TRACE SONET path trace buffer for communication information
BUFFER: about remote hostname, interface name and number, and IP
address, or any other message you choose
APS BER list of the APS bit-error rate (BER) thresholds configured with
thresholds: the pos threshold command
TCA thresholds: list of threshold crossing alarms (TCA) configured with the
pos threshold command

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show controllers pos [<X/Y>]

Command Syntax

X/Y POS interface slot and port number

Compass ID: 188656176 Version 5 MGBI 15-33


BSR 64000 Command Reference Guide Release 4.2.0

show interfaces pos


The show interfaces pos command displays the SONET interface configuration. The
following information is provided:

POS 15/0 is indicates whether the interface hardware is currently active and
administratively can transmit and receive or if it has been taken down by an
up/down, line administrator
protocol is up/down
Hardware hardware type
MTU maximum transmission units of the interface
BW interface bandwidth in kilobits per second
Encapsulation encapsulation method assigned to interface
Keepalive keepalive set indicator
Scramble POS scramble enable
LCP Initial LCP initialized
IPCP Initial IPCP initialized

Last input hours, minutes, and seconds since the last packet was
successfully received by an interface.; useful for knowing
when a dead interface failed
Last output hours, minutes, and seconds since the last packet was
successfully transmitted by an interface
Last clearing of show interface counters
Last state change hours, minutes, and seconds when the interface was reset
Queueing strategy first-in, first-out queuing strategy (other queueing strategies
you might see are priority-list, custom-list, and weighted fair)
Output queue, number of packets in output and input queues. Each number is
drops/input queue, followed by a slash, the maximum size of the queue, and the
drops number of packets dropped because a queue was full
packets input error-free packets received by the system

15-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

bytes (input) number of bytes, including data and MAC encapsulation, in


the error-free packets received by the system
broadcasts number of broadcast packets received by the interface
multicasts number of multicast packets received by the interface
input errors number of no buffer, runts, giants, CRCs, frame, overrun,
ignored, and abort counts; other input-related errors can also
increment the count, so that this sum might not balance with
the other counts
CRC cyclic redundancy checksum generated by the originating
LAN station or far-end device does not match the checksum
calculated from the data received. On a LAN, this usually
indicates noise or transmission problems on the LAN interface
or the LAN bus itself. A high number of CRCs is usually the
result of collisions or a station transmitting bad data. On a
serial link, CRCs usually indicate noise, gain hits or other
transmission problems on the data link
overruns number of times the serial receiver hardware was unable to
hand received data to a hardware buffer because the input rate
exceeded the receiver's ability to handle the data
runts packets that are discarded because they are smaller than the
medium's minimum packet size
giants packets that are discarded because they exceed the medium's
maximum packet size
aborts illegal sequence of one bits on the interface
packets output total number of messages transmitted by the system
bytes (output) total number of bytes, including data and MAC encapsulation,
transmitted by the system
output errors sum of all errors that prevented the final transmission of
datagrams out of the interface being examined. Note that this
might not balance with the sum of the enumerated output
errors, as some datagrams can have more than one error, and
others can have errors that do not fall into any of the
specifically tabulated categories.

Compass ID: 188656176 Version 5 MGBI 15-35


BSR 64000 Command Reference Guide Release 4.2.0

collisions collision indication


underruns Number of times that the far-end transmitter has been running
faster than the near-end router's receiver can handle
carrier transitions Number of times the carrier detect signal of the interface has
changed state.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show interfaces pos [<X/Y>] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show interfaces pos [<X/Y>] [ | {count | count-only}]

Command Syntax

X/Y POS interface slot and port number


| turns on output modifiers (filters)
begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

15-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 POS Commands

show ppp info


The show ppp info command displays PPP link and statistic information.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ppp info [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show ppp info [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 188656176 Version 5 MGBI 15-37


BSR 64000 Command Reference Guide Release 4.2.0

show ppp statistics


The show ppp statistics command displays the PPP running statistics.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ppp statistics [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ppp statistics [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

15-38 MGBI Compass ID: 188656176 Version 5


16
BGP Commands

Introduction
This chapter describes the Border Gateway Protocol version 4 (BGP-4) commands
used with the BSR.
BGP is an Inter-Autonomous System (AS) routing protocol that exchanges network
availability information with any other router speaking BGP. The information for a
network is the complete list of ASs that traffic must transport to reach that network
and is then used to assure loop-free paths. This information is used to construct a
graph of AS connectivity from which routing loops may be pruned, and some policy
decisions at the AS level may be enforced.

BGP Command Descriptions


This section contains an alphabetized list and descriptions of the BGP commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 16-1


BSR 64000 Command Reference Guide Release 4.2.0

aggregate-address
The aggregate-address command creates an entry in the BGP routing table. The no
aggregate-address command disables this function. Use the aggregate-address
command to implement aggregate routing by redistributing the route in BGP.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


aggregate-address <A.B.C.D> <A.B.C.D> [advertise-map <WORD>] [as-set]
[attribute-map <WORD>] [summary-only] [suppress-map <WORD>]
no aggregate-address <A.B.C.D> <A.B.C.D> [advertise-map <WORD>] [as-set]
[attribute-map <WORD>] [summary-only] [suppress-map <WORD>]

Command Syntax
A.B.C.D aggregate address in routing table

A.B.C.D aggregate mask in routing table


advertise-map WORD name of route map to choose the routes to
include into the aggregate and generate
associated attributes if as-set is specified
attribute-map WORD route map name to establish aggregate route
attribute
as-set generates AS set path information
summary-only creates aggregate route and suppresses
advertisements of all aggregated, more
specific routes
suppress-map WORD suppresses chosen, specific routes

Command Default
Disabled

16-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

auto-summary
The auto-summary command returns the user back to the automatic summarization
default of subnet routes into network-level routes. The no auto-summary command
disables this function.
When the route is summed up, it reduces the amount of routing information in the
routing tables. Use the network command or the no auto-summary command to
advertise and transmit subnet routes in BGP. BGP will not accept subnets distributed
from IGP.
If a network command is not entered, and auto-summarization is disabled, network
routes will not be advertised for networks with subnet routes unless they contain a
summary route.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


auto-summary
no auto-summary

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 16-3


BSR 64000 Command Reference Guide Release 4.2.0

bgp always-compare-med
The bgp always-compare-med command enables comparison of the Multi-exit
Discriminator (MED) from path entries from different ASs. The no bgp
always-compare-med command stops comparisons.
Use the bgp always-compare MED command to change the default, allowing
comparison of MEDs, which are received from any autonomous system. By default,
during the best-path selection process, MED comparison is done only among paths
from the same autonomous system. This command changes the default behavior by
allowing comparison of MEDs among paths regardless of the autonomous system
from which the paths are received.
The MED path, considered the best path, is the parameter used when selecting the
paths compared to many other options. The preference between a path with a lower
MED and a path with a higher MED, is the lower MED path.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


bgp always-compare-med
no bgp always-compare-med

16-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

bgp client-to-client reflection


The bgp client-to-client reflection command re-establishes route reflection from a
BGP router reflector client to other clients. The no bgp client-to-client reflection
command stops the re-establishment of route reflection from a BGP router reflector.
Use the bgp client-to-client-reflection command to configure the cluster if it has
more than one route and to increase redundancy. The routes from a client, or route
reflector, are reflected to other clients. Clients of a route reflector are not required to
be fully interconnected.
More often than not, a cluster of clients will have a single route reflector. The router
ID of the route reflector identifies the cluster. To ensure increased redundancy, and
evade a single point of failure, a cluster might have more than one route reflector. If
this is the case, all route reflectors that are in the must be configured with a 4-byte
cluster ID. Use the no bgp client-to-client command to disable BGP client-to-client
reflection. If client-to-client reflection is enabled, clients of a route reflector can not
be members of a peer group

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


bgp client-to-client reflection
no bgp client-to-client reflection

Command Default
When a route reflector is configured, it reflects routes from a client to other clients.

Compass ID: 188656176 Version 5 MGBI 16-5


BSR 64000 Command Reference Guide Release 4.2.0

bgp cluster-id
The bgp cluster-id command configures a cluster ID if the BGP cluster has more than
one route reflector. The no bgp cluster-id command removes the cluster.
Use the bgp cluster-id command to increase redundancy and avoid a single point of
failure. Route reflectors in a cluster must be configured with a 4-byte cluster ID in
order to be recognized from route reflectors in the same cluster. Use this command to
configure the cluster ID if the route reflector has more than one route.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


bgp cluster-id <value>
no bgp cluster-id <value>

Command Syntax

value router (as a route reflector) ID in IP address


format

Command Default
router ID route reflector in cluster

16-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

bgp confederation identifier


The bgp confederation identifier command configures a BGP confederation
identifier. The no bgp confederation identifier command removes a BGP
confederation identifier.
Use the bgp confederation identifier command to reduce the IBGP mesh which
splits an autonomous system into many autonomous systems. They are then grouped
into an individual confederation. Each autonomous system is entirely engaged and has
a small number of connections to other autonomous systems in the identical
confederation. The confederation appears to be an individual autonomous system to
all else.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


bgp confederation identifier <1-65535>
no bgp confederation identifier <1-65535>

Command Syntax

1-65535 autonomous system number to identify


confederation as a whole

Compass ID: 188656176 Version 5 MGBI 16-7


BSR 64000 Command Reference Guide Release 4.2.0

bgp confederation peers


The bgp confederation peers command configures the ASs that belong to the
confederation. The no bgp confederation peer command removes an AS from the
confederation.
Use the bgp confederation peers command to configure the ASs that belong to a
confederation. Autonomous systems specified in this command are visible internally
to a confederation. Each autonomous system is fully meshed within itself. The BGP
confederation identifier command specifies the confederation to which the
autonomous systems belong.

Group Access
ISP

Command Mode
Router configuration

Command Line Usage


bgp confederation peers <1-65535> [1-65535...]
no bgp confederation peers <1-65535>

Command Syntax[

1-65535 autonomous system number

16-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

bgp dampening
The bgp dampening command enables BGP route dampening. The no bgp
dampening command to sets the default values or disables this function.

Note: The penalty is halved after the half-life period when a route is flapping.
The router configured for damping (dampening) assigns a penalty to a route
when a route flaps. Penalties are cumulative and are stored in the BGP
routing table. A flapping route is suppressed when its penalty exceeds the
suppress limit. A suppressed route is reused when its decayed penalty falls
below the reuse limit.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


bgp dampening [<1-45> <1-20000> <1-20000> <1-255>| route-map <WORD>]
no bgp dampening

Command Syntax

1-45 half-life period in minutes, each time a route


is assigned a penalty, the penalty is decreased
by half after the half-life period in 5 second
intervals, with penalties being cumulative
1-20000 allows route to be reused if penalty for
flapping route falls below reuse value
1-20000 route suppresses when its penalty exceeds this
value
1-255 maximum suppression time in minutes
route-map WORD route map name

Compass ID: 188656176 Version 5 MGBI 16-9


BSR 64000 Command Reference Guide Release 4.2.0

Command Default

half life = 15 minutes


route reuse = 750
route suppression = 2000

maximum suppression = 4 times the half-life


time

16-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

bgp default
The bgp default command specifies the default route advertisement which is sent to
all routers in the local ASs. The no bgp default command disables a default
advertisement.
A default route in a router IP forwarding table is used by the router if a routing entry
for a destination does not exist. By convention, a default route is represented by the
network mask combination 0.0.0.0/0.0.0.0. Any AS advertising the default route
represents itself as the gateway of last resort to other systems.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


bgp default { ipv4-unicast | local-preference <0-4294967295> | route-refresh |
vpnv4 }
no bgp default { ipv4-unicast | local-preference <0-4294967295> | route-refresh |
vpnv4 }

Command Syntax

ipv4-unicast activate IP Version 4 (IPv4) Unicast for a peer


by default
local-preference local preference value (higher values receive
0-4294967295 preference) - when multiple paths exist to the
same destination, the local preference
specifies the preferred path
route-refresh activate Route Refresh for a peer by default

vpnv4 activate VPN-IP Version 4 (VPNv4) for a


peer by default

Compass ID: 188656176 Version 5 MGBI 16-11


BSR 64000 Command Reference Guide Release 4.2.0

bgp permit
The bgp permit command permits updates with either the AGGREGATOR attribute
set to the 0 Autonomous System (AS) or with the 0.0.0.0 address in the BGP routing
process. The no bgp permit command disables the updates.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


bgp permit [aggregator-AS-0 | aggregator-address-0]
no bgp permit [aggregator-AS-0 | aggregator-address-0]

Command Syntax

aggregator-AS-0 permits updates to AGGREGATOR attribute


set with an AS of 0.
aggregator-address-0 permits updates with the AGGREGATOR
attribute set with a 0.0.0.0 address.

Command Default
Disabled

16-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

bgp router-id
The bgp router-id command overrides a configured BGP router identifier (IP
address) by manually configuring a new identifier. The no bgp router-id command
restores the initial configuration.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


bgp router-id <A.B.C.D>
no bgp router-id

Command Syntax

A.B.C.D the new BGP router identifier (IP address)

Compass ID: 188656176 Version 5 MGBI 16-13


BSR 64000 Command Reference Guide Release 4.2.0

clear ip bgp
The clear ip bgp command resets a BGP connection using soft reconfiguration.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ip bgp {* | <A.B.C.D> | <WORD>}[soft [in | out]]

Command Syntax

* resets active BGP sessions


A.B.C.D IP address of BGP neighbor to clear
WORD name of a specific BGP peer group to clear
the state
soft reapply any export policies and sends refresh
updates without clearing the state
in inbound soft reconfiguration; reapply any
import policies and send refresh updates
without clearing the state
out outbound soft reconfiguration

Command Default
Disabled

16-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

clear ip bgp dampening


The clear ip bgp dampening command clears route dampening information and
unsuppress the suppressed routes.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ip bgp dampening [<A.B.C.D> | <A.B.C.D>]

Command Syntax

A.B.C.D IP address of the network about which to


clear dampening information
A.B.C.D network mask applied to the above address

Compass ID: 188656176 Version 5 MGBI 16-15


BSR 64000 Command Reference Guide Release 4.2.0

clear ip bgp flap-statistics


The clear ip bgp flap-statistics clears BGP flap statistics.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ip bgp flap-statistics [<A.B.C.D> | filter-list <1-199> | regexp <LINE>]

Command Syntax

A.B.C.D network to clear flap statistics


filter-list clear flap statistics for all the paths that pass
the access list

1-199 clear flap statistics for all the paths that match
the regular expression
regexp clear flap statistics for all the paths that match
the regular expression.
LINE a regular-expression to match the BGP AS
paths

16-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

default-information originate
The default-information originate command generates a default route into the BGP
database. The no default-information originate command disables default route
generation.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


default-information originate
no default-information originate

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 16-17


BSR 64000 Command Reference Guide Release 4.2.0

default-metric
The default metric feature is used to eliminate the need for separate metric definitions
for each routing protocol redistribution.The default-metric command forces the BGP
routing protocol to use the same metric value for all distributed routes from other
routing protocols. The no default-metric command removes or changes the default
metric value for the BGP routing protocol.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


default-metric <0-4294967295>
no default-metric

Command Syntax

0-4294967295 Default metric value.

16-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

distance bgp
The distance bgp command sets external, internal, and local administrative distances
for routes to function. The no distance bgp command sets the default values.
Use the distance bgp command to administer distance based on the preferred routing
information source received from a router or group of routers. This enables the system
to prioritize protocols dependant upon the distances between 1 to 255, where 0 is the
best route, and the most unreliable route is 255. The bgp distance command has an
influence on whether the BGP-learned routes are installed in the routing table.

Note: It is recommended that the administrative distance not be changed.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distance bgp [<1-255> < 1-255> <1-255>]
no distance bgp

Command Syntax

1-255 administrative distance for routes external to


the AS
1-255 administrative distance for routes external to
the AS - routes with a distance of 255 are not
installed in the routing table
1-255 administrative distance for local route

Compass ID: 188656176 Version 5 MGBI 16-19


BSR 64000 Command Reference Guide Release 4.2.0

Command Default

external distance = 20
internal distance = 200
local distance = 200

16-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

distribute-list in
The distribute-list in command filters networks received in routing updates. The no
distribute-list in command changes or cancels the filters received in updates.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distribute-list <1-199> <1300-2699> in
no distribute-list <1-199> <1300-2699> in

Command Syntax

1-199 access list number


1300-2699 extended access list number
in applies access list to incoming route updates

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 16-21


BSR 64000 Command Reference Guide Release 4.2.0

distribute-list out
The distribute-list out command prevents networks from being advertised in
updates. The no distribute-list out command enables update advertisements.
Use the distribute-list out command to apply the access list to outgoing route
updates.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


distribute-list <1-199> <1300-2699> out
no distribute-list <1-199> <1300-2699> out

Command Syntax

1-199 pre-defined access list number


1300-2699
out applies access list to outgoing route updates

Command Default
Disabled

16-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

ip as-path access-list
The ip as-path access-list command creates or modifies a BGP related access list and
its elements. The no ip as-path access command deletes the corresponding list
element.
Use the no ip as-path access-list command to modify elements and add to the IP
as-path access list of corresponding elements. Use the ip as-path access-list and the
neighbor filter-list commands to use as-path filters to filter BGP advertisements.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip as-path access-list <1-199> {permit <LINE> | deny <LINE>}
no ip as-path access <1-199>

Command Syntax

1-199 access list number


permit permits access for matching conditions
deny denies access to matching conditions
LINE regular expression describing the as-paths to
be matched

Compass ID: 188656176 Version 5 MGBI 16-23


BSR 64000 Command Reference Guide Release 4.2.0

ip community-list
The ip community-list command creates a BGP related access list and its
elements.There are two types of community lists: standard and extended. The
standard community lists have a list number from 1 to 99. The extended community
lists have a list number from 100 to 199. The ip community-list deletes the
community lists and all associated elements.
The community lists are used in the match community-list command and the set
communities’ set comm-list delete commands. The route maps are used for inbound
and outbound filtering.

Note: The community lists are related to the respective elements, and are of
the standard and extended types:

Standard community lists:

To create a standard community list and its elements, use the ip


community-list command. To delete the list element use the no ip
community-list command.

If there is no elements left in the list, the list will be removed too. To delete the
community list and all its elements use the no ip community-list command.

Extended community lists:

To create an extended community list and its elements use the ip


community-list command. To delete the list element use the no ip
community-list command. If there are no elements left in the list, the list will
be removed too.

Group Access
ISP

Command Mode
Global Configuration

16-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

Command Line Usage


ip community-list <1-99>{deny | permit } [<1-4294967295> | internet | local-AS |
no-advertise | no-export ]
ip community-list <100-199>{deny | permit } <LINE> [<LINE>...]
no ip community-list <1-99>{deny | permit } [<1-4294967295> | internet |
local-AS | no-advertise | no-export ]
no ip community-list <100-199>{deny | permit } <LINE> [<LINE>...]

Command Syntax

1-99 standard access list number,


100-199 extended access list number
deny prevents access for matching
permit allows access for matching
1-4294967295 a community number - you can specify a
single number or multiple numbers
separated by a space
internet internet community
local-AS do not advertise this route to peers outside of
the local autonomous system
no-advertise do not advertise this route to any peer
internal or external
no-export routes with this community are sent to
peers in other sub-autonomous systems
within a confederation
LINE an ordered list as a regular expression

Compass ID: 188656176 Version 5 MGBI 16-25


BSR 64000 Command Reference Guide Release 4.2.0

match as-path
The match as-path command matches a BGP autonomous system path access list
match entries or appends new list numbers to the existing match entry. The no match
as-path command removes the list numbers from the match entry used in the
command.
Use the match as-path command to match a BGP autonomous system path to
advertise on the route-map. Values can be set using the match as-path command.
Use the match as-path command to match at least one BGP autonomous system path
to ensure advertisement on the route-map.
Use the match as-path command to globally replace values matched and set with the
match as-path command and the set weight command to supersede weights
established with the neighbor weight and the neighbor filter-list commands.
The values set by the match and set commands override global values. For example,
the weights assigned with the match as-path and set weight route-map commands
override the weights assigned using the neighbor weight and neighbor filter-list
commands. The implemented weight is established by the initial autonomous system
match.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


match as-path [<1-199>]
no match as-path [<1-199>]
Command Syntax

1-199 as-path list number - you can specify a


single number or multiple numbers
separated by a space

16-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

match community
The match community command creates a BGP autonomous system community
access list match entry or appends new list numbers to the existing match entry. The
no match community command removes the match entry completely. The no match
community command removes the list numbers or the exact-match attribute from the
match entry use the command
Use the match community-list command to ensure that the route is advertised for
outbound and inbound route-maps. If a change to some of the information is to match
is needed, configure a second route-map with specifics.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


match community [<1-99> <100-199>] exact-match]
no match community [<1-99> <100-199>] exact-match]

Command Syntax

1-99 standard community list number


100-199 extended community list number
exact-match exact match required; all of the communities
and only those communities in the
community list must be present

Compass ID: 188656176 Version 5 MGBI 16-27


BSR 64000 Command Reference Guide Release 4.2.0

maximum-paths
The maximum-paths command specifies the maximum number of parallel routes an
IP routing protocol can support. The no maximum-paths command changes or
cancels the number of maximum paths.

Group Access
RESTRICTED

Command Mode
Router Configuration

Command Line Usage


maximum-paths <1-2>
no maximum-paths

Command Syntax

1-2 the maximum number of parallel routes

16-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor advertisement-interval
The neighbor advertisement-interval command sets the minimum amount of time
between sending BGP routing updates. The no neighbor advertisement-interval
form of this command to delete an entry.
Use the neighbor advertisement-interval command to configure all the members of
the peer group with the same attributes.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} advertisement-interval <0-600>
no neighbor {<A.B.C.D> | <WORD>} advertisement-interval <0-600>

Command Syntax

A.B.C.D neighbor IP address


WORD neighbor peer-group-name
0-600 amount of time in seconds

Command Default
30 seconds for external peers
5 seconds for internal peers

Compass ID: 188656176 Version 5 MGBI 16-29


BSR 64000 Command Reference Guide Release 4.2.0

neighbor confed-segment
The neighbor confed-segment command allows you configure a neighbor to use
either AS confederation sequence or AS confederation set as the path segment type in
the AS path attribute. The no neighbor confed-segment command disables the AS
confederation path segment type attribute.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D>} confed-segment {sequence | set}
no neighbor {<A.B.C.D>} confed-segment {sequence | set}

Command Syntax

A.B.C.D neighbor IP address


sequence convert to AS_CONFED_SEQUENCE
(rfc3065: value 3)
set convert to AS_CONFED_SET
(rfc3065: value 4)

Command Default
AS confederation path segment type attribute is disabled.

16-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor default-originate
The neighbor default-originate command allows a BGP speaker to send the default
route 0.0.0.0 to a neighbor for the neighbor’s default. The no neighbor
default-originate command sends no route as a default.
The neighbor default-originate command does not require the presence of 0.0.0.0 in
the local router, and when used with a route map, the default route 0.0.0.0 is injected
only if the route map contains a match ip address clause and there is a route that
matches the IP access list exactly. The route map can contain other match clauses
also.
The user can use standard or extended access lists with the neighbor
default-originate command.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} default-originate [route-map <WORD>]
no neighbor {<A.B.C.D> | <WORD>} default-originate [route-map <WORD>]

Command Syntax

A.B.C.D neighbor IP address


WORD peer group name
WORD route map name

Compass ID: 188656176 Version 5 MGBI 16-31


BSR 64000 Command Reference Guide Release 4.2.0

neighbor description
The neighbor description command provides a neighbor a description. The no
neighbor description clears the provided neighbor description.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} description [LINE]
no neighbor {<A.B.C.D> | <WORD>} description [LINE]

Command Syntax

A.B.C.D neighbor IP address


WORD name of a BGP peer group
LINE up to 80 characters in length to describe
neighbor

16-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor distribute-list
The neighbor distribute-list command distributes BGP neighbor information based
on the access list. The no neighbor distribute-list command deletes an entry.
Use the neighbor distribute-list command to filter BGP advertisements. Also, use
the ip as-path access-list and the neighbor filter-list commands to use as-path filters
to filter BGP advertisements. If a BGP peer group is specified, all members of that
group are associated. Specifying the neighbor distribute-list command with an IP
address to replace the value already in the peer group.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} distribute-list <1-199> <1300-2699>{in | out}
no neighbor {<A.B.C.D> | <WORD>} distribute-list <1-199> <1300-2699>{in |
out}

Command Syntax

A.B.C.D neighbor IP address


WORD name of a BGP peer group
1-199 number of a standard or extended access list
1300-2699 number of an expanded range access list
in within the group

out outside the group

Compass ID: 188656176 Version 5 MGBI 16-33


BSR 64000 Command Reference Guide Release 4.2.0

neighbor ebgp-multihop
The neighbor ebgp-mulithop command accepts route updates from external peers
residing on the network that are not directly connected. The no neighbor
ebgp-mulithop command blocks route updates.
Use the neighbor ebgp-multihop command to modify BGP peer groups for unified
configuration by specifying a peer-group-name.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} ebgp-multihop <1-255>
no neighbor {<A.B.C.D> | <WORD>} ebgp-multihop <1-255>

Command Syntax

A.B.C.D IP address of external peer, BGP neighbor


WORD external BGP group name
1-255 the maximum hop count - if no value is
entered, the default value of 255 is used

16-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor filter-list
The neighbor filter-list command creates a BGP filter. The no neighbor filter-list
command disables this function.
Use the neighbor filter-list command to create filters on both inbound and outbound
BGP routes. Unlimited weight filters are accepted on a per-neighbor principle, but
only one inbound or one outbound filter is accepted, not both. Route selection rules
determine the weight of a route.
Weight assignment is based on the initial autonomous system path, or as-path.
Weights announced override weights assigned by global neighbor commands. This
happens when the initial match is made. Therefore, weights assigned using match
as-path and set weight commands override weights assigned by the neighbor weight
and neighbor filter-list commands.
Members of a peer group realize configured specifics when the peer-group-name
argument is used with the neighbor filter-list command. If the neighbor filter-list
command is used with a specified IP address, then the IP address overrides the value
from the peer group.

Note: Using the command in the form, no neighbor {ip-address |


peer-group} filter-list <access-list-number> weight [<weight>], the optional
[<weight>] argument has no effect.

Using the command in the form, neighbor {ip-address | peer-group}


filter-list [<access-list-number>] {in | out }, the optional
[<access-list-number>] argument has no effect.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} filter-list <1-199> {in | out | weight <0-65535>}
no neighbor {<A.B.C.D> | <WORD>} filter-list <1-199> {in | out | weight
<0-65535>}

Compass ID: 188656176 Version 5 MGBI 16-35


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D neighbor IP address


WORD BGP peer group
1-199 filter list number
in access list to incoming routes
out access list to outgoing routes
weight BGP weight metric assigned for competing
0-65535 incoming routes; accepted values are 0 to
65535; the largest weight is preferred

Command Default
Disabled

16-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor maximum-prefix
The neighbor maximum-prefix command controls the number of prefixes accepted
from a neighbor. The no neighbor maximum-prefix command stops the controlled
number of prefixes accepted from a neighbor.
Use the neighbor maximum-prefix command to manage the number of prefixes
accepted from a neighbor.

Note: A prefix is a classless route or a route with a particular starting point


and length, with unlimited prefixes. Therefore, 198.7.97.0/27 and 198.7.97.0/
20 are not the same prefix (route). If the maximum number of acceptable
prefixes configured is exceeded, the router ends peering, which is the default.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} maximum-prefix <1-65536> [<1-100 > |
warning-only ]
no neighbor {<A.B.C.D> | <WORD>} maximum-prefix <1-65536> [<1-100> |
warning-only ]

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer-group
1-65536 maximum number of configured prefixes
allowed from specific neighbor

Compass ID: 188656176 Version 5 MGBI 16-37


BSR 64000 Command Reference Guide Release 4.2.0

1-100 integer specifying what percentage of the


maximum number that the router generates a
warning message
warning-only only generate a warning message when the
maximum number is exceeded

Command Default
Disabled
Threshold default, 75%

16-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor next-hop-self
The neighbor next-hop-self command disables BGP processing updates. The no
neighbor next-hop-self command enables BGP processing updates.

Note: Members of a peer group realize configured specifics when the


peer-group-name argument is used with the neighbor next-hop-self
command.

Specifying the command with an IP address will override the value inherited
from the peer group. Use the set ip next-hop command for additional
control.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} next-hop-self
no neighbor {<A.B.C.D> | <WORD>} next-hop-self

Command Syntax

A.B.C.D neighbor IP address


WORD name of neighbor peer-group

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 16-39


BSR 64000 Command Reference Guide Release 4.2.0

neighbor password
The neighbor password command enables the Message Digest 5 (MD5)
authentication on a TCP connection between two BGP peers. The no neighbor
password command disables the Message Digest 5 (MD5) authentication on a TCP
connection between two BGP peers.
Use the neighbor password command to authenticate and to verify TCP connections
between two BGP peers, of which the same password is configured. This command
begins the MD5 generation for outgoing packets and check every segment on a TCP
connection for incoming packets.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} password {0 | 7 }<LINE>
no neighbor {<A.B.C.D> | <WORD>} password {0 | 7} <LINE>

Command Syntax

A.B.C.D neighbor IP address


WORD name of neighbor peer-group
0 specifies an UNENCRYPTED password will
follow
7 specifies an ENCRYPTED password will
follow
LINE the password (1-32 characters)

Command Default
Disabled

16-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor peer-group (assigning members)


The neighbor peer-group (assigning members) command configures a BGP
neighbor to be a member a BGP peer group. The no neighbor peer-group (assigning
members) command removes the neighbor from the peer group.
The neighbor peer-group creates a new member of a peer-group. If there is no such
peer, it will be created and assigned to the group. If there is such peer already, and it
does not belong to any other group, it will be assigned to the group and inherit its AS
number and all its policies. If an existing peer belongs to another group, it must be
removed from that group first with no neighbor peer-group command.
The neighbor at the IP address specified completes all of the configuration options of
the peer group.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor <A.B.C.D> peer-group <WORD>
no neighbor <A.B.C.D> peer-group <WORD>

Command Syntax

A.B.C.D address of the BGP neighbor


WORD the name of the peer-group

Compass ID: 188656176 Version 5 MGBI 16-41


BSR 64000 Command Reference Guide Release 4.2.0

neighbor peer-group (creating)


The neighbor peer-group (creating) command creates a BGP peer group. The no
neighbor peer-group (creating) command removes the peer group and all of its
members.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor <WORD> peer-group
no neighbor <WORD> peer-group

Command Syntax

WORD peer group name

16-42 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor remote-as
The neighbor remote-as command performs many functions as described below. Use
the neighbor remote-as number command to assign a BGP router to an autonomous
system.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage

neighbor <A.B.C.D> remote-as <1-65535>


creates a new BGP peer and assigns an AS number to it. If such peer does not exist
already, it assigns a new AS number to existing peer. Such assignment can be done for
the existing peer only if it is not a member of any peer-group.

no neighbor <A.B.C.D> [remote-as [<1-65535>]]


deletes the corresponding peer, regardless if it is peer-group member or not.

neighbor <WORD> remote-as <1-65535>


assigns a new AS number to existing peer-group. If the peer-group has an AS number
already, it will be replaced with the new one. All existing peer-group members will
inherit this AS number too.

no neighbor <WORD> remote-as [<1-65535>]


removes the peer-group and all its members.

Compass ID: 188656176 Version 5 MGBI 16-43


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

A.B.C.D BGP peer address


WORD name of BGP peer group
1-65535 neighbor autonomous system number

16-44 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor remove-private-as
The neighbor remove-private-as command triggers the removal of private AS
numbers from outbound updates. Use no neighbor remove-private-as command to
stops such removal.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} remove-private-as
no neighbor {<A.B.C.D> | <WORD>} remove-private-as

Command Syntax

A.B.C.D address of the BGP neighbor


WORD name of neighbor peer-group

Command Default
No removal

Compass ID: 188656176 Version 5 MGBI 16-45


BSR 64000 Command Reference Guide Release 4.2.0

neighbor route-map
The neighbor route-map command applies a route map to incoming or outgoing
routes. The no neighbor route-map command clears a route map for incoming and
outgoing routes.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} route-map <WORD> {in | out}
no neighbor {<A.B.C.D> | <WORD>} route-map <WORD> {in | out}

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer group
WORD name of route-map

in apply to incoming routes


out apply to outgoing routes

16-46 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor route-reflector-client
The neighbor route-reflector-client command configures the router as a BGP
route-reflector. The no neighbor route-reflector-client command configures a router
back to a BGP route-reflector.
Use the neighbor route-reflector-client command to establish a local router to act as
the route-reflector with the specified neighbor as a client.

Note: When all clients are disabled, the local router is no longer a
route-reflector.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} route-reflector-client
no neighbor {<A.B.C.D> | <WORD>} route-reflector-client

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer group

Compass ID: 188656176 Version 5 MGBI 16-47


BSR 64000 Command Reference Guide Release 4.2.0

neighbor route-refresh
The neighbor route-refresh command allows a BGP neighbor to accept route refresh
requests. The no neighbor route-refresh command disables the acceptance of reoute
refresh requests for a BGP neighbor.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} route-refresh
no neighbor {<A.B.C.D> | <WORD>} route-refresh

Command Syntax

A.B.C.D BGP neighbor IP address


WORD name of BGP peer group

16-48 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor send-community
The neighbor send-community command will allow a communities attribute, if any,
to be sent in outbound updates to a neighbor. The no neighbor send-community
command stops sending communities attribute.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} send-community [both | extended | standard]
no neighbor {<A.B.C.D> | <WORD>} send-community [both | extended |
standard]

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer group
both send standard and extended community
attributes
extended send extended community attributes
standard send standard community attributes

Compass ID: 188656176 Version 5 MGBI 16-49


BSR 64000 Command Reference Guide Release 4.2.0

neighbor shutdown
The neighbor shutdown command disables a neighbor or peer group. The no
neighbor shutdown command enables a neighbor or peer group.
Use the neighbor shutdown command to end an session for a particular neighbor or
peer group. This removes all routing information associated.
Use the show ip bgp summary command for a list of neighbors and peer-group
connection. Those neighbors with an Idle status and the Administrative entry have
been disabled by the neighbor shutdown command.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} shutdown
no neighbor {<A.B.C.D> | <WORD>} shutdown

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer group

16-50 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor soft-reconfiguration inbound


The neighbor soft-reconfiguration inbound command starts the storage of incoming
updates without any modification. The no neighbor soft-reconfiguration inbound
command stops this storage and releases the memory used for them.
Use the neighbor soft-reconfiguration inbound command to start update story
required to enable inbound software configuration with the clear ip bgp soft [in]
command. Outbound BGP soft-reconfiguration does not need inbound software
configuration.
Outbound BGP soft-reconfiguration does not need inbound software configuration.

Note: When the neighbor soft-reconfiguration inbound command is


issued, the peer will first be disabled and then enabled again. The no form of
this command doesn't bring the peer down.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} soft-reconfiguration inbound
no neighbor {<A.B.C.D> | <WORD>} soft-reconfiguration inbound

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer group
inbound specific inbound update

Command Default
No storage

Compass ID: 188656176 Version 5 MGBI 16-51


BSR 64000 Command Reference Guide Release 4.2.0

neighbor timers
The neighbor timers command sets the timers for a particular BGP peer or peer
group. The no neighbor timers command clears the timers for a particular BGP peer
or peer group.
Use the neighbor timers command to configure a specific neighbor or peer-group
timers values to bypass the timers configured for all BGP neighbors using the timers
bgp command.

Note: If, during the negotiated holdtime (which is the smallest of configured
hold time and the holdtime advertised by the neighbor), no messages arrive,
the peer will be brought down. If the negotiated holdtime is 0, then the peer
will never be brought down, because it hasn't received any messages. If the
value of the keepalive timer is 0, then no keepalive messages will be sent.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} timers {<0-21845>} [<0-65535>]
no neighbor {<A.B.C.D> | <WORD>} timers

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer group
0-21845 frequency of keepalive messages to peers in seconds
0-65535 amount of time passed when no keepalive message is
sent, in seconds

16-52 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

Command Default
keepalive = 60 seconds
hold time = 180 seconds

Compass ID: 188656176 Version 5 MGBI 16-53


BSR 64000 Command Reference Guide Release 4.2.0

neighbor update-source loopback


The neighbor update-source loopback command allows an internal BGP session to
use any loopback interface for the TCP session. The no neighbor update-source
loopback command blocks a BGP session from using a loopback interface for the
TCP session.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} update-source loopback <1-255>
no neighbor {<A.B.C.D> | <WORD>} update-source loopback <1-255>

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer group
loopback loopback interface
1-255 loopback interface number

Command Default
Best local address

16-54 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

neighbor weight
The neighbor weight command establishes a weight to a neighbor connection. The
no neighbor weight command removes a weight to a neighbor connection.

Note: Initially, all routes learned from this neighbor will have the assigned
weight. The route with the highest weight is chosen as the choice route when
multiple routes are available on the network.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


neighbor {<A.B.C.D> | <WORD>} weight <0-65535>
no neighbor {<A.B.C.D> | <WORD>} weight <0-65535>

Command Syntax

A.B.C.D neighbor IP address


WORD name of BGP peer group
0-65535 weight assignment

Command Default
learned routes = 0
routes sourced by local router = 32768

Compass ID: 188656176 Version 5 MGBI 16-55


BSR 64000 Command Reference Guide Release 4.2.0

network
The network command specifies the list of networks for the BGP routing process.
The no network command deletes the entry.
Use the network command to control what networks are originated. be included in
the BGP updates. Network types are learned from connected routes, dynamic routing,
and static route sources. Because BGP can handle subnetting and supernetting, the
mask is used. The maximum number of network commands is based on the
configured nvram or ram.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


network <A.B.C.D> [mask <A.B.C.D>]
no network <A.B.C.D> [mask <A.B.C.D>]

Command Syntax

A.B.C.D network that BGP will advertise


A.B.C.D network or subnetwork mask address

16-56 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

redistribute
The redistribute command redistributes routes from one protocol domain to another
routing domain. The no redistribute command disables route distribution from one
protocol domain to another routing domain.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


redistribute {connected | ospf [match {internal | external | external 1 | external
2}] | rip | static} [metric <0-4294967295>] [route-map <WORD>] [weight
<0-65535>]
no redistribute {connected | ospf [match {internal | external | external 1 |
external 2}] | rip | static} [metric <0-4294967295>] [route-map <WORD>]
[weight <0-65535>]

Command Syntax

connected established routes as result of IP enabled on


an interface

ospf OSPF source protocol


match the criteria by which OSPF routes are
redistributed into BGP
internal routes that are internal to an autonomous
system
external routes external to an autonomous system, but
are imported into OSPF as either Type 1 or
Type 2 external route
external 1 routes that are external to an autonomous
system, but are imported into OSPF as Type 1
external route

Compass ID: 188656176 Version 5 MGBI 16-57


BSR 64000 Command Reference Guide Release 4.2.0

external 2 routes that are external to an autonomous


system, but are imported into OSPF as Type 2
external route
rip RIP source protocol

static IP or BGP static routes


metric 0-4294967295 metric value used for the redistributed route.
route-map WORD the name of the route-map used to
conditionally control the route redistribution
weight 0-65535 set a network weight value when
redistributing into BGP

Command Default
Disabled

16-58 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

route-map
The route-map command creates or modifies route-maps and their sequences. The no
route-map command removes the corresponding sequence from the route-map.If
there are no sequences left in the route-map, the route-map will be deleted too.
Use the route-map command, and the match and set commands to configure the
rules for redistributing routes from one routing protocol to another. Each route-map
command has a list of match and set commands associated with it. The match
commands specify the match criteria, which are the conditions under which
redistribution is allowed for the current route-map command. The set commands
specify the set actions, the particular redistribution actions to perform if the criteria
enforced by the match commands are met. The no route-map command deletes the
route map.

Note: If the optional sequence number [<0-65535>] is omitted, the default


sequence number 10 is used. If the optional access value [permit | deny] is
omitted, the default value permit is used.

These two commands create a route-map with the <route-map-name> name,


if it does not exist, and the sequence specified by the sequence number and
access value, there is no such sequence. Otherwise, the access value of the
existing sequence is set to the new access value.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


route-map <WORD> [deny | permit] [<0-65535>]
route-map <WORD> [deny | permit] [<0-65535>]

Compass ID: 188656176 Version 5 MGBI 16-59


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

WORD route-map name


0-65535 route-map sequence number
deny denies access for matching conditions

permit permits access for matching conditions

16-60 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

router bgp
The router bgp command configures the BGP routing process. Use the no router
bgp command clears BGP routing process configuration.
Use the router bgp command to establish a distributed routing core that automatically
guarantees the loop-free exchange of routing information between autonomous
systems.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


router bgp <1-65535>
no router bgp <1-65535>

Command Syntax

1-65535 number of the autonomous system identifying


the router to other BGP routers

Compass ID: 188656176 Version 5 MGBI 16-61


BSR 64000 Command Reference Guide Release 4.2.0

set as-path prepend


The set as-path prepend command modifies AS system path attributes for the
matched BGP routes. The no set as-path prepend command ends modification of a
system path for BGP routes.
Use the set as-path prepend command to guide the path information to control the
BGP decision process.

Group Access
ISP

Command Mode
Route Map Configuration

Command Line Usage


set as-path prepend <1-65535> [<1-65535>]
no set as-path prepend <1-65535> [<1-65535>]

Command Syntax

1-65535 prepend string - you can specify a single


number or multiple numbers separated
by a space

16-62 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

set comm-list
The set comm-list command deletes communities from the community attribute of an
inbound or outbound update. The no set comm-list command deletes the entry.
Use the set comm-list command to delete communities from the community attribute
of inbound or outbound updates using a route map to filter and determine the
communities to be deleted.
If the standard list is referred in the set comm-list delete command, only the elements
with the single community number or no community number in them will be used. All
others will be quietly ignored. Any element specified with the 'internet' keyword is
equivalent to element without community number.
If the set community comm and set comm-list list-num delete commands are
configured in the same sequence of a route-map attribute, the deletion operation (set
comm-list list-num delete) is performed before the set operation (set community
comm).

Note: If the set community and set comm-list delete commands are
configured in the same sequence of a route-map attribute, the deletion
operation (set comm-list delete) is performed before the set operation (set
community).

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set comm-list {<1-99> | <100-199>} delete
no set comm-list {<1-99> | <100-199>} delete

Compass ID: 188656176 Version 5 MGBI 16-63


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

1-99 standard community list number


100-199 extended community list number
delete delete inbound or outbound communities from the
community attribute

16-64 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

set community
The set community command add or replace communities from the community
attribute of an inbound or outbound update. Use the no set community command
removes the specified communities from the set.
Use the route-map command, and the match and set commands to configure the rules
for redistributing routes from one routing protocol to another. Each route-map
command has a list of match and set commands associated with it. The match
commands specify the match criteria, which are the conditions under which
redistribution is allowed for the current route-map command. The set commands
specify the set actions, the particular redistribution actions to perform if the criteria
enforced by the match commands are met. The no route-map command deletes the
route map.

Note: The communities could be specified as numbers; the result will be the
same; none removes community attribute from the update unless additive is
specified for the set entry. In this case it doesn't modify update community
attributes.

In other words, the no set community command, if the entry had some
community numbers in it before removal, and as the result of the removal no
numbers are left, then the entry itself is deleted.

The command set community none removes all community numbers from
set entry, if any, but leaves the value of the additive attribute intact.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set community {<1-4294967295> | local-AS | no-advertise | no-export | additive |
none}
no set community {<1-4294967295> | local-AS | no-advertise | no-export |
additive | none}

Compass ID: 188656176 Version 5 MGBI 16-65


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

1-4294967295 community number


additive add to the existing community
local-AS do not advertise this route to peers outside of
the local autonomous system
no-advertise do not advertise this route to any peer
internal or external
no-export routes with this community are sent to
peers in other sub-autonomous systems
within a confederation
none no community attribute

16-66 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

set ip next-hop
The set ip next-hop command establishes a next-hop value for the AS path. The no ip
next-hop command deletes the entry.
Use the ip policy route-map interface configuration command, the route-map global
configuration command, and the match and set route-map configuration commands,
to define the conditions for policy routing packets. The ip policy route-map
command identifies a route map by name. Each route-map command has a list of
match and set commands associated with it. The match commands specify the match
criteria---the conditions under which policy routing occurs. The set commands
specify the set actions---the particular routing actions to perform if the criteria
enforced by the match commands are met.
If the interface associated with the first next hop specified with the set ip next-hop
command is down, the optionally specified IP addresses are tried in turn.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set ip next-hop <A.B.C.D>
no set ip next-hop

Command Syntax

A.B.C.D IP address of the next hop to which packets


are output; address of the adjacent router

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 16-67


BSR 64000 Command Reference Guide Release 4.2.0

set local-preference
The set-local preference command establishes a preference value for the AS system
path. Use the set local-preference command to send the local-preference to all
routers in the local autonomous system.
Use the no set-local preference form of this command to delete the entry.

Note: In the no set-local preference command, the optional


<0-4294967295> argument has no effect.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set local-preference <0-4294967295>
no set local-preference <0-4294967295>

Command Syntax

0-4294967295 local preference value

16-68 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

set metric-type
The set metric-type command sets the destination routing protocol. The no set
metric-type command returns the default.
Use the set metric-type command, and the match and set commands to configure the
rules for redistributing routes from one routing protocol to another. Each set
metric-type command has a list of match and set commands associated with it. The
match commands specify the match criteria, which are the conditions under which
redistribution is allowed for the current set metric-type command. The set commands
specify the set actions, the particular redistribution actions to perform if the criteria
enforced by the match commands are met. The no set metric-type command deletes
the route map.

Group Access
ISP

Command Mode
Route-map configuration

Command Line Usage


set metric-type {internal | external | type-1 | type-2}
no set metric-type {internal | external | type-1 | type-2}

Command Syntax

internal internal metric


external external metric

type-1 OSPF external type 1 metric


type-2 OSPF external type 2 metric

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 16-69


BSR 64000 Command Reference Guide Release 4.2.0

set origin
The set origin command configures the conditions for redistributing routes from any
protocol to any protocol. The no set origin command deletes the BGP origin code.
When the set origin command configures redistributing routes from any protocol to
any protocol, any match clause is necessary which includes pointing to a “permit
everything” to set tags.

Group Access
ISP

Command Mode
Route-Map Configuration

Command Line Usage


set origin {egp | igp | incomplete}
no set origin {egp | igp | incomplete}

Command Syntax

egp remote EGP


igp local IGP
incomplete unknown heritage

16-70 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

set tag
The set tag command sets the value of the destination routing protocol. The no set tag
command removes the value.
The route-map global configuration command and the match and set route-map
configuration commands are used together to define the conditions for redistributing
routes from one routing protocol into another. Each route-map command has a list of
match and set commands associated with it. The match commands specify the
conditions for redistribution for the current route-map command. The set commands
specify the particular redistribution actions to perform if the criteria enforced by the
match commands are met. The no route-map command deletes the route map.

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set tag <0-4294967295>
no set tag <0-4294967295>

Command Syntax

0-4294967295 tag value

Command Default
If not specified, tag is forwarded to the new destination protocol.

Compass ID: 188656176 Version 5 MGBI 16-71


BSR 64000 Command Reference Guide Release 4.2.0

set weight
The set-weight command to set the route weight on the network. The first
autonomous system match determines the weight to be set.
Use the set weight command to set the route weight on the network. The first AS
match determines the weight to be set. The route with the highest weight is chosen as
the choice route when multiple routes are available on the network. Weights spoken
when an as path is matched, override any weight set by the neighbor command. Any
match clause is necessary which includes pointing to a “permit everything” to set tags

Group Access
ISP

Command Mode
Route-map Configuration

Command Line Usage


set weight <0-65535>
no set weight

Command Syntax

0-65535 weight value

16-72 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip as-path-access-list
The show ip as-path-access-list command displays configured AS path access lists
and their elements.
Use the show ip as-path-access-list command to display configured as-path access
lists and their elements.
With the optional access list number argument, it displays the specified as-path access
list, if such list exists. Without it, it displays all configured as-path access lists.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip as-path-access-list [<1-199>]

Command Syntax

1-199 access list number

Compass ID: 188656176 Version 5 MGBI 16-73


BSR 64000 Command Reference Guide Release 4.2.0

show ip bgp
The show ip bgp command displays entries in the BGP routing table. Use the show ip
bgp command to determine whether the session is active or not.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp [<A.B.C.D>] [<A.B.C.D>] [longer-prefixes] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show ip bgp [<A.B.C.D>] [<A.B.C.D>] [longer-prefixes] [ | {count | count-only}]

Command Syntax

A.B.C.D network address in the BGP routing table to


display
A.B.C.D displays all BGP routes matching the network
address/network mask pair
longer-prefixes displays route and more specific routes
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

16-74 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 16-75


BSR 64000 Command Reference Guide Release 4.2.0

show ip bgp cidr-only


The show ip bgp cidr-only command displays routes without natural network masks,
or Classless Inter-domain Routing (CIDR) routes.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp cidr-only [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip bgp cidr-only [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the
specified string
exclude filter for output that excludes the
specified string
include filter for output that includes the
specified string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

16-76 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp community


The show ip bgp community command display routes that belong to specified BGP
communities.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp community [ <1-4294967295> | <LINE> | exact-match <LINE> |
expanded | local-AS | no-advertise | no-export ] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show ip bgp community [ <1-4294967295> | <LINE> | exact-match <LINE> |
extended | local-AS | no-advertise | no-export ] [ | {count | count-only}]

Command Syntax

1-4294967295 the community number


LINE an ordered list as a regular expression
exact-match display routes that have an exact match
expanded extended access list format
local-AS do not advertise this route to peers outside of
the local autonomous system
no-advertise do not advertise this route to any peer
internal or external
no-export routes with this community are sent to
peers in other sub-autonomous systems
within a confederation
| turns on output modifiers (filters)

Compass ID: 188656176 Version 5 MGBI 16-77


BSR 64000 Command Reference Guide Release 4.2.0

begin filter for output that begins with the specified


string
exclude filter for output that excludes the specified
string

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

16-78 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp community-list


The show ip bgp community-list command display routes that are permitted by the
BGP community list.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp community-list {<1-99> | <100-199>} [exact-match] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show ip bgp community-list {<1-99> | <100-199>} [exact-match] [ | {count |
count-only}]

Command Syntax

1-99 standard community list number


100-199 extended community list number
exact-match display routes that have an exact match
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string

count count the number of outputted lines


count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 16-79


BSR 64000 Command Reference Guide Release 4.2.0

show ip bgp dampened-paths


The show ip bgp dampened-paths command displays BGP dampened routes.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp dampened-paths [ | {begin | exclude | include} {<WORD>} [ | {count
| count-only}]]
show ip bgp dampened-paths [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

16-80 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp flap-statistics


The show ip bgp flap-statistics command displays BGP flap statistics.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp flap-statistics [<A.B.C.D>] [<A.B.C.D>] [longer-prefixes ] [filter-list
<1-199> ] [ regexp <LINE> ] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip bgp flap-statistics [<A.B.C.D>] [<A.B.C.D>] [longer-prefixes ] [filter-list
<1-199> ] [ regexp <LINE> ] [ | {count | count-only}]

Command Syntax

A.B.C.D network address in the BGP routing table to


display
A.B.C.D displays all BGP routes matching the network
address/network mask pair
longer-prefixes displays route and more specific routes
filter-list 1-199 number of an autonomous system path access
list
regexp LINE a regular-expression to match the BGP
autonomous system paths
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string

Compass ID: 188656176 Version 5 MGBI 16-81


BSR 64000 Command Reference Guide Release 4.2.0

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

16-82 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp ipv4 unicast


The show ip bgp ipv4 unicast command displays IPv4 address family unicast BGP
routing information.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp ipv4 unicast [<A.B.C.D>] [<A.B.C.D>]] [longer-prefixes]]] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show ip bgp ipv4 unicast [<A.B.C.D>] [<A.B.C.D>]] [longer-prefixes]]] {<LINE>}
[ | {count | count-only}]

show ip bgp ipv4 unicast cidr-only [ | {begin | exclude | include} {<WORD>} [ |


{count | count-only}]]
show ip bgp ipv4 unicast cidr-only [ | {count | count-only}]

show ip bgp ipv4 unicast community [ <1-4294967295> | <LINE> | exact-match


<LINE> | expanded | local-AS | no-advertise | no-export ] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show ip bgp ipv4 unicast community [ <1-4294967295> | <LINE> | exact-match
<LINE> | expanded | local-AS | no-advertise | no-export ] {<LINE>} [ | {count |
count-only}]

show ip bgp ipv4 unicast community-list {<1-99> | <100-199>} [exact-match] [ |


{begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show ip bgp ipv4 unicast community-list {<1-99> | <100-199>} [exact-match]
{<LINE>} [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 16-83


BSR 64000 Command Reference Guide Release 4.2.0

show ip bgp ipv4 unicast dampened-paths [ | {begin | exclude | include} show ip


bgp ipv4 unicast dampened-paths {<WORD>} [ | {count | count-only}]]
show ip bgp ipv4 unicast dampened-paths [ | {count | count-only}]

show ip bgp ipv4 unicast flap-statistics [<A.B.C.D>] [<A.B.C.D>]


[longer-prefixes] [filter-list <1-199> ] [ regexp <LINE> ] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show ip bgp ipv4 unicast flap-statistics [<A.B.C.D>] [<A.B.C.D>]
[longer-prefixes] [filter-list <1-199> ] [ regexp <LINE> ] {<LINE>} [ | {count |
count-only}]

show ip bgp ipv4 unicast paths [<LINE>] [ | {begin | exclude | include}


{<WORD>} [ | {count | count-only}]
show ip bgp ipv4 unicast paths [<LINE>] [ | {count | count-only}]

show ip bgp ipv4 unicast regexp {<LINE>} [ | {begin | exclude | include}


{<WORD>} [ | {count | count-only}]]
show ip bgp ipv4 unicast regexp{<LINE>} [ | {count | count-only}]

Command Syntax

A.B.C.D network address in the BGP routing table to


display
A.B.C.D displays all BGP routes matching the network
address/network mask pair
longer-prefixes displays route and more specific routes
cidr-only displays routes without natural network
masks, or Classless Inter-domain Routing
(CIDR) routes
community displays routes that belong to specified BGP
communities
1-4294967295 the community number

16-84 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

LINE an ordered list as a regular expression


exact-match display routes that have an exact match
expanded extended access list format
local-AS do not advertise this route to peers outside of
the local autonomous system
no-advertise do not advertise this route to any peer internal
or external
no-export routes with this community are sent to peers
in other sub-autonomous systems within a
confederation
community-list displays routes that are permitted by the BGP
community list.
1-99 standard community list number
100-199 extended community list number
dampened-paths displays BGP dampened routes
flap-statistics displays BGP flap statistics
filter-list 1-199 number of an autonomous system path access
list
regexp displays routes matching the regular
expression
LINE regular expression to match BGP autonomous
systems paths
paths displays all BGP paths in the database
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string

Compass ID: 188656176 Version 5 MGBI 16-85


BSR 64000 Command Reference Guide Release 4.2.0

include filter for output that includes the specified


string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

16-86 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp memory


The show ip bgp memory command displays BGP memory usage information. The
following is an example of typical screen output from the show ip bgp memory
command:

Mem Pool Size Free Used High Water Mark


------------------------------------------------------------------------------
Bgp Node 116036
Bgp 32B 32 1024 ( 32768) 0 ( 0) 0 ( 0)
Bgp 64B 64 1024 ( 65536) 0 ( 0) 0 ( 0)
Bgp 128B 128 4096 ( 524288) 0 ( 0) 0 ( 0)
Bgp 256B 256 16 ( 4096) 0 ( 0) 0 ( 0)
Bgp 512B 512 15 ( 7680) 1 ( 512) 1 ( 512)
Bgp 2048B 2048 512 ( 1048576) 0 ( 0) 0 ( 0)
Bgp 8192B 8192 128 ( 1048576) 0 ( 0) 0 ( 0)
BgpRte 40 16384 ( 655360) 0 ( 0) 0 ( 0)
BgpRt 76 16384 ( 1245184) 0 ( 0) 0 ( 0)
BgpExp 36 16384 ( 589824) 0 ( 0) 0 ( 0)
BgpCB 2284 256 ( 584704) 0 ( 0) 0 ( 0)
------------------------------------------------------------------------------
Total Free 5670K (5806592) + Used 113K (116548) = 5784K (5923140)

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp memory [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip bgp memory [ | {count | count-only}]

Compass ID: 188656176 Version 5 MGBI 16-87


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

16-88 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp neighbors


The show ip bgp neighbors command displays information about TCP and BGP
connections to neighbors.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp neighbors [<A.B.C.D> | global [<A.B.C.D>] | ipv4 [<A.B.C.D>] |
vpnv4 [<A.B.C.D>]] [advertised-routes | dampened-routes | received-routes |
routes] [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show ip bgp neighbors [<A.B.C.D> | global [<A.B.C.D>] | ipv4 [<A.B.C.D>] |
vpnv4 [<A.B.C.D>]] [advertised-routes | dampened-routes | received-routes |
routes] [ | {count | count-only}]

Command Syntax

A.B.C.D the IP address of a neighbor - if not specified,


all neighbors are displayed
global displays all neighbors for global BGP routing/
forwarding
ipv4 displays all neighbors active in the IPv4
address family
vpnv4 displays all neighbors active in the VPNv4
address family
advertised-routes displays all routes advertised to a BGP
neighbor
dampened-routes displays the dampened routes received from
BGP neighbor

received-routes displays all received routes (both accepted


and filtered) from a specific neighbor

Compass ID: 188656176 Version 5 MGBI 16-89


BSR 64000 Command Reference Guide Release 4.2.0

routes displays all routes that were received and


accepted for the specified neighbor
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

16-90 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp next-hops


The show ip bgp next-hops command displays BGP next-hop information.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp next-hops [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip bgp next-hops [ | {count | count-only}]

Command Syntax

| turns on output modifiers (filters)


begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 16-91


BSR 64000 Command Reference Guide Release 4.2.0

show ip bgp paths


The show ip bgp paths command displays all BGP paths in the database.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp paths [<LINE>] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ip bgp paths [<LINE>] [ | {count | count-only}]

Command Syntax

LINE regular expression to match BGP autonomous


systems paths
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

16-92 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp peer-group


The show ip bgp peer-group command displays information about BGP peer groups.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp peer-group [<WORD> | global [<WORD>] | ipv4 [<WORD>] | vpnv4
[<WORD>]] [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show ip bgp peer-group <WORD> | global [<WORD>] | ipv4 [<WORD>] | vpnv4
[<WORD>]] [ | {count | count-only}]

Command Syntax

WORD display information about a specific


peer-group; number of peers and groups
global displays all peer-groups for global BGP
routing/forwarding
ipv4 displays all peer-groups active in the IPv4
address family
vpnv4 displays all neighbors peer-groups in the
VPNv4 address family
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

Compass ID: 188656176 Version 5 MGBI 16-93


BSR 64000 Command Reference Guide Release 4.2.0

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

16-94 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

show ip bgp regexp


The show ip bgp regexp command displays routes matching the regular expression.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp regexp {<LINE>} [ | {begin | exclude | include} {<WORD>} [ | {count
| count-only}]]
show ip bgp regexp {<LINE>} [ | {count | count-only}]

Command Syntax

LINE regular expression to match the BGP


autonomous system paths
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 16-95


BSR 64000 Command Reference Guide Release 4.2.0

show ip bgp summary


The show ip bgp summary command displays the status of all BGP connections. The
following is an example of typical screen output from the show ip bgp summary
command:

BGP router identifier 150.31.108.1, local AS number 3

Message statistics:
Rcvd RcvdLast Sent SentLast
Open 0 0
Update 0 0
Notify 0 0
Keepalive 0 0
Route Refresh 0 0
Total 0 0

New since last show 2w3d ago: none

CONF/RCVD values: U IPv4 unicast, u IPv4 unicast (no capabilities)


V VPNv4, M IPv4 multicast, L MPLS

Neighbor AS CONF/RCVD MsgRcvd MsgSent TblVer Up/Down State/PfxUsed

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip bgp summary [ global | ipv4 | vpnv4] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show ip bgp summary [ global | ipv4 | vpnv4] [ | {count | count-only}]

16-96 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

Command Syntax

global displays all neighbors for global BGP routing/


forwarding
ipv4 displays all neighbors active in the IPv4
address family
vpnv4 displays all neighbors active in the VPNv4
address family
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 16-97


BSR 64000 Command Reference Guide Release 4.2.0

show ip community-list
The show ip community-list command displays a configured community access list
and the associated elements.
Use the show ip community access list command to display configured community
access lists and their elements.
With the optional access list number argument, it displays the specified community
access list, if such list exists. Without it, it displays, all configured community access
lists.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip community-list {<1-99> | <100-199>}

Command Syntax

1-99 standard community list number


100-199 extended community list number

16-98 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 BGP Commands

synchronization
The synchronization command enables IGP synchronization. The no
synchronization command disables IGP synchronization.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


synchronization
no synchronization

Compass ID: 188656176 Version 5 MGBI 16-99


BSR 64000 Command Reference Guide Release 4.2.0

timers bgp
The timers bgp command adjusts BGP network timers. The no timers bgp command
resets the BGP timing defaults values.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


timers bgp <0-21845> [<0-65535>]
no timers bgp <0-21845>

Command Syntax

0-21845 the frequency, in seconds, at which the


software sends keepalive messages to its peer
0-65535 the holdtime interval, in seconds, which, after
not receiving a keepalive message, that the
software declares a BGP peer dead - the
holdtime value is always three times the
keepalive value

Command Syntax
keepalive = 60 seconds
holdtime = 180 seconds

16-100 MGBI Compass ID: 188656176 Version 5


17
PIM Commands

Introduction
This chapter describes the Protocol-Independent Multicast (PIM) commands that are
supported on the BSR 64000. The BSR supports PIM in sparse mode.

PIM Command Descriptions


This section contains an alphabetized list and descriptions of the PIM commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 17-1


BSR 64000 Command Reference Guide Release 4.2.0

ip pim border
Use the ip pim border command to configure a PIM domain boundary on the
interface of a border router peering with one or more neighbors outside the PIM
domain.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim border
no ip pim border

17-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

ip pim bsr-candidate
Use the ip pim bsr-candidate command to configure the BSR to be a candidate
bootstrap router.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim bsr-candidate <0-32>
no ip pim bsr-candidate <0-32>

Command Syntax

0-32 specifies the hash mask length from 0 to 32 bits.

Command Default
30 bits

Compass ID: 188656176 Version 5 MGBI 17-3


BSR 64000 Command Reference Guide Release 4.2.0

ip pim bsr-candidate ip-address


Use the ip pim bsr-candidate ip-address command to use the IP address of a specific
interface on the candidate BSR.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim bsr-candidate ip-address <A.B.C.D> <0-32>
no ip pim bsr-candidate ip-address <A.B.C.D> <0-32>

Command Syntax

A.B.C.D the interface IP address


0-32 the hash mask length

Command Default
Hash mask length = 30 bits

17-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

ip pim dr-priority
The ip pim dr-priority command sets the priority for which a router is elected as
the designated router (DR). When a Designated Router (DR) is an election
candidate, the router with the highest priority is elected as the DR. The DR
priority is configured on the router’s interface. If a DR priority is assigned on
multiple router interfaces, then the router with the highest IP address is used as
the DR.
If a router does not advertise its priority in its hello messages, the router has the
highest priority and is elected as the DR. If multiple routers have this priority
status, then the router with the highest IP address configured on an interface is
elected to be the DR.
The no ip pim dr-priority command removes a router from the list of Designated
Routers.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim dr-priority <1-255>
no ip pim dr-priority <1-255>

Command Syntax

1-255 the priority of the router to be selected as the


DR

Command Default
The default DR priority for the BSR is 1, which means that the BSR is the DR.

Compass ID: 188656176 Version 5 MGBI 17-5


BSR 64000 Command Reference Guide Release 4.2.0

ip pim message-interval
Use the ip pim message-interval command to specify the PIM router join/prune
messages interval.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim message-interval <1-65535>
no ip pim message-interval

Command Syntax

1-65535 join/prune interval in seconds

Command Default
60 seconds

17-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

ip pim query-interval
The ip pim query-interval command adjusts how often PIM router query messages
are sent to other PIM routers to control the DR process. IP multicast routers send PIM
query "Hello" messages to determine which router is the Designated Router (DR) for
each LAN segment (subnetwork). The DR sends Internet Group Management
Protocol (IGMP) host query messages to all hosts on the directly connected LAN.
When PIM operates in sparse mode, the DR sends source registration messages to the
Rendezvous Point (RP). The no ip pim query-interval command disables PIM router
query messages.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim query-interval <0-65535>
no ip pim query-interval

Command Syntax

0-65535 the PIM query message interval in seconds

Command Default
30 seconds

Compass ID: 188656176 Version 5 MGBI 17-7


BSR 64000 Command Reference Guide Release 4.2.0

ip pim rp-candidate
Use the ip pim rp-candidate command to configure a single rendezvous pointer (RP)
candidate on the PIM domain.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim rp-candidate
no ip pim rp-candidate

17-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

ip pim rp-candidate group-list


Use the ip pim rp-candidate group-list command to configure one or more groups
that can become rendezvous point (RP) candidates on the PIM domain.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim rp-candidate group-list <1-99>
no ip pim rp-candidate group-list <1-99>

Command Syntax

1-99 the access list reference number for group prefixes

Compass ID: 188656176 Version 5 MGBI 17-9


BSR 64000 Command Reference Guide Release 4.2.0

ip pim rp-candidate interval


Use the ip pim rp-candidate interval command to change the interval with which a
candidate rendezvous point (RP) is selected.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim rp-candidate interval <1-200>
no ip pim rp-candidate interval <1-200>

Command Syntax

1-200 the candidate rendezvous point interval in seconds

Command Default
60 seconds

17-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

ip pim rp-candidate ip-address


Use the ip pim rp-candidate ip-address command to use the IP address of a specific
interface for the candidate RP (rendezvous point) that is associated with the BSR.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim rp-candidate ip-address <A.B.C.D>
no ip pim rp-candidate ip-address <A.B.C.D>

Command Syntax

A.B.C.D the IP address of the candidate rendezvous pointer

Compass ID: 188656176 Version 5 MGBI 17-11


BSR 64000 Command Reference Guide Release 4.2.0

ip pim rp-candidate priority


Use the ip pim rp-candidate priority command to specify the candidate rendezvous
pointer priority for the BSR on the PIM domain.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip pim rp-candidate priority <0-255>
no ip pim rp-candidate priority <0-255>

Command Syntax

0-255 the assigned priority of the candidate rendezvous pointer

Command Default
0

17-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

ip pim spt-threshold lasthop


The ip pim spt-threshold lasthop command configures when a PIM leaf router
should join the shortest path source tree. This is determined by specifying a network
traffic threshold at which the router switches to the shortest path source tree after the
last hop. The no ip pim spt-threshold lasthop command restores the default value or
changes the setting.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip pim spt-threshold lasthop {<0-4294967294> | infinity}
no ip pim spt-threshold lasthop [<0-4294967294> | infinity]

Command Syntax

0-4294967294 the traffic rate in kilobits per second


infinity never switch to the shortest path source tree -
indicates that the rendezvous point (RP) is
always used

Command Default
1024 kbps

Compass ID: 188656176 Version 5 MGBI 17-13


BSR 64000 Command Reference Guide Release 4.2.0

ip pim spt-threshold rp
Use the ip pim spt-threshold rp command to specify the multicast traffic threshold
that must be reached on the rendezvous point (RP) router before the multicast traffic is
switched over to the Shortest Path Tree (SPT).

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip pim spt-threshold rp {<0-4294967294> | infinity }
no ip pim spt-threshold rp

Command Syntax

0-4294967294 the multicast traffic rate in kilobits per second (kbps)


infinity indicates that the RP is always used

Command Default
0

17-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

network
The PIM version of the network command enables IP networks for the PIM routing
process. The no network command disables networks for the PIM routing process.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


network <A.B.C.D> <A.B.C.D>
no network <A.B.C.D> <A.B.C.D>

Command Syntax

A.B.C.D IP address of directly connected network


A.B.C.D PIM wild card bits

Compass ID: 188656176 Version 5 MGBI 17-15


BSR 64000 Command Reference Guide Release 4.2.0

pim accept-rp
The pim accept-rp command configures a router to accept only Join or Prune
messages destined for a specified rendezvous point (RP) and for a specific list of
groups. The no pim accept-rp command disables accepting only Join or Prune
messages so that all Join and Prune messages are processed.
The group address must be in the range specified by the access list. If no access list is
provided, the default is all class D group addresses. When the address is one of the
system's addresses, the system will be the RP only for the specified group range
specified by the access list. When the group address is not in the group range, the RP
will not accept Join or Register messages and will respond immediately to Register
messages with Register-Stop messages.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


pim accept-rp <A.B.C.D> [1-99]
no pim accept-rp <A.B.C.D> [1-99]

Command Syntax

A.B.C.D The rendezvous point address of the RP


allowed to send Join and Prune messages to
groups in the range specified by the group
access list.
1-99 The access list number that defines which
groups are subject to be checked for only Join
and Prune messages. If not specified, the
whole class D groups are subject to the check.

Command Default
Disabled

17-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

pim register-checksum
Use the pim register-checksum command to register a packet checksum type.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


pim register-checksum [ new | old ]

Command Syntax

new use only IP and PIM Control Headers


old use complete IP packet length

Command Default
Complete IP packet length

Compass ID: 188656176 Version 5 MGBI 17-17


BSR 64000 Command Reference Guide Release 4.2.0

pim rp-address
The pim rp-address command configures the address of a static PIM rendezvous
point (RP) for a particular group. The no pim rp-address command removes an RP
address for a particular group.

Note: You must configure the IP address of RPs on all routers (including the
RP router) if you use static RP.

First-hop routers send register packets to the RP address on behalf of source multicast
hosts. Routers also use this address on behalf of multicast hosts that want to become
members of a group. These routers send Join and Prune messages towards the RP. The
RP must be a PIM router but does not require any special configuration to recognize
that it is the RP. RPs are not members of the multicast group but serve as a "meeting
place" for multicast sources and group members. You can configure a single RP for
more than one group. The access list determines which groups the RP can be used for.
If no access list is configured, the RP is used for all groups. A PIM router can use
multiple RPs, but only one per group. Statically configured RP will take precedence
over RP learned though a dynamic mechanism such as the bootstrap mechanism.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


pim rp-address <A.B.C.D> [1-99]
no ip pim rp-address <A.B.C.D>

17-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

Command Syntax

A.B.C.D The IP address of the router to be a statically


configured PIM RP. This is a unicast IP
address in four-part, dotted notation.
1-99 The number of an access list that defines for
which multicast groups the RP should use.
This is a standard IP access list. If no number
is entered, then the default is the whole class
D group range.

Command Default
No PIM rendezvous points are preconfigured.

Compass ID: 188656176 Version 5 MGBI 17-19


BSR 64000 Command Reference Guide Release 4.2.0

pim unicast-route-lookup
The pim unicast-route-lookup command retrieves routes from the BSR’s unicast
routing table.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


pim unicast-route-lookup
no pim unicast-route-lookup

17-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

router pim
Use the router pim command to enter Router Configuration mode from Global
Configuration mode and enable PIM routing.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


router pim

Compass ID: 188656176 Version 5 MGBI 17-21


BSR 64000 Command Reference Guide Release 4.2.0

show ip pim
The show ip pim command displays various PIM routing information. Use the show
ip pim command to determine whether the session is active or not.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip pim bsr-router
show ip pim interface [cable <X/Y> | count | ethernet <X/Y> | gigaether <X/Y> |
loopback <1-64>]
show ip pim neighbor [<A.B.C.D> | cable <X/Y> | detail | ethernet <X/Y> |
gigaether <X/Y> | loopback <1-64>]
show ip pim rp [<A.B.C.D> | mapping]
show ip pim rp-hash <A.B.C.D>
show ip pim unresolved-groups

Command Syntax

bsr-router Bootstrap router (v2) information


interface PIM interface information
cable X/Y the slot and MAC Domain number of the
CMTS module:
• the 1:4 or 1:8 CMTS modules will have a
MAC Domain number of "0"
the 2:8 and 2:8 (2.0) CMTS modules will
have a MAC Domain number of "0" or "1"
count Internet multicast packet count
ethernet X/Y Ethernet interface

17-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PIM Commands

gigaether X/Y Gigabit Ethernet interface


loopback 1-64 Loopback interface
neighbor PIM neighbor information
A.B.C.D IP address of a specific neighbor
detail Shows all joins/prunes towards this neighbor

rp PIM Rendezvous Point (RP) information


A.B.C.D IP group address
mapping show group-to-RP mappings
rp-hash RP to be chosen based on group selected
information
unresolved-groups unresolved groups information
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 17-23


18
MPLS Commands

Introduction
Multiprotocol Label Switching (MPLS) provides a mechanism for engineering
network traffic patterns that is independent of routing tables. In a standard routed
network (without MPLS), as a packet travels from a source to a destination, an
independent forwarding decision must be made at each router along the path. As a
packet travels through the network, each router analyzes the packet and determines
the “next hop router” that the packet must be sent to in order for the packet to arrive at
its final destination.
With MPLS, a packet only has to be analyzed once it enters the network. As the
packet is received at the first router in the network, the router assigns a short “label” to
the packet. When the packet is forwarded to the next router, the label is included in the
packet. At subsequent routers, there is no further analysis of the packet’s layer 3
address. Instead, the label is used to instruct the router how to forward the packet.
An MPLS network consists of Label Edge Routers (LERs) and Label Switch Routers
(LSRs).
■ The LER is responsible for classifying each packet based on some
user-configurable policy (source, destination, port, QoS class, etc.), and assigning
a label to the packet.

Compass ID: 188656176 Version 5 MGBI 18-1


BSR 64000 Command Reference Guide Release 4.2.0

■ The LSRs are responsible for forwarding the packet along the correct Label
Switched Path (LSP) based upon the label. LSPs are configured from end-to-end
across the network. In order for a packet to properly travel across the network, all
routers in the path must be aware of the label for each packet and which LSP to
send the packet on. LSPs are configured statically at each router along the path or
dynamically using the Resource Reservation Protocol (RSVP).
MPLS supports a variety routing protocols by creating end-to-end links across a
network that serve as “tunnels” for all packets that need to travel to the same
destination.

18-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

About RSVP
Resource Reservation Protocol (RSVP) data transfer occurs between a router that
serves as the link’s entrance point and another router that serves as the link’s exit
point. RSVP is used in conjunction with MPLS to distribute MPLS labels.
RSVP is a resource reservation setup protocol that is used by both network hosts and
routers. Hosts use RSVP to request a specific quality of service (QoS) from the
network for particular application flows. Routers use RSVP to deliver QoS requests to
all routers along the data path. RSVP also can maintain and refresh states for a
requested QoS application flow.
RSVP is not a routing protocol, but rather is designed to inter-operate with current and
future unicast and multicast routing protocols. The routing protocols are responsible
for choosing the routes to use to forward packets, and RSVP consults local routing
tables to obtain routes. RSVP is responsible only for ensuring the QoS of packets
traveling along a data path.

MPLS Command Descriptions


This chapter contains an alphabetized list and descriptions of the MPLS commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 18-3


BSR 64000 Command Reference Guide Release 4.2.0

clear ip rsvp statistics


The clear ip rsvp statistics command clears RSVP statistics for all interfaces or
selected interfaces with RSVP enabled.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear ip rsvp statistics [ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>]

Command Syntax

rsvp statistics clear RSVP statistics for all or selected


interfaces
ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot
and port number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on
the BSR

pos X/Y the Packet over SONET slot and port number
on the BSR

18-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

clear mpls traffic


The clear mpls traffic command clears MPLS protocol statistics for the entire
system.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear mpls traffic

Compass ID: 188656176 Version 5 MGBI 18-5


BSR 64000 Command Reference Guide Release 4.2.0

debug mpls forwarding


The debug mpls forwarding command enables debugging for MPLS forwarding.
The no debug mpls forwarding disables debugging for MPLS forwarding.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug mpls forwarding
no debug mpls forwarding

18-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

debug mpls rsvp


The debug mpls rsvp command enables various debugging functions for MPLS
RSVP protocol messages. The no debug mpls rsvp command disables debugging for
MPLS RSVP protocol messages.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug mpls rsvp {all | path | resv | ptear | rtear | error}
no debug mpls rsvp {all | path | resv | ptear | rtear | error}

Command Syntax

all debug all MPLS RSVP protocol messages


path debug MPLS RSVP protocol Path messages -
each sender transmits Path messages
downstream along the routes provided by the
unicast and multicast routing protocols
resv debug MPLS RSVP protocol Resv messages -
each receiver sends reservation request
(Resv) messages upstream toward senders
and sender applications and follow the
reverse route of Path messages
ptear debug MPLS RSVP protocol PathTear
messages - PathTear messages remove path
states and dependent reservation states in any
routers along a path and follow the same route
as Path messages.

Compass ID: 188656176 Version 5 MGBI 18-7


BSR 64000 Command Reference Guide Release 4.2.0

rtear debug MPLS RSVP protocol ResvTear


messages - ResvTear messages remove
reservation states along a path and travel
upstream toward senders of the session
error debug MPLS RSVP protocol PathErr and
ResvErr error messages

18-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

ip rsvp
The ip rsvp command is used to enable the RSVP protocol on an interface. The no ip
rsvp command is used to disable the RSVP protocol on an interface.
The ip rsvp command can also be used to enable message aggregation and to specify
the interval in seconds between the transmission of RSVP bundle messages, hello
packets, message acknowledgements, and refresh messages.

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


ip rsvp {aggregate | bundle-time <1-30> | hello-interval <0-65535> | hello-misses
<4-10> | msgack-time <1-65535> | refresh-time <1-65535> | summary-refresh}

no ip rsvp {aggregate | bundle-time <1-30> | hello-interval <0-65535> |


hello-misses <4-10> | msgack-time <1-65535> | refresh-time <1-65535> |
summary-refresh}

Command Syntax

aggregate enable message aggregation which allows the


bundling of multiple RSVP messages in a
single RSVP transmission
bundle-time 1-30 specify the maximum interval in seconds
between the generation of bundle messages
hello-interval 0-65535 specify the value in seconds as to how often
this MPLS link generates hello packets
hello-misses 4-10 the number of sequential Hello
acknowledgments that a node can miss before
the LSP can be removed

Compass ID: 188656176 Version 5 MGBI 18-9


BSR 64000 Command Reference Guide Release 4.2.0

msgack-time 1-65535 specify the maximum interval in seconds


between the acknowledgement of bundle
messages
refresh-time 1-65535 specify the interval in seconds between the
successive generation of refresh messages
summary-refresh RSVP summary refresh

Command Default
bundle time = 10 seconds
hello-misses = 4
msgack-time = 2 seconds
refresh-time = 30 seconds

Note: Setting the hello-interval to "0" disables the transmission of hello


packets.

18-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

mpls create-lsp rsvp


The mpls create-lsp rsvp command creates a dynamic MPLS LSP using RSVP.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


mpls create-lsp rsvp <string> <A.B.C.D> [<A.B.C.D>]
no mpls create-lsp rsvp <string>

Command Syntax

string the LSP name


A.B.C.D the destination IP address
A.B.C.D the source IP address

Compass ID: 188656176 Version 5 MGBI 18-11


BSR 64000 Command Reference Guide Release 4.2.0

mpls create-lsp rsvp explicit-route identifier


The mpls create-lsp rsvp explicit-route identifier command is used to create one or
more named paths on an ingress router. The no mpls create-lsp rsvp explicit-route
identifier command removes a named path.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


mpls create-lsp rsvp explicit-route identifier <string> [hops [<1-20>]]
no mpls create-lsp rsvp explicit-route identifier <string>

Command Syntax

identifier string the name of the LSP


hops 1-20 the number of hops - if not specified, the
default number of hops is 10

18-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

mpls create-lsp rsvp next-hop


The mpls create-lsp rsvp next-hop command is used to specific one or more
intermediate router addresses and whether the route from the previous hop router is a
direct path.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


mpls create-lsp rsvp <string> next-hop <A.B.C.D> { Loose | Strict } [ Last-Hop ]

Command Syntax

string the name of the LSP


A.B.C.D the IP address of the next hop router
Loose specifies that the route taken from the
previous router to this router does not need to
be a direct path, can include other routers, and
can be received on any interface
Strict species that the route taken from the previous
router to this router is a direct path and does
not include any other routers - the IP address
of the next hop router should be directly
connected and should be one of the interface
addresses in the LSP path
Last-Hop the keyword that signifies the last hop in the
LSP configuration

Compass ID: 188656176 Version 5 MGBI 18-13


BSR 64000 Command Reference Guide Release 4.2.0

mpls create-lsp static


The mpls create-lsp static command is used to create an MPLS LSP static route that
uses push-label, pop-label, or swap-label operations. The no mpls create-lsp static
command deletes an existing static LSP.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


mpls create-lsp static <lsp-path-name> {ip-to-mpls-push <16-1048575>
<A.B.C.D> | mpls-to-mpls-push <16-1048575> <16-1048575> <A.B.C.D> |
pop-label <16-1048575> | swap-label <16-1048575> <16-1048575> <A.B.C.D>
[queue <0-3>]}

no mpls create-lsp static <lsp-path-name>

Command Syntax

lsp-path-name the LSP name


ip-to-mpls-push perform ip-to-mpls push label operation -
push label adds a new label to the packet
16-1048575 MPLS label to be the push on the packet
A.B.C.D the IP address of the next hop router
mpls-to-mpls-push perform mpls-to-mpls push label operation -
push label adds a new label to the packet
16-1048575 MPLS label to match the packet
16-1048575 MPLS label to be the push on the packet
A.B.C.D the IP address of the next hop router

18-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

pop-label create an MPLS LSP static route that uses


pop-label operation - pop-label removes the
label from the beginning of the packet
16-1048575 MPLS label to be the pop on the packet

swap-label create an MPLS LSP static route that uses


swap-label operation - swap-label replaces
the label at the top of the label stack with a
new label

16-1048575 MPLS label to be the swap out from the


packet
16-1048575 MPLS label to be the swap in to the packet
A.B.C.D the IP address of the next hop router
queue 0-3 QoS queue identifier

Compass ID: 188656176 Version 5 MGBI 18-15


BSR 64000 Command Reference Guide Release 4.2.0

mpls ip
The mpls ip command enables dynamic MPLS forwarding for IP on the interface.
The mpls ip propagate-ttl command causes a traceroute command to show all the
hops traversed by the MPLS packet in the network. The no mpls ip propagate-ttl
command causes a traceroute command to ignore all hops traversed by the MPLS
packet in the network.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


mpls ip [ propagate-ttl ]
no mpls ip [ propagate-ttl ]

Command Syntax

propagate-ttl propagate IP TTL into the label stack

Command Default
time-to-live = 64 hops

18-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

mpls label range


The mpls label range command allows you to specify an MPLS minimum and
maximum label range for static or dynamic LSPs.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


mpls label range {dynamic-lsp | static-lsp}{<16-1048575> <16-1048575>}
no mpls label range {dynamic-lsp | static-lsp}

Command Syntax

dynamic-lsp specify a label range for a dynamic LSP


static-lsp specify a label range for a static LSP
16-1048575 the minimum label value
16-1048575 the maximum label value

Note: A dynamic-lsp range can not overlap a static-lsp range.

Compass ID: 188656176 Version 5 MGBI 18-17


BSR 64000 Command Reference Guide Release 4.2.0

mpls mtu
The mpls mtu command allows you to specify the MPLS maximum transmission unit
for an interface.

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


mpls mtu <64-65536>
no mpls mtu

Command Syntax

64-65536 the maximum transmission size in bytes

18-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

mpls rsvp restart-lsp


The mpls rsvp restart-lsp command restarts an MPLS LSP specified by name. If no
name is specified, the command restarts all configures LSPs specified in the
running-configuration file.

Group Access
All

Command Mode
Privileged EXEC, Global Configuration, and Interface Configuration (Ethernet,
Gigabit Ethernet, and POS interfaces only)

Command Line Usage


mpls rsvp restart-lsp [<string>]

Command Syntax

string the LSP name

Compass ID: 188656176 Version 5 MGBI 18-19


BSR 64000 Command Reference Guide Release 4.2.0

mpls ttl
The mpls ttl command allows change the default time-to-live value used in the mpls
ip propagate-ttl command. The no mpls ttl command restores the default value in
the mpls ip propagate-ttl command.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


mpls ttl <1-255>
no mpls ttl

Command Syntax

1-255 the time-to-live value

18-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

show ip rsvp explicit-routed-lsps


The show ip rsvp explicit-routed-lsps command displays all LSPs created with the
mpls create-lsp rsvp explicit-route identifier command.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip rsvp explicit-routed-lsps

Compass ID: 188656176 Version 5 MGBI 18-21


BSR 64000 Command Reference Guide Release 4.2.0

show ip rsvp interface


The show ip rsvp interface command displays the following running system
interface information for the RSVP routing process:

Interface interface type, slot, and port number on the


BSR 64000
State the state of the interface - either "Up" or
"Down"
Neighbor Count the number of routers connected to this
interface
Query Interval the specified Hello Interval, in seconds, for
this interface

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip rsvp interface [ ethernet <X/Y> | gigaether <X/Y> | pos <X/Y> ]

Command Syntax

ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot


and port number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on
the BSR
pos X/Y the Packet over SONET slot and port number
on the BSR

18-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

show ip rsvp lsp


The show ip rsvp lsp command displays LSP setup information.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show mpls rsvp lsp [ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>]

Command Syntax

ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot


and port number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on
the BSR
pos X/Y the Packet over SONET slot and port number
on the BSR

Compass ID: 188656176 Version 5 MGBI 18-23


BSR 64000 Command Reference Guide Release 4.2.0

show ip rsvp neighbor


The show ip rsvp neighbor command displays the following running system
information for current RSVP neighbors:

Neighbor Address IP address of the RSVP neighbor


Interface the interface on which Hello packets are sent
to this neighbor
Reduction Capable refresh reduction creation - enabled or
disabled
Uptime the total time, in seconds, that the neighbor
has been up
Expires the times, in seconds, that if a Hello packet is
not received, this neighbor entry is deleted
Reduction Type Summary Ref, Aggregate, or both

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip rsvp neighbor [ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>]

Command Syntax

ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot


and port number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on
the BSR
pos X/Y the Packet over SONET slot and port number
on the BSR

18-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

show ip rsvp reservation


The show ip rsvp reservation command displays the following running system
RSVP-related receiver information:

Senders the IP address of the sender


Dest the IP address of the receiver of this LSP
Tun-Id the tunnel interface number or address to
which packets with this label are going
NHOP IP address of the next hop
Style the reservation style
LSP Id the LSP ID used for sender identification

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip rsvp reservation [ ethernet <X/Y> | gigaether <X/Y> | pos <X/Y> ]

Command Syntax

ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot


and port number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on
the BSR
pos X/Y the Packet over SONET slot and port number
on the BSR

Compass ID: 188656176 Version 5 MGBI 18-25


BSR 64000 Command Reference Guide Release 4.2.0

show ip rsvp sender


The show ip rsvp sender command displays the following running system
RSVP-related sender information:

Source Addr the IP address of the sender


LSP the number of LSPs
Dest Addr the IP address to which the LSP is created
Phop the IP address of the previous hop
Tun_Id the tunnel interface number or address to
which packets with this label are going
LSP_Name the user-defined name assigned to the LSP
Intf the interface on which this LSP is created

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip rsvp sender [ ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>]

Command Syntax

ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot


and port number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on
the BSR
pos X/Y the Packet over SONET slot and port number
on the BSR

18-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

show ip rsvp statistics


The show ip rsvp statistics command displays running system statistical information
for the MPLS RSVP routing process.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip rsvp statistics [ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>]

Command Syntax

ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot


and port number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on
the BSR
pos X/Y the Packet over SONET slot and port number
on the BSR

Compass ID: 188656176 Version 5 MGBI 18-27


BSR 64000 Command Reference Guide Release 4.2.0

show mpls filters


The show mpls filters command displays the MPLS filter table including the flow
classification type (mpls-to-mpls-push, etc.) and the number of filters. The following
information is provided:

Dest Ip Address the destination IP address


Src Ip Address the source address in the packet
Pro the protocol
SP the source port - either TCP or UDP
DP the destination port
DS Diff-serv Code Point (differentiated services)
In If the incoming (Ingress) interface
FT the flow classification type:

PU = IP to MPLS Label Push


PS = IP to MPLS Push Stacked
IG = Ignore CAM use LME
Lbl1 label 1
Lbl2 label 2
Out If the outgoing interface
Exp0 the available experimental field class of
service
Exp1 the standard experimental class of service
Mac the MAC address
Mtu the change in the outgoing MTU
QId Oueue ID used for POS

18-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show mpls filters [ hitCount <NUM> | summary | vrf {<word>}] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show mpls filters [ hitCount <NUM> | summary | vrf {<word>}] [ | {count |
count-only }]

Command Syntax

hitCount NUM the access list hit count and optional BSR
chassis slot number
summary summary of all MPLS Fast Path filters
vrf word select a VPN Routing/Forwarding instance
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

Compass ID: 188656176 Version 5 MGBI 18-29


BSR 64000 Command Reference Guide Release 4.2.0

show mpls forwarding-table


The show mpls forwarding-table command displays the LSP forwarding table
including the route label type and network. The following is an example of typical
screen output from the show mpls forwarding-table command:

PU = MPLS Label Push, SW = MPLS Label Switch, PO = MPLS Label Pop,


LS = MPLS Label To SRM

VRF IN Label OUT Lbl1 OUT Lbl2 Phys If RT Next Hop Ip MAC Address QId HitCnt
------ -------- -------- -------- ------- -- --------------- -------------- --- ------

1034 -- -- - - PO -- -- - 0
1035 -- -- - - PO -- -- - 0
1036 -- -- - - PO -- -- - 2834493
1037 -- -- - - PO -- -- - 0
1044 -- -- - - PO -- -- - 0
1045 -- -- - - PO -- -- - 0
1046 -- -- - - PO -- -- - 6514681
1047 -- -- - - PO -- -- - 0

The following information is provided:

Label IN the label assigned by this router


Label OUT the label assigned by next hop
Mtu the maximum transmission unit (MTU) of
labeled packet
Phys If the interface through which packets with this
label are sent

18-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

RT the forwarding flow classification type:

PU = MPLS Label Push


SW = MPLS Label Switch
PO = MPLS Label Pop
IP = MPLS Label to IP
LS = MPLS Label To SRM
Next Hop Ip the IP address of the neighbor that assigned
the outgoing label
MAC Address the MAC address (not valid for POS)
QId the QoS queue ID

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show mpls forwarding-table [ hitCount <NUM> | summary | vrf {<word>}] [ |
{begin | exclude | include} {<WORD>} | {count | count-only}]
show mpls forwarding-table [ hitCount <NUM> | summary | vrf {<word>}] [ |
{count | count-only}]

Command Syntax

hitCount NUM the access list hit count and optional BSR
chassis slot number
summary summary of all MPLS Fast Path filters

vrf word select a VPN Routing/Forwarding instance


| turns on output modifiers (filters)

Compass ID: 188656176 Version 5 MGBI 18-31


BSR 64000 Command Reference Guide Release 4.2.0

begin filter for output that begins with the specified


string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

18-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

show mpls label range


The show mpls label range command displays the specified minimum and maximum
label range for both static and dynamic LSPs, as follows:

Static LSP Min/Max the minimum and maximum label range for
label: X/Y static LSPs
Dynamic LSP Min/Max the minimum and maximum label range for
label: X/Y dynamic LSPs

The following is an example of typical screen output from the show mpls label range
command:

Local label pool:


Static LSP Min/Max label: 16/1023, Dynamic LSP Min/Max label: 1024/1048575

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show mpls label range

Compass ID: 188656176 Version 5 MGBI 18-33


BSR 64000 Command Reference Guide Release 4.2.0

show mpls lsp


The show mpls lsp command displays all configured LSPs on this BSR, as well as all
the number of Ingress, Transit, and Egress routers that are part of an LSP.
The show mpls lsp detail command displays the following information:

Incoming label the label assigned by this router


Outgoing label the label assigned by next hop
Prefix or TunnelId the address or tunnel to which packets with
this label are going
Incoming interface the interface through which packets with this
label are received
Outgoing interface the interface through which packets with this
label are sent
Next Hop the IP address of neighbor that assigned the
outgoing label
Status the status of the LSP - either up or down
proto the protocol with which the LSP was setup -
either RSVP or Static
lspName the name of the LSP
initiator the source address of the LSP
destination the destination address of the LSP
label stack all of the outgoing labels and associated label
operations (PUSH/SWAP/POP)

18-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

The show mpls lsp summary command displays the following information:
STATIC : summary of static LSPs
INGRESS : the number of Ingress routers that are part of
this static LSP that are either up or down
TRANSIT : the number of Transit routers that are part of
this static LSP that are either up or down
EGRESS : the number of Engress routers that are part of
this static LSP that are either up or down
Total : the total number of static LSPs with status
either up or down
RSVP : summary of dynamic LSPs set up via RSVP
INGRESS : the number of Ingress routers that are part of
this LSP that are either up or down
TRANSIT : the number of Transit routers that are part of
this LSP that are either up or down
EGRESS : the number of Engress routers that are part of
this LSP that are either up or down
Total : the total number of dynamic LSPs set up via
RSVP with status either up or down
Total LSPs : the total number of static and dynamic LSPs

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 188656176 Version 5 MGBI 18-35


BSR 64000 Command Reference Guide Release 4.2.0

Command Line Usage


show mpls lsp [detail | labels <16-1048575> <16-1048575> [detail] | lsp-tunnel
<0-65536> [detail] | network <A.B.C.D> <A.B.C.D> [detail] | next-hop <A.B.C.D>
[detail] | summary ]] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show mpls lsp [detail | labels <16-1048575> <16-1048575> [detail] | lsp-tunnel
<0-65536> [detail] | network <A.B.C.D> <A.B.C.D> [detail] | next-hop <A.B.C.D>
[detail] | summary ]] [ | {count | count-only}]

Command Syntax

detail display detailed information

labels match label values


16-1048575 low label value
16-1048575 high label value
lsp-tunnel 0-65536 match specific LSP tunnel identifier
network A.B.C.D A.B.C.D destination IP address and network mask
next-hop A.B.C.D IP address of next hop
summary display a summary of all LSPs
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string
WORD the specified string
count count the number of outputted lines

count-only count the number of lines while suppressing


screen output

18-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

show mpls lsp interface


The show mpls lsp command displays all configured LSPs on this BSR, as well as all
the number of Ingress, Transit, and Egress routers that are part of an LSP that are
associated with a specific interface.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show mpls lsp interface {ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>} [detail] [
| {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show mpls lsp interface {ethernet <X/Y> | gigaether <X/Y> | pos <X/Y>} [detail] [
| {count | count-only}]

Command Syntax

ethernet X/Y the Ethernet/Fast Ethernet IEEE 802.3 slot


and port number on the BSR
gigaether X/Y the Gigabit Ethernet slot and port number on
the BSR
pos X/Y the Packet over SONET slot and port number
on the BSR
detail display detailed information
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string
exclude filter for output that excludes the specified
string
include filter for output that includes the specified
string

Compass ID: 188656176 Version 5 MGBI 18-37


BSR 64000 Command Reference Guide Release 4.2.0

WORD the specified string


count count the number of outputted lines
count-only count the number of lines while suppressing
screen output

18-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

show mpls rsvp refresh-time


The show mpls rsvp refresh-time command displays the global refresh time.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show mpls rsvp refresh-time

Compass ID: 188656176 Version 5 MGBI 18-39


BSR 64000 Command Reference Guide Release 4.2.0

show mpls traffic


The show mpls traffic command displays the following MPLS network traffic
information:

total the total number of MPLS packets that have been


received
header errors counted when a MPLS packet is discarded because of
error in the packet header
bad hop count counted when a MPLS packet is discarded because its
time-to-live (TTL) field was decremented to zero
runt counted when a MPLS packet length is too small to
hold a single label
unreachable counted when a MPLS packet is discarded because its
nextHop is unreachable.
no lsp counted when there is no LSP established to forward
the incoming MPLS packet
other error counted when a MPLS packet is discarded without
processing, such as when MPLS forwarding is not
enabled on this router or for some other reason

forwarded the total number of MPLS packets that have been sent
drop the total number of MPLS packets that have been
dropped

18-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 MPLS Commands

The following is an example of typical screen output from the show mpls traffic
command:

MPLS statistics:
Rcvd: 1112 total, 0 header errors
0 bad hop count, 0 runt, 0 unreachable
0 no lsp, 3 other error
Sent: 1109 forwarded
Drop: 3 drop

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show mpls traffic

Compass ID: 188656176 Version 5 MGBI 18-41


19
Service Class Commands

Introduction
Service levels provide a means of defining service flows with specific QoS
parameters (such as maximum, minimum, or reserved traffic rates, priority, and
service scheduling types) and binding them to a named service class. The concept of
maximum assigned bandwidth, in the context of a service class, provides a means for
controlling the amount of bandwidth that a particular service class can use on an
interface. This allows a user to configure levels of service to support applications with
specific bandwidth and priority requirements such as voice, video, and data and to
further permit users to provide differentiated levels of service.
Admission control is an authorization mechanism that provides a method of
controlling the admission of service flows belonging to specific service classes on
individual interfaces. Admission control is determined by the bandwidth percentage
(maximum assigned bandwidth) and the amount of over-booking (configured active
percent) allowed for a service class on an interface.
The creation of service classes involves assigning service flows to a service class and
providing all flows belonging to that class with a defined Quality of Service. DOCSIS
1.1 has defined a set of QoS parameters, a means for associating specific QoS
parameter values to a service flow, and assigning service flows their QoS parameters
by referencing a service class name. A set of pre-defined, default service classes are
provided with the BSR 64000 and a user has the capability of modifying these default
service class parameters.

Compass ID: 188656176 Version 5 MGBI 19-1


BSR 64000 Command Reference Guide Release 4.2.0

Entering Service Class Configuration Mode


Service Class Configuration mode provides access to the service class commands
described in this section. To enter Service Class Configuration mode, do the
following:
1. From Global Configuration mode, enter cable service-class and press the
<Enter> key:
MOT(config)# cable service-class <Enter>
The command line prompt changes to:
MOT(config-srvclass)#
To return to Global Configuration mode:
2. Enter the end or exit press the <Enter> key:
MOT(config-srvclass)# end/exit <Enter>

Service Class Command Descriptions


This section contains an alphabetized list and descriptions of the service class
commands supported by the BSR.

19-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

activity-timeout
The activity-timeout command specifies the timeout for active QoS parameters
which is the maximum duration that resources may remain unused on an active
service flow. The no activity-timeout command restores the default value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


activity-timeout <WORD> <0-65535>
no activity-timeout <WORD> <0-65535>

Command Syntax

WORD the user-defined service class name created


with the name command
0-65535 the activity timeout value in seconds

Command Default
0

Compass ID: 188656176 Version 5 MGBI 19-3


BSR 64000 Command Reference Guide Release 4.2.0

admission-timeout
The admission-timeout command specifies the timeout for admitted QoS parameters
which is the duration that the CMTS must hold resources for a service flow's admitted
QoS parameter set while they are in excess of its active QoS parameter set. The no
admission-timeout command a restores the default value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


admission-timeout <WORD> <0-65535>
no admission-timeout <WORD> <0-65535>

Command Syntax

WORD the user-defined service class name created


with the name command
0-65535 the admission timeout value in seconds

Command Default
200

19-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

admitted-bw-threshold
The admitted-bw-threshold command specifies the amount of admitted bandwidth,
in percentage, for a service class on an interface. If this bandwidth threshold is
exceeded, an event will be generated. The no admitted-bw-threshold command
restores the default value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


admitted-bw-threshold <WORD> <0-100>
no admitted-bw-threshold <WORD> <0-100>

Command Syntax

WORD the user-defined service class name created


with the name command
0-100 the percentage of admitted bandwidth

Command Default
0

Compass ID: 188656176 Version 5 MGBI 19-5


BSR 64000 Command Reference Guide Release 4.2.0

allow-share
The allow-share command provides the ability to share bandwidth between different
service level classes. Enabling bandwidth sharing, allows the bandwidth of a service
level class to be used as a bandwidth “pool” that can be shared by multiple service
level classes.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


allow-share <WORD> <0-1>
no allow-share <WORD> <0-1>

Command Syntax

WORD the name of the service class


0 disables bandwidth sharing
1 enables bandwidth sharing

Command Default
Disabled for every service class.

19-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

cable service-class
The cable service-class command enters Service Class Configuration mode from
Global Configuration mode. To return to Global Configuration mode, use the end
command.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable service-class

Compass ID: 188656176 Version 5 MGBI 19-7


BSR 64000 Command Reference Guide Release 4.2.0

cap
The cap command specifies the configured active percent (CAP) parameter for a
service flow. This parameter controls overbooking for a service class. The no cap
command restores the default value.
The configured active percent of a service class is an estimation of what fraction,
expressed as a percentage, of service flows belonging to that service class that will be
simultaneously active on an interface.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


cap <WORD> <0-100>
no cap <WORD> <0-100>

Command Syntax

WORD the user-defined service class name created


with the name command
0-100 the configured active percentage value

Command Defaults

Upstream Services Classes Downstream Service Classses


DefBEUp = 0 DefBEDown = 0
DefRRUp = 0 DefRRDown = 0
DefUGS = 100 DefEMDown = 100
DefUGSAD = 80 DefMCDown = 100
DefRTPS = 5
DefNRTPS = 5
DefEMUp = 100

19-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

clear cable srvclass-stats


The clear cable srvclass-stats command clears service class statistics on the BSR.
These are the same service class statistics displayed with the show cable srvclass-stats
command.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


clear cable srvclass-stats [<X/Y> <NUM> [DOWN | UP | <WORD>]]

Command Syntax

X/Y the BSR 64000 slot number and MAC


Domain
NUM the port number on the specified MAC
Domain
DOWN clear downstream service class statistics

UP clear upstream service class statistics


WORD the user-defined service class name created
with the name command

Compass ID: 188656176 Version 5 MGBI 19-9


BSR 64000 Command Reference Guide Release 4.2.0

enforce-cmts-qos
The enforce-cmts-qos command enforces all service level parameters for all cable
modems belonging to a service class regardless of the parameters specified in the
cable modem’s configuration file. When MAB, CAP, and the maximum or minimum
reserve rates are configured for a given service class, these parameters are overriden
by a cable modem’s configuration file if the cable modem was configured after the
service class was set up.
The enforce-cmts-qos command overrides the cable modem’s configuration file QoS
settings with the CMTS’s service class configuration. The no enforce-cmts-qos
command disables the cable modem’s configuraion file override.

Note: The enforce-cmts-qos command will not override service flow TLV
settings in cable modem configuration files for dynamically created service
flows.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


enforce-cmts-qos <WORD>
no enforce-cmts-qos <WORD>

Command Syntax

WORD the name of the service class

Command Default
Disabled

19-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

grant-interval
The grant-interval command specifies the nominal time between grants. The no
grant-interval command restores the default value.

Note: Specifying a grant interval is only relevant for service flows using
Unsolicited Grant Service (UGS ) or Unsolicited Grant Service with Activity
Detection (UGS-AD) scheduling.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


grant-interval <WORD> <0-4294967295>
no grant-interval <WORD> <0-4294967295>

Command Syntax

WORD the user-defined service class name created


with the name command
0-4294967295 the grant interval in microseconds

Command Default
UGS = 10000
UGS-AD = 10000

Compass ID: 188656176 Version 5 MGBI 19-11


BSR 64000 Command Reference Guide Release 4.2.0

grant-jitter
The grant-jitter command specifies the tolerated grant jitter which is the maximum
amount of time that the transmission opportunities may be delayed from the nominal
periodic schedule for this service flow. The no grant-jitter command restores the
default value.

Note: Specifying a tolerated grant jitter is only relevant for service flows using
Unsolicited Grant Service (UGS ) or Unsolicited Grant Service with Activity
Detection (UGS-AD) scheduling.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


grant-jitter <WORD> <0-4294967295>
no grant-jitter <WORD> <0-4294967295>

Command Syntax

WORD the user-defined service class name created


with the name command
0-4294967295 the tolerated grant jitter in microseconds

Command Default
UGS = 2000
UGS-AD = 2000

19-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

grant-size
The grant-size command specifies the unsolicited grant size. Grant size includes the
entire MAC frame data PDU from the Frame Control byte to end of the MAC frame.
The no grant-size command restores the default value.

Note: Specifying an unsolicited grant size is only relevant for service flows
using Unsolicited Grant Service (UGS ) or Unsolicited Grant Service with
Activity Detection (UGS-AD) scheduling.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


grant-size <WORD> <0-65535>
no grant-size <WORD> <0-65535>

Command Syntax

WORD the user-defined service class name created


with the name command
0-65535 the unsolicited grant size in bytes

Command Default
UGS = 152
UGS-AD = 152

Compass ID: 188656176 Version 5 MGBI 19-13


BSR 64000 Command Reference Guide Release 4.2.0

grants-per-interval
The grants-per-interval command specifies the number of data grants per grant
interval. The no grants-per-interval command restores the default value.

Note: Specifying the number of data grants per grant interval is only relevant
for service flows using Unsolicited Grant Service (UGS )or Unsolicited Grant
Service with Activity Detection (UGS-AD) scheduling:

• for UGS, the value of this parameter indicates the actual number of data
grants per Nominal Grant Interval
• for UGS-AD, the value of this parameter indicates the maximum number
of Active Grants per Nominal Grant Interval

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


grants-per-interval <WORD> <0-127>
no grants-per-interval <WORD> <0-127>

Command Syntax

WORD the user-defined service class name created


with the name command
0-127 the number of grants

Command Default
1

19-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

mab
The mab command specifies the Maximum Assigned Bandwidth (MAB) which is the
amount of bandwidth a service class is permitted to use on an interface. It is expressed
as a percentage of the total interface bandwidth capacity. The MAB of a service class
is applied during admission control to determine whether to admit a new service flow
and again by the packet schedulers to provide a class-based weighting to the
scheduler. The no mab command restores the default value.

Note: For scheduling purposes, each service class gets its bandwidth based
on its MAB fraction relative to other classes, not based on the absolute value
of the MAB. For example, if there are only two active service classes and
both have the same MAB, each service class would get 50% of the
bandwidth. The absolute value of the MAB is only used for admission control
not scheduling.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


mab <WORD> <1-100>
no mab <WORD> <1-100>

Command Syntax

WORD the user-defined service class name created


with the name command
1-100 the percentage of bandwidth a service class is
permitted to use on an interface

Compass ID: 188656176 Version 5 MGBI 19-15


BSR 64000 Command Reference Guide Release 4.2.0

Command Defaults

Upstream Services Classes Downstream Service Classses


DefBEUp = 10 DefBEDown = 10
DefRRUp = 10 DefRRDown = 10
DefUGS = 25 DefEMDown = 1
DefUGSAD = 5 DefMCDown = 1
DefRTPS = 5
DefNRTPS = 5
DefEMUp = 1

19-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

max-burst
The max-burst command specifies the maximum traffic burst size for flows
belonging to a specific service class. The no max-burst command restores the default
value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


max-burst <WORD> <1522-4294967295>
no max-burst <WORD> <1522-4294967295>

Command Syntax

WORD the user-defined service class name created


with the name command
1522-4294967295 the token bucket size in bytes for this service
flow - the minimum value is the larger of
1522 bytes or the value of Maximum
Concatenated Burst size

Command Defaults
BE-DOWN = 3044
BE-UP = 3044
RTPS = 3044
NRTPS = 3044

Compass ID: 188656176 Version 5 MGBI 19-17


BSR 64000 Command Reference Guide Release 4.2.0

max-concat-burst
The max-concat-burst command specifies the maximum concatenated burst in bytes
which a service flow is allowed. The maximum concatenated burst is calculated from
the FC byte of the Concatenation MAC Header to the last CRC in the concatenated
MAC frame. The no max-concat-burst command restores the default value.

Note: Specifying a maximum concatenated burst is only relevant for


upstream service flows.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


max-concat-burst <WORD> <0-65535>
no max-concat-burst <WORD> <0-65535>

Command Syntax

WORD the user-defined service class name created


with the name command
0-65535 the maximum concatenated burst in bytes - a
value of "0" means there is no limit

Command Default
All upstream non-UGS service classes = 1522

19-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

max-latency
The max-latency command specifies the maximum allowable time for sending a
packet from a CMTS network interface to an RF interface starting at the point the
packet is received on the network interface. The no max-latency command restores
the default value.

Note: Specifying a maximum latency value is only relevant for downstream


service flows.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


max-latency <WORD> <0-4294967295>
no max-latency <WORD> <0-4294967295>

Command Syntax

WORD the user-defined service class name created


with the name command
0-4294967295 the latency value in microseconds

Command Default
0

Compass ID: 188656176 Version 5 MGBI 19-19


BSR 64000 Command Reference Guide Release 4.2.0

max-rate
The max-rate command specifies the maximum data rate the CM must adhere to and
the CMTS must enforce. The no max-rate command restores the default value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


max-rate <WORD> <0-4294967295>
no max-rate <WORD> <0-4294967295>

Command Syntax

WORD the user-defined service class name created


with the name command
0-4294967295 the maximum data rate value in bits per
second

Command Default
0

19-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

min-pkt-size
The min-pkt-size command specifies the minimum packet size in bytes reserved for a
service flow. The minimum reserved rate (min-rate) must be set in conjunction with
the minimum packet size for this service flow. The no min-pkt-size command
restores the default value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


min-pkt-size <WORD> <64-1522>
no min-pkt-size <WORD> <64-1522>

Command Syntax

WORD the user-defined service class name created


with the name command
64-1522 the minimum packet size in bytes

Command Default
128

Compass ID: 188656176 Version 5 MGBI 19-21


BSR 64000 Command Reference Guide Release 4.2.0

min-rate
The min-rate command specifies the minimum reserved traffic rate reserved for this
service flow. The minimum packet size (min-pkt-size) must be set in conjunction
with the minimum reserved traffic rate for this service flow.The no min-rate
command restores the default value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


min-rate <WORD> <0-4294967295>
no min-rate <WORD> <0-4294967295>

Command Syntax

WORD the user-defined service class name created


with the name command
0-4294967295 the minimum reserved traffic rate in
bits-per-second

Command Default
0

19-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

name
The name command creates a service class record with a user-specified name that is
entered on the command line. The no name command deletes this service class
record. Commands for specifying configuration parameters will use the service class
name as the key word for distinguishing which service class record is being
configured.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


name <WORD> [schedtype [be-down | be-up | non-rtps | rtps | ugs | ugs-ad]]
no name <WORD>

Command Syntax

WORD the user-defined service class name, 1-15


characters in length
schedtype specifies which upstream scheduling service
is used for upstream transmission requests
and packet transmissions
be-down best effort service on the downstream port
be-up best effort service on the upstream port
non-rtps non-real-time polling
rtps real-time polling
ugs unsolicited grant service
ugs-ad unsolicited grant service with activity
detection

Compass ID: 188656176 Version 5 MGBI 19-23


BSR 64000 Command Reference Guide Release 4.2.0

over-max-rate
The over-max-rate command allows the maximum sustained rate to be increased for
voice calls. This command is only functional for downstream voice flows.

Note: A setting of 100% (the default) will have the effect of disabling rate
limting for voice calls.

Group Access

All

Command Mode

Service-Class Configuration

Command Line Usage

over-max-rate <0-100>

Command Syntax

<0-100> the amount of increase, specified as a percent


of the configured max rate

Command Default

100%

19-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

poll-interval
The poll-interval command specifies the nominal polling interval between successive
unicast request opportunities for this service flow on the upstream channel. The no
poll-interval command restores the default value.

Note: Specifying a nominal polling interval is only relevant for service flows
using Unsolicited Grant Service with Activity Detection (UGS-AD), Real-Time
Polling Service (RTPS), or Non-Real-Time Polling Service (NRTPS)
scheduling.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


poll-interval <WORD> <0-4294967295>
no poll-interval <WORD> <0-4294967295>

Command Syntax

WORD the user-defined service class name created


with the name command
0-4294967295 the nominal polling interval in microseconds

Command Default
UGS-AD = 10000
RTPS = 50000
NRTPS = 50000

Compass ID: 188656176 Version 5 MGBI 19-25


BSR 64000 Command Reference Guide Release 4.2.0

poll-jitter
The poll-jitter command specifies the maximum amount of time that the unicast
request interval may be delayed from the nominal periodic schedule for this service
flow. The no poll-jitter command restores the default value.

Note: Specifying a poll jitter value is only relevant for service flows using
Unsolicited Grant Service with Activity Detection (UGS-AD) or Real-Time
Polling Service (RTPS) scheduling.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


poll-jitter <WORD> <0-4294967295>
no poll-jitter <WORD> <0-4294967295>

Command Syntax

WORD the user-defined service class name created


with the name command
0-4294967295 maximum amount of delay in microseconds

Command Default
UGS-AD = 5000
RTPS = 25000

19-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

req-trans-policy
The req-trans-policy command specifies:
■ which IUC opportunities the CM uses for upstream transmission requests and
packet transmissions for this service flow
■ whether requests for this Service Flow may be piggybacked with data
■ whether data packets transmitted on this service flow can be concatenated,
fragmented, or have their payload headers suppressed
For UGS, it also specifies how to treat packets that do not fit into the UGS grant. The
no req-trans-policy command restores the default value.

Note: Specifying a req-trans-policy value is only relevant for upstream


service flows.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


req-trans-policy <WORD> <0x0-0x7fff>
no req-trans-policy <WORD> <0x0-0x7fff>

Command Syntax

WORD the user-defined service class name created


with the name command
0x0-0x7fff the Request/Transmission Policy bit mask

Compass ID: 188656176 Version 5 MGBI 19-27


BSR 64000 Command Reference Guide Release 4.2.0

Command Default
BE-UP = 0
UGS = 0x7f
UGS-AD = 0x7f
RTPS = 0x1f
NRTPS = 0

19-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

restricted admission disabled


The restricted admission disabled command disables the admission of service flows
in the admission restricted state. The admission restricted state is when a service flow
is admitted when there is insufficient resources to meet its reserved rate and,
subsequently, the flow only receives best effort service. The no restricted admission
disabled command enables the admission of service flows in the admission restricted
state.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


restricted admission disabled
no restricted admission disabled

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 19-29


BSR 64000 Command Reference Guide Release 4.2.0

schedpriority
The schedpriority command assigns a scheduling priority for a service class. The no
schedpriority command a restores the default value.
Each service class must be assigned a scheduling priority to determine the order in
which service flows are serviced for transmitting packets (downstream) and
generating data grants (upstream). Schedule priority is separate from the traffic
priority parameter which is specified to differentiate priority for service flows with
identical QoS parameter sets.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


schedpriority <WORD> <1-32>
no schedpriority <WORD> <1-32>

Command Syntax

WORD the user-defined service class name created


with the name command
1-32 the scheduling priority value

Command Default
1

19-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

show cable service-class


The show cable service-class command displays a configuration summary for all
service classes, including all default service classes, that are active on the BSR.The
complete configuration of an individual service class can also be displayed. The
following default service classes are supported:
DefBEDown downstream service class, no minimum rate
DefRRDown downstream service class, non-zero minimum rate
DefBEUp upstream best-effort service class, no minimum rate
DefRRUp upstream best-effort service class, non-zero minimum rate
DefUGS upstream unsolicited grant service class
DefUGSAD upstream unsolicited grant service with activity detection
service class
DefRTPS upstream real-time polling service class
DefNRTPS upstream non-real-time polling service class
DefEMUp upstream emergency call service class
DefEMDown downstream emergency call service class
DefMCDown downstream mulitcast service class

The following is an example of typical screen output from the show cable
service-class command:

Compass ID: 188656176 Version 5 MGBI 19-31


BSR 64000 Command Reference Guide Release 4.2.0

Upstream Service Classes

Service Class mab cap priority allowShared enforce-cmts-qos


--------------------------------------------------------------------------------
DefBEUp 10 0 1 no no
DefRRUp 10 0 1 no no
DefUGS 25 100 1 no no
DefUGSAD 5 80 1 no no
DefRTPS 5 5 1 no no
DefNRTPS 5 5 1 no no
DefEMUp 1 100 1 no no

Total assigned bandwidth (mab sum): 61%

Downstream Service Classes

Service Class mab cap priority allowShared enforce-cmts-qos


--------------------------------------------------------------------------------
DefBEDown 10 0 1 no no
DefRRDown 10 0 1 no no
DefEMDown 1 100 1 no no
DefMCDown 1 100 1 no no

Total assigned bandwidth (mab sum): 22%

The following is an example of typical screen output for an individual service class
from the show cable service-class <WORD> command:

19-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

service class name: DefBEUp


direction: upstream
schedule type: best effort
maximum assigned bandwidth: 10
configured active percent: 0
scheduling priority: 1
admitted bw threshold: 0
traffic priority: 0
maximum sustained rate: 0
maximum traffic burst: 3044
minimum reserved rate: 0
assumed minimum rate packet size: 128
maximum concatenated burst: 1522
active QoS parameter timeout: 0
admitted QoS parameter timeout: 200
tos overwrite AND mask: 0xff
tos overwrite OR mask: 0x0
request/transmission policy: 0x0
allow sharing: no
enforce cmts qos: no

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable service-class [<WORD>]

Command Syntax

WORD displays the complete configuration of a


user-defined service class created with the
name command or one of the default service
classes

Compass ID: 188656176 Version 5 MGBI 19-33


BSR 64000 Command Reference Guide Release 4.2.0

show cable srvclass-stats


The show cable srvclass-stats command displays service class statistics for a
specified service class on a specified interface. The following is an example of typical
screen output from the show cable srvclass-stats command:

Qos service class name: DefBEUp


Direction: upstream
Interface slot/port: 4/7
Total packets: 0
total bytes: 0
Admitted flow count: 0
Peak admitted flows count: 0
Average admitted flow count: 0
Peak average admitted flow count: 0
Admission deferred flow count: 0
Admission restricted flow count: 0
Admission rejected flow count: 0
Admitted Bandwidth: 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable srvclass-stats {<X/Y>} {<NUM>} {<WORD>}

Command Syntax

X/Y the BSR 64000 slot number and MAC


Domain
NUM the port number on the specified MAC
Domain
WORD the user-defined service class name created
with the name command

19-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Service Class Commands

tos-overwrite
The tos-overwrite command provides an "AND" and "OR" mask which the CMTS
must use to overwrite the "type of service" field on all upstream IP packets on a
service flow. If this parameter is omitted, then the TOS field will not be modified by
the CMTS. The no tos-overwrite command restores the default value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


tos-overwrite <WORD> <0x0-0xff> <0x0-0xff>
no tos-overwrite <WORD> <0x0-0xff> <0x0-0xff>

Command Syntax

WORD the user-defined service class name created


with the name command
0x0-0xff TOS AND mask
0x0-0xff TOS OR mask

Command Default

TOS AND mask TOS OR mask

BE-UP = 0xff BE-UP = 0


UGS = 0xff UGS = 0
UGS-AD = 0xff UGS-AD = 0
RTPS = 0xff RTPS = 0
NRTPS = 0xff NRTPS = 0

Compass ID: 188656176 Version 5 MGBI 19-35


BSR 64000 Command Reference Guide Release 4.2.0

trafpriority
The trafpriority command specifies the relative priority of service flows that have
identical QoS parameters. The no trafpriority command restores the default value.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


trafpriority <WORD> <0-7>
no trafpriority <WORD> <0-7>

Command Syntax

WORD the user-defined service class name created


with the name command
0-7 the service flow priority value

Command Default
0

19-36 MGBI Compass ID: 188656176 Version 5


20
Secure Shell Server
Commands

Introduction
Secure Shell server (SSH) is a program that allows remote hosts to login to the BSR
over a non-secure network and execute commands in a secure manner. SSH
provides strong authentication and secure communications over non-secure
networks such as the public Internet.
The SSH protocol uses TCP as the transport layer. An SSH server listens for
connections from SSH clients on a well-known TCP port. An SSH client is
launched from a remote host and connects to the SSH server. The SSH server and
SSH client then handle key exchange, encryption, authentication, command
execution, and data exchange.

Secure Shell Server Command Descriptions


This chapter contains an alphabetized list and descriptions of the SSH commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 20-1


BSR 64000 Command Reference Guide Release 4.2.0

password ssh-passphrase
The password ssh-passphrase command establishes a password that must be
specified by users attempting to establish an SSH session with the BSR. An SSH
session will not be established if the correct password is not specified by the user. The
no password ssh-passphrase command removes the password.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


password ssh-passphrase [0 | 7] <WORD>
no password ssh-passphrase

Command Syntax

0 specifies an UNENCRYPTED
password
7 specifies a HIDDEN password
WORD the password (31 character
maximum, 78 character maximum
for option 7) - enclosed with double
quotes if the key contains spaces).
The "%" and "!" characters must not
be used.

20-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

show ssh config


The show ssh config command displays the following configuration information for
an SSH session.

SSH2 Secure Shell the SSH version number


sshTaskId the task identifier for this SSH session
debugMode "0" indicates that SSH debugging is turned
off - "1" indicates that SSH debugging is
turned on
quiet_mode "1" indicates that SSH debugging is turned
off - "0" indicates that SSH debugging is
turned on
idle_timeout the inactivity timeout value (in seconds) for
SSH sessions to time out a specified with the
ssh timeout command
portStr the defined TCP port number for SSH to
listen for incoming connections as specified
with the ssh port command
max_connections the maximum number of allowed,
simultaneous SSH sessions specified with
the ssh session-limit command
password_guesses the number of authentication attempts that
will be allowed for an SSH client attempting a
connection as specified with the ssh
password-guesses command
macs the message authentication (data integrity)
algorithm used for SSH sessions as
specified with the ssh
message-authentication command
ciphers the cipher for the encryption of SSH session
data as specified with the ssh ciphers
command

Compass ID: 188656176 Version 5 MGBI 20-3


BSR 64000 Command Reference Guide Release 4.2.0

subsystemString the type of SSH server


Private HostKey file the private hostkey authentication filename
Public HostKey file the public hostkey authentication filename

The following is an example of typical screen output from the show ssh config
command:

SSH2 Secure Shell 3.0.4


sshTaskId = 0x0
sshTaskFatalError = 0x0
debugMode = 0
quiet_mode = 1
idle_timeout = 300
portStr = 22
max_connections = 8
password_guesses = 3
macs = any
ciphers = any
subsystemString = subsystem-sftp sftp-server
authenticationString = AllowedAuthentications publickey,password
Private HostKey file = NVRAM:hostkey
Public HostKey file = NVRAM:hostkey.pub
Zlib compression level = 0
accessGroup = 0

Total SSH resources used=0, pty's


tied-up=0

Note: To display modifications to the default SSH configuration, use the


following command:

show running-config | include ssh

20-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ssh config

Compass ID: 188656176 Version 5 MGBI 20-5


BSR 64000 Command Reference Guide Release 4.2.0

show ssh hostkey-fingerprint


The show ssh hostkey-fingerprint command displays the fingerprint of a public key.

Note: The SSH server must be disabled to execute this command.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ssh hostkey-fingerprint {nvram: <filename> | flash: <filename>}

Command Syntax

nvram: filename display fingerprint of public hostkey file


stored in NVRAM

flash: filename display fingerprint of public hostkey file


stored in Flash

20-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

show users ssh


The show users ssh command displays information about active SSH sessions
including SSH resource use and active calls.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show users ssh

Compass ID: 188656176 Version 5 MGBI 20-7


BSR 64000 Command Reference Guide Release 4.2.0

ssh ciphers
The ssh ciphers command configures a cipher for the encryption of SSH session data.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ssh ciphers [3des-cbc | aes128-cbc | aes192-cbc | aes256-cbc | any | arcfour |
blowfish-cbc | cast128-cbc | none | twofish-cbc | twofish192-cbc | twofish256-cbc]
no ssh ciphers

Command Syntax

3des-cbc three-key triple DES in cbc mode, with


168-bit keys
aes128-cbc Advanced Encryption standard (AES) with
128-bit keys
aes192-cbc Advanced Encryption standard (AES) with
192-bit keys
aes256-cbc Advanced Encryption standard (AES) with
256-bit keys
any attempt all possible Ciphers, none excluded
arcfour stream cipher with 128-bit keys
blowfish-cbc Blowfish in CBC mode, with 128-bit keys
cast128-cbc CAST cipher in cbc mode
none no encryption
twofish-cbc alias for twofish128-cbc

20-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

twofish192-cbc Twofish in cbc mode with 192-bit keys


twofish256-cbc Twofish in cbc mode with 256-bit keys

Compass ID: 188656176 Version 5 MGBI 20-9


BSR 64000 Command Reference Guide Release 4.2.0

ssh enable
The ssh enable command enables an SSH process. The no ssh enable command
disables the SSH process. If SSH is disabled, all existing SSH sessions will be
terminated.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ssh enable
no ssh enable

20-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

ssh-keygen2
The ssh-keygen2 tool generates authentication key files for the BSR Secure Shell
Server. Host keys are required for the SSH Server and can either be generated in the
BSR 64000 or generated on another BSR and copied over.

Note: The SSH Server must be disabled on the BSR 64000 before running
the ssh-keygen2 tool.

Caution: The BSR 64000 Secure Shell Server only accepts host key files
generated with the ssh-keygen2 tool. Keys files generated using the
OpenSSH ssh-keygen tool will not work with the BSR 64000 Secure Shell
Server.

The ssh-keygen2 tool resolves interoperability problems associated with


OpenSSH. A key file must be generated using the ssh-keygen2 tool for the
BSR 64000 Secure Shell Server to interoperate properly with OpenSSH
Secure Shell clients.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


ssh-keygen2 [bits <512-1024> | hostkeyfile {flash: <filename> | nvram:
<filename>} | passphrase <WORD> | type {dsa | rsa}]

Command Syntax

bits 512-1024 specify the key strength in bits


hostkeyfile flash: create private hostkey file name stored in
filename Flash

Compass ID: 188656176 Version 5 MGBI 20-11


BSR 64000 Command Reference Guide Release 4.2.0

hostkeyfile nvram: create private hostkey file name stored in


filename NVRAM
passphrase WORD set a password (31 character maximum,) for
SSH connections - the "%" and "!" characters
must not be used
type dsa Digital Signature Algorithm key type
type rsa Rivest-Shamir-Adleman public-key
algorithm key type

Command Default
bits = 1024
hostkeyfile = nvram: hostkey
type = dsa

20-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

ssh load-host-key-files
The ssh load-host-key-files command specifies a new private or public hostkey
authentication file. The default hostkey authentication file names are “hostkey and
hostkey.pub”. These two files must exist and must be valid key files. Use the
UNIX ssh-keygen2 tool to generate a new hostkey authentication file.

Note: If the hostkey authentication files are invalid, SSH will not run.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ssh load-host-key-files {flash: | nvram:} {<filename>}
no ssh load-host-key-files

Command Syntax

flash: specifies Flash memory as the location of the


SSH hostkey authentication file
nvram: specifies Non-volatile Random Access
Memory (NVRAM) as the location of the
hostkey authentication file
filename filename of the hostkey authentication file
stored in Flash or NVRAM

Command Default
hostkey = hostkey.pub

Compass ID: 188656176 Version 5 MGBI 20-13


BSR 64000 Command Reference Guide Release 4.2.0

ssh logout session-id


The ssh logout session-id command will terminate an SSH session in progress. This
command can be used when a user wants to reconnect using new configuration
parameters.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


ssh logout session-id <0-7>

Command Syntax

0-7 the session-id number - the session-id is the


number displayed with the show users ssh
ssh command

20-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

ssh message-authentication
The ssh message-authentication command specifies the message authentication
(data integrity) algorithm used for SSH sessions.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ssh message-authentication [any | hmac-md5 | hmac-md5-96 | hmac-sha1 |
hmac-sha1-96 | none]
no ssh message-authentication

Command Syntax

any attempt all possible MAC algorithms except


"none"
hmac-md5 digest length = key length = 20
hmac-md5-96 first 96 bits of HMAC-MD5 (digest
length=12, key length=16)
hmac-sha1 digest length = key length = 20
hmac-sha1-96 first 96 bits of HMAC-SHA1 (digest
length=12, key length=20)
none no message authentication

Command Default
any

Compass ID: 188656176 Version 5 MGBI 20-15


BSR 64000 Command Reference Guide Release 4.2.0

ssh password-authentication radius


The ssh password-authentication radius command enables RADIUS services to be
used for password authentication. The no ssh password-authentication radius
command disables this feature.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


ssh password-authentication radius [ local-password ]
no ssh password-authentication radius [ local-password ]

Command Syntax

local-password authenticate with a locally configured


password if there is no response from the
RADIUS server

20-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

ssh password-guesses
The ssh password-guesses command specifies how many authentication attempts
(login and password exchange) will be allowed for an SSH client attempting a
connection.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ssh password-guesses <1-5>
no ssh password-guesses

Command Syntax

1-5 password guess attempt number

Command Default
3

Compass ID: 188656176 Version 5 MGBI 20-17


BSR 64000 Command Reference Guide Release 4.2.0

ssh port
The ssh port command configures SSH to listen for incoming connections on a
defined TCP port number.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ssh port <1-65535>
no ssh port

Command Syntax

1-65535 port number

Command Default
22

20-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Secure Shell Server Commands

ssh session-limit
The ssh session-limit command specifies the maximum number of simultaneous
SSH sessions that the BSR accepts.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ssh session-limit <0-8>
no ssh session-limit

Command Syntax

0-8 number of simultaneous SSH sessions

Command Default
8

Compass ID: 188656176 Version 5 MGBI 20-19


BSR 64000 Command Reference Guide Release 4.2.0

ssh timeout
The ssh timeout command specifies an inactivity timeout value for SSH sessions to
time out. Specifying a value of "0" will disable time-out for SSH sessions.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ssh timeout <0-60>

Command Syntax

0-60 the timeout value in minutes

Command Default
5 minutes

20-20 MGBI Compass ID: 188656176 Version 5


21
PacketCable Commands

Overview
The BSR fully supports the Cablelabs® PacketCable™ 1.x and PacketCable
Multimedia (PCMM) specifications. PacketCable Multimedia, building on the VoIP
capabilities of PacketCable 1.x, provides an IP-based platform for delivering
Quality-of-Service (QoS)-enhanced multimedia services over DOCSIS 1.1 and 2.0
HFC networks. Using PacketCable Multimedia, cable operators can offer subscribers,
in addition to the VoIP telephony services available through PacketCable 1.x,
additional services that include interactive gaming, streaming media, video telephony,
and video conferencing.

Command Descriptions
This chapter contains an alphabetized list and descriptions of PacketCable and
PacketCable Multimedia commands used with the BSR.

Compass ID: 188656176 Version 5 MGBI 21-1


BSR 64000 Command Reference Guide Release 4.2.0

cable dynamic-service authorization-mode


The cable dynamic-service authorization-mode command allows the cable
interface to accept dynamic service. The no cable dynamic-service command rejects
dynamic service on the cable interface.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable dynamic-service authorization-mode {auth_no_ecn02064 | authorize |
disable | unauthorize}

Command Syntax

auth_no_ecn02064 authorize Dynamic Service based on DQoS


gates without PacketCable ECN 2064 support
authorize authorize CM initiated Dynamic Service
based on DQoS gates, which only accepts
DOCSIS DSX MAC management message
types (DSA-REQ, DSC-REQ, DSD-REQ)
from the CM that is authorized through
DQoS. This argument is required when DQoS
is enabled.
disable reject all Dynamic Service
unauthorize accept all Dynamic Service

Note: ECN 2064 (dqos-n-02064) places additional requirements on the


authorization of dynamic service requests by an MTA. Set this value if the
MTAs connected to the cable interface do not support this ECN.

21-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 21-3


BSR 64000 Command Reference Guide Release 4.2.0

cable dynamic-service active-timeout


CMs dynamically allocate resources such as service identifiers (SIDs) and bandwidth
by using a Dynamic Service Addition (DSA) transaction. If the CM fails to issue a
Dynamic Service Deletion Request (DSD-REQ) to the cable interface or the
DSD-REQ is being dropped for any reasons (e.g. due to noise), these resources could
be held by the cable interface indefinitely. For this reason, an active timeout interval
could be configured on the cable interface so that the cable interface can remove the
dynamic service flows by issuing the DSD-REQs to the CM when the timer expires.
The cable dynamic-service active-timeout command specifies an active timeout for
dynamic service flows. The active timeout is the time since the dynamic service was
used. As long as the dynamic service continues to receive at least one packet within
this interval, the service is not deleted.

Group Access
All

Command Mode
Interface Configuration (cable interface)

Command Line Usage


cable dynamic-service active-timeout <0-65535>

Command Syntax

0-65535 active timeout value in seconds - "0" disables


the active timer

Note: If the CM requests an active timeout for that dynamic service flow in
the DSA-REQ, this active timer starts using the timeout value specified in the
DSA-REQ.

Command Default
0

21-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

clear configuration
The clear configuration command resets the Dynamic QoS, event message,
electronic surveillance, or PacketCable Multimedia configuration parameters to the
default settings.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


clear configuration [cops | dqos | em | es | mm]

Command Syntax

cops set all COPS configuration parameters to their


default values
dqos set all DQoS configuration parameters to their
default values
em set all event message configuration parameters to
their default values
es set the electronic surveillance feature to the default
value.
mm set all PacketCable Multimedia configuration
parameters to their default values

Compass ID: 188656176 Version 5 MGBI 21-5


BSR 64000 Command Reference Guide Release 4.2.0

clear cops pdp-ip all


The clear cops pdp-ip all command removes all Policy Decision Point (PDP) IP
addresses.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


clear cops pdp-ip all

21-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

clear counters ipsec


The clear counters ipsec command clears the IPSec statistical counters.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear counters ipsec

Compass ID: 188656176 Version 5 MGBI 21-7


BSR 64000 Command Reference Guide Release 4.2.0

clear packet-cable cops


The clear packet-cable statistics command clears specific, inactive, or all COPS
connections.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


clear packet-cable cops {<0-99> | all | inactive}

Command Syntax

0-99 shutdown specific COPS connection


all shutdown all active COPS connections

inactive clear inactive COPS connections

21-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

clear packet-cable gate


The clear packet-cable gate command releases reserved or committed DQoS and
Multimedia gates.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


clear packet-cable gate {all | cops <0-99> | dqos | identifier <0x00000000-0xffffffff>
| mm | modem <mac> | slot <NUM> | subscriber <A.B.C.D> }

Command Syntax

all releases all gates


cops 0-99 releases a gate for a specified COPS Client handle
dqos releases all DQoS gates
identifier Gate Identifier in hexadecimal notation
0x00000000-0xffffffff
mm releases all Multimedia gates
modem mac CM MAC address
slot NUM releases all gates associated with a specified BSR
slot number
subscriber A.B.C.D MTA or Client IP address.

Compass ID: 188656176 Version 5 MGBI 21-9


BSR 64000 Command Reference Guide Release 4.2.0

clear packet-cable statistics


The clear packet-cable statistics command clears event messages, gate, or electronic
surveillance statistical counters.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


clear packet-cable statistics [em | gate | es identifier {<0x00000000-0xffffffff>}]

Command Syntax

em event message statistics


gate specify gate statistics

es ES duplicated packet and byte counts


0x00000000-0xffffffff clear a specific ES identifier

21-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

cmts-ip
The cmts-ip command specifies the network or loopback interface IP address used for
the PacketCable protocols.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


cmts-ip <A.B.C.D>
no cmts-ip <A.B.C.D>

Command Syntax

A.B.C.D network or loopback interface IP address

Command Default
Any network or loopback IP address

Compass ID: 188656176 Version 5 MGBI 21-11


BSR 64000 Command Reference Guide Release 4.2.0

cops client-timer
If the show packet-cable statistics gate command output for the Client-Open Sent
field in the COPS Statistics section is incrementing, the network and the PDP server
need to be examined to determine the reason for the COPS Client timeouts. The
COPS Client Timer (which is the response timer for sending the COPS Client-Open
message) can be specified if COPS connections time out before receiving a
Client-Accept message.
The cops client-timer command specifies the time permitted for the BSR to receive
the Client-Accept message from the PDP before terminating the COPS connection.
The no cops client-timer command restores the default setting.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


cops client-timer <1-3600000>
no cops client-timer <1-3600000>

Command Syntax

1-3600000 COPS Client timer value in milliseconds

Command Default
3000 milliseconds

21-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

cops pdp-ip
The cops pdp-ip command restricts COPS connections to a specific Policy Decision
Point (PDP). A PDP is either the Call Management Server in the PacketCable
architecture or the Policy Server in the PacketCable Multimedia architecture where a
Client/MTA policy request is either serviced or rejected. The no cops pdp-ip
command removes an IP address from the list.

Note: If one or more PDP IP addresses are configured, only connections


from these PDP IP addresses are accepted. Up to 100 “trusted” PDP IP
addresses can be configured.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


cops pdp-ip <A.B.C.D>
no cops pdp-ip <A.B.C.D>

Command Syntax

A.B.C.D PDP IP address

Command Default
Any PDP IP address is allowed to make a COPS connection.

Compass ID: 188656176 Version 5 MGBI 21-13


BSR 64000 Command Reference Guide Release 4.2.0

cops pep-id
The cops pep-id command specifies the default Policy Enforcement Point (PEP) text
string, that is used in COPS messaging, to uniquely identify the BSR within the
PacketCable/PacketCable Multimedia domain
The no cops pep-id command restores the default value.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


cops pep-id <WORD> [<WORD>]
no cops pep-id <WORD> [<WORD>]

Command Syntax

WORD COPS PEP ID string that is between 1 and 32


characters.

Command Default
"Motorola CMTS"

21-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

cops status-trap-enable
The cops status-trap-enable command enables or disables the COPS status SNMP
trap through the DQoSCopsTrap SNMP MIB object. If the COPS status SNMP trap is
enabled, the BSR generates an SNMP trap when one or more of the following
conditions are occur:
■ a keep alive timeout
■ the COPS connection is disconnected
■ a failure to establish a TCP connection
■ a COPS connection is established
■ an unauthorized PDP attempt to establish a COPS connection

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


cops status-trap-enable {disable | enable}

Command Syntax

disable disables COPS status SNMP trap (if


previously enabled).
enable enables COPS status SNMP trap. The default
is disabled.

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 21-15


BSR 64000 Command Reference Guide Release 4.2.0

dqos emergency-trap-enable
The dqos emergency-trap-enable command enables or disables an SNMP trap for
Emergency Calls through the rdnPktDQoSEmergencyTrapEnable SNMP MIB object.
If the Emergency Call SNMP trap is enabled, the BSR generates an SNMP trap if an
Emergency Call is initiated.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


dqos emergency-trap-enable {disable | enable}

Command Syntax

disable disable Emergency Call SNMP trap (if


previously enabled)
enable enable Emergency Call SNMP trap

Command Default
Disabled

21-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

dqos res-req-trap-enable
The dqos res-req-trap-enable command enables or disables a Resource Request
SNMP trap through the DQoSResReq SNMP MIB object. If the Resource Request
SNMP trap is enabled, the BSR generates an SNMP trap if a Resource Request from
an MTA is invalid. This would include one or more of the following conditions:
■ an invalid gate ID (DSA-REQ contains an unknown gate ID)
■ a missing gate ID (DSA-REQ is missing gate ID)
■ requested resources are exceeded

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


dqos res-req-trap-enable {disable | enable}

Command Syntax

disable disable Resource Request SNMP trap (if


previously enabled)
enable enable Resource Request SNMP trap

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 21-17


BSR 64000 Command Reference Guide Release 4.2.0

dqos shutdown
The dqos shutdown command disables Dynamic QoS (DQoS) and COPS operation
on the BSR.The no dqos shutdown command enables DQoS and the COPS operation
on the BSR.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


dqos shutdown [vrf <WORD>]
no dqos shutdown [vrf <WORD>]

Command Syntax

vrf WORD the name of a specific VPN

Command Default
Disabled

21-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

dqos t0-timer/t1-timer
If T0 and T1 timeouts are being counted in the show packet-cable statistics gate
command output, the network and the PDP server need to be examined. T0 and T1
timers may need to be increased from their default values to avoid T0 and T1
timeouts.
The dqos t0-timer and dqos t1-timer commands configure the T0 and T1 timers. The
T0 timer specifies the period of time that a gate is allocated without being authorized.
The T1 timer specifies the time that can elapse between the authorization and commit.
The no dqos t0-timer and no dqos t1-timer commands restore the default values.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


dqos {t0-timer | t1-timer} <1-3600>

Command Syntax

t0-timer time, in seconds, that a gate ID can remain


allocated without any specified gate
parameters
t1-timer time, in seconds, that an authorization for a
gate can remain valid
1-3600 number of seconds

Command Default
t0-timer = 30
t1-timer = 250

Compass ID: 188656176 Version 5 MGBI 21-19


BSR 64000 Command Reference Guide Release 4.2.0

em element-number
The em element-number command specifies a unique event message Element ID for
the BSR. The no em element-number command restores the default setting.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em element-number <0-99999>
no em element-number <0-99999>

Command Syntax

0-99999 Element ID number

Command Default
0

21-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

em event-disable-mask
The em event-disable-mask command specifies a hexidecimal mask to disable event
messages. The no em event-disable-mask command restores the default setting.
The following table describes the QoS event message bit definitions. These
hexidecimal values can also be combined. For example, QoS_Release and
QoS_Commit event messages can be disabled by entering the hexidecimal number:
0x00040080.

Event Message Bit Definition (1 Based) Hexidecimal value

QoS_Reserve 7 0x00000040

QoS_Release 8 0x00000080

Time_Change 17 0x00010000

QoS_Commit 19 0x00040000

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em event-disable-mask <0x00000000-0xffffffff>

Command Syntax

0x00000000-0xffffffff set bits correspond to event message IDs


being disabled

Command Default
0x00000000 (which is no mask)

Compass ID: 188656176 Version 5 MGBI 21-21


BSR 64000 Command Reference Guide Release 4.2.0

em event-priority
The em event-priority command specifies the priority of event messages generated
from the BSR relative to other events. The no em event-priority command restores
the default setting.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em event-priority <0-255>
no em event-priority <0-255>

Command Syntax

0-255 event message priority value

Command Default
128

21-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

em flag-override
The Call Management Server directs the BSR (for PacketCable only) to send event
messages to the Record Keeping Server in either batch mode (putting event messages
together in a packet) or in realtime mode (sending event messages in packets as they
come). The event flag, which tells the BSR to send event messages to the Record
Keeping Server can be overridden.
The em flag-override command forces the BSR to use realtime mode or batch mode
regardless of what the Call Manager Server directs the BSR to do. The no em
flag-override command disables event flag override.

Note: PacketCable Multimedia supports realtime mode only.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em flag-override {batch | realtime}
no em flag-override

Command Syntax

batch send the event message in batch mode


realtime send the event message in realtime mode

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 21-23


BSR 64000 Command Reference Guide Release 4.2.0

em max-batch-events
Event messages are batched together before being sent to the Record Keeping Server.
The em max-batch-events command specifies the amount of event messages that are
batched. The no em max-batch-events command restores the default setting. The
collected messages are sent when the em max-batch-time parameter expires.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em max-batch-events <2-32>
no em max-batch-events <2-32>

Command Syntax

2-32 maximum number of batched event messages

Command Default
6

21-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

em max-batch-time
The hold-time for batched event messages can be specified to allow more time so that
multiple event messages are combined into one packet to reduce network traffic.
The em max-batch-time command specifies the interval that the batched event
messages are held before they are sent to the Record Keeping Server. The no em
max-batch-time command restores the default setting.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em max-batch-time <1-60>
no em max-batch-time <1-60>

Command Syntax

1-60 maximum time in seconds

Command Default
10

Compass ID: 188656176 Version 5 MGBI 21-25


BSR 64000 Command Reference Guide Release 4.2.0

em qos-descriptor-disable
The QoS Descriptor attribute can be disabled if an MSO administrator decides it does
not need it because it wants to reduce the event message size for network traffic
management purposes.
The QoS descriptor attribute contains the Service Class profile name and QoS
parameters. The em qos-descriptor-disable command disables the QoS Descriptor
attribute. The no em qos-descriptor-disable command enables the QoS Descriptor.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em qos-descriptor-disable
no em qos-descriptor-disable

Command Default
Enabled

21-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

em retry-count
If an Accounting-Response event message is not received by the BSR from the
Record Keeping Server, the BSR sends the event message again. Once all retries are
exhausted, the BSR tries an alternate Record Keeping Server (if one is available). The
network and the Record Keeping Server should be examined to determine the reason
for these timeouts.
The event message retry count can be specified depending on the amount of network
congestion and the distance between the BSR and the Record Keeping Server. For
example, if network congestion causes reported timeouts in the Account Request
Failure field in the show packet-cable statistics command output, the event message
retry count may need to be changed.
The em retry-count command specifies the number of retries that should occur
before the BSR tries an alternate Record Keeping Server. The no em retry-count
command restores the default setting.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em retry-count <0-16>
no em retry-count <0-16>

Command Syntax

0-16 maximum number of retransmissions for each


Record Keeping Server

Command Default
3

Compass ID: 188656176 Version 5 MGBI 21-27


BSR 64000 Command Reference Guide Release 4.2.0

em retry-interval
The event message retry interval can be configured depending on the amount of
network congestion and the distance between the BSR and the Record Keeping
Server. For example, if the distance caused a time delay, the event message retry
interval can be extended from the default value to allow more time for the BSR to
receive an Accounting-Response message. The network and the Record Keeping
Server should be examined to determine the reason for these timeouts. In most cases
the em retry-count command parameter should be increased before the em
retry-interval command parameter is modified.
The em retry-interval command specifies the event message retry interval for
receiving an Accounting Response. The no em retry-interval command restores the
default value.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em retry-interval <1-3600>
no em retry-interval

Command Syntax

1-3600 retry interval in seconds

Command Default
2

21-28 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

em shutdown
The em shutdown command disables event messages generated from the BSR if they
are not needed. The no em shutdown command enables event messages.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em shutdown
no em shutdown

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 21-29


BSR 64000 Command Reference Guide Release 4.2.0

em udp-port
If the default UDP port is already in use, another UDP port can be specified for
PacketCable event messages. A different UDP port can also be specified for event
messages because of security reasons.
The em udp-port command specifies a UDP port number for event messages. The no
em udp-port command restores the default setting.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em udp-port <1-65535>
no em udp-port <1-65535>

Command Syntax

1-65535 UDP port number for event messages.

Command Default
1813

21-30 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

es
The no es shutdown command enables electronic surveillance. The es shutdown
command disables electronic surveillance.
The es trap-enable enable command enables the electronic surveillance SNMP trap.
The no es trap-enable disable command disables the electronic surveillance SNMP
trap.

Note: Electronic surveillance conforms to Communications Assistance for


Law Enforcement Act (CALEA) requirements.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


es {shutdown | trap-enable {disable | enable}}
no es {shutdown | trap-enable {disable | enable}}

Command Syntax

shutdown Shutdown electronic surveillance


functionality
trap-enable {disable | Enable/disable the electronic
enable} surveillance SNMP trap

Command Default
Disabled

Compass ID: 188656176 Version 5 MGBI 21-31


BSR 64000 Command Reference Guide Release 4.2.0

ike client-addr
The ike client-addr command specifies the IP address used by the BSR for its source
address during IKE protocol exchanges.

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


ike client-addr <A.B.C.D>

Command Syntax

A.B.C.D host IP address used for IKE

21-32 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

ike phase1
The IKE Phase 1 Lifetime Interval and IKE Phase 1 Lifesize can be specified to
enhance security. These settings determine how long the key is exposed. For example,
an MSO administrator can decide to update this key on a regular basis to prevent
successful hacking.
The ike phase1 command specifies the IKE phase 1 lifetime value and the lifesize
value that can either trigger or prevent the expiration of the IKE security association:

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


ike phase1 [lifetime <0, 300-2592000> | lifesize <0, 10240-4190000>]

Command Syntax

0, 300-2592000 lifetime interval value in seconds - "0"


indicates an unlimited lifetime
0, 10240-4190000 lifesize value in kilobytes - "0" indicates an
unlimited lifesize

Command Default
Lifetime is 28800.
Lifesize is 0, which indicates an unlimited size in kilobytes.

Compass ID: 188656176 Version 5 MGBI 21-33


BSR 64000 Command Reference Guide Release 4.2.0

ike phase2
The IKE Phase 2 Lifetime Interval and IKE Phase 2 Lifesize can be specified to
enhance security. These settings determine how long the key is exposed. For example,
an MSO administrator can decide to update this key on a regular basis to prevent
successful hacking.
The ike phase2 command specifies the IKE phase 2 lifetime value and lifesize value
for the lifetime:

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


ike phase2 [lifetime <300-2592000> | lifesize <0, 10240-4190000>]

Command Syntax

300-2592000 lifetime interval value in seconds


0, 10240-4190000 lifesize value in kilobytes - "0" indicates an
unlimited lifesize

Command Default
Lifetime is 28800
Lifesize is 0, which indicates an unlimited size in kilobytes.

21-34 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

ike retries
The number of IKE retries can be specified for network problems. Observe the
number of IKE retries in the show ipsec ike command output. If the number of IKE
retries is increasing, then the network and server should be examined to determine the
reason for the excessive number of IKE retries.
The ike retries command specifies the number of IKE retries.

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


ike retries <1-10>

Command Syntax

1-10 number of retransmissions

Command Default
3

Compass ID: 188656176 Version 5 MGBI 21-35


BSR 64000 Command Reference Guide Release 4.2.0

ike timeout
The IKE retransmission timeout interval can be specified for network problems.
Observe the number of IKE timeouts in the show ipsec ike command output. If the
number of IKE timeouts is increasing, then the network and server should be
examined to determine the reason for the excessive number of IKE timeouts.
The ike timeout command specifies the IKE retransmission timeout interval.

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


ike timeout <1-20>

Command Syntax

1-20 timeout value in seconds

Command Default
10

21-36 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

ipsec
The ipsec command accesses IPSec Configuration mode from Global Configuration
mode.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipsec

Compass ID: 188656176 Version 5 MGBI 21-37


BSR 64000 Command Reference Guide Release 4.2.0

ipsec shutdown
The ipsec shutdown command disables IPSecIKE for the BSR.The no ipsec
shutdown command enables IPSec/IKE for the BSR.

Note: For the initial configuration of IPSec/IKE, the IPSec configurable


parameters should be configured, before IPSec is enabled. At a minimum,
the ike client-addr command should be configured prior to enabling IPSec.

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


ipsec shutdown
no ipsec shutdown

Command Default
Disabled

21-38 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

mm shutdown
The mm shutdown command disables PacketCable Multimedia and COPS operation
on the BSR. The no mm shutdown command enables PacketCable Multimedia and
COPS operation on the BSR.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


mm shutdown
no mm shutdown

Command Default
Disabled (shut down)

Compass ID: 188656176 Version 5 MGBI 21-39


BSR 64000 Command Reference Guide Release 4.2.0

mm t1-timer
The mm t1-timer command specifies the Multimedia Gate Timer T1 interval that
elapses between authorizing and reserving a PacketCable Multimedia gate.
The multimedia T1 timer starts when a gate is authorized. The Multimedia T1 timer is
stopped when an operation is performed (e.g. The gate state is switched). On
expiration of this timer, the BSR deletes the gate.
The no mm t1-timer command restores the default setting.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


mm t1-timer <1-3600>
no mm t1-timer <1-3600>

Command Syntax

1-3600 T1 timer in seconds

Command Default
200 seconds

21-40 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

packet-cable
The packet-cable command is used to access PacketCable Configuration mode from
Global Configuration mode.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


packet-cable

Compass ID: 188656176 Version 5 MGBI 21-41


BSR 64000 Command Reference Guide Release 4.2.0

show cable dynamic-service


The show cable dynamic-service command displays the dynamic service
configuration status for the cable interfaces.
The following provides typical screen output from the show cable dynamic-service
command:

Cable dynamic-service auth-mode: authorize


Cable dynamic-service active-timeout: 0
Cable dynamic-service loadbalance: disable

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


show cable dynamic-service

21-42 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

show ipsec
The show ipsec command displays the configuration of IKE, IPSec, Security
Association Database (SADB), Security Policy Database (SPD), SPD
preshared-keys, or SPD Policies.
The following is an example of typical screen output from the show ipsec sadb policy
command:

SADB:
Initialized = false
Outbound DB
Outbound Tunnel DB
Inbound ESP DB
Inbound AH DB
Inbound Other Protocol DB

The following is an example of typical screen output from the show ipsec spd policy
command:

Index Source Address Destination Address SPort DPort


Processing Indicator IPsec Mode Proto Handle
1 150.31.40.10 150.31.50.10 0 0
Apply Transport Mode 0 3
2 150.31.50.10 150.31.40.10 0 0
Apply Transport Mode 0 4
3 0.0.0.0:0.0.0.0 0.0.0.0:0.0.0.0 0 0
ByPass 0 5
4 0.0.0.0-255.255.255.255 0.0.0.0-255.255.255.255 500 500
ByPass 17 1
5 0.0.0.0-255.255.255.255 0.0.0.0-255.255.255.255 0 0
Discard 0 2

The following is an example of typical screen output from the show ipsec ike
command:

Compass ID: 188656176 Version 5 MGBI 21-43


BSR 64000 Command Reference Guide Release 4.2.0

IKE:
Initialized = false
Timeout in seconds = 0
Number of retries = 0
IKE Client IP Address = 150.31.50.10
IKE Phase1 Lifetime in Seconds = 28800
IKE Phase1 Lifesize in Kilobytes = 0
IKE Phase2 Lifetime in Seconds = 28800
IKE Phase2 Lifesize in Kilobytes = 0

The following is an example of typical screen output from the show ipsec ipsec
command:

IPsec:
Initialized = false
IPsec Retain DF bit = disabled

IPsec Bypass : 0 Ipsec Discard : 0


IPsec Outbound Ah : 0 IPsec Inbound Ah : 0
IPsec Outbound ESP : 0 IPsec Inbound ESP : 0
IPsec Output(total): 0 IPsec Input(total): 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ipsec {ike | ipsec | sadb | spd [policy | preshared-key]}

21-44 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

Command Syntax

ike display IKE-specific configuration


ipsec display IPSec-specific configuration
sadb display the Security Association Database
(SADB) configuration
spd display SPD-specific configuration
policy display SPD policy configuration
preshared-key display SPD preshared-key and IP address
configuration

Compass ID: 188656176 Version 5 MGBI 21-45


BSR 64000 Command Reference Guide Release 4.2.0

show packet-cable configuration


The show packet-cable configuration command displays COPS, DQoS, event
messaging, electronic surveillance, and PacketCable Multimedia configuration
information.
The following provides typical screen output and output field descriptions for the
show packet-cable configuration command:

PacketCable Configuration
-------------------------
CMTS IP address: 150.31.50.10

COPS Configuration
------------------
PEP ID: Motorola CMTS
Client Timer: 4000 milliseconds
Status trap: disabled

Dynamic QoS Configuration


-------------------------
DQoS is enabled
T0 Timer: 30 seconds
T1 Timer: 60 seconds
Resource Request trap: disabled
Emergency trap: disabled

Multimedia Configuration
------------------------
MM is enabled
T1 Timer: 300 seconds

PacketCable Configuration display the cable (CMTS) interface


IP address.
COPS Configuration display the PEP ID, Client Timer,
and if the Status SNMP trap is
enabled or disabled.

21-46 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

PDP IP Address display the Policy Decision Point


(PDP) for one or more Call
Management Servers (PacketCable
architecture) or Policy Server(s)
(PSs) (PacketCable Multimedia
architecture)
Dynamic QoS Configuration displays if DQoS is enabled or
disabled, T0 and T1 timer
parameters, and whether the COPS
status and Resource Request SNMP
traps are enabled or disabled.
Multimedia Configuration displays if PacketCable Multimedia
is enabled or disabled and the
configured T1 Timer interval.
Event Message displays if event messages are
Configuration enabled or disabled and other event
message configuration parameters
Electronic Surveillance displays if ES is enabled or disabled
Configuration and if the ES status SNMP trap is
enabled or disabled.

The following is an example of typical screen output from the show packet-cable
configuration cops command:

COPS Configuration
------------------
PEP ID: Motorola CMTS
Client Timer: 4000 milliseconds
Status trap: disabled

Compass ID: 188656176 Version 5 MGBI 21-47


BSR 64000 Command Reference Guide Release 4.2.0

The following is an example of typical screen output from the show packet-cable
configuration dqos command:

Dynamic QoS Configuration


-------------------------
DQoS is enabled
T0 Timer: 30 seconds
T1 Timer: 60 seconds
Resource Request trap: disabled
Emergency trap: disabled

The following is an example of typical screen output from the show packet-cable
configuration em command:

Event Message Configuration


---------------------------
EM is enabled
UDP Port Number: 1813
Element Number: 0
Event Priority: 128
Retry Interval: 2 seconds
Retry Count: 3
Maximum Batch Events: 6
Maximum Batch Time: 10 seconds
Event Disable Mask: 0x00000000
Flag Override: None
QoS Descriptor: enabled

The following is an example of typical screen output from the show packet-cable
configuration es command:

21-48 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

MOT:7A#show packet-cable configuration es


Electronic Surveillance Configuration
-------------------------------------
ES is disabled
ES trap: disabled

The following is an example of typical screen output from the show packet-cable
configuration mm command:

Multimedia Configuration
------------------------
MM is enabled
T1 Timer: 300 seconds

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show packet-cable configuration [cops | dqos | em | es | mm]

Command Syntax

cops display the COPS configuration and status


information
dqos display DQoS configuration and status
information
em display event message configuration and
status information

Compass ID: 188656176 Version 5 MGBI 21-49


BSR 64000 Command Reference Guide Release 4.2.0

es display electronic surveillance configuration


and status information
mm display PacketCable Multimedia T1 timer
interval and PacketCable Multimedia status
information.

21-50 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

show packet-cable cops


The show packet-cable cops command display all COPS connections, which
includes the COPS Client handle, PDP IP address, port number, keep-alive timeout,
and duration time.
The following provides typical screen output from the show packet-cable cops
command and output field descriptions:

COPS Connection Information


----------------------------------------------------------------------------
| Handle | Type | IP Address | Port | Keep-Alive Timeout | Connected Time |
----------------------------------------------------------------------------
0 DQoS 172.50.1.100 52287 60 01:05:02
1 MM 150.31.1.143 46351 30 01:05:02
4 MM 150.31.1.140 59970 60 00:49:25

Handle COPS handle ID


CMS IP Address PDP IP address
Port Number Socket connection port number.
Keep-Alive Timeout Keep-Alive timeout interval between
when a Keep-Alive packet is sent
and received for a COPS connection.
Duration Time time (days and hours) the COPS
connection has been active. If a
COPS handle has been disconnected
it display "disconnected".

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show packet-cable cops [inactive]

Compass ID: 188656176 Version 5 MGBI 21-51


BSR 64000 Command Reference Guide Release 4.2.0

Command Syntax

inactive specify the COPS Client(s) that are inactive

21-52 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

show packet-cable gate


The show packet-cable gate command display the gate ID in hexidecimal notation,
CM MAC address, CPE (subscriber) IP address, cable slot number, upstream and
downstream Service Flow Identifier (SFID) number, status and committed time gate
summary information
The following provides typical screen output from the show packet-cable gate
command:
p g
DQoS Gates: 2
--------------------------------------------------------------------------------
GateID | Modem | Subscriber |CM| SFID |Pri| Status |Committed
(0x) | MAC Address | IP Address |TS| Up | Dn | | | Time
--------------------------------------------------------------------------------
00000D3C 0011.8065.f57a 150.31.55.101 9 57 58 Low Committed 00:21:58
00000E86 0011.8065.f580 150.31.55.102 9 55 56 Low Committed 00:21:58

Multimedia Gates: 8
--------------------------------------------------------------------------------
GateID | Modem | Subscriber |CM| SFID |Pri| Status |Committed
(0x) | MAC Address | IP Address |TS| Up | Dn | | | Time
--------------------------------------------------------------------------------
010004E5 000e.5c6c.98f2 150.31.56.5 9 0 37 Low Committed 00:24:20
010005CA 000e.5c6c.98f2 150.31.56.5 9 39 0 Low Committed 00:24:19
01000600 000e.5c6c.98f2 150.31.56.5 9 0 41 Low Committed 00:24:19
0100077E 000e.5c6c.98f2 150.31.56.5 9 43 0 Low Committed 00:24:19
0100084A 000e.5c6c.9810 150.31.56.103 9 0 45 Low Committed 00:24:19
010009E5 000e.5c6c.9810 150.31.56.103 9 47 0 Low Committed 00:24:19
01000A4C 000e.5c6c.9810 150.31.56.103 9 0 49 Low Committed 00:24:19
01000BBA 000e.5c6c.9810 150.31.56.103 9 51 0 Low Committed 00:24:19

The following provides the show packet-cable gate command output field
descriptions:

GateID (0x) display the gate Identifier in


hexadecimal notation
Modem MAC Address cable modem (CM) MAC address
Subscriber IP Address Client IP address

Compass ID: 188656176 Version 5 MGBI 21-53


BSR 64000 Command Reference Guide Release 4.2.0

CMTS cable slot number


SFID display the upstream (Up) SFID
number, and the downstream (Dn)
Service Flow Identifier (SFID)
number.
Pri gate priority, which is either high or
low.
Status gate status
Committed Time time at which the gate was
committed

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show packet-cable gate [dqos | mm | cops <0-99> | identifier
<0x00000000-0xffffffff> | modem <mac> | slot <NUM> | subscriber <A.B.C.D>]

Command Syntax

dqos specify all DQoS gates


mm specify all Multimedia gates
cops 0-99 specify a COPS connection and COPS handle
to display
identifier Gate Identifier in hexadecimal notation to
0x00000000-0xffffffff display detailed information about the DQoS
or Multimedia gate.
modem mac specify a cable modem MAC address to
display

21-54 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

slot NUM cable slot number to display


subscriber A.B.C.D specify a CPE (subscriber) IP address to
display

Compass ID: 188656176 Version 5 MGBI 21-55


BSR 64000 Command Reference Guide Release 4.2.0

show packet-cable statistics


The show packet-cable statistics command displays COPS statistics, DQoS gate
statistics, PacketCable Multimedia gate statistics, event message statistics, DQoS
event message statistics, electronic surveillance event message statistics, and
PacketCable Multimedia event message statistics.
The following is an example of typical screen output from the show packet-cable
statistics em command:

Event Message Statistics


--------------------------------------------------------------------------
Account Request Sent: 3 Account Response Received: 3
Account Request Failure: 0 Account Response Discarded: 0

DQoS Event Message Statistics


--------------------------------------------------------------------------
QoS_Reserve Count: 0 Primary RKS Retries: 0
QoS_Commit Count: 0 Primary RKS Exhausted: 0
QoS_Release Count: 0 Secondary RKS Retries: 0
Time_Change Count: 0 Secondary RKS Exhausted: 0

Electronic Surveillance Event Message Statistics


--------------------------------------------------------------------------
QoS_Reserve Count: 0 DF Retries: 0
QoS_Commit Count: 0 DF Exhausted: 0
QoS_Release Count: 0

Multimedia Event Message Statistics


--------------------------------------------------------------------------
QoS_Reserve Count: 1 Primary RKS Retries: 0
QoS_Commit Count: 1 Primary RKS Exhausted: 0
QoS_Release Count: 1 Secondary RKS Retries: 0
Time_Change Count: 0 Secondary RKS Exhausted: 0

21-56 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

The following is an example of typical screen output from the show packet-cable
statistics gate command:

COPS Statistics
--------------------------------------------------------------------------
COPS Established: 6 Client-Open Sent: 6
COPS Terminated: 3 Client-Accept Received: 6
COPS Unauthorized: 0 Request Sent: 6
Keep-Alive Sent: 519 Client-Close Received: 0
Keep-Alive Received: 519 Client-Close Sent: 0
Keep-Alive Timeout: 0 Sync-State-Req Received: 0
Del-Req-State Sent: 0 Sync-State-Comp Sent: 0

DQoS Gate Statistics


--------------------------------------------------------------------------
Gate-Alloc Count: 3 Gate-Open Count: 4
Gate-Alloc-Ack Count: 3 Gate-Close Count: 2
Gate-Alloc-Err Count: 0 T0 Timeout: 0
Gate-Set Count: 4 T1 Timeout: 0
Gate-Set-Ack Count: 4 T7 Timeout: 0
Gate-Set-Err Count: 0 T8 Timeout: 0
Gate-Delete Count: 1 CM Delete: 2
Gate-Delete-Ack Count: 1 CM Dereg: 0
Gate-Delete-Err Count: 0 Admin Delete: 0
Gate-Info Count: 0
Gate-Info-Ack Count: 0
Gate-Info-Err Count: 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show packet-cable statistics [em | es identifier <0x00000000-0xffffffff> | gate [ cops
[<0-99>]]]

Command Syntax

Compass ID: 188656176 Version 5 MGBI 21-57


BSR 64000 Command Reference Guide Release 4.2.0

em display event message statistics


es display electronic surveillance statistics
identifier Gate Identifier in hexadecimal notation to
0x00000000-0xffffffff display detailed information about the DQoS
or Multimedia gate

gate display gate statistics


cops 0-99 specify a COPS connection and COPS handle
to display

21-58 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

spd allow-dynamic-rsp
The spd allow-dynamic-rsp command allows a dynamic response from a peer to
negotiate Internet Key Exchange (IKE) even though the SPD policy setting is other
than the "APPLY" policy setting.
The no spd allow-dynamic-rsp command is used to return the default setting.

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


spd allow-dynamic-rsp
no spd allow-dynamic-rsp

Command Default
BSR strictly follows the configured SPD.

Compass ID: 188656176 Version 5 MGBI 21-59


BSR 64000 Command Reference Guide Release 4.2.0

spd override
The spd override command is used to override IP addresses, ports, or protocols that
are configured in the IPSec Security Policy Database (SPD).
The no spd override is used to remove the address, port, or protocol override.

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


spd override [addr-selector | port-selector | protocol-selector]
no spd override [addr-selector | port-selector | protocol-selector]

Command Syntax

addr-selector SPD overrides a specific IP address within a


range of IP addresses or a wild card IP
address set in the SPD.
port-selector SPD overrides a specific port with a range of
port(s) or wild card set in the SPD.
protocol-selector SPD overrides a specific protocol with a
range of protocol or wild card of protocol set
in the SPD.

Command Default
No SPD override address selector is configured.
SPD override port selector is configured.
SPD override protocol selector is configured.

21-60 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

spd policy
The spd policy command specifies a security policy for the given peers IPSec
Security Policy Database (SPD). The SPD policy is priority based. The lower
number index has a higher priority. Data packets are compared against rules in the
SPD policy, starting with the first index. When a match is found, that rule is applied
and no further comparisons are made against the SPD policy for that data packet.
When deleting entries, a single rule or all the rules in the table can be deleted at
once.

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


spd policy <ipAddr{-ipAddr2|:ipMask}> <ipAddr{-ipAddr2|:ipMask}> <num>
<0-65535> <0-65535> {apply | bypass | discard} transport [after <num>]
no spd policy {<num> | all}

Command Syntax

ipAddr{-ipAddr2|:ipMask} source network IP address followed by a


colon and subnetwork mask. If a hyphen is
used between ipAddr and ipAddr2, this
specifies a range of source network IP
addresses.
ipAddr{-ipAddr2|:ipMask} destination network IP address followed by a
colon and subnetwork mask. If a hyphen is
used between ipAddr and ipAddr2, this
specifies a range of destination network IP
addresses.

Compass ID: 188656176 Version 5 MGBI 21-61


BSR 64000 Command Reference Guide Release 4.2.0

num transport protocol number which is the IP


protocol from the IP protocol header. The
format is a decimal number. A value of “0”
represents any protocol. For example, the Call
Management Server/Gate Controller or Call
Management Server/Policy Server can use
TCP Port 6 and the Record Keeping Server
can use UDP Port 17.
0-65535 source TCP/UDP port number. “0” represents
any port.
0-65535 destination TCP/UDP port number. “0”
represents any port
apply transport used if the packet matches the rule for this
policy (i.e., ipAddr, ipAddr2, num, source
port, or destination port matches the packet
being processed), then apply transport mode
IPSEC to the IP Packet.
bypass used if the packet matches the rule for this
policy (i.e., ipAddr, ipAddr2, num, source
port, or the destination port matches the
packet being processed), then the IPSEC
processing is bypassed and the IP packet is
processed.
discard used if the packet matches the rule for this
policy (i.e., ipAddr, ip Addr2, num, source
port, or destination port matches the packet
being processed), then discard this IP packet.
after allows a rule to be inserted after an existing
rule in the SPD. If the after is not present, the
new rule is added to the first index.
num policy security index number from the show
ipsec spd policy command. The index
numbering begins at “1”.

21-62 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 PacketCable Commands

spd preshared-key
The spd preshared-key command specifies the Pre-shared Key IP address to allow a
Pre-shared secret key to be passed between parties in a communication flow to
authenticate their mutual identities. The no spd preshared-key removes the
Pre-shared Key IP address.

Group Access
All

Command Mode
IPSec Configuration

Command Line Usage


spd preshared-key <A.B.C.D> <string>
no spd preshared-key <A.B.C.D>

Command Syntax

A.B.C.D cable interface IP address


string Pre-shared Key name which is between 1 to
128 characters

Compass ID: 188656176 Version 5 MGBI 21-63


22
VLAN Tagging Commands

Introduction
This chapter describes the commands used to configure and manage the VLAN
Tagging feature on the BSR. VLAN Tagging allows the BSR to forward traffic
received from a CPE connected to a bridging CM to a uniquely numbered VLAN
using the 802.1Q industry-standard trunking encapsulation on a selected "bridge
mode trunk" port.

VLAN Tagging Command Descriptions


This section contains an alphabetized list and descriptions of the VLAN Tagging
commands supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 22-1


BSR 64000 Command Reference Guide Release 4.2.0

bridge cable intercept


The bridge cable intercept command creates a cable intercept on a specified bridging
CM as a respone to a CALEA request from law enforcement for traffic regarding a
specific user. The no bridge cable intercept command deletes a bridge cable
intercept on a specified bridging CM.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


bridge cable intercept <mac> modem <mac> <A.B.C.D> <0-65535>
no bridge cable intercept <mac> modem <mac> <A.B.C.D> <0-65535>

Command Syntax

mac the intercept source, which is the MAC address from


which traffic is intercepted. Packets with a source or
destination MAC address that matches this address
are copied and forwarded to the data collection server
- this MAC address is always the user's CPE device
(such as a PC or VoIP phone), and not the MAC
address of the user's CM.
modem mac The MAC address of the user's CM.
A.B.C.D Specifies the destination IP address for the data
collection server that receives copies of the forwarded
traffic.
0-65535 The destination User Datagram Port (UDP) port
number, which is used exclusively by the data
collection server. A default UDP port number is not
provided.

22-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VLAN Tagging Commands

bridge cable modem


The bridge cable modem command designates a particular cable modem as a
bridging CM and associates its CPE traffic to a specified VLAN.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


bridge cable modem <mac> <2-4094> [stackable]
no bridge cable modem <mac> <2-4094> [stackable]

Command Syntax

mac cable modem MAC Address in the form


xxxx.xxxx.xxxx
2-4094 the VLAN ID
stackable allows stacking of multiple IEEE 802.1Q tags

Note: VLAN ID 1 is reserved for use by the attached Layer 2 switch/router for
management purposes and as the default "native" VLAN for that equipment.
VLAN ID 1 may not be configured on the BSR for Ethernet port tagged
routing or for cable modem Layer 2 bridging.

Compass ID: 188656176 Version 5 MGBI 22-3


BSR 64000 Command Reference Guide Release 4.2.0

bridge mode trunk


The bridge mode trunk command enables VLAN tagged bridging on a network
interface. Only the ports of a Gigabit Ethernet Network Interface Module are
permitted to be configured for VLAN Tagging.

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


bridge mode trunk [priority <0-255>]
no bridge mode trunk [priority <0-255>]

Command Syntax

priority 0-255 the optional priority value for the "bridge


mode trunk "port - if multiple network ports
are configured with bridge mode trunk
command, the BSR selects the port with the
highest priority value with its link state up for
forwarding VLAN tagged layer 2 packets. If
not specified, the default priority value is 128

22-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VLAN Tagging Commands

cable privacy mandatory


The cable privacy mandatory command allows a cable operator to enable the
encryption of all routed broadcasts and routed unmapped multicast traffic. The cable
privacy mandatory command encrypts otherwise unencrypted downstream routed
non-unicasts and only gives the key to decrypt these messages to routing cable
modems. Bridging cable modems will discard all downstream routed broadcasts or
routed multicasts. The no cable privacy mandatory disables the encryption of routed
broadcasts and routed unmapped multicast traffic.

Note: The cable privacy mandatory feature requires that all cable modems
have BPI enabled in order to register. If a cable modem does not have BPI
enabled and cable privacy mandatory is turned on, the cable modem will not
be able to register.

With cable privacy mandatory enabled, routed broadcasts are not received by
VLAN Tagging CM's. Therefore, VLAN tagging cable modems will not be able
to respond to broadcast pings.

Warning: After enabling the cable privacy mandatory feature, the cable
operator must issue the clear cable modem all reset command to
re-register all cable modems and allow non-unicast traffic (including ARPs) to
function correctly.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable privacy mandatory
no cable privacy mandatory

Compass ID: 188656176 Version 5 MGBI 22-5


BSR 64000 Command Reference Guide Release 4.2.0

clear bridge vlan counters


The clear bridge vlan counters command clears all receive and transmit statistics for
all VLANs associated with a VLAN cable modem. These are the same statistics
displayed with the show bridge vlan counters command.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


clear bridge vlan counters [<2-4094>]

Command Syntax

2-4094 the VLAN ID - if omitted, all VLAN counters


are cleared

22-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VLAN Tagging Commands

encapsulation dot1q
The encapsulation dot1q command configures VLAN tagged routing. This means
that all layer 3 packets routed by the BSR that egress the port are tagged with a
particular 802.1Q VLAN ID tag. The no encapsulation dot1q disables VLAN tagged
routing.

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


encapsulation dot1q <1-4094>
no encapsulation dot1q <1-4094>

Command Syntax

1-4094 the VLAN ID for routed traffic

Compass ID: 188656176 Version 5 MGBI 22-7


BSR 64000 Command Reference Guide Release 4.2.0

show bridge vlan


The show bridge vlan command display the bridging cable modem MAC addresses
for all VLANS or a specific VLAN. The following is typical screen output from the
show bridge vlan command:

Selected Network Bridge Port: gigaether 15/2


Vlan CM Stackable
---- -------------- ---------
400 0008.0e10.39be disabled
900 000b.0643.33fc disabled
910 0020.409a.24c8 disabled

The show bridge vlan counters command displays statistical counters for all VLANs
or a specific VLAN. The following is typical screen output from the show bridge
vlan counters command:

VLAN Upstream Upstream Downstream Downstream


ID Packets Discards Packets Discards
---- -------- ------------- ---------- ----------

2 714 23 922 34
3 50 0 45 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show bridge vlan [<2-4094>]
show bridge vlan counters [<2-4094>]

22-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 VLAN Tagging Commands

Command Syntax

counters display statistical counters for all VLANs or a


specific VLAN
2-4094 the VLAN ID - if omitted, all VLANs are
displayed

Note: VLAN ID 1 is reserved for use by the attached Layer 2 switch/router for
management purposes and as the default "native" VLAN for that equipment.
VLAN ID 1 may not be configured on the BSR for Ethernet port tagged
routing or for cable modem Layer 2 bridging.

Compass ID: 188656176 Version 5 MGBI 22-9


23
DSG Commands

Introduction
This chapter describes the commands used to configure the DOCSIS Digital Set-top
Gateway (DSG) feature on the BSR. DSG allows the BSR CMTS to provide
out-of-band (OOB) cable services over a DOCSIS network. DSG allows MSOs to
merge both set-top box and DOCSIS operations into a single, open network without
having to re-configure their existing network or cable modems.

Command Descriptions
This section contains an alphabetized list and descriptions of the DSG commands
supported by the BSR.

Compass ID: 188656176 Version 5 MGBI 23-1


BSR 64000 Command Reference Guide Release 4.2.0

cable downstream dsg


The cable downstream dsg command associates a channel list, timer, or vendor
parameter with a downstream channel. The no cable downstream dsg command
disassociates a channel list, timer, or vendor parameter with a downstream channel.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> dsg {channel-list | timer | vendor-param}
<1-4294967295>
no cable downstream <NUM> dsg {channel-list | timer | vendor-param}
<1-4294967295>

Command Syntax

NUM the downstream port number (default=0)


channel-list associates a channel list with a downstream
cable channel
timer associates a DSG timer with a downstream
cable channel
vendor-param associates a DSG vendor parameter list with a
downstream cable channel
1-4294967295 the channel list, timer, or vendor-param index

23-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

cable downstream dsg enable


The cable downstream dsg enable command enables or disables DSG Downstream
Channel Descriptor (DCD) messages on a downstream channel. The no cable
downstream dsg enable command disables DSG DCD messages on a downstream
channel.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> dsg enable
no cable downstream <NUM> dsg enable

Command Syntax

NUM the downstream port number

Command Default
Enabled

Compass ID: 188656176 Version 5 MGBI 23-3


BSR 64000 Command Reference Guide Release 4.2.0

cable dsg
The cable dsg command accesses DOCSIS Set-top Gateway Configuration mode.
DOCSIS Set-top Gateway Configuration Mode allows you to configure or modify
various DSG configurations including channel lists, classifiers, client lists, group
maps, timers and DSG tunnels.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable dsg

23-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

channel-list
The channel-list command creates or modifies a channel list. A channel list is a list of
one or multiple downstream frequencies that are carrying DSG tunnels. The
appropriate DSG Channel List will be included in the DCD messages on the
associated downstream channel. The DSG Client uses the channel list to determine
which downstream frequencies have DSG Tunnels present. The no channel-list
command deletes a channel list.

Note: Configuring a DSG channel list is optional. A DSG channel list provides
a faster means of searching for DSG Tunnels but is not a mandatory
configuration.

Group Access
MSO

Command Mode
DOCSIS Set-top Gateway Configuration

Command Line Usage


channel-list <1-4294967295> channel <1-4294967295> {delete | ds-freq
<91000000-857000000>}
no channel-list <1-4294967295> channel <1-4294967295> ds-freq
<91000000-857000000>

Command Syntax

1-4294967295 specifies a channel list index


channel 1-4294967295 specifies a channel index
delete removes this channel list
ds-freq specifies the downstream channel
91000000-857000000 frequency (s)

Compass ID: 188656176 Version 5 MGBI 23-5


BSR 64000 Command Reference Guide Release 4.2.0

classifier
The classifier command provides parameters for classifying DSG packets. The DSG
Agent applies the DSG classifier parameters to DSG packets transmitted from the
BSR to assign the DSG packet to the appropriate DSG tunnel. The DSG Agent can
also include the classifier configuration in the DCD messages on the downstream
channels to which the classifiers apply. The no classifier command deletes a
classifier.

Group Access
MSO

Command Mode
DOCSIS Set-top Gateway Configuration

Command Line Usage


classifier <1-65535> {delete | destination <A.B.C.D> | destination-port <0-65535>
<0-65535> | include-in-dcd | priority <0-255> | source <A.B.C.D> <A.B.C.D>}
no classifier <1-65535> {destination <A.B.C.D> | destination-port <0-65535>
<0-65535> | include-in-dcd | priority <0-255> | source <A.B.C.D> <A.B.C.D>}

Command Syntax

1-65535 the classifier number

delete removes this classifier


destination A.B.C.D the destination IP address to be matched for
this classifier
Note: Specifying a destination IP address is
required for the operation of this DSG
classifier
destination-port the low and high end destination port range to
0-65535 0-65535 be matched for this classifier
include-in-dcd specifies the inclusion of this DSG classifier
in DCD messages

23-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

priority 0-255 the priority of this classifier - the default


value of 0 indicates the lowest priority
source A.B.C.D the IP address and network mask of the DSG
A.B.C.D server

Command Default
priority = 0
include-in-dcd = false

Compass ID: 188656176 Version 5 MGBI 23-7


BSR 64000 Command Reference Guide Release 4.2.0

client-list
The client-list command creates a new DSG client list or modifies an existing DSG
client list. A DSG client terminates the DSG tunnel and receives transmission from
the CMTS. There may be more than one DSG Client within a Set-top Device.
Configuring a DSG client involves specifying the matching parameters for the DSG
clients for which the DSG rules applies. A DSG client ID uniquely identifies each
DSG client. The same DSG client can exist in multiple Set-top Devices.
In DSG Advanced Mode, the DSG client ID can be a 6 byte MAC address or may
additionally be a 2 byte Application ID, a 2 byte CA_system_ID, or a broadcast ID.
The Set-top Device has a fixed MAC address that must be matched by the DSG
tunnel.
The no client-list command deletes a client list.

Group Access
MSO

Command Mode
DOCSIS Set-top Gateway Configuration

Command Line Usage


client-list <1-4294967295> client-id <1-4294967295> {application-id <line> |
broadcast [<1-4>] | ca-id <line> | delete | mac-address <mac> | vendor-param
<1-4294967295>}
no client-list <1-4294967295> client-id <1-4294967295> {application-id <line> |
broadcast [<1-4>] | ca-id <line> | mac-address <mac> | vendor-param
<1-4294967295>}

Command Syntax

1-4294967295 the client list number


1-4294967295 the client identifier
application-id line specifies an application ID in 2-byte hex
string (e.g. 12ab) - indicating a numeric ID
for an application running on the Set-top
Device

23-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

broadcast 1-4 specifies the broadcast ID which identifies


what types of data streams are provided
through the Broadcast Tunnel - the following
list provides Broadcast ID data stream type
values and definitions:

1 = contains SCTE-65 [SCTE-65] delivery as


defined in Annex D
2 = contains SCTE-18 [SCTE-18] delivery as
defined in Annex D
3 = contains OCAP Object Carousel
[OC-SP-OCAP1.0
4 = contains OpenCable Common Download
Carousel
ca-id line specifies a CA ID in 2-byte hex string (e.g.
12ab) - indicating the type of CA system
applicable for the associated embedded
Cable Modem (ECM) streams
delete delete this DSG client
mac-address mac specifies a DSG client MAC address in the
form of xxxx.xxxx.xxxx - this refers to
the MAC address of the DSG Client within
the Set-top Device
vendor-param the index of the vendor parameter list
1-4294967295 specifying the vendor specific DSG
parameters

Compass ID: 188656176 Version 5 MGBI 23-9


BSR 64000 Command Reference Guide Release 4.2.0

group-map
The group-map command associates groups of tunnels to one or more downstream
channels. A DSG group map contains the downstream port number, DSG rule priority,
UCID range, and vendor parameter identifications. At least one tunnel must be
configured before a tunnel group can be mapped to a downstream channel through a
group map. The no group-map command deletes a DSG group map.

Group Access
MSO

Command Mode
DOCSIS Set-top Gateway Configuration

Command Line Usage


group-map <1-4294967295> tunnel-group <1-4294967295> {delete | interface
cable <X/Y> downstream <NUM> | priority <0-255> | ucid <1-255> [<1-255>...] |
vendor-param <1-4294967295>}
no group-map <1-4294967295> tunnel-group <1-4294967295> {interface cable
<X/Y> downstream <NUM> | priority <0-255> | ucid <1-255> [<1-255>...] |
vendor-param <1-4294967295>}

Command Syntax

1-4294967295 specifies a group map number


1-4294967295 specifies the tunnel group number
delete delete this group map
interface cable X/Y the cable interface slot and MAC domain and
downstream NUM the downstream port number
priority 0-255 specifies a DSG rule priority level - DSG rule
priority determines the order of which the
channel and its associated UCIDs should be
applied by the DSG client

23-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

ucid 1-255...1-255... specifies the upstream channel ID (UCID) for


which the DSG rule applies
vendor-param specifies the index of the vendor parameter
1-4294967295 specifying the vendor specific DSG
parameters

Compass ID: 188656176 Version 5 MGBI 23-11


BSR 64000 Command Reference Guide Release 4.2.0

show cable dsg


The show cable dsg command displays all DSG configuration information provided
with the following show commands:
■ show cable dsg channel-list
■ show cable dsg classifier
■ show cable dsg client-list
■ show cable dsg downstream
■ show cable dsg group-map
■ show cable dsg timer
■ show cable dsg tunnel
■ show cable dsg tunnel-group
■ show cable dsg vendor-param
Additionally, the show cable dsg command displays tunnel group associations to one
or more downstream channels. The following is typical screen output from the show
cable dsg for tunnel group associations to one or more downstream channels.

Cable DSG GroupChan 1 1:


Downstream ifIndex: 32769 (cable 0/0 D0)
Priority: 1
Ucid list: 1 2 3 4
Vendor Param Id: 1
Mapped slot/dsPort (slot<<4 | port): 00
mask = 0x00000000, grpChanUpdate=0
Status: 1

Cable DSG GroupChan 1 2:


Downstream ifIndex: 32769 (cable 0/0 D0)
Priority: 1
Mapped slot/dsPort (slot<<4 | port): 00
mask = 0x00000000, grpChanUpdate=0
Status: 1

23-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg

Compass ID: 188656176 Version 5 MGBI 23-13


BSR 64000 Command Reference Guide Release 4.2.0

show cable dsg channel-list


The show cable dsg channel-list command displays DSG channel list configuration
information. The following is typical screen output from the show cable dsg
channel-list command:

Cable DSG Channel List 1 1:


Downstream Frequency: 575000000

Cable DSG Channel List 1 2:


Downstream Frequency: 600000000

Cable DSG Channel List 1 3:


Downstream Frequency: 625000000

Cable DSG Channel List 1 4:


Downstream Frequency: 650000000

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg channel-list [<1-4294967295> channel <1-4294967295>]

Command Syntax

1-4294967295 specifies a channel list index


channel 1-4294967295 specifies a channel index

23-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

show cable dsg classifier


The show cable dsg classifier command displays DSG classifier configuration
information. The following is typical screen output from the show cable dsg
classifier command:

Cable DSG Classifier 10 :


Tunnel index: 1
Priority: 10
Source IP address: 10.100.10.1
Source IP prefix length: 32
Destination IP address: 230.10.10.10
Destination-port: low = 100, high = 300
Include in DCD: TRUE

Cable DSG Classifier 20 :


Tunnel index: 2
Priority: 0
Source IP address: 10.100.10.1
Source IP prefix length: 32
Destination IP address: 230.20.20.20
Destination-port: low = 100, high = 300
Include in DCD: TRUE

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg classifier [<1-65535>]

Command Syntax

1-65535 specifies a classifier number

Compass ID: 188656176 Version 5 MGBI 23-15


BSR 64000 Command Reference Guide Release 4.2.0

show cable dsg client-list


The show cable dsg client-list command displays DSG client list information. The
following is typical screen output from the show cable dsg client-list command:

Cable DSG Client List 1 1:


Client Id Type: Broadcast

Cable DSG Client List 1 2:


Client Id Type: Application Id
Client Id Value: 0x1000

Cable DSG Client List 2 1:


Client Id Type: MAC address
Client Id Value: 010b.0b0b.0b0b

Cable DSG Client List 2 2:


Client Id Type: CA system Id
Client Id Value: 0x3717

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg client-list [<1-4294967295> client-id <1-4294967295>]

Command Syntax

1-4294967295 specifies a client list number


client-id 1-4294967295 specifies a client identifying number

23-16 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

show cable dsg downstream


The show cable dsg downstream command displays DSG downstream channel
configuration information. The following is typical screen output from the show
cable dsg downstream command:

Cable DSG Downstream 32769(cable 0/0 D0):


Vendor Param: 2
Timer: 1
Channel List: 1
DCD Enabled: TRUE
Cable DSG Downstream 32770(cable 0/1 D1):
DCD Enabled: FALSE
Cable DSG Downstream 163841(cable 2/0 D0):
DCD Enabled: FALSE
Cable DSG Downstream 163842(cable 2/1 D1):
DCD Enabled: FALSE
Cable DSG Downstream 294913(cable 4/0 D0):
DCD Enabled: FALSE

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg downstream

Compass ID: 188656176 Version 5 MGBI 23-17


BSR 64000 Command Reference Guide Release 4.2.0

show cable dsg group-map


The show cable dsg group-map command displays DSG group map configuration
information. The following is typical screen output from the show cable dsg
group-map command:

Cable DSG GroupChan 10 10:


Downstream ifIndex: 8388608 (cable 5/0 D0)
Priority: 10
Mapped slot/dsPort (slot<<4 | port): 00
Status: 1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg timer [<1-4294967295>]

Command Syntax

1-4294967295 specifies a group map number

23-18 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

show cable dsg timer


The show cable dsg timer command displays DSG timer configuration information.
The following is typical screen output from the show cable dsg timer command:

DSG Timer 1:
Tdsg1: 20
Tdsg2: 2000
Tdsg3: 300
Tdsg4: 1000

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg timer [<1-4294967295>]

Command Syntax

1-4294967295 specifies a timer index

Compass ID: 188656176 Version 5 MGBI 23-19


BSR 64000 Command Reference Guide Release 4.2.0

show cable dsg tunnel


The show cable dsg tunnel command displays DSG tunnel configuration
information. The following is typical screen output from the show cable dsg tunnel
command:

Cable DSG Tunnel 1:


Client list index: 1
Classifier indices: 10
Mac address: 010a.0a0a.0a0a

Cable DSG Tunnel 2:


Client list index: 2
Classifiers indices: 20
Mac address: 010b.0b0b.0b0b

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg tunnel [<1-4294967295>]

Command Syntax

1-4294967295 specifies a tunnel number

23-20 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

show cable dsg tunnel-group


The show cable dsg tunnel-group command displays DSG tunnel group information.
The following is typical screen output from the show cable dsg tunnel-group
command:

Cable DSG Tunnel Group 1:


Tunnel indices: 1

Cable DSG Tunnel Group 2:


Tunnel indices: 2

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg tunnel-group [<1-4294967295>]

Command Syntax

1-4294967295 specifies a tunnel group number

Compass ID: 188656176 Version 5 MGBI 23-21


BSR 64000 Command Reference Guide Release 4.2.0

show cable dsg vendor-param


The show cable dsg vendor-param command displays DSG vendor parameter
configuration information. The following is typical screen output from the show
cable dsg vendor-param command:

Cable DSG VendorParam 1 1:


Vendor OUI: 010203
Vendor Value: "10"

Cable DSG VendorParam 2 1:


Vendor OUI: 010203
Vendor Value: "20"

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg vendor-param [<1-4294967295> vendor <1-4294967295> ]

Command Syntax

1-4294967295 specifies a vendor parameter group number


vendor 1-4294967295 specifies a vendor index

23-22 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

timer
The timer command specifies the 4 timeout timers that are sent to DSG clients
through the DCD message. Each downstream channel is mapped to only one set of
timers. The no timer command deletes a timer group.

Note: Configuring a DSG timer is optional.

Group Access
MSO

Command Mode
DOCSIS Set-top Gateway Configuration

Command Line Usage


timer <1-4294967295> {delete | dsg1 <1-65535> | dsg2 <1-65535> | dsg3
<1-65535> | dsg4 <1-65535>}
no timer <1-4294967295> {dsg1 <1-65535> | dsg2 <1-65535> | dsg3 <1-65535> |
dsg4 <1-65535>}

Command Syntax

1-4294967295 the timer group number


delete delete this timer group
dsg1 initialization timeout - this is the timeout
period for DSG packets during the
initialization of the DSG client
dsg2 operational timeout - this is the timeout
period for DSG packets during the normal
operation of the DSG client

Compass ID: 188656176 Version 5 MGBI 23-23


BSR 64000 Command Reference Guide Release 4.2.0

dsg3 two-way retry timer - this is the retry timer


that determines when the DSG client attempts
to reconnect with the DSG Agent and
establish two-way connectivity - a value of 0
indicates that the DSG client will
continuously retry two-way operation
dsg4 one-way retry timer - the retry timer that
determines when the DSG client attempts to
rescan for a DOCSIS downstream channel
that contains DSG packets after a dsg1 or
dsg2 timeout - a value of 0 indicates that the
DSG client will immediately begin scanning
upon a dsg1 or dsg2 timeout
1-65535 the timer value in seconds

Command Defaults
dsg1 = 2 seconds
dsg2 = 600 seconds (10 minutes)
dsg3 = 300 seconds (5 minutes)
dsg4 = 1800 seconds (30 minutes)

23-24 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

tunnel
The tunnel command configures a DSG tunnel. The no tunnel command deletes a
DSG tunnel.

Note: A DSG tunnel with a minimum specification of classifier, client-list,


and mac-address must be configured before the configuration of a DSG
tunnel group.

Group Access
MSO

Command Mode
DOCSIS Set-top Gateway Configuration

Command Line Usage


tunnel <1-4294967295> {classifier <1-65535> | client-list <1-4294967295> | delete
| mac-address <mac> | service-class <WORD> | tunnel-group <1-4294967295>}
no tunnel <1-4294967295> {classifier <1-65535> | client-list <1-4294967295> |
mac-address <mac> | service-class <WORD> | tunnel-group <1-4294967295>}

Command Syntax

1-4294967295 specifies the DSG tunnel number


classifier 1-65535 specifies a classifier number for this DSG
tunnel
client-list specifies a client list number for this DSG
1-4294967295 tunnel

delete deletes this DSG tunnel


mac-address mac specifies a DSG tunnel MAC address in the
form of xxxx.xxxx.xxxx

Compass ID: 188656176 Version 5 MGBI 23-25


BSR 64000 Command Reference Guide Release 4.2.0

service-class WORD specifies a Service Class name


tunnel-group add this DSG tunnel to a DSG tunnel group -
1-4294967295 specify an a new or existing DSG tunnel
group number

23-26 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 DSG Commands

vendor-param
The vendor-param command allows a vendor to send vendor specific parameters.
The no vendor-param command deletes a vendor parameter entry.

Group Access
MSO

Command Mode
DOCSIS Set-top Gateway Configuration

Command Line Usage


vendor-param <1-4294967295> vendor <1-4294967295> {delete | oui <line> value
<octet-string>}
no vendor-param <1-4294967295> vendor <1-4294967295>

Command Syntax

1-4294967295 specifies a vendor parameter index


vendor 1-4294967295 specifies a vendor index
delete delete this vendor parameter entry

oui line specifies a vendor assigned Organization


Unique ID (OUI) which is three bytes of an
octet string (e.g. aa056b)
value octet-string specifies a vendor value string of up to 50
characters

Compass ID: 188656176 Version 5 MGBI 23-27


Index

A
aps working, 15-12
aaa accounting commands default, 1-3
area authentication, 8-2
aaa accounting exec default, 1-5
area default-cost, 8-3
aaa authentication enable, 1-7
area nssa, 8-4
aaa authentication enable default, 1-7
area range, 8-5
aaa authentication fail-message, 1-8
area stub, 8-6
aaa authentication local-override, 1-9
area virtual-link, 8-7
aaa authentication login default, 1-9, 1-10
arp, 2-3
aaa authorization commands default, 1-11
arp (global), 2-3
aaa authorization exec default, 1-13
arp timeout, 2-5, 13-2
aaa console authentication, 1-14
auto-cost reference-bandwidth, 8-9
aaa console authorization commands default, 1-15
auto-summary, 7-2, 16-3
aaa new-model, 1-16
auto-virtual link, 8-10
access-class in, 5-2
access-list (extended), 5-4 B
access-list (standard), 5-3
balance, 13-3
aggregate-address, 16-2
band, 13-4
alias, 1-17
banner motd, 1-18
allow-share, 19-6
batch, 1-19
aps force, 15-3
bgp always-compare-med, 16-4
aps group, 15-4
bgp client-to-client reflection, 16-5
aps lockout, 15-5
bgp cluster-id, 16-6
aps manual, 15-6
bgp confederation identifier, 16-7
aps protect, 15-7
bgp confederation peers, 16-8
aps revert, 15-8
bgp dampening, 16-9
aps signal-degrade ber threshold, 15-9
bgp default, 16-11
aps signal-fail ber threshold, 15-10
bgp permit, 16-12
aps unidirectional, 15-11

Compass ID: 188656176 Version 5 MGBI Index-1


BSR 64000 Command Reference Guide Release 4.2.0

bgp router-id, 16-13 cable downstream trap-enable-if, 13-33


bind cmts, 13-5 cable downstream trap-enable-rdn, 13-34
boot system, 1-20 cable dsg, 13-35, 23-4
bridge cable intercept, 22-2 cable dynamic-service, 21-2
bridge cable modem, 22-3 cable dynamic-service active-timeout, 21-4
bridge mode trunk, 22-4 cable flap-list aging, 13-35
broadcast, 1-21 cable flap-list insertion-time, 13-37
cable flap-list miss-threshold, 13-38
C cable flap-list percentage threshold, 13-39
cabel upstream channel-type, 13-101 cable flap-list power-adjust threshold, 13-40
cable, 13-89, 23-4 cable flap-list size, 13-41
cable bind, 13-6 cable flap-list trap-enable, 13-42
cable bundle, 13-7 cable helper-address, 2-6, 13-43
cable bundle master, 13-8 cable host authorization range, 13-45
cable cmts type, 13-9 cable insert-interval, 13-46
cable concatenation docsis-1.0, 13-10 cable intercept, 13-47
cable deny ip, 13-11 cable load-balance loadbalance-group, 13-56
cable dhcp force-unicast, 13-12 cable load-balance spectrum-group, 13-57
cable dhcp leasequery message-type, 13-14 cable loadbalance-group, 13-49
cable dhcp-giaddr primary, 13-13 cable loadbalance-policy, 13-50
cable disable 3140-nbpwr-adjustment, 13-16 cable loadbalance-restricted, 13-51
cable disable bpi-cmcert, 13-17 cable loadbalance-rule, 13-53
cable downstream carrier-only, 13-18 cable modem dcc, 13-59
cable downstream description, 13-19, 13-111 cable modem deny, 13-61
cable downstream dsg, 13-20, 23-2 cable modem disable loadbalancing, 13-62
cable downstream dsg enable, 23-3 cable modem max-hosts, 13-67
cable downstream frequency, 13-20 cable modem max-hosts-all, 13-68
cable downstream interleave-depth, 13-22 cable modem qos dsa, 13-63
cable downstream loadbalance-group, 13-24 cable modem qos dsc, 13-65
cable downstream modulation, 13-25 cable modem qos dsd, 13-66
cable downstream power-level, 13-26 cable modem remote-query, 13-69
cable downstream rate-limit, 13-27 cable modem ucc, 13-71
cable downstream schedule, 13-28 cable modem updis, 13-73
cable downstream scrambler on, 13-29 cable modem-aging-timer, 13-58
cable downstream shutdown, 13-30 cable modulation-profile, 13-74
cable downstream threshold, 13-31 cable modulation-profile copy, 13-78
cable modulation-profile description, 13-79

Index-2 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Index

cable modulation-profile reset, 13-80 cable upstream modem-ranging-delay, 13-137


cable multicast, 13-81 cable upstream modulation-profile, 13-139
cable multi-ds-override, 13-83 cable upstream physical-delay, 13-141
cable privacy auth life-time, 13-84 cable upstream power-level, 13-145
cable privacy cert, 13-85 cable upstream power-level default, 13-148
cable privacy cm-auth life-time, 13-86 cable upstream pre-equalization, 13-151
cable privacy cm-auth reset, 13-87 cable upstream range-backoff, 13-153
cable privacy cm-tek life-time, 13-89 cable upstream range-forced-continue, 13-155
cable privacy cm-tek reset, 13-90 cable upstream range-power-override, 13-156
cable privacy mandatory, 22-5 cable upstream rate-limit, 13-157
cable privacy mcast, 13-91 cable upstream shutdown, 13-159
cable privacy mcast access, 13-92 cable upstream snr-offset, 13-161
cable privacy tek life-time, 13-93 cable upstream spectrum-group, 13-163
cable qos-profile, 13-94 cable upstream spread-interval, 13-164
cable service-class, 19-7 cable upstream trap-enable-cmts, 13-165
cable shared-secondary-secret, 13-96 cable upstream trap-enable-if, 13-167
cable shared-secret, 13-95 cable upstream trap-enable-rdn, 13-169
cable spectrum-group, 13-97 cable utilization-interval, 13-171
cable sync-interval, 13-98 cap, 19-8
cable ucd-interval, 13-99 channel-list, 13-172, 23-5
cable upstream active_codes, 13-100 channel-type, 13-172
cable upstream channel-width, 13-103 chassis alias, 1-22
cable upstream codes-minislot, 13-105 chassis assetid, 1-23
cable upstream concatenation, 13-107 chkdsk, 1-24
cable upstream data-backoff, 13-109 classifier, 23-6
cable upstream force-frag, 13-113 clear arp-cache, 2-8
cable upstream frequency, 13-115 clear bridge, 22-6
cable upstream hopping-seed, 13-117 clear cable dcc-stats, 13-173
cable upstream ingress-canceller enable, 13-119 clear cable flap-list, 13-174
cable upstream ingress-canceller idle-interval, 13-121 clear cable modem, 13-175
cable upstream invited-range-interval, 13-123 clear cable modem offline, 13-176
cable upstream iuc11-grant-size, 13-125 clear cable modem sync, 13-177
cable upstream loadbalance-group, 13-127 clear cable qos svc-flow statistics, 13-178
cable upstream maintain-power-density on, 13-129 clear cable srvclass-stats, 19-9
cable upstream map-interval, 13-131 clear cable ucc-stats, 13-179
cable upstream max-calls, 13-133 clear core log, 1-25
cable upstream minislot-size, 13-135 clear counters, 2-9

Compass ID: 188656176 Version 5 MGBI Index-3


BSR 64000 Command Reference Guide Release 4.2.0

clear counters cable, 13-180 Communications Assistance for Law Enforcement Act
clear counters ipsec, 21-7 (CALEA), 21-31
clear evt, 1-26 configure, 1-33
clear host, 2-10 console authentication radius, 1-34
clear interfaces cable upstream signal-quality, 13-181 cops status-trap-enable, 21-15
clear ip bgp, 16-14 copy, 1-35
clear ip bgp dampening, 16-15 crc, 15-13
clear ip bgp flap-statistics, 16-16
D
clear ip igmp counters, 9-3
clear ip multicast fwd-cache, 11-8 debug aps, 4-2
clear ip multicast proto-cache, 11-9 debug arp, 4-3
clear ip ospf, 8-11 debug cable cra, 4-4
clear ip rip statistics, 7-3 debug cable err, 4-4
clear ip route, 2-11 debug cable keyman, 4-5
clear ip rsvp statistics, 18-4 debug cable mac, 4-6
clear ip traffic, 2-12 debug cable map, 4-7
clear ip vrrp, 10-2 debug cable modem-select, 4-8
clear log, 1-28 debug cable privacy, 4-9
clear mpls traffic, 18-5 debug cable qos, 4-10
clear packet-cable configuration, 21-5 debug cable range, 4-11
clear packet-cable cops, 21-6, 21-8 debug cable reg, 4-12
clear packet-cable gate, 21-9 debug cable remote-query, 4-13
clear packet-cable statistics, 21-10 debug cable ucc, 4-14
clear redundancy stats, 1-29 debug ip access-list, 4-15
Client-Accept message, 21-12 debug ip bgp, 4-16
client-list, 13-182, 23-8 debug ip dvmrp, 4-18
client-timer, 21-12 debug ip icmp, 4-19
clock set, 1-30 debug ip igmp, 4-20
clock timezone, 1-31 debug ip mfm, 4-21
cmts-ip, 21-11 debug ip mrtm, 4-22
codes-subframe, 13-182 debug ip ospf, 4-23
collect interval, 13-183 debug ip packet, 4-25
collect resolution, 13-184 debug ip pim, 4-26
commands debug ip policy, 4-28
snmp-server community, 3-26 debug ip redistribute to, 4-29
snmp-server host, 3-26 debug ip rip, 4-31
debug ip rip database, 4-32

Index-4 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Index

debug ip rip events, 4-33 distribute-list out, 7-8, 16-22


debug ip rip trigger, 4-34 docstest, 13-187
debug ip tcp transactions, 4-35 docstest type, 13-188
debug ip udp, 4-36 dqos cops-trap-enable, 21-16
debug ip vrrp, 4-37 dqos emergency-trap-enable, 21-16
debug ipsec, 4-38 dqos res-req-trap-enable, 21-17
debug mpls forwarding, 4-40, 18-6 dqos shutdown, 21-18
debug mpls rsvp, 4-41, 18-7 dqos t0/t1-timer, 21-19
debug packet-cable, 4-43 dqos t0-timer/t1-timer, 21-19
debug ppp fsm, 4-44 duplex, 1-41
debug ppp packet, 4-45
debug radius, 4-46
E
debug snmp, 4-47 Electronic Surveillance, 21-31
debug sntp, 4-48 Element ID, 21-20
debug specmgr, 4-49 em element-number, 21-20
debug ssh, 4-50 em event-disable-mask, 21-21
debug tacacs, 4-51 em event-priority, 21-22
debug tacacs events, 4-52 em flag-override, 21-23
debug task monitor, 4-53 em max-batch-events, 21-24
debug tunnel, 4-57 em max-batch-time, 21-25
default-information originate, 8-12, 16-17 em qos-descriptor-disable, 21-26
default-information originate (OSPF), 6-2 em retry-count, 21-27
default-information originate (RIP), 7-4 em retry-interval, 21-28
default-metric, 6-4, 16-18 em shutdown, 21-29
default-metric (OSPF), 8-13 em udp-port, 21-30
default-metric (RIP), 7-5 enable, 1-42
delete, 1-37 enable authentication radius, 1-43
description, 1-38 enable password, 1-44
dhcp leasequery authorization on, 13-185 enable rdn-process, 1-45
differential-encoding on, 13-186 enable secret, 1-46
dir, 1-39 encapsulation dot1q, 22-7
disable, 1-40 encapsulation snap, 1-47
distance, 7-6, 8-14 enforce-cmts-qos, 19-10
distance bgp, 16-19 erase, 1-48
distance ospf, 8-15 es, 21-31
distribute-list, 8-17 exception, 1-49
distribute-list in, 7-7, 16-21

Compass ID: 188656176 Version 5 MGBI Index-5


BSR 64000 Command Reference Guide Release 4.2.0

exit, 1-50 hostname, 1-55

F I
fec-codeword, 13-189 icp keepalive, 1-56
fec-correction, 13-190 ike client-addr, 21-32
fft display, 13-191 ike phase1, 21-33
fft setup, 13-193 ike phase2, 21-34
fft start, 13-194 ike retries, 21-35
fft store, 13-195 ike timeout, 21-36
forced-download, 1-51 interface, 2-15
format, 1-52 interface cable, 13-207
interface pos, 15-14
G interleaver-block-size, 13-208
graceful-restart, 8-18 interleaver-depth, 13-209
graceful-restart-period, 7-9 interleaver-step-size, 13-210
grant-interval, 19-11 ip access-group, 2-17, 5-11
grant-jitter, 19-12 ip access-list, 5-12
grant-size, 19-13 ip address, 2-18, 13-211
grants-per-interval, 19-14 ip as-path access-list, 16-23
group-map, 23-10 ip broadcast-address, 2-21
guard-band, 13-196 ip community-list, 16-24
ip dhcp relay information, 2-22
H ip dhcp relay information option, 13-214
help, 1-53 ip domain-list, 2-24
helper-mode, 8-19 ip domain-lookup, 2-25
history, 1-54 ip domain-name, 2-26
hop action band, 13-197 ip dvmrp accept-filter, 12-2
hop action channel-width, 13-198 ip dvmrp default-information originate, 12-3
hop action frequency, 13-199 ip dvmrp metric-offset, 12-4
hop action modulation-profile, 13-200 ip dvmrp output-report-delay, 12-5
hop action power-level, 13-201 ip dvmrp out-report-filter, 12-6
hop action roll-back, 13-203 ip dvmrp probe-interval, 12-7
hop period, 13-204 ip dvmrp reject-non-pruners, 12-8
hop threshold error, 13-205 ip dvmrp summary-address, 12-9
hop threshold flap, 13-206 ip forwarding, 2-28
host authorization, 2-13 ip forward-protocol udp, 2-27

Index-6 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Index

ip ftp password, 1-58 ip pim rp-candidate, 17-8


ip ftp username, 1-59 ip pim rp-candidate group-list, 17-9
ip helper-address, 2-29 ip pim rp-candidate interval, 17-10
ip host, 2-30 ip pim rp-candidate ip-address, 17-11
ip igmp access-group, 9-4 ip pim rp-candidate priority, 17-12
ip igmp querier-timeout, 9-5 ip pim spt-threshold lasthop, 17-13
ip igmp query-interval, 9-6 ip pim spt-threshold rp, 17-14
ip igmp query-max-response-time, 9-7 ip policy route-map, 6-6
ip igmp static-group, 9-8 ip proxy-arp, 2-36
ip igmp version, 9-9 ip qos-group, 14-2
ip igmp version1-querier, 9-10 ip rarp-server, 2-37
ip irdp, 2-31 ip redirects, 2-38
ip local policy route-map, 6-5 ip rip authentication key, 7-10
ip mask-reply, 2-33 ip rip host-routes, 7-11
ip mroute, 11-2 ip rip message-digest-key md5, 7-12
ip mroute distance, 11-3 ip rip receive version, 7-13
ip mroute unicast distance, 11-4 ip rip send version, 7-14
ip mtu, 2-34 ip route, 2-39
ip multicast-routing, 11-5 ip routing, 2-40
ip name-server, 2-35 ip rsvp, 18-9
ip netmask-format, 1-60 ip source-route, 2-41
ip ospf authentication-key, 8-21 ip split-horizon, 7-15
ip ospf cost, 8-22 ip tacacs source-interface, 1-61
ip ospf database-filter all out, 8-23 ip tftp source-interface loopback, 1-62
ip ospf dead-interval, 8-24 ip unreachables, 2-42
ip ospf hello-interval, 8-25 ip vrrp, 10-3
ip ospf message-digest-key, 8-26 ip vrrp (virtual router ID), 10-4
ip ospf network, 8-27 ip vrrp address, 10-5
ip ospf priority, 8-28 ip vrrp authentication key, 10-6
ip ospf retransmit-interval, 8-29 ip vrrp authentication type, 10-7
ip ospf transmit-delay, 8-30 ip vrrp enable, 10-8
ip pim border, 17-2 ip vrrp preempt, 10-9
ip pim bsr-candidate, 17-3 ip vrrp primary-ip, 10-11
ip pim bsr-candidate ip-address, 17-4 ip vrrp priority, 10-10
ip pim dr-priority, 17-5 ip vrrp timer, 10-12
ip pim message-interval, 17-6 ip vrrp verify-availability, 10-13
ip pim query-interval, 17-7 ip-address (pos), 15-15

Compass ID: 188656176 Version 5 MGBI Index-7


BSR 64000 Command Reference Guide Release 4.2.0

ipsec, 21-37 M
ipsec shutdown, 21-38
mab, 19-15
iuc, 13-215
macro, 1-98
L match as-path, 6-7, 16-26
match community, 6-8, 16-27
last-codeword-length, 13-218
match ip address, 6-9
ldap client, 1-63
match ip next-hop, 6-10
ldap search-base, 1-64
match ip route-source, 6-11
ldap server, 1-65
match metric, 6-12
load-balancing, 13-219
match route-type external, 6-13
load-balancing static, 13-220
match route-type internal, 6-14
load-interval, 1-66
match tag, 6-15
logging, 1-68
max-burst, 13-221, 19-17
logging admin-status, 1-69
max-concat-burst, 19-18
logging buffered, 1-71
maximum-paths, 7-16, 8-31 , 16-28
logging console, 1-73
max-latency, 19-19
logging control docsis, 1-75
max-rate, 19-20
logging default, 1-76
memory checkzero, 1-99
logging disable bpi_auth_invalid_messages, 1-77
message, 1-100
logging disable bpi_auth_reject_messages, 1-78
min-pkt-size, 19-21
logging disable bpi_map_reject_messages, 1-79
min-rate, 19-22
logging disable cm_ranging_fail_r103_0, 1-80
mm t1-timer, 21-40
logging evt clear, 1-81
modulation-type, 13-222
logging evt set, 1-82
more, 1-104
logging facility, 1-83
moto-nsf, 8-32
logging on, 1-84
mpls create-lsp rsvp, 18-11
logging rate-limit, 1-85
mpls create-lsp rsvp explicit-route identifier, 18-12
logging reporting, 1-86
mpls create-lsp rsvp next-hop, 18-13
logging reporting default, 1-89
mpls create-lsp static, 18-14
logging session, 1-90
mpls ip, 18-16
logging snmp-trap, 1-91
mpls label range, 18-17
logging source-interface loopback, 1-93
mpls mtu, 18-18
logging trap, 1-94
mpls rsvp restart-lsp, 18-19
login, 1-96
mpls ttl, 18-20
logout, 1-97
mtrace, 11-10
Loopback interface, 21-11

Index-8 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Index

N P
name, 19-23 PacketCable
neighbor advertisement-interval, 16-29 description, 21-1
neighbor confed-segment, 16-30 packet-cable, 21-41
neighbor default-originate, 16-31 PacketCable Multimedia
description, 21-1
neighbor description, 16-32
page, 1-106
neighbor distribute-list, 16-33
passive-interface, 2-43, 7-21, 8-35
neighbor ebgp-multihop, 16-34
password, 1-107
neighbor filter-list, 16-35
password ssh-passphrase, 20-2
neighbor maximum-prefix, 16-37
pdp-ip, 21-13
neighbor next-hop-self, 16-39
peer default ip address, 15-16
neighbor password, 16-40
pep-id, 21-14
neighbor peer-group (assigning members), 16-41
pim accept-rp, 17-16
neighbor peer-group (creating), 16-42
pim register-checksum, 17-17
neighbor remote-as, 16-43
pim rp-address, 17-18
neighbor remove-private-as, 16-45
pim unicast-route-lookup, 17-20
neighbor route-map, 16-46
ping, 2-44
neighbor route-reflector client, 16-47
ping docsis, 13-224
neighbor route-refresh, 16-48
Policy Enforcement Point (PEP), 21-14
neighbor send-community, 16-49
policy rule, 13-225
neighbor shutdown, 16-50
poll-interval, 19-25
neighbor soft-reconfiguration inbound, 16-51
poll-jitter, 19-26
neighbor timers, 16-52
pos ais-shut, 15-17
neighbor update-source loopback, 16-54
pos flag, 15-18
neighbor weight, 16-55
pos framing, 15-20
network, 7-17, 12-10, 16-56, 17-15
pos internal-clock, 15-21
network area, 8-34
pos report, 15-22
network-clock-select, 15-16
pos scramble, 15-24
network-clock-select revertive, 1-103
pos signal mode, 15-25
O pos threshold, 15-26
ppp magic-number, 15-28
offset-list, 7-18
ppp negotiation-count, 15-29
output-delay, 7-20
ppp timeout, 15-30
over-max-rate, 19-24
preamble-length, 13-226
preamble-type, 13-227

Compass ID: 188656176 Version 5 MGBI Index-9


BSR 64000 Command Reference Guide Release 4.2.0

privilege restricted, 1-108 session-window set, 1-126


set as-path prepend, 6-18, 16-62
Q set automatic-tag, 6-19
qos bw default, 14-2 set bandwidth-factor, 1-127
qos queue bw, 14-3 set comm-list, 6-20, 16-63
qos-list queue, 14-3 set community, 6-22, 16-65
set default interface, 6-24
R set interface, 6-25
radius-server, 1-109 set ip default next-hop, 6-26
radius-server source-interface loopback, 1-111 set ip diff-serv, 6-27
redistribute, 7-22, 8-36 , 16-57 set ip next-hop, 6-29, 16-67
redundancy cmts, 1-112 set ip qos queue, 6-30
redundancy force-switchover cmts, 1-114 set local-preference, 6-31, 16-68
redundancy force-switchover srm, 1-116 set metric, 6-32
reload, 1-117 set metric-type, 6-33, 16-69
reload switched, 1-118 set origin, 6-34, 16-70
repeat, 1-122 set stats poll, 1-128
req-trans-policy, 19-27 set tag, 6-35, 16-71
reset, 1-123 set weight, 6-36, 16-72
restricted admission disabled, 19-29 setting
RF output upstream frequency RF output upstream frequency, 13-115
setting, 13-115 show access-lists, 5-13
rfc1583-compatible, 8-38 show aliases, 1-130
route-map, 6-16, 16-59 show aps, 15-31
router bgp, 16-59, 16-61 show arp, 2-46
router dvmrp, 12-11 show bindings, 13-230
router ospf, 8-40 show boot, 1-132
router pim, 17-21 show bridge vlan, 22-8
router rip, 7-24 show cable binding, 13-231
router-id, 8-39 show cable dcc-stats, 13-233
show cable downstream, 13-235
S show cable dsg, 23-12
schedpriority, 19-30 show cable dsg channel-list, 23-14
scrambler-mode, 13-228 show cable dsg classifier, 23-15
scrambler-seed, 13-229 show cable dsg client-list, 23-16
service password-encryption, 1-124 show cable dsg downstream, 23-17
session-timeout, 1-125 show cable dsg group-map, 23-18

Index-10 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Index

show cable dsg timer, 23-19 show cable qos profile, 13-310
show cable dsg tunnel, 23-20 show cable qos profile user-defined, 13-313
show cable dsg tunnel-group, 23-21 show cable qos svc-flow classifier, 13-316
show cable dsg vendor-param, 23-22 show cable qos svc-flow dynamic-stat, 13-318
show cable flap-list, 13-237 show cable qos svc-flow log, 13-319
show cable insert-interval, 13-239 show cable qos svc-flow param-set, 13-320
show cable loadbalance-group, 13-240 show cable qos svc-flow phs, 13-322
show cable loadbalance-policy, 13-242 show cable qos svc-flow statistics, 13-323
show cable loadbalance-restricted, 13-244 show cable qos svc-flow summary, 13-325
show cable loadbalance-rule, 13-245 show cable qos svc-flow upstream-stat, 13-326
show cable modem, 13-246 show cable service-clas, 19-31
show cable modem cpe, 13-250 show cable spectrum-group, 13-327
show cable modem detail, 13-252 show cable spectrum-group load-balance summary,
show cable modem hosts, 13-255 13-329
show cable modem loadbalance-group, 13-257 show cable srvclass-stats, 19-34
show cable modem mac, 13-259 show cable sync-interval, 13-330
show cable modem maintenance, 13-263 show cable ucc-stats, 13-331
show cable modem offline, 13-266 show cable ucd-interval, 13-333
show cable modem phy, 13-268 show cable upstream, 13-334
show cable modem registered, 13-271 show chassis alias, 1-133
show cable modem remote-query, 13-274 show chassis assetid, 1-134
show cable modem stats, 13-27, 13-278 show chassis serial-num, 1-135
show cable modem summary, 13-281 show chassis status, 1-136
show cable modem summary total, 13-283 show clock, 1-140
show cable modem svc-flow-id, 13-285 show controllers, 2-48
show cable modem svc-flow-id detail, 13-287 show controllers pos, 15-32
show cable modem time-registered, 13-290 show core log, 1-141
show cable modem timing-offset, 13-293 show debugging, 4-58
show cable modem unregistered, 13-297 show docsis-version, 13-338
show cable modulation-profile, 13-299 show docstest, 13-339
show cable modulation-profile brief, 13-302 show evt, 1-142
show cable modulation-profile description, 13-303 show forced-download, 1-146
show cable privacy auth, 13-304 show history, 1-148
show cable privacy cm-auth, 13-305 show host authorization, 2-50
show cable privacy cm-tek, 13-306 show host authorization cpe, 2-51
show cable privacy cmts, 13-308 show host authorization interface cable, 2-53
show cable privacy tek, 13-309 show host authorization summary, 2-55

Compass ID: 188656176 Version 5 MGBI Index-11


BSR 64000 Command Reference Guide Release 4.2.0

show host unauthorized cpe, 2-57 show ip dvmrp tunnels, 12-19


show hosts, 2-58 show ip filters, 2-65
show interfaces, 2-59 show ip filters summary, 2-69
show interfaces cable, 13-340 show ip forwarding-table, 2-72
show interfaces cable bandwidth voice, 13-345 show ip igmp groups, 9-11
show interfaces cable configuration, 13-347 show ip igmp interface, 9-13
show interfaces cable downstream, 13-349 show ip igmp statistics, 9-15
show interfaces cable intercept, 13-351 show ip interface, 2-74
show interfaces cable service-class, 13-353 show ip irdp, 2-77
show interfaces cable stats, 13-356 show ip multicast cache-summary, 11-11
show interfaces cable upstream, 13-358 show ip multicast fwd-cache, 11-12
show interfaces pos, 15-34 show ip multicast interface, 11-13
show ip arp, 2-62 show ip multicast no-oi-fwd-cache, 11-15
show ip as-path-access-list, 16-73 show ip multicast oi-fwd-cache, 11-14
show ip bgp, 16-73, 16-74 show ip multicast proto-cache, 11-16
show ip bgp cidr-only, 16-76 show ip ospf, 8-41
show ip bgp community, 16-77 show ip ospf border-routers, 8-43
show ip bgp community-list, 16-79 show ip ospf database, 8-44
show ip bgp dampened-paths, 16-80 show ip ospf interface, 8-47
show ip bgp flap-statistics, 16-81 show ip ospf memory, 8-49
show ip bgp ipv4 unicast, 16-83 show ip ospf neighbor, 8-51
show ip bgp memory, 16-87 show ip ospf network, 8-53
show ip bgp neighbors, 16-89 show ip ospf virtual-links, 8-54
show ip bgp next-hops, 16-91 show ip pim, 17-22
show ip bgp paths, 16-92 show ip protocols, 2-79
show ip bgp peer-group, 16-93 show ip redistribute, 6-37
show ip bgp regexp, 16-95 show ip rip database, 7-25
show ip bgp summary, 16-96 show ip route, 2-81
show ip community-list, 16-98 show ip rpf, 11-6
show ip dhcp stats, 2-64 show ip rsvp explicit-routed-lsps, 18-21
show ip dvmrp information, 12-12 show ip rsvp interface, 18-22
show ip dvmrp interface, 12-13 show ip rsvp lsp, 18-23
show ip dvmrp neighbor, 12-14 show ip rsvp neighbor, 18-24
show ip dvmrp network, 12-15 show ip rsvp reservation, 18-25
show ip dvmrp route, 12-16 show ip rsvp sender, 18-26
show ip dvmrp route hold-down, 12-17 show ip rsvp statistics, 18-27
show ip dvmrp summary-route, 12-18 show ip traffic, 2-84, 6-39

Index-12 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Index

show ip vrrp, 10-14 show snmp, 3-3


show ipsec, 21-43 show sntp, 2-89
show keepalive, 1-150 show srm alias, 1-187
show l2-cam, 2-86 show srm assetid, 1-188
show log, 1-152 show srm serial-num, 1-189
show logging evt, 1-154 show ssh config, 20-3
show logging reporting, 1-155 show ssh hostkey-fingerprint, 20-6
show logging syslog, 1-158 show startup-config, 1-190
show macro, 1-159 show stats cmts, 13-364
show memory, 1-160 show stats summary error, 13-367
show mpls filters, 18-28 show stats xfabric, 1-192
show mpls forwarding-table, 18-30 show system, 1-193
show mpls label range, 18-33 show system alarms, 1-197
show mpls lsp, 18-34 show system fans, 1-200
show mpls lsp interface, 18-37 show tacacs, 1-202
show mpls rsvp refresh-time, 18-39 show tacacs statistics, 1-203
show mpls traffic, 18-40 show tcp brief, 2-90
show network-clocks, 1-163, 15-37 show tcp statistics, 2-91
show packet-cable configuration, 21-46 show tech, 1-204
show packet-cable cops, 21-51 show update, 1-206
show packet-cable gate, 21-53 show user-group, 1-207
show packet-cable statistics, 21-56 show users, 1-209
show pool, 1-164 show users ssh, 20-7
show ppp info, 15-37 show vectron slot, 1-211
show ppp statistics, 15-38 show version, 1-213
show process, 1-166 show xfabric, 1-216
show process cpu, 1-168 shutdown, 2-95
show process memory, 1-172 slot, 1-218
show process msg-q-info, 1-175 snmp-server access, 3-9
show process semaphores, 1-176 snmp-server chassis-id, 3-11
show process stack, 1-178 snmp-server community, 3-12
show qos queue config, 14-4 snmp-server community-table, 3-13
show qos-lists, 14-4 snmp-server contact, 3-16
show redundancy cmts, 1-180 snmp-server context, 3-17
show reload, 1-184 snmp-server convert, 3-18
show route-map, 6-40 snmp-server docs-trap-control, 3-19
show running-config, 1-185 snmp-server enable informs, 3-21

Compass ID: 188656176 Version 5 MGBI Index-13


BSR 64000 Command Reference Guide Release 4.2.0

snmp-server enable traps, 3-22 spreader on, 13-377


snmp-server engineID, 3-24 srm alias, 1-220
snmp-server group, 3-25 srm assetid, 1-221, 1-222
snmp-server host, 3-26 ssh ciphers, 20-8
snmp-server location, 3-29 ssh enable, 20-10
snmp-server manager response-timeout, 3-30 ssh load-host-key-files, 20-13
snmp-server notify, 3-31 ssh logout session-id, 20-14
snmp-server notify-filter, 3-33 ssh message-authentication, 20-15
snmp-server notify-filter-profile, 3-35 ssh password-authentication radius, 20-16
snmp-server packetsize, 3-37 ssh password-guesses, 20-17
snmp-server port number, 3-38 ssh port, 20-18
snmp-server shutdown, 3-39 ssh session-limit, 20-19
snmp-server sysname, 3-40 ssh timeout, 20-20
snmp-server target-addr, 3-41 ssh-keygen2, 20-11
snmp-server target-params, 3-44 summary-address, 8-55
snmp-server trap rate-limit, 3-47 sync file, 1-223
snmp-server trap-source loopback, 3-48 synchronization, 16-99
snmp-server user, 3-49
snmp-server view, 3-51
T
snr display, 13-369 tacacs-server host, 1-225
snr loop, 13-370 tacacs-server key, 1-227
snr setup, 13-372 tacacs-server port, 1-228
snr setup-get, 13-374, 13-375 tacacs-server reset-connections, 1-224
snr start, 13-375 tacacs-server retry, 1-229
snr store, 13-376 tacacs-server timeout, 1-230
sntp authenticate, 2-96 tcm-encoding on, 13-378
sntp authentication-key, 2-97 telnet, 1-231
sntp broadcast client, 2-99 telnet authentication radius, 1-232
sntp broadcastdelay, 2-98 telnet session-limit, 1-233
sntp disable, 2-100 time band, 13-379
sntp server, 2-101 time delete, 13-380
sntp timer, 2-103 timer, 23-23
sntp trusted-key, 2-104 timers basic, 7-28
source-port 520, 7-27 timers bgp, 16-100
spd policy, 21-61 timers spf, 8-56
spd preshared-key, 21-63 tos-overwrite, 19-35
speed, 1-219

Index-14 MGBI Compass ID: 188656176 Version 5


Release 4.2.0 Index

traceroute, 2-105
trafpriority, 19-36
trap-enable-if, 2-107
trap-enable-rdn, 2-108
tunnel, 23-25
tunnel destination, 2-109
tunnel mode, 2-110
tunnel source, 2-111

U
undebug all, 4-59
unresolved-ip-packet-throttle, 2-112
update bypass, 1-234
update chassis, 1-235
username, 1-236
username privilege, 1-238
username user-group, 1-239

V
vendor-param, 23-27
version, 7-30

X
xfabric keepalive, 1-240

Compass ID: 188656176 Version 5 MGBI Index-15


Visit our website at:
www.motorola.com

Compass ID: 188656176 Version 5


12/06

MGBI

También podría gustarte