Вы находитесь на странице: 1из 1880

BSR 64000

Command
Reference Guide

Compass ID: 327594480 Version 3


Release 5.2.1
Notice
Copyright © 2009
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.

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.

Compass ID: 327594480 Version 3


Release 5.2.1
Published: 9/09
Contents

Preface
Scope ........................................................................................................................................... xlv
Audience...................................................................................................................................... xlv
Documentation Set ...................................................................................................................... xlv
Conventions...............................................................................................................................xlvii
Notes, Cautions, Warnings .......................................................................................................xlviii
If You Need Help........................................................................................................................xlix

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: 327594480 Version 3 iii


BSR 64000 Command Reference Guide Release 5.2.1

batch ...............................................................................................................................1-19
boot system.....................................................................................................................1-20
broadcast.........................................................................................................................1-21
carriage-return-lf-mode ..................................................................................................1-22
chassis alias ....................................................................................................................1-23
chassis assetid.................................................................................................................1-24
chkdsk.............................................................................................................................1-25
clear core log ..................................................................................................................1-26
clear evt ..........................................................................................................................1-27
clear log ..........................................................................................................................1-29
clear redundancy stats.....................................................................................................1-30
clock set ..........................................................................................................................1-31
clock summer-time .........................................................................................................1-32
clock timezone................................................................................................................1-34
configure.........................................................................................................................1-36
console authentication radius .........................................................................................1-37
copy ................................................................................................................................1-38
copy core ........................................................................................................................1-40
core .................................................................................................................................1-41
datapath keepalive ..........................................................................................................1-42
datapath pause enable .....................................................................................................1-43
delete...............................................................................................................................1-44
description ......................................................................................................................1-45
dir....................................................................................................................................1-46
disable.............................................................................................................................1-47
duplex .............................................................................................................................1-48
enable..............................................................................................................................1-49
enable authentication radius ...........................................................................................1-50
enable password..............................................................................................................1-51
enable rdn-process ..........................................................................................................1-52
enable secret ...................................................................................................................1-53
encapsulation snap..........................................................................................................1-54
erase................................................................................................................................1-55
exception.........................................................................................................................1-56

iv Compass ID: 327594480 Version 3


Release 5.2.1 Contents

exit ..................................................................................................................................1-57
forced-download.............................................................................................................1-58
format .............................................................................................................................1-59
help .................................................................................................................................1-60
history size......................................................................................................................1-61
hostname.........................................................................................................................1-62
hsim4 slot........................................................................................................................1-63
icp keepalive...................................................................................................................1-64
ip ftp password ...............................................................................................................1-66
ip ftp username ...............................................................................................................1-67
ip netmask-format...........................................................................................................1-68
ip tacacs source-interface ...............................................................................................1-69
ip tftp source-interface loopback ....................................................................................1-70
ldap client .......................................................................................................................1-71
ldap search-base..............................................................................................................1-72
ldap server ......................................................................................................................1-73
load-interval....................................................................................................................1-74
logging............................................................................................................................1-76
logging admin-status ......................................................................................................1-77
logging buffered .............................................................................................................1-79
logging console...............................................................................................................1-81
logging control docsis.....................................................................................................1-83
logging default................................................................................................................1-84
logging disable bpi_auth_invalid_messages ..................................................................1-85
logging disable bpi_auth_reject_messages.....................................................................1-86
logging disable bpi_map_reject_messages.....................................................................1-87
logging disable bpi_tek_invalid_messages ....................................................................1-88
logging disable cm_ranging_fail_r103_0.......................................................................1-89
logging disable dcc_arrive_new_c203_0 .......................................................................1-90
logging disable dcc_depart_old_c202_0 ........................................................................1-90
logging disable securityuser-login..................................................................................1-91
logging evt clear .............................................................................................................1-92
logging evt set.................................................................................................................1-93
logging facility................................................................................................................1-94

Compass ID: 327594480 Version 3 v


BSR 64000 Command Reference Guide Release 5.2.1

logging on.......................................................................................................................1-95
logging rate-limit ............................................................................................................1-96
logging reporting ............................................................................................................1-97
logging reporting default ..............................................................................................1-100
logging session .............................................................................................................1-101
logging snmp-trap.........................................................................................................1-102
logging source-interface loopback ...............................................................................1-104
logging trap...................................................................................................................1-105
login..............................................................................................................................1-107
logout............................................................................................................................1-108
macro ............................................................................................................................1-109
memory checkzero........................................................................................................1-110
message......................................................................................................................... 1-111
network-clock-select.....................................................................................................1-112
network-clock-select revertive .....................................................................................1-114
more..............................................................................................................................1-115
page...............................................................................................................................1-117
password .......................................................................................................................1-118
patch install...................................................................................................................1-119
privilege restricted ........................................................................................................1-120
radius-server .................................................................................................................1-121
radius-server source-interface loopback.......................................................................1-123
redundancy cmts...........................................................................................................1-124
redundancy dtx .............................................................................................................1-126
redundancy force-switchover cmts...............................................................................1-127
redundancy force-switchover dtx .................................................................................1-129
redundancy force-switchover srm ................................................................................1-130
reload ............................................................................................................................1-131
reload switched.............................................................................................................1-132
remote copy ..................................................................................................................1-136
remote delete slot..........................................................................................................1-138
remote rm slot...............................................................................................................1-138
remote dir slot...............................................................................................................1-139
remote ls slot.................................................................................................................1-139

vi Compass ID: 327594480 Version 3


Release 5.2.1 Contents

repeat ............................................................................................................................1-141
reset...............................................................................................................................1-142
service password-encryption ........................................................................................1-143
session-timeout .............................................................................................................1-144
session-window set.......................................................................................................1-145
set bandwidth-factor .....................................................................................................1-146
set stats poll ..................................................................................................................1-147
show aliases ..................................................................................................................1-149
show boot......................................................................................................................1-151
show chassis alias .........................................................................................................1-152
show chassis assetid .....................................................................................................1-153
show chassis serial-num ...............................................................................................1-154
show chassis status .......................................................................................................1-155
show clock ....................................................................................................................1-159
show core log................................................................................................................1-160
show evt........................................................................................................................1-161
show forced-download .................................................................................................1-165
show history..................................................................................................................1-167
show keepalive .............................................................................................................1-169
show log........................................................................................................................1-171
show logging evt...........................................................................................................1-174
show logging reporting.................................................................................................1-175
show logging syslog .....................................................................................................1-178
show macro...................................................................................................................1-179
show memory ...............................................................................................................1-180
show network-clocks ....................................................................................................1-183
show patches-installed..................................................................................................1-184
show pool......................................................................................................................1-186
show process.................................................................................................................1-188
show process cpu..........................................................................................................1-190
show process memory ..................................................................................................1-194
show process msg-q-info..............................................................................................1-197
show process semaphores.............................................................................................1-198
show process stack .......................................................................................................1-200

Compass ID: 327594480 Version 3 vii


BSR 64000 Command Reference Guide Release 5.2.1

show redundancy ..........................................................................................................1-202


show redundancy cmts .................................................................................................1-205
show redundancy dtx....................................................................................................1-209
show redundancy srm ...................................................................................................1-212
show reload...................................................................................................................1-214
show running-config.....................................................................................................1-215
show srm alias ..............................................................................................................1-217
show srm assetid...........................................................................................................1-218
show srm serial-num.....................................................................................................1-219
show startup-config ......................................................................................................1-220
show stats fastpath ........................................................................................................1-222
show stats summary error .............................................................................................1-224
show stats xfabric .........................................................................................................1-225
show system..................................................................................................................1-226
show system alarms......................................................................................................1-230
show system fans..........................................................................................................1-233
show tacacs...................................................................................................................1-235
show tacacs statistics ....................................................................................................1-236
show tech ......................................................................................................................1-237
show update ..................................................................................................................1-240
show user-group ...........................................................................................................1-241
show users ....................................................................................................................1-243
show vectron slot..........................................................................................................1-245
show version.................................................................................................................1-247
show xfabric .................................................................................................................1-249
slot ................................................................................................................................1-251
speed .............................................................................................................................1-252
srm alias........................................................................................................................1-253
srm assetid ....................................................................................................................1-254
sync file ........................................................................................................................1-256
system temperature-threshold.......................................................................................1-257
tacacs reset-connections ...............................................................................................1-259
tacacs-server host..........................................................................................................1-260
tacacs-server key ..........................................................................................................1-262

viii Compass ID: 327594480 Version 3


Release 5.2.1 Contents

tacacs-server port..........................................................................................................1-263
tacacs-server retry.........................................................................................................1-264
tacacs-server timeout ....................................................................................................1-265
telnet .............................................................................................................................1-266
telnet authentication radius...........................................................................................1-267
telnet session-limit........................................................................................................1-268
update bypass................................................................................................................1-269
update chassis ...............................................................................................................1-270
update slot.....................................................................................................................1-271
username.......................................................................................................................1-272
username privilege........................................................................................................1-274
username user-group ....................................................................................................1-275
xfabric keepalive ..........................................................................................................1-276

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
clear sntp history.............................................................................................................2-13
host authorization ...........................................................................................................2-14
interface ..........................................................................................................................2-16
ip access-group ...............................................................................................................2-18
ip address ........................................................................................................................2-19
ip broadcast-address .......................................................................................................2-23
ip dhcp relay information ...............................................................................................2-24
ip domain-list..................................................................................................................2-26
ip domain-lookup............................................................................................................2-27

Compass ID: 327594480 Version 3 ix


BSR 64000 Command Reference Guide Release 5.2.1

ip domain-name ..............................................................................................................2-28
ip forward-protocol udp..................................................................................................2-29
ip forwarding ..................................................................................................................2-30
ip helper-address.............................................................................................................2-31
ip host .............................................................................................................................2-32
ip irdp..............................................................................................................................2-33
ip mask-reply ..................................................................................................................2-35
ip mtu..............................................................................................................................2-36
ip multicast fastpath........................................................................................................2-37
ip name-server ................................................................................................................2-39
ip proxy-arp ....................................................................................................................2-40
ip rarp-server ..................................................................................................................2-41
ip redirects ......................................................................................................................2-42
ip route............................................................................................................................2-43
ip routing ........................................................................................................................2-44
ip source-route ................................................................................................................2-45
ip unreachables ...............................................................................................................2-46
passive-interface .............................................................................................................2-47
ping .................................................................................................................................2-49
show arp..........................................................................................................................2-51
show controllers..............................................................................................................2-53
show host authorization..................................................................................................2-55
show host authorization cpe ...........................................................................................2-56
show host authorization interface cable .........................................................................2-58
show host authorization summary ..................................................................................2-60
show host unauthorized cpe............................................................................................2-62
show hosts ......................................................................................................................2-63
show interfaces ...............................................................................................................2-64
show ip arp .....................................................................................................................2-66
show ip dhcp stats...........................................................................................................2-69
show ip filters .................................................................................................................2-70
show ip filters summary .................................................................................................2-74
show ip flows..................................................................................................................2-77
show ip forwarding-table................................................................................................2-79

x Compass ID: 327594480 Version 3


Release 5.2.1 Contents

show ip interface.............................................................................................................2-81
show ip irdp ....................................................................................................................2-84
show ip multicast fastpath ..............................................................................................2-86
show ip multicast fwd-cache ..........................................................................................2-87
show ip protocols............................................................................................................2-89
show ip route ..................................................................................................................2-91
show ip traffic.................................................................................................................2-94
show l2-cam....................................................................................................................2-98
show sntp ......................................................................................................................2-101
show tcp brief ...............................................................................................................2-102
show tcp statistics .........................................................................................................2-103
shutdown.......................................................................................................................2-107
sntp authenticate ...........................................................................................................2-108
sntp authentication-key.................................................................................................2-109
sntp broadcastdelay ......................................................................................................2-110
sntp broadcast client ..................................................................................................... 2-111
sntp disable ...................................................................................................................2-112
sntp response timeout ...................................................................................................2-113
sntp server.....................................................................................................................2-114
sntp source-interface loopback .....................................................................................2-116
sntp timer ......................................................................................................................2-117
sntp trusted-key ............................................................................................................2-118
traceroute ......................................................................................................................2-119
trap-enable-if ................................................................................................................2-121
trap-enable-rdn .............................................................................................................2-122
tunnel destination..........................................................................................................2-123
tunnel mode ..................................................................................................................2-124
tunnel source.................................................................................................................2-125
unresolved-ip-packet-throttle .......................................................................................2-126

Compass ID: 327594480 Version 3 xi


BSR 64000 Command Reference Guide Release 5.2.1

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

xii Compass ID: 327594480 Version 3


Release 5.2.1 Contents

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-27
debug ip policy ...............................................................................................................4-29
debug ip redistribute .......................................................................................................4-30
debug ip rip.....................................................................................................................4-32
debug ip rip database ......................................................................................................4-33
debug ip rip events..........................................................................................................4-34
debug ip rip trigger .........................................................................................................4-35
debug ip tcp transactions ................................................................................................4-36
debug ip udp ...................................................................................................................4-37

Compass ID: 327594480 Version 3 xiii


BSR 64000 Command Reference Guide Release 5.2.1

debug ip vrrp...................................................................................................................4-38
debug ipsec .....................................................................................................................4-39
debug ipv6 all .................................................................................................................4-41
debug ipv6 dhcp .............................................................................................................4-42
debug ipv6 icmp6 ...........................................................................................................4-43
debug ipv6 packet...........................................................................................................4-44
debug ipv6 tcp6 ..............................................................................................................4-45
debug ipv6 udp6 .............................................................................................................4-46
debug isis adj-packets.....................................................................................................4-47
debug isis authentication ................................................................................................4-48
debug isis snp-packets ....................................................................................................4-49
debug isis spf-event ........................................................................................................4-50
debug isis spf-statistics ...................................................................................................4-51
debug isis spf-triggers.....................................................................................................4-52
debug isis update-packets ...............................................................................................4-53
debug mpls forwarding...................................................................................................4-54
debug mpls rsvp..............................................................................................................4-55
debug nd .........................................................................................................................4-57
debug packet-cable .........................................................................................................4-58
debug ppp fsm ................................................................................................................4-59
debug ppp packet............................................................................................................4-60
debug radius....................................................................................................................4-61
debug snmp.....................................................................................................................4-62
debug sntp.......................................................................................................................4-63
debug specmgr................................................................................................................4-64
debug ssh ........................................................................................................................4-65
debug tacacs....................................................................................................................4-66
debug tacacs events ........................................................................................................4-67
debug task monitor .........................................................................................................4-68
debug tunnel ...................................................................................................................4-72
show debugging..............................................................................................................4-73
undebug all .....................................................................................................................4-74

xiv Compass ID: 327594480 Version 3


Release 5.2.1 Contents

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-12
ip access-list....................................................................................................................5-13
show access-lists.............................................................................................................5-14

6 Routing Policy Commands


Introduction .................................................................................................................................6-1
Routing Policy Command Descriptions ......................................................................................6-1
default-information originate............................................................................................6-2
default-metric ...................................................................................................................6-4
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

Compass ID: 327594480 Version 3 xv


BSR 64000 Command Reference Guide Release 5.2.1

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

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

xvi Compass ID: 327594480 Version 3


Release 5.2.1 Contents

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

Compass ID: 327594480 Version 3 xvii


BSR 64000 Command Reference Guide Release 5.2.1

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
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 last-member-query-count ....................................................................................9-7
ip igmp last-member-query-interval.................................................................................9-8
ip igmp query-max-response-time....................................................................................9-9
ip igmp static-group........................................................................................................9-10
ip igmp version ...............................................................................................................9-11

xviii Compass ID: 327594480 Version 3


Release 5.2.1 Contents

ip igmp version1-querier ................................................................................................9-12


show ip igmp groups ......................................................................................................9-13
show ip igmp interface ...................................................................................................9-15
show ip igmp statistics....................................................................................................9-17

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

Compass ID: 327594480 Version 3 xix


BSR 64000 Command Reference Guide Release 5.2.1

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

xx Compass ID: 327594480 Version 3


Release 5.2.1 Contents

band ................................................................................................................................13-4
bind cmts ........................................................................................................................13-5
bootrom-filename ...........................................................................................................13-6
bootrom-invalidate slot...................................................................................................13-7
cable bind........................................................................................................................13-8
cable bundle..................................................................................................................13-10
cable bundle master ......................................................................................................13-11
cable cmts type .............................................................................................................13-12
cable concatenation docsis-1.0 .....................................................................................13-13
cable deny ip.................................................................................................................13-14
cable dhcp force-unicast ...............................................................................................13-15
cable dhcp preserve-server-id.......................................................................................13-16
cable dhcp-giaddr primary............................................................................................13-17
cable dhcp leasequery message-type ............................................................................13-18
cable disable 3140-nbpwr-adjustment ..........................................................................13-20
cable disable bpi-cmcert ...............................................................................................13-21
cable disable eth-pkt-filtering.......................................................................................13-22
cable downstream aggregate.........................................................................................13-23
cable downstream bdm-interval ...................................................................................13-24
cable downstream bonding disable...............................................................................13-25
cable downstream bonding-domain..............................................................................13-26
cable downstream bonding-group ................................................................................13-27
cable downstream carrier-only .....................................................................................13-29
cable downstream channel-id .......................................................................................13-30
cable downstream channel-mode .................................................................................13-31
cable downstream description ......................................................................................13-32
cable downstream fiber-node........................................................................................13-33
cable downstream frequency ........................................................................................13-34
cable downstream interleave-depth ..............................................................................13-36
cable downstream loadbalance-group ..........................................................................13-38
cable downstream modulation......................................................................................13-39
cable downstream mot-bonding-group.........................................................................13-40
cable downstream multicast enable ..............................................................................13-42
cable downstream non-bonding-reset interval..............................................................13-43

Compass ID: 327594480 Version 3 xxi


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream port..................................................................................................13-44


cable downstream power-level .....................................................................................13-45
cable downstream primary-capable..............................................................................13-47
cable downstream rate-limit .........................................................................................13-48
cable downstream schedule ..........................................................................................13-49
cable downstream scrambler on ...................................................................................13-50
cable downstream shutdown.........................................................................................13-51
cable downstream sync-interval ...................................................................................13-52
cable downstream threshold .........................................................................................13-53
cable downstream trap-enable-if ..................................................................................13-55
cable downstream trap-enable-rdn ...............................................................................13-56
cable dtx type................................................................................................................13-57
cable dynamic-service admitted-timeout......................................................................13-58
cable fast-path cm.........................................................................................................13-59
cable filter group index src-ip.......................................................................................13-60
cable filter group index dst-ip.......................................................................................13-61
cable filter group index ulp...........................................................................................13-62
cable filter group index tos ...........................................................................................13-63
cable filter group index action......................................................................................13-64
cable filter group index enable .....................................................................................13-65
cable flap-list aging ......................................................................................................13-66
cable flap-list insertion-time.........................................................................................13-68
cable flap-list miss-threshold........................................................................................13-69
cable flap-list percentage threshold ..............................................................................13-70
cable flap-list power-adjust threshold ..........................................................................13-71
cable flap-list size .........................................................................................................13-72
cable flap-list trap-enable .............................................................................................13-73
cable helper-address .....................................................................................................13-74
cable helper-address host vendor-class-identifiers .......................................................13-76
cable host authorization range ......................................................................................13-77
cable insert-interval ......................................................................................................13-78
cable intercept...............................................................................................................13-79
cable ip-broadcast-echo ................................................................................................13-81
cable ip-multicast-echo.................................................................................................13-82

xxii Compass ID: 327594480 Version 3


Release 5.2.1 Contents

cable load-balance ........................................................................................................13-83


cable loadbalance-group...............................................................................................13-84
cable loadbalance-policy ..............................................................................................13-85
cable loadbalance-restricted .........................................................................................13-86
cable loadbalance-rule ..................................................................................................13-88
cable load-balance spectrum-group ..............................................................................13-91
cable mdd-interval ........................................................................................................13-92
cable modem-aging-timer.............................................................................................13-93
cable modem dcc ..........................................................................................................13-94
cable modem deny ........................................................................................................13-96
cable modem disable loadbalancing .............................................................................13-97
cable modem max-hosts ...............................................................................................13-98
cable modem max-hosts-all..........................................................................................13-99
cable modem qos dsa..................................................................................................13-100
cable modem qos dsc..................................................................................................13-102
cable modem qos dsd..................................................................................................13-103
cable modem remote-query ........................................................................................13-104
cable modem remote-query source-interface .............................................................13-105
cable modem service-class-name ...............................................................................13-108
cable modem ucc ........................................................................................................13-110
cable modem updis .....................................................................................................13-112
cable modulation-profile ............................................................................................13-113
cable modulation-profile copy....................................................................................13-117
cable modulation-profile description..........................................................................13-118
cable modulation-profile reset....................................................................................13-119
cable mta-protection enable........................................................................................13-120
cable multicast ............................................................................................................13-121
cable multi-ds-override...............................................................................................13-123
cable privacy auth life-time ........................................................................................13-124
cable privacy cert........................................................................................................13-125
cable privacy cm-auth life-time..................................................................................13-126
cable privacy cm-auth reset ........................................................................................13-127
cable privacy cm-tek life-time....................................................................................13-129
cable privacy cm-tek reset ..........................................................................................13-130

Compass ID: 327594480 Version 3 xxiii


BSR 64000 Command Reference Guide Release 5.2.1

cable privacy enforce-bpi-plus ...................................................................................13-131


cable privacy mandatory.............................................................................................13-132
cable privacy mcast ....................................................................................................13-134
cable privacy mcast access .........................................................................................13-135
cable privacy tek life-time ..........................................................................................13-136
cable qos max-burst....................................................................................................13-137
cable qos-profile .........................................................................................................13-138
cable security authorized ............................................................................................13-139
cable security failure...................................................................................................13-140
cable shared-secret......................................................................................................13-141
cable shared-secondary-secret ....................................................................................13-142
cable spectrum-group .................................................................................................13-143
cable spm-management ..............................................................................................13-144
cable submgmt default cpe-control active..................................................................13-145
cable submgmt default cpe-control learnable.............................................................13-146
cable submgmt default cpe-control max-cpe..............................................................13-147
cable submgmt default filter-group ............................................................................13-148
cable submgmt default filter-group cm ......................................................................13-149
cable sync-interval......................................................................................................13-150
cable tcpudp-filter group index src-port .....................................................................13-151
cable tcpudp-filter group index dst-port .....................................................................13-152
cable tcpudp-filter group index enable .......................................................................13-153
cable tcpudp-filter group index tcp-flag .....................................................................13-154
cable ucd-interval .......................................................................................................13-155
cable upstream active-codes .......................................................................................13-156
cable upstream capability ...........................................................................................13-157
cable upstream channel-id ..........................................................................................13-158
cable upstream channel-type ......................................................................................13-159
cable upstream channel-width ....................................................................................13-160
cable upstream codes-minislot ...................................................................................13-161
cable upstream concatenation.....................................................................................13-162
cable upstream data-backoff.......................................................................................13-163
cable upstream description .........................................................................................13-164
cable upstream eng-nb-atten-backoff value................................................................13-165

xxiv Compass ID: 327594480 Version 3


Release 5.2.1 Contents

cable upstream eq-magnitude-scaling ........................................................................13-167


cable upstream force-frag ...........................................................................................13-169
cable upstream frequency ...........................................................................................13-170
cable upstream global-clock .......................................................................................13-172
cable upstream global-clock enable............................................................................13-173
cable upstream hopping-seed .....................................................................................13-174
cable upstream ingress-canceller enable ....................................................................13-175
cable upstream invited-range-interval ........................................................................13-176
cable upstream iuc11-grant-size .................................................................................13-177
cable upstream loadbalance-group .............................................................................13-178
cable upstream maintain-power-density on................................................................13-179
cable upstream map-interval.......................................................................................13-180
cable upstream max-calls ...........................................................................................13-181
cable upstream minislot-size ......................................................................................13-182
cable upstream modem-ranging-delay .......................................................................13-184
cable upstream modulation-profile.............................................................................13-185
cable upstream physical-delay....................................................................................13-187
cable upstream power-level ........................................................................................13-191
cable upstream power-level default............................................................................13-193
cable upstream pre-equalization .................................................................................13-195
cable upstream range-backoff.....................................................................................13-196
cable upstream range-forced-continue .......................................................................13-197
cable upstream range-power-override ........................................................................13-198
cable upstream rate-limit ............................................................................................13-199
cable upstream schedule .............................................................................................13-200
cable upstream shutdown ...........................................................................................13-201
cable upstream snr-offset............................................................................................13-202
cable upstream spectrum-group..................................................................................13-203
cable upstream spread-interval ...................................................................................13-204
cable upstream trap-enable-cmts ................................................................................13-205
cable upstream trap-enable-if .....................................................................................13-206
cable upstream trap-enable-rdn ..................................................................................13-207
cable utilization-interval.............................................................................................13-208
channel-type ...............................................................................................................13-209

Compass ID: 327594480 Version 3 xxv


BSR 64000 Command Reference Guide Release 5.2.1

clear cable dcc-stats....................................................................................................13-211


clear cable downstream bonding-group statistics.......................................................13-212
clear cable flap-list .....................................................................................................13-213
clear cable host ...........................................................................................................13-214
clear cable modem ......................................................................................................13-215
clear cable modem downstream .................................................................................13-216
clear cable modem reject-pk reset ..............................................................................13-217
clear cable modem reject-pt reset ...............................................................................13-217
clear cable modem offline ..........................................................................................13-218
clear cable modem sync..............................................................................................13-219
clear cable qos svc-flow statistics...............................................................................13-220
clear cable srvclass-stats.............................................................................................13-221
clear cable ucc-stats....................................................................................................13-223
clear cable ugs-stats....................................................................................................13-224
clear counters cable ....................................................................................................13-225
clear interfaces cable upstream channel-agility-stats .................................................13-226
clear interfaces cable upstream signal-quality............................................................13-227
clear usage-stats..........................................................................................................13-228
cmts-id ........................................................................................................................13-229
codes-subframe...........................................................................................................13-230
collect interval ............................................................................................................13-231
collect resolution ........................................................................................................13-232
dhcp leasequery authorization on ...............................................................................13-233
differential-encoding on .............................................................................................13-234
docstest .......................................................................................................................13-235
docstest type ...............................................................................................................13-236
fec-codeword ..............................................................................................................13-238
fec-correction..............................................................................................................13-239
fft display....................................................................................................................13-240
fft setup .......................................................................................................................13-242
fft start ........................................................................................................................13-243
fft store........................................................................................................................13-244
frequency-test-method................................................................................................13-245
guard-band ..................................................................................................................13-246

xxvi Compass ID: 327594480 Version 3


Release 5.2.1 Contents

hop action band...........................................................................................................13-247


hop action channel-width ...........................................................................................13-248
hop action frequency ..................................................................................................13-249
hop action modulation-profile ....................................................................................13-250
hop action power-level ...............................................................................................13-251
hop action roll-back....................................................................................................13-253
hop modulation-rollback-count ..................................................................................13-254
hop period...................................................................................................................13-255
hop snr hysteresis .......................................................................................................13-256
hop sampling-period active-channel...........................................................................13-258
hop sampling-period rollback-channel .......................................................................13-259
hop sampling-period spare-channel............................................................................13-260
hop threshold error .....................................................................................................13-261
hop threshold flap .......................................................................................................13-262
hop threshold snr modulation-type.............................................................................13-263
init-tech.......................................................................................................................13-265
interface cable.............................................................................................................13-266
interleaver-block-size .................................................................................................13-267
interleaver-depth.........................................................................................................13-268
interleaver-step-size....................................................................................................13-269
ip address ....................................................................................................................13-270
ip dhcp relay information option ................................................................................13-273
iuc ...............................................................................................................................13-274
last-codeword-length ..................................................................................................13-277
load-balancing ............................................................................................................13-278
load-balancing static...................................................................................................13-279
max-burst....................................................................................................................13-280
mdrc enable ................................................................................................................13-281
modulation-type..........................................................................................................13-282
ping docsis ..................................................................................................................13-284
policy rule...................................................................................................................13-285
preamble-length..........................................................................................................13-286
preamble-type .............................................................................................................13-287
reference-modem-exclusion .......................................................................................13-288

Compass ID: 327594480 Version 3 xxvii


BSR 64000 Command Reference Guide Release 5.2.1

scrambler-mode ..........................................................................................................13-289
scrambler-seed ............................................................................................................13-290
show bindings.............................................................................................................13-291
show cable binding .....................................................................................................13-292
show cable bonding-group minrr-multipliers .............................................................13-294
show cable dcc-stats ...................................................................................................13-296
show cable downstream..............................................................................................13-298
show cable downstream bonding-groups ...................................................................13-301
show cable downstream idlist.....................................................................................13-304
show cable fiber-node.................................................................................................13-305
show cable filter .........................................................................................................13-307
show cable flap-list.....................................................................................................13-308
show cable insert-interval...........................................................................................13-310
show cable loadbalance-group ...................................................................................13-311
show cable loadbalance-no-move-list ........................................................................13-313
show cable loadbalance-policy...................................................................................13-315
show cable loadbalance-restricted..............................................................................13-317
show cable loadbalance-rule.......................................................................................13-318
show cable md-ds-sg ..................................................................................................13-319
show cable modem .....................................................................................................13-321
show cable modem bonding .......................................................................................13-325
show cable modem cpe...............................................................................................13-327
show cable modem detail ...........................................................................................13-330
show cable modem downstream.................................................................................13-333
show cable flap-list.....................................................................................................13-336
show cable modem hosts ............................................................................................13-339
show cable modem loadbalance-group ......................................................................13-341
show cable modem mac..............................................................................................13-343
show cable modem mac30..........................................................................................13-346
show cable modem maintenance ................................................................................13-349
show cable modem max-rate ......................................................................................13-351
show cable modem mta ..............................................................................................13-352
show cable modem ps.................................................................................................13-352
show cable modem stb................................................................................................13-352

xxviii Compass ID: 327594480 Version 3


Release 5.2.1 Contents

show cable modem offline..........................................................................................13-357


show cable modem offline-previous ..........................................................................13-359
show cable modem phy ..............................................................................................13-361
show cable modem qos...............................................................................................13-364
show cable modem qos summary...............................................................................13-367
show cable modem registered ....................................................................................13-370
show cable modem remote-query...............................................................................13-373
show cable modem security........................................................................................13-378
show cable modem stats .............................................................................................13-383
show cable modem summary .....................................................................................13-386
show cable modem summary total .............................................................................13-389
show cable modem svc-flow-id..................................................................................13-391
show cable modem svc-flow-id detail........................................................................13-393
show cable modem time-registered ............................................................................13-396
show cable modem timing-offset ...............................................................................13-399
show cable modem unregistered ................................................................................13-403
show cable modem vendor .........................................................................................13-405
show cable modem vendor summary .........................................................................13-407
show cable modem verbose........................................................................................13-409
show cable modulation-profile ...................................................................................13-411
show cable modulation-profile brief ..........................................................................13-414
show cable modulation-profile description ................................................................13-415
show cable privacy auth .............................................................................................13-416
show cable privacy cm-auth .......................................................................................13-417
show cable privacy cm-tek .........................................................................................13-418
show cable privacy cmts.............................................................................................13-420
show cable privacy enforce-bpi-plus..........................................................................13-421
show cable privacy mandatory ...................................................................................13-422
show cable privacy tek ...............................................................................................13-423
show cable qos profile ................................................................................................13-424
show cable qos profile user-defined ...........................................................................13-427
show cable qos svc-flow classifier .............................................................................13-430
show cable qos svc-flow dynamic-stat .......................................................................13-433
show cable qos svc-flow log.......................................................................................13-434

Compass ID: 327594480 Version 3 xxix


BSR 64000 Command Reference Guide Release 5.2.1

show cable qos svc-flow param-set............................................................................13-435


show cable qos svc-flow phs ......................................................................................13-437
show cable qos svc-flow statistics..............................................................................13-439
show cable qos svc-flow summary.............................................................................13-441
show cable qos svc-flow upstream-stat ......................................................................13-442
show cable spectrum-group........................................................................................13-443
show cable spectrum-group load-balance summary...................................................13-446
show cable spectrum-group map ................................................................................13-447
show cable spectrum-group modem-exclusion-list ....................................................13-449
show cable spectrum-group reference-modem...........................................................13-450
show cable spectrum-group snr-thresholds ................................................................13-451
show cable spectrum-group stats................................................................................13-452
show cable submgmt default ......................................................................................13-454
show cable sync-interval ............................................................................................13-455
show cable tcpudp-filter .............................................................................................13-456
show cable ucc-stats ...................................................................................................13-457
show cable ucd-interval..............................................................................................13-459
show cable ugs-stats ...................................................................................................13-460
show cable upstream...................................................................................................13-462
show cable upstream global-clock..............................................................................13-466
show controllers cable ds-mac....................................................................................13-467
show controllers cable ds-phy ....................................................................................13-471
show docsis-version....................................................................................................13-473
show docstest..............................................................................................................13-474
show interfaces cable..................................................................................................13-475
show interfaces cable bandwidth voice ......................................................................13-481
show interfaces cable configuration ...........................................................................13-483
show interfaces cable downstream .............................................................................13-485
show interfaces cable intercept...................................................................................13-488
show interfaces cable service-class ............................................................................13-490
show interfaces cable stats..........................................................................................13-493
show interfaces cable upstream ..................................................................................13-495
show interfaces cable upstream channel-agility-stats.................................................13-500
show running-config cable downstream port .............................................................13-502

xxx Compass ID: 327594480 Version 3


Release 5.2.1 Contents

show stats cmts ...........................................................................................................13-504


show stats summary error ...........................................................................................13-507
snr display...................................................................................................................13-509
snr loop .......................................................................................................................13-510
snr setup......................................................................................................................13-512
snr setup-get................................................................................................................13-514
snr setup-spare-mod-profile........................................................................................13-515
snr start .......................................................................................................................13-516
snr store ......................................................................................................................13-517
spectrum-copy ............................................................................................................13-518
spreader on..................................................................................................................13-519
tcm-encoding on .........................................................................................................13-520
time band ....................................................................................................................13-521
time delete ..................................................................................................................13-522
vendor-class-identifier ................................................................................................13-523

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

15 POS Commands
Introduction ...............................................................................................................................15-1
POS Command Descriptions.....................................................................................................15-2
aps force..........................................................................................................................15-3
aps group ........................................................................................................................15-4
aps lockout......................................................................................................................15-5
aps manual ......................................................................................................................15-6
aps protect.......................................................................................................................15-7
aps revert ........................................................................................................................15-8
aps signal-degrade ber threshold ....................................................................................15-9

Compass ID: 327594480 Version 3 xxxi


BSR 64000 Command Reference Guide Release 5.2.1

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

xxxii Compass ID: 327594480 Version 3


Release 5.2.1 Contents

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 bgp-community new-format.....................................................................................16-24
ip community-list..........................................................................................................16-26
match as-path................................................................................................................16-28
match community .........................................................................................................16-29
maximum-paths ............................................................................................................16-30
neighbor advertisement-interval...................................................................................16-31
neighbor confed-segment .............................................................................................16-32
neighbor default-originate ............................................................................................16-33
neighbor description .....................................................................................................16-34
neighbor distribute-list..................................................................................................16-35
neighbor ebgp-multihop ...............................................................................................16-36
neighbor filter-list .........................................................................................................16-37
neighbor maximum-prefix............................................................................................16-39
neighbor next-hop-self..................................................................................................16-41
neighbor password........................................................................................................16-42
neighbor peer-group (assigning members) ...................................................................16-43
neighbor peer-group (creating).....................................................................................16-44
neighbor remote-as .......................................................................................................16-45
neighbor remove-private-as..........................................................................................16-47
neighbor route-map ......................................................................................................16-48
neighbor route-reflector-client......................................................................................16-49

Compass ID: 327594480 Version 3 xxxiii


BSR 64000 Command Reference Guide Release 5.2.1

neighbor route-refresh ..................................................................................................16-50


neighbor send-community ............................................................................................16-51
neighbor shutdown .......................................................................................................16-52
neighbor soft-reconfiguration inbound.........................................................................16-53
neighbor timers.............................................................................................................16-54
neighbor update-source loopback.................................................................................16-56
neighbor weight ............................................................................................................16-57
network .........................................................................................................................16-58
redistribute....................................................................................................................16-59
route-map......................................................................................................................16-61
router bgp......................................................................................................................16-62
set as-path prepend .......................................................................................................16-63
set comm-list ................................................................................................................16-64
set community ..............................................................................................................16-66
set ip next-hop ..............................................................................................................16-68
set local-preference.......................................................................................................16-69
set metric-type ..............................................................................................................16-70
set origin .......................................................................................................................16-71
set tag............................................................................................................................16-72
set weight......................................................................................................................16-73
show ip as-path-access-list ...........................................................................................16-74
show ip bgp...................................................................................................................16-75
show ip bgp cidr-only ...................................................................................................16-77
show ip bgp community ...............................................................................................16-78
show ip bgp community-list .........................................................................................16-80
show ip bgp dampened-paths .......................................................................................16-81
show ip bgp flap-statistics ............................................................................................16-82
show ip bgp ipv4 unicast ..............................................................................................16-84
show ip bgp memory ....................................................................................................16-88
show ip bgp neighbors..................................................................................................16-90
show ip bgp next-hops..................................................................................................16-92
show ip bgp paths .........................................................................................................16-93
show ip bgp peer-group ................................................................................................16-94
show ip bgp regexp.......................................................................................................16-96

xxxiv Compass ID: 327594480 Version 3


Release 5.2.1 Contents

show ip bgp summary...................................................................................................16-97


show ip community-list ................................................................................................16-99
synchronization...........................................................................................................16-100
timers bgp ...................................................................................................................16-101

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
ip pim ssm.....................................................................................................................17-15
network .........................................................................................................................17-16
pim accept-rp ................................................................................................................17-17
pim graceful-restart restart-interval..............................................................................17-18
pim register-checksum..................................................................................................17-19
pim rp-address ..............................................................................................................17-20
pim unicast-route-lookup..............................................................................................17-22
router pim .....................................................................................................................17-23
show ip pim ..................................................................................................................17-24

Compass ID: 327594480 Version 3 xxxv


BSR 64000 Command Reference Guide Release 5.2.1

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 fp max ..................................................................................................................18-16
mpls ip ..........................................................................................................................18-17
mpls label range............................................................................................................18-18
mpls rsvp restart-lsp .....................................................................................................18-20
mpls ttl ..........................................................................................................................18-21
show fast-path ranges ...................................................................................................18-22
show ip rsvp explicit-routed-lsps..................................................................................18-23
show ip rsvp interface...................................................................................................18-24
show ip rsvp lsp ............................................................................................................18-25
show ip rsvp neighbor ..................................................................................................18-26
show ip rsvp reservation...............................................................................................18-27
show ip rsvp sender ......................................................................................................18-28
show ip rsvp statistics...................................................................................................18-29
show mpls filters...........................................................................................................18-30
show mpls forwarding-table .........................................................................................18-32
show mpls label range ..................................................................................................18-35
show mpls lsp ...............................................................................................................18-36
show mpls lsp interface ................................................................................................18-39
show mpls rsvp refresh-time ........................................................................................18-41
show mpls traffic ..........................................................................................................18-42

xxxvi Compass ID: 327594480 Version 3


Release 5.2.1 Contents

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-35
tos-overwrite.................................................................................................................19-37
trafpriority.....................................................................................................................19-38

Compass ID: 327594480 Version 3 xxxvii


BSR 64000 Command Reference Guide Release 5.2.1

ugs-stats-window..........................................................................................................19-39

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

xxxviii Compass ID: 327594480 Version 3


Release 5.2.1 Contents

cops pdp-ip ...................................................................................................................21-13


cops pep-id....................................................................................................................21-14
cops status-trap-enable .................................................................................................21-15
dqos dscp ......................................................................................................................21-16
dqos emergency-preempt..............................................................................................21-17
dqos emergency-trap-enable.........................................................................................21-18
dqos res-req-trap-enable ...............................................................................................21-19
dqos shutdown ..............................................................................................................21-20
dqos t0-timer/t1-timer...................................................................................................21-21
em dscp .........................................................................................................................21-22
em element-number ......................................................................................................21-23
em event-disable-mask .................................................................................................21-24
em event-priority ..........................................................................................................21-25
em flag-override ...........................................................................................................21-26
em max-batch-events....................................................................................................21-27
em max-batch-time.......................................................................................................21-28
em qos-descriptor-disable.............................................................................................21-29
em retry-count ..............................................................................................................21-30
em retry-interval ...........................................................................................................21-31
em rks-failure-trap-enable ............................................................................................21-32
em shutdown.................................................................................................................21-34
em udp-port ..................................................................................................................21-35
es...................................................................................................................................21-36
es ccc-dscp....................................................................................................................21-38
ike client-addr ...............................................................................................................21-39
ike phase1 .....................................................................................................................21-40
ike phase2 .....................................................................................................................21-41
ike retries ......................................................................................................................21-42
ike timeout ....................................................................................................................21-43
ipsec..............................................................................................................................21-44
ipsec shutdown .............................................................................................................21-45
mm dscp........................................................................................................................21-46
mm shutdown ...............................................................................................................21-47
mm t1-timer ..................................................................................................................21-48

Compass ID: 327594480 Version 3 xxxix


BSR 64000 Command Reference Guide Release 5.2.1

packet-cable..................................................................................................................21-49
show cable dynamic-service.........................................................................................21-50
show ipsec ....................................................................................................................21-51
show packet-cable configuration ..................................................................................21-54
show packet-cable cops ................................................................................................21-59
show packet-cable gate.................................................................................................21-61
show packet-cable statistics..........................................................................................21-64
spd allow-dynamic-rsp .................................................................................................21-69
spd override ..................................................................................................................21-70
spd policy......................................................................................................................21-71
spd preshared-key .........................................................................................................21-73

22 VLAN Tagging Commands


Introduction ...............................................................................................................................22-1
VLAN Tagging Command Descriptions...................................................................................22-1
bridge cable intercept .....................................................................................................22-2
bridge cable modem .......................................................................................................22-4
bridge mode trunk...........................................................................................................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

xl Compass ID: 327594480 Version 3


Release 5.2.1 Contents

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
show cable dsg vendor-param ......................................................................................23-22
timer..............................................................................................................................23-23
tunnel ............................................................................................................................23-25
vendor-param................................................................................................................23-27

24 IPDR Commands
Introduction ...............................................................................................................................24-1
Command Descriptions .............................................................................................................24-1
debug ipdr.......................................................................................................................24-2
ipdr acksequenceinterval ................................................................................................24-3
ipdr acktimeinterval........................................................................................................24-4
ipdr collection-interval ...................................................................................................24-5
ipdr collector...................................................................................................................24-6
ipdr enable ......................................................................................................................24-9
ipdr keepaliveinterval ...................................................................................................24-10
ipdr poll-rate .................................................................................................................24-11
ipdr source-interface.....................................................................................................24-12
show cable metering-status...........................................................................................24-13
show ipdr connection....................................................................................................24-15
show ipdr session..........................................................................................................24-16

25 Cable Traffic Management Commands


Introduction ...............................................................................................................................25-1
Command Descriptions .............................................................................................................25-1
bidirectional....................................................................................................................25-2
cable traffic sample-interval ...........................................................................................25-3
cable traffic policy ..........................................................................................................25-4

Compass ID: 327594480 Version 3 xli


BSR 64000 Command Reference Guide Release 5.2.1

clear cable traffic enforcement .......................................................................................25-6


clear cable traffic history ................................................................................................25-7
credit ...............................................................................................................................25-8
enabled..........................................................................................................................25-10
enforce ..........................................................................................................................25-12
max-rate........................................................................................................................25-14
peak-time ......................................................................................................................25-16
penalty-period...............................................................................................................25-18
show cable subscriber-usage ........................................................................................25-20
show cable subscriber-usage summary.........................................................................25-26
show cable traffic policy ..............................................................................................25-29

26 IPv6 Commands
Introduction ...............................................................................................................................26-1
IPv6 Command Descriptions ....................................................................................................26-1
cable ipv6 helper-address ...............................................................................................26-2
cable ip prov-mode .........................................................................................................26-4
clear ipv6 neighbor-cache...............................................................................................26-6
clear ipv6 traffic .............................................................................................................26-7
ipv4 range .......................................................................................................................26-8
ipv6 address ....................................................................................................................26-9
ipv6 helper-address.......................................................................................................26-11
ipv6 icmp error-interval................................................................................................26-12
ipv6 nd ..........................................................................................................................26-13
ipv6 neighbor................................................................................................................26-15
ipv6 range .....................................................................................................................26-16
ipv6 redirects ................................................................................................................26-17
ipv6 route......................................................................................................................26-18
ipv6 unicast-routing......................................................................................................26-19
ping6 .............................................................................................................................26-20
service ipv6 cpe-forwarding enable..............................................................................26-21
show ipv6 dhcp.............................................................................................................26-22
show ipv6 interface.......................................................................................................26-24
show ipv6 interface brief ..............................................................................................26-27

xlii Compass ID: 327594480 Version 3


Release 5.2.1 Contents

show ipv6 neighbor ......................................................................................................26-29


show ipv6 route ............................................................................................................26-31
show ipv6 traffic...........................................................................................................26-33
traceroute6 ....................................................................................................................26-36

27 IS-IS Commands
Introduction ...............................................................................................................................27-1
IS-IS Command Descriptions....................................................................................................27-1
area-password .................................................................................................................27-2
authentication mode........................................................................................................27-3
clear isis ..........................................................................................................................27-4
default-information originate..........................................................................................27-5
distance ...........................................................................................................................27-6
domain-password............................................................................................................27-7
hello padding ..................................................................................................................27-8
ignore-lsp-errors .............................................................................................................27-9
ip router isis ..................................................................................................................27-10
isis authentication mode ...............................................................................................27-11
isis circuit-type .............................................................................................................27-12
isis csnp-interval...........................................................................................................27-13
isis hello padding..........................................................................................................27-14
isis hello-interval ..........................................................................................................27-15
isis hello-multiplier.......................................................................................................27-16
isis lsp-interval..............................................................................................................27-17
isis message-digest-key ................................................................................................27-18
isis metric......................................................................................................................27-19
isis network point-to-point ...........................................................................................27-20
isis password.................................................................................................................27-21
isis priority....................................................................................................................27-22
isis retransmit-interval ..................................................................................................27-23
isis retransmit-throttle-interval .....................................................................................27-24
is-type ...........................................................................................................................27-25
log-adjacency-changes .................................................................................................27-26
lsp-gen-interval.............................................................................................................27-27

Compass ID: 327594480 Version 3 xliii


BSR 64000 Command Reference Guide Release 5.2.1

lsp-refresh-interval .......................................................................................................27-28
max-lsp-lifetime ...........................................................................................................27-29
maximum-paths ............................................................................................................27-30
message-digest-key md5 ..............................................................................................27-31
metric-style ...................................................................................................................27-32
net .................................................................................................................................27-33
passive-interface ...........................................................................................................27-34
redistribute....................................................................................................................27-35
router isis ......................................................................................................................27-37
set-overload-bit.............................................................................................................27-38
show clns interface .......................................................................................................27-39
show clns is-neighbors .................................................................................................27-42
show clns neighbors .....................................................................................................27-44
show clns protocol........................................................................................................27-46
show clns traffic ...........................................................................................................27-48
show ip redistribute ......................................................................................................27-51
show isis database.........................................................................................................27-53
show isis hostname .......................................................................................................27-56
show isis neighbors.......................................................................................................27-57
show isis spf-log ...........................................................................................................27-59
show isis topology ........................................................................................................27-64
summary-address..........................................................................................................27-66

Index

xliv Compass ID: 327594480 Version 3


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: 327594480 Version 3 xlv


BSR 64000 Command Reference Guide Release 5.2.1

■ 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

ii-xlvi Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 ii-xlvii


BSR 64000 Command Reference Guide Release 5.2.1

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.

ii-xlviii Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 ii-xlix


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: 327594480 Version 3 1-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-11


BSR 64000 Command Reference Guide Release 5.2.1

none no method is specified as the authorization


method
tacacs TACACS+ to be used as the authorization
method

1-12 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-21


BSR 64000 Command Reference Guide Release 5.2.1

carriage-return-lf-mode
The carriage-return-lf-mode command controls the order of the carriage return and
linefeed sequence. When enabled, the carriage return will be output before the
linefeed. When disabled, the linefeed will be output before the carriage return.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


carriage-return-lf-mode {disable | enable}

Command Syntax

disable disables carriage return then linefeed


mode
enable enables carriage return then linefeed
mode

Command Default
Disabled

1-22 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-23


BSR 64000 Command Reference Guide Release 5.2.1

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

1-24 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-25


BSR 64000 Command Reference Guide Release 5.2.1

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

1-26 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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 Table

Compass ID: 327594480 Version 3 1-27


BSR 64000 Command Reference Guide Release 5.2.1

Table 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 spafft Spectrum Agent FFT
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 svcflo
lbm2 Load Balancing 2nd Service Flow
em PacketCable Event cra
Table CRA
Message
lbmsnr Load Balacing SNR cra2 CRA SNR
lbgmgr Load Balance Manage
cms Cable Modem bcm1 Broadcom 3138 Driver
drm DOCSIS Redundancy
Selector bcmmac Broadcom 3212 Driver
Manager
acc ACC pream Preamble
drme DOCSIS Redundancy
accpkt ACC Packet upcmot Upconverter Motorola
Manager Engine

1-28 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-29


BSR 64000 Command Reference Guide Release 5.2.1

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

1-30 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-31


BSR 64000 Command Reference Guide Release 5.2.1

clock summer-time
The clock summer-time command provides the BSR system administrator with the
ability to adjust when the BSR will change the system clock offset for the start and
end of daylight saving time.
The Energy Policy Act of 2005 (H.R.6.ENR), Section 110 changes the start date of
daylight saving time from the first Sunday of April to the second Sunday of March
and changes the end date of daylight saving time from the last Sunday of October to
the first Sunday of November. Starting in 2007, this new rule may cause the BSR to
generate timestamps (such as in syslog messages) that are inaccurate if the time is not
adjusted by the administrator or this command.
The clock summer-time command changes the BSR clock offset from Greenwich
Mean Time at the start and end times specified in the command. The no clock
summer-time command restores the default daylight saving time configuration.
The following command example sets the correct daylight saving time changes as
specified by the Energy Policy Act of 2005:
BSR:7A(config:)#clock summer-time EDT 60 start 2 sun mar 2:00 end first sun
nov 2:00

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


clock summer-time <WORD> <1-1440> start {{<1-4> | first | last} <day>
<MONTH> <hh:mm>} end {{<1-4> | first | last} <day> <MONTH> <hh:mm>}
clock summer-time <WORD> <1-1440> start {<1-31> <MONTH> <hh:mm>} end
{<1-31> <MONTH> <hh:mm>}
clock summer-time <WORD> <1-1440> start {<MONTH> <1-31> <hh:mm>} end
{<MONTH> <1-31> <hh:mm>}
no clock summer-time

1-32 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Note: The clock summer-time command arguments used after the start
argument must be mirrored by the command arguments available after the
end argument. For example:

clock summer-time est 60 start 11 mar 10:30 end 4 nov 03:30

clock summer-time EDT 60 start 2 sun mar 2:00 end first sun nov 2:00

Command Syntax

WORD the name of the time zone during daylight


savings time
1-1440 minute offset to be added during daylight
savings time
start the start of day light savings time
1-31 the day of the month
1-4 the week of the month
MONTH the month of the year (3 letter abbreviation)
day the day of the week (3 letter abbreviation)
hh:mm the time of day that daylight savings time
starts
first the first week of the month
last the last week of the month
end the end of daylight savings time

Compass ID: 327594480 Version 3 1-33


BSR 64000 Command Reference Guide Release 5.2.1

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.

1-34 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-35


BSR 64000 Command Reference Guide Release 5.2.1

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

1-36 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-37


BSR 64000 Command Reference Guide Release 5.2.1

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

1-38 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-39


BSR 64000 Command Reference Guide Release 5.2.1

copy core
The copy core command copies an SRM core file to a remote FTP host. This feature
provides for effective debugging by allowing a review of the exact state of the BSR
prior to a software failure.

Warning: The copy core command is for debugging purposes only and
should be used under the guidance of Motorola technical support staff.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


copy core [<NUM> [ ftp ]]

Command Syntax

NUM the slot number of the SRM module


ftp copy core file to ftp: filesystem

1-40 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

core
The core command allows a user to configure memory core dump options.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


core {compression <0-9> | path <WORD> | protocol ftp | server <WORD>}
no core {path <WORD> | server <WORD>}

Command Syntax

compression 0-9 the core dump compression level - "0"


indicates compression is disabled while "9"
indicates the maximum compression level
path WORD the path to the core dump file on a target core
dump server
protocol ftp the FTP network protocol will be used to
transfer core dump files
server WORD the core dump target server’s IP address or
hostname

Compass ID: 327594480 Version 3 1-41


BSR 64000 Command Reference Guide Release 5.2.1

datapath keepalive
The datapath keepalive command is enabled by default to protect the data path on
redundant 2:8 CMTS modules. A CMTS module is reset after 100 datapath ICP
keepalive message failures. This threshold may be reconfigured using the threshold
argument. The no datapath keepalive command disables this feature.

Group Access
MSO

Command Mode
Slot Configuration

Command Line Usage


datapath keepalive {monitor | slot-reset} [threshold <5-255>]
no datapath keepalive

Command Syntax

monitor monitor the status


slot-reset reset the CMTS module after the threshold of
ICP keepalive failures is reached
threshold 5-255 the number of ICP keepalive failures
permitted before resetting the CMTS module

Command Default
slot-reset threshold = 100

1-42 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

datapath pause enable


The datapath pause enable command enables FPGA PAUSE frames on the 2:8
CMTS module. The no datapath pause enable command disables FPGA PAUSE
frames.

Note: Only use the datapath pause enable command when directed to do
so by Motorola Support.

Group Access
MSO

Command Mode
Slot Configuration

Command Line Usage


datapath pause enable
no datapath pause enable

Command Default
Enabled

Compass ID: 327594480 Version 3 1-43


BSR 64000 Command Reference Guide Release 5.2.1

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

1-44 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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.

Compass ID: 327594480 Version 3 1-45


BSR 64000 Command Reference Guide Release 5.2.1

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

1-46 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-47


BSR 64000 Command Reference Guide Release 5.2.1

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

1-48 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-49


BSR 64000 Command Reference Guide Release 5.2.1

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

1-50 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-51


BSR 64000 Command Reference Guide Release 5.2.1

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

1-52 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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.

Compass ID: 327594480 Version 3 1-53


BSR 64000 Command Reference Guide Release 5.2.1

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

1-54 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-55


BSR 64000 Command Reference Guide Release 5.2.1

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

1-56 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-57


BSR 64000 Command Reference Guide Release 5.2.1

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

1-58 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-59


BSR 64000 Command Reference Guide Release 5.2.1

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

1-60 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-61


BSR 64000 Command Reference Guide Release 5.2.1

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

1-62 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

hsim4 slot
The hsim4 slot command sets the mode in which the Ether-Flex module operates. If
this command is not configured for a given slot, the default is for the module to
operate in Gigabit Ethernet mode. Once this command is used, you must reset the
configured slot for the module to operate in the newly selected mode. As a reminder,
each time you use this command, the following warning message displays on the
console:
%Warning: You must reset slot <num> in order for the
configuration to take effect.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


hsim4 slot <0-5, 9-15> {gigaether | ethernet}

Command Syntax

0-5, 9-15 The slot number of the Ether-Flex module.


Ether-Flex modules cannot be installed in
slots 6, 7 and 8.
gigaether Gigabit Ethernet mode
ethernet Ethernet mode

Compass ID: 327594480 Version 3 1-63


BSR 64000 Command Reference Guide Release 5.2.1

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.

1-64 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-65


BSR 64000 Command Reference Guide Release 5.2.1

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-66 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-67


BSR 64000 Command Reference Guide Release 5.2.1

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-68 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-69


BSR 64000 Command Reference Guide Release 5.2.1

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-70 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-71


BSR 64000 Command Reference Guide Release 5.2.1

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-72 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-73


BSR 64000 Command Reference Guide Release 5.2.1

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-74 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Command Syntax

1-300 the load interval timer value in minutes

Command Default
5 minutes

Compass ID: 327594480 Version 3 1-75


BSR 64000 Command Reference Guide Release 5.2.1

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 - up to 8


SYSLOG servers can be specified

1-76 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-77


BSR 64000 Command Reference Guide Release 5.2.1

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-78 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-79


BSR 64000 Command Reference Guide Release 5.2.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)
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-80 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-81


BSR 64000 Command Reference Guide Release 5.2.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)
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-82 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-83


BSR 64000 Command Reference Guide Release 5.2.1

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-84 Compass ID: 327594480 Version 3


Release 5.2.1 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 command 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: 327594480 Version 3 1-85


BSR 64000 Command Reference Guide Release 5.2.1

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 command 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-86 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-87


BSR 64000 Command Reference Guide Release 5.2.1

logging disable bpi_tek_invalid_messages


The logging disable bpi_tek_invalid_messages command disables logging of the
"BPI TEK Invalid" DOCSIS error message. The no logging disable
bpi_auth_reject_messages command 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_tek_invalid_messages


no logging disable bpi_tek_invalid_messages

Command Default
Logging of BPI TEK Invalid messages is enabled by default.

1-88 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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 command 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.

Compass ID: 327594480 Version 3 1-89


BSR 64000 Command Reference Guide Release 5.2.1

logging disable dcc_arrive_new_c203_0


logging disable dcc_depart_old_c202_0
With Dynamic Load Balancing configured, there can be too many DCC transactions
on a large system. The console or log buffer can be easily flooded with the following
OSSI Event Messages (error codes C202.0 and C203.0) which are defined as a Notice
priority by the OSSI specification:
[06/28-07:50:40.88- 11:CMTSMAC]<133>CMTS[DOCSIS]:<67020200>DCC
depart old (CM 0011.8092.e47c, US:5)
[06/28-07:50:41.26- 11:CMTSMAC]<133>CMTS[DOCSIS]:<67020300>DCC
arrive new (CM 0011.8092.e47c, US:4)
The logging disable dcc_arrive_new_c203_0 and logging disable
dcc_depart_old_c202_0 commands disable the logging of these messages. The no
logging disable dcc_arrive_new_c203_0 and no logging disable
dcc_depart_old_c202_0 commands enable the logging of these messages.

Group Access
System Administrator

Command Mode
Global Configuration

Command Defaults
Enabled

1-90 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

logging disable securityuser-login


The logging disable securityuser-login command disables the logging of Legal
Intercept securityuser login/logout transactions to the SYSLOG. The no logging
disable securityuser-login enables the logging of securityuser login/logout
transactions.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


logging disable securityuser-login
no logging disable securityuser-login

Compass ID: 327594480 Version 3 1-91


BSR 64000 Command Reference Guide Release 5.2.1

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'

1-92 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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.

Group Access
All

Command Mode
Global Configuration

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'

Compass ID: 327594480 Version 3 1-93


BSR 64000 Command Reference Guide Release 5.2.1

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

1-94 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-95


BSR 64000 Command Reference Guide Release 5.2.1

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

1-96 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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)

Compass ID: 327594480 Version 3 1-97


BSR 64000 Command Reference Guide Release 5.2.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)
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

1-98 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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).

Compass ID: 327594480 Version 3 1-99


BSR 64000 Command Reference Guide Release 5.2.1

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

1-100 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-101


BSR 64000 Command Reference Guide Release 5.2.1

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)

1-102 Compass ID: 327594480 Version 3


Release 5.2.1 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)

Compass ID: 327594480 Version 3 1-103


BSR 64000 Command Reference Guide Release 5.2.1

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.

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>

Command Syntax

1-255 the loopback interface number

1-104 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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)

Compass ID: 327594480 Version 3 1-105


BSR 64000 Command Reference Guide Release 5.2.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)
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)

1-106 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-107


BSR 64000 Command Reference Guide Release 5.2.1

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

1-108 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-109


BSR 64000 Command Reference Guide Release 5.2.1

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

1-110 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-111


BSR 64000 Command Reference Guide Release 5.2.1

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} | 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} | 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

1-112 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-113


BSR 64000 Command Reference Guide Release 5.2.1

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

1-114 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-115


BSR 64000 Command Reference Guide Release 5.2.1

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-116 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-117


BSR 64000 Command Reference Guide Release 5.2.1

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.

1-118 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

patch install
The BSR supports a maximum of 16 unique patch files. A patch file can be configured
through the CLI and then displayed in the running-config file. Once the
running-config file is copied to the startup-config file, the patches are persistently
applied to the BSR chassis.
The patch install command applies text patch files to the BSR chassis or to a
specified slot in the BSR chassis. The SRM copies the specified patch file to all the
running modules. Once a module receives the patch file and a patch indicate message,
the module begins the patching process. The patching process involves opening the
patch file and determining whether the patch file is compatible with the module’s
system version. If the patch file is compatible with the module’s system version, the
patch file is executed on the module. The patch install slot command executes the
patching process on a single module.
The no patch install command removes a patch from the BSR chassis or from a
specified slot in the BSR chassis.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


patch install {flash: | nvram:} {<filename>} [slot <NUM>]
no patch install {flash: | nvram:} {<filename>} [slot <NUM>]

Command Syntax

flash: Specifies flash memory as the location of the


patch file.
nvram: Specifies Non-volatile Random Access
Memory (NVRAM) as the location of the
patch file.
filename Patch filename stored in Flash or NVRAM.
slot NUM The BSR slot number.

Compass ID: 327594480 Version 3 1-119


BSR 64000 Command Reference Guide Release 5.2.1

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-120 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-121


BSR 64000 Command Reference Guide Release 5.2.1

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-122 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-123


BSR 64000 Command Reference Guide Release 5.2.1

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-124 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Command Default
redundancy enabled

Compass ID: 327594480 Version 3 1-125


BSR 64000 Command Reference Guide Release 5.2.1

redundancy dtx
The redundancy dtx command enables TX32 redundancy protection for a Primary
TX32. The slot number of the Primary TX32 must be in the range 0..5 or 9..14. Slots
7 and 8 are reserved for SRM modules, slot 6 is reserved for a standby CMTS, and
slot 15 does not support the necessary backplane signals.
The no redundancy cmts command disables TX32 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 TX32 modules.

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


configuration to the startup configuration with the copy running-config
startup-config command so that these changes are maintained whenever
any primary module switches over to a redundant module or is restored back
to a primary module.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


redundancy dtx {<X> | reset-after-switchover }
no redundancy dtx {<X> | reset-after-switchover }

Command Syntax

X the TX32 slot number


reset-after-switchover enables resetting a surrendering TX32 card
following a manual switchover

Command Defaults
redundancy enabled
reset-after-switchover = disabled

1-126 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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>

Compass ID: 327594480 Version 3 1-127


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

NUM the BSR 64000 CMTS slot number

1-128 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

redundancy force-switchover dtx


The redundancy force-switchover dtx command forces a Primary TX32 module to
switchover to the Standby TX32 module that provides redundancy for it..

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


configuration to the startup configuration with the copy running-config
startup-config command so that these changes are maintained whenever
any primary module switches over to a redundant module or is restored back
to a primary module.

Only users with read/write privileges are allowed to use the redundancy
force-switchover dtx 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 dtx <NUM>

Command Syntax

NUM the TX32 slot number

Compass ID: 327594480 Version 3 1-129


BSR 64000 Command Reference Guide Release 5.2.1

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-130 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-131


BSR 64000 Command Reference Guide Release 5.2.1

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.

Note: The reload switched command checks to determine if redundancy is


enabled for all slots. If any CMTS slot is not enabled for redundancy, a
warning message appears.

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-132 Compass ID: 327594480 Version 3


Release 5.2.1 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
Privileged EXEC

Command Line Usage


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

Compass ID: 327594480 Version 3 1-133


BSR 64000 Command Reference Guide Release 5.2.1

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-134 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-135


BSR 64000 Command Reference Guide Release 5.2.1

remote copy
The remote copy command provides the ability to copy a file from an external File
Transport Protocol (FTP) server to a remote module such as the CMTS 2:8 or TX32.
The remote copy command also provides the ability to copy a file from a remote
module to an external FTP server.
The following example copies the cmts2x8_ar.z file from an FTP server onto BSR slot
4's filesystem:
MOT:7A# remote copy ftp://10.14.37.195/mgi515/cmts2x8_ar.z slot 4
cmts2x8_ar.z
The following example copies the cmts2x8_ar.z file from BSR slot 4's filesystem onto
an FTP server:
MOT:7A# remote copy slot 4 cmts2x8_ar.z ftp://10.14.37.195/mgi515/
cmts2x8_ar.z

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


remote copy ftp: <filesystem> slot <NUM> [<WORD> [gateway <A.B.C.D>]]
[gateway <A.B.C.D>]
remote copy slot <NUM> <WORD> ftp: [gateway <A.B.C.D>]

Command Syntax

ftp: filesystem Copy the configuration file from an


FTP server.
slot NUM Copy the configuration file from a
FTP server BSR slot number.

1-136 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

WORD Destination filename or file to be


copied.
gateway A.B.C.D Specifies a port-forwarding
gateway’s local logical interface’s IP
address.

Compass ID: 327594480 Version 3 1-137


BSR 64000 Command Reference Guide Release 5.2.1

remote delete slot


remote rm slot
The remote delete slot and remote rm slot commands delete a specified file on a
specified BSR slot.

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


remote delete slot <NUM> <WORD>
remote rm slot <NUM> <WORD>

Command Syntax

NUM The BSR slot number.


WORD The filename of the file to be
deleted.

1-138 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

remote dir slot


remote ls slot
The remote dir slot and remote ls slot commands display a list of filenames, creation
dates, file sizes and space available on a filesystem. The following is typical screen
output from the remote dir slot and remote ls slot commands:

Directory of Slot 11:

8667918 Tue Jun 23 09:59:44 2009 tx.bin


2097148 Mon Jun 22 13:57:37 2009 eventlog8.mer
2097148 Mon Jun 22 16:08:53 2009 eventlog9.mer
2097148 Tue Jun 23 10:03:27 2009 eventlog1.mer
5230 Thu Jan 15 15:13:43 2009 tx32_qrm_eeprom.hex
129356 Thu Jan 15 15:14:06 2009 tx32_qrm_flash.hex
1144176 Thu Jan 15 15:14:51 2009 tx32_qrm_fpga.cbt
0 Fri Jan 16 15:29:42 2009 core_dsphy.Initial_01
0 Thu Feb 05 12:16:46 2009 core_ProcessTask_01
0 Fri Jan 16 15:16:16 2009 core_dsphy.Initial_04
0 Fri Jan 16 15:19:49 2009 core_dsphy.Initial_05
0 Fri Jan 16 15:26:13 2009 core_dsphy.Initial_06

Number of Files: 12

Kbytes Used Avail Use%


------ ---- ----- ----
50495 15919 34576 31 %

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


remote dir slot <NUM>
remote ls slot <NUM>

Compass ID: 327594480 Version 3 1-139


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

NUM The BSR slot number.

1-140 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-141


BSR 64000 Command Reference Guide Release 5.2.1

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

1-142 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-143


BSR 64000 Command Reference Guide Release 5.2.1

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)

1-144 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-145


BSR 64000 Command Reference Guide Release 5.2.1

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%

1-146 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-147


BSR 64000 Command Reference Guide Release 5.2.1

gige Gigabit Ethernet statistics


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

1-148 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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}]

Compass ID: 327594480 Version 3 1-149


BSR 64000 Command Reference Guide Release 5.2.1

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

1-150 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-151


BSR 64000 Command Reference Guide Release 5.2.1

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

1-152 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-153


BSR 64000 Command Reference Guide Release 5.2.1

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

1-154 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

show chassis status


The show chassis status command displays the operational status and twhe type of
modules that are installed in the BSR. The following information is provided:

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 - 2X8 CMTS, ETH1, ETH8, etc.
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. stby indicates that the
module is in standby mode
RM resource module. An x indicates that this module is operational.
A - (dash) indicates that this module is not currently operational
IO 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: 327594480 Version 3 1-155


BSR 64000 Command Reference Guide Release 5.2.1

The following is an example of typical screen output from the show chassis status
command: For Release 5.0.0, the show chassis status command has been enhanced
with the TX32 module type and operational status. The following is typical screen
output from the show chassis status command:

Current Time: 11/19-06:43:15


Running archive: NVRAM:500T00P01.Z

Slot Type Sub Red State RM IO UpTime LastUpTime Success Failure


0 - - - - 0 0
1 - - - - 0 0
2 CMTS 2x8(2.0) - RUN x x 0w2d16h 1 1
3 - - - - 0 0
4 - - - x 0 0
5 CMTS 2x8 - RUN x x 0w2d16h 1 1
6 CMTS 2x8(2.0) - stby x x 0w2d16h 0 1
7 SRM4 - RUN x x 0w2d16h 0 0
8 - - - - 0 0
9 - - - - TX32 Module 0 0
10 - - - - 0 0
11 DTX TX32 - RUN x x 0w2d16h 1 1
12 - - - x 0 0
13 - - - x 0 0
14 HSIM MMGE - RUN x x 0w2d16h 1 1
15 HSIM ETH8 - RUN x x 0w2d16h 1 1

1-156 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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.

Note: After an SRM switchover, the show chassis status command output
may display an inaccurate uptime value for SRM4 modules in the BSR
chassis. This should not otherwise affect system performance.

For BSR 64000 systems with an SRM4, a file called timezone is


automatically created in NVRAM to store the system clock time zone
information configured with the clock set and clock timezone commands.

The timezone file should not be deleted. If the file is removed for any reason,
then the system clock and time zone configuration must be re-entered using
the clock set and clock timezone commands and verified using the show
clock command.

Compass ID: 327594480 Version 3 1-157


BSR 64000 Command Reference Guide Release 5.2.1

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}]

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

1-158 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-159


BSR 64000 Command Reference Guide Release 5.2.1

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

1-160 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-161


BSR 64000 Command Reference Guide Release 5.2.1

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>]

1-162 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Command Syntax

NUM the chassis slot number


WORD the name of an EVT group - refer to the table
below.

Compass ID: 327594480 Version 3 1-163


BSR 64000 Command Reference Guide Release 5.2.1

Table 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 spafft Spectrum Agent FFT
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 svcflo
lbm2 Load Balancing 2nd Service Flow
em PacketCable Event cra
Table CRA
Message
lbmsnr Load Balacing SNR cra2 CRA SNR
lbgmgr Load Balance Manage
cms Cable Modem bcm1 Broadcom 3138 Driver
drm DOCSIS Redundancy
Selector bcmmac Broadcom 3212 Driver
Manager
acc ACC pream Preamble
drme DOCSIS Redundancy
accpkt ACC Packet upcmot Upconverter Motorola
Manager Engine

1-164 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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>}]

Compass ID: 327594480 Version 3 1-165


BSR 64000 Command Reference Guide Release 5.2.1

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-166 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-167


BSR 64000 Command Reference Guide Release 5.2.1

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-168 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-169


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

show log
The show log command displays message logging in the log file, the oldest 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]-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

Command Mode
All modes except User EXEC

Compass ID: 327594480 Version 3 1-171


BSR 64000 Command Reference Guide Release 5.2.1

Command Line Usage


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

1-172 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Command Syntax

chronological displays the log file from the oldest


entry to the newest entry - this is the
reverse of using the show log
command without options
security displays security privilege
information
Note: the security option is only
available to a user logged in as
securityuser - refer to Configuring
Cable Intercepts in the BSR 64000
CMTS Configuration and
Management Guide
| 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: 327594480 Version 3 1-173


BSR 64000 Command Reference Guide Release 5.2.1

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-174 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-175


BSR 64000 Command Reference Guide Release 5.2.1

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-176 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show logging reporting

Compass ID: 327594480 Version 3 1-177


BSR 64000 Command Reference Guide Release 5.2.1

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-178 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-179


BSR 64000 Command Reference Guide Release 5.2.1

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-180 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-181


BSR 64000 Command Reference Guide Release 5.2.1

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-182 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-183


BSR 64000 Command Reference Guide Release 5.2.1

show patches-installed
The show patches-installed command displays all slots in the BSR chassis that have
patches installed and descriptions of these patches. The show patches-installed slot
command displays only the names of the patches on a particular slot and the
timestamp for when the patch was installed on that slot.
The following is an example of typical screen output from the show
patches-installed command:

Slot Patch File Description


0 patch_cq40400 CQ40400 Patch Text File
0 patch_cq40420 CQ40400 Patch Text File
7 patch_cq40400 CQ40400 Patch Text File
7 patch_cq40420 CQ40400 Patch Text File
14 patch_cq40400 CQ40400 Patch Text File
14 patch_cq40420 CQ40400 Patch Text File
15 patch_cq40420 CQ40400 Patch Text File

The following is an example of typical screen output from the show


patches-installed slot command:

Slot 14
patch_cq40400 Installed on 04/30 at 12:06:59

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


show patches-installed [slot <NUM>]

1-184 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Command Syntax

slot NUM The BSR slot number.

Compass ID: 327594480 Version 3 1-185


BSR 64000 Command Reference Guide Release 5.2.1

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-186 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-187


BSR 64000 Command Reference Guide Release 5.2.1

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-188 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-189


BSR 64000 Command Reference Guide Release 5.2.1

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:
2x8 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: 2x8 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-190 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-191


BSR 64000 Command Reference Guide Release 5.2.1

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-192 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Command Default
frequency = 60 Hz

Compass ID: 327594480 Version 3 1-193


BSR 64000 Command Reference Guide Release 5.2.1

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-194 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-195


BSR 64000 Command Reference Guide Release 5.2.1

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-196 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-197


BSR 64000 Command Reference Guide Release 5.2.1

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-198 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-199


BSR 64000 Command Reference Guide Release 5.2.1

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-200 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-201


BSR 64000 Command Reference Guide Release 5.2.1

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

Slot the slots configured for redundancy


Sub Type the type of module installed in the slot
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 for another slot
Red Slot the redundant slot providing redundancy
protection for this slot
Primary Slot the context in which this module slot is
active:
• when a primary module slot is active, the
slot number indicated is the same as a
primary module slot
• when a standby module slot is active, the
primary slot for which the standby module
is running is indicated
Logging Status full indicates that TX32 information has been
fully replicated to the Standby TX32 module
for this slot

inactive indicates that the TX32 is not


running or has no redundant slot to which to
replicate.

partial indicates that replication is currently


underway - a TX32 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.

1-202 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Manual Takeovers the number of operator-requested takeovers


Auto-takeovers the number of takeovers prompted by a TX32
module failure, reset, or de-insertion - each
takeover count represents the number of times
that a slot has been taken over
Unavailable Time the time in dd:mm:ss since the last chassis
boot when the Primary TX32 Module was not
active and the Standby TX32 Module did not
takeover for it
Time Since Failover the time in dd:mm:ss since the Standby TX32
Module has taken over for the Primary TX32
Module
PLL the status of the phase lock loop between the
CMTS 2:8 and the TX32

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

Pri- Manual Auto Time


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

2 2x8E(2.0)RUN - 2 inactive 0 0 0:00:00 0:00:00 Ok


3 TX32 RUN 4 3 full 0 1 0:06:14 5:37:03 Ok
4 TX32 stby - - inactive 0 0 0:00:00 0:00:00 Ok
5 TX32 RUN 4 5 full 0 0 0:00:00 0:00:00 Ok
6 2x8(2.0) stby - - inactive 0 0 0:00:00 0:00:00 Ok
7 SRM3 RUN 8 7 NA 0 0 NA 0:00:00 n/a
8 SRM3 stby - 7 NA 0 0 NA 0:00:00 n/a
9 2x8(2.0) RUN - 9 inactive 0 0 0:00:00 0:00:00 Loss
10 2x8 RUN 6 10 full 0 0 0:00:00 0:00:00 Ok
11 2x8(2.0) RUN 6 11 full 0 0 0:00:00 0:00:00 Ok
12 2x8(2.0) RUN 6 12 full 0 0 0:00:00 0:00:00 Ok
13 2x8(2.0) RUN 6 13 full 0 0 0:00:00 0:00:00 Ok

Compass ID: 327594480 Version 3 1-203


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show redundancy [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show redundancy [ | {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-204 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-205


BSR 64000 Command Reference Guide Release 5.2.1

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:

1-206 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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 2x8 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

Compass ID: 327594480 Version 3 1-207


BSR 64000 Command Reference Guide Release 5.2.1

count count the number of outputted lines


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

1-208 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

show redundancy dtx


The show redundancy dtx command displays the BSR redundancy configuration for
TX32 modules in the BSR chassis. The following information is displayed:

DTX Slot the TX32 slots configured for TX32


redundancy
Sub Type the type of TX32 module installed in the slot
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 for another slot
Red Slot the redundant slot providing redundancy
protection for this slot
Primary Slot the context in which this Primary TX32
module slot is active:
• when a Primary TX32 module slot is
active, the slot number indicated is the
same as a Primary TX32 module slot
• when a Standby TX32 module slot is
active, the Primary TX32 module slot for
which the Standby TX32 module is
running is indicated

Compass ID: 327594480 Version 3 1-209


BSR 64000 Command Reference Guide Release 5.2.1

Logging Status full indicates that TX32 information has been


fully replicated to the Standby TX32 module
for this slot

inactive indicates that the TX32 is not


running or has no redundant slot to which to
replicate.

partial indicates that replication is currently


underway - a TX32 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 TX32
module failure, reset, or de-insertion - each
takeover count represents the number of times
that a slot has been taken over
Unavailable Time the time in dd:mm:ss since the last chassis
boot when the Primary TX32 Module was not
active and the Standby TX32 Module did not
takeover for it
Time Since Failover the time in dd:mm:ss since the Standby TX32
Module has taken over for the Primary TX32
Module
PLL the status of the phase lock loop between the
CMTS 2:8 and the TX32

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

1-210 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Pri- Manual Auto Time


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

3 TX32 RUN 4 3 full 0 1 0:06:14 9:36:22 Ok


4 TX32 stby - - inactive 0 0 0:00:00 0:00:00 Ok
5 TX32 RUN 4 5 full 0 0 0:00:00 0:00:00 Ok

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show redundancy dtx [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show redundancy dtx [ | {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: 327594480 Version 3 1-211


BSR 64000 Command Reference Guide Release 5.2.1

show redundancy srm


The show redundancy srm command tracks takeover statistics on the SRM module
in a chassis. When a manual or an automatic takeover occurs, this will be reflected in
the statistics for that SRM module by showing an increase in takeovers for the
respective field on the respective module (the one that was just taken over). The
command displays the SRM module slot number, subtype, status, redundant slot
number, primary slot number, number of manual takeovers, number of automatic
takeovers, and the time since its last failover. The time since failover on a certain
module will display the amount of time since the respective module was last taken
over. The following displays typical screen output for the show redundancy srm
command:

Pri- Manual Auto Time


SRM Sub Slot Red mary Take- Take- Since
Slot Type Status Slot Slot overs overs Failover

7 SRM3 RUN - 7 0 0 0:00:00

Group Access
All

Command Mode
All modes except for User EXEC mode

Command Line Usage


show redundancy srm [ | {begin | exclude | include} {<WORD>} [ | {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

1-212 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

WORD the specified string


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

Compass ID: 327594480 Version 3 1-213


BSR 64000 Command Reference Guide Release 5.2.1

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.

Last reload reason: power reset


No reload is scheduled

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show reload

1-214 Compass ID: 327594480 Version 3


Release 5.2.1 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}]
show running-config security [ | {begin | exclude | include} {<WORD>} [ | {count
| count-only}]]
show running-config security [ | {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

Compass ID: 327594480 Version 3 1-215


BSR 64000 Command Reference Guide Release 5.2.1

pos X/Y the Packet over SONET slot and port number on the
BSR
tunnel 0-255 the tunnel interface number
verbose runs the show running-config command in verbose
mode
security displays security privilege information
Note: the security option is only available to a user
logged in as securityuser - refer to Configuring Cable
Intercepts in the BSR 64000 CMTS Configuration and
Management Guide
| 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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-217


BSR 64000 Command Reference Guide Release 5.2.1

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-218 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-219


BSR 64000 Command Reference Guide Release 5.2.1

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 [security] [ | {begin | exclude | include} {<WORD>} [ | {count
| count-only}]]
show startup-config [security] [ | {count | count-only}]

Command Syntax

security displays security privilege information


Note: the security option is only available to
a user logged in as securityuser - refer to
Configuring Cable Intercepts in the BSR
64000 CMTS Configuration and Management
Guide
| 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-220 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

count count the number of outputted lines


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

Compass ID: 327594480 Version 3 1-221


BSR 64000 Command Reference Guide Release 5.2.1

show stats fastpath


The show stats fastpath command allows a user to view various fastpath statistical
information. The following is an example of typical screen output from the show stats
fastpath command:

FastPath Statistics:

IP
----------

Unicast
----------

Packets : 153018
Header errors : 0
Version errors : 0
TTL errors : 0
Checksum errors : 0
Length errors : 0
Protocol errors : 0
Source address errors : 0
Destination address errors : 0
Forwarded packets : 147876
Forwarded tunnel packets : 0
To SRM : 5142
De-encapsulated : 0
Discards : 0
Dropped : 0

Group Access
All

Command Mode
All modes

1-222 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Command Line Usage


show stats <NUM> fastpath [ | {begin | exclude | include} {<WORD>} | {count |
count-only}]
show stats <NUM> fastpath [ | {count | count-only}]

Command Syntax

NUM the BSR slot number containing the


HSIM module
| 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: 327594480 Version 3 1-223


BSR 64000 Command Reference Guide Release 5.2.1

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

1-224 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-225


BSR 64000 Command Reference Guide Release 5.2.1

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

1-226 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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.

Compass ID: 327594480 Version 3 1-227


BSR 64000 Command Reference Guide Release 5.2.1

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}]

1-228 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-229


BSR 64000 Command Reference Guide Release 5.2.1

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

1-230 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-231


BSR 64000 Command Reference Guide Release 5.2.1

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

1-232 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-233


BSR 64000 Command Reference Guide Release 5.2.1

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

1-234 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-235


BSR 64000 Command Reference Guide Release 5.2.1

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

1-236 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

■ show chassis status


■ show version
■ show running-config
■ show log
■ show core log
■ show ip traffic
■ show stats xfabric
■ show xfabric status
■ show stats fastpath
■ show stats lcpu
■ show stats gige
■ show stats bmeth
■ show stats feth
■ show controllers cable ds-mac
■ show controllers cable ds-phy
■ show controllers cable
■ show interfaces cable service-class all
■ show process memory
■ show memory information
■ show stats cmts
■ show pool
■ show pool application
■ show process cpu
■ show process memory sorted
■ show process msg-q-info
■ show process semaphores
■ show process stack

Compass ID: 327594480 Version 3 1-237


BSR 64000 Command Reference Guide Release 5.2.1

■ show evt
■ show memory fastpath
■ show interfaces
■ show redundancy cmts
■ show cable modem summary
■ show cable modem summary total
■ show bind
■ show packet-cable cops inactive
■ show packet-cable statistics
■ show packet-cable statistics gate cops
■ show l2-cam mac
■ show l2-cam ip
■ show l2-cam label
■ show cable spectrum-group
■ show cable downstream bonding-groups statistics

The display 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.
The show tech light version of the show tech command displays information that is
helpful for trouble shooting. The show tech light command displays only dynamic
information. The show tech command displays both dynamic and static information.
Static commands are commands like show running config, show chassis status,
show version and show log and are not included in the display output of the show
tech light command. However, dynamic commands like show stats xfabric and
show memory info are included in the display output of the show tech light
command.

Note: The show tech command output will not display SNMP community
and username or password entries.

1-238 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show tech [flash: <filename> | light | nvram: <filename>]

Command Syntax

flash: filename output to a file on the Flash memory file


system
light display abbreviated version of the show tech
command - dynamic command information
only
nvram: filename output to a file on the NVRAM file system

Compass ID: 327594480 Version 3 1-239


BSR 64000 Command Reference Guide Release 5.2.1

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-240 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-241


BSR 64000 Command Reference Guide Release 5.2.1

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-242 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-243


BSR 64000 Command Reference Guide Release 5.2.1

count count the number of outputted lines


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

1-244 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-245


BSR 64000 Command Reference Guide Release 5.2.1

count count the number of outputted lines


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

1-246 Compass ID: 327594480 Version 3


Release 5.2.1 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 5.0.0.34 Created: Friday, January 30, 2009 4:05:44 PM EST
System Image: 5.0.0T00P95.HXX.KRAU
Patches:
patch_cq40400
patch_cq40420
Date Built: Fri Apr 24 18:15:47 EDT 2009
CPU: MPC750-MPC8260
Memory Size: 256 MB

The table below describes the displayed fields:

Slot 0-15 The type of module present in the slot such as


2:8 CMTS, 2:8 CMTS (2.0), Gigabit
Ethernet, Supervisory Routing Module
(SRM3 or SRM4), etc.
Boot ROM: The Boot ROM version.
System Image: The current software version running on the
module.
Patches: The patches installed on this BSR module.
Date Built: The date the above version was built.
CPU: The processor type name.
Memory Size: The processor memory size.

Compass ID: 327594480 Version 3 1-247


BSR 64000 Command Reference Guide Release 5.2.1

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}]

Command Syntax

slot 0-15 The slot number in the BSR 64000 chassis


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.

1-248 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-249


BSR 64000 Command Reference Guide Release 5.2.1

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

1-250 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-251


BSR 64000 Command Reference Guide Release 5.2.1

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

1-252 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-253


BSR 64000 Command Reference Guide Release 5.2.1

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

1-254 Compass ID: 327594480 Version 3


Release 5.2.1 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 asset ID number - enclose


the alias name within quotation
marks if the string contains spaces

Compass ID: 327594480 Version 3 1-255


BSR 64000 Command Reference Guide Release 5.2.1

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

1-256 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

system temperature-threshold
The system temperature-threshold command sets temperature threshold values that
are retained between reboots of the chassis.

Group Access
System Administrator

Command Mode
Privileged EXEC

Command Line Usage


system temperature-threshold low <num>
system temperature-threshold {high srm {750 | dimm | dc2dc | xfab} | high fan}
<num>
system temperature-threshold default [srm | fan]

Command Syntax

low set the minimum system temperature


high srm set the maximum temperature a the SRM module component
750 set the maximum temperature for the SRM module 750 component
dimm set the maximum temperature for the SRM module dimm
component
dc2dc set the maximum temperature for the SRM module dc2dc
component
xfab set the maximum temperature for the SRM module xfab component
high fan set the maximum temperature for the fan tray
<num> temperature value (low or high), in degrees Celsius
default set the minimum and maximum temperature values to the defaults

Compass ID: 327594480 Version 3 1-257


BSR 64000 Command Reference Guide Release 5.2.1

Command Defaults
low = 0C
high srm 750 = 65C
high srm dimm = 65C
high srm dc2dc = 65C
high srm xfab = 80C
high fan = 50C

1-258 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-259


BSR 64000 Command Reference Guide Release 5.2.1

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

1-260 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-261


BSR 64000 Command Reference Guide Release 5.2.1

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 and is limited to 127
characters

1-262 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-263


BSR 64000 Command Reference Guide Release 5.2.1

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

1-264 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-265


BSR 64000 Command Reference Guide Release 5.2.1

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>} [<0-65535>]

Command Syntax

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


WORD the hostname of the remote system
0-65535 the destination port of the remote system

1-266 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-267


BSR 64000 Command Reference Guide Release 5.2.1

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

1-268 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

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

Compass ID: 327594480 Version 3 1-269


BSR 64000 Command Reference Guide Release 5.2.1

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

1-270 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

update slot
The update slot command allows a user to perform a runtime upgrade of a Boot
ROM on a single module with a single command instead of having to use the
additional upgrade steps necessary when using the update bypass all command.

Group Access
All

Command Mode
Privileged EXEC and Global Configuration

Command Line Usage


update slot <NUM> {all | app | boot | fpga} [flash: | nvram:]

Note: Entering the update slot command without specifying a boot image
initiates an update from the boot system image. Otherwise, the update slot
command attempts the specified upgrade type (all, app, boot, or fpga) using
the specified boot image.

Command Syntax

NUM the slot number for a module installed in the


BSR chassis
all upgrade all updates
app upgrade application
boot upgrade boot image
fpga upgrade FPGA(s)
flash: <boot image> upgrade from archive in the Flash memory
file system
nvram: <boot image> upgrade from archive in the NVRAM file
system

Compass ID: 327594480 Version 3 1-271


BSR 64000 Command Reference Guide Release 5.2.1

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-272 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-273


BSR 64000 Command Reference Guide Release 5.2.1

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-274 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 1-275


BSR 64000 Command Reference Guide Release 5.2.1

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 | hsim-warmstart | 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
hsim-warmstart initiate HSIM warmstart if the data path is
not operational

1-276 Compass ID: 327594480 Version 3


Release 5.2.1 System Administration Commands

monitor system logger notification only


slot-recover initiate a slot recovery reset if the switch
fabric is not operational
threshold 1-255 configures the number of 2.5 second timeouts
until an action is taken
threshold restores the default threshold value for the no
xfabric keepalive 880-recover,
cmts-rebind, hsim-warmstart, monitor,
and slot-recover commands - the no xfabric
keepalive threshold command restores all
default threshold values

Command Defaults

880-recover Disabled
cmts-rebind Disabled
hsim-warmstart Disabled
monitor Disabled
slot-recover Disabled
880-recover threshold 5
cmts-rebind threshold 15
hsim-warmstart threshold 10
monitor threshold 10
slot-recover threshold 60

Compass ID: 327594480 Version 3 1-277


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 map 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 dynamically map hostnames to
IP addresses and to control Internet routing information. Lists of domain names and
IP addresses are distributed throughout the Internet by 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.
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.

Release 5.2.1 2-1


BSR 64000 Command Reference Guide Release 5.2.1

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

2-2 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

arp
The arp command adds a permanent entry in the ARP cache. The no arp command
removes the entry from 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 map IP
addresses and their associated 48-bit hardware MAC 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 IP address of ARP entry associated with the


local data link address
H.H.H 48-bit local data link address (MAC address),
format xxxx.xxxx.xxxx
arpa standard Ethernet-style ARP, RFC 826
snap IEEE 802.3 usage of ARP packets
conforming to RFC 1042
alias respond to ARP as if it owns the specified
address, if proxy arp is enabled

Compass ID: 327594480 Version 3 2-3


BSR 64000 Command Reference Guide Release 5.2.1

cablebundle cable X/Y slot X and MAC domain Y of the cable bundle
physical interface on the CMTS module
cm-hardware-address
H.H.H MAC address of the cable modem, format
xxxx.xxxx.xxxx

Command Default
no entries in table
arpa (ethernet ARP)

2-4 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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 timeout <4-6000>
no arp timeout <4-6000>

Command Syntax

4-6000 amount of time, in minutes, that an entry is


allowed to stay in the ARP cache

Command Default
60 minutes

Compass ID: 327594480 Version 3 2-5


BSR 64000 Command Reference Guide Release 5.2.1

cable helper-address
The cable helper-address command enables broadcast forwarding for User
Datagram Protocol (UDP) packets. 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 is also used to bind a cable helper address to a
secondary IP subnet of a CM 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>
| global ]
no cable helper-address <A.B.C.D> {cable-modem | host | mta} [isp-bind
<A.B.C.D> | global ]

Command Syntax

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


cable-modem only CM UDP broadcasts are forwarded
host only CPE UDP broadcasts are forwarded
mta only MTA UDP broadcasts are forwarded

2-6 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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


is bound
global cable-helper is on the global network

Compass ID: 327594480 Version 3 2-7


BSR 64000 Command Reference Guide Release 5.2.1

clear arp-cache
The clear arp-cache command clears all dynamic entries or a specific entry from the
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 IP address entry to be cleared from the ARP


table

2-8 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


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

Command Syntax

cable X/Y clear the cable counters for the specified slot
cable X/Y.N X, port Y, and if applicable, sub-interface N

ethernet X/Y clear the Ethernet counters for the specified


slot X and port Y
gigaether X/Y clear the Gigabit Ethernet counters for the
gigaether X/Y.N specified slot X, port Y, and if applicable,
sub-interface N
ipsec clear the IPSEC counters
loopback 1-255 clear the loopback counters for the specified
loopback interface number
tunnel 0-255 clear the tunnel interface counters for the
specified tunnel interface number
pos X/Y clear the Packet over SONET (POS) counters
for the specified slot X and port Y

Compass ID: 327594480 Version 3 2-9


BSR 64000 Command Reference Guide Release 5.2.1

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 delete a specific DNS hostname entry


* delete all DNS hostname entries

2-10 Compass ID: 327594480 Version 3


Release 5.2.1 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

* delete all routes


A.B.C.D destination network route to delete
A.B.C.D destination network subnet mask

Compass ID: 327594480 Version 3 2-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

clear sntp history


The clear sntp history command removes servers from the SNTP server history list
displayed by the show sntp command and the show sntp detail command. To remove
a specific SNTP server from the display, that particular SNTP server must be
specified with the clear sntp history command. To remove all SNTP servers from the
display, the clear sntp history command is used without specifying an individual
SNTP server.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


clear sntp history [<A.B.C.D> | <Hostname>]

Command Syntax

A.B.C.D the IP address of an SNTP server


Hostname the hostname of an SNTP server

Command Default
All SNTP servers on the SNTP server list are displayed by the show sntp command
and the show sntp detail command.

Compass ID: 327594480 Version 3 2-13


BSR 64000 Command Reference Guide Release 5.2.1

host authorization
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.
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 a 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.

Group Access
ISP

Command Mode
Interface Configuration mode (cable interface only)

Command Line Usage


host authorization {<mac> {cpe <mac> <A.B.C.D> | cpr <mac> <A.B.C.D>} | on}
no host authorization on {<mac> {cpe <mac> <A.B.C.D> | cpr <mac> <prefix>} |
on}

Command Syntax

mac cable modem MAC address, format


xxxx.xxxx.xxxx
cpe Customer Premises Equipment
cpr Customer Premise Router
mac MAC address of the CPE or CPR, format
xxxx.xxxx.xxxx

2-14 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

A.B.C.D IP address of the CPE or CPR


on enable host authorization

Command Default
Disabled

Compass ID: 327594480 Version 3 2-15


BSR 64000 Command Reference Guide Release 5.2.1

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 | X/Y.N> | ethernet <X/Y> | gigaether <X/Y | X/Y.N> |
loopback <1-255> | pos <X/Y> | tunnel <0-255>}

Command Syntax

cable X/Y slot X, MAC domain Y, and, if applicable, the


cable X/Y.N cable sub-interface N of the CMTS module

ethernet X/Y slot X and port Y on the Ethernet interface:


• On the 8-port Ethernet module, there are 8
10/100 Mbps Ethernet ports
• 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
gigaether X/Y slot X, port Y, and, if applicable, the
gigaether X/Y.N sub-interface N of the 1000 Mbps optical
Ethernet interface

2-16 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

loopback 1-255 loopback interfaces are used as inbound


logical interfaces when physical interfaces go
down - up to 255 loopback interfaces are
supported
pos X/Y slot X and port Y on the high speed
OC3/OC12 SONET interface
tunnel 0-255 tunnels are logical interfaces used to make
point-to-point links between two devices, up
to 255 tunnels are supported

Compass ID: 327594480 Version 3 2-17


BSR 64000 Command Reference Guide Release 5.2.1

ip access-group
The ip access-group command configures an interface to use an access list. The no ip
access-group command removes an access-list for the interface.

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 access-list number range


1300-2699 extended access-list number range
in incoming packet is processed only if the
source address is permitted by the access-list
out outgoing packet is processed only if
access-list permits the packet

Command Default
No access groups defined.

2-18 Compass ID: 327594480 Version 3


Release 5.2.1 IP 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.
The BSR now allows multiple BSRs connected to the same LAN (or VLAN) to share
the same IP subnet by using the shared-proxy-arp option. An interface configured
with the shared-proxy-arp option is allowed to share ARP resolutions with all
Ethernet or Gigabit Ethernet interfaces configured with the ip proxy-arp command.
When the BSR needs to resolve an IP address in a shared-proxy-arp IP subnet, it sends
an ARP request upstream on the Ethernet or Gigabit Ethernet interfaces configured
with the ip proxy-arp command and also sends the ARP request downstream on the
cable interface(s) configured with the shared-proxy-arp option. The BSR then learns
the host addresses of shared-proxy-arp IP subnets present on the Ethernet or Gigabit
Ethernet interfaces configured with the ip proxy-arp command.

Note: The shared-proxy-arp option must be specified after all other options.
For example, when enabling shared-proxy-arp on a secondary host subnet,
the secondary host options must be specified prior to the shared-proxy-arp
option.

When configuring the IP address of a cable or loopback interface, 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.

Compass ID: 327594480 Version 3 2-19


BSR 64000 Command Reference Guide Release 5.2.1

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.

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

2-20 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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>}} [shared-proxy-arp]
ip address {<A.B.C.D>{<A.B.C.D>}} [secondary [ host | mta] [isp-bind
<A.B.C.D> | shared-proxy-arp]]
ip address {<A.B.C.D>{<A.B.C.D>}} [secondary [shared-proxy-arp]]
no ip address {<A.B.C.D>{<A.B.C.D>}} [shared-proxy-arp]
no 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 [shared-proxy-arp]]

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
shared-proxy-arp share ARP resolutions with Ethernet or
Gigabit Ethernet interfaces configured with
the ip proxy-arp command

Compass ID: 327594480 Version 3 2-21


BSR 64000 Command Reference Guide Release 5.2.1

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-22 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

ip broadcast-address
The ip broadcast-address command configures 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 IP broadcast address assigned to the interface

Compass ID: 327594480 Version 3 2-23


BSR 64000 Command Reference Guide Release 5.2.1

ip dhcp relay information


The ip dhcp relay information command enables the BSR to insert the 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).
The ip dhcp relay informationmulti-isp-enable command allows the BSR to
insert the DHCP relay information option (option-82) into received DHCP client
messages being forwarded to a DHCP server.

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)

2-24 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

Command Line Usage


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

Command Syntax

multi-isp-enable enables the insertion of the DHCP relay


information option when multiple ISPs are
used
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: 327594480 Version 3 2-25


BSR 64000 Command Reference Guide Release 5.2.1

ip domain-list
The ip domain-list command configures 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> [<WORD>] [<WORD>] [<WORD>] [<WORD>]
[<WORD>]

Command Syntax

WORD domain name

2-26 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 2-27


BSR 64000 Command Reference Guide Release 5.2.1

ip domain-name
The ip domain-name command is used to configure a domain name. The no ip
domain-name command removes the 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.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


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

Command Syntax

WORD domain name

Command Default
No domain is configured.

2-28 Compass ID: 327594480 Version 3


Release 5.2.1 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 UDP port number


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

Compass ID: 327594480 Version 3 2-29


BSR 64000 Command Reference Guide Release 5.2.1

ip forwarding
The ip forwarding command neutralizes virus or hacking attacks by forwarding the
offending traffic to Transmission Control Protocol (TCP) or User Datagram Protocol
(UDP) source or destination port zero (depending where this traffic is coming from).
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


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

Command Default
Disabled

2-30 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

ip helper-address
The ip helper-address command specifies 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 IP address of the DHCP server

Compass ID: 327594480 Version 3 2-31


BSR 64000 Command Reference Guide Release 5.2.1

ip host
The ip host command is used to add a static, classless DNS host entry and its IP
address to the IP hostname table. 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 <Hostname> <A.B.C.D>
no ip host <Hostname> <A.B.C.D>

Command Syntax

Hostname name of host


A.B.C.D IP address

Command Default
No hosts configured.

2-32 Compass ID: 327594480 Version 3


Release 5.2.1 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 A.B.C.D IP address to proxy-advertise, preference


value
holdtime 1-9000 amount of time, in seconds, advertisements
hold valid
maxadvertinterval 4-1800 maximum time, in seconds, between
advertisements
minadvertinterval 3-1800 minimal time between advertisement in
seconds
multicast advertisements are sent with multicast
preference
-2147483648-2147483647 preference value for this interface, -231 to 231,
higher values increase performance, preferred
router

Compass ID: 327594480 Version 3 2-33


BSR 64000 Command Reference Guide Release 5.2.1

Command Default

holdtime = 1800 seconds


maxadvertinterval = 600 seconds
minadvertinterval = 450 seconds

2-34 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 2-35


BSR 64000 Command Reference Guide Release 5.2.1

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-1500>
no ip mtu

Command Syntax

68-1500 MTU size in bytes

Command Default
1496 bytes

2-36 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

ip multicast fastpath
The ip multicast fastpath command is used to specify which multicast flow or flows
will be given preferential treatment for forwarding in the fast path.
Which flow is forwarded in the fast path depends on the user configuration. A flow or
a range of flows can be configured with an extended access list (eACL). If no eACL
configured flows are present, all flows will be forwarded through the slow path in the
SRM. When the traffic for these eACL configured flows is active, they will be
forwarded in the fast path. Only the maximum allowed 16 fast path entries can be
forwarded even though there might be more active flows configured. When an active
flow is deleted, either due to a timeout or forced removal, the next active eACL
configured flow, if any, will be forwarded in the fast path.
Source and group destination IP addresses can be setup in ranges using wildcard
network masks in the eACL. Only permit entries are parsed for eligibility of installing
into the fast path. The fast path entries will be installed up to the first 16 flows
configured in the eACL initially. When a multicast flow becomes active in the
multicast forwarding cache and it matches any of the entries in the eACL, the entry
will be programmed into the fast path if one of the 16 flows are available. A flow is
considered active when traffic of that flow is being forwarded within a 3 minute
window. The entries in the fast path will be re-evaluated on any updates to the eACL.
For entries no longer matched in the eACL, they will be taken out of the fast path. The
updated eACL will be parsed to see if any corresponding active flows need to be
programmed into the fast path if there are still room in the fast path. However, if all 16
installed entries still match the configured range, no entry in the fast path will be
replaced even if the configured range has become higher in the sequence order of the
eACL. This is because ACLs only provide a way to make a binary decision, i.e. it is
either eligible for the fast path or not, and not used for ordering to determine which
entries get installed.
There is an optional parameter “queue” for all multicast data packets to be forwarded
out one of the eight specified queues which can be used for statistics, debugging or
QoS purposes. The queue number cannot be changed once configured unless a new
extended ACL is configured where all previous fast path flows are removed and any
new fast path flows are created with the new queue number.

Group Access
ISP

Command Mode
Global Configuration

Compass ID: 327594480 Version 3 2-37


BSR 64000 Command Reference Guide Release 5.2.1

Command Line Usage


ip multicast fastpath {<100-199> | <2000-2699>} [ queue <0-7>]
no ip multicast fastpath {<100-199> | <2000-2699>} [ queue <0-7>]

Command Syntax

100-199 the mulitcast acceleration eligibility list


2000-2699 the extended ACL range
queue 0-7 the HSIM transmit queue number

Command Default
queue = 1

2-38 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

ip name-server
The ip name-server command is used to enter the IP address of one or more Domain
Name System (DNS) servers. Up to six DNS servers 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 address of a DNS server, 6 addresses may


be specified

Compass ID: 327594480 Version 3 2-39


BSR 64000 Command Reference Guide Release 5.2.1

ip proxy-arp
The ip proxy-arp command enables proxy Address Resolution Protocol (ARP) on an
Ethernet and Gigabit Ethernet 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 and 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 enabled.

Group Access
ISP

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

Command Line Usage


ip proxy-arp
no ip proxy-arp

Command Default
Disabled

2-40 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

ip rarp-server
The ip rarp-server command is used to enable the router to act as a Reverse Address
Resolution Protocol (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 <A.B.C.D>
no ip rarp-server <A.B.C.D>

Command Syntax

A.B.C.D IP address for use as the source protocol


address

Command Default
Disabled

Compass ID: 327594480 Version 3 2-41


BSR 64000 Command Reference Guide Release 5.2.1

ip redirects
The ip redirects command enables the processing of "Host Redirect" messages. If
both the global and interface configuration modes are enabled, the BSR will send an
ICMPv4 "Host Redirect" packet to the original source of an IPv4 packet received by
the BSR from that interface when both the source IP address and destination IP
address of the packet are within a logical IPv4 subnet implemented on the incoming
interface. The source should send packets directly to the destination rather than
routing through the BSR.
The no ip redirects command disables the processing of "Host Redirect" messages.
When disabled, the BSR will not send an ICMPv4 "Host Redirect" message to the
source.
This command applies only to IP version 4 packets. Regardless of the configuration,
the BSR attempts to forward packets back onto the incoming interface in order to
reach their destinations.

Note: Unless your network devices respond to IP redirects, which can be a


security issue, Motorola recommends that this function be disabled. This will
minimize network traffic load and packet processing by the BSR.

Group Access
ISP

Command Mode
Global Configuration and Interface Configuration (not supported for Cable interfaces)

Command Line Usage


ip redirects
no ip redirects

Command Default
Enabled

2-42 Compass ID: 327594480 Version 3


Release 5.2.1 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 removes 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 <NUM> | pos <X/Y> | tunnel
<0-255>} [<1-255> ] [ range <1-65536> ] [tag <1-4294967295>]
no ip route <A.B.C.D> <A.B.C.D> {<A.B.C.D> | null <NUM> | pos <X/Y> | tunnel
<0-255>} [<1-255> ] [ range <1-65536> ] [tag <1-4294967295>]

Command Syntax

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


A.B.C.D netmask of the destination network
A.B.C.D IP address of the forwarding router
null <NUM> null interface number
pos X/Y POS slot X and port Y
tunnel 0-255 tunnel interface number
1-255 administrative distance
range 1-65536 number of route entries
tag 1-4294967295 match value to control route-map
redistribution

Command Default
Administrative distance = 1

Compass ID: 327594480 Version 3 2-43


BSR 64000 Command Reference Guide Release 5.2.1

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-44 Compass ID: 327594480 Version 3


Release 5.2.1 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 datagrams
containing a source-route option.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ip source-route
no ip source-route

Compass ID: 327594480 Version 3 2-45


BSR 64000 Command Reference Guide Release 5.2.1

ip unreachables
The ip unreachables command enables processing of an ICMP unreachable message
when the BSR can not deliver a received packet. When enabled for both the global
and interface configuration modes, the BSR will send an ICMPv4 "Network
Unreachable" packet to the original source of an IPv4 packet received by the BSR for
which the BSR does not have a route.
The no ip unreachables command disables ICMP unreachable message processing
when the router can not deliver a received a packet. If either the global or interface
configuration mode is disabled, then the BSR will not send an ICMPv4 packet to the
source.
This command applies only to IP version 4 packets. Regardless of the configuration,
the BSR will discard the packet when it has no route to its destination.

Note: Because enabling this feature can cause large amounts of data to be
sent on the network interface, Motorola recommends that this feature be
disabled.

Group Access
ISP

Command Mode
Global Configuration and Interface Configuration (not supported for Cable interfaces)

Command Line Usage


ip unreachables
no ip unreachables

Command Default
Enabled

2-46 Compass ID: 327594480 Version 3


Release 5.2.1 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
command 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 | X/Y.N> | default | ethernet <X/Y>
| gigaether <X/Y | X/Y.N> | loopback <1-255> | pos <X/Y>}
no passive-interface {cable <X/Y | X/Y.N> | default | ethernet <X/Y>
| gigaether <X/Y | X/Y.N> | loopback <1-255> | pos <X/Y>}

Command Syntax

cable X/Y slot X, MAC domain Y, and, if applicable, the


cable X/Y.N cable sub-interface N of the CMTS module

default suppress routing updates on all interfaces


ethernet X/Y Ethernet interface slot X and port Y
gigaether X/Y slot X, port Y, and, if applicable, the
gigaether X/Y.N sub-interface N of the 1000 Mbps optical
Ethernet interface

Compass ID: 327594480 Version 3 2-47


BSR 64000 Command Reference Guide Release 5.2.1

loopback 1-255 loopback interface number


pos X/Y Packet-Over-SONET interface slot X and port
Y

Command Default
Routing updates are transmitted over the router (no passive-interface command).

2-48 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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 reachability 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 destination system


Hostname name of the destination system
size 40-65535 size, in bytes, of the echo message

Compass ID: 327594480 Version 3 2-49


BSR 64000 Command Reference Guide Release 5.2.1

1-65535 number of ping requests to send


timeout 1-1024 time, in seconds, to wait for a reply before the
connection times out
source A.B.C.D IP address of the BSR interface to use as the
source of the ping request
tos 0-255 type of service
ttl 0-255 time to live value
df set the "don’t fragment" IP flag in the
outgoing ping IP header

2-50 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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

| turn on output modifiers (filters)


begin filter for output that begins with the
specified string

Compass ID: 327594480 Version 3 2-51


BSR 64000 Command Reference Guide Release 5.2.1

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-52 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show controllers
The show controllers command displays detailed hardware and configuration
information for each module installed in the BSR chassis.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show controllers {ethernet [<X/Y>] | gigaether [<X/Y | X/Y.N>] | pos [<X/Y>]
| cable <X/Y | X/Y.N> [upstream <NUM> | downstream <NUM> | mac ]} [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]
show controllers {ethernet [<X/Y>] | gigaether [<X/Y | X/Y.N>] | pos [<X/Y>]
| cable <X/Y | X/Y.N> [upstream <NUM> | downstream <NUM> | mac ]} [ | {count |
count-only}]

Command Syntax

ethernet X/Y display Ethernet interface controller


information for the entire BSR
chassis or the optional, specified
BSR chassis slot X and port Y
gigaether X/Y display Gigabit Ethernet interface
gigaether X/Y.N controller information for the entire
BSR chassis or the optional,
specified BSR chassis slot X, port Y,
and if applicable, sub-interface N
pos X/Y display POS interface controller
information for the entire BSR
chassis or the optional, specified
BSR chassis slot X and port Y

Compass ID: 327594480 Version 3 2-53


BSR 64000 Command Reference Guide Release 5.2.1

cable X/Y display cable interface controller


cable X/Y.N information for the specified BSR
chassis slot X, MAC domain Y, and if
applicable sub-interface N
upstream NUM display information for the specified
upstream port including the upstream
modulation type, channel width,
frequency, and modulation profile
information (i.e minislots, interleave,
preamble, etc.)
downstream NUM display information for the
downstream port number including
downstream modulation type,
frequency (label), and symbol rate
mac display MAC layer (layer 2)
information for all cable modems on
this specific CMTS module
| turn 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-54 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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 CMTS slot number

Compass ID: 327594480 Version 3 2-55


BSR 64000 Command Reference Guide Release 5.2.1

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
| turn 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

2-56 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

WORD the specified string


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

Compass ID: 327594480 Version 3 2-57


BSR 64000 Command Reference Guide Release 5.2.1

show host authorization interface cable


The show host authorization interface cable command 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
Host Dyn Ack 3600 0012.25d9.59f8 150.31.56.2 0008.0ecc.9a52
Host Dyn Ack 3600 000e.5c6c.9810 150.31.56.3 0008.0ecc.9a3a
Modem Dyn Ack-TD-TF 3600 0019.5eb4.8176 150.31.54.20 0019.5eb4.8176
Modem Dyn Ack-TD-TF 3600 000e.5c00.d2e2 150.31.54.15 000e.5c00.d2e2

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 slot X and MAC Domain Y of the CMTS


module
| turn 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

2-58 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

WORD the specified string


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

Compass ID: 327594480 Version 3 2-59


BSR 64000 Command Reference Guide Release 5.2.1

show host authorization summary


The show host authorization summary command is used to display ARP table
summary information. 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 CMTS slot number


| turn 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 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

count count the number of outputted lines


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

Compass ID: 327594480 Version 3 2-61


BSR 64000 Command Reference Guide Release 5.2.1

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:

Index Seconds Modem MAC Addr Host IP Addr Host MAC Addr Vrf Index
32767 600 0012.2588.33ac 150.42.101.2 0030.1bb4.a703 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show host unauthorized cpe

2-62 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show hosts
The show hosts command displays the cache list of hostnames with their IP addresses
and aliases.

Group Access
ISP

Command Mode
Privileged EXEC

Command Line Usage


show hosts

Compass ID: 327594480 Version 3 2-63


BSR 64000 Command Reference Guide Release 5.2.1

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:

gigaether 14/0.10 is up, line protocol is up


Hardware address is 00:30:b8:80:63:3f
Internet address is 150.31.90.10/24
Encapsulation Arpa
802.1Q Virtual LAN, VLAN ID 63
ARP Timeout 01:00:00
Last state change at 1d16h, 63 interface resets
Queueing strategy: FIFO

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show interfaces [ethernet <X/Y> | gigaether <X/Y | X/Y.N> | cable <X/Y | X/Y.N>
| 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 | X/Y.N> | cable <X/Y | X/Y.N>
| pos <X/Y> | loopback <1-255> | tunnel <0-255>] [accounting] [ | {count |
count-only}]

Command Syntax

ethernet X/Y Ethernet interface slot X and port Y


gigaether X/Y Gigabit Ethernet interface slot X, port Y, and if
gigaether X/Y.N applicable, sub-interface N

2-64 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

cable X/Y cable interface slot X, port Y, and if


cable X/Y.N applicable, sub-interface N

pos X/Y Packet-over-SONET interface slot X and port


Y
loopback 1-255 loopback interface number
tunnel 0-255 tunnel interface number
accounting display the number of packets for each
protocol type that has been sent through an
interface
| turn 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: 327594480 Version 3 2-65


BSR 64000 Command Reference Guide Release 5.2.1

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 | X/Y.N> | ethernet
<X/Y> | gigaether <X/Y | X/Y.N> | loopback <0-255> | incomplete ] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]

2-66 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show ip arp [<A.B.C.D> | <H.H.H> | <Hostname> | cable <X/Y | X/Y.N> | ethernet


<X/Y> | gigaether <X/Y | X/Y.N> | loopback <0-255> | incomplete ] [ | {count |
count-only}]

Command Syntax

A.B.C.D display ARP entries matching the specified IP


address
H.H.H display ARP entries matching the specified
48 bit MAC address
Hostname display ARP entries matching the specified
hostname
cable X/Y display ARP entries for the specified cable
cable X/Y.N interface in the BSR slot X, MAC Domain Y,
and if applicable, sub-interface N
ethernet X/Y display ARP entries for the specified Ethernet
interface in BSR slot X and port number Y
gigaether X/Y display ARP entries for the specified Gigabit
gigaether X/Y.N Ethernet interface in BSR slot X, port Y, and if
applicable sub-interface N
loopback 0-255 display ARP entries for the specified
loopback interface
incomplete display incomplete ARP entries
| turn 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: 327594480 Version 3 2-67


BSR 64000 Command Reference Guide Release 5.2.1

count count the number of outputted lines


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

2-68 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show ip dhcp stats


The show ip dhcp stats command displays 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 CMTS slot number

Compass ID: 327594480 Version 3 2-69


BSR 64000 Command Reference Guide Release 5.2.1

show ip filters
The show ip filters command displays a variety of filter and routing policy
configuration information. IP 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 destination IP address for this filter


Src Ip Address source IP address for this filter
Pro first three characters of the routing
protocol acronym for this filter. For
example, OSPF is displayed as OSP.
SP source IP port for this filter

2-70 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

DP destination IP port for this filter


FT 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 outgoing QoS queue ID number

The following additional filter configuration information is displayed for the policy
command option:

In If incoming TCP/UDP port number


associated with this filter entry
Out If outgoing TCP/UDP port number
associated with this filter entry
DS Diff-serv Code Point (differentiated
services)
Def default filter indicator

Compass ID: 327594480 Version 3 2-71


BSR 64000 Command Reference Guide Release 5.2.1

Mac MAC address for the interface


Mtu 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 | srm | summary | tunnel] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show ip filters [acl | icmp | policy | qos | srm | summary | tunnel] [ | {count |
count-only}]

Command Syntax

acl display access list filters


icmp display ICMP filters
policy display policy 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 a summary of all Fast Path
filters - refer to show ip filters
summary
tunnel display IP tunneling filters
| turn on output modifiers (filters)

2-72 Compass ID: 327594480 Version 3


Release 5.2.1 IP 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: 327594480 Version 3 2-73


BSR 64000 Command Reference Guide Release 5.2.1

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 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 number of filters applied to each
Flow Classification Type
Slot BSR 64000 slot
Number of Filters 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:

2-74 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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}]

Compass ID: 327594480 Version 3 2-75


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

| turn 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-76 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show ip flows
The show ip flows command displays active TCP/UDP flows/connections including
servers.

PCB specifies the source physical address of the


flow or connection - PCB denotes printed
circuit board
Proto specifies the protocol used in this flow or
connection
Recv-Q specifies the number of packets received
Send-Q specifies the number of packets sentr
Local Address specifies the source IP address and UDP port
of the flow
Foreign Address specifies the destination IP address and UDP
port of the flow
(state) the state of the flow or connection
VPN the Virtual Private Network associated with
this flow or connection

The following is an example of typical screen output from the show ip flows
command:

Active Internet connections (including servers)


PCB Proto Recv-Q Send-Q Local Address Foreign Address (state) VPN
--- ----- ------ ------ ------------- --------------- ------ ---
1fb10e8 TCP 56 54 150.31.20.10.23 10.14.37.103.39345 ESTABLISHED global
1fb0fd8 TCP 89 78 150.31.20.10.43 10.14.37.103.42034 ESTABLISHED global
1fb1060 TCP 45 23 150.31.20.10.67 10.14.37.103.54220 ESTABLISHED global
1fb0f50 UDP 101 0 127.0.0.1.161 0.0.0.0.0 LISTENING global

Compass ID: 327594480 Version 3 2-77


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
All modes

Command Line Usage


show ip flows [ | {begin | exclude | include} {<WORD>} | {count | count-only}]
show ip flows [ | {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

2-78 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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 }]

Compass ID: 327594480 Version 3 2-79


BSR 64000 Command Reference Guide Release 5.2.1

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

A.B.C.D display the entries for the specified IP address


hitCount NUM display the access-list hit count for the
(optional) BSR chassis slot number
summary display a summary
mpls display the MPLS Fast Path filters
tunnel display the tunnel filters
vrf word display a VPN Routing/Forwarding instance
| turn 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

2-80 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

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

Compass ID: 327594480 Version 3 2-81


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


show ip interface [ brief | cable <X/Y | X/Y.N> | ethernet <X/Y>
| gigaether <X/Y | X/Y.N> | loopback <1-255> | pos <X/Y> | tunnel <0-255>]
[ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show ip interface [ brief | cable <X/Y | X/Y.N> | ethernet <X/Y>
| gigaether <X/Y | X/Y.N> | 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 X, MAC Domain Y, and if
cable X/Y.N applicable, sub-interface N

ethernet X/Y Ethernet interface slot X and port Y


gigaether X/Y Gigabit Ethernet interface slot X, port Y, and if
gigaether X/Y.N applicable, sub-interface N

loopback 1-255 loopback interface number


pos X/Y Packet-over-SONET interface slot X and port
Y
tunnel 0-255 tunnel interface number
| turn on output modifiers (filters)
begin filter for output that begins with the specified
string

2-82 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 2-83


BSR 64000 Command Reference Guide Release 5.2.1

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 | X/Y.N>] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show ip irdp [ethernet <X/Y> | gigaether <X/Y | X/Y.N>] [ | {count | count-only}]

2-84 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

Command Syntax

ethernet X/Y Ethernet interface slot X and port Y


gigaether X/Y Gigabit Ethernet interface slot X, port Y, and if
gigaether X/Y.N applicable, sub-interface N

| turn 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: 327594480 Version 3 2-85


BSR 64000 Command Reference Guide Release 5.2.1

show ip multicast fastpath


The show ip multicast fastpath command display multicast entries in the fast path.
The following is an example of typical screen output from the show ip multicast
fastpath command:

Source/Group In Phys If Out Phys Ifs FP Idx


----------------------- ---------- ------------- ------
8.8.8.21/224.2.166.71 feth 2/0 cab 5/0 2
cab 4/0
20.1.1.10/224.2.166.71 feth 3/0 cab 5/0 5
cab 5/1
8.8.8.21/224.2.231.191 feth 2/1 eth 2/6 13
cab 5/0
20.1.1.10/224.2.231.191 feth 2/2 cab 1/0 6

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip multicast fastpath

2-86 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show ip multicast fwd-cache


The show ip multicast fwd-cache command displays the multicast forwarding cache
on a source and group pair basis. The added legend of “s” indicates that the flow is
currently being switched/forwarded in the fast path. If the entry is in the fast path, the
column in parenthesis displays any packets that have come through to the slow path.
The following is an example of typical screen output from the show ip multicast
fwd-cache command:

Legend (L): D = DVMRP accept, d = DVMRP drop, P = PIM accept, p = PIM drop
s = Switched (FastPath), N = None/Drop, U = unknown
Source/ (L) Incoming/ # in pkts # out pkts # OI Entry
Group Outgoing (# in SRM) Timeout
--------------- -- ------------ ---------- ---------- ---- -------
8.8.8.21/ Ps 90.1.1.15/ 2352 1 208
224.2.166.71 Ps 1.1.1.1 (49)
20.1.1.10/ P PIM REG IN/ 1074 1 210
224.2.166.71 P 90.1.1.15 1074
8.8.8.21/ Ps 90.1.1.15/ 47 1 209
224.2.231.191 Ps 1.1.1.1 (147)
20.1.1.10/ Ps 1.1.1.1/ 24709 1 210
224.2.231.191 Ps 90.1.1.15 (1)

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 ]

Compass ID: 327594480 Version 3 2-87


BSR 64000 Command Reference Guide Release 5.2.1

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
physical displays the cache only in relation to the
physical interface - if "physical" is not
specified - if "physical" is not specified, the
command output relates to the logical
interface

2-88 Compass ID: 327594480 Version 3


Release 5.2.1 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 [bgp | summary] [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]

Compass ID: 327594480 Version 3 2-89


BSR 64000 Command Reference Guide Release 5.2.1

show ip protocols [bgp | summary] [ | {count | count-only}]

Command Syntax

bgp display BGP protocol infomation


summary display a summary of system routing protocol
processes
| turn 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-90 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show ip route
The show ip route command displays active entries in the BSR routing table. The
following is typical screen 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: 327594480 Version 3 2-91


BSR 64000 Command Reference Guide Release 5.2.1

"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> [longer-prefixes] [<A.B.C.D> [longer-prefixes] | bgp |
connected | <Hostname> | isis | ospf | rip | static | summary | vrf <word> ] [ | {begin
| exclude | include} {<WORD>} [ | {count | count-only}]]
show ip route [<A.B.C.D> [longer-prefixes] [<A.B.C.D> [longer-prefixes] | bgp |
connected | <Hostname> | isis | ospf | rip | static | summary | vrf <word> ] [ | {count
| count-only}]

2-92 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

Command Syntax

A.B.C.D display routes for the specified IP address


A.B.C.D subnet mask
longer-prefixes display routes matching the specified network
and mask pair only
bgp display Border Gateway Protocol routes
connected display connected routes
Hostname display routes for the hostname
isis display ISIS routes
ospf display OSPF routes
rip display RIP routes
static display static routes
summary display a summary of routes
vrf word display a VPN Routing/Forwarding instance
| turn 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: 327594480 Version 3 2-93


BSR 64000 Command Reference Guide Release 5.2.1

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: 3348 total, 1215 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: 34 received, 0 sent
Mcast: 971 control pkt received, 3126 control pkt sent
0 data pkt received, 0 data pkt sent
Sent: 6395 generated, 2133 forwarded
Drop: 0 encapsulation failed, 0 unresolved, 0 no adjacency
0 Mcast In Drop, 0 Mcast Out Drop
0 no route, 0 unicast RPF, 0 forced drop
0 acces-list inbound, 0 access-list outbound
0 policy-based routing drop

ICMP statistics:
Rcvd: 0 format errors, 0 checksum errors, 0 redirects, 0 unreachable
0 echo, 0 echo reply, 0 mask requests, 0 mask replies,0 quench
0 parameter problem, 0 timestamp, 0 timestamp reply, 0 info request
0 other, 0 irdp solicitations, 0 irdp advertisements
Sent: 0 redirects, 0 unreachable, 0 echo, 0 echo reply
0 mask requests, 0 mask replies, 0 quench, 0 timestamp
0 info reply, 0 time exceeded, 0 parameter problem

2-94 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

UDP statistics:
Rcvd: 34 total, 0 checksum errors, 0 no port, 34 no port broadcast
Sent: 0 total, 0 forwarded broadcasts
Dhcp Relay Rcvd: 20 discover, 20 offer, 14 request
14 ack, 0 nak
Dhcp Relay Sent: 20 discover, 20 offer, 14 request
14 ack, 0 nak
DhcpLeaseQuery Sent: 0
DhcpLeaseQuery Rcvd: 0 Active, 0 Known, 0 Unknown, 0 Unimplemented

TCP statistics:
Dropped 0 broadcast/multicast TCP packets in the IP layer
Rcvd: 109 total, 0 checksum errors, 0 no port
Sent: 111 total

ARP statistics:
Rcvd: 10 requests, 1 replies, 0 reverse replies, 0 reverse requests, 0 oth
er
Sent: 4 requests, 7 replies (0 proxy), 0 reverse replies, 0 reverse reques
ts

OSPF statistics:
Rcvd: 1044 total (dropped 0), 665 hello (dropped 0)
3 database desc, 0 link state req, 301 link state updates
75 link state acks
Sent: 3131 total, 2756 hello
2 database desc, 2 link state req, 77 link state updates
294 link state acks

IGMP statistics: Sent/Received


Total: 0/0, Format errors: 0/0, Checksum errors: 0/0
Host Queriers: 0/0, Host Reports: 0/0, Host Leaves: 0/0
Bad Queries: 0/0, Bad Reports: 0/0

Compass ID: 327594480 Version 3 2-95


BSR 64000 Command Reference Guide Release 5.2.1

DVMRP statistics:
Total DVMRP routes: 0, Valid DVMRP routes: 0
Total Probes sent: 0, Total Probes received: 0
Total Reports sent: 0, Total Reports received: 0
Total Prunes sent: 0, Total Prunes received: 0
Total Grafts sent: 0, Total Grafts received: 0
Total Graft Acks sent: 0, Total Graft Acks received: 0
Total Unknown packets received: 0

PIM statistics:
All Pim Send & Receive counters: 0

RADIUS client statistics:


Recv: invalid server 0

TACACS+ Statistics

TACACS+ Overall Statistics


Number of access requests : 0
Number of access deny responses : 0
Number of access allow responses: 0

No TACACS+ Servers Configured.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


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

2-96 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show ip traffic [ | {count | count-only}]

Command Syntax

| turn 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: 327594480 Version 3 2-97


BSR 64000 Command Reference Guide Release 5.2.1

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 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 frame priority level which is used for
prioritizing traffic and is capable of
representing 8 levels (0-7)
CFI Canonical Format Indicator (CFI), 1 indicates
the MAC address is in non-canonical format,
0 indicates the MAC address is in canonical
format
VLAN VLAN ID number

2-98 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

TP reserved by Motorola.
BEN Layer 2 Bridge status, 0 indicates disabled, 1
indicates enabled
EN Routing status, 0 indicates disabled, 1
indicates enabled
PT Preserve (P) Type of Service (TOS) status, 0
indicates disabled, 1 indicates enabled
TOS Type of Service value
VRF VRF name
EIID/IIID Egressing or Ingressing Interface ID
IIID Ingressing Interface ID
ILID Ingressing Logical ID
MAC Address 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: 327594480 Version 3 2-99


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

ip display the Internet Protocol table,


including bridging (VLAN tagging)
entries
label display leased host authorization
entries for a CPE
mac [NUM] display the entire MAC address table
or MAC addresses for a specific
BSR module, including VRF host
authorization entries for all leased
CPEs
| turn 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-100 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

show sntp
The Simple Network Time Protocol (SNTP) provides system time with high accuracy.
The show sntp command displays the following SNTP information for the BSR:
SNTP server configured SNTP server 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 Recvd. 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 display transaction details even if no SNTP


server is configured

Compass ID: 327594480 Version 3 2-101


BSR 64000 Command Reference Guide Release 5.2.1

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-102 Compass ID: 327594480 Version 3


Release 5.2.1 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:

sent: statistics for packets sent by the router


packets sent total number of packets sent
data packets number of data packets sent
data packet number of data packets retransmitted
retransmitted
ack-only packets number of packets sent that are
acknowledgments only
URG only packet number of urgent packets sent
window probe number of window probe packets sent
packet
window update number of window update packets sent
packet
control packets number of control packets (SYN, FIN, or
RST) sent
received: statistics in this section refer to packets
received by the router
packets received total number of packets received
acks number of acknowledgment packets received
duplicate acks number of duplicate acknowledgment packets
received
ack for unsent data number of acknowledgment packets with
unsent data received
packets received in number of data packets received in sequence
sequence
completely duplicate number of duplicate packets received
packets

Compass ID: 327594480 Version 3 2-103


BSR 64000 Command Reference Guide Release 5.2.1

packets with some number of packets received with partially


dup data duplicated data
out-of-order packet number of packets received out of order
packet of data after number of packets received with data that
window exceeds the receiver window size
window probe number of window probe packets received
window update number of window update packets received
packets
packet received after number of packets received after the
close connection has been closed
discarded for bad number of packets received with checksum
checksum error
discarded for bad number of packets received with bad offset to
header offset field data
discarded because number of packets received that were too
packet too short short
connection request number of connections initiated
connection accepts number of connections accepted
connections established number of connections established
connections closed number of connections closed
retransmit timeout number of times the router tried to retransmit,
but timed out
connection dropped number of connections dropped in retransmit
by rxmit timeout timeout
keepalive timeouts number of keepalive packets in timeout
keepalive probes number of keepalive probes
sent
connection dropped number of connections dropped in keepalive
by keepalive

2-104 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

The following is an example of typical screen output from the show tcp statistics
command:

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

Compass ID: 327594480 Version 3 2-105


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
Privileged EXEC

Command Line Usage


show tcp statistics

2-106 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 2-107


BSR 64000 Command Reference Guide Release 5.2.1

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-108 Compass ID: 327594480 Version 3


Release 5.2.1 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
WORD key value, up to 8 characters

Compass ID: 327594480 Version 3 2-109


BSR 64000 Command Reference Guide Release 5.2.1

sntp broadcastdelay
The sntp broadcastdelay command establishes the round-trip delay time between the
system and a broadcast server. The no sntp broadcastdelay command removes the
round-trip delay time 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 round-trip delay in microseconds

Command Default
3000 microseconds

2-110 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

sntp broadcast client


The sntp broadcast client command configures the BSR to listen for SNTP
broadcasts. The no sntp broadcast client command blocks the BSR 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: 327594480 Version 3 2-111


BSR 64000 Command Reference Guide Release 5.2.1

sntp disable
The sntp disable command disables SNTP. The no sntp disable command enables
the BSR 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-112 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

sntp response timeout


The sntp response timeout command is used to configure the switchover criteria
when the active SNTP server is not responding and the next SNTP server on the
SNTP server list becomes the active SNTP server. For details on configuring the list
of SNTP servers, refer to the sntp server command. The switchover criteria is
determined by the total number of failures occurring within a number of attempts at
communicating with the active SNTP server. When the number of failures out of the
number of attempts match the numbers configured with the sntp response timeout
command, then the next SNTP server on the list will become the active SNTP server.
The default values are three failures and five attempts. If using the default values and
a server has three failures out of five attempts, then the next configured SNTP server
on the SNTP server list becomes the active SNTP server. The no sntp response
timeout command restores the default values.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


sntp response timeout attempts <1-5>
sntp response timeout failures <1-5>

no sntp response timeout attempts


no sntp response timeout failures

Command Syntax

1-5 the number of attempts/failures allowed with


the active SNTP server before switching to
the next SNTP server

Command Default
attempts = 5
failures = 3

Compass ID: 327594480 Version 3 2-113


BSR 64000 Command Reference Guide Release 5.2.1

sntp server
The sntp server command configures a BSR for SNTP to accept NTP traffic. The no
sntp server command disables the BSR from receiving NTP traffic.
A secondary SNTP server can also be configured as a backup in case the primary
SNTP server goes down unexpectedly. This secondary SNTP server automatically
becomes the primary SNTP server after 5 unsuccessful attempts to contact the
primary SNTP server.

Note: When the SNTP server address is set to 224.0.1.1 (the assigned
multicast address for NTP), the BSR operates in unicast mode. It then
transmits a request to this multicast address and waits for replies. It then
"binds" to the first SNTP server that replies. All subsequent transactions
happen in a unicast mode. In this way, the SNTP server’s address does not
need to be known beforehand.

If you configure the BSR to operate in authenticated mode, you must also
configure an authentication key with the sntp authentication-key command
and a trusted key with the sntp 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>]
[secondary [key <1-4294967295>]]
no sntp server [secondary]

2-114 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

Command Syntax

224.0.1.1 the NTP Multicast group


A.B.C.D the SNTP server’s IP address.
Hostname the SNTP server’s hostname
key 1-4294967295 the key number for authentication purposes
secondary specifies this SNTP server as a secondary
SNTP server

Compass ID: 327594480 Version 3 2-115


BSR 64000 Command Reference Guide Release 5.2.1

sntp source-interface loopback


The sntp source-interface loopback command specifies a configured loopback
interface as the interface for sending SNTP messages. The no sntp source-interface
loopback command removes the configured SNTP source-interface.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


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

Command Syntax

loopback 1-255 the loopback interface number; the loopback


interface must be previously configured

Command Default
An SNTP source-interface is not configured.

2-116 Compass ID: 327594480 Version 3


Release 5.2.1 IP Commands

sntp timer
The sntp timer command specifies the time interval between queries to the SNTP
server. The no sntp timer command removes 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 time interval in seconds

Compass ID: 327594480 Version 3 2-117


BSR 64000 Command Reference Guide Release 5.2.1

sntp trusted-key
The sntp trusted-key command authorizes synchronization and authenticates system
identity. The no sntp 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 to deliver 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-118 Compass ID: 327594480 Version 3


Release 5.2.1 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

Compass ID: 327594480 Version 3 2-119


BSR 64000 Command Reference Guide Release 5.2.1

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 ]

Command Syntax

A.B.C.D destination IP address


Hostname destination hostname
Source A.B.C.D IP address of the source interface
timeout 1-1024 number of seconds to wait for a response to a
probe packet
nprobes 1-1024 number of probes to send
minhops 1-64 minimum TTL value - the default value is 1 but
can be set to a higher value to suppress the
display of known hops
maxhops 2-1024 maximum TTL value - the traceroute command
terminates when the destination or this value is
reached
port 0-65535 destination port used by the UDP probe messages
tos 0-255 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-120 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 2-121


BSR 64000 Command Reference Guide Release 5.2.1

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-122 Compass ID: 327594480 Version 3


Release 5.2.1 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 re-issued 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: 327594480 Version 3 2-123


BSR 64000 Command Reference Guide Release 5.2.1

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) - 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-124 Compass ID: 327594480 Version 3


Release 5.2.1 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 for the tunnel interface
cable X/Y CMTS interface slot X and MAC Domain Y
default source interface is based on the destination IP
address
ethernet X/Y Ethernet interface slot X and port Y
gigaether X/Y Gigabit Ethernet interface slot X and port Y
loopback 1-255 loopback interface number
pos X/Y Packet-Over-SONET interface slot X and
port Y

Compass ID: 327594480 Version 3 2-125


BSR 64000 Command Reference Guide Release 5.2.1

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-126 Compass ID: 327594480 Version 3


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: 327594480 Version 3 3-1


BSR 64000 Command Reference Guide Release 5.2.1

SNMP Command Descriptions


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

3-2 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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 (Tom.Terrific@motorola.com)
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: 327594480 Version 3 3-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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.
The no snmp-server community-table command removes an snmpCommunityTable
entry.

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 <octet-string>| eng-id <HEX>| index <octet-string>|
nonvolatile | not-in-service | transport-tag <octet-string> | volatile ]
no snmp-server community-table <octet-string>

Note: The no snmp-server community-table <octet-string> command


requires an snmpCommunityIndex (the unique index value of a row in the
snmpCommunityTable) as an entered value for the <octet-string> parameter
NOT an snmpCommunityName.

Compass ID: 327594480 Version 3 3-13


BSR 64000 Command Reference Guide Release 5.2.1

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"
context-name the context in which management information
is accessed when using the community string
specified by the snmpCommunityName
eng-id HEX 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 octet-string 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"

3-14 Compass ID: 327594480 Version 3


Release 5.2.1 SNMP Commands

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

Command Defaults
snmpCommunityStatus = active
snmpCommunityStorageType = nonvolatile

Compass ID: 327594480 Version 3 3-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-23


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-25


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-27


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-29


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-31


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-33


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-35


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-37


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-39


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-41


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-43


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-45


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-47


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-49


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 3-51


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 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.

Note: These debug commands and messages only function or display


packets which are routed through the SRM. Most user-to-user traffic is
switched through hardware which bypasses the SRM so these commands
would not show those packets.

Debug Command Descriptions


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

Compass ID: 327594480 Version 3 4-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 4-3


BSR 64000 Command Reference Guide Release 5.2.1

debug cable err


The debug cable err command displays miscellaneous error conditions.\

Note: The debug cable err command is only supported on the 2:8 CMTS
module 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 Compass ID: 327594480 Version 3


Release 5.2.1 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 2:8
CMTS module 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: 327594480 Version 3 4-5


BSR 64000 Command Reference Guide Release 5.2.1

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 2:8 CMTS
module 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 Compass ID: 327594480 Version 3


Release 5.2.1 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 2:8 CMTS
module 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: 327594480 Version 3 4-7


BSR 64000 Command Reference Guide Release 5.2.1

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


2:8 CMTS module 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 Compass ID: 327594480 Version 3


Release 5.2.1 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 2:8
CMTS module 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: 327594480 Version 3 4-9


BSR 64000 Command Reference Guide Release 5.2.1

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 2:8 CMTS
module 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 Compass ID: 327594480 Version 3


Release 5.2.1 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 2:8 CMTS
module 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: 327594480 Version 3 4-11


BSR 64000 Command Reference Guide Release 5.2.1

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

4-12 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 4-13


BSR 64000 Command Reference Guide Release 5.2.1

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 2:8 CMTS
module 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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 4-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 4-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 4-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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
no debug ip mfm

Command Default
Disabled

Compass ID: 327594480 Version 3 4-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 4-23


BSR 64000 Command Reference Guide Release 5.2.1

spf debug OSPF SPF calculation events


detail display detailed SPF calculation events debug
information

Command Default
Disabled

4-24 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug ip packet
The debug ip packet command displays general IP debugging information generated
and forwarded through th SRM 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 Usage Examples:


debug ip packet
debug ip packet detail
debug ip packet detail [<1-199> | <1300-2699>]
debug ip packet [<1-199> | <1300-2699>
debug ip packet [<1-199> | <1300-2699> detail
debug ip packet [<1-199> | <1300-2699> detail [<1-199> | <1300-2699>]

Compass ID: 327594480 Version 3 4-25


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

1-199 access list number


1300-2699 extended access list number
detail display more detailed IP packet; debugging
information

Command Default
Disabled

4-26 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-27


BSR 64000 Command Reference Guide Release 5.2.1

Command Default
Disabled

4-28 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-29


BSR 64000 Command Reference Guide Release 5.2.1

debug ip redistribute
The debug ip redistribute command displays route redistribution information from
one routing domain to another routing domain. The no debug ip redistribute
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 | isis | ospf | rip} from {all | bgp | connected | isis
| ospf | rip | static}
no debug ip redistribute to {all | bgp | isis | ospf | rip} from {all | bgp | connected |
isis | ospf | rip | static}

Command Syntax

to to protocols
all all supported protocols
bgp routes redistributed into BGP
isis routes redistributed into IS-IS
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
isis routes redistributed from IS-IS

4-30 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

ospf routes redistributed from OSPF


rip routes redistributed from RIP
static routes redistributed static

Command Default
Disabled

Compass ID: 327594480 Version 3 4-31


BSR 64000 Command Reference Guide Release 5.2.1

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

4-32 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-33


BSR 64000 Command Reference Guide Release 5.2.1

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

4-34 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-35


BSR 64000 Command Reference Guide Release 5.2.1

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

4-36 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-37


BSR 64000 Command Reference Guide Release 5.2.1

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

4-38 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-39


BSR 64000 Command Reference Guide Release 5.2.1

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

4-40 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug ipv6 all


The debug ipv6 all command turns on debugging messages for all IPv6 debug
functions. The no debug ipv6 all command turns off this debugging operation.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ipv6 all
no debug ipv6 all

Command Default
Disabled

Compass ID: 327594480 Version 3 4-41


BSR 64000 Command Reference Guide Release 5.2.1

debug ipv6 dhcp


The debug ipv6 dhcp command turns on debugging messages for all DHCP based
transactions. The no debug ipv6 dhcp command turns off this debugging operation.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ipv6 dhcp
no debug ipv6 dhcp

Command Default
Disabled

4-42 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug ipv6 icmp6


The debug ipv6 icmp6 command turns on debugging messages for all ICMP6 based
transactions. The no debug ipv6 icmp6 command turns off this debugging operation.

Caution: The debug ipv6 icmp6 command could cause a huge number of
messages to be displayed or logged and should only be enabled for short
periods.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ipv6 icmp6
no debug ipv6 icmp6

Command Default
Disabled

Compass ID: 327594480 Version 3 4-43


BSR 64000 Command Reference Guide Release 5.2.1

debug ipv6 packet


The debug ipv6 packet command displays general IPv6 debugging information
generated and forwarded through the SRM including packets received, generated, and
forwarded. The no debug ipv6 packet command turns off this debugging operation.
The detail option displays more detailed IPV6 packet debugging.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ipv6 packet [detail]
no debug ipv6 packet [detail]

Command Default
Disabled

4-44 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug ipv6 tcp6


The debug ipv6 tcp6 command turns on debugging messages for all TCP6 based
transactions. The no debug ipv6 tcp6 command turns off this debugging operation.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ipv6 tcp6
no debug ipv6 tcp6

Command Default
Disabled

Compass ID: 327594480 Version 3 4-45


BSR 64000 Command Reference Guide Release 5.2.1

debug ipv6 udp6


The debug ipv6 udp6 command turns on debugging messages for all UDP6 based
transactions. The no debug ipv6 udp6 command turns off this debugging operation.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ipv6 udp6
no debug ipv6 udp6

Command Default
Disabled

4-46 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug isis adj-packets


The debug isis adj packets command displays debug information on all
adjacency-related activity such as hello packets sent and received and IS-IS
adjacencies going up and down. The no debug isis adj packets command disables
debugging output.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug isis adj packets
no debug isis adj packets

Command Default
Disabled

Compass ID: 327594480 Version 3 4-47


BSR 64000 Command Reference Guide Release 5.2.1

debug isis authentication


The debug isis authentication command turns on debugging messages for all IS-IS
packet authentication. The no isis authentication command turns off this debugging
operation.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug isis authentication
no debug isis authentication

Command Default
Disabled

4-48 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug isis snp-packets


The debug isis snp-packets command turns on debugging messages for all IS-IS
CSNP/PSNP packets. The no isis snp-packets command turns off this debugging
operation.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug isis snp-packets
no debug isis snp-packets

Command Default
Disabled

Compass ID: 327594480 Version 3 4-49


BSR 64000 Command Reference Guide Release 5.2.1

debug isis spf-event


The debug isis spf-events command turns on debugging messages for all IS-IS
Shortest Path First Events. The no isis spf-events command turns off this debugging
operation.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug isis spf-events
no debug isis spf-events

Command Default
Disabled

4-50 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug isis spf-statistics


The debug isis spf-statistics command turns on debugging messages for all IS-IS
shortest path first statistics. The no debug isis spf-statistics command turns off this
debugging operation.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug isis spf-statistics
no debug isis statistics

Command Default
Disabled

Compass ID: 327594480 Version 3 4-51


BSR 64000 Command Reference Guide Release 5.2.1

debug isis spf-triggers


The debug isis spf-triggers command turns on debugging messages for all IS-IS SPF
triggering events. The no debug isis spf-triggers command turns off this debugging
operation.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug isis spf-triggers
no debug isis spf-triggers

Command Default
Disabled

4-52 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug isis update-packets


The debug isis update-packets command displays various sequence number protocol
data units (PDUs) and link state packets that are detected by the BSR. The no debug
isis update-packets command turns off this debugging operation.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


debug isis update-packets
no debug isis update-packets

Command Default
Disabled

Compass ID: 327594480 Version 3 4-53


BSR 64000 Command Reference Guide Release 5.2.1

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-54 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 4-55


BSR 64000 Command Reference Guide Release 5.2.1

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-56 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

debug nd
The debug nd command turns on debugging messages for all Neighbor Discovery
(ND) functions. The no debug nd command turns off this debugging operation.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug nd [dad | error | na | ns | nud | ra | rs]
no debug nd [dad | error | na | ns | nud | ra | rs]

Command Syntax

dad debug duplicate address detection


error debug error messages
na debug neighbor advertisement messages
ns debug neighbor solicitation messages
nud debug neighbor unreachablily detection
ra debug router advertisement messages
rs debug router advertisement solicitation
messages

Command Default
Disabled

Compass ID: 327594480 Version 3 4-57


BSR 64000 Command Reference Guide Release 5.2.1

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

4-58 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-59


BSR 64000 Command Reference Guide Release 5.2.1

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

4-60 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-61


BSR 64000 Command Reference Guide Release 5.2.1

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

4-62 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-63


BSR 64000 Command Reference Guide Release 5.2.1

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 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
upstream display upstream information
NUM upstream port number

4-64 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-65


BSR 64000 Command Reference Guide Release 5.2.1

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

4-66 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-67


BSR 64000 Command Reference Guide Release 5.2.1

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.

4-68 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-69


BSR 64000 Command Reference Guide Release 5.2.1

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 Time interval in seconds during which if a
10-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 If the memory on the primary SRM falls
0-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 If a single task consumes more than this value
50-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.

4-70 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-71


BSR 64000 Command Reference Guide Release 5.2.1

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

4-72 Compass ID: 327594480 Version 3


Release 5.2.1 Debug Commands

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

Compass ID: 327594480 Version 3 4-73


BSR 64000 Command Reference Guide Release 5.2.1

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

4-74 Compass ID: 327594480 Version 3


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: 327594480 Version 3 5-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 5-3


BSR 64000 Command Reference Guide Release 5.2.1

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>}

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 | diff-serv <0-63> |
dod-host-prohibited | dod-net-prohibited | echo | echo-reply | fragments [diff-serv
<0-63>] | 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]
To configure an extended access list for IGMP, use the following command:

5-4 Compass ID: 327594480 Version 3


Release 5.2.1 Access List Commands

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 <0-63> | dvmrp | fragments [diff-serv <0-63>] | 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 | fragments [diff-serv <0-63>] | 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 |
fragments [diff-serv <0-63>] | 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: 327594480 Version 3 5-5


BSR 64000 Command Reference Guide Release 5.2.1

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

5-6 Compass ID: 327594480 Version 3


Release 5.2.1 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 <0-63> Diff-Serv Code Point
dod-host-prohibited Host prohibited
dod-net-prohibited Network prohibited
echo Echo - ping
echo-reply Echo reply
fragments Check non-initial fragments
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: 327594480 Version 3 5-7


BSR 64000 Command Reference Guide Release 5.2.1

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)
fragments Check non-initial fragments
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 Compass ID: 327594480 Version 3


Release 5.2.1 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)
fragments Check non-initial fragments
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: 327594480 Version 3 5-9


BSR 64000 Command Reference Guide Release 5.2.1

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)

5-10 Compass ID: 327594480 Version 3


Release 5.2.1 Access List Commands

The number or name of a UDP


port.
A UDP port number.
0-65535 Biff - mail notification (512)
biff Bootstrap Protocol Client (68)
bootpc Bootstrap Protocol Server (67)
bootps Discard (9)
discard Domain Name Service (53)
domain Echo (7)
echo Check non-initial fragments
fragments Mobile IP registration (434)
mobile-ip NetBios Datagram Service (138)
netbios-dgm NetBios Name Service (137)
netbios-ns NetBios Session Service (139)
netbios-ss Network Time Protocol (123)
ntp PIM Auto-RP (496)
pim-auto-rp Routing Information Protocol (520)
rip Simple Network Management Protocol (161)
snmp SNMP Traps (162)
snmptrap Sun Remote Procedure Call (111)
sunrpc Syslog (514)
syslog Talk (517)
talk Trivial File Transfer Protocol (69)
tftp Time (37)
time Who service - rwho (513)
who X Display Manager Control Protocol (177)
xdmcp

Compass ID: 327594480 Version 3 5-11


BSR 64000 Command Reference Guide Release 5.2.1

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

5-12 Compass ID: 327594480 Version 3


Release 5.2.1 Access List Commands

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

Compass ID: 327594480 Version 3 5-13


BSR 64000 Command Reference Guide Release 5.2.1

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 access-lists 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}]

5-14 Compass ID: 327594480 Version 3


Release 5.2.1 Access List Commands

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
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.

Compass ID: 327594480 Version 3 5-15


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. Policy-based routing uses sets 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: 327594480 Version 3 6-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 Routing Policy Commands

Command Default
Disabled

Compass ID: 327594480 Version 3 6-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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 at least one BGP autonomous system path
to ensure advertisement on the route-map. Values can be set using the match as-path
command.
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: 327594480 Version 3 6-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-15


BSR 64000 Command Reference Guide Release 5.2.1

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 set actions to perform if the
criteria enforced by the match commands are met. When all match criteria are met,
all set actions are performed. The no route-map command deletes the route-map, or
an instance.

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 Routing Policy Commands

100-199 extended community list number


delete delete inbound or outbound communities from the
community attribute

Compass ID: 327594480 Version 3 6-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-23


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-25


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-27


BSR 64000 Command Reference Guide Release 5.2.1

Command Default
0

6-28 Compass ID: 327594480 Version 3


Release 5.2.1 Routing Policy Commands

set ip next-hop
The set ip next-hop command establishes a next-hop IP address 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: 327594480 Version 3 6-29


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-31


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-33


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-35


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-37


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 6-39


BSR 64000 Command Reference Guide Release 5.2.1

show route-map
The show route-map command displays configured route maps. The following
displays typical screen output from the show route-map command:

route-map LOOPBACK2, permit, sequence 10


Match clauses:
ip address (access-list): 100
Set clauses:
ip next-hop 150.31.50.1

route-map TEST, permit, sequence 10


Match clauses:
Set clauses:
community 1:57920
route-map QOS, permit, sequence 1
Match clauses:
ip address (access-list): 101 102
Set clauses:
ip qos queue 1

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 the specified route-map

6-40 Compass ID: 327594480 Version 3


Release 5.2.1 Routing Policy Commands

| 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: 327594480 Version 3 6-41


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: 327594480 Version 3 7-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-11


BSR 64000 Command Reference Guide Release 5.2.1

ip rip message-digest-key md5


The ip rip message-digest-key command is used to configure a Message Digest 5
(MD5) Authentication key for a RIP V2 interface.

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 {7 <WORD> | <WORD>}

Command Syntax

1-255 the range of numbers from which an MD5


secret Key ID can be selected
7 <WORD> specifies a hidden (encrypted) MD5 password
will follow that is between 1-50 characters.
WORD MD5 password that is between 1-16
characters.

Note: A maximum of ten key IDs can be configured at the same time.

Command Default
Disabled

7-12 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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 Network mask

Compass ID: 327594480 Version 3 7-17


BSR 64000 Command Reference Guide Release 5.2.1

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 | X/Y.N> | ethernet <X/Y>
| gigaether <X/Y | X/Y.N> | pos <X/Y>]
no offset-list {<1-99> | any} {in | out} <0-16> [cable <X/Y | X/Y.N>
| ethernet <X/Y >| gigaether <X/Y | X/Y.N> | 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 X, MAC Domain Y, and if
cable X/Y.N applicable, sub-interface N to which the
offset-list is applied
ethernet X/Y Ethernet interface slot X and port Y to which
the offset-list is applied

7-18 Compass ID: 327594480 Version 3


Release 5.2.1 RIP Commands

gigaether X/Y Gigabit Ethernet interface slot X, port Y, and


gigaether X/Y.N if applicable, sub-interface N to which the
offset-list is applied
pos X/Y POS interface slot X and port Y to which the
offset-list is applied

Command Default
Disabled

Compass ID: 327594480 Version 3 7-19


BSR 64000 Command Reference Guide Release 5.2.1

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 delay time, in milliseconds, between packets


of a multiple-packet RIP update

Command Default
0

7-20 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-23


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-25


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 7-27


BSR 64000 Command Reference Guide Release 5.2.1

timers basic
The timers basic command configures RIP network timers. The no timers basic
command resets the network timer default.

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


timers basic <update> <invalid> <flush>
no timers basic <update> <invalid> <flush>

Command Syntax

update specify the interval, in seconds, between


periodic routing updates; valid values:
0-4294967295

7-28 Compass ID: 327594480 Version 3


Release 5.2.1 RIP Commands

invalid specify the interval of time, in seconds, after


which a route is declared invalid; valid
values: 1-4294967295
invalid 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 specify the amount of time (in seconds) that
must pass before the route is removed from
the routing table; valid range: 1-4294967295
flush 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: 327594480 Version 3 7-29


BSR 64000 Command Reference Guide Release 5.2.1

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.

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 Compass ID: 327594480 Version 3


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 Link-state Advertisements (LSAs) that allow OSPF routers to update
each other about the LAN and WAN links to which they are connected. OSPF ensures
that each OSPF router has an identical link-state database, except during periods 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: 327594480 Version 3 8-1


BSR 64000 Command Reference Guide Release 5.2.1

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.

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-3


BSR 64000 Command Reference Guide Release 5.2.1

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 LSA into the
NSSA area on an NSSA Area Border Router
(ABR) only.
no-redistribution When the router is a NSSA ABR, the
no-redistribute option 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 Compass ID: 327594480 Version 3


Release 5.2.1 OSPF Commands

area range
Use the area range command to consolidate OSPF routes for an Area Border Router
(ABR) only by advertising a single summary route 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 ]
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 Network 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: 327594480 Version 3 8-5


BSR 64000 Command Reference Guide Release 5.2.1

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 (LSAs)
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 Compass ID: 327594480 Version 3


Release 5.2.1 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) 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 IP address of the virtual link neighbor.
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: 327594480 Version 3 8-7


BSR 64000 Command Reference Guide Release 5.2.1

hello-interval 1-65535 Time in seconds between hello packets on an


interface; the 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; the value
must be more than the 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 Compass ID: 327594480 Version 3


Release 5.2.1 OSPF Commands

auto-cost reference-bandwidth
The BSR OSPF routing process calculates the OSPF cost metric for an interface
according to the bandwidth of the interface. The cost of an interface depends on the
type of interface. The formula to calculate the cost is the reference bandwidth divided
by the 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
100 Mbps

Compass ID: 327594480 Version 3 8-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-11


BSR 64000 Command Reference Guide Release 5.2.1

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 advertise the default route into the


OSPF domain regardless of whether the
routing table has a default route.
metric 0-16777214 OSPF metric assigned to 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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-13


BSR 64000 Command Reference Guide Release 5.2.1

distance
The distance command sets all 3 OSPF distances (intra-area, inter-area, and external)
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 assigned to all OSPF


routes

Command Default
120

8-14 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-15


BSR 64000 Command Reference Guide Release 5.2.1

Command Default
intra-area distance = 110
inter-area distance = 110
external distance = 110

8-16 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-23


BSR 64000 Command Reference Guide Release 5.2.1

ip ospf dead-interval
The ip ospf dead-interval command sets the number of seconds after which a
neighbor routers is considered to be down. The no ip ospf dead-internal resets the
dead interval to the default value.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip ospf dead-interval <1-65535>
no ip ospf dead-interval

Command Syntax

1-65535 time, in seconds, after which a neighbor is


considered dead; the value must be the same
for all routers on the network

Command Default
40

8-24 Compass ID: 327594480 Version 3


Release 5.2.1 OSPF Commands

ip ospf hello-interval
The ip ospf hello-interval command sets the number of seconds between hello
packets sent by the BSR 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 time, in seconds, between transmitting hello


packets on an interface, the time value must
be the same for all nodes on the network.

Command Default
10

Compass ID: 327594480 Version 3 8-25


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-27


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-29


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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-3>
no maximum-paths

Command Syntax

1-3 the maximum number of parallel routes

Compass ID: 327594480 Version 3 8-31


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-33


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-35


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 OSPF Commands

Command Default
Disabled

Compass ID: 327594480 Version 3 8-37


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-39


BSR 64000 Command Reference Guide Release 5.2.1

router ospf
The router ospf command enables an OSPF routing process. The no router ospf
command disables the OSPF routing process.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


router ospf
no router ospf

8-40 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-41


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 OSPF Commands

show ip ospf border-routers


The show ip ospf border-routers command displays the internal OSPF routing table
for Autonomous System Boundary Routers (ASBRs), and Area Border Routers
(ABRs).

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: 327594480 Version 3 8-43


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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 Link state ID in IP address format, always the
same as the advertising router, 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).
begin filter for output that begins with the specified
string.

Compass ID: 327594480 Version 3 8-45


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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 | X/Y.N> | ethernet <X/Y>
| gigaether <X/Y | X/Y.N> | 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 | X/Y.N> | ethernet <X/Y>
| gigaether <X/Y | X/Y.N> | loopback <1-255>| pos <X/Y> | tunnel <0-255>]
[ | {count | count-only}]

Compass ID: 327594480 Version 3 8-47


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

A.B.C.D Interface IP address


cable X/Y OSPF information over the cable interface
cable X/Y.N slot X, MAC Domain Y, and if applicable,
sub-interface N
ethernet X/Y OSPF information over the Ethernet/
FastEthernet 802.3 interface slot X and port Y
gigaether X/Y OSPF information over the Gigabit Ethernet
gigaether X/Y.N interface slot X, port Y, and if applicable,
sub-interface N
loopback 1-255 OSPF information over the loopback
interface
pos X/Y OSPF information over the Packet Over
SONET interface slot X and port Y
tunnel 0-255
| 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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-49


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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}]

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

Compass ID: 327594480 Version 3 8-51


BSR 64000 Command Reference Guide Release 5.2.1

count count the number of outputted lines


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

8-52 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 8-53


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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


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: 327594480 Version 3 8-55


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


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: 327594480 Version 3 9-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 9-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 IGMP Commands

ip igmp querier-timeout
The ip igmp querier-timeout command configures the timeout value indicating
when 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: After a no ip igmp querier-timeout command is issued and only after


the querier has completed the last query, then the router takes over as the
interface querier.

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-interval value x 2

Compass ID: 327594480 Version 3 9-5


BSR 64000 Command Reference Guide Release 5.2.1

ip igmp query-interval
The igmp query-interval command sets the frequency at which the router sends out
IGMP queries on the interface. The no ip igmp query-interval command returns the
query interval 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 Compass ID: 327594480 Version 3


Release 5.2.1 IGMP Commands

ip igmp last-member-query-count
The ip igmp last-member-query-count command configures the number of times
that the BSR sends Internet Group Management Protocol (IGMP) group-specific
query messages in response to receiving a group-specific leave message. The no ip
igmp last-member-query-count command resets this interval to the default value of
2.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp last-member-query-count <1-7>
no ip igmp last-member-query-count <1-7>

Command Syntax

1-7 the number of times that the BSR


sends Internet Group Management
Protocol (IGMP) group-specific
query messages in response to
receiving a group-specific leave
message

Command Default
2

Compass ID: 327594480 Version 3 9-7


BSR 64000 Command Reference Guide Release 5.2.1

ip igmp last-member-query-interval
The ip igmp last-member-query-interval command configures the interval (in
tenths of a second) at which the BSR sends Internet Group Management Protocol
(IGMP) group-specific query messages. The no ip igmp
last-member-query-interval command resets this interval to the default value of 10
(1 second).

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp last-member-query-interval <1-255>
no ip igmp last-member-query-interval <1-255>

Command Syntax

1-255 the interval (in tenths of a second) at


which the BSR sends Internet Group
Management Protocol (IGMP)
group-specific query messages

Command Default
10 (1 second)

9-8 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 9-9


BSR 64000 Command Reference Guide Release 5.2.1

ip igmp static-group
The ip igmp static-group command is used for the following:
■ Connects or configures the router as a member of a particular multicast group on
the interface.
■ Gives a host (that does not run IGMP) membership in a multicast group.
■ Allows an IP unicast source address and the multicast group address channel to
join an upstream PIM neighbor.

Note: Packet forwarding of this IP unicast source address and the multicast
group address channel will only be sent onto physical interfaces that have
this static IP unicast source address and the multicast group address channel
Join message.

The no ip igmp static-group disassociates the router from the group.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ip igmp static-group <A.B.C.D> [source <A.B.C.D>]
no ip igmp static-group <A.B.C.D> [source <A.B.C.D>]

Command Syntax

A.B.C.D The multicast group IP address that the router


is configured to be a member, which is in the
Class D IP address range 224.0.0.0 through
232.255.255.255.
source A.B.C.D The unicast source IP address.

Command Default
Disabled

9-10 Compass ID: 327594480 Version 3


Release 5.2.1 IGMP Commands

ip igmp version
The ip igmp version command configures a specific 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: 327594480 Version 3 9-11


BSR 64000 Command Reference Guide Release 5.2.1

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 affected 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-12 Compass ID: 327594480 Version 3


Release 5.2.1 IGMP Commands

show ip igmp groups


The show ip igmp groups command displays the following information for 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
IP Address source IP address for the group
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


Legend: # - Version 1 Host detected, * - all sources
Group Address Interface IP Address Uptime Expires Last Reporter
232.1.1.1/ loopback 1 40.4.4.15 142:12:11 00:00 0.0.0.0
20.1.1.10

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip igmp groups [summary] [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]

Compass ID: 327594480 Version 3 9-13


BSR 64000 Command Reference Guide Release 5.2.1

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-14 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 9-15


BSR 64000 Command Reference Guide Release 5.2.1

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-16 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 9-17


BSR 64000 Command Reference Guide Release 5.2.1

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-18 Compass ID: 327594480 Version 3


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 Master VRRP router is
responsible for forwarding packets that are sent to the IP addresses of the virtual
router from hosts on the LAN. The election process provides dynamic failover in the
forwarding responsibility if the Master becomes unavailable. When the Master goes
down, the remaining VRRP routers elect a new Master VRRP router based on priority
and primary IP address. 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: 327594480 Version 3 10-1


BSR 64000 Command Reference Guide Release 5.2.1

clear ip vrrp
The clear ip vrrp command resets all VRRP statistic counters of all virtual routers
configured on the router. A specific interface and specific Virtual Router ID (VRID)
may be specified.

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 VRRP statistics counters for all


virtual routers on all interfaces on this router
ethernet X/Y resets VRRP statistics counters on the
Ethernet interface slot X and port Y
gigaether X/Y resets VRRP statistics counters on the Gigabit
Ethernet interface slot X and port Y
1-255 virtual router ID (VRID)

10-2 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 10-3


BSR 64000 Command Reference Guide Release 5.2.1

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 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 Backup routers 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 Virtual Router ID (VRID)

10-4 Compass ID: 327594480 Version 3


Release 5.2.1 VRRP Commands

ip vrrp address
The ip vrrp address command specifies a virtual IP address and secondary IP
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 virtual router ID (VRID)


A.B.C.D specify the IP address of this virtual router
...A.B.C.D specifies additional secondary IP addresses of
this virtual router

Compass ID: 327594480 Version 3 10-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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 virtual router ID (VRID)


text simple text authentication type

Command Default
No authentication

Compass ID: 327594480 Version 3 10-7


BSR 64000 Command Reference Guide Release 5.2.1

ip vrrp enable
The ip vrrp enable command enables a specific VRRP router on a configured
interface. The no vrrp enable command disables a specific VRRP 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 VRRP router when the router is 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 virtual router ID (VRID)

Command Default
Enabled

10-8 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 10-9


BSR 64000 Command Reference Guide Release 5.2.1

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. A priority of 0 is reserved for the
Master to indicate the relinquishing of responsibility of the virtual router.

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 virtual router ID (VRID)


priority 1-254 priority value of the VRRP router

Command Default
100

10-10 Compass ID: 327594480 Version 3


Release 5.2.1 VRRP Commands

ip vrrp primary-ip
The ip vrrp primary-ip command configures the primary IP address for a virtual
router with multiple interface addresses in a VRRP group. The no ip vrrp primary-ip
command resets the primary IP address to the lowest IP address among all real
interface addresses for the given interface.

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 virtual router ID (VRID)


A.B.C.D IP address to set as the source of outgoing IP
packets when selected as the master VRRP
router

Command Default
The lowest IP address value among all valid IP addresses of the given interface.

Compass ID: 327594480 Version 3 10-11


BSR 64000 Command Reference Guide Release 5.2.1

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 virtual router ID (VRID)


timer 1-255 advertisement interval in seconds

Command Default
1 second

10-12 Compass ID: 327594480 Version 3


Release 5.2.1 VRRP Commands

ip vrrp verify-availability
The ip vrrp verify-availability command configures the VRRP router to monitor one
or more ip addresses. The no ip vrrp verify-availability command stops monitoring
one or more of the designated IP addresses.
Use the ip vrrp verify-availability command to configure the VRRP router to
monitor the link states of other VRRP router interfaces. 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. 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.

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.D VRRP IP address that this VRRP router
monitors
...A.B.C.D additional IP addresses that this virtual router
monitors

Compass ID: 327594480 Version 3 10-13


BSR 64000 Command Reference Guide Release 5.2.1

show ip vrrp
The show ip vrrp command displays detailed status information on all VRRP virtual
routers configured on the router. 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 X and port Y


gigaether X/Y Gigabit Ethernet interface slot X and port Y
1-255 identification number of a configured virtual
router
summary summary information for all VRRP routers
configured on all interfaces

10-14 Compass ID: 327594480 Version 3


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: 327594480 Version 3 11-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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


static route - a lower distance has preference

Compass ID: 327594480 Version 3 11-3


BSR 64000 Command Reference Guide Release 5.2.1

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 unicast


multicast route - a lower distance has
preference

11-4 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 11-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 11-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 11-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 11-11


BSR 64000 Command Reference Guide Release 5.2.1

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 display the cache for this source or group


address
A.B.C.D display the cache for this specified source and
group address
physical display the cache only in relation to the
physical interface - if "physical" is not
specified, the cache will display in relation to
the logical interface

11-12 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 11-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 11-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


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: 327594480 Version 3 12-1


BSR 64000 Command Reference Guide Release 5.2.1

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 access list for filtering routes

Command Default
Accepts destination reports from all neighbors.

12-2 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 12-3


BSR 64000 Command Reference Guide Release 5.2.1

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 increment value for incoming DVMRP routes


out 0-31 increment value for outgoing DVMRP routes

Command Default
in = 1
out = 0

12-4 Compass ID: 327594480 Version 3


Release 5.2.1 DVMRP Commands

ip dvmrp output-report-delay
The ip dvmrp output-report-delay command configures transmission delays
between packet sets 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: 327594480 Version 3 12-5


BSR 64000 Command Reference Guide Release 5.2.1

ip dvmrp out-report-filter
The ip dvmrp out-report-filter command uses the specified 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 specified 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 access list for filtering outgoing route reports

Command Default
Disabled

12-6 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 12-7


BSR 64000 Command Reference Guide Release 5.2.1

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 all neighbors, even those that do not support DVMRP
pruning or grafting.
Use the ip dvmrp reject-non-pruners command to discard a DVMRP report
message that does not have 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 Compass ID: 327594480 Version 3


Release 5.2.1 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 DVMRP 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: 327594480 Version 3 12-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 12-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 12-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 12-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 12-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 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: 327594480 Version 3 13-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-5


BSR 64000 Command Reference Guide Release 5.2.1

bootrom-filename
The bootrom-filename command sets the BSR Boot ROM filename using a Boot
ROM image file stored in either Flash memory, NVRAM on the Supervisory Routing
Module (SRM), or on an FTP or TFTP server.

Note: Using the update chassis <Boot ROM filename> command will set
the Boot ROM filename automatically. However, you must save the
configuration when prompted to preserve the Boot ROM filename across a
reboot of the chassis.

If the chassis has been restarted before the updated configuration has been
saved, you will need to use the bootrom-filename command to set the Boot
ROM filename so that automatic Boot ROM recovery can function properly.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


bootrom-filename {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 on an FTP or TFTP server

13-6 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

bootrom-invalidate slot
Boot ROM invalidate and recovery is a feature available on BSR 64000 5.x releases
that allows the SRM to send Boot Invalidation Indication messages to a module
running Mini ROM through the bootroom-invalidate slot command for the desired
module. If Mini ROM receives a Boot Invalidation Indication message, it will mark
its current secondary boot image as invalid and start a TFTP download of a new boot
image from the SRM. Bootrom invalidate is useful in the event that a module has a
valid secondary boot image, but has unforeseen issues with bringing up the module
properly, such as neglecting to provide support for a newer version of a particular
component. Boot ROM invalidate allows a user to downgrade a module to a
previously known working Boot ROM or to a newer version which properly handles
the newer components.

Note: The Boot ROM invalidate and recovery feature is only supported by the
TX32 and 2:8 CMTS modules. These are the only modules that currently
support running a Mini ROM and therefore the Boot ROM invalidate and
recovery feature.

Group Access
All

Command Modes
Privileged EXEC and Global Configuration

Command Line Usage


bootrom-invalidate slot <NUM>

Command Syntax

NUM the BSR chassis slot number

Compass ID: 327594480 Version 3 13-7


BSR 64000 Command Reference Guide Release 5.2.1

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 is a list of local and/or remote downstream channels


separated by spaces
for a description of the • local channels are represented as a single digit
NUM syntax for channel number
downstream channels, • remote channels are in the form slot/downstream port
refer to the figure below number/downstream channel number - a remote
this table TX32 downstream channel must be bound before it
can be bonded
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

13-8 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

4/[0-7]/[0-3] 9/[0-1] 11/[0-1]

TX32 Module Slot Number/ 2:8 CMTS Module Slot Number/


TX32 Downstream Port Number/ Downstream Port Number
TX32 Downstream Channel Number

Command Default
A MAC Domain definition is defined for each resource module slot in which a 2:8
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.

Compass ID: 327594480 Version 3 13-9


BSR 64000 Command Reference Guide Release 5.2.1

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

13-10 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-11


BSR 64000 Command Reference Guide Release 5.2.1

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

13-12 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

Compass ID: 327594480 Version 3 13-13


BSR 64000 Command Reference Guide Release 5.2.1

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

13-14 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-15


BSR 64000 Command Reference Guide Release 5.2.1

cable dhcp preserve-server-id


The cable dhcp preserve-server-id command prevents the modification of DHCP
option 54, server ID, as a part of MPLS VPN support on the BSR 64000. The no
cable dhcp preserve-server-id command re-establishes the default behavior, which
is to allow modification of DHCP option 54.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable dhcp preserve-server-id
no cable dhcp preserve-server-id

Command Default
Disabled

13-16 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-17


BSR 64000 Command Reference Guide Release 5.2.1

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-18 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

10-254 DHCPLEASEQUERY message type

Command Default
10

Compass ID: 327594480 Version 3 13-19


BSR 64000 Command Reference Guide Release 5.2.1

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-20 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-21


BSR 64000 Command Reference Guide Release 5.2.1

cable disable eth-pkt-filtering


The cable disable eth-pkt-filtering command disables filtering of Ethernet packets
based on MAC addresses received at the CMTS. When Ethernet packet filtering is
disabled, the CMTS accepts and processes any Ethernet packet. The no cable disable
eth-pkt-filtering command enables the filtering of Ethernet packets.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable disable eth-pkt-filtering
no cable disable eth-pkt-filtering

Command Default
Enabled

13-22 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream aggregate


The cable downstream aggregate command configures a downstream aggregate rate
limiter.
If numerous service flows are backlogged and rate limiting is turned on, dpsDsTask
can run at high CPU levels This command implements a downstream ARL and
calendar scheduled flow rate limiting to resolve the high dspDsTask CPU level due to
rate limiting and can also improved downstream throughput.

Warning: The cable downstream aggregate command should be used only


when instructed to do so by Motorola support personnel

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> aggregate { burst <250-1000000> | fraction <0-100>}
no cable downstream <NUM> aggregate { burst <250-1000000> | fraction
<0-100>}

Command Syntax

NUM the downstream port number


burst 250-1000000 the downstream traffic burst downstream in
usec
fraction 0-100 the percentage of downstream throughput

Command Default
fraction = 95%

Compass ID: 327594480 Version 3 13-23


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream bdm-interval


The cable downstream bdm-interval command configures the Motorola proprietary
bonding descriptor message transmission interval.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable bdm-interval <100-2000>
no cable bdm-interval <100-2000>

Command Syntax

100-2000 bonding descriptor message interval in


milliseconds - entries will be rounded to
nearest 50 milliseconds - for example, an
entry of 151 milliseconds would be rounded
to 200 milliseconds - the default bonding
descriptor message transmission interval is
2000 milliseconds (2 seconds) - a value of "0"
disables sending MDD messages on this
MAC Domain

Command Default
250 milliseconds

13-24 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream bonding disable


The cable downstream bonding disable command disables channel bonding for a
downstream channel. The no cable downstream bonding disable command enables
channel bonding for a downstream channel.

Note: Disabling downstream channel bonding during run-time will result in


the deregistration of all bonding cable modems associated with this MAC
domain.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream bonding disable
no cable downstream bonding disable

Command Default
Enabled

Compass ID: 327594480 Version 3 13-25


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream bonding-domain


The cable downstream bonding-domain command configures a bonding domain
that will be used for binding more than one MAC Domain to a bonding group. The no
cable downstream bonding-domain removes a bonding domain from the BSR’s
configuration.
All bonding groups configured in a bonding domain must be deleted before removing
that bonding domain from the BSR’s configuration. The BSR will not allow the
configuration of bonding domains whose slots are currently configured in an existing
bonding domain.
For example, if a bonding domain is currently configured to include slots 1 and 2 and
the user wants to remove slot 2 from that bonding domain, the bonding domain
consisting of slots 1 and 2 must first be removed and then a new bonding domain must
be created that only includes slot 1.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable downstream bonding-domain <NUM> [<NUM>]
no cable downstream bonding-domain <NUM> [<NUM>]

Command Syntax

NUM the BSR 2:8 CMTS module slot number

13-26 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream bonding-group


The cable downstream bonding-group command is used to configure a DOCSIS 3.0
downstream channel bonding group. The no cable downstream bonding-group
command removes a downstream channel bonding group.

Note: To configure a Motorola Proprietary downstream channel bonding


group, refer to the cable downstream mot-bonding-group command.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream bonding-group <1-65535> <NUM>
no cable downstream bonding-group <1-65535> <NUM>

Compass ID: 327594480 Version 3 13-27


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

1-65535 the DOCSIS 3.0 downstream


channel bonding group number
NUM a list of local and/or remote
downstream channels associated
with this channel bonding group
which includes TX32 or 2:8 CMTS
modules installed in the BSR -
• local channels are represented as
a single digit channel number
• remote channels are in the form
slot/downstream port number/
downstream channel number
each in the channel list needs to be
separated by a space - a remote
TX32 downstream channel must be
bound before it can be bonded (refer
to the example output below)

4/[0-7]/[0-3] 9/[0-1] 11/[0-1]

TX32 Module Slot Number/ 2:8 CMTS Module Slot Number/


TX32 Downstream Port Number/ Downstream Port Number
TX32 Downstream Channel Number

13-28 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream carrier-only


The downstream carrier-only function is disabled by default and is used for testing
purposes only to control the behavior of the downstream output. The cable
downstream carrier-only command is optionally used as a test function to enable the
sending of an un-modulated (CW) RF carrier on the downstream port. The no cable
downstream carrier-only command disables the sending of the un-modulated RF
carrier on the downstream port.

Group Access
MSO

Command Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> carrier-only
no cable downstream <NUM> carrier-only

Command Syntax

NUM the downstream channel or port number

Command Default
Modulation to the RF carrier is disabled.

Compass ID: 327594480 Version 3 13-29


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream channel-id


The cable downstream channel-id command allows a user to specify a Channel ID
number for a downstream port instead of using the default pre-defined Channel IDs
that are automatically assigned to the downstream ports by the SRM. Refer to the BSR
64000 CMTS Configuration and Management Guide for a listing of the default
downstream channel IDs.

Note: Channel IDs must be unique within a BSR chassis.

Group Access
MSO

Command Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> channel-id <1-255>
no cable downstream <NUM> channel-id <1-255>

Command Syntax

NUM the downstream channel or port


number
1-255 the downstream Channel ID number

13-30 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream channel-mode


The cable downstream channel-mode command configures the channel mode (1
channel, 2 channel, or 4 channel) of a TX32 downstream RF port. The no cable
downstream channel-mode command returns to the default value. When configured
to the default value of “4”, the configuration is not displayed in with the show
running-config downstream port command.

Note: The TX32 downstream RF port must be shutdown before changing the
channel mode of the port. Also, the user must first unbind the already bound
affected channels of the TX32 downstream RF port before changing the
channel mode of the port.

Group Access
MSO

Command Mode
TX32 Downstream Configuration

Command Line Usage


cable downstream channel-mode {1 | 2 | 4}
no cable downstream channel-mode {1 | 2 | 4}

Command Syntax

1 allocate 1 channel on this port


2 allocate 2 channels on this port
4 allocate 4 channels on this port

Command Default
4 = allocate 4 channels on this port

Compass ID: 327594480 Version 3 13-31


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream description


The cable downstream description command is used to specify descriptive
information for a downstream port.
For example: an MSO could assign the following description:
MOT:7A(config-ds)#cable downstream description TX32 dsport 0
MOT:7A(config-if)#cable downstream 0 description 2:8 local dsport 0

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.

Group Access
MSO

Command Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage

TX32 Downstream Configuration Mode


cable downstream description <LINE>

Cable Interface Configuration Mode


cable downstream <NUM> description <LINE>

Command Syntax

NUM the downstream port number


LINE the text that describes the interface - this
information is limited to 80 characters -
spaces can be used and are counted as a part
of the 80 character limit

13-32 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream fiber-node


The cable downstream fiber-node command associates a TX32 RF Port or CMTS
2:8 downstream port to one or more configured Fiber Nodes. The no cable
downstream fiber-node command removes a Fiber Node association.

Group Access
MSO

Command Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage

TX32 Downstream Configuration Mode


cable downstream fiber-node <WORD>
no cable downstream fiber-node

Cable Interface Configuration Mode


cable downstream <NUM> fiber-node <WORD>
no cable downstream <NUM> fiber-node

Command Syntax

NUM the downstream port number


WORD is the list of Fiber Node names separated by
commas with no spaces allowed

Compass ID: 327594480 Version 3 13-33


BSR 64000 Command Reference Guide Release 5.2.1

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 four downstream frequencies of a TX32 downstream port are


configured by configuring downstream channel 0’s center frequency. Explicit
configuration of the downstream frequency for channels 1-3 is not allowed.
The downstream frequencies of channels 1-3 are derived internally as the
next three contiguous frequencies in the spectrum (based on a channel-width
of 6 or 8 MHz) from the downstream frequency defined for channel 0.

Note: The respective DOCSIS standard (North American DOCSIS,


Euro-DOCSIS, or Japan-DOCSIS) must be specified with the cable dtx type
command before a downstream frequency can be selected for a TX32
module.

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 2:8 module.

Group Access
MSO

Command Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

13-34 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Line Usage

North American DOCSIS


cable downstream <NUM> frequency <91000000-857000000>
no cable downstream <NUM> frequency <91000000-857000000>
EuroDOCSIS Standard
cable downstream <NUM> frequency <91000000-858000000>
no cable downstream <NUM> frequency <91000000-858000000>

Japan DOCSIS (J-DOCSIS) Standard


cable downstream <NUM> frequency <91000000-860000000>
no cable downstream <NUM> frequency <91000000-860000000>

Command Syntax

NUM the downstream channel or port number


91000000-857000000 the downstream carrier center frequency for
the North American DOCSIS standard - valid
values are from 91000000 to 857000000
Hertz (Hz) for North American DOCSIS and
should be in multiples of 62500 Hz
112000000-858000000 the downstream carrier center frequency for
the EuroDOCSIS standard - valid values are
from 112000000 to 858000000 Hertz (Hz) for
EuroDOCSIS and should be in multiples of
62500 Hz
91000000-860000000 the downstream carrier center frequency for
the Japan DOCSIS (J-DOCSIS) Standard -
valid values are from 91000000 to 857000000
Hertz (Hz) for Japan DOCSIS and should be
in multiples of 62500 Hz

Command Default
555000000 Hz

Compass ID: 327594480 Version 3 13-35


BSR 64000 Command Reference Guide Release 5.2.1

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 Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage

TX32 Downstream Configuration Mode


cable downstream interleave-depth {8 | 16 | 32 | 64 | 128}
no cable downstream interleave-depth {8 | 16 | 32 | 64 | 128}

Cable Interface Configuration Mode


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-36 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Review the following to determine the appropriate interleave-depth. The increment


parameter determines the amount of delay increment in symbols for each additional
tap in the algorithm

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: 327594480 Version 3 13-37


BSR 64000 Command Reference Guide Release 5.2.1

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 Modes
TX32 Downstream Configuration
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 or port number


WORD the name of the load balancing group to
assign to this downstream channel or port
number

13-38 Compass ID: 327594480 Version 3


Release 5.2.1 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 Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage

TX32 Downstream Configuration Mode


cable downstream modulation {256 | 64}
no cable downstream modulation {256 | 64}

Cable Interface Configuration Mode


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: 327594480 Version 3 13-39


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream mot-bonding-group


The cable downstream mot-bonding-group command is used to configure a
Motorola proprietary downstream channel bonding group. The no cable downstream
mot-bonding-group command removes a downstream Motorola proprietary
downstream channel bonding group.

Note: To configure a DOCSIS 3.0 downstream channel bonding group, refer


to the cable downstream bonding-group command.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream mot-bonding-group <1-65535> <NUM>
no cable downstream mot-bonding-group <1-65535> <NUM>

13-40 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

1-65535 the downstream Motorola


proprietary channel bonding group
number
NUM a list of local and/or remote
downstream channels associated
with this channel bonding group
which includes TX32 or 2:8 CMTS
modules installed in the BSR -
• local channels are represented as
a single digit channel number
• remote channels are in the form
slot/downstream port number/
downstream channel number
each in the channel list needs to be
separated by a space - a remote
TX32 downstream channel must be
bound before it can be bonded (refer
to the example output below)

4/[0-7]/[0-3] 9/[0-1] 11/[0-1]

TX32 Module Slot Number/ 2:8 CMTS Module Slot Number/


TX32 Downstream Port Number/ Downstream Port Number
TX32 Downstream Channel Number

Compass ID: 327594480 Version 3 13-41


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream multicast enable


The cable downstream multicast enable command allows a user to configure a
downstream channel as “multicast capable”. This enables the replication of
downstream multicast packets on the specified channel/port. The no cable
downstream multicast enable command disables the replication of a downstream
multicast packets on this downstream channel/port.

Group Access
MSO

Command Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage

TX32 Downstream Configuration Mode


cable downstream <0-3> multicast enable
no cable downstream <0-3> multicast enable

Cable Interface Configuration Mode


cable downstream <NUM> multicast enable
no cable downstream <NUM> multicast enable

Command Syntax

0-3 the TX32 downstream channel number


NUM the CMTS 2:8 downstream port number

Command Default
Enabled

13-42 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream non-bonding-reset interval


The cable downstream non-bonding-reset interval configures the periodic resetting
of bonding capable cable modems operating in a non-bonded mode fter a specific
time interval. The no cable downstream non-bonding-reset interval command
disables the periodic resetting of bonding capable cable modems operating in a
non-bonded mode fter a specific time interval.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable downstream non-bonding-reset interval <5-10080>
no cable downstream non-bonding-reset interval

Command Syntax

10080 the reset interval in minutes

Command Default
Disabled

Compass ID: 327594480 Version 3 13-43


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream port


TX32 Downstream Port Configuration mode allows a user to configure a TX32
downstream port. The cable downstream port command enters TX32 Downstream
Port Configuration mode. After issuing the cable downstream port command, the
command line prompt changes to:
MOT:7A(config-ds)#
Use the end or exit commands to return to Global Configuration mode.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable downstream port <X/Y>

Command Syntax

X/Y the slot and downstream port number


of the TX32 module

13-44 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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. The cable downstream power-level command set
the absolute power level in tenths of dBmV.

Note: The allowed power levels that can be specified with the cable
downstream power-level command for theTX32 will vary depending on the
channel mode that the TX32 is set to with the cable downstream
channel-mode command (1, 2, or 4 channel mode).

Power-level ranges valid for a TX32 port are as follows:

Channel Mode 1 Power Level <520-600>


Channel Mode 2 Power Level <480-560>
Channel Mode 4 Power Level <440-520>

If a power level is configured beyond the range allowed, an error will be


displayed and the configuration will be rejected.

Group Access
MSO

Command Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Compass ID: 327594480 Version 3 13-45


BSR 64000 Command Reference Guide Release 5.2.1

Command Line Usage

TX32 Downstream Configuration Mode


cable downstream power-level <440-600>
no cable downstream power-level <440-600>

Cable Interface Configuration Mode


cable downstream <NUM> power-level <450-630>
no cable downstream <NUM> power-level <450-630>

Command Syntax

NUM the downstream port number


440-600 downstream power level value for a TX32
module in tenths of a dBmV
450-630 downstream power level value for a 2:8
CMTS module in tenths of a dBmV

Command Defaults
2:8 CMTS module = 550 (55.0 dBmV)
TX32 module = 520 (52.0 dBmV)

13-46 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream primary-capable


The cable downstream primary-capable command enables the primary capable
option for a downstream channel port. The no cable downstream primary-capable
command to disables the primary capable option for a downstream channel or port.
When configured to the default to value of “Enabled”, the cable downstream
primary-capable configuration is not displayed in the show running-config
command output.

Group Access
MSO

Command Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> primary-capable
no cable downstream <NUM> primary-capable

Command Syntax

NUM the downstream channel or port number

Command Default
Enabled

Compass ID: 327594480 Version 3 13-47


BSR 64000 Command Reference Guide Release 5.2.1

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. A token-bucket algorithm is
used for rate limiting.

Note: If rate limiting is enabled, downstream traffic is rate limited according to


the cable modem’s configured throughput. 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 Modes
TX32 Downstream Configuration Mode
Interface Configuration (cable interface only)

Command Line Usage


cable downstream <NUM> rate-limit
no cable downstream <NUM> rate-limit

Command Syntax

NUM the downstream channel or port number

Command Default
Disabled

13-48 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-49


BSR 64000 Command Reference Guide Release 5.2.1

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 Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage

TX32 Downstream Configuration Mode


cable downstream scrambler on
no cable downstream scrambler on

Cable Interface Configuration Mode


cable downstream <NUM> scrambler on
no cable downstream <NUM> scrambler on

Command Syntax

NUM the downstream port number

13-50 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream shutdown


The cable downstream shutdown command is used to disable an enabled
downstream port. 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 Modes
TX32 Downstream Configuration
Interface Configuration (cable interface only)

Command Line Usage

TX32 Downstream Configuration Mode


cable downstream shutdown
no cable downstream shutdown
cable downstream <NUM> shutdown
no cable downstream <NUM> shutdown

Cable Interface Configuration Mode


cable downstream <NUM> shutdown
no cable downstream <NUM> shutdown

Command Syntax

NUM the downstream channel or port number

Command Default
The downstream port(s) on the cable interface is disabled or "shut down" by default.

Compass ID: 327594480 Version 3 13-51


BSR 64000 Command Reference Guide Release 5.2.1

cable downstream sync-interval


The cable downstream sync-interval command sets the synchronization interval
between transmission of successive SYNC messages from the TX32 to the cable
modems. The synchronization message interval is the interval between successive
synchronization message transmissions from a TX32’s RF port. The no cable
downstream sync-interval returns the interval setting to transmit SYNC messages to
the default.

Note: Disable the cable interface using the cable downstream shutdown
command before using the cable downstream sync-interval command.

The BSR will only send SYNC messages on primary capable downstream channels.

Group Access
MSO

Command Mode
TX32 Downstream Configuration

Command Line Usage


cable downstream sync-interval <0-200>
no cable downstream sync-interval <0-200>

Command Syntax

0-200 synchronization interval in milliseconds.

Command Default
10

13-52 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable downstream threshold


The cable downstream threshold command specifies downstream channel upper and
lower queue thresholds for a 2:8 CMTS or 2:8 (2.0) CMTS module. 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: 327594480 Version 3 13-53


BSR 64000 Command Reference Guide Release 5.2.1

Command Defaults
upper byte threshold = 1000 bytes
lower byte threshold = 500 bytes
upper pdu threshold = 32 PDUs
lower pdu threshold = 16 PDUs

Note: When using the byte count parameter as the threshold unit, 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.

13-54 Compass ID: 327594480 Version 3


Release 5.2.1 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 Modes
TX32 Downstream Configuration
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 channel or port number

Command Default
Disabled

Compass ID: 327594480 Version 3 13-55


BSR 64000 Command Reference Guide Release 5.2.1

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 Modes
TX32 Downstream Configuration
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 channel or port number

Command Default
Disabled

13-56 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable dtx type


The cable dtx type command configures the operational mode of a TX32 module. If
the default configuration of domestic is used, the cable dtx type command
configuration does not appear in the show running-config command output. The
cable dtx type command is only applicable to TX32 slots.

Note: All downstream channels of the DTX card must be administratively


shutdown before the DTX type is changed.

The respective DOCSIS standard (North American DOCSIS, EuroDOCSIS,


or Japan-DOCSIS) must be specified with the cable dtx type command
before a downstream frequency can be selected for a TX32 module.

Group Access
MSO

Command Mode
TX32 Slot Configuration

Command Line Usage


cable dtx type {domestic | euro | japan }

Command Syntax

domestic set module type to North American DOCSIS


standard
euro set module type to EuroDOCSIS standard
japan set module type to Japan-DOCSIS standard

Command Default
domestic

Compass ID: 327594480 Version 3 13-57


BSR 64000 Command Reference Guide Release 5.2.1

cable dynamic-service admitted-timeout


The cable dynamic-service admitted-timeout command allows a user to set an
admitted timeout value for admitted service flows. If the admitted timeout value is
exceeded by a service flow, the service flow is deleted. In previous software releases,
the service flow was only deferred. The value specified with this command will be
used for the admitted timeout unless an admitted timeout value is specified by the
TLV. The no cable dynamic-service admitted-timeout command disables the
admitted timeout timer.

Group Access
MSO

Command Mode
Interface Configuration (cable or loopback interfaces only)

Command Line Usage


cable dynamic-service admitted-timeout <0-65535>
no cable dynamic-service admitted-timeout

Command Syntax

0-65535 the admitted timeout in seconds, a value of


"0" disables the admitted timeout timer

Note: Disabling the cable dynamic-service admitted-timeout command by


using a value of "0" or using the no version of the command, causes a
service flow that has exceeded an admitted timeout to be deferred instead of
deleted as in previous software releases.

Command Default
0

13-58 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable fast-path cm
The cable fast-path cm command enables HSIM fast path forwarding of cable
modem traffic by adding cable modem ARP entries to the HSIM fast path. The no
cable fast-path cm command disables HSIM fast path forwarding of cable modem
traffic.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable fast-path cm
no cable fast-path cm

Command Default
Enabled

Compass ID: 327594480 Version 3 13-59


BSR 64000 Command Reference Guide Release 5.2.1

cable filter group index src-ip


The cable filter group index src-ip command configures the source IP address and
bit mask, which must match the classified packet’s source IP address and bit mask.
The no cable filter group index src-ip command returns to the default values.
The no cable filter group index command deletes the assigned packet filter group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable filter group <1-32> index <1-64> src-ip <A.B.C.D> <A.B.C.D>
no cable filter group <1-32> index <1-64> src-ip <A.B.C.D> <A.B.C.D>
no cable filter group <1-32> index <1-64>

Command Syntax

1-32 subscriber management filter group


number
1-64 submanagement packet filter number
(index)
A.B.C.D source IP address
A.B.C.D source IP bit mask

Command Default
source IP address: 0.0.0.0
source IP bit mask: 0.0.0.0

13-60 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable filter group index dst-ip


The cable filter group index dst-ip command configures the destination IP address
and bit mask, which must match the classified packet’s destination IP address and bit
mask.
The no cable filter group index dst-ip command returns to the default values.
The no cable filter group index command deletes the assigned packet filter group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable filter group <1-32> index <1-64> dst-ip <A.B.C.D> <A.B.C.D>
no cable filter group <1-32> index <1-64> dst-ip <A.B.C.D> <A.B.C.D>
no cable filter group <1-32> index <1-64>

Command Syntax

1-32 subscriber management filter group


number
1-64 submanagement packet filter number
(index)
A.B.C.D destination IP address
A.B.C.D destination IP bit mask

Command Default
destination IP address: 0.0.0.0
destination IP bit mask: 0.0.0.0

Compass ID: 327594480 Version 3 13-61


BSR 64000 Command Reference Guide Release 5.2.1

cable filter group index ulp


Use the cable filter group index ulp command in Global Configuration mode to
configure the Layer 4 upper level protocol (ULP) IP protocol number, which is to be
matched in the classified packet.
The no cable filter group index ulp command returns to the default value.
The no cable filter group index command deletes the assigned packet filter group.

Note: If the ULP number is 256, it matches all ULP values.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable filter group <1-32> index <1-64> ulp <0-256>
no cable filter group <1-32> index <1-64> ulp <0-256>
no cable filter group <1-32> index <1-64>

Command Syntax

1-32 subscriber management filter group


number
1-64 submanagement packet filter number
(index)
0-256 ULP number

Command Default
256

13-62 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable filter group index tos


The cable filter group index tos command configures the Type of Service (TOS)
value and mask, which is to be matched in the classified packet.
The no cable filter group index tos command returns to the default value.
The no cable filter group index command deletes the assigned packet filter group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable filter group <1-32> index <1-64> tos <0x0-0xff> <0x0-0xff>
no cable filter group <1-32> index <1-64> tos <0x0-0xff> <0x0-0xff>
no cable filter group <1-32> index <1-64>

Command Syntax

1-32 subscriber management filter group


number
1-64 submanagement packet filter number
(index)
0x0-0xff hexidecimal TOS number
0x0-0xff hexidecimal TOS mask

Command Default
0x0

Compass ID: 327594480 Version 3 13-63


BSR 64000 Command Reference Guide Release 5.2.1

cable filter group index action


The cable filter group index action command configures the action to take when the
packet filter matches.
The no cable filter group index action command disables the packet filter.
The no cable filter group index command deletes the assigned packet filter group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable filter group <1-32> index <1-64> action {accept | drop}
no cable filter group <1-32> index <1-64> action {accept | drop}
no cable filter group <1-32> index <1-64>

Command Syntax

1-32 subscriber management filter group


number
1-64 submanagement packet filter number
(index)
accept accepts the packet for further
processing
drop discards the packet

Command Default
accept

13-64 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable filter group index enable


The cable filter group index enable command enables the configured packet filter.
The no cable filter group index enable command disables the configured packet
filter.
The no cable filter group index command deletes the assigned packet filter group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable filter group <1-32> index <1-64> enable
no cable filter group <1-32> index <1-64> enable
no cable filter group <1-32> index <1-64>

Command Syntax

1-32 subscriber management filter group


number
1-64 submanagement packet filter number
(index)

Command Default
Disabled

Compass ID: 327594480 Version 3 13-65


BSR 64000 Command Reference Guide Release 5.2.1

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

13-66 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Default
1440 minutes

Compass ID: 327594480 Version 3 13-67


BSR 64000 Command Reference Guide Release 5.2.1

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

13-68 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-69


BSR 64000 Command Reference Guide Release 5.2.1

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

13-70 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-71


BSR 64000 Command Reference Guide Release 5.2.1

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

13-72 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-73


BSR 64000 Command Reference Guide Release 5.2.1

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 [isp-bind <A.B.C.D>] | mta
[isp-bind <A.B.C.D>]}

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


[isp-bind <A.B.C.D>]}

13-74 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

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


server.
cable-modem specifies that only CM 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.

Compass ID: 327594480 Version 3 13-75


BSR 64000 Command Reference Guide Release 5.2.1

cable helper-address host vendor-class-identifiers


The cable helper-address host vendor-class-identifiers command assigns a helper
address to a vendor class identifier (VCI) group. This helper address will only be used
when a host includes the VCI option (option 60) and the field matches one of the VCI
strings in the assigned VCI group.

Group Access
System Administrator

Command Mode
Interface Configuration (cable or loopback interfaces only)

Command Line Usage


cable helper-address <A.B.C.D> host vendor-class-identifiers <1-32> [global |
vrf ]
no cable helper-address <A.B.C.D> host vendor-class-identifiers <1-32> [global |
vrf ]

Command Syntax

1-32 the vendor class identifier group number


global specify that the helper address is on the global
network
vrf specify that the helper address is on a VPN

13-76 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-77


BSR 64000 Command Reference Guide Release 5.2.1

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-78 Compass ID: 327594480 Version 3


Release 5.2.1 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.

Note: The cable intercept command is only available to a user logged in as


securityuser - refer to Configuring Cable Intercepts in the BSR 64000 CMTS
Configuration and Management Guide.

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

Compass ID: 327594480 Version 3 13-79


BSR 64000 Command Reference Guide Release 5.2.1

Command Line Usage


cable intercept <mac> <prefix> <0-65535>
no cable intercept <mac> <prefix> <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.
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.

13-80 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable ip-broadcast-echo
The cable ip-broadcast-echo command reflects all upstream broadcast flows back to
the downstream to mimic a broadcast domain. The no cable ip-broadcast-echo
command disabled this functionality.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable ip-broadcast-echo
no cable ip-broadcast-echo

Command Default
Disabled

Compass ID: 327594480 Version 3 13-81


BSR 64000 Command Reference Guide Release 5.2.1

cable ip-multicast-echo
The cable ip-multicast-echo command reflects all upstream multicast flows back to
the downstream to mimic a multicast domain. The no cable ip-multicast-echo
command disabled this functionality.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable ip-multicast-echo
no cable ip-multicast-echo

Command Default
Disabled

13-82 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable load-balance
The cable load-balance command executes downstream or upstream static load
balancing (based on ds-reg or us-reg rules) for all registered cable modems in the
affected load balancing groups. Downstream or upstream static count-based load
balancing evenly distributes cable modems across multiple channels serving the same
geographical community or Spectrum Group. The term "static" means that the BSR
will only attempt to move a cable modem to another channel after the registration
process is complete. Static downstream or upstream load balancing occurs
automatically moves a newly registered cable modem to the least loaded channel.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


cable load-balance [downstream| upstream] [loadbalance-group <WORD>]

Command Syntax

downstream enable downstream cable modem count load


balancing
upstream enable upstream cable modem count load
balancing
loadbalance-group load balance the specified load balancing
WORD group

Compass ID: 327594480 Version 3 13-83


BSR 64000 Command Reference Guide Release 5.2.1

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

13-84 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-85


BSR 64000 Command Reference Guide Release 5.2.1

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

13-86 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

Compass ID: 327594480 Version 3 13-87


BSR 64000 Command Reference Guide Release 5.2.1

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 | spec-trigger | 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> |
rem-dsx | spec-trigger | 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

13-88 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

ds-util min 0-100 minimum threshold percentage of


downstream utilization before load-balancing
starts - any downstream channel that has a
minimum utilization value of "0" will
participate in load balancing
ds-util delta 0-100 delta percentage of downstream utilization
between load-balancing channels to start load
balancing - the delta between two
downstream channels must be equal to or
exceed a utilization of "0" before load
balancing can start
ds-util stop 0-100 delta percentage of downstream utilization
between load-balancing channels to stop load
balancing - when moving cable modems
between downstream channels the process
will attempt to bring the channels as close to
"0" as possible before stopping
enable enable the load balancing rule
interval 5-480 periodic interval for load balancing in
minutes
rem-dsx remote DSX resource failure load-balancing
spec-trigger trigger load balancing when there is a
spectrum management configuration change
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 - any
upstream channel that has a minimum
utilization value of "0" will participate in load
balancing

Compass ID: 327594480 Version 3 13-89


BSR 64000 Command Reference Guide Release 5.2.1

us-util delta 0-100 delta percentage of upstream utilization


between load-balancing channels to start load
balancing - the delta between two upstream
channels must be equal to or exceed a
utilization of "0" before load balancing can
start
us-util stop 0-100 delta percentage of upstream utilization
between load-balancing channels to stop load
balancing - when moving cable modems
between upstream channels the process will
attempt to bring the channels as close to "0"
as possible before stopping
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.

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 86399

cable loadbalance-rule <WORD> dis-period 1 32400

Command Defaults
us-reg modem-count-thresh = 5

13-90 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-91


BSR 64000 Command Reference Guide Release 5.2.1

cable mdd-interval
In order to communicate topology and IP layer service initialization parameters to a
DOCSIS 3.0 Cable Modem, the BSR transmits an MAC Domain Descriptor (MDD)
message periodically on every downstream channel in the MAC Domain. The MDD
message is configured with the cable mdd-interval command. A separate MDD
message is sent for each downstream channel associated with the bonding domain
where a DOCSIS 3.0 bonding group is configured. This message is used by the cable
modem during initialization. The information provided to the cable modem in the
MDD message allows the cable modem to identify the downstream fiber node it is
connected to and which downstream channels reach it. The downstream fiber node is
identified by the MAC Domain Downstream Service Group (MD-DS-SG). MDD
messages will coexist on the same downstream channel with Motorola Proprietary
BDM messages if a Motorola Proprietary bonding group and a DOCSIS 3.0 bonding
group share the same channel.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable mdd-interval <0-2000>
no cable mdd-interval <0-2000>

Command Syntax

0-2000 MAC Domain Descriptor message interval in


milliseconds - entries will be rounded to
nearest 50 milliseconds - a value of "0"
disables sending MDD messages on this
MAC Domain

Command Default
2000 milliseconds (2 seconds)

13-92 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-93


BSR 64000 Command Reference Guide Release 5.2.1

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

13-94 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-95


BSR 64000 Command Reference Guide Release 5.2.1

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.

13-96 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-97


BSR 64000 Command Reference Guide Release 5.2.1

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.

13-98 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

Warning: Cable modems already registered need to be reset for any


configuration change to take effect.

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 the number of CPE hosts

Compass ID: 327594480 Version 3 13-99


BSR 64000 Command Reference Guide Release 5.2.1

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.

13-100 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Default
none

Compass ID: 327594480 Version 3 13-101


BSR 64000 Command Reference Guide Release 5.2.1

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.

13-102 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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
1-262143 Service Flow Identifier (not all values are
valid at all times in a running system)

Command Default
none

Compass ID: 327594480 Version 3 13-103


BSR 64000 Command Reference Guide Release 5.2.1

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>

13-104 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable modem remote-query source-interface


If cable modems are configured to only allow SNMP access from certain trusted
subnets and the current Remote Query feature uses the virtual cable bundle IP address
as the source for SNMP access to these cable modems, access can be blocked.
Allowing a user to specify a source interface for Remote Query will provide SNMP
access to a trusted subnet.
The cable modem remote-query source-interface command sets the source
interface of the polls that are sent to cable modems when Remote Query is active.
If a source interface is not specified and Remote Query is active, polls will be sent
from any available IP address. The source interface may be specified before the
interface has an IP address configured and will then function as described once the IP
address is configured on the interface.
If the source interface is specified before it is active, Remote Query will use any
available IP address and will use the specified source interface once it is active.
The no cable modem remote-query source-interface disables the Remote Query
source interface configuration.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable modem remote-query source-interface {cable <X/Y | X/Y.N> | ethernet
<X/Y> | gigaether <X/Y | X/Y.N> | loopback <1-255> | tunnel <0-255>}
no cable modem remote-query source-interface {cable <X/Y | X/Y.N> | ethernet
<X/Y> | gigaether <X/Y | X/Y.N> | loopback <1-255> | tunnel <0-255>

Compass ID: 327594480 Version 3 13-105


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

cable X/Y set the remote query source interface for cable
cable X/Y.N interface slot X, MAC domain Y, and, if
applicable, cable sub-interface N
ethernet X/Y set the remote query source interface slot X
and port Y on the Ethernet interface:
gigaether X/Y set the remote query source interface slot X,
gigaether X/Y.N port Y, and, if applicable, the sub-interface N
on the Gigabit Ethernet
loopback 1-255 set the remote query source interface for the
specified loopback interface number
tunnel 0-255 set the remote query source interface for the
specified tunnel interface

13-106 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-107


BSR 64000 Command Reference Guide Release 5.2.1

cable modem service-class-name


Motorola assigns a Service Class Name (SCN) to all service flows for a cable modem
whether the CM registers with DOCSIS 1.0 or DOCSIS 1.1 registration parameters.
However, the SCN can also be explicitly assigned with DOCSIS 1.1
Type-Length-Value (TLV) parameters in the cable modem’s registration request, or
(as usually deployed) selected implicitly by the BSR based on the TLVs.
The cable modem service-class-name command overrides the selected service class
that defines the QoS parameters of one or both primary service flows for the
referenced CM.
When the cable modem service-class-name command is issued and the referenced
CM is already registered, the BSR dynamically changes the QoS parameters of the
primary service flow(s) according to the command without de-registering the CM.
When the referenced CM registers (or re-registers) with the cable modem
service-class-name command in effect, the BSR selects the referenced SCN(s) for the
QoS parameters of the CMs primary service flow(s).
The cable modem service-class-name command is typically used to lower the QoS
received by a CM as a penalty for non-payment, bandwidth overuse, etc. The no cable
modem service-class-name command removes the service class name override.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable modem <mac> service-class-name <WORD> [<WORD> ]
no cable modem <mac> service-class-name [<WORD> | <WORD> ]

13-108 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

mac The cable modem MAC address in the form


of xxxx.xxxx.xxxx.
WORD An existing service class name in either the
upstream or downstream direction.
WORD An existing service class name in the opposite
direction of <WORD> above. This is an
optional second service class name.

Compass ID: 327594480 Version 3 13-109


BSR 64000 Command Reference Guide Release 5.2.1

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

13-110 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-111


BSR 64000 Command Reference Guide Release 5.2.1

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

13-112 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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}

Compass ID: 327594480 Version 3 13-113


BSR 64000 Command Reference Guide Release 5.2.1

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

13-114 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

Compass ID: 327594480 Version 3 13-115


BSR 64000 Command Reference Guide Release 5.2.1

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

13-116 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-117


BSR 64000 Command Reference Guide Release 5.2.1

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

13-118 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-119


BSR 64000 Command Reference Guide Release 5.2.1

cable mta-protection enable


The cable mta-protection enable command enables or disables MTA protection for a
MAC domain. An MTA will be moved to a protected channel only when MTA
protection has been enabled with the cable mta-protection enable command in the
MAC domain in which the MTA registers. MTA protection is enabled by default. The
no cable mta-protection enable command disables MTA protection for a MAC
domain.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable mta-protection enable
no cable mta-protection enable

Command Default
Enabled

13-120 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-121


BSR 64000 Command Reference Guide Release 5.2.1

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-122 Compass ID: 327594480 Version 3


Release 5.2.1 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 two 2:8
Primary CMTS Resource Modules that share a 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: 327594480 Version 3 13-123


BSR 64000 Command Reference Guide Release 5.2.1

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-124 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-125


BSR 64000 Command Reference Guide Release 5.2.1

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-126 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-127


BSR 64000 Command Reference Guide Release 5.2.1

Command Default
profile 1

13-128 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-129


BSR 64000 Command Reference Guide Release 5.2.1

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-130 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable privacy enforce-bpi-plus


The cable privacy enforce-bpi-plus command mandates that a cable modem
provisioned in DOCSIS 1.1 or higher must register with DOCSIS Baseline Privacy
Interface Plus (BPI+) and not use the earlier version of DOCSIS BPI. The no cable
privacy enforce-bpi-plus command disables BPI+ enforcement.

Note: CMs provisioned with DOCSIS 1.0 are permitted to register without
BPI+.

Group Access
MSO

Command Mode
Global Configuration
Interface Configuration (cable interface only)

Command Line Usage


cable privacy enforce-bpi-plus
no cable privacy enforce-bpi-plus

Compass ID: 327594480 Version 3 13-131


BSR 64000 Command Reference Guide Release 5.2.1

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
MSO

Command Mode
Global Configuration
Interface Configuration (cable interface only)

Command Line Usage


cable privacy mandatory [bpi-plus-only ]
no cable privacy mandatory [bpi-plus-only ]

13-132 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

bpi-plus-only Require BPI+ for all CMs by default.

Compass ID: 327594480 Version 3 13-133


BSR 64000 Command Reference Guide Release 5.2.1

cable privacy mcast


The cable privacy mcast command enables the encryption of multicast traffic from a
specific IP address. The no cable privacy mcast command disables 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> [<15872-16381>]
no cable privacy mcast access <A.B.C.D> <A.B.C.D> [<15872-16381>]

Command Syntax

A.B.C.D the multicast IP address


A.B.C.D the multicast subnet mask
15872-16381 the multicast SAID number

13-134 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-135


BSR 64000 Command Reference Guide Release 5.2.1

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

13-136 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable qos max-burst


The cable qos max-burst command automatically adjusts the downstream maximum
burst based on the downstream maximum sustained rate (max-rate) and adjusts the
upstream maximum burst and maximum concatenated burst (max-concat-burst)
based on the upstream maximum sustained rate. The cable qos max-burst command
should be used only for service flows that do not have a not have maximum burst
setting defined with the max-burst command. The no cable qos max-burst
command disables automatic downstream or upstream maximum burst adjustments.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable qos max-burst {downstream automatic | upstream automatic}
no cable qos max-burst {downstream automatic | upstream automatic}

Command Syntax

downstream automatic Automatic maximum burst adjustments are


calculated for service flows in the
downstream direction only.
upstream automatic Automatic maximum burst adjustments are
calculated for service flows in the upstream
direction only.

Command Default
Disabled

Compass ID: 327594480 Version 3 13-137


BSR 64000 Command Reference Guide Release 5.2.1

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-138 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable security authorized


The cable security authorized command enables cable security authorization for a
MAC domain. The no cable security authorized command disables cable security
authorization for a MAC domain.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable security authorized
no cable security authorized

Command Default
Disabled

Compass ID: 327594480 Version 3 13-139


BSR 64000 Command Reference Guide Release 5.2.1

cable security failure


The cable security failure command configures how the BSR handles an initializing
cable modem after the CM’s second consecutive security failure. When an initializing
CM fails a cable security option check, it is said to have a “cable security failure”. In
order to account for present and future initializing CMs that may change their
behavior between initialization attempts, the BSR permits an initializing CM to have
one cable security failure before it applies a configured cable security failure action
after the second failure.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable security failure {mark | reject }

Command Syntax

mark This configuration allows the CM to register,


but the CM is “marked” as having failed a
security option.The BSR displays an
exclamation point (“!”) before the CM status
field (e.g. “!online”) in the show cable
modem command output for CMs which
were permitted to register with a cable
security failure.
reject This configuration means that the BSR
continues to reject the CMs registration and
resets the consecutive failure count to zero.

Command Default
cable security failure reject

13-140 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-141


BSR 64000 Command Reference Guide Release 5.2.1

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-142 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-143


BSR 64000 Command Reference Guide Release 5.2.1

cable spm-management
The cable spm-management command allows for the configuration of either
composite SNR or minimum SNR (single cable modem) as the basis for Advanced
Spectrum Management agility decisions. The command specifies the basic method
that Advanced Spectrum Management uses to determine upstream channel quality.
The no cable spm-management command returns the configuration to the default
value.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable spm-management {composite | minimum}
no cable spm-management {composite | minimum}

Command Syntax

composite use the average of all cable modems


to determine upstream channel
quality via SNR
minimum use a single cable modem to
determine upstream channel quality
via SNR
Note: The 15 cable modems with the
lowest SNR are excluded from being
the reference modem - refer to the
reference-modem-exclusion
command for more information on
this configuration.

Command Default
minimum

13-144 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable submgmt default cpe-control active


The cable submgmt default cpe-control active command configures the default
filter for controlling active CPEs if it is not signaled in the DOCSIS Registration
request.
The no cable submgmt default cpe-control active command returns to the default.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable submgmt default cpe-control active {true | false}
no cable submgmt default cpe-control active

Command Syntax

true CPE is active


false CPE is not active

Command Default
false

Compass ID: 327594480 Version 3 13-145


BSR 64000 Command Reference Guide Release 5.2.1

cable submgmt default cpe-control learnable


Sometimes the CMTS does not learn a CPE IP address from the DOCSIS
provisioning entries in a CM’s configuration file that is signaled in a DOCSIS
registration request.
The cable submgmt default cpe-control learnable command configures the default
for controlling whether or not a CPE IP address can be learned.
The no cable submgmt default cpe-control learnable command returns to the
default.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable submgmt default cpe-control learnable {true | false}
no cable submgmt default cpe-control learnable

Command Syntax

true CPE can be learned


false CPE cannot be learned

Command Default
true

13-146 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable submgmt default cpe-control max-cpe


The cable submgmt default cpe-control max-cpe command configures a packet
filter for controlling the number of CPEs, if it is not signaled in the DOCSIS
Registration request.
The no cable submgmt default cpe-control max-cpe command returns to the default
value.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable submgmt default cpe-control max-cpe <0-1024>
no cable submgmt default cpe-control max-cpe <0-1024>

Command Syntax

0-1024 default packet filter group number

Command Default
16 CPEs upon CMTS initialization

Compass ID: 327594480 Version 3 13-147


BSR 64000 Command Reference Guide Release 5.2.1

cable submgmt default filter-group


The cable submgmt default filter-group command configures the default filter
group for traffic applied to or from CPEs through its connected CM.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


cable submgmt default filter-group {downstream | upstream} <1-32>

Command Syntax

downstream default filter group for a CPE, for


traffic going to the CPE through its
connected CM on the downstream
from the CMTS
upstream default filter group for a CPE, for
traffic going from the CPE through
its connected CM on the upstream to
the CMTS
1-32 default packet filter group number

13-148 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable submgmt default filter-group cm


The cable submgmt default filter-group cm command configures the default filter
group for traffic applied to or from the CM itself.
The no cable submgmt default filter-group cm command removes the default filter
group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable submgmt default filter-group cm {downstream | upstream} <1-32>
no cable submgmt default filter-group cm {downstream | upstream} <1-32>

Command Syntax

downstream default filter group for a CM, for


traffic going to the CM on the
downstream from the CMTS
upstream default filter group for a CPE, for
traffic going from the CM on the
upstream to the CMTS
1-32 default packet filter group number

Compass ID: 327594480 Version 3 13-149


BSR 64000 Command Reference Guide Release 5.2.1

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-150 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable tcpudp-filter group index src-port


The cable tcpudp-filter group index src-port command configures which TCP/UDP
source port that should be matched in the classified packet.

Note: The default source port 65536 matches any value in the TCP or UDP
source field.

The no cable tcpudp-filter group index src-port command returns to the default
value.
The no cable tcpudp-filter group index command deletes an assigned TCP/UDP
packet filter group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable tcpudp-filter group <1-32> index <1-64> src-port <0-65536>
no cable tcpudp-filter group <1-32> index <1-64> src-port <0-65536>
no cable tcpudp-filter group <1-32> index <1-64>

Command Syntax

1-32 TCP/UDP packet filter group


number
1-64 packet filter
0-65536 source port to match in the classified
packet

Command Default
65536

Compass ID: 327594480 Version 3 13-151


BSR 64000 Command Reference Guide Release 5.2.1

cable tcpudp-filter group index dst-port


The cable tcpudp-filter group index dst-port command configures the TCP/UDP
destination port that should be matched in the classified packet.

Note: The default destination port 65536 matches any value in the TCP or
UDP destination field.

The no tcpudp-filter group index dst-port command disables the configured TCP/
UDP packet filter.
The no cable tcpudp-filter group index command deletes an assigned TCP/UDP
packet filter group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable tcpudp-filter group <1-32> index <1-64> dst-port <0-65536>
no cable tcpudp-filter group <1-32> index <1-64> dst-port <0-65536>
no cable tcpudp-filter group <1-32> index <1-64>

Command Syntax

1-32 TCP/UDP packet filter group


number
1-64 packet filter index number
0-65536 destination port to match in the
classified packet

Command Default
Source port 65536

13-152 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable tcpudp-filter group index enable


The cable tcpudp-filter group index enable command enables the configured TCP/
UDP packet filter.
The no cable tcpudp-filter group index enable command returns to the default.
The no cable tcpudp-filter group index command deletes an assigned TCP/UDP
packet filter group.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable tcpudp-filter group <1-32> index <1-64> enable
no cable tcpudp-filter group <1-32> index <1-64> enable
no cable tcpudp-filter group <1-32> index <1-64>

Command Syntax

1-32 TCP/UDP packet filter group


number
1-64 packet filter
0-65536 destination port to match in the
classified packet

Command Default
Disabled

Compass ID: 327594480 Version 3 13-153


BSR 64000 Command Reference Guide Release 5.2.1

cable tcpudp-filter group index tcp-flag


The cable tcpudp-filter group index tcp-flag command configures the desired TCP
packet header flag value and mask to match in the classified packet.
The no cable tcpudp-filter group index tcp-flag command returns to the default
value.
The no cable tcpudp-filter group index command deletes an assigned TCP/UDP
packet filter group.

Note: The TCP flag value must always be a subset (proper or otherwise) of
the mask field.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable tcpudp-filter group <1-32> index <1-64> tcp-flag <0x0-0x3f> <0x0-0x3f>
no cable tcpudp-filter group <1-32> index <1-64> tcp-flag <0x0-0x3f> <0x0-0x3f>
no cable tcpudp-filter group <1-32> index <1-64>

Command Syntax

1-32 TCP/UDP packet filter group number


1-64 packet filter
0x0-0x3f TCP flag value
0x0-0x3f TCP flag mask

Command Default
0x0 (Zero)

13-154 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-155


BSR 64000 Command Reference Guide Release 5.2.1

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 <X/Y> active-codes <64-128>
no cable upstream <X/Y> active-codes <64-128>

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-156 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable upstream capability


The cable upstream capability command enables/disables concatenation or
fragmentation for an upstream port. The no cable upstream capability command
disables concatenation or fragmentation for an upstream port.

Caution: The cable upstream capability command is intended for Motorola


support purposes only. The command may or may not be displayed in a
running-configuration, depending on various other configuration settings.

Do not add, delete, or change the cable upstream capability configuration


setting except as directed by Motorola support personnel.

Group Access
All

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream <NUM> capability {concatenation | fragmentation}
no cable upstream <NUM> capability {concatenation | fragmentation}

Command Syntax

NUM the upstream port number


concatenation enable/disable concatenation for this
upstream port
fragmentation enable/disable fragmentation for this
upstream port

Command Default
concatenation = enabled
fragmentation = enabled

Compass ID: 327594480 Version 3 13-157


BSR 64000 Command Reference Guide Release 5.2.1

cable upstream channel-id


The cable upstream channel-id command allows a user to specify a Channel ID
number for an upstream port and logical channel instead of using the default
pre-defined Channel IDs that are automatically assigned to the upstream ports by the
BSR CMTS. Refer to the BSR 64000 CMTS Configuration and Management Guide
for a listing of the default upstream channel IDs.

Group Access
MSO

Command Mode
Interface Configuration (cable interfaces only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} channel-id <1-255>
no cable upstream {<NUM> | <X/Y>} channel-id <1-255>

Command Syntax

NUM the upstream port number


X/Y the upstream port number and
optional logical channel number
(0-3).
1-255 the upstream Channel ID number

13-158 Compass ID: 327594480 Version 3


Release 5.2.1 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}

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

Compass ID: 327594480 Version 3 13-159


BSR 64000 Command Reference Guide Release 5.2.1

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> channel-width [1600000 | 200000 | 3200000 | 400000 |
800000]
no cable upstream <NUM> channel-width [1600000 | 200000 | 3200000 | 400000 |
800000]

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-160 Compass ID: 327594480 Version 3


Release 5.2.1 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 <X/Y> codes-minislot <2-32>
no cable upstream <X/Y> codes-minislot <2-32>

Command Syntax

X/Y the upstream port and logical channel number


(0-3)
2-32 the number of codes allowed per minislot

Compass ID: 327594480 Version 3 13-161


BSR 64000 Command Reference Guide Release 5.2.1

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> concatenation
no cable upstream <NUM> concatenation

Command Syntax

NUM the upstream port number

Command Default
Enabled

13-162 Compass ID: 327594480 Version 3


Release 5.2.1 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}

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.

Compass ID: 327594480 Version 3 13-163


BSR 64000 Command Reference Guide Release 5.2.1

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> description <LINE>

Command Syntax

NUM is the upstream port number


LINE is the text that describes the interface

13-164 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable upstream eng-nb-atten-backoff value


The cable upstream eng-nb-atten-backoff value command configures the internal
narrow band attenuation backoff. Configuring a backoff in narrow band attenuation
may alleviate the potential problem of adjacent upstream channel interference on the
DOCSIS 2.0 2:8 CMTS modules.
The cable upstream eng-nb-atten-backoff value command is configured on a
physical upstream port basis. A 6dB backoff in narrow band attenuation is enabled by
default. Setting the backoff value to 0 disables the internal narrow band attenuation
backoff. The no cable upstream eng-nb-atten-backoff value command resets the
narrow band attenuation backoff value to the default of 6dB.

Note: The narrow band attenuation backoff value must be set to a value
other than 0 when an upstream channel is configured for SCDMA mode.

This change only applies to the DOCSIS 2.0 2:8 CMTS module.

Warning: The cable upstream eng-nb-atten-backoff value command


should be used only when instructed to do so by Motorola support personnel.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream <NUM> eng-nb-atten-backoff value <0-15>
no cable upstream <NUM> eng-nb-atten-backoff value <0-15>

Compass ID: 327594480 Version 3 13-165


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

NUM the upstream port number


0-15 backoff value in dB, 0 disables narrow band
attenuation backoff

Command Default
6dB narrow band attenuation backoff is enabled.

13-166 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable upstream eq-magnitude-scaling


The cable upstream eq-magnitude-scaling command allows the equalizer's update
to be scaled by the specified value. The default magnitude scaling value is 1 which
does not scale the output. With a value configured other than 1, the update is scaled
down to either a fourth, an eighth, or a sixteenth of the current update. The no cable
upstream eq-magnitude-scaling command returns the magnitude scaling value to the
default or another value. The cable upstream eq-magnitude-scaling command is
configured on a physical upstream port basis on the CMTS 2:8 DOCSIS 2.0 module

Warning: The cable upstream eq-magnitude-scaling command should be


used only when instructed to do so by Motorola support personnel.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream <NUM> eq-magnitude-scaling {16 | 1 | 4 | 8 }
no cable upstream <NUM> eq-magnitude-scaling { 16 | 1 | 4 | 8 }

Command Syntax

16 magnitude scaling is set to 1/16


1 magnitude scaling is set to 1 - this is
the default value and does not scale
the output
4 magnitude scaling is set to 1/4
8 magnitude scaling is set to 1/8

Compass ID: 327594480 Version 3 13-167


BSR 64000 Command Reference Guide Release 5.2.1

Command Default
magnitude scaling = 1 - this is the default value and does not scale the output

13-168 Compass ID: 327594480 Version 3


Release 5.2.1 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>

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.

Compass ID: 327594480 Version 3 13-169


BSR 64000 Command Reference Guide Release 5.2.1

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> frequency <5000000-65000000>
no cable upstream <NUM> frequency <5000000-65000000>

Japan DOCSIS (J-DOCSIS) Standard


cable upstream <NUM> frequency <10000000-55000000>
no cable upstream <NUM> frequency <10000000-55000000>

13-170 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

NUM the upstream port number


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

Compass ID: 327594480 Version 3 13-171


BSR 64000 Command Reference Guide Release 5.2.1

cable upstream global-clock


The cable upstream global-clock command overrides the automated Global Clock
Delay (GCD) setting and the calibrated GCD setting of the BCM3140 global clock
register with the specified GCD value for a specified upstream port. The no cable
upstream global-clock command disables a specified GCD setting for a specified
upstream port.

Caution: Do not use the cable upstream global-clock command unless


instructed to do so by Motorola.

Group Access

System Administrator

Command Mode

Global Configuration

Command Line Usage

cable upstream <NUM> global-clock <0-31>


no cable upstream <NUM> global-clock <0-31>

Command Syntax

NUM the upstream port number


0-31 the GCD value

13-172 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable upstream global-clock enable


The cable upstream global-clock enable command enables a Global Clock Delay
(GCD) setting for a specified upstream port. The no cable upstream global-clock
enable command disables a GCD setting for an upstream port and returns the system
to use either the automated GCD setting or the calibrated GCD setting.

Caution: Do not use the cable upstream global-clock enable command


unless instructed to do so by Motorola.

Group Access

All

Command Mode

Interface Configuration (cable interface only)

Command Line Usage

cable upstream <NUM> global-clock enable


no cable upstream <NUM> global-clock enable

Command Syntax

NUM the upstream port number

Command Default
Disabled

Compass ID: 327594480 Version 3 13-173


BSR 64000 Command Reference Guide Release 5.2.1

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 <X/Y> hopping-seed <0-32767>
no cable upstream <X/Y> hopping-seed <0-32767>

Command Syntax

X/Y the upstream port and logical channel number


(0-3)
0-32767 the hopping seed value (0 disables code
hopping)

13-174 Compass ID: 327594480 Version 3


Release 5.2.1 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> ingress-canceller enable
no cable upstream <NUM> ingress-canceller enable

Command Syntax

NUM the upstream port number

Command Default
Enabled

Compass ID: 327594480 Version 3 13-175


BSR 64000 Command Reference Guide Release 5.2.1

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> invited-range-interval <0-30000>
no cable upstream <NUM> invited-range-interval <0-30000>

Command Syntax

NUM the upstream port number


0-30000 the time in milliseconds allowed by the
CMTS between ranging requests transmitted
by the cable modem

Command Default
10000 milliseconds

13-176 Compass ID: 327594480 Version 3


Release 5.2.1 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 <X/Y> iuc11-grant-size [<0-1024>]
no cable upstream <X/Y> iuc11-grant-size [<0-1024>]

Command Syntax

X/Y the upstream port and logical channel number


(0-3)
0-1024 the grant size in bytes

Command Default
0 bytes

Compass ID: 327594480 Version 3 13-177


BSR 64000 Command Reference Guide Release 5.2.1

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> loadbalance-group <WORD>
no cable upstream <NUM> loadbalance-group <WORD>

Command Syntax

NUM the upstream port number


WORD the load balancing group name

13-178 Compass ID: 327594480 Version 3


Release 5.2.1 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 <X/Y> maintain-power-density on
no cable upstream <X/Y> maintain-power-density on

Command Syntax

X/Y the upstream port and logical channel number


(0-3)

Compass ID: 327594480 Version 3 13-179


BSR 64000 Command Reference Guide Release 5.2.1

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 cable
modem to allocate upstream time slots. The no cable upstream map-interval
command resets the upstream interval to the default value.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream {<NUM> | <X/Y>} map-interval <500-16000>
no cable upstream {<NUM> | <X/Y>} map-interval <500-16000>

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)
500-16000 the interval value in microseconds.

Command Default
4000 microseconds

13-180 Compass ID: 327594480 Version 3


Release 5.2.1 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>

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.

Compass ID: 327594480 Version 3 13-181


BSR 64000 Command Reference Guide Release 5.2.1

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]

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

13-182 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-183


BSR 64000 Command Reference Guide Release 5.2.1

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> modem-ranging-delay <0-600>
no cable upstream <NUM> modem-ranging-delay

Command Syntax

NUM the upstream port number


0-600 the maximum ranging timing offset in
microseconds

Command Default
250 microseconds

13-184 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-185


BSR 64000 Command Reference Guide Release 5.2.1

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-186 Compass ID: 327594480 Version 3


Release 5.2.1 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> physical-delay {<10-1600> | automatic [<10-1600>
<10-1600>]}
no cable upstream <NUM> physical-delay {<10-1600> | automatic [<10-1600>
<10-1600>]}

Compass ID: 327594480 Version 3 13-187


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

NUM the upstream port number


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).
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.

13-188 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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:
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

Compass ID: 327594480 Version 3 13-189


BSR 64000 Command Reference Guide Release 5.2.1

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-190 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cable upstream power-level


The BSR CMTS interface controls cable modem 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.

The following table describes how the upstream channel bandwidth corresponds to
the input power-level range and default power-level range for a specific upstream
channel.

Table 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: 327594480 Version 3 13-191


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream <NUM> power-level <200-3200>
no cable upstream <NUM> power-level <200-3200>

Command Syntax

NUM the upstream port number


200-3200 the input power level, expressed in dB

Command Default
0 dB

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

13-192 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

The folliwng table describes how the upstream channel bandwidth corresponds to the
input power-level range and default power-level range for a specific upstream
channel.

Table 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

Compass ID: 327594480 Version 3 13-193


BSR 64000 Command Reference Guide Release 5.2.1

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream <NUM> power-level default {<-150 - +150>}
no cable upstream <NUM> power-level default {<-150 - +150>}

Command Syntax

NUM the upstream port number


-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.
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-194 Compass ID: 327594480 Version 3


Release 5.2.1 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> pre-equalization
no cable upstream <NUM> pre-equalization

Command Syntax

NUM the upstream port number

Compass ID: 327594480 Version 3 13-195


BSR 64000 Command Reference Guide Release 5.2.1

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}

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
0-15 end of range backoff
automatic the automatic range backoff.

Command Default
start 0, end 4

13-196 Compass ID: 327594480 Version 3


Release 5.2.1 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> range-forced-continue
no cable upstream <NUM> range-forced-continue

Command Syntax

NUM the upstream port number

Compass ID: 327594480 Version 3 13-197


BSR 64000 Command Reference Guide Release 5.2.1

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> range-power-override
no cable upstream <NUM> range-power-override

Command Syntax

NUM the upstream port number

13-198 Compass ID: 327594480 Version 3


Release 5.2.1 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> rate-limit
no cable upstream <NUM> rate-limit

Command Syntax

NUM the upstream port number

Command Default
Disabled

Compass ID: 327594480 Version 3 13-199


BSR 64000 Command Reference Guide Release 5.2.1

cable upstream schedule


The cable upstream schedule command is used to configure the type of scheduling
to be applied on upstream ports.

Group Access
MSO

Command Mode
Interface Configuration (cable interface only)

Command Line Usage


cable upstream 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-200 Compass ID: 327594480 Version 3


Release 5.2.1 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

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.

Compass ID: 327594480 Version 3 13-201


BSR 64000 Command Reference Guide Release 5.2.1

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> snr-offset {10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 100}
no cable upstream <NUM> snr-offset {10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 100}

Command Syntax

NUM the upstream port number


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-202 Compass ID: 327594480 Version 3


Release 5.2.1 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> spectrum-group <WORD>
no cable upstream <NUM> spectrum-group <WORD>

Command Syntax

NUM the upstream port number


WORD the exact group name applied to the upstream
port

Compass ID: 327594480 Version 3 13-203


BSR 64000 Command Reference Guide Release 5.2.1

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 <X/Y> spread-interval <1-32>
no cable upstream <X/Y> spread-interval <1-32>

Command Syntax

X/Y the upstream port and logical channel number


(0-3)
1-32 the spreading interval value

13-204 Compass ID: 327594480 Version 3


Release 5.2.1 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

Command Syntax

NUM the upstream port number


X/Y the upstream port number and logical channel
number (0-3)

Command Default
Disabled

Compass ID: 327594480 Version 3 13-205


BSR 64000 Command Reference Guide Release 5.2.1

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

Command Syntax

NUM the upstream port number.


X/Y the upstream port number and logical channel
number (0-3)

Command Default
Disabled

13-206 Compass ID: 327594480 Version 3


Release 5.2.1 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

Command Syntax

NUM the upstream port number.


X/Y the upstream port number and logical channel
number (0-3)

Command Default
Disabled

Compass ID: 327594480 Version 3 13-207


BSR 64000 Command Reference Guide Release 5.2.1

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

13-208 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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}

Note: The channel-type command is applicable to the 2:8 and 2:8


(2.0)CMTS modules only. To determine which CMTS modules are installed in
the BSR 64000, use the show chassis status command.

It is unnecessary to configure and enable multiple logical channels with the


same channel types. The total capacity of the physical channel will not be
enhanced by enabling multiple logical channels. However, it is reasonable to
assign unique modulation profile to multiple logical channels of the same type
for RF impairment investigation.

Compass ID: 327594480 Version 3 13-209


BSR 64000 Command Reference Guide Release 5.2.1

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-210 Compass ID: 327594480 Version 3


Release 5.2.1 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

Compass ID: 327594480 Version 3 13-211


BSR 64000 Command Reference Guide Release 5.2.1

clear cable downstream bonding-group statistics


The clear cable downstream bonding-group statistics command clears downstream
bonding group statistics. The BSR will automatically clear downstream bonding
group statistics under the following conditions:
■ a downstream bonding group configuration is modified.
■ a downstream bonding group is deleted.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear cable downstream bonding-group statistics [<X/Y>]

Command Syntax

X/Y the downstream channel associated with this


channel bonding group: X is the 2:8 CMTS
module slot number and Y is the MAC
domain

13-212 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-213


BSR 64000 Command Reference Guide Release 5.2.1

clear cable host


The clear cable host command removes a host CPE's IP address, MAC address, or
domain name from the BSR’s internal address tables. This allows a new host CPE to
come online from the previous host's cable modem.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


clear cable host {<mac> | <prefix> | all}

Command Syntax

mac the host CPE’s MAC address


prefix the host CPE’s IP address
all reset all host CPE’s

13-214 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-215


BSR 64000 Command Reference Guide Release 5.2.1

clear cable modem downstream


The clear cable modem command is used to reset all bonded or non-bonded cable
modems on a BSR downstream channel. The clear cable modem command can be
used to do the following:
■ Reset all bonded cable modems on a MAC Domain.
■ Reset all bonded cable modems on a MAC Domain bonding group.
■ Resets all bonding capable cable modems that are registered as non-bonded.

Note: Only users with read/write privileges are allowed to reset cable
modems on a downstream channel.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


clear cable modem <X/Y> downstream bonding [<1-65535>] reset
clear cable modem <X/Y> downstream non-bonding reset

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
bonding channel bonded cable modems
1-65535 the downstream channel bonding group
number
non-bonding all channel-bonding capable cable modems
that are registered as non-bonding
reset reset the cable modems

13-216 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

clear cable modem reject-pk reset


clear cable modem reject-pt reset
The clear cable modem reject-pk reset and clear cable modem reject-pt reset
commands are used to reset cable modems that are in the reject(pk) or the reject(pt)
states, respectively.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


clear cable modem reject-pk reset
clear cable modem reject-pt reset

Compass ID: 327594480 Version 3 13-217


BSR 64000 Command Reference Guide Release 5.2.1

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
slot NUM a CMTS slot number (0-5, 9-14)

13-218 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-219


BSR 64000 Command Reference Guide Release 5.2.1

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
1-4292967295 service flow ID

13-220 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS 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 <NUM> <NUM> {DOWN | UP | <WORD>}

Command Syntax

NUM specify a CMTS slot number


NUM specify a CMTS downstream or
upstream port number or a TX32
module slot number/downstream port
number/downstream channel number -
refer to the diagram following the
Command Syntax table
Note: The comma should not be entered
as part of the command syntax
DOWN clear downstream service class statistics
UP clear upstream service class statistics
WORD the pre-defined service class name or
the user-defined service class name
created with the name command

Compass ID: 327594480 Version 3 13-221


BSR 64000 Command Reference Guide Release 5.2.1

<0-7> , 4/[0-7]/[0-3]
comma

2:8 CMTS Module TX32 Module Slot Number/


Downstream or Upstream TX32 Downstream Port Number/
Port Number TX32 Downstream Channel Number

13-222 Compass ID: 327594480 Version 3


Release 5.2.1 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

Compass ID: 327594480 Version 3 13-223


BSR 64000 Command Reference Guide Release 5.2.1

clear cable ugs-stats


The clear cable ugs-stats command clears active voice call statistics for all CMTS
modules, a specified CMTS module, or a specified upstream port on a CMTS module.

Command Mode
All modes except User EXEC

Command Line Usage


clear cable ugs-stats [<0-15> [<0-7>]]

Command Syntax

0-15 DOCSIS (CMTS) module slot


number
0-7 the upstream port number.

13-224 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-225


BSR 64000 Command Reference Guide Release 5.2.1

clear interfaces cable upstream channel-agility-stats


The clear interfaces cable upstream channel-agility-stats command clears ASPM
Channel Statistics.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear interfaces cable <X/Y> upstream <NUM> channel-agility-stats

Note: When using the clear interfaces cable upstream


channel-agility-stats command, only the NUM argument displays for a BCM
3138-based 2:8 CMTS module (For example: clear interfaces cable
upstream <NUM> channel-agility-stats). Both the NUM and X/Y arguments
display for a BCM 3140-based DOCSIS 2.0 2:8 CMTS (For example: clear
interfaces cable upstream {<NUM> | <X/Y>} channel-agility-stats). Only
the NUM argument is applicable to this command.

Command Syntax

X/Y the slot and MAC Domain number of the 2:8


CMTS module:
NUM the upstream port number

Command Default
Disabled

13-226 Compass ID: 327594480 Version 3


Release 5.2.1 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
NUM the upstream port number

Compass ID: 327594480 Version 3 13-227


BSR 64000 Command Reference Guide Release 5.2.1

clear usage-stats
The clear usage-stats command clears the ASPM statistics displayed per Spectrum
Group with the show cable spectrum-group stats command.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


clear usage-stats [upstream <NUM>]

Command Syntax

upstream NUM specify an upstream port number

13-228 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

cmts-id
The method that the BSR uses to generate GateIDs for DQoS allows for unique IDs
across CMTSs which is referred to as the CMTS-ID. CMTS-IDs remove the need to
constantly update the Call Management Server (CMS) with scope information. The
CMTS-ID is configured using the cmts-id command.
The BSR generates a unique GateID when a request to create a PacketCable gate is
received from a Call Management Server (CMS) or a Policy Server (PS). The cmts-id
command allows the user to reserve 1-17 MSBs in the GateID. These bits are used to
for specifying a CMTS-ID for identifying the CMTS generating the GateID.
The no cmts-id command removes a configured CMTS-ID.

Group Access
All

Command Mode
Packet Cable Configuration

Command Line Usage


cmts-id {size <1-14> value <0x0-0x3fff>}
no cmts-id {size <1-14> value <0x0-0x3fff>}

Command Syntax

size 1-14 the number of bits reserved for specifying the


CMTS-ID
value 0x0-0x3fff the CMTS-ID value in hexidecimal - a
CMTS-ID must fit within the specified range

Command Default
Disabled. The GateID does not contain a CMTS-ID.

Compass ID: 327594480 Version 3 13-229


BSR 64000 Command Reference Guide Release 5.2.1

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-230 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-231


BSR 64000 Command Reference Guide Release 5.2.1

collect resolution
The collect resolution command is used to configure the frequency resolution rate
that the spectrum manager performs. The value from the collect resolution command
is used as an increment when measuring the upstream frequencies. This value is also
used as the channel width so that the measurements over the spectrum contain no gaps
nor overlaps.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


collect resolution {200000 | 400000}

Command Syntax

200000 the resolution in Hertz (Hz)


400000

Command Default
200000 Hz

13-232 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-233


BSR 64000 Command Reference Guide Release 5.2.1

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-234 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-235


BSR 64000 Command Reference Guide Release 5.2.1

docstest type
The docstest type command allows you to specify 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 {110 | 111} | slot <NUM> downstream {0 | 1} [LINE]
docstest type 112 slot <NUM> [LINE]
no docstest type {110 | 111} | slot <NUM> downstream {0 | 1} [LINE]
no docstest type 112 slot <NUM> [LINE]

Command Syntax

110 the enumerated test type for the downstream


111 channel - the enumerated test types
correspond to an integer "TYPE" field in the
DOCSIS 2.0 Testing MIB’s CM/CMTS TLV
Table
112 the enumerated test type for the 10.24 MHz
reference clock
slot NUM the slot number in the BSR chassis containing
an installed DOCSIS 2.0 2:8 CMTS module

13-236 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

downstream 0 the downstream channel number


downstream 1
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

Compass ID: 327594480 Version 3 13-237


BSR 64000 Command Reference Guide Release 5.2.1

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

13-238 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-239


BSR 64000 Command Reference Guide Release 5.2.1

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)

13-240 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

endfreq 0-81920000 end of the frequency range (0 Hz - 81.92


MHz)
table | graph specify table or graph display format

Compass ID: 327594480 Version 3 13-241


BSR 64000 Command Reference Guide Release 5.2.1

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

13-242 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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)

Compass ID: 327594480 Version 3 13-243


BSR 64000 Command Reference Guide Release 5.2.1

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:<filename> | flash:<filename>}

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
filename power level measurement data filename -
limit of 20 characters not including any
filename extension

13-244 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

frequency-test-method
The frequency-test-method command allows an operator to select the preferred type
of measurement method for frequency agility. Frequency Agility provides the
capability of periodically monitoring the quality of the active upstream channel. The
no frequency-test-method command disables frequency agility measurement.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


frequency-test-method {fft | snr}
no frequency-test-method {fft | snr}

Command Syntax

fft use power level measurement by means of the


Fast Fourier Transform (FFT) algorithm -
FFT transforms a discrete signal in a time
domain to a power level in a frequency
domain
snr use Signal to Noise Ratio (SNR)
measurement which exchanges data between
a reference modem and the 2:8 CMTS - a
reference modem is a registered cable modem
that is selected to send an upstream traffic/
burst used to measure the SNR on that
upstream

Command Default
fft

Compass ID: 327594480 Version 3 13-245


BSR 64000 Command Reference Guide Release 5.2.1

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-246 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-247


BSR 64000 Command Reference Guide Release 5.2.1

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-248 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-249


BSR 64000 Command Reference Guide Release 5.2.1

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>]

Note: The modulation type for the hopping profile has to be the same as the
configured channel profile type (i.e.TDMA to TDMA or ATDMA to ATDMA,
etc.)

Command Syntax

1-600 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-250 Compass ID: 327594480 Version 3


Release 5.2.1 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 Table describes how the upstream channel bandwidth
corresponds to the input power-level range and default power-level range for a
specific upstream channel.

Table 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: 327594480 Version 3 13-251


BSR 64000 Command Reference Guide Release 5.2.1

Command Default
upstream band priority = 128

13-252 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-253


BSR 64000 Command Reference Guide Release 5.2.1

hop modulation-rollback-count
The hop modulation-rollback-count command provides an operator with the ability
to specify the number of consecutive, good SNR (MER) measurements before ASPM
will perform a modulation profile rollback. This ensures that the channel is clean
before performing a modulation profile rollback back and also reduces the number of
extraneous UCD changes.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop modulation-rollback-count <5-100>
no hop modulation-rollback-count <5-100>

Command Syntax

5-100 the number of consecutive, good SNR (MER)


measurements before ASPM will perform a
modulation profile rollback

Command Defaults
18

13-254 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-255


BSR 64000 Command Reference Guide Release 5.2.1

hop snr hysteresis


The hop snr hysteresis command specifies the amount of dB degradation in a
downward direction before a channel will be marked as "IMPAIRED". For example.
if a channel is operating in a "NORMAL" state of 20 dB and SNR hysteresis is set to
2 dB, if the channel degrades in a downward direction until it reaches 18 dB, then the
channel will be considered to be in the "IMPAIRED" state. If the channel again
improves to 20 dB, the channel is no longer considerd to be "IMPAIRED".
The user must be aware of the effects of lowering or increasing the SNR hysteresis. A
higher SNR hysteresis value will delay switching to a channel that is not impaired. A
smaller SNR hysteresis value could result in too many channel transitions.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop snr hysteresis <2-3>
no hop snr hysteresis <2-3>

13-256 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

2-3 defines the SNR threshold for the downward


transition of a modulation type - the amount
of dB improvement in the channel being
assessed through the RF Sentry 9th Receiver
before switching back to this channel.

Command Default
2dB

Compass ID: 327594480 Version 3 13-257


BSR 64000 Command Reference Guide Release 5.2.1

hop sampling-period active-channel


The hop sampling-period active-channel command configures the active channel
sampling period which is how often the active channel quality is measured.
The signal quality of the active channel is periodically measured for SNR. The active
channel sampling period is the time between two consecutive signal quality
measurements of the active channel.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop sampling-period active-channel <0-15>
no hop sampling-period active-channel <0-15>

Command Syntax

0-15 the rate, measured in seconds, at which the


signal quality of the active channel is assessed
- a value of "0" disables active channel
measurement per Spectrum Group

Command Default
3 seconds

13-258 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

hop sampling-period rollback-channel


The hop sampling-period rollback-channel command configures the rollback
rollback sampling period which is how often the configured channel quality is
measured with RF Sentry.
When a primary channel is swapped with the spare channel, if the rollback is
configured, the primary channel is periodically measured for signal quality in the
background using RF Sentry. The rollback channel sampling period is the time
between two consecutive signal quality measurements of the impaired configured
channel.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop sampling-period rollback-channel <10-300>
no hop sampling-period rollback-channel <10-300>

Command Syntax

10-300 the rate, measured in seconds, at which the


signal quality of the primary channel is
assessed when the receiver is operating on a
spare channel, i.e. the receiver is in a
“rollback” mode

Command Default
60 seconds

Compass ID: 327594480 Version 3 13-259


BSR 64000 Command Reference Guide Release 5.2.1

hop sampling-period spare-channel


The hop sampling-period spare-channel command configures the spare channel
sampling period which is how often the spare channel’s Spectrum quality is measured
when an active channel is in the "NON-OPTIMAL" or "IMPAIRED" states.
If a primary channel could not be swapped for noise avoidance with a spare channel,
due to poor signal quality of the spare channels, the spare channels are periodically
assessed with the RF Sentry 9th receiver. The spare channel sampling period is the
time between two consecutive signal quality measurements of all the spare channels.
In each spare channel quality sampling cycle, all the spare channels are tested.
The quality assessment for a spare channel is performed whenever the active channel
of a receiver in the Spectrum Group is in the "NON-OPTIMAL" or "IMPAIRED"
state provided a spare channel for the Spectrum Group is available. If all spare
channels are searched and no acceptable replacement channel is found, this
configurable hold down delay will elapse before the retesting of the spare channels is
resumed.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop sampling-period spare-channel <10-600>
no hop sampling-period spare-channel <10-600>

Command Syntax:

10-600 the rate, measured in seconds, at which the


signal quality of the spare channels is
assessed when a channel tuned to the receiver
is operating at a sub-optimal quality

Command Default
60 seconds

13-260 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-261


BSR 64000 Command Reference Guide Release 5.2.1

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-262 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

hop threshold snr modulation-type


The hop threshold snr modulation-type command configures the SNR thresholds
for each modulation type.
SNR threshold is used to determine if a channel is capable of operating error free in
the modulation mode that is specified for Long Data or Advanced Long Data IUCs in
the configured modulation profile for the upstream receiver. A default SNR threshold
is used for each modulation type. The operator can override this by configuring a
different SNR threshold for a specific modulation type that is used in the active
channel. This threshold is used to transition channel states. SNR thresholds are
configurable with a resolution of 1dB.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


hop threshold snr modulation-type {128qam | 16qam | 256qam | 32qam | 64qam |
8qam | qpsk} <13-34>
no hop threshold snr modulation-type {128qam | 16qam | 256qam | 32qam |
64qam | 8qam | qpsk} <13-34>

Command Syntax

13-34 is the SNR threshold, in dB, at which a


specified modulation type should operate -
this setting is also used to transition channel
states

Compass ID: 327594480 Version 3 13-263


BSR 64000 Command Reference Guide Release 5.2.1

Command Defaults
The following table lists the recommended SNR thresholds for different modulation
types without FEC.

Note: The SNR threshold values for the different modulation types must
always be in a low to high order with QPSK being the lowest and 256QAM
being the highest.

Modulation Type Default SNR Threshold

QPSK 14dB

8QAM 17dB

16QAM 20dB

32QAM 23dB

64QAM 27dB

128QAM 30dB

256QAM 33dB

13-264 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

init-tech
The init-tech command allows an operator to select the initialization technique to use
when using DCC to move a cable modem to RF Sentry. The initialization technique
selected will be on a per Spectrum Group basis.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


init-tech <1-4>
no init-tech <1-4>

Command Syntax

init-tech 1-4 the initialization technique used for


DCC:
1 = perform broadcast initial 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-initializing or ranging

Command Default
1

Compass ID: 327594480 Version 3 13-265


BSR 64000 Command Reference Guide Release 5.2.1

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

13-266 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-267


BSR 64000 Command Reference Guide Release 5.2.1

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

13-268 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-269


BSR 64000 Command Reference Guide Release 5.2.1

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.

13-270 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-271


BSR 64000 Command Reference Guide Release 5.2.1

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.

13-272 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-273


BSR 64000 Command Reference Guide Release 5.2.1

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

13-274 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-275


BSR 64000 Command Reference Guide Release 5.2.1

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

13-276 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-277


BSR 64000 Command Reference Guide Release 5.2.1

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

13-278 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

Compass ID: 327594480 Version 3 13-279


BSR 64000 Command Reference Guide Release 5.2.1

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

13-280 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

mdrc enable
The mdrc enable command allows a user/operator to enable the MDRC feature on a
MAC domain. If the MDRC feature is not enabled, the BSR will operate as it did prior
to the implementation of the MDRC feature. If “multicast capability” is not enabled
with the cable downstream multicast enable command for a channel/port (but
MDRC is enabled), the multicast packet will not be replicated on that downstream
channel/port. The “multicast capability” parameter of a downstream channel/port
comes into play only when the MDRC feature is enabled for that MAC domain. The
no mdrc enable command disables the MDRC feature.

Group Access
All

Command Modes
Interface Configuration (cable interface only)

Command Line Usage


mdrc enable
no mdrc enable

Command Default
Disabled

Compass ID: 327594480 Version 3 13-281


BSR 64000 Command Reference Guide Release 5.2.1

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-282 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-283


BSR 64000 Command Reference Guide Release 5.2.1

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-284 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-285


BSR 64000 Command Reference Guide Release 5.2.1

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-286 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-287


BSR 64000 Command Reference Guide Release 5.2.1

reference-modem-exclusion
The reference-modem-exclusion command specifies the number of low SNR cable
modem(s) on each upstream channel in a Spectrum Group that are not allowed to be
used for channel assessment.
This value is used to exclude bad or cable modems with errors from being selected as
the reference modem. These excluded reference cable modems are those with the
lowest SNR values within the reference cable modem list.

Group Access
MSO

Command Mode
Cable Spectrum Group

Command Line Usage


reference-modem-exclusion <0-45>
no reference-modem-exclusion <0-45>

Command Syntax

0-45 the number of low SNR cable modem(s) on


each upstream in the Spectrum Group that are
not allowed to be used for channel assessment
- this parameter has no effect when the
number of registered cable modems on a
specific upstream are less than double this
value - a value of "0" indicates that no cable
modem is excluded from the reference cable
modem list

Command Default
15

13-288 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-289


BSR 64000 Command Reference Guide Release 5.2.1

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

13-290 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-291


BSR 64000 Command Reference Guide Release 5.2.1

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,1,12/0/0,12/0/1; upstream 0,1,2,3,4,5,6,7


Cable 0/1: downstream NONE; upstream NONE
Cable 2/0: downstream 12/2/0,12/2/1; upstream 0,1,2,3
Cable 2/1: downstream 12/2/2,12/2/3; upstream 4,5,6,7
Cable 4/0: downstream 12/4/0,12/4/1,12/4/2,12/4/3; upstream 0,1,2,3,4,5,6,7
Cable 4/1: downstream NONE; upstream NONE
Cable 11/0: downstream 0,12/6/0; upstream 0,1,2,3
Cable 11/1: downstream 1,12/7/0; upstream 4,5,6,7

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

Command Line Usage


show cable binding [cable <X/Y> | slot <NUM>]

13-292 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-293


BSR 64000 Command Reference Guide Release 5.2.1

show cable bonding-group minrr-multipliers


The show cable bonding-group minrr-multipliers command displays the minimum
reserved rate multipliers for a cable bonding group.
The following is typical screen output from the show cable bonding-group
minrr-multipliers command:

Interface 9/0 bonding group 1

9/0 9/1 1

DefBEDown 34 33
DefRRDown 34 33
DefBEUp 34 33
DefRRUp 34 33
DefUGS 34 33
DefUGSAD 34 33
DefRTPS 34 33
DefNRTPS 34 33
DefEMUp 34 33
DefEMDown 34 33
DefMCDown 34 33
DefVoiceDown 34 33

Interface 11/0 bonding group 1

11/0 11/1

DefBEDown 50 50
DefRRDown 50 50
DefBEUp 50 50
DefRRUp 50 50
DefUGS 50 50
DefUGSAD 50 50
DefRTPS 50 50
DefNRTPS 50 50
DefEMUp 50 50
DefEMDown 50 50
DefMCDown 50 50
DefVoiceDown 50 50

13-294 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable bonding-group minrr-multipliers [<X/Y>]

Command Syntax

X/Y the downstream channel associated with this


channel bonding group: X is the 2:8 CMTS
module slot number and Y is the MAC
domain

Compass ID: 327594480 Version 3 13-295


BSR 64000 Command Reference Guide Release 5.2.1

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 : 2
Number of DCC Rsps : 4
Number of DCC Rsps(Depart) : 2
Number of DCC Rsps(Arrive) : 2
Number of DCC Acks : 2
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)

13-296 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Line Usage


show cable dcc-stats [<X/Y>]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module

Compass ID: 327594480 Version 3 13-297


BSR 64000 Command Reference Guide Release 5.2.1

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:

13-298 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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 is a list of local and/or remote downstream


channels separated by spaces
for a description of the • local channels are represented as a single
NUM syntax for digit channel number
downstream channels, • remote channels are in the form slot/
refer to the figure below downstream port number/downstream
this table channel number - a remote TX32
downstream channel must be bound
before it can be bonded

Compass ID: 327594480 Version 3 13-299


BSR 64000 Command Reference Guide Release 5.2.1

4/[0-7]/[0-3] 9/[0-1] 11/[0-1]

TX32 Module Slot Number/ 2:8 CMTS Module Slot Number/


TX32 Downstream Port Number/ Downstream Port Number
TX32 Downstream Channel Number

13-300 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable downstream bonding-groups


The show cable downstream bonding-groups command displays the following
downstream channel bonding group information:

Interface cable slot and MAC domain of the Primary


downstream channel
Group-Id downstream channel bonding group ID
number
Type displays the type of bonding group (DOCSIS
or Motorola)
Channels the BSR cable interface slot and MAC
Domain of the downstream channels that
belong to the bonding group.
State Up indicates the downstream channel is
enabled. Down indicates the downstream
channel is disabled.
QAM downstream Quadrature Amplitude
Modulation (QAM). 64 is 6 bits per
downstream symbol. 256 is 8 bits per
downstream symbol.
Primary reflects if the downstream channel in
"Primary Capable" (TRUE) or "Non-Primary
Capable" (FALSE) - any downstream channel
associated with a bonding group can be
configured to be "Primary Capable" or
"Non-Primary Capable"
Frequency downstream frequency in Hertz (Hz)

The following is an example of typical screen output from the show cable
downstream bonding-groups command:

Compass ID: 327594480 Version 3 13-301


BSR 64000 Command Reference Guide Release 5.2.1

Interface Group-Id Type Channels ChanId State Qam Primary Frequency


11/0 10 Motorola 11/0 1 Up 64 TRUE 537000000
4/0/0 2 Up 256 TRUE 549000000

11/0 20 DOCSIS 11/0 1 Up 64 TRUE 537000000


4/0/0 2 Up 256 TRUE 549000000

The following is an example of typical screen output from the show cable
downstream bonding-groups statistics command:

Interface: 11/0 DOCSIS Group-Id: 20


Channel Packets Octets
------- -------------------- --------------------
11/0 256 4790
4/0/0 498 4524
-------------------- --------------------
Totals 754 9314

Total Registered Modems: 23

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable downstream bonding-groups [statistics | <X/Y> [<1-65535>]]

13-302 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

statistics display downstream bonding group statistics


X/Y the downstream channel associated with this
channel bonding group: X is the 2:8 CMTS
module slot number and Y is the MAC
domain
1-65535 the downstream channel bonding group
number

Compass ID: 327594480 Version 3 13-303


BSR 64000 Command Reference Guide Release 5.2.1

show cable downstream idlist


The show cable downstream idlist command to displays the physical interface,
downstream channel ID, Fiber Node Name and Load Balancing Group name
associations for each TX32 of CMTS module in the BSR chassis.
The following is an example of typical screen output from the show cable
downstream idlist command:

Phy DS-CHAN-ID Fiber Node Load Balancing


Interface Name Group Name
Cable 0/0 7 RedSox NULL
Cable 0/1 2 RedSox NULL
Cable 2/0 NULL NULL NULL
Cable 2/1 NULL NULL NULL
Cable 4/0 NULL NULL NULL
Cable 4/1 NULL NULL NULL
Cable 11/0 24 NULL marlborough
Cable 11/1 5 NULL mansfield
DTX 12/0/0 9 R dS NULL
Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable downstream idlist [slot <NUM>]

Command Syntax

slot NUM specifies a CMTS or TX32 slot

13-304 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable fiber-node


The show cable fiber-node command displays the Fiber Node and MAC Domain
associations. The Fiber Node and MAC Domain associations are created when a fiber
node name is associated to a downstream port of a MAC Domain with the cable
fiber-node command. Once configured, the MD-DS-SG-ID
(MacDomain-DownStream-ServingGroup-Identifier) will be assigned internally for
the association.
Without the optional MAC Domain <X/Y> parameter, the show cable fiber-node
command displays the Fiber Node Names and MD-DS-SG-ID for every configured
MAC Domain. Use the optional MAC Domain <X/Y> parameter to display the
information for a specific MAC Domain.
The following is an example of typical screen output from the show cable fiber-node
command:

Interface Fiber Node Name MD-DS-SG-ID

Cable 3/0 FN-A 1


Cable 3/0 FN-B 1
Cable 3/0 FN-C 1
Cable 3/0 FN-D 1
Cable 4/0 FN-E 1
Cable 4/0 FN-F 1
Cable 4/1 FN-G 1
Cable 4/1 FN-H 1
Cable 10/0 FN-I 1
Cable 10/0 FN-J 1
Cable 10/0 FN-K 1
Cable 10/0 FN-L 1
Cable 11/0 FN-M 1
Cable 11/0 FN-N 1
Cable 11/0 FN-O 2
Cable 11/0 FN-P 2

Group Access
All

Compass ID: 327594480 Version 3 13-305


BSR 64000 Command Reference Guide Release 5.2.1

Command Mode
All modes except User EXEC

Command Line Usage


show cable fiber-node [<X/Y ] [ | {begin | exclude | include} {<WORD>} [ | {count
| count-only}]]
show cable fiber-node [<X/Y>] [ | {count | count-only}]

Command Syntax

X/Y the slot and MAC Domain 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-306 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable filter


The show cable filter command displays the packet filter configuration.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable filter [group <1-32> [index <1-64>]]

Command Syntax

group 1-32 displays a specified packet filter


group
index 1-64 displays the packet filter

Compass ID: 327594480 Version 3 13-307


BSR 64000 Command Reference Guide Release 5.2.1

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.

13-308 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

Compass ID: 327594480 Version 3 13-309


BSR 64000 Command Reference Guide Release 5.2.1

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

13-310 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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>]

Compass ID: 327594480 Version 3 13-311


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

WORD the load balancing group name

13-312 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable loadbalance-no-move-list


The show cable loadbalance-no-move-list command displays cable modems that
have been added to the no-move-list and are not participating in dynamic load
balancing. The following is an example of typical screen output from the show cable
loadbalance-no-move-list command:

CM Mac Address Interface TLV1 TLV2 UCC DCC REJECT


0011.805f.3d18 1/1/D1/U5/C0 OFF OFF ON OFF OFF
0014.e835.e8f2 1/1/D1/U5/C0 OFF OFF ON OFF OFF
0014.e836.8c84 1/1/D1/U6/C0 OFF OFF ON OFF OFF
0011.1aca.2ce4 1/1/D1/U4/C0 OFF OFF ON OFF OFF

The following table describes the reasons for a cable modem being added to the
no-move-list. As reflected by the sample output above, "ON" indicates the reason that
the cable modem was added to the no-move-list. All the cable modems displayed
above are on the no-move list because they deregistered after receiving a UCC
command.

TLV1 cable modem is prevented from moving due


to TLV1 (Downstream Frequency) being
configured in the cable modem configuration
file and was placed on the no-move-list
TLV2 cable modem is prevented from moving due
to TLV2 (Upstream Channel ID) being
configured in the cable modem configuration
file and was placed on the no-move-list
UCC cable modem deregistered when attempting a
UCC and was placed on the no-move-list

Compass ID: 327594480 Version 3 13-313


BSR 64000 Command Reference Guide Release 5.2.1

DCC cable modem deregistered within 5 minutes


after attempting a DCC and was placed on the
no-move-list
REJECT cable modem responded to a DCC request
with a confirmation code other than a Depart
(180) indicating the cable modem is on the
old channel and is about to perform the jump
to the new channel

Command Mode
All modes except User EXEC

Command Line Usage


show cable loadbalance-no-move-list [slot]

Command Syntax

slot specify a CMTS slot on the BSR

13-314 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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>]

Compass ID: 327594480 Version 3 13-315


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

WORD the load balancing policy name

13-316 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-317


BSR 64000 Command Reference Guide Release 5.2.1

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

13-318 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable md-ds-sg


The show cable md-ds-sg command displays MAC Domain Downstream Service
Group (MD-DS-SG) information which is information pertaining to cable interfaces
and MAC domains and their associated service groups and downstream channels.
This includes the cable interface and MAC domain number, the MD-DS-SG-ID, and
the associated list of downstream channels. The following is typical screen output
from the show cable md-ds-sg command:

Interface MD-S-SG-ID FN-Count CM-Count DS Channels


Cable 3/0 3 0 0 0,10/0
Cable 3/1 1 0 0 1

Group Access
All

Command Mode
All modes

Command Line Usage


show cable md-ds-sg [<X/Y>] | [{begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show cable md-ds-sg [<X/Y>] | [{count | count-only}]

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module - use this optional
slot and MAC Domain parameter to
display information for a specific
MAC Domain
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string

Compass ID: 327594480 Version 3 13-319


BSR 64000 Command Reference Guide Release 5.2.1

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-320 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

Compass ID: 327594480 Version 3 13-321


BSR 64000 Command Reference Guide Release 5.2.1

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:

13-322 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Intf Prim Prim Prim Connect Timing RxPwr Ip Address Mac Address
Cable DS US Sid State Offset dBmV
9/0 9D0C0 U1C0L0 15841 online 1267 0.0 150.31.92.87 0017.ee85.affc
11/0 11D0C0 U1C0L0 0 offline 0 0.0.0.0 0017.ee90.30ac
11/0 11D0C0 U0C0L0 1 online 1290 -.2 150.31.93.12 0011.1aca.13a6
11/0 11D1C0 U5C0L0 8193 online 1291 -.2 150.31.93.40 0019.5eb4.704e
11/0 11D1C0 U5C0L0 2 online(pt) 2843 -.1 150.31.93.32 0800.3e08.7f4

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

Compass ID: 327594480 Version 3 13-323


BSR 64000 Command Reference Guide Release 5.2.1

count count the number of outputted lines


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

13-324 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable modem bonding


The show cable modem bonding command displays information about downstream
channel bonded cable modems.
The following is an example of typical screen output from the show cable modem
bonding command:

Interface Prim Connect BgId Ip Address Mac Address


Sid State
Cable 4/0/D0/U0/C1 2 online 1 150.31.153.23 0010.ee90.3200
Cable 4/0/D0/U0/C0 3 online 1 150.31.153.24 0010.ff81.1478

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem bonding [<X/Y>] | [{begin | exclude | include} {<WORD>} [ |
{count | count-only}]]
show cable modem bonding [<X/Y>] | [{count | count-only}]

Command Syntax

X/Y the downstream channel associated with this


channel bonding group
| 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: 327594480 Version 3 13-325


BSR 64000 Command Reference Guide Release 5.2.1

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-326 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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:

Compass ID: 327594480 Version 3 13-327


BSR 64000 Command Reference Guide Release 5.2.1

Intf Prim Prim PSID CM MAC CM IP CPE Count


Cable DS US
9/0 9D0C0 U1C0L0 15841 0017.ee85.affc 150.31.92.87 0
Intf Prim Prim PSID CM MAC CM IP CPE Count
Cable DS US
11/0 11D0C0 U0C0L0 1 0011.1aca.13a6 150.31.93.12 1
CPE MAC CPE IP
0011.1aca.13a8 150.31.94.10
Intf Prim Prim PSID CM MAC CM IP CPE Count
Cable DS US
11/0 11D1C0 U5C0L0 8193 0019.5eb4.704e 150.31.93.40 1
CPE MAC CPE IP
00c0.4f63.482c 150.31.98.10
Intf Prim Prim PSID CM MAC CM IP CPE Count
Cable DS US
11/0 11D1C0 U5C0L0 2 0800.3e08.7f4e 150.31.93.32 0

Total number of CPE : 2

Group Access
All

Command Mode
All modes except User EXEC

13-328 Compass ID: 327594480 Version 3


Release 5.2.1 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
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: 327594480 Version 3 13-329


BSR 64000 Command Reference Guide Release 5.2.1

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 following is typical output from the show cable modem detail
command:

CM Record (index 16) Dump:


Psid 8211
MD-DS-SG-ID 3
Config 0x3002
Status regComplete
BPI Enabled No
MAC Address 001f.c4aa.808e
IP Addr 30.10.1.34
US Chan 0
DS Chan 0/0/0 0/1/0 2/0/0 2/0/1
Vendor Id 00 20 40
MAX Classifier 0
MAX CPEs 10
Qos Profile 0
Device type eCM
--Ranging State--
State 0x4
Retry 0
NoReqCount 0
Pending 0
Rx Power(TenthdBmV) 28
Freq Offset 729
Timing Offset 1475
Last Invited 83102932(ms)
Max Interval 10125(ms)
Max Req Delay 393(ticks)
Equalization Data:
ff f0 ff d0 00 20 ff f0 ff d0 00 20
ff e0 00 30 00 10 00 10 ff c0 ff f0
EAE: Yes
PreDocs30 Fragmentation:Yes

13-330 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

##CM Capability:##
Concatenation: 1
DOCSIS Version: DOCSIS 3.0
Fragmentation: 1
PHS: 1
BPI: 1
DS SAIDs: 24
US SIDs: 8
Transmit Equalizer: 1(Taps/Symbol)
Transmit Equalizer Taps:24
DCC Support: 1
Expanded Unicast SID Space: 1
Range Holdoff Support: 0
L2VPN Capability: 0
Upstream Frequency Band Support: 0
Upstream Symbol Rate Support: 0
Selectable Active Code Mode 2 Support: 0
Code Hopping Mode 2 Support: 0
Multiple TX Channel Support: 0
5.12 Msps Upstream TX Channel Support: 0
2.56 Msps Upstream TX Channel Support: 0
Total SID Clulster Support: 40
SID Clusters per SF Support: 2
Multiple RX Channel Support: 4
Total DSID Support: 32
Resequence DSID Support: 16
Multicast DSID Support: 0
Multicast DSID Forwarding: 0
Frame Control Type Forwarding Capability: 1
DPV Capability: 0
UGS Upstream Flow Support: 24
MAP and UCD Receipt Support: 0
IPv6 Support: 1

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 327594480 Version 3 13-331


BSR 64000 Command Reference Guide Release 5.2.1

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
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-332 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable modem downstream


The show cable modem downstream command provides configuration information
for channel bonded cable modems or channel-bonding capable cable modems that are
registered as non-bonding. The show cable modem downstream command displays
the following information for each bonded or non-bonded cable modem:

Interface the downstream cable interface and upstream


port that the cable modem is connected to
Prim SID the primary service identifier assigned to this
cable modem
Connect 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
BgId (if applicable) downstream channel bonding group ID
number
Multi RxCap the number of downstream channels a cable
modem or channel bonded cable modem can
support (receive) - this is not necessarily the
number of downstream channels being used
but the number of downstream channels the
cable modem’s hardware supports
IP Address the cable modem’s IP address
MAC Address the cable modem’s MAC address

Compass ID: 327594480 Version 3 13-333


BSR 64000 Command Reference Guide Release 5.2.1

The following is an example of typical screen output from the show cable modem
downstream command:

Interface Prim Connect BgId Multi Ip Address Mac Address


Sid State RxCap
11/0 4D0C0 U4C0L0 8195 online 20 3 150.31.93.15 0010.1881.0190
11/0 4D0C0 U4C0L0 8194 online 10 4 150.31.93.66 0017.ee85.b07c

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem downstream bonding [<X/Y> [<1-65535>]] [ | {begin | exclude
| include} {<WORD>} [ | {count | count-only}]]
show cable modem downstream bonding [<X/Y> [<1-65535>]] [ | {count |
count-only}]

show cable modem <X/Y> downstream non-bonding [<X/Y>] [ | {begin | exclude


| include} {<WORD>} [ | {count | count-only}]]
show cable modem <X/Y> downstream non-bonding [<X/Y>] [ | {count |
count-only}]

13-334 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
bonding channel bonded cable modems
1-65535 the downstream channel bonding group
number
non-bonding all channel-bonding capable cable modems
that are registered as non-bonding
| 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: 327594480 Version 3 13-335


BSR 64000 Command Reference Guide Release 5.2.1

show cable flap-list


The show cable flap-list command displays the cable flap-list and provides the
following information:

MAC ID the MAC address of the flapping cable modem


Cable IF the upstream port
Hit the number of times the cable modem responded
to MAC layer keepalive messages (minimum hit
rate one time/30 seconds) that can indicate
intermittent upstream, laser clipping, or
common-path distortion - the Hit count should
be much higher than Miss count - if not, the
cable modem is having problems maintaining
the connection due to an upstream problem - the
flap count increments each time the system
transitions from a Hit to a Miss
Miss the number of times the cable modem missed the
MAC layer keepalive message - 8% normal, can
indicate intermittent upstream, laser clipping,
common path distortion
Ins the number of times the cable modem comes up
and connects to the network - this can indicated
the number of times an RF link was
reestablished more frequently than the time
period configured with the cable flap-list
insertion time command
CRC displays the count of CRC errors for each cable
modem on the flap-list - this count is also saved
in the cable modem history record so that the
count remains valid if cable modems flap - the
count is a sum of all of the CRC errors for each
service flow tied to a cable modem

13-336 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Pow the number of times the CMTS instructed the


cable modem to adjust transmit (TX) power
beyond the threshold configured with the cable
flap-list power-adjust threshold command -
this can indicate unacceptable connections or
thermal sensitivity
Rng the number of times the modem exceeded the
missed ranging threshold
Flap the total of Pow and Ins values - high flap-count
cable modems have high SIDs and may not
register
Type specifies the type of flap (ranging, timing, or
power)
Time the most recent time a cable modem dropped a
connection

The following is an example of typical screen output from the show cable flap-list
command:

MAC ID CableIF Hit Miss Ins CRC Pow Rng Flap Type Time
000b.0643.3b60 4/0 U1 1469 7 0 3 0 1 1 Rng FRI NOV 05 11:59:39
000b.0643.36c8 4/0 U1 1469 7 0 0 0 1 1 Rng FRI NOV 05 11:59:40
000b.0643.3b78 4/0 U1 1469 6 0 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]

Compass ID: 327594480 Version 3 13-337


BSR 64000 Command Reference Guide Release 5.2.1

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-338 Compass ID: 327594480 Version 3


Release 5.2.1 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.

Intf Prim Prim Prim Connect Timing RxPwr Ip Address Mac Address
Cable DS US Sid State Offset dBmV
9/0 9D0C0 U1C0L0 15841 online 1267 0.0 150.31.92.87 0017.ee85.affc
Number of Hosts = 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: 327594480 Version 3 13-339


BSR 64000 Command Reference Guide Release 5.2.1

count count the number of outputted lines


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

13-340 Compass ID: 327594480 Version 3


Release 5.2.1 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:

Intf Prim Prim Mac Address Load Balance


Cable DS US Group Name
9/0 9D0C0 U1C0L0 0017.ee85.affc Not Assigned
11/0 11D0C0 U0C0L0 0011.1aca.13a6 Not Assigned
11/0 11D1C0 U5C0L0 0019.5eb4.704e Not Assigned
11/0 11D1C0 U5C0L0 0800.3e08.7f4e 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
count-only count the number of lines while
suppressing screen output
exclude filter for output that excludes the
specified string

Compass ID: 327594480 Version 3 13-341


BSR 64000 Command Reference Guide Release 5.2.1

include filter for output that includes the


specified string
WORD the specified string

13-342 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-343


BSR 64000 Command Reference Guide Release 5.2.1

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-344 Compass ID: 327594480 Version 3


Release 5.2.1 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
| 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: 327594480 Version 3 13-345


BSR 64000 Command Reference Guide Release 5.2.1

show cable modem mac30


The show cable modem mac30 command displays the following DOCSIS 3.0 MAC
layer (layer 2) information for all DOCSIS 3.0 cable modems attached to the BSR,
DOCSIS 3.0 cable modems on a specific CMTS module, or a specific DOCSIS 3.0
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 - "bd" indicates a bonded cable modem
Prim SID the Primary SID number associated with this
cable modem
Multi RxCap the number of downstream channels a cable
modem or channel bonded cable modem can
support (receive) - this is not necessarilly the
number of downstream channels being used
but the number of downstream channels the
cable modem’s hardware supports
PReg Frag yes indicates that this cable modem is capable
of performing DOCSIS 1.1 style
fragmentation
EAE displays whether early authentication and
encryption (EAE) signaling for the MAC
Domain is enabled (yes) or disabled (no) -
early authentication functions as a network
admission control - only authenticated CMs
are allowed to continue their initialization
process and may be subsequently admitted to
the network and the results of successful
authentication are used for securing the
subsequent steps in the CM’s initialization
process

13-346 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

The following is typical screen output from the show cable modem mac30
command:

MAC Address MAC Prim Multi PReg EAE


State SID RxCap Frag
0017.ee85.affc online(bd) 15809 4 no no
0017.ee90.30ac online 2 4 no no
0011.1aca.13a6 online 1 0 no no
0017.ee85.b020 online(bd) 15778 4 no no
0017.ee85.b07c online(bd) 15777 4 no no
0019.5eb4.704e online 8193 3 no no
0800.3e08.7f4e online 3 0 no no

Group Access
All

Command Mode
All modes

Command Line Usage


show cable modem mac30 <X/Y> [ | {begin | exclude | include} {<WORD>} |
{count | count-only}]
show cable modem mac30 <X/Y> [ | {count | count-only}]

Command Syntax

X/Y the slot and MAC Domain number of


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

Compass ID: 327594480 Version 3 13-347


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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 Intf Prim Prim SM Exhausted SM Aborted


Cable DS US Count - Time Count - Time
0017.ee85.affc 9/0 9D0C0 U1C0L0 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
0011.1aca.13a6 11/0 11D0C0 U0C0L0 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
0017.ee90.30ac 11/0 11D0C0 U1C0L0 8 APR 17 07:23:19 0 xxx xx xx:xx:xx
0019.5eb4.704e 11/0 11D1C0 U5C0L0 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx
0800.3e08.7f4e 11/0 11D1C0 U5C0L0 0 xxx xx xx:xx:xx 0 xxx xx xx:xx:xx

Group Access
All

Compass ID: 327594480 Version 3 13-349


BSR 64000 Command Reference Guide Release 5.2.1

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
| 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 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable modem max-rate


The show cable modem max-rate command shows the upstream and downstream
maximum sustained rate for the primary service flow. The following is an example of
typical screen output from the show cable modem max-rate command:

Interface Modem Primary Upstream Primary Downstream


Mac Address US SFID Max-Rate DS SFID Max-Rate
Cable 9/0/D0/U0 0011.1a63.e1b4 3 0 4 0
Cable 9/0/D0/U0 0011.1aca.2dda 5 1000000 6 5000000
Cable 9/0/D0/U0 0011.aefe.8fbe 9 0 10 0
Cable 9/0/D0/U0 0015.9a6a.88ee 13 1000000 14 5000000
Cable 9/0/D0/U0 0015.9a6a.8906 11 1000000 12 5000000
Cable 9/0/D0/U0 0015.9adc.7c8c 7 0 8 0
Cable 9/0/D0/U0 0017.ee5a.1bfc 1 0 2 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem max-rate [<X/Y>]

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module

Compass ID: 327594480 Version 3 13-351


BSR 64000 Command Reference Guide Release 5.2.1

show cable modem mta


show cable modem ps
show cable modem stb
The show cable modem mta, show cable modem ps, and show cable modem stb
commands are used to display embedded DOCSIS cable modem (eCM) statistics
information based on the embedded Service/Application Functional Entity (eSAFE)
types, including embedded PacketCable Multimedia Terminal Adapter (MTA),
embedded CableHome Portal Services (PS), and embedded Set-Top Box (STB). This
device information can used to evaluate network performance, troubleshoot
registration problems, and view specific registration and ranging information for
devices connected to a specific interface.
The following is an example of typical screen output from the show cable modem
{mta | ps | stb}, show cable modem {mta | ps | stb} <X/Y>, and show cable modem
{mta | ps | stb} registered commands:

Intf Prim Prim Prim Connect Timing RxPwr Ip Address Mac Address
Cable DS US Sid State Offset dBmV
11/0 11D0C0 U0C0L0 1 online 1290 -.1 150.31.93.12 0011.1aca.13a6

The show cable modem {mta | ps | stb}, show cable modem {mta | ps | stb} <X/Y>,
and show cable modem {mta | ps | stb} registered commands display the following
information:

Interface interface with active connection


Prim Sid Primary Service Identifier number
Connect State the device connectivity state - the table
below describes the connectivity states
supported on the BSR
Timing Offset current timing adjustment
RxPwr receive downstream power level in dBmV
Ip address IP address
Mac address Media Access Control layer address

13-352 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

The supported MTA, PS, and STB device 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.
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.

Compass ID: 327594480 Version 3 13-353


BSR 64000 Command Reference Guide Release 5.2.1

The following is an example of typical screen output from the show cable modem
{mta | ps | stb} summary command:

Cable Total Reg Unreg Offline SpecGrp LbGrp


Interface Modem Modem Modem Modem Name Name
2/0/U0 4 4 0 0 N/A N/A
2/0/U1 3 3 0 0 N/A N/A
9/0/U0 4 4 0 0 marlborough N/A
9/0/U1 13 13 0 0 marlborough N/A
9/0/U2 15 15 0 0 marlborough N/A
11/1/U4 16 16 0 0 N/A mansfield
11/1/U5 13 13 0 0 N/A mansfield
11/1/U6 8 8 0 0 N/A mansfield
11/1/U7 13 13 0 0 N/A mansfield

The following is an example of typical screen output from the show cable modem
{mta | ps | stb} summary total command:

Cable Total Active Registered SpecGrp LbGrp


Interface Modems Modems Modems Name Name
2/0/U0 4 0 4 N/A N/A
2/0/U1 3 0 3 N/A N/A
9/0/U0 4 0 4 marlborough N/A
9/0/U1 13 0 13 marlborough N/A
9/0/U2 15 0 15 marlborough N/A
11/1/U4 16 0 16 N/A mansfield
11/1/U5 13 0 13 N/A mansfield
11/1/U6 8 0 8 N/A mansfield
11/1/U7 13 0 13 N/A mansfield
Total 89 0 89

The show cable modem {mta | ps | stb} summary and show cable modem {mta |
ps | stb} summary total commands display the following information:

13-354 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Cable Interface the BSR 64000 CMTS slot, port, and


upstream port number
Total Modem the total number of active, registered, and
offline cable modems
Reg Modem the number of cable modems which have
reached the Online(d), Online (pk),
Online(pt) or Online(un) states
Unreg Modem the number of cable modems in any Init,
DHCP, Reject state or substate
Offline Modem 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.
LbGrp the load balancing group assignment for each
upstream channel

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem {mta | ps | stb} [<X/Y> | offline | registered | summary
[total ]] [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show cable modem {mta | ps | stb} [<X/Y> | offline | registered | summary
[total ]] [ | {count | count-only}]

Compass ID: 327594480 Version 3 13-355


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
offline displays all offline MTAs, PSs, or STBs
registered displays all registered MTAs, PSs, or STBs
summary displays summarized configuration
information for each MTA, PS, or STB
total displays the total number of all MTAs, PSs, or
STBs in each summarized configuration
category
| 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-356 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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:

Intf Prim Prim Prim Mac Address DeRegistration Last Us Last Ds


Cable DS US Sid TimeStamp KBytes KBytes
11/0 11D0C0 U1C0L0 0 0017.ee90.30ac APR 17 06:55:54 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}]

Compass ID: 327594480 Version 3 13-357


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

0-15 the BSR 64000 CMTS slot number


X/Y the slot and MAC Domain number of the
CMTS module
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

13-358 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable modem offline-previous


The show cable modem offline-previous command displays the modem’s previous
state prior to going into the offline state. The 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
Previous State the previous state the modem was in
before going offline

The following is an example of typical screen output from the show cable modem
offline-previous command:

Cable Prim Mac Address DeRegistration Previous


Interface Sid TimeStamp State
0/0 0D0CO U0C0L0 0 0011.ae89.7e62 SEP 09 01:48:35 online

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem offline-previous [<0-15> | <X/Y> | <mac>] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show cable modem offline-previous [<0-15> | <X/Y> | <mac>] [ | {count |
count-only}]

Compass ID: 327594480 Version 3 13-359


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

0-15 the BSR 64000 CMTS slot number


X/Y the slot and MAC Domain number of the
CMTS module
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

13-360 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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:

Compass ID: 327594480 Version 3 13-361


BSR 64000 Command Reference Guide Release 5.2.1

MAC Address Intf Prim Prim USPwr USSNR Timing Mod


Cable DS US (tenthdBmV) (tenthdB) Offset Type
0017.ee85.affc 9/0 9D0C0 U1C0L0 0 328 1267 TDMA
0011.1aca.13a6 11/0 11D0C0 U0C0L0 -1 361 1290 TDMA
0019.5eb4.704e 11/0 11D1C0 U5C0L0 -2 365 1291 TDMA
0800.3e08.7f4e 11/0 11D1C0 U5C0L0 -1 342 2843 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
X/Y the slot and MAC Domain number of
the CMTS module
| turns on output modifiers (filters)
begin filter for output that begins with the
specified string

13-362 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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: 327594480 Version 3 13-363


BSR 64000 Command Reference Guide Release 5.2.1

show cable modem qos


The show cable modem qos command displays the service class names applied to
each MAC domain, the downstream and upstream maximum rates allowed, and
whether the cable modem service-class-name command has been used to override
service class to temporarily penalize the QoS received by a CM due to violations of
the subscriber’s service level agreement. The following is typical screen output from
the show cable modem qos command:

Cable MAC DS SCN DS US SCN


IF MAX-RATE
3/0 0008.0e15.48d0 T1up 0 DefBEUp
3/0 0008.0e15.4900 DefRRDown 64000 DefBEUp
3/0 0008.0e15.49d2 DefRRDown 64000 DefBEUp
3/0 0008.0e15.a42c DefRRDown 64000 DefBEUp
3/0 0008.0e15.a61e DefRRDown 64000 DefBEUp
3/0 0008.0e15.a72c DefBEDown 0 DefBEUp
3/0 0008.0e15.a7c2 DefRRDown 64000 DefBEUp
3/0 000e.5cf3.acc0 DefBEDown 5000000 DefBEUp
3/0 000e.5cf3.accc DefBEDown 5000000 penaltyUS
3/0 000e.5cf3.ad26 DefBEDown 5000000 DefBEUp
3/0 0011.8056.3fee DefBEDown 5000000 DefBEUp
3/0 0011.8059.f796 DefBEDown 5000000 DefBEUp
3/0 0011.8060.e598 DefBEDown 5000000 DefBEUp
3/0 0011.8060.e5b0 DefBEDown 5000000 DefRRUp
3/0 0011.8060.e5bc DefBEDown 5000000 DefBEUp
3/0 0011.8060.e5c2 DefBEDown 5000000 DefBEUp
3/0 0011.8061.0aca DefBEDown 5000000 DefBEUp
3/0 0011.8061.0bd8 DefBEDown 5000000 DefBEUp
3/0 0011.8061.0c08 DefBEDown 5000000 DefBEUp
3/0 0011.8061.0d22 DefBEDown 5000000 DefBEUp
3/0 0011.8061.0d64 DefBEDown 5000000 DefBEUp
3/0 0011.8061.0d94 DefBEDown 5000000 DefBEUp
3/0 0011.8061.0ee4 DefBEDown 5000000 DefBEUp
3/0 0011.ae02.56de DefBEDown 5000000 DefBEUp
3/0 0011.ae05.b850 DefBEDown 5000000 DefBEUp
3/0 0011.ae89.7820 DefBEDown 5000000 DefBEUp
/

13-364 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

The following table provides descriptions of the output fields:

Cable If The slot and MAC Domain of the cable


interface.
MAC The MAC address of the cable modem.
DS SCN Displays the current operational downstream
service class name of the service flow.
DS Max-Rate Displays the current maximum rate of the
primary downstream channel.
US SCN Displays the current operational upstream
service-class-name of the service flow.
US Max-Rate Displays the current maximum rate of the
primary upstream channel.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem qos [<X/Y> ] [ name <service class name>] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show cable modem qos [<X/Y> ] [ name <service class name>] [ | {count |
count-only}]

Compass ID: 327594480 Version 3 13-365


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y Limits output to the slot and MAC domain


specified.
name service class Limits output to the service class name
name specified.
| 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 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable modem qos summary


The show cable modem qos summary command displays a summary of QoS
activity for each MAC domain and associated service classes. The following is typical
screen output from the show cable modem qos summary command:

Cable Direction Primary Service CMs


IF Flow Service Name
3/0 downstream DefBEDown 23
3/0 downstream DefRRDown 5
3/0 downstream T1up 1
3/0 upstream DefBEUp 27
3/0 upstream DefRRUp 1
3/0 upstream penaltyUS 1

Summary

Direction Primary Service SFs


Flow Service Name
downstream DefBEDown 23
downstream DefRRDown 5
downstream T1up 1
upstream DefBEUp 27
upstream DefRRUp 1
upstream penaltyUS 1

Total downstream 29
Total upstream 29
Total 58

Compass ID: 327594480 Version 3 13-367


BSR 64000 Command Reference Guide Release 5.2.1

The following table provides descriptions of the output fields:

Cable I/F Output from the slot and MAC domain


specified.
Dir Output in the downstream or upstream
direction.
Primary SF SCN Output from the service class name specified.
Service Class Name
CMs The number of cable modems

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem qos summary [<X/Y>] [downstream | upstream ] [name
<service class name>] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show cable modem qos summary [<X/Y>] [downstream | upstream ] [name
<service class name>] [ | {count | count-only}]

Command Syntax

downstream Limits output to the downstream direction.


upstream Limits output to the upstream direction.
X/Y Limits output to the slot and MAC domain
specified.
name service class Limits output to the service class name
name specified.

13-368 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

| 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: 327594480 Version 3 13-369


BSR 64000 Command Reference Guide Release 5.2.1

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

13-370 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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}]

Compass ID: 327594480 Version 3 13-371


BSR 64000 Command Reference Guide Release 5.2.1

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-372 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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 or 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 17 07:53:53 2008


Last Poll Cycle Completed: THU APR 17 07:53:54 2008

Intf Prim Prim DS US DS Tx Micro Modem


Cable Ds Us Mac Address S/N Pwr Pwr Offs Refln State
----- ------ ------ -------------- ---- ---- ----- ----- ----- -------
9/0 9D0C0 U1C0L0 0017.ee85.affc 40.2 42.8 -6.9 3366 31 online
11/0 11D0C0 U0C0L0 0011.1aca.13a6 37.0 38.7 -0.4 1290 27 online
11/0 11D0C0 U1C0L0 0017.ee90.30ac 0.0 0.0 +0.0 0 0 offline
11/0 11D1C0 U5C0L0 0019.5eb4.704e 38.8 43.5 -2.6 3390 32 online
11/0 11D1C0 U5C0L0 0800.3e08.7f4e 35.4 42.0 -8.0 2843 0 online

The following information is displayed:.

Remote Query Enabled indicates that the Remote Query feature is enabled
Polling Disabled indicates that the Remote Query feature is disabled
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

Compass ID: 327594480 Version 3 13-373


BSR 64000 Command Reference Guide Release 5.2.1

Last Poll Cycle the date and time at which the last Remote Query polling cycle
Started: was started - if the Remote Query feature has never been enabled,
the field is not displayed
Last Poll Cycle displays the date and time at which the last Remote Query polling
Completed: cycle was completed - if the Remote Query feature has never been
enabled or the first Remote Query polling cycle has not yet
completed, the field is not displayed
Cable Interface the slot/port/downstream channel number/upstream channel
number of the cable modem
IP Address the IP address of the cable modem
Mac Address the MAC address of the cable modem
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
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+

13-374 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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 State online indicates that the cable modem is registered properly
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

The following is an example of typical screen output from the show cable modem
remote-query bonding downstream command:

Last Poll Cycle Started: InvalidLast Poll Cycle Completed: Invalid


Pri Pri Pri 2nd 2nd 2nd 3rd 3rd 3rd 4th 4th 4th
Mac Address Frq SNR Pwr Frq SNR Pwr Frq SNR Pwr Frq SNR Pwr
-------------- --- ---- ----- --- ---- ----- --- ---- ----- --- ---- -----
001f.c4aa.7ed1 555 39.8 -0.9 513 39.3 -1.9 519 40.3 -1.0 525 39.8 -1.2
001f.c4aa.7f23 555 39.8 -0.5 513 39.3 -2.3 519 39.8 -1.0 525 39.8 -1.8

The following is an example of typical screen output from the show cable modem
remote-query bonding detail command:

Compass ID: 327594480 Version 3 13-375


BSR 64000 Command Reference Guide Release 5.2.1

Cable Chan Tx Micro


Interface Mac Address Ip Address Desc Frq SNR Pwr Offs Refln
------------ -------------- --------------- ----- --- ---- ----- ---- -----
0/0/D0U1C0 001f.c4aa.7ed1 30.10.1.6 dsPri 555 39.8 -0.9 1474 0
dsSec 513 39.3 -2.0 0 0
dsSec 519 40.3 -0.9 0 0
dsSec 525 39.8 -1.4 0 0
usPri 24 0.0 44.5 0 0
0/0/D0U0C0 001f.c4aa.7f23 30.10.1.16 dsPri 555 39.8 -0.6 1475 0
dsSec 513 39.3 -2.3 0 0
dsSec 519 39.8 -0.9 0 0
dsSec 525 39.8 -1.9 0 0
usPri 31 0.0 45.8 0 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem remote-query [version | bonding [detail | downstream ]] [ |
{begin | exclude | include} {<WORD>} | {count | count-only}]
show cable modem remote-query [version | bonding [detail | downstream ]] [ |
{count | count-only} {<WORD>}]

13-376 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

version displays the version of software that a


customer cable modem is running, i.e
"SB6120 SB6120-1.0.1.7-SCM00-NOSH"
bonding displays the SNR and power levels for
secondary channels with channel bonding
cable modems
detail provides detailed channel bonding
information
downstream provides downstream channel information
only
| 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: 327594480 Version 3 13-377


BSR 64000 Command Reference Guide Release 5.2.1

show cable modem security


The show cable modem security command displays a summary of initializing CMs’
security authorization state, one CM per line. The command provides output only for
“initializing” CMs which are CMs which have sent an initial DHCP Discover but
have not yet registered. Registered CMs and offline CMs are not displayed by the
show cable modem security command.
The following is an example of typical screen output from the show cable modem
security command:

CM MAC State DHCP Server TFTP Server P Config Filename C


-------------- --------- --------------- -------------- - -------------------- -
0000.0001.0002 init(o) 10.20.23.121 10. 20. 23.121 P ResLow.bin C
0000.0001.0003 reject(m) 10.20.23.121 10. 20. 23.121 - *ig/BusinessHigh.bin C

The following table provides descriptions of the output fields:

CM MAC The MAC address of the cable modem.


State Describes the connectivity state of a cable
modem - the table below describes the cable
modem connectivity states supported on the
BSR.
DHCP Server The DHCP server selected by the cable
modem through a DHCP-REQUEST. This
field will display a “-“ if the cable modem has
not yet sent a DHCP-REQUEST.
TFTP Server The MSO TFTP server address learned from
the DHCP-ACK. This field will display a “-“
if a DHCP-ACK has not been received.
P The “P” column reports a “P” if the BSR acts
as a TFTP proxy for the authorized TFTP
server, or “-“ otherwise.

13-378 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Config Filename The CM configuration filename. The BSR


supports configuration filenames of up to 128
characters. The show cable modem security
command will display all 128 characters of
the filename.
C The “C” column reports whether the TFTP
file contents were cached.

The following is an example of typical screen output from the show cable modem
<cm-mac> security command:

CM Mac: 0000.0001.0003
State: reject(m)
DHCP Server: 10.20.23.121
TFTP Server: 10.20.23.121 (proxy 172.52.111.1)
TOD Server: 10.20.23.121
Syslog Server: 10.20.23.121
Config File: /public/config/BusinessHigh.bin
Cached: Yes, last updated 19-jun-2008 03:43
Failure: Requested tftp file not authorized by DHCP.

Compass ID: 327594480 Version 3 13-379


BSR 64000 Command Reference Guide Release 5.2.1

The following table provides descriptions of the output fields:

CM MAC The MAC address of the cable modem.


State Describes the connectivity state of a cable
modem. The table below describes the cable
modem connectivity states supported by the
BSR.
DHCP Server The DHCP server selected by the cable
modem through a DHCP-REQUEST. This
field will display a “-“ if the cable modem has
not yet sent a DHCP-REQUEST.
TFTP Server The authorized TFTP Server reported in the
DHCP-ACK to the CM. If the BSR served as
a TFTP server proxy, the BSR’s proxy TFTP
server IP address provided to the CM is also
reported.This field will display a “-“ if a
DHCP-ACK has not been received.
TOD Server The Time of Day server IP address.
Syslog Server The Syslog server IP address.
Config File The CM configuration filename. The BSR
supports configuration filenames of up to 128
characters. The show cable modem
<cm-mac> security command will display all
128 characters of the filename.
Cached Reports whether the configuration file was
retrieved from the cache and, if so, what was
the date and time at which it was updated
from the MSO’s TFTP server.
Failure The “Failure” field provides a user-readable
reason for the latest cable security failure
reason for the CM, or “None” if none.

13-380 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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 or cable
security failure.
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.

Compass ID: 327594480 Version 3 13-381


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem [<cm-mac>] security [ | {begin | exclude | include} {<WORD>}
[ | {count | count-only}]]
show cable modem [<cm-mac>] security [ | {count | count-only}]

Command Syntax

cm-mac The MAC address of the cable modem.


| 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-382 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.

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
DS Kbytes the number of unicast Kbytes on the
downstream
US Kbytes the number of unicast Kbytes on the
upstream

The following is an example of typical screen output from the show cable modem
stats command:

Intf Prim Prim Prim Connect Mac Address Us Ds


Cable DS US Sid State KBytes KBytes
9/0 9D0C0 U1C0L0 15841 online 0017.ee85.affc 2158 0

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.

Compass ID: 327594480 Version 3 13-383


BSR 64000 Command Reference Guide Release 5.2.1

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

Command Line Usage


show cable modem {<X/Y> | <mac> | <prefix>} stats [subinterface] [ | {begin |
exclude | include} {<WORD>} [ | {count | count-only}]]

13-384 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-385


BSR 64000 Command Reference Guide Release 5.2.1

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 displaying upstream cable modem
information:

Cable Upstream Total Reg Unreg Offline SpecGrp LbGrp


Interface Modem Modem Modem Modem Name Name
2/0/U0 7 7 0 0 N/A N/A
2/0/U1 9 9 0 0 N/A N/A
9/0/U0 32 32 0 0 marlborough N/A
9/0/U1 29 29 0 0 marlborough N/A
9/0/U2 29 29 0 0 marlborough N/A
11/1/U4 16 16 0 0 N/A mansfield
11/1/U5 13 13 0 0 N/A mansfield
11/1/U6 8 8 0 0 N/A mansfield
11/1/U7 13 13 0 0 N/A mansfield

The following is an example of typical screen output from the show cable modem
summary downstream command:

Intf Prim Total Reg Unreg Offline LbGrp


Cable DS Modem Modem Modem Modem Name
0/0 0D0C0 3 3 0 0 RedSox
0/0 0D1C0 7 7 0 0 RedSox
0/0 9D0C0 4 4 0 0 RedSox
0/0 9D0C1 3 3 0 0 RedSox
Total 17 17 0 0

13-386 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

The following table provides descriptions of the output fields:

Intf Cable The slot and MAC Domain number.


Prim DS The primary slot, port, and downstream
channel number of the CMTS module.
Cable Upstream The slot, MAC Domain, and upstream port
Interface number of the CMTS module.
Total Modem The total number of active, registered, and
offline cable modems.
Reg Modem The number of cable modems which have
reached the Online(d), Online (pk),
Online(pt) or Online(un) states.
Unreg Modem The number of cable modems in any Init,
DHCP, Reject state or substate.
Offline Modem 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.
LbGrp The load balancing group assignment for each
upstream or downstream channel.

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 327594480 Version 3 13-387


BSR 64000 Command Reference Guide Release 5.2.1

Command Line Usage


show cable modem summary <X/Y> [downstream <NUM> | total ] [total]
[upstream <NUM> | total ] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]
show cable modem summary <X/Y> [downstream <NUM> | total ] [total]
[upstream <NUM> | total ] [ | {count | count-only}]

show cable modem summary [downstream [total ]] | [total] | upstream [total]] [ |


{begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show cable modem summary [downstream [total ]] | [total] | upstream [total]] [ |
{count | count-only}]]

Command Syntax

X/Y The slot and MAC Domain number of the


CMTS module.
downstream Displays downstream summary information.
upstream Displays upstream summary information.
total Displays total summary 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-388 Compass ID: 327594480 Version 3


Release 5.2.1 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:

Cable Total Active Registered SpecGrp LbGrp


Interface Modems Modems Modems Name Name
2/0/U0 7 0 7 N/A N/A
2/0/U1 9 0 9 N/A N/A
9/0/U0 32 0 32 marlborough N/A
9/0/U1 29 0 29 marlborough N/A
9/0/U2 29 0 29 marlborough N/A
11/1/U4 16 0 16 N/A mansfield
11/1/U5 13 0 13 N/A mansfield
11/1/U6 8 0 8 N/A mansfield
11/1/U7 13 0 13 N/A mansfield
Total 156 0 156

Cable Interface the BSR 64000 CMTS slot, port, and


upstream port number
Total Modem the total number of active, registered, and
offline cable modems
Reg Modem the number of cable modems which have
reached the Online(d), Online (pk),
Online(pt) or Online(un) states
Unreg Modem the number of cable modems in any Init,
DHCP, Reject state or substate
Offline Modem 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

Compass ID: 327594480 Version 3 13-389


BSR 64000 Command Reference Guide Release 5.2.1

SpecGrp the Spectrum Group name for each upstream


channel.
LbGrp the load balancing group assignment for each
upstream channel

Group Access
All

Command Mode
All modes except User EXEC

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-390 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-391


BSR 64000 Command Reference Guide Release 5.2.1

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-392 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-393


BSR 64000 Command Reference Guide Release 5.2.1

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 - Unsolicited 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

13-394 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

The following is typical output from the show cable modem svc-flow-id detail
command:

CM - 0017.ee85.affc
Cable Interface 9/0 9D0C0 U1/C0

Dir SFID SID Type State Sched Min-Rate Max-Rate Packets Bytes

Up 1 15841 Stat* Activ BE 100000 none 6132 2394478


Down 2 n/a Stat* Activ Undef 5000000 none 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: 327594480 Version 3 13-395


BSR 64000 Command Reference Guide Release 5.2.1

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:

Intf Prim Prim Connect Mac Address Registration


Cable DS US State Time
9/0 9D0C0 U1C0L0 online 0017.ee85.affc 000:16:57:25

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-396 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-397


BSR 64000 Command Reference Guide Release 5.2.1

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


module
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-398 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-399


BSR 64000 Command Reference Guide Release 5.2.1

The following is typical output from the show cable modem timing-offset command:

Intf Prim Prim Prim Connect Timing RxPwr Ip Address Mac Address
Cable DS US Sid State Offset dBmV
9/0 9D0C0 U1C0L0 15841 online 1267 0.0 150.31.92.87 0017.ee85.affc
11/0 11D0C0 U0C0L0 1 online 1290 -.1 150.31.93.12 0011.1aca.13a6
11/0 11D0C0 U1C0L0 3 init(r2) 1282 -4.4 0.0.0.0 0017.ee90.30ac
11/0 11D1C0 U5C0L0 8193 online 1291 -.1 150.31.93.40 0019.5eb4.704e
11/0 11D1C0 U5C0L0 2 online(pt) 2844 -.1 150.31.93.32 0800.3e08.7f4e

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.

13-400 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

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
X/Y the slot and MAC Domain number of the CMTS
module
subinterface show subinterface information

Compass ID: 327594480 Version 3 13-401


BSR 64000 Command Reference Guide Release 5.2.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-402 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-403


BSR 64000 Command Reference Guide Release 5.2.1

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-404 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable modem vendor


The show cable modem vendor command displays the cable modem’s vendor name
which is returned from the Organizational Unique Identifier (OUI) vendor table. If no
match is found in the OUI vendor table, the vendor field is left blank. Currently, 71
vendors and 729 OUI's are supported by this command.
The following is an example of typical screen output from the show cable modem
vendor command:

Vendor MAC I/F Connect Prim RxPwr Timing Num BPI


Address State Sid (dBmV) Offset CPE
Motorola 0020.4041.7c40 4/0/U1 online 21 0.4 1888 0 N
Motorola 0020.4041.7d18 4/0/U0 online 22 0.0 567 0 N
Motorola 0011.aefe.8fbe 9/0/U0 online 62 0.0 1792 0 N
Motorola 0015.2f48.0f0a 9/0/U0 online 71 0.2 1297 0 N
Motorola 0015.9a6a.88ee 9/0/U0 online 68 0.0 1280 0 N
Motorola 0015.9a6a.8906 9/0/U0 online 69 0.1 1281 0 N
Motorola 0015.9a6a.8932 9/0/U0 online 67 -.2 1279 0 N
Motorola 0015.9adc.7c8c 9/0/U0 online 70 -.1 1279 0 N

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem vendor {<cm-mac> | <X/Y>} [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem vendor {<cm-mac> | <X/Y>} [ | {count | count-only}]

Compass ID: 327594480 Version 3 13-405


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

cm-mac cable modem Mac address in the form of


xxxx.xxxx.xxxx
X/Y the slot and MAC Domain number of the
CMTS module
| 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-406 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable modem vendor summary


The show cable modem vendor summary command displays cable modem
summary totals per vendor OUI. The following is an example of typical screen output
from the show cable modem vendor summary command:

Interface: 5/0
Vendor OUI Total CM's Registered Unregistered Offline
Motorola 000e.5c 1 1 0 0
Motorola 0011.ae 1 1 0 0
Motorola 0012.25 1 1 0 0
Motorola 0017.ee 1 1 0 0
Interface: 5/1
Vendor OUI Total CM's Registered Unregistered Offline
Motorola 0017.ee 1 1 0 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable modem vendor summary {<X/Y>} [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem vendor summary {<X/Y>} [ | {count | count-only}]

Compass ID: 327594480 Version 3 13-407


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
| 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-408 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable modem verbose


The show cable modem verbose command displays detailed cable modem
information
The following is an example of typical screen output from the show cable modem
verbose command:

MAC Address: 0017.ee85.b020


IP Address: 150.31.93.65
Prim Sid: 8194
QoS Profile Index: 0
Interface: Cable 11/1/D1/U5/C0
sysDescr: Vendor = Motorola , Model =
Upstream Power: 0.0
Downstream Power: 0.0
Timing Offset: 1280
Received Power: -1
MAC Version: Docsis 2.0
Qos Provisioned Mode: 1.1
Phy Operating Mode: TDMA
Capabilities: Frag = yes , Concat = yes , PHS = yes , Priv = BPI
Sid/Said Limit: Max US Sids = 16 , Max DS Saids = 15
Transmit Eq. Support: Taps/Symbol = 1 , Num of Taps = 24
Number of CPE IP's: 0
Max number of CPE's: 16
Total US Data: 0 bytes
Total US Throughput: 0 bytes/sec
Total DS Data: 0 byte
Total DS Throughput: 0 bytes/sec
Max Classifiers: 0
Total Time Online: 002:13:43:43

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 327594480 Version 3 13-409


BSR 64000 Command Reference Guide Release 5.2.1

Command Line Usage


show cable modem [<cm-mac>] verbose [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable modem [<cm-mac>] verbose [ | {count | count-only}]]

Command Syntax

cm-mac cable modem Mac address in the form of


xxxx.xxxx.xxxx
| 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-410 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-411


BSR 64000 Command Reference Guide Release 5.2.1

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-412 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-413


BSR 64000 Command Reference Guide Release 5.2.1

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-414 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-415


BSR 64000 Command Reference Guide Release 5.2.1

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-416 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-417


BSR 64000 Command Reference Guide Release 5.2.1

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-418 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Line Usage


show cable privacy cm-tek [<1-8192>]

Command Syntax

1-8192 cable modem’s Service ID number

Compass ID: 327594480 Version 3 13-419


BSR 64000 Command Reference Guide Release 5.2.1

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-420 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable privacy enforce-bpi-plus


The show cable privacy enforce-bpi-plus command displays whether BPI+ is
enabled and enforced on a MAC domain. The following is typical screen output from
the show cable privacy enforce-bpi-plus command:

’-’ for ’no cable privacy enforce-bpi-plus’


’E’ for ’cable privacy enforce-bpi-plus’
Interface Configuration Operation
--------- ------------- ---------
Global - -
cable 3/0 - -
cable 3/1 E E
cable 10/0 - -
cable 10/1 - -

Group Access
All

Command Mode
All Modes except User EXEC

Command Line Usage


show cable privacy enforce-bpi-plus

Compass ID: 327594480 Version 3 13-421


BSR 64000 Command Reference Guide Release 5.2.1

show cable privacy mandatory


The show cable privacy mandatory command displays the cable privacy
configuration for each MAC domain. The following is typical screen output from the
show cable privacy enforce-bpi-plus command:

’-’ for ’no cable privacy mandatory’


’M’ for ’cable privacy mandatory’
’M+’ for ’cable privacy mandatory bpi-plus-only’
Interface Configuration Operation
--------- ------------- ---------
Global - -
cable 3/0 M+ M+
cable 3/1 - -
cable 10/0 - -
cable 10/1 - -

Group Access
All

Command Mode
All Modes except User EXEC

Command Line Usage


show cable privacy mandatory

13-422 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-423


BSR 64000 Command Reference Guide Release 5.2.1

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-424 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-425


BSR 64000 Command Reference Guide Release 5.2.1

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-426 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-427


BSR 64000 Command Reference Guide Release 5.2.1

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-428 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-429


BSR 64000 Command Reference Guide Release 5.2.1

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 cable modem 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 is an
example of typical screen output from the show cable qos svc-flow classifier
command:

13-430 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Interface index: 75431936


Service flow id: 6
Packet class id: 2
Packet class direction: Downstream
Packet class priority: 20
Packet class IP tos low: 0
Packet class IP tos high: 0
Packet class IP tos mask: 0
Packet class IP protocol: 258
Packet class IP source addr: 0.0.0.0
Packet class IP source mask: 0.0.0.0
Packet class IP dest addr: 0.0.0.0
Packet class IP dest mask: 0.0.0.0
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 dest Mac Addr: 1214.2428.3848
Packet class enet prot type: 0
Packet class enet protocol: 0x0
Packet class state: Active
Packet class packets: 0

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 327594480 Version 3 13-431


BSR 64000 Command Reference Guide Release 5.2.1

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
1-4292967295 SFID
1-65535 Classifier identification

13-432 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-433


BSR 64000 Command Reference Guide Release 5.2.1

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

13-434 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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: 159318016


Qos service flow id: 1
Qos parameter set type: Active
Qos parameter set bit map: 0x10800000
Qos classname: DefRRUp
Qos active timeout: 0
Qos admitted timeout: 200
Qos scheduling type: Best Effort
Qos traffic priority: 0
Qos max traffic rate: 0
Qos max traffic burst: 3044
Qos min reserved rate: 100000
Qos min reserved pkt size: 128
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>]

Compass ID: 327594480 Version 3 13-435


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
1-4292967295 service flow ID

13-436 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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.
The following is typical output from the show cable qos svc-flow phs command:

Interface index: 192872704


Qos service flow id: 1599
Qos PHS index: 1
Qos PHS field:
00 00 00 00 00 00 00 13 71 38 e1 74 08 00 45 a0
00 c8 00 00 00 00 40 11 00 00 96 33 01 34 96 33
01 37 c0 02 c0 02 00 b4 00 00
Qos PHS Mask:
03 ff 3f 3c 30 c0
Qos PHS size: 42
Qos PHS verify: 1
Qos PHS classifier index: 662
Packets: 533

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>]]]

Compass ID: 327594480 Version 3 13-437


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
1-4292967295 SFID
1-65535 Classifier identification

13-438 Compass ID: 327594480 Version 3


Release 5.2.1 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: 159318016


Qos service flow id: 1
Qos service flow packets: 6280
Qos service flow octets: 2452091
Qos service flow time created: 16335
Qos service flow time active: 64996 seconds
Qos service flow PHS unknowns: 0
Qos service flow policed drop packets: 0
Qos service flow policed delay packets: 0
Qos service flow class: DefRRUp
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
Bonding group Id (0=non-bonded) 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: 327594480 Version 3 13-439


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
1-4292967295 SFID

13-440 Compass ID: 327594480 Version 3


Release 5.2.1 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
1-4292967295 SFID

Compass ID: 327594480 Version 3 13-441


BSR 64000 Command Reference Guide Release 5.2.1

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
1-16383 Classifier identification

13-442 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable spectrum-group


The show cable spectrum-group command is used to verify if an assigned Spectrum
Group is activated for an upstream port and if and how the Spectrum Group is
configured for Advanced Spectrum Management.
The show cable spectrum-group command displays the following Spectrum Group
information::

Member channel the channels which belong to the Spectrum Group being
displayed
CfgFreq the configured center frequency - this is the frequency set in the
running configuration for this upstream channel
Cfg MP the configured modulation profile - this is the number of the
modulation profile set in the running configuration for this
upstream channel
ActFreq the active center frequency - this is the frequency this upstream is
currently tuned to
Act MP the active modulation profile - this is the Modulation Profile
Number which the upstream channel is currently using
ModType the modulation type - this is the Modulation type currently being
used on this upstream channel
Thresh the configured hop threshold snr modulation-type value for the
modulation type currently in use on this upstream channel
ChanWidth the channel width currently in use on this upstream channel
ChanQual the quality of this upstream channel - NORMAL or IMPAIRED

The following is an example of typical screen output from the show cable
spectrum-group command:

Compass ID: 327594480 Version 3 13-443


BSR 64000 Command Reference Guide Release 5.2.1

Spectrum Group: sg1


Member channel CfgFreq Cfg MP ActFreq Act MP ModType Thresh ChanWidth ChanQual
Cable 9/0/U0 10000000 1 25000000 1 16qam 20db 3200000 NORMAL
Cable 9/0/U1 13200000 1 13200000 1 16qam 20db 3200000 NORMAL
hop snr hysteresis 2 db
hop sampling-period active-channel 0 sec
hop sampling-period rollback-channel 10 sec
hop sampling-period spare-channel 60 sec
reference-modem-exclusion 0

hop action modulation-profile 2 priority 128


hop action frequency 25000000 priority 128

The following is an example of typical screen output from the show cable
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

13-444 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Line Usage


show cable spectrum-group [<WORD> [schedule ]]

Command Syntax

WORD the Spectrum Group name applied to the


upstream port
schedule display the Spectrum Group schedule

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 327594480 Version 3 13-445


BSR 64000 Command Reference Guide Release 5.2.1

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.

13-446 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable spectrum-group map


The show cable spectrum-group command displays the state of each channel in the
Spectrum Group. The command displays the following Spectrum Group map states:

SPEC_RESERVED this portion of the upstream spectrum has been configured as


the primary channel for use by the listed Member Channel
and is not currently being used - this portion of the spectrum
is not available for use by other upstream interfaces
SPEC_OCCUPIED this portion of the upstream spectrum is currently being used
by the listed Member Channel. This portion of the spectrum
is the configured primary channel for the listed Member
Channel - this portion of the spectrum is not available for use
by other upstream interfaces
SPEC_HOP_AVAIL this portion of the upstream spectrum is not currently being
used and is available for use by any member channel which
belongs to this Spectrum Group
SPEC_AGILE this portion of the upstream spectrum is currently being used
by the listed member channel - this is being used because the
configured primary channel was impaired the last time it was
checked - this portion of the spectrum is not available for use
by other upstream interfaces until the listed member channel
switches back to it’s primary channel or another portion of
the spectrum

The following is an example of typical screen output from the show cable
spectrum-group map command:

Compass ID: 327594480 Version 3 13-447


BSR 64000 Command Reference Guide Release 5.2.1

Spectrum Group : sg1


Start Frequency (Hz) stop Frequency (Hz) Map status Member channels
8400000 11600000 SPEC_RESERVED Cable 9/0/U0
11600000 14800000 SPEC_OCCUPIED Cable 9/0/U1
23400000 26600000 SPEC_HOP_AVAIL -------
36400000 39600000 SPEC_AGILE Cable 9/0/U0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable spectrum-group [<WORD>] map

Command Syntax

WORD the Spectrum Group name applied to the


upstream port

13-448 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable spectrum-group modem-exclusion-list


The show cable spectrum-group modem-exclusion-list command displays the list
of low SNR cable modems that are not allowed to be used for channel assessment.
The following is an example of typical screen output from the show cable
spectrum-group modem-exclusion-list command:

Spectrum Group: sg1


Interface: Cable 9/0/U0 Last built on: MON MAR 19 07:40:01 2007

SNR
Mac Address Ip Address (Tenth DB)
0015.9a6a.88ee 150.31.32.76 147
0015.9a6a.8906 150.31.32.71 156

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable spectrum-group [<WORD>] modem-exclusion-list

Command Syntax

WORD the Spectrum Group name applied to the


upstream port

Compass ID: 327594480 Version 3 13-449


BSR 64000 Command Reference Guide Release 5.2.1

show cable spectrum-group reference-modem


The show cable spectrum-group reference-modem command displays the active
and rollback reference cable modems being used for channel assessment. The
reference cable modem list is built every 5 minutes. The active reference cable
modem is listed first and the rollback reference cable modem is listed second.
The following is an example of typical screen output from the show cable
spectrum-group reference-modem command:

Spectrum Group: sg1, reference-modem-exclusion = 2


Interface: Cable 9/0 U0
SNR
Active Reference Mac Address Ip Address (Tenth DB)
Cable Modem 0015.9a6a.8932 150.31.32.68 230
0015.2f48.0f0a 150.31.32.67 235

Rollback Reference
Cable Modem

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable spectrum-group [<WORD>] reference-modem

Command Syntax

WORD the Spectrum Group name applied to the


upstream port

13-450 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show cable spectrum-group snr-thresholds


The show cable spectrum-group snr-thresholds command displays the default and
user configured SNR threshold configuration for each modulation type.
The following is an example of typical screen output from the show cable
spectrum-group snr-thresholds command:

Spectrum Group : sg1


Default Thresholds (dB) Configured Thresholds (dB)
qpsk 14 qpsk 14
8qam 17 8qam 17
16qam 20 16qam 21
32qam 23 32qam 24
64qam 27 64qam 28
128qam 30 128qam 31
256qam 33 256qam 34

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable spectrum-group [<WORD>] snr-thresholds

Command Syntax

WORD the Spectrum Group name applied to the


upstream port

Compass ID: 327594480 Version 3 13-451


BSR 64000 Command Reference Guide Release 5.2.1

show cable spectrum-group stats


The show cable spectrum-group stats command displays statistics per Spectrum
Group for the ASPM feature. The command provides an overall picture on how the
Spectrum Group is operating. The show cable spectrum-group stats command
displays the following Spectrum Group information:

Member channel the channels which belong to the Spectrum Group being
displayed
Freq Hops the number of times that the channel has changed (hopped)
to spare frequencies due to noise - this total also includes
the number of times the frequency has rolled back to its
configured frequency
MProf Hops the number of times that the channel has hopped to a spare
modulation profile due to noise - this total also includes
the number of times the modulation profile has rolled back
to its configured modulation profile
%Cfg Freq the percentage of time that the configured frequency was
in use over the sampling period
% in Modulation modes the percentage of time that each modulation profile was in
use over the sampling period
Start Time the start time of the statistical sampling period in mm/
dd-hh:ss format
Stop Time the stop time of the statistical sampling period in mm/
dd-hh:ss format - this is the current time

The following is typical screen output from the show cable spectrum-group stats
command:

Member Freq MProf %Cfg | % in Modulation modes | Start Stop


Channel Hops Hops Freq 256 128 64 32 16 8 qpsk Time Time
4/0/U0 0 0 100 0 0 0 0 100 0 0 01/29-13:55 01/30-13:15

13-452 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable spectrum-group [<WORD>] stats

Command Syntax

WORD the Spectrum Group name applied to the


upstream port

Compass ID: 327594480 Version 3 13-453


BSR 64000 Command Reference Guide Release 5.2.1

show cable submgmt default


The show cable submgmt default command displays default filter control
parameters for CPEs.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable submgmt default

13-454 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-455


BSR 64000 Command Reference Guide Release 5.2.1

show cable tcpudp-filter


The show cable tcpudp-filter command displays the TCP/UDP packet filter
configuration.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable tcpudp-filter [group <1-32> [index <1-64>]]

Command Syntax

group 1-32 displays a specified TCP/UDP


packet filter group
index 1-64 displays the packet filter

13-456 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-457


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module

13-458 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-459


BSR 64000 Command Reference Guide Release 5.2.1

show cable ugs-stats


The show cable ugs-stats command is used to determine how many calls are active
on a given BSR upstream port at a specific time.
The following is an example of screen output from the show cable ugs-stats
command:

US Interface slot/port: 4/1


Current flow count: 3
Flow count Max (last 5 min window): <Valid in 5 minute(s)>
Flow count Min (last 5 min window): <Valid in 5 minute(s)>
Flow count Ave (last 5 min window): <Valid in 5 minute(s)>
Flow count Max (last 10 min window): <Valid in 10 minute(s)>
Flow count Min (last 10 min window): <Valid in 10 minute(s)>
Flow count Ave (last 10 min window): <Valid in 10 minute(s)>

The Current Flow Count output field is updated every time statistics are displayed.
The Maximum, Minimum and Average UGS flow counts for voice calls are updated
once every minute to display their status within the configured sample period. Once
enough samples are collected, these statistics become valid.

Note: The UGS Statistics window is refeshed every 60 seconds. The


sampling time period displayed in the show cable ugs-stats command
outputis specified with the ugs-stats-window command.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable ugs-stats {<0-15> <0-7>}

13-460 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

0-15 CMTS module number


0-7 the upstream port number

Compass ID: 327594480 Version 3 13-461


BSR 64000 Command Reference Guide Release 5.2.1

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-462 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-463


BSR 64000 Command Reference Guide Release 5.2.1

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-464 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-465


BSR 64000 Command Reference Guide Release 5.2.1

show cable upstream global-clock


The show cable upstream global-clock command displays the Global Clock Delay
(GCD) setting for a specified upstream port and if the GCD setting is enabled for that
upstream port. The following is typical screen output from the show cable upstream
global-clock command:

Global Clock: 16
Global Clock Enabled: TRUE

Note: When using the show cable upstream global-clock command, both
the NUM and X/Y arguments display for a BCM 3140-based DOCSIS 2.0 2:8
CMTS module. The show cable upstream global-clock command is only
applicable for an upstream port (NUM) and is not applicable for an upstream
port and logical channel (X/Y). The show cable upstream global-clock
command will only be available through the NUM argument.

Group Access

All

Command Mode

Interface Configuration (cable interface only)

Command Line Usage

show cable upstream <NUM> global-clock

Command Syntax

NUM the upstream port number

13-466 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show controllers cable ds-mac


The show controllers cable ds-mac command displays the downstream MAC
parameters (BCM3215 devices) of a TX32 slot. The following is an example of
typical screen output from the show controllers cable ds-mac command:

*** ds-mac module 0 ***


DS MAC part_id=3215, rev_id=C8F0001
Mac Address: 0200.0000.0100
ENP version: 000101

RX TX
Total: 2818004 Pkts 8003011 Pkts
337034878 Bytes 1549103444 Bytes
FCS Error: 0 Pkts 0 Pkts
Multicast: 0 Pkts 0 Pkts
Broadcast: 0 Pkts 0 Pkts
Control: 0 Pkts 0 Pkts
Pause: 0 Pkts 0 Pkts
Unknown OPCode: 0 Pkts N/A
Alignment Error: 0 Pkts N/A
Frame Len Error: 0 Pkts N/A
Undersize: 0 Pkts 0 Pkts
Oversize: 0 Pkts 0 Pkts
Fragment: 0 Pkts 0 Pkts
Dropped: 0 Pkts N/A

Compass ID: 327594480 Version 3 13-467


BSR 64000 Command Reference Guide Release 5.2.1

Ingress Control: 881359 Pkts


Dropped: 0 Pkts
DOCSIS: 75496164 Pkts
Status: 0x00000000
Chan S/P/C Hi Que (pkts) Med Que (pkts) Lo Que (pkts)
0 0/0/0 0 0 0
1 0/0/1 0 0 0
2 0/0/2 0 0 0
3 0/0/3 0 0 0
4 0/1/0 0 0 0
5 0/1/1 0 0 0
6 0/1/2 0 0 0
7 0/1/3 0 0 0

Egress DOCSIS: 75496164 Pkts


Chan S/P/C MPT (bps) Hi Byte Cnt Lo Byte Cnt Packet Cnt
0 0/0/0 37700000 0 2725219244 52715990
1 0/0/1 37700000 0 2729065023 52745617
2 0/0/2 37700000 0 0 0
3 0/0/3 37700000 0 0 0
4 0/1/0 37700000 0 0 0
5 0/1/1 37700000 0 0 0
6 0/1/2 37700000 0 0 0
7 0/1/3 37700000 0 0 0

Chans PHS Auto-CRC Cnt PHS Mask-Field Cnt PHS Mask-Ones Cnt
0-3 0 0 0
4-7 0 0 0

Chans DOCSIS Pkts Invalid DOCSIS Pkts


0-3 75496128 0
4-7 36 0

13-468 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Ring Manager
Ring Base Address: 0x01F9D800
Control Status: 0x00000000
FIFO Status: 0x0001021E
Chan Queue Status0 Status1 Status2 Status3 Status4
-------------------------------------------------------------------------
0 LO 0x00000000 0x81A00000 0xEA12303E 0x87198719 0x00000007
0 MED 0x00000000 0x81A3E800 0xEA12303E 0x82548254 0x00000007
0 HI 0x00000000 0x81A7D000 0x6A12303E 0x87820782 0x00000007

1 LO 0x00000000 0x81ABB800 0x6A12303E 0x86690669 0x00000007


1 MED 0x00000000 0x81AFA000 0xEA12303E 0x82C282C2 0x00000007
1 HI 0x00000000 0x81B38800 0xEA12303E 0x83478347 0x00000007

2 LO 0x00000000 0x81B77000 0xEA12303E 0x86AE86AE 0x00000007


2 MED 0x00000000 0x81BB5800 0x6A12303E 0x82810281 0x00000007
2 HI 0x00000000 0x81BF4000 0xEA12303E 0x834A834A 0x00000007

3 LO 0x00000000 0x81C32800 0xEA12303E 0x817D817D 0x00000007


3 MED 0x00000000 0x81C71000 0x6A12303E 0x82530253 0x00000007
3 HI 0x00000000 0x81CAF800 0x6A12303E 0x87850785 0x00000007

4 LO 0x00000000 0x81CEE000 0x6212303E 0x80000000 0x00000007


4 MED 0x00000000 0x81D2C800 0x6212303E 0x80000000 0x00000007
4 HI 0x00000000 0x81D6B000 0xEA12303E 0x80048004 0x00000007

5 LO 0x00000000 0x81DA9800 0x6212303E 0x80000000 0x00000007


5 MED 0x00000000 0x81DE8000 0x6212303E 0x80000000 0x00000007
5 HI 0x00000000 0x81E26800 0xEA12303E 0x80048004 0x00000007

6 LO 0x00000000 0x81E65000 0x6212303E 0x80000000 0x00000007


6 MED 0x00000000 0x81EA3800 0x6212303E 0x80000000 0x00000007
6 HI 0x00000000 0x81EE2000 0xEA12303E 0x80048004 0x00000007

7 LO 0x00000000 0x81F20800 0x6212303E 0x80000000 0x00000007


7 MED 0x00000000 0x81F5F000 0x6212303E 0x80000000 0x00000007
7 HI 0x00000000 0x81F9D800 0xEA12303E 0x80048004 0x00000007

Compass ID: 327594480 Version 3 13-469


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
MSO

Command Mode
All modes except for User EXEC

Command Line Usage


show controllers cable ds-mac <X> module <0-3>

Command Syntax

X the TX32 slot number


0-3 the BCM3215 chip number

13-470 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

show controllers cable ds-phy


The show controllers cable ds-phy command displays the downstream PHY
information for the 4QRM devices of a TX32 slot. The following is an example of
typical screen output from the show controllers cable ds-phy command:

4QRM module 0
DS S/N= 01860807263705500013
Frequency 555000000 HZ, Power Level 520 10th dBmV, channel-mode 4 channel
FPGA Interface version fe020006
RF Output Level: 52.10
Muting (0-Unmute): 0
Reference Input Signal Status: 0
Base plate Temerature in Celsius: 41
+5VDC supply input: 5.060
+3.3VDC supply input: 3.190
Loss of Sync: 0
Not Locked to the 27 MHz Ref: 0
Not Detected the 27 MHz Ref: 0
Loss of Data Clock: 0
Synchroization Fault: 0
Initialization Error: 0
RF level exceeds upper threshold: 0
RF level below lower threshold: 0
+3.3VDC above upper threshold: 0
+3.3VDC below lower threshold: 0
+5VDC above upper threshold: 0
+5VDC below lower threshold: 0
Plate temp above upper threshold: 0
Plate temp threshold: 0
Missing Digital Data Input Ch0 0
Missing Digital Data Input Ch1 0
Missing Digital Data Input Ch2 0
Missing Digital Data Input Ch3 0

Compass ID: 327594480 Version 3 13-471


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
MSO

Command Mode
All modes except for User EXEC

Command Line Usage


show controllers cable ds-phy <X> module <0-7>

Command Syntax

X the TX32 slot number


0-7 the 4QRM device number - selects one of the
eight 4QRM devices on the TX32

13-472 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-473


BSR 64000 Command Reference Guide Release 5.2.1

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

13-474 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-475


BSR 64000 Command Reference Guide Release 5.2.1

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

13-476 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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:

Compass ID: 327594480 Version 3 13-477


BSR 64000 Command Reference Guide Release 5.2.1

cable 0/0 is up, line protocol is up


Hardware is Cable, Mac address is 00:30:b8:c1:d6:00
snmpIndex=0x7f0000(8323072)
MTU 1500 bytes
Last clearing of
"show interface
" counters 01:11:24
5 minute Input rate 815 bytes/sec, 5 packets/sec
5 minute Output rate 140564 bytes/sec, 10 packets/sec
24508 packets input, 4024761 bytes
Received 269 broadcasts+multicasts
0 input errors,
44549 packets output, 574571990 bytes
0 output errors
Length of output packet queue 0
downstream port 0, snmpIndex=0x800000(8388608)
upstream port 0, snmpIndex=0x810000(8454144)
upstream port 1, snmpIndex=0x810001(8454145)
upstream port 2, snmpIndex=0x810002(8454146)
upstream port 3, snmpIndex=0x810003(8454147)
upstream port 4, snmpIndex=0x810004(8454148)
upstream port 5, snmpIndex=0x810005(8454149)
upstream port 6, snmpIndex=0x810006(8454150)
upstream port 7, snmpIndex=0x810007(8454151)
downstream port 1, snmpIndex=0x800010(8388624)
downstream slot 12, port/chan 0/0, snmpIndex=0xc800000(209715200)
downstream slot 12, port/chan 0/1, snmpIndex=0xc800001(209715201)

Group Access
All

Command Mode
All modes except User EXEC

13-478 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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: 327594480 Version 3 13-479


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
| 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-480 Compass ID: 327594480 Version 3


Release 5.2.1 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

Intf Total Peak Allow Curr Curr Allow Curr Curr


Cable DS/US Alloc #Calls BW Alloc #Calls BW Alloc #Calls
---------------------------- --------------------- ---------------------
9/0 9D0C0 0.36% 0 25% 0.00% 0 1% 0.00% 0
9/0 U0C0 0.00% 0 30% 0.00% 0 1% 0.00% 0
9/0 U1C0 0.73% 0 30% 0.00% 0 1% 0.00% 0
9/0 U2C0 0.00% 0 30% 0.00% 0 1% 0.00% 0
9/0 U3C0 0.00% 0 30% 0.00% 0 1% 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: 327594480 Version 3 13-481


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of the


CMTS module
| 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-482 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-483


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module
| 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-484 Compass ID: 327594480 Version 3


Release 5.2.1 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 9/0: Downstream 0 is up


48326 packet output, 3734348280 bytes, 0 discarded
Avg downstream channel utilization : 0
1 total active modems
Spectrum Group: N/A
LB Group: N/A
MD-DS-SG-ID: None
Fiber-Node: FN-1

Group Access
All

Compass ID: 327594480 Version 3 13-485


BSR 64000 Command Reference Guide Release 5.2.1

Command Mode
All modes except User EXEC

Command Line Usage


show interfaces cable <X/Y> downstream [<NUM>] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show interfaces cable <X/Y> downstream [<NUM>] [ | {count | count-only}]

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module
NUM is a list of local and/or remote
downstream channels separated by
for a description of the NUM spaces
syntax for downstream • local channels are represented as
channels, refer to the figure a single digit channel number
below this table • remote channels are in the form
slot/downstream port number/
downstream channel number - a
remote TX32 downstream
channel must be bound before it
can be bonded
| 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-486 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

count count the number of outputted lines


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

4/[0-7]/[0-3] 9/[0-1] 11/[0-1]

TX32 Module Slot Number/ 2:8 CMTS Module Slot Number/


TX32 Downstream Port Number/ Downstream Port Number
TX32 Downstream Channel Number

Compass ID: 327594480 Version 3 13-487


BSR 64000 Command Reference Guide Release 5.2.1

show interfaces cable intercept


Use the show interfaces cable intercept command to view statistical information for
each intercepted Customer Premises Equipment (CPE) MAC address.

Note: The show interfaces cable intercept command is only available to a


user logged in as securityuser - refer to Configuring Cable Intercepts in the
BSR 64000 CMTS Configuration and Management Guide.

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

13-488 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Mode
All modes except User EXEC mode.

Command Line Usage


show interfaces cable <X/Y> intercept

Command Syntax

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


module

Compass ID: 327594480 Version 3 13-489


BSR 64000 Command Reference Guide Release 5.2.1

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:

Service Level Interface database

| non-bonded flow counts |


Dir Ch ClassName Pri Thr CAP MAB FreeBW | Defer Succe Restr HighPri |
==========================================================================
Dn 0 DefBEDown 1 0 0 10 100% 0 0 0 0
Dn 0 DefRRDown 1 0 5 10 96% 0 0 0 0
Dn 0 DefEMDown 1 0 100 1 100% 0 0 0 0
Dn 0 DefMCDown 1 0 100 1 100% 0 0 0 0
Dn 0 DefVoiceD 5 0 100 25 100% 0 0 0 0
Dn 0 mysc 1 0 5 20 100% 0 0 0 0
Dn 0 Multicast 20 0 100 30 100% 0 0 0 0
Dn 0 myclass2 1 0 0 1 100% 0 0 0 0
Dn 0 myclass3 1 0 0 1 100% 0 0 0 0
--------------------------------------------------------------------------
Up 0 DefBEUp 1 0 0 10 100% 0 0 0 0
Up 0 DefRRUp 1 0 50 25 100% 0 0 0 0
Up 0 DefUGS 1 0 100 25 100% 0 0 0 0
Up 0 DefUGSAD 1 0 80 5 100% 0 0 0 0
Up 0 DefRTPS 1 0 5 5 100% 0 0 0 0
Up 0 DefNRTPS 1 0 5 5 100% 0 0 0 0
Up 0 DefEMUp 1 0 100 1 100% 0 0 0 0

Group Access
All

Command Mode
All modes except User EXEC

13-490 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Line Usage


show interfaces cable <X/Y> service-class [all | downstream <NUM> | upstream
<NUM>] [ | {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
all display both upstream and
downstream service class
information
NUM is a list of local and/or remote
downstream channels separated by
for a description of the NUM spaces
syntax for downstream • local channels are represented as
channels, refer to the figure a single digit channel number
below this table • remote channels are in the form
slot/downstream port number/
downstream channel number - a
remote TX32 downstream
channel must be bound before it
can be bonded
upstream NUM 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

Compass ID: 327594480 Version 3 13-491


BSR 64000 Command Reference Guide Release 5.2.1

WORD the specified string


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

4/[0-7]/[0-3] 9/[0-1] 11/[0-1]

TX32 Module Slot Number/ 2:8 CMTS Module Slot Number/


TX32 Downstream Port Number/ Downstream Port Number
TX32 Downstream Channel Number

13-492 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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 0
1/0 1 0 0 0 0
2/0 0 0 0 0 0
3/0 0 0 0 0 0
8/0 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
| 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: 327594480 Version 3 13-493


BSR 64000 Command Reference Guide Release 5.2.1

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-494 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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:

Compass ID: 327594480 Version 3 13-495


BSR 64000 Command Reference Guide Release 5.2.1

Cable 9/0: Upstream 0 is up


Received 0 broadcasts, 0 multicasts, 13 unicasts
0 discarded, 0 errors, 0 unknown protocol
Avg upstream channel utilization : 0
13 packets input
Total Modems On This Upstream Channel: 0
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 FF.FA.00.01.00.09.00.0B

The following is an example of typical screen output from the show interfaces cable
upstream spectrum command:

13-496 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-497


BSR 64000 Command Reference Guide Release 5.2.1

Command Mode
All modes except User EXEC

Note: When using the show cable interfaces upstream command, only the
NUM option displays for 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}]

13-498 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Command Syntax

X/Y the slot and MAC Domain number of


the CMTS module
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
count count the number of outputted lines
count-only count the number of lines while
suppressing screen output

Compass ID: 327594480 Version 3 13-499


BSR 64000 Command Reference Guide Release 5.2.1

show interfaces cable upstream channel-agility-stats


The show interfaces cable upstream channel-agility-stats command displays
ASPM Channel Statistics.
The following is an example of typical screen output from the show interfaces cable
upstream channel-agility-stats command:

Spectrum Group: sg1


Channel: Cable 9/0 U0
State: SPM_CHAN_NORMAL_ST
Number of State Transitions: 6
Last State Transitions: THU MAR 08 01:23:01 2007
Elapsed time in Current state 02:06:25.0

Note: The displayed "Elapsed time in Current state" value is dependant on


the amount of elapsed time. In the example above, the time is displayed in
Hours:Minutes:Seconds.10ths of a Second. If the BSR has been running for
a longer period of time, the display could be similar to the following:

1w:10d:6h

which would indicate Weeks:Days:Hours.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show interfaces cable <X/Y> upstream <NUM> channel-agility-stats

13-500 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

Note: When using the show cable interfaces upstream


channel-agility-stats command, only the NUM argument displays for a BCM
3138-based 2:8 CMTS module (For example: show cable interfaces
upstream <NUM> channel-agility-stats). Both the NUM and X/Y arguments
display for a BCM 3140-based DOCSIS 2.0 2:8 CMTS (For example: show
cable interfaces upstream {<NUM> | <X/Y>} channel-agility-stats). Only
the NUM argument is applicable to this command.

Command Syntax

X/Y the slot and MAC Domain number of the 2:8


CMTS module:
NUM the upstream port number

Compass ID: 327594480 Version 3 13-501


BSR 64000 Command Reference Guide Release 5.2.1

show running-config cable downstream port


The show running-config cable downstream port command displays the
downstream port configuration for a TX32 RF port. The following is an example of
typical screen output from the show running-config cable downstream port
command:

cable downstream port 10/0


cable downstream interleave-depth 16
cable downstream 0 channel-id 2
no cable downstream 0 shutdown
cable downstream 1 shutdown
cable downstream 2 shutdown
cable downstream 3 shutdown
no cable downstream shutdown

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show running-config cable downstream port <X/Y > [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show running-config cable downstream port <X/Y> [ | {count | count-only}]

Command Syntax

X/Y the slot and port number of the TX32 module


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

13-502 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS 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: 327594480 Version 3 13-503


BSR 64000 Command Reference Guide Release 5.2.1

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-504 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-505


BSR 64000 Command Reference Guide Release 5.2.1

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 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-506 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-507


BSR 64000 Command Reference Guide Release 5.2.1

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-508 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-509


BSR 64000 Command Reference Guide Release 5.2.1

snr loop
The snr loop command allows an operator to perform SNR measurements for a
specified number of times on one particular frequency.

Note: Equalization settings on the snr loop command is for POST


equalization.

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 use a ranging test pattern for SNR
measurement
frequency the particular frequency to perform SNR
measurements on

13-510 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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
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 - perform 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: 327594480 Version 3 13-511


BSR 64000 Command Reference Guide Release 5.2.1

snr setup
The snr setup command is used to configure SNR measurement on the BCM3138/
BCM3140 chip set.

Note: Equalization settings on the snr setup command is for POST


equalization.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


snr setup {<NUM>{<NUM>}} {<5000000-42000000> | <5000000-42000000> |
<5000000-65000000>} {<5000000-65000000> | <1000000-55000000> |
<1000000-55000000>} {1600000 | 200000 | 3200000 | 400000 | 6400000 | 800000}
[equalization {off | on}]

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.

13-512 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

5000000-65000000 is the EURODOCSIS standard start


frequency in Hz
5000000-65000000 is the EURODOCSIS standard start
frequency in Hz
1000000-55000000 is the J-DOCSIS standard start frequency in
Hz
1000000-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 off - evaluate the SNR without equalization
on - evaluate the SNR with equalization

Compass ID: 327594480 Version 3 13-513


BSR 64000 Command Reference Guide Release 5.2.1

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-514 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

snr setup-spare-mod-profile
The snr setup-spare-mod-profile command determines the modulation profile to be
used by RF Sentry during the snr start command.

Group Access
MSO

Command Mode
Privileged EXEC

Command Line Usage


snr setup-spare-mod-profile <NUM> <1-600>

Command Syntax

NUM the 2:8 CMTS module slot number


1-600 the secondary modulation profile number

Note: Modulation profiles 1-4, 101-116, 201-205, and 301-310 are


pre-configured modulation profiles.

Motorola recommends that user-created modulation profiles use the


numbering range of 401-600 to ensure better future portability.

Compass ID: 327594480 Version 3 13-515


BSR 64000 Command Reference Guide Release 5.2.1

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

13-516 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

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

Compass ID: 327594480 Version 3 13-517


BSR 64000 Command Reference Guide Release 5.2.1

spectrum-copy
The spectrum-copy command allows an operator to copy Spectrum Group
configurations from one Spectrum Group to another and assign the CMTS slot and
port numbers to the Spectrum Group at the time of the copy.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


spectrum-copy <WORD> <WORD> [slot <NUM> ] upstream <NUM> ]]

Command Syntax

WORD the source Spectrum Group name


WORD the destination Spectrum Group
name
slot NUM specify a CMTS slot number
upstream NUM specify an upstream port number

13-518 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-519


BSR 64000 Command Reference Guide Release 5.2.1

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-520 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 13-521


BSR 64000 Command Reference Guide Release 5.2.1

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-522 Compass ID: 327594480 Version 3


Release 5.2.1 CMTS Commands

vendor-class-identifier
The vendor-class-identifier command configures a vendor class identifier (VCI)
string and maps it to a vendor class identifier group. Any number of VCI strings can
be bounded to a single VCI group. The no vendor-class-identifier command
removes a VCI string.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


vendor-class-identifier <1-32> <WORD>
no vendor-class-identifier <1-32> <WORD>

Command Syntax

1-32 the vendor class identifier group number


WORD the vendor class identifier string

Compass ID: 327594480 Version 3 13-523


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: 327594480 Version 3 14-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 14-3


BSR 64000 Command Reference Guide Release 5.2.1

qos queue dot1p


The qos queue dot1p command is used to configure the 802.1p class of service.

Group Access
All

Command Mode
Interface Configuration

Command Line Usage


qos queue <0-7> dot1p <0-7>
no qos queue <0-7> dot1p <0-7>

Command Syntax

0-7 qos queue number


0-7 802.1p CoS priority setting

14-4 Compass ID: 327594480 Version 3


Release 5.2.1 QoS Commands

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>]

Compass ID: 327594480 Version 3 14-5


BSR 64000 Command Reference Guide Release 5.2.1

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

14-6 Compass ID: 327594480 Version 3


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: 327594480 Version 3 15-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-5


BSR 64000 Command Reference Guide Release 5.2.1

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 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 Compass ID: 327594480 Version 3


Release 5.2.1 POS Commands

aps protect
The aps protect command configures a 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: 327594480 Version 3 15-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-23


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-25


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-27


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-29


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-31


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-33


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-35


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 15-37


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


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: 327594480 Version 3 16-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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 cluster 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: 327594480 Version 3 16-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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. It 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 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 the


confederation as a whole

Compass ID: 327594480 Version 3 16-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-9


BSR 64000 Command Reference Guide Release 5.2.1

Command Default

half life = 15 minutes


route reuse = 750
route suppression = 2000
maximum suppression = 4 times the half-life
time

16-10 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

clear ip bgp dampening


The clear ip bgp dampening command clears route dampening information and
unsuppresses 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: 327594480 Version 3 16-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-19


BSR 64000 Command Reference Guide Release 5.2.1

Command Default

external distance = 20
internal distance = 200
local distance = 200

16-20 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-23


BSR 64000 Command Reference Guide Release 5.2.1

ip bgp-community new-format
The ip bgp-community new-format command enables the extended community
format to be represented as a two byte number. In the most recent version of RFC
1997, an extended community is in the form AA:NN. The first part (AA) is the
autonomous system number and the second part (NN) is a 2-byte number. The BSR’s
default community format is one 32-bit number. The ip bgp-community new-format
command changes the community format from one 32-bit number to the AA:NN
format to conform to RFC 1997.
The following command sequence example illustrates how the ip bgp-community
new-format command enables the extended AA:NN format:

MOT:7A(config)# ip bgp-community new-format


MOT:7A(config)# route-map test
MOT:7A(config-rmap)# set community 123456
MOT:7A(config-rmap)# show route-map

route-map test, permit, sequence 10


Match clauses:
Set clauses:
community 1:57920

The decimal number of 123456, specified with the set community command,
converts to a binary number of 11110001001000000. The last two bytes from this
binary number are 1110001001000000 which equals 57920 in decimal. This leaves a
single binary number of 1 which translates to a decimal number of 1. Thus, the
AA:NN format is 1:57920.
The ip bgp-community new-format command does not change the actual
community it just changes the way the bits are presented.

Group Access
ISP

16-24 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

Command Mode
Global Configuration

Command Line Usage


ip bgp-community new-format

Command Default
Disabled

Compass ID: 327594480 Version 3 16-25


BSR 64000 Command Reference Guide Release 5.2.1

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 no 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-26 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

Command Line Usage


ip community-list <1-99>{deny | permit } [<1-4294967295>/<aa:nn> | 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>/<aa:nn> | 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
aa:nn the extended community in the form AA:NN -
the first part (AA) is the autonomous system
number and the second part (NN) is a 2-byte
number
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: 327594480 Version 3 16-27


BSR 64000 Command Reference Guide Release 5.2.1

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-28 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-29


BSR 64000 Command Reference Guide Release 5.2.1

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-30 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

neighbor advertisement-interval
The neighbor advertisement-interval command sets the minimum amount of time
between sending BGP routing updates. Use 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: 327594480 Version 3 16-31


BSR 64000 Command Reference Guide Release 5.2.1

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-32 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-33


BSR 64000 Command Reference Guide Release 5.2.1

neighbor description
The neighbor description command provides a description of a neighbor. 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-34 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-35


BSR 64000 Command Reference Guide Release 5.2.1

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-36 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-37


BSR 64000 Command Reference Guide Release 5.2.1

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-38 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-39


BSR 64000 Command Reference Guide Release 5.2.1

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-40 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-41


BSR 64000 Command Reference Guide Release 5.2.1

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-42 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-43


BSR 64000 Command Reference Guide Release 5.2.1

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-44 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

neighbor remote-as
The neighbor remote-as command performs many functions as described below. Use
the neighbor remote-as 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: 327594480 Version 3 16-45


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

A.B.C.D BGP peer address


WORD name of BGP peer group
1-65535 neighbor autonomous system number

16-46 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-47


BSR 64000 Command Reference Guide Release 5.2.1

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-48 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-49


BSR 64000 Command Reference Guide Release 5.2.1

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-50 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-51


BSR 64000 Command Reference Guide Release 5.2.1

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-52 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-53


BSR 64000 Command Reference Guide Release 5.2.1

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-54 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

Command Default
keepalive = 60 seconds
hold time = 180 seconds

Compass ID: 327594480 Version 3 16-55


BSR 64000 Command Reference Guide Release 5.2.1

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-56 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 16-57


BSR 64000 Command Reference Guide Release 5.2.1

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-58 Compass ID: 327594480 Version 3


Release 5.2.1 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 routes

Compass ID: 327594480 Version 3 16-59


BSR 64000 Command Reference Guide Release 5.2.1

external 2 routes that are external to an autonomous


system, but are imported into OSPF as Type 2
external routes
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-60 Compass ID: 327594480 Version 3


Release 5.2.1 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.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


route-map <WORD> [deny | permit] [<0-65535>]
no route-map <WORD> [deny | permit] [<0-65535>]

Command Syntax

WORD route-map name


0-65535 route-map sequence number
deny denies access for matching conditions
permit permits access for matching conditions

Compass ID: 327594480 Version 3 16-61


BSR 64000 Command Reference Guide Release 5.2.1

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

16-62 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-63


BSR 64000 Command Reference Guide Release 5.2.1

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

16-64 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

Command Syntax

1-99 standard community list number


100-199 extended community list number
delete delete inbound or outbound communities from the
community attribute

Compass ID: 327594480 Version 3 16-65


BSR 64000 Command Reference Guide Release 5.2.1

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>/<aa:nn> | local-AS | no-advertise | no-export |
additive | none}
no set community {<1-4294967295>/<aa:nn> | local-AS | no-advertise | no-export
| additive | none}

16-66 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

Command Syntax

1-4294967295 the community number


aa:nn the extended community in the form AA:NN -
the first part (AA) is the autonomous system
number and the second part (NN) is a 2-byte
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: 327594480 Version 3 16-67


BSR 64000 Command Reference Guide Release 5.2.1

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

16-68 Compass ID: 327594480 Version 3


Release 5.2.1 BGP 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: 327594480 Version 3 16-69


BSR 64000 Command Reference Guide Release 5.2.1

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

16-70 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-71


BSR 64000 Command Reference Guide Release 5.2.1

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.

16-72 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-73


BSR 64000 Command Reference Guide Release 5.2.1

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

16-74 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-75


BSR 64000 Command Reference Guide Release 5.2.1

count count the number of outputted lines


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

16-76 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-77


BSR 64000 Command Reference Guide Release 5.2.1

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>/<aa:nn> | <LINE> | exact-match
<LINE> | expanded | local-AS | no-advertise | no-export ] [ | {begin | exclude |
include} {<WORD>} [ | {count | count-only}]]
show ip bgp community [ <1-4294967295>/<aa:nn> | <LINE> | exact-match
<LINE> | extended | local-AS | no-advertise | no-export ] [ | {count | count-only}]

Command Syntax

1-4294967295 the community number


aa:nn the extended community in the form AA:NN -
the first part (AA) is the autonomous system
number and the second part (NN) is a 2-byte
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

16-78 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

no-export routes with this community are sent to


peers in other sub-autonomous systems
within a confederation
| 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: 327594480 Version 3 16-79


BSR 64000 Command Reference Guide Release 5.2.1

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

16-80 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-81


BSR 64000 Command Reference Guide Release 5.2.1

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

16-82 Compass ID: 327594480 Version 3


Release 5.2.1 BGP 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: 327594480 Version 3 16-83


BSR 64000 Command Reference Guide Release 5.2.1

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}]

16-84 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-85


BSR 64000 Command Reference Guide Release 5.2.1

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

16-86 Compass ID: 327594480 Version 3


Release 5.2.1 BGP 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: 327594480 Version 3 16-87


BSR 64000 Command Reference Guide Release 5.2.1

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}]

16-88 Compass ID: 327594480 Version 3


Release 5.2.1 BGP 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: 327594480 Version 3 16-89


BSR 64000 Command Reference Guide Release 5.2.1

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

16-90 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-91


BSR 64000 Command Reference Guide Release 5.2.1

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

16-92 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-93


BSR 64000 Command Reference Guide Release 5.2.1

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

16-94 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

WORD the specified string


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

Compass ID: 327594480 Version 3 16-95


BSR 64000 Command Reference Guide Release 5.2.1

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

16-96 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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}]

Compass ID: 327594480 Version 3 16-97


BSR 64000 Command Reference Guide Release 5.2.1

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

16-98 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

show ip community-list
The show ip community-list command displays a configured community access list
and associated elements.
With the optional access list number argument, the command displays the specified
community access list, if such a list exists. Without the optional access list number
argument, the command displays all configured community access lists.
The following is typical screen output from the show ip community-list command:

Community standard list 10


permit 100:100
permit 10000:10000
permit 1:35474
permit 100:1
permit 1:57920
Community expanded list 100
permit line

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

Compass ID: 327594480 Version 3 16-99


BSR 64000 Command Reference Guide Release 5.2.1

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

16-100 Compass ID: 327594480 Version 3


Release 5.2.1 BGP Commands

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

Compass ID: 327594480 Version 3 16-101


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: 327594480 Version 3 17-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 17-3


BSR 64000 Command Reference Guide Release 5.2.1

ip pim bsr-candidate ip-address


Use the ip pim bsr-candidate ip-address command to specifiy the IP address of a
specific interface on the candidate Bootstrap Router (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 Compass ID: 327594480 Version 3


Release 5.2.1 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 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 interface with the highest IP address is used as the DR.
If a router does not advertise its priority in its hello messages, the router is elected
as the DR. If multiple routers have the highest 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 potential
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 DR priority

Command Default
The default DR priority is 1 (highest).

Compass ID: 327594480 Version 3 17-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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. IP multicast routers send PIM query "Hello" messages
to determine which router is the Designated Router (DR) for each LAN segment. 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 the PIM router query message interval to the
default.

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 router query message interval in


seconds

Command Default
30 seconds

Compass ID: 327594480 Version 3 17-7


BSR 64000 Command Reference Guide Release 5.2.1

ip pim rp-candidate
Use the ip pim rp-candidate command to configure and advertise the router as a
single Rendezvous Point (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 Compass ID: 327594480 Version 3


Release 5.2.1 PIM Commands

ip pim rp-candidate group-list


Use the ip pim rp-candidate group-list command to configure one or more groups
that are associated with this 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: 327594480 Version 3 17-9


BSR 64000 Command Reference Guide Release 5.2.1

ip pim rp-candidate interval


Use the ip pim rp-candidate interval command to change the candidate Rendezvous
Point (RP) advertisement interval.

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 Compass ID: 327594480 Version 3


Release 5.2.1 PIM Commands

ip pim rp-candidate ip-address


Use the ip pim rp-candidate ip-address command to advertise the IP address of a
specific interface for the candidate Rendezvous Point (RP).

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 RP

Compass ID: 327594480 Version 3 17-11


BSR 64000 Command Reference Guide Release 5.2.1

ip pim rp-candidate priority


Use the ip pim rp-candidate priority command to specify the candidate Rendezvous
Point (RP) 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 RP

Command Default
0

17-12 Compass ID: 327594480 Version 3


Release 5.2.1 PIM Commands

ip pim spt-threshold lasthop


The ip pim spt-threshold lasthop command configures when a PIM last-hop router
should join the shortest path tree (SPT). This is determined by specifying a network
traffic threshold. 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 tree -
indicates that the Rendezvous Point (RP)
always uses a shared tree

Command Default
1024 kbps

Compass ID: 327594480 Version 3 17-13


BSR 64000 Command Reference Guide Release 5.2.1

ip pim spt-threshold rp
Use the ip pim spt-threshold rp command to specify the multicast traffic threshold
that must be reached by the Rendezvous Point (RP) router before the distribution tree
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 shared tree distribution control method is always
used by the RP

Command Default
0

17-14 Compass ID: 327594480 Version 3


Release 5.2.1 PIM Commands

ip pim ssm
The ip pim ssm command is used to select the SSM range so that IP unicast source
address and the multicast group address channel subscriptions from IGMP are ignored
for groups outside the selected range.
Once a range is specified, only Source Specific Join Messages within this specified
range can be generated.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


ip pim ssm [default | range {<1-99> | <1300-1999>}]
no ip pim ssm

Command Syntax

default selects the default address range 232.0.0.0


through 232.255.255.255 (232/8) for SSM
applications and protocols.
range selects a range that uses a standard or
extended access-list number.

Command Default
Disabled

Compass ID: 327594480 Version 3 17-15


BSR 64000 Command Reference Guide Release 5.2.1

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

17-16 Compass ID: 327594480 Version 3


Release 5.2.1 PIM Commands

pim accept-rp
The pim accept-rp command configures the router to accept only Join or Prune
messages destined for the specified Rendezvous Point (RP) for a specific list of
multicast groups. The no pim accept-rp command removes the RP address.
The multicast groups 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 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 IP address of the RP.


1-99 The access list number that defines which
groups the RP is allowed to send Join
messages. If not specified, the whole class D
groups are subject to the check.

Command Default
Disabled

Compass ID: 327594480 Version 3 17-17


BSR 64000 Command Reference Guide Release 5.2.1

pim graceful-restart restart-interval


If multicast data traffic is being forwarded in the active SRM, the same multicast data
traffic will remain forwarded across an SRM switchover. For multicast data that is
being forwarded in the slow path on the SRM, there will be a slight interruption of
data as the new active SRM is taking over. This interruption should be less than 3
seconds. For multicast data that is being forwarded in the fast path, there should be no
significant interruption of data forwarding as the fast path is not being reset across an
SRM switchover.
The pim graceful-restart restart-interval command provides a configurable PIM
graceful restart interval that will complete the protocol relearn process which
validates all the replicated forwarding entries after an SRM switchover. The no pim
graceful-restart restart-interval command returns to the default value.

Note: The BSR does not support multicast data forwarding across a SRM
switchover for traffic learned from other multicast routing protocols except for
PIM-SM and PIM-SSM. When the newly active SRM initializes, all multicast
forwarding entries that are learned from protocols other than PIM-SM or
PIM-SSM will be deleted when graceful restart completes. These traffic flows
will be recreated as soon as new traffic arrives.

Group Access
ISP

Command Mode
Router Configuration

Command Line Usage


pim graceful-restart restart-interval <30-180>
no pim graceful-restart restart-interval

Command Syntax

30-180 the graceful restart period in seconds

Command Default
120 seconds

17-18 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 17-19


BSR 64000 Command Reference Guide Release 5.2.1

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-20 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 17-21


BSR 64000 Command Reference Guide Release 5.2.1

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-22 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 17-23


BSR 64000 Command Reference Guide Release 5.2.1

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
count Internet multicast packet count
ethernet X/Y Ethernet interface
gigaether X/Y Gigabit Ethernet interface
loopback 1-64 Loopback interface
neighbor PIM neighbor information

17-24 Compass ID: 327594480 Version 3


Release 5.2.1 PIM Commands

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: 327594480 Version 3 17-25


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: 327594480 Version 3 18-1


BSR 64000 Command Reference Guide Release 5.2.1

■ 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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 MPLS Commands

mpls create-lsp rsvp next-hop


The mpls create-lsp rsvp next-hop command is used to specify one or more transit
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 that this is the last
hop in the LSP configuration

Compass ID: 327594480 Version 3 18-13


BSR 64000 Command Reference Guide Release 5.2.1

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 push on the packet
A.B.C.D 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 push on the packet
A.B.C.D the IP address of the next hop router

18-14 Compass ID: 327594480 Version 3


Release 5.2.1 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 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 swap out from the packet
16-1048575 MPLS label to swap in to the packet
A.B.C.D IP address of the next hop router
queue 0-3 QoS queue identifier

Compass ID: 327594480 Version 3 18-15


BSR 64000 Command Reference Guide Release 5.2.1

mpls fp max
The mpls fp max command sets the maximum number of MPLS fastpath forwarding
entries. The configurable MPLS entries feature allows a user to increase the number
of IP forwarding entries by setting a maximum number for MPLS forwarding entries.
By decreasing the number of MPLS entries from 10,000, the number of allowable IP
entries is increased. The no mpls fp max command restores the default value.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


mpls fp max <256-10000>
no mpls fp max

Command Syntax

256-10000 the number of MPLS forwarding entries

Command Default
MPLS Fastpath Entries = 10,000

18-16 Compass ID: 327594480 Version 3


Release 5.2.1 MPLS Commands

mpls ip
The mpls ip command enables dynamic label switching and MPLS forwarding of IP
(IPv4) packets on the interface.
The mpls ip propagate-ttl command enables the traceroute command to show all
the hops traversed by the MPLS packet in the network. When the no mpls ip
propagate-ttl command is used, the hops will not displa on the output of the
traceroute command.

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

Compass ID: 327594480 Version 3 18-17


BSR 64000 Command Reference Guide Release 5.2.1

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.

18-18 Compass ID: 327594480 Version 3


Release 5.2.1 MPLS Commands

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

Compass ID: 327594480 Version 3 18-19


BSR 64000 Command Reference Guide Release 5.2.1

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

18-20 Compass ID: 327594480 Version 3


Release 5.2.1 MPLS Commands

mpls ttl
The mpls ttl command changes the default time-to-live value used by the mpls ip
propagate-ttl command. The no mpls ttl command restores the default value (64
hops) 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

Compass ID: 327594480 Version 3 18-21


BSR 64000 Command Reference Guide Release 5.2.1

show fast-path ranges


The show fast-path ranges command displays the IP Table Entry size and the MPLS
Label entry size in the Fast Path. The following is typical screen output from the show
fast-path ranges command:

FP Entry Type Range


------------- -----

IP <0 - 54999>
MPLS <55000 - 64999>

Group Access
All

Command Mode
All modes except for User EXEC mode

Command Line Usage


show fast-path ranges [ | {begin | exclude | include} {<WORD>} [ | {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

18-22 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-23


BSR 64000 Command Reference Guide Release 5.2.1

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-24 Compass ID: 327594480 Version 3


Release 5.2.1 MPLS Commands

show ip rsvp lsp


The show ip rsvp lsp command displays LSP information.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip 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: 327594480 Version 3 18-25


BSR 64000 Command Reference Guide Release 5.2.1

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-26 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-27


BSR 64000 Command Reference Guide Release 5.2.1

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-28 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-29


BSR 64000 Command Reference Guide Release 5.2.1

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-30 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-31


BSR 64000 Command Reference Guide Release 5.2.1

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-32 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-33


BSR 64000 Command Reference Guide Release 5.2.1

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-34 Compass ID: 327594480 Version 3


Release 5.2.1 MPLS Commands

show mpls label range


The show mpls label range command displays the configured 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: 327594480 Version 3 18-35


BSR 64000 Command Reference Guide Release 5.2.1

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-36 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-37


BSR 64000 Command Reference Guide Release 5.2.1

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-38 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-39


BSR 64000 Command Reference Guide Release 5.2.1

WORD the specified string


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

18-40 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-41


BSR 64000 Command Reference Guide Release 5.2.1

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-42 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 18-43


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: 327594480 Version 3 19-1


BSR 64000 Command Reference Guide Release 5.2.1

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 <Enter>
-or-
MOT(config-srvclass)# 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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-23


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-25


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-27


BSR 64000 Command Reference Guide Release 5.2.1

Command Default
BE-UP = 0
UGS = 0x7f
UGS-AD = 0x7f
RTPS = 0x1f
NRTPS = 0

19-28 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-29


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-31


BSR 64000 Command Reference Guide Release 5.2.1

Upstream Service Classes

Service Class mab cap priority allowShared


enforce admitted bw
cmts-qos threshold
--------------------------------------------------------------------------------
DefBEUp 10 0 1 no no 0
DefRRUp 10 0 1 no no 0
DefUGS 25 100 1 no no 0
DefUGSAD 5 80 1 no no 0
DefRTPS 5 5 1 no no 0
DefNRTPS 5 5 1 no no 0
DefEMUp 1 100 1 no no 0

Total assigned bandwidth (mab sum): 61%

Downstream Service Classes

Service Class mab cap priority allowShared


enforce admitted bw
cmts-qos threshold
-------------------------------------------------------------------------------
DefBEDown 10 0 1 no no 0
DefRRDown 10 0 1 no no 0
DefEMDown 1 100 1 no no 0
DefMCDown 1 100 1 no no 0

Total assigned bandwidth (mab sum): 22%

The admitted bw threshold field 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.

19-32 Compass ID: 327594480 Version 3


Release 5.2.1 Service Class Commands

The following is an example of typical screen output for an individual service class
from the show cable service-class <WORD> command:

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>]

Compass ID: 327594480 Version 3 19-33


BSR 64000 Command Reference Guide Release 5.2.1

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

19-34 Compass ID: 327594480 Version 3


Release 5.2.1 Service Class Commands

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: De


Direction: upstream
Interface slot/port/chan: 11/0/0
Total packets: 3187
Total bytes: 953566
Service flow counts:
MacSlot/Port BGID Admit Defer Restrict Reject Admitted BW
_________ ____ _____ _____ ________ __________ ___________
11/0 NA 5 0 0 0 0
11/0 1 0 0 0 0 0
11/1 1 0 0 0 0 0
9/0 1 0 0 0 0 0
total 5 0 0 0 0

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable srvclass-stats <NUM> <NUM> <WORD>

Compass ID: 327594480 Version 3 19-35


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

NUM specify a CMTS slot number


NUM specify a CMTS downstream or
upstream port number or a TX32
module slot number/downstream
port number/downstream channel
number - refer to the diagram
following the Command Syntax
table
Note: The comma should not be
entered as part of the command
syntax.
WORD the pre-defined service class name or
the user-defined service class name
created with the name command

<0-7> , 4/[0-7]/[0-3]
comma

2:8 CMTS Module TX32 Module Slot Number/


Downstream or Upstream TX32 Downstream Port Number/
Port Number TX32 Downstream Channel Number

19-36 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 19-37


BSR 64000 Command Reference Guide Release 5.2.1

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-38 Compass ID: 327594480 Version 3


Release 5.2.1 Service Class Commands

ugs-stats-window
The ugs-stats-window command sets the UGS Flow Voice Call statistics sample
period. The no ugs-stats-window command returns to the default value.

Note: The ugs-stats-window command specifies the sampling time period


displayed in the show cable ugs-stats command output.

Group Access
All

Command Mode
Service Class Configuration

Command Line Usage


ugs-stats-window [<0> | <5-120>]
no ugs-stats-window

Command Syntax

0 disables UGS Flow Statistics


sampling
5-120 sets the UGS Flow Statistics
sampling time interval in minutes

Command Default
60 minutes

Compass ID: 327594480 Version 3 19-39


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: 327594480 Version 3 20-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 20-3


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 Secure Shell Server Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ssh config

Compass ID: 327594480 Version 3 20-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 20-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 20-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 20-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 20-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 20-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 20-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 20-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


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: 327594480 Version 3 21-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

Command Default
Disabled

Compass ID: 327594480 Version 3 21-3


BSR 64000 Command Reference Guide Release 5.2.1

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>
no cable dynamic-service active-timeout

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-15


BSR 64000 Command Reference Guide Release 5.2.1

dqos dscp
The dqos dscp command sets a Differentiated Services Code Point for Dynamic
Quality-of-Service (DQoS) Connections. The command adds a DSCP (TOS) byte
value to all DQoS COPS connection packets locally generated by the BSR.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


dqos dscp <0-63>

Command Syntax

0-63 the DSCP value

Command Default
0

21-16 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

dqos emergency-preempt
The dqos emergency-preempt command is used to select one or all of three
emergency pre-emption options for admitting additional normal voice bandwidth for
high-priority “911” calls.
The no dqos emergency-preempt command returns the command default.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


dqos emergency-preempt [most-recent | oldest | random]
no dqos emergency-preempt [most-recent | oldest | random]

Command Syntax

most-recent admits bandwidth from the most


recent active normal voice calls
oldest admits bandwidth from the oldest
active normal voice calls.
random admits bandwidth from random
normal voice calls.

Command Default
Disabled

Compass ID: 327594480 Version 3 21-17


BSR 64000 Command Reference Guide Release 5.2.1

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-18 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-19


BSR 64000 Command Reference Guide Release 5.2.1

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-20 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-21


BSR 64000 Command Reference Guide Release 5.2.1

em dscp
The em dscp command sets a Differentiated Services Code Point for Event Message
(EM) Call Data Connections. The command adds a DSCP (TOS) byte value to all EM
COPS connection packets locally generated by the BSR.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em dscp <0-63>

Command Syntax

0-63 the DSCP value

Command Default
0

21-22 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-23


BSR 64000 Command Reference Guide Release 5.2.1

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)

21-24 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-25


BSR 64000 Command Reference Guide Release 5.2.1

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

21-26 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-27


BSR 64000 Command Reference Guide Release 5.2.1

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

21-28 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-29


BSR 64000 Command Reference Guide Release 5.2.1

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

21-30 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-31


BSR 64000 Command Reference Guide Release 5.2.1

em rks-failure-trap-enable
The em rks-failure-trap-enable command enables/disables PacketCable EM RKS
Failure traps. PacketCable EM RKS Failure traps are generated if an
Accounting-Response event message is not received by the BSR from the Record
Keeping Server (RKS) after the BSR sends the RKS an Accounting-Request event
message. The RKS stores event messages which are used by applications for billing,
settlements, network usage monitoring, and fraud detection purposes.
If an Accounting-Response event message from the RKS is not received by the BSR ,
the BSR re-sends the Accounting-Request event message according to a
pre-configured retry count. If the retry count is exceeded without a returned
Accounting-Response event message, the BSR tries an alternate (secondary) RKS if
one is available. A PacketCable EM RKS Failure trap is generated if the
Accounting-Request event mesage retry count has been exceeded for both the
Primary RKS and the optional Secondary RKS.
The event message retry count is specified on the BSR with the em retry-count
command. If PacketCable EM RKS Failure traps are being generated, the event
message retry count may need to be increased. Repeated Accounting-Request event
message failures may indicate too much network congestion and/or distance between
the BSR and the RKS. The number of Accounting-Request event message failures can
be viewed through the Account Request Failure field in the show packet-cable
statistics em command output.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


em rks-failure-trap-enable { disable | enable }
no em rks-failure-trap-enable { disable | enable }

21-32 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

Command Syntax

disable disables the PacketCable EM RKS Failure


trap
enable enables the PacketCable EM RKS Failure
trap

Command Default
Disabled

Compass ID: 327594480 Version 3 21-33


BSR 64000 Command Reference Guide Release 5.2.1

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

21-34 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-35


BSR 64000 Command Reference Guide Release 5.2.1

es
The no es shutdown command enables electronic surveillance. The es shutdown
command disables electronic surveillance.
The es ccc-source-port command specifies the UDP source port number for
Electronic Surveillance Call Content Connections. Changes made to the
ccc-source-port configuration are displayed with the show packet-cable
configuration es and show running-config commands. The no es ccc-source-port
command removes a non-default ccc-source-port configuration and re-establishes the
default ccc-source-port configuration of 60000.
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 {ccc-source-port <0-65535> | shutdown | trap-enable {disable | enable}}
no es {ccc-source-port <0-65535> | shutdown | trap-enable {disable | enable}}

21-36 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

Command Syntax

ccc-source-port the UDP source port number for


0-65535 Electronic Surveillance Call Content
Connections
shutdown Shutdown electronic surveillance
functionality
trap-enable {disable | Enable/disable the electronic
enable} surveillance SNMP trap

Command Default
Electronic Surveillance = disabled

Compass ID: 327594480 Version 3 21-37


BSR 64000 Command Reference Guide Release 5.2.1

es ccc-dscp
The es ccc-dscp command sets a Differentiated Services Code Point for Electronic
Surveillance (ES) Call Content Connections. The command adds a DSCP (TOS) byte
value to all ES COPS connection packets locally generated by the BSR.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


es ccc-dscp <0-63>

Command Syntax

0-63 the DSCP value

Command Default
0

21-38 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-39


BSR 64000 Command Reference Guide Release 5.2.1

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.

21-40 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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.

Compass ID: 327594480 Version 3 21-41


BSR 64000 Command Reference Guide Release 5.2.1

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

21-42 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-43


BSR 64000 Command Reference Guide Release 5.2.1

ipsec
The ipsec command accesses IPSec Configuration mode from Global Configuration
mode.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipsec

21-44 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

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

Compass ID: 327594480 Version 3 21-45


BSR 64000 Command Reference Guide Release 5.2.1

mm dscp
The mm dscp command sets a Differentiated Services Code Point for Multimedia
(MM) Connections. The command adds a DSCP (TOS) byte value to all MM COPS
connection packets locally generated by the BSR.

Group Access
All

Command Mode
PacketCable Configuration

Command Line Usage


mm dscp <0-63>

Command Syntax

0-63 the DSCP value

Command Default
0

21-46 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-47


BSR 64000 Command Reference Guide Release 5.2.1

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-48 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-49


BSR 64000 Command Reference Guide Release 5.2.1

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-50 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-51


BSR 64000 Command Reference Guide Release 5.2.1

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-52 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-53


BSR 64000 Command Reference Guide Release 5.2.1

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-54 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-55


BSR 64000 Command Reference Guide Release 5.2.1

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-56 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-57


BSR 64000 Command Reference Guide Release 5.2.1

es display electronic surveillance configuration


and status information
mm display PacketCable Multimedia T1 timer
interval and PacketCable Multimedia status
information.

21-58 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-59


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

inactive specify the COPS Client(s) that are inactive

21-60 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

show packet-cable gate


The show packet-cable gate command displays currently allocated packet
cable DQoS and Multimedia gates. The following table 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 the client IP address
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

The following is an example of typical screen output from the show packet-cable
gate command:

Compass ID: 327594480 Version 3 21-61


BSR 64000 Command Reference Guide Release 5.2.1

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

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show packet-cable gate [am-tag <0-65535> | application-type <0-65535> | cops
<0-99> | dqos | identifier <0x00000000-0xffffffff> | mm | modem <mac> |
not-committed | slot <NUM> | subscriber <A.B.C.D>| summary ]

21-62 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

Command Syntax

am-tag 0-65535 Application Manager tag


application-type application type
0-65535
cops 0-99 specify a COPS connection and COPS handle
to display
dqos specify all DQoS gates
identifier Gate Identifier in hexadecimal notation to
0x00000000-0xffffffff display detailed information about the DQoS
or Multimedia gate.
mm specify all Multimedia gates
modem mac specify a cable modem MAC address to
display
not-committed only display gates not in COMMITTED state
slot NUM cable slot number to display
subscriber A.B.C.D specify a CPE (subscriber) IP address to
display
summary display summary information

Compass ID: 327594480 Version 3 21-63


BSR 64000 Command Reference Guide Release 5.2.1

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

The following is an example of typical screen output from the show packet-cable
statistics gate command:

21-64 Compass ID: 327594480 Version 3


Release 5.2.1 PacketCable Commands

COPS Statistics
--------------------------------------------------------------------------
COPS Established: 1 Client-Open Sent: 1
COPS Terminated: 0 Client-Accept Received: 1
COPS Unauthorized: 0 Request Sent: 1
Keep-Alive Sent: 7 Client-Close Received: 0
Keep-Alive Received: 7 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: 0 Gate-Open Count: 8
Gate-Alloc-Ack Count: 0 Gate-Close Count: 8
Gate-Alloc-Err Count: 0 T0 Timeout: 0
Gate-Set Count: 8 T1 Timeout: 0
Gate-Set-Ack Count: 8 T7 Timeout: 0
Gate-Set-Err Count: 0 T8 Timeout: 0
Gate-Delete Count: 0 CM Delete: 6
Gate-Delete-Ack Count: 0 CM Dereg: 0
Gate-Delete-Err Count: 0 Admin Delete: 0
Gate-Info Count: 0 Resource Reassign: 2
Gate-Info-Ack Count: 0
Gate-Info-Err Count: 0

Multimedia Gate Statistics


--------------------------------------------------------------------------
Gate-Set Count: 0 Gate-Report-State Count: 0
Gate-Set-Ack Count: 0 T1 Timeout: 0
Gate-Set-Err Count: 0 T2 Timeout: 0
Gate-Delete Count: 0 T3 Timeout: 0
Gate-Delete-Ack Count: 0 T4 Timeout: 0
Gate-Delete-Err Count: 0 Volume Limit: 0
Gate-Info Count: 0 CM Dereg: 0
Gate-Info-Ack Count: 0 Admin Delete: 0
Gate-Info-Err Count: 0

Compass ID: 327594480 Version 3 21-65


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show packet-cable statistics [em | gate [ cops [<0-99>]]]

Command Syntax

em display event message statistics


gate display gate statistics
cops 0-99 specify a COPS connection and COPS handle
to display

21-66 Compass ID: 327594480 Version 3


Release 5.2.1 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>]]]

Compass ID: 327594480 Version 3 21-67


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

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-68 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-69


BSR 64000 Command Reference Guide Release 5.2.1

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-70 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-71


BSR 64000 Command Reference Guide Release 5.2.1

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-72 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 21-73


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: 327594480 Version 3 22-1


BSR 64000 Command Reference Guide Release 5.2.1

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.

Note: The bridge cable intercept command is only available to a user


logged in as securityuser - refer to Configuring Cable Intercepts in the BSR
64000 CMTS Configuration and Management Guide.

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.

22-2 Compass ID: 327594480 Version 3


Release 5.2.1 VLAN Tagging Commands

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.

Compass ID: 327594480 Version 3 22-3


BSR 64000 Command Reference Guide Release 5.2.1

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.

22-4 Compass ID: 327594480 Version 3


Release 5.2.1 VLAN Tagging Commands

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

Compass ID: 327594480 Version 3 22-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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.
The encapsulation dot1q command associates a sub-interface with a unique 802.1q
tag that must be configured in the sub-interface shell. The no encapsulation dot1q
command removes the sub-interface.

Group Access
ISP

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: 327594480 Version 3 22-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 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: 327594480 Version 3 23-1


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-3


BSR 64000 Command Reference Guide Release 5.2.1

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. The no cable dsg command disables the DSG
configuration.

Group Access
MSO

Command Mode
Global Configuration

Command Line Usage


cable dsg
no cable dsg

23-4 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-5


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-7


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-9


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-11


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 DSG Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable dsg

Compass ID: 327594480 Version 3 23-13


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-15


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-17


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-19


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-21


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-23


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-25


BSR 64000 Command Reference Guide Release 5.2.1

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 Compass ID: 327594480 Version 3


Release 5.2.1 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: 327594480 Version 3 23-27


24
IPDR Commands

Introduction
This chapter describes the IPDR commands supported by the BSR 64000 for Release
5.2.0. IPDR based subscriber usage data accounting allows MSOs to accurately and
reliably collect and account for user traffic data from a DOCSIS access network.

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

Compass ID: 327594480 Version 3 24-1


BSR 64000 Command Reference Guide Release 5.2.1

debug ipdr
The debug ipdr command enables IPDR debugging. The no debug ipdr command
turns IPDR debugging off.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


debug ipdr { all | common | exporter | ipdr | platform | transport}
no debug ipdr { all | common | exporter | ipdr | platform | transport}

Command Syntax

all all of the following debugging modes


common debug mode for common
exporter debug mode for the IPDR Exporter
ipdr debug mode for IPDR
platform debug mode for platform
transport debug mode for transport

24-2 Compass ID: 327594480 Version 3


Release 5.2.1 IPDR Commands

ipdr acksequenceinterval
The ipdr acksequenceinterval command configures the maximum number of
unacknowledged IPDR records within a session with a collector. Unacknowledged
IPDR records are the maximum number of ACKs which will be allowed to be
pending at any given time. The no ipdr acksequenceinterval command
re-establishes the default value.

Note: Changing the ackSequenceInterval value will not affect an existing


IPDR session with the collector. A changed ackSequenceInterval value will
be used for a new, subsequently established IPDR session.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipdr acksequenceinterval <1-128>
no ipdr acksequenceinterval

Command Syntax

1-128 the maximum number of unacknowledged


(pending) IPDR records

Command Default
64 unacknowledged IPDR records

Compass ID: 327594480 Version 3 24-3


BSR 64000 Command Reference Guide Release 5.2.1

ipdr acktimeinterval
The ipdr acktimeinterval command configures the maximum time between ACKs
received from a collector within a session. The no ipdr acktimeinterval command
re-establishes the default value.

Note: Changing the ackTimeInterval value will not affect an existing IPDR
session with the collector. A changed ackTimeInterval value will be used for a
new, subsequently established IPDR session.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipdr acktimeinterval <1-60>
no ipdr acktimeinterval

Command Syntax

1-60 the maximum time between ACKs in seconds

Command Default
30 seconds

24-4 Compass ID: 327594480 Version 3


Release 5.2.1 IPDR Commands

ipdr collection-interval
The ipdr collection-interval command configures the collection interval for
exporting the subscriber’s IPDR records to the collector. The no ipdr
collection-interval command re-establishes the default value.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipdr collection-interval <15-1440>
no ipdr collection-interval

Command Syntax

15-1440 the collection interval in minutes

Command Default
30 minutes

Compass ID: 327594480 Version 3 24-5


BSR 64000 Command Reference Guide Release 5.2.1

ipdr collector
The ipdr collector command adds, deletes, or modifies authorized IPDR collectors.

Note: The Session Id should be configured as "0" in the IPDR Collector when
configuring the Exporter (BSR) information in the IPDR Collector.

Note: The ipdr collector command allows for the provisioning of a maximum
of four IPDR collectors. An IPDR collector configured with this command is
uniquely identified using its IP address.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipdr collector <A.B.C.D> {<0-3>} [<1024-65535>] [cpe-list-suppress]
[new-session-per-interval]
no ipdr collector <A.B.C.D>

24-6 Compass ID: 327594480 Version 3


Release 5.2.1 IPDR Commands

Command Syntax

A.B.C.D the IP Address of the collector


0-3 the priority value of the collector - the
collector with highest priority value (the one
with highest numerical value) is selected as
the primary collector for a given IPDR
session - if the priority value for two or more
collectors is the same, the collector with the
lowest IP Address will be selected as the
primary collector - if the primary collector is
unreachable for any reason, a session will be
established with the next highest priority
collector
1024-65535 specifies the TCP port for the collector
connection - this should be one of the
non-reserved non-assigned TCP port number.
for the IPDR connection - if not specified, a
default port number of 4737 is used

Compass ID: 327594480 Version 3 24-7


BSR 64000 Command Reference Guide Release 5.2.1

cpe-list-suppress optionally suppresses the inclusion of the


CPE IP address list as part of IPDR data
record being exported to the collector - this
could be useful for improving performance
and also for disabling the inclusion of CPE IP
Address List in IPDR records to be sent to
collectors which do not support CPE IP
Address List ECN - if not specified, by
default CPE IP Address list will be included
in IPDR records sent to a particular collector
new-session-per-interval optionally sends "session close" messages to
IPDR collectors at the end of each streaming
interval - during IPDR data collection, some
collectors require a "session close" message
to write the data to a file - this parameter
should be enabled for those collectors that
require it - when enabled, the BSR sends a
file closure message at the end of each
streaming interval

Command Default
collector port = 4737
cpe-list-suppress = included
new-session-per-interval = disabled

24-8 Compass ID: 327594480 Version 3


Release 5.2.1 IPDR Commands

ipdr enable
The ipdr enable command enables IPDR export of subscriber usage based
accounting information. The no ipdr enable command disables IPDR export of
subscriber usage based accounting information.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipdr enable
no ipdr enable

Command Default
Disabled

Compass ID: 327594480 Version 3 24-9


BSR 64000 Command Reference Guide Release 5.2.1

ipdr keepaliveinterval
The ipdr keepaliveinterval command configures the keepalive interval for IPDR
connections. A keepalive interval is the maximum amount of idle time on an IDPR
connection before a keepalive message is sent to verify that the underlying TCP
connection is still available. The no ipdr keepaliveinterval command re-establishes
the default value.

Note: Changing the KeepAliveInterval value will not affect any existing IPDR
connection(s) with a collector(s). The existing IPDR connection(s) will
continue to use the previously negotiated value (as per the previous
configuration) with the collector. A changed KeepAliveInterval value will be
used for a new, subsequently established IPDR connection.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipdr keepaliveinterval <10-300>
no ipdr keepaliveinterval

Command Syntax

10-300 the keepalive interval in seconds

Command Default
60 seconds

24-10 Compass ID: 327594480 Version 3


Release 5.2.1 IPDR Commands

ipdr poll-rate
The ipdr poll-rate command configures the subscriber accounting information
transmission rate from CMTS to SRM. The subscriber accounting information
transmission rate is the number of subscriber accounting records per second. The no
ipdr poll-rate command re-establishes the default value. The no ipdr poll-rate slot
command resets the poll rate value for a specified slot to the default.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipdr poll-rate {<16-100> | slot <NUM>{<16-100>}}
no ipdr poll-rate [slot <NUM>]

Command Syntax

16-100 the number subscriber accounting records


transmitted per second
slot NUM configures the subscriber accounting
information transmission rate for a specific
the BSR 64000 CMTS slot number

Command Default
32 subscriber accounting records per second

Compass ID: 327594480 Version 3 24-11


BSR 64000 Command Reference Guide Release 5.2.1

ipdr source-interface
The ipdr source-interface command optionally configures a source protocol address
for IPDR transport (TCP) connections to any of the configured collectors as an IP
address associated with one of the BSR’s physical or loopback interfaces. The no ipdr
source-interface command removes this configuration.

Group Access
All

Command Mode
Global Configuration

Command Line Usage


ipdr source-interface {cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> | loopback
<1-255>}
no ipdr source-interface

Command Syntax

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


CMTS module
ethernet X/Y the Ethernet interface slot and port number
gigaether X/Y the Gigabit Ethernet interface slot and port
number
loopback 1-255 the loopback interface number

24-12 Compass ID: 327594480 Version 3


Release 5.2.1 IPDR Commands

show cable metering-status


The show cable metering-status command displays the status of most recent IPDR
streaming operation to currently selected IPDR collector. The following information
is provided:

Destination the IP address and port number of the IPDR


collector to which IPDR records are streamed
Complete-Time the date (month:day) and time (hh:mm:ss)
when the last billing record was streamed to
the IPDR collector
Cpe-Supp indicates whether the CPE IP addresses are
included or suppressed in the billing records
Status indicates the status of the last streaming
operation - this could one of the following:
• success - the billing records were
successfully sent to the IPDR collector
• connect-failed - the BSR was able to
establish the TCP level connection but
could not establish the IPDR level
connection
• write-error – the write on IPDR TCP
connection failed
• no-memory – the BSR has insufficient
memory to collect the billing records
• unknown - an unknown error occurred

The following is an example of typical screen output from the show cable
metering-status comman

Destination Complete-Time Cpe-Supp Status

10.11.37.2 :4737 Jun 12 09:33:05 No success

Compass ID: 327594480 Version 3 24-13


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable metering-status

24-14 Compass ID: 327594480 Version 3


Release 5.2.1 IPDR Commands

show ipdr connection


The show ipdr connection command displays the current transport status of an IPDR
connection with a specific collector or for all the configured collectors. The following
is an example of typical screen output from the show ipdr connection command:

Collector Port No. Connection Status ConnUpTime

10.10.10.10 4737 Connected 12:34:45


20.20.20.20 4737 Connected 22:11:13
30.30.30.30 5321 Disconnected -
40.40.40.40 8181 ReadyToReceive 15:56:23

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ipdr connection [<A.B.C.D>]

Command Syntax

A.B.C.D the IP Address of a specific collector

Compass ID: 327594480 Version 3 24-15


BSR 64000 Command Reference Guide Release 5.2.1

show ipdr session


The show ipdr session command displays the current status of a specific IPDR
session or all of the currently active sessions. The following is an example of typical
screen output from the show ipdr session command:

Session-Id SessUpTime Collector Primary


0 14:37:46 10.10.10.10 Yes
20.20.20.20 No
30.30.30.30 No

The following is an example of typical screen output from the show ipdr session
detail command:

Session-Id SessUpTime Collector Primary


0 14:37:46 10.10.10.10 Yes
20.20.20.20 No
30.30.30.30 No

No of IPDR Records Transmitted: 2367589043


No of erroneous IPDR Records Received: 0
Current Record Sequence Number: 243
Last ACK Sequence Number: 657
Time since Last ACK Received: 12:05:23
Session’s Template ID: 1234

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ipdr session [<NUM> [ detail ]]

24-16 Compass ID: 327594480 Version 3


Release 5.2.1 IPDR Commands

Command Syntax

NUM the IPDR unique session identifier - "0"


indicates that the statistics associated with
session ID 0 will be displayed
detail display the details of a specific IPDR session

Compass ID: 327594480 Version 3 24-17


25
Cable Traffic Management
Commands

Introduction
This chapter discusses commands introduced with the Cable Traffic Management
feature for Release 5.0.1 of the BSR 64000.

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

Compass ID: 327594480 Version 3 25-1


BSR 64000 Command Reference Guide Release 5.2.1

bidirectional
The bidirectional command specifies that when a primary service flow controlled by
a cable traffic policy is enforced in one direction, the penalty is also enforced for that
primary service flow in the opposite direction. If the opposite direction’s primary
service flow does not have a cable traffic policy applied and the policy is not enabled
when the bidirectional attribute is configured, the BSR logs an event. Each cable
traffic policy can have bidirectional configured as an option.

Note: The bidirectional configuration is intended to match the behavior of


other vendor’s Subscriber Traffic Management ”enforce-rule” options which
penalize both the upstream and downstream primary service flows when a
downstream service flow or upstream service flow's traffic count exceeds its
policy credit maximum. Motorola recommends omitting the bidirectional
configuration.

Group Access

Command Mode
Cable Traffic Management Configuration

Command Line Usage


bidirectional
no bidirectional

Command Default
Disabled

25-2 Compass ID: 327594480 Version 3


Release 5.2.1

cable traffic sample-interval


The cable traffic sample-interval command configures the cable sample interval at
which Traffic Token Buckets (TTBs) are updated and enforcement applied. The Cable
Traffic Management feature operates in the background of data forwarding,
periodically updating a Traffic Token Bucket based on background sampling of the
bytes transferred for a service flow. The configured cable sample interval controls the
interval between updates of a TTB for a single service flow.

Note: When any cable traffic policies are enabled, setting the cable traffic
sample-interval will disable and re-enable these policies after the interval is
changed. This will reset any current enforcement. A user will receive the
following warning message:

Changing sample-interval will reset any enabled cable


traffic policies. Continue? [yes/no]:

Group Access

Command Mode
Global Configuration

Command Line Usage


cable traffic sample-interval <5-60>

Command Syntax

5-60 the cable sample interval in minutes

Command Default
5 minutes

Compass ID: 327594480 Version 3 25-3


BSR 64000 Command Reference Guide Release 5.2.1

cable traffic policy


The cable traffic policy command configures a cable traffic policy named in a
specified direction and enters a Cable Traffic Policy configuration mode. Cable
Traffic Policy configuration mode allows a user to configure a cable traffic policy. A
user can either create a new named cable traffic policy in a specified direction and
enters Cable Traffic Policy configuration mode for the new policy or enters Cable
Traffic Policy configuration mode for an existing cable traffic policy.
The no cable traffic policy command deletes an existing cable traffic policy.
Specifying the direction is optional when deleting a cable traffic policy and is not
verified to match the existing policy direction.

Note: A cable traffic policy’s direction cannot be changed once the policy is
created.

Group Access

Command Mode
Global Configuration

Command Line Usage


cable traffic policy <ctp-name> {downstream | upstream}
no cable traffic policy <ctp-name> [downstream | upstream]

Command Syntax

ctp-name the cable traffic policy name- from one to 12


case-sensitive alphanumeric characters
including underscores and must start with a
letter

25-4 Compass ID: 327594480 Version 3


Release 5.2.1

downstream indicates that this cable traffic policy applies


in the downstream direction
upstream indicates that this cable traffic policy applies
in the upstream direction

Compass ID: 327594480 Version 3 25-5


BSR 64000 Command Reference Guide Release 5.2.1

clear cable traffic enforcement


The clear cable traffic enforcement command clears the traffic counts for traffic
token buckets (TTBs) and thereby expires any enforcement penalty periods in effect.
The clear cable traffic enforcement command clears the Traffic Count fields
displayed with the show cable subscriber-usage command and, depending on the
parameter specified with the clear cable traffic enforcement command, will effect
the summary counts in the show cable subscriber-usage summary output. In all
cases except the clearing of a single cable modem’s traffic, the clear cable traffic
enforcement command also sets the “Last Cleared” field of the show cable traffic
summary command to the current time for the combinations of cable traffic policy
and interface that are cleared.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear cable traffic enforcement {<cmMac> | <ctp-name> | <X/Y> | all}

Command Syntax

cmMac a cable modem MAC address - clears the


TTBs for the downstream and upstream
primary service flows of the indicated cable
modem
ctp-name a cable traffic policy name - clears all TTBs
created by that policy on all cable interface
X/Y clears the TTBs for all online cable modems
registered in the indicated cable interface and
MAC domain
all clears the TTBs for all online cable modems
on all cable interfaces

25-6 Compass ID: 327594480 Version 3


Release 5.2.1

clear cable traffic history


The clear cable traffic history command starts a new ”Enforced Since” history
period for the show cable subscriber-usage command. The clear cable traffic
history command clears the “Last Enforced” timestamp for all TTBs and the “Last
Enforced” field of the show cable subscriber-usage command for all service flows.
Subsequent use of show cable subscriber-usage command will display as “over
consumed” only those service flows that had started enforcement since the clear
cable traffic history command was issued.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear cable traffic history

Compass ID: 327594480 Version 3 25-7


BSR 64000 Command Reference Guide Release 5.2.1

credit
The credit command configures how a TTB controlled by a cable traffic policy
determines its credit maximum. If the mbytes option is used, the credit maximum is
the absolute number of megabytes specified. If the seconds option is used, the credit
maximum is calculated relative to the configured maximum rate (max-rate). The
credit maximum is set to the number of megabytes (rounded up) that can be
transferred in the specified seconds at the configured maximum rate for each flow. For
example, if the primary service flow’s maximum rate is 2 mbps and the credit
maximum is configured as 300 seconds, the credit maximum would be set to 2 * 300 /
8 = 75 mbytes.
Although the absolute credit maximum option (mbytes) is intended for a
single-tier-per-policy strategy and the relative credit maximum option (seconds) is
intended for a multiple-tier-per-policy strategy, the BSR does not enforce this as a
restriction.

Group Access

Command Mode
Cable Traffic Management Configuration

Command Line Usage


credit {mbytes <1-2147483> | seconds <1-43200> }
no credit [mbytes <1-2147483> | seconds <1-43200> ]

Note: Motorola recommends that the credit mbytes option for TTBs be
configured to be at least 10 megabytes.

Command Default
The default cable sample interval in seconds. The default cable sample interval is 300
seconds (5 minutes), so the default credit maximum is 300 seconds.

25-8 Compass ID: 327594480 Version 3


Release 5.2.1

Command Syntax

mbytes 1-2147483 the credit maximum is the absolute number of


megabytes specified
seconds 1-43200 the credit maximum is calculated relative to
the configured maximum rate (max-rate) - the
credit maximum is set to the number of
megabytes (rounded up) that can be
transferred in the specified seconds at the
configured maximum rate for each flow

Compass ID: 327594480 Version 3 25-9


BSR 64000 Command Reference Guide Release 5.2.1

enabled
The enabled command enables a configured cable traffic policy. When a cable traffic
policy is first created, it is disabled by default. A disabled cable traffic policy can be
configured and displayed but does not affect packet forwarding unless enabled. TTBs
are created only for enabled cable traffic policies and are deleted when the cable
traffic policy is disabled. The no enabled command disables an already enabled cable
traffic policy.
Cable traffic policies are configured with working defaults and may be enabled
immediately after creation without any additional configuration. The default values
are:

Command Command Default

max-rate max-rate all


credit The default cable sample interval in seconds.
The default cable sample interval is 5
minutes, so the default credit maximum is
300 seconds.
enforce enforce percent = 50
bidirectional Disabled
penalty-period Disabled
peak-time Disabled

Note: No attribute of an existing cable traffic policy can be changed while it is


enabled. For example, you must disable a cable traffic policy in order to
change the “max-rate” attribute. When a cable traffic policy is disabled, all
TTBs configured by the policy are deleted and all service flows controlled by
those TTBs are restored to their configured maximum rate.

Group Access

25-10 Compass ID: 327594480 Version 3


Release 5.2.1

Command Mode
Cable Traffic Management Configuration

Command Line Usage


enabled
no enabled

Command Default
Disabled

Compass ID: 327594480 Version 3 25-11


BSR 64000 Command Reference Guide Release 5.2.1

enforce
The enforce command configures how a TTB controlled by the cable traffic policy
determines its enforce rate for a service flow to which the policy applies. The enforce
rate can be configured to an absolute number with enforce rate command or as a
relative percentage of the configured maximum rate (max-rate) with the enforce
percent command. The no enforce command resets the enforce rate to the default
value.
The BSR packet scheduler implements its scheduler rate limiter with a minimum
granularity of 8 kbps and a maximum rate of 200000 kbps. A configured maximum
rate (max-rate) or enforce rate is rounded down to a multiple of 8 kbps.
The BSR does not check or prevent an absolute enforce rate being set higher than a
flow’s configured maximum rate. Setting a relative enforce configuration to 100% is
convenient for cable traffic monitoring only and determining which subscribers would
be penalized without actually doing so.

Note: Setting the enforce percent to 0 is the equivalent of no enforcement


and allows all traffic from the service flow for an entire cable sample interval
and is not recommended.

Note: When a cable traffic policy is applies to service flows with no


configured maximum rate, then setting enforcement by percent will have no
effect - i.e. no penalization.

Group Access

Command Mode
Cable Traffic Management Configuration

Command Line Usage


enforce {percent <0-100> | rate <8-200000> }
no enforce [percent <0-100> | rate <8-200000>]

25-12 Compass ID: 327594480 Version 3


Release 5.2.1

Command Default
enforce percent = 50

Command Syntax

percent 0-100 configures the enforce rate relative to the


percentage of the service flow's Maximum
Rate (max-rate)
rate 8-200000 configures the enforce rate to a absolute
number in kbps

Compass ID: 327594480 Version 3 25-13


BSR 64000 Command Reference Guide Release 5.2.1

max-rate
The max-rate command specifies whether a cable traffic policy only applies to
primary service flows with a particular configured maximum rate. When a cable
traffic policy is created, the default setting is max-rate all which means that the
policy applies to all configured maximum rate values (all service flows in the
direction of the cable traffic policy). If max-rate 0-4294967 is configured, the policy
will apply to a service flow only if that service flow’s configured maximum rate value
equals the value specified in the 0-4294967 argument of the command.
Operators may define different subscriber tiers of service with different combinations
of QOS parameters that have the same configured maximum rate in a given direction.
For example, an operator may define a “10/128” tier with 10 Mbps configured for the
maximum rate downstream and 128 kbps upstream as well as a “10/256” tier with 10
Mbps downstream and 256 kbps upstream. If the operator wishes to have different
cable traffic policies in a direction that apply to the different tiers with the same
maximum rate in that direction, the operator can configure slightly different
maximum rate values in order to uniquely match the desired cable traffic policy. For
example, the operator can define the "10/128" tier with a configured maximum rate of
10000001 bps and the “10/256” tier with a configured maximum rate of 10000002
bps. These would match separate cable traffic policies with “max-rate 10000001” and
“max-rate 10000002”, respectively.
When a CM registers, the BSR selects a cable traffic policy for its primary
downstream and primary upstream service flows based on the configured maximum
rate of the service flow. The BSR prioritizes matching to a cable traffic policy
configured with an exact match with the max-rate 0-4294967 option. The BSR
selects the first matching policy in alphabetic order of policy name.
To thwart hackers who register with unauthorized maximum rates, an operator can
define cable traffic policies with the max-rate 0-4294967 option for all authorized
maximum rates, and then define a default cable traffic policy with the max-rate all
option and very low credit maximum and enforce rate attributes.

Group Access

Command Mode
Cable Traffic Management Configuration

25-14 Compass ID: 327594480 Version 3


Release 5.2.1

Command Line Usage


max-rate {<0-4294967> | all}

Command Syntax

0-4294967 Note: the cable traffic policy will apply to a


service flow only if that service flow’s
configured maximum rate value equals the
value specified in the 0-4294967 argument -
entering a max-rate of "0" will specify that
the cable traffic policy applies to all service
flows of cable modems without configured
max rates (enforcement by percent is not
allowed)

all the cable traffic policy applies to all


configured maximum rate values - all service
flows in the direction of the cable traffic
policy - a more specific max-rate policy will
take precedence over the ‘all’ policy

Command Default
max-rate all

Compass ID: 327594480 Version 3 25-15


BSR 64000 Command Reference Guide Release 5.2.1

peak-time
The peak-time command configures a cable traffic policy for peak-time monitoring
mode. In peak-time monitoring mode, a service flow is permitted to send a traffic
count up to a credit limit during a configured peak-interval in the day before being
penalized to an enforced rate. A policy can be configured with up to four
non-overlapping peak-time attributes, each with a different index value.
If any peak-time interval is configured, the policy operates only during the set of
configured peak-times using peak-time traffic monitoring by counting absolute bytes
during the peak time only. If no peak-time intervals are configured, the policy
operates in continuous monitoring mode by measuring a traffic count only in excess
of an enforce rate
The no peak-time command deletes the peak-time attribute of the cable traffic policy.
At a minimum, the index must be specified with the no peak-time command. All
other arguments are optional and are not checked to verify that they match the
configuration of the peak-time index being deleted.

Note: Peak-time monitoring mode is disabled by default. Not configuring


peak-time causes the CTM to use Continuous Mode.

Group Access

Command Mode
Cable Traffic Management Configuration

Command Line Usage


peak-time <1-4> {daily | weekday | weekend} start {<hh:mm> | <0-23>} duration
<1-1440>
no peak-time <1-4> [daily | weekday | weekend] [start {<hh:mm> | <0-23>}
duration <1-1440>]

25-16 Compass ID: 327594480 Version 3


Release 5.2.1

Command Syntax

1-4 a required index argument that uniquely


identifies the peak-time interval within the
cable traffic policy
daily specifies a peak-time that is defined as all
seven days of the week
weekday specifies a peak-time interval that is defined
as only Monday through Friday
weekend specifies the peak-time interval as only on
Saturday or Sunday
start hh:mm specifies the starting hour (and optionally,
start 0-23 minute) of the peak time during the day - hh =
0-23 mm = 0-59
duration 1-1440 specifies the number of minutes that the
peak-time interval lasts - the duration may not
extend past 24 hours

Command Default
Disabled

Compass ID: 327594480 Version 3 25-17


BSR 64000 Command Reference Guide Release 5.2.1

penalty-period
The penalty-period command configures a cable traffic policy to penalize a service
flow exceeding its traffic count credit for a fixed duration penalty period. The penalty
is also enforced for that primary service flow in the opposite direction, provided a
policy is applied in that direction.
■ For continuous monitoring, when no peak-time is configured, the enforcement
period always lasts for the configured penalty in minutes.
■ For peak-time monitoring, a penalty-period can continue beyond the end of the
peak-time interval.
■ If the expires-end-peak option is specified, then any penalty-period being
enforced at the end of the peak-time expires.
■ If expires-end-peak parameter is omitted, a penalty period can extend beyond
the end of the current peak-time. Any such “late” penalty-period expires
automatically at the start of the next peak-time interval. The expires-end-peak
option is ignored with continuous traffic monitoring (when no peak-time is
configured).
The minimum penalty-period can be specified as "0" minutes in order to monitor
subscriber traffic without enforcing it. Subscribers which exceed their traffic count
credit may be observed through the show cable subscriber-usage command even
though such subscribers never had their scheduler rate limits enforced. The maximum
penalty-period is 1440 minutes or 24 hours.
The no penalty-period removes a penalty-period configuration if one exists and is
ignored if no penalty-period configuration exists. The optional arguments after no
penalty-period command are not checked to verify that they match the existing
configuration.

Note: The penalty-period mode of traffic enforcement is intended for


compatibility with other vendor’s subscriber traffic management feature.
Motorola recommends NOT using the penalty-period configuration and using
token-based enforcement instead. Token-based enforcement restores
subscribers to their configured maximum rate limit as soon as they have
earned the tokens to do so thus minimizing the enforcement duration for the
subscriber.

25-18 Compass ID: 327594480 Version 3


Release 5.2.1

Group Access

Command Mode
Cable Traffic Management Configuration

Command Line Usage


penalty-period <0-1440> [expires-end-peak]
no penalty-period [<0-1440> [expires-end-peak]]

Command Syntax

0-1440 specifies the penalty period duration in


minutes (24 hour maximum) - the minimum
penalty-period may be specified as "0"
minutes in order to monitor subscriber traffic
without enforcing it
expires-end-peak stops enforcement of a service flow at the end
of the policy peak time
• if the expires-end-peak option is
specified, then any penalty-period being
enforced at the end of the peak-time
expires
• if the expires-end-peak option is omitted,
a penalty period can extend beyond the
end of the current peak-time
any such “late” penalty-period expires
automatically at the start of the next
peak-time interval - the expires-end-peak
option is ignored with continuous traffic
monitoring, i.e. when no “peak-time” is
configured

Command Default
Disabled

Compass ID: 327594480 Version 3 25-19


BSR 64000 Command Reference Guide Release 5.2.1

show cable subscriber-usage


The show cable subscriber-usage command displays the cable traffic policy
enforcement state for downstream and upstream primary service flows of online cable
modems for which a cable traffic policy is applied. The show cable subscriber-usage
command only displays the cable modems for which a cable traffic policy is applied.
The following is an example of typical screen output from the show cable
subscriber-usage command:

E=Enforced, M=Monitored, B=Bidirectional

Enforced since: THU JUL 24 10:55:04 2008

Cable Sfid CM Mac Address Traffic Monitored Last Remain Limit M R

I/F Policy Traffic(K) Enforced Enforced Rate (K)

----- ----- -------------- ----------- --------- -------- -------- -------- - -

1/0 3764 000b.0626.5bc8 ctp-ds-6700 30397 0:07:53 0:05:00 3350 M E

1/0 3774 000b.0623.ffa4 ctp-ds-3400 26535 0:15:11 0:00:18 100 M E

1/0 3780 0011.ae05.bcda ctp-ds-all 1352 0:17:39 - 34000 M -

1/0 3806 000b.0623.fe4c ctp-ds-3400 23053 0:10:17 0:05:00 100 M E

1/0 3842 000b.0626.afa8 ctp-ds-3400 17450 0:03:03 0:05:00 100 M E

1/0 3850 000b.0623.fe68 ctp-ds-3400 17463 0:03:03 0:05:00 100 M E

1/0 3852 000b.0626.5b10 ctp-ds-6700 31103 0:07:53 0:05:00 3350 M E

1/0 3858 000b.0627.b41c ctp-ds-3400 13906 0:34:47 - 100 M B

1/0 3862 000b.0626.5dcc ctp-ds-6700 27747 0:05:20 0:05:00 3350 M E

1/0 3864 000b.0627.577c ctp-ds-3400 17714 0:03:03 0:05:00 100 M E

1/0 3866 000b.0627.b44c ctp-ds-3400 22466 0:10:17 0:05:00 100 M E

25-20 Compass ID: 327594480 Version 3


Release 5.2.1

The show cable subscriber-usage command displays the following cable traffic
policy enforcement state information:

Cable I/F the <slot/MAC Domain> number of a cable


interface
Sfid the service flow identifier of a primary
downstream service flow for an online cable
modem on this cable interface
CM Mac Address the MAC address of the subscriber cable
modem.
Traffic Policy the name of the cable traffic policy applying
to the service flow
Monitored Traffic the current traffic token bucket (TTB) credit
used (i.e. credit maximum less the traffic
token count)
• for traditional TTBs, this is a measure of
recent traffic in excess of the enforce rate
• for penalty-period TTBs, this is a total
count of transferred bytes since the TTB
was cleared
a penalty-period TTB is cleared at the start of
a peak-time, after expiration of
penalty-period, or by using the clear cable
traffic command - penalty-period TTB Traffic
Counts remain fixed outside of a peak-time
Last Enforced if the service flow has been enforced, this
field displays the amount of time since the
service flow was last enforced by it's applied
cable traffic policy (not by a bidirectional
policy) - if the service flow has not undergone
enforcement, this field displays a “-“character

Compass ID: 327594480 Version 3 25-21


BSR 64000 Command Reference Guide Release 5.2.1

Remain Enforced if the service flow is currently being enforced,


this field is the amount of time of the earliest
cable sample interval boundary at which time
the enforcement can be removed
• for traditional TTBs, this is calculated as
when a completely idle flow would earn
tokens back to a positive token level
• for enforced penalty-period TTBs, this is
the cable sample interval boundary for this
flow at which the penalty will expire
• if the “Remain Enforced” field is in the
form hh:mm, the hour and minute indicate
a time within the next 24 hours
• if the “Remain Enforced” field is in the
form hh:mm+dd, the +dd gives a number
of additional 24-hour days from now until
the enforcement ends at hh:mm from that
point in time
• the “Remain Enforced” field will only
have a time displayed if R (Reason) = E
(Enforced)
Limit Rate (K) the current scheduler limit rate L for the
service flow in kilobits per second (kbps) -
this is either the configured maximum rate or
the enforce rate (if the service flow is
currently being enforced) - an asterisk (*)
following the Limit Rate means that because
maximum rate limiting is not enabled on at
least one of the downstream channels of the
MAC domain, the limit rate does not apply

25-22 Compass ID: 327594480 Version 3


Release 5.2.1

M the monitored flag will be displayed as "M" if


the service flow is currently being monitored
- if the service flow is not currently being
monitored, this field displays a “-“ character
R the reason flag which is displayed as “E” if
the service flow is currently being enforced
(i.e. its current scheduler limit rate is lower
than its configured maximum rate) or "B" if
the service flow is bidirectional and being
enforced - if the service flow is not currently
being enforced, his field displays a “-“
character

Note: If rate limiting is not enabled for any channel with the cable
downstream rate-limiting or cable upstream rate-limiting commands, the
“Limit Rate” field displayed for a service flow may not actually be enforced.

Note: The clear counters and clear stats commands do not affect the
Traffic Count statistics displayed with the show cable subscriber-usage
summary command.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable subscriber-usage [ <mac> | <X/Y> ] [ downstream | upstream ]
[<ctp-name> | over-consume | sort-byte-count ] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show cable subscriber-usage [ <mac> | <X/Y> ] [ downstream | upstream ]
[<ctp-name> | over-consume | sort-byte-count ] [ | {count | count-only}]

Compass ID: 327594480 Version 3 25-23


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

mac displays the cable traffic policy enforcement


state for downstream and upstream primary
service flows, for which a cable traffic policy
is applied, of the indicated cable modem’s
MAC address
X/Y restricts the command output to a single cable
interface and MAC domain, otherwise, all
interfaces are shown in order of slot and
MAC domain number
downstream displays a traffic count summary for cable
traffic policies in the downstream direction
upstream displays a traffic count summary for cable
traffic policies in the upstream direction
ctp-name the name of a cable traffic policy - only the
configuration for the this named policy is
displayed
over-consume restricts the command output to service flows
that have been penalized (or were being
penalized at that time) since the last clear
cable traffic history command was issued -
- the "Last Enforced" field in the command
output will display a time only for service
flows that are newly enforced
sort-byte-count displays the service flows on a given cable
traffic policy are shown in decreasing order of
Traffic Count, otherwise, the service flows
are shown in increasing order of the service
flow ID
| turns on output modifiers (filters)
begin filter for output that begins with the specified
string

25-24 Compass ID: 327594480 Version 3


Release 5.2.1

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: 327594480 Version 3 25-25


BSR 64000 Command Reference Guide Release 5.2.1

show cable subscriber-usage summary


The show cable subscriber-usage summary command displays a summary of the
traffic transferred for all service flows controlled by a particular cable traffic policy on
a particular cable interface. The following is an example of typical screen output from
the show cable subscriber-usage summary command:

Dir Interface Traffic Monitored Total Enforced

Policy Count (K) Flows Flows

---- ---------- ------------- ----------- ----- --------

down 1/0 ctp-ds-0 170690 1497 10

down 1/0 ctp-ds-3400 1477193 68 67

down 1/0 ctp-ds-6700 1824075 66 65

down 1/0 ctp-ds-all 455760 118 21

up 1/0 ctp-us-0 446046 1497 10

up 1/0 ctp-us-1500 2011912 89 88

up 1/0 ctp-us-670 1911957 66 65

up 1/0 ctp-us-all 3547 97 0

25-26 Compass ID: 327594480 Version 3


Release 5.2.1

The show cable subscriber-usage summary command displays the following cable
traffic policy summary information:

Dir the direction of the traffic - “down” for


downstream or “up” for upstream
Interface the <slot/MAC Domain> number of a cable
interface
Traffic Policy the name of the cable traffic policy that
applies to service flows that were active on
this cable interface since the last time cable
traffic statistics were cleared with the clear
cable traffic enforcement command
Monitored Count (K) the sum of the Traffic Counts for all TTBs for
currently active service flows to which this
cable traffic policy applies - the Traffic Count
for a TTB is the credit used (the credit
maximum minus the token count) - the Traffic
Count is shown in kilobytes, with 1000 bytes
per kilobyte and does not include traffic for
offline cable modems
Total Flows the number of service flows on the MAC
Domain that the cable traffic policy applies to
Enforced Flows the number of applied service flows currently
under enforcement

Note: The clear counters and clear stats commands do not affect the
Traffic Count statistics displayed with the show cable subscriber-usage
summary command.

Group Access
All

Compass ID: 327594480 Version 3 25-27


BSR 64000 Command Reference Guide Release 5.2.1

Command Mode
All modes except User EXEC

Command Line Usage


show cable subscriber-usage summary [ downstream | upstream ] [<X/Y>] [ |
{begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show cable subscriber-usage summary [ downstream | upstream ] [<X/Y>] [ |
{count | count-only}]

Command Syntax

X/Y restricts the command output to a single cable


interface and MAC domain, otherwise, all
interfaces are shown in order of slot and
MAC domain number
downstream displays a traffic count summary for cable
traffic policies in the downstream direction
upstream displays a traffic count summary for cable
traffic policies in the upstream direction
| 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

25-28 Compass ID: 327594480 Version 3


Release 5.2.1

show cable traffic policy


The show cable traffic policy command displays the configuration of all existing
cable traffic policies. The following is an example of typical screen output from the
show cable traffic policy command:

Cable Traffic Dir Max Pk Fq Start Dur Pen X B Credit Enforce En


Policy Rate (K) Mins Mins Rate
------------- --- --------- -- -- ----- ----- ----- - - ----------- --------- --
ctp_all dn all - - - - - - N 300s 50% Y
ctp_ds1 dn 20000 1 dy 20:20 35 - - N 1000mb 5000 N
ctp_us1 up 20000 1 dy 08:00 20 - - Y 300s 5000 N
test up all - - - - - - N 300s 75% N

The show cable traffic policy command displays the following cable traffic policy
information:

Cable Traffic Policy the name of a cable traffic policy - only the
configuration for this policy is displayed
Dir the cable traffic policy direction abbreviated
as “dn” for downstream or “up” for upstream.
Max Rate the value of the max-rate attribute of the
cable traffic policy which controls the service
flows to which the policy applies
Pk the index of the peak-time attribute
configured for this cable traffic policy - if no
peak-time is configured, a “-“is displayed
Fq the frequency of the peak-time configuration
abbreviated as “dy” for “daily”, “wd” for
“weekday”, “we” for “weekend” - if no
peak-time is configured, a “-“ is displayed
Start the starting hour and minute of the peak-time
configuration in a 24-hour format - if no
peak-time is configured, a “-“ is displayed

Compass ID: 327594480 Version 3 25-29


BSR 64000 Command Reference Guide Release 5.2.1

Dur Mins the duration of the peak-time configuration


in minutes,- if no peak-time is configured, a
“-“ is displayed
Pen Mins the penalty-period configuration in minutes,
if any, or “-“ if no penalty-period or
peak-time configured,
X "Y" if expires-off-peak is configured
B the bidirectional status - “Y” if configured,
“N” if not configured
Credit the value of the credit mbytes or credit
seconds attribute of the cable traffic policy
Enforce Rate the value of the enforce rate attribute of the
cable traffic policy. For absolute enforce rate
configurations, the value shown is in the form
“xxxxxx K” in kilobits per second, where
xxxxxx is the configured enforce rate divided
by 1000. For relative enforce rate
configurations, the value shown is of the form
“NNN %”
En the enforced status - “Y” if enabled, “N” if
disabled

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show cable traffic policy [<ctp-name>] [ | {begin | exclude | include} {<WORD>} [
| {count | count-only}]]
show cable traffic policy [<ctp-name>] [ | {count | count-only}]

25-30 Compass ID: 327594480 Version 3


Release 5.2.1

Command Syntax

ctp-name the name of a cable traffic policy - only the


configuration for this policy is 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: 327594480 Version 3 25-31


26
IPv6 Commands

Introduction
This chapter describes the IPv6 commands supported by the BSR 64000. IPv6
represents the evolution of the Internet Protocol from IPv4. IPv6 maintains the same
basic operational principles of IPv4 but makes some important modifications
particularly in the area of addressing. One of the most significant changes is the
creation of an entirely new support protocol for IPv6 which combines several tasks
previously performed by other protocols in IPv4. This new protocol is called the IPv6
Neighbor Discovery (ND).
The Internet Control Message Protocol (ICMPv6) provides a method for error
reporting, route discovery and diagnostics. In addition, it provides information about
multicast group membership, and performs address resolution (Address Resolution
Protocol (ARP) in IPv4). Significant functionality of ICMPv6 includes neighbor
discovery and auto configuration. Neighbor discovery allows one device in a network
to find out about other nearby devices, and stateless address auto configuration allows
a device to dynamically configure an IPv6 address.

IPv6 Command Descriptions


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

Compass ID: 327594480 Version 3 26-1


BSR 64000 Command Reference Guide Release 5.2.1

cable ipv6 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 BSR and
communicate with the DHCP server.
The cable ipv6 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 cable ipv6 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 IPv6
helper-addresses.

Group Access
ISP

Command Mode
Interface Configuration (cable and loopback interfaces only)

Command Line Usage


cable ipv6 helper-address <A:B:C:D:E:F:G:H> cable-modem
no cable ipv6 helper-address <A:B:C:D:E:F:G:H> cable-modem

26-2 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

Command Syntax

A:B:C:D:E:F:G: the IPv6 address of the destination DHCP


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

Compass ID: 327594480 Version 3 26-3


BSR 64000 Command Reference Guide Release 5.2.1

cable ip prov-mode
The cable ip prov-mode command specifies the provisioning mode of DOCSIS 3.0
cable modems on a particular cable interface (MAC domain). The no cable ip
prov-mode command disables the specified provisioning mode.

Group Access
ISP

Command Mode
Interface Configuration (cable interfaces only)

Command Line Usage


cable ip prov-mode {apm | dpm | ipv4-only | ipv6-only}
no cable ip prov-mode {apm | dpm | ipv4-only | ipv6-only}

Command Syntax

apm Alternate Provisioning Mode - i.e.


the cable modem will first try to
acquire IPv6 address, if that fails
then modem will try to acquire IPv4
address
dpm Dual-Stack Provisioning Mode - i.e.
the cable modem will try to acquire
both IPv6 and IPv4 address. If IPv6
address acquisition was successful,
modem will complete the
registration using that address
otherwise modem will complete the
registration with the acquired IPv4
address

26-4 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

ipv4-only IPv4 only provisioning mode - i.e.


the cable modem will acquire only
the IPv4 address
ipv6-only IPv6 only provisioning mode - i.e.
the cable modem will acquire only
the IPv6 address

Compass ID: 327594480 Version 3 26-5


BSR 64000 Command Reference Guide Release 5.2.1

clear ipv6 neighbor-cache


The clear ipv6 neighbor-cache command clears the entire IPv6 neighbor cache or a
specific neighbor cache entry.

Group Access
ISP

Command Mode
All modes except User EXEC

Command Line Usage


clear ipv6 neighbor-cache [<A:B:C:D:E:F:G:H> | <A:B:C:D:E:F:G:H>]

Command Syntax

A:B:C:D:E:F:G:H the IPv6 address of the neighbor


cache entry
A:B:C:D:E:F:G:H the Link Local address of the
neighbor cache entry

26-6 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

clear ipv6 traffic


The clear ipv6 traffic command clears IPv6 protocol statistics.

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


clear ipv6 traffic Command Syntax

Compass ID: 327594480 Version 3 26-7


BSR 64000 Command Reference Guide Release 5.2.1

ipv4 range
IPv6-mapped addresses are used by an IPv4 host to communicate with an IPv6 host.
The IPv4 host addresses the packet to the mapped address.
The ipv4 range command establishes IPv4 to IPv6 address mapping. The no ipv4
range command removes the address mapping association.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ipv4 range <A:B:C:D/1-32> mapto <A:B:C:D:E:F:G:H>
no ipv46 range <A:B:C:D/1-32> mapto <A:B:C:D:E:F:G:H>

Command Syntax

A.B.C.D/1-32 the IPv4 address/Prefix Length to be mapped


to an IPv6 address
mapto translate the above IPv4 address/Prefix
Length into an IPv6 address
A:B:C:D:E:F:G:H map to this IPv6 address

26-8 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

ipv6 address
The ipv6 address command configures a primary or secondary IP address for an
interface. The no ipv6 address command is used to remove an IP address from the
interface.
The following rules apply to IPv6 addressing:
■ The default link local address for the interface is automatically configured when
first IPv6 prefix is configured on that interface.
■ A user specified link-local address can be configured before any primary or
secondary IPv6 address is configured for the interface, or to overwrite an existing
link-local address on an interface.
■ BSR will not allow IPv6 addresses to be configured on an interface if Tagged
Router Interface (TRI) is enabled on that interface (via the encapsulation dot1q
command). Similarly the BSR will not allow TRI to be enabled on an interface if
IPv6 subnets are already configured on that interface.
■ The automatically generated default link local address for the interface is deleted
when the primary IPv6 prefix is deleted on that interface.
■ The user configured link local address for the interface will not be automatically
be deleted when the primary IPv6 prefix is deleted on that interface.
■ Deleting the primary IPv6 prefix of the interface without deleting all the
secondary prefixes of the interface is not allowed.
■ When the user specified link local address for the interface is deleted, the default
link local address for the interface is automatically generated if the primary IPv6
subnet was previously configured for the interface.
■ The BSR will not allow the IPv4-Mapped IPv6 addresses to be configured as part
of the ipv6 address command.

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ipv6 address <A:B:C:D:E:F:G:H/1-128> [eui-64 [secondary] | secondary ]]
ipv6 address <FE80:0:0:0:E:F:G:H> link-local

Compass ID: 327594480 Version 3 26-9


BSR 64000 Command Reference Guide Release 5.2.1

Note: The link-local option will not be visible until the correct upper 8 octects
of the link-local address, which must be FE80:0:0:0, is entered. The lower 8
octets can be any valid entry.

Command Syntax

A:B:C:D:E:F:G:H the Link-local IPv6 address


A:B:C:D:E:F:G:H/1-128 the IPv6 address/Prefix Length
eui-64 use EUI-64 interface identifier
secondary make this IPv6 address a secondary
address

Note: The Extended Unique Identifier (EUI). EUI-64 is a 64-bit identifier that
is formed by concatenating the 24-bit Organizationally Unique Identifier (OUI)
with a 40-bit extension identifier that is assigned by the organization that
purchased the OUI. The resulting identifier is generally represented as a set
of octets separated by dashes (hexadecimal notation) or colons (bit-reversed
notation) as in xx-xx-xx-xx-xx-xx-xx-xx or xx:xx:xx:xx:xx:xx:xx:xx. RFC 3513
specifies the use of EUI-64 identifiers as part of an IPv6 address.

26-10 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

ipv6 helper-address
The ipv6 helper-address command specifies the destination IPv6 address of the
DHCP server for where broadcast packets are forwarded. The no ipv6
helper-address command removes the IPv6 address. In most cases, the cable ipv6
helper-address command will be used instead of this command.

Group Access
ISP

Command Mode
Interface Configuration (cable and loopback interfaces only

Command Line Usage


ip ipv6 helper-address <A:B:C:D:E:F:G:H>
no ipv6 helper-address <A:B:C:D:E:F:G:H>

Command Syntax

A:B:C:D:E:F:G:H the IPv6 address of the destination DHCP


server

Compass ID: 327594480 Version 3 26-11


BSR 64000 Command Reference Guide Release 5.2.1

ipv6 icmp error-interval


The ipv6 icmp error-interval command configures ICMPv6 error message rate
limiting. The command specifies the minimum interval between ICMPv6 error
messages and the maximum number of ICMPv6 error messages allowed to be queued
in the Rate Limiting Bucket. The no ipv6 icmp error-interval command disables the
limiting of ICMP error messages.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ipv6 icmp error-interval <0-2147483647> [<1-200>]
no ipv6 icmp error-interval

Command Syntax

0-2147483647 the minimum interval between ICMP error


messages in milliseconds
1-200 the maximum number of ICMP error
messages in the Rate Limiting Bucket

Command Default
100
10

26-12 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

ipv6 nd
The ipv6 nd command configures Neighbor Discovery on the BSR. Neighbor
Discovery is an ICMPv6 function that allows a router or host to identify other devices
on its links. The discovered information is used in address auto configuration which
redirects a node to use a more appropriate router, if necessary, and to maintain
reachability information with its neighbors. IPv6 Neighbor Discovery is similar to a
combination of the ARP, ICMP Router Discovery and ICMP Redirect IPv4 protocols.
Neighbor Discovery provides the following functions:
■ Duplicate Address Detection
■ Neighbor Solicitation Retransmission Interval
■ Suppression of IPv6 Router Advertisement
■ Router Advertisement Interval
■ Router Advertisement Lifetime Advertised
■ Reachability Time Interval

Group Access
ISP

Command Mode
Interface Configuration

Command Line Usage


ipv6 nd dad attempts <0-600>
ipv6 nd ns-interval <1000-3600000>
ipv6 nd ra suppress
ipv6 nd ra-interval {<3-1800> | msec <500-1800000>}
ipv6 nd ra-lifetime <0-9000>
ipv6 nd reachable-time <0-3600000>

no ipv6 nd dad attempts


no ipv6 nd ns-interval
no ipv6 nd ra suppress
no ipv6 nd ra-interval

Compass ID: 327594480 Version 3 26-13


BSR 64000 Command Reference Guide Release 5.2.1

no ipv6 nd ra-lifetime
no ipv6 nd reachable-time

Command Syntax

dad attempts 0-600 sets the number of duplicate address detection


attempts
ns-interval sets the neighbor solicitation retransmission
1000-3600000 interval value in milliseconds
ra suppress suppress router advertisement messages
ra-interval 3-1800 sets router advertisement interval value in
seconds
ra-interval msec sets the router advertisement interval value in
500-1800000 milliseconds
ra-lifetime 0-9000 sets the router advertisement lifetime value in
seconds
reachable-time sets the reachability time in milliseconds
0-3600000

Command Defaults
dad attempts = 3
ns-interval = 1000
ra-interval msec = 200000
ra suppress = disabled
ra-lifetime = 1800
reachable-time = 0

26-14 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

ipv6 neighbor
The ipv6 neighbor command establishes IPv6 static neighbors. The is referred to as a
static arp configuration. The no ipv6 neighbor command removes the static neighbor
association.

Command Mode
Global Configuration

Command Line Usage


ipv6 neighbor <A:B:C:D:E:F:G:H> <H.H.H> {arpa | snap} interface {ethernet
<X/Y>| gigaether <X/Y>}
no ipv6 neighbor <A:B:C:D:E:F:G:H>

Command Syntax

A:B:C:D:E:F:G:H the IPv6 address of the ARP entry associated


with the local data link address
H.H.H the 48-bit local data link address (MAC
address) in the format xxxx.xxxx.xxxx
arpa standard Ethernet-style ARP (RFC 826)
snap IEEE 802.3 usage of ARP packets
conforming to RFC 1042
interface the IPv6 interface
ethernet X/Y the Ethernet interface slot and port number
gigaether X/Y the Gigabit Ethernet interface slot and port
number

Compass ID: 327594480 Version 3 26-15


BSR 64000 Command Reference Guide Release 5.2.1

ipv6 range
IPv4-mapped addresses are used by an IPv6 host to communicate with an IPv4 host.
The IPv6 host addresses the packet to the mapped address.
The ipv6 range command establishes IPv6 to IPv4 address mapping. The no ipv6
range command removes the mapping association.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ipv6 range <A:B:C:D:E:F:G:H/1-128> mapto <A.B.C.D>
no ipv6 range <A:B:C:D:E:F:G:H/1-128> mapto <A.B.C.D>

Command Syntax

A:B:C:D:E:F:G:H/ the IPv6 address/Prefix Length to be mapped


1-128 to an IPv4 address
mapto translate the above IPv6 address/Prefix
Length into an IPv4 address
A.B.C.D map to this IPv4 address

26-16 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

ipv6 redirects
The ipv6 redirects command enables the processing of "Host Redirect" messages. If
enabled, the BSR will send an ICMPv6 “Host Redirect” packet to the originating IPv6
source when:
■ The interface the packet is received on is the same as the outgoing interface.
■ The source subnet is on the same subnet as the next-hop address.
■ Both the source and destination IP addresses of the packet are within a logical
IPv6 subnet.
The no ipv6 redirects command disables the sending of "Host Redirect" messages.
When disabled, the BSR will not send an ICMPv6 "Host Redirect" message to the
source.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


ipv6 redirects
no ipv6 redirects

Command Default
Enabled

Compass ID: 327594480 Version 3 26-17


BSR 64000 Command Reference Guide Release 5.2.1

ipv6 route
The ipv6 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 removes a static route.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ipv6 route <A:B:C:D:E:F:G:H/1-128> {<A:B:C:D:E:F:G:H> | <A:B:C:D:E:F:G:H>}
[<1-255>]
no ipv6 route <A:B:C:D:E:F:G:H/1-128> [<A:B:C:D:E:F:G:H> |
<A:B:C:D:E:F:G:H>] [<1-255>]

Command Syntax

A:B:C:D:E:F:G:H/ IP address of the destination network


1-128
A:B:C:D:E:F:G:H the Link-local IPv6 address
A:B:C:D:E:F:G:H IP address of the forwarding router
1-255 administrative distance

Command Default
Administrative distance = 1

26-18 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

ipv6 unicast-routing
The ipv6 unicast-routing command enables the forwarding of IPv6 unicast
datagrams. The no ipv6 unicast-routing command disables the forwarding of IPv6
unicast datagrams.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


ipv6 unicast-routing
no ipv6 unicast-routing

Command Default
Enabled

Compass ID: 327594480 Version 3 26-19


BSR 64000 Command Reference Guide Release 5.2.1

ping6
The Packet Internet Groper (PING) ping6 command sends an Internet Control
Message Protocol (ICMPv6) echo request to a remote host which replies with an
ICMPv6 echo reply.
Use the ping6 command to verify network routing and 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.

ICMPv6 is used to report problems with delivery of IPv6 datagrams within an


IPv6 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
All modes except User EXEC

Command Line Usage


ping6 {<A:B:C:D:E:F:G:H> | <A:B:C:D:E:F:G:H>}

Command Syntax

A:B:C:D:E:F:G:H the destination IPv6 address


A:B:C:D:E:F:G:H the Link-local IPv6 address

26-20 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

service ipv6 cpe-forwarding enable


The service ipv6 cpe-forwarding enable command enables IPv6 CPE forwarding.
The no service ipv6 cpe-forwarding enable command disables IPv6 CPE
forwarding.

Group Access
System Administrator

Command Mode
Global Configuration

Command Line Usage


service ipv6 cpe-forwarding enable
no service ipv6 cpe-forwarding enable

Command Default
Disabled

Compass ID: 327594480 Version 3 26-21


BSR 64000 Command Reference Guide Release 5.2.1

show ipv6 dhcp


The show ipv6 dhcp command displays DHCP messages sent and received for all
slots on the BSR. The following is an example of typical screen output from the show
ipv6 dhcp command:

DHCP IPv6 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 ipv6 dhcp [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ipv6 dhcp [ | {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

26-22 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

count count the number of outputted lines


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

Compass ID: 327594480 Version 3 26-23


BSR 64000 Command Reference Guide Release 5.2.1

show ipv6 interface


The show ipv6 interface command displays the status, statistical information, and
configuration for the network interfaces. The show ipv6 interface command without
any command arguments displays status, statistical information, and configuration for
all interfaces configured for IPv6. The following is an example of typical screen
output from the show ipv6 interface command:

26-24 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

ethernet 15/6 is up, line protocol is up


IPv6 is enabled, link-local address is FE80::230:B8FF:FEC1:D6F6 [UP]
Primary address:
2000:300::18, subnet is 2000:300::/64 [UP]
Joined Group address(es):
FF02::1
FF02::2
FF02::1:2
FF02::1:FF00:18
FF02::1:FFC1:D6F6
FF05::1:3
MTU 1500 bytes
ICMP redirects are enabled
ND DAD is enabled, number of DAD attempts: 3
ND reachable time is 0 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised retransmit interval is 1000 milliseconds
ND router advertisements are sent every 200000 milliseconds
ND router advertisements live for 0 milliseconds
loopback 2 is up, line protocol is up
IPv6 is enabled, link-local address is FE80::230:B8FF:FEC1:D600 [UP]
Primary address:
2001:900:101::1, subnet is 2001:900:101::/64 [UP]
Joined Group address(es):
FF02::1
FF02::1:2
FF02::1:FF00:1
FF02::1:FFC1:D600
MTU 1514 bytes
IPv6 helper address(es):
Cable IPv6 cable-modem helper address(es):
2000:300::2 cable-modem
ICMP redirects are disabled
Secondary address(es):
2001:900:102::1, subnet is 2001:900:102::/64 [UP]
cable 0/0 is up, line protocol is up
IPv6 is enabled, link-local address is FE80::230:B8FF:FEC1:D600 [UP]
cable 0/1 is administratively down, line protocol is down
IPv6 is enabled, link-local address is FE80::230:B8FF:FEC1:D601 [TEN]
bl 2/0 i d i i t ti l d li t l i d

Compass ID: 327594480 Version 3 26-25


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ipv6 interface [cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> | loopback
<1-255>] [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show ipv6 interface [cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> | loopback
<1-255>] [ | {count | count-only}]

Command Syntax

cable X/Y the cable interface slot and MAC


domain number
ethernet X/Y the Ethernet interface slot and port
number
gigaether X/Y the Gigabit Ethernet interface slot
and port number
loopback 1-255 the 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

26-26 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

show ipv6 interface brief


The show ipv6 interface brief command provides a summary of IPv6 status and
configuration. The following is an example of typical screen output from the show
ipv6 interface brief command:

ethernet 15/6 [up/up]


FE80::230:B8FF:FEC1:D6F6 [UP]
2000:300::18 [UP]
loopback 2 [up/up]
FE80::230:B8FF:FEC1:D600 [UP]
2001:900:101::1 [UP]
2001:900:102::1 [UP]
cable 0/0 [up/up]
FE80::230:B8FF:FEC1:D600 [UP]
cable 0/1 [up/down]
FE80::230:B8FF:FEC1:D601 [TEN]
cable 2/0 [up/down]
FE80::230:B8FF:FEC1:D620 [TEN]
cable 2/1 [up/down]
FE80::230:B8FF:FEC1:D621 [TEN]
cable 4/0 [up/down]
FE80::230:B8FF:FEC1:D640 [TEN]
cable 4/1 [up/down]
FE80::230:B8FF:FEC1:D641 [TEN]

Group Access
All

Command Mode
All modes except User EXEC

Compass ID: 327594480 Version 3 26-27


BSR 64000 Command Reference Guide Release 5.2.1

Command Line Usage


show ipv6 interface brief [ cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> |
loopback <1-255>] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ipv6 interface brief [ cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> |
loopback <1-255>] [ | {count | count-only}]

Command Syntax

cable X/Y the cable interface slot and MAC


domain number
ethernet X/Y the Ethernet interface slot and port
number
gigaether X/Y the Gigabit Ethernet interface slot
and port number
loopback 1-255 the 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

26-28 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

show ipv6 neighbor


The show ipv6 neighbor command displays IPv6 neighbor information. The
following is an example of typical screen output from the show ipv6 neighbor
command:

IPv6 Address Age Link-layer Addr State Interface

2001:0DB8:0:4::2 0 0003.a0d6.141e REACH Ethernet2

FE80::XXXX:A0FF:FED6:141E 0 0003.a0d6.141e REACH Ethernet2

2001:0DB8:1::45a - 0002.7d1a.9472 REACH Ethernet2

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ipv6 neighbor [<A:B:C:D:E:F:G:H> | cable <X/Y> | ethernet <X/Y> |
gigaether <X/Y> | loopback <1-255>] [ | {begin | exclude | include} {<WORD>} [ |
{count | count-only}]]
show ipv6 neighbor [ <A:B:C:D:E:F:G:H> | cable <X/Y> | ethernet <X/Y> |
gigaether <X/Y> | loopback <1-255>] [ | {count | count-only}]

Command Syntax

A:B:C:D:E:F:G:H the IPv6 Address of the neighbor


entry
cable X/Y the cable interface slot and MAC
domain number
ethernet X/Y the Ethernet interface slot and port
number

Compass ID: 327594480 Version 3 26-29


BSR 64000 Command Reference Guide Release 5.2.1

gigaether X/Y the Gigabit Ethernet interface slot


and port number
loopback 1-255 the 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

26-30 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

show ipv6 route


The show ipv6 route command displays active entries in the IPv6 routing table. The
following is typical screen output from the show ipv6 route command:

IPv6 Routing Table

Codes: C - Connected, L - Local, S - Static

IPv6 Routing Table - Total number of routes 3

C 2000:300::/64 [0/0]
via 2000:300::18, ethernet 15/6
C 2001:900:101::/64 [0/0]
via 2001:900:101::1, loopback 2
C 2001:900:102::/64 [0/0]
via 2001:900:102::1, loopback 2

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ipv6 route [ <A:B:C:D:E:F:G:H> | <A:B:C:D:E:F:G:H/ 1-128 > | connected |
static | summary] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ipv6 route [ <A:B:C:D:E:F:G:H> | <A:B:C:D:E:F:G:H/ 1-128 > | connected |
static | summary] [ | {count | count-only}]

Compass ID: 327594480 Version 3 26-31


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

A:B:C:D:E:F:G:H the destination IPv6 Address


A:B:C:D:E:F:G:H/ 1-128 the IPv6 address/Prefix Length
connected displays connected routes
static displays static routes
summary displays a summary of routes in the
IPv6 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

26-32 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

show ipv6 traffic


The show ipv6 traffic command displays IPv6, ICMPv6, UDPv6, and DHCPv6
statistics. The following is an example of typical screen output from the show ipv6
traffic command:

Compass ID: 327594480 Version 3 26-33


BSR 64000 Command Reference Guide Release 5.2.1

IPv6 statistics:
Rcvd: 1139 input, 600 local destination
0 source-routed, 0 truncated
0 format errors, 0 hop count exceeded
0 bad header, 0 unknown option, 0 bad source
0 unknown protocol, 0 not a router
0 fragments, 0 total reassembled
0 reassembly timeouts, 0 reassembly failures
0 unicast RPF drop, 0 suppressed RPF drop
0 not a member, 0 bad scope
0 too short, 0 too small
0 fragments dropped, 0 fragments overflow
0 bad version, 0 nobuffer drop, 0 too big
Sent: 170 generated, 0 forwarded
0 fragmented into, 0 fragments, 0 failed
0 encapsulation failed, 0 no route, 0 too big
Mcast: 1100 received, 261 sent

ICMPv6 statistics:
Rcvd: 561 input, 0 checksum errors, 0 too short
0 unknown info type, 0 unknown error type
unreach: 0 routing, 0 admin, 0 neighbor, 0 address, 0 po
parameter: 0 error, 0 header, 0 option
0 hopcount expired, 0 reassembly timeout,0 too big
0 echo request, 0 echo reply
0 group query, 0 group report, 0 group reduce
0 router solicit, 553 router advert, 0 redirects
0 neighbor solicit, 0 neighbor advert
Sent: 131 output, 0 rate
unreach: 0 routing, 0 admin, 0 neighbor, 0 address, 0 po
parameter: 0 error, 0 header, 0 option
0 hopcount expired, 0 reassembly timeout,0 too big
0 echo request, 0 echo reply
0 group query, 0 group report, 0 group reduce
0 router solicit, 119 router advert, 0 redirects
12 neighbor solicit, 0 neighbor advert

UDPv6 statistics:
Rcvd: 39 input, 0 checksum errors, 0 length errors
0 no port, 0 dropped
Sent: 39 output

26-34 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ipv6 traffic [detail ] [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show ipv6 traffic [detail ] [ | {count | count-only}]

Command Syntax

detail display detailed statistics


| 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: 327594480 Version 3 26-35


BSR 64000 Command Reference Guide Release 5.2.1

traceroute6
The traceroute6 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 number 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 traceroute6 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


traceroute6 {<A:B:C:D:E:F:G:H > | options <WORD> {<A:B:C:D:E:F:G:H >}}
[source <A:B:C:D:E:F:G:H >] [timeout <1-1024>] [nprobes <1-1024>] [maxhops
<2-1024>] [port <0-65535>]

26-36 Compass ID: 327594480 Version 3


Release 5.2.1 IPv6 Commands

Command Syntax

A:B:C:D:E:F:G:H the destination IPv6 address


WORD any combination of d, l, n, r, or v
d = SO_DEBUG
l = hostnames and addresses
n = addresses
r = SO_DONTROUTE
v = verbose
source the IPv6 address of the source interface
A:B:C:D:E:F:G:H
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
maxhops 2-1024 the maximum TTL value - the traceroute6
command terminates when the destination or this
value is reached
port 0-65535 the destination port used by the UDP probe
messages

Command Defaults
timeout = 3 seconds
nprobes = 3
maxhops = 64
port = 32868

Compass ID: 327594480 Version 3 26-37


27
IS-IS Commands

Introduction
This chapter describes the integrated Intermediate System to Intermediate System
(IS-IS) commands. The Intermediate System to Intermediate System (IS-IS) is a link
state based intra-domain routing protocol used to build a complete and consistent
picture of a network’s topology by sharing link state information across all network
Intermediate System (IS) devices. IS-IS is based on an SPF routing algorithm and
shares all the advantages common to other link-state protocols. It also routes both IP
packets and pure OSI packets with no extra encapsulation by design. IS-IS supports
type of service (TOS) identifiers, IP subnetting, variable subnet masks, external
routing, and authentication.

IS-IS Command Descriptions


This section contains an alphabetized list and descriptions of the IS-IS commands
supported by the BSR.

Compass ID: 327594480 Version 3 27-1


BSR 64000 Command Reference Guide Release 5.2.1

area-password
The area-password command is used to configure an IS-IS area authentication
password for an area.The area authentication password is inserted in Level 1 (station
router level) LSPs, CSNPs, and Partial Sequence Number PDUs (PSNPs).

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


area-password <WORD>

Command Syntax

WORD the unencrypted text password, 1-8 characters


in length.

27-2 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

authentication mode
The authentication mode command specifies global IS-IS authentication mode
control. The no authentication mode command disables global IS-IS authentication.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


authentication mode {md5 | text}
no authentication mode {md5 | text}

Command Syntax

md5 MD5 based authentication


text clear text authentication

Command Default
Disabled

Compass ID: 327594480 Version 3 27-3


BSR 64000 Command Reference Guide Release 5.2.1

clear isis
The clear isis command clears the IS-IS database.

Group Access
All

Command Mode
All modes except User EXEC.

Command Line Usage


clear isis *

27-4 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

default-information originate
The BSR must be configured to force a default route into the IS-IS routing domain.
The default-information originate command is used to force a default route into the
IS-IS routing domain.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


default-information originate [route-map <WORD>]

Command Syntax

route-map WORD the route map name - this keyword is not


supported at this time

Compass ID: 327594480 Version 3 27-5


BSR 64000 Command Reference Guide Release 5.2.1

distance
An administrative distance is a rating of the trustworthiness of a routing information
source, such as an individual router or a group of routers. Numerically, an
administrative distance is an integer between 1 and 255. The higher the value, the
lower the trust rating. For example, an administrative distance of 255 means the
routing information source cannot be trusted and should be ignored.
The distance command is used to set the administrative distance for the IS-IS router.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


distance <1-255>

Command Syntax

1-255 the IS-IS routing administrative distance

Command Default
115

27-6 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

domain-password
The routing domain authentication password is inserted in Level 2 (the area router
level) LSP, CSNP, and PSNPs. The domain-password command is used to configure
authentication password for an IS-IS routing domain.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


domain-password <WORD>

Command Syntax

WORD the unencrypted text password 1-8 characters


in length

Compass ID: 327594480 Version 3 27-7


BSR 64000 Command Reference Guide Release 5.2.1

hello padding
The hello padding command pads IS-IS hello PDUs to the full MTU. The no hello
padding command disables hello PDU padding.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


hello padding
no hello padding

27-8 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

ignore-lsp-errors
The ignore-lsp-errors command allows the BSR to ignore IS-IS link-state packets
that are received with internal checksum errors rather than deleting the link-state
packets. Link-state packets are used by receiving routers to maintain their routing
tables. The no ignore-lsp-errors command disables this function.
The IS-IS protocol requires that a received link-state packet with an internal
checksum error be deleted by the receiving router. This causes the transmitting router
to resend the packet. If a network has a link that causes data corruption while still
delivering link-state packets with correct checksums, a continuous cycle of deleting
and resending large numbers of packets can occur which may create network
problems.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


ignore-lsp-errors
no ignore-lsp-errors

Command Default
Disabled

Compass ID: 327594480 Version 3 27-9


BSR 64000 Command Reference Guide Release 5.2.1

ip router isis
The ip router isis command is used to enable IS-IS routing on the interface.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


ip router isis
no ip router isis

27-10 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

isis authentication mode


The isis authentication mode command specifies IS-IS authentication mode control
for an interface. The no isis authentication mode command disables IS-IS
authentication for an interface.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis authentication mode {md5 | text }
no isis authentication mode {md5 | text }

Command Syntax

md5 MD5 based authentication


text cleartext authentication

Command Default
Disabled

Compass ID: 327594480 Version 3 27-11


BSR 64000 Command Reference Guide Release 5.2.1

isis circuit-type
The default IS-IS interface circuit type is for Level 1 and Level 2. The isis
circuit-type command is used to select the IS-IS interface circuit type of adjacency
desired for neighbors on the BSR interface (IS-IS interface circuit type).

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis circuit-type [level-1 | level-1-2 | level-2-only]
no isis circuit-type [level-1 | level-1-2 | level-2-only]

Command Syntax

level-1 indicates that a Level 1 adjacency may be


established if there is at least one area address
in common between this system and its
neighbors
level-1-2 indicates that a Level 1 and 2 adjacency is
established if the neighbor is also configured
as level-1-2 and there is at least one area in
common. If there is no area in common, a
Level 2 adjacency is established
level-2-only indicates that a Level 2 adjacency is
established only if the neighbor is configured
exclusively to be a Level 2 router

27-12 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

isis csnp-interval
Complete Sequence Number PDUs (CSNPs) hold a complete list of all LSPs in the
IS-IS routing database. CSNPs are sent periodically on all links, and the receiving
systems use the information in the CSNP to update and synchronize their LSP
databases. The designated router multicasts CSNPs on broadcast links in place of
sending explicit acknowledgments for each LSP.
By default, IS-IS sends CSN packets periodically. If the BSR is the designated router
on a LAN, IS-IS sends CSN packets every 10 seconds. Depending on your network
topology you may want to modify the default interval to protect against LSP flooding.
The isis csnp-interval command is used to adjust the IS-IS CSNP interval for Intranet
connections if the Intranet is a part of a multiaccess meshed network on the interface.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis csnp-interval <1-65535> [level-1 | level-2]
no isis csnp-interval [level-1 | level-2]

Command Syntax

1-65535 the IS-IS CSNP interval in seconds


level-1 indicates that the interface is a Level 1 IS-IS
interface
level-2 indicates that the interface is a Level 2 IS-IS
interface

Compass ID: 327594480 Version 3 27-13


BSR 64000 Command Reference Guide Release 5.2.1

isis hello padding


The isis hello padding command pads IS-IS hello PDUs to the full MTU on an IS-IS
enabled interface. The no isis hello padding command disables hello PDU padding
on an IS-IS enabled interface.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis hello padding

27-14 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

isis hello-interval
IS-IS hello packets are broadcast to discover the identity of neighboring IS-IS systems
and to determine whether the neighbors are Level 1 or Level 2 intermediate systems.
The hello-interval is the amount of time between sending hello packets. The hello
interval can be configured independently for Level 1 and Level 2. The isis
hello-interval command is used to specify the length of time between hello packets
that the BSR sends on either the Level 1 or Level 2 IS-IS router interface.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis hello-interval <1-65535> [level-1 | level-2]
no isis hello-interval [level-1 | level-2]

Command Syntax

1-65535 the ISIS hello interval in seconds


level-1 Level 1 IS-IS routing
level-2 Level 2 IS-IS routing

Compass ID: 327594480 Version 3 27-15


BSR 64000 Command Reference Guide Release 5.2.1

isis hello-multiplier
The isis hello-multiplier command is used to specify the number of Intermediate
System-to-Intermediate System (IS-IS) hello packets a neighbor can miss before the
BSR determines the adjacency between the BSR interface and the neighbor is down.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis hello-multiplier <3-1000> [level-1 | level-2]
no isis hello-multiplier [level-1 | level-2]

Command Syntax

3-1000 the number of missing hello packets


level-1 Level 1 IS-IS routing
level-2 Level 2 IS-IS routing

27-16 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

isis lsp-interval
IS-IS Link-state PDUs (LSPs) contain information about the state of adjacencies to
neighboring IS-IS systems. LSPs are flooded periodically throughout an area.
The isis lsp-interval command configures the time delay between successive link
state packet (LSP) transmissions.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis lsp-interval <1-65535>
no isis lsp-interval

Command Syntax

1-65535 the time delay between successive LSPs in


milliseconds

Command Default
33 milliseconds

Compass ID: 327594480 Version 3 27-17


BSR 64000 Command Reference Guide Release 5.2.1

isis message-digest-key
The isis message-digest-key md5 command is used to configure a Message Digest 5
(MD5) Authentication key for an IS-IS interface. The no isis message-digest-key
md5 command disables MD5 auhentication for an IS-IS interface.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis message-digest-key <1-255> md5 {7 <password> | <password>} [level-1 |
level-2 ]
no isis message-digest-key <1-255> [level-1 | level-2 ]

Command Syntax

1-255 the range of numbers from which an MD5


secret Key ID can be selected
7 <password> specifies a hidden (encrypted) MD5 password
between 18-50 characters
password specifies an MD5 cleartext password between
1-16 characters
level-1 configure MD5 for Level 1 IS-IS routing
level-2 configure MD5 for Level 2 IS-IS routing

27-18 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

isis metric
You can configure a cost for a specified interface. A cost is an arbitrary routing metric
value assigned for crossing or intersecting networks. This metric can be applied to
both Level 1 and/or Level 2 routing.
The isis metric command is used to configure the metric cost for the specified IS-IS
interface. The no isis metric command disables the metric cost for the specified IS-IS
interface.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis metric {<0-63> | <0-16777214>} [level-1 | level-2]
no isis metric [level-1 | level-2]

Command Syntax

0-63 the assigned narrow metric style value for the


interface - metric styles are specified with the
metric-style command
0-16777214 the assigned wide metric style value for the
interface - metric styles are specified with the
metric-style command
level-1 configure a cost for Level 1 IS-IS routing
level-2 configure a cost for Level 2 IS-IS routing

Command Default
Disabled

Compass ID: 327594480 Version 3 27-19


BSR 64000 Command Reference Guide Release 5.2.1

isis network point-to-point


The isis network point-to-point command enables IS-IS point-to-point operations
over broadcast media interfaces. The no isis network point-to-point command
disables IS-IS point-to-point operations over broadcast media interfaces.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis network point-to-point
no isis network point-to-point

Command Default
Disabled

27-20 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

isis password
You can assign different passwords for the different IS-IS routing levels. Specifying
Level 1 or Level 2 configures the password for only Level 1 or Level 2 routing,
respectively. By default, password authentication is disabled.
The isis password command is used to configure the authentication password for
hello packets on the specified interface. The no isis password command removes the
password.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis password <WORD> [level-1 | level-2]
no isis password [<WORD>] [level-1 | level-2]

Command Syntax

WORD the unencrypted cleartext password 1-8


characters in length.
level-1 configure a password for Level 1 IS-IS
routing
level-2 configure a password for Level 2 IS-IS
routing

Command Default
Disabled

Compass ID: 327594480 Version 3 27-21


BSR 64000 Command Reference Guide Release 5.2.1

isis priority
A BSR uses hello packets to advertise its priority to become a designated router. IS-IS
uses the advertised priorities on all multiaccess networks to elect a designated router
for the network. This router is responsible for sending network LSP advertisements,
which describe all the routers attached to the network. These advertisements are
flooded throughout a single area. The priority value is meaningful only on a
multiaccess network. A router’s priority for becoming the designated router is
indicated by an arbitrary number. Routers with a higher value are more likely to
become the designated router.
The isis priority command is used to select the designated router priority. The no isis
priority command restores the default priority value.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis priority <0-127> [level-1 | level-2]
no isis priority [level-1 | level-2]

Command Syntax

0-127 a number that assigns a priority value to the


designated router.
level-1 designate a priority for Level 1 IS-IS routing
level-2 designate a priority for Level 2 IS-IS routing

Command Default
32

27-22 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

isis retransmit-interval

Note: The isis retransmit-interval command is not valid on the BSR as


IS-IS point-to-point links are not supported.

When LSPs are dropped, LSPs are retransmitted. The isis retransmit-interval
command is used to set the number of seconds between retransmission of the same
LSP. The no isis retransmit-interval command disables the retransmission of LSPs.

Note: The number of seconds should be greater than the expected round-trip
delay between any two routers on the attached network. Set this parameter
conservatively to avoid unnecessary retransmission. Increase the number of
seconds for networks that have serial lines and virtual links.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis retransmit-interval <1-65535>
no isis retransmit-interval

Command Syntax

1-65535 the number of seconds between


retransmission of the same LSP

Command Default
5 seconds
Disabled

Compass ID: 327594480 Version 3 27-23


BSR 64000 Command Reference Guide Release 5.2.1

isis retransmit-throttle-interval

Note: The isis retransmit-throttle-interval command is not valid on the


BSR as IS-IS point-to-point links are not supported.

The isis retransmit-throttle-interval command to configure the amount of time


between any LSP retransmissions.

Group Access
ISP

Command Mode
Interface Configuration (not supported for cable interfaces)

Command Line Usage


isis retransmit-throttle-interval <1-65535>
no isis retransmit-throttle-interval

Command Syntax

1-65535 the minimum delay in milliseconds between


LSP retransmissions on the interface

Command Default
33 milliseconds

27-24 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

is-type
The is-type command is used to specify that the BSR acts as a Level 1 (intra-area)
router, as both a Level 1 router and a Level 2 (inter-area) router, or as a Level-2 router
only. The no is-type command disables the IS-IS type.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


is-type {level-1 | level-1-2 | level-2-only}
no is-type

Command Syntax

level-1 indicates a Level 1 IS-IS router


level-1-2 indicates a Level 1 and Level 2 IS-IS router
level-2-only indicates a Level 2 IS-IS router

Command Default
Disabled

Compass ID: 327594480 Version 3 27-25


BSR 64000 Command Reference Guide Release 5.2.1

log-adjacency-changes
The log-adjacency-changes command logs adjacency changes with neighboring
Intermediate Systems without having to use a debug command.The command logs
Level-1 and Level-2 Intermediate System to Intermediate System Hellos (IIH). IIHs
are used for establishing L1/L2 adjacencies with other Intermediate Systems.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


log-adjacency-changes [all]
no log-adjacency-changes [all]

Command Syntax

all Log adjacency changes generated by non-IIH


events.

Command Default
Disabled

27-26 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

lsp-gen-interval
The lsp-gen-interval command specifies the minimum interval between regenerating
the same LSP. The no lsp-gen-interval command disables regenerating the same LSP.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


lsp-gen-interval <1-120>
no lsp-gen-interval

Command Syntax

1-120 the minimum LSP regeneration interval in


seconds

Command Default
Disabled

Compass ID: 327594480 Version 3 27-27


BSR 64000 Command Reference Guide Release 5.2.1

lsp-refresh-interval
The lsp-refresh-interval command specifies the LSP refresh interval. The no
lsp-refresh-interval command disables LSP refresh.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


lsp-refresh-interval <1-65234>
no lsp-refresh-interval

Command Syntax

1-65234 the LSP refresh interval in seconds

Command Default
900 seconds

27-28 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

max-lsp-lifetime
The max-lsp-lifetime command specifies the maximum LSP lifetime value. The no
max-lsp-lifetime command disables maximum LSP lifetime.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


max-lsp-lifetime <301-65535>
no max-lsp-lifetime

Command Syntax

301-65535 the maximum LSP lifetime in seconds

Command Default
Disabled

Compass ID: 327594480 Version 3 27-29


BSR 64000 Command Reference Guide Release 5.2.1

maximum-paths
The maximum-paths command specifies the maximum number of parallel routes an
IP routing protocol can support. The no maximum-paths command cancels the
number of maximum paths.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


maximum-paths <1-3>
no maximum-paths

Command Syntax

1-3 the maximum number of parallel routes

27-30 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

message-digest-key md5
The message-digest-key md5 command is used to configure a global Message Digest
5 (MD5) Authentication key for IS-IS. The no message-digest-key md5 command
disables global MD5 authentication for IS-IS.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


message-digest-key <1-255> md5 {7 <password> | <password>} [level-1 | level-2 ]
no message-digest-key <1-255> [level-1 | level-2 ]

Command Syntax

1-255 the range of numbers from which an MD5


secret Key ID can be selected
7 <password> specifies a hidden (encrypted) MD5 password
between 18-50 characters
password specifies an MD5 cleartext password between
1-16 characters
level-1 configure MD5 for Level 1 IS-IS routing
level-2 configure MD5 for Level 2 IS-IS routing

Compass ID: 327594480 Version 3 27-31


BSR 64000 Command Reference Guide Release 5.2.1

metric-style
The metric-style command specifies the metric style to be used with IS-IS.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


metric-style {narrow} {transition [ level-1 | level-2] } {wide [ level-1 | level-2 |
transition] }
no metric-style [narrow] [transition [ level-1 | level-2] ] [wide [ level-1 | level-2 |
transition] ]

Command Syntax

narrow use the old style of TLVs with narrow metric


transition send and accept both styles of TLVs during
transition
wide use the new style of TLVs to carry a wider
metric
level-1 set the metric style for Level 1 IS-IS routing
level-2 set the metric style for Level 2 IS-IS routing
wide transition send the new style of TLVs to carry a wider
metric and accept both styles of TLVs in
return

27-32 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

net
The net command is used to define a Network Entity Title (NET) for the area address
and the system ID of an IS-IS router. Most end systems and intermediate systems have
one NET. Intermediate systems that participate in multiple areas can have multiple
NETs. A user can configure 3 net commands.
The following example configures IS-IS for IP routing, with an area ID of 01.0001
and a system ID of 0000.0000.0002.00:
MOT(config-isis)#net 01.0001.0000.0000.0002.00
The following criteria is used to interpret the IS-IS NET address format:
■ The first portion of the NET address is the area number, which is a variable
number from 1 through 13 bytes. The first byte of the area number (01) is the
authority and format indicator (AFI). The next bytes are the assigned domain
(area) identifier, which can be from 0 through 12 bytes. In the example above, the
area identifier is 0001.
■ The next six bytes form the system identifier (SYSID). The SYSID can be any six
bytes that are unique throughout the entire domain. The system identifier
commonly is either the Media Access Control (MAC) address or the IP address
expressed in binary-coded decimal (BCD).
■ The last byte (00) is the n-selector.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


net <XX.XXXX.XXXX. ... .XXXX.XX>
no net <XX.XXXX.XXXX. ... .XXXX.XX>

Command Syntax

XX.XXXX.XXXX. ... .XXXX.XX is the IS-IS area ID and system ID for an


IS-IS router

Compass ID: 327594480 Version 3 27-33


BSR 64000 Command Reference Guide Release 5.2.1

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
IS-IS Router Configuration

Command Line Usage


passive-interface {cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> | loopback
<1-255>}
no passive-interface {cable <X/Y> | ethernet <X/Y> | gigaether <X/Y> | loopback
<1-255>}

Command Syntax

cable X/Y the cable interface slot and MAC domain


number
ethernet X/Y the Ethernet interface slot and port number
gigaether X/Y the Gigabit Ethernet interface slot and port
number
loopback 1-255 the loopback interface number

Command Default
Enabled

27-34 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

redistribute
You can advertise networks by redistributing routes learned from one routing protocol
into another. The redistribute command is used to redistribute a BGP, OSPF, RIP, or
static route into the IS-IS routing process.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


redistribute {bgp | connected | ospf | rip | static} [level-1 | level-1-2 | level-2 ]
[metric <1-16777215>] [metric-type {1 | 2}] [route-map <WORD>]
no redistribute {bgp | connected | ospf | rip | static}

Command Syntax

bgp indicates a BGP route


connected indicates a connected route
ospf indicates an OSPF route
rip indicates a RIP route
static indicates a static route
level-1 specifies that IS-IS Level 1 routes are
redistributed independently
level-1-2 specifies that IS-IS Level 1 and Level 2 routes
are redistributed independently
level-2 specifies that IS-IS Level 2 routes are
redistributed independently
metric 0-63 the assigned narrow metric style value for the
interface - metric styles are specified with the
metric-style command

Compass ID: 327594480 Version 3 27-35


BSR 64000 Command Reference Guide Release 5.2.1

metric 0-16777214 the assigned wide metric style value for the
interface - metric styles are specified with the
metric-style command
metric-type IS-IS exterior metric type for redistributed
routes
route-map WORD the name of the route-map used to
conditionally control the route redistribution

27-36 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

router isis
The router isis command enables IS-IS routing, specifies an IS-IS process for IP
communication and enters IS-IS router configuration mode.

Group Access
ISP

Command Mode
Global Configuration

Command Line Usage


router isis [<WORD>]

Command Syntax

WORD the name for the routing process - if a tag is


not specified, a null tag is assumed

Compass ID: 327594480 Version 3 27-37


BSR 64000 Command Reference Guide Release 5.2.1

set-overload-bit
The LSP overload bit is enabled for the IS-IS routing process to ensure that no paths
through the BSR are seen by other routers in the IS-IS area when the Link State
routing table on the BSR is incomplete or inaccurate. However, IP and CLNS prefixes
directly connected to the BSR continue to be reachable.
Use the set-overload-bit command to allow other routers on the network to ignore
IS-IS routing problems on the BSR in their SPF calculations until the IS-IS routing
process on the BSR has recovered. The no set-overload-bit command disables the
overload bit.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


set-overload-bit
no set-overload-bit

Command Default
Disabled

27-38 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

show clns interface


The show clns interface command displays the CLNS interface status and
configuration. The following is an example of typical screen output from the show
clns interface command:

ethernet 7/0 is up,line protocol is up


CLNS protocol processing is disabled
loopback 1 is up,line protocol is up
CLNS protocol processing is disabled
loopback 2 is up,line protocol is up
CLNS protocol processing is disabled
loopback 3 is up,line protocol is up
CLNS protocol processing is disabled
loopback 5 is up,line protocol is up
CLNS protocol processing is disabled
loopback 6 is up,line protocol is up
CLNS protocol processing is disabled
ethernet 2/3 is up,line protocol is up
CLNS protocol processing is enabled
Checksums enabled, MTU 1500
Next Esh/Ish is 1 seconds
Routing Protocol: IS-IS
Circuit Type:level-1
Level-1 Metric:18 Priority: 32 Circuit ID:0011.0011.0016
Number of active level-1 adjacencies:1
Next IS-IS LAN Level-1 Hello in 7 seconds
ethernet 2/4 is up,line protocol is up
CLNS protocol processing is enabled
Checksums enabled, MTU 1500
Next Esh/Ish is 1 seconds
Routing Protocol: IS-IS
Circuit Type:level-2 only
Level-2 Metric:12 Priority: 32 Circuit ID:0011.0011.0012
Number of active level-2 adjacencies:0
Next IS-IS LAN Level-2 hello in 7 seconds

Compass ID: 327594480 Version 3 27-39


BSR 64000 Command Reference Guide Release 5.2.1

The show clns interface command displays the following information:

interface the specific interface is described in the output and is described


as being up (functional) and the line protocol as being up
(functional) or administratively down
CLNS protocol describes whether or not the CLNS protocol is enabled or
processing disabled
Checksums the checksums can be enabled or disabled
enabled
MTU the maximum transmission unit size for a packet on this
interface
Next Esh/Ish displays when the next IS-IS hello packet is sent on this
interface
Routing Protocol describes the routing protocol on this interface - below this
field, information for Level 1 and/or Level 2 is displayed
Circuit Type indicates whether the interface has been configured for local
routing (Level 1), area routing, (Level 2), or local and area
routing (Level 1 and 2)
Metric indicates the routing metric assigned to the Level 1 or Level 2
router
Priority indicates the priority of the IS on this interface
Circuit ID indicates the ISIS circuit ID
Number of active indicates the number of active Level 1 adjacencies
level-1 adjacencies
Number of active indicates the number of active Level 2 adjacencies
level-2 adjacencies

Group Access
All

Command Mode
All modes except User EXEC

27-40 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

Command Line Usage


show clns interface [ ethernet <X/Y> | gigaether <X/Y> | loopback <1-255> ] [ |
{begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show clns interface [ ethernet <X/Y> | gigaether <X/Y> | loopback <1-255> ] [ |
{count | count-only}]

Command Syntax

ethernet X/Y the Ethernet interface slot and port


number
gigaether X/Y the Gigabit Ethernet interface slot
and port number
loopback 1-255 the 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: 327594480 Version 3 27-41


BSR 64000 Command Reference Guide Release 5.2.1

show clns is-neighbors


The show clns is-neighbors command displays IS-IS information for IS-IS router
adjacencies. The following is an example of typical screen output from the show clns
is-neighbors command:

System Id Interface State Type Priority Circuit Id


0011.0011.0016 Ethernet2/3 Up L1 64 0011.0011.0016.02

The show clns is-neighbors command displays the following information:

System Id the System ID of the IS-IS router


Interface the interface on which the router was discovered
State the Adjacency state - "Up" and "Init" are the states of the IS-IS
neighbor
Type displays whether the IS-IS router type is Level 1 or Level 2
Priority indicates the routing priority
Circuit Id indicates the IS-IS circuit ID

Group Access
All

Command Mode
All modes except User EXEC

27-42 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

Command Line Usage


show clns is-neighbors [ethernet <X/Y> | gigaether <X/Y> | loopback <1-255>]
[ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show clns is-neighbors [ethernet <X/Y> | gigaether <X/Y> | loopback <1-255>]
[ | {count | count-only}]

Command Syntax

ethernet X/Y the Ethernet interface slot and port


number
gigaether X/Y the Gigabit Ethernet interface slot
and port number
loopback 1-255 the 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: 327594480 Version 3 27-43


BSR 64000 Command Reference Guide Release 5.2.1

show clns neighbors


The show clns neighbors command displays IS-IS neighbor information. The
following is an example of typical screen output from the show clns neighbors
command:

System Id SNPA Interface State Holdtime Type Protocol


0011.0011.0016 0030.942e.ddc1 Ethernet2/3 Up 7 L1 IS-IS

The show clns neighbors command displays the following information:

System ID the System ID of the IS-IS router


SNPA the Subnetwork Point of Attachment, which is the data-link
layer address
Interface the interface from which the system was learned
State the Adjacency state - "Up" and "Init" are the states of the IS
neighbor
Init the system is an IS and is waiting for an IS-IS hello message -
IS-IS regards the neighbor as not adjacent
Up the IS is reachable
Holdtime the number of seconds before this adjacency entry times out
Type the level of the IS-IS router
Protocol the protocol through which the adjacency was learned - valid
protocol source is IS-IS

Group Access
All

Command Mode
All modes except User EXEC

27-44 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

Command Line Usage


show clns neighbors [detail] [ethernet <X/Y> | gigaether <X/Y> | loopback
<1-255>] [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show clns neighbors [detail] [ethernet <X/Y> | gigaether <X/Y> | loopback
<1-255>] [ | {count | count-only}]

Command Syntax

detail displays detailed information


ethernet X/Y the Ethernet interface slot and port
number
gigaether X/Y the Gigabit Ethernet interface slot
and port number
loopback 1-255 the 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: 327594480 Version 3 27-45


BSR 64000 Command Reference Guide Release 5.2.1

show clns protocol


The show clns protocol command displays the protocol-specific information for each
IS-IS routing process in the BSR. The following is an example of typical screen
output from the show clns protocol command:

IS-IS Router:
System Id:0011.0011.0012.00 IS-Type: level-1-2
Manual area address(es):
49
Routing for area address(es):
49
Interfaces supported by IS-IS:
Ethernet2/3 - IP
Ethernet2/4 - IP
Distance:115
Generate narrow metrics: level-1-2
Accept narrow metrics: level-1-2
Generate wide metrics: none
Accept wide metrics: none

The show clns protocol command displays the following information:

IS-IS Router indicates that the IS-IS protocol is enabled on the BSR
System Id the Identification value of the system
IS-Type: indicates the IS-IS routing level (Level 1, Level 2 or both)
is enabled on the router
Manual area the area addresses that have been configured
address(es):
Routing for area the manually configured and learned area addresses
address(es):

27-46 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

Interfaces supported by the interfaces on the BSR that have IS-IS configured
IS-IS:
Distance: the configured IS-IS administrative routing distance

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show clns protocol [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show clns protocol [ | {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: 327594480 Version 3 27-47


BSR 64000 Command Reference Guide Release 5.2.1

show clns traffic


The show clns traffic command lists the CLNS packets that the BSR has processed.
The following is an example of typical screen output from the show clns traffic
command:

IS-IS: Corrupted LSPs: 0


IS-IS: L1 LSP Database Overloads: 0
IS-IS: L2 LSP Database Overloads: 0
IS-IS: Area Addresses Dropped: 0
IS-IS: Attempts to Exceed Max Seq: 0
IS-IS: Sequence Numbers Skipped: 0
IS-IS: Own LSPs Purges: 0
IS-IS: System ID Length Mismatches: 0
IS-IS: Maximum Area Mismatches: 0
IS-IS: Level-1 Hellos(sent/rcvd): 17153/65132
IS-IS: Level-2 Hellos(sent/rcvd): 17171/0
IS-IS: PTP Hellos(sent/rcvd): 0/0
IS-IS: Level-1 LSPs(sent/rcvd): 3564/10879
IS-IS: Level-2 LSPs(sent/rcvd): 0/0
IS-IS: Level-1 CSNP(sent/rcvd): 0/16273
IS-IS: Level-2 CSNP(sent/rcvd): 0/0
IS-IS: Level-1 PSNP(sent/rcvd): 6/0
IS-IS: Level-2 PSNP(sent/rcvd): 0/0
IS-IS: Level-1 SPF Calculations: 3596
IS-IS: Level-2 SPF Calculations: 3802
IS-IS: Tot IS-Task Recvd pkts: 92284
IS-IS: Packets (sent/recvd): 37894/92284
IS-IS: Mux Level Isis Pkts recvd: 92284
IS-IS: Total xmit failed: 0

The show clns traffic command displays the following information:

Corrupted LSPs the number of corrupted LSPs recorded on BSR


L1 LSP the number of times that the Level 1 LSP database has
Database overloaded
Overloads

27-48 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

L2 LSP the number of times that the Level 2 LSP database has
Database overloaded
Overloads
Area Addresses the number of area addresses dropped by the BSR
Dropped
Attempts to the maximum sequence number is 232 -1 - the number of times the
Exceed Max BSR reaches that number when the generating new LSPs
Sequence
Own LSPs the number of LSPs received which have the same system ID as
Purges the BSR
System ID the number of IS-IS packets received which have an ID length
Length other than 6
Mismatches
Maximum Area the number of IS-IS packets received which have a maximum
Mismatches area number greater than 3
Level-1 Hellos the number of Level 1 IS-IS hello packets sent and received
(sent/rcvd)
Level-2 Hellos the number of Level 2 IS-IS hello packets sent and received
(sent/rcvd)
Level-1 LSPs the number of Level 1 link-state PDUs sent and received
(sent/rcvd)
Level-2 LSPs the number of Level 2 link-state PDUs sent and received
(sent/rcvd)
Level-1 CSNP the number of Level 1 CSNPs sent and received
(sent/rcvd)
Level-2 CSNP the number of Level 2 CSNPs sent and received
(sent/rcvd)
Level-1 PSNPs the number of Level 1 PSNPs sent and received
(sent/rcvd)
Level-2 PSNPs the number of Level 2 PSNPs sent and received
(sent/rcvd)

Compass ID: 327594480 Version 3 27-49


BSR 64000 Command Reference Guide Release 5.2.1

Level-1 SPF the number of times a Level 1 shortest -path-first (SPF) tree was
Calculations computed
Level-2 SPF the number of times a Level 2 SPF tree was computed
Calculations

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show clns traffic [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show clns 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

27-50 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

show ip redistribute
The show ip redistribute command displays which routing processes are being
redistributed to other routing domains. The following is an example of typical screen
output from the show ip redistribute command:

To isis in ipv4
redistribute ospf match internal match external 1 match external 2 route-map OSPF
redistribute connected level-1
redistribute static

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show ip redistribute [ bgp | isis | ospf | rip ] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show ip redistribute [ bgp | isis | ospf | rip ] [ | {count | count-only}]

Command Syntax

bgp displays only the routing domains


redistributed into BGP
isis displays only the routing domains
redistributed into ISIS
ospf displays only the routing domains
redistributed into OSPF
rip displays only the routing domains
redistributed into RIP

Compass ID: 327594480 Version 3 27-51


BSR 64000 Command Reference Guide Release 5.2.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

27-52 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

show isis database


The show isis database command is used to display all or specific IS-IS database
information. The following is an example of typical screen output from the show isis
database command:

IS-IS Level-1 Link State Database


LSPID LSP Seq Num LSP Checksum LSP Holdtime ATT/P/OL
0011.0011.0005.00-00 0x0000001B 0xD0C2 370 0/0/0
0011.0011.0005.03-00 0x0000000B 0x08BF 380 0/0/0
0011.0011.0012.00-00 * 0x00000014 0x6D7E 329 0/0/0

IS-IS Level-2 Link State Database


LSPID LSP Seq Num LSP Checksum LSP Holdtime ATT/P/OL
0011.0011.0012.00-00 * 0x00000014 0x0633 329 0/0/0
0011.0011.0016.00-00 0x00004DFC 0xE624 284 0/0/0
0011.0011.0016.02-00 0x00000013 0xF432 279 0/0/0

The show isis database command displays the following information:

LSPID the LSP identifier


LSP Seq Num the sequence number for the LSP. Allows other systems to
determine if they have received the latest information from source
LSP the checksum of the LSP packet
Checksum
LSP Holdtime the number of seconds the LSP remains valid
ATT the Attach bit - this indicates that router is a Level 2 router and can
reach other areas
P the P bit - this detects if Intermediate System is capable of area
partition repair
OL the Overload bit - this determines if Intermediate System is
congested

Compass ID: 327594480 Version 3 27-53


BSR 64000 Command Reference Guide Release 5.2.1

Group Access
All

Command Mode
All modes except User EXEC

Command Line Usage


show isis database [detail <WORD> | l1 | l2 | level-1 | level-2] [<WORD> | detail
<WORD>] [ | {begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show isis database [detail <WORD> | l1 | l2 | level-1 | level-2] <WORD> | detail
<WORD>] [ | {count | count-only}]

Command Syntax

detail displays the contents of each LSP


WORD the LSPID in the form
xxxx.xxxx.xxxx.xx-xx or name.xx-xx
l1 abbreviation for the level-1 option
l2 abbreviation for the level-2 option
level-1 displays the Level 1 IS-IS routing
link state database
level-2 displays the Level 2 IS-IS routing
link state 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
include filter for output that includes the
specified string
WORD the specified string

27-54 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

count count the number of outputted lines


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

Compass ID: 327594480 Version 3 27-55


BSR 64000 Command Reference Guide Release 5.2.1

show isis hostname


The show isis hostname command displays IS-IS hostname information. The
following is an example of typical screen output from the show isis hostname
command:

Level System ID Dynamic Hostname


* 0011.0011.0012 MOT-Marlboro

Command Line Usage


show isis hostname [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show isis hostname [ | {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

27-56 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

show isis neighbors


The show isis neighbors command displays IS-IS neighbor information. The
following is an example of typical screen output from the show isis neighbors
command:

System Id Interface State Type Priority Circuit Id


0011.0011.0016 Ethernet2/3 Up L2 64 0011.0011.0016.02
0011.0011.0005 Ethernet2/4 Up L1 64 0011.0011.0005.03

The show isis neighbors command displays the following information:

System Id the System ID of the IS-IS router


Interface the interface from which the system was learned
State the Adjacency state - "Up" and "Init" are the states of the IS
neighbor
Type displays whether the IS-IS router type is Level 1 or Level 2
Priority indicates the routing priority
Circuit Id indicates the IS-IS circuit ID

Command Line Usage


show isis neighbors [ethernet <X/Y> | gigaether <X/Y> | loopback <1-255>] [ |
{begin | exclude | include} {<WORD>} [ | {count | count-only}]]
show isis neighbors [ethernet <X/Y> | gigaether <X/Y> | loopback <1-255>] [ |
{count | count-only}]

Compass ID: 327594480 Version 3 27-57


BSR 64000 Command Reference Guide Release 5.2.1

Command Syntax

ethernet X/Y the Ethernet interface slot and port


number
gigaether X/Y the Gigabit Ethernet interface slot
and port number
loopback 1-255 the 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

27-58 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

show isis spf-log


The show isis spf-log command displays how often and why the router has run a full
SPF calculation for the Level 1 and Level 2 IS-IS routers. The following is an
example of typical screen output from the show isis spf-log command:

Compass ID: 327594480 Version 3 27-59


BSR 64000 Command Reference Guide Release 5.2.1

Level 1 SPF log


When Duration Nodes Count Last trigger LSP Triggers
00:09:48 0 7 1 0011.0011.0016.02-00 NEWLSP
00:09:43 0 9 1 0011.0011.0016.00-00 NEWLSP
00:09:36 0 9 1 0000.0000.0000.00-00 PERIODIC
00:09:06 0 7 2 0011.0011.0016.00-00 PERIODIC NEWLEVEL TLVCODE TL
VCONTENT
00:08:36 0 7 1 0000.0000.0000.00-00 PERIODIC
00:08:04 0 7 2 0000.0000.0000.00-00 PERIODIC NEWADJ TLVCODE TLVC
ONTENT ADJCHANGE
00:07:56 16 12 1 0011.0011.0005.00-00 PERIODIC NEWLSP
00:07:54 16 12 1 0011.0011.0005.03-00 NEWLSP
00:07:34 0 12 1 0000.0000.0000.00-00 PERIODIC
00:07:04 0 12 1 0011.0011.0005.00-00 PERIODIC
00:06:34 0 12 1 0011.0011.0005.00-00 PERIODIC
00:05:58 0 12 1 0011.0011.0005.03-00 PERIODIC
00:05:18 0 12 1 0011.0011.0005.03-00 PERIODIC
00:04:38 0 12 1 0011.0011.0005.03-00 PERIODIC
00:03:58 0 12 1 0011.0011.0005.03-00 PERIODIC
00:03:18 16 12 1 0011.0011.0005.00-00 PERIODIC
00:02:38 0 12 1 0011.0011.0005.03-00 PERIODIC
00:01:58 0 12 1 0011.0011.0005.03-00 PERIODIC
00:01:18 0 12 1 0011.0011.0005.03-00 PERIODIC
00:00:38 16 12 1 0011.0011.0005.03-00 PERIODIC
Level 2 SPF log
When Duration Nodes Count Last trigger LSP Triggers
00:09:38 16 8 1 0000.0000.0000.00-00 PERIODIC TLVCODE
00:09:13 0 12 1 0011.0011.0016.00-00 PERIODIC TLVCODE
00:09:08 0 12 1 0000.0000.0000.00-00 PERIODIC TLVCODE TLVCONTENT
00:08:41 0 8 1 0000.0000.0000.00-00 TLVCODE
00:08:38 0 8 1 0011.0011.0005.00-00 PERIODIC TLVCODE
00:07:58 0 8 1 0011.0011.0005.03-00 PERIODIC NEWADJ
00:07:56 0 8 0 0000.0000.0000.00-00
00:07:28 0 8 1 0011.0011.0005.00-00 PERIODIC TLVCODE
00:06:58 0 8 1 0011.0011.0005.00-00 PERIODIC
00:06:29 16 8 1 0011.0011.0005.03-00 PERIODIC
00:05:57 0 8 1 0011.0011.0005.03-00 PERIODIC
00:05:17 0 8 1 0011.0011.0005.03-00 PERIODIC
00:04:37 0 8 1 0011.0011.0005.03-00 PERIODIC
00:03:57 16 8 1 0011.0011.0005.00-00 PERIODIC

27-60 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

The show isis spf-log command displays the following information:

When The amount of time since a full SPF calculation took place given
in hours:minutes:seconds. The previous 20 calculations are
logged.
Duration The number of milliseconds to complete this SPF run - the elapsed
time is the time from the start to the finish of the SPF run including
time spent doing other tasks
Nodes Number of routers and pseudonodes (LANs) that make up the
topology calculated in this SPF run.
Count Number of events that triggered this SPF run. When there is a
topology change, often multiple LSPs are received in a short time
period. A router waits 5 seconds before running a full SPF run, so
it can include all new information. This count denotes the number
of events (such as receiving new LSPs) that occurred while the
router was waiting its 5 seconds before running full SPF.
Last trigger Whenever a full SPF calculation is triggered by a new LSP, the
LSP LSP ID is stored in the router and displayed here
Triggers The reason the full SPF calculation occurred - refer to the
following table for a list of the possible SPF triggers

The following table describes a list of possible SPF triggers

Trigger Reason

PERIODIC Typically, every 15 minutes a router runs a periodic full SPF


calculation.
NEWSYSID A new system ID through the net command was configured on
this router.
NEWAREA A new area (via the net command) was configured on this router.
NEWLEVEL A new level (via the is-type command) was configured on this
router.
NEWMETRIC A new metric was configured on an interface of this router.

Compass ID: 327594480 Version 3 27-61


BSR 64000 Command Reference Guide Release 5.2.1

Trigger Reason

IPBACKUP An IP route disappeared, which was not learned via IS-IS, but via
another protocol with better administrative distance. IS-IS will
run a full SPF to install an IS-IS route for the disappeared IP
prefix.
IPQUERY A clear ip route command was issued on this router.
ATTACHFLAG The router has either attached or lost contact with the Level 2
backbone.
ADMINDIST Another administrative distance was configured for the IS-IS
process on this router.
AREASET Set of learned area-addresses in this area changed.
NEWADJ This router has created a new adjacency to another router.
DBCHANGED A clear isis * command was issued on this router.
BACKUPOVFL An IP prefix disappeared. The router knows there is another way
to reach that prefix, but has not stored that backup route. The only
way to find the alternative route is to perform a full SPF run
NEWLSP A new router or pseudonode appeared in the topology.
LSPEXPIRED An LSP in the LS database has aged out.
LSPHEADER The Attach, Partition, or Overload bits or the is-type in an LSP
header changed.
TLVCODE TLV code mismatch, indicating that different TLVs are included
in the newest version of an LSP.
TLVCONTENT TLV contents changed. This normally indicates that an adjacency
somewhere in the area has come up or gone down. Look at the
"Last trigger LSP" address to get an indication of where the
instability may have occurred.

Group Access
All

27-62 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

Command Mode
All modes except User EXEC

Command Line Usage


show isis spf-log [ | {begin | exclude | include} {<WORD>} [ | {count |
count-only}]]
show isis spf-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: 327594480 Version 3 27-63


BSR 64000 Command Reference Guide Release 5.2.1

show isis topology


The show isis topology command displays the IS-IS paths to Intermediate Systems.
The following is an example of typical screen output from the show isis topology
command:

IS-IS paths to level-1 routers


System Id Metric Next-Hop Interface SNPA
0011.0011.0012 ---
0011.0011.0016 18 0011.0011.0016 Ethernet2/3 0030.942e.ddc1

IS-IS paths to level-2 routers


System Id Metric Next-Hop Interface SNPA
0011.0011.0012 ---
0011.0011.0016 18 0011.0011.0016 Ethernet2/3 0030.942e.ddc1
0011.0011.0005 12 0011.0011.0005 Ethernet2/4 000c.854b.1d32
0011.0011.0013 19 0011.0011.0005 Ethernet2/4 000c.854b.1d32

The show isis topology command displays the following information:

System ID the System ID of the IS-IS router


Metric indicates the routing metric assigned to the Level 1 or Level 2
router
Next-Hop the MAC address of the next hop router
Interface the interface from which the system was learned
SNPA the Subnetwork Point of Attachment, which is the data-link
layer address

Group Access
All

Command Mode
All modes except User EXEC

27-64 Compass ID: 327594480 Version 3


Release 5.2.1 IS-IS Commands

Command Line Usage


show isis topology [ l1| l2 | level-1 | level-2 ] [ | {begin | exclude | include}
{<WORD>} [ | {count | count-only}]]
show isis topology [ l1| l2 | level-1 | level-2 ] [ | {count | count-only}]

Command Syntax

l1 abbreviation for the option level-1


l2 abbreviation for the option level-2
level-1 display the Level 1 IS-IS routing link
state database
level-2 display the Level 2 IS-IS routing link
state 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
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: 327594480 Version 3 27-65


BSR 64000 Command Reference Guide Release 5.2.1

summary-address
A range of IP addresses listed in a routing table can be represented by a summary
address. Routes learned from other routing protocols also can be summarized. The
metric used to advertise the summary is the smallest metric of all the more specific
routes.
The summary-address command is used to create a summary address for a range of
IP addresses.

Group Access
ISP

Command Mode
IS-IS Router Configuration

Command Line Usage


summary-address <A.B.C.D> <A.B.C.D> [level-1 | level-1-2 | level-2 | metric]
no summary-address <A.B.C.D> <A.B.C.D>

Command Syntax

A.B.C.D the summary IP address


A.B.C.D the subnetwork mask for the summary IP
address
level-1 indicates a Level 1 IS-IS router
level-1-2 indicates a Level 1 and 2 IS-IS router
level-2 indicates a Level 2 IS-IS router
metric sets a metric for the summary route

Command Default
level-2

27-66 Compass ID: 327594480 Version 3


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
area-password, 27-2
aaa authorization commands default, 1-11
arp, 2-3
aaa authorization exec default, 1-13
arp (global), 2-3
aaa console authentication, 1-14
arp timeout, 2-5, 13-2
aaa console authorization commands default, 1-15
authentication mode, 27-3
aaa new-model, 1-16
auto-cost reference-bandwidth, 8-9
access-class in, 5-2
auto-summary, 7-2, 16-3
access-list (extended), 5-4
auto-virtual link, 8-10
access-list (standard), 5-3
aggregate-address, 16-2 B
alias, 1-17
balance, 13-3
allow-share, 19-6
band, 13-4
aps force, 15-3
banner motd, 1-18
aps group, 15-4
batch, 1-19
aps lockout, 15-5
bgp always-compare-med, 16-4
aps manual, 15-6
bgp client-to-client reflection, 16-5
aps protect, 15-7
bgp cluster-id, 16-6
aps revert, 15-8
bgp confederation identifier, 16-7
aps signal-degrade ber threshold, 15-9
bgp confederation peers, 16-8
aps signal-fail ber threshold, 15-10
bgp dampening, 16-9
aps unidirectional, 15-11

Compass ID: 327594480 Version 3 Index-1


BSR 64000 Command Reference Guide Release 5.2.1

bgp default, 16-11 cable downstream description, 13-32, 13-164


bgp permit, 16-12 cable downstream dsg, 23-2
bgp router-id, 16-13 cable downstream dsg enable, 23-3
bind cmts, 13-5 cable downstream fiber-node, 13-33
boot system, 1-20 cable downstream frequency, 13-34
bootrom-filename, 13-6 cable downstream interleave-depth, 13-36
bootrom-invalidate slot, 13-7 cable downstream loadbalance-group, 13-38
bridge cable intercept, 22-2 cable downstream modulation, 13-39
bridge cable modem, 22-4 cable downstream mot-bonding-group, 13-40
bridge mode trunk, 22-5 cable downstream port, 13-44
broadcast, 1-21 cable downstream power-level, 13-45
cable downstream primary-capable, 13-47
C cable downstream rate-limit, 13-48
cabel upstream channel-type, 13-158 cable downstream scrambler on, 13-50
cable, 13-50, 13-129, 23-4 cable downstream shutdown, 13-51
cable bind, 13-8 cable downstream sync-interval, 13-52
cable bundle, 13-10 cable downstream threshold, 13-53
cable bundle master, 13-11 cable downstream trap-enable-if, 13-55
cable cmts type, 13-12 cable downstream trap-enable-rdn, 13-56
cable concatenation docsis-1.0, 13-13 cable dsg, 13-66, 23-4
cable deny ip, 13-14 cable dtx type, 13-57
cable dhcp force-unicast, 13-15 cable dynamic-service, 21-2
cable dhcp leasequery message-type, 13-18 cable dynamic-service active-timeout, 21-4
cable dhcp preserve-server-id, 13-16 cable fast-path cm, 13-59
cable dhcp-giaddr primary, 13-17 cable filter group index action, 13-64
cable disable 3140-nbpwr-adjustment, 13-20 cable filter group index dst-ip, 13-61
cable disable bpi-cmcert, 13-21 cable filter group index enable, 13-65
cable disable eth-pkt-filtering, 13-22 cable filter group index src-ip, 13-60
cable downstream aggregate, 13-23 cable filter group index tos, 13-63
cable downstream bdm-interval, 13-24 cable filter group index ulp, 13-62
cable downstream bonding disable, 13-25 cable flap-list aging, 13-66
cable downstream bonding-domain, 13-26 cable flap-list insertion-time, 13-68
cable downstream bonding-group, 13-27 cable flap-list miss-threshold, 13-69
cable downstream carrier-only, 13-29 cable flap-list percentage threshold, 13-70
cable downstream channel-id, 13-30 cable flap-list power-adjust threshold, 13-71
cable downstream channel-mode, 13-31 cable flap-list size, 13-72
cable flap-list trap-enable, 13-73

Index-2 Compass ID: 327594480 Version 3


Release 5.2.1 Index

cable helper-address, 2-6, 13-74 cable privacy cert, 13-125


cable host authorization range, 13-77 cable privacy cm-auth life-time, 13-126
cable insert-interval, 13-78 cable privacy cm-auth reset, 13-127
cable intercept, 13-79 cable privacy cm-tek life-time, 13-129
cable ip prov-mode, 26-4 cable privacy cm-tek reset, 13-130
cable ip-broadcast-echo, 13-81 cable privacy enforce-bpi-plus, 13-131
cable ip-multicast-echo, 13-82 cable privacy mandatory, 13-132
cable ipv6 helper-address, 26-2 cable privacy mcast, 13-134
cable load-balance, 13-83 cable privacy mcast access, 13-135
cable load-balance spectrum-group, 13-91 cable privacy tek life-time, 13-136
cable loadbalance-group, 13-84 cable qos max-burst, 13-137
cable loadbalance-policy, 13-85 cable qos-profile, 13-138
cable loadbalance-restricted, 13-86 cable security authorized, 13-139
cable loadbalance-rule, 13-88 cable security failure, 13-140
cable mdd-interval, 13-92 cable service-class, 19-7
cable modem dcc, 13-94 cable shared-secondary-secret, 13-142
cable modem deny, 13-96 cable shared-secret, 13-141
cable modem disable loadbalancing, 13-97 cable spectrum-group, 13-143
cable modem max-hosts, 13-98 cable spm-management, 13-144
cable modem max-hosts-all, 13-99 cable submgmt default cpe-control active, 13-145
cable modem qos dsa, 13-98, 13-100 cable submgmt default cpe-control learnable, 13-146
cable modem qos dsc, 13-102 cable submgmt default cpe-control max-cpe, 13-147
cable modem qos dsd, 13-103 cable submgmt default filter-group, 13-148
cable modem remote-query, 13-104 cable submgmt default filter-group cm, 13-149
cable modem remote-query source-interface, 13-105 cable sync-interval, 13-150
cable modem service-class-name, 13-108 cable tcpudp-filter group index dst-port, 13-152
cable modem ucc, 13-110 cable tcpudp-filter group index enable, 13-153
cable modem updis, 13-112 cable tcpudp-filter group index src-port, 13-151
cable modem-aging-timer, 13-93 cable tcpudp-filter group index tcp-flag, 13-154
cable modulation-profile, 13-113 cable ucd-interval, 13-155
cable modulation-profile copy, 13-117 cable upstream active_codes, 13-156
cable modulation-profile description, 13-118 cable upstream capability, 13-157
cable modulation-profile reset, 13-119 cable upstream channel-id, 13-158
cable mta-protection enable, 13-120 cable upstream channel-type, 13-159
cable multicast, 13-121 cable upstream channel-width, 13-160
cable multi-ds-override, 13-123 cable upstream codes-minislot, 13-161
cable privacy auth life-time, 13-124 cable upstream concatenation, 13-162

Compass ID: 327594480 Version 3 Index-3


BSR 64000 Command Reference Guide Release 5.2.1

cable upstream data-backoff, 13-163 channel-type, 13-209


cable upstream eng-nb-atten-backoff value, 13-165 chassis alias, 1-23
cable upstream eq-magnitude-scaling, 13-167 chassis assetid, 1-24
cable upstream force-frag, 13-169 chkdsk, 1-25
cable upstream frequency, 13-170 classifier, 23-6
cable upstream global-clock enable, 13-173 clear arp-cache, 2-8
cable upstream hopping-seed, 13-174 clear bridge, 22-6
cable upstream ingress-canceller enable, 13-175 clear cable dcc-stats, 13-211
cable upstream invited-range-interval, 13-176 clear cable downstream bonding-group statistics,
cable upstream iuc11-grant-size, 13-177 13-212
cable upstream loadbalance-group, 13-178 clear cable flap-list, 13-213
cable upstream maintain-power-density on, 13-179 clear cable modem, 13-215
cable upstream map-interval, 13-180 clear cable modem downstream, 13-216
cable upstream max-calls, 13-181 clear cable modem offline, 13-218
cable upstream minislot-size, 13-182 clear cable modem sync, 13-219
cable upstream modem-ranging-delay, 13-184 clear cable qos svc-flow statistics, 13-220
cable upstream modulation-profile, 13-185 clear cable srvclass-stats, 13-221, 19-9
cable upstream physical-delay, 13-187 clear cable ucc-stats, 13-223
cable upstream power-level, 13-191 clear cable ugs-stats, 13-224
cable upstream power-level default, 13-193 clear core log, 1-26
cable upstream pre-equalization, 13-195 clear counters, 2-9
cable upstream range-backoff, 13-196 clear counters cable, 13-225
cable upstream range-forced-continue, 13-197 clear counters ipsec, 21-7
cable upstream range-power-override, 13-198 clear evt, 1-27
cable upstream rate-limit, 13-199 clear host, 2-10
cable upstream schedule, 13-200 clear interfaces cable upstream signal-quality, 13-227
cable upstream shutdown, 13-201 clear ip bgp, 16-14
cable upstream snr-offset, 13-202 clear ip bgp dampening, 16-15
cable upstream spectrum-group, 13-203 clear ip bgp flap-statistics, 16-16
cable upstream spread-interval, 13-204 clear ip igmp counters, 9-3
cable upstream trap-enable-cmts, 13-205 clear ip multicast fwd-cache, 11-8
cable upstream trap-enable-if, 13-206 clear ip multicast proto-cache, 11-9
cable upstream trap-enable-rdn, 13-207 clear ip ospf, 8-11
cable utilization-interval, 13-208 clear ip rip statistics, 7-3
cap, 19-8 clear ip route, 2-11
carriage-return-lf-mode, 1-22 clear ip rsvp statistics, 18-4
channel-list, 13-209, 23-5 clear ip traffic, 2-12

Index-4 Compass ID: 327594480 Version 3


Release 5.2.1 Index

clear ip vrrp, 10-2 D


clear ipv6 neighbor-cache, 26-6
datapath keepalive, 1-42
clear ipv6 traffic, 26-7
datapath pause enable, 1-43
clear isis, 27-4
debug aps, 4-2
clear log, 1-29
debug arp, 4-3
clear mpls traffic, 18-5
debug cable cra, 4-4
clear packet-cable configuration, 21-5
debug cable err, 4-4
clear packet-cable cops, 21-6, 21-8
debug cable keyman, 4-5
clear packet-cable gate, 21-9
debug cable mac, 4-6
clear packet-cable statistics, 21-10
debug cable map, 4-7
clear redundancy stats, 1-30
debug cable modem-select, 4-8
clear sntp history, 2-13
debug cable privacy, 4-9
clear usage-stats, 13-228
debug cable qos, 4-10
Client-Accept message, 21-12
debug cable range, 4-11
client-list, 13-230, 23-8
debug cable reg, 4-12
client-timer, 21-12
debug cable remote-query, 4-13
clock set, 1-31
debug cable ucc, 4-14
clock summer-time, 1-32
debug ip access-list, 4-15
clock timezone, 1-34
debug ip bgp, 4-16
cmts-id, 13-229
debug ip dvmrp, 4-18
cmts-ip, 21-11
debug ip icmp, 4-19
codes-subframe, 13-230
debug ip igmp, 4-20
collect interval, 13-231
debug ip mfm, 4-21
collect resolution, 13-232
debug ip mrtm, 4-22
commands
snmp-server community, 3-26 debug ip ospf, 4-23
snmp-server host, 3-26 debug ip packet, 4-25
Communications Assistance for Law Enforcement Act debug ip pim, 4-27
(CALEA), 21-36 debug ip policy, 4-29
configure, 1-36 debug ip redistribute, 4-30
console authentication radius, 1-37 debug ip rip, 4-32
cops status-trap-enable, 21-15 debug ip rip database, 4-33
copy, 1-38 debug ip rip events, 4-34
copy core, 1-40 debug ip rip trigger, 4-35
core, 1-41 debug ip tcp transactions, 4-36
crc, 15-13 debug ip udp, 4-37
debug ip vrrp, 4-38

Compass ID: 327594480 Version 3 Index-5


BSR 64000 Command Reference Guide Release 5.2.1

debug ipdr, 24-2 docstest, 13-235


debug ipsec, 4-39 domain-password, 27-7
debug isis spf-statistics, 4-51 dqos cops-trap-enable, 21-18
debug isis update-packets, 4-53 dqos dscp, 21-16
debug mpls forwarding, 4-54, 18-6 dqos emergency-preempt, 21-17
debug mpls rsvp, 4-55, 18-7 dqos emergency-trap-enable, 21-18
debug nd, 4-57 dqos res-req-trap-enable, 21-19
debug packet-cable, 4-58 dqos shutdown, 21-20
debug ppp fsm, 4-59 dqos t0/t1-timer, 21-21
debug ppp packet, 4-60 dqos t0-timer/t1-timer, 21-21
debug radius, 4-61 duplex, 1-48
debug snmp, 4-62
debug sntp, 4-63
E
debug specmgr, 4-64 Element ID, 21-23
debug ssh, 4-65 em dscp, 21-22
debug tacacs, 4-66 em element-number, 21-23
debug tacacs events, 4-67 em event-disable-mask, 21-24
debug task monitor, 4-68 em event-priority, 21-25
debug tunnel, 4-72 em flag-override, 21-26
default-information originate, 8-12, 16-17, 27-5 em max-batch-events, 21-27
default-information originate (OSPF), 6-2 em max-batch-time, 21-28
default-information originate (RIP), 7-4 em qos-descriptor-disable, 21-29
default-metric, 6-4, 16-18 em retry-count, 21-30
default-metric (OSPF), 8-13 em retry-interval, 21-31
default-metric (RIP), 7-5 em rks-failure-trap-enable, 21-32
delete, 1-44 em shutdown, 21-34
description, 1-45 em udp-port, 21-35
dhcp leasequery authorization on, 13-233 enable, 1-49
differential-encoding on, 13-234 enable authentication radius, 1-50
dir, 1-46 enable password, 1-51
disable, 1-47 enable rdn-process, 1-52
distance, 7-6, 8-14, 27-6 enable secret, 1-53
distance bgp, 16-19 encapsulation dot1q, 22-7
distance ospf, 8-15 encapsulation snap, 1-54
distribute-list, 8-17 enforce-cmts-qos, 19-10
distribute-list in, 7-7, 16-21 erase, 1-55
distribute-list out, 7-8, 16-22

Index-6 Compass ID: 327594480 Version 3


Release 5.2.1 Index

es, 21-36 hop period, 13-255


exception, 1-56 hop sampling-period active-channel, 13-258
exit, 1-57 hop sampling-period rollback-channel, 13-259
hop sampling-period spare-channel, 13-260
F hop snr hysteresis, 13-256
fec-codeword, 13-238 hop threshold error, 13-261
fec-correction, 13-239 hop threshold flap, 13-262
fft display, 13-240 hop threshold snr modulation-type, 13-263
fft setup, 13-242 host authorization, 2-14
fft start, 13-243 hostname, 1-62
fft store, 13-244 hsim4 slot, 1-63
forced-download, 1-58
I
format, 1-59
icp keepalive, 1-64
G ignore-lsp-errors, 27-9
graceful-restart, 8-18 ike client-addr, 21-39
graceful-restart-period, 7-9 ike phase1, 21-40
grant-interval, 19-11 ike phase2, 21-41
grant-jitter, 19-12 ike retries, 21-42
grant-size, 19-13 ike timeout, 21-43
grants-per-interval, 19-14 init-tech, 13-265
group-map, 23-10 interface, 2-16
guard-band, 13-246 interface cable, 13-266
interface pos, 15-14
H interleaver-block-size, 13-267
hello padding, 27-8 interleaver-depth, 13-268
help, 1-60 interleaver-step-size, 13-269
helper-mode, 8-19 ip access-group, 2-18, 5-12
history, 1-61 ip access-list, 5-13
hop action band, 13-247 ip address, 2-19, 13-270
hop action channel-width, 13-248 ip as-path access-list, 16-23
hop action frequency, 13-249 ip bgp-community new-format, 16-24
hop action modulation-profile, 13-250 ip broadcast-address, 2-23
hop action power-level, 13-251 ip community-list, 16-26
hop action roll-back, 13-253 ip dhcp relay information, 2-24
hop modulation-rollback-count, 13-254 ip dhcp relay information option, 13-273

Compass ID: 327594480 Version 3 Index-7


BSR 64000 Command Reference Guide Release 5.2.1

ip domain-lookup, 2-27 ip ospf database-filter all out, 8-23


ip domain-name, 2-28 ip ospf dead-interval, 8-24
ip dvmrp accept-filter, 12-2 ip ospf hello-interval, 8-25
ip dvmrp default-information originate, 12-3 ip ospf message-digest-key, 8-26
ip dvmrp metric-offset, 12-4 ip ospf network, 8-27
ip dvmrp output-report-delay, 12-5 ip ospf priority, 8-28
ip dvmrp out-report-filter, 12-6 ip ospf retransmit-interval, 8-29
ip dvmrp probe-interval, 12-7 ip ospf transmit-delay, 8-30
ip dvmrp reject-non-pruners, 12-8 ip pim border, 17-2
ip dvmrp summary-address, 12-9 ip pim bsr-candidate, 17-3
ip forwarding, 2-30 ip pim bsr-candidate ip-address, 17-4
ip forward-protocol udp, 2-29 ip pim dr-priority, 17-5
ip ftp password, 1-66 ip pim message-interval, 17-6
ip ftp username, 1-67 ip pim query-interval, 17-7
ip helper-address, 2-31, 26-11 ip pim rp-candidate, 17-8
ip host, 2-32 ip pim rp-candidate group-list, 17-9
ip igmp access-group, 9-4 ip pim rp-candidate interval, 17-10
ip igmp last-member-query-interval, 9-8 ip pim rp-candidate ip-address, 17-11
ip igmp querier-timeout, 9-5 ip pim rp-candidate priority, 17-12
ip igmp query-interval, 9-6 ip pim spt-threshold lasthop, 17-13
ip igmp query-max-response-time, 9-9 ip pim spt-threshold rp, 17-14
ip igmp static-group, 9-10 ip pim ssm, 17-15
ip igmp version, 9-11 ip policy route-map, 6-6
ip igmp version1-querier, 9-12 ip proxy-arp, 2-40
ip irdp, 2-33 ip qos-group, 14-2
ip local policy route-map, 6-5 ip rarp-server, 2-41
ip mask-reply, 2-35 ip redirects, 2-42
ip mroute, 11-2 ip rip authentication key, 7-10
ip mroute distance, 11-3 ip rip host-routes, 7-11
ip mroute unicast distance, 11-4 ip rip message-digest-key md5, 7-12
ip mtu, 2-36 ip rip receive version, 7-13
ip multicast fastpath, 2-37 ip rip send version, 7-14
ip multicast-routing, 11-5 ip route, 2-43
ip name-server, 2-39 ip router isis, 27-10
ip netmask-format, 1-68 ip routing, 2-44
ip ospf authentication-key, 8-21 ip rsvp, 18-9
ip ospf cost, 8-22 ip source-route, 2-45

Index-8 Compass ID: 327594480 Version 3


Release 5.2.1 Index

ip split-horizon, 7-15 isis circuit-type, 27-12


ip tacacs source-interface, 1-69 isis csnp-interval, 27-13
ip tftp source-interface loopback, 1-70 isis hello padding, 27-14
ip unreachables, 2-46 isis hello-interval, 27-15
ip vrrp, 10-3 isis hello-multiplier, 27-16
ip vrrp (virtual router ID), 10-4 isis lsp-interval, 27-17
ip vrrp address, 10-5 isis message-digest-key, 27-18
ip vrrp authentication key, 10-6 isis metric, 27-19
ip vrrp authentication type, 10-7 isis network point-to-point, 27-20
ip vrrp enable, 10-8 isis password, 27-21
ip vrrp preempt, 10-9 isis priority, 27-22
ip vrrp primary-ip, 10-11 isis retransmit-interval, 27-23
ip vrrp priority, 10-10 isis retransmit-throttle-interval, 27-24
ip vrrp timer, 10-12 is-type, 27-25
ip vrrp verify-availability, 10-13 iuc, 13-274
ip-address (pos), 15-15
ipdr acksequenceinterval, 24-3
L
ipdr acktimeinterval, 24-4 last-codeword-length, 13-277
ipdr collection-interval, 24-5 ldap client, 1-71
ipdr collector, 24-6 ldap search-base, 1-72
ipdr enable, 24-9 ldap server, 1-73
ipdr keepaliveinterval, 24-10 load-balancing, 13-278
ipdr poll-rate, 24-11 load-balancing static, 13-279
ipdr source-interface, 24-12 load-interval, 1-74
ipsec, 21-44 log-adjacency-changes, 27-26
ipsec shutdown, 21-45 logging, 1-76
ipv4 range, 26-8 logging admin-status, 1-77
ipv6 address, 26-9 logging buffered, 1-79
ipv6 helper-address, 26-11 logging console, 1-81
ipv6 icmp error-interval, 26-12 logging control docsis, 1-83
ipv6 nd, 26-13 logging default, 1-84
ipv6 neighbor, 26-15 logging disable bpi_auth_invalid_messages, 1-85
ipv6 range, 26-16 logging disable bpi_auth_reject_messages, 1-86
ipv6 redirects, 26-17 logging disable bpi_map_reject_messages, 1-87
ipv6 route, 26-18 logging disable bpi_tek_invalid_messages, 1-88
ipv6 unicast-routing, 26-19 logging disable cm_ranging_fail_r103_0, 1-89
isis authentication mode, 27-11

Compass ID: 327594480 Version 3 Index-9


BSR 64000 Command Reference Guide Release 5.2.1

logging evt clear, 1-92 message, 1-111


logging evt set, 1-93 message-digest-key md5, 27-31
logging facility, 1-94 metric-style, 27-32
logging on, 1-95 min-pkt-size, 19-21
logging rate-limit, 1-96 min-rate, 19-22
logging reporting, 1-97 mm dscp, 21-46
logging reporting default, 1-100 mm shutdown, 21-47
logging session, 1-101 mm t1-timer, 21-48
logging snmp-trap, 1-102 modulation-type, 13-282
logging source-interface loopback, 1-104 more, 1-115
logging trap, 1-105 moto-nsf, 8-32
login, 1-107 mpls create-lsp rsvp, 18-11
logout, 1-108 mpls create-lsp rsvp explicit-route identifier, 18-12
Loopback interface, 21-11 mpls create-lsp rsvp next-hop, 18-13
lsp-gen-interval, 27-27 mpls create-lsp static, 18-14
lsp-refresh-interval, 27-28 mpls ip, 18-17
mpls label range, 18-18
M mpls mtu, 18-19
mab, 19-15 mpls rsvp restart-lsp, 18-20
macro, 1-109 mpls ttl, 18-21
match as-path, 6-7, 16-28 mtrace, 11-10
match community, 6-8, 16-29
N
match ip address, 6-9
match ip next-hop, 6-10 name, 19-23
match ip route-source, 6-11 neighbor advertisement-interval, 16-31
match metric, 6-12 neighbor confed-segment, 16-32
match route-type external, 6-13 neighbor default-originate, 16-33
match route-type internal, 6-14 neighbor description, 16-34
match tag, 6-15 neighbor distribute-list, 16-35
max-burst, 13-280, 19-17 neighbor ebgp-multihop, 16-36
max-concat-burst, 19-18 neighbor filter-list, 16-37
maximum-paths, 7-16, 8-31, 16-30, 27-30 neighbor maximum-prefix, 16-39
max-latency, 19-19 neighbor next-hop-self, 16-41
max-lsp-lifetime, 27-29 neighbor password, 16-42
max-rate, 19-20 neighbor peer-group (assigning members), 16-43
memory checkzero, 1-110 neighbor peer-group (creating), 16-44

Index-10 Compass ID: 327594480 Version 3


Release 5.2.1 Index

neighbor remote-as, 16-45 pim graceful-restart restart-interval, 17-18


neighbor remove-private-as, 16-47 pim register-checksum, 17-19
neighbor route-map, 16-48 pim rp-address, 17-20
neighbor route-reflector client, 16-49 pim unicast-route-lookup, 17-22
neighbor route-refresh, 16-50 ping, 2-49
neighbor send-community, 16-51 ping docsis, 13-284
neighbor shutdown, 16-52 ping6, 26-20
neighbor soft-reconfiguration inbound, 16-53 Policy Enforcement Point (PEP), 21-14
neighbor timers, 16-54 policy rule, 13-285
neighbor update-source loopback, 16-56 poll-interval, 19-25
neighbor weight, 16-57 poll-jitter, 19-26
net, 27-33 pos ais-shut, 15-17
network, 7-17, 12-10, 16-58, 17-16 pos flag, 15-18
network area, 8-34 pos framing, 15-20
network-clock-select, 15-16 pos internal-clock, 15-21
network-clock-select revertive, 1-114 pos report, 15-22
pos scramble, 15-24
O pos signal mode, 15-25
offset-list, 7-18 pos threshold, 15-26
output-delay, 7-20 ppp magic-number, 15-28
over-max-rate, 19-24 ppp negotiation-count, 15-29
ppp timeout, 15-30
P preamble-length, 13-286
PacketCable preamble-type, 13-287
description, 21-1 privilege restricted, 1-120
packet-cable, 21-49
PacketCable Multimedia Q
description, 21-1
qos bw default, 14-2
page, 1-117
qos queue bw, 14-3
passive-interface, 2-47, 7-21, 8-35, 27-34
qos queue dot1p, 14-4
password, 1-118
qos-list queue, 14-3
password ssh-passphrase, 20-2
patch install, 1-119 R
pdp-ip, 21-13
radius-server, 1-121
peer default ip address, 15-16
radius-server source-interface loopback, 1-123
pep-id, 21-14
redistribute, 7-22, 8-36, 16-59, 27-35
pim accept-rp, 17-17

Compass ID: 327594480 Version 3 Index-11


BSR 64000 Command Reference Guide Release 5.2.1

redundancy cmts, 1-124 set community, 6-22


redundancy dtx, 1-126 set default interface, 6-24
redundancy force-switchover cmts, 1-127 set interface, 6-25
redundancy force-switchover dtx, 1-129 set ip default next-hop, 6-26
redundancy force-switchover srm, 1-130 set ip diff-serv, 6-27
reference-modem-exclusion, 13-288 set ip next-hop, 6-29, 16-68
reload, 1-131 set ip qos queue, 6-30
reload switched, 1-132 set local-preference, 6-31, 16-69
remote copy, 1-136 set metric, 6-32
repeat, 1-141 set metric-type, 6-33, 16-70
req-trans-policy, 19-27 set origin, 6-34, 16-71
reset, 1-142 set stats poll, 1-147
restricted admission disabled, 19-29 set tag, 6-35, 16-72
RF output upstream frequency set weight, 6-36, 16-73
setting, 13-170 set-overload-bit, 27-38
rfc1583-compatible, 8-38 setting
route-map, 6-16, 16-61 RF output upstream frequency, 13-170
router bgp, 16-61, 16-62 show access-lists, 5-14
router dvmrp, 12-11 show aliases, 1-149
router isis, 27-37 show aps, 15-31
router ospf, 8-40 show arp, 2-51
router pim, 17-23 show bindings, 13-291
router rip, 7-24 show boot, 1-151
router-id, 8-39 show bridge vlan, 22-8
show cable binding, 13-292
S show cable bonding-group minrr-multipliers, 13-294
schedpriority, 19-30 show cable dcc-stats, 13-296
scrambler-mode, 13-289 show cable downstream, 13-298
scrambler-seed, 13-290 show cable downstream bonding-groups, 13-301
service ipv6 cpe-forwarding enable, 26-21 show cable downstream id-list, 13-304
service password-encryption, 1-143 show cable dsg, 23-12
session-timeout, 1-144 show cable dsg channel-list, 23-14
session-window set, 1-145 show cable dsg classifier, 23-15
set as-path prepend, 6-18, 16-63 show cable dsg client-list, 23-16
set automatic-tag, 6-19 show cable dsg downstream, 23-17
set bandwidth-factor, 1-146 show cable dsg group-map, 23-18
set comm-list, 6-20, 16-64 show cable dsg timer, 23-19

Index-12 Compass ID: 327594480 Version 3


Release 5.2.1 Index

show cable dsg tunnel, 23-20 show cable modem summary, 13-386, 13-391
show cable dsg tunnel-group, 23-21 show cable modem summary total, 13-389, 13-391
show cable dsg vendor-param, 23-22 show cable modem svc-flow-id, 13-391
show cable dynamic-service, 21-50 show cable modem svc-flow-id detail, 13-393
show cable fiber-node, 13-305 show cable modem time-registered, 13-396
show cable filter, 13-307 show cable modem timing-offset, 13-399
show cable flap-list, 13-308 show cable modem unregistered, 13-403
show cable insert-interval, 13-310 show cable modem vendor, 13-405
show cable loadbalance-group, 13-311 show cable modem vendor summary, 13-407
show cable loadbalance-no-move-list, 13-313 show cable modem verbose, 13-409
show cable loadbalance-policy, 13-315 show cable modulation-profile, 13-411
show cable loadbalance-restricted, 13-317 show cable modulation-profile brief, 13-414
show cable loadbalance-rule, 13-318 show cable modulation-profile description, 13-415
show cable md-ds-sg, 13-319 show cable privacy auth, 13-416
show cable metering-status, 24-13 show cable privacy cm-auth, 13-417
show cable modem, 13-321 show cable privacy cm-tek, 13-418
show cable modem bonding, 13-325 show cable privacy cmts, 13-420
show cable modem cpe, 13-327 show cable privacy tek, 13-423
show cable modem detail, 13-330 show cable qos profile, 13-424
show cable modem downstream, 13-333 show cable qos profile user-defined, 13-427
show cable modem hosts, 13-339 show cable qos svc-flow classifier, 13-430
show cable modem loadbalance-group, 13-341 show cable qos svc-flow dynamic-stat, 13-433
show cable modem mac, 13-343 show cable qos svc-flow log, 13-434
show cable modem mac30, 13-346 show cable qos svc-flow param-set, 13-435
show cable modem maintenance, 13-349 show cable qos svc-flow phs, 13-437
show cable modem max-rate, 13-351 show cable qos svc-flow statistics, 13-439
show cable modem mta, 13-352 show cable qos svc-flow summary, 13-441
show cable modem offline, 13-357 show cable qos svc-flow upstream-stat, 13-442
show cable modem phy, 13-361 show cable service-class, 19-31
show cable modem ps, 13-352 show cable spectrum-group, 13-443, 13-445
show cable modem qos, 13-364 show cable spectrum-group load-balance summary,
show cable modem qos summary, 13-367 13-446
show cable modem registered, 13-370 show cable spectrum-group map, 13-447
show cable modem remote-query, 13-373 show cable spectrum-group modem-exclusion-list,
13-449
show cable modem security, 13-378
show cable spectrum-group reference-modem, 13-450
show cable modem stats, 13-383
show cable spectrum-group snr-thresholds, 13-451
show cable modem stb, 13-352

Compass ID: 327594480 Version 3 Index-13


BSR 64000 Command Reference Guide Release 5.2.1

show cable spectrum-group stats, 13-452 show hosts, 2-63


show cable srvclass-stats, 19-35 show interfaces, 2-64
show cable submgmt cpe-control default, 13-454 show interfaces cable, 13-475
show cable sync-interval, 13-455 show interfaces cable bandwidth voice, 13-481
show cable tcpudp-filter, 13-456 show interfaces cable configuration, 13-483
show cable ucc-stats, 13-457 show interfaces cable downstream, 13-485
show cable ucd-interval, 13-459 show interfaces cable intercept, 13-488
show cable ugs-stats, 13-460 show interfaces cable service-class, 13-490
show cable upstream, 13-462 show interfaces cable stats, 13-493
show cable upstream global-clock, 13-466 show interfaces cable upstream, 13-495
show chassis alias, 1-152 show interfaces cable upstream channel-agility-stats,
show chassis assetid, 1-153 13-500
show chassis serial-num, 1-154 show interfaces pos, 15-34
show chassis status, 1-155 show ip arp, 2-66
show clns interface, 27-39 show ip as-path-access-list, 16-74
show clns is-neighbors, 27-42 show ip bgp, 16-74, 16-75
show clns neighbors, 27-44 show ip bgp cidr-only, 16-77
show clns protocol, 27-46 show ip bgp community, 16-78
show clns traffic, 27-48 show ip bgp community-list, 16-80
show clock, 1-159 show ip bgp dampened-paths, 16-81
show controllers, 2-53 show ip bgp flap-statistics, 16-82
show controllers cable ds-mac, 13-467 show ip bgp ipv4 unicast, 16-84
show controllers cable ds-phy, 13-471 show ip bgp memory, 16-88
show controllers pos, 15-32 show ip bgp neighbors, 16-90
show core log, 1-160 show ip bgp next-hops, 16-92
show debugging, 4-73 show ip bgp paths, 16-93
show docsis-version, 13-473 show ip bgp peer-group, 16-94
show docstest, 13-474 show ip bgp regexp, 16-96
show evt, 1-161 show ip bgp summary, 16-97
show fast-path ranges, 18-22 show ip community-list, 16-100
show forced-download, 1-165 show ip dhcp stats, 2-69
show history, 1-167 show ip dvmrp information, 12-12
show host authorization, 2-55 show ip dvmrp interface, 12-13
show host authorization cpe, 2-56 show ip dvmrp neighbor, 12-14
show host authorization interface cable, 2-58 show ip dvmrp network, 12-15
show host authorization summary, 2-60 show ip dvmrp route, 12-16
show host unauthorized cpe, 2-62 show ip dvmrp route hold-down, 12-17

Index-14 Compass ID: 327594480 Version 3


Release 5.2.1 Index

show ip dvmrp summary-route, 12-18 show ip rsvp sender, 18-28


show ip dvmrp tunnels, 12-19 show ip rsvp statistics, 18-29
show ip filters, 2-70 show ip traffic, 2-94, 6-39
show ip filters summary, 2-74 show ip vrrp, 10-14
show ip flows, 2-77 show ipdr connection, 24-15
show ip forwarding-table, 2-79 show ipdr session, 24-16
show ip igmp groups, 9-13 show ipsec, 21-51
show ip igmp interface, 9-15 show ipv6 dhcp, 26-22
show ip igmp statistics, 9-17 show ipv6 interface, 26-24
show ip interface, 2-81 show ipv6 interface brief, 26-27
show ip irdp, 2-84 show ipv6 neighbor, 26-29
show ip multicast cache-summary, 11-11 show ipv6 route, 26-31
show ip multicast fastpath, 2-86 show ipv6 traffic, 26-33
show ip multicast fwd-cache, 2-87, 11-12 show isis database, 27-53
show ip multicast interface, 11-13 show isis hostname, 27-56
show ip multicast no-oi-fwd-cache, 11-15 show isis neighbors, 27-57
show ip multicast oi-fwd-cache, 11-14 show isis spf-log, 27-59
show ip multicast proto-cache, 11-16 show isis topology, 27-64
show ip ospf, 8-41 show keepalive, 1-169
show ip ospf border-routers, 8-43 show l2-cam, 2-98
show ip ospf database, 8-44 show log, 1-171
show ip ospf interface, 8-47 show logging evt, 1-174
show ip ospf memory, 8-49 show logging reporting, 1-175
show ip ospf neighbor, 8-51 show logging syslog, 1-178
show ip ospf network, 8-53 show macro, 1-179
show ip ospf virtual-links, 8-54 show memory, 1-180
show ip pim, 17-24 show mpls filters, 18-30
show ip protocols, 2-89 show mpls forwarding-table, 18-32
show ip redistribute, 6-37, 27-51 show mpls label range, 18-35
show ip rip database, 7-25 show mpls lsp, 18-36
show ip route, 2-91 show mpls lsp interface, 18-39
show ip rpf, 11-6 show mpls rsvp refresh-time, 18-41
show ip rsvp explicit-routed-lsps, 18-23 show mpls traffic, 18-42
show ip rsvp interface, 18-24 show network-clocks, 1-183, 15-37
show ip rsvp lsp, 18-25 show packet-cable configuration, 21-54
show ip rsvp neighbor, 18-26 show packet-cable cops, 21-59
show ip rsvp reservation, 18-27 show packet-cable gate, 21-61

Compass ID: 327594480 Version 3 Index-15


BSR 64000 Command Reference Guide Release 5.2.1

show packet-cable statistics, 21-64 show tacacs statistics, 1-236


show patches-installed, 1-184 show tcp brief, 2-102
show pool, 1-186 show tcp statistics, 2-103
show ppp info, 15-37 show tech, 1-237
show ppp statistics, 15-38 show update, 1-240
show process, 1-188 show user-group, 1-241
show process cpu, 1-190 show users, 1-243
show process memory, 1-194 show users ssh, 20-7
show process msg-q-info, 1-197 show vectron slot, 1-245
show process semaphores, 1-198 show version, 1-247
show process stack, 1-200 show xfabric, 1-249
show qos queue config, 14-5 shutdown, 2-107
show qos-lists, 14-5 slot, 1-251
show redundancy, 1-202 snmp-server access, 3-9
show redundancy cmts, 1-205 snmp-server chassis-id, 3-11
show redundancy dtx, 1-209 snmp-server community, 3-12
show redundancy srm, 1-212 snmp-server community-table, 3-13
show reload, 1-214 snmp-server contact, 3-16
show route-map, 6-40 snmp-server context, 3-17
show running-config, 1-215 snmp-server convert, 3-18
show running-config cable downstream port, 13-502 snmp-server docs-trap-control, 3-19
show snmp, 3-3 snmp-server enable informs, 3-21
show sntp, 2-101 snmp-server enable traps, 3-22
show srm alias, 1-217 snmp-server engineID, 3-24
show srm assetid, 1-218 snmp-server group, 3-25
show srm serial-num, 1-219 snmp-server host, 3-26
show ssh config, 20-3 snmp-server location, 3-29
show ssh hostkey-fingerprint, 20-6 snmp-server manager response-timeout, 3-30
show startup-config, 1-220 snmp-server notify, 3-31
show stats cmts, 13-504 snmp-server notify-filter, 3-33
show stats fastpath, 1-222 snmp-server notify-filter-profile, 3-35
show stats summary error, 13-507 snmp-server packetsize, 3-37
show stats xfabric, 1-225 snmp-server port number, 3-38
show system, 1-226 snmp-server shutdown, 3-39
show system alarms, 1-230 snmp-server sysname, 3-40
show system fans, 1-233 snmp-server target-addr, 3-41
show tacacs, 1-235 snmp-server target-params, 3-44

Index-16 Compass ID: 327594480 Version 3


Release 5.2.1 Index

snmp-server trap rate-limit, 3-47 ssh password-guesses, 20-17


snmp-server trap-source loopback, 3-48 ssh port, 20-18
snmp-server user, 3-49 ssh session-limit, 20-19
snmp-server view, 3-51 ssh timeout, 20-20
snr display, 13-509 ssh-keygen2, 20-11
snr loop, 13-510 summary-address, 8-55, 27-66
snr setup, 13-512 sync file, 1-256
snr setup-get, 13-514, 13-516 synchronization, 16-100
snr setup-spare-mod-profile, 13-515
snr start, 13-516
T
snr store, 13-517 tacacs-server host, 1-260
sntp authenticate, 2-108 tacacs-server key, 1-262
sntp authentication-key, 2-109 tacacs-server port, 1-263
sntp broadcast client, 2-111 tacacs-server reset-connections, 1-259
sntp broadcastdelay, 2-110 tacacs-server retry, 1-264
sntp disable, 2-112 tacacs-server timeout, 1-265
sntp response timeout, 2-113 tcm-encoding on, 13-520
sntp server, 2-114 telnet, 1-266
sntp source-interface loopback, 2-116 telnet authentication radius, 1-267
sntp timer, 2-117 telnet session-limit, 1-268
sntp trusted-key, 2-118 time band, 13-521
source-port 520, 7-27 time delete, 13-522
spd allow-dynamic-rsp, 21-69 timer, 23-23
spd override, 21-70 timers basic, 7-28
spd policy, 21-71 timers bgp, 16-101
spd preshared-key, 21-73 timers spf, 8-56
spectrum-copy, 13-518 tos-overwrite, 19-37
speed, 1-252 traceroute, 2-119
spreader on, 13-519 traceroute6, 26-36
srm alias, 1-253 trafpriority, 19-38
srm assetid, 1-254, 1-255 trap-enable-if, 2-121
ssh ciphers, 20-8 trap-enable-rdn, 2-122
ssh enable, 20-10 tunnel, 23-25
ssh load-host-key-files, 20-13 tunnel destination, 2-123
ssh logout session-id, 20-14 tunnel mode, 2-124
ssh message-authentication, 20-15 tunnel source, 2-125
ssh password-authentication radius, 20-16

Compass ID: 327594480 Version 3 Index-17


BSR 64000 Command Reference Guide Release 5.2.1

U
ugs-stats-window, 19-39
undebug all, 4-74
unresolved-ip-packet-throttle, 2-126
update bypass, 1-269
update chassis, 1-270
update slot, 1-271
username, 1-272
username privilege, 1-274
username user-group, 1-275

V
vendor-class-identifier, 13-523
vendor-param, 23-27
version, 7-30

X
xfabric keepalive, 1-276, 1-277

Index-18 Compass ID: 327594480 Version 3


Visit our website at:
www.motorola.com

Compass ID: 327594480 Version 3


9/09

Вам также может понравиться