Upload
phamthuy
View
243
Download
7
Embed Size (px)
Citation preview
Juniper Networks, Inc.
1194 North Mathilda Avenue
Sunnyvale, CA 94089
USA
408-745-2000
www.juniper.net
Part Number: 530-008220-01, Revision 1
Juniper NetworksG-series CMTS
CLI Reference
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
ii
Copyright © 2002, Juniper Networks, Inc. All rights reserved. Juniper Networks is registered in the U.S. Patent and Trademark Office and in other countries as a trademark of Juniper Networks, Inc. Broadband Cable Processor, ERX, ESP, G1, G10, G-series, Internet Processor, JUNOS, JUNOScript, M5, M10, M20, M40, M40e, M160, M-series, NMC-RX, SDX, ServiceGuard, T320, T640, T-series, UMC, and Unison are trademarks of Juniper Networks, Inc. All other trademarks, service marks, registered trademarks, or registered service marks are the property of their respective owners. All specifications are subject to change without notice.
Products made or sold by Juniper Networks (including the M5, M10, M20, M40, M40e, M160, and T320 routers, T640 routing node, and the JUNOS software) or components thereof might be covered by one or more of the following patents that are owned by or licensed to Juniper Networks: U.S. Patent Nos. 5,473,599, 5,905,725, 5,909,440, 6,333,650, 6,359,479, and 6,406,312.
G-series CMTS CLI ReferenceCopyright © 2002, Juniper Networks, Inc.All rights reserved. Printed in USA.
Writer: Jerry Isaac, Jim Stauffer, Dervinn CaldwellIllustrations: Paul GilmanCovers and template design: Edmonds Design
Revision History10 October 2002—First edition.
Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right to change, modify, transfer, or otherwise revise this publication without notice.
The Chassis Control Module and its corresponding G-series CMTS software perform encryption that is subject to U.S. Customs and Export regulations and shall not be exported, sold or transferred to a country outside the USA and Canada without an appropriate export license from the U.S. Government. The specific Regulations governing exports of encryption products are set forth in the Export Administration Regulations, 15 C.F.R. (Code of Federal Regulations), Parts 730-774.
••••••••••••••••••••••••••••••••••••••••••••••••
Table of Contents iii
Table of ContentsAbout This Manual
Purpose ...............................................................................................................xiiiOrganization ........................................................................................................xiiiDocument Conventions ....................................................................................... xiv
Notes, Cautions, and Warnings.....................................................................xivG-series CMTS Document Set................................................................................xv
Part 1CLI Commands
Chapter 1Command Summary ................................................................................................3
Chapter 2Command Listing .................................................................................................... 11
Management Commands......................................................................................11alias ......................................................................................................................12arp........................................................................................................................13arp timeout...........................................................................................................14auto-negotiation....................................................................................................15banner exec..........................................................................................................16banner incoming ..................................................................................................17banner login .........................................................................................................18banner motd.........................................................................................................19banner show.........................................................................................................20broadcast..............................................................................................................20cable address-verification .....................................................................................21cable arp-verify .....................................................................................................22cable authorize .....................................................................................................23cable broadcast-domain........................................................................................24cable dhcp-giaddr .................................................................................................25cable downstream add..........................................................................................27cable downstream channel-width .........................................................................28cable downstream frequency................................................................................29cable downstream interleave-depth ......................................................................30cable downstream modulation..............................................................................31cable downstream rf-power ..................................................................................32cable downstream show .......................................................................................33
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Referenceiv
cable downstream shutdown................................................................................34cable drop-unverifiable-addresses.........................................................................35cable filter group...................................................................................................36cable filter show ...................................................................................................38cable helper-address .............................................................................................39cable host downstream-filter default-group...........................................................40cable host upstream-filter default-group................................................................41cable insertion-interval .........................................................................................42cable ip-broadcast-echo ........................................................................................42cable ip-multicast-echo .........................................................................................43cable llc-filter index ..............................................................................................44cable llc-filter show...............................................................................................45cable llc-filter unmatched-action ...........................................................................46cable log-invalid-addresses ...................................................................................47cable log-unverifiable-addresses ...........................................................................48cable modem-config-file .......................................................................................49cable modem downstream-filter default-group .....................................................55cable modem flap-list ...........................................................................................56cable modem upstream-filter default-group ..........................................................58cable modulation-profile .......................................................................................59cable noise-cancellation........................................................................................61cable privacy ........................................................................................................62cable privacy check-cert-validity-periods...............................................................63cable privacy kek life-time ....................................................................................64cable privacy tek life-time.....................................................................................64cable privacy trust-self-signed-cert ........................................................................65cable proxy-arp.....................................................................................................66cable ranging-attempts .........................................................................................68cable relay-agent-option .......................................................................................69cable shared-secret ...............................................................................................70cable show............................................................................................................71cable source-verify................................................................................................72cable subscriber-group..........................................................................................74cable sync-interval ................................................................................................75cable ucd-interval .................................................................................................76cable upstream add ..............................................................................................77cable upstream channel-hopping ..........................................................................78cable upstream channel-width ..............................................................................79cable upstream concatenation ..............................................................................80cable upstream data-backoff.................................................................................81cable upstream force ............................................................................................83cable upstream frequency ....................................................................................84cable upstream-load-balance ................................................................................85cable upstream minislot-size ................................................................................85cable upstream modem flap-list............................................................................86cable upstream modulation-control ......................................................................88cable upstream modulation-profile .......................................................................89cable upstream port..............................................................................................90cable upstream-port spare ....................................................................................92cable upstream power-level ..................................................................................93cable upstream-pre-equalization ...........................................................................94cable upstream range-backoff...............................................................................95cable upstream show............................................................................................96cable upstream shutdown.....................................................................................97cable upstream width-control ...............................................................................98cable vpn..............................................................................................................99cat ......................................................................................................................100
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Table of Contents v
cd .......................................................................................................................100change-password ................................................................................................101chassis environment ambient-temperature.........................................................101clear aborted-modems........................................................................................102clear alarms ........................................................................................................103clear arp-cache....................................................................................................104clear cable modem .............................................................................................104clear cable modem flap-list .................................................................................105clock ...................................................................................................................106clock ntp-server ..................................................................................................107clock show..........................................................................................................108clock summer-time .............................................................................................109clock timezone....................................................................................................111configure memory ..............................................................................................112configure terminal ..............................................................................................112copy....................................................................................................................113cpe-controlled-cable-modem...............................................................................114debug..................................................................................................................115debug cable ........................................................................................................115debug cable arp ..................................................................................................116debug cable bpkm ..............................................................................................116debug cable bwr .................................................................................................117debug cable clear filter........................................................................................117debug cable clear log ..........................................................................................118debug cable dcc ..................................................................................................118debug cable dci...................................................................................................119debug cable dhcp................................................................................................120debug cable dynsrv.............................................................................................122debug cable icmp................................................................................................123debug cable interface cable.................................................................................124debug cable mac-address....................................................................................126debug cable mac-protocol ...................................................................................127debug cable map ................................................................................................128debug cable range...............................................................................................129debug cable registration......................................................................................130debug cable ucc ..................................................................................................131debug cable ucd..................................................................................................132debug cable updis ...............................................................................................133debug log-to-console ...........................................................................................133delete..................................................................................................................134description..........................................................................................................135dhcp-giaddr.........................................................................................................135dir.......................................................................................................................136disable ................................................................................................................136duplex.................................................................................................................137edit .....................................................................................................................137enable.................................................................................................................138erase startup-config ............................................................................................138exit .....................................................................................................................139ftp.......................................................................................................................140help ....................................................................................................................141helper-address ....................................................................................................142history ................................................................................................................142hostname............................................................................................................143interface cable ....................................................................................................144interface fastEthernet .........................................................................................145interface gigaEthernet.........................................................................................146
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Referencevi
ip address ...........................................................................................................147ip default-gateway ..............................................................................................148ip domain-name .................................................................................................148ip ftp-enable .......................................................................................................149ip name-server ...................................................................................................150ip show...............................................................................................................150ip telnet-enable...................................................................................................151kill ......................................................................................................................151log-level generate................................................................................................152log-level show.....................................................................................................154logout .................................................................................................................154ls ........................................................................................................................155mkdir..................................................................................................................156more...................................................................................................................156ping ....................................................................................................................157pwd ....................................................................................................................158relay-agent-option...............................................................................................158reload .................................................................................................................159rename...............................................................................................................160reset-slot.............................................................................................................161rmdir ..................................................................................................................161session timeout ..................................................................................................162show cable address-verification ..........................................................................163show cable flap-list .............................................................................................164show cable modem ............................................................................................166show cable modem connectivity ........................................................................170show cable modem cpe ......................................................................................172show cable modem offline..................................................................................174show cable modem phy......................................................................................175show cable modem registered ............................................................................177show cable modem unregistered ........................................................................178show cable modulation-profile............................................................................179show cable qos profile ........................................................................................179show cable shared-secret....................................................................................180show cable vpn...................................................................................................180show chassis environment..................................................................................181show chassis hardware.......................................................................................182show clock..........................................................................................................182show configuration .............................................................................................183show controller cable..........................................................................................183show cpu ............................................................................................................185show debugging..................................................................................................186show disk ...........................................................................................................186show history .......................................................................................................187show interfaces ..................................................................................................188show ip arp.........................................................................................................190show local-log .....................................................................................................191show memory ....................................................................................................192show privilege ....................................................................................................192show running-config ...........................................................................................193show startup-config ............................................................................................194show tech-support ..............................................................................................195show upgrade-log ...............................................................................................197show usernames.................................................................................................197show users..........................................................................................................198show version ......................................................................................................198show whoami .....................................................................................................199
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Table of Contents vii
show working-config...........................................................................................199shutdown............................................................................................................201snmp-server community.....................................................................................202snmp-server host ................................................................................................203speed ..................................................................................................................204system apply ......................................................................................................205system auto-rollback...........................................................................................207system commit ...................................................................................................207system config-backup .........................................................................................208system config-restore..........................................................................................208telnet ..................................................................................................................209terminal monitor ................................................................................................209terminal page-mode............................................................................................210terminal speed....................................................................................................210tftp......................................................................................................................211traceroute ...........................................................................................................211username............................................................................................................212who ....................................................................................................................213write memory.....................................................................................................214
Part 2Appendixes
Appendix ALogin, Prompts, and Keys ...............................................................................217
Login...................................................................................................................217Prompts..............................................................................................................217Key Commands ..................................................................................................218
Appendix BConfiguration Notes ...........................................................................................219
Slot Numbers ......................................................................................................219Interface, Port, and Channel Numbers................................................................220
Interface ......................................................................................................220Port .............................................................................................................220Channel .......................................................................................................221Defaults .......................................................................................................221
Appendix CSecurity ......................................................................................................................225
Groups ................................................................................................................225Privileges ............................................................................................................226Commands .........................................................................................................226Users ..................................................................................................................226
••••••••••••••••••••••••••••••••••••••••••••••••
List of Figures ix
List of FiguresList of Figures
Figure 1: G10 CMTS Slot Numbering ...............................................................219Figure 2: HFC Connector Module and Chassis Control Module ........................223Figure 3: G1 CMTS Rear Ports..........................................................................224
List of Figures
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Referencex
••••••••••••••••••••••••••••••••••••••••••••••••
List of Tables xi
List of TablesList of Tables
Table 1: Document Conventions .....................................................................xivTable 2: Command Summary ............................................................................3Table 3: Quick-Reference Commands ..............................................................11Table 4: Interleaver Depth Parameters .............................................................30Table 5: CM Configuration File TLV Type Names..............................................49Table 6: Event Priority Correspondence to CCM LEDs....................................103Table 7: Default Event Priority Logging and Reporting Assignment ................152Table 8: Flap-list Statistics ..............................................................................165Table 9: Parameters Displayed by ‘show cable modem’.................................168Table 10: Description of Online States .............................................................168Table 11: Description of CM Operational States ...............................................169Table 12: Parameters Displayed by ‘show cable modem connectivity’.............171Table 13: Parameters Displayed by ‘show cable modem cpe’ ..........................173Table 14: Parameters Displayed by ‘show cable modem phy’..........................176Table 15: Local Event Log Headings Displayed.................................................191Table 16: Key Commands ................................................................................218Table 17: G1 CMTS Slot Numbering .................................................................220Table 18: G10 CMTS Cable Interface to Ethernet Port Association....................220Table 19: G1 CMTS Cable Interface to Ethernet Port Association......................220Table 20: G10 CMTS Downstream Channel Assignment...................................221Table 21: G10 CMTS Upstream Channel Assignment (8 Channels) ...................221Table 22: G10 CMTS Upstream Channel Assignment (16 Channels) .................222Table 23: G1 CMTS Downstream Channel Assignment.....................................222Table 24: G1 CMTS Upstream Channel Assignment .........................................222Table 25: Group/Privilege Matrix......................................................................225Table 26: Hierarchy of Privileges......................................................................226
List of Tables
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Referencexii
••••••••••••••••••••••••••••••••••••••••••••••••
About This Manual xiii
About This Manual
This section describes important information about the design of this document.
Purpose
The purpose of this document, G-series CMTS CLI Reference, is to provide detailed descriptions of the commands used to operate a G-series Cable Modem Termination System (CMTS) through a command line interface (CLI). Instructions to perform specific tasks with commands are covered in the Installation and Operation manuals. This reference manual lists all commands and describes syntax, variables, and other guidance to facilitate their use.
The intended audience for this information is the technicians and engineers who will install, configure, operate, and maintain a G-series CMTS.
Organization
This document is organized as follows:
! Chapter 1, “Command Summary” – Provides a list of top-level commands and a list of all commands organized by hierarchy.
! Chapter 2, “Command Listing” – Provides an alphabetical listing of all commands. Includes syntax, definitions, examples, and further guidance where applicable.
! Appendix A, “Login, Prompts, and Keys” – Provides information about navigating and general operation of the CLI.
! Appendix B, “Configuration Notes” – Provides guidance in determining the slot, interface, port, and channel identifiers needed during configuration tasks.
! Appendix C, “Security” – Describes the groups and privileges used to implement security and user access in the CLI.
Document Conventions
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Referencexiv
Document Conventions
The following document conventions are used in this manual:
Table 1: Document Conventions
Notes, Cautions, and Warnings
General Conventions Italic font Denotes a) emphasis, b) first use of a new term, or c) a document title.
Screen Name font Denotes a) the on-screen name of a window, dialog box or field, or b) keys on a keyboard.
Software Conventions Computer font Font denotes code or messages displayed on-screen.
Computer Bold font Font denotes literal commands and parameters that you enter exactly as shown.
<Computer Italic> font Font denotes parameter values that require a user-defined input.
The value strings are enclosed in angle brackets <...>.
[parameter] Square brackets denote optional parameters.
{parameter} Braces denote required parameters.
| Vertical bars separate parameters in a group from which you must choose only one.
A note indicates information that might be helpful in a particular situation, or information that might otherwise be overlooked.
A caution indicates a situation that requires careful attention. Failure to observe a cautionary note could result in injury or discomfort to yourself, or serious damage to the product.
A warning is intended to alert the user of the presence of uninsulated dangerous voltage within the product’s enclosure that may present a risk of electric shock.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
About This Manual xv
Document Conventions
G-series CMTS Document Set
! G10 CMTS Installation and Operation
! G1 CMTS Installation and Operation
! G10 CMTS Functional Description
! G1 CMTS Functional Description
! G-series CMTS CLI Reference
! G-series CMTS SNMP and Enterprise MIB Specification
Document Conventions
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Referencexvi
••••••••••••••••••••••••••••••••••••••••••••••••
1
Part 1CLI Commands
! Command Summary on page 3
! Command Listing on page 11
••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 3
Chapter 1Command Summary
Table 2 lists all the CLI commands in hierarchical structure. Commands that are only applicable to the G10 CMTS are denoted as such.
The Group–Privilege column denotes the security access levels assigned to the command. Valid CLI groups are ip, rf, ad, and fs. A command that belongs to all four of these groups is designated as having a group of grp. A command that can be issued by all users, including those users not assigned to a group, is designated as having a group of all.
See Appendix C, “Security”, for more details regarding groups and privileges.
Table 2: Command Summary
Group –Privilege
Top Level Commands Subordinate Commands
all alias <alias> <alias-string>
all broadcast <broadcast-string>
rf-rw cable authorize <filename> <slot> (G10 CMTS only)
rf-rd cable modem-config-file show <config-file>
rf-rw cable modem-config-file generate-from-ascii <ascii-file> <config-file> [shared-secret <secret-string>]
rf-rw cable modem-config-file to-ascii <config-file> <ascii-file>
rf-rw cable upstream slot <slot> channel <channel> force [channel-width <width>] [frequency <frequency>] [minislot-size <minislot-size>] [modulation-profile <profile-id>]
fs-ro cat <file-name>
fs-ro cd [dir-name]
all change-password
rf-rw clear aborted-modems
ad-rw clear alarms [minor] [major] [critical]
ip-rw clear arp-cache
rf-rw clear cable modem {<ip-address>|<mac-address>} [cpe]
rf-rw clear cable modem [<mac-address>] flap-list
ad-rw clock adjust <adjustment>
ad-rw clock set <time> <day-of-month> <month-of-year> <year>
grp-rw configure memory
grp-rw configure terminal
ip-rw arp <ip-address> <mac-address> [vlan-id <vlan-id>]
ip-rw arp timeout <seconds>
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference4
ad-rw banner exec <banner-string>
ad-rw banner incoming <banner-string>
ad-rw banner login <banner-string>
ad-rw banner motd <banner-string>
ad-rw banner show
ip-rw cable address-verification <ip-address> <mac-address>
ip-rw cable arp-verify
ip-rw cable drop-unverifiable-addresses
ip-rw cable filter group <pkt-filter-grp> index <index> match-action {discard|accept} [src-ip <src-ip-addr> src-mask <src-mask> dest-ip <dest-ip-addr> dest-mask <dest-mask> ip-proto <l4-protocol> ip-tos <tos-byte> ip-tos-mask <tos-mask> src-port <src-port> dest-port <dest-port> tcp-flags <tcp-flags> tcp-flags-mask <tcp-flags-mask>]
grp-rw cable filter show
ip-rw cable host downstream-filter default-group <pkt-filter-grp>
ip-rw cable host upstream-filter default-group <pkt-filter-grp>
ip-rw cable llc-filter index <index> interface <if-index> protocol-type {dsap|ethertype} protocol <l3-protocol>
ip-rw cable llc-filter show
ip-rw cable llc-filter unmatched-action {accept|discard}
ip-rw cable log-invalid-addresses
ip-rw cable log-unverifiable-addresses
ip-rw cable modem downstream-filter default-group <pkt-filter-grp>
rf-rw cable modem flap-list snr-threshold <snr-threshold>
rf-rw cable modem flap-list mer-threshold <mer-threshold>
rf-rw cable modem flap-list cer-threshold <cer-threshold>
rf-rw cable modem flap-list power-adjust-threshold <power-adjust-threshold>
rf-rw cable modem flap-list im-retry-interval <im-retry-interval>
rf-rw cable modem flap-list sm-miss-threshold <sm-miss-threshold>
rf-rw cable modem flap-list size <size>
rf-rw cable modem flap-list age-time <days> [<hours> [<minutes>]]
rf-rw cable modem flap-list show
ip-rw cable modem upstream-filter default-group <pkt-filter-grp>
rf-rw cable modulation-profile <profile-id> request <p1> <p2> <p3> <p4> <p5> <p6> <p7> <p8> <p9> <p10>
rf-rw cable modulation-profile <profile-id> reqdata <p1> <p2> <p3> <p4> <p5> <p6> <p7> <p8> <p9> <p10>
rf-rw cable modulation-profile <profile-id> initial <p1> <p2> <p3> <p4> <p5> <p6> <p7> <p8> <p9> <p10>
rf-rw cable modulation-profile <profile-id> station <p1> <p2> <p3> <p4> <p5> <p6> <p7> <p8> <p9> <p10>
rf-rw cable modulation-profile <profile-id> short <p1> <p2> <p3> <p4> <p5> <p6> <p7> <p8> <p9> <p10>
rf-rw cable modulation-profile <profile-id> long <p1> <p2> <p3> <p4> <p5> <p6> <p7> <p8> <p9> <p10>
rf-rw cable modulation-profile <profile-id> show
rf-rw cable noise-cancellation
rf-rw cable shared-secret <secret-string> [encrypted]
rf-rw cable shared-secret show
ip-rw cable source-verify [DHCP]
rf-rw cable upstream-load-balance
rf-rw cable upstream-port slot <slot> port <port> spare center-frequency <frequency> width <width>
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 5
rf-rw cable upstream-pre-equalization
ip-rw cable vpn <mac-address> <vpn-id>
ad-rw chassis environment ambient-temperature {user-high-threshold <high-threshold>} | {user-low-threshold <low-threshold>}
ad-rw clock ntp-server <ip-address>
grp-rw clock show
ad-rw clock summer-time <time-zone> date <date-start> <month-start> <time-start> <date-end> <month-end> <time-end> [<offset>]
ad-rw clock summer-time <time-zone> recurring <week-start> <weekday-start> <month-start> <time-start> <week-end> <weekday-end> <month-end> <time-end> [<offset>]
ad-rw clock timezone <timezone> <hour-offset> [<min-offset>]
ad-rw hostname <“name”>|show
grp-rw interface cable <slot>/<if>
ip-rw cable broadcast-domain <domain-id>
ip-rw cable dhcp-giaddr <ip-address> [cable-modem|host]
rf-rw cable downstream <channel> add
rf-rw cable downstream <channel> channel-width
rf-rw cable downstream <channel> frequency <frequency>
rf-rw cable downstream <channel> interleave-depth {8|16|32|64|128}
rf-rw cable downstream <channel> modulation {64qam|256qam}
rf-rw cable downstream <channel> rf-power <power-level>
rf-rw cable downstream <channel> show
rf-rw cable downstream <channel> shutdown
ip-rw cable helper-address <ip-address> [<next-hop>] [cable-modem|host]
rf-rw cable insertion-interval <interval>
ip-rw cable ip-broadcast-echo
ip-rw cable ip-multicast-echo
rf-rw cable privacy [enforce]
rf-rw cable privacy check-cert-validity-periods
rf-rw cable privacy kek-life-time <seconds>
rf-rw cable privacy tek-life-time <seconds>
rf-rw cable privacy trust-self-signed-cert
ip-rw cable proxy-arp
rf-rw cable ranging-attempts <number-of-attempts>
ip-rw cable relay-agent-option
grp-rw cable show
ip-rw cable subscriber-group <group-name>
ip-rw dhcp-giaddr <ip-address> [cable-modem|host]
ip-rw helper-address <ip-address> <next-hop> [cable-modem|host]
ip-rw relay-agent-option
rf-rw cable sync-interval <interval>
rf-rw cable ucd-interval <interval>
rf-rw cable upstream <channel> add
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference6
rf-rw cable upstream <channel> channel-hopping
rf-rw cable upstream <channel> channel-width <width>
rf-rw cable upstream <channel> concatenation
rf-rw cable upstream <channel> data-backoff <start> <end>
rf-rw cable upstream <channel> frequency
rf-rw cable upstream <channel> minislot-size <minislot-size>
rf-rw cable upstream <channel> modem flap-list snr-threshold <snr-threshold>
rf-rw cable upstream <channel> modem flap-list mer-threshold <mer-threshold>
rf-rw cable upstream <channel> modem flap-list cer-threshold <cer-threshold>
rf-rw cable upstream <channel> modem flap-list power-adjust-threshold <power-adjust-threshold>
rf-rw cable upstream <channel> modem flap-list im-retry-interval <im-retry-interval>
rf-rw cable upstream <channel> modem flap-list sm-miss-threshold <sm-miss-threshold>
rf-rw cable upstream <channel> modem flap-list show
rf-rw cable upstream <channel> modulation-control
rf-rw cable upstream <channel> modulation-profile <profile-id>
rf-rw cable upstream <channel> port <port>
rf-rw cable upstream <channel> power-level <power-level>
rf-rw cable upstream <channel> range-backoff <start> <end>
rf-rw cable upstream <channel> show
rf-rw cable upstream <channel> shutdown
rf-rw cable upstream <channel> width-control
rf-rw, ip-rw description <string>
rf-rw, ip-rw shutdown
ip-rw interface fastEthernet <slot>/<if>
ip-rw auto-negotiation {on|off}
ip-rw description <string>
ip-rw duplex {full|half}
ip-rw ip address <ip-address> <mask>
ip-rw show
ip-rw shutdown
ip-rw speed {10|100}
ip-rw interface gigaEthernet <slot>/<if> (G10 CMTS only)
ip-rw description <string>
ip-rw show
ip-rw shutdown
ip-rw ip default-gateway <ip-address> management
ip-rw ip domain-name <domain>
ip-rw ip ftp-enable
ip-rw ip name-server <ip-address>
ip-rw ip show
ip-rw ip telnet-enable
ad-rw log-level <level-name> generate [local-log] [local-volatile-log] [syslog] [trap]
ad-rw log-level show
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 7
ad-rw session timeout <seconds> [console]
ad-rw snmp-server community <community-string> {ro|rw}
ad-rw snmp-server host <ip-address> version {1|2c} [port <port-number>]
ad-rw snmp-server host show
ad-rw username <name> group {ad|ip|rf|fs} privilege {rw|rd|ro}
ad-rw username <name> password <password>
ad-rw username <name> prompt <prompt-string>
fs-rw copy <source-file> <dest-file>|<dest-dir>
rf-rw cpe-controlled-cable-modem <mac-address> disable {forever|<time-to-disable>}
rf-rw cpe-controlled-cable-modem <mac-address> reset
grp-rd debug (“no” form only)
grp-rd debug cable
grp-rd debug cable arp
grp-rd debug cable bpkm
grp-rd debug cable bwr
grp-rd debug cable clear filter
grp-rd debug cable clear log
grp-rd debug cable dcc
grp-rd debug cable dci
grp-rd debug cable dhcp
grp-rd debug cable dynsrv
grp-rd debug cable icmp
grp-rd debug cable interface cable
grp-rd debug cable interface cable <slot/if> mac-address <mac-address> <mac-mask> [verbose]
grp-rd debug cable interface cable <slot/if> sid <sid> [verbose]
grp-rd debug cable interface cable <slot/if> [verbose]
grp-rd debug cable mac-address <mac-address> <mac-mask> [verbose]
grp-rd debug cable mac-protocol
grp-rd debug cable map
grp-rd debug cable range
grp-rd debug cable registration
grp-rd debug cable ucc
grp-rd debug cable ucd
grp-rd debug cable updis
ad-rd, ip-rd, rf-rd
debug log-to-console
fs-rw delete <file-name>
fs-ro dir [directory-name]
all disable
fs-rw edit <filename>
all enable
ad-rw erase startup-config
all exit [all]
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference8
ad-rw, fs-rw ftp {<hostname>|<ip-address>}
all help [edit-keys] (Available at all levels)
all history (available at all levels)
ad-rw kill <session-id>
all logout
fs-ro ls (same as dir)
fs-rw mkdir <dir-name>
fs-ro more <file-name>
all ping [ip] {<ip-address>|<hostname>}
all ping cable-modem {<ip-address>|<mac-address>}
fs-ro pwd
ad-rw reload [show|cancel]
ad-rw reload at <time>
ad-rw reload in <minutes>
fs-rw rename <source-filename> <dest-filename>
ad-rw reset-slot <slot>
fs-rw rmdir <directory-name>
all show cable address-verification [<ip-address>|<mac-address>|<slot/if>]
all show cable flap-list [by-total-flaps]
all show cable flap-list [by-time]
all show cable flap-list [by-snr-flaps]
all show cable flap-list [by-cer-flaps]
all show cable flap-list [by-mer-flaps]
all show cable flap-list [by-im-flaps]
all show cable flap-list [by-sm-flaps]
all show cable flap-list [by-power-adjust]
all show cable flap-list by-interface [<slot> [<if>]]
all show cable flap-list by-upstream [<slot> [<channel>]]
all show cable flap-list by-mac [<mac-address>]
all show cable modem [summary [total]]
all show cable modem <slot/if> [upstream <channel>] [summary [total]]
all show cable modem <ip-address>|<mac-address>
all show cable modem [<ip-address>|<mac-address>] connectivity
all show cable modem <slot/if> [upstream <channel>] connectivity
all show cable modem [<ip-address>|<mac-address>] cpe
all show cable modem <slot/if> [upstream <channel>] cpe
all show cable modem <slot/if> sid <sid> cpe
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 9
all show cable modem [<ip-address>|<mac-address>] offline
all show cable modem <slot/if> [upstream <channel>] offline
all show cable modem [<ip-address>|<mac-address>] phy
all show cable modem <slot/if> [upstream <channel>] phy
all show cable modem [<ip-address>|<mac-address>] registered
all show cable modem <slot/if> [upstream <channel>] registered
all show cable modem [<ip-address>|<mac-address>] unregistered
all show cable modem <slot/if> [upstream <channel>] unregistered
all show cable modulation-profile [<profile-id> [<iuc>]]
all show cable qos profile [<qos-profile-id>]
all show cable
all show cable vpn <vpn-id>
all show chassis environment
all show chassis hardware [detail]
all show clock
all show configuration (same as show startup-config)
all show controller cable [<slot/if> [downstream <channel> | upstream <channel>]]
all show cpu [<interval> [<repeat>]]
all show debugging
all-ro show disk
all show history
all show interfaces cable <slot/if> downstream [<channel>]
all show interfaces cable <slot/if> upstream [<channel>]
all show interfaces cable <slot/if> sid [<sid>]
all show interfaces fastEthernet <slot/if>
all show interfaces gigaEthernet <slot/if>
all show ip arp [<ip-address>|<mac-address>|<slot/if>]
all show local-log
all show memory
all show privilege
all show running-config
all show startup-config
all show tech-support
all show upgrade-log
all show usernames
all show users
all show version [normal|failsafe|upgrade]
all show whoami
all show working-config
ad-rw system apply {normal|failsafe|upgrade [<filename>]}
ad-rw system auto-rollback
ad-rw system commit
ad-rw system config-backup <filename>
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference10
ad-rw system config-restore {factory|<filename>}
all telnet {<hostname>|<ip-address>}
grp-rd terminal monitor
all terminal page-mode
grp-rd terminal speed <speed>
fs-rw tftp get|put <ip-address> <filename>
all traceroute {<ip-address>|<host-name>}
all who
grp-rw write memory
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing 11
Chapter 2Command Listing
This section lists all the CLI commands in alphabetical order.
Management Commands
Table 3 provides a quick-reference list of commands commonly used for general management tasks.
Table 3: Quick-Reference Commands
All command parameters, both mandatory and optional, must be entered in the exact order specified in the Syntax section of the command description.
Administration Utility
username (config term mode) copy
clock delete
change-password (config term mode) cd
hostname dir / ls
enable mkdir
disable rmdir
reload pwd
exit more
logout edit
alias
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference12
alias
This command creates an alias for a string of text. A single-character delimiter of " must be used before and after the alias and the alias string if they are greater than one word. The delimiter cannot be used within the body of the string.
! alias is a top-level command and is available to all users.
! Omitting the alias-string parameter clears the alias.
Syntax alias <“alias”> <“alias-string”>
Definitions
Examples GX$root# alias ct “configure terminal”
GX$root# ct
GX$root(config)#
Use ct as the alias for configure terminal.
GX$root(config)# exit
GX$root# alias ct
Clear the ct alias.
alias Specifies the alias to be used.
alias-string Specifies the string to be aliased.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
arp
13
arp
This command adds static entries (entries that never time out) to the ARP (address resolution protocol) table cache in the CMTS. ARP is used to associate IP addresses to MAC addresses. If a static or dynamic table entry with the specified IP address already exists, that entry is updated with the given MAC address (if an optional VLAN ID is given, the IP address and the VLAN ID must match those of an existing entry for that entry to be updated).
! arp is a command within the configure terminal mode and requires read-write privilege.
! The no form of this command removes static or dynamic entries in the ARP table that match the specified IP address. If the IP address is part of multiple virtual LANs (VLANs), all entries that match the IP address are removed.
! If the optional parameter vlan-id is not specified, this command refers to untagged ARP entries.
Syntax arp <ip-address> <mac-address> [vlan-id <vlan-id>]
no arp <ip-address>
Definitions
Examples GX$root# configure terminal
GX$root(config)# arp 192.203.56.9 1234.5678.9ABC vlan-id 3
A static ARP table entry is created with an IP address of 192.203.56.9, a MAC address of 1234.5678.9ABC, and a VLAN ID of 3.
Related Commands arp timeoutcable address-verificationcable proxy-arpcable vpnclear arp-cacheshow ip arp
ip-address The IP address of the ARP table entry. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the ARP table entry. Specified as xxxx.xxxx.xxxx in hexadecimal.
vlan-id The VLAN ID of the ARP table entry. Valid range is 1–4095. An unspecified VLAN ID is represented in the ARP table as 0.
arp timeout
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference14
arp timeout
This command defines the timeout duration of a dynamic entry in the ARP (Address Resolution Protocol) table cache. This command applies to all cable interfaces.
! arp timeout is a command within the configure terminal mode and requires read-write privilege.
! The no form of this command resets the timeout duration to the default of 600 seconds (10 minutes).
Syntax arp timeout <seconds>
no arp timeout
Definitions
Examples GX$root# configure terminal
GX$root(config)# arp timeout 1200
The timeout duration for dynamic ARP entries is set to 1200 seconds (20 minutes).
Related Commands arpcable address-verificationcable proxy-arpcable vpnclear arp-cacheshow ip arp
seconds The timeout duration, in seconds, of a dynamic ARP entry. Valid range is 0–4294967295. A value of 0 specifies that dynamic entries do not timeout.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
auto-negotiation
15
auto-negotiation
This command enables or disables the automatic negotiation of link speed and duplex setting for the Fast Ethernet interfaces on the DOCSIS Module and the NIC Module.
! auto-negotiation is a command within the interface fastEthernet sub-mode and requires read-write privilege.
! This command does not have a no form.
! The default setting of this command is on.
Syntax auto-negotiation {on|off}
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface fastEthernet 6/0
GX$root(config-if-f6/0)# auto-negotiation on
Enables auto-negotiation for Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS.
Guidance When auto-negotiation is enabled, the CMTS ignores any previous setting for link speed or duplicity and tries to negotiate the best possible link speed and duplicity. When auto-negotiation is disabled, the CMTS leaves the Ethernet link’s speed and duplicity unchanged. That is, the Ethernet interface continues to operate with the previously negotiated settings until explicitly changed by the operator.
Related Commands duplexshowshutdownspeed
on This option enables the automatic negotiation of link speed and duplex setting for an Ethernet interface.
off This option disables the automatic negotiation of link speed and duplex setting for an Ethernet interface.
banner exec
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference16
banner exec
This command specifies a banner that is displayed after a user successfully logs in and the CMTS enters its command execution mode. A single-character delimiter of " must be used before and after the specified banner if the banner is greater than one word. The delimiter cannot be used within the body of the banner.
! banner exec is a command within the configure terminal mode and requires read-write privilege.
! no banner exec removes the banner display.
Syntax banner exec <"banner-string">
no banner exec
Definitions
Examples GX$root# configure terminal
GX$root(config)# banner exec "Exec Banner"
The banner displayed will be Exec Banner:
Login: root
Password:
Exec Banner
G10$root#
Related Commands banner incomingbanner loginbanner motdbanner show
banner-string Specifies the banner that is displayed. The string is comprised of a sequence of text characters
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
banner incoming
17
banner incoming
This command specifies a banner that is displayed before the login prompt when connecting to the CMTS through a console session. A single-character delimiter of " must be used before and after the specified banner if the banner is greater than one word. The delimiter cannot be used within the body of the banner.
! banner incoming is a command within the configure terminal mode and requires read-write privilege.
! no banner incoming removes the banner display.
Syntax banner incoming <"banner-string">
no banner incoming
Definitions
Examples GX$root# configure terminal
GX$root(config)# banner login "Incoming Banner"
The banner displayed will be Incoming Banner:
Copyright (c) 2000-2002 Juniper Networks, Inc.
G10 CMTS Release 2.0.1.19
Incoming Banner
Login:
Related Commands banner execbanner loginbanner motdbanner show
banner-string Specifies the banner that is displayed. The string is comprised of a sequence of text characters
banner login
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference18
banner login
This command specifies a banner that is displayed before the login prompt when connecting to the CMTS through a Telnet session. A single-character delimiter of " must be used before and after the specified banner if the banner is greater than one word. The delimiter cannot be used within the body of the banner.
! banner login is a command within the configure terminal mode and requires read-write privilege.
! no banner login removes the banner display.
Syntax banner login <"banner-string">
no banner login
Definitions
Examples GX$root# configure terminal
GX$root(config)# banner login "Login Banner"
The banner displayed will be Login Banner.
Copyright (c) 2000-2002 Juniper Networks, Inc.
G10 CMTS Release 2.0.1.19
Login Banner
Login:
Related Commands banner execbanner incomingbanner motdbanner show
banner-string Specifies the banner that is displayed. The string is comprised of a sequence of text characters
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
banner motd
19
banner motd
This command specifies a banner that is displayed before the login prompt when connecting to the CMTS through a Telnet or console session. If an incoming banner or a login banner has been specified, the motd banner is displayed immediately before it. A single-character delimiter of " must be used before and after the specified banner if the banner is greater than one word. The delimiter cannot be used within the body of the banner.
! banner motd is a command within the configure terminal mode and requires read-write privilege.
! no banner motd removes the banner display.
Syntax banner motd <"banner-string">
no banner motd
Definitions
Examples GX$root# configure terminal
GX$root(config)# banner login "Login Banner"
GX$root(config)# banner motd "MOTD Banner"
The motd banner (MOTD Banner) is displayed immediately before the login banner (Login Banner).
Copyright (c) 2000-2002 Juniper Networks, Inc.
G10 CMTS Release 2.0.1.19
MOTD Banner
Login Banner
Login:
Related Commands banner execbanner incomingbanner loginbanner show
banner-string Specifies the banner that is displayed. The string is comprised of a sequence of text characters.
banner show
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference20
banner show
This command is used to display the exec, incoming, login, and motd banners.
! banner show is a command within the configure terminal mode and requires read-write privilege.
Syntax banner show
Examples GX$root# configure terminal
GX$root(config)# banner show
Exec banner : This is an exec banner
Incoming banner : This is an incoming banner
login banner : This is a login banner
motd banner : This is an motd banner
Related Commands banner execbanner incomingbanner loginbanner motd
broadcast
This command sends a broadcast message to all sessions. A single-character delimiter of " must be used before and after the broadcast string if the string is greater than one word. The delimiter cannot be used within the body of the string.
! broadcast is a top-level command and is available to all users.
Syntax broadcast <“broadcast-string”>
Definitions
Examples GX$root# broadcast “Please logoff now”
The broadcast string “Please logoff now” is sent to all sessions.
broadcast-string Specifies the broadcast string.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable address-verification
21
cable address-verification
This command adds static entries (entries that never time out) to the address verification table in the CMTS. If a static or dynamic table entry with the specified IP address already exists, that entry is updated with the given MAC address.
! cable address-verification is a command within the configure terminal mode and requires read-write privilege.
! The no form of this command removes static or dynamic entries in the address verification table that match the specified IP address. If the optional parameter ip-address is not specified, the entire address verification table is cleared.
Syntax cable address-verification <ip-address> <mac-address>
no cable address-verification [<ip-address>]
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable address-verification 192.203.56.9 1234.5678.9ABC
A static address verification table entry is created with an IP address of 192.203.56.9 and a MAC address of 1234.5678.9ABC.
Related Commands cable arp-verifycable drop-unverifiable-addressescable source-verifyshow cable address-verification
ip-address The IP address of the address verification table entry. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the address verification table entry. Specified as xxxx.xxxx.xxxx in hexadecimal.
cable arp-verify
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference22
cable arp-verify
This command enables ARP verification—also referred to as ARP authentication. All ARP packets—requests and responses—are checked against an address verification table that contains the correspondence between a CM’s IP address, MAC address, and internal CM ID. There are three possible outcomes of the address verification check:
1. If the IP address of an ARP packet is found in the address verification table, and the source MAC address and CM ID match those in the table entry, the packet is considered valid and the CMTS appropriately proxies (if enabled) or forwards the packet.
2. If the IP address of an ARP packet is found in the address verification table, and the source MAC address and/or CM ID do not match those in the table entry, the packet is considered invalid and the CMTS unconditionally drops it.
3. If the IP address of an ARP packet is not found in the address verification table, the packet is considered unverifiable. By default, unverifiable ARP packets are forwarded unless the cable drop-unverifiable-addresses command enables the dropping of these packets.
! cable arp-verify is a command within the configure terminal mode and requires read-write privilege.
! no cable arp-verify disables ARP packet verification. DHCP lease queries are no longer issued, regardless of the previous state of the lease query.
! By default, ARP packet verification is disabled.
Syntax cable arp-verify [DHCP]
no cable arp-verify
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable arp-verify
Verify all ARP packets (without DHCP lease query).
Related Commands arpcable address-verificationcable broadcast-domaincable drop-unverifiable-addressescable ip-broadcast-echocable ip-multicast-echocable proxy-arpcable source-verifyclear arp-cacheshow cable address-verificationshow ip arp
DHCP If DHCP is specified and the source IP address of the ARP packet cannot be found in the address verification table, the CMTS issues DHCP lease queries to attempt to learn the association between the IP address, the MAC address, and the CM. The address verification table is updated accordingly.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable authorize
23
cable authorize
This command is used to upgrade a DOCSIS Module from a 4x8 configuration (four downstream channels and eight upstream channels) to a 4x16 configuration. The upgrade requires you to purchase a software key file that must be transferred to the CMTS prior to issuing this command. The ftp or tftp command can be used for the file transfer.
! cable authorize is a top-level command and requires read-write privilege.
! The DOCSIS Module must be rebooted to enable the usage of the eight new upstream channels.
! Issuing the show chassis hardware command displays the upgrade as a separate line item (specifying the optional parameter detail might be required, depending on the software release).
Syntax cable authorize <filename> <slot>
Definitions
Examples GX$root# cable authorize /home/myfile 2
GX$root# reset-slot 2
Upgrade the DOCSIS Module in slot 2 from a 4x8 to a 4x16 configuration. Reboot the DOCSIS Module to enable the eight additional upstream channels.
Related Commands ftpreset-slotshow chassis hardwaretftp
This command is applicable only to the G10 CMTS.
filename The absolute path and filename of the software key file.
slot Chassis slot number of the DOCSIS Module to be upgraded. (1 to 4 or 10 to 13). See the diagram in “Interface, Port, and Channel Numbers” on page 220
The filename parameter must be specified with an absolute path.
cable broadcast-domain
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference24
cable broadcast-domain
This command defines the broadcast domain scope for the targeted slot/interface. Multiple slot/interfaces (MAC domains) can belong to the same broadcast domain. However, a MAC domain can only be part of one broadcast domain, so a second instance of this command overrides the previous domain ID. Broadcast domains are implemented using VLAN tags. A corresponding VLAN for the broadcast domain must be configured on the upstream router or switch.
! cable broadcast-domain is a command within the interface cable sub-mode and requires read-write privilege.
! no cable broadcast-domain resets the broadcast domain to the default (untagged packets).
Syntax cable broadcast-domain <domain-id>
no cable broadcast-domain
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable broadcast-domain 2
GX$root(config-if-c2/0)# exit
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable broadcast-domain 2
Defines interfaces 0 and 1 of slot 2 to the same broadcast domain, and assigns a broadcast domain ID of 2 for these interfaces.
Related Commands cable ip-broadcast-echocable ip-multicast-echocable proxy-arp
domain-id The ID assigned to the broadcast domain for the targeted slot/interface. Valid range is 1–128.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable dhcp-giaddr
25
cable dhcp-giaddr
This command is used to specify the IP address for a cable interface, and is also used by the CMTS while relaying DHCP packets originating from cable modem and CPE devices connected to the cable interface. The GIADDR is a standard option in DHCP requests that is used by the DHCP server to select an IP address pool (also known as the DHCP scope) from which to assign the IP addresses. The CMTS allows you to specify separate GIADDRs for cable modems and for CPE devices to simplify the provisioning scenario where separate IP address pools have been assigned for cable modems and CPEs, but only a single DHCP server is used.
The GIADDR configured for a cable interface is owned by the CMTS. This enables the CMTS to directly receive the DHCP message responses sent by the DHCP server.
Multiple GIADDRs can be configured for the CPE devices, in which case the relay agent uses a round robin algorithm to assign the GIADDR address to CPE device DHCP Discover/Request messages. Multiple GIADDRs are configured to distribute the CPE devices evenly within all the multiple subnets behind a single cable interface.
Other ways to distinguish DHCP requests from cable modems and CPEs are also supported (see the Related Commands section).
! cable dhcp-giaddr is a command within the interface cable sub-mode and requires read-write privilege.
! no cable dhcp-giaddr removes the configured GIADDR.
! Only one GIADDR can be configured for a CM.
! A maximum of 16 GIADDRs can be configured for CPE devices.
! Any DHCP configuration performed at the interface cable sub-mode level applies to the default subscriber group for that cable interface (see the cable subscriber-group command for more details).
Syntax cable dhcp-giaddr <ip-address> [cable-modem|host]
no cable dhcp-giaddr <ip-address> [cable-modem|host]
Definitions
ip-address The IP address assigned to the cable interface, and the IP address of the relay agent for the DHCP server. Standard dot-quad notation (xxx.xxx.xxx.xxx).
cable-modem Specifies the IP address is for cable modems.
host Specifies the IP address is for hosts (CPE devices).
If neither the cable-modem nor the host keyword is given, the specified dhcp-giaddr is used for both cable modems and CPE devices.
cable dhcp-giaddr
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference26
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable dhcp-giaddr 192.111.210.88
Assigns IP address 192.111.210.88 to slot 2 / interface 1, and configures this address as the GIADDR for CMs and CPE devices. This GIADDR will be used by the relay agent to forward CM and CPE Discover/Request messages to the DHCP server.
GX$root(config-if-c2/1)# cable dhcp-giaddr 192.111.211.7 host
GX$root(config-if-c2/1)# cable dhcp-giaddr 192.111.212.7 host
Configures two GIADDRs for CPE devices, which will be used by the relay agent in a round robin fashion to forward CPE Discover/Request messages to the DHCP server.
Related Commands cable helper-addresscable relay-agent-optioncable subscriber-groupdhcp-giaddrhelper-addressrelay-agent-option
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream add
27
cable downstream add
This command adds the given downstream channel to the targeted cable interface.
! cable downstream add is a command within the interface cable sub-mode and requires read-write privilege.
! no cable downstream add removes the given downstream channel from the targeted cable interface.
! Up to four (G10 CMTS) or two (G1 CMTS) downstream channels can be added to a cable interface.
! By default, downstream channels 0–3 of a DOCSIS Module are assigned to the same-numbered cable interfaces 0–3, respectively, for the G10 CMTS. Likewise, downstream channels 0–1 are assigned to the same-numbered cable interfaces 0–1, respectively, for the G1 CMTS. See “Configuration Notes” on page 219 for details.
Syntax cable downstream <channel> add
no cable downstream <channel> add
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable downstream 1 add
Add downstream channel 1 to slot 2 / interface 0.
Related Commands cable downstream showcable upstream add
Guidance
See the “Guidance” section for recommendations on the maximum number of downstream channels per cable interface.
channel The channel to assign to the cable interface (0–3 for the G10 CMTS, 0–1 for the G1 CMTS). This is a channel in the slot/if specified by the interface cable command.
The following guidance applies only to the G10 CMTS.
cable downstream channel-width
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference28
Each DOCSIS Module contains two downstream processing paths. The traffic through even numbered cable interfaces (0 and 2) is forwarded through Ethernet port 0 on one path, while the traffic through odd numbered cable interfaces (1 and 3) is forwarded through the Ethernet port 1 on the other path. This implies, for example, that all downstream channels that reside in the even interfaces are handled within the same downstream processing path. Therefore, to load balance the traffic, we recommend that the number of downstream channels assigned to interface 0, plus the number of downstream channels assigned to interface 2, be no greater than two. The same recommendation applies to the odd interfaces.
cable downstream channel-width
This command sets the channel width for a downstream channel in the targeted slot/interface.
! cable downstream channel-width is a command within the interface cable sub-mode and requires read-write privilege.
! no cable downstream channel-width sets the downstream channel-width to the default value.
! The default setting for this command is 6000000 Hz (for DOCSIS) and 8000000 Hz (for EuroDOCSIS).
Syntax cable downstream <channel> channel-width <width>
no cable downstream <channel> channel-width <width>
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable downstream 1 channel-width 8000000
The downstream channel width for channel 1 in slot 2 / interface 1 is set to 8 MHz.
Related Commands cable downstream show
channel The channel for which the width is being set (0–3 for the G10 CMTS, 0–1 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
width The channel width (in Hz) of the channel being set. Choices are 6000000 (DOCSIS) and 8000000 (EuroDOCSIS).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream frequency
29
cable downstream frequency
This command sets the IF-to-RF upconverter output frequency for the specified downstream channel in the DOCSIS Module identified by slot/interface. The DOCSIS Radio Frequency Interface Specification requires that a CMTS must output an RF modulated signal in the downstream with a center frequency from 91 MHz to 857 MHz. However, the upconverter can be programmed within the range of 54 MHz to 1 GHz.
! cable downstream frequency is a command within the interface cable sub-mode and requires read-write privilege.
! no cable downstream frequency resets the upconverter to its default frequency and disables the output of the upconverter.
! The default frequencies for the four downstream channels are 531000000, 567000000, 603000000, and 639000000 Hz.
Syntax cable downstream <channel> frequency <frequency>
no cable downstream <channel> frequency
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable downstream 1 frequency 105000000
The center frequency for downstream channel 1 in slot 2 / interface 1 is set to 105000000 Hz (105 MHz).
Related Commands cable downstream showcable downstream rf-powercable downstream modulation
channel The channel for which the frequency is being set (0–3 for the G10 CMTS, 0–1 for the G1 CMTS). This is a channel in the slot/if specified by the interface cable command.
frequency The center frequency, in Hz, for the channel.
DOCSIS: 91000000 to 857000000EuroDOCSIS: 109000000 to 861000000
Unlike specifying the frequency parameter for an upstream channel, the G10 CMTS does not take into account the channel width prior to checking the valid range of the frequency parameter for a downstream channel.
cable downstream interleave-depth
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference30
cable downstream interleave-depth
This command sets the depth of the interleaver for the specified downstream channel. ITU-T Recommendations J.83 requires that convolutional interleaving be employed to facilitate the correction of burst noise induced errors. As the interleave depth is increased, the amount of burst protection increases, but the latency of the data transmission also increases. Table 4 defines the relation between the interleave-depth parameters, the “I” and “J” characteristics of the interleaver, and the latency and burst protection durations for 64QAM and 256QAM.
Where:
I = number of registersJ = symbol increment
Table 4: Interleaver Depth Parameters
! cable downstream interleave-depth is a command within the interface cable sub-mode and requires read-write privilege.
! no cable downstream interleave-depth resets the interleave depth to the default.
! The default interleave depth for a channel is 8.
Syntax cable downstream <channel> interleave-depth {8|16|32|64|128}
no cable downstream <channel> interleave-depth
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable downstream 1 interleave-depth 64
The interleave depth for downstream channel 1 in slot 2 / interface 1 is set to 64.
Related Commands cable downstream show
interleave-depth I / JLatency / Burst Protection 64QAM
Latency / Burst Protection 256QAM
8 8 / 16 0.22 ms / 5.9 µs 0.15 ms / 4.1µs
16 16 / 8 0.48 ms / 12 µs 0.33 ms / 8.2 µs
32 32 / 4 0.98 ms / 24 µs 0.68 ms / 16 µs
64 64 / 2 2.0 ms / 47 µs 1.4 ms / 33 µs
128 128 / 1 4.0 ms / 95 µs 2.8 ms / 66 µs
channel The channel for which the interleave depth is being set (0–3 for the G10 CMTS, 0–1 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
8|16|32|64|128 The interleaver depth: 8, 16, 32, 64, or 128 (see Table 4).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream modulation
31
cable downstream modulation
This command sets the downstream modulation mode for the specified channel to either 64QAM or 256QAM. According to the DOCSIS specification, the nominal symbol rate in 64QAM mode is 5.056941 Msym/sec, where each symbol represents six bits. The nominal symbol rate in 256QAM mode is 5.360537 Msym/sec, where each symbol represents eight bits.
! cable downstream modulation is a command within the interface cable sub-mode and requires read-write privilege.
! This command does not have a no form.
! The default modulation mode for a channel is 64QAM.
Syntax cable downstream <channel> modulation {64qam|256qam}
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable downstream 1 modulation 64qam
The downstream modulation mode for channel 1 in slot 2 / interface 1 is set to 64QAM.
Related Commands cable downstream showcable downstream frequencycable downstream rf-power
channel The channel for which the modulation mode is being set (0–3 for the G10 CMTS, 0–1 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
64qam | 256qam Select the modulation mode.
cable downstream rf-power
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference32
cable downstream rf-power
This command sets the output RF power level of the IF-to-RF upconverter in the DOCSIS Module for the specified channel in the cable interface.
! cable downstream rf-power is a command within the interface cable sub-mode and requires read-write privilege.
! no cable downstream rf-power resets the output RF power level to the default value.
! The default output RF power level is 61 dBmV.
Syntax cable downstream <channel> rf-power <power-level>
no cable downstream <channel> rf-power
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable downstream 1 rf-power 55
The output RF power level for channel 1 on slot 2 / interface 1 is set to 55 dBmV.
Related Commands cable downstream showcable downstream frequencycable downstream modulation
channel The channel for which the power level is being set (0–3 for the G10 CMTS, 0–1 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
power-level The output RF power level in dBmV. Range is 50 to 61 dBmV.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream show
33
cable downstream show
This command displays channel performance information for a specific downstream channel in a given slot/interface.
! cable downstream show is a command within the interface cable sub-mode and requires read-write privilege.
! This command does not have a no form.
! There is no default setting for this command.
Syntax cable downstream <channel> show
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable downstream 1 show
Channel performance information for downstream channel 1 on slot 2 / interface 1 is displayed.
Cable 4/1: Downstream Channel 1 is up
458844 packets output, 68363319 bytes, 0 discarded
0 output errors
channel The channel for which cable modem information is desired (0–3 for the G10 CMTS, 0–1 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
cable downstream shutdown
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference34
cable downstream shutdown
This command disables a downstream channel in the specified slot/interface.
! cable downstream shutdown is a command within the interface cable sub-mode and requires read-write privilege.
! no cable downstream shutdown enables the channel.
! The channels are disabled by default.
Syntax cable downstream <channel> shutdown
no cable downstream <channel> shutdown
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# no cable downstream 1 shutdown
Channel 1 in slot 2 / interface 1 is enabled.
Related Commands cable upstream shutdownshutdown
channel The channel that will be enabled or disabled (0–3 for the G10 CMTS, 0–1 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable drop-unverifiable-addresses
35
cable drop-unverifiable-addresses
This command enables the dropping of IP and ARP packets that are unverifiable. A packet is considered unverifiable if its IP address is not found in the address verification table. IP and ARP verification are enabled with the cable source-verify and cable arp-verify commands, respectively.
! cable drop-unverifiable-addresses is a command within the configure terminal mode and requires read-write privilege.
! no cable drop-unverifiable-addresses disables the dropping of unverifiable packets.
! By default, the dropping of unverifiable packets is disabled.
Syntax cable drop-unverifiable-addresses
no cable drop-unverifiable-addresses
Examples GX$root# configure terminal
GX$root(config)# cable drop-unverifiable-addresses
Drop all unverifiable packets.
Related Commands arpcable address-verificationcable arp-verifycable log-unverifiable-addressescable proxy-arpcable source-verifyclear arp-cacheshow cable address-verificationshow ip arp
cable filter group
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference36
cable filter group
This command creates a packet filter corresponding to the SNMP object docsSubMgtPktFilterEntry and potentially an associated TCP/UDP filter corresponding to the SNMP object docsSubMgtTcpUdpFilterEntry (a TCP/UDP filter is created if one or more of the last four parameters is specified). These objects are defined in the DOCSIS Subscriber Management MIB. Packet filters apply to incoming and outgoing IP packets depending on how packet filter groups are associated with upstream or downstream traffic. Packet filters match based on various fields in the layer 3 packet header. Each packet filter can be associated with a TCP/UDP filter which adds match attributes for certain fields in the layer 4 header and applies if the IP packet is carrying TCP or UDP traffic.
Up to 1024 packet filters, and an equal number of associated TCP/UDP filters, can be created in the packet filter table. Filters are uniquely identified by the packet filter group and the packet filter index. The filters are prioritized within a given packet filter group by the filter index such that a smaller index implies a higher priority. The action taken for a packet depends on the highest priority matching filter. If no filter matches, the packet is accepted.
In the absence of an associated TCP/UDP filter, or for packets that carry neither TCP nor UDP traffic, a packet matches a packet filter when all header fields match the corresponding filter attributes under the match rules defined for that field. If a TCP/UDP filter is associated, and a packet carries TCP or UDP traffic, both the packet filter and the TCP/UDP filter attributes must match. See the DOCSIS Subscriber Management MIB for further details regarding packet and TCP/UDP filters.
! cable filter group is a command within the configure terminal mode and requires read-write privilege.
! no cable filter group removes a packet filter and its associated TCP/UDP filter (if it exists) from the packet and TCP/UDP filter tables.
! Parameters group, index, and match-action are required, and all others are optional. If an optional parameter is not specified, its default is used for that packet or TCP/UDP filter.
! The default values of all optional parameters are given under “Definitions”.
Syntax cable filter group <pkt-filter-grp> index <index> match-action {discard|accept} [src-ip <src-ip-addr> src-mask <src-mask> dest-ip <dest-ip-addr> dest-mask <dest-mask> ip-proto <l4-protocol> ip-tos <tos-byte> ip-tos-mask <tos-mask> src-port <src-port> dest-port <dest-port> tcp-flags <tcp-flags> tcp-flags-mask <tcp-flags-mask>]
no cable filter group <pkt-filter-grp> index <index>
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable filter group
37
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable filter group 22 index 5 match-action discard ip-proto 27
Sets up a packet filter to discard all IP packets carrying RDP traffic.
GX$root# configure terminal
GX$root(config)# cable filter group 33 index 7 match-action accept src-port 80
dest-port 80
Sets up a packet filter and an associated TCP/UDP filter to accept all TCP/UDP packets carrying HTTP traffic.
pkt-filter-grp An integer in the range 1–1024 that identifies an ordered group of filters.
index An integer in the range 1–1024 that describes the ordering of filters within a group. Filters are applied in index order, smallest index first.
discard|accept The action to take when a filter matches.
src-ip-addr The source IP address to match in an IP packet. A packet matches if [src-ip-addr AND src-mask]=[Packet Source IP Address AND src-mask]. Standard dot-quad notation (xxx.xxx.xxx.xxx). The default is 0.0.0.0.
src-mask A bit mask to be applied to the source address of an IP packet prior to matching. Standard dot-quad notation (xxx.xxx.xxx.xxx). The default is 0.0.0.0.
dest-ip-addr The destination IP address to match in an IP packet. A packet matches if [dest-ip-addr AND dest-mask]=[Packet Destination IP Address AND dest-mask]. Standard dot-quad notation (xxx.xxx.xxx.xxx). The default is 0.0.0.0.
dest-mask A bit mask to be applied to the destination address of an IP packet prior to matching. Standard dot-quad notation (xxx.xxx.xxx.xxx). The default is 0.0.0.0.
l4-protocol Layer 4 protocol to match. The valid range is 0–256. The default value of 256 matches all layer 4 protocols.
tos-byte The TOS (Type of Service) value to match in the IP packet. A packet matches on this attribute if [tos-byte AND tos-mask]=[Packet TOS Value AND tos-mask]. The value is specified as a two-digit hexadecimal number (00–FF) as it refers to a field containing multiple bitfields. The default is 00.
tos-mask The two-digit hexadecimal mask to apply against the TOS value to be matched in the IP packet. The default is 00.
src-port The TCP or UDP source port to match. The valid range is 0–65536. The default value of 65536 matches any value in the TCP or UDP source port field.
dest-port The TCP or UDP destination port to match. The valid range is 0–65536. The default value of 65536 matches any value in the TCP or UDP destination port field.
tcp-flags The TCP flags to match in the IP packet. A packet matches on this attribute if [tcp-flags]=[Packet TCP Flags AND tcp-flags-mask]. The value is specified as a two-digit hexadecimal number as it refers to multiple bitfields. The bits in this parameter are mapped to the TCP flags as follows:
80: URG40: ACK20: PSH10: RST08: SYN04: FIN
The least two significant bits must not be set to 1, and the value must always be a subset of tcp-flags-mask. Multiple bits can be set to 1 (for example, C0: URG, ACK). The default is 00.
tcp-flags-mask The mask applied to the TCP flags of a packet before it is compared to the TCP flags of the filter. The value is specified as a two-digit hexadecimal number as it refers to a field containing multiple bitfields. The default is 00.
cable filter show
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference38
GX$root# configure terminal
GX$root(config)# no cable filter group 33 index 7
Removes the packet filter and the associated TCP/UDP filter with index 7 in packet filter group 33.
Related Commands cable filter showcable host downstream-filter default-groupcable host upstream-filter default-groupcable modem downstream-filter default-groupcable modem upstream-filter default-group
cable filter show
This command displays the current setting for all filters in the packet filter table corresponding to the SNMP object docsSubMgtPktFilterTable and any associated TCP/UDP filters from the TCP/UDP filter table corresponding to SNMP object docsSubMgtTcpUdpFilterTable. These objects are defined in the DOCSIS Subscriber Management MIB.
! cable filter show is a command within the configure terminal mode and requires read-write privilege.
Syntax cable filter show
Examples GX$root# configure terminal
GX$root(config)# cable filter show
Displays a list of all filters in the tables corresponding to the Subscriber Management MIB objects docsSubMgtPktFilterTable and docsSubMgtTcpUdpFilterTable. The first entry displayed is a packet filter. The second entry, which displays values for the last four parameters wrapped around on the next line, is a TCP/UDP filter. Default values are displayed for all optional parameters that were not explicitly specified during the creation of the filter.
group index action ipSrcAddr ipSrcMask ipDstAddr ipDstMask
ipProt tos tosMask scrPort dstPort tcp tcpMask
----- ----- ------ --------- --------- --------- ---------
------ --- ------- ------- ------- --- -----
22 5 discard 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0
27 00 00
33 7 accept 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0
256 00 00 80 80 00 00
Related Commands cable filter group
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable helper-address
39
cable helper-address
This command is used to specify a destination IP address for dynamic host configuration protocol (DHCP) broadcast packets that are sent by cable modems and CPE devices on the specified slot/interface to a DHCP server. The user datagram protocol (UDP) is used as a connectionless transport protocol for carrying DHCP packets.
! cable helper-address is a command within the interface cable sub-mode and requires read-write privilege.
! no cable helper-address disables the helper-address feature.
! There is no default setting for this command.
! A maximum of 20 helper addresses can be specified for each cable interface—ten for CMs and ten for CPEs.
! Any DHCP configuration performed at the interface cable sub-mode level applies to the default subscriber group for that cable interface (see the cable subscriber-group command for more details).
Syntax cable helper-address <ip-address> [<next-hop>] [cable-modem|host]
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable helper-address 192.71.25.108 172.168.10.1
Enables the forwarding of DHCP broadcast packets from any cable modem and CPE device on slot 2 / interface 1 to the DHCP server at 192.71.25.108. The packet will be sent out with the destination MAC address of a router port that has the IP address 172.168.10.1.
Related Commands cable dhcp-giaddrcable relay-agent-optioncable subscriber-groupdhcp-giaddrhelper-addressrelay-agent-option
ip-address The IP address of the DHCP server.
next-hop An optional parameter that specifies the IP address of the next-hop gateway from the CMTS en route to the DHCP server. This parameter is required only if the DHCP server specified by the ip-address parameter is not in one of the IP subnets directly connected to the Ethernet port corresponding to the associated cable interface.
cable-modem Specifies the IP address is for cable modems.
host Specifies the IP address is for hosts (CPE devices).
If neither the cable-modem nor the host keyword is given, the specified DHCP server is used for both cable modems and CPE devices.
cable host downstream-filter default-group
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference40
cable host downstream-filter default-group
This command sets the default packet filter group for downstream traffic to the cable hosts behind a cable modem. The specified default filter group is automatically associated with cable modems for which no filter group has been provisioned. Filter groups are defined in the DOCSIS Subscriber Management MIB or by the cable filter group CLI command, and are used to filter IP packets that meet a set of criteria. The modified entity corresponds to the SNMP MIB object docsSubMgtSubFilterDownDefault.
! cable host downstream-filter default-group is a command within the configure terminal mode and requires read-write privilege.
! no cable host downstream-filter default-group resets the command to its default value.
! The default value for this command is 0, indicating no packet filtering for downstream traffic to hosts behind the cable modem.
Syntax cable host downstream-filter default-group <pkt-filter-grp>
no cable host downstream-filter default-group
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable host downstream-filter default-group 7
Sets the default cable host downstream packet filter group to 7.
Related Commands cable filter groupcable host upstream-filter default-groupcable modem downstream-filter default-groupcable modem upstream-filter default-group
pkt-filter-grp The number of the packet filter group to be used. (0 to 1024)
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable host upstream-filter default-group
41
cable host upstream-filter default-group
This command sets the default packet filter group for upstream traffic to the cable hosts behind a cable modem. The specified default filter group is automatically associated with cable modems for which no filter group has been provisioned. Filter groups are defined in the DOCSIS Subscriber Management MIB or by the cable filter group CLI command, and are used to filter IP packets that meet a set of criteria. The modified entity corresponds to the SNMP MIB object docsSubMgtSubFilterUpDefault.
! cable host upstream-filter default-group is a command within the configure terminal mode and requires read-write privilege.
! no cable host upstream-filter default-group resets the command to its default value.
! The default value for this command is 0, indicating no packet filtering for upstream traffic from hosts behind the cable modem.
Syntax cable host upstream-filter default-group <pkt-filter-grp>
no cable host upstream-filter default-group
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable host upstream-filter default-group 7
Sets the default cable host upstream packet filter group to 7.
Related Commands cable filter groupcable host downstream-filter default-groupcable modem downstream-filter default-groupcable modem upstream-filter default-group
pkt-filter-grp The number of the packet filter group to be used. (0 to 1024)
cable insertion-interval
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference42
cable insertion-interval
This command sets the interval between initial maintenance opportunities scheduled by the CMTS for the specified interface. Initial Maintenance opportunities are sent to cable modems within upstream bandwidth allocation MAP messages that define the time slots in which a cable modem can transmit its initial ranging request (RNG-REQ MAC frame).
! cable insertion-interval is a command within the interface cable sub-mode and requires read-write privilege.
! no cable insertion-interval resets the Initial Maintenance interval to the default.
! The default setting is 10.
Syntax cable insertion-interval <interval>
no cable insertion-interval
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable insertion-interval 25
The initial maintenance interval for the modems on slot 2 / interface 1 is set to 250 milliseconds.
cable ip-broadcast-echo
This command enables echoing of IP broadcast packets from the upstream channels in the targeted slot/interface to the downstream channels in the currently-defined broadcast domain.
! cable ip-broadcast-echo is a command within the interface cable sub-mode and requires read-write privilege.
! no cable ip-broadcast-echo disables echoing of IP broadcast packets.
! By default, IP broadcast echo is disabled.
Syntax cable ip-broadcast-echo
no cable ip-broadcast-echo
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable ip-broadcast-echo
Echo all IP broadcast packets from the upstream channels in slot 2 / interface 1 to the downstream channels in the broadcast domain.
Related Commands cable broadcast-domaincable ip-multicast-echocable proxy-arp
interval The number of 10-millisecond intervals between initial maintenance opportunities. Range is 1 to 200 (10 milliseconds to 2000 milliseconds).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable ip-multicast-echo
43
cable ip-multicast-echo
This command enables echoing of IP multicast packets from the upstream channels in the targeted slot/interface to the downstream channels in the currently-defined broadcast domain.
! cable ip-multicast-echo is a command within the interface cable sub-mode and requires read-write privilege.
! no cable ip-multicast-echo disables echoing of IP multicast packets.
! By default, IP multicast echo is enabled.
Syntax cable ip-multicast-echo
no cable ip-multicast-echo
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable ip-multicast-echo
Echo all IP multicast packets from the upstream channels in slot 2 / interface 1 to the downstream channels in the broadcast domain.
Related Commands cable broadcast-domaincable ip-broadcast-echocable proxy-arp
cable llc-filter index
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference44
cable llc-filter index
This command creates an LLC filter corresponding to the SNMP object docsDevFilterLLCEntry as defined in the DOCSIS Cable Device MIB (RFC-2669). LLC filters allow the filtering of all packets on ingress based on the interface index of the physical interface they entered, the layer 3 protocol type, and the layer 3 protocol.
Up to 10 LLC filters can be created in the LLC filter table, and each is uniquely identified by its index. There is no prioritization between LLC filters. If any of the LLC filters matches an incoming packet, the opposite of the LLC filter unmatched action is performed and the packet is accepted or discarded accordingly (see the cable llc-filter unmatched-action command). If none of the LLC filters matches, the LLC filter unmatched action is performed. If no LLC filters are created, all incoming packets are accepted.
See the DOCSIS Cable Device MIB for further details regarding LLC filters.
! cable llc-filter index is a command within the configure terminal mode and requires read-write privilege.
! no cable llc-filter index removes the LLC filter from the LLC filter table.
! There are no default settings.
Syntax cable llc-filter index <index> interface <if-index> protocol-type {dsap|ethertype} protocol <l3-protocol>
no cable llc-filter index <index>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable llc-filter index 5 interface 0 protocol-type ethertype
protocol 2054
Sets up an LLC filter that matches an ARP packet encapsulated in a DIX or SNAP frame on any physical interface.
Related Commands cable llc-filter unmatched-actioncable llc-filter show
index An integer in the range 1–2147483647 that is used for the identification of the filter.
if-index An integer in the range 0–2147483647 that is the interface index of a physical interface on the CMTS. If if-index equals 0, the filter applies to all interfaces.
dsap|ethertype Selects whether the protocol specified by <l3-protocol> is defined by the 8-bit DSAP field of an 802.3 encapsulated frame, or by the 16-bit Ethertype field of a DIX (EthernetII) or SNAP encapsulated frame.
l3-protocol The layer 3 protocol to which this filter applies. The valid range is 0–65535. If the protocol type is dsap, only values in the range 0–255 should be specified to assure the proper operation of this command. For SNAP frames, filtering is based on ethertype rather than on DSAP.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable llc-filter show
45
cable llc-filter show
This command displays the current setting for the LLC filter unmatched action and the current LLC filters in the LLC filter table, which correspond to the SNMP objects docsDevFilterLLCUnmatchedAction and docsDevFilterLLCTable, respectively, in the DOCSIS Subscriber Management MIB.
See the DOCSIS Cable Device MIB for further details regarding LLC filters.
! cable llc-filter show is a command within the configure terminal mode and requires read-write privilege.
Syntax cable llc-filter show
Examples GX$root# configure terminal
GX$root(config)# cable llc-filter show
Displays the current unmatched action and LLC filters.
Unmatched action: accept
llcIdx ifIndex protocolType protocol
------ ------- ------------ --------
5 0 ethertype 2054
Related Commands cable llc-filter indexcable llc-filter unmatched-action
cable llc-filter unmatched-action
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference46
cable llc-filter unmatched-action
This command sets the action to be performed on a packet when there are LLC filters set in the LLC filter table and no LLC filters match the incoming packet. It sets the object corresponding to the SNMP object docsDevFilterLLCUnmatchedAction defined in the DOCSIS Subscriber Management MIB. The value of this object is ignored if no LLC filers are set in the LLC filter table.
See the DOCSIS Cable Device MIB for further details regarding LLC filters.
! cable llc-filter unmatched-action is a command within the configure terminal mode and requires read-write privilege.
! At initial system startup, the value of the LLC filter unmatched action defaults to accept.
Syntax cable llc-filter unmatched-action {accept|discard}
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable llc-filter unmatched-action accept
Sets the action to be performed when there are LLC filters set, but no LLC filters match, to accept.
Related Commands cable llc-filter indexcable llc-filter show
accept|discard The action to be performed on a packet when there are LLC filters set, but no LLC filters match the packet. The opposite of this action is performed when LLC filters match the packet.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable log-invalid-addresses
47
cable log-invalid-addresses
This command declares invalid IP and ARP packets as events that are conditionally logged and reported to the NMS. A packet is considered invalid if its IP address is found in the address verification table, but with a different MAC address and/or CM ID. IP and ARP verification are enabled with the cable source-verify and cable arp-verify commands, respectively.
See the log-level generate command to see how logging and reporting actions are defined for events of various priority levels. Invalid IP and ARP packet events have a priority level of informational. The show local-log command is used to display the local event log.
! cable log-invalid-addresses is a command within the configure terminal mode and requires read-write privilege.
! no cable log-invalid-addresses prevents invalid IP and ARP packets from being declared as events.
! By default, invalid IP and ARP packets are declared as events.
Syntax cable log-invalid-addresses
no cable log-invalid-addresses
Examples GX$root# configure terminal
GX$root(config)# no cable log-invalid-addresses
Do not declare invalid IP and ARP packets as events.
Related Commands arpcable address-verificationcable arp-verifycable log-unverifiable-addressescable proxy-arpcable source-verifyclear arp-cachelog-level generateshow cable address-verificationshow ip arpshow local-log
cable log-unverifiable-addresses
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference48
cable log-unverifiable-addresses
This command declares unverifiable IP and ARP packets as events that are conditionally logged and reported to the NMS. A packet is considered unverifiable if its IP address is not found in the address verification table. IP and ARP verification are enabled with the cable source-verify and cable arp-verify commands, respectively.
See the log-level generate command to see how logging and reporting actions are defined for events of various priority levels. Unverifiable IP and ARP packet events have a priority level of informational. The show local-log command is used to display the local event log.
! cable log-unverifiable-addresses is a command within the configure terminal mode and requires read-write privilege.
! no cable log-unverifiable-addresses prevents unverifiable IP and ARP packets from being declared as events.
! By default, unverifiable IP and ARP packets are not declared as events.
Syntax cable log-unverifiable-addresses
no cable log-unverifiable-addresses
Examples GX$root# configure terminal
GX$root(config)# cable log-unverifiable-addresses
Declare unverifiable IP and ARP packets as events.
Related Commands arpcable address-verificationcable arp-verifycable drop-unverifiable-addressescable log-invalid-addressescable proxy-arpcable source-verifyclear arp-cachelog-level generateshow cable address-verificationshow ip arpshow local-log
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem-config-file
49
cable modem-config-file
This command allows you to display, convert (to ASCII), or create (from ASCII) a CM configuration file. The type/length/value (TLV) type names defined in ASCII are provided in Table 5. See the DOCSIS specifications for details regarding the TLV encodings.
Within an ASCII text file, simple TLVs are specified as:
simple-tlv-type-name = <value>
Composite TLVs are specified as a list of simple and composite TLVs:
composite-tlv-type-name {simple-tlv-type-name = <value> simple-tlv-type-name = <value>..composite-tlv-type-name {simple-tlv-type-name = <value> simple-tlv-type-name = <value>..}}
See the G10 CMTS and G1 CMTS Installation and Operation manuals for more details regarding the format of the ASCII text configuration file.
! cable modem-config-file is a top level command and requires read-write privilege.
Table 5: CM Configuration File TLV Type Names
TLV Type Name (Level 1) TLV Type Name (Level 2) TLV Type Name (Level 3)
DownstreamFrequency — —
UpstreamChannelId — —
NetworkAccessControl — —
ClassOfServiceConfig ClassId
MaxDownstreamRate
MaxUpstreamRate
UpstreamChannelPriority
GuaranteedUpstreamRate
MaxUpstreamBurst
PrivacyEnable
—
cable modem-config-file
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference50
ModemCapabilities ConcatenationSupport
DocsisVersion
FragmentationSupport
PhsSupport
IgmpSupport
PrivacySupport
DownstreamSaidSupport
UpstreamSidSupport
FilteringSupport
TransmitEqualizationTapsPerSymbol
TransmitEqualizationTapsQuantity
DccSupport
—
CmMic — —
CmtsMic — —
VendorId — —
CmIpAddress — —
BaselinePrivacyConfig AuthWaitTimeout
ReauthWaitTimeout
AuthGraceTime
OperationalWaitTimeout
RekeyWaitTimeout
TekGraceTime
AuthRejectWaitTimeout
SaMapWaitTimeout
SaMapMaxRetries
—
MaxCpeQuantity — —
TftpTimestamp — —
ProvisionedIpAddress — —
TLV Type Name (Level 1) TLV Type Name (Level 2) TLV Type Name (Level 3)
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem-config-file
51
UpstreamClassificationEncoding ClassifierReference
ClassifierId
ServiceFlowReference
ServiceFlowId
RulePriority
ClassifierActivationState
—
IpPacketClassificationEncoding IpTosRangeAndMask
IpProtocol
IpSourceAddress
IpSourceMask
IpDestinationAddress
IpDestinationMask
TcpUdpSourcePortStart
TcpUdpSourcePortEnd
TcpUdpDestinationPortStart
TcpUdpDestinationPortEnd
EthernetPacketClassificationEncoding DestinationMacAddressAndMask
SourceMacAddress
EthertypeDsapMacType
Ieee8021PQPktClassificationEncoding UserPriority
VlanId
VendorSpecificClassifierParameters —
DownstreamClassificationEncoding ClassifierReference
ClassifierId
ServiceFlowReference
ServiceFlowId
RulePriority
ClassifierActivationState
—
IpPacketClassificationEncoding IpTosRangeAndMask
IpProtocol
IpSourceAddress
IpSourceMask
IpDestinationAddress
IpDestinationMask
TcpUdpSourcePortStart
TcpUdpSourcePortEnd
TcpUdpDestinationPortStart
TcpUdpDestinationPortEnd
EthernetPacketClassificationEncoding DestinationMacAddressAndMask
SourceMacAddress
EthertypeDsapMacType
Ieee8021PQPktClassificationEncoding UserPriority
VlanId
VendorSpecificClassifierParameters —
TLV Type Name (Level 1) TLV Type Name (Level 2) TLV Type Name (Level 3)
cable modem-config-file
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference52
UpstreamServiceFlowEncoding ServiceFlowReference
ServiceClassName
QosSetType
TrafficPriority
MaxSustainedTrafficRate
MaxTrafficBurst
MinReservedTrafficRate
MinReservedRatePacketSize
ActiveQosTimeout
AdmittedQosTimeout
MaxConcatenatedBurst
SchedulingType
RequestTransmissionPolicy
NominalPollingInterval
ToleratedPollJitter
UnsolicitedGrantSize
NominalGrantInterval
ToleratedGrantJitter
GrantsPerInterval
IpTosOverwrite
GrantTimeReference
VendorSpecificQosParameters
—
DownstreamServiceFlowEncoding ServiceFlowReference
ServiceClassName
QosSetType
TrafficPriority
MaxSustainedTrafficRate
MaxTrafficBurst
MinReservedTrafficRate
MinReservedRatePacketSize
ActiveQosTimeout
AdmittedQosTimeout
MaxLatency
VendorSpecificQosParameters
—
PayloadHeaderSuppressionEncoding ClassifierReference
ClassifierId
ServiceFlowReference
ServiceFlowIdentifier
DynamicServiceChangeAction
PhsField
PhsIndex
PhsMask
PhsSize
PhsVerification
VendorSpecificPhsParameters
—
MaxNumberOfClassifiers — —
TLV Type Name (Level 1) TLV Type Name (Level 2) TLV Type Name (Level 3)
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem-config-file
53
Syntax cable modem-config-file show <config-file>
cable modem-config-file generate-from-ascii <ascii-file> <config-file> [shared-secret <secret-string>]
cable modem-config-file to-ascii <config-file> <ascii-file>
Definitions
PrivacyEnable — —
SubscriberManagementControl — —
SubscriberManagementCpeIpTable — —
SubscriberManagementFilterGroups — —
VendorConfig — —
SoftwareUpgradeFilename — —
SnmpWriteAccessControl — —
SnmpMibObject — —
CpeMacAddress — —
SoftwareUpgradeTftpServerIpAddress — —
SnmpV3KickstartValue SecurityName
ManagerPublicNumber
—
TLV Type Name (Level 1) TLV Type Name (Level 2) TLV Type Name (Level 3)
show Displays the specified binary CM configuration file as ASCII text.
config-file TLV-encoded binary CM configuration file.
generate-from-ascii Converts the specified ASCII text CM configuration file (generated from a configuration file editor or by the cable modem-config-file to-ascii command) to a binary CM configuration file.
ascii-file ASCII text CM configuration file.
shared-secret Indicates that an optional shared secret is specified for encoding the CMTS MIC (Message Integrity Check).
secret-string The optional shared secret (authentication string), up to a maximum of 64 text characters.
to-ascii Converts the specified binary CM configuration file (generated from a configuration file editor or by the cable modem-config-file generate-from-ascii command) to an ASCII text CM configuration.
cable modem-config-file
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference54
Examples GX$root# cable modem-config-file show config1.cfg
Displays the binary CM configuration file config1.cfg in ASCII text.
NetworkAccessControl = 1
ClassOfServiceConfig {
ClassId = 1
MaxDownstreamRate = 10000000
MaxUpstreamRate = 5000000
PrivacyEnabled = 1
}
BaselinePrivacyConfig {
AuthWaitTimeout = 10
ReauthWaitTimeout = 10
AuthGraceTime = 60
OperationalWaitTimeout = 10
RekeyWaitTimeout = 10
TekGraceTime = 60
AuthRejectWaitTimeout = 60
}
MaxCpeQuantity = 4
# CmMic = 0x8d 0xd2 0xd3 0x15 0x87 0x4f 0x15 0x76 0x4d 0xb4 0x00 0x82 0x4f
0xf9 0x76 0x25
# CmtsMic = 0xb3 0x1e 0xfc 0x1c 0xa7 0xe3 0x0e 0xd6 0xd3 0x0c 0xf6 0xac 0x
a5 0x12 0x75 0xcd
GX$root# cable modem-config-file to-ascii config1.cfg config1.txt
Converts the binary CM configuration file config1.cfg to an ASCII text CM configuration file config1.txt.
GX$root# cable modem-config-file generate-from-ascii config1.txt config1.cfg
Converts the ASCII text CM configuration file config1.txt to a binary CM configuration file config1.cfg.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem downstream-filter default-group
55
cable modem downstream-filter default-group
This command sets the default packet filter group for downstream traffic to cable modems. The specified default filter group is automatically associated with cable modems for which no filter group has been provisioned. Filter groups are defined in the DOCSIS Subscriber Management MIB or by the cable filter group CLI command, and are used to filter IP packets that meet a set of criteria. The modified entity corresponds to the SNMP MIB object docsSubMgtCmFilterDownDefault.
! cable modem downstream-filter default-group is a command within the configure terminal mode and requires read-write privilege.
! no cable modem downstream-filter default-group resets the command to its default value.
! The default value for this command is 0, indicating no packet filtering for downstream traffic to the cable modem.
Syntax cable modem downstream-filter default-group <pkt-filter-grp>
no cable modem downstream-filter default-group
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable modem downstream-filter default-group 5
Sets the default cable modem downstream packet filter group to 5.
Related Commands cable filter groupcable modem upstream-filter default-groupcable host downstream-filter default-groupcable host upstream-filter default-group
pkt-filter-grp The number of the packet filter group to be used. (0 to 1024)
cable modem flap-list
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference56
cable modem flap-list
The G10 CMTS maintains a database of CMs along with various modem statistics for each CM. When a CM exhibits behavior that matches pre-defined criteria—referred to as a flap—an entry is added to a table called a flap-list. Each flap-list entry contains the MAC address of the CM, along with additional modem statistics that can assist in determining why the CM flapped (see the show cable flap-list command for details).
The flap criteria are defined globally for all cable interfaces by setting various parameters (thresholds) within the cable modem flap-list command. If a parameter is not explicitly set, a flap is defined by its default value. After an entry is added to the flap-list for a CM, any subsequent flap for that CM, whether defined explicitly or by default, updates that flap-list entry with new statistics (including a flap count). Examples of flaps include excessive initial ranging, missed station maintenance opportunities, large upstream power adjustments, and a signal-to-noise ratio (SNR) dropping below a threshold.
The flap-list can be used to assist an operator with troubleshooting, locating CMTS and CM configuration issues, and locating problems in the HFC plant without impacting throughput and downstream performance, and without creating additional packet overhead throughout the HFC network.
! cable modem flap-list is a command within the configure terminal mode and requires read-write privilege.
! The cable modem flap-list command applies to all cable interfaces.
! The no form of this command restores all parameters, or the specified parameter, to its default value.
! The cable upstream modem flap-list command can be used on an upstream channel basis to override a global threshold set by the cable modem flap-list command.
Syntax cable modem flap-list {snr-threshold <snr-threshold>} |{mer-threshold <mer-threshold>} |{cer-threshold <cer-threshold>} |{power-adjust-threshold <power-adjust-threshold>} |{im-retry-interval <im-retry-interval>} |{sm-miss-threshold <sm-miss-threshold>} |{size <size>} |{age-time <days> [<hours> [<minutes>]]} |{show}
no cable modem flap-list [snr-threshold|mer-threshold|cer-threshold|power-adjust-threshold|im-retry-interval|sm-miss-threshold|age-time]
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem flap-list
57
Definitions
snr-threshold A flap occurs when the measured SNR of a CM drops below this threshold (specified in dB). The valid range is 1–100 and the default is 18.
mer-threshold A flap occurs when the measured modulation error rate (MER) of a CM drops below this threshold (specified in dB). The valid range is 1–100 and the default is 18.
cer-threshold A flap occurs when the measured codeword error rate (CER) of a CM rises above this threshold (specified in units of 10-6). The CER is the ratio of the number of codewords received with errors, before error correction is attempted, and the total number of codewords received (with and without errors). The valid range is 1–1000000 and the default is 1 (1 x 10-6).
power-adjust-threshold A flap occurs when the power adjustment sent to the CM during station maintenance is above this threshold (specified in dB). The valid range is 1–100 and the default is 3.
im-retry-interval A flap occurs when the time between two successive initial maintenance attempts by a particular CM is below this threshold (specified in seconds). The valid range is 60–86400 and the default is 180.
sm-miss-threshold A flap occurs when the number of consecutively missed station maintenance opportunities by a particular CM is above this threshold, and the CMTS subsequently receives a successful ranging request from the CM (this latter condition is required to discern whether the CM is missing station maintenance opportunities or is off-line). The valid range is 1–100 and the default is 2.
size The maximum number of CMs that can be displayed in the flap-list. The valid range is 1–8192 and the default is 8192.
days The duration, in days, to maintain an entry in the flap-list, counted from its last flap. The valid range is 0–60 and the default is 1. If specifying a value less than one day, enter 0 for days and use the optional parameters hours and/or minutes. The maximum age-time of a flap is 60 days and the minimum is 60 minutes.
hours The duration, in hours, to maintain an entry in the flap-list, counted from its last flap. The valid range is 0–23 and the default is 0. If specifying a value less than one hour, enter 0 for hours and use the optional parameter minutes. The maximum age-time of a flap is 60 days and the minimum is 60 minutes.
minutes The duration, in minutes, to maintain an entry in the flap-list, counted from its last flap. The valid range is 0–59 and the default is 0. The maximum age-time of a flap is 60 days and the minimum is 60 minutes.
show Displays the current value of each flap-list parameter.
Tuning the flap thresholds is recommended to minimize the number of irrelevant entries in the flap-list.
cable modem upstream-filter default-group
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference58
Examples GX$root# configure terminal
GX$root(config)# cable modem flap-list snr-threshold 20
Set the SNR threshold for all CMs to 20 dB.
GX$root(config)# cable modem flap-list age-time 0 0 45
Maintain an entry in the flap-list 45 minutes from its last flap.
GX$root(config)# no cable modem flap-list snr-threshold
Restore the SNR threshold for all CMs to its default value.
GX$root(config)# no cable modem flap-list
Restore all thresholds for all CMs to their default values.
Related Commands cable upstream modem flap-listclear cable modem flap-listshow cable flap-list
cable modem upstream-filter default-group
This command sets the default packet filter group for upstream traffic from cable modems. The specified default filter group is automatically associated with cable modems for which no filter group has been provisioned. Filter groups are defined in the DOCSIS Subscriber Management MIB or by the cable filter group CLI command, and are used to filter IP packets that meet a set of criteria. The modified entity corresponds to the SNMP MIB object docsSubMgtCmFilterUpDefault.
! cable modem upstream-filter default-group is a command within the configure terminal mode and requires read-write privilege.
! no cable modem upstream-filter default-group resets the command to its default value.
! The default value for command is 0, indicating no packet filtering for upstream traffic from the cable modem.
Syntax cable modem upstream-filter default-group <pkt-filter-grp>
no cable modem upstream-filter default-group
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable modem upstream-filter default-group 6
Sets the default cable modem upstream packet filter group to 6.
Related Commands cable filter groupcable modem downstream-filter default-groupcable host downstream-filter default-groupcable host upstream-filter default-group
pkt-filter-grp The number of the packet filter group to be used. (0 to 1024)
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modulation-profile
59
cable modulation-profile
This command defines a modulation profile for a specific interval usage code which can be applied to one or more upstream channels. When applied, the modulation profile is used to compose the Burst Descriptor included in that channel's upstream channel descriptor (UCD) message, which is periodically sent to each cable modem. The UCD message configures the modem’s transmission characteristics. A modulation profile is composed of six interval usage codes, where each is followed by ten parameters. However, if the scrambler is disabled, p7 parameter is not used so there are nine parameters to set in this case.
! cable modulation-profile is a command within the configure terminal mode and requires read-write privilege.
! The no form of this command removes the specified modulation profile.
! The default setting is modulation profile ID 8 for all upstream channels. See the example for the default parameters.
Syntax cable modulation-profile <profile-id> {request|reqdata| initial|station|short|long} {<p1> <p2> <p3> <p4> <p5> <p6> <p7> <p8> <p9> <p10>}
no cable modulation-profile <profile-id> {request|reqdata| initial|station|short|long} {<p1> <p2> <p3> <p4> <p5> <p6> <p7> <p8> <p9> <p10>}
cable modulation-profile <profile-id> show
Definitions
profile-ID The modulation profile identification number (ID). Valid options are numbers from 1 to 256.
{request|reqdata|initial|station|short|long}
Interval usage code.
request: An upstream interval in which requests can be made for bandwidth for upstream data transmission
reqdata: An interval in which requests for bandwidth or short data packets can be transmitted
initial: An interval in which new stations (cable modems) can join the network
station: An interval in which stations are expected to perform some aspect of routine network maintenance, such as ranging or power adjustment
short: An interval in which a CM transmits one or more upstream Protocol Data Units (PDUs). The interval for a short interval is less than or equal to the Maximum Burst Size defined in the short profile.
long: An interval in which a CM transmits one or more upstream Protocol Data Units (PDUs). The number of mini-slots in the interval is larger than the maximum for short interval transmissions.
p1 FEC T bytes: The number of codeword parity bytes is 2*T. T is the number of bytes that can be corrected per FEC codeword. Values range from 1 to 10, or 0 for no FEC—forward error correction.
p2 FEC K bytes: Codeword information bytes (Not used if no FEC, T=0). Values range from 16 to 253.
p3 maxburst size: The maximum number of mini-slots that can be transmitted during this burst type. Values range from 1 to 255, or 0 for no limit.
p4 guard time: Number of symbol times which must follow the end of this burst. Values range from 0 to 255.
p5 modulation: Upstream modulation type. Options are qpsk or 16qam.
p6 scrambler: Determines if the scrambler is used. Options are scrambler or no-scrambler.
Note: no-scrambler can cause packet loss and should be used only in a lab environment.
cable modulation-profile
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference60
Examples GX$root# configure terminal
GX$root(config)# cable modulation-profile 5 short 5 75 8 5 qpsk scrambler 1 diff
32 shortened
The short interval usage code is set for modulation profile #5, which includes 5 FEC T bytes; 75 FEC K bytes; maximum burst size of 8 minislots; guard time between bursts of 5 symbols; QPSK modulation type; enabled scrambler using a seed value of 0001h; enabled differential encoding; preamble length of 32 bits; and a shortened last codeword.
GX$root# configure terminal
GX$root(config)# cable modulation-profile 10 initial 3 34 0 5 qpsk no-scrambler
diff 52 fixed
The initial interval usage code is set for modulation profile #10. This profile does not use the scrambler, so only nine parameters are set.
GX$root# configure terminal
GX$root(config)# cable modulation-profile 1 show
ModId IUC prelen seed mod dif fec data/fec brst guard lstcw scrmb
1 request(1) 68 0x0001 QPSK Y 0 16 0 6 2 Y
1 reqdata(2) 68 0x0001 QPSK Y 3 40 8 6 2 Y
1 initial(3) 52 0x0001 QPSK Y 3 34 0 5 2 Y
1 station(4) 52 0x0001 QPSK Y 3 34 0 5 2 Y
1 short(5) 32 0x0001 QPSK Y 5 75 8 5 1 Y
1 long(6) 32 0x0001 QPSK Y 8 220 0 5 1 Y
Related Commands show cable modulation-profile
p7 scrambler seed: The 15-bit scrambler seed value. Values range from 0 to 7FFF. This parameter is not required if the scrambler is disabled.
p8 diff encoding: Determines if differential encoding is used. Options are diff or no-diff.
p9 preamble length: Defines the length of the preamble in bits. Values range from 0, 2, 4,... 1024 for qpsk modulation and 0, 4, 8, ...1024 for 16qam modulation.
p10 shortened last codeword: Determines whether the last codeword is shortened or not. Options are fixed (fixed length code word) or shortened (shortened code word).
show Displays the parameters for the specified modulation profile ID.
The no-scrambler option can cause packet loss and should be used only in a lab environment.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable noise-cancellation
61
cable noise-cancellation
This command enables the noise cancellation feature of the Broadband Cable Processor ASIC.
! cable noise-cancellation is a command within the configure terminal mode and requires read-write privilege.
! no cable noise-cancellation disables noise cancellation.
! By default, noise cancellation is enabled.
Syntax cable noise-cancellation
no cable noise-cancellation
Examples GX$root# configure terminal
GX$root(config)# cable noise-cancellation
Enables the noise cancellation feature of the Broadband Cable Processor ASIC.
Noise cancellation should always remain enabled under normal operational conditions. The ability to disable noise cancellation is provided to facilitate the evaluation of this feature.
cable privacy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference62
cable privacy
This command affects the manner in which the CMTS responds to a CM registration request based on the Privacy Enable Configuration Setting (BPI or BPI+) within the REG-REQ message. Depending on the variant of the command issued, privacy will be enabled, disabled, or enforced.
! cable privacy is a command within the interface cable sub-mode and requires read-write privilege.
! Following are descriptions of the effects of the four variants of this command on a CM that resides on the targeted slot/interface:
! cable privacy – privacy is enabled. Privacy for a CM is determined by the privacy setting in the REG-REQ message. The CMTS will not reject a REG-REQ message due to the privacy setting.
! no cable privacy – privacy is disabled. If a CM attempts to register with privacy enabled, the CMTS will reject the REG-REQ message. A CM that attempts to register without privacy enabled will not be rejected (due to privacy) during registration.
! cable privacy enforce – privacy is enforced. If a CM attempts to register without privacy enabled, the CMTS will reject the REG-REQ message. A CM that attempts to register with privacy enabled will not be rejected (due to privacy) during registration.
! no cable privacy enforce – privacy is enabled. Privacy for a CM is determined by the privacy setting in the REG-REQ message. The CMTS will not reject a REG-REQ message due to the privacy setting. Note that the effect of this command is identical to the effect of the cable privacy command.
! The default setting privacy enabled.
! This command only affects CMs during registration attempts. CMs that have already registered are not affected by the parameter specified within this command until they register again (due to other reasons).
Syntax cable privacy [enforce]
no cable privacy [enforce]
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable privacy enforce
The CMTS will reject any registrations by CMs on slot 2 / interface 0 that attempt to register without privacy enabled.
Related Commands show cable privacy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable privacy check-cert-validity-periods
63
cable privacy check-cert-validity-periods
This command instructs the CMTS to check the validity period or the trust of authentication certificates presented by CMs.
! cable privacy check-cert-validity-periods is a command within the interface cable sub-mode and requires read-write privilege.
! cable privacy check-cert-validity-periods strictly checks the validity of a certificate. The CM is rejected if its certificate has expired.
! no cable privacy check-cert-validity-periods ignores the validity of a certificate, but checks the trust status. A CM can register with an expired certificate as long as the trust status is trusted or chained. Otherwise, the CM is rejected.
! The default is to check the validity of a certificate for expiration.
Syntax cable privacy check-cert-validity-periods
no cable privacy check-cert-validity-periods
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable privacy check-cert-validity-periods
The CMTS will check the validity of certificates from CMs on slot 2 / interface 0.
Related Commands cable privacy kek life-timecable privacy tek life-timecable privacy trust-self-signed-cert
cable privacy kek life-time
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference64
cable privacy kek life-time
This command sets the default lifetime of a key encryption key (KEK). The CMTS assigns this value to all new KEKs.
! cable privacy kek life-time is a command within the interface cable sub-mode and requires read-write privilege.
! no cable privacy kek life-time restores the default value to 604800 seconds.
Syntax cable privacy kek life-time <seconds>
no cable privacy kek life-time
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable privacy kek life-time 500000
Sets the KEK lifetime to 500000 seconds for all CMs on slot 2 / interface 0.
Related Commands cable privacy check-cert-validity-periodscable privacy tek life-timecable privacy trust-self-signed-cert
cable privacy tek life-time
This command sets the default lifetime of a traffic encryption key (TEK). The CMTS assigns this value to all new TEKs.
! cable privacy tek life-time is a command within the interface cable sub-mode and requires read-write privilege.
! no cable privacy tek life-time restores the default value to 43200 seconds.
Syntax cable privacy tek life-time <seconds>
no cable privacy tek life-time
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable privacy tek life-time 50000
Sets the TEK lifetime to 50000 seconds for all CMs on slot 2 / interface 0.
Related Commands cable privacy check-cert-validity-periodscable privacy kek life-timecable privacy trust-self-signed-cert
seconds Specifies the default lifetime of a KEK (in seconds). Valid range is 1 to 6048000.
seconds Specifies the default lifetime of a TEK (in seconds). Valid range is 1 to 604800.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable privacy trust-self-signed-cert
65
cable privacy trust-self-signed-cert
This command sets the default trust of new self-signed manufacturer certificates to trusted.
! cable privacy trust-self-signed-cert is a command within the interface cable sub-mode and requires read-write privilege.
! no cable privacy trust-self-signed-cert sets the default trust of new self-signed manufacturer certificates to untrusted.
! The default trust is untrusted.
Syntax cable privacy trust-self-signed-cert
no cable privacy trust-self-signed-cert
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable privacy trust-self-signed-cert
Sets the default trust of new self-signed manufacturer certificates to trusted for all CMs on slot 2 / interface 0.
Related Commands cable privacy check-cert-validity-periodscable privacy kek life-timecable privacy tek life-time
cable proxy-arp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference66
cable proxy-arp
This command enables proxying of ARP requests from the network side interface, and from the upstream channels in the targeted slot/interface. The CMTS responds to all ARP requests from devices on the NSI and RFI interfaces with ordinary ARP replies that return the MAC address of the requested IP address, as long as the CMTS has the IP/MAC address association in its ARP cache. Otherwise, the CMTS forwards the ARP request normally.
See the “Syntax” section for descriptions of the various forms of this command, and their effect on ARP requests from the HFC/RF side.
If enabled, ARP verification (authentication) is performed on the source of the ARP packet prior to proxying or forwarding an ARP packet (see the cable arp-verify command).
! cable proxy-arp is a command within the interface cable sub-mode and requires read-write privilege.
! no cable proxy-arp disables proxying of ARP packets.
! By default, ARP proxying is enabled.
Syntax cable proxy-arp
The CMTS checks an ARP request against its ARP table cache for a match. If a match is found, the CMTS sends an ARP response directly to the requestor. If a match is not found (or if ARP proxy is disabled), the CMTS forwards the ARP request to all downstream channels in the currently-defined broadcast domain. This form of the command disables the gateway and the rewrite options if either was previously enabled.
cable proxy-arp gateway
The CMTS responds to all ARP requests (by either a CM or a CPE device) with the MAC address of the requesting device’s gateway. The purpose is to force all traffic from an RF device to be routed through its respective gateway. This prevents direct subscriber-to-subscriber communication. Note that the presence of an layer-2 switch attached to a DOCSIS Module allows the forwarding of packets from one RF interface to another on a different DOCSIS Module, or on a different Fast Ethernet port on the same DOCSIS Module.
The gateway for each device is determined dynamically by gleaning the router option from the DHCPACK message that grants the device its IP address. If multiple routers are listed in the option, the first router will be selected as the gateway.
This form of the command disables the rewrite option if it was previously enabled.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable proxy-arp
67
cable proxy-arp gateway rewrite
This form of the command enables all the functionality of the cable proxy-arp gateway form of the command. In addition, the CMTS overwrites the destination MAC address of every packet (except for ARP and DHCP packets) to be the MAC address of the gateway. This forces all subscriber traffic to be routed to the gateway, even if a rogue subscriber attempts to ignore the gateway proxy-arp response (for example, by entering static ARP entries on their CPE device).
no cable proxy-arp
Disables proxying of ARP packets.
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable proxy-arp
Proxy all verified ARP requests from the upstream channels in slot 2 / interface 1.
Related Commands arpcable arp-verifycable broadcast-domaincable ip-broadcast-echocable ip-multicast-echoclear arp-cacheshow ip arp
! The rewrite option incurs additional CMTS overhead because the destination MAC address must be written in every packet.
! Packets with layer-2 group addresses (multicast or broadcast) will also be overwritten with the unicast gateway MAC address when rewrite is enabled. This might cause problems for applications that use IP multicast or broadcast packets.
cable ranging-attempts
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference68
cable ranging-attempts
This command sets the number of ranging attempts the CMTS will make before concluding that a cable modem is non-responsive.
Ranging is the process by which the CM and CMTS establish connectivity and exchange basic physical information under the DOCSIS protocol. The CM sends a ranging request at initialization. The CMTS also prompts the CM for ranging requests periodically. Parameters such as SID, channel ID, timing, frequency and power information are maintained and adjusted during ranging.
! cable ranging-attempts is a command within the interface cable sub-mode and requires read-write privilege.
! The default value is 16.
! no cable ranging-attempts sets the value to default.
Syntax cable ranging-attempts <number-of-attempts>
no cable ranging-attempts
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable ranging-attempts 25
The CMTS will attempt to range the cable modems on slot 2 / interface 1 twenty-five times before concluding the modem is non-responsive.
number-of-attempts The number of times the CMTS will attempt to range a modem. Range of values is 0 to 1024. However, large values should only be used for testing purposes. Select a small value for operation.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable relay-agent-option
69
cable relay-agent-option
This command enables the CMTS to insert Dynamic Host Configuration Protocol (DHCP) relay information in DHCP Bootrequest messages forwarded by a CM or CPE to DHCP servers. Specifically, the CMTS inserts the 48-bit MAC address of the CM in the "DHCP Relay Agent Information Option, sub-option Agent Circuit ID" (option 82) field. The DHCP server uses this address and the one in the DHCP Bootrequest message to determine if the original request came from a CM or CPE.
! cable relay-agent-option is a command within the interface cable sub-mode and requires read-write privilege.
! The default for this command is disabled.
! no cable relay-agent-option disables insertion of DHCP relay information.
! Any DHCP configuration performed at the interface cable sub-mode level applies to the default subscriber group for that cable interface (see the cable subscriber-group command for more details).
Syntax cable relay-agent-option
no cable relay-agent-option
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable relay-agent-option
Enables the insertion of DHCP relay information from any cable modem or CPE device on slot 2 / interface 1.
Related Commands cable dhcp-giaddrcable helper-addresscable subscriber-groupdhcp-giaddrhelper-addressrelay-agent-option
cable shared-secret
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference70
cable shared-secret
This command is used to specify an authentication string that is shared between a server that provides a cable modem’s configuration file and the CMTS. This string is used by the CMTS during the provisioning to authenticate that the configuration parameters in the cable modem’s Registration Request (REG-REQ) are from a trusted source. If assigned in the configure terminal mode, the shared secret applies globally to the CMTS. If assigned in the interface cable sub-mode, the shared secret applies to the targeted cable interface and overrides the global shared secret.
! cable shared-secret is a command in the configure terminal mode and the interface cable sub-mode, and requires read-write privilege.
! no cable shared-secret disables authentication during cable modem registration.
! By default, authentication is disabled during cable modem registration.
Syntax cable shared-secret <secret-string> [encrypted]
no cable shared-secret
cable shared-secret show
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable shared-secret DOCSIS
The shared secret authentication string is DOCSIS.
GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable shared-secret 977071536c2ea956 encrypted
The encrypted shared secret authentication string is 977071536c2ea956 for slot 2 / interface 1.
GX$root(config)# cable shared-secret show
Shared-secret is: 977071536c2ea956
Related Commands show cable shared-secret
secret-string Specifies the authentication string, up to a maximum of 64 text characters.
show Displays the shared secret in encrypted form.
encrypted The secret string is treated as an encrypted string. If this parameter is not specified, the string is treated as plain text.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable show
71
cable show
This command displays configuration data about the cable interface specified by the interface cable command.
! cable show is a command within the interface cable sub-mode and requires read-write privilege.
Syntax cable show
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable show
Data for the cable interface at slot 2 / interface 1 is displayed.
IfIndex : 6
Insertion Interval : 10
Ranging Attempts : 16
Sync Interval : 5
Ucd Interval : 1000
cable source-verify
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference72
cable source-verify
This command enables IP verification—also referred to as IP authentication. All IP packets are checked against an address verification table that contains the correspondence between a CM’s IP address, MAC address, and internal CM ID. There are three possible outcomes of the address verification check:
1. If the source IP address of an IP packet is found in the address verification table, and the source MAC address and CM ID match those in the table entry, the packet is considered valid and the CMTS forwards it.
2. If the source IP address of an IP packet is found in the address verification table, and the source MAC address and/or CM ID do not match those in the table entry, the packet is considered invalid and the CMTS unconditionally drops it.
3. If the source IP address of an IP packet is not found in the address verification table, the packet is considered unverifiable. By default, unverifiable IP packets are forwarded unless the cable drop-unverifiable-addresses command enables the dropping of these packets.
! cable source-verify is a command within the configure terminal mode and requires read-write privilege.
! no cable source-verify disables IP packet verification. DHCP lease queries are no longer issued, regardless of the previous state of the lease query.
! By default, IP packet verification is disabled.
Syntax cable source-verify [DHCP]
no cable source-verify
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable source-verify
Verify all IP packets (without DHCP lease query).
DHCP If DHCP is specified and the source IP address of the IP packet cannot be found in the address verification table, the CMTS issues DHCP lease queries to attempt to learn the association between the IP address, the MAC address, and the CM. The address verification table is updated accordingly.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable source-verify
73
Related Commands arpcable address-verificationcable arp-verifycable broadcast-domaincable ip-broadcast-echocable ip-multicast-echocable proxy-arpclear arp-cacheshow cable address-verificationshow ip arp
Guidance This command enables address verification for IP packets only. Generally, if IP packet verification is enabled, ARP packet verification should also be enabled (see the cable arp-verify command).
There is a performance impact when IP address verification is enabled.
cable subscriber-group
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference74
cable subscriber-group
This command is used to define a subscriber group that represents a collection of CMs and CPEs. All CMs and CPEs that reside in the same subscriber group use the DHCP-related parameters assigned while in the subscriber group sub-mode. These parameters are assigned with the subscriber group sub-mode commands dhcp-giaddr, helper-address, and relay-agent-option. The basic underlying functionality of these commands is the same as the cable dhcp-giaddr, cable helper-address, and cable relay-agent-option commands, respectively.
Every subscriber group created on a cable interface must be assigned a GIADDR, and the IP address used must be from the same subnet assigned to the CMs in that subscriber group.
Any DHCP configuration performed at the interface cable sub-mode level applies to what is known as the default subscriber group for that slot/interface.
See the G10 CMTS and G1 CMTS Installation and Operation manuals for provisioning examples and more information regarding DHCP-related configuration.
! cable subscriber-group is a command within the interface cable sub-mode and requires read-write privilege.
! A maximum of four subscriber groups can be created for each cable interface.
! no cable subscriber-group removes the subscriber group, including the configuration performed under that group.
Syntax cable subscriber-group <group-name>
no cable subscriber-group <group-name>
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable subscriber-group ISP1
GX$root(config-if-c2/1-sgrp)# dhcp-giaddr 10.22.3.4
GX$root(config-if-c2/1-sgrp)# helper-address 192.168.23.45 10.22.3.1
GX$root(config-if-c2/1-sgrp)# relay-agent-option
Defines and configures the subscriber group ISP1 under slot 2 / interface 1. A GIADDR of 10.22.3.4 is used for both CMs and CPEs. The DHCP server IP address is 192.168.23.45, but since it is not on the Fast Ethernet port associated with this cable interface, a next-hop IP address of 10.22.3.1 is specified. The relay agent option is used for DHCP-Bootrequest messages.
GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# no cable subscriber-group ISP1
Removes the subscriber group ISP1, including the configuration performed under this group.
group-name Alphanumeric string that specifies the group name.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable sync-interval
75
Related Commands cable dhcp-giaddrcable helper-addresscable relay-agent-optiondhcp-giaddrhelper-addressrelay-agent-option
cable sync-interval
This command sets the DOCSIS Sync Interval for those cable modems on the targeted interface. This interval is defined as the nominal time between the transmission of SYNC messages from the CMTS.
! cable sync-interval is a command within the interface cable sub-mode and requires read-write privilege.
! no cable sync-interval resets the Sync interval to the default.
! The default Sync interval is 5 milliseconds.
Syntax cable sync-interval <interval>
no cable sync-interval
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable sync-interval 20
Set the Sync interval for slot 2 / interface 1 to 20 milliseconds.
Related Commands show running-config
interval Number of milliseconds between 1 and 200, assigned to the Sync interval.
cable ucd-interval
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference76
cable ucd-interval
This command defines the interval between the transmission of Upstream Channel Descriptor (UCD) messages scheduled by the CMTS for the targeted interface. UCD messages must be periodically transmitted by the CMTS to define the channel and burst characteristics of an upstream channel. Examples of channel parameters include symbol rate, frequency, and preamble pattern. Examples of burst parameters include modulation type, differential encoding, maximum burst size, guard time size, and parameters associated with the preamble, forward error correction (FEC), and scrambler.
! The cable ucd-interval command is a command within the interface cable sub-mode and requires read-write privilege.
! The default interval is 1000 milliseconds.
! no cable ucd-interval resets the interval to the default.
Syntax cable ucd-interval <interval>
no cable ucd-interval
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable ucd-interval 100
Set the interval between UCD messages for slot 2 / interface 1 to 100 milliseconds.
Related Commands cable modulation-profileshow running-config
interval The number of milliseconds (1 to 2000) between UCD messages
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream add
77
cable upstream add
This command adds the given upstream channel to the targeted cable interface.
! cable upstream add is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream add removes the given upstream channel from the targeted cable interface.
! See “Configuration Notes” on page 219 for the default upstream channel assignment for 8-channel and 16-channel DOCSIS Modules.
Syntax cable upstream <channel> add
no cable upstream <channel> add
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable upstream 4 add
GX$root(config-if-c2/0)# no cable upstream 4 shutdown
Add upstream channel 4 to slot 2 / interface 0, then enable the channel.
Related Commands cable downstream addcable upstream show
Guidance After adding a channel to a slot/interface, the channel must be enabled into service by issuing the no cable upstream shutdown command.
channel The channel that is assigned to the cable interface (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
cable upstream channel-hopping
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference78
cable upstream channel-hopping
The G10 CMTS uses its integrated spectrum analyzer to implement a feature called Upstream Channel Monitoring (UCM). UCM allows the CMTS to monitor the noise power for the frequency band allocated to an upstream channel, and automatically adjust the channel location, width, and modulation profile with the intent of maximizing the channel’s throughput. These adjustments—referred to as channel hopping, channel width control, and channel modulation control—are enabled and occur independently of each other.
The cable upstream channel-hopping command enables channel hopping for the specified channel to a new location on the same port defined by the cable upstream-port spare command.
! cable upstream channel-hopping is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream channel-hopping disables channel hopping for the specified channel.
! An upstream channel will only exist in its original location or in a spare location. Existing upstream channels will not be swapped.
! If channel width control is not enabled, a spare channel can only be used if its width is greater than or equal to the original channel width. If the spare channel width is greater than the original channel width, the resulting frequency of the channel moved into the spare slot is chosen to maximize the signal-to-noise ratio (which might be different than the center frequency specified in the cable upstream-port spare command).
Syntax cable upstream <channel> channel-hopping
no cable upstream <channel> channel-hopping
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 channel-hopping
Enables channel hopping for channel 2 on slot 2 / interface 1.
Related Commands cable upstream-port sparecable upstream modulation-controlcable upstream width-control
channel The channel for which channel hopping is enabled (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream channel-width
79
cable upstream channel-width
This command sets the channel width for an upstream channel in the targeted slot/interface.
! cable upstream channel-width is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream channel-width sets the upstream channel-width to the default value.
! The default settings for this command is 1600000 Hz.
Syntax cable upstream <channel> channel-width <width>
no cable upstream <channel> channel-width
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 channel-width 400000
The upstream channel width for channel 2 in slot 2 / interface 1 is set to 400 KHz.
Related Commands cable upstream show
channel The channel for which the width is being set (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
width The channel width (in Hz) of the channel being set. Choices are: 200000, 400000, 800000, 1600000, and 3200000.
cable upstream concatenation
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference80
cable upstream concatenation
This command enables the deconcatenation of concatenated MAC frames transmitted by CMs on the given upstream channel on the targeted slot/interface. Concatenation allows a CM to transmit multiple MAC frames in a single transmit opportunity. The PHY overhead, such as the preamble, guard time, and any zero-fill bytes, as well as the Concatenation MAC Header occur only once for the concatenated transmission.
! cable upstream concatenation is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream concatenation disables concatenation for the given upstream channel on the targeted cable interface.
! By default, concatenation is enabled for all upstream channels.
Syntax cable upstream <channel> concatenation
no cable upstream <channel> concatenation
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable upstream 4 concatenation
Enable concatenation on upstream channel 4 on slot 2 / interface 0.
Related Commands cable upstream show
channel The channel for which concatenation is enabled or disabled (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream data-backoff
81
cable upstream data-backoff
This command establishes a range of values a cable modem will use when it needs to defer (back-off) opportunities for transmission of a bandwidth request or packet in a contention region. This information is in the Bandwidth Allocation Map.
The number of times a CM will attempt to transmit a request or packet in contention is fixed at 16. The start and end parameters of this command define intervals between attempts. The CM randomly chooses a value from within a window that defines the number of transmit opportunities it will defer. If the first transmission attempt is not successful, the size of the window is increased for the second attempt, and again for the third attempt, and so forth for the remaining attempts. The values in the window are the number of transmit opportunities that will be deferred.
The window of values always begins with 0. The window for the first attempt stops with the value [2x–1], where X = start parameter. If a second attempt is needed, the window of values stops at [2x+1–1]. The exponent continues to increment by one until it equals the number in the end parameter. The size of the window will not increase for any subsequent transmit attempts.
The G10 CMTS features a special algorithm to optimize the allocation of request contention slots in the upstream. This optimization makes use of collision statistics to control both the rate of these contention slots and the window start and end parameters of the truncated binary exponential backoff algorithm specified in DOCSIS. This special algorithm is enabled by specifying 0 for both the start and the end parameters of the command.
! cable upstream data-backoff is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream data-backoff allows the CMTS to dynamically vary the upstream data backoff start and stop values.
! The default setting is the no form of this command.
Syntax cable upstream <channel> data-backoff <start> <end>
no cable upstream <channel> data-backoff
Definitions
channel The channel for which the data backoff parameters are to be set (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
start Indicates upper limit of the random backoff window for the first attempt (0 to 15).
end Indicates maximum upper limit of the random backoff window for subsequent attempts (0 to 15). Must be equal to or larger than start value.
cable upstream data-backoff
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference82
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 data-backoff 5 10
Sets the start and end data-backoff parameters of channel 2 on slot 2 / interface 1 to 5 and 10, respectively.
GX$root(config-if-c2/1)# cable upstream 2 data-backoff 0 0
Sets the start and end data-backoff parameters of channel 2 on slot 2 / interface 1 to 0. For broadcast requests, the optimization algorithm dynamically configures the start and end parameters and schedules contention requests at a rate such that it minimizes both the collision statistics on contention slots and the upstream bandwidth used by broadcast requests.
Guidance Based on a truncated binary exponential backoff, DOCSIS specifies a method to resolve contention in data and request transmission opportunities. The initial backoff window (start) and final backoff window (end) values are specified as part of the Bandwidth Allocation Map message and controlled by the CMTS. Each value represents a power of two, so that a value of 4 represents a window between 0 and 15 (24 = 16 window).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream force
83
cable upstream force
When a change is made to an upstream channel descriptor (UCD), the CMTS will normally reject any UCD changes that make it impossible to maintain active service flow guarantees (such as a reduction in the width of a channel). This command allows you to unconditionally change UCD parameters without rejection. Issuing this command might cause service flows to be dropped, including the possibility that some CMs might lose their registration.
! cable upstream force is a top-level command and requires read-write privilege.
! Any combination of the parameters following the force keyword can be specified (in the order shown).
Syntax cable upstream slot <slot> channel <channel> force [channel-width <width>] [frequency <frequency>] [minislot-size <minislot-size>] [modulation-profile <profile-id>]
Definitions
Examples GX$root# cable upstream slot 2 channel 3 force channel-width 1600000
Force the channel width in the UCD for channel 3 on the DOCSIS Module in slot 2 to be 1.6 MHz.
Related Commands cable upstream channel-widthcable upstream frequencycable upstream minislot-sizecable upstream modulation-profile
slot Chassis slot number of the DOCSIS Module on which the specified channel resides (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS). See the diagram in “Interface, Port, and Channel Numbers” on page 220.
channel The channel corresponding to the UCD (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
channel-width Specifies that the channel width in the UCD will be changed.
width The channel width (in Hz) of the reserved upstream channel. Choices are: 200000, 400000, 800000, 1600000, and 3200000.
frequency Specifies that the frequency in the UCD will be changed.
frequency The center frequency in Hz of the upstream channel to be set.
DOCSIS: 5000000 to 42000000EuroDOCSIS: 5000000 to 65000000
minislot-size Specifies that the minislot-size in the UCD will be changed.
minislot-size The minislot size in time ticks. Valid values are 2, 4, 8, 16, 32, 64, 128.
modulation-profile Specifies that the parameters associated with the specified modulation profile will be used in the UCD.
profile-id The modulation profile ID number that was defined with the cable modulation-profile command. Valid options are numbers from 1 to 256.
cable upstream frequency
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference84
cable upstream frequency
This command sets a fixed frequency for a channel in the specified slot/interface.
! cable upstream frequency is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream frequency allows the CMTS to dynamically select the frequency for an upstream channel.
! The default setting is the no form of this command.
Syntax cable upstream <channel> frequency <frequency>
no cable upstream <channel> frequency
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 frequency 32000000
A fixed frequency for channel 2 in slot 2 / interface 1 is set to 32 MHz.
channel The channel for which the frequency is being set (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
frequency The center frequency in Hz of the upstream channel to be set.
DOCSIS: 5000000 to 42000000EuroDOCSIS: 5000000 to 65000000
Because the frequency parameter specifies the center frequency of the upstream channel, the CMTS takes into account the channel width prior to checking the valid range of the frequency parameter. For example, specifying a center frequency of 5000000 (5 MHz) will fail the frequency range check because part of the channel would reside below 5 MHz.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream-load-balance
85
cable upstream-load-balance
This command enables automatic upstream load balancing for cable modems based on channel width and utilization. When a cable modem first ranges, the CMTS has an opportunity to choose the upstream channel to which the cable modem is assigned. With load balancing, the CMTS will attempt to assign an upstream channel in proportion to the available bandwidth amongst available upstream channels.
! cable upstream-load-balance is a command within the configure terminal sub-mode and requires read-write privilege.
! no cable upstream-load-balance disables automatic load balancing.
! The default setting is the no form of this command.
Syntax cable upstream-load-balance
no cable upstream-load-balance
Examples GX$root# configure terminal
GX$root(config)# cable upstream-load-balance
Enable upstream load balancing.
cable upstream minislot-size
This command sets the minislot size for a channel in the specified slot/interface.
! cable upstream minislot-size is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream minislot-size allows the CMTS to set the minislot size as appropriate for the configured upstream channel width.
! The default setting is the no form of this command.
Syntax cable upstream <channel> minislot-size <minislot-size>
no cable upstream <channel> minislot-size
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 minislot-size 16
The minislot size for channel 2 in slot 2 / interface 1 is set to 16 (which equals 256 symbols at a symbol rate of 2560 Ksym/sec).
channel The channel for which the minislot size is being set (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
minislot-size The minislot size in time ticks. Valid values are 2, 4, 8, 16, 32, 64, 128.
cable upstream modem flap-list
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference86
cable upstream modem flap-list
This command defines flap criteria for the specified upstream channel on the targeted interface by setting various parameters (thresholds). The thresholds defined by this command override those defined by the cable modem flap-list command, which defines global threshold settings for all cable interfaces. Once a threshold has been set by the cable upstream modem flap-list command, its value is not affected by the cable modem flap-list command.
See the cable modem flap-list command for details regarding the flap-list.
! cable upstream modem flap-list is a command within the interface cable sub-mode and requires read-write privilege.
! The no form of this command restores all, or the specified parameter, to its current global value.
Syntax cable upstream <channel> modem flap-list {snr-threshold <snr-threshold>} |{mer-threshold <mer-threshold>} |{cer-threshold <cer-threshold>} |{power-adjust-threshold <power-adjust-threshold>} |{im-retry-interval <im-retry-interval>} |{sm-miss-threshold <sm-miss-threshold>} |{show}
no cable upstream <channel> modem flap-list [snr-threshold|mer-threshold|cer-threshold|power-adjust-threshold|im-retry-interval|sm-miss-threshold]
Definitions
channel The channel to which the specified threshold applies (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
snr-threshold A flap occurs when the measured SNR of a CM drops below this threshold (specified in dB). The valid range is 1–100 and the default is 18.
mer-threshold A flap occurs when the measured Modulation Error Rate (MER) of a CM drops below this threshold (specified in dB). The valid range is 1–100 and the default is 18.
cer-threshold A flap occurs when the measured Codeword Error Rate (CER) of a CM rises above this threshold (specified in units of 10-6). The CER is the ratio of the number of codewords received with errors, before error correction is attempted, and the total number of codewords received (with and without errors). The valid range is 1–1000000 and the default is 1 (1 x 10-6).
power-adjust-threshold A flap occurs when the power adjustment sent to the CM during station maintenance is above this threshold (specified in dB). The valid range is 1–100 and the default is 3.
im-retry-interval A flap occurs when the time between two successive initial maintenance attempts by a particular CM is below this threshold (specified in seconds). The valid range is 60–86400 and the default is 180.
sm-miss-threshold A flap occurs when the number of consecutively missed station maintenance opportunities by a particular CM is above this threshold, and the CMTS subsequently receives a successful ranging request from the CM (this latter condition is required to discern whether the CM is missing station maintenance opportunities or is off-line). The valid range is 1–100 and the default is 2.
show Displays the current value of each flap-list parameter. A value followed by * indicates that the global threshold was overridden by the cable upstream modem flap-list command.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream modem flap-list
87
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 modem flap-list snr-threshold 20
Set the SNR threshold for all CMs on channel 2 of slot 2 / interface 1 to 20 dB.
GX$root(config-if-c2/1)# no cable upstream 2 modem flap-list snr-threshold
Restore the SNR threshold for all CMs on channel 2 of slot 2 / interface 1 to its previous global value.
GX$root(config-if-c2/1)# no cable upstream 2 modem flap-list
Restore all thresholds for all CMs on channel 2 of slot 2 / interface 1 to their previous global values.
Related Commands cable modem flap-listclear cable modem flap-listshow cable flap-list
Tuning the flap thresholds is recommended to minimize the number of irrelevant entries in the flap-list.
cable upstream modulation-control
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference88
cable upstream modulation-control
The CMTS uses its integrated spectrum analyzer to implement a feature called Upstream Channel Monitoring (UCM). UCM allows the CMTS to monitor the noise power for the frequency band allocated to an upstream channel, and automatically adjust the channel location, width, and modulation profile with the intent of maximizing the channel’s throughput. These adjustments—referred to as channel hopping, channel width control, and channel modulation control—are enabled and occur independently of each other.
The cable upstream modulation-control command enables channel modulation control for the specified channel.
! cable upstream modulation-control is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream modulation-control disables channel modulation control for the specified channel.
Syntax cable upstream <channel> modulation-control
no cable upstream <channel> modulation-control
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 modulation-control
Enables channel modulation control for channel 2 on slot 2 / interface 1.
Related Commands cable upstream-port sparecable upstream channel-hoppingcable upstream width-control
channel The channel for which channel modulation control is enabled (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream modulation-profile
89
cable upstream modulation-profile
This command assigns a modulation profile to a channel in the specified slot/interface. Modulation profiles are defined with the cable modulation-profile command in the configure terminal mode.
! cable upstream modulation-profile is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream modulation-profile assigns the default profile to the channel.
! The default setting is the no form of this command.
Syntax cable upstream <channel> modulation-profile <profile-id>
no cable upstream <channel> modulation-profile
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 modulation-profile 2
The modulation profile with ID number 2 is assigned to channel 2 in slot 2 / interface 1.
Related Commands cable modulation-profile
channel The channel to which the modulation profile is being assigned (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
profile-id The modulation profile ID number that was defined with the cable modulation-profile command. Valid options are numbers from 1 to 256.
cable upstream port
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference90
cable upstream port
This command associates an upstream channel with a physical upstream (US) port. You can associate more than one channel with any of the four upstream ports. See Appendix B, Configuration Notes, for more information.
! cable upstream port is a command within the interface cable sub-mode and requires read-write privilege.
! On a G10 CMTS DOCSIS Module that supports 8 upstream channels, the default association of cable interfaces to US ports and channels is:
! On a G10 CMTS DOCSIS Module that supports 16 upstream channels, the default association of cable interfaces to US ports and channels is:
Cable Interface Upstream Channel Upstream Port
0 0 US 0
1
1 2 US 1
3
2 4 US 2
5
3 6 US 3
7
Cable Interface Upstream Channel Upstream Port
0
0
US 01
8
9
1
2
US 13
10
11
2
4
US 25
12
13
3
6
US 37
14
15
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream port
91
! The default association of cable interfaces to US ports and channels for the G1 CMTS is:
Syntax cable upstream <channel> port <port>
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 port 2
Upstream channel 2 on slot 2 / interface 1 is assigned to upstream port 2.
Cable Interface Upstream Channel Upstream Port
0
0 US0
1
4 US2
5
1
2 US1
3
6 US3
7
channel The channel that is being associated to a port (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
port The US port (0 to 3) to which the channel is associated.
cable upstream-port spare
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference92
cable upstream-port spare
The CMTS uses its integrated spectrum analyzer to implement a feature called Upstream Channel Monitoring (UCM). UCM allows the CMTS to monitor the noise power for the frequency band allocated to an upstream channel, and automatically adjust the channel location, width, and modulation profile with the intent of maximizing the channel’s throughput. These adjustments—referred to as channel hopping, channel width control, and channel modulation control—are enabled and occur independently of each other.
The cable upstream-port spare command reserves spare channels on the specified slot and port that are used to support channel hopping. Channel overlap is checked against existing channels and other spares on the specified port.
! cable upstream-port spare is a command within the configure terminal mode and requires read-write privilege.
! no cable upstream-port spare can remove a specified spare channel, or remove all spare channels on a specified port.
! An upstream channel will only exist in its original location or in a spare location. Existing upstream channels will not be swapped.
! If channel width control is not enabled, a spare channel can only be used if its width is greater than or equal to the original channel width. If the spare channel width is greater than the original channel width, the resulting frequency of the channel moved into the spare slot is chosen to maximize the signal-to-noise ratio (which might be different than the center frequency specified in the cable upstream-port spare command).
Syntax cable upstream-port slot <slot> port <port> spare center-frequency <frequency> width <width>
no cable upstream-port slot <slot> port <port> spare center-frequency <frequency>
Removes the specified spare channel.
no cable upstream-port slot <slot> port <port> spare
Removes all spare channels on the specified port.
Definitions
Once a spare channel is reserved, the CMTS begins monitoring the noise power of that spare channel. Minimize the number of spare channels reserved to ensure that the performance of the CMTS is not severely impacted.
slot Chassis slot number of the DOCSIS Module on which spare channels are reserved (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS). See the diagram in “Interface, Port, and Channel Numbers” on page 220.
port The US port (0 to 3) on which spare channels are reserved.
frequency The center frequency in Hz of the reserved upstream channel.
DOCSIS: 5000000 to 42000000EuroDOCSIS: 5000000 to 65000000
width The channel width (in Hz) of the reserved upstream channel. Choices are: 200000, 400000, 800000, 1600000, and 3200000.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream power-level
93
Examples GX$root# configure terminal
GX$root(config)# cable upstream-port slot 2 port 3 spare center-frequency
19000000 width 1600000
Reserve a spare channel on port 3 of the HFC Connector Module in slot 2. Frequency is 19 MHz. Channel width is 1.6 MHz.
Related Commands cable upstream channel-hoppingcable upstream modulation-controlcable upstream width-control
cable upstream power-level
This command sets the input power level for a channel in the specified slot/interface.
! cable upstream power-level is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream power-level sets the input power level to the default.
! The default is 0 dBmV.
Syntax cable upstream <channel> power-level <power-level>
no cable upstream <channel> power-level
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 power-level 5
The input power level for channel 2 in slot 2 / interface 1 is set to 5 dBmV.
channel The channel for which the power level is being set (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
power-level The input power level in dBmV. Range is -10 to +25 dBmV.
cable upstream-pre-equalization
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference94
cable upstream-pre-equalization
Upstream pre-equalization is a technique used by the CMTS to compensate for various distortions present in the return path. The DOCSIS 1.1 specification states that CM transmitters must have a symbol (T)-spaced equalizer structure with 8 taps. In response to an initial ranging request and periodic ranging requests from the CM, the CMTS evaluates the distortions in the return path, computes the set of pre-equalizer coefficients, and returns them back to the CM in the ranging response messages.
! cable upstream-pre-equalization is a command within the configure terminal mode and requires read-write privilege.
! no cable upstream-pre-equalization disables pre-equalization.
! The default is disabled.
Syntax cable upstream-pre-equalization
no cable upstream-pre-equalization
Examples GX$root# configure terminal
GX$root(config)# cable upstream-pre-equalization
Enable upstream pre-equalization.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream range-backoff
95
cable upstream range-backoff
This command establishes a range of values a cable modem will use when it needs to defer (back-off) opportunities for transmission of a ranging request in an Initial Maintenance contention region. This information is in the Bandwidth Allocation Map.
The number of times a CM will attempt to transmit a request or packet in contention is fixed at 16. The start and end parameters of this command define intervals between attempts. The CM randomly chooses a value from within a window that defines the number of transmit opportunities it will defer. If the first transmission attempt is not successful, the size of the window is increased for the second attempt, and again for the third attempt, and so forth for the remaining attempts. The values in the window are the number of transmit opportunities that will be deferred.
The window of values always begins with 0. The window for the first attempt stops with the value [2x–1], where X = start parameter. If a second attempt is needed, the window of values stops at [2x+1–1]. The exponent continues to increment by one until it equals the number in the end parameter. The size of the window will not increase for any subsequent transmit attempts.
The G10 CMTS features a special algorithm to optimize the allocation of initial ranging contention slots in the upstream. This optimization makes use of collision statistics to control both the rate of these contention slots and the window start and end parameters of the truncated binary exponential backoff algorithm specified in DOCSIS. This special algorithm is enabled by specifying 0 for both the start and the end parameters of the command.
! cable upstream range-backoff is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream range-backoff allows the CMTS to dynamically vary the upstream range backoff start and stop values.
! The default setting is the no form of this command.
Syntax cable upstream <channel> range-backoff <start> <end>
no cable upstream <channel> range-backoff
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 range-backoff 5 10
Sets the start and end range-backoff parameters of channel 2 on slot 2 / interface 1 to 5 and 10, respectively.
channel The channel for which the range backoff parameters are to be set (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
start Indicates upper limit of the random backoff window for the first attempt (0 to 15).
end Indicates maximum upper limit of the random backoff window for subsequent attempts (0 to 15). Must be equal to or larger than start value.
cable upstream show
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference96
GX$root(config-if-c2/1)# cable upstream 2 range-backoff 0 0
Sets the start and end data-backoff parameters of channel 2 on slot 2 / interface 1 to 0. For broadcast initial maintenance slots, the optimization algorithm dynamically configures the start and end parameters. The rate at which initial maintenance slots are scheduled is not optimized because:
1. It would conflict with the initial maintenance alignement feature.
2. The Broadband Cable Processor ASIC has a unique feature of being able to receive multiple initial ranging requests during one initial maintenance slot. Therefore, the G10 CMTS does not need to increase the rate of initial maintenance grants after a power outage in order to have all the CMs back online as soon as possible.
Guidance Based on a truncated binary exponential backoff, DOCSIS specifies a method to resolve contention in Initial Maintenance transmission opportunities. The initial backoff window (start) and final backoff window (end) values are specified as part of the Bandwidth Allocation Map message and controlled by the CMTS. Each value represents a power of two, so that a value of 4 represents a window between 0 and 15 (24 = 16 window).
cable upstream show
This command displays the upstream channel information for a specified slot/interface.
! cable upstream show is a command within the interface cable sub-mode and requires read-write privilege.
! This command does not have a no form.
! There are no default settings for this command.
Syntax cable upstream <channel> show
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable upstream 1 show
Cable modem information for channel 1 in slot 2 / interface 0 is displayed.
Cable 2/0: Upstream 1 is up
Received 10 broadcast, 0 multicasts, 14044 unicasts
0 discards, 0 errors, 0 unknown protocol
14054 packets input, 0 uncorrectable
301 noise, 0 microreflections
channel The channel for which information will be displayed (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream shutdown
97
cable upstream shutdown
This command disables an upstream channel in the specified slot/interface.
! cable upstream shutdown is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream shutdown enables the channel.
! The channels are disabled by default.
Syntax cable upstream <channel> shutdown
no cable upstream <channel> shutdown
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# no cable upstream 2 shutdown
Channel 2 in slot 2 / interface 1 is enabled.
Related Commands cable downstream shutdownshutdown
channel The channel that will be enabled or disabled (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS). This channel is in the slot/if specified in the interface cable command.
cable upstream width-control
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference98
cable upstream width-control
The CMTS uses its integrated spectrum analyzer to implement a feature called Upstream Channel Monitoring (UCM). UCM allows the CMTS to monitor the noise power for the frequency band allocated to an upstream channel, and automatically adjust the channel location, width, and modulation profile with the intent of maximizing the channel’s throughput. These adjustments—referred to as channel hopping, channel width control, and channel modulation control—are enabled and occur independently of each other.
The cable upstream width-control command enables channel width control for the specified channel. Channel width control typically affects a channel’s width and its frequency. If channel hopping is disabled, any frequency change is limited to the channel’s current slot.
! cable upstream width-control is a command within the interface cable sub-mode and requires read-write privilege.
! no cable upstream width-control disables channel width control for the specified channel.
! If channel width control and channel hopping are enabled, a spare channel can be used even if its width is less than the original channel width.
Syntax cable upstream <channel> width-control
no cable upstream <channel> width-control
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable upstream 2 width-control
Enables channel width control for channel 2 on slot 2 / interface 1.
Related Commands cable upstream-port sparecable upstream channel-hoppingcable upstream modulation-control
channel The channel for which channel width control is enabled (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable vpn
99
cable vpn
This command assigns the CPE devices behind a CM to a cable Virtual Private Network (VPN). A CPE can only be part of one VPN, so a second instance of this command overrides the previous VPN ID. This command does not ensure the VPN is private, so BPI (or BPI+) must be enabled within the CM’s configuration file if privacy on the VPN is desired.
VPNs are implemented using 802.1Q VLAN tags. Upstream packets normally arrive at the CMTS untagged. However, the CPE might elect to send 802.1Q tagged packets. If the tag does not match the vpn-id assigned to the CPE, the packet is dropped. Otherwise, the packet is forwarded. All downstream packets are always transmitted untagged.
A CM can also be provisioned as a member of a VPN by inclusion of a Juniper Networks TLV in the CM configuration file. See the G10 CMTS and G1 CMTS Installation and Operation manuals for more details.
! cable vpn is a command within the configure terminal mode and requires read-write privilege.
! no cable vpn removes a specified CM from a VPN.
! By default, a CM does not belong to a VPN unless it is provisioned as such.
Syntax cable vpn <mac-address> <vpn-id>
no cable vpn <mac-address>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable vpn 1234.5678.9ABC 129
Assign the CM with the MAC address of 1234.5678.ABCD to VPN ID 129.
Related Commands show cable vpn
Guidance The cable vpn command overrides any VPN provisioning through a CM configuration file.
mac-address The MAC address of the CM specified as xxxx.xxxx.xxxx in hexadecimal.
vpn-id The ID used to specify the VPN to which the CM is assigned. This is used to add VLAN tags to the packets. Valid range is 129–4000.
It is important to note that the mac-address specified in this command is the MAC address of the CM (not the MAC address of the CPE).
cat
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference100
cat
This command displays the entire contents of a file without stopping until the end of the file is reached.
! cat is a top-level command and requires read-only privilege.
Syntax cat <file-name>
Definitions
Examples GX$root> cat README
Displays the entire contents of the file README.
Related Commands dirmkdirmorepwd
cd
This command changes the current working directory. By default, the current working directory becomes the prefix for all relative paths. For absolute paths, specify the current working directory with a slash.
! cd is a top-level command and requires read-only privilege.
! This command does not have a no form.
! There are no default settings for this command.
Syntax cd [dir-name]cd ..
Definitions
Examples GX$root> cd temp
The current working directory is changed to the temp directory using a relative path. The temp directory must be under the current location.
GX$root> cd /home/temp
The current working directory is changed to the temp directory using an absolute path.
Related Commands lsmkdirpwdrmdir
file-name Name of the file to be displayed. Can include the path to the file.
dir-name The name of the target directory. If omitted, the current working directory will change into the home directory (/home).
.. The target directory is one level up from the current working directory.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
change-password
101
change-password
The command allows the current user to change their password.
! change-password is a top-level command and is available to all users.
! This command does not have a no form.
Examples GX$root> change-password
GX$root> Old password:
GX$root> New password:
GX$root> New password again:
chassis environment ambient-temperature
This command sets internal chassis temperature thresholds that determine when SNMP messages are sent to the NMS. When the chassis temperature crosses above the high threshold, the CMTS sends a warning message to the NMS. When the chassis temperature crosses below the low threshold, the CMTS sends an informational message to the NMS. SNMP message generation only occurs for unidirectional transitions across a threshold.
! chassis environment ambient-temperature is a command within the configure terminal mode and requires read-write privilege.
! The high-threshold and low-threshold parameters default to 60°C and 40°C, respectively.
Syntax chassis environment ambient-temperature {user-high-threshold <high-threshold>} | {user-low-threshold <low-threshold>}
Definitions
The SNMP message generation produced by this command is independent of the message generation produced by the Chassis Control Module when the temperature crosses its internally-defined thresholds.
user-high-threshold Indicates the command is setting the high temperature threshold.
high-threshold The high temperature threshold, in degrees C. The default is 60°C.
user-low-threshold Indicates the command is setting the low temperature threshold.
low-threshold The low temperature threshold, in degrees C. The default is 40°C.
clear aborted-modems
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference102
Examples GX$root# chassis environment ambient-temperature user-high-threshold 55
Sets the high temperature threshold at 55°C. If the chassis temperature crosses above this threshold, the CMTS sends a warning message to the NMS.
GX$root# chassis environment ambient-temperature user-low-threshold 42
Sets the low temperature threshold at 42°C. If the chassis temperature crosses below this threshold, the CMTS sends an informational message to the NMS.
Related Commands show chassis environmentshow chassis hardware
clear aborted-modems
This command removes all CM entries from the G10 CMTS database that correspond to the operational states destroyed and ranging-aborted as displayed by the show cable modem command. If such a CM attempts to perform initial ranging again, it will be added back to the CMTS database and its status can be determined by the show cable modem command.
! clear aborted-modems is a top-level command and requires read-write privilege.
! This command has no parameters.
Syntax clear aborted-modems
Examples GX$root# clear aborted-modems
Remove all destroyed and ranging-aborted CM entries from the CMTS database.
Related Commands show cable modem
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clear alarms
103
clear alarms
This command turns off the Minor, Major, and Crit LEDs on the Chassis Control Module front panel. These LEDs are illuminated when events occur that correspond to these LED levels. Table 6 provides the correspondence between the event priority and the LED that is illuminated. See the log-level show and show local-log commands for more information related to events and their priorities.
Table 6: Event Priority Correspondence to CCM LEDs
! clear alarms is a top-level command and requires read-write privilege.
! If no optional parameters are specified, all three event LEDs are turned off.
! Any combination of event LEDs can be turned off by specifying one or more optional parameters in the order shown below.
Syntax clear alarms [minor] [major] [critical]
Definitions
Examples GX$root# clear alarms
Turns off all three event LEDs on the Chassis Control Module front panel.
GX$root# clear alarms minor major
Turns off the Minor and Major LEDs on the Chassis Control Module front panel. The Crit LED is not affected.
Related Commands log-level showshow local-log
Event Priority LED
Emergency Crit
Alert Crit
Critical Crit
Error Major
Warning Minor
Notice —
Informational —
Debug —
minor Turn off the Minor LED of the Chassis Control Module.
major Turn off the Major LED of the Chassis Control Module.
critical Turn off the Crit LED of the Chassis Control Module.
clear arp-cache
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference104
clear arp-cache
This command removes all dynamic entries from the ARP (Address Resolution Protocol) table. Static ARP entries are not affected by this command (the no arp command must be used to remove static ARP entries individually by IP address).
! clear arp-cache is a top-level command and requires read-write privilege.
! This command has no parameters.
Syntax clear arp-cache
Examples GX$root# clear arp-cache
All dynamic entries are removed from the ARP table.
Related Commands arparp timeoutcable address-verificationcable proxy-arpcable vpnshow ip arp
clear cable modem
If the optional parameter cpe is not specified, this command instructs the CMTS to stop sending periodic station maintenance MAP messages to the specified CM. This causes the CM to timeout within 30 seconds and to reinitialize its MAC. If the optional parameter cpe is specified, this command clears the table of known CPEs associated with the specified CM.
! clear cable modem is a top-level command and requires read-write privilege.
Syntax clear cable modem {<ip-address>|<mac-address>} [cpe]
Definitions
Examples GX$root> clear cable modem 110.155.27.45
Forces the CM at IP address 110.155.27.45 to reinitialize its MAC.
GX$root> clear cable modem 110.155.27.45 cpe
GX$root> clear cable modem 00D0.59FD.F52F cpe
Clears the tables of known CPEs associated with CMs at IP address 110.155.27.45 and MAC address 00D0.59FD.F52F.
Related Commands clear cable modemcpe-controlled-cable-modemshow cable modem
ip-address The IP address of the cable modem. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem. Specified as xxxx.xxxx.xxxx in hexadecimal.
cpe Clears the table of known CPEs associated with the specified CM.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clear cable modem flap-list
105
clear cable modem flap-list
This command removes a single or all CMs from the flap-list. See the cable modem flap-list command for details regarding the flap-list.
! clear cable modem flap-list is a top-level command and requires read-write privilege.
! If the optional parameter mac-address is not specified, all CM entries are removed from the flap-list.
Syntax clear cable modem [<mac-address>] flap-list
Definitions
Examples GX$root# clear cable modem 1234.5678.9ABC flap-list
Remove the CM with MAC address 1234.5678.9ABC from the flap-list.
GX$root# clear cable modem flap-list
Remove all CM entries from the flap-list.
Related Commands cable modem flap-listcable upstream modem flap-listshow cable flap-list
mac-address The MAC address of the cable modem to be removed specified as xxxx.xxxx.xxxx in hexadecimal.
clock
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference106
clock
This command sets the clock time or adjusts the current time of the system clock. If the usage of the NTP server clock has been enabled, it must be disabled (by issuing the no clock ntp-server command) prior to manually setting or adjusting the clock with this command.
! clock is a top-level command and requires read-write privilege.
! This command does not have a no form.
! There are no default settings for this command.
Syntax clock adjust <adjustment>
clock set <time> <day-of-month> <month-of-year> <year>
Definitions
Examples GX$root# clock adjust –150
Adjusts the clock 2 1/2 minutes backwards.
Related Commands clock ntp-serverclock showclock summer-timeclock timezoneshow clock
adjustment Subtract or add time in seconds. Range is –3600 to 3600 seconds.
time Hours, minutes, and seconds in 24-hour format: hhmmss
day-of-month Numerical indicator for day. Range is 1 to 31.
month-of-year Numerical indicator for month. Range is 1 to 12.
year Four digit year indicator. Range is 1971 to 2037.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clock ntp-server
107
clock ntp-server
This command specifies the IP address of the network time protocol (NTP) server and enables the usage of this server for setting the CMTS system clock.
! clock ntp-server is a command within the configure terminal mode and requires read-write privilege.
! The no form of this command disables the usage of the NTP server as the CMTS system clock.
! There are no default settings for this command.
Syntax clock ntp-server <ip-address>
no clock ntp-server
Definitions
Examples GX$root# configure terminal
GX$root(config)# clock ntp-server 192.168.201.1
The NTP server at IP address 192.168.201.1 is used for setting the CMTS system clock.
GX$root(config)# clock show
Tue Dec 11 23:05:42 UTC 2001
Tue Dec 11 15:05:42 PST 2001
ntp-server ip address: 192.168.201.1
Related Commands clockclock showclock summer-timeclock timezoneshow clock
ip-address IP address of the NTP server to be sampled. Standard dot-quad notation (xxx.xxx.xxx.xxx).
clock show
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference108
clock show
This command displays the current time and date of the CMTS clock, and the NTP server IP address. The first line of the display represents the UTC time, the second line represents the local time, and the third line displays the IP address of an NTP server (if configured). If the clock summer-time command was previously issued, the fourth and fifth lines of the display show the daylight savings time start and end times, respectively.
! clock show is a command within the configure terminal mode and requires read-write privilege
! There are no parameters with this command.
Examples GX$root# configure terminal
GX$root(config)# clock show
Tue Jul 30 17:11:44 UTC 2002
Tue Jul 30 10:11:44 PDT 2002
ntp-server ip address: 192.168.10.183
Summer-time starts at: Sun Apr 07 02:00:00 PST 2002
Summer-time ends at: Sun Oct 27 02:00:00 PDT 2002
Related Commands clockclock ntp-serverclock summer-timeclock timezoneshow clock
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clock summer-time
109
clock summer-time
This command sets the start and end of daylight savings time. The local clock is adjusted accordingly based on the current date and time. There are two forms of this command. If the date parameter is specified, the clock adjustment is performed based on the specific start and end dates specified, in which case this command might have to be issued on a yearly basis. If the recurring parameter is specified, the clock adjustment is performed based on the specified month, week, and weekday, in which case the yearly execution of this command is not necessary.
! clock summer-time is a command within the configure terminal mode and requires read-write privilege.
! The no form of this command disables daylight savings time.
! There are no default settings for this command.
Syntax clock summer-time <time-zone> date <date-start> <month-start> <time-start> <date-end> <month-end> <time-end> [<offset>]
clock summer-time <time-zone> recurring <week-start> <weekday-start> <month-start> <time-start> <week-end> <weekday-end> <month-end> <time-end> [<offset>]
Definitions
time-zone The name of the local daylight savings time zone of the CMTS. This parameter must be alphabetic (at least 3 characters long), but can contain the character /.
date Specifies the form of the command in which the start and end of daylight savings time is fixed to specific dates and might have to be adjusted yearly.
date-startdate-end
Numerical value for the date of the month (1 to 31) when daylight savings time begins (date-start) and ends (date-end).
month-startmonth-end
Month when daylight savings time begins (month-start) and ends (month-end). Specified numerically (1 to 12) or as case-insensitive text (January to December). Text abbreviations are allowed providing they are unique.
time-starttime-end
Time when daylight savings time begins (time-start) and ends (time-end), specified as hh or hh:mm. Valid ranges are 0 to 24 for hh, 0 to 59 for mm.
offset Optional parameter that specifies the number of minutes to add to the local time when daylight savings time takes effect. Valid range is 1 to 1440. Default is 60.
recurring Specifies the form of the command in which the start and end of daylight savings time is changed by the CMTS based on the specified month, week, and weekday.
week-startweek-end
Numerical value for the week of the month (1 to 5, where 1 and 5 represent the first and last weeks, respectively) when daylight savings time begins (week-start) and ends (week-end). The words first and last can be specified (case insensitive) and, if desired, abbreviated.
weekday-startweekday-end
Day of the week when daylight savings time begins (weekday-start) and ends (weekday-end). Specified numerically (0 to 6, where 0 and 6 represent Sunday and Saturday, respectively) or as case-insensitive text (Sunday to Saturday). Text abbreviations are allowed providing they are unique.
clock summer-time
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference110
Examples GX$root# configure terminal
GX$root(config)# clock summer-time MNT date 7 apr 2 27 oct 2
The daylight savings time zone is named MNT and is set to begin on April 7 at 2 a.m. and end on October 27 at 2 a.m.
GX$root(config)# clock summer-time MNT recurring first sun apr 2 last sun oct 2
The daylight savings time zone is named MNT and is set to begin on the first Sunday of April at 2 a.m. and end on the last Sunday of October at 2 a.m. These start and end times are standard in the USA.
Guidance Here are the beginning and ending dates for the next several years:
2002 – Begin April 7; end October 272003 – Begin April 6; end October 262004 – Begin April 4; end October 312005 – Begin April 3; end October 30
Related Commands clockclock ntp-serverclock showclock timezoneshow clock
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clock timezone
111
clock timezone
This command adjusts the local time.
! clock timezone is a command within the configure terminal mode and requires read-write privilege.
! The no form of this command removes the local time setting.
Syntax clock timezone <timezone> <hour-offset> [<min-offset>]
no clock timezone
Definitions
Examples GX$root# configure terminal
GX$root(config)# clock timezone PST 8
Define PST as the timezone, and subtract 8 hours from UTC. The clock show command would then produce the following output:
Wed Feb 13 19:50:29 UTC 2002
Wed Feb 13 11:50:29 PST 2002
ntp-server ip address:
Related Commands clockclock ntp-serverclock showclock summer-timeshow clock
timezone The arbitrary name assigned to the time zone to which the time will be adjusted (for example, PST, PDT, Eastern, Central). This parameter must be alphabetic.
hour-offset Hour offset (-12 to 12) from coordinated universal time (UTC).
min-offset Minute offset (0 to 59) from coordinated universal time (UTC). The default value is 0.
Specified offsets are subtracted from UTC. For example, an hour offset of 8 subtracts 8 from than the Coordinated Universal Time. An hour offset of -5 adds 5 hours to the Coordinated Universal Time.
configure memory
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference112
configure memory
This command copies the startup-config file to the running-config file.
! configure memory is a top-level command and requires read-write privilege.
! This command does not have a no form.
! There are no default settings for this command.
Syntax configure memory
Examples GX$root# configure memory
Copies the startup-config file to the running-config file.
Related Commands copy
configure terminal
This command enters the configure terminal mode. You must first enter this mode to perform numerous configuration tasks. To exit the configure terminal mode, use the exit command.
! configure terminal is a top-level command and requires read-write privilege.
! This command does not have a no form.
! There are no default settings for this command.
Syntax configure terminal [<command>]
Definitions
Examples GX$root# configure terminal
GX$root(config)#
The CLI is now in the configure terminal mode.
GX$root# conf t
GX$root(config)#
This example illustrates the usage of an abbreviated form of the command.
GX$root# configure terminal clock show
Issues the clock show command, which is a command in the configure terminal mode.
Tue Dec 11 23:05:42 UTC 2001
Tue Dec 11 15:05:42 PST 2001
ntp-server ip address: 192.168.201.1
command Any valid command that can be entered within the configure terminal mode.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
copy
113
copy
This command copies a data file from a source location to a target location.
! copy is a top-level command and requires read-write privilege.
! This command does not have a no form.
! There are no default settings for this command.
Syntax copy <source-file> <dest-file>|<dest-dir>
Definitions
Examples GX$root# copy testa_040101.bin testb_040101.bin
The file testa_040101.bin is copied to file testb_040101.bin.
GX$root# copy running-config startup-config
The currently-executing configuration is saved to the startup-config file (which is stored in the home directory as Startup.cli).
Related Commands deletemkdirrenamermdirwrite memory
source-file The name of the source file to be copied. Can include the path to the file.
dest-file The name of the target file to be copied to. Can include the path to the file.
dest-dir The name of the target directory to be copied to.
cpe-controlled-cable-modem
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference114
cpe-controlled-cable-modem
This command instructs a CM to disable its upstream transmission, or to remotely reset its MAC and re-enable its upstream transmission. A CM is disabled or reset by issuing the UP-DIS MAC management message, so the CM must support this message for this command to have any effect.
! cpe-controlled-cable-modem is a top-level command and requires read-write privilege.
Syntax cpe-controlled-cable-modem <mac-address> disable {forever|<time-to-disable>}
cpe-controlled-cable-modem <mac-address> reset
Definitions
Examples GX$root# cpe-controlled-cable-modem 1234.5678.9ABC disable 300
Disables the CM at MAC address 1234.5678.9ABC for 300 milliseconds.
GX$root# cpe-controlled-cable-modem 1234.5678.9ABC reset
Resets the MAC of the CM at MAC address 1234.5678.9ABC and re-enables its upstream transmission.
Related Commands clear cable modem
mac-address The MAC address of the CM specified as xxxx.xxxx.xxxx in hexadecimal.
disable Specifies that the CM is to be disabled.
forever Immediately and permanently disables the upstream transmitter of the CM until it is re-enabled by a power cycle or by using the reset form of this command.
time-to-disable Immediately disables the upstream transmitter of the CM for a period of time-to-disable milliseconds (valid range is 1–4294967294). After this period has elapsed, the CM reinitializes its MAC.
reset Specifies that the CM is to be reset with its upstream transmission re-enabled.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug
115
debug
This command clears the list of all debug event types—such as arp, range, and ucd—that have been set by the debug commands, which effectively disables debugging. The list of MAC addresses, SIDs, and slot/interfaces to be debugged is not affected by this command. Therefore, if this command is followed by a debug command that defines an event type, that event type will be debugged. See the debug cable interface cable command for more details regarding the debug feature.
! debug is a top-level command and requires read-debug privilege.
! The only form of this command is the no form.
! This command behaves identically to the no debug cable command (this behavior can change in the future).
Syntax no debug
Examples GX$root# no debug
Clears the list of all debugging event types.
Related Commands debug cabledebug cable clear filterdebug cable interface cabledebug cable mac-addressshow debugging
debug cable
This command clears the list of cable debug event types—such as arp, range, and ucd—that have been set by the debug commands, which effectively disables debugging. The list of MAC addresses, SIDs, and slot/interfaces to be debugged is not affected by this command. Therefore, if this command is followed by a debug command that defines an event type, that event type will be debugged. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable is a top-level command and requires read-debug privilege.
! The only form of this command is the no form.
! This command behaves identically to the no debug command (this behavior can change in the future).
Syntax no debug cable
Examples GX$root# no debug cable
Clears the list of cable debug event types.
Related Commands debugdebug cable clear filterdebug cable interface cabledebug cable mac-addressshow debugging
debug cable arp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference116
debug cable arp
This command enables the display of debug messages associated with address resolution protocol (ARP) events. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable arp is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for ARP.
Syntax debug cable arp
no debug cable arp
Examples GX$root# debug cable arp
Enables debugging for ARP.
ETHERFRAME pktId = 0x00001FD6 frameLen = 60 EthernetII_(DIX)
dstMacAddr = FF:FF:FF:FF:FF:FF srcMacAddr = 00:03:E3:08:41:C9
etherType = 0x0806
ARP hardType = 0x01 protType = 0x800
hardSize = 0x06 protSize = 0x04
op = ARP_REP
sndMacAddr = 00:03:E3:08:41:C9 sndIpAddr = 10.136.2.27
tgtMacAddr = FF:FF:FF:FF:FF:FF tgtIpAddr = 10.136.2.27
crc = 0x18A6B9E3
Related Commands debug cable dhcpdebug cable interface cabledebug cable mac-addressterminal monitorterminal speed
debug cable bpkm
This command enables the display of debug messages associated with baseline privacy key management (BPKM) messages. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable bpkm is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for BPKM.
Syntax debug cable bpkm
no debug cable bpkm
Examples GX$root# debug cable bpkm
Enables debugging for BPKM.
Related Commands debug cable interface cabledebug cable mac-addressdebug cable mac-protocolterminal monitorterminal speed
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable bwr
117
debug cable bwr
This command enables the display of debug messages associated with request frame (REQ) messages. The Request Frame is the basic mechanism a CM uses to request bandwidth. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable bwr is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for Request Frames.
Syntax debug cable bwr
no debug cable bwr
Examples GX$root# debug cable bwr
Enables debugging for Request Frames.
Related Commands debug cable interface cabledebug cable mac-addressterminal monitorterminal speed
debug cable clear filter
This command clears the list of MAC addresses, SIDs, and slot/interfaces to be debugged (known as debug filters). The list of debug event types—such as arp, range, and ucd—that have been set by the debug commands is not affected by this command. Therefore, if this command is followed by a command that defines a new debug filter (such as a SID), that entity will be debugged. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable clear filter is a top-level command and requires read-debug privilege.
Syntax debug cable clear filter
Examples GX$root# debug cable clear filter
Clears the list of debugging filters.
Related Commands debugdebug cabledebug cable clear logdebug cable interface cabledebug cable mac-addressshow debugging
If no filters are defined, all enabled debug event types are monitored, regardless of their associated MAC addresses, SIDs, and slot/interfaces. This can result in a continuous display of debug messages. See the terminal speed command to reduce the debug message output speed.
debug cable clear log
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference118
debug cable clear log
This command clears the current buffer of debug messages. This can be useful if the buffer is filling up with debug messages faster than your terminal can display them, thereby preventing you from seeing later debug messages associated with more recent debug events. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable clear log is a top-level command and requires read-debug privilege.
Syntax debug cable clear log
Examples GX$root# debug cable clear log
Clears the current buffer of debug messages.
Related Commands debugdebug cabledebug cable clear filterdebug cable interface cabledebug cable mac-address
debug cable dcc
This command enables the display of debug messages associated with dynamic channel change (DCC) events. DCC is used by the CMTS to change the upstream and/or the downstream channels on which a CM resides.See the debug cable interface cable command for more details regarding the debug feature.
! debug cable dcc is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for messages related to DCC.
Syntax debug cable dcc
no debug cable dcc
Examples GX$root# debug cable dcc
Enables debugging for all messages related to DCC.
Related Commands debug cable interface cabledebug cable mac-addressdebug cable mac-protocolterminal monitorterminal speed
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable dci
119
debug cable dci
This command enables the display of debug messages associated with device class identification (DCI) events. A CM can use DCI to identify itself between ranging and establishing IP connectivity. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable dci is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for messages related to DCI.
Syntax debug cable dci
no debug cable dci
Examples GX$root# debug cable dci
Enables debugging for all messages related to DCI.
DCI_REQ macFrameLength = 46
fc = 0xC2 macParm = 0x00 len = 0x001E hcs = 0x8E07
da = 00:03:04:D0:02:74 sa = 00:07:E9:01:20:0C msgLen = 0x000C type = 0x1A
contrl = 0x03 version = 0x02
sid = 0x000F
Device Class = 0x00000001
crc = 0x00000000
-------------------------------------------------------------------------------
DCI_RSP macFrameLength = 47
fc = 0xC2 macParm = 0x00 len = 0x001F hcs = 0x0000
da = 00:07:E9:01:20:0C sa = 00:03:04:D0:02:74 msgLen = 0x000D type = 0x1B
contrl = 0x03 version = 0x02
sid = 0x000F
Device Class = 0x00000001
Confirmation Code = 0x00
crc = 0x00000000
-------------------------------------------------------------------------------
Related Commands debug cable interface cabledebug cable mac-addressdebug cable mac-protocoldebug cable rangedebug cable registrationterminal monitorterminal speed
debug cable dhcp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference120
debug cable dhcp
This command enables the display of debug messages associated with the dynamic host configuration protocol (DHCP) events. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable dhcp is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for DHCP.
Syntax debug cable dhcp
no debug cable dhcp
Examples GX$root# debug cable dhcp
Enables debugging for DHCP.
ETHERFRAME pktId = 0x00002623 frameLen = 618 EthernetII_(DIX)
dstMacAddr = 00:01:30:E7:C1:00 srcMacAddr = 00:03:E3:08:41:C9
etherType = 0x0800
IP ver = 4 hdrLen = 0x14 tos = 0x00 totLen = 0x025C
id = 0x8369 flags = 0 fragOfs = 0x0000 ttl = 0xFF
protocol = 0x11 hdrChkSum = 0xF527
srcIpAddr = 0.0.0.0 dstIpAddr = 192.168.128.87
UDP srcPort = 0x0044 dstPort = 0x0043
udpLen = 0x0248 udpChkSum = 0x0000
DHCP op = 0x01 htype = 0x01 hlen = 0x06
hops = 0x00 xid = 0x00001DE4 secs = 0x0000
flags = 0x8000
ciAddr = 0.0.0.0 yiAddr = 0.0.0.0
siAddr = 0.0.0.0 giAddr = 0.0.0.0
chAddr = 00:03:E3:08:41:C9
pad
pad
...
[More "pad" entries ...]
...
pad
pad
pad
magicCookie = 0x63825363
dhcpMessageType = DHCPDISCOVER
maxDhcpMessageSize = 0x0480
clientIdentifier = 0x01 0x00 0x03 0xE3 0x08 0x41 0xC9
paramReqeuestList = 0x01 0x02 0x04 0x42 0x80 0x03 0x07
0x43
vendorClassId = docsis1.0
optionOverload = file_and_sname_is_options
end
crc = 0xF96A0698
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable dhcp
121
ETHERFRAME pktId = 0x0000279F frameLen = 342 EthernetII_(DIX)
dstMacAddr = 00:03:04:A0:07:A0 srcMacAddr = 00:01:30:E7:C1:00
etherType = 0x0800
IP ver = 4 hdrLen = 0x14 tos = 0x00 totLen = 0x0148
id = 0x7A7B flags = 0 fragOfs = 0x0000 ttl = 0x7E
protocol = 0x11 hdrChkSum = 0x739F
srcIpAddr = 192.168.128.87 dstIpAddr = 10.136.2.3
UDP srcPort = 0x0043 dstPort = 0x0043
udpLen = 0x0134 udpChkSum = 0x43BB
DHCP op = 0x02 htype = 0x01 hlen = 0x06
hops = 0x00 xid = 0x00000A52 secs = 0x0000
flags = 0x8000
ciAddr = 0.0.0.0 yiAddr = 10.136.2.27
siAddr = 192.168.128.81 giAddr = 10.136.2.3
chAddr = 00:03:E3:08:41:C9
sname =
file = nikhil531.cfg
magicCookie = 0x63825363
dhcpMessageType = DHCPOFFER
serverIdentifier = 192.168.128.87
ipAddrLeaseTime = 0x0008A7B3
subNetMask = 255.255.255.0
timeOffset = 36000
timeServer = 192.168.128.81
router = 10.136.2.1
logServer = 192.168.128.81
end
crc = 0xACC7A682
Related Commands debug cable arpdebug cable interface cabledebug cable mac-addressterminal monitorterminal speed
debug cable dynsrv
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference122
debug cable dynsrv
This command enables the display of debug messages associated with dynamic service addition messages (creates a new service flow), dynamic service change messages (dynamically changes the parameters of an existing service flow), and dynamic service deletion messages (deletes an existing service flow). See the debug cable interface cable command for more details regarding the debug feature.
! debug cable dynsrv is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for messages related to Dynamic Service Flow.
Syntax debug cable dynsrv
no debug cable dynsrv
Examples GX$root# debug cable dynsrv
Enables debugging for all messages related to dynamic service flow.
DSA_REQ macFrameLength = 155
fc = 0xC2 macParm = 0x00 len = 0x008B hcs = 0xFFFF
da = 00:10:95:1D:19:B8 sa = 00:03:04:D0:00:B5 msgLen = 0x0079 type = 0x0F
contrl = 0x03 version = 0x02
Transaction Id = 0x8003
UpstreamClassificationEncoding (t=0x16,l=0x14) =
ClassifierId (t=0x02,l=0x02) = 0x0001
ServiceFlowId (t=0x04,l=0x04) = 0x0100015F
IpPacketClassificationEncoding (t=0x09,l=0x08) =
TcpUdpSourcePortStart (t=0x07,l=0x02) = 0x000A
TcpUdpSourcePortEnd (t=0x08,l=0x02) = 0x000A
DownstreamClassificationEncoding (t=0x17,l=0x14) =
ClassifierId (t=0x02,l=0x02) = 0x0001
ServiceFlowId (t=0x04,l=0x04) = 0x01000160
IpPacketClassificationEncoding (t=0x09,l=0x08) =
TcpUdpSourcePortStart (t=0x07,l=0x02) = 0x001E
TcpUdpSourcePortEnd (t=0x08,l=0x02) = 0x001E
UpstreamServiceFlowEncoding (t=0x18,l=0x2F) =
ServiceFlowId (t=0x02,l=0x04) = 0x0100015F
ServiceIdentifier (t=0x03,l=0x02) = 0x0011
QosSetType (t=0x06,l=0x01) = 0x06
SchedulingType (t=0x0F,l=0x01) = 0x06
RequestTransmissionPolicy (t=0x10,l=0x04) = 0x000001FF
UnsolicitedGrantSize (t=0x13,l=0x02) = 0x0064
NominalGrantInterval (t=0x14,l=0x04) = 0x00002710
ToleratedGrantJitter (t=0x15,l=0x04) = 0x000007D0
GrantsPerInterval (t=0x16,l=0x01) = 0x01
GrantTimeReference (t=0x18,l=0x04) = 0x0000B000
DownstreamServiceFlowEncoding (t=0x19,l=0x12) =
ServiceFlowId (t=0x02,l=0x04) = 0x01000160
QosSetType (t=0x06,l=0x01) = 0x06
TrafficPriority (t=0x07,l=0x01) = 0x07
MaxSustainedTrafficRate (t=0x08,l=0x04) = 0x003D0900
crc = 0xD11D0000
-------------------------------------------------------------------------------
DSA_RSP macFrameLength = 47
fc = 0x0C3 ehLen = 0x04 len = 0x001F
EH_REQ miniSlots = 0x00 sid = 0x0010
hcs = 0x97E0
da = 00:03:04:D0:00:B5 sa = 00:10:95:1D:19:B8 msgLen = 0x0009 type = 0x10
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable icmp
123
contrl = 0x03 version = 0x02
Transaction Id = 0x8003
Confirmation Code = 0x00
crc = 0x5F090000
-------------------------------------------------------------------------------
DSA_ACK macFrameLength = 43
fc = 0xC2 macParm = 0x00 len = 0x001B hcs = 0x0000
da = 00:10:95:1D:19:B8 sa = 00:03:04:D0:00:B5 msgLen = 0x0009 type = 0x11
contrl = 0x03 version = 0x02
Transaction Id = 0x8003
Confirmation Code = 0x00
crc = 0x2ABB0001
Related Commands debug cable interface cabledebug cable mac-addressdebug cable mac-protocolterminal monitorterminal speed
debug cable icmp
This command enables the display of debug messages associated with the internet control message protocol (ICMP) events. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable icmp is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for ICMP.
Syntax debug cable icmp
no debug cable icmp
Examples GX$root# debug cable icmp
Enables debugging for ICMP.
ETHERFRAME pktId = 0x00001B56 frameLen = 98 EthernetII_(DIX)
dstMacAddr = 00:02:00:01:29:B2 srcMacAddr = 00:01:30:E7:C1:00
etherType = 0x0800
IP ver = 4 hdrLen = 0x14 tos = 0x00 totLen = 0x0054
id = 0x0000 flags = 2 fragOfs = 0x0000 ttl = 0x3E
protocol = 0x01 hdrChkSum = 0xEDD6
srcIpAddr = 192.168.129.136 dstIpAddr = 10.136.2.26
ICMP type = 0x08 code = 0x00 chkSum = 0x0AE6
ECHO_REQUEST id = 0xFE62 seqNbr = 0x0300
crc = 0xD6EDFE53
Related Commands debug cable interface cabledebug cable mac-addressterminal monitorterminal speed
debug cable interface cable
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference124
debug cable interface cable
This command defines a list of MAC addresses, service IDs (SIDs), or slot/interfaces (MAC domains) that are to be monitored for debugging purposes. These are known as debug filters. The debug feature sends informational messages to a Telnet or console session whenever a debug event occurs. Debug event types are defined by other CLI debug commands for events such as ranging, registration, and the transmission of certain MAC messages (such as MAP and UCD messages).
! debug cable interface cable is a top-level command and requires read-debug privilege.
! The no form of this command removes the specified entity from the debug monitor list.
Debug messages are enabled by performing the following tasks:
1. Define a list of MAC addresses, SIDs, or slot/interfaces to monitor by using the debug cable interface cable command or the debug cable mac-address command.
2. Define the debug event types to be monitored by issuing the appropriate debug commands (such as debug cable range and debug cable registration).
3. Enable debug message output for the current Telnet or console session by issuing the terminal monitor command.
Syntax debug cable interface cable <slot/if> mac-address <mac-address> <mac-mask> [verbose]
Adds the specified MAC address to the list of entities to be monitored on the given slot/interface.
debug cable interface cable <slot/if> sid <sid> [verbose]
Adds the specified SID to the list of entities to be monitored on the given slot/interface.
debug cable interface cable <slot/if> [verbose]
All debug events on this interface are to be monitored.
no debug cable interface cable <slot/if> mac-address <mac-address>
no debug cable interface cable <slot/if> sid <sid>
no debug cable interface cable <slot/if>
Care should be taken when using the debug feature to ensure that the performance of the CMTS is not severely impacted. Restricting the number of CMs and debug events minimizes the resources required to support this feature.
If no debug filters are defined, all enabled debug event types are monitored, regardless of their associated MAC addresses, SIDs, and slot/interfaces. This can result in a continuous display of debug messages in which case you can enter no terminal monitor (blindly) to stop the display.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable interface cable
125
Definitions
Examples GX$root# debug cable interface cable 2/0 mac-address 1234.5678.ABCD
FFFF.FFFF.0000
All MAC addresses in the range of 1234.5678.0000 to 1234.5678.FFFF on slot 2 / interface 0 are monitored.
GX$root# debug cable interface cable 2/0 [verbose]
All debug events on slot 2 / interface 0 are monitored using the verbose mode.
Related Commands debugdebug cable mac-addressterminal monitorterminal speed
slot/if The slot number and interface number of the cable interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
mac-address The MAC address of the cable modem or CPE to be monitored specified as xxxx.xxxx.xxxx in hexadecimal. The MAC addresses shown in the debug message output are identified as da (destination address) and sa (source address). CPE debug messages are limited to relevant event types such as ARP, DHCP, and ICMP.
mac-mask The mask used against the mac-address specified as xxxx.xxxx.xxxx in hexadecimal. This allows a block of MAC addresses to be monitored.
sid Service identifier (SID) to be monitored (1–8191). SIDs can be viewed with the show cable modem command.
verbose Toggles between lengthy and brief messages.
debug cable mac-address
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference126
debug cable mac-address
This command defines a list of MAC addresses that are to be monitored for debugging purposes. The entry in the list created by this command applies globally to all slot/interfaces in the CMTS. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable mac-address is a top-level command and requires read-debug privilege.
! The no form of this command removes the specified MAC address from the debug monitor list.
Syntax debug cable mac-address <mac-address> <mac-mask> [verbose]
no debug cable mac-address <mac-address>
Definitions
Examples GX$root# debug cable mac-address 1234.5678.ABCD FFFF.FFFF.0000
All MAC addresses in the range of 1234.5678.0000 to 1234.5678.FFFF on all slot/interfaces are monitored.
Related Commands debugdebug cable clear filterdebug cable interface cableterminal monitorterminal speed
mac-address The MAC address of the cable modem or CPE to be monitored specified as xxxx.xxxx.xxxx in hexadecimal. The MAC addresses shown in the debug message output are identified as da (destination address) and sa (source address). CPE debug messages are limited to relevant event types such as ARP, DHCP, and ICMP.
mac-mask The mask used against the mac-address specified as xxxx.xxxx.xxxx in hexadecimal. This allows a block of MAC addresses to be monitored.
verbose Toggles between lengthy and brief messages.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable mac-protocol
127
debug cable mac-protocol
Issuing this command is equivalent to issuing all the following debug commands:
! debug cable bpkm
! debug cable dcc
! debug cable dci
! debug cable dynsrv
! debug cable range
! debug cable registration
! debug cable ucc
! debug cable updis
See the debug cable interface cable command for more details regarding the debug feature.
! debug cable mac-protocol is a top-level command and requires read-debug privilege.
! Issuing the no form of this command is equivalent to executing the no form of all the debug commands associated with the debug cable mac-protocol command.
Syntax debug cable mac-protocol
no debug cable mac-protocol
Examples GX$root# debug cable mac-protocol
Enables debugging for all events related to the aforementioned debug commands.
Related Commands debug cable bpkmdebug cable dccdebug cable dcidebug cable dynsrvdebug cable interface cabledebug cable mac-addressdebug cable rangedebug cable registrationdebug cable uccdebug cable updisterminal monitorterminal speed
debug cable map
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference128
debug cable map
This command enables the display of debug messages associated with upstream bandwidth allocation MAP messages. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable map is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for MAP messages.
Syntax debug cable map
no debug cable map
Examples GX$root# debug cable map sid 14
Enables debugging for all MAP messages containing SID 14.
MAP macFrameLength = 76
fc = 0xC2 macParm = 0x00 len = 0x003C hcs = 0x0000
da = 01:E0:2F:00:00:01 sa = 00:03:04:A0:07:A2 msgLen = 0x002A type = 0x03
usChannelId = 0x20 UcdCnt = 0x0A NumElem = 0x05
AllocStartTime = 0009178D AckTime = 0009173E
RngBackoffStart=0x01 RngBackoffEnd=0x05
DatBackoffStart=0x03 DatBackoffEnd=0x0A
ie = (sid = 0x3FFF iuc = Request (0x1) offset=0x0000)
ie = (sid = 0x3FFF iuc = Initial Maintenance (0x3) offset=0x0008)
ie = (sid = 0x0000 iuc = Undefined (0x0) offset=0x003E)
ie = (sid = 0x0000 iuc = Undefined (0x0) offset=0x0058)
ie = (sid = 0x0000 iuc = Null IE (0x7) offset=0x0072)
crc = 0x03FC0000
Related Commands debug cable interface cabledebug cable mac-addressterminal monitorterminal speed
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable range
129
debug cable range
This command enables the display of debug messages associated with initial and station maintenance ranging. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable range is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for messages related to ranging.
Syntax debug cable range
no debug cable range
Examples GX$root# debug cable range
Enables debugging for all messages related to ranging.
RNG_RSP macFrameLength = 59
fc = 0xC2 macParm = 0x00 len = 0x002B hcs = 0xE9B9
da = 00:02:00:01:29:B2 sa = 00:03:04:A0:07:A2 msgLen = 0x0019 type = 0x05
contrl = 0x03 version = 0x01
sid = 0x0002 usChannelId = 0x20
timingAdjust (t=0x01,l=0x04) = 0x00000000
txPowerAdjust (t=0x02,l=0x01) = 0x00
txFreqAdjust (t=0x03,l=0x02) = 0x0000
rangingStatus (t=0x05,l=0x01) = 0x03
crc = 0xCFC02DFF
RNG_REQ macFrameLength = 44
fc = 0xC0 macParm = 0x00 len = 0x001C hcs = 0xEA1D
da = 00:03:04:A0:07:A3 sa = 00:D0:59:FD:F2:92 msgLen = 0x000A type = 0x04
contrl = 0x03 version = 0x01
sid = 0x0004 dsChannelId = 0x21 pendingTillCompl = 0
crc = 0x01000302
Related Commands debug cable interface cabledebug cable mac-addressdebug cable mac-protocoldebug cable registrationterminal monitorterminal speed
debug cable registration
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference130
debug cable registration
This command enables the display of debug messages associated with CM registration. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable registration is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for messages related to registration.
Syntax debug cable registration
no debug cable registration
Examples GX$root# debug cable registration
Enables debugging for all messages related to registration.
REG_REQ macFrameLength = 118
fc = 0x0C3 ehLen = 0x04 len = 0x0066
EH_REQ miniSlots = 0x00 sid = 0x000B
hcs = 0x520A
da = 00:03:04:A0:07:A2 sa = 00:02:00:01:29:B2 msgLen = 0x0050 type = 0x06
contrl = 0x03 version = 0x01
sid = 0x000B
NetworkAccessControl (t=0x03,l=0x01) = 0x01
DownstreamFrequency (t=0x01,l=0x04) = 0x1FA66AC0
ClassOfServiceConfig (t=0x04,l=0x06) =
ClassId (t=0x01,l=0x01) = 0x01
PrivacyEnabled (t=0x07,l=0x01) = 0x00
MaxCpeQuantity (t=0x12,l=0x01) = 0x04
CmMic (t=0x06,l=0x10) = 0x0C 0x8D 0x51 0xC7 0xAF 0x39 0x37 0x5B 0xB9 0xAE 0x51
0xD3 0xC8 0x08 0x35 0x27
CmtsMic (t=0x07,l=0x10) = 0x53 0x51 0x7B 0x99 0x80 0x35 0x98 0xF0 0xCF 0x12 0x6E
0xB8 0x37 0x50 0x70 0x67
ModemCapabilities (t=0x05,l=0x03) =
ConcatenationSupport (t=0x01,l=0x01) = 0x00
VendorId (t=0x08,l=0x03) = 0x00 0x02 0x00
CmIpAddress (t=0x0C,l=0x04) = 0x0A88021A
crc = 0x1D1D0000
REG_RSP macFrameLength = 62
fc = 0xC2 macParm = 0x00 len = 0x002E hcs = 0xD8D2
da = 00:02:00:01:29:B2 sa = 00:03:04:A0:07:A2 msgLen = 0x001C type = 0x07
contrl = 0x03 version = 0x01
sid = 0x000B response = 0x00
serviceClassData (t=0x01,l=0x07) =
classId (t=0x01,l=0x01) = 0x01
sid (t=0x02,l=0x02) = 0x000C
modemCapabilities (t=0x05,l=0x03) =
ConcatenationSupport (t=0x01,l=0x01) = 0x00
vendorId (t=0x08,l=0x03) = 0x00 0x03 0x04
crc = 0x0C8D0022
Related Commands debug cable interface cabledebug cable mac-addressdebug cable mac-protocoldebug cable rangeterminal monitorterminal speed
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable ucc
131
debug cable ucc
This command enables the display of debug messages associated with upstream channel change (UCC) messages. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable ucc is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for Upstream Channel Change messages.
Syntax debug cable ucc
no debug cable ucc
Examples GX$root# debug cable ucc
Enables debugging for Upstream Channel Change messages.
Related Commands debug cable interface cabledebug cable mac-addressdebug cable mac-protocoldebug cable ucdterminal monitorterminal speed
debug cable ucd
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference132
debug cable ucd
This command enables the display of debug messages associated with upstream channel descriptor (UCD) messages. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable ucd is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for Upstream Channel Descriptor messages.
Syntax debug cable ucd
no debug cable ucd
Examples GX$root# debug cable ucd
Enables debugging for Upstream Channel Descriptor messages.
UCD macFrameLength = 417
fc = 0xC2 macParm = 0x00 len = 0x0191 hcs = 0x9E1A
da = 01:E0:2F:00:00:01 sa = 00:03:04:A0:07:A2 msgLen = 0x017F type = 0x02
usChannelId = 0x20 confChgCount = 0x0A
miniSlotSize = 0x08 dsChannelId = 0x20
symbolRate (t=0x01,l=0x01) = 0x08
frequency (t=0x02,l=0x04) = 0x006ACFC0
preamblePattern (t=0x03,l=0x80) = 0x0C 0x0F 0xF3 0xCC 0x0C 0x0F 0xF3 0x3F 0x33
0xFC 0xCF 0xC0 0xFF 0xCC 0xC0 0xC3 0xFC 0x03 0xFF 0xCF 0xC0 0xC3 0xC3 0x03 0xCF
0xC3 0xC3 0x03 0xFC 0x3F 0xC0 0xFF 0x0C 0x30 0x0F 0xFC 0x3C 0xC0 0xC0 0xC0 0x0F
0x0C 0x31 0x1D 0x11 0x1D 0xDD 0xD1 0xDD 0x1D 0x11 0x1D 0x11 0x1D 0xDD 0xD1 0xD1
0xDD 0xD1 0xD1 0xDD 0xDD 0x1D 0x1D 0xDD 0x11 0x1D 0xDD 0xDD 0x1D 0x1D 0x11 0x1D
0x11 0xDD 0xDD 0x11 0x11 0xDD 0xDD 0xDD 0x1D 0xDD 0x11 0x1D 0x11 0xDD 0x11 0xD1
0x11 0xDD 0x1D 0xDD 0x11 0xDD 0x11 0xD1 0x11 0xDD 0xDD 0x11 0xDD 0xDD 0x11 0x1D
0xDD 0xD1 0x1D 0x11 0xD1 0x11 0x1D 0xDD 0xDD 0x11 0xDD 0x1D 0x11 0x1D 0x11 0x1D
0x11 0x11 0x1D 0xD1 0x1D 0x11 0xD0
BurstDescriptor (t=0x04,l=0x25) =
modulationType (t=0x01,l=0x01) = 0x01
modulationType (t=0x01,l=0x02) = 0x0102
...
[Burst descriptor list ...]
...
guardTimeSize (t=0x09,l=0x01) = 0x08
lastFecCwLength (t=0x0A,l=0x01) = 0x02
isScramblerUsed (t=0x0B,l=0x01) = 0x01
crc = 0x00000000
Related Commands debug cable interface cabledebug cable mac-addressdebug cable uccterminal monitorterminal speed
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable updis
133
debug cable updis
This command enables the display of debug messages associated with upstream transmitter disable (UP-DIS) messages. See the debug cable interface cable command for more details regarding the debug feature.
! debug cable updis is a top-level command and requires read-debug privilege.
! The no form of this command disables debugging for Upstream Transmitter Disable messages.
Syntax debug cable updis
no debug cable updis
Examples GX$root# debug cable updis
Enables debugging for Upstream Transmitter Disable messages.
UP_DIS macFrameLength = 44
fc = 0xC2 macParm = 0x00 len = 0x001C hcs = 0xFFFF
da = 00:07:E9:01:20:0C sa = 00:03:04:D0:02:74 msgLen = 0x000A type = 0x1C
contrl = 0x03 version = 0x02
timeoutInterval = 0x00000000
crc = 0x01000000
Related Commands debug cable interface cabledebug cable mac-addressdebug cable uccterminal monitorterminal speed
debug log-to-console
This command enables the console display of events that have a priority of error, warning, notice, information, or debug. Events of priority emergency, alert, and critical are always displayed to the console (these are the three highest levels of priority).
! debug log-to-console is a top-level command and requires read-only privilege.
! The no form of this command disables the console display of error, warning, notice, information, and debug events.
Syntax debug log-to-console
no debug log-to-console
Examples GX$root# debug log-to-console
Enables the console display of error, warning, notice, information, and debug events.
Related Commands log-level generatelog-level show
delete
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference134
delete
This command deletes a file from the CMTS.
! delete is a top-level command and requires read-write privilege.
! The default is current directory if a path is not specified.
Syntax delete <file-name>
Definitions
Examples GX$root# delete /pbc/myfile
Deletes the file named myfile located in directory pbc.
Related Commands copyerase startup-configmkdirrenamermdir
file-name Name of the file to be deleted. Can include the path to the file.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
description
135
description
This command adds a description to a Fast Ethernet port, a Gigabit Ethernet port, or a cable interface. Compose any description to assist you in identifying the port. The descriptions are displayed when the show interfaces commands are issued.
! description is a command within the interface fastEthernet, the gigaEthernet, and the interface cable sub-modes and requires read-write privilege.
! The no form of this command removes the description.
! There are no default values for this command.
Syntax description <"string">
no description
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface fastEthernet 6/0
GX$root(config-if-f6/0)# description “First Ethernet Port”
Adds the description First Ethernet Port to Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS.
GX$root# configure terminalGX$root(config)# interface cable 2/1GX$root(config-if-c2/1)# description “Eighth RF Cable”
Adds the description Eighth RF Cable to the cable interface at slot 2 / interface 1.
Related Commands show interfaces
dhcp-giaddr
This command is used to configure a subscriber group under the subscriber group sub-mode. The basic underlying functionality of this command is the same as the cable dhcp-giaddr command. See the cable subscriber-group for more details regarding subscriber groups.
string User-defined text string up to 64 characters enclosed in quotes.
dir
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference136
dir
This command displays a list of files and sub-directories that are in the named directory of the CMTS. The command ls performs the same function.
! dir is a top-level command and requires read-only privilege.
! Default is the current directory if no other path is named.
Syntax dir [directory-name]
Definitions
Examples GX$root> dir /logs/userlogs
Displays the contents of the directory logs/userlogs in the CMTS. Typical response:
drwx 1024 Dec 12 09:34:16 2001 .
dr-x 1024 Dec 04 15:21:21 2001 ..
-rw- 83 Nov 30 01:27:55 2001 README
-rw- 16671 Nov 30 12:14:36 2001 test.cli
-rw- 17500 Dec 10 14:07:55 2001 Startup.back
Related Commands cdlsmkdirpwdrmdir
disable
This command returns the user’s privilege level to the level established prior to issuing the corresponding enable command. Read-write and read-debug privilege are denoted by # at the end of the prompt string. Read-only access is denoted by > at the end of the prompt string.
! disable is a top-level command and is available to all users.
! There is no default setting for this command.
Examples
GX$root# disable
GX$root>
The command prompt changes to indicate read-only privilege since this was the privilege level established prior to issuing the enable command.
Related Commands enable
directory-name Optional - Path and name of the directory to be displayed.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
duplex
137
duplex
This command sets an Ethernet port to either full or half duplex.
! duplex is a command within the interface fastEthernet sub-mode and requires read-write privilege.
! Default is full duplex.
Syntax duplex {full|half}
Definitions
Examples
GX$root# configure terminal
GX$root(config)# interface fastEthernet 6/0
GX$root(config-if-f6/0)# duplex full
Sets Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS to full duplex.
Related Commands auto-negotiationshowshutdownspeed
edit
This command opens the specified file in the current directory using the vi editor.
! edit is a top-level command and requires read-write privilege.
Syntax edit <filename>
Definitions
Examples GX$root# edit myfile
Opens the file myfile using the vi editor.
Related Commands cdcopydeletelsmore
full Set interface to full duplex mode allowing simultaneous two-way data flow.
half Set interface to half duplex mode invoking alternating transmit/receive data flows.
filename The name of the file to edit.
enable
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference138
enable
This command sets the user’s privilege level to the root level. You will be prompted for the root-level password.
! enable is a top-level command and is available to all users.
! There are no parameters with this command.
Syntax enable
Examples G10$newuser# enable
password: changeme
Sets the session for newuser to root level access privileges. This example assumes the initial root password of changeme is still valid.
Related Commands disable
erase startup-config
This command deletes the startup configuration file (Startup.cli). This command is identical to issuing delete /home/Startup.cli (the Startup.cli file is created by issuing the write memory or copy running-config startup-config commands). If the startup.cli file is deleted, the CMTS uses the default configuration on the next reboot.
! erase startup-config is a top-level command and requires read-write privilege.
Syntax erase startup-config
Examples GX$root# erase startup-config
Erases the Startup.cli file.
Related Commands copydeletewrite memory
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
exit
139
exit
This command takes you out of the current mode, or any of the sub-modes, to the next highest level. If the optional parameter all is specified, you will be taken to the top-level prompt. This command has no effect at the top-level prompt.
! exit can be entered at any command level and is available to all users.
Syntax exit [all]
Definitions
Examples GX$root(config-if-c2/1)# exit
GX$root#(config)# exit
GX$root#
Exiting from a configure interface sub-mode then from the configure terminal mode.
Related Commands Ctrl-Z (key command that exits to the top level)
all Unconditionally takes you to the top-level prompt regardless of the current mode or sub-mode.
ftp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference140
ftp
This command opens an FTP (File Transfer Protocol) session to the specified hostname or IP address. The current CLI directory is the target directory for any file transfers between the CMTS and the FTP host.
! ftp is a top-level command and requires read-write privilege.
Syntax ftp {<hostname>|<ip-address>}
Definitions
Examples GX$root# ftp 192.163.25.8
login: user1
password: mypassword
ftp> bin
ftp> get myfile
ftp> bye
Establish an ftp session with the host at IP address 192.163.25.8, login to the host, download the binary file myfile into the current CLI directory of the CMTS, then close the ftp session. Issuing the ls command shows that myfile has been downloaded, in this case, to the home directory.
GX$root# ls
drwx 1024 Apr 05 12:12:32 2002 .
drwx 1024 Apr 01 07:24:07 2002 ..
-rw- 99 Apr 15 14:32:44 2002 myfile
-rw- 83 Nov 30 01:27:22 2001 README
-rw- 10211 Apr 05 10:22:28 2002 Startup.cli
drwx 1024 Jan 08 22:24:37 2002 CVS
Related Commands telnettftp
hostname The hostname to which the ftp session is established.
ip-address The IP address of the host to which the ftp session is established. Standard dot-quad notation (xxx.xxx.xxx.xxx).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
help
141
help
This command displays a list of valid commands that can be issued within the current mode or sub-mode. Help— or equivalently a question mark—can be entered at any command level. The usage of the question mark, either as a standalone command or as described below, does not require a carriage return. Following is a list of the various help modes:
1. A list of valid commands displays when you type help, help help, or a question mark at the command prompt.
2. A list of valid parameters displays when you type a question mark after a command. If there are no additional parameters, or if all additional parameters are optional, a carriage return abbreviation <cr> will also be displayed.
3. If you type a question mark after one or more characters of a parameter, the valid parameters that contain those characters leading up to the question mark will be displayed.
4. Typing help followed by the edit-keys parameter displays the available editing keystrokes.
5. Typing help followed by the commands parameter displays a list of commands
! help (or ?) can be entered at any command level and is available to all users.
Syntax help [edit-keys|help]
?
<command> ?
<command> <abbreviated-parameter>?
Definitions
Examples GX$root# help
Displays a list of all valid commands in the current mode or sub-mode.
GX$root# show ?
Displays a list of parameters available for the show command. Notice that a carriage return is not needed.
edit-keys Displays a list of available editing keystrokes.
help Specifying help as a parameter to the help command displays a list of valid commands.
command Any valid command for the current mode, sub-mode, group, and privilege.
abbreviated-parameter One or more letters in a valid parameter for the command specified.
helper-address
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference142
GX$root# show us?
GX$root# show user
Displays a list of all parameters under the show command that begin with us. Notice in this example that the system has expanded the parameter to user immediately after entering ? to facilitate command entry since the two possible parameters are usernames and users.
helper-address
This command is used to configure a subscriber group under the subscriber group sub-mode. The basic underlying functionality of this command is the same as the cable helper-address command. See the cable subscriber-group for more details regarding subscriber groups.
history
This command is used to display a list of previously-issued commands, including the history command just issued. To issue any of the commands displayed, enter ! followed by the number of the command displayed.
! history can be entered at any command level and is available to all users.
! This command does not have a no form.
Syntax history
Examples GX$root# history
Issue configure terminal by entering !1.
1 configure terminal
2 interface fastEthernet 6/0
3 show
4 exit
5 interface cable 2/0
6 ip show
7 history
GX$root# !1
GX$root(config)#
Related Commands show history
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
hostname
143
hostname
This command sets a name for the host CMTS. The host name defines the prompt that appears on the screen.
! hostname is a command in the configure terminal mode and requires read-write privilege.
! The default hostname is G10.
! The no form of this command deletes any existing hostname.
Syntax hostname <"name">|show
no hostname
Definitions
Examples GX$root# configure terminalGX$root(config)# hostname "My CMTS"My CMTS$root#
Sets the CMTS hostname to My CMTS and defines a new prompt.
name A text string enclosed in quotation marks.
show Displays the current host name.
interface cable
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference144
interface cable
This command enters a sub-mode under the configure terminal mode where you configure a given cable interface. See Chapter 1, “Command Summary”, for a hierarchal display of modes, sub-modes and commands.
A cable interface is a logical configuration that encompasses upstream (US) and downstream (DS) ports in a specified DOCSIS Module slot. Each slot/interface corresponds to a DOCSIS MAC domain. See also Appendix B, “Configuration Notes”.
! interface cable is a sub-mode within the configure terminal mode and requires read-write privilege.
! The default is four cable interfaces defined for each slot. See Appendix B, “Configuration Notes”.
Syntax interface cable <slot/if>
Definitions
Examples GX$root# configure terminalGX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)#
This puts you in the interface cable sub-mode for slot 2 / interface 1. All subsequent commands in this sub-mode implicitly see this slot/interface.
Related Commands configure terminalshow interfaces cableshow running-configshow startup-config
slot Chassis slot number of the DOCSIS Module to be configured (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS). See “Interface, Port, and Channel Numbers” on page 220.
if An existing interface number that includes the US and DS ports to be configured. A maximum of four interfaces per slot are allowed. {0–3 for the G10 CMTS, or 0–1 for the G1 CMTS}
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
interface fastEthernet
145
interface fastEthernet
This command enters a sub-mode under the configure terminal mode where you configure the Fast Ethernet ports in the DOCSIS Module, the Chassis Control Module, and the NIC Module. Defined parameters for these ports are auto-negotiate, speed, and duplex.
! interface fastEthernet is a sub-mode within the configure terminal mode and requires read-write privilege.
! There are no defaults for this command.
Syntax interface fastEthernet <slot/if> [show]
Definitions
Examples GX$root# configure terminalGX$root(config)# interface fastEthernet 6/0
GX$root(config-if-f6/0)#
This puts you in the sub-mode to configure Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS.
Related Commands show interfaces fastEthernetshutdown
slot Chassis slot number:
DOCSIS Module: 1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS
Chassis Control Module: 6 and 7 for the G10 CMTS, or 1 for the G1 CMTS
NIC Module: 5 and 9 (G10 CMTS only)
if Port number of the Fast Ethernet ports to be configured:
DOCSIS Module: 0 and 1 (G10 CMTS), or 0 (G1 CMTS)
Chassis Control Module: 0
NIC Module: 0–11 (G10 CMTS only)
show Displays configuration information for the slot/if. The system remains in the configure terminal mode.
Fast Ethernet ports 0–11 on the G10 CMTS NIC Module correspond to the RJ-45 connectors labeled PORT 1–PORT 12 on the NIC Access Module cable plugged into connector 2 on the NIC Access Module.
interface gigaEthernet
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference146
interface gigaEthernet
This command enters a sub-mode under the configure terminal mode where you enable or disable the Gigabit ports on the NIC Module.
! interface gigaEthernet is a sub-mode within the configure terminal mode and requires read-write privilege.
! There are no defaults for this command.
Syntax interface gigaEthernet <slot/if> [show]
Definitions
Examples GX$root# configure terminalGX$root(config)# interface gigaEthernet 5/0
GX$root(config-if-g5/0)#
This puts you in the sub-mode to configure Gigabit port 0 of the NIC Module in slot 5.
Related Commands show interfaces gigaEthernetshutdown
This command is applicable only to the G10 CMTS.
slot Chassis slot number of the NIC Module: 5 or 9
if Gigabit port number of the NIC Module: 0 or 1
show Displays configuration information for the slot/if. The system remains in the configure terminal mode.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
ip address
147
ip address
This command sets the IP address for the Fast Ethernet interface of the Chassis Control Module, which serves as the IP address for the CMTS. The Chassis Control Modules are in slots 6 and 7 (G10 CMTS) or slot 0 (G1 CMTS) and always use interface 0. All IP packets transmitted by the CMTS will include the IP address as the source IP address.
! ip address is a command within the interface fastEthernet sub-mode and requires read-write privilege.
! The no form of the command removes the IP address.
Syntax ip address <ip-address> <mask>
no ip address <ip-address>
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface fastEthernet 6/0
GX$root(config-if-f6/0)# ip address 192.168.20.101 255.255.255.0
Assigns the IP address 192.168.20.101 with mask 255.255.255.0 to the G10 CMTS Chassis Control Module Fast Ethernet interface at slot 6 / interface 0.
Related Commands cable dhcp-giaddrip default-gatewayshow interfaces
ip-address The IP address to assign to the interface. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mask The subnet mask corresponding to the IP address. Standard dot-quad notation (xxx.xxx.xxx.xxx).
The ip address command is not used to assign IP addresses to cable interfaces.
ip default-gateway
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference148
ip default-gateway
This command is used to specify the IP address of the default router. The default router is used as the next-hop router for all Chassis Control Module management port traffic.
! ip default-gateway is a command within the configure terminal mode and requires read-write privilege.
! no ip default-gateway removes the default gateway setting.
Syntax ip default-gateway <ip-address> management
no ip default-gateway management
Definitions
Examples GX$root# configure terminalGX$root(config)# ip default-gateway 192.111.168.101 management
The default gateway for all Chassis Control Module management port traffic is set to 192.111.168.101.
Related Commands ip address
ip domain-name
This command sets a domain name for the CMTS. Any hostname specified without a dot-extension in a command is then assumed to belong to this domain.
! ip domain-name is a command within the configure terminal mode and requires read-write privilege.
! no ip domain-name removes the domain name setting.
Syntax ip domain-name <domain>
no ip domain-name
Definitions
Examples GX$root# configure terminal
GX$root(config)# ip domain-name mydomain.com
GX$root(config)# exit
GX$root# ping myCPE
The domain name mydomain.com is set for the CMTS. Then, the equipment named myCPE.mydomain.com is pinged.
Related Commands ip name-server
ip-address The IP address to assign as the default gateway. Standard dot-quad notation (xxx.xxx.xxx.xxx).
domain The domain name for the CMTS.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
ip ftp-enable
149
ip ftp-enable
This command enables FTP access to the CMTS from an external host. This command does not affect establishing FTP sessions from the CMTS to external hosts.
! ip ftp-enable is a command within the configure terminal mode and requires read-write privilege.
! no ip ftp-enable disables FTP access to the CMTS.
! By default, FTP access to the CMTS is enabled.
Syntax ip ftp-enable
no ip ftp-enable
Examples GX$root# configure terminal
GX$root(config)# no ip ftp-enable
Disables FTP access to the CMTS.
Related Commands ip telnet-enable
ip name-server
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference150
ip name-server
This command specifies the IP address of a domain name system (DNS) server. A DNS server is consulted to resolve host names and their related IP addresses. Use this command to store up to five distinct DNS server addresses. The CMTS will seek the servers in the order they are provided.
! ip name-server is a command within configure terminal mode and requires read-write privilege.
! no ip name-server removes all, or one, server(s) from the list.
Syntax ip name-server <ip-address>
no ip name-server [<ip-address>]
Definitions
Examples GX$root# configure terminal
GX$root(config)# ip name-server 192.16.90.1
GX$root(config)# ip name-server 192.16.90.2
Adds the DNS servers at addresses 192.16.90.1 and192.16.90.2. The CMTS will then consult these addresses, in that order, when resolving a host name.
GX$root(config)# no ip name-server
Removes all DNS server addresses.
GX$root(config)# no ip name-server 192.16.90.1
Removes the specified DNS server address.
Related Commands ip domain-name
ip show
This command displays the IP addresses that have been assigned at the current command level.
! ip show is a command in the configure terminal mode and requires read-write privilege.
! This is a display command that has no defaults and requires no parameters.
Examples GX$root# configure terminal
GX$root(config)# ip show
Default gateway (Management Interface): 192.168.201.1
ip-address The address of the DNS server in standard dot-quad notation (xxx.xxx.xxx.xxx). Five addresses can be specified by repeating this command.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
ip telnet-enable
151
ip telnet-enable
This command enables Telnet access to the CMTS.
! ip telnet-enable is a command within the configure terminal mode and requires read-write privilege.
! no ip telnet-enable disables Telnet access to the CMTS.
! By default, Telnet access to the CMTS is enabled.
Syntax ip telnet-enable
no ip telnet-enable
Examples GX$root# configure terminal
GX$root(config)# no ip telnet-enable
Disables Telnet access to the CMTS.
Related Commands ip ftp-enable
kill
This command terminates the specified Telnet session.
! kill is a top-level command and requires read-write privilege.
Syntax kill <session-id>
Definitions
Examples GX$root# show users
SessionId Login Connection
0 root 192.168.201.137
1 u1 192.168.200.12
GX$root# kill 1
Terminates the Telnet session with ID 1 (user u1).
Related Commands session timeoutshow userswho
If Telnet access to the CMTS is disabled by the no ip telnet-enable command, the only way to re-establish Telnet access is through a console session established through the serial port of the Chassis Control Module.
session-id The ID of the Telnet session to be terminated. Valid range is 0–9. Issuing the show users command displays the associated session IDs.
log-level generate
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference152
log-level generate
This command provides access to the docsDevEvControlTable within the DOCSIS Cable Device MIB (RFC-2669). This table controls how events of various priority levels are logged and reported.
The CMTS maps events, such as a registration authentication failure, to one of eight priority levels. These priorities correspond to the level-name parameter of this command, and to the priorities defined in the docsDevEvPriority object of RFC-2669. When an event occurs, the logging and reporting actions taken are determined by the parameters specified after the generate keyword of this command, and correspond to the bits defined in the docsDevEvReporting object of RFC-2669. See RFC-2669 and the DOCSIS OSSI specifications for more details. The G10 CMTS and G1 CMTS Installation and Operation manuals provide a list of Juniper Networks-specific log events.
! log-level generate is a command in the configure terminal mode and requires read-write privilege.
! no log-level generate resets the specified bits in the docsDevEvReporting object for the specified priority level, in which case the specified logging and reporting actions are not taken.
! The local log corresponds to the docsDevEventTable of RFC-2669.
! For each priority level, four different actions, or combinations thereof, can be specified (in the order shown after the generate keyword). Three combinations are not allowed:
! syslog
! trap
! syslog, trap
! This command is cumulative in that it will only enable or disable those actions specified, and will not affect unspecified actions.
! Table 7 provides the default assignment of event priorities to logging and reporting actions.
Table 7: Default Event Priority Logging and Reporting Assignment
Event Priority Logging and Reporting Action
Emergency local-log
Alert local-log
Critical local-log, syslog, trap
Error local-volatile-log, syslog, trap
Warning local-volatile-log
Notice local-volatile-log
Informational —
Debug —
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
log-level generate
153
Syntax log-level <level-name> generate [local-log] [local-volatile-log] [syslog] [trap]
no log-level <level-name> generate [local-log] [local-volatile-log] [syslog] [trap]
Definitions
Examples GX$root# configure terminal
GX$root(config)# log-level alert generate local-log local-volatile syslog trap
Events occurring with an alert priority will be logged in the local non-volatile log and the local volatile log, will cause a syslog message to be sent, and will cause a trap to be generated.
GX$root(config)# log-level information generate local-log
Events occurring with an information priority will be logged in the local non-volatile log.
Related Commands log-level showshow local-log
level-name One of eight event priorities: emergency, alert, critical, error, warning, notice, information, debug. These are presented from most critical to least.
local-log Specifies that the event will be written to the local non-volatile log on the CMTS (corresponds to localNonVolatile(0) in docsDevEvReporting).
local-volatile-log Specifies that the event will be written to the local volatile log on the CMTS (corresponds to localVolatile(3) in docsDevEvReporting).
syslog Specifies that the event will cause a syslog message to be sent (corresponds to syslog(2) in docsDevEvReporting).
trap Specifies that the event will cause a trap to be generated (corresponds to traps(1) in docsDevEvReporting).
log-level show
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference154
log-level show
This command displays the logging and reporting actions defined for each of the event priority levels set by the log-level generate command, or by SNMP. These priority levels correspond to the priorities in the docsDevEvPriority object within the DOCSIS Cable Device MIB (RFC-2669). See RFC-2669 for more details.
! log-level show is a command in the configure terminal mode and requires read-write privilege.
Syntax log-level show
Examples GX$root# configure terminal
GX$root(config)# log-level show
Displays the logging and reporting actions for each of the event priority levels in the docsDevEvPriority object.
evPriority evReporting
------------ -------------
emergency local-log
alert local-log, local-volatile-log
critical local-log, local-volatile-log, syslog, trap
error local-volatile-log, syslog, trap
warning local-volatile-log, syslog, trap
notice local-volatile-log, syslog, trap
information local-volatile-log
debug local-volatile-log
Related Commands log-level generateshow local-log
logout
This command ends the Telnet session when entered within any mode or sub-mode.
! logout can be entered at any command level and is available to all users.
! There are no parameters with this command.
Examples G10$user1> logout
Logout from the non-privileged top-level prompt.
G10$user1# logout
Logout from the privileged top-level prompt.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
ls
155
ls
This command displays a list of files and sub-directories that are in the named directory of the CMTS. The command dir performs the same function.
! ls is a top-level command and requires read-only privilege.
! Default is the current directory if no other path is named.
Syntax ls [directory-name]
Definitions
Examples GX$root> ls /home
Displays the contents of the directory home in the CMTS. Typical response:
drwx 1024 Dec 12 09:34:16 2001 .
dr-x 1024 Dec 04 15:21:21 2001 ..
-rw- 83 Nov 30 01:27:55 2001 README
-rw- 16671 Nov 30 12:14:36 2001 test.cli
-rw- 17500 Dec 10 14:07:55 2001 Startup.cli
Related Commands cddirmkdirpwdrmdir
directory-name Optional - Path and name of the directory to be displayed.
mkdir
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference156
mkdir
This command creates the specified directory. The parent directory of the created directory must already exist.
! mkdir is a top-level command and requires read-write privilege.
! There are no default settings for this command.
Syntax mkdir <dir-name>
Definitions
Examples GX$root# cd /samples/data
GX$root# mkdir logs
GX$root# cd /logs
Creates a new directory named logs in the path sample/data.
Related Commands cddirlspwdrmdir
more
This command causes the contents of a file to display one screen at a time. After a screen has been displayed, pressing Enter will advance the display one line, and pressing the space bar will advance the display one screen. Pressing q or Q will quit this command.
! more is a top-level command and requires read-only privilege.
Syntax more <file-name>
Definitions
Examples GX$root> cd /samples/data
GX$root> more sample.txt
Displays one screen of the data in the file named sample.txt in the directory samples/data.
Related Commands catcddir
dir-name Name of the directory being created.
file-name Name of the file to be displayed. Can include the path to the file.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
ping
157
ping
This command verifies a network connection between the CMTS and the target device.
The ping and ping ip commands send ICMP echo requests to the specified target and display a response if the target is reached, or it times out if the target is not reached.
The ping cable-modem command instructs the CMTS to schedule a station maintenance opportunity in a MAP message to the specified CM. If the CM uses this opportunity to transmit a RNG-REQ message, and the CMTS receives it within 5 seconds (the timeout period), the ping cable-modem command is considered successful. Otherwise, it is considered a failure.
! ping is a top-level command and is available to all users.
Syntax ping {<ip-address>|<hostname>}
ping [ip] <ip-address>
ping cable-modem {<ip-address>|<mac-address>}
Definitions
Examples GX$root# ping 10.1.1.35
Verifies the connection between the CMTS and the device at IP address 10.1.1.35 using ICMP.
PING 10.1.1.35 (10.1.1.35) from 192.168.21.49 : 56(84) bytes of data.
--- 10.1.1.35 ping statistics ---
5 packets transmitted, 5 packets received, 0% packet loss
round-trip min/avg/max/mdev = 8.630/10.937/14.091/1.900 ms
GX$root# ping cable-modem 1234.5678.9ABC
Verifies the connection between the CMTS and the CM at MAC address 1234.5678.9ABC using the DOCSIS MAP message.
Received RNG-REQ from the modem
Timing OffSet (1/64 Tick): 0
Power OffSet (1/4 DB) : 2
Freq OffSet (Hz) : -5
ip-address IP address of the device being pinged. Standard dot-quad notation (xxx.xxx.xxx.xxx).
hostname Hostname of the device being pinged.
ip This parameter is optional and is supported for industry-standard compatibility.
cable-modem The ping is directed to the IP address or MAC address on the cable interface.
mac-address The MAC address of the cable modem specified as xxxx.xxxx.xxxx in hexadecimal.
pwd
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference158
pwd
This command displays the current directory.
! pwd is a top-level command and requires read-only privilege.
! There are no parameters with this command.
Syntax pwd
Examples GX$root# pwd
/home
Related Commands cddirlsmkdirrmdir
relay-agent-option
This command is used to configure a subscriber group under the subscriber group sub-mode. The basic underlying functionality of this command is the same as the cable relay-agent-option command. See the cable subscriber-group for more details regarding subscriber groups.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
reload
159
reload
This command causes the CMTS to initiate a restart (reboot). Optional parameters allow a user to restart the system at a specific time of day, or after a given duration of time has elapsed.
! reload is a top-level command and requires read-write privilege.
! Issuing reload without any optional parameters unconditionally restarts the CMTS.
Syntax reload [show|cancel]
reload at <time>
Restarts the CMTS at a specific time of day.
reload in <minutes>
Restarts the CMTS after the given duration of time has elapsed.
Definitions
Examples GX$root# reload
Restart the CMTS unconditionally.
GX$root# reload at 23:30
Restart the CMTS at the next occurrence of 11:30 pm.
Related Commands reset-slot
This action will disrupt service to all subscribers supported by the CMTS.
show Shows if a reload command is pending.
cancel Cancels a pending reload command.
time Hours and minutes in 24-hour format (hh:mm).
minutes Integer number of minutes. Valid range is 0–65535.
rename
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference160
rename
This command renames a file in the CMTS. The parent directory
! rename is a top-level command and requires read-write privilege.
Syntax rename <source-filename> <dest-filename>
Definitions
Examples GX$root# rename log.txt log_8-17.txt
The file log.txt is renamed to log_8-17.txt in the same directory.
GX$root# rename log.txt home/usr/log_8-17.txt
The file log.txt is renamed to log_8-17.txt and moved to the home/usr directory.
Related Commands cdcopydir
source-filename The current file name. Can include the path to the file.
dest-filename The new file name to which the current file name will be changed. Can include the path to the file. The parent directory of the new file must already exist.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
reset-slot
161
reset-slot
This command causes the DOCSIS Module in the specified slot to be restarted (rebooted)
! reset-slot is a top-level command and requires read-write privilege.
Syntax reset-slot <slot>
Definitions
Examples GX$root# reset-slot 2
Restart the DOCSIS Module in slot 2 unconditionally.
Related Commands cable authorizereload
rmdir
This command removes an existing directory in the CMTS. If the current directory no longer exists as a result of this command, the current directory will be reset to /home.
! rmdir is a top-level command and requires read-write privilege.
Syntax rmdir <directory-name>
Definitions
Examples GX$root# cd home/usr
GX$root# rmdir temp
Removes the directory named temp in the home/usr path.
Related Commands cddirlsmkdirpwd
This action will disrupt service to the subscribers on the specified DOCSIS Module.
slot The CMTS slot number in which the DOCSIS Module resides.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS)
directory-name The name of the directory to be removed.
session timeout
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference162
session timeout
This command sets the timeout duration for all Telnet sessions into the CMTS, and optionally, the timeout duration for the console session. A timeout is defined as a period of time in which no CLI commands have been entered.
! session timeout is a command within the configure terminal mode and requires read-write privilege.
! The default timeout period is 300 seconds (5 minutes).
! Setting the timeout to 0 disables timeouts.
! This command affects the current session, as well as any sessions started afterwards. Previously-running sessions are not affected.
Syntax session timeout <seconds> [console]
Definitions
Examples GX$root# configure terminal
GX$root(config)# session timeout 600 console
Sets the timeout period for Telnet and console sessions to 600 seconds (10 minutes).
Related Commands kill
seconds The duration of the timeout in seconds. Valid range is 0–36000.
console Specifies that the timeout duration also applies to the console session.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable address-verification
163
show cable address-verification
This command displays specified entries of the address verification table. If no optional parameters are specified, the entire address verification table is displayed.
The Timeout value displayed indicates the DHCP lease timeout for dynamic entries (in seconds). This value cannot be set from within the CLI. A timeout of -1 indicates the entry is static.
! show cable address-verification is a top-level command and is available to all users.
Syntax show cable address-verification [<ip-address>|<mac-address>|<slot/if>]
Definitions
Examples GX$root> show cable address-verification 10.131.2.100
Display the address verification table entry that has an IP address of 10.131.2.100.
IP Address MAC Address Timeout
10.131.2.100 00D0.59FD.F53D 596558
GX$root> show cable address-verification
Display the entire address verification table.
Related Commands cable arp-verifycable address-verificationcable drop-unverifiable-addressescable source-verify
ip-address The IP address of the address verification table entry. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the address verification table entry. Specified as xxxx.xxxx.xxxx in hexadecimal. Multiple entries can be displayed for a MAC address.
slot/if The slot number and interface number of the cable interface. Multiple entries can be displayed for a slot/interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
show cable flap-list
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference164
show cable flap-list
This command displays the flap-list sorted by the specified criteria. See the cable modem flap-list command for details regarding the flap-list.
! show cable flap-list is a top-level command and is available to all users.
Syntax show cable flap-list {by-total-flaps|by-time|by-snr-flaps|by-cer-flaps|by-mer-flaps |by-im-flaps|by-sm-flaps|by-power-adjust|by-interface [<slot> [<if>]] |by-upstream [<slot> [<channel>]] | by-mac [<mac-address>]}
Definitions
Examples GX$root# show cable flap-list by-total-flaps
Display the entire flap-list sorted by the total number of flaps (under the column labeled Total).
MacAddr CableIF IM SM PAdj SNR MER CER LTime
LEvnt Total SNRavg MERavg CERavg
0002.0001.2C28 C02/0 U00/0 0 0 72 0 0 0 May 06 15:
18:21 PADJ FLAP 72 34 27 0
0000.CA25.1C4A C02/0 U00/0 0 0 59 0 0 0 May 06 15:
10:42 PADJ FLAP 59 34 28 0
0020.40A7.278C C02/0 U00/0 45 0 3 0 1 0 May 06 15:
by-total-flaps Sorts the flap-list in descending order of the Total column.
by-time Sorts the flap-list from most recent (top) to least recent (bottom) i.n the LTime column.
by-snr-flaps Sorts the flap-list in descending order of the SNR column.
by-cer-flaps Sorts the flap-list in descending order of the CER column.
by-mer-flaps Sorts the flap-list in descending order of the MER column.
by-im-flaps Sorts the flap-list in descending order of the IM column.
by-sm-flaps Sorts the flap-list in descending order of the SM column.
by-power-adjust Sorts the flap-list in descending order of the PAdj column.
by-interface If the slot and if parameters are not specified, the flap-list is sorted in ascending order of slot, interface, and port in the CableIF column. See slot and if to see their effect on the sorting.
slot If specified, only the flap-list entries associated with CMs on the DOCSIS Module slot are displayed.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS)
if If specified, only the flap-list entries associated with CMs on the slot and if are displayed.
Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
by-upstream If the slot and channel parameters are not specified, the flap-list is sorted in ascending order of slot, channel, and port in the CableIF column. See slot and channel to see their effect on the sorting.
channel If specified, only the flap-list entries associated with CMs on the slot and channel are displayed.
The upstream channel (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS)
by-mac If specified, only the flap-list entries associated with the CM that has a MAC address of mac-address are displayed.
mac-address MAC address of CM specified as xxxx.xxxx.xxxx in hexadecimal.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable flap-list
165
23:12 IM FLAP 49 34 12 72
00E0.6F03.1061 C02/0 U00/0 0 0 48 0 0 0 May 06 15:
21:40 PADJ FLAP 48 34 27 0
0050.DAA7.6E12 C02/0 U00/0 1 0 41 0 0 0 May 06 15:
20:11 PADJ FLAP 42 34 27 0
0030.D002.1B6F C02/0 U00/0 0 0 35 0 0 0 May 06 15:
19:57 PADJ FLAP 35 34 28 0
0020.407E.F330 C02/0 U00/0 0 0 16 0 0 0 May 06 15:
25:15 PADJ FLAP 16 34 28 0
Total checked entries 7
Table 8 explains each statistic provided in the flap-list. All thresholds cited in Table 8 are parameters within the cable modem flap-list and cable upstream modem flap-list CLI commands.
Table 8: Flap-list Statistics
Related Commands cable modem flap-listcable upstream modem flap-listclear cable modem flap-list
Statistic Description
MacAddr The MAC address of the CM that flapped.
CableIF The slot/interface and upstream channel/port on which the flapping CM resides, in the form: Cslot/interface Uchannel/port
IM This counter is incremented when the time between two successive initial maintenance attempts (ranging) by the CM is below the threshold im-retry-interval.
SM This counter is incremented when the number of consecutively missed station maintenance opportunities (ranging) by the CM is above the threshold sm-miss-threshold, and the CMTS subsequently receives a successful ranging request from the CM (this latter condition is required to discern whether the CM is missing station maintenance opportunities or is off-line).
PAdj This counter is incremented when the power adjustment sent to the CM during station maintenance is above the threshold power-adjust-threshold.
SNR This counter is incremented when the measured Signal-to-Noise Ratio (SNR) of the CM drops below threshold snr-threshold.
MER This counter is incremented when the measured Modulation Error Rate (MER) of the CM drops below threshold mer-threshold.
CER This counter is incremented when the measured Codeword Error Rate (CER) of the CM rises above cer-threshold.
LTime The timestamp that indicates when the CM flapped.
LEvnt A description of the type of flap that occurred.
Total This counter represents the total number of flaps that have occurred for the CM.
SNRavg The average SNR for the CM.
MERavg The average MER for the CM.
CERavg The average CER for the CM.
show cable modem
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference166
show cable modem
This command optionally displays the number of CMs that exist in various operational states, or displays individual modem information. The command can apply to all CMs, to those CMs in a slot/interface or an upstream channel, or to individual CMs specified by their IP or MAC address.
! show cable modem is a top-level command and is available to all users.
Syntax show cable modem [summary [total]]
Displays all CMs supported by the CMTS.
show cable modem <slot/if> [upstream <channel>] [summary [total]]
Displays all CMs in the given slot/interface, or optionally, only those CMs in the specified upstream channel in the given slot/interface.
show cable modem <ip-address>|<mac-address>
Displays the CM registered with the given address.
Definitions
Examples GX$root> show cable modem 2/1 upstream 2
Display individual information for each CM in upstream channel 2 in slot 2 / interface 1. See Table 9 for a description of the parameters displayed.
Intrfc Prim Online Timing Rec QoS IP-Address MAC-Address Ver Vpn
Sid State Offset Power Id
C2/1/U2 156 online 2481 -2.5 - 192.168.27.101 0010.951D.19B8 1.1
GX$root> show cable modem 192.168.27.110
Display individual information for the CM with an IP address of 192.168.27.110.
Intrfc Prim Online Timing Rec QoS IP-Address MAC-Address Ver Vpn
Sid State Offset Power Id
C2/0/U0 233 online 2294 -3.1 3 192.168.27.110 0001.0327.DCAA 1.0
summary A summary of the number of CMs that exist in various operational states is displayed.
total A row is displayed that provides the total number of CMs as displayed by the summary option.
slot/if The CMTS slot and interface number, which will display all the cable modems in that interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
upstream Only information associated with CMs on the specified upstream channel is displayed.
channel The upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
ip-address The IP address of the cable modem to be displayed. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem to be displayed specified as xxxx.xxxx.xxxx in hexadecimal.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem
167
GX$root> show cable modem summary total
Display the counts and totals for various operational states of all CMs supported by the G10 CMTS. See Table 11 on page 169 for a description of the operational states displayed.
Cable Modem Operational States
Interface US Dstry Dclr Rng Rng Rng IP Reg Access
Total Abort Compl Compl Denied
Cable2/0/U0 230 10 30 10 5 20 10 100 50
Cable2/0/U1 230 10 30 10 5 20 10 100 50
Cable2/0/U2 230 10 30 10 5 20 10 100 50
Cable2/0/U3 230 10 30 10 5 20 10 100 50
Cable3/0/U0 230 10 30 10 5 20 10 100 50
Cable3/0/U1 230 10 30 10 5 20 10 100 50
Cable3/0/U2 230 10 30 10 5 20 10 100 50
Cable3/0/U3 230 10 30 10 5 20 10 100 50
Totals 1840 80 240 80 40 160 80 800 400
GX$root> show cable modem 2/0 upstream 0 summary
Display the counts for various operational states of all CMs in upstream channel 0 in slot 2 / interface 0.
Cable Modem Operational States
Interface CM Dstry Dclr Rng Rng Rng IP Reg Access
Qty Abort Compl Compl Denied
C2/0/U0 9 0 0 0 0 0 0 9 0
show cable modem
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference168
Table 9: Parameters Displayed by ‘show cable modem’
Table 10: Description of Online States
Parameter Description
Interface The interface specified as Cslot/if/Uchannel.
Prim SID The primary service ID (SID) of the CM.
Online State The state of the CM. See Table 10 for a list of these states, then see Table 11 for the correspondence to the CM operational states that can be displayed with the summary option of the show cable modem command.
Timing Offset The timing adjustment provided by the CMTS in a ranging response. Units are (6.25µs/64).
Rec Power The receive power (dBmV) of the CM as detected by the CMTS.
QoS The quality of service (QoS) profile ID.
IP address The IP address of the CM.
MAC address The MAC address of the CM.
Ver The DOCSIS version of the CM.
Vpn ID The VPN ID to which this CM belongs (if applicable).
State Description
init(r1) The CM has entered the declared state (see Dclr in Table 11).
init(r2) The CM has entered the ranging state (see Rng in Table 11).
init(rc) The CM has entered the ranging-complete state (see Rng Compl in Table 11).
init(i) The CM has entered the IP-complete state (see IP Compl in Table 11).
online The CM has entered the registration-complete state (see Reg in Table 11).
offline The CM has entered the destroyed or ranging-aborted state (see Dstry or Rng Abort, respectively, in Table 11).
reject The CM has entered the access-denied state (see Access Denied in Table 11).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem
169
Table 11: Description of CM Operational States
Related Commands show cable modem connectivityshow cable modem cpeshow cable modem offlineshow cable modem physhow cable modem registeredshow cable modem unregisteredshow cable qos profile
Operational State Description
Dstry Number of CMs in destroyed operational state. If a CM goes offline for more than 24 hours, it will be removed from the CMTS. A CM is briefly in this state during the removal process.
Dclr Number of CMs in declared operational state. A CM is in this state right after the CMTS receives the CM’s initial ranging request.
Rng Number of CMs in ranging operational state. A CM is in this state during its initial ranging.
Rng Abort Number of CMs in ranging-aborted operational state. A CM is in this state right after the CMTS aborts the ranging (initial or periodic) in its ranging response.
Rng Compl Number of CMs in ranging-complete operational state. A CM is in this state after it has completed its initial ranging.
IP Compl Number of CMs in IP-complete operational state. A CM is in this state right after the CMTS receives a registration request from the CM containing an IP address (TLV Type 12 or 20). The CM can transition from this state only from the ranging-completed state.
Reg Number of CMs in registration-complete operational state. A CM is in this state right after the CMTS sends an Okay registration response (DOCSIS 1.0) or receives an error-free registration acknowledgment (DOCSIS 1.1) from the CM.
Access Denied Number of CMs in access-denied operational state. A CM is in this state after one of several conditions occurs:
– A CM timed out before responding to an upstream channel change request
– The CMTS responds to a DCI-REQ message with a DCI-RSP message containing a confirmation code set to reject-permanent
– The CM’s registration process failed
show cable modem connectivity
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference170
show cable modem connectivity
This command displays CM connectivity information, such as the length of time a CM has been registered or unregistered. A CM is considered unregistered if it is in one of the following operational states—destroyed, declared, ranging, ranging-aborted, ranging-complete, IP-complete, or access-denied (see Table 11 on page 169 for definitions of these states).
The command can be used to display information pertaining to all CMs, to those CMs in a slot/interface or an upstream channel, or to individual CMs specified by their IP or MAC address.
! show cable modem connectivity is a top-level command and is available to all users.
Syntax show cable modem [<ip-address>|<mac-address>] connectivity
Displays information for all CMs supported by the CMTS, or optionally, the specified CM.
show cable modem <slot/if> [upstream <channel>] connectivity
Displays information for all CMs in the given slot/interface, or optionally, only those CMs in the specified upstream channel in the given slot/interface.
Definitions
Examples GX$root> show cable modem connectivity
Displays information for all CMs supported by the CMTS.
CM 1st-Join #Times %Time Reg Time Unreg Time
MAC Address Time Reg Reg Min Avg Max Min Avg Max
0000.F00A.D084 15:18:58 2 93.6 13:54 10:16 13:54 00:11 00:42 01:13
0010.9517.91B2 15:19:06 1 98.8 21:32 21:32 21:32 00:16 00:16 00:16
0010.9517.92EC 15:19:04 1 98.7 21:33 21:33 21:33 00:17 00:17 00:17
0010.9518.F212 15:19:06 1 98.7 21:31 21:31 21:31 00:17 00:17 00:17
0010.951A.0424 15:19:06 1 98.8 21:32 21:32 21:32 00:16 00:16 00:16
0010.951A.044F 15:19:05 1 98.8 21:33 21:33 21:33 00:16 00:16 00:16
0090.833E.BA18 15:19:03 1 98.2 21:28 21:28 21:28 00:23 00:23 00:23
0090.961E.0470 15:19:18 1 99.6 21:31 21:31 21:31 00:05 00:05 00:05
0090.961E.0472 15:19:04 1 98.6 21:32 21:32 21:32 00:18 00:18 00:18
slot/if The CMTS slot and interface number, which will display all the cable modems in that interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
upstream Only information associated with CMs on the specified upstream channel is displayed.
channel The upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
ip-address The IP address of the cable modem to be displayed. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem to be displayed specified as xxxx.xxxx.xxxx in hexadecimal.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem connectivity
171
Table 12: Parameters Displayed by ‘show cable modem connectivity’
Related Commands show cable modemshow cable modem cpeshow cable modem offlineshow cable modem physhow cable modem registeredshow cable modem unregistered
Parameter Description
CM MAC Address The MAC adddress of the CM.
1st-Join Time Date or time when the CMTS received the initial ranging request from the CM. If the CM joined the network on the same day this command is issued, the time is shown in hh:mm:ss format. Otherwise, the date is shown (for example, Jul-22-02).
#Times Reg The number of times a CM has successfully registered with the CMTS.
%Time Reg The percentage of time the CM has been in the registered state.
Reg Time The registration time is measured as a window of time that begins when the CM is registered, and ends: 1) when the CM is unregistered, or 2) at the time the show cable modem connectivity command is issued. For purposes of displaying the minimum registration time, only those windows that end when the CM is unregistered are considered.
The Min, Avg, and Max values represent the minimum, average, and maximum of the registration time windows for the CM, respectively.
Registration times are displayed as follows: 1) less than an hour—mm:ss; 2) greater than one hour but less than one day—hhhmmm (for example, 16h34m); 3) greater than one day—dddhhh (for example, 78d18h).
Unreg Time The unregistration time is measured as a window of time that begins when the CM is unregistered, and ends: 1) when the CM is registered, or 2) at the time the show cable modem connectivity command is issued. For purposes of displaying the minimum unregistration time, only those windows that end when the CM is registered are considered.
The Min, Avg, and Max values represent the minimum, average, and maximum of the unregistration time windows for the CM, respectively.
Unregistration times are displayed as follows: 1) less than an hour—mm:ss; 2) greater than one hour but less than one day—hhhmmm (for example, 16h34m); 3) greater than one day—dddhhh (for example, 78d18h).
All the counters in Table 12 are cleared when the CMTS is rebooted, or when the CMTS performs its periodic cleanup of the CM database and removes CMs that have been offline for longer than 24 hours.
show cable modem cpe
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference172
show cable modem cpe
This command displays a list of known CPEs behind a specified CM or set of CMs. The command can apply to all CMs, to those CMs in a slot/interface, an upstream channel, a SID, or to individual CMs specified by their IP or MAC address. Table 13 on page 173 defines the information that is displayed for each CM and CPE. CPE MAC and IP addresses are learned by the CMTS when CPEs send upstream traffic.
! show cable modem cpe is a top-level command and is available to all users.
Syntax show cable modem [<ip-address>|<mac-address>] cpe
Displays a list of all known CPEs, or optionally, the CPEs associated with a specified CM.
show cable modem <slot/if> [upstream <channel>] cpe
Displays a list of all CPEs in the given slot/interface, or optionally, only those CPEs in the specified upstream channel in the given slot/interface
show cable modem <slot/if> sid <sid> cpe
Displays a list of all CPEs associated with a CM assigned the specified primary SID in the given slot/interface.
Definitions
Examples GX$root> show cable modem cpe
Displays a list of all CMs and known CPEs associated with all CMs.
Intrfc Prim Sid Type State IP Address Method Mac Address
C2/0/U0 165 modem init(i) 192.168.27.110 dhcp 0001.0327.DCAA
C2/0/U0 162 modem online 192.168.27.106 dhcp 0030.D002.1B71
host unknown 20.5.1.2 - 0001.8339.BACE
host unknown 20.1.5.29 - 0001.5147.2935
C2/1/U2 0 modem offline 20.1.1.63 dhcp 00D0.59FD.F519
C2/1/U3 0 modem offline 192.168.27.122 dhcp 0040.3609.44EB
ip-address The IP address of the cable modem for which the associated CPEs are to be displayed. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem for which the associated CPEs are to be displayed. Specified as xxxx.xxxx.xxxx in hexadecimal.
slot/if The slot number and interface number of the cable interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
upstream Specifies that an upstream channel will be specified.
channel The upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
sid Specifies that the interface will be displayed based on the Service identifier.
sid Service identifier. (1–8191)
SIDs can be viewed with the show cable modem command.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem cpe
173
Table 13: Parameters Displayed by ‘show cable modem cpe’
Related Commands show cable modemshow cable modem connectivityshow cable modem offlineshow cable modem physhow cable modem registeredshow cable modem unregistered
Parameter Description
Intrfc The interface specified as Cslot/if/Uchannel.
Prim Sid The primary service ID (SID) of the CM.
Type Specifies whether the entry is for a CM (modem) or CPE (host).
State The state of the CM. See Table 10 on page 168 for a list of these states.
IP Address The IP address of the CM or CPE.
Method For the G10 CMTS, the method used by a CM to obtain its IP address is always dhcp.
Mac Address The MAC adddress of the CM or CPE.
show cable modem offline
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference174
show cable modem offline
This command displays a list of offline CMs, along with various operational parameters. A CM is considered offline if it is in the offline or reject states as defined in Table 10 on page 168. The command can be used to display information pertaining to all CMs, to those CMs in a slot/interface, an upstream channel, or to individual CMs specified by their IP or MAC address.
! show cable modem offline is a top-level command and is available to all users.
Syntax show cable modem [<ip-address>|<mac-address>] offlineDisplays parameters for all offline CMs, or optionally displays whether the CM with the given address is offline.
show cable modem <slot/if> [upstream <channel>] offlineDisplays parameters for all offline CMs in the given slot/interface, or optionally, only those offline CMs in the specified upstream channel in the given slot/interface.
Definitions
Examples GX$root> show cable modem offline
Displays parameters for all offline CMs. The display is identical to the display produced by the show cable modem command (see Table 9 on page 168 for a definition of all parameters displayed).
Related Commands show cable modemshow cable modem connectivityshow cable modem cpeshow cable modem physhow cable modem registeredshow cable modem unregistered
ip-address The IP address of the cable modem for which the associated CPEs are to be displayed. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem for which the associated CPEs are to be displayed. Specified as xxxx.xxxx.xxxx in hexadecimal.
slot/if The slot number and interface number of the cable interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
upstream Specifies that an upstream channel will be specified.
channel The upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem phy
175
show cable modem phy
This command displays CM physical layer parameters. The command can be used to display information pertaining to all CMs, to those CMs in a slot/interface or an upstream channel, or to individual CMs specified by their IP or MAC address.
! show cable modem phy is a top-level command and is available to all users.
Syntax show cable modem [<ip-address>|<mac-address>] phy
Displays physical parameters for all CMs supported by the CMTS, or optionally the CM with the given address.
show cable modem <slot/if> [upstream <channel>] phy
Displays physical parameters for all CMs in the given slot/interface, or optionally, only those CMs in the specified upstream channel in the given slot/interface.
Definitions
Examples GX$root> show cable modem phy
Displays physical parameters for all CMs supported by the CMTS.
Interface CM USPwr UsSNR Timing MicroReflec
MAC Address (dBmV) (dB) Offset (dBc)
C2/0/U0 0000.F00A.D084 0.0 29.4 579 39
C2/0/U0 0010.9517.91B2 0.0 29.4 2482 36
C2/0/U0 0010.9517.92EC -0.3 29.1 2482 39
C2/0/U0 0010.9518.F212 0.0 29.2 2484 42
C2/0/U0 0010.951A.0424 0.0 29.2 2485 37
C2/0/U0 0010.951A.044F -0.1 29.1 2485 33
slot/if The CMTS slot and interface number, which will display all the cable modems in that interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
upstream Only information associated with CMs on the specified upstream channel is displayed.
channel The upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
ip-address The IP address of the cable modem to be displayed. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem to be displayed specified as xxxx.xxxx.xxxx in hexadecimal.
show cable modem phy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference176
Table 14: Parameters Displayed by ‘show cable modem phy’
Related Commands show cable modemshow cable modem connectivityshow cable modem cpeshow cable modem offlineshow cable modem registeredshow cable modem unregisteredshow cable qos profile
Parameter Description
Interface The interface specified as Cslot/if/Uchannel.
CM MAC Address The MAC adddress of the CM.
UsPwr (dBmV) The receive power level of the CM’s upstream signal as measured at the CMTS. Zero is returned if unknown.
UsSNR (dB) The signal-to-noise ratio of the CM’s upstream signal as measured at the CMTS. Zero is returned if unknown.
Timing Offset The timing adjustment provided by the CMTS in a ranging response. Units are (6.25µs/64). Zero is returned if unknown.
MicroReflec (dBc) Total microreflections. This parameter is identical to the docsIfCmtsCmStatusMicroreflections object in the RFC-2670 MIB.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem registered
177
show cable modem registered
This command displays a list of registered CMs, along with various operational parameters. The command can be used to display information pertaining to all CMs, to those CMs in a slot/interface, an upstream channel, or to individual CMs specified by their IP or MAC address.
! show cable modem registered is a top-level command and is available to all users.
Syntax show cable modem [<ip-address>|<mac-address>] registered
Displays parameters for all registered CMs, or optionally displays whether the CM with the given address is registered.
show cable modem <slot/if> [upstream <channel>] registered
Displays parameters for all registered CMs in the given slot/interface, or optionally, for all registered CMs in the specified upstream channel in the given slot/interface.
Definitions
Examples GX$root> show cable modem registered
Displays parameters for all registered CMs. The display is identical to the display produced by the show cable modem command (see Table 9 on page 168 for a definition of all parameters displayed).
Related Commands show cable modemshow cable modem connectivityshow cable modem cpeshow cable modem offlineshow cable modem physhow cable modem unregistered
ip-address The IP address of the cable modem for which the associated CPEs are to be displayed. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem for which the associated CPEs are to be displayed. Specified as xxxx.xxxx.xxxx in hexadecimal.
slot/if The slot number and interface number of the cable interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
upstream Specifies that an upstream channel will be specified.
channel The upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
show cable modem unregistered
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference178
show cable modem unregistered
This command displays a list of unregistered CMs, along with various operational parameters. A CM is considered unregistered if it is in one of the following operational states—destroyed, declared, ranging, ranging-aborted, ranging-complete, IP-complete, or access-denied (see Table 11 on page 169 for definitions of these states). The command can be used to display information pertaining to all CMs, to those CMs in a slot/interface, an upstream channel, or to individual CMs specified by their IP or MAC address.
! show cable modem unregistered is a top-level command and is available to all users.
Syntax show cable modem [<ip-address>|<mac-address>] unregistered
Displays parameters for all unregistered CMs, or optionally displays whether the CM with the given address is unregistered.
show cable modem <slot/if> [upstream <channel>] unregistered
Displays parameters for all unregistered CMs in the given slot/interface, or optionally, for all unregistered CMs in the specified upstream channel in the given slot/interface.
Definitions
Examples GX$root> show cable modem unregistered
Displays parameters for all unregistered CMs. The display is identical to the display produced by the show cable modem command (see Table 9 on page 168 for a definition of all parameters displayed).
Related Commands show cable modemshow cable modem connectivityshow cable modem cpeshow cable modem offlineshow cable modem physhow cable modem registered
ip-address The IP address of the cable modem for which the associated CPEs are to be displayed. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem for which the associated CPEs are to be displayed. Specified as xxxx.xxxx.xxxx in hexadecimal.
slot/if The slot number and interface number of the cable interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
upstream Specifies that an upstream channel will be specified.
channel The upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modulation-profile
179
show cable modulation-profile
This command displays the configuration parameters of a cable modulation profile.
! show cable modulation-profile is a top-level command and is available to all users.
Syntax show cable modulation-profile [<profile-id> [<iuc>]]
Definitions
Examples GX$root> show cable modulation-profile 1
ModId IUC prelen seed mod dif fec data/fec brst guard lstcw scrmb
1 request(1) 68 0x0001 QPSK Y 0 16 0 6 2 Y
1 reqdata(2) 68 0x0001 QPSK Y 3 40 8 6 2 Y
1 initial(3) 52 0x0001 QPSK Y 3 34 0 5 2 Y
1 station(4) 52 0x0001 QPSK Y 3 34 0 5 2 Y
1 short(5) 36 0x0001 QPSK Y 3 40 8 5 1 Y
1 long(6) 36 0x0001 QPSK Y 3 100 0 5 1 Y
GX$root> show cable modulation-profile
Displays all profiles and interval usage codes.
GX$root> show cable modulation-profile 1 long
Only displays the long interval usage code parameters for profile ID 1.
Related Commands cable modulation-profile
show cable qos profile
This command displays the details of the QoS (quality of service) profile in the CMTS.
! show cable qos profile is a top-level command and is available to all users.
Syntax show cable qos profile [<qos-profile-id>]
Definitions
Examples GX$root> show cable qos profile 1
Display QoS profile 1.
Service Prio Max Guarantee Max Max tx Create Baseline
class upstream upstream downstream burst by privacy
bandwidth bandwidth bandwidth enable
1 0 1000000 0 10000000 0 cmts no
profile-id The modulation profile ID number of the profile to be displayed. Valid options are numbers from 1 to 256.
iuc DOCSIS interval usage code: request, reqdata, initial, station, short, long
qos-profile-id The QoS profile ID number of the profile to be displayed. Valid options are numbers from 0 to 65535. If not specified, all defined QOS profiles are displayed.
show cable shared-secret
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference180
show cable shared-secret
This command is used to display the specified authentication string shared between the provisioning server that provides a cable modem’s configuration file and the CMTS. The shared secret authentication string is displayed in encrypted form.
! show cable shared-secret is a top-level command and is available to all users.
! This command does not have a no form.
! The default shared secret is DOCSIS.
Syntax show cable shared-secret
Examples GX$root> show cable shared-secret
The shared secret authentication string is displayed in encrypted form.
Shared-secret is: 977071536c2ea956
Related Commands cable shared-secret
show cable vpn
This command displays a list of active (registered) CMs and their associated CPE devices that are assigned to the specified VPN. If a CM is not registered, the CM and its associated CPE devices are not displayed by this command, even if they have been previously assigned to a VPN. Active members of a VPN are displayed regardless of the manner in which they were assigned to the VPN (by the cable vpn command, or by configuration file provisioning).
! show cable vpn is a top-level command and is available to all users.
Syntax show cable vpn <vpn-id>
Definitions
Examples GX$root> show cable vpn 129
Display all CMs and associated CPEs assigned to VPN ID 129.
1234.1234.1234 cm
abcd.abcd.abcd cpe
Related Commands cable vpn
vpn-id Displays all CMs and associated CPEs assigned to this VPN ID. Valid range is 129–4000.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show chassis environment
181
show chassis environment
This command displays the status of various environmental parameters in the CMTS chassis, including the temperature of each DOCSIS Module, fan status, power supply status, and the user notification temperature thresholds.
! show chassis environment is a top-level command and is available to all users.
Syntax show chassis environment
Examples GX$root> show chassis environment
Displays the status of various environmental parameters of the G10 CMTS.
Class Item Status Measurement
Temp DOCSIS Module Slot 2 OK 28 degrees C / 82 degrees F
Fans Left Fan Tray Fan 0 OK 4740 RPM
Left Fan Tray Fan 1 OK 4680 RPM
Left Fan Tray Fan 2 OK 5040 RPM
Left Fan Tray Fan 3 OK 4860 RPM
Left Fan Tray Fan 4 OK 4860 RPM
Left Fan Tray Fan 5 OK 4860 RPM
Right Fan Tray Fan 0 OK 5160 RPM
Right Fan Tray Fan 1 OK 5220 RPM
Right Fan Tray Fan 2 OK 5160 RPM
Right Fan Tray Fan 3 FAIL 0 RPM
Right Fan Tray Fan 4 FAIL 0 RPM
Right Fan Tray Fan 5 FAIL 0 RPM
Rear Fan Tray Fan 0 OK 4020 RPM
Rear Fan Tray Fan 1 OK 4020 RPM
Rear Fan Tray Fan 2 OK 4020 RPM
Rear Fan Tray Fan 3 OK 5760 RPM
Rear Fan Tray Fan 4 OK 5820 RPM
Rear Fan Tray Fan 5 OK 5820 RPM
Power Power Supply Normal
Temp User Notify High Threshold 60 degrees C / 140 degrees F
User Notify Low Threshold 40 degrees C / 104 degrees F
Related Commands chassis environment ambient-temperatureshow chassis hardware
show chassis hardware
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference182
show chassis hardware
This command displays a list of all DOCSIS Modules, Chassis Control Modules, and NIC Modules (G10 CMTS only) installed in the CMTS, including (where applicable) the module version, part number, and serial number.
! show chassis hardware is a top-level command and is available to all users.
Syntax show chassis hardware [detail]
Definitions
Examples GX$root> show chassis hardware
Displays a list of all modules installed in the G10 CMTS.
Item Version Part Number Serial Number UpTime
CCM in slot 6 5.16 D Unknown 0 days 01:08:46
DM in slot 2 0.0 750-006610 012345 0 days 01:08:17
Related Commands cable authorizechassis environment ambient-temperatureshow chassis environment
show clock
This command displays the current time and date of the CMTS clock, and the NTP server IP address. The first line of the display represents the UTC time, the second line represents the local time, and the third line displays the IP address of an NTP server (if configured). If the clock summer-time command was previously issued, the fourth and fifth lines of the display show the daylight savings time start and end times, respectively.
! show clock is a top-level command and is available to all users.
Syntax show clock
Examples GX$root> show clock
Tue Jul 30 17:11:44 UTC 2002
Tue Jul 30 10:11:44 PDT 2002
ntp-server ip address: 192.168.10.183
Summer-time starts at: Sun Apr 07 02:00:00 PST 2002
Summer-time ends at: Sun Oct 27 02:00:00 PDT 2002
Related Commands clockclock ntp-serverclock showclock summertimeclock timezone
detail Specifies that more hardware details will be displayed.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show configuration
183
show configuration
This command is a synonym for show startup-config. See show startup-config on page 194 for details.
show controller cable
This command displays DOCSIS channel statistics at the CMTS level, the slot/interface level, or for a single channel. The downstream channel statistics displayed include channel status, frequency, channel width, modulation, symbol rate, RF power, and interleaver depth. The upstream channel statistics displayed include channel status, frequency, channel width, symbol rate, modulation, SNR, input power, timing offset values, backoff window values, modulation profile group, and minislot size.
! show controller cable is a top-level command and is available to all users.
Syntax show controller cable [<slot/if> [downstream <channel> | upstream <channel>]]
Definitions
Examples GX$root> show controller cable 2/0 downstream 0
This displays statistics for downstream channel 0 on slot 2 / interface 0.
C2/0/D0 is up
Frequency 531.000 Mhz, Channel Width 6 MHz, QAM256, Symbol Rate 5.360537 Msps
RF Power 61.0 dBmv
FEC ITU-T J.83 Annex B, R/S Interleave I=8, J=16
GX$root> show controller cable 2/0 upstream 0
This displays statistics for upstream channel 0 on slot 2 / interface 0.
slot/if The slot number and interface number of the cable interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
downstream Specifies that a downstream interface will be displayed.
upstream Specifies that an upstream interface will be displayed.
channel The downstream channel number (0–3 for the G10 CMTS, 0–1 for the G1 CMTS) or the upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
show controller cable
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference184
C2/0/U0 is up
Frequency 14.000 MHz, Channel Width 0.200 MHz, Symbol Rate 160 Msps
Long Grant: QAM16, Short Grant: QAM16
SNR 3750 dB
Nominal Input Power Level 80 dBmV, Tx Timing Offset 19352
Ranging Backoff Start 1, Ranging Backoff End 5
Tx Backoff Start 3, Tx Backoff End 10
Modulation Profile Group 8
Minislot Size in number of Timebase Ticks is = 64
Minislot Size in Symbols = 64
GX$root> show controller cable 2/0
This displays statistics for all downstream and upstream channels on slot 2 / interface 0.
GX$root> show controller cable
This displays statistics for all downstream and upstream channels in the CMTS.
Related Commands show interfaces
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cpu
185
show cpu
This command displays the average central processing unit (CPU) usage of the Chassis Control Module since the system was booted up, and during the latest specified interval. You can optionally instruct the CMTS to repeatedly display the CPU usage within this interval a specified number of times. The command displays the total usage, the percentage used by the current user, and the percentage used by the system (non-user usage).
! show cpu is a top-level command and is available to all users.
! The interval defaults to one second.
! If repeat is not specified, the command displays the CPU usage since the system was booted, and the usage within one elapsed interval.
Syntax show cpu [<interval> [<repeat>]]
Definitions
Examples GX$root> show cpu
Displays the CPU usage since the system was booted, and the usage within the last second.
CPU average usage since the system was up:
Total Time: 28.8%
User Time: 4.0%
System Time: 24.7%
CPU current usage within latest 1 seconds:
Total Time: 0.0%
User Time: 0.0%
System Time: 0.0%
GX$root> show cpu 10 2
Displays the CPU usage since the system was booted, and the usage within the last 10 seconds. Because the repeat parameter was given (2), the CPU usage within the next two 10-second intervals is also displayed.
CPU average usage since the system was up:
Total Time: 24.6%
User Time: 3.4%
System Time: 21.1%
CPU current usage within latest 10 seconds:
Total Time: 0.1%
User Time: 0.0%
System Time: 0.1%
interval Specifies the window, in seconds, in which to measure the CPU usage. The window begins when the Enter key is pressed, and ends when <interval>seconds have elapsed. The default is one second.
repeat Specifies that the CPU usage during each interval is to be displayed repeatedly, <repeat> number of times. The default is 0.
show debugging
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference186
CPU current usage within latest 10 seconds:
Total Time: 0.0%
User Time: 0.0%
System Time: 0.0%
CPU current usage within latest 10 seconds:
Total Time: 0.0%
User Time: 0.0%
System Time: 0.0%
Related Commands show memory
show debugging
This command displays a list of debug filters—MAC addresses, service IDs (SIDs), and slot/interfaces—that are currently being monitored for each debug event type (such as arp, range, and ucd).
! show debugging is a top-level command and is available to all users.
Syntax show debugging
Examples GX$root> show debugging
Displays a list of debug filters that are currently being monitored for each debug event type.
Related Commands debugdebug cabledebug cable clear filterdebug cable interface cable
show disk
This command displays usage information for user-accessible region in the CMTS local storage.
! show disk is a top-level command and is available to all users.
Syntax show disk
Examples GX$root> show disk
Displays usage information for user-accessible region.
Filesystem 1k-blocks Used Available Use% Mounted on
/dev/disk 63454 5520 54645 10% /
Related Commands show memory
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show history
187
show history
This command is used to display a list of previously-issued commands, including the show history command just issued. To issue any of the commands displayed, enter ! followed by the number of the command displayed.
! show history is a top-level command and is available to all users.
! This command does not have a no form.
Syntax show history
Examples GX$root# show history
Issue configure terminal by entering !1.
1 configure terminal
2 interface fastEthernet 6/0
3 show
4 exit
5 interface cable 2/0
6 ip show
7 show history
GX$root# !1
GX$root(config)#
Related Commands history
show interfaces
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference188
show interfaces
This command displays packet and link statistics for all cable, fastEthernet, and gigaEthernet interfaces.
! show interfaces is a top-level command and is available to all users.
Syntax show interfaces
show interfaces cable [<slot/if>]
show interfaces cable <slot/if> downstream [<channel>]
show interfaces cable <slot/if> upstream [<channel>]
show interfaces cable <slot/if> sid [<sid>]
show interfaces fastEthernet [<slot/if>]
show interfaces gigaEthernet [<slot/if>] (G10 CMTS only)
Definitions
cable Specifies that a DOCSIS Module cable interface will be displayed.
slot Chassis slot number:
DOCSIS Module: 1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS
Chassis Control Module: 6 and 7 for the G10 CMTS), or 1 for the G1 CMTS
NIC Module: 5 and 9 (G10 CMTS only)
if Interface number to be configured:
DOCSIS Module cable interfaces: 0–3 for the G10 CMTS, or 0–1 for the G1 CMTS
DOCSIS Module Fast Ethernet ports: 0–1 for the G10 CMTS, or 0 for the G1 CMTS
Chassis Control Module: Fast Ethernet port 0
NIC Module (G10 CMTS only): Fast Ethernet ports 0–11, Gigabit Ethernet port 0 and 1
downstream Specifies that a downstream interface will be displayed.
upstream Specifies that an upstream interface will be displayed.
channel The downstream channel number (0–3 for the G10 CMTS, 0–1 for the G1 CMTS) or the upstream channel number (0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS).
sid Specifies that the interface will be displayed based on the Service identifier.
sid Service identifier. (1–8191)
SIDs can be viewed with the show cable modem command.
fastEthernet Specifies a Fast Ethernet interface in a DOCSIS Module, a Chassis Control Module, or a NIC Module will be displayed.
gigaEthernet Specifies a Gigabit Ethernet interface in a NIC Module will be displayed (G10 CMTS only).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show interfaces
189
Examples GX$root> show interfaces cable 2/0 downstream
This displays statistics for the entire downstream interface at slot 2 / interface 0.
Cable 2/0: Downstream 0 is administratively up, operationally up
12168624 packets output, 281544087 bytes, 4936795 discarded
0 output errors
GX$root> show interfaces cable 2/0 upstream 0
This displays statistics for upstream channel 0 at slot 2 / interface 0.
Cable 2/0: Upstream 0 is administratively up, operationally up
Received 48192 broadcast, 1250 multicasts, 29167 unicasts
0 discards, 0 errors, 0 unknown protocol
78609 packets input, 40 uncorrectable
31.8 noise (dB), 32 microreflections
GX$root> show interfaces fastEthernet 6/0
Displays statistics for Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS.
FastEthernet6/0 is administratively up, operationally up
Description: "FastEthernet 6/0"
Hardware address is 00:03:04:B0:06:2E
Internet address is 192.168.27.49/255.255.255.0
MTU 1500 bytes
Configuration:
Full-duplex, 100 Mb/s, Auto-negotiation On
Current Link State:
Full-duplex, 100 Mb/s
193197 packets input, 21892929 bytes, received 0 broadcasts
0 input errors
117747 packets output, 13414065 bytes
15 output errors
show ip arp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference190
show ip arp
This command displays specified entries or the entire ARP (Address Resolution Protocol) table. If no optional parameters are specified, the entire ARP table is displayed.
The Timeout value displayed indicates the timeout for dynamic entries (in seconds). The timeout duration can be set by the arp timeout command. A timeout of -1 indicates the entry is static.
! show ip arp is a top-level command and is available to all users.
Syntax show ip arp [<ip-address>|<mac-address>|<slot/if>]
Definitions
Examples GX$root# show ip arp 10.131.2.1
Display any ARP table entries that have an IP address of 10.131.2.1.
IP Address MAC Address VLAN Id Timeout
10.131.2.1 0001.309F.2800 0 588
GX$root# show ip arp
Display the entire ARP table.
Related Commands arparp timeoutcable address-verificationcable proxy-arpcable vpn
ip-address The IP address of the ARP table entry. Standard dot-quad notation (xxx.xxx.xxx.xxx). Multiple entries are displayed if an IP address is part of multiple VLANs.
mac-address The MAC address of the ARP table entry. Specified as xxxx.xxxx.xxxx in hexadecimal. Multiple entries can be displayed for a MAC address.
slot/if The slot number and interface number of the cable interface. Multiple entries can be displayed for a slot/interface.
Slot (1–4 or 10–13 for the G10 CMTS, or 2 for the G1 CMTS) Interface (0–3 for the G10 CMTS, or 0–1 for the G1 CMTS)
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show local-log
191
show local-log
This command displays the local event log of the CMTS that corresponds to the docsDevEventTable within the DOCSIS Cable Device MIB (RFC-2669). This log can assist with troubleshooting various issues. See the DOCSIS OSSI specification and RFC-2669 for more details. The G10 CMTS and G1 CMTS Installation and Operation manuals provide a list of Juniper Networks-specific log events.
! show local-log is a top-level command and is available to all users.
Syntax show local-log
Examples GX$root> show local-log
Displays the local event log of the CMTS. Table 15 provides the correspondence between the display headings and the RFC-2669 objects.
Time shown as : YYYY:MM:DD:HH:MM:SS:DS
Index Date/Time Level Id Description
----- ---------------------- ----------- ---------- ----------------------
7180 2002:08:05:08:13:02:05 information 2539850601 DATAPATH Unverifiable IP add
ress 20.5.1.2 received from CPE MAC 0-1-2-E4-2A-C7. CM MAC 0-90-83-39-BA-CE
7181 2002:08:05:08:13:41:07 information 2539850603 DATAPATH Invalid CPE IP (192
.168.27.96), MAC 0-20-40-7F-4F-CA from CM 0-20-40-7F-4F-CA; address not allocate
d
7182 2002:08:05:08:13:42:04 information 2539850603 DATAPATH Invalid CPE IP (192
.168.27.96), MAC 0-20-40-7F-4F-CA from CM 0-20-40-7F-4F-CA; address not allocate
d
Table 15: Local Event Log Headings Displayed
Related Commands log-level generatelog-level show
Display Headings RFC-2669 Object Meaning
Index docsDevEvIndex Relative ordering in the event log.
Date/Time docsDevEvFirstTime The time the entry was created.
Level docsDevEvLevel The priority level of the event.
Id docsDevEvId Unique identifier used by the G10 CMTS for the event type.
Description docsDevEvText A text description of the Id.
show memory
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference192
show memory
This command displays the memory usage of the Chassis Control Module, including the total, shared, free, buffer, and cached memory.
! show memory is a top-level command and is available to all users.
Syntax show memory
Examples GX$root> show memory
Displays the memory usage of the CMTS.
Memory Usage
MemTotal: 253576 kB
MemFree: 186780 kB
MemShared: 0 kB
Buffers: 560 kB
Cached: 34628 kB
Related Commands show disk
show privilege
This command displays the privilege levels of the current session’s user.
! show privilege is a top-level command and is available to all users.
Syntax show privilege
Examples GX$root> show privilege
User root has the following access privilege:
Admin group access level : rw
Fs group access level : rw
Ip group access level : rw
Rf group access level : rw
Related Commands show usernamesshow usersshow whoamiusernamewho
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show running-config
193
show running-config
This command displays the current CMTS configuration parameters being used. Information is not displayed for empty DOCSIS Module slots (see the show working-config command).
! show running-config is a top-level command and is available to all users.
Syntax show running-config
Examples GX$root> show running-config
cable modulation-profile 1 initial 3 34 0 5 qpsk scrambler 1 diff 52 fixed
cable modulation-profile 1 long 3 100 0 5 qpsk scrambler 1 diff 36 shortened
cable modulation-profile 1 reqdata 3 40 8 6 qpsk scrambler 1 diff 68 fixed
cable modulation-profile 1 request 0 16 0 6 qpsk scrambler 1 diff 68 fixed
cable modulation-profile 1 short 3 40 8 5 qpsk scrambler 1 diff 36 shortened
cable modulation-profile 1 station 3 34 0 5 qpsk scrambler 1 diff 52 fixed
cable modulation-profile 2 initial 3 34 0 5 16qam scrambler 1 diff 104 fixed
cable modulation-profile 2 long 3 100 0 5 16qam scrambler 1 diff 64 shortened
continued...
cable shared-secret DOCSIS
clock timezone PST 0 0
hostname myhost-7
interface
cable 2/0
cable dhcp-giaddrcable downstream 0 channel-width 6000000cable downstream 0 frequency 531000000cable downstream 0 interleave-depth 8cable downstream 0 modulation 64qamcable downstream 0 rf-power 61no cable downstream 0 shutdowncable helper-address 192.168.200.5 cable-modem
continued...
Related Commands show configurationshow startup-configshow working-config
show startup-config
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference194
show startup-config
This command displays the CMTS configuration parameters that will be used at the next start-up.
! show startup-config is a top-level command and is available to all users.
Syntax show startup-config
Examples GX$root> show startup-config
cable modulation-profile 1 initial 3 34 0 5 qpsk scrambler 1 diff 52 fixed
cable modulation-profile 1 long 3 100 0 5 qpsk scrambler 1 diff 36 shortened
cable modulation-profile 1 reqdata 3 40 8 6 qpsk scrambler 1 diff 68 fixed
cable modulation-profile 1 request 0 16 0 6 qpsk scrambler 1 diff 68 fixed
cable modulation-profile 1 short 3 40 8 5 qpsk scrambler 1 diff 36 shortened
cable modulation-profile 1 station 3 34 0 5 qpsk scrambler 1 diff 52 fixed
cable modulation-profile 2 initial 3 34 0 5 16qam scrambler 1 diff 104 fixed
cable modulation-profile 2 long 3 100 0 5 16qam scrambler 1 diff 64 shortened
continued...
cable shared-secret DOCSIS
clock timezone PST 0 0
hostname myhost-7
interface
cable 2/0
cable dhcp-giaddrcable downstream 0 channel-width 6000000cable downstream 0 frequency 531000000cable downstream 0 interleave-depth 8cable downstream 0 modulation 64qamcable downstream 0 rf-power 61no cable downstream 0 shutdowncable helper-address 192.168.200.5 cable-modem
continued...
Related Commands show configurationshow running-configshow working-config
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show tech-support
195
show tech-support
This command displays the following useful information to assist technical support with troubleshooting:
! The current time
! The current software version and the names of upgrade, normal, and failsafe software packages
! The Chassis Control Module and DOCSIS Module error logs
! The chassis hardware details (equivalent to the show chassis hardware detail command)
! Chassis Control Module memory usage (equivalent to the show memory command)
! The local event log (equivalent to the show local-log command)
! Internal warning and error status logs
! Running configuration (equivalent to the show running-config command)
! show startup-config is a top-level command and is available to all users
Syntax show tech-support
Examples GX$root> show tech-support
Current Time: Sat May 25 15:12:21 2002
====================== SW version ========================
Software Version 2.1.1.11a (built on May 24 2002)
Current Image : Normal
Upgrade Mode package: GX-v211-r11a_bahia_us
Normal Mode package: GX-v211-r11_bahia_us
FailSafe Mode Package: GX-v211-r11_bahia_us
============ CCM Fatal Error Log History =================
<none>
======== Docsis Module Fatal Error Log History ===========
<none>
================ Chassis Hardware =======================
Hardware inventory:
Item Version Part Number Serial Number Description
CCM in slot 6 5.16 D Unknown CCM Module 6
FastEthernet 0 N/A N/A N/A FastEthernet Port 0
FastEthernet 1 N/A N/A N/A FastEthernet Port 1
continued...
================ Chassis Environment ====================
Class Item Status Measurement
show tech-support
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference196
Temp DOCSIS Module Slot 2 OK 28 degrees C / 82 degrees F
Fans Left Fan Tray Fan 0 FAIL 0 RPM
Left Fan Tray Fan 1 FAIL 0 RPM
Left Fan Tray Fan 2 FAIL 0 RPM
continued...================ CCM Memory Usage ======================
Memory Usage
MemTotal: 253576 kB
MemFree: 172620 kB
MemShared: 0 kB
Buffers: 656 kB
Cached: 44312 kB
===================== Local Log ==========================
Time shown as : YYYY:MM:DD:HH:MM:SS:DS
Index Date/Time Level Id Description
----- ---------------------- ----------- ---------- ----------------------
1 2002:05:24:20:30:04:04 error 66060510 Map Reject - Downstream Traf
fic Flow Not Mapped to BPI+ SAID (EC=8). MAC addr: 00:10:95:1D:18:43
2 2002:05:24:20:30:06:07 error 66060510 Map Reject - Downstream Traf
fic Flow Not Mapped to BPI+ SAID (EC=8). MAC addr: 00:10:95:1C:A7:8A
continued...
========== Internal Warnig/Errror Status Logs ===========
Fri May 24 20:29:00 2002 , Status 0 File /homes/xxu/cmts_main/ccm/src/modules/mn
m/cmmf/mo/nicModule.cpp Line 267 Msg NIC-addInterface :: Object already exist
Fri May 24 20:29:00 2002 , Status 0 File /homes/xxu/cmts_main/ccm/src/modules/mn
m/cmmf/mo/nicModule.cpp Line 267 Msg NIC-addInterface :: Object already exist
continued...================== Running Config =======================
arp timeout 600
no cable arp-verify
no cable drop-unverifiable-addresses
cable host downstream-filter default-group 0
cable host upstream-filter default-group 0
continued...
Related Commands show chassis environmentshow chassis hardwareshow local-logshow memoryshow running-configshow version
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show upgrade-log
197
show upgrade-log
This command displays all the software upgrade log messages produced during the last four system reboots.
! show usernames is a top-level command and is available to all users.
Syntax show upgrade-log
Examples GX$root> show upgrade-log
Displays the software upgrade log messages produced during the last four system reboots.
Related Commands system applysystem auto-rollback
show usernames
This command displays all usernames known to the CMTS, including those users that are not currently logged into the CMTS, along with their associated prompts and privileges.
! show usernames is a top-level command and is available to all users.
Syntax show usernames
Examples GX$root> show usernames
Username : admin
Access rights : FS - rw
Username : root
Access rights : AD - rw FS - rw IP - rw RF - rw
Related Commands show privilegeshow usersshow whoamiusernamewho
show users
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference198
show users
This command displays all users currently logged into the CMTS.
! show users is a top-level command and is available to all users.
Syntax show users
Examples GX$root> show users
SessionId Login Connection
0 root Console
1 usr1 172.17.19.61
Related Commands show privilegeshow usernamesshow whoamiusernamewho
show version
If an optional parameter is not specified, this command displays the version of software currently running in the CMTS and a copyright banner. If one of the optional parameters is specified, the version of that specified software image is displayed. See the system apply command for definitions of the software image types in the CMTS.
! show version is a top-level command and is available to all users.
Syntax show version [normal|failsafe|upgrade]
Definitions
Examples GX$root> show version
Displays the version of the software currently running in the CMTS.
GX$root> show version normal
Displays the version of the normal software image.
Related Commands system applysystem commit
normal Specifies that the version of the normal software image is to be displayed.
failsafe Specifies that the version of the failsafe software image is to be displayed.
upgrade Specifies that the version of the upgrade software image, if present in the archive, is to be displayed.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show whoami
199
show whoami
This command displays your current username.
! show whoami is a top-level command and is available to all users.
Syntax show whoami
Examples GX$root> show whoami
root
Related Commands show privilegeshow usernamesshow usersusernamewho
show working-config
This command displays the current CMTS configuration parameters being used. Information is displayed for empty DOCSIS Module slots that have been previously configured.
! show working-config is a top-level command and is available to all users.
! There are no parameters for this command.
Syntax show working-config
Examples GX$root> show working-config
cable modulation-profile 1 initial 3 34 0 5 qpsk scrambler 1 diff 52 fixed
cable modulation-profile 1 long 3 100 0 5 qpsk scrambler 1 diff 36 shortened
cable modulation-profile 1 reqdata 3 40 8 6 qpsk scrambler 1 diff 68 fixed
cable modulation-profile 1 request 0 16 0 6 qpsk scrambler 1 diff 68 fixed
cable modulation-profile 1 short 3 40 8 5 qpsk scrambler 1 diff 36 shortened
cable modulation-profile 1 station 3 34 0 5 qpsk scrambler 1 diff 52 fixed
cable modulation-profile 2 initial 3 34 0 5 16qam scrambler 1 diff 104 fixed
cable modulation-profile 2 long 3 100 0 5 16qam scrambler 1 diff 64 shortened
continued...
A DOCSIS Module can be configured using the CLI prior to its actual installation into the G10 CMTS.
show working-config
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference200
cable shared-secret DOCSIS
clock timezone PST 0 0
hostname myhost-7
interface
cable 2/0
cable dhcp-giaddr
cable downstream 0 channel-width 6000000
cable downstream 0 frequency 531000000
cable downstream 0 interleave-depth 8
cable downstream 0 modulation 64qam
cable downstream 0 rf-power 61
no cable downstream 0 shutdowncable helper-address 192.168.200.5 cable-modem
continued...
Related Commands show configurationshow running-configshow startup-config
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
shutdown
201
shutdown
This command disables a cable interface, a Fast Ethernet interface, or a Gigabit interface (G10 CMTS only). All upstream and downstream channels within a cable interface are affected by this command.
! shutdown is a command within the interface cable, the interface fastEthernet, and the interface gigaEthernet sub-modes and requires read-write privilege.
! Then no form of this command enables the targeted interface.
! The cable interfaces, the Fast Ethernet interfaces, and the Gigabit interfaces are disabled by default.
Syntax shutdown
no shutdown
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# no shutdown
Enable all upstream and downstream channels on slot 2 / interface 0.
GX$root# configure terminal
GX$root(config)# interface fastEthernet 6/0
GX$root(config-if-f6/0)# no shutdown
Enable Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS.
GX$root# configure terminal
GX$root(config)# interface gigaEthernet 5/0
GX$root(config-if-g5/0)# no shutdown
Enable Gigabit port 0 of the NIC Module in slot 5 of the G10 CMTS.
GX$root# configure terminal
GX$root(config)# interface fastEthernet 6/0
GX$root(config-if-f6/0)# shutdown
Disable Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS.
Related Commands auto-negotiationduplexshowspeed
snmp-server community
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference202
snmp-server community
This command specifies the read-only and read-write SNMP password community strings.
! snmp-server community is a command within the configure terminal mode and requires read-write privilege.
! no snmp-server community deletes all community strings.
Syntax snmp-server community <community-string> {ro|rw}
no snmp-server community <community-string>
snmp-server show
Definitions
Examples GX$root# configure terminal
GX$root(config)# snmp-server community myrwpw rw
Establishes myrwpw as the read-write SNMP password community string.
Related Command snmp-server host
community-string Alphabetic string that will be used by all SNMP hosts to gain access to the CMTS.
ro Specifies the string is for read-only access.
rw Specifies the string is for read-write access.
show Displays the community strings.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
snmp-server host
203
snmp-server host
This command specifies the destination hosts that will receive SNMPv1 and SNMPv2c traps from the CMTS. Up to 10 SNMPv1 and up to 10 SNMPv2c destinations can be specified. An alternative way to specify trap destinations for SNMPv1, SNMPv2c, and SNMPv3 is to use the SNMP-TARGET-MIB tables. Those tables are distinct from the tables acted upon by the snmp-server host command. To avoid confusion, it might be advantageous to set up SNMP trap destination hosts either via the SNMP-TARGET-MIB tables or the snmp-server host command, but not both.
! snmp-server host is a command within the configure terminal mode and requires read-write privilege.
! There is no default setting for this command.
! The no form of this command deletes the existing host address.
Syntax snmp-server host <ip-address> version {1|2c} [port <port-number>]
no snmp-server host <ip-address> version {1|2c}
snmp-server show
Definitions
Examples GX$root# configure terminal
GX$root(config)# snmp-server host 205.15.128.132 version 2c
Specify an IP address of 205.15.128.132 for the SNMP server. The SNMP version that will be used to send traps is 2c. The UDP port to which traps will be sent on this host is 162.
GX$root(config)# snmp-server host 205.15.128.177 version 1 port 2345
Specify an IP address of 205.15.128.177 for the SNMP server. The SNMP version that will be used to send traps is 1. The UDP port to which traps will be sent on this host is 2345.
GX$root(config)# no snmp-server host 205.15.128.177 version 1
Removes the entry for the SNMP server with an IP address of 205.15.128.177 and SNMP version 1.
ip-address The IP address of the host that will receive SNMP traps. Standard dot-quad notation (xxx.xxx.xxx.xxx).
1|2c Identifies the version of SNMP to use during communication with the destination host.
show Displays the IP address, SNMP version, and trap port for each destination host that has been configured. Also displays the community strings that were set using the snmp-server community command.
port-number Optional UDP port number to which SNMP traps are sent. If not specified, the port number defaults to 162.
speed
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference204
GX$root(config)# snmp-server show
Displays the IP address, SNMP version, and trap port for all configured SNMP servers.
NMS nodes table
----------------------------------------------------------------------
ipAddress: 205.15.128.177 SNMP version: 1 trap port: 2345
ipAddress: 205.15.128.132 SNMP version: 2 trap port: 162
Community string (r/o): public
Community string (r/w): private
Related Commands snmp-server community
speed
This command specifies the speed when configuring Fast Ethernet ports.
! speed is a command in the interface fastEthernet sub-mode, which is under the configure terminal mode, and requires read-write privilege.
! There is not a no form to this command.
! The default speed setting is 100.
Syntax speed {10|100}
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface fastEthernet 6/0
GX$root(config-if-f6/0)# speed 100
Sets the speed for Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS to 100Base-T.
10|100 Set the Ethernet port speed as 10Base-T or 100Base-T.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
system apply
205
system apply
This command instructs the CMTS to use either the normal, failsafe, or upgrade software images for the next system reboot. An image is defined as normal if it has been declared as such by the system commit command. The failsafe image is the image that was initially supplied by the factory and is never replaced. An upgrade image is a new software release that the CMTS has accepted for a trial by issuing the system apply upgrade command (with the name of the upgrade image file).
! system apply is a top-level command and requires read-write privilege.
! system apply normal is used to instruct the CMTS to move to the committed image for the next bootup (see the system commit command). This command can also be used to cancel a system apply upgrade.
! system apply failsafe instructs the CMTS to use the image and configuration that was initially supplied by the factory for the next bootup. The configuration file Startup.cli is renamed to Startup.cli.old to preserve the current configuration.
! system apply upgrade with a filename instructs the CMTS to check the provided upgrade image file for compatibility, create a copy of it in its internal archive, and use the internal copy for the next bootup. If no filename is specified, the CMTS checks its internal archive for a previously-accepted upgrade image. If no image is found, an error is returned.
! Software upgrade monitoring messages are displayed on the serial console, and are logged to /log/Upgrade.log. After each system reboot, the /log/Upgrade.log file is renamed to /log/Upgrade.log.1, and a new /log/Upgrade.log file is created. This cycling of log files keeps a history of up to four system reboots (up to /log/Upgrade.log.3). In addition, software upgrade messages are logged in the local event log, and the corresponding SNMP traps are generated (if enabled).
! The no form of this command cancels any pending system apply command.
Syntax system apply {normal|failsafe|upgrade [<filename>]}
no system apply
Definitions
normal Specifies that the normal software image is to be used for the next bootup.
failsafe Specifies that the failsafe software image and the initial factory configuration file are to be used for the next bootup.
upgrade Specifies that the upgrade software image specified by filename is to be used for the next bootup.
filename The absolute path and filename of the upgrade software image.
The filename parameter must be specified with an absolute path.
system apply
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference206
Examples GX$root# system apply failsafe
GX$root# reload
The CMTS will reboot using the failsafe image and configuration. The Startup.cli file is renamed to Startup.cli.old.
GX$root# system apply failsafe
GX$root# no system apply
GX$root# reload
The CMTS will not use the failsafe image upon reboot, but will reboot using the committed image in its internal archive.
GX$root# system apply upgrade /GX_v12r11
GX$root# reload
The CMTS will reboot using the upgrade image GX_v12r11 in the home directory.
Related Commands show upgrade-logshow versionsystem auto-rollbacksystem commit
Guidance We recommend that you retain all upgrade image files (the files can be renamed or moved to any directory of your choice). This allows you the option of applying any of those retained upgrade images to the CMTS in the future. Although an upgrade image is copied to the CMTS internal archive when the system apply upgrade command is issued, the archive should be considered a precaution against failures, and not a repository for multiple upgrade images. Any image files not needed can be deleted in the future.
After the CMTS has been rebooted following the execution of the system apply upgrade command, the system commit command must be issued to make the currently-executing image the normal image. Thereafter, this new normal image will be used for subsequent bootups.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
system auto-rollback
207
system auto-rollback
This command enables an automatic recovery feature where the CMTS will rollback to a previous version of software if the system is unable to start the CLI and SNMP interfaces at bootup. If the system cannot boot up an upgrade image of software, the system is rolled back to the normal image. If the system cannot boot up a normal image of software, the system is rolled back to the failsafe image. See the system apply command for definitions of the software image types in the CMTS.
! system auto-rollback is a top-level command and requires read-write privilege.
! Auto-rollback monitoring messages are displayed on the serial console, and are logged to /log/Upgrade.log. After each reboot following an auto-rollback, the /log/Upgrade.log file is renamed to /log/Upgrade.log.1, and a new /log/Upgrade.log file is created. This cycling of log files keeps a history of up to four reboots (up to /log/Upgrade.log.3).
! The no form of this command disables the automatic recovery feature.
Syntax system auto-rollback
Examples GX$root# system auto-rollback
Enables the automatic recovery feature.
Related Commands show versionsystem applysystem commit
system commit
This command is used to define the currently-executing software image as the normal image. It is typically used after the CMTS has been rebooted following the execution of the system apply upgrade command. Using system commit replaces the previously-committed image in the internal archive with the currently-running image. This command has no effect if the CMTS had used the normal image for bootup. See the system apply command for definitions of the software image types in the CMTS.
! system commit is a top-level command and requires read-write privilege.
Syntax system commit
Examples GX$root# system apply upgrade upgrade1.rpm
GX$root# reload
GX$root# system commit
The CMTS will reboot using the upgrade image upgrade1.rpm. This new image will be defined as the normal image and replaces the previously-committed image in the internal archive.
Related Commands show versionsystem applysystem auto-rollback
system config-backup
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference208
system config-backup
This command stores all persistent configuration data—including the user database, the CLI configuration, and the SNMPv3 configuration—in the specified file. This command does not implicitly save the running-config file as the startup-config file. This can be accomplished with the write memory or copy running-config startup-config commands.
! system config-backup is a top-level command and requires read-write privilege.
! The system config-restore command can be used to restore the configuration that is save by the system config-backup command.
Syntax system config-backup <filename>
Definitions
Examples GX$root# system config-backup mycfg.cli
Saves the current configuration in mycfg.cli in the current directory.
Related Commands system config-restore
system config-restore
This command stores all persistent configuration data—including the user database, the CLI configuration, and the SNMPv3 configuration—in file /home/backup, and resets the CMTS to either the factory configuration, or the configuration defined by the given filename, after the next reboot. The current running configuration and operation of the CMTS is not affected. See the system config-backup command to see how to create a configuration backup file.
! system config-restore is a top-level command and requires read-write privilege.
Syntax system config-restore {factory|<filename>}
Definitions
Examples GX$root# system config-restore factory
Saves the current configuration in /home/backup, and resets the CMTS to the factory configuration after the next reboot.
Related Commands system config-backup
Guidance To cancel the effect of this command, issue system config-restore /home/backup.
filename The name of the file in which the current configuration is saved.
factory Specifies that the configuration is reset to the factory configuration after the next reboot.
filename Specifies that the configuration is reset to the configuration defined by this file after the next reboot.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
telnet
209
telnet
This command opens a Telnet session to the specified hostname or IP address.
! telnet is a top-level command and is available to all users.
Syntax telnet {<hostname>|<ip-address>}
Definitions
Examples GX$root> telnet 192.163.25.8
Establish a Telnet session with the host at IP address 192.163.25.8.
Related Commands ftptftp
terminal monitor
This command enables debug message output for the current Telnet or console session.
! terminal monitor is a top-level command and requires read-debug privilege.
! The no form of this command disables debug message output.
! By default, debug message output is disabled.
Syntax terminal monitor
no terminal monitor
Examples GX$root# terminal monitor
Enables debug message output for the current session.
Related Commands debug cable interface cabledebug cable mac-addressterminal speed
hostname The hostname to which the Telnet session is established.
ip-address The IP address of the host to which the Telnet session is established. Standard dot-quad notation (xxx.xxx.xxx.xxx).
terminal page-mode
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference210
terminal page-mode
This command enables the pagination of the display output.
! terminal page-mode is a top-level command and is available to all users.
! The no form of this command disables display pagination.
! By default, display pagination is enabled.
Syntax terminal page-mode
no terminal page-mode
Examples GX$root# no terminal page-mode
Disables display pagination.
Related Commands terminal monitorterminal speed
terminal speed
This command sets the maximum debug message output speed in characters per second for the current session. This command does not affect the display output speed attributed to non-debug CLI commands.
! terminal speed is a top-level command and requires read-debug privilege.
! The no form of this command sets the maximum terminal speed to the default of 128.
Syntax terminal speed <speed>
no terminal speed
Definitions
Examples GX$root# terminal speed 200
Set the maximum debug message output speed to 200 characters per second for the current session.
Related Commands debug cable clear logdebug cable interface cabledebug cable mac-addressterminal monitor
We recommend that the debug message output speed be set conservatively for a console session to ensure that the performance of the CMTS is not severely impacted (Telnet sessions are not subject to this restriction). The appropriate maximum value to use is dependent on your particular environment.
speed The maximum debug message output speed in characters per second. There is no range checking performed on this parameter. A value of 0 sets the speed to the default (128).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
tftp
211
tftp
This command uses TFTP (Trivial File Transfer Protocol) to copy a file from the specified server to the CMTS (or from the CMTS to the specified server). The current CLI directory is the target directory for any file transfers between the CMTS and the TFTP server.
! tftp is a top-level command and requires read-write privilege.
Syntax tftp get|put <ip-address> <filename>
Definitions
Examples GX$root# tftp get 192.163.25.8 myfile
Copies the file myfile from the TFTP server at IP address 192.163.25.8 to the current directory of the CMTS.
Related Commands ftptelnet
traceroute
This command traces the connection to a given IP address or host name.
! traceroute is a top-level command and is available to all users.
! There is not a no form to this command.
! There are no default settings for this command.
Syntax traceroute {<ip-address>|<host-name>}
Definitions
Examples GX$root# traceroute 192.168.201.104
traceroute to 192.168.201.104 (192.168.201.104), 30 hops max, 38 byte packets
1 192.168.201.104 (192.168.201.104) 0.271 ms
get Copies the file from the server to the current directory of the CMTS.
put Copies the file from the current directory of the CMTS to the server.
ip-address The IP address of the server. Standard dot-quad notation (xxx.xxx.xxx.xxx).
filename The filename to transfer.
ip-address The IP address to be traced. Standard dot-quad notation (xxx.xxx.xxx.xxx).
host-name The host name corresponding to the address to be traced. Include the domain: xxxhost.yyydomain.com.
username
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference212
username
This command sets various values for establishing user access.
! username is a command within the configure terminal mode and requires read-write privilege.
! no username password removes the user’s password (a password is not required for the user).
! no username group privilege removes the user’s privilege from the specified group.
! no username name deletes the user from the CMTS.
! There are no default settings for this command.
Syntax username <name> password <password>
no username <name> password
username <name> group {ad|ip|rf|fs} privilege {rw|rd|ro}
no username <name> group {ad|ip|rf} privilege
username <name> prompt <prompt-string>
no username <name>
Definitions
name The assigned user name for an individual or group.
password The password associated with the user name.
group Command groups:
ad – administration
ip – Network-side interface
rf – HFC network
fs – file system (only fs-rw and fs-ro are valid)
privilege Privilege levels:
rw – read-write
rd – read-debug
ro – read-only
prompt-string Unique prompt string for the user name.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
who
213
Examples GX$root# configure terminal
GX$root(config)# username myname password myword
Define a username myname and assign a password of myword.
GX$root(config)# username myname group rf privilege rw
Assign username myname to the rf group with read-write privilege.
GX$root(config)# username myname prompt myprompt
Assign a prompt of myprompt for username myname. When user myprompt logs in, the prompt will appear as follows:
G10$myprompt(config)#
GX$root(config)# no username myname
Delete username myname from the CMTS.
Related Commands show privilegeshow usernamesshow usersshow whoamiwho
Guidance In the event the password for username root is lost, you can reset the password to the default of changme by performing the following procedure on the console port (not supported within a Telnet session):
1. Reboot the CMTS by issuing the reload command or by power cycling the system.
2. When you see the following messages displayed on the console, type passwordreset:
Waiting for system to start-up ...Waiting for completion of system initialization ...
3. When prompted, log into the CMTS as user root with a password of changeme.
who
This command is a synonym for show users. See show users on page 198 for details.
write memory
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference214
write memory
This command sets the startup-config file to be a duplicate of the current running-config file. Use this command if you are going to reboot the CMTS and want it to reload with the configuration currently in the running-config file. This command produces the same result as the command copy running-config startup-config. The startup-config file is stored in the home directory as Startup.cli.
! write memory is a top-level command and requires read-write privilege.
! There is not a no form of the command.
! There are no parameters for this command.
Examples GX$root# write memory
Copy the running-config file to the startup-config file.
Related Commands copy
••••••••••••••••••••••••••••••••••••••••••••••••
215
Part 2Appendixes
! Login, Prompts, and Keys on page 217
! Configuration Notes on page 219
! Security on page 225
••••••••••••••••••••••••••••••••••••••••••••••••
Login, Prompts, and Keys 217
Appendix ALogin, Prompts, and Keys
This appendix provides information about navigating and general operation of the command line interface (CLI).
Login
Upon initial installation, before user names and passwords have been established, use these factory defaults:
Username: root
Password: changeme
Prompts
The factory default prompt is:
GX$root#
The examples in this manual use this default prompt.
The prompt is derived from the CMTS host name (GX) and the logged in user name (root). Both of these can be changed with the hostname and username commands, respectively.
The last character of the prompt denotes whether you have privileged access (read-write and read-debug) or non-privileged access (read-only):
Privileged access: #
Non-privileged access: >
Login, Prompts, and Keys
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference218
Key Commands
The list of key commands can be displayed by entering the help edit-keys command.
Table 16: Key Commands
Key Command Action
Enter Issue command.
Tab Word completion.
Backspace Erase before cursor. Same as Delete.
Delete Erase before cursor. Same as Backspace.
? List available options (context-sensitive help).
Ctrl-d Delete current character.
Ctrl-u Delete text up to cursor.
Ctrl-k Delete from cursor to end of line.
Ctrl-a Move to the beginning of the line.
Ctrl-e Move to the end of the line.
Ctrl-p Get prior command from buffer.
Ctrl-n Copy next command from buffer.
Ctrl-f Move forward a character.
Ctrl-b Move cursor left.
Ctrl-f Move cursor right.
Ctrl-w Delete word up to cursor.
Ctrl-t Transpose current and previous character.
Ctrl-z Enter command and return to top-level prompt.
Ctrl-l Clear screen, retain command line input.
Ctrl-c Clear current command line input.
Esc-b Move back one word.
Esc-f Move forward one word.
Esc-c Convert rest of word to uppercase.
Esc-l Convert rest of word to lowercase.
Esc-d Delete remainder of word.
••••••••••••••••••••••••••••••••••••••••••••••••
Configuration Notes 219
Appendix BConfiguration Notes
When configuring an interface cable, an interface fastEthernet, or an interface gigaEthernet (G10 CMTS only), you must provide slot and interface numbers. For the interface cable, you must also provide port and channel numbers.
Figure 1 provides the G10 CMTS slot numbering. Table 17 on page 220 provides the G1 CMTS slot numbering. Use these slot numbers for configuration tasks.
Slot Numbers
Figure 1: G10 CMTS Slot Numbering
DOCSIS Module
DOCSIS Module
DOCSIS Module
DOCSIS Module
DOCSIS Module
DOCSIS Module
DOCSIS Module
DOCSIS Module
NIC Module
Chassis Control Module
Chassis Control Module
HFC Connector Module
HFC Connector Module
HFC Connector Module
HFC Connector Module
HFC Connector Module
HFC Connector Module
HFC Connector Module
HFC Connector Module
CHASSISTOP VIEW
Midplane
Fro
ntR
ear
NIC Access Module 5
6
4
3
2
1
7
8
9
10
11
12
13
with logical slot numbers
NIC Module
NIC Access Module
CCM Access Module
CCM Access Module
Configuration Notes
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference220
Table 17: G1 CMTS Slot Numbering
Interface, Port, and Channel Numbers
Interface
A cable interface is a logical entity that consists of at least one upstream and one downstream port. A cable interface is the same as a MAC domain.
On the G10 CMTS, the traffic through even numbered cable interfaces (0 and 2) is forwarded through the Ethernet port 0 on the HFC Connector Module, while traffic through odd numbered cable interfaces (1 and 3) is forwarded through the Ethernet port 1 on the HFC Connector Module. This relationship is summarized in Table 18.
The traffic through both cable interfaces (0 and 1) is forwarded through the Ethernet port labeled DATA on the G1 CMTS. This relationship is summarized in Table 19.
Table 18: G10 CMTS Cable Interface to Ethernet Port Association
Table 19: G1 CMTS Cable Interface to Ethernet Port Association
Interface is also used describe the Fast Ethernet and the Gigabit Ethernet ports, which are also configurable. Here, the interface number is the port number.
Port
A port is a physical connector. Use the numerical part of the connector label for the port ID during configuration tasks. See Figure 2 on page 223 to view the ports on the HFC Connector Module and the Chassis Control Module of a G10 CMTS. See Figure 3 on page 224 to view the ports on the rear of the G1 CMTS.
Slot Module
1 Chassis Control Module
2 DOCSIS Module
Cable Interface Associated Ethernet Port
0 Eth0
1 Eth1
2 Eth0
3 Eth1
Cable Interface Associated Ethernet Port
0 DATA
1
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Configuration Notes 221
Configuration Notes
Channel
A channel is a logical entity. On the G10 CMTS, there are four downstream channels and 8 or 16 upstream channels (depending on the DOCSIS Module model) routed through each HFC Connector Module / DOCSIS Module pair. Downstream channels are assigned one-each to the DS ports and are enumerated 0 – 3. Upstream channels can be assigned to any US port and are enumerated 0 – 7 or 0 – 15, depending on the DOCSIS Module model.
On the G1 CMTS, there are two downstream channels and eight upstream channels. Downstream channels are assigned one-each to the DS ports and are enumerated 0 – 1. Upstream channels can be assigned to any US port and are enumerated 0 – 7.
Defaults
Table 20 through Table 24 summarize the various assignments described above. Note that the downstream and upstream channel to cable interface assignments and the upstream channel to upstream port assignments specified in these tables are the factory defaults, and can be changed through the CLI or the startup-config file. The default assignments are used if the startup-config file does not assign any downstream or upstream channels to a MAC domain.
Table 20: G10 CMTS Downstream Channel Assignment
Table 21: G10 CMTS Upstream Channel Assignment (8 Channels)
Cable Interface Downstream Channel Downstream Port
0 0 DS 0
1 1 DS 1
2 2 DS 2
3 3 DS 3
Cable Interface Upstream Channel Upstream Port
0 0 US 0
1
1 2 US 1
3
2 4 US 2
5
3 6 US 3
7
Configuration Notes
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference222
Table 22: G10 CMTS Upstream Channel Assignment (16 Channels)
Table 23: G1 CMTS Downstream Channel Assignment
Table 24: G1 CMTS Upstream Channel Assignment
Cable Interface Upstream Channel Upstream Port
0
0
US01
8
9
1
2
US13
10
11
2
4
US25
12
13
3
6
US37
14
15
Cable Interface Downstream Channel Downstream Port
0 0 DS 0
1 1 DS 1
Cable Interface Upstream Channel Upstream Port
0
0 US 0
1
4 US 2
5
1
2 US 1
3
6 US 3
7
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Configuration Notes 223
Configuration Notes
Figure 2: HFC Connector Module and Chassis Control Module
Eth0
Eth1
US 3
US 2
US 1
US 0
DS 3
DS 2
DS 1
DS 0
Eth0
HFC Connector Module Chassis Control Module
Configuration Notes
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference224
Figure 3: G1 CMTS Rear Ports
••••••••••••••••••••••••••••••••••••••••••••••••
Security 225
Appendix CSecurity
This appendix describes the groups and privileges used to implement security and user access in the Command Line Interface (CLI).
Access to CLI commands is granted to users based on their assigned group and privilege. This matrix is shown in Table 25.
Table 25: Group/Privilege Matrix
Groups
Groups are associated with commands in the following manner:
IP – Those commands that relate to network-side functions. Examples are Ethernet port and IP configuration.
RF – Those commands that relate to hybrid fiber/coax-side functions. Examples are interface cable configuration and modulation profile set-up.
AD – Those commands limited to basic administration functions.
FS – Those commands limited to functions that affect the file system.
Some commands belong to multiple groups.
Group RW (Read-Write) RD (Read-Debug) RO (Read-Only)
IP (Network Side) ip-rw ip-rd ip-ro
RF (HFC Side) rf-rw rf-rd rf-ro
AD (Administration) ad-rw ad-rd ad-ro
FS (File System) fs-rw — fs-ro
Security
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI Reference226
Privileges
Each command in the CLI is associated with all the privileges that may be needed to operate that command as follows:
RW – Read-write allows a user to obtain a display from a command, and to input parameters to the command.
RD – Read-debug allows access to the series of debug commands. It also limits access to some of the show commands.
RO – Read-only allows a user to obtain a display from a command.
The three categories of privileges are hierarchical and provided in Table 26.
Table 26: Hierarchy of Privileges
Commands
Each command in the CLI hierarchy of commands has one or more group-privileges associated with it. You cannot change this association. See “Command Summary” on page 3 for associations, which are shown with abbreviations such as ip-ro, rf-rw, and so forth.
Users
Each user can be assigned to multiple groups and privileges with the username command:
username <name> group {ad|ip|rf|fs} privilege {rw|ro|rd}
root is a username built in to the CMTS that is assigned to all group-privileges.
A user that is not assigned to a group has access to a limited set of commands (see those commands that have a group of all in the “Command Summary” on page 3).
This Level Can Also Access This Level
RW RD, RO
RD RO
RO —