juniper networks g-series cmts · juniper networks g-series cmts cli and snmp reference ... about...
TRANSCRIPT
Juniper Networks, Inc.
1194 North Mathilda Avenue
Sunnyvale, CA 94089
USA
408-745-2000
www.juniper.net
Part Number: 530-008685-01, Revision 1
Juniper NetworksG-series CMTS
CLI and SNMP 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 and SNMP ReferenceCopyright © 2002, Juniper Networks, Inc.All rights reserved. Printed in USA.
Writer: Jerry Isaac, Jim Stauffer, Dervinn CaldwellEditor: Stella HackellIllustrations: Paul GilmanCovers and template design: Edmonds Design
Revision History6 December 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 ................................................................................................................xvOrganization .........................................................................................................xvDocument Conventions ....................................................................................... xvi
Notes, Cautions, and Warnings.....................................................................xviG-series CMTS Document Set.............................................................................. xvii
Part 1CLI Commands
Chapter 1Command Summary ................................................................................................3
Chapter 2Command Listing ....................................................................................................13
add-to ...................................................................................................................14alias ......................................................................................................................15arp........................................................................................................................16arp timeout...........................................................................................................17auto-negotiation....................................................................................................18banner exec..........................................................................................................19banner incoming ..................................................................................................20banner login .........................................................................................................21banner motd.........................................................................................................22banner show.........................................................................................................23billing enable ........................................................................................................23broadcast..............................................................................................................24cable address-verification .....................................................................................24cable aligned-insertion-interval .............................................................................25cable allow-non-ip-traffic.......................................................................................26cable arp-verify .....................................................................................................27cable authorize .....................................................................................................29cable broadcast-domain........................................................................................30cable dhcp-giaddr .................................................................................................31cable downstream add..........................................................................................33cable downstream admission-control-policy .........................................................34cable downstream channel-width .........................................................................35cable downstream congestion-control-policy ........................................................36
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Referenceiv
cable downstream description..............................................................................37cable downstream frequency................................................................................38cable downstream igmp-multicast-group ..............................................................39cable downstream interleave-depth ......................................................................40cable downstream modulation .............................................................................41cable downstream rf-power ..................................................................................42cable downstream service-class ............................................................................43cable downstream show.......................................................................................44cable downstream shutdown................................................................................45cable downstream traffic-scheduling-policy ..........................................................46cable drop-unverifiable-addresses.........................................................................47cable filter group...................................................................................................48cable filter show ...................................................................................................50cable helper-address .............................................................................................51cable host downstream-filter default-group...........................................................52cable host upstream-filter default-group................................................................53cable insertion-interval .........................................................................................54cable ip-broadcast-echo ........................................................................................55cable ip-multicast-echo .........................................................................................55cable llc-filter index ..............................................................................................56cable llc-filter show...............................................................................................57cable llc-filter unmatched-action ...........................................................................58cable log-invalid-addresses ...................................................................................59cable log-unverifiable-addresses ...........................................................................60cable mac-rewrite .................................................................................................61cable modem downstream-filter default-group .....................................................63cable modem event-enable...................................................................................64cable modem flap-list ...........................................................................................65cable modem snmp-community...........................................................................68cable modem upstream-filter default-group ..........................................................69cable modem-config-file .......................................................................................70cable modulation-profile .......................................................................................76cable multicast-map..............................................................................................78cable noise-cancellation........................................................................................79cable policy admission-control..............................................................................80cable policy congestion-control.............................................................................81cable policy traffic-scheduling...............................................................................82cable privacy ........................................................................................................83cable privacy check-cert-validity-periods...............................................................84cable privacy kek life-time ....................................................................................85cable privacy tek life-time.....................................................................................85cable privacy trust-self-signed-cert ........................................................................86cable proxy-arp.....................................................................................................87cable ranging-attempts .........................................................................................89cable relay-agent-option .......................................................................................90cable rogue-modem..............................................................................................91cable security-association .....................................................................................93cable service-class ................................................................................................94cable shared-secret ...............................................................................................95cable show............................................................................................................96cable source-verify................................................................................................97cable subscriber-group..........................................................................................99cable sync-interval ..............................................................................................100cable ucd-interval ...............................................................................................101cable upstream add ............................................................................................102cable upstream admission-control-policy............................................................103cable upstream channel-hopping ........................................................................104
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Table of Contents v
cable upstream channel-width ............................................................................105cable upstream concatenation ............................................................................106cable upstream congestion-control-policy ...........................................................107cable upstream data-backoff ...............................................................................108cable upstream description.................................................................................110cable upstream frequency...................................................................................111cable upstream min-power-level .........................................................................112cable upstream minislot-size...............................................................................113cable upstream modem flap-list..........................................................................114cable upstream modulation-control ....................................................................116cable upstream modulation-profile .....................................................................117cable upstream port............................................................................................118cable upstream power-level ................................................................................120cable upstream range-backoff .............................................................................121cable upstream show ..........................................................................................122cable upstream shutdown...................................................................................123cable upstream traffic-scheduling-policy .............................................................124cable upstream width-control .............................................................................125cable upstream-load-balance...............................................................................126cable upstream-min-power-level .........................................................................127cable upstream-port spare ..................................................................................128cable upstream-pre-equalization .........................................................................129cable vpn ............................................................................................................130cable vpn-description..........................................................................................131cable vpn-service-class........................................................................................132cat ......................................................................................................................132cd .......................................................................................................................133change-password ................................................................................................133chassis environment ambient-temperature.........................................................134chassis port description ......................................................................................135clear aborted-modems........................................................................................136clear alarms ........................................................................................................137clear arp .............................................................................................................138clear arp-cache....................................................................................................139clear cable modem cpe.......................................................................................139clear cable modem flap-list .................................................................................140clear cable modem phy-statistics ........................................................................141clear cable modem ranging-statistics ..................................................................142clear cable modem reset.....................................................................................143clear cable rogue-modem....................................................................................143clear forwarding-table .........................................................................................144clear interfaces cable forwarding-table................................................................144clear ip multicast-group ......................................................................................145clear local-log......................................................................................................146clear local-nv-log .................................................................................................146clock ...................................................................................................................147clock ntp-server ..................................................................................................148clock show..........................................................................................................149clock summer-time .............................................................................................150clock timezone....................................................................................................152configure memory ..............................................................................................152configure terminal ..............................................................................................153copy....................................................................................................................153cpe-controlled-cable-modem...............................................................................155debug..................................................................................................................156debug cable ........................................................................................................156debug cable arp ..................................................................................................157
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Referencevi
debug cable bpkm ..............................................................................................158debug cable bwr .................................................................................................158debug cable clear filter........................................................................................159debug cable clear log ..........................................................................................159debug cable dcc..................................................................................................160debug cable dci...................................................................................................161debug cable dhcp................................................................................................162debug cable dynsrv.............................................................................................164debug cable icmp ...............................................................................................165debug cable interface cable ................................................................................166debug cable mac-address....................................................................................168debug cable mac-protocol...................................................................................169debug cable map ................................................................................................170debug cable range ..............................................................................................171debug cable registration .....................................................................................172debug cable ucc ..................................................................................................173debug cable ucd..................................................................................................174debug cable updis...............................................................................................175debug log-to-console...........................................................................................175delete .................................................................................................................176description..........................................................................................................177dhcp-giaddr ........................................................................................................177dir.......................................................................................................................178disable ................................................................................................................178duplex ................................................................................................................179edit .....................................................................................................................179enable.................................................................................................................180encryption-algorithm ..........................................................................................180erase startup-config ............................................................................................181exit .....................................................................................................................181ftp.......................................................................................................................182help ....................................................................................................................183helper-address ....................................................................................................184history ................................................................................................................184hostname ...........................................................................................................185interface aggEthernet .........................................................................................186interface cable ....................................................................................................187interface fastEthernet .........................................................................................188interface gigaEthernet.........................................................................................189interface loopback ..............................................................................................190ip address ...........................................................................................................191ip default-gateway ..............................................................................................192ip domain-name .................................................................................................192ip ftp-enable .......................................................................................................193ip igmp enable....................................................................................................194ip igmp membership-interval .............................................................................195ip name-server ...................................................................................................196ip show...............................................................................................................196ip ssh-enable.......................................................................................................197ip telnet-enable...................................................................................................198ip-multicast.........................................................................................................198kill ......................................................................................................................199log-level generate................................................................................................200log-level set-default-all ........................................................................................202log-level show.....................................................................................................202logout .................................................................................................................203ls ........................................................................................................................203
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Table of Contents vii
maximum-latency...............................................................................................204maximum-sustained-traffic-rate ..........................................................................204maximum-traffic-burst........................................................................................205minimum-reserved-traffic-rate ............................................................................205maximum-rate-enforcement ...............................................................................206minimum-links ...................................................................................................207mkdir..................................................................................................................208more...................................................................................................................208multicast-auth modem........................................................................................209ping ....................................................................................................................210port-selection ......................................................................................................212pwd ....................................................................................................................213radius-server host ...............................................................................................214real-time-jitter minimum.....................................................................................215red drop-profile...................................................................................................216red latency max..................................................................................................217relay-agent-option...............................................................................................217reload .................................................................................................................218remote-authentication.........................................................................................219rename ...............................................................................................................220request chassis ccm billing-sync-primary ............................................................221request chassis ccm config-sync-primary............................................................222request chassis ccm remind-to-replace ...............................................................223request chassis ccm standby-ccm synchronize ...................................................224request chassis ccm switch-to-standby................................................................225reservation minimum-rate-traffic ........................................................................226reset-slot .............................................................................................................227rmdir ..................................................................................................................227security-association.............................................................................................228service-class........................................................................................................229session timeout...................................................................................................230show cable address-verification ..........................................................................231show cable flap-list .............................................................................................232show cable modem.............................................................................................235show cable modem connectivity.........................................................................239show cable modem counters ..............................................................................241show cable modem cpe ......................................................................................243show cable modem errors ..................................................................................245show cable modem flap......................................................................................247show cable modem offline..................................................................................248show cable modem phy......................................................................................249show cable modem qos-profile ...........................................................................251show cable modem ranging-statistics .................................................................252show cable modem registered ............................................................................254show cable modem remote-query ......................................................................255show cable modem rogue...................................................................................257show cable modem unregistered ........................................................................258show cable modem verbose ...............................................................................259show cable modulation-profile ............................................................................260show cable multicast-auths .................................................................................261show cable multicast-maps .................................................................................262show cable qos profile ........................................................................................262show cable security-associations.........................................................................263show cable shared-secret ....................................................................................263show cable vpn...................................................................................................264show chassis ccm pending switch-over...............................................................265show chassis environment..................................................................................266
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Referenceviii
show chassis hardware.......................................................................................267show clock..........................................................................................................267show configuration .............................................................................................268show controller cable..........................................................................................268show cpu ............................................................................................................270show debugging..................................................................................................271show disk ...........................................................................................................271show history .......................................................................................................272show interfaces ..................................................................................................273show ip arp.........................................................................................................275show ip multicast-group......................................................................................276show local-log .....................................................................................................277show local-nv-log ................................................................................................278show memory ....................................................................................................279show privilege ....................................................................................................279show running-config ...........................................................................................280show startup-config ............................................................................................281show tech-support ..............................................................................................282show upgrade-log ...............................................................................................284show usernames.................................................................................................284show users..........................................................................................................285show version ......................................................................................................285show whoami .....................................................................................................286show working-config ..........................................................................................287shutdown............................................................................................................289snmp-server community.....................................................................................290snmp-server enable traps docsis-cmts ................................................................291snmp-server enable traps vendor-cmts...............................................................292snmp-server host................................................................................................293speed..................................................................................................................294syslog-server.......................................................................................................295system................................................................................................................296system apply ......................................................................................................297system auto-rollback...........................................................................................299system commit...................................................................................................299system config-backup .........................................................................................300system config-restore .........................................................................................300tacacs-server host ...............................................................................................301telnet ..................................................................................................................302terminal monitor ................................................................................................302terminal page-mode ...........................................................................................303terminal speed....................................................................................................303tftp .....................................................................................................................304traceroute ...........................................................................................................304traffic-class .........................................................................................................305traffic-priority .....................................................................................................306trap-syslog-throttle admin-status.........................................................................307trap-syslog-throttle interval .................................................................................308trap-syslog-throttle threshold ..............................................................................309type ....................................................................................................................310username ...........................................................................................................311vendor-events-enable .........................................................................................313who ....................................................................................................................313write memory.....................................................................................................313
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Table of Contents ix
Part 2SNMP Overview and Specification
Chapter 3Management Architecture Overview.......................................................317
CMTS SNMP Support ...................................................................................319CMTS MIB Categories ..................................................................................319
Chapter 4Standard MIB Specification ..........................................................................321
CMTS Standard MIB Support...............................................................................321Support of Optional MIB Objects.........................................................................322
IF-MIB Object Support .................................................................................322DOCS-CABLE-DEVICE-MIB Object Support...................................................323DOCS-QOS-MIB Object Support ...................................................................323
Chapter 5Enterprise MIB Specification .......................................................................325
Module pacificBroadband ...................................................................................325Objects Beneath Object pbcRegs .................................................................327Objects Beneath Object pbcManagement ....................................................328Objects Beneath Object pbcProducts ...........................................................328Objects Beneath Object pbcCaps .................................................................328
Part 3Appendixes
Appendix ALogin, Prompts, and Keys ...............................................................................331
Login...................................................................................................................331Prompts..............................................................................................................331Key Commands ..................................................................................................332
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Referencex
Appendix BConfiguration Notes...........................................................................................333
Slot Numbers......................................................................................................333Interface, Port, and Channel Numbers................................................................334
Interface......................................................................................................334Port .............................................................................................................334Channel .......................................................................................................335Defaults .......................................................................................................335
Appendix CSecurity ......................................................................................................................339
Groups................................................................................................................339Privileges ............................................................................................................340Commands .........................................................................................................340Users ..................................................................................................................340Remote User Authentication...............................................................................340
Part 4Index
••••••••••••••••••••••••••••••••••••••••••••••••
List of Figures xi
List of FiguresList of Figures
Figure 1: CMTS Management Architecture ......................................................318Figure 2: Hierarchy of Module pacificBroadband ............................................326Figure 3: G10 CMTS Slot Numbering ...............................................................333Figure 4: HFC Connector Module and Chassis Control Module ........................337Figure 5: G1 CMTS Rear Ports..........................................................................338
List of Figures
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Referencexii
••••••••••••••••••••••••••••••••••••••••••••••••
List of Tables xiii
List of TablesList of Tables
Table 1: Document Conventions .....................................................................xviTable 2: Command Summary ............................................................................3Table 3: Interleaver Depth Parameters .............................................................40Table 4: CM Configuration File TLV Type Names..............................................70Table 5: Event Priority Correspondence to CCM LEDs....................................137Table 6: Default Event Priority Logging and Reporting Assignment ................200Table 7: Flap-list Statistics ..............................................................................234Table 8: Parameters Displayed by ‘show cable modem’.................................237Table 9: Description of Online States .............................................................237Table 10: Description of CM Operational States ...............................................238Table 11: Parameters Displayed by ‘show cable modem connectivity’.............240Table 12: Parameters Displayed by ‘show cable modem counters’ ..................242Table 13: Parameters Displayed by ‘show cable modem cpe’ ..........................244Table 14: Parameters Displayed by ‘show cable modem errors’ ......................246Table 15: Parameters Displayed by ‘show cable modem phy’..........................250Table 16: Parameters Displayed by ‘show cable modem qos-profile’ ...............251Table 17: Parameters Displayed by ‘show cable modem ranging-statistics’ .....253Table 18: Parameters Displayed by ‘show cable multicast-maps’ .....................262Table 19: Parameters Displayed by ‘show cable security-associations’.............263Table 20: Parameters Displayed by ‘show interfaces cable forwarding-table’ ...275Table 21: Local Event Log Headings Displayed.................................................277Table 22: Local Event Log Headings Displayed.................................................278Table 23: CMTS SNMP-Related IETF RFCs Supported .......................................319Table 24: CMTS Standard MIBs Supported .......................................................321Table 25: Objects Beneath Module pacificBroadband .......................................327Table 26: Objects Beneath Module pbcManagement ........................................328Table 27: Objects Beneath Module pbcCaps .....................................................328Table 28: Key Commands ................................................................................332Table 29: G1 CMTS Slot Numbering .................................................................334Table 30: G10 CMTS Cable Interface to Ethernet Port Association....................334Table 31: G1 CMTS Cable Interface to Ethernet Port Association......................334Table 32: G10 CMTS Downstream Channel Assignment...................................335Table 33: G10 CMTS Upstream Channel Assignment (8 Channels) ...................335Table 34: G10 CMTS Upstream Channel Assignment (16 Channels) .................336Table 35: G1 CMTS Downstream Channel Assignment.....................................336Table 36: G1 CMTS Upstream Channel Assignment .........................................336Table 37: Group/Privilege Matrix......................................................................339Table 38: Hierarchy of Privileges......................................................................340
List of Tables
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Referencexiv
••••••••••••••••••••••••••••••••••••••••••••••••
About This Manual xv
About This Manual
This section describes important information about the design of this document.
Purpose
The purpose of this document, G-series CMTS CLI and SNMP Reference, is to provide detailed information on accessing a G-series Cable Modem Termination System (CMTS) through the command-line interface (CLI) and through the simple network management protocol (SNMP).
This reference manual lists all CLI commands and describes syntax, parameters, and other guidance to facilitate their use. Instructions to perform specific tasks with these commands are described in the Installation and Operation manuals.
Standard and enterprise management information base (MIB) support within a G-series CMTS is also provided. With respect to the SNMP and MIB requirements specified by the Data Over Cable Service Interface Specifications (DOCSIS), this particular revision of the G-series CMTS CLI and SNMP Reference specifies those requirements as defined by DOCSIS version 1.1.
The intended audience for this information is the technicians and engineers who install, configure, operate, and maintain a G-series CMTS, as well as network management application developers and network operators.
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.
! Chapter 3, “Management Architecture Overview”—Provides a general overview of network management with respect to a CMTS. This chapter also specifies the SNMP-related support provided by the CMTS.
! Chapter 4, “Standard MIB Specification”—Specifies the standard MIBs supported by the CMTS as required by DOCSIS 1.1.
! Chapter 5, “Enterprise MIB Specification”—Specifies the enterprise MIBs supported by the CMTS.
Document Conventions
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Referencexvi
! 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
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 xvii
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 and SNMP Reference
Document Conventions
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Referencexviii
••••••••••••••••••••••••••••••••••••••••••••••••
1
Part 1CLI Commands
! Command Summary on page 3
! Command Listing on page 13
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference2
••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 3
Chapter 1Command Summary
Table 2 lists all the CLI commands in hierarchical structure. Commands that apply only to the G10 CMTS are noted.
The Group–Privilege column shows 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 has a group of grp. A command that can be issued by all users, including users not assigned to a group, has 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>
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 <ip-address> | <mac-address> | [cable <slot/if>] | [broadcast-domain <domain-id>] | [cable vpn <vpn-id>]
ip-rw clear arp-cache
rf-rw clear cable modem {<ip-address> | <mac-address>} cpe
rf-rw clear cable modem [<mac-address>] flap-list
rf-rw clear cable modem [<ip-address> | <mac-address>] phy-statistics
rf-rw clear cable modem <slot/if> [upstream <channel>] phy-statistics
rf-rw clear cable modem [<ip-address> | <mac-address>] ranging-statistics
rf-rw clear cable modem <slot/if> [upstream <channel>] ranging-statistics
rf-rw clear cable modem {<ip-address> | <mac-address>} reset
rf-rw clear cable rogue-modem
ip-rw clear forwarding-table [<mac-address> | [broadcast-domain <domain-id>] | [cable vpn <vpn-id>]]
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference4
ip-rw clear interfaces cable <slot/if> forwarding-table
ip-rw clear ip multicast-group [<ip-address>] | [cable <slot/if> [downstream <channel>]]
ad-rw clear local-log
ad-rw clear local-nv-log
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>
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
ad-rw billing enable
ip-rw cable address-verification <ip-address> <mac-address>
rf-rw cable aligned-insertion-interval <interval>
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 mac-rewrite
ip-rw cable modem downstream-filter default-group <pkt-filter-grp>
rf-rw cable modem event-enable [registration | de-ranging]
rf-rw cable modem flap-list snr-threshold <snr-threshold>
rf-rw cable modem flap-list snr-qpsk-threshold <snr-qpsk-threshold>
rf-rw cable modem flap-list snr-16qam-threshold <snr-16qam-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 frequency-adjust-threshold <frequency-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>
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 5
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
rf-rw cable modem flap-list event-enable
rf-rw cable modem snmp-community <“community-string”> [ro | rw]
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 multicast-map <name>
rf-rw ip-multicast <ip-address> <mask>
rf-rw security-association <sa-name>
rf-rw service-class <class-name>
rf-rw cable noise-cancellation
rf-rw cable policy admission-control <policy-name>
rf-rw real-time-jitter minimum <jitter> [enforce]
rf-rw reservation minimum-rate-traffic <percent>
rf-rw cable policy congestion-control <policy-name>
rf-rw red drop-profile <fill-percentage>/<drop-probability> [<fill-percentage>/<drop-probability> ... <fill-percentage>/<drop-probability>]
rf-rw red latency max <latency>
rf-rw cable policy traffic-scheduling <policy-name>
rf-rw maximum-rate-enforcement {drop | shape}
rf-rw traffic-class {minimum-rate | best-effort} scheduling-discipline {fifo | strict-priority}
rf-rw cable rogue-modem {declare <mac-address>} | require-dhcp-tftp | {im-flap-threshold <im-flap-threshold>} | {access-denied-threshold <access-denied-threshold>} | {config-file <filename> [tftp-server <ip-address>]}
rf-rw cable security-association <sa-name>
rf-rw encryption-algorithm {des56cbc | des40cbc}
rf-rw multicast-auth modem <mac-address>
rf-rw type {dynamic | static}
rf-rw cable service-class <class-name>
rf-rw maximum-latency <latency>
rf-rw maximum-sustained-traffic-rate <rate>
rf-rw maximum-traffic-burst <size>
rf-rw minimum-reserved-traffic-rate <rate>
rf-rw traffic-priority <priority>
rf-rw cable shared-secret <secret-string> [encrypted]
rf-rw cable shared-secret show
ip-rw cable source-verify [DHCP]
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference6
rf-rw cable upstream-load-balance
rf-rw cable upstream-min-power-level <power-level>
rf-rw cable upstream-port slot <slot> port <port> spare <spare-id> center-frequency <frequency> width <width>
rf-rw cable upstream-pre-equalization
ip-rw cable vpn <mac-address> <vpn-id>
ip-rw cable vpn-description <vpn-id> <“description-string“>
rf-rw cable vpn-service-class <vpn-id> <class-name>
ad-rw chassis environment ambient-temperature {user-high-threshold <high-threshold>} | {user-low-threshold <low-threshold>}
ad-rw chassis port {cable downstream | cable upstream | fastEthernet | gigaEthernet} slot <slot> port <port> description <“description-string”>
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
ip-rw interface aggEthernet <link> (G10 CMTS only)
ip-rw description
ip-rw minimum-links <number>
ip-rw port-selection [src-mac-address | dest-mac-address | src-dest-mac-address | src-ip-address | dest-ip-address | src-dest-ip-address] (G10 CMTS only)
ip-rw shutdown
grp-rw interface cable <slot/if>
ip-rw cable allow-non-ip-traffic
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> addmission-control-policy <policy-name>
rf-rw cable downstream <channel> channel-width
rf-rw cable downstream <channel> congestion-control-policy <policy-name>
ad-rw cable downstream <channel> description <“description-string”>
rf-rw cable downstream <channel> frequency <frequency>
ip-rw cable downstream <channel> igmp-multicast-group <ip-address> [<end-ip-address>]
rf-rw cable downstream <channel> interleave-depth {8 | 16 | 32 | 64 | 128}
rf-rw cable downstream <channel> minimum-reserved-rate <percent>
rf-rw cable downstream <channel> modulation {64qam | 256qam}
rf-rw cable downstream <channel> rf-power <power-level>
rf-rw cable downstream <channel> service-class <class-name>
rf-rw cable downstream <channel> show
rf-rw cable downstream <channel> shutdown
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 7
rf-rw cable downstream <channel> traffic-scheduling-policy <policy-name>
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
rf-rw cable upstream <channel> addmission-control-policy <policy-name>
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> congestion-control-policy <policy-name>
rf-rw cable upstream <channel> data-backoff <start> <end>
ad-rw cable upstream <channel> description <“description-string”>
rf-rw cable upstream <channel> frequency
rf-rw cable upstream <channel> min-power-level <power-level>
rf-rw cable upstream <channel> minimum-reserved-rate <percent>
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 snr-qpsk-threshold <snr-qpsk-threshold>
rf-rw cable upstream <channel> modem flap-list snr-16qam-threshold <snr-16qam-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 frequency-adjust-threshold <frequency-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
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference8
rf-rw cable upstream <channel> modulation-profile <profile-id>
rf-rw cable upstream <channel> policing {drop | shape}
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> traffic-scheduling-policy <policy-name>
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 add-to aggEthernet <link>
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 add-to aggEthernet <link>
ip-rw description <string>
ip-rw show
ip-rw shutdown
ip-rw interface loopback <slot/0>
ip-rw description <string>
ip-rw ip address <ip-address> <mask> secondary
ip-rw no shutdown
ip-rw ip default-gateway <ip-address> management
ip-rw ip domain-name <domain>
ip-rw ip ftp-enable
ip-rw ip igmp enable
ip-rw ip igmp membership-interval <interval>
ip-rw ip name-server <ip-address>
ip-rw ip show
fs-rw ip ssh-enable
ip-rw ip telnet-enable
ad-rw log-level <level-name> generate [local-log] [local-volatile-log] [syslog] [trap]
ad-rw log-level set-default-all
ad-rw log-level show
ad-rw session timeout <seconds> [console]
ad-rw snmp-server community <community-string> {ro | rw}
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 9
ad-rw snmp-server enable traps docsis-cmts <docsis-trap-class>
ad-rw snmp-server enable traps vendor-cmts <vendor-trap-class>
ad-rw snmp-server host <ip-address> version {1 | 2c} [port <port-number>]
ad-rw snmp-server host show
ad-rw syslog-server <ip-address> | show
ad-rw system
ad-rw radius-server host <ip-address> secret <secret-string> [port <port>] [retry <number>] [timeout <seconds>]
ad-rw remote-authentication {<radius> | <tacacs>} [no-local-fallback]
ad-rw tacacs-server host <ip-address> key <secret-string> [timeout <seconds>] [single-connection]
ad-rw trap-syslog-throttle admin-status {unconstrained | below-threshold | stop-at-threshold | inhibited}
ad-rw trap-syslog-throttle interval <seconds>
ad-rw trap-syslog-throttle threshold <count>
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>
ad-rw vendor-events-enable
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
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference10
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]
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-address> | <hostname>} [[count <count>] | [size <size>] | [interval <interval>] | [ttl <ttl>] | [tos <tos>] | [deadline <deadline>] | record-route | quiet]
all ping [ip] <ip-address>
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 request chassis ccm billing-sync-primary
ad-rw request chassis ccm config-sync-primary
ad-rw request chassis ccm remind-to-replace <minutes>
ad-rw request chassis ccm standby-ccm synchronize
ad-rw request chassis ccm switch-to-standby [[in <seconds>] | [at <time>] | cancel]
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-frequency-adjust]
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Summary 11
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 [vpn:<vpn-id>] [summary [total]]
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] connectivity
all show cable modem <slot/if> [upstream <channel>] connectivity
all show cable modem [<ip-address> | <mac-address> | <slot/if> | vpn:<vpn-id>] counters
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] cpe
all show cable modem <slot/if> [upstream <channel>] cpe
all show cable modem <slot/if> sid <sid> cpe
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] errors
all show cable modem <slot/if> [upstream <channel>] errors
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] flap
all show cable modem <slot/if> [upstream <channel>] flap
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] offline
all show cable modem <slot/if> [upstream <channel>] offline
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] phy
all show cable modem <slot/if> [upstream <channel>] phy
all show cable modem [<slot/if> | vpn:<vpn-id>] qos-profile <qos-profile-id>
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] ranging-statistics
all show cable modem <slot/if> [upstream <channel>] ranging-statistics
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] registered
all show cable modem <slot/if> [upstream <channel>] registered
all show cable modem [<ip-address> | <mac-address> | <slot/if> | vpn:<vpn-id>] remote-query <snmp-entity>
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] rogue
all show cable modem <slot/if> [upstream <channel>] rogue
all show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] unregistered
all show cable modem <slot/if> [upstream <channel>] unregistered
all show cable modem {<ip-address> | <mac-address>} verbose
all show cable modulation-profile [<profile-id> [<iuc>]]
all show cable multicast-auths
all show cable multicast-maps
all show cable qos profile [<qos-profile-id>]
all show cable security-associations
all show cable shared-secret
all show cable vpn <vpn-id>
all show chassis ccm pending switch-over
all show chassis environment
all show chassis hardware [detail]
all show clock
Group –Privilege
Top Level Commands Subordinate Commands
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference12
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 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> forwarding-table
all show interfaces cable <slot/if> sid [<sid>]
all show interfaces aggEthernet <link>
all show interfaces fastEthernet <slot/if>
all show interfaces gigaEthernet <slot/if>
all show ip arp [<ip-address> | <mac-address> | <slot/if>]
ip-rw show ip multicast-group [<ip-address>] | [cable <slot/if>]
all show local-log
all show local-nv-log
all show memory
all show privilege
all show running-config [interface <if-type> <slot/if>]
all show cable security-associations
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 [interface <if-type> <slot/if>]
ad-rw system apply {normal | failsafe | [upgrade [<filename>]]}
ad-rw system auto-rollback
ad-rw system commit
ad-rw system config-backup <filename>
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 13
Chapter 2Command Listing
This chapter lists all the CLI commands in alphabetical order.
All command parameters, both mandatory and optional, must be entered in the exact order specified in the Syntax section of the command description.
add-to
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference14
add-to
Adds (or removes) a general-purpose switched Fast Ethernet port (0–3) or a Gigabit port (0–1) of a NIC Module to the specified aggregate link. This command is entered under the interface fastEthernet or interface gigaEthernet submode. The interface specified when entering the submode implicitly specifies the targeted port of the add-to command.
See the interface aggEthernet command for more information regarding aggregate links.
! add-to is within the interface fastEthernet and interface gigaEthernet submodes and requires ip-rw group-privilege
! no add-to removes the port from the specified aggregate link.
Syntax add-to aggEthernet <link>
no add-to aggEthernet <link>
Definitions
Examples GX$root# configure terminalGX$root(config)# interface gigaEthernet 5/0
GX$root(config-if-g5/0)# add-to aggEthernet 0
GX$root(config-if-g5/0)# exit
GX$root(config)# interface gigaEthernet 9/0
GX$root(config-if-g9/0)# add-to aggEthernet 0
Adds Gigabit port 0 of the NIC Module in slot 5 and Gigabit port 0 of the NIC Module in slot 9 to aggregate link 0.
Related Commands descriptioninterface aggEthernetminimum-linksport-selectionshutdown
This command is applicable only to the G10 CMTS.
link The aggregate link number. Valid range is 0–4.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
alias
15
alias
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.
arp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference16
arp
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 within the configure terminal mode and requires ip-rw group-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 arpclear 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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
arp timeout
17
arp timeout
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 within the configure terminal mode and requires ip-rw group-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 arpclear 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 time out.
auto-negotiation
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference18
auto-negotiation
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.
When auto-negotiation is enabled, the CMTS ignores any previous setting for link speed or duplex setting and tries to negotiate the best possible link speed and duplex setting. When auto-negotiation is disabled, the CMTS leaves the Fast Ethernet link’s speed and duplex setting unchanged. That is, the Fast Ethernet interface continues to operate with the previously negotiated settings until explicitly changed by the operator.
! auto-negotiation is within the interface fastEthernet submode and requires ip-rw group-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.
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
banner exec
19
banner exec
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 within the configure terminal mode and requires ad-rw group-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 is 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 composed of a sequence of text characters.
banner incoming
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference20
banner incoming
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 within the configure terminal mode and requires ad-rw group-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 is 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 composed of a sequence of text characters.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
banner login
21
banner login
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 within the configure terminal mode and requires ad-rw group-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 is 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 composed of a sequence of text characters.
banner motd
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference22
banner motd
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 within the configure terminal mode and requires ad-rw group-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 composed of a sequence of text characters.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
banner show
23
banner show
Used to display the exec, incoming, login, and motd banners.
! banner show is within the configure terminal mode and requires ad-rw group-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
billing enable
Enables the subscriber account management (SAM) billing feature on the CMTS. The Chassis Control Module maintains a billing file (in compressed format) composed of subscriber usage billing records that adhere to the IP detail record (IPDR) standard as extended for XML format cable data systems subscriber usage billing records. In this role, the CMTS acts as the IPDR recorder (IR). Billing records contain packet statistics for each service flow and subscriber.
Billing files cannot be accessed through the CLI. They must be transferred by the FTP or SFTP protocol from an external server by a user with bi-rw and fs-rw group-privilege access.
The name of the billing file is /billing.xml.gz. See the G10 CMTS or G1 CMTS Functional Description for more details regarding subscriber account management.
! billing enable is within the configure terminal mode and requires ad-rw group-privilege.
! no billing enable disables the SAM billing feature.
Syntax billing enable
no billing enable
Examples GX$root# configure terminal
GX$root(config)# billing enable
Enables the SAM billing feature.
broadcast
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference24
broadcast
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.
cable address-verification
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 within the configure terminal mode and requires ip-rw group-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
broadcast-string Specifies the broadcast string.
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable aligned-insertion-interval
25
cable aligned-insertion-interval
Enables the initial maintenance alignment (IMA) feature that ensures initial maintenance opportunities occur at the same time across all upstream channels on a DOCSIS Module. This prevents a CM from attempting initial maintenance during data transmissions on an upstream channel the CM has selected—from an upstream channel descriptor (UCD) message—that is not received by the upstream port on which the CM transmits.
For the G10 CMTS, this command applies to all DOCSIS Modules installed in the chassis. Synchronization of initial maintenance opportunities is aligned for all upstream channels within a DOCSIS Module, but not across all DOCSIS Modules in the chassis.
When IMA is enabled, the interval set by the cable aligned-insertion-interval command overrides the interval set by the cable insertion-interval command. Likewise, when IMA is disabled, the interval set by the cable insertion-interval command overrides the interval set by the cable aligned-insertion-interval command.
! cable aligned-insertion-interval is within the configure terminal mode and requires rf-rw group-privilege.
! no aligned-cable insertion-interval disables IMA.
! IMA is disabled by default.
Syntax cable aligned-insertion-interval <interval>
no cable aligned-insertion-interval
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable aligned-insertion-interval 20
IMA is enabled, and the initial maintenance interval for all CMs supported by the CMTS is set to 200 milliseconds.
Related Commands cable insertion-interval
interval The number of 10-millisecond intervals between initial maintenance opportunities. Range is 10 to 200 (100 milliseconds to 2000 milliseconds).
cable allow-non-ip-traffic
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference26
cable allow-non-ip-traffic
Prevents (or allows) non-IP traffic from being forwarded to the downstream. If the Startup.cli file is not present, the default setting is to prevent non-IP traffic from being forwarded. The current setting is displayed in the running configuration (show running-config command).
! cable allow-non-ip-traffic is within the interface cable submode and requires ip-rw group-privilege.
! no cable allow-non-ip-traffic prevents non-IP traffic from being forwarded (this is the default).
Syntax cable allow-non-ip-traffic
no cable allow-non-ip-traffic
Examples GX$root# cable allow-non-ip-traffic
Allows non-IP traffic to be forwarded in the downstream.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable arp-verify
27
cable arp-verify
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.
Separate address verification tables are created for each data path processor (DPP) on a DOCSIS Module. On the G10 CMTS, one DPP is dedicated to even-numbered cable interfaces (0 and 2) and the other DPP is dedicated to odd-numbered cable interfaces (1 and 3). Therefore, each DOCSIS Module contains two address verification tables—one for even-numbered cable interfaces, and one for odd-numbered cable interfaces. If a CM is moved from one cable interface to another, and the new cable interface is not supported by the same DPP as the original cable interface, multiple entries for the same CM can exist in the address verification tables (until either ARP entry times out). Because the G1 CMTS contains a single DOCSIS Module and a single DPP that supports both of its cable interfaces (0 and 1), multiple entries for the same CM cannot exist in its address verification table.
! cable arp-verify is within the configure terminal mode and requires ip-rw group-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-addresses
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.
cable arp-verify
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference28
cable ip-broadcast-echocable ip-multicast-echocable proxy-arpcable source-verifyclear arpclear arp-cacheshow cable address-verificationshow ip arp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable authorize
29
cable authorize
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 rf-rw group-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 334
The filename parameter must be specified with an absolute path.
cable broadcast-domain
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference30
cable broadcast-domain
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 within the interface cable submode and requires ip-rw group-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–600.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable dhcp-giaddr
31
cable dhcp-giaddr
Used to specify the IP address for a cable interface, and 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 within the interface cable submode and requires ip-rw group-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 submode 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 DHCPGIADDR is used for both cable modems and CPE devices.
cable dhcp-giaddr
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference32
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 is 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 are 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
33
cable downstream add
Adds the given downstream channel to the targeted cable interface.
! cable downstream add is within the interface cable submode and requires rf-rw group-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 333 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
The following guidance applies only to the G10 CMTS:
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.
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.
cable downstream admission-control-policy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference34
cable downstream admission-control-policy
Applies the specified call admission control (CAC) policy name defined by the cable policy admission-control command to the given downstream channel.
! cable downstream admission-control-policy is within the interface cable submode and requires rf-rw group-privilege.
! no cable downstream admission-control-policy deletes the association of the specified policy and the downstream channel.
Syntax cable downstream <channel> admission-control-policy <policy-name>
no cable downstream <channel> admission-control-policy
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable downstream 0 admission-control-policy
<policy-name>
Applies a CAC policy to downstream channel 0 in slot 2 / interface 0.
Related Commands cable policy admission-controlcable upstream admission-control-policyreal-time-jitter minimumreservation minimum-rate-traffic
channel The channel to which the CAC policy is being applied (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.
policy-name The CAC policy name to apply to the given downstream channel.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream channel-width
35
cable downstream channel-width
Sets the channel width for a downstream channel in the targeted slot/interface.
! cable downstream channel-width is within the interface cable submode and requires rf-rw group-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
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).
cable downstream congestion-control-policy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference36
cable downstream congestion-control-policy
Applies the specified congestion control policy name defined by the cable policy congestion-control command to the given downstream channel.
! cable downstream congestion-control-policy is within the interface cable submode and requires rf-rw group-privilege.
! no cable downstream congestion-control-policy deletes the association of the specified policy and the downstream channel.
Syntax cable downstream <channel> congestion-control-policy <policy-name>
no cable downstream <channel> congestion-control-policy
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable downstream 0 congestion-control-policy
<policy-name>
Applies a congestion control policy to downstream channel 0 in slot 2 / interface 0.
Related Commands cable policy congestion-controlcable upstream congestion-control-policyred drop-profilered latency max
channel The channel to which the congestion control policy is being applied (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.
policy-name The congestion control policy name to apply to the given downstream channel.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream description
37
cable downstream description
Assigns a description to a downstream channel on a DOCSIS Module. The description corresponds to the ifAlias object in the ifXTable in the IF-MIB, and is displayed when the show running-config command is issued. A single-character delimiter of " must be used before and after the description if it is greater than one word.
! cable downstream description is within the interface cable submode and requires ad-rw group-privilege.
! no cable downstream description removes the description from the specified channel.
Syntax cable downstream <channel> description <“description-string”>
no cable downstream <channel> description
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable downstream 0 description “DS Channel 0 to Node 4”
Assigns a description of DS Channel 0 to Node 4 to downstream channel 0 in slot 2 / interface 0.
Related Commands cable upstream descriptionchassis port description
channel Channel number to which the description is assigned: 0–3 for the G10 CMTS, 0–1 for the G1 CMTS.
description-string User-defined text string up to 256 characters, enclosed in quotes if more than one word.
cable downstream frequency
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference38
cable downstream frequency
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 within the interface cable submode and requires rf-rw group-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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream igmp-multicast-group
39
cable downstream igmp-multicast-group
Adds static entries to the IGMP multicast group membership table for the specified downstream channel. A single multicast IP address or a range of addresses can be specified. A maximum of 64 static multicast IP addresses are saved for each downstream channel (each IP address within a range is considered a single IP address).
See the ip igmp enable command for more details regarding IGMP snooping.
! cable downstream igmp-multicast-group is within the interface cable submode and requires ip-rw group-privilege.
Syntax cable downstream <channel> igmp-multicast-group <ip-address> [<end-ip-address>]
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable downstream 0 igmp-multicast-group 225.17.18.1
Add a static entry to the IGMP multicast group membership table for downstream channel 0 of slot 2 / interface 1 in the multicast group 225.17.18.1.
GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable downstream 0 igmp-multicast-group 225.17.18.1
225.17.18.10
Add a static entry to the IGMP multicast group membership table for downstream channel 0 of slot 2 / interface 1 in the multicast group range of 225.17.18.1 to 225.17.18.10.
Related Commands cable multicast-mapclear ip multicast-groupip igmp enableip igmp membership-intervalshow ip multicast-group
channel The downstream channel within the cable interface (0–3 for the G10 CMTS, 0–1 for the G1 CMTS).
ip-address The multicast IP address of the multicast group entry. Standard dot-quad notation (xxx.xxx.xxx.xxx).
end-ip-address If specified, a multicast IP address range is implied, where ip-address and end-ip-address are the start and end, respectively, of the range (inclusive). Standard dot-quad notation (xxx.xxx.xxx.xxx).
cable downstream interleave-depth
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference40
cable downstream interleave-depth
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 3 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 3: Interleaver Depth Parameters
! cable downstream interleave-depth is within the interface cable submode and requires rf-rw group-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 3).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream modulation
41
cable downstream modulation
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 within the interface cable submode and requires rf-rw group-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 and SNMP Reference42
cable downstream rf-power
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 within the interface cable submode and requires rf-rw group-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 in 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 service-class
43
cable downstream service-class
Applies the specified service class name defined by the cable policy service-class command to unclassified traffic on the given downstream channel.
! cable downstream service-class is within the interface cable submode and requires rf-rw group-privilege.
! no cable downstream service-class deletes the association of the specified service class and the downstream channel.
Examples of unclassified traffic include:
! Broadcast packets.
! Multicast packets received on the NSI with a multicast group that is not provisioned.
! VLAN tagged traffic received with a VLAN ID that is unknown to the CMTS.
! Unicast packets that are not associated to CMs.
Syntax cable downstream <channel> service-class <class-name>
no cable downstream <channel> service-class
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable downstream 0 service-class <class-name>
Applies a service class to downstream channel 0 in slot 2 / interface 0.
Related Commands cable policy service-class
channel The channel to which the service class is being applied (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.
class-name The service class name to apply to the given downstream channel.
cable downstream show
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference44
cable downstream show
Displays channel performance information for a specific downstream channel in a given slot/interface.
! cable downstream show is within the interface cable submode and requires rf-rw group-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 in 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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable downstream shutdown
45
cable downstream shutdown
Disables a downstream channel in the specified slot/interface.
! cable downstream shutdown is within the interface cable submode and requires rf-rw group-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 is 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.
cable downstream traffic-scheduling-policy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference46
cable downstream traffic-scheduling-policy
Applies the specified traffic scheduling policy name defined by the cable policy traffic-scheduling command to the given downstream channel.
! cable downstream traffic-scheduling-policy is within the interface cable submode and requires rf-rw group-privilege.
! no cable downstream traffic-scheduling-policy deletes the association of the specified policy and the downstream channel.
Syntax cable downstream <channel> traffic-scheduling-policy <policy-name>
no cable downstream <channel> traffic-scheduling-policy
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable downstream 0 traffic-scheduling-policy
<policy-name>
Applies a traffic scheduling policy to downstream channel 0 in slot 2 / interface 0.
Related Commands cable policy traffic-schedulingcable upstream traffic-schedulingmaximum-rate-enforcementtraffic-class
channel The channel to which the traffic scheduling policy is being applied (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.
policy-name The traffic scheduling policy name to apply to the given downstream channel.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable drop-unverifiable-addresses
47
cable drop-unverifiable-addresses
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 within the configure terminal mode and requires ip-rw group-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 arpclear arp-cacheshow cable address-verificationshow ip arp
cable filter group
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference48
cable filter group
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 within the configure terminal mode and requires ip-rw group-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
49
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 and SNMP Reference50
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
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 within the configure terminal mode and requires grp-rw group-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
51
cable helper-address
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 within the interface cable submode and requires ip-rw group-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. When more than one helper address is specified, the CMTS forwards the DHCP broadcast packets to all the destination IP addresses specifed by this command.
! Any DHCP configuration performed at the interface cable submode 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 in slot 2 / interface 1 to the DHCP server at 192.71.25.108. The packet is 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 and SNMP Reference52
cable host downstream-filter default-group
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 within the configure terminal mode and requires ip-rw group-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
53
cable host upstream-filter default-group
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 within the configure terminal mode and requires ip-rw group-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 and SNMP Reference54
cable insertion-interval
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 within the interface cable submode and requires rf-rw group-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 in slot 2 / interface 1 is set to 250 milliseconds.
Related Commands cable aligned-insertion-interval
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-broadcast-echo
55
cable ip-broadcast-echo
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. This command does not affect ARP, DHCP IP broadcast, or any other non-IP packets.
! cable ip-broadcast-echo is within the interface cable submode and requires ip-rw group-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
cable ip-multicast-echo
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 within the interface cable submode and requires ip-rw group-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 and SNMP Reference56
cable llc-filter index
Creates an LLC filter corresponding to the SNMP object docsDevFilterLLCEntry as defined in the DOCS-CABLE-DEVICE-MIB. 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 within the configure terminal mode and requires ip-rw group-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
57
cable llc-filter show
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 within the configure terminal mode and requires ip-rw group-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 and SNMP Reference58
cable llc-filter unmatched-action
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 within the configure terminal mode and requires ip-rw group-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
59
cable log-invalid-addresses
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 within the configure terminal mode and requires ip-rw group-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 arpclear arp-cachelog-level generateshow cable address-verificationshow ip arpshow local-log
cable log-unverifiable-addresses
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference60
cable log-unverifiable-addresses
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 within the configure terminal mode and requires ip-rw group-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 arpclear arp-cachelog-level generateshow cable address-verificationshow ip arpshow local-log
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable mac-rewrite
61
cable mac-rewrite
Enables the Layer 2 MAC rewrite feature. When enabled, the source MAC address of a packet originating from a CM (or a host behind it) that is destined for the network side interface (NSI) is rewritten with the MAC address of the cable interface (MAC domain) in which the CM resides. This reduces the number of MAC addresses seen by a network device to a maximum of four per DOCSIS Module for the G10 CMTS, and two for the G1 CMTS. Accordingly, the destination MAC address of a packet destined for the MAC address of a DOCSIS Module’s cable interface is rewritten with the MAC address of the destination CM (or a host behind it).
The following rules apply to the Layer 2 MAC rewrite feature:
1. If a packet’s ethertype is not IP or ARP, or if the packet is destined for the DOCSIS Module itself (that is, not forwarded), the MAC address is not rewritten.
2. Source MAC address rules:
a. Source MAC addresses are rewritten only for packets arriving from a cable interface in which this feature is enabled. Source MAC addresses of packets arriving from a DOCSIS Module or the NSI are not rewritten.
b. The source MAC address is rewritten with the MAC address of the ingress cable interface. In the case of an ARP packet, the source MAC address within the ARP payload is rewritten.
3. Destination MAC address rules:
a. Destination MAC addresses are rewritten only for unicast packets destined for a DOCSIS Module’s cable interface.
b. If a packet is a DHCP packet, and it is arriving from the NSI, the destination MAC address is written with the contents of the chaddr field in the DHCP payload.
c. If the packet is an IP packet, the destination IP address is looked up in the ARP table. If the lookup is successful, the destination MAC address is rewritten with the lookup result. If the lookup fails, the IP packet is dropped, and an ARP request is initiated for the destination IP address.
d. If the packet is an ARP packet, the target IP address is extracted from the ARP payload and is looked up in the ARP table. If the lookup is successful, the destination MAC address is rewritten with the lookup result, as is the destination address in the ARP payload. If the lookup fails, the IP packet is dropped, and an ARP request is initiated for the destination IP address.
The Layer 2 MAC rewrite feature must not be enabled on a cable interface that contains a routed subscriber network (a network with a router behind a CM) because data loss might occur for hosts located behind the router.
cable mac-rewrite
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference62
4. If ARP proxy is enabled (see the cable proxy-arp command) and the requested IP address is contained in the ARP table, the CMTS responds to ARP requests as follows:
a. If the requesting device is on the NSI or resides in a cable interface that does not have Layer 2 MAC rewrite enabled, the CMTS sends an ARP reply using the MAC address of the device.
b. If the requesting device is on a cable interface that has Layer 2 MAC rewrite enabled, the CMTS sends an ARP reply using the MAC address of the cable interface.
! cable mac-rewrite is within the configure terminal mode and requires ip-rw group-privilege.
! no cable mac-rewrite disables the Layer 2 MAC rewrite feature.
! By default, the Layer 2 MAC rewrite feature is disabled.
Syntax cable mac-rewrite
no cable mac-rewrite
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/1
GX$root(config-if-c2/1)# cable mac-rewrite
Enables the Layer 2 MAC rewrite feature for slot 2 / interface 1.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem downstream-filter default-group
63
cable modem downstream-filter default-group
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 within the configure terminal mode and requires ip-rw group-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 event-enable
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference64
cable modem event-enable
Declares CM registration and de-ranging as vendor-specific events. These events can be logged in the local event log, and can generate trap and syslog messages (see the PBC-CMTS-MIB enterprise MIB and the log-level generate command for details on enabling these).
A registration event occurs when a CM successfully registers with the CMTS.
A de-ranging event occurs when one of the following occurs with a CM that is already registered:
! Ranging fails due to an incorrect power offset.
! Ranging fails due to an invalid timing correction.
! Ranging fails due to an incorrect frequency offset.
! A new initial maintenance response (RNG-RSP) message is received.
Registration and de-ranging events have a priority of information. Use the log-level generate command to specify that information events will generate traps and syslog messages.
! cable modem event-enable is within the configure terminal mode and requires rf-rw group-privilege.
! If an optional parameter is not specified, CM registration and CM de-ranging are considered events.
! If no cable modem event-enable is issued, CM registration and CM de-ranging are not considered events (this is the default setting).
Syntax cable modem event-enable [registration | de-ranging]
no cable modem event-enable [registration | de-ranging]
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable modem event-enable
Specifies that CM registration and de-ranging are events.
Related Commands log-level generatelog-level showshow local-log
registration Specifies that CM registration is an event.
de-ranging Specifies that CM de-ranging is an event.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem flap-list
65
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 within the configure terminal mode and requires rf-rw group-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 to override a global threshold set by the cable modem flap-list command.
Syntax cable modem flap-list {snr-threshold <snr-threshold>} |{snr-qpsk-threshold <snr-qpsk-threshold>} |{snr-16qam-threshold <snr-16qam-threshold>} |{mer-threshold <mer-threshold>} |{cer-threshold <cer-threshold>} |{power-adjust-threshold <power-adjust-threshold>} |{frequency-adjust-threshold <frequency-adjust-threshold>} |{im-retry-interval <im-retry-interval>} |{sm-miss-threshold <sm-miss-threshold>} |{size <size>} |{age-time <days> [<hours> [<minutes>]]} |show |event-enable
no cable modem flap-list [snr-threshold | snr-qpsk-threshold | snr-16qam-threshold | frequency-adjust-threshold | mer-threshold | cer-threshold | power-adjust-threshold | im-retry-interval | sm-miss-threshold | age-time | event-enable]
cable modem flap-list
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference66
Definitions
snr-threshold A flap occurs when the measured SNR of a CM using QPSK or 16QAM modulation drops below this threshold (specified in dB). The valid range is 1–100, and the default is 18 and 24 for QPSK and 16QAM, respectively. The thresholds for QPSK and 16QAM can be changed by using the snr-qpsk-threshold and snr-16qam-threshold parameters, respectively.
snr-qpsk-threshold A flap occurs when the measured SNR of a CM using QPSK modulation drops below this threshold (specified in dB). The valid range is 1–100 and the default is 18.
snr-16qam-threshold A flap occurs when the measured SNR of a CM using 16QAM modulation drops below this threshold (specified in dB). The valid range is 1–100 and the default is 24.
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.
frequency-adjust-threshold A flap occurs when the absolute value of the accumulated sum of all the relative frequency offset corrections sent to a CM, following initial ranging, is greater than or equal to this threshold (specified in Hz). The valid range is 0–10000000 and the default is 0 (disabled).
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.
event-enable By default, a vendor-specific event is generated only when a CM is first added to the flap-list (subsequent flaps for that CM do not generate events). If the event-enable parameter is specified, all flaps generate vendor-specific events, even for a CM that already exists in the flap-list.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem flap-list
67
Examples GX$root# configure terminal
GX$root(config)# cable modem flap-list snr-threshold 20
Sets the SNR threshold for all CMs to 20 dB.
GX$root(config)# cable modem flap-list age-time 0 0 45
Maintains an entry in the flap-list 45 minutes from its last flap.
GX$root(config)# no cable modem flap-list snr-threshold
Restores the SNR threshold for all CMs to its default value.
GX$root(config)# no cable modem flap-list
Restores all thresholds for all CMs to their default values.
GX$root(config)# cable modem flap-list show
Displays the current value of each flap-list parameter.
snrQpsk snrQam16 mer cer im sm padj fadj aging(day hrs mins)
18 24 18 1 180 2 3 0 1 0 0
Related Commands cable upstream modem flap-listclear cable modem flap-listshow cable flap-listshow cable modem flap
Tuning the flap thresholds is recommended to minimize the number of irrelevant entries in the flap-list.
cable modem snmp-community
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference68
cable modem snmp-community
Allows you to configure read and write SNMP community strings for all CMs. Only one read community string and one write community can be configured. If the optional ro and rw parameters are not given, the specified community string is used for the read and the write community strings.
If not configured, the read and write strings default to public and private, respectively.
A single-character delimiter of " must be used before and after the specified community string if the string is greater than one word. The delimiter cannot be used within the body of the string.
! cable modem snmp-community is within the configure terminal mode and requires rf-rw group-privilege.
! no cable modem snmp-community configures the read and write strings to their defaults.
Syntax cable modem snmp-community <“community-string”> [ro | rw]
no cable modem snmp-community [ro | rw]
Definitions
Examples GX$root# cable modem snmp-community myrwpw rw
Configures myrwpw as the write community string for all CMs.
GX$root# no cable modem snmp-community myrwpw rw
Configures the write community string for all CMs to its default of private.
Related Commands show cable modem remote-query
community-string Alphanumeric string that is used for the community string. Maximum length is 31 characters.
ro Specifies the community-string is for the read community string.
rw Specifies the community-string is for the write community string.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem upstream-filter default-group
69
cable modem upstream-filter default-group
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 within the configure terminal mode and requires ip-rw group-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)
cable modem-config-file
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference70
cable modem-config-file
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 4. 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 rf-rw group-privilege (usage of the show parameter requires rf-rd group-privilege).
Table 4: 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
—
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem-config-file
71
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)
cable modem-config-file
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference72
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)
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem-config-file
73
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)
cable modem-config-file
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference74
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modem-config-file
75
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.
cable modulation-profile
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference76
cable modulation-profile
Defines a modulation profile for a specific interval usage code that 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, the p7 parameter is not used.
! cable modulation-profile is within the configure terminal mode and requires rf-rw group-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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable modulation-profile
77
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.
cable multicast-map
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference78
cable multicast-map
Defines an IP multicast map name and enters a submode under the configure terminal mode where you can assign the multicast IP address and mask, and associate a service class (created by the cable service-class command) and a multicast security association (created by the cable security-association command) to the IP multicast map name.
Issue the write memory command to make IP multicast maps persistent across reboots.
! cable multicast-map is within the configure terminal mode and requires rf-rw group-privilege.
! no cable multicast-map deletes the specified IP multicast map.
Syntax cable multicast-map <map-name>
no cable multicast-map <map-name>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable multicast-map <map-name>GX$root(config-cable-mm)#
Defines an IP multicast map name and enters a submode where you can associate a service class and a multicast security association to the IP multicast map name.
Related Commands cable security-associationcable service-classip-multicastsecurity-associationservice-class
map-name The name of the IP multicast map name to create. The name is composed of a sequence of text characters. A single-character delimiter of “ must be used before and after the specified name if the name is greater than one word.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable noise-cancellation
79
cable noise-cancellation
Enables the noise cancellation feature of the Broadband Cable Processor ASIC.
! cable noise-cancellation is within the configure terminal mode and requires rf-rw group-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 policy admission-control
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference80
cable policy admission-control
Defines a call admission control (CAC) policy name and enters a submode under the configure terminal mode where you configure the policy parameters such as real-time minimum jitter and minimum reserved traffic rate.
Issue the write memory command to make the configuration of the CAC policy persistent across reboots.
! cable policy admission-control is within the configure terminal mode and requires rf-rw group-privilege.
! no cable policy admission-control deletes the specified policy.
Syntax cable policy admission-control <policy-name>
no cable policy admission-control <policy-name>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy admission-control <policy-name>GX$root(config-cable-policy-ac)#
Defines a CAC policy name and enters a submode where you configure the policy parameters.
Related Commands cable downstream admission-control-policycable upstream admission-control-policyreal-time-jitter minimumreservation minimum-rate-traffic
policy-name The name of the CAC policy to create. The name is composed of a sequence of text characters. A single-character delimiter of “ must be used before and after the specified name if the name is greater than one word.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable policy congestion-control
81
cable policy congestion-control
Defines a congestion control policy name and enters a submode under the configure terminal mode where you configure the policy parameters.
Issue the write memory command to make the configuration of the congestion control policy persistent across reboots.
! cable policy congestion-control is within the configure terminal mode and requires rf-rw group-privilege.
! no cable policy congestion-control deletes the specified policy.
Syntax cable policy congestion-control <policy-name>
no cable policy congestion-control <policy-name>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy congestion-control <policy-name>GX$root(config-cable-policy-ac)#
Defines a congestion control policy name and enters a submode where you configure the policy parameters.
Related Commands cable downstream congestion-control-policycable upstream congestion-control-policyred drop-profilered latency max
policy-name The name of the CAC policy to create. The name is composed of a sequence of text characters. A single-character delimiter of “ must be used before and after the specified name if the name is greater than one word.
cable policy traffic-scheduling
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference82
cable policy traffic-scheduling
Defines a traffic scheduling policy name and enters a submode under the configure terminal mode where you configure the policy parameters such as the traffic policing algorithm and the traffic class.
Issue the write memory command to make the configuration of the traffic scheduling policy persistent across reboots.
! cable policy traffic-scheduling is within the configure terminal mode and requires rf-rw group-privilege.
! no cable policy traffic-scheduling deletes the specified policy.
Syntax cable policy traffic-scheduling <policy-name>
no cable policy traffic-scheduling <policy-name>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy traffic-scheduling <policy-name>GX$root(config-cable-policy-ts)#
Defines a traffic scheduling policy name and enters a submode where you configure the policy parameters.
Related Commands cable downstream traffic-scheduling-policycable upstream traffic-scheduling-policymaximum-rate-enforcementtraffic-class
policy-name The name of the traffic scheduling policy to create. The name is composed of a sequence of text characters. A single-character delimiter of “ must be used before and after the specified name if the name is greater than one word.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable privacy
83
cable privacy
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 is enabled, disabled, or enforced.
! cable privacy is within the interface cable submode and requires rf-rw group-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 does 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 rejects the REG-REQ message. A CM that attempts to register without privacy enabled is not rejected (due to privacy) during registration.
! cable privacy enforce—Privacy is enforced. If a CM attempts to register without privacy enabled, the CMTS rejects the REG-REQ message. A CM that attempts to register with privacy enabled is not 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 does 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 for privacy is 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 rejects any registrations by CMs in slot 2 / interface 0 that attempt to register without privacy enabled.
Related Commands show cable privacy
cable privacy check-cert-validity-periods
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference84
cable privacy check-cert-validity-periods
Instructs the CMTS to check the validity period or the trust of authentication certificates presented by CMs.
! cable privacy check-cert-validity-periods is within the interface cable submode and requires rf-rw group-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 checks the validity of certificates from CMs in slot 2 / interface 0.
Related Commands cable privacy kek life-timecable privacy tek life-timecable privacy trust-self-signed-cert
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable privacy kek life-time
85
cable privacy kek life-time
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 within the interface cable submode and requires rf-rw group-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 in 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
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 within the interface cable submode and requires rf-rw group-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 in 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.
cable privacy trust-self-signed-cert
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference86
cable privacy trust-self-signed-cert
Sets the default trust of new self-signed manufacturer certificates to trusted.
! cable privacy trust-self-signed-cert is within the interface cable submode and requires rf-rw group-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 in slot 2 / interface 0.
Related Commands cable privacy check-cert-validity-periodscable privacy kek life-timecable privacy tek life-time
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable proxy-arp
87
cable proxy-arp
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 RF 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.
Separate ARP tables are created for each data path processor (DPP) on a DOCSIS Module. On the G10 CMTS, one DPP is dedicated to even-numbered cable interfaces (0 and 2) and the other DPP is dedicated to odd-numbered cable interfaces (1 and 3). Therefore, each DOCSIS Module contains two ARP tables—one for even-numbered cable interfaces, and one for odd-numbered cable interfaces. If a CM is moved from one cable interface to another, and the new cable interface is not supported by the same DPP as the original cable interface, multiple ARP entries for the same CM can exist in the ARP tables (until either ARP entry times out). Because the G1 CMTS contains a single DOCSIS Module and a single DPP that supports both of its cable interfaces (0 and 1), multiple ARP entries for the same CM cannot exist in its ARP table.
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 within the interface cable submode and requires ip-rw group-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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference88
cable proxy-arp gateway
The CMTS responds to all ARP requests from the RF interface (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 a 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 is selected as the gateway. Whenever a DHCPACK message is sent to an RF device, the CMTS sends a gratuitous ARP message to the NSI, using the RF device’s MAC address and newly-acquired IP address. This ensures that NSI ARP cache synchronization occurs whenever an RF device has its IP address renewed by DHCP.
This form of the command disables the rewrite option if it was previously enabled.
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 from the RF interface (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 arpclear 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) are also overwritten with the unicast gateway MAC address when rewrite is enabled. This might cause problems for applications that use IP multicast or broadcast packets.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable ranging-attempts
89
cable ranging-attempts
Sets the number of ranging attempts the CMTS makes 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 within the interface cable submode and requires rf-rw group-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 attempts to range the cable modems in slot 2 / interface 1 twenty-five times before concluding the modem is non-responsive.
number-of-attempts The number of times the CMTS attempts to range a modem. Range of values is 0 through 1024. However, large values should only be used for testing purposes. Select a small value for operation.
cable relay-agent-option
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference90
cable relay-agent-option
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 within the interface cable submode and requires ip-rw group-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 submode 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 in slot 2 / interface 1.
Related Commands cable dhcp-giaddrcable helper-addresscable subscriber-groupdhcp-giaddrhelper-addressrelay-agent-option
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable rogue-modem
91
cable rogue-modem
Defines the conditions for declaring a CM rogue. A CM can be declared as rogue by specifying its MAC address (statically configured), or by matching a specified conditional parameter (dynamically detected) such as require-dhcp-tftp, im-flap-threshold, or access-denied-threshold. In addition, a rogue CM can be forced to use the specified configuration file and TFTP server.
Examples of rogue CM behavior include:
! Unprovisioned CMs that continuously attempt to register.
! CMs that exploit provisioning systems that are weak or that do not use a shared secret for configuration file integrity. Such CMs can register with the CMTS with higher QoS guarantees than the level for which they are provisioned.
! CMs that exhibit misconduct in the use of the network, or are in violation of the network-use policy set by the operator.
The CMTS can allow a rogue CM to register, but all upstream traffic from all CPEs behind the rogue CM is disabled.
! cable rogue-modem is within the configure terminal mode and requires rf-rw group-privilege.
! no cable rogue-modem restores the specified parameter to its default value.
Syntax cable rogue-modem{declare <mac-address>} |require-dhcp-tftp |{im-flap-threshold <im-flap-threshold>} |{access-denied-threshold <access-denied-threshold>} |{config-file <filename> [tftp-server <ip-address>]}
no cable rogue-modem{declare <mac-address>} |require-dhcp-tftp |im-flap-threshold |access-denied-threshold |config-file
Definitions
mac-address The MAC address of the cable modem to be statically declared as rogue, specified as xxxx.xxxx.xxxx in hexadecimal. The no cable rogue-modem declare command resets the rogue CM, which forces it out of the rogue CM status.
require-dhcp-tftp Specifies that a CM is declared rogue if it attempts to transition from the ranging-complete state to the registration-complete state without using DHCP and TFTP for configuration. This is the default.
im-flap-threshold If a CM has attempted im-flap-threshold successive initial maintenance retries without successfully registering, the CM is declared rogue. By default, the value of this parameter is 0, which means this feature is disabled. Disabling this feature does not change the rogue status of a CM that has already been declared rogue. This setting is displayed in the running-config.
cable rogue-modem
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference92
Examples GX$root# configure terminal
GX$root(config)# cable rogue-modem 0000.39BB.AA51
Declares the CM with MAC address 0000.39BB.AA51 rogue.
GX$root# configure terminal
GX$root(config)# cable rogue-modem config-file cfg1 tftp-server 192.168.55.55
The configuration filename and TFTP server IP address in DHCPACK messages to all rogue CMs are overwritten with cfg1 and 192.168.55.55, respectively.
GX$root(config)# cable rogue-modem config-file cfg2
Once the TFTP server IP address has been specified, the configuration filename (cfg2 in this example) can be changed by issuing the command without the optional tftp-server parameter.
GX$root(config)# no cable rogue-modem config-file
Disables the DHCPACK overwrite feature, in which case the configuration filename and the TFTP server IP address for rogue CMs are cleared.
Related Commands cable relay-agent-optionclear cable modem rogueshow cable modem rogue
access-denied-threshold If a CM has been denied access access-denied-threshold successive times without successfully registering (for example, due to a failed MIC check), the CM is declared rogue. By default, the value of this parameter is 0, which means this feature is disabled. Disabling this feature does not change the rogue status of a CM that has already been declared rogue. This setting is displayed in the running-config.
config-file Specifies that all rogue CMs use the configuration file specified by filename. The CMTS overwrites the configuration filename in the DHCPACK message.
filename The filename of the configuration file for rogue CMs.
tftp-server Optional parameter that specifies that all rogue CMs get their configuration file from the TFTP server specified by ip-address. The CMTS overwrites the TFTP server IP address in the DHCPACK message.
ip-address The IP address of the TFTP server for rogue CMs. Standard dot-quad notation (xxx.xxx.xxx.xxx).
When using the DHCPACK overwrite feature for rogue CMs, consider the following:
! The DHCP relay agent option must be enabled (see the cable relay-agent-option and relay-agent-option commands).
! In order to prevent unprovisioned CMs from continually flapping, a configuration file must be used that allows a rogue CM to successfully register.
This feature does not force rogue CMs that do not use DHCP and TFTP for configuration to use the configuration file specified by the config-file parameter.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable security-association
93
cable security-association
Defines a multicast security association name and enters a submode under the configure terminal mode where you can assign the security association to a CM, and change the security association parameters, such as the security association type and the data encryption algorithm (these parameters default to dynamic and des56cbc, respectively, when the security association is initially created). The security association is applied to IP multicast maps by the security-association command under the multicast map submode.
This command creates an entry into the IP multicast mapping table that contains the mapping between multicast groups to multicast security association identifiers (SAIDs). Up to 256 multicast security associations can be created by the CLI. Issue the write memory command to make multicast security associations persistent across reboots.
! cable security-association is within the configure terminal mode and requires rf-rw group-privilege.
! no cable security-association deletes the specified multicast security association.
Syntax cable security-association <sa-name>
no cable security-association <sa-name>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable security-association <sa-name>GX$root(config-cable-sec-assoc)#
Defines a multicast security association name and enters a submode where you can assign the security association to a CM, and configure the security association parameters.
Related Commands encryption-algorithmmulticast-auth modemsecurity-associationtype
A multicast security association applied to one or more IP multicast maps cannot be deleted until all of the corresponding IP multicast maps are deleted. A multicast security association applied to CMs can be deleted at any time.
sa-name The name of the multicast security association to create. The name is composed of a sequence of text characters. A single-character delimiter of “ must be used before and after the specified name if the name is greater than one word.
cable service-class
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference94
cable service-class
Defines a service class name and enters a submode under the configure terminal mode where you configure the service class parameters such as the traffic priority, maximum sustained traffic rate (MSTR), maximum traffic burst, minimum reserved traffic rate (MRTR), and maximum latency. The service class can be applied to IP multicast maps (by the service-class command under the multicast map submode), cable VPNs (by the cable vpn-service-class command), and unclassified traffic on a downstream channel (by the cable downstream service-class command).
Issue the write memory command to make the configuration of service classes persistent across reboots.
! cable service-class is within the configure terminal mode and requires rf-rw group-privilege.
! no cable service-class deletes the specified service class.
Syntax cable service-class <policy-name>
no cable service-class <policy-name>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable service-class <class-name>GX$root(config-cable-service-class)#
Defines a service class name and enters a submode where you configure the policy parameters.
Related Commands cable downstream service-classcable vpn-service-classmaximum-latencymaximum-sustained-traffic-ratemaximum-traffic-burstminimum-reserved-traffic-rateservice-classtraffic-priority
policy-name The name of the service class to create. The name is composed of a sequence of text characters. A single-character delimiter of “ must be used before and after the specified name if the name is greater than one word.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable shared-secret
95
cable shared-secret
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 submode, 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 submode, and requires rf-rw group-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.
cable show
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference96
cable show
Displays configuration data about the cable interface specified by the interface cable command.
! cable show is within the interface cable submode and requires grp-rw group-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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable source-verify
97
cable source-verify
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.
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).
! cable source-verify is within the configure terminal mode and requires ip-rw group-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).
There is a performance impact when IP address verification is enabled.
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.
cable source-verify
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference98
Related Commands arpcable address-verificationcable arp-verifycable broadcast-domaincable ip-broadcast-echocable ip-multicast-echocable proxy-arpclear arpclear arp-cacheshow cable address-verificationshow ip arp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable subscriber-group
99
cable subscriber-group
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 submode. These parameters are assigned with the subscriber group submode 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 submode 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 within the interface cable submode and requires ip-rw group-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.
Related Commands cable dhcp-giaddrcable helper-addresscable relay-agent-optiondhcp-giaddr
group-name Alphanumeric string that specifies the group name.
cable sync-interval
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference100
helper-addressrelay-agent-option
cable sync-interval
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 within the interface cable submode and requires rf-rw group-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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable ucd-interval
101
cable ucd-interval
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 within the interface cable submode and requires rf-rw group-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
cable upstream add
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference102
cable upstream add
Adds the given upstream channel to the targeted cable interface. After adding a channel to a slot/interface, the channel must be enabled into service by issuing the no cable upstream shutdown command.
! cable upstream add is within the interface cable submode and requires rf-rw group-privilege.
! no cable upstream add removes the given upstream channel from the targeted cable interface.
! See “Configuration Notes” on page 333 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
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream admission-control-policy
103
cable upstream admission-control-policy
Applies the specified call admission control (CAC) policy name defined by the cable policy admission-control command to the given upstream channel.
! cable upstream admission-control-policy is within the interface cable submode and requires rf-rw group-privilege.
! no cable upstream admission-control-policy deletes the association of the specified policy and the upstream channel.
Syntax cable upstream <channel> admission-control-policy <policy-name>
no cable upstream <channel> admission-control-policy
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable upstream 0 admission-control-policy <policy-name>
Applies a CAC policy to upstream channel 0 in slot 2 / interface 0.
Related Commands cable downstream admission-control-policycable policy admission-controlreal-time-jitter minimumreservation minimum-rate-traffic
channel The channel to which the CAC policy is being applied (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.
policy-name The CAC policy name to apply to the given upstream channel.
cable upstream channel-hopping
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference104
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 within the interface cable submode and requires rf-rw group-privilege.
! no cable upstream channel-hopping disables channel hopping for the specified channel. If a channel hopped to a spare location, the channel returns to its original user configuration. If channel width control is enabled and the original location is too noisy, the channel might not use all of the original user configuration (such as the original channel width).
! 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 in 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
105
cable upstream channel-width
Sets the channel width for an upstream channel in the targeted slot/interface.
! cable upstream channel-width is within the interface cable submode and requires rf-rw group-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 and SNMP Reference106
cable upstream concatenation
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 within the interface cable submode and requires rf-rw group-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 deconcatenation on upstream channel 4 in 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 congestion-control-policy
107
cable upstream congestion-control-policy
Applies the specified congestion control policy name defined by the cable policy congestion-control command to the given upstream channel.
! cable upstream congestion-control-policy is within the interface cable submode and requires rf-rw group-privilege.
! no cable upstream congestion-control-policy deletes the association of the specified policy and the upstream channel.
Syntax cable upstream <channel> congestion-control-policy <policy-name>
no cable upstream <channel> congestion-control-policy
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable upstream 0 congestion-control-policy <policy-name>
Applies a congestion control policy to upstream channel 0 in slot 2 / interface 0.
Related Commands cable downstream congestion-control-policycable policy congestion-controlred drop-profilered latency max
channel The channel to which the congestion control policy is being applied (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.
policy-name The congestion control policy name to apply to the given upstream channel.
cable upstream data-backoff
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference108
cable upstream data-backoff
Establishes a range of values a cable modem uses 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. 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).
The number of times a CM attempts 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 defers. 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 are 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 does 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. Alternatively, specifying 16 for both the start and the end parameters also enables this special algorithm.
! cable upstream data-backoff is within the interface cable submode and requires rf-rw group-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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream data-backoff
109
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 in 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 in 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.
cable upstream description
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference110
cable upstream description
Assigns a description to an upstream channel on a DOCSIS Module. The description corresponds to the ifAlias object in the ifXTable in the IF-MIB, and is displayed when the show running-config command is issued. A single-character delimiter of " must be used before and after the description if it is greater than one word.
! cable upstream description is within the interface cable submode and requires ad-rw group-privilege.
! no cable upstream description removes the description from the specified channel.
Syntax cable upstream <channel> description <“description-string”>
no cable upstream <channel> description
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable upstream 0 description “US Channel 0 from Node 4”
Assigns a description of US Channel 0 from Node 4 to upstream channel 0 in slot 2 / interface 0.
Related Commands cable downstream descriptionchassis port description
channel Channel number to which the description is assigned: 0–7 or 0–15, depending on the G10 CMTS DOCSIS Module model, or 0–7 for the G1 CMTS.
description-string User-defined text string up to 256 characters, enclosed in quotes if more than one word.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream frequency
111
cable upstream frequency
Sets a fixed frequency for a channel in the specified slot/interface.
! cable upstream frequency is within the interface cable submode and requires rf-rw group-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.
cable upstream min-power-level
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference112
cable upstream min-power-level
Configures the minimum power level at which a CM is considered successfully ranged. The default is –3 dB below the commanded power level. This command applies to all CMs on the specified upstream channel and overrides the configuration set by the cable upstream-min-power-level command.
! cable upstream min-power-level is within the interface cable submode and requires rf-rw group-privilege.
! no cable upstream min-power-level configures the minimum power level at which a CM is considered successfully ranged to its default.
Syntax cable upstream <channel> min-power-level <power-level>
no cable upstream <channel> min-power-level
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable upstream 0 min-power-level –4
Configures the minimum power level at which all CMs in channel 0 in slot 2 / interface 0 are considered successfully ranged to –4 dB below the commanded power level.
Related Commands cable upstream power-levelcable upstream-min-power-level
channel The channel for which the input 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 power level (dB) below the commanded power level at which a CM is considered successfully ranged. Valid range is –3 through –12, and the following relation must be guaranteed at all times:
SNR + power-level > 7 dB
See the cable upstream-min-power-level command for important notes regarding the usage of this feature.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream minislot-size
113
cable upstream minislot-size
Sets the minislot size for a channel in the specified slot/interface.
! cable upstream minislot-size is within the interface cable submode and requires rf-rw group-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 and SNMP Reference114
cable upstream modem flap-list
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 within the interface cable submode and requires rf-rw group-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>} |{snr-qpsk-threshold <snr-qpsk-threshold>} |{snr-16qam-threshold <snr-16qam-threshold>} |{mer-threshold <mer-threshold>} |{cer-threshold <cer-threshold>} |{power-adjust-threshold <power-adjust-threshold>} |{frequency-adjust-threshold <frequency-adjust-threshold>} |{im-retry-interval <im-retry-interval>} |{sm-miss-threshold <sm-miss-threshold>} |{show}
no cable upstream <channel> modem flap-list [snr-threshold | snr-qpsk-threshold | snr-16qam-threshold | frequency-adjust-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 using QPSK or 16QAM modulation drops below this threshold (specified in dB). The valid range is 1–100, and the default is 18 and 24 for QPSK and 16QAM, respectively. The thresholds for QPSK and 16QAM can be changed by using the snr-qpsk-threshold and snr-16qam-threshold parameters, respectively.
snr-qpsk-threshold A flap occurs when the measured SNR of a CM using QPSK modulation drops below this threshold (specified in dB). The valid range is 1–100 and the default is 18.
snr-16qam-threshold A flap occurs when the measured SNR of a CM using 16QAM modulation drops below this threshold (specified in dB). The valid range is 1–100 and the default is 24.
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream modem flap-list
115
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-listshow cable modem flap
frequency-adjust-threshold A flap occurs when the absolute value of the accumulated sum of all the relative frequency offset corrections sent to a CM, following initial ranging, is greater than or equal to this threshold (specified in Hz). The valid range is 0–10000000 and the default is 0 (disabled).
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.
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 and SNMP Reference116
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 within the interface cable submode and requires rf-rw group-privilege.
! no cable upstream modulation-control disables channel modulation control for the specified channel. If the modulation had changed, it is restored to its original modulation.
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 in 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
117
cable upstream modulation-profile
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 within the interface cable submode and requires rf-rw group-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 and SNMP Reference118
cable upstream port
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 within the interface cable submode and requires rf-rw group-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
119
! 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 in 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 power-level
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference120
cable upstream power-level
Sets the input power level for a channel in the specified slot/interface.
! cable upstream power-level is within the interface cable submode and requires rf-rw group-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.
Related Commands cable upstream min-power-levelcable upstream-min-power-level
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream range-backoff
121
cable upstream range-backoff
Establishes a range of values a cable modem uses 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. 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).
The number of times a CM attempts 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 defers. 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 are 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 does 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. Alternatively, specifying 16 for both the start and the end parameters also enables this special algorithm.
! cable upstream range-backoff is within the interface cable submode and requires rf-rw group-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
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 and SNMP Reference122
Sets the start and end range-backoff parameters of channel 2 in slot 2 / interface 1 to 5 and 10, respectively.
GX$root(config-if-c2/1)# cable upstream 2 range-backoff 0 0
Sets the start and end data-backoff parameters of channel 2 in 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 alignment 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 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.
cable upstream show
Displays the upstream channel information for a specified slot/interface.
! cable upstream show is within the interface cable submode and requires rf-rw group-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 is 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
123
cable upstream shutdown
Disables an upstream channel in the specified slot/interface.
! cable upstream shutdown is within the interface cable submode and requires rf-rw group-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 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.
cable upstream traffic-scheduling-policy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference124
cable upstream traffic-scheduling-policy
Applies the specified traffic scheduling policy name defined by the cable policy traffic-scheduling command to the given upstream channel.
! cable upstream traffic-scheduling-policy is within the interface cable submode and requires rf-rw group-privilege.
! no cable upstream traffic-scheduling-policy deletes the association of the specified policy and the upstream channel.
Syntax cable upstream <channel> traffic-scheduling-policy <policy-name>
no cable upstream <channel> traffic-scheduling-policy
Definitions
Examples GX$root# configure terminal
GX$root(config)# interface cable 2/0
GX$root(config-if-c2/0)# cable upstream 0 traffic-scheduling-policy <policy-name>
Applies a traffic scheduling policy to upstream channel 0 in slot 2 / interface 0.
Related Commands cable policy traffic-schedulingcable downstream traffic-schedulingmaximum-rate-enforcementtraffic-class
channel The channel to which the traffic scheduling policy is being applied (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.
policy-name The traffic scheduling policy name to apply to the given upstream channel.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream width-control
125
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 within the interface cable submode and requires rf-rw group-privilege.
! no cable upstream width-control disables channel width control for the specified channel. If the channel width had changed, it is restored to its original width. If the channel hopped to a spare channel that cannot support the original channel width (because the spare channel width is too narrow), the channel hops back to its original location.
! 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 in 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).
cable upstream-load-balance
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference126
cable upstream-load-balance
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 attempts to assign an upstream channel in proportion to the available bandwidth amongst available upstream channels.
! cable upstream-load-balance is within the configure terminal submode and requires rf-rw group-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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream-min-power-level
127
cable upstream-min-power-level
Configures the minimum power level at which a CM is considered successfully ranged. The default is –3 dB below the commanded power level. This command applies globally to all CMs.
! cable upstream-min-power-level is within the configure terminal mode and requires rf-rw group-privilege.
! no cable upstream-min-power-level configures the minimum power level at which a CM is considered successfully ranged to its default.
Syntax cable upstream-min-power-level <power-level>
no cable upstream-min-power-level
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable upstream-min-power-level –4
Configures the minimum power level at which all CMs are considered successfully ranged to –4 dB below the commanded power level.
power-level The power level (dB) below the commanded power level at which a CM is considered successfully ranged. Valid range is –3 through –12, and the following relation must be guaranteed at all times:
SNR + power-level > 7 dB
This feature is intended to allow CMs experiencing excessive attenuation to operate, even when they cannot reach their commanded power level. Be aware of the following when using this feature:
! You should reduce the commanded power level before issuing this command. This might be sufficient for proper CM operation. The lowest commanded power supported by all symbol rates is –4 dBmV.
! The relation SNR+power-level > 7 dB must be guaranteed at all times, and must take into account the worst SNR across daily and seasonal changes. This requires very good characterization of the HFC plant. This relation typically applies if:
! power-level is kept between –3 dB and –6 dB.
! A CM at the minimum power level allowed below the commanded power level is capable of passing traffic.
! We strongly advise against setting power-level below –6 dB. The misconfiguration of power-level can lead to improper CMTS behavior.
cable upstream-port spare
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference128
Related Commands cable upstream min-power-levelcable upstream power-level
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 within the configure terminal mode and requires rf-rw group-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 <spare-id> center-frequency <frequency> width <width>
no cable upstream-port slot <slot> port <port> spare <spare-id> 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.
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable upstream-pre-equalization
129
Definitions
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-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 within the configure terminal mode and requires rf-rw group-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.
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 334.
port The US port (0 to 3) on which spare channels are reserved.
spare-id An identifier for the spare channel. Valid range is 0 through 3.
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.
cable vpn
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference130
cable vpn
Assigns a CM, and the CPE devices behind it, to a cable Virtual Private Network (VPN). A CM 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. If a CM belongs to a VPN, the CMTS adds a VLAN tag to all untagged upstream packets received from the CM. The CM might elect to send 802.1Q tagged packets. If the tag does not match the vpn-id assigned to the CM, the packet is dropped. Otherwise, the tagged packet is forwarded. In both cases (tagged and untagged), packets forwarded to the NSI from a CM that belongs to a VPN are always tagged with the appropriate VLAN tag.
All downstream packets to the CM 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.
The cable vpn command overrides any VPN provisioning through a CM configuration file.
! cable vpn is within the configure terminal mode and requires ip-rw group-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 608
Assign the CM with the MAC address of 1234.5678.ABCD to VPN ID 608.
Related Commands show cable vpn
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 601–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 a CPE behind the CM).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cable vpn-description
131
cable vpn-description
Adds a description to the specified cable VPN. The description is displayed when the show cable vpn and show cable modem vpn:<vpn-id> cpe commands are issued.
! cable vpn-description is within the configure terminal mode and requires ip-rw group-privilege.
! no cable vpn-description removes the description from the cable VPN.
Syntax cable vpn-description <vpn-id> <“description-string”>
no cable vpn-description <vpn-id>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable vpn-description 655 “VPN ID is 655”
Adds the description VPN ID is 655 to cable VPN 655.
Related Commands show cable modem vpnshow cable vpn
vpn-id The ID of the cable VPN. Valid range is 601–4000.
description-string User-defined text string up to 256 characters, enclosed in quotes if more than one word.
cable vpn-service-class
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference132
cable vpn-service-class
Applies the specified service class name defined by the cable service-class command to the targeted cable VPN.
! cable vpn-service-class is within the configure terminal mode and requires rf-rw group-privilege.
! no cable vpn-service-class deletes the association of the specified service class and the cable VPN.
Syntax cable vpn-service-class <vpn-id> <class-name>
no cable vpn-service-class <vpn-id>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable vpn-service-class 601 <class-name>
Applies a service class to cable VPN ID 601.
Related Commands cable service-class
cat
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 fs-ro group-privilege.
Syntax cat <file-name>
Definitions
Examples GX$root> cat README
Displays the entire contents of the file README.
Related Commands dirmkdirmorepwd
vpn-id The cable VPN ID to which the service class is applied. Valid range is 601–4000.
class-name The service class name to apply to the given cable VPN.
file-name Name of the file to be displayed. Can include the path to the file.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cd
133
cd
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 fs-ro group-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
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:
dir-name The name of the target directory. If omitted, the current working directory changes into the home directory (/home).
.. The target directory is one level up from the current working directory.
chassis environment ambient-temperature
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference134
chassis environment ambient-temperature
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 within the configure terminal mode and requires ad-rw group-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
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
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
chassis port description
135
chassis port description
Assigns a description to a downstream, upstream, Fast Ethernet, or Gigabit Ethernet (G10 CMTS only) port. The description corresponds to the pbcCardPortAlias object in the pbcCardPortTable in the PBC-GENERIC-MIB enterprise MIB, and is displayed when the show running-config command is issued. A single-character delimiter of " must be used before and after the description if it is greater than one word.
! chassis port description is within the configure terminal mode and requires ad-rw group-privilege.
! no chassis port description removes the description from the specified port.
Syntax chassis port {cable downstream | cable upstream | fastEthernet | gigaEthernet} slot <slot> port <port> description <“description-string”>
no chassis port {cable downstream | cable upstream | fastEthernet | gigaEthernet} slot <slot> port <port> description
Definitions
Examples GX$root# chassis port cable downstream slot 2 port 0 description “DS Port to
Node 4”
Assigns a description of DS Port to Node 4 to downstream port 0 of the DOCSIS Module in slot 2.
cable downstream Specifies that a description is to be added to a DOCSIS Module downstream port.
cable upstream Specifies that a description is to be added to a DOCSIS Module upstream port.
fastEthernet Specifies that a description is to be added to a Fast Ethernet port.
gigaEthernet Specifies that a description is to be added to a Gigabit Ethernet port on the NIC Module (G10 CMTS only).
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)
See “Interface, Port, and Channel Numbers” on page 334.
port Port number to which the description is assigned:
DOCSIS Module:
! cable downstream: 0–3 for the G10 CMTS, 0–1 for the G1 CMTS
! cable upstream: 0–3
! fastEthernet: 0–1 for the G10 CMTS, 0 for the G1 CMTS
Chassis Control Module:
! fastEthernet: 0
NIC Module (G10 CMTS only):
! fastEthernet: 0–3
! gigaEthernet: 0–1
description-string User-defined text string up to 256 characters, enclosed in quotes if more than one word.
clear aborted-modems
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference136
Related Commands cable downstream descriptioncable upstream description
clear aborted-modems
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 is 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 rf-rw group-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
137
clear alarms
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 5 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 5: Event Priority Correspondence to CCM LEDs
! clear alarms is a top-level command and requires ad-rw group-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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference138
clear arp
Clears all ARP cache entries associated with an IP address, a MAC address, a cable interface, a broadcast domain, or a VPN.
! clear arp is a top-level command and requires ip-rw group-privilege.
Syntax clear arp <ip-address> | <mac-address> | [cable <slot/if>] |[broadcast-domain <domain-id>] | [cable vpn <vpn-id>]
Definitions
Examples GX$root# clear arp 192.203.56.9
The ARP entry associated with IP address 192.203.56.9 is cleared.
GX$root# clear arp cable 2/0
All ARP entries associated with slot 2 / interface 0 are cleared.
Related Commands arpcable proxy-arpclear arp-cache
ip-address All ARP entries associated with this IP address are cleared. Applicable to all DOCSIS Modules and the Chassis Control Module. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address All ARP entries associated with this MAC address are cleared. Applicable to all DOCSIS Modules and the Chassis Control Module. Specified as xxxx.xxxx.xxxx in hexadecimal.
slot/if All ARP entries associated with this slot number and interface number are cleared.
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)
domain-id All ARP entries associated with this broadcast domain ID are cleared. Applicable to all DOCSIS Modules. Valid range is 1–600.
vpn-id All ARP entries associated with this VPN ID are cleared. Applicable to all DOCSIS Modules. Valid range is 601–4000.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clear arp-cache
139
clear arp-cache
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 ip-rw group-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 vpnclear arpshow ip arp
clear cable modem cpe
Clears the table of known CPEs associated with the specified CM.
! clear cable modem cpe is a top-level command and requires rf-rw group-privilege.
Syntax clear cable modem {<ip-address> | <mac-address>} cpe
Definitions
Examples 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 modem resetcpe-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.
clear cable modem flap-list
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference140
clear cable modem flap-list
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 rf-rw group-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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clear cable modem phy-statistics
141
clear cable modem phy-statistics
Clears the CM error and physical layer (PHY) statistics that are displayed by the show cable modem errors and show cable modem phy commands.
! clear cable modem phy-statistics is a top-level command and requires rf-rw group-privilege.
Syntax clear cable modem [<ip-address> | <mac-address>] phy-statistics
Clears error and PHY statistics for all CMs supported by the CMTS, or optionally, the specified CM.
clear cable modem <slot/if> [upstream <channel>] phy-statistics
Clears error and PHY statistics 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> clear cable modem phy-statistics
Clears error statistics for all CMs supported by the CMTS.
Related Commands show cable modem errorsshow cable modem phy
ip-address The IP address of the cable modem for which error statistics are cleared. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem for which error statistics are cleared, specified as xxxx.xxxx.xxxx in hexadecimal.
slot/if The CMTS slot and interface number, which clears error statistics for 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 error statistics associated with CMs on the specified upstream channel are cleared.
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).
clear cable modem ranging-statistics
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference142
clear cable modem ranging-statistics
Clears the CM ranging statistics that are listed in Table 17 on page 253.
! clear cable modem ranging-statistics is a top-level command and requires rf-rw group-privilege.
Syntax clear cable modem [<ip-address> | <mac-address>] ranging-statistics
Clears ranging statistics for all CMs supported by the CMTS, or optionally, the specified CM.
clear cable modem <slot/if> [upstream <channel>] ranging-statistics
Clears ranging statistics 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> clear cable modem ranging-statistics
Clears ranging statistics for all CMs supported by the CMTS.
Related Commands show cable modem ranging-statistics
ip-address The IP address of the cable modem for which ranging statistics are cleared. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mac-address The MAC address of the cable modem for which ranging statistics are cleared, specified as xxxx.xxxx.xxxx in hexadecimal.
slot/if The CMTS slot and interface number, which clears ranging statistics for 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 ranging statistics associated with CMs on the specified upstream channel are cleared.
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
clear cable modem reset
143
clear cable modem reset
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.
! clear cable modem reset is a top-level command and requires rf-rw group-privilege.
Syntax clear cable modem {<ip-address> | <mac-address>} reset
Definitions
Examples GX$root# clear cable modem 110.155.27.45 reset
Forces the CM at IP address 110.155.27.45 to reinitialize its MAC.
Related Commands clear cable modem cpecpe-controlled-cable-modemshow cable modem
clear cable rogue-modem
Resets all dynamically-detected rogue CMs, in which case they are no longer declared as rogue until the next time they are detected to be rogue. The CMTS stops sending station maintenance MAP messages to the CMs, which causes them to timeout. This command does not affect statically-configured rogue CMs.
See the cable rogue-modem command for more information regarding rogue CMs.
! clear cable rogue-modem is a top-level command and requires rf-rw group-privilege.
Syntax clear cable rogue-modem
Examples GX$root# configure terminal
GX$root(config)# clear cable rogue-modem
Resets all dynamically-detected rogue CMs.
Related Commands cable rogue-modemshow cable modem rogue
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.
clear forwarding-table
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference144
clear forwarding-table
Clears the entire Layer 2 forwarding database, or optionally clears all entries associated with a MAC address, a broadcast domain, or a VPN. This command is applicable to all DOCSIS Modules and NIC Modules (G10 CMTS only).
! clear forwarding-table is a top-level command and requires ip-rw group-privilege.
! If no optional parameters are specified, the entire forwarding database on all DOCSIS Modules is cleared.
Syntax clear forwarding-table [<mac-address> | [broadcast-domain <domain-id>] |[cable vpn <vpn-id>]]
Definitions
Examples GX$root# clear forwarding-table
Clears the entire forwarding database on all DOCSIS Modules.
GX$root# clear forwarding-table 0001.30E7.C100
Clears all forwarding database entries associated with MAC address 0001.30E7.C100 on all DOCSIS Modules.
Related Commands clear interfaces cable forwarding-table
clear interfaces cable forwarding-table
Clears the Layer 2 forwarding database associated with the specified cable interface.
! clear interfaces cable forwarding-table is a top-level command and requires ip-rw group-privilege.
Syntax clear interfaces cable <slot/if> forwarding-table
Definitions
Examples GX$root# clear interfaces cable 2/0 forwarding-table
Clears the forwarding database associated with slot 2 / interface 0.
Related Commands clear forwarding-table
mac-address All forwarding database entries associated with this MAC address are cleared. Specified as xxxx.xxxx.xxxx in hexadecimal.
domain-id All forwarding database entries associated with this broadcast domain ID are cleared. Valid range is 1–600.
vpn-id All forwarding database entries associated with this VPN ID are cleared. Valid range is 601–4000.
slot/if The forwarding database associated with this slot number and interface number is cleared.
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
clear ip multicast-group
145
clear ip multicast-group
Clears specific entries, or the entire IGMP multicast group membership table. Specific entries can be specified by a multicast IP address, a cable interface, or a downstream channel within a cable interface. Any entry that contains the optionally specified parameter is cleared from the multicast group membership table.
See the ip igmp enable command for more details regarding IGMP snooping.
! clear ip multicast-group is a top-level command and requires ip-rw group-privilege.
Syntax clear ip multicast-group [<ip-address>] | [cable <slot/if> [downstream <channel>]]
Definitions
Examples GX$root# clear ip multicast-group 225.17.18.1
Clears any multicast group entries that have an IP address of 225.17.18.1.
GX$root# clear ip multicast-group cable 2/0
Clears any multicast group entries for slot 2 / interface 0.
GX$root# clear ip multicast-group cable 2/0 downstream 0
Clears any multicast group entries for downstream channel 0 in slot 2 / interface 0.
GX$root# clear ip multicast-group
Clears the entire multicast group table.
Related Commands cable downstream igmp-multicast-groupip igmp enableip igmp membership-intervalshow ip multicast-group
ip-address The multicast IP address of the multicast group entry. Standard dot-quad notation (xxx.xxx.xxx.xxx).
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)
channel The downstream channel within the cable interface (0–3 for the G10 CMTS, 0–1 for the G1 CMTS).
clear local-log
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference146
clear local-log
Clears the local volatile event log. This log corresponds to the docsDevEventTable of the DOCS-CABLE-DEVICE-MIB.
! clear local-log is a top-level command and requires ad-rw group-privilege.
Syntax clear local-log
Examples GX$root# clear local-log
Clears the local volatile event log.
Related Commands clear local-nv-loglog-level generatelog-level set-default-alllog-level showshow local-logshow local-nv-log
clear local-nv-log
Clears the local non-volatile event log. This log corresponds to the docsDevEventTable of the DOCS-CABLE-DEVICE-MIB.
! clear local-nv-log is a top-level command and requires ad-rw group-privilege.
Syntax clear local-nv-log
Examples GX$root# clear local-nv-log
Clears the local non-volatile event log.
Related Commands clear local-loglog-level generatelog-level set-default-alllog-level showshow local-logshow local-nv-log
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clock
147
clock
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 ad-rw group-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.
clock ntp-server
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference148
clock ntp-server
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 within the configure terminal mode and requires ad-rw group-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).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clock show
149
clock show
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 within the configure terminal mode and requires grp-rw group-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
clock summer-time
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference150
clock summer-time
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.
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
! clock summer-time is within the configure terminal mode and requires ad-rw group-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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
clock summer-time
151
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.
Related Commands clockclock ntp-serverclock showclock timezoneshow clock
clock timezone
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference152
clock timezone
Adjusts the local time.
! clock timezone is within the configure terminal mode and requires ad-rw group-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
configure memory
Copies the startup-config file to the running-config file.
! configure memory is a top-level command and requires grp-rw group-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
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
configure terminal
153
Copies the startup-config file to the running-config file.
Related Commands copy
configure terminal
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 grp-rw group-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
copy
Copies a data file from a source location to a target location.
! copy is a top-level command and requires fs-rw group-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
command Any valid command that can be entered within the configure terminal mode.
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.
copy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference154
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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
cpe-controlled-cable-modem
155
cpe-controlled-cable-modem
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 rf-rw group-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.
debug
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference156
debug
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 grp-rd group-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
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 grp-rd group-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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable arp
157
debug cable arp
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.
If the Layer 2 MAC rewrite feature is enabled (see the cable mac-rewrite command), the display reflects the rewritten packet information, and indicates that a rewrite was performed.
! debug cable arp is a top-level command and requires grp-rd group-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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference158
debug cable bpkm
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 grp-rd group-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
debug cable bwr
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 grp-rd group-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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
debug cable clear filter
159
debug cable clear filter
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 grp-rd group-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
debug cable clear log
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 grp-rd group-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
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 dcc
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference160
debug cable dcc
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 grp-rd group-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
161
debug cable dci
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 grp-rd group-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 and SNMP Reference162
debug cable dhcp
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.
If the Layer 2 MAC rewrite feature is enabled (see the cable mac-rewrite command), the display reflects the rewritten packet information, and indicates that a rewrite was performed.
! debug cable dhcp is a top-level command and requires grp-rd group-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
163
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 and SNMP Reference164
debug cable dynsrv
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 grp-rd group-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
165
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
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 grp-rd group-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 and SNMP Reference166
debug cable interface cable
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 grp-rd group-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
167
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 in slot 2 / interface 0 are monitored.
GX$root# debug cable interface cable 2/0 [verbose]
All debug events in 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 and SNMP Reference168
debug cable mac-address
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 grp-rd group-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
169
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 grp-rd group-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 and SNMP Reference170
debug cable map
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 grp-rd group-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
171
debug cable range
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 grp-rd group-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 and SNMP Reference172
debug cable registration
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 grp-rd group-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
173
debug cable ucc
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 grp-rd group-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 and SNMP Reference174
debug cable ucd
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 grp-rd group-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
175
debug cable updis
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 grp-rd group-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
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 ad-rd, ip-rd, or rf-rd group-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 and SNMP Reference176
delete
Deletes a file from the CMTS.
! delete is a top-level command and requires fs-rw group-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
177
description
Adds a description to a Fast Ethernet port, a Gigabit Ethernet port, an aggregate link, 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 within the interface cable, interface fastEthernet, interface gigaEthernet, interface aggEthernet, and interface cable submodes, and requires ip-rw group-privilege (users with a group-privilege of rf-rw can also issue this command in the interface cable submode).
! 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
Used to configure a subscriber group under the subscriber group submode. 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 and SNMP Reference178
dir
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 fs-ro group-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
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
179
duplex
Sets an Ethernet port to either full or half duplex.
! duplex is within the interface fastEthernet submode and requires ip-rw group-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
Opens the specified file in the current directory using the vi editor.
! edit is a top-level command and requires fs-rw group-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 and SNMP Reference180
enable
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
encryption-algorithm
Defines the data encryption algorithm for the targeted multicast security association.
! encryption-algorithm is within the security association submode and requires rf-rw group-privilege.
Syntax encryption-algorithm {des56cbc | des40cbc}
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable security-association <sa-name>GX$root(config-cable-sec-assoc)# encryption-algorithm des40cbc
Specifies the data encryption algorithm as des40cbc for the targeted multicast security association.
Related Commands cable security-associationmulticast-auth modemsecurity-associationtype
des56cbc Specifies the data encryption algorithm used is des56cbc (default).
des40cbc Specifies the data encryption algorithm used is des40cbc.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
erase startup-config
181
erase startup-config
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 ad-rw group-privilege.
Syntax erase startup-config
Examples GX$root# erase startup-config
Erases the Startup.cli file.
Related Commands copydeletewrite memory
exit
Takes you out of the current mode, or any of the submodes, to the next highest level. If the optional parameter all is specified, you are 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 submode 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 submode.
ftp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference182
ftp
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 ad-rw or fs-rw group-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
183
help
Displays a list of valid commands that can be issued within the current mode or submode. 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 are 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 submode.
GX$root# show ?
Displays a list of parameters available for the show command. Notice that a carriage return is not needed.
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.
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, submode, group, and privilege.
abbreviated-parameter One or more letters in a valid parameter for the command specified.
helper-address
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference184
helper-address
Used to configure a subscriber group under the subscriber group submode. 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
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
185
hostname
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 ad-rw group-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 aggEthernet
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference186
interface aggEthernet
Enters a submode under the configure terminal mode where you can configure an aggregate link that uses the 802.3ad protocol. An aggregate link can be comprised of two Gigabit ports (ports 0–1) on a single NIC Module, two Gigabit ports (port 0) across two NIC Modules, or two through eight of the eight total general-purpose switched Fast Ethernet ports (ports 0–3) across two NIC Modules. If link aggregration is configured for any ports across two NIC Modules (Gigabit ports or switched general-purpose Fast Ethernet ports), Gigabit port 1 on each NIC Module is used for the stacking port. Defined parameters for these links are description, minimum-links, port-selection, and shutdown.
A maximum of five aggregate links can be supported, and each aggregate link can be configured with a maximum of four ports. A port can only belong to one aggregate link at a time.
! interface aggEthernet is a submode within the configure terminal mode and requires ip-rw group-privilege.
Syntax interface aggEthernet <link>
Definitions
Examples GX$root# configure terminalGX$root(config)# interface aggEthernet 0
GX$root(config-if-a0)#
Puts you in the submode where you can configure aggregate link 0.
Related Commands add-todescriptionminimum-linksport-selectionshutdown
This command is applicable only to the G10 CMTS.
link The aggregate link number. Valid range is 0–4.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
interface cable
187
interface cable
Enters a submode under the configure terminal mode where you configure a given cable interface. See Chapter 1, “Command Summary”, for a hierarchal display of modes, submodes, 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 submode within the configure terminal mode and requires grp-rw group-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 submode for slot 2 / interface 1. All subsequent commands in this submode 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 334.
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}
interface fastEthernet
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference188
interface fastEthernet
Enters a submode 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 submode within the configure terminal mode and requires ip-rw group-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 submode 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–3 (G10 CMTS only)
show Displays configuration information for the slot/if. The system remains in the configure terminal mode.
Fast Ethernet ports 0–3 on the G10 CMTS NIC Module correspond to the RJ-45 connectors labeled PORT 9–PORT 12 on the NIC Access Module cable plugged into connector 2 on the NIC Access Module.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
interface gigaEthernet
189
interface gigaEthernet
Enters a submode under the configure terminal mode where you enable or disable the Gigabit ports on the NIC Module.
! interface gigaEthernet is a submode within the configure terminal mode and requires ip-rw group-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 submode 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.
interface loopback
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference190
interface loopback
Enters a submode under the configure terminal mode where you configure the Fast Ethernet management port of the Chassis Control Module as a loopback interface. This interface can be assigned one primary loopback IP address and multiple secondary loopback IP addresses. Defined parameters for this interface are description and ip address.
! interface loopback is a submode within the configure terminal mode and requires ip-rw group-privilege.
Syntax interface loopback <slot>/0
Definitions
Examples GX$root# configure terminalGX$root(config)# interface loopback 6/0
GX$root(config-if-l6/0)#
This puts you in the submode to configure Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS as the loopback interface.
Related Commands descriptionip addressno shutdown
slot Chassis Control Module slot number: 6 and 7 for the G10 CMTS, or 1 for the G1 CMTS
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
ip address
191
ip address
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 1 (G1 CMTS) and always use interface 0. All IP packets transmitted by the CMTS will include the IP address as the source IP address.
This command can be issued in the interface loopback submode, where one primary loopback IP address and multiple secondary loopback IP addresses can be assigned to the loopback interface (Fast Ethernet interface of the Chassis Control Module). If the optional parameter secondary is omitted, the current primary loopback IP address is overwritten by the IP address specified in the command.
! ip address is within the interface fastEthernet submode and requires ip-rw group-privilege.
! The no form of the command removes the IP address.
Syntax ip address <ip-address> <mask> [secondary]
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.
GX$root# configure terminal
GX$root(config)# interface loopback 6/0
GX$root(config-if-l6/0)# ip address 192.168.20.102 255.255.255.0
Assigns the IP address 192.168.20.102 with mask 255.255.255.0 to the G10 CMTS Chassis Control Module loopback 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).
secondary Optional parameter available only in the interface loopback submode. Used to indicate the specified IP address is a secondary loopback IP address.
The ip address command is not used to assign IP addresses to cable interfaces (see the cable dhcp-giaddr command).
ip default-gateway
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference192
ip default-gateway
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 within the configure terminal mode and requires ip-rw group-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
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 within the configure terminal mode and requires ip-rw group-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
193
ip ftp-enable
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 within the configure terminal mode and requires ip-rw group-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 ssh-enableip telnet-enable
ip igmp enable
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference194
ip igmp enable
Enables (or disables) Internet Group Management Protocol (IGMP) snooping. When enabled, IGMP (v1 or v2) membership report messages received on an upstream channel are monitored in order to determine the multicast group memberships on the associated downstream channel. The multicast group memberships are saved in a table that is used to forward multicast traffic only to those downstream channels that belong to the multicast group. A maximum of 64 multicast IP addresses are saved for each downstream channel.
A group membership interval timer is maintained for each entry in the multicast group membership table (see the ip igmp membership-interval command). When a timer expires, that entry is removed from the table.
All downstream channels belong to multicast groups in the range of 224.0.0.1 to 224.0.0.255, inclusive. There is no group membership interval timer maintained for any multicast group in this range.
! ip igmp enable is a command within configure terminal mode and requires ip-rw group-privilege.
! no ip igmp enable disables IGMP snooping.
! IGMP snooping is disabled by default.
Syntax ip igmp enable
no ip igmp enable
Examples GX$root# configure terminal
GX$root(config)# ip igmp enable
Enables IGMP snooping.
Related Commands cable downstream igmp-multicast-groupclear ip multicast-groupip igmp membership-intervalshow ip multicast-group
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
ip igmp membership-interval
195
ip igmp membership-interval
Sets the IGMP multicast group membership interval. A group membership interval timer is maintained for each entry in the multicast group membership table. The timer is loaded with the interval when an entry is added to the table, and when an IGMP membership report message is received for an existing entry in the table. If the timer expires, that entry is removed from the table.
See the ip igmp enable command for more details regarding IGMP snooping.
! ip igmp membership-interval is a command within configure terminal mode and requires ip-rw group-privilege.
! no ip igmp membership-interval resets the interval to its default (260 seconds).
Syntax ip igmp membership-interval <interval>
no ip igmp membership-interval
Definitions
Examples GX$root# configure terminal
GX$root(config)# ip igmp membership-interval 400
Sets the IGMP multicast group membership interval to 400 seconds.
Related Commands cable downstream igmp-multicast-groupclear ip multicast-groupip igmp enableshow ip multicast-group
interval The IGMP multicast group membership interval specified in seconds. Valid range is 10 to 16000. Default is 260.
ip name-server
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference196
ip name-server
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 ip-rw group-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 and 192.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
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 ip-rw group-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 ssh-enable
197
ip ssh-enable
Enables the secure shell (SSH) server on the CMTS for access to the CLI. The SSH server supports the ssh, scp (secure copy), and sftp (secure FTP) commands issued from a client.
When transferring files using the scp and sftp commands, the client has file system access based on its assigned group-privilege:
! If the user has fs-rw group-privilege, the client can only transfer files in the root directory.
! If the user has fs-rw and bi-rw group-privilege, the client (in this case an external server) can only transfer files in the billing directory (this directory is not visible from the CLI).
The SSH server supports:
! Ciphers 3des-cbc, blowfish-cbc, twofish128-cbc, and aes128-cbc.
! Message authentication codes (MACs) hmac-sha1 and hmac-sha1-96.
! Key exchange method diffie-hellman-group1-sha1.
The SSH server uses the same authentication mechanism for verifying the password as that configured for Telnet access. These mechanisms are the local password database, RADIUS, or TACACS+ (see the remote-authentication command). Unlike the Telnet server, the SSH server is unable to support remote authentication requiring server-driven dialog.
! ip ssh-enable is within the configure terminal mode and requires fs-rw group-privilege.
! no ip ssh-enable disables the SSH server (default setting).
Syntax ip ssh-enable
no ip ssh-enable
Examples GX$root# configure terminal
GX$root(config)# ip ssh-enable
Enables the SSH server on the CMTS.
Related Commands ip ftp-enableip telnet-enableremote-authentication
ip telnet-enable
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference198
ip telnet-enable
Enables Telnet access to the CMTS.
! ip telnet-enable is within the configure terminal mode and requires ip-rw group-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
ip-multicast
Assigns the multicast IP address and mask to the targeted IP multicast map.
! ip-multicast is within the multicast map submode and requires rf-rw group-privilege.
Syntax ip-multicast <ip-address> <mask>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable multicast-map <map-name>GX$root(config-cable-mm)# ip-multicast 192.168.27.49 255.255.255.255
Assigns a multicast IP address and mask of 192.168.27.49 and 255.255.255.255, respectively, to the targeted IP multicast map.
Related Commands cable multicast-mapsecurity-associationservice-class
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.
ip-address The multicast IP address of the multicast group entry. Standard dot-quad notation (xxx.xxx.xxx.xxx).
mask The mask corresponding to the IP address. Standard dot-quad notation (xxx.xxx.xxx.xxx).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
kill
199
kill
Terminates the specified Telnet session.
! kill is a top-level command and requires ad-rw group-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
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 and SNMP Reference200
log-level generate
Provides access to the docsDevEvControlTable within the DOCS-CABLE-DEVICE-MIB. 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 the DOCS-CABLE-DEVICE-MIB. 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 the DOCS-CABLE-DEVICE-MIB. See the DOCS-CABLE-DEVICE-MIB 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. Trap generation for Juniper Networks-specific events is controlled by the pbcCmtsNotificationsControl object in the PBC-CMTS-MIB enterprise MIB (disabled by default).
! log-level generate is a command in the configure terminal mode and requires ad-rw group-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 the DOCS-CABLE-DEVICE-MIB.
! 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 6 provides the default assignment of event priorities to logging and reporting actions as defined by the DOCSIS OSSIv1.1 specification.
Table 6: 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, syslog, trap
Notice local-volatile-log, syslog, trap
Informational —
Debug —
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
log-level generate
201
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 are logged in the local non-volatile log and the local volatile log, cause a syslog message to be sent, and cause a trap to be generated.
GX$root(config)# log-level information generate local-log
Events occurring with an information priority are logged in the local non-volatile log.
Related Commands log-level set-default-alllog-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 set-default-all
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference202
log-level set-default-all
Sets the actions for all eight event levels to their default values (this does not correspond to all actions cleared). The modified entity corresponds to the docsDevEvControlTable of the DOCS-CABLE-DEVICE-MIB. Table 6 on page 200 provides the default assignment of event priorities to logging and reporting actions as defined by the DOCSIS OSSIv1.1 specification.
! log-level set-default-all is a command in the configure terminal mode and requires ad-rw group-privilege.
Syntax log-level set-default-all
Examples GX$root# configure terminal
GX$root(config)# log-level set-default-all
Sets the actions for all eight event levels to their default values.
Related Commands log-level generatelog-level showshow local-log
log-level show
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 the DOCS-CABLE-DEVICE-MIB. See the DOCS-CABLE-DEVICE-MIB for more details.
! log-level show is a command in the configure terminal mode and requires ad-rw group-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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
logout
203
logout
Ends the Telnet session when entered within any mode or submode.
! 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.
ls
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 fs-ro group-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.
maximum-latency
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference204
maximum-latency
Sets the maximum latency for the targeted service class.
! maximum-latency is within the service class submode and requires rf-rw group-privilege.
Syntax maximum-latency <latency>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable service-class <class-name>GX$root(config-cable-service-class)# maximum-latency 100
Specifies a maximum latency of 100 microseconds for the given service class.
Related Commands cable downstream service-classcable service-classmaximum-sustained-traffic-ratemaximum-traffic-burstminimum-reserved-traffic-ratetraffic-priority
maximum-sustained-traffic-rate
Sets the maximum sustained traffic rate (MSTR) for the targeted service class. The number of bytes forwarded is limited during any time interval to the MSTR.
! maximum-sustained-traffic-rate is within the service class submode and requires rf-rw group-privilege.
Syntax maximum-sustained-traffic-rate <rate>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable service-class <class-name>GX$root(config-cable-service-class)# maximum-sustained-traffic-rate 200000
Specifies a MSTR of 200 Kb/s for the given service class.
Related Commands cable downstream service-classcable service-classmaximum-latencymaximum-traffic-burstminimum-reserved-traffic-ratetraffic-priority
latency The maximum latency, in microseconds, between the reception of a packet by the CMTS on its NSI and the forwarding of the packet to the RF interface. Valid range is 0 through 4294967295. A value of 0 (default) signifies that no maximum latency is enforced.
rate The MSTR allowed for this service class in bits/sec. The number of bytes forwarded is limited during any time interval. The value 0 (default) means that no maximum traffic rate is enforced.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
maximum-traffic-burst
205
maximum-traffic-burst
Sets the maximum traffic burst for the targeted service class. This command has no effect unless a non-zero value has been provided for the maximum sustained traffic rate for the targeted service class (see the maximum-sustained-traffic-rate command).
! maximum-traffic-burst is within the service class submode and requires rf-rw group-privilege.
Syntax maximum-traffic-burst <size>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable service-class <class-name>GX$root(config-cable-service-class)# maximum-traffic-burst 3044
Specifies a maximum traffic burst size of 3044 bytes for the given service class.
Related Commands cable downstream service-classcable service-classmaximum-latencymaximum-sustained-traffic-rateminimum-reserved-traffic-ratetraffic-priority
minimum-reserved-traffic-rate
Sets the minimum reserved traffic rate (MRTR) for the targeted service class. The MRTR is the guaranteed minimum rate.
! minimum-reserved-traffic-rate is within the service class submode and requires rf-rw group-privilege.
Syntax minimum-reserved-traffic-rate <rate>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable service-class <class-name>GX$root(config-cable-service-class)# minimum-reserved-traffic-rate 100000
Specifies a MRTR of 100 Kb/s for the given service class.
Related Commands cable downstream service-classcable service-classmaximum-latencymaximum-traffic-burstmaximum-sustained-traffic-ratetraffic-priority
size The size, in bytes, of the maximum burst length. Valid range is 0 through 4294967295. The default is 1522 and 3044 for DOCSIS 1.0 and 1.1 CMs, respectively.
rate The MRTR for this service class in bits/sec. The value 0 (default) means that no bandwidth is reserved.
maximum-rate-enforcement
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference206
maximum-rate-enforcement
Configures (or disables) the traffic policing algorithm for the targeted traffic scheduling policy.
Within an upstream channel, when the specified policing algorithm is drop and the CMTS must drop the CM’s bandwidth request (because the MSTR is exceeded), the CMTS schedules a null grant in the first MAP message after it has received the request. The request is then discarded in the following MAP message. Advertising the dropped request to the CM accelerates the retry mechanism in the event of congestion in an upstream channel. When the specified policing algorithm is shape, the CMTS defers a grant (by sending a zero-length grant) until the bandwidth request conforms to the MSTR.
Within a downstream channel, when the specified policing algorithm is drop, the CMTS drops packets until they conform with the MSTR.
! maximum-rate-enforcement is within the traffic scheduling submode and requires rf-rw group-privilege.
! no maximum-rate-enforcement applies the default policing algorithm (drop).
Syntax maximum-rate-enforcement {drop | shape}
no maximum-rate-enforcement
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy traffic-scheduling <policy-name>GX$root(config-cable-policy-ts)# maximum-rate-enforcement shape
Specifies shape as the policing algorithm for the given traffic scheduling policy.
Related Commands cable downstream traffic-scheduling-policycable upstream traffic-scheduling-policycable policy traffic-schedulingtraffic-class
drop Specifies that upstream bandwidth requests that do not conform with the MSTR are dropped, and downstream packets are dropped until they conform with the MSTR.
shape Specifies that upstream bandwidth requests that do not conform with the MSTR constraint are shaped.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
minimum-links
207
minimum-links
Sets the minimum number of links required to be up for the targeted aggregate link to be considered operational.
See the interface aggEthernet command for more information regarding aggregate links.
! minimum-links is within the interface aggEthernet submode and requires ip-rw group-privilege.
! The default value is 1.
Syntax minimum-links <number>
Definitions
Examples GX$root# configure terminalGX$root(config)# interface aggEthernet 0
GX$root(config-if-a0)# minimum-links 2
Sets 2 as the minimum number of links required to be up for aggregate link 0 to be considered operational.
Related Commands add-todescriptioninterface aggEthernetport-selectionshutdown
This command is applicable only to the G10 CMTS.
number The number of links. Valid range is 1–8.
mkdir
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference208
mkdir
Creates the specified directory. The parent directory of the created directory must already exist.
! mkdir is a top-level command and requires fs-rw group-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
Causes the contents of a file to display one screen at a time. After a screen has been displayed, pressing Enter advances the display one line, and pressing the space bar advances the display one screen. Pressing q or Q quits this command.
! more is a top-level command and requires fs-ro group-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
more
209
multicast-auth modem
Authorizes the specified CM to access the targeted multicast security association.
! multicast-auth modem is within the security association submode and requires rf-rw group-privilege.
! no multicast-auth modem revokes the authorization of the specified CM to access the targeted multicast security association.
Syntax multicast-auth modem <mac-address>
no multicast-auth modem <mac-address>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable security-association <sa-name>GX$root(config-cable-sec-assoc)# multicast-auth modem 1234.5678.ABCD
Authorizes the CM at MAC address 1234.5678.ABCD to access the targeted multicast security association.
Related Commands cable security-associationencryption-algorithmsecurity-associationtype
mac-address The MAC address of the cable modem specified as xxxx.xxxx.xxxx in hexadecimal.
ping
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference210
ping
Verifies a network connection between the CMTS and the target host.
The ping and ping ip commands send ICMP echo requests to the specified host and display an echo response if the host is reached, or it times out if the host is not reached. If the optional count parameter is not specified, you can interrupt a ping by typing Ctrl-C.
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>} [[count <count>] | [size <size>] | [interval <interval>] |[ttl <ttl>] | [tos <tos>] | [deadline <deadline>] | record-route | quiet]
ping [ip] <ip-address>
ping cable-modem {<ip-address> | <mac-address>}
Definitions
ip-address IP address of the host being pinged. Standard dot-quad notation (xxx.xxx.xxx.xxx).
hostname Hostname of the host being pinged.
count The number of ping requests to send. Valid range is 1 through 1000000.
size The size of the ping request packets (in bytes). Valid range is 1 through 65507. Default is 56 bytes, which is effectively 64 bytes because 8 bytes of ICMP header data are added to the packet.
interval Specifies how often to send ping requests (in seconds). Valid range is 0.1 through 10000 seconds. Default is 1 second.
ttl The TTL (time to live) value to include in the ping request (in seconds). Valid range is 1 through 255. Default is 252.
tos The TOS (type-of-service) bit in the IP header of the ping packets. Valid range is 1 through 255.
deadline The timeout, in seconds, before the ping exits, regardless of how many packets have been sent or received. Valid range is 1 through 1000000.
record-route Includes the RECORD_ROUTE option in the request packet and displays the route buffer on returned packets. Note that the IP header is only large enough for nine such routes. Many hosts ignore or discard this option.
quiet Supresses the echo responses from the targeted host (only the initial and final ping information is displayed). Ctrl-C must be typed to interrupt the ping.
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
ping
211
Examples GX$root# ping 192.168.129.134
Verifies the connection between the CMTS and the device at IP address 192.168.129.134 using ICMP.
PING 192.168.129.134 (192.168.129.134) from 192.168.31.50 : 56(84) bytes of data
.
64 bytes from 192.168.129.134: icmp_seq=0 ttl=252 time=430 usec
64 bytes from 192.168.129.134: icmp_seq=1 ttl=252 time=385 usec
64 bytes from 192.168.129.134: icmp_seq=2 ttl=252 time=377 usec
64 bytes from 192.168.129.134: icmp_seq=3 ttl=252 time=349 usec
64 bytes from 192.168.129.134: icmp_seq=4 ttl=252 time=382 usec
^C [abort]
--- 192.168.129.134 ping statistics ---
5 packets transmitted, 5 packets received, 0% packet loss
round-trip min/avg/max/mdev = 0.349/0.384/0.430/0.033 ms
GX$root# ping 192.168.129.134 count 3 size 200
Verifies the connection between the CMTS and the device at IP address 192.168.129.134 using ICMP. A total of three ICMP echo requests are sent, and each request is 208 bytes in size (200 bytes specified, plus 8 additional ICMP header bytes).
PING 192.168.129.134 (192.168.129.134) from 192.168.31.50 : 200(228) bytes of da
ta.
208 bytes from 192.168.129.134: icmp_seq=0 ttl=252 time=685 usec
208 bytes from 192.168.129.134: icmp_seq=1 ttl=252 time=493 usec
208 bytes from 192.168.129.134: icmp_seq=2 ttl=252 time=471 usec
--- 192.168.129.134 ping statistics ---
3 packets transmitted, 3 packets received, 0% packet loss
round-trip min/avg/max/mdev = 0.471/0.549/0.685/0.099 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
port-selection
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference212
port-selection
Specifies the port selection criterion used for egress traffic for the targeted aggregate link. For example, if dest-ip-address is specified, the NIC Module uses the destination IP address of a packet to determine which port within the aggregate link the packet is forwarded on. In this case, all packets with the same destination IP address are always forwarded to the same port. This ensures the order of the packets is preserved.
See the interface aggEthernet command for more information regarding aggregate links.
! port-selection is within the interface aggEthernet submode and requires ip-rw group-privilege.
! If no criterion is specified, the default is src-mac-address.
Syntax port-selection [src-mac-address | dest-mac-address | src-dest-mac-address | src-ip-address | dest-ip-address | src-dest-ip-address]
Definitions
Examples GX$root# configure terminalGX$root(config)# interface aggEthernet 0
GX$root(config-if-a0)# port-selection src-ip-address
Specifies the source IP address of a packet as the port selection criterion used for egress traffic for aggregate link 0.
Related Commands add-todescriptioninterface aggEthernetminimum-linksshutdown
This command is applicable only to the G10 CMTS.
src-mac-address The source MAC address is used for the port selection criterion.
dest-mac-address The destination MAC address is used for the port selection criterion.
src-dest-mac-address The source and the destination MAC addresses are used for the port selection criterion.
src-ip-address The source IP address is used for the port selection criterion.
dest-ip-address The destination IP address is used for the port selection criterion.
src-dest-ip-address The source and destination IP addresses are used for the port selection criterion.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
pwd
213
pwd
Displays the current directory.
! pwd is a top-level command and requires fs-ro group-privilege.
! There are no parameters with this command.
Syntax pwd
Examples GX$root# pwd
/home
Related Commands cddirlsmkdirrmdir
radius-server host
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference214
radius-server host
Adds a server to the set of RADIUS authentication servers to be used when remote authentication with RADIUS is enabled by the remote-authentication command. Up to three RADIUS servers can be specified.
! radius-server host is within the system submode and requires ad-rw group-privilege.
! no radius-server host removes the specified server.
Syntax radius-server host <ip-address> secret <secret-string> [port <port>] [retry <number>] [timeout <seconds>]
no radius-server host <ip-address>
Definitions
Examples GX$root# configure terminal
GX$root(config)# system
GX$root(config-system)# radius-server host 192.168.100.101 secret DOCSIS
Specifies a RADIUS server at IP address 192.168.100.101 with a shared secret of DOCSIS. The default values for port, retry, and timeout are used by the RADIUS client during authentication.
Related Commands remote-authenticationtacacs-server host
ip-address The IP address of the RADIUS server. Standard dot-quad notation (xxx.xxx.xxx.xxx).
secret-string The shared secret between the CMTS and the RADIUS server.
number An optional parameter that specifies the number of times to retry accessing the RADIUS server if it is not responding within the timeout period (see seconds parameter). Valid range is 1 to 10, and the default is 3.
port If the RADIUS server is not listening on the standard port (1812), this optional parameter can be used to specify another port.
seconds An optional parameter that specifies the time, in seconds, to wait for a reply from the RADIUS server before attempting a retry. The valid range is 1 to 60, and the default is 3.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
real-time-jitter minimum
215
real-time-jitter minimum
Enables and specifies the jitter in a call admission control (CAC) policy for the tolerated grant jitter parameter for unsolicited grant (UGS) and unsolicited grant with activity detection (UGS-AD) scheduling types. The tolerated grant jitter specifies the maximum amount of time that the transmission opportunities can be delayed from the nominal periodic schedule for a service flow.
If the requested jitter (specified by the CM’s configuration file or within a DSA or DSC message) is less than the jitter specified by this command, the jitter used by the CMTS is the value specified by this command (assuming the enforce parameter is not specified). If the jitter requested is greater than the jitter specified by this command, the jitter used by the CMTS is the value requested by the CM.
Using the enforce option specifies that all requested real-time service flows with a jitter less than the jitter parameter are rejected. Using enforce does not affect the jitter parameter specified without the enforce option. Likewise, specifying the jitter parameter without the enforce option does not affect the jitter specified with the enforce option.
! real-time-jitter minimum is within the admission control submode and requires rf-rw group-privilege.
! no real-time-jitter minimum disables the control of the jitter relaxation and enforce parameters.
Syntax real-time-jitter minimum <jitter> [enforce]
no real-time-jitter minimum
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy admission-control <policy-name>GX$root(config-cable-policy-ac)# real-time-jitter minimum 4
Specifies a jitter of 4 microseconds for the tolerated grant jitter parameter for UGS and UGS-AD scheduling types in the given CAC policy.
Related Commands cable policy admission-controlcable downstream admission-control-policycable upstream admission-control-policyreservation minimum-rate-traffic
Relaxing jitter, which increases latency, might result in degraded voice quality for voice-over-IP (VoIP) applications.
jitter The amount of jitter allowed for the CAC policy, specified in microseconds. Valid range is 0 through 4294967295.
enforce Specifies that all requested real-time service flows with a jitter less than this parameter are rejected for the CAC policy. Valid range is 0 through 4294967295.
red drop-profile
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference216
red drop-profile
Configures the drop profile for the random early detection (RED) congestion management algorithm for the targeted congestion management policy.
A drop profile consists of pairs of (X,Y) coordinates that form a graph that conveys the drop probability (Y) for a given queue fill percentage (X). The fill percentage corresponds to the percentage of the maximum queue traversal latency (referred to as the maximum RED latency) specified in the red latency max command. Up to 64 coordinates can be specified by this command. The CMTS assumes that the graph begins at (0,0) and ends at (100,100). Points of the graph in between the beginning, ending, and specified coordinates are interpolated by the CMTS. The maximum RED latency defines the (100,100) point of the drop profile.
The drop profile is used to drop some packets before the average queue traversal latency becomes too high. It is important to set up a correct drop profile to have an effective congestion avoidance and management mechanism. For example, if the drop probability is constant from 0% through 100% of the queue traversal latency, congestion can build to the point where all packets are suddenly dropped when the average queue traversal latency reaches the maximum RED latency. This implies the synchronous dropping of all packets of all TCP flows, at which point all TCP sources stop transmitting packets and the channel becomes underutilized. The goal of RED is to keep the average queue traversal latency low during sustained congestion, while allowing small bursts of traffic.
RED can be applied to all downstream and upstream traffic queues on a per-channel basis.
! red drop-profile is within the congestion control submode and requires rf-rw group-privilege.
Syntax red drop-profile <fill-percentage>/<drop-probability> [<fill-percentage>/<drop-probability> ... <fill-percentage>/<drop-probability>]
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy congestion-control <policy-name>GX$root(config-cable-policy-cc)# red drop-profile 0/0 50/40 100/100
Specifies three points in the RED drop profile for the given congestion control policy. If the maximum RED latency is 100 milliseconds, the drop probability is 40% for packets with an expected queue traversal latency of 50 milliseconds (50% of 100 milliseconds).
Related Commands cable downstream congestion-control-policycable policy congestion-controlcable upstream congestion-control-policy
RED requires that you find a balance between the number of packets dropped and the queue fill percentages. Misconfiguring RED parameters can result in low port utilization or high packet latencies.
fill-percentage The X-coordinate of the drop profile graph that represents the percentage of the maximum RED latency. Up to 64 (X,Y) coordinates can be specified.
drop-probability The Y-coordinate of the drop profile graph that represents the drop probability. Up to 64 (X,Y) coordinates can be specified.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
red latency max
217
red latency max
red latency max
Configures the maximum queue traversal latency for a packet at which the random early detection (RED) drop probability becomes 100% (referred to as the maximum RED latency).
A channel can encounter transient congestion, in which case the average traversal latency can be higher than the maximum RED latency. At this point, all new packets are dropped until the average traversal latency decreases below the maximum RED latency.
The maximum latency specifies the (100,100) point of the drop profile. See the red drop-profile command for more information on RED.
! red latency max is within the congestion control submode and requires rf-rw group-privilege.
Syntax red latency max <latency>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy congestion-control <policy-name>GX$root(config-cable-policy-cc)# red latency max 100
Specifies a maximum RED latency of 100 milliseconds for the given congestion control policy. The drop probability is 100% for packets with an expected queue traversal latency of 100 milliseconds.
Related Commands cable downstream congestion-control-policycable policy congestion-controlcable upstream congestion-control-policyred drop-profile
relay-agent-option
Used to configure a subscriber group under the subscriber group submode. The basic underlying functionality of this command is the same as the cable relay-agent-option command. See the cable subscriber-group command for more details regarding subscriber groups.
latency The maximum queue latency (in milliseconds) at which the drop probability becomes 100%. The upper limit is 500 milliseconds.
reload
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference218
reload
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 ad-rw group-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 disrupts 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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
remote-authentication
219
remote-authentication
Configures the CMTS to use either the RADIUS or TACACS+ remote authentication mechanism. If the remote authentication servers do not respond, the CMTS uses the local password database, unless the no-local-fallback parameter is specified.
See the G1 CMTS and G10 CMTS Installation and Operation manuals for details regarding authentication server configuration using Juniper Networks-specific RADIUS and TACACS+ attributes.
! remote-authentication is within the system submode and requires ad-rw group-privilege.
! The default setting is no remote authentication (local password database is used).
Syntax remote-authentication {<radius> | <tacacs>} [no-local-fallback]
no remote-authentication
Definitions
Examples GX$root# configure terminal
GX$root(config)# system
GX$root(config-system)# remote-authentication radius
Configures the CMTS to use a remote RADIUS authentication server. If the server does not respond, the local password database is used for authentication.
Related Commands radius-server hosttacacs-server host
The parameter to select the TACACS+ protocol is tacacs. This should not be confused with the TACACS protocol, which is not supported by the CMTS.
radius Specifies that the authentication mechanism uses the RADIUS protocol.
tacacs Specifies that the authentication mechanism uses the TACACS+ protocol.
no-local-fallback An optional parameter that disables the usage of the local authentication mechanism (local password database) when the remote authentication servers do not respond.
rename
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference220
rename
Renames a file in the CMTS.
! rename is a top-level command and requires fs-rw group-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 is changed. Can include the path to the file. The parent directory of the new file must already exist.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
request chassis ccm billing-sync-primary
221
request chassis ccm billing-sync-primary
Copies the billing files from the secondary Chassis Control Module to the primary Chassis Control Module (if a functional primary module is available) in a redundant configuration. This allows an operator to apply the billing files to the primary module before switching back to it.
This command can only be issued to the secondary module and assumes a switchover has taken place.
See the G10 CMTS Functional Description for more information regarding Chassis Control Module redundancy and subscriber account management.
! request chassis ccm billing-sync-primary is a top-level command and requires ad-rw group-privilege.
Syntax request chassis ccm billing-sync-primary
Examples GX$root# request chassis ccm billing-sync-primary
Copies the billing files from the secondary Chassis Control Module to the primary Chassis Control Module.
Related Commands request chassis ccm config-sync-primaryrequest chassis ccm remind-to-replacerequest chassis ccm standby-ccm synchronizerequest chassis ccm switch-to-standbyshow chassis ccm pending switch-over
This command is applicable only to the G10 CMTS.
request chassis ccm config-sync-primary
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference222
request chassis ccm config-sync-primary
Copies the configuration files from the secondary Chassis Control Module to the primary Chassis Control Module (if a functional primary module is available) in a redundant configuration. This allows an operator to apply the configuration files to the primary module before switching back to it.
This command can only be issued to the secondary module and assumes a switchover has taken place.
See the G10 CMTS Functional Description for more information regarding Chassis Control Module redundancy.
! request chassis ccm config-sync-primary is a top-level command and requires ad-rw group-privilege.
Syntax request chassis ccm config-sync-primary
Examples GX$root# request chassis ccm config-sync-primary
Copies the configuration files from the secondary Chassis Control Module to the primary Chassis Control Module.
Related Commands request chassis ccm billing-sync-primaryrequest chassis ccm remind-to-replacerequest chassis ccm standby-ccm synchronizerequest chassis ccm switch-to-standbyshow chassis ccm pending switch-over
This command is applicable only to the G10 CMTS.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
request chassis ccm remind-to-replace
223
request chassis ccm remind-to-replace
Enables (or disables) the vendor-specific event that reminds the operator that a switchover from the primary Chassis Control Module to the secondary Chassis Control Module in a redundant configuration has occurred (see the G10 CMTS Installation and Operation manual for a list of vendor-specific events). In this case, the primary module should be replaced as soon as possible, followed by a switchback to the primary module.
See the G10 CMTS Functional Description for more information regarding Chassis Control Module redundancy.
! request chassis ccm remind-to-replace is a top-level command and requires ad-rw group-privilege.
! This feature is enabled by default.
! no request chassis ccm remind-to-replace disables this feature.
Syntax request chassis ccm remind-to-replace <minutes>
no request chassis ccm remind-to-replace
Definitions
Examples GX$root# request chassis ccm remind-to-replace 120
Sets the frequency with which this reminder event is generated to 120 minutes.
Related Commands request chassis ccm billing-sync-primaryrequest chassis ccm config-sync-primaryrequest chassis ccm standby-ccm synchronizerequest chassis ccm switch-to-standbyshow chassis ccm pending switch-over
This command is applicable only to the G10 CMTS.
minutes The frequency, in minutes, at which this reminder event is generated.
request chassis ccm standby-ccm synchronize
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference224
request chassis ccm standby-ccm synchronize
Synchronizes the software version (normal and upgrade) on the secondary Chassis Control Module with the primary Chassis Control Module in a redundant configuration. If a secondary module is installed in a CMTS and its software version is different from the version running on the primary module, the secondary module is not enabled for switchovers until its software is synchronized (upgraded or downgraded) to the version running on the primary module.
After this command has been issued, the CMTS must be rebooted (reload command) to complete the software synchronization. Once the two Chassis Control Modules are successfully running in a redundant configuration, performing a software upgrade of the primary module also upgrades the secondary module.
See the G10 CMTS Functional Description for more information regarding Chassis Control Module redundancy.
! request chassis ccm standby-ccm synchronize is within the configure terminal mode and requires ad-rw group-privilege.
Syntax request chassis ccm standby-ccm synchronize
Examples GX$root# request chassis ccm standby-ccm synchronize
Synchronizes the software version of the secondary Chassis Control Module with the primary Chassis Control Module after the next CMTS reboot.
Related Commands request chassis ccm billing-sync-primaryrequest chassis ccm config-sync-primaryrequest chassis ccm remind-to-replacerequest chassis ccm switch-to-standbyshow chassis ccm pending switch-over
This command is applicable only to the G10 CMTS.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
request chassis ccm switch-to-standby
225
request chassis ccm switch-to-standby
Allows an operator to initiate an immediate or scheduled switchover from the primary Chassis Control Module to the secondary Chassis Control Module in a redundant configuration. This might be performed if the primary module needs to be removed or replaced. The modified entity corresponds to pbcG10CmtsCCMAction, and optionally, pbcG10CmtsCcmSwitchIn and pbcG10CmtsCcmSwitchAt, in the PBC-KODIAK-M-G10-MIB.
See the G10 CMTS Functional Description for more information regarding Chassis Control Module redundancy.
! request chassis ccm switch-to-standby is a top-level command and requires ad-rw group-privilege.
! If an optional parameter is not specified, the switchover occurs immediately.
Syntax request chassis ccm switch-to-standby [[in <seconds>] | [at <time>] | cancel]
Definitions
Examples GX$root# request chassis ccm switch-to-standby in 600
Schedules a Chassis Control Module switchover in 600 seconds.
Related Commands request chassis ccm billing-sync-primaryrequest chassis ccm config-sync-primaryrequest chassis ccm remind-to-replacerequest chassis ccm standby-ccm synchronizerequest chassis ccm switch-to-standbyshow chassis ccm pending switch-over
This command is applicable only to the G10 CMTS.
seconds The time, in seconds, when the switchover is to take place. Corresponds to pbcG10CmtsCcmSwitchIn.
time The time of day at which the switchover is to take place, specified as hh:mm. Corresponds to pbcG10CmtsCcmSwitchAt.
cancel A pending switchover is cancelled if this parameter is specified. This generates a vendor-specific event.
reservation minimum-rate-traffic
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference226
reservation minimum-rate-traffic
For the targeted call admission control (CAC) policy, sets the maximum allowable ratio of the aggregate minimum reserved traffic rate (MRTR) for all admitted service flows to the channel bandwidth. The CMTS ensures that this ratio is not exceeded by dropping CMs based on the traffic priority of their service flows. The ratio can be set to greater than 100% (which allows the operator to overprovision the downstream with respect to the best-effort rate guarantee).
! reservation minimum-rate-traffic is within the admission control submode and requires rf-rw group-privilege.
! no reservation minimum-rate-traffic disables the control of the best-effort MRTR for the CAC policy.
Syntax reservation minimum-rate-traffic <percent>
no reservation minimum-rate-traffic
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy admission-control <policy-name>GX$root(config-cable-policy-ac)# reservation minimum-rate-traffic 80
Specifies a maximum aggregate best-effort MRTR to channel bandwidth ratio of 80% for the given CAC policy.
Related Commands cable policy admission-controlcable downstream admission-control-policycable upstream admission-control-policyreal-time-jitter minimum
percent The maximum aggregate best-effort MRTR to channel bandwidth ratio, in percent, for the CAC policy. Valid values are 0–4294967295, where 0 disables best-effort reserved traffic rate control. Values greater than 100 are allowed for overprovisioning.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
reset-slot
227
reset-slot
Causes the DOCSIS Module in the specified slot to be restarted (rebooted)
! reset-slot is a top-level command and requires ad-rw group-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
Removes an existing directory in the CMTS. If the current directory no longer exists as a result of this command, the current directory is reset to /home.
! rmdir is a top-level command and requires fs-rw group-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 disrupts 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.
security-association
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference228
security-association
Applies the specified multicast security association name defined by the cable security-association command to the targeted IP multicast map. Issue the write memory command to make this association persistent across reboots.
! security-association is within the multicast map submode and requires rf-rw group-privilege.
! no security-association deletes the association of the specified multicast security association and the IP multicast map.
Syntax security-association <sa-name>
no security-association
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable multicast-map <map-name>GX$root(config-cable-mm)# security-association <sa-name>
Applies a multicast security association to the targeted IP multicast map.
Related Commands cable multicast-mapip-multicastservice-class
sa-name The multicast security association name to apply to the targeted IP multicast map.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
service-class
229
service-class
Applies the specified service class name defined by the cable service-class command to the targeted IP multicast map.
! service-class is within the multicast map submode and requires rf-rw group-privilege.
! no service-class deletes the association of the specified service class and the IP multicast map.
Syntax service-class <class-name>
no service-class
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable multicast-map <map-name>GX$root(config-cable-mm)# service-class <class-name>
Applies a service class to the targeted IP multicast map.
Related Commands cable multicast-mapip-multicastsecurity-association
class-name The service class name to apply to the targeted IP multicast map.
session timeout
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference230
session timeout
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 within the configure terminal mode and requires ad-rw group-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
231
show cable address-verification
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 and SNMP Reference232
show cable flap-list
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-frequency-adjust |by-interface [<slot> [<if>]] | by-upstream [<slot> [<channel>]] | by-mac [<mac-address>]}
Definitions
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) in 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-frequency-adjust Sorts the flap-list in descending order of the FAdj 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
233
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 FAdj SNR MER CER
LTime LEvnt Total FAdjAmnt SNRavg MERavg CERavg
0002.0001.2C28 C02/0 U00/0 0 0 72 0 0 0 0
May 06 15:18:21 PADJ FLAP 72 0 34 27 0
0000.CA25.1C4A C02/0 U00/0 0 0 59 0 0 0 0
May 06 15:10:42 PADJ FLAP 59 0 34 28 0
0020.40A7.278C C02/0 U00/0 45 0 3 0 0 1 0
May 06 15:23:12 IM FLAP 49 0 34 12 72
00E0.6F03.1061 C02/0 U00/0 0 0 48 0 0 0 0
May 06 15:21:40 PADJ FLAP 48 0 34 27 0
0010.951A.0424 C02/0 U00/0 0 0 0 6 0 0 0
May 07 14:14:54 FADJ FLAP 6 104 28 24 0
0010.9517.91B2 C02/0 U00/0 0 0 0 4 0 0 0
May 07 14:15:49 FADJ FLAP 4 -107 28 24 0
0010.951A.044F C02/0 U00/0 0 0 0 3 0 0 0
May 07 14:16:19 FADJ FLAP 3 106 29 25 0
Total checked entries 7
Table 7 explains each statistic provided in the flap-list. All thresholds cited in Table 7 are parameters within the cable modem flap-list and cable upstream modem flap-list CLI commands.
show cable flap-list
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference234
Table 7: Flap-list Statistics
Related Commands cable modem flap-listcable upstream modem flap-listclear cable modem flap-listshow cable modem flap
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.
FAdj This counter is incremented when the absolute value of the accumulated sum of all the relative frequency offset corrections sent to a CM, following initial ranging or the latest frequency adjustment flap, is greater than or equal to the threshold frequency-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.
FAdjAmnt The accumulated sum of all the relative frequency offset corrections sent to a CM that triggered the flap.
SNRavg The average SNR for the CM.
MERavg The average MER for the CM.
CERavg The average CER for the CM.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem
235
show cable modem
Optionally displays the number of CMs that exist in various operational states, or displays individual modem information.
! 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.
show cable modem [vpn:<vpn-id>] [summary [total]]
Displays all CMs associated with the given VPN ID.
Definitions
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 displays 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.
vpn-id Information is displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
show cable modem
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference236
Examples GX$root> show cable modem 2/0 upstream 0
Display individual information for each CM in upstream channel 0 in slot 2 / interface 0. See Table 8 for a description of the parameters displayed.
Intrfc Prim Online Timing Rec QoS IP-Address MAC-Address Reg Modul
Vpn
Sid State Offset Power
Id
C2/0/U0 10 online 1999 0.0 - 192.168.31.103 0000.39A1.684F 1.1 TDMA
C2/0/U0 8 online 2013 0.0 - 192.168.31.104 0000.39A1.764F 1.1 TDMA
C2/0/U0 9 online 2001 0.1 - 192.168.31.102 0000.39BB.B851 1.1 TDMA
C2/0/U0 7 online 2034 -0.3 - 192.168.31.101 0000.39D7.1251 1.1 TDMA
GX$root> show cable modem 192.168.31.103
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 Reg Modul
Vpn
Sid State Offset Power
Id
C2/0/U0 10 online 1999 0.0 - 192.168.31.103 0000.39A1.684F 1.1 TDMA
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 10 on page 238 for a description of the operational states displayed.
Cable Modem Operational States
Interface CM Dstry Dclr Rng Rng Rng IP Reg Access
Qty Abort Compl Compl Denied
C2/0/U0 5 0 0 0 0 0 0 5 0
C2/1/U2 2 0 0 0 0 0 0 2 0
Totals: 7 0 0 0 0 0 0 7 0
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 5 0 0 0 0 0 0 5 0
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem
237
Table 8: Parameters Displayed by ‘show cable modem’
Table 9: Description of Online States
Parameter Description
Intrfc 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 9 for a list of these states, then see Table 10 for the correspondence to the CM operational states that can be displayed with the summary option of the show cable modem command. Rogue CMs can be identified by the presence of one of the following appended to the online state (see the cable rogue-modem command):
! –ru: The CM is presumed to be unprovisioned.
! –rc: The CM was statically configured as rogue by the operator.
! –rt: The CM was declared rogue because it did not use DHCP and TFTP for configuration before registration.
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.
Reg Modul The DOCSIS version and the upstream modulation mode 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 10).
init(r2) The CM has entered the ranging state (see Rng in Table 10).
init(rc) The CM has entered the ranging-complete state (see Rng Compl in Table 10).
init(i) The CM has entered the IP-complete state (see IP Compl in Table 10).
online The CM has entered the registration-complete state (see Reg in Table 10).
offline The CM has entered the destroyed or ranging-aborted state (see Dstry or Rng Abort, respectively, in Table 10).
reject The CM has entered the access-denied state (see Access Denied in Table 10).
show cable modem
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference238
Table 10: Description of CM Operational States
Related Commands show cable modem connectivityshow cable modem countersshow cable modem cpeshow cable modem errorsshow cable modem flapshow cable modem offlineshow cable modem physhow cable modem ranging-statisticsshow cable modem registeredshow cable modem unregisteredshow cable modem verboseshow 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 is 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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem connectivity
239
show cable modem connectivity
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 10 on page 238 for definitions of these states).
! show cable modem connectivity is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] connectivity
Displays information for all CMs supported by the CMTS, or optionally, the specified CM, or CMs associated with the specified VPN.
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
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.
vpn-id Information is displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
slot/if The CMTS slot and interface number, which displays 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).
show cable modem connectivity
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference240
Table 11: 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 unregisteredshow cable modem verbose
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 11 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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem counters
241
show cable modem counters
Displays byte and packet counters for all active service flows for the specified CMs (for DOCSIS 1.0 CMs, the counters correspond to the equivalent primary service flows created corresponding to the primary class-of-service).
! show cable modem counters is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | <slot/if> | vpn:<vpn-id>] counters
Displays counters for all CMs supported by the CMTS, or optionally, the specified CM, all CMs in the given slot/interface, or CMs associated with the specified VPN.
Definitions
Examples GX$root> show cable modem 2/0 counters
Displays counters for all CMs in slot 2 / interface 0. See Table 12 for a description of the parameters displayed.
Mac Address Us Bytes Us Packets Ds Bytes Ds Packets Sample Time
0000.39A1.684F 13036 80 11548 80 Fri Oct 18 02:35:20 20
02
0000.39A1.764F 13036 80 11548 80 Fri Oct 18 02:35:20 20
02
0000.39BB.B851 13036 80 11548 80 Fri Oct 18 02:35:20 20
02
0000.39D7.1251 13036 80 11548 80 Fri Oct 18 02:35:20 20
02
0090.961E.047A 90522 689 26050 195 Fri Oct 18 02:35:20 20
02
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.
vpn-id Counter statistics are displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
slot/if The CMTS slot and interface number, which displays counters for 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)
show cable modem counters
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference242
Table 12: Parameters Displayed by ‘show cable modem counters’
Related Commands show cable modemshow cable modem errorsshow cable modem verbose
Parameter Description
Mac Address The MAC address of the cable modem.
Us Bytes The cumulative number of bytes received in the upstream from the CM on all active service flows.
Us Packets The cumulative number of packets received in the upstream from the CM on all active service flows.
Ds Bytes The cumulative number of bytes transmitted in the downstream to the CM on all active service flows.
Ds Packets The cumulative number of packets transmitted in the downstream to the CM on all active service flows.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem cpe
243
show cable modem cpe
Displays a list of known CPEs behind a specified CM or set of CMs. Table 13 on page 244 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> | vpn:<vpn-id>] cpe
Displays a list of all known CPEs, or optionally, the CPEs associated with a specified CM, or the CPEs that belong to the specified VPN.
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 Vpn Id
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.
vpn-id Information is displayed for all CPEs associated with this VPN ID. Valid range is 601–4000.
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 is 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 is displayed based on the Service identifier.
sid Service identifier. (1–8191)
SIDs can be viewed with the show cable modem command.
show cable modem cpe
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference244
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 unregisteredshow cable modem verbose
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 9 on page 237 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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem errors
245
show cable modem errors
Displays CM error statistics, such as bit error rate (BER), codeword error rate (CER), and modulation error rate (MER). BER, CER, and MER calculations are based on recent traffic (at least 1000 bursts) to offer sufficient accuracy.
! show cable modem errors is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] errors
Displays error statistics for all CMs supported by the CMTS, or optionally, the specified CM, or CMs associated with the specified VPN.
show cable modem <slot/if> [upstream <channel>] errors
Displays error statistics 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 2/0 errors
Displays error statistics for all CMs in slot 2 / interface 0. See Table 14 for a description of the parameters displayed.
Interface CM BER CER (CCER UCER) MER CRC HCS
C2/0/U0 0040.3609.44EB 0.06 29.23 (0.00 29.23) 28.94 0 2
C2/0/U0 0090.8339.BACE 0.00 0.00 (0.00 0.00 ) 29.13 0 0
C2/0/U0 00D0.59FD.F519 0.00 0.00 (0.00 0.00 ) 27.84 0 0
C2/0/U1 0000.39BB.AA51 0.00 0.00 (0.00 0.00 ) 25.63 0 0
C2/0/U1 0001.0327.DCAA 0.00 0.00 (0.00 0.00 ) 28.34 0 0
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.
vpn-id Error statistics are displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
slot/if The CMTS slot and interface number, which displays error statistics for 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 error statistics associated with CMs on the specified upstream channel are 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).
show cable modem errors
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference246
Table 14: Parameters Displayed by ‘show cable modem errors’
Related Commands clear cable modem phy-statisticsshow cable modemshow cable modem countersshow cable modem physhow cable modem verbose
Parameter Description
Interface The interface specified as Cslot/if/Uchannel.
CM The MAC address of the CM.
BER The bit error rate of all packets received by the CMTS from the specified CM(s).
CER The codeword error rate of all packets received by the CMTS from the specified CM(s).
CCER The correctable codeword error rate of all packets received by the CMTS from the specified CM(s). (CCER + UCER = CER).
UCER The uncorrectable codeword error rate of all packets received by the CMTS from the specified CM(s). (CCER + UCER = CER).
MER The modulation error rate of all packets received by the CMTS from the specified CM(s).
CRC The total number of cyclic redundancy code errors of all packets received by the CMTS from the specified CM(s).
HCS The total number of header check sequence errors of all packets received by the CMTS from the specified CM(s).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem flap
247
show cable modem flap
Displays flap data for CMs.
! show cable modem flap is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] flap
Displays flap data for all CMs supported by the CMTS, or optionally, the specified CM, or CMs associated with the specified VPN.
show cable modem <slot/if> [upstream <channel>] flap
Displays flap data 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 2/0 flap
Displays flap data for all CMs in slot 2 / interface 0. See Table 7 on page 234 for a description of the parameters displayed.
MacAddr CableIF IM SM PAdj SNR MER CER LTime
LEvnt Total SNRavg MERavg CERavg
0000.39A1.684F C02/0 U00/0 0 0 3 0 1 1 Oct 18 04:
51:20 CER FLAP 5 34 28 0
0000.39A1.764F C02/0 U00/0 0 0 3 0 1 1 Oct 18 04:
02:17 CER FLAP 5 34 28 0
0000.39BB.B851 C02/0 U00/0 0 0 3 0 1 0 Oct 17 22:
54:56 MER FLAP 4 34 28 0
0000.39D7.1251 C02/0 U00/0 0 0 3 0 1 1 Oct 18 04:
53:41 CER FLAP 5 34 28 0
Total checked entries 4
Related Commands cable modem flap-listcable upstream modem flap-listshow cable flap-listshow cable modemshow cable modem errorsshow cable modem physhow cable modem ranging-statisticsshow cable modem verbose
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.
vpn-id Flap data is displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
slot/if The CMTS slot and interface number, which displays flap data for 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 flap data 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).
show cable modem offline
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference248
show cable modem offline
Displays a list of offline CMs, along with various operational parameters. A CM is considered offline if it is in the offline or reject state as defined in Table 9 on page 237.
! show cable modem offline is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] offline
Displays parameters for all offline CMs, or optionally, those offline CMs associated with the specified VPN, or displays whether the CM with the given address is offline.
show cable modem <slot/if> [upstream <channel>] offline
Displays 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 8 on page 237 for a definition of all parameters displayed).
Related Commands show cable modemshow cable modem connectivityshow cable modem cpeshow cable modem physhow cable modem ranging-statisticsshow cable modem registeredshow cable modem unregisteredshow cable modem verbose
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.
vpn-id Information is displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
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 is 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
249
show cable modem phy
Displays CM physical layer (PHY) parameters.
! show cable modem phy is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] phy
Displays physical parameters for all CMs supported by the CMTS, or optionally the CM with the given address, or CMs associated with the specified VPN.
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 UsFreq Tming uRfl Unerrored Corrtbl Err
ored
MAC Address dBmV dB Drift(Hz) Ofset dBc
C2/0/U0 0090.961E.046E 0.9 38.8 0 2591 32 33 0
0
C2/0/U1 0000.F00A.D087 -0.6 36.1 0 577 22 209 0
0
C2/1/U2 0010.9518.C0BA -0.5 32.4 53 2485 23 584 0
0
C2/1/U3 0010.951A.03F6 0.3 33.3 34 2487 25 583 0
0
C2/2/U4 0010.9517.92AB -2.4 26.4 0 2482 31 4755 0
0
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.
vpn-id Physical layer parameters are displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
slot/if The CMTS slot and interface number, which displays 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).
show cable modem phy
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference250
Table 15: Parameters Displayed by ‘show cable modem phy’
Related Commands clear cable modem phy-statisticsshow cable modemshow cable modem connectivityshow cable modem cpeshow cable modem errorsshow cable modem flapshow cable modem offlineshow cable modem ranging-statisticsshow cable modem registeredshow cable modem unregisteredshow cable modem verboseshow 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.
UsFreq Drift(Hz) The accumulated sum of all the relative frequency offset corrections sent to a CM following initial ranging (in Hz).
Tming Ofset The timing adjustment provided by the CMTS in a ranging response. Units are (6.25µs/64). Zero is returned if unknown.
uRfl dBc Total microreflections. This parameter is identical to the docsIfCmtsCmStatusMicroreflections object in RF-MIBv2-04.
Unerrored The number of codewords received without error. Corresponds to the docsIfCmtsCmStatusUnerroreds object in RF-MIBv2-04.
Corrtbl The number of codewords received with error that were corrected. Corresponds to the docsIfCmtsCmStatusUncorrectables object in RF-MIBv2-04.
Errored The number of codewords received with error that were uncorrectable. Corresponds to the docsIfCmtsCmStatusCorrecteds object in RF-MIBv2-04.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem qos-profile
251
show cable modem qos-profile
Displays all CMs associated with the specified QoS profile ID (which corresponds to the docsIfCmtsServiceQosProfile object in RF-MIBv2-04). The command can be used to display information pertaining to all CMs, to CMs in a slot/interface, or to CMs associated with the specified VPN.
! show cable modem qos-profile is a top-level command and is available to all users.
Syntax show cable modem [<slot/if> | vpn:<vpn-id>] qos-profile <qos-profile-id>
Definitions
Examples GX$root> show cable modem 2/0 qos-profile 1
Displays all CMs in slot 2 / interface 0 associated with QoS profile ID 1. See Table 8 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/0/U0 24 online 1583 0.4 - 20.1.1.67 0000.39BB.AA51 1.1 601
C2/0/U0 27 online 1747 0.1 1 20.1.1.57 0001.0327.DCAA 1.0
C2/0/U1 23 online 1860 0.0 1 20.1.1.56 0002.0001.29B3 1.0
C2/0/U0 9 online 1595 0.0 1 20.1.1.58 0010.9505.79FB 1.0
C2/0/U1 19 online 1317 -0.3 1 20.1.1.60 0030.D002.1B71 1.0
C2/0/U1 13 online 555 -0.6 1 20.1.1.51 0040.3609.44EB 1.0 601
C2/0/U0 7 online 1283 0.2 1 20.1.1.61 0090.8339.BACE 1.0 601
C2/0/U1 18 online 2024 -0.1 - 20.1.1.54 0090.961E.0482 1.1 700
Table 16: Parameters Displayed by ‘show cable modem qos-profile’
Related Commands show cable modem verbose
slot/if The CMTS slot and interface number, which displays all CMs with the specified QoS profile ID 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)
vpn-id CMs with the specified QoS profile ID that are associated with this VPN ID are displayed. Valid range is 601–4000.
qos-profile-id CMs that are associated with this QoS profile ID are displayed. Valid options are numbers from 0 to 65535.
Parameter Description
Intrfc 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 9 on page 237 for a list of these states.
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.
Reg Modul The DOCSIS version and the upstream modulation mode of the CM.
Vpn Id The VPN ID to which this CM belongs (if applicable).
show cable modem ranging-statistics
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference252
show cable qos profile
show cable modem ranging-statistics
Displays CM ranging statistics, such as the number of initial maintenance requests seen, and the number of station maintenance opportunities scheduled.
! show cable modem ranging-statistics is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] ranging-statistics
Displays ranging statistics for all CMs supported by the CMTS, or optionally, the specified CM, or CMs associated with the specified VPN.
show cable modem <slot/if> [upstream <channel>] ranging-statistics
Displays ranging statistics 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 2/0 ranging-statistics
Displays ranging statistics for all CMs in slot 2 / interface 0. See Table 11 for a description of the parameters displayed.
Interface CM InitReq SmOpp SmReq SmCont Abort-T Abort-O MaxPwr MaxF
req MaxTime L-Opp L-Req
C2/0/U0 0000.39BB.AA51 32 801 504 1 21 0 0.50 55
-30 22 1
C2/0/U0 0002.0001.29B3 26 689 475 0 12 0 0.50 203
-6 14 0
C2/0/U0 0010.9505.79FB 21 622 490 0 7 0 -2.00 -87
-2 9 0
C2/0/U0 0030.D002.1B71 18 634 473 0 10 0 -0.75 113
7 12 0
C2/0/U0 0040.3609.44EB 21 669 472 0 12 0 0.50 71
-4 13 0
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.
vpn-id Ranging statistics are displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
slot/if The CMTS slot and interface number, which displays ranging statistics for 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 ranging statistics associated with CMs on the specified upstream channel are 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).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem ranging-statistics
253
Table 17: Parameters Displayed by ‘show cable modem ranging-statistics’
Related Commands clear cable modem ranging-statisticsshow cable modemshow cable modem flapshow cable modem offlineshow cable modem physhow cable modem registeredshow cable modem unregisteredshow cable modem verbose
Parameter Description
Interface The slot/interface and upstream channel on which the CM resides, in the form: Cslot/interface Uchannel/port
CM The MAC address of the CM.
InitReq The number of initial maintenance requests seen.
SmOpp The number of station maintenance (SM) opportunities scheduled.
SmReq The number of RNG-REQ messages received in SM opportunities.
SmCont The number of RNG-RSP messages sent during SM with a ranging status of continue.
Abort-T The number of aborted SM due to timeout.
Abort-O The number of aborted SM due to other reasons.
MaxPwr The maximum power correction sent to the CM (in dB).
MaxFreq The maximum frequency correction sent to the CM (in Hertz).
MaxTime The maximum timing correction sent in an SM opportunity (in 1/64th of a time tick).
L-Opp The number of large-SM opportunities scheduled. A large-SM opportunity is proprietary to a G-series CMTS, and is scheduled when a CM does not respond to an SM opportunity twice in a row. Large-SM opportunities are scheduled for CMs that cannot range due to timing errors that are not compatible with DOCSIS. From the CM’s perspective, a large-SM opportunity is DOCSIS compatible. Large-SMs are rate-limited to one every 50 ms.
L-Req The number of RNG-REQ messages received in large-SM opportunities.
show cable modem registered
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference254
show cable modem registered
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> | vpn:<vpn-id>] registered
Displays parameters for all registered CMs, or optionally displays whether the CM with the given address is registered, or CMs associated with the specified VPN.
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 8 on page 237 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 ranging-statisticsshow cable modem unregistered
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.
vpn-id Parameters are displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
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 is 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 remote-query
255
show cable modem remote-query
Displays various CM statistics and state information using the SNMP protocol for CMs that are in the IP-complete or registration-complete states.
! show cable modem remote-query is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | <slot/if> | vpn:<vpn-id>] remote-query <snmp-entity>
Displays information for all CMs supported by the CMTS, or optionally, the specified CM, all CMs in the given slot/interface, or CMs associated with the specified VPN.
Definitions
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.
vpn-id Information is displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
slot/if The CMTS slot and interface number, which displays information for 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).
snmp-entity The CM entity to be displayed:
! description—Displays the sysDescr for the CMs from the SNMPv2-MIB.
! status—Displays the docsIfCmStatusTable from RF-MIBv2-04.
! interfaces—Displays key information from the ifTable from the IF-MIB.
! signal-quality—Displays information about the downstream signal quality as seen by the CMs:
! RxPower is docsIfDownChannelPower from RF-MIBv2-04.
! Information from the docsIfSignalQualityTable from RF-MIBv2-04.
! event-log—Displays the event log (docsDevEventTable from the DOCS-CABLE-DEVICE-MIB) for the CMs.
! date-time—Displays the date and time setting (docsDevDateTime from the DOCS-CABLE-DEVICE-MIB) on the CMs.
show cable modem remote-query
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference256
Examples GX$root> show cable modem 2/0 remote-query signal-quality
Displays information about the downstream signal quality for all CMs in slot 2 / interface 0.
MAC IP RxPower SNR ------------ Codewords --
------------- CER
UnErroreds Correcteds
Erroreds
--------------------------------------------------------------------------------
----------------------------------------------------
0:0:39:a1:68:4f 192.168.31.103 -15.9 dBm 31.9 dB 1951813387 134
0 0
0:0:39:a1:76:4f 192.168.31.104 -13.8 dBm 31.0 dB 1951750200 155
4 2.05e-07
0:0:39:bb:b8:51 192.168.31.102 -14.1 dBm 31.2 dB 1951876479 145
60 3.07e-06
0:0:39:d7:12:51 192.168.31.101 -14.7 dBm 30.8 dB 1951844896 136
70 3.59e-06
0:90:96:1e:4:7a 192.168.31.105 -16.4 dBm 31.4 dB 2023351706 0
0 0
Related Commands cable modem snmp-community
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable modem rogue
257
show cable modem rogue
Displays a list of CMs that have been declared as rogue. The entity displayed corresponds to the pbcCmtsRogueCmTable in the PBC-CMTS-MIB.
See the cable rogue-modem command for more information regarding rogue CMs.
! show cable modem rogue is a top-level command and is available to all users.
Syntax show cable modem [<ip-address> | <mac-address> | vpn:<vpn-id>] rogue
Displays all rogue CMs supported by the CMTS, or optionally, the specified CM, or CMs that belong to the specified VPN.
show cable modem <slot/if> [upstream <channel>] rogue
Displays rogue CMs in the given slot/interface, or optionally, only those rogue CMs in the specified upstream channel in the given slot/interface.
Definitions
Examples GX$root> show cable modem 2/0 rogue
Displays a list of rogue CMs in slot 2 / interface 0. The display is formatted identically to the display produced by the show cable modem command. The online state is appended with the rogue CM indication (see Table 10 on page 215 for more information).
Intrfc Prim Online Timing Rec QoS IP-Address MAC-Address Ver
Vpn Cable
Sid State Offset Power Id
ifIndex
C2/0/U0 8 online-rc 579 -0.2 - 10.135.2.110 0000.F00A.D084 1.1
5
C2/0/U0 0 offline-rc 579 -0.2 - 10.135.2.110 0000.F00A.D084 1.1
5
C2/0/U0 15 init(rc)-rc 578 0.0 1 10.135.2.110 0000.F00A.D084 1.0
5
Related Commands cable modem rogueclear cable rogue-modemshow cable modemshow cable modem verbose
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.
vpn-id Rogue CMs associated with this VPN ID are displayed. Valid range is 601–4000.
slot/if The CMTS slot and interface number, which displays rogue CMs 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 rogue CMs on the specified upstream channel are 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).
show cable modem unregistered
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference258
show cable modem unregistered
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 10 on page 238 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> | vpn:<vpn-id>] unregistered
Displays parameters for all unregistered CMs, or optionally displays whether the CM with the given address is unregistered, or CMs associated with the specified VPN.
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 8 on page 237 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 ranging-statisticsshow cable modem registered
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.
vpn-id Parameters are displayed for all CMs associated with this VPN ID. Valid range is 601–4000.
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 is 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 verbose
259
show cable modem verbose
Displays various CM parameters, statistics, and state information pertaining to an individual CM specified by its IP or MAC address. This allows you to display a variety of pertinent CM data by issuing a single command.
! show cable modem verbose is a top-level command and is available to all users.
Syntax show cable modem {<ip-address> | <mac-address>} verbose
Definitions
Examples GX$root> show cable modem 0000.39BB.AA51 verbose
Displays various CM parameters, statistics, and state information for the CM with MAC address 0000.39BB.AA51.
CM Mac Version : DOCSIS 1.0
MAC Address : 0010.9518.C0BA
IP Address : 10.134.2.100
Prim Sid : 6
Interface : C10/3/U6
Status : Online since 15:39:28
vpn : id:888 description:" a lucky vlan"
Upstream Power : -1.7(dBmV) SNR:23.2
Time Offset : 2485
Errors : BER:0.00 CER:0.00 (CCER:0.00 UCER:0.00 ) MER:22.01 CRC:0
HCS:0
Ranging Statistics: InitReq:1 SmOpp :58 SmReq :58 SmCont:0
Abort-T:0 Abort-O:0
MaxPwr :-1.00 MaxFreq:-107 MaxTime:0 L-Opp :0
L-Req :0
Connectivity : 1st-Time @ 15:38:20 #Times Reg:1 %Time Reg:95.3
Min/Avg/Max Reg Time:22:54/22:54/22:54
Min/Avg/Max UnReg Time:01:08/01:08/01:08
Flaps : Total: 57 Last Flap:PADJ @ Oct 16 16:02:08
CPEs :
--------------------------------------------------------------------------------
Type State IP Address Method Mac Address Vpn Id
host unknown unknown - 0050.04FC.8776 888
Related Commands show cable modemshow cable modem connectivityshow cable modem cpeshow cable modem errorsshow cable modem flapshow cable modem offlineshow cable modem physhow cable modem qos-profileshow cable modem ranging-statisticsshow cable modem remote-queryshow cable modem rogue
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 modulation-profile
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference260
show cable modulation-profile
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
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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable multicast-auths
261
show cable multicast-auths
Displays a list of CMs authorized to access a multicast security association. The security association name can optionally be specified to limit the display to CMs authorized to access that particular security association.
! show cable multicast-auths is a top-level command and is available to all users.
Syntax show cable multicast-auths [security-association <sa-name>]
Definitions
Examples GX$root> show cable multicast-auths security-association <sa-name>
Displays a list of CMs assigned to the given multicast security association.
Related Commands cable security-associationmulticast-auth modemshow cable multicast-mapsshow cable security-associations
sa-name Optional parameter that limits the display to those CMs assigned to the given multicast security association.
show cable multicast-maps
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference262
show cable multicast-maps
Displays all of the IP multicast maps created by the cable multicast-map command and their corresponding parameters.
! show cable multicast-maps is a top-level command and is available to all users.
Syntax show cable multicast-maps
Examples GX$root> show cable multicast-maps
Displays all of the IP multicast maps. See Table 18 for a description of the parameters displayed.
Table 18: Parameters Displayed by ‘show cable multicast-maps’
Related Commands cable multicast-mapshow cable multicast-authsshow cable security-associations
show cable qos profile
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
Related Commands show cable modem qos-profile
Parameter Description
tbd The IP multicast map name.
tbd The IP address of the multicast group.
tbd The mask applied to the IP address of the multicast group.
tbd The associated multicast security association.
tbd The associated service class.
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show cable security-associations
263
show cable security-associations
Displays all of the multicast security associations created by the cable security -association command and their corresponding parameters.
! show cable security-associations is a top-level command and is available to all users.
Syntax show cable security-associations
Examples GX$root> show cable security-associations
Displays all of the multicast security associations. See Table 19 for a description of the parameters displayed.
Table 19: Parameters Displayed by ‘show cable security-associations’
Related Commands cable security-associationencryption-algorithmsecurity-associationshow cable multicast-authsshow cable multicast-mapstype
show cable shared-secret
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
Parameter Description
tbd The multicast security association name.
tbd The multicast security association type.
tbd The multicast security association data encryption algorithm.
show cable vpn
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference264
show cable vpn
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 601
Display all CMs and associated CPEs assigned to VPN ID 601.
Related Commands cable vpncable vpn-description
vpn-id Displays all CMs and associated CPEs assigned to this VPN ID. Valid range is 601–4000.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show chassis ccm pending switch-over
265
show chassis ccm pending switch-over
Displays the status of a pending operator-initiated switchover from the primary Chassis Control Module to the secondary Chassis Control Module in a redundant configuration. The pending switchover is configured by the request chassis ccm switch-to-standby command.
See the G10 CMTS Functional Description for more information regarding Chassis Control Module redundancy.
! show chassis ccm pending switchover is top-level command and is available to all users.
Syntax show chassis ccm pending switch-over
Examples GX$root# configure terminal
GX$root(config)# show chassis ccm pending switch-over
Displays the status of a pending Chassis Control Module switchover.
Related Commands request chassis ccm billing-sync-primaryrequest chassis ccm config-sync-primaryrequest chassis ccm remind-to-replacerequest chassis ccm standby-ccm synchronizerequest chassis ccm switch-to-standby
This command is applicable only to the G10 CMTS.
show chassis environment
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference266
show chassis environment
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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show chassis hardware
267
show chassis hardware
Displays a list of all DOCSIS Modules, Chassis Control Modules, and NIC Modules (G10 CMTS only) installed in the CMTS, including (where applicable) the chassis and 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.
Hardware inventory:
Item Version Part Number Serial Number UpTime
GX CMTS Chassis N/A N/A N/A
CCM in slot 6 5.16 D Unknown 0 days 02:59:56
DM in slot 2 0.0 0 days 02:59:09
NIC in slot 5 2.0.3.4PBCOV2 002 01BE0X004PBC 0 days 02:59:32
Related Commands cable authorizechassis environment ambient-temperatureshow chassis environment
show clock
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 summer-timeclock timezone
detail Specifies that more hardware details are displayed.
show configuration
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference268
show configuration
This command is a synonym for show startup-config. See show startup-config on page 281 for details.
show controller cable
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 in 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 in 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).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show controller cable
269
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 in 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
show cpu
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference270
show cpu
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show debugging
271
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
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
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
show history
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference272
show history
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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show interfaces
273
show interfaces
Displays packet and link statistics for all cable, Fast Ethernet, and Gigabit Ethernet interfaces. You can also display the Layer 2 forwarding database for the specified cable interface.
! 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> forwarding-table
show interfaces cable <slot/if> sid [<sid>]
show interfaces aggEthernet <link>
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–3, Gigabit Ethernet port 0 and 1
downstream Specifies that a downstream interface will be displayed.
upstream Specifies that an upstream interface will be displayed.
forwarding-table Specifies that the Layer 2 forwarding database 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 is displayed based on the Service identifier.
sid Service identifier. (1–8191)
SIDs can be viewed with the show cable modem command.
link The aggregate link number. Valid range is 0–4.
aggEthernet Specifies an aggregate link is to be displayed.
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).
show interfaces
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference274
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
GX$root# show interfaces cable 2/0 forwarding-table
Displays the forwarding database associated with slot 2 / interface 0. See Table 20 for a description of the parameters displayed.
No. address vid recvPort
=====================================
00001 0000.39BB.AA51 100 RF (ds 0)
00002 0001.022E.FC37 0 Ether
00003 0001.0327.DCAA 100 RF (ds 0)
00004 0002.0001.29B3 100 RF (ds 0)
00005 0002.B9BB.3A60 0 Ether
00006 0002.FDE1.7309 0 Ether
00007 0003.04D0.0983 0 Ether
00008 0003.04D0.0985 0 Ether
00009 0003.04D0.0987 0 Ether
00010 0004.7578.5CF1 0 Ether
00011 0010.9505.79FB 100 RF (ds 0)
00012 0010.951C.B8D7 50 RF (ds 2)
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show ip arp
275
Table 20: Parameters Displayed by ‘show interfaces cable forwarding-table’
show ip arp
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 Rewrite Address VLAN Id Timeout
10.131.2.1 0001.309F.2800 0002.0343.7211 0 588
GX$root# show ip arp
Display the entire ARP table.
Related Commands arparp timeoutcable address-verificationcable proxy-arpcable vpn
Parameter Description
No. A numerical index of the forwarding database.
address The MAC address.
vid The VPN ID.
recvPort The interface to which the packet is forwarded.
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)
show ip multicast-group
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference276
show ip multicast-group
Displays the IGMP multicast group membership table, including the cable interface, the multicast IP address, and the interval timer (showing the remaining time) for each snooped and static entry. Specific table entries can be displayed if a multicast IP address or a cable interface is specified.
See the ip igmp enable command for more details regarding IGMP snooping.
! show ip multicast-group is a top-level command and requires ip-rw group-privilege.
Syntax show ip multicast-group [<ip-address>] | [cable <slot/if>]
Definitions
Examples GX$root# show ip multicast-group 225.17.18.1
Displays any multicast group entries that have an IP address of 225.17.18.1.
Interface Type Timeout IP Address
C2/0/D0 SNOOPED 220 225.17.18.1
GX$root# show ip multicast-group cable 2/0
Displays any multicast group entries that have a slot/interface of 2/0.
Interface Type Timeout IP Address
C2/0/D0 SNOOPED 220 225.17.18.1
GX$root# show ip multicast-group
Displays the entire multicast group table.
Interface Type Timeout IP Address
C2/0/D0 SNOOPED 220 225.17.18.1
C2/1/D1 STATIC -- 227.17.18.2
C2/1/D1 STATIC -- 227.17.18.3 to 227.17.18.20
Related Commands cable downstream igmp-multicast-groupclear ip multicast-groupip igmp enableip igmp membership-interval
ip-address The multicast IP address of the multicast group entry. Standard dot-quad notation (xxx.xxx.xxx.xxx).
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)
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show local-log
277
show local-log
Displays the local event log of the CMTS that corresponds to the docsDevEventTable within the DOCS-CABLE-DEVICE-MIB. This log can assist with troubleshooting various issues. See the DOCSIS OSSI specification and the DOCS-CABLE-DEVICE-MIB 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 21 provides the correspondence between the display headings and the DOCS-CABLE-DEVICE-MIB 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 21: Local Event Log Headings Displayed
Related Commands log-level generatelog-level showshow local-nv-log
Upon bootup, the CMTS copies the non-volatile event log into the volatile event log. Therefore, the show local-log command displays entries from both logs. The show local-nv-log command displays entries from only the non-volatile event log.
Display HeadingsDOCS-CABLE-DEVICE-MIBObject 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 local-nv-log
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference278
show local-nv-log
Displays the non-volatile local event log of the CMTS that corresponds to the docsDevEventTable within the DOCS-CABLE-DEVICE-MIB. This log can assist with troubleshooting various issues. See the DOCSIS OSSI specification and the DOCS-CABLE-DEVICE-MIB for more details. The G10 CMTS and G1 CMTS Installation and Operation manuals provide a list of Juniper Networks-specific log events.
! show local-nv-log is a top-level command and is available to all users.
Syntax show local-nv-log
Examples GX$root> show local-nv-log
Displays the non-volatile local event log of the CMTS. Table 21 provides the correspondence between the display headings and the DOCS-CABLE-DEVICE-MIB 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 22: Local Event Log Headings Displayed
Related Commands log-level generatelog-level showshow local-log
Display HeadingsDOCS-CABLE-DEVICE-MIBObject 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 CMTS for the event type.
Description docsDevEvText A text description of the Id.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show memory
279
show memory
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
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
show running-config
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference280
show running-config
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 [interface <if-type> [<slot/if>]]
Definitions
Examples GX$root> show running-config
Displays the entire CMTS configuration.
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...
if-type The interface to be displayed:
! cable—Displays the cable slot/interface specified by slot/if.
! fastEthernet—Displays the Fast Ethernet interface specified by slot/if.
! gigaEthernet—Displays the Gigabit Ethernet interface specified by slot/if.
! loopback—Displays the loopback interface specified by slot/if.
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:
! 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–3, Gigabit Ethernet port 0 and 1
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show startup-config
281
GX$root> show running-config interface fastEthernet 6/0
Displays the CMTS configuration associated with Fast Ethernet port 0 of the Chassis Control Module in slot 6 of the G10 CMTS.
interface
fastEthernet 6/0
auto-negotiation on
description ""
duplex full
ip address 192.168.20.50 255.255.255.0
no shutdown
speed 100
exit
exit
Related Commands show configurationshow startup-configshow working-config
show startup-config
Displays the CMTS configuration parameters that are 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
show tech-support
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference282
show tech-support
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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show tech-support
283
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
show upgrade-log
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference284
show upgrade-log
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
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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show users
285
show users
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 Connect Time Idle Time
0 root Console 3 days 2:14:0 3 days 1:4:23
1 root 172.17.19.60 0 days 0:32:10 0 days 0:32:2
2 usr1 192.168.31.10 3 days 1:0:28 3 days 0:47:26
3 fs 192.168.31.10 2 days 23:59:25 2 days 23:59:25
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.
show whoami
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference286
show whoami
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
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
show working-config
287
show working-config
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 [interface <if-type> [<slot/if>]]
Definitions
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.
if-type The interface to be displayed:
! cable—Displays the cable slot/interface specified by slot/if.
! fastEthernet—Displays the Fast Ethernet interface specified by slot/if.
! gigaEthernet—Displays the Gigabit Ethernet interface specified by slot/if.
! loopback—Displays the loopback interface specified by slot/if.
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:
! 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–3, Gigabit Ethernet port 0 and 1
show working-config
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference288
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
289
shutdown
Disables a cable interface, a Fast Ethernet interface, a Gigabit interface, or an aggregate link. All upstream and downstream channels within a cable interface are affected by this command.
! shutdown is within the interface cable, interface fastEthernet, interface gigaEthernet, and interface aggEthernet submodes, and requires ip-rw group-privilege (users with a group-privilege of rf-rw can also issue this command in the interface cable submode).
! Then no form of this command enables the targeted interface or link.
! The cable interfaces, the Fast Ethernet interfaces, the Gigabit interfaces, and aggregate links 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 in 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.
GX$root# configure terminal
GX$root(config)# interface aggEthernet 0
GX$root(config-if-a0)# no shutdown
Enable aggregate link 0.
Related Commands auto-negotiationduplexshowspeed
snmp-server community
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference290
snmp-server community
Specifies the read-only and read-write SNMP communities. Multiple read-only and read-write communities can be specified, but only one instance of a particular community name can exist at a time.
! snmp-server community is within the configure terminal mode and requires ad-rw group-privilege.
! no snmp-server community deletes the specified community.
Syntax snmp-server community <community-string> {ro | rw}
no snmp-server community <community-string>
snmp-server show
Definitions
Examples GX$root(config)# snmp-server community private1 rw
GX$root(config)# snmp-server community private2 rw
GX$root(config)# snmp-server community public1 ro
GX$root(config)# snmp-server community public2 ro
Establishes read-write communities private1 and private2, and read-only communities public1 and public2.
GX$root(config)# snmp-server show
NMS nodes table
-----------------------------------------------------------------------
Community string r/w: private1
Community string r/w: private2
Community string r/o: public1
Community string r/o: public2
Related Commands snmp-server host
community-string Alphabetic string that is used by all SNMP hosts to gain access to the CMTS.
ro Specifies a read-only community.
rw Specifies a read-write community.
show Displays the communities.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
snmp-server enable traps docsis-cmts
291
snmp-server enable traps docsis-cmts
Enables (or disables) trap classes for DOCSIS CMTS traps. The modified entity corresponds to the docsDevCmtsTrapControl object of the RFC2669-EXT MIB. Only one trap class can be enabled for each issuance of the command. If a trap class is enabled and an event occurs that causes a trap belonging to this trap class, the trap is sent to the configured SNMP trap server. See the log-level generate command for more information regarding events and the corresponding actions taken.
! snmp-server enable traps docsis-cmts is within the configure terminal mode and requires ad-rw group-privilege.
! By default, all traps are disabled.
! The show running-config command displays the trap classes that are enabled (in the form of this command).
! no snmp-server enable traps docsis-cmts disables the specified trap class.
Syntax snmp-server enable traps docsis-cmts <docsis-trap-class>
no snmp-server enable traps docsis-cmts <docsis-trap-class>
Definitions
Examples GX$root# configure terminal
GX$root(config)# snmp-server enable traps docsis-cmts InitRegReqFail
Enables traps for DOCSIS trap class InitRegReqFail.
GX$root(config)# no snmp-server enable traps docsis-cmts BpiInit
Disables traps for DOCSIS trap class BpiInit.
Related Commands log-level generatelog-level set-default-allsnmp-server enable traps vendor-cmtslog-level show
docsis-trap-class The DOCSIS trap class (see RFC2669-EXT for details):
! InitRegReqFail
! InitRegRspFail
! InitRegAckFail
! DynServReqFail
! DynServRspFail
! DynServAckFail
! BpiInit
! BPKM
! DynamicSA
! DCCReqFail
! DCCRspFail
! DCCAckFail
snmp-server enable traps vendor-cmts
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference292
snmp-server enable traps vendor-cmts
Enables (or disables) trap classes for vendor CMTS traps. The modified entity corresponds to the pbcCmtsNotificationsControl object of the PBC-CMTS-MIB enterprise MIB. Only one trap class can be enabled for each issuance of the command. If a trap class is enabled and a vendor event occurs that causes a trap belonging to this trap class, the trap is sent to the configured SNMP trap server. See the log-level generate and vendor-events-enable commands for more information regarding events and the corresponding actions taken.
! snmp-server enable traps vendor-cmts is within the configure terminal mode and requires ad-rw group-privilege.
! By default, all traps are disabled.
! The show running-config command displays the trap classes that are enabled (in the form of this command).
! no snmp-server enable traps vendor-cmts disables the specified trap class.
Syntax snmp-server enable traps vendor-cmts <vendor-trap-class>
no snmp-server enable traps vendor-cmts <vendor-trap-class>
Definitions
Examples GX$root# configure terminal
GX$root(config)# snmp-server enable traps vendor-cmts chassis
Enables traps for vendor trap class chassis.
GX$root(config)# no snmp-server enable traps vendor-cmts access
Disables traps for vendor trap class access.
Related Commands log-level generatelog-level set-default-alllog-level showsnmp-server enable traps docsis-cmtsvendor-events-enable
vendor-trap-class The vendor trap class (see PBC-CMTS-MIB and the G1 CMTS or G10 CMTS Installation and Operation manual for details):
! envMon
! chassis
! software
! access
! config
! dataPath
! rfInterface
! flapList
! debug
! cmStateChange
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
snmp-server host
293
snmp-server host
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 within the configure terminal mode and requires ad-rw group-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 is used to send traps is 2c. The UDP port to which traps are 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 is used to send traps is 1. The UDP port to which traps are 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 and SNMP Reference294
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
Specifies the speed when configuring Fast Ethernet ports.
! speed is a command in the interface fastEthernet submode, which is under the configure terminal mode, and requires ip-rw group-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
syslog-server
295
syslog-server
Specifies the IP address of the syslog server for the CMTS. The modified entity corresponds to the docsDevEvSyslog object in the DOCS-CABLE-DEVICE-MIB. The configured IP address of a syslog server can optionally be display with the show parameter. If a syslog server is configured and an event occurs that causes a syslog, the syslog is sent to the specified server. See the log-level generate command for more information regarding events and the corresponding actions taken.
! syslog-server is a command in the configure terminal mode and requires ad-rw group-privilege.
! no syslog-server clears the syslog server configuration.
Syntax syslog-server <ip-address> | show
no syslog-server
Definitions
Examples GX$root# configure terminal
GX$root(config)# syslog-server 192.168.21.49
Specifies 192.168.21.49 as the IP address of the syslog server for the CMTS.
GX$root(config)# syslog-server show
Displays the IP address of the syslog server for the CMTS.
Syslog Server IP Address : 192.168.21.49
Related Commands log-level generatelog-level set-default-alllog-level showvendor-events-enable
ip-address The IP address of the syslog server. Standard dot-quad notation (xxx.xxx.xxx.xxx).
show Displays the configured IP address of the syslog server.
system
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference296
system
Enters a submode under the configure terminal mode where you configure the authentication parameters of the CMTS (see “Related Commands”). See Chapter 1, “Command Summary”, for a hierarchal display of modes, submodes, and commands.
! system is a submode within the configure terminal mode and requires ad-rw group-privilege.
Syntax system
Examples GX$root# configure terminalGX$root(config)# system
GX$root(config-system)#
This puts you in the system submode.
Related Commands radius-server hostremote-authenticationtacacs-server host
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
system apply
297
system apply
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).
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.
! system apply is a top-level command and requires ad-rw group-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.
system apply
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference298
Examples GX$root# system apply failsafe
GX$root# reload
The CMTS reboots 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 does not use the failsafe image upon reboot, but reboots using the committed image in its internal archive.
GX$root# system apply upgrade /GX_v12r11
GX$root# reload
The CMTS reboots using the upgrade image GX_v12r11 in the home directory.
Related Commands show upgrade-logshow versionsystem auto-rollbacksystem commit
The filename parameter must be specified with an absolute path.
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 is used for subsequent bootups.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
system auto-rollback
299
system auto-rollback
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 ad-rw group-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
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 ad-rw group-privilege.
Syntax system commit
Examples GX$root# system apply upgrade upgrade1.rpm
GX$root# reload
GX$root# system commit
The CMTS reboots using the upgrade image upgrade1.rpm. This new image is 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 and SNMP Reference300
system config-backup
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 ad-rw group-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
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.
To cancel the effect of this command, issue system config-restore /home/backup.
! system config-restore is a top-level command and requires ad-rw group-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
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
tacacs-server host
301
tacacs-server host
Adds a server to the set of TACACS+ authentication servers to be used when remote authentication with TACACS+ is enabled by the remote-authentication command. Up to ten TACACS+ servers can be specified.
! tacacs-server host is within the system submode and requires ad-rw group-privilege.
! no tacacs-server host removes the specified server.
Syntax tacacs-server host <ip-address> key <secret-string> [timeout <seconds>] [single-connection]
no tacacs-server host <ip-address>
Definitions
Examples GX$root# configure terminal
GX$root(config)# system
GX$root(config-system)# tacacs-server host 192.168.100.101 key DOCSIS
Specifies a TACACS+ server at IP address 192.168.100.101 with a shared secret of DOCSIS. The default value for timeout is used by the TACACS+ client during authentication. A new connection is created for each authentication request.
Related Commands remote-authenticationradius-server host
ip-address The IP address of the TACACS+ server. Standard dot-quad notation (xxx.xxx.xxx.xxx).
secret-string The shared secret between the CMTS and the TACACS+ server.
seconds An optional parameter that specifies the time, in seconds, to wait for a reply from the TACACS+ server. The valid range is 1 to 60, and the default is 3.
single-connection An optional parameter that forces the CMTS to use a long-lived single connection to the TACACS+ server for all authentication requests. The defaults behavior is to create a new connection on every authentication request.
telnet
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference302
telnet
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
Enables debug message output for the current Telnet or console session.
! terminal monitor is a top-level command and requires grp-rd group-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).
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
terminal page-mode
303
terminal page-mode
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
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 grp-rd group-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).
tftp
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference304
tftp
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 fs-rw group-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
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.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
traffic-class
305
traffic-class
Configures the scheduling discipline for the specified traffic class for the targeted traffic scheduling policy. The traffic scheduling policy can be applied to downstream and upstream channels.
All service flows are associated with one or two traffic classes, best-effort and guaranteed:
! Best-effort traffic class—Applies to a service flow in which the packet rate is above the minimum reserved traffic rate (MRTR).
! Minimum rate (or guaranteed) traffic class—Applies to a service flow in which the packet rate is below the MRTR.
Service flows associated with the minimum rate traffic class have strict higher precedence over service flows associated with the best-effort traffic class (regardless of the scheduling discipline enabled—strict-priority or fifo).
Each traffic class supports one of eight traffic priorities—0 through 7. If strict-priority scheduling is enabled, packets belonging to a service flow with a higher traffic priority are scheduled ahead of packets belonging to a service flow with a lower traffic priority. If fifo scheduling is enabled, the traffic priority is ignored, and packets are scheduled on a first come, first served basis.
! traffic-class is within the traffic scheduling submode and requires rf-rw group-privilege.
Syntax traffic-class {minimum-rate | best-effort} scheduling-discipline {fifo | strict-priority}
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable policy traffic-scheduling <policy-name>GX$root(config-cable-policy-ts)# traffic-class minimum-rate
scheduling-discipline strict-priority
Specifies a strict priority scheduing discipline for the minimum rate traffic class for the given traffic scheduling policy.
Related Commands cable downstream traffic-scheduling-policycable upstream traffic-scheduling-policycable policy traffic-schedulingmaximum-rate-enforcement
minimum-rate Specifies the scheduling discipline applies to the minimum rate traffic class.
best-effort Specifies the scheduling discipline applies to the best-effort traffic class.
fifo Enables first-in first-out (FIFO) as the scheduling discipline for the specified traffic class.
strict-priority Enables strict priority as the scheduling discipline for the specified traffic class.
traffic-priority
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference306
traffic-priority
Sets the traffic priority for the targeted service class.
! traffic-priority is within the service class submode and requires rf-rw group-privilege.
Syntax traffic-priority <priority>
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable service-class <class-name>GX$root(config-cable-service-class)# traffic-priority 1
Specifies a traffic priority of 1 for the given service class.
Related Commands cable downstream service-classcable service-classmaximum-latencymaximum-sustained-traffic-ratemaximum-traffic-burstminimum-reserved-traffic-rate
priority The relative priority of the service class. Valid range is 0 through 7, where higher numbers indicate higher priority. Default is 0.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
trap-syslog-throttle admin-status
307
trap-syslog-throttle admin-status
Controls the transmission of trap and syslog messages with respect to the trap pacing threshold. The modified entity corresponds to the docsDevEvThrottleAdminStatus object in the DOCS-CABLE-DEVICE-MIB.
If enabled, trap/syslog throttling occurs after the number of trap and syslog events equals a threshold within an interval of time (an event causing both a trap and a syslog message is treated as a single event). The threshold and interval parameters are set by the trap-syslog-threshold and trap-syslog-interval commands, respectively.
! trap-syslog-throttle admin-status is within the configure terminal mode and requires ad-rw group-privilege.
! no trap-syslog-throttle admin-status sets the throttling control to its default of unconstrained.
! The show running-config command displays the current throttling control status (in the form of this command).
Syntax trap-syslog-throttle admin-status {unconstrained | below-threshold | stop-at-threshold | inhibited}
no trap-syslog-throttle admin-status
Definitions
Examples GX$root# configure terminal
GX$root(config)# trap-syslog-throttle admin-status below-threshold
Sets the trap and syslog throttling control to below-threshold.
Related Commands trap-syslog-throttle intervaltrap-syslog-throttle threshold
unconstrained Corresponds to unconstrained(1) in the DOCS-CABLE-DEVICE-MIB: causes traps and syslog messages to be transmitted without regard to the threshold settings.
below-threshold Corresponds to maintainBelowThreshold(2) in the DOCS-CABLE-DEVICE-MIB: causes trap transmission and syslog messages to be suppressed if the number of traps would otherwise exceed the threshold.
stop-at-threshold Corresponds to stopAtThreshold(3) in the DOCS-CABLE-DEVICE-MIB: causes trap transmission to cease at the threshold, and not resume until directed to do so.
inhibited Corresponds to inhibited(4) in the DOCS-CABLE-DEVICE-MIB: causes all trap transmission and syslog messages to be suppressed.
trap-syslog-throttle interval
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference308
trap-syslog-throttle interval
Sets the trap and syslog throttling interval. The modified entity corresponds to the docsDevEvThrottleInterval object in the DOCS-CABLE-DEVICE-MIB. See the trap-syslog-throttle admin-status command for more information regarding trap and syslog throttling.
! trap-syslog-throttle interval is within the configure terminal mode and requires ad-rw group-privilege.
! no trap-syslog-throttle interval sets the throttling interval to its default of 1.
! The show running-config command displays the current throttling interval (in the form of this command).
Syntax trap-syslog-throttle interval <seconds>
no trap-syslog-throttle interval
Definitions
Examples GX$root# configure terminal
GX$root(config)# trap-syslog-throttle interval 60
Sets the trap and syslog throttling interval to 60 seconds.
Related Commands trap-syslog-throttle admin-statustrap-syslog-throttle threshold
seconds The interval over which the trap threshold applies, in seconds. Valid range is 1–2147483647.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
trap-syslog-throttle threshold
309
trap-syslog-throttle threshold
Sets the trap and syslog throttling threshold. The modified entity corresponds to the docsDevEvThrottleThreshold object in the DOCS-CABLE-DEVICE-MIB. See the trap-syslog-throttle admin-status command for more information regarding trap and syslog throttling.
! trap-syslog-throttle threshold is within the configure terminal mode and requires ad-rw group-privilege.
! no trap-syslog-throttle threshold sets the throttling threshold to its default of 0 (no throttling).
! The show running-config command displays the current throttling threshold (in the form of this command).
Syntax trap-syslog-throttle threshold <count>
no trap-syslog-throttle threshold
Definitions
Examples GX$root# configure terminal
GX$root(config)# trap-syslog-throttle threshold 10
Sets the trap and syslog throttling threshold to 10.
Related Commands trap-syslog-throttle admin-statustrap-syslog-throttle interval
count The number of trap and syslog events per docsDevEvThrottleInterval to be transmitted before throttling. Valid range is 0–4294967295.
type
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference310
type
Defines the multicast security association type for the targeted security association.
! type is within the security association submode and requires rf-rw group-privilege.
Syntax type {dynamic | static}
Definitions
Examples GX$root# configure terminal
GX$root(config)# cable security-association <sa-name>GX$root(config-cable-sec-assoc)# type static
Specifies a multicast security association type of static for the targeted multicast security association.
Related Commands cable security-associationencryption-algorithmmulticast-auth modemsecurity-association
dynamic Specifies the multicast security association type is dynamic (default).
static Specifies the multicast security association type is static.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
username
311
username
Sets various values for establishing user access.
! username is within the configure terminal mode and requires ad-rw group-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.
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 ...
When prompted, log into the CMTS as user root with a password of changeme.
Syntax username <name> password <password>
no username <name> password
username <name> group {ad | ip | rf | fs | bi} 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)
bi – billing (allows a remote user to access the billing file)
privilege Privilege levels:
rw – read-write
rd – read-debug
ro – read-only
prompt-string Unique prompt string for the user name.
username
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference312
Examples GX$root# configure terminal
GX$root(config)# username myname password myword
Defines a username myname and assign a password of myword.
GX$root(config)# username myname group rf privilege rw
Assigns username myname to the rf group with read-write privilege.
GX$root(config)# username myname prompt myprompt
Assigns a prompt of myprompt for username myname. When user myprompt logs in, the prompt appears as follows:
G10$myprompt(config)#
GX$root(config)# no username myname
Deletes username myname from the CMTS.
Related Commands show privilegeshow usernamesshow usersshow whoamiwho
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Command Listing
vendor-events-enable
313
vendor-events-enable
Enables (or disables) vendor events. The modified entity corresponds to the pbcCmtsEventsEnable object in the PBC-CMTS-MIB enterprise MIB. See the G1 CMTS or G10 CMTS Installation and Operation manual for a list of vendor-specific events.
! vendor-events-enable is within the configure terminal mode and requires ad-rw group-privilege.
! Vendor events are enabled by default.
! The show running-config command displays whether vendor events are disabled (in the no form of this command).
! no vendor-events-enable disables vendor events.
Syntax vendor-events-enable
no vendor-events-enable
Examples GX$root# configure terminal
GX$root(config)# no vendor-events-enable
Disables vendor events, in which case events are not logged into the local volatile and non-volatile logs, and trap and syslog messages are not generated.
Related Commands log-level generatelog-level set-default-alllog-level showsnmp-server enable traps vendor-cmts
who
This command is a synonym for show users. See show users on page 285 for details.
write memory
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 grp-rw group-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
write memory
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference314
••••••••••••••••••••••••••••••••••••••••••••••••
315
Part 2SNMP Overview and Specification
! Management Architecture Overview on page 317
! Standard MIB Specification on page 321
! Enterprise MIB Specification on page 325
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference316
••••••••••••••••••••••••••••••••••••••••••••••••
Management Architecture Overview 317
Chapter 3Management Architecture Overview
The primary management of the CMTS is performed using SNMP in conjunction with the command-line interface (CLI). Though the initial configuration of the CMTS is performed primarily through the CLI, SNMP can also be used to perform some of the steps required for configuration. The CLI can also be used to manage the CMTS.
Key components of the SNMP model of a managed network consist of one or more managed SNMP entities, one or more SNMP managers, a messaging protocol, and a transport stack to allow messaging to occur between the managed entity and the manager.
A managed SNMP entity must contain an SNMP agent that provides access to the management information and its properties contained in its management information base (MIB). The management information can include configuration parameters, various statistics, and state variables that reflect the status of the managed entity. Each DOCSIS Module and Chassis Control Module contains a set of management information that must be accessible by an SNMP manager. Within the CMTS, the Chassis Control Module runs an SNMP agent that provides SNMP and CLI access to all the modules within the CMTS. In addition, the MIB can define events—a trap, an inform, or a notification—that represent specific conditions in the managed entity. The SNMP agent generates event reports to an SNMP manager or a Trap Manager that reflect these conditions.
An SNMP manager has access to the MIBs of its managed entities. Depending on the definition of the objects in each MIB, the manager can retrieve and modify the objects as part of its management role. Also, an SNMP manager receives events from SNMP agents and takes the appropriate action, depending on the type of event that has occurred. Figure 1 on page 318 provides a high-level view of the SNMP management architecture of the CMTS.
A network management system (NMS) is composed of servers and managers that use SNMP for multiple purposes:
! The NMS Management Server and the CMTS SNMP manager use the SNMP protocol for message exchange with the SNMP agent that resides on the CMTS.
! The diagnostics server in the NMS uses SNMP to poll various statistics defined in the standard and enterprise MIBs, such as media access control (MAC) variables (HCS errors, CRC errors, collisions for requests), and physical (PHY) variables (signal-to-noise ratios, sync loss, power levels). These statistics can then be used to detect, diagnose, and potentially correct CMTS or HFC problems. The diagnostics server can also be configured to generate traps or notifications to the trap manager.
! SNMP is used between the NMS and the network operations center (NOC) allowing remote management of the NMS and the CMTS. Remote clients on the network can also use SNMP to access those elements of the managed network for which privilege has been granted.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference318
! There is a syslog server in the NMS and a local event log in the CMTS that contain the same log of events, which are defined within MIBs. The CMTS uses the SYSLOG mechanism (as opposed to SNMP) to send SYSLOG events to the SYSLOG Server. The local event log is CLI and SNMP accessible.
! The NMS contains the SNMP manager for the DOCSIS cable modems (CMs). NMS management of the CMs is transparent to the CMTS since the SNMP messages, or protocol data units, are encapsulated as the payload within DOCSIS MAC frames.
Figure 1: CMTS Management Architecture
DiagnosticsServer
CMTS SNMP Manager
CM SNMPManager
Trap Manager
Remote Client
NOCSNMP
G-series CMTSNetwork Management System
DOCSIS CM
CMTS SNMP Agent
LocalEvent Log
NMS ManagementServer
SNMP
SNMP
SNMP
SNMP
SNMP
SNMP
SYSLOGServer
SYSLOG
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Management Architecture Overview 319
CMTS SNMP Support
As required by DOCSIS 1.1, the CMTS supports SNMPv1, SNMPv2c, and SNMPv3.
Table 23 provides a list of the SNMP- and SMI-related IETF RFCs that are supported by the CMTS.
Table 23: CMTS SNMP-Related IETF RFCs Supported
CMTS MIB Categories
A G-series CMTS supports two general categories of MIBs—standard and enterprise. Some standard MIBs must be supported as required by DOCSIS 1.1. However, a G-series CMTS supports additional standard MIBs. The standard MIBs supported are listed in Chapter 4. The enterprise MIBs are defined in Chapter 5.
Name RFC Number RFC Title
— RFC1157 A Simple Network Management Protocol
— RFC1212 Concise MIB Definitions
— RFC1215 A Convention for Defining Traps For Use With the SNMP
— RFC1901 Introduction to Community-based SNMPv2
— RFC1902 Structure of Management Information for Version 2 of the Simple Network Management Protocol (SNMPv2)
— RFC1903 Textual Conventions for Version 2 of the Simple Network Management Protocol (SNMPv2)
— RFC1904 Conformance Statements for Version 2 of the Simple Network Management Protocol (SNMPv2)
SNMPv2-PDU RFC1905 Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)
SNMPv2-TM RFC1906 Transport Mappings for Version 2 of the Simple Network Management Protocol (SNMPv2)
SNMPv2-MIB RFC1907 Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)
— RFC1908 Coexistence between Version 1 and Version 2 of the Internet-standard Network Management Framework
— RFC2570 Introduction to Version 3 of the Internet-standard Network Management
SNMP-FRAMEWORK-MIB RFC2571 An Architecture for Describing SNMP Management Frameworks
SNMP-MPD-MIB RFC2572 Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)
SNMP-NOTIFICATION-MIB RFC2573 SNMP Applications
SNMP-TARGET-MIB
SNMP-USER-BASED-SM-MIB RFC2574 The User-Based Security Model for Version 3 of the Simple Network Management Protocol (SNMPv3)
SNMP-VIEW-BASED-ACM-MIB RFC2575 View-based Access Control Model for the Simple Network Management Protocol (SNMP)
SNMP-COMMUNITY-MIB RFC2576 Coexistence between Version 1, Version 2, and Version 3 of the Internet-Standard and Network Management Framework
SNMPv2-SMI RFC2578 Structure of Management Information Version 2 (SMIv2)
SNMPv2-TC RFC2579 Textual Conventions for SMIv2
SNMPv2-CONF RFC2580 Conformance Statements for SMIv2
INET-ADDRESS-MIB RFC2851 Textual Conventions for Internet Network Addresses
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference320
••••••••••••••••••••••••••••••••••••••••••••••••
Standard MIB Specification 321
Chapter 4Standard MIB Specification
The standard MIBs supported by the CMTS are a combination of those MIBs required by DOCSIS 1.1, along with additional MIBs specific to a G-series CMTS. The following sections in this chapter simply provide a list of the MIBs supported by a G-series CMTS and do not provide details regarding the management information contained therein. For details regarding a specific MIB, the reader is encouraged to read that particular MIB.
CMTS Standard MIB Support
Table 24 provides a list of the standard MIBs and the corresponding IETF RFCs that are supported by the CMTS.
Table 24: CMTS Standard MIBs Supported
MIB Name RFC Description
— RFC1155 Structure and Identification of Management Information for TCP/IP-based Internets
— RFC1213 Management Information Base for Network Management of TCP/IP-based internets: MIB-II
BRIDGE-MIB RFC1493 Definitions of Managed Objects for Bridges
IP-MIB RFC2011 SNMPv2 Management Information Base for the Internet Protocol using SMIv2
TCP-MIB RFC2012 SNMPv2 Management Information Base for the Transmission Control Protocol using SMIv2
UDP-MIB RFC2013 SNMPv2 Management Information Base for the User Datagram Protocol using SMIv2
IF-MIB RFC2233 The Interfaces Group MIB using SMIv2
ETHERLIKE-MIB RFC2665 Ethernet Interface MIB
DOCS-CABLE-DEVICE-MIB RFC2669 DOCSIS Cable Device MIB
DOCS-CABLE-DEVICE-TRAP-MIB RFC2669-EXT DOCSIS Cable Device Trap MIB
RF-MIBv2-04 — Radio Frequency (RF) Interface MIB
ENTITY-MIB RFC2737 Entity MIB (Version 2) (only entPhysicalTable supported)
DOCS-BPI-MIB RFC3083 Baseline Privacy Interface MIB
DOCS-BPI2-MIB — Management Information Base for DOCSIS Cable Modems and Cable Modem Termination Systems for Baseline Privacy Plus
DOCS-QOS-MIB — Data Over Cable System Quality of Service Management Information Base
DOCS-SUBMGT-MIB — Management Information Base for DOCSIS Cable Modem Termination Systems for Subscriber Management
DOCS-CABLE-DEVICE-TRAP-MIB — Extension of the CABLE DEVICE MIB Defined in RFC2669
Support of Optional MIB Objects
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference322
Support of Optional MIB Objects
In some cases, support for certain objects (OBJECT-TYPE or OBJECT-GROUP) within a MIB is considered optional as defined by the DOCSIS and OSSI specifications. This section identifies, by MIB, those optional objects that are supported by the CMTS. If an object is listed as supported, all underlying objects are also supported. The omission of an optional object in the following sections implies that the object is not supported by the CMTS.
If a MIB is not explicitly addressed in this section, none of the optional objects within that MIB are supported in the CMTS.
IF-MIB Object Support
The IF-MIB (“The Interfaces Group MIB using SMIv2”) objects that are considered optional by DOCSIS 1.1, but are supported by the CMTS, are as follows:
! ifXTable
! ifHCInOctets
! ifHCInUcastPkts
! ifHCInMulticastPkts
! ifHCInBroadcastPkts
! ifHCOutOctets
! ifHCOutUcastPkts
! ifHCOutMulticastPkts
! ifHCOutBroadcastPkts
! ifStackLastChange
! ifRcvAddressTable
! ifTestTable
In general, a G-series CMTS does not support those objects classified by the DOCSIS specifications as Deprecated or Obsolete. In the exceptional case where a deprecated or obsolete object is supported, Juniper Networks reserves the right to remove such support in a future release without prior notice.
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Standard MIB Specification
Support of Optional MIB Objects
323
DOCS-CABLE-DEVICE-MIB Object Support
The DOCS-CABLE-DEVICE-MIB (“DOCSIS Cable Device MIB”) objects that are considered optional by DOCSIS 1.1, but are supported by the CMTS, are as follows:
! docsDevBaseGroup
! docsDevFilterGroup
! docsDevFilterLLCTable
DOCS-QOS-MIB Object Support
The DOCS-QOS-MIB (“IETF Proposed Standard RFC-version of Qos MIB”) objects that are considered optional by DOCSIS 1.1, but are supported by the CMTS, are as follows:
! docsQosServiceClassPolicyTable
! docsQosPHSTable
Support of Optional MIB Objects
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference324
••••••••••••••••••••••••••••••••••••••••••••••••
Enterprise MIB Specification 325
Chapter 5Enterprise MIB Specification
A G-series CMTS provides support for the following enterprise MIBs:
! PBC-ENT-MIB—This is the top-level MIB which defines the root structure for all Juniper Networks CMTS enterprise MIBs.
! PBC-GENERIC-MIB—Defines system and chassis management capabilities that are common to all Juniper Networks CMTS product offerings.
! PBC-CMTS-MIB—Defines management objects common to all Juniper Networks CMTS product offerings.
! PBC-KODIAK-M-G10-MIB—Defines management features specific to a G-series CMTS.
These MIBs define extensions to the standard MIBs, and provide the support for managing the proprietary features and functions of the CMTS. The enterprise MIBs can be downloaded from the following location:
http://www.juniper.net/techpubs/cable/
Module pacificBroadband
The top level of the PBC-ENT-MIB tree is the pacificBroadband module which resides under enterprise at { enterprise 5987 }. The complete path to the pacificBroadband module from the root of the Object Identifier (OID) tree is as follows:
{ iso org dod internet mgmt private enterprise pacificBroadband }
This path is equivalent to OID value { 1 3 6 1 4 1 5987 }. Figure 2 on page 326 illustrates the hierarchy of the pacificBroadband module and the next two levels beneath it.
Module pacificBroadband
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference326
Figure 2: Hierarchy of Module pacificBroadband
pacificBroadband
pbcModuleRegs { pbcRegs 1 }
pbcRegs { pacificBroadband 1 }
pbcGeneric { pbcManagement 1 }
pbcCmts { pbcManagement 2 }
pbcManagement { pacificBroadband 2 }
pbcKodiakMG10Cmts { pbcProducts 1 }
pbcProducts { pacificBroadband 3 }
pbcGenericSystemAgentCapsR2 { pbcCaps 1 }
pbcCaps { pacificBroadband 4 }
pbcReqs { pacificBroadband 5 }
pbcExpr { pacificBroadband 6 }
cmtsAgentCaps { pbcCaps 2 }
pbcKodiakMG10AgentCaps { pbcCaps 3 }
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Enterprise MIB Specification
Module pacificBroadband
327
The objects one level beneath the pacificBroadband module, along with their OIDs, are presented in Table 25, which is followed by brief explanations of each of these objects.
Table 25: Objects Beneath Module pacificBroadband
! pbcRegs—Represents the sub-tree for PBC registrations.
! pbcManagement—Represents assorted common management MIBs.
! pbcProducts—Represents the sub-tree for product-specific object and event definitions.
! pbcCaps—Represents the sub-tree for agent profiles (defined with the AGENT-CAPABILITIES construct).
! pbcReqs—Represents the sub-tree for management application requirements (defined with MODULE-COMPLIANCE construct).
! pbcExpr—Represents the sub-tree for experimental definitions.
Sections “Objects Beneath Object pbcRegs” through “Objects Beneath Object pbcCaps” on page 328 itemize and describe the objects that reside beneath the objects listed in Table 25 (the pbcReqs and pbcExpr objects do not have any objects directly beneath them).
Objects Beneath Object pbcRegs
The only object that resides directly beneath the pbcRegs object is the pbcModuleRegs object which represents the sub-tree used to register the values assigned to modules with the MODULE-IDENTITY construct.
Objects OID
pbcRegs { pacificBroadband 1 }
pbcManagement { pacificBroadband 2 }
pbcProducts { pacificBroadband 3 }
pbcCaps { pacificBroadband 4 }
pbcReqs { pacificBroadband 5 }
pbcExpr { pacificBroadband 6 }
Module pacificBroadband
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference328
Objects Beneath Object pbcManagement
The objects immediately beneath the pbcManagement object, along with their OIDs, are presented in Table 26, which is followed by brief explanations of each of these objects.
Table 26: Objects Beneath Module pbcManagement
! pbcGeneric—The root node for all Juniper Networks management objects which are common to chassis-type systems.
! pbcCmts—The root node for management objects which are common to all Juniper Networks CMTS products and which are not defined by standard RFCs.
Objects Beneath Object pbcProducts
The only object that resides directly beneath the pbcProducts object is the pbcKodiakMG10Cmts object. There are currently no management objects specific only to the G10 CMTS or G1 CMTS models.
Objects Beneath Object pbcCaps
The objects immediately beneath the pbcCaps object, along with their OIDs, are presented in Table 27, which is followed by brief explanations of each of these objects.
Table 27: Objects Beneath Module pbcCaps
! pbcGenericSystemAgentCapsR2—Defines the agent capabilities which are common to all Juniper Networks system/chassis products.
! CmtsAgentCaps—Defines the baseline agent capabilities for Juniper Networks CMTS SNMP agents.
! pbcKodiakMG10AgentCaps—Defines agent capabilities specific to the CMTS.
Objects OID
pbcGeneric { pacificBroadband pbcManagement 1 }
pbcCmts { pacificBroadband pbcManagement 2 }
Objects OID
pbcGenericSystemAgentCapsR2 { pacificBroadband pbcCaps 1 }
cmtsAgentCaps { pacificBroadband pbcCaps 2 }
pbcKodiakMG10AgentCaps { pacificBroadband pbcCaps 3}
••••••••••••••••••••••••••••••••••••••••••••••••
329
Part 3Appendixes
! Login, Prompts, and Keys on page 331
! Configuration Notes on page 333
! Security on page 339
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference330
••••••••••••••••••••••••••••••••••••••••••••••••
Login, Prompts, and Keys 331
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 and SNMP Reference332
Key Commands
The list of key commands can be displayed by entering the help edit-keys command.
Table 28: 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 333
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 3 provides the G10 CMTS slot numbering. Table 29 on page 334 provides the G1 CMTS slot numbering. Use these slot numbers for configuration tasks.
Slot Numbers
Figure 3: 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 and SNMP Reference334
Table 29: 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 30.
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 31.
Table 30: G10 CMTS Cable Interface to Ethernet Port Association
Table 31: 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 4 on page 337 to view the ports on the HFC Connector Module and the Chassis Control Module of a G10 CMTS. See Figure 5 on page 338 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 335
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 32 through Table 36 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 32: G10 CMTS Downstream Channel Assignment
Table 33: 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 and SNMP Reference336
Table 34: G10 CMTS Upstream Channel Assignment (16 Channels)
Table 35: G1 CMTS Downstream Channel Assignment
Table 36: 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 337
Configuration Notes
Figure 4: 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 and SNMP Reference338
Figure 5: G1 CMTS Rear Ports
••••••••••••••••••••••••••••••••••••••••••••••••
Security 339
Appendix CSecurity
This appendix describes the groups and privileges used to implement security and user access in the CLI.
Access to CLI commands is granted to users based on their assigned group and privilege. This matrix is shown in Table 37.
Table 37: Group/Privilege Matrix
Groups
Groups are associated with commands and file access rights 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.
! BI—Access to billing files is limited to those users who have bi-rw and fs-rw acess.
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
BI (billing feature) bi-rw — —
Security
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference340
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 38.
Table 38: 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|bi} 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).
Remote User Authentication
The CMTS maintains the local user and password database that is used for user authentication by default. In addition, RADIUS and TACACS+ clients are supported for remote user authentication. The CMTS can be configured to use one of these clients for authentication, with an option to fall back to the local database if an authorization server does not respond. See the remote-authentication command and its related commands for more details.
This Level Can Also Access This Level
RW RD, RO
RD RO
RO —
••••••••••••••••••••••••••••••••••••••••••••••••
341
Part 4Index
! Index on page 343
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
G-series CMTS CLI and SNMP Reference342
••••••••••••••••••••••••••••••••••••••••••••••••
Index 343
IndexIndex
Numerics4x16 configuration ......................................................294x8 configuration ........................................................29802.1Q ......................................................................130802.3ad.....................................................................186
Aaccess-denied ............................................................239address verification .......................................24, 59, 231AGENT-CAPABILITIES................................................327aggregate link ..............................14, 186, 207, 212, 289archive ......................................................................297ARP ...........16, 17, 47, 55, 59, 60, 87, 97, 139, 157, 275ARP authentication......................................................27ARP cache ...........................................................88, 138ARP proxy .............................................................62, 87ARP verification.....................................................27, 87authentication .....................................................95, 296authentication certificate .............................................84authentication servers ...............................................219automatic recovery....................................................299auto-negotiate ...........................................................188
Bbackoff ......................................................108, 121, 268Bandwidth Allocation Map.................................108, 121banner...................................................................19–23Baseline Privacy Interface..........................................321BER ...........................................................................245best-effort traffic........................................................305billing ..................................................................23, 221BPI ......................................................................83, 130BPKM ........................................................................158Broadband Cable Processor ASIC ........................79, 122broadcast ..................................24, 30, 55, 88, 138, 144
Ccall admission control....................34, 80, 103, 215, 226CER .............................................................66, 114, 245channel hopping................................104, 116, 125, 128
channel modulation control...............104, 116, 125, 128channel status............................................................268channel width......................................35, 105, 126, 268channel width control ........................104, 116, 125, 128chassis...............................................134, 266, 267, 325Chassis Control Module .............................................317clock..........................................................147, 149, 267configuration file .............................70, 92, 95, 130, 222congestion control .........................................36, 81, 107congestion management ...........................................216console ......................................................................175counters ....................................................................241CPU usage .................................................................270CRC ...........................................................................317
Ddata path processor ...............................................27, 87daylight savings time.................................................150debug filters...............................................159, 166, 271declared.....................................................................239deconcatenation ........................................................106Deprecated ................................................................322de-ranging ...................................................................64description.................................................................177destroyed ..........................................................136, 239device class identification ..........................................161DHCP...........................................31, 51, 55, 90, 99, 162DHCPACK..............................................................88, 92Diagnostics Server .....................................................317differential encoding............................................77, 101directory............................................................208, 227DNS ...........................................................................196docsDevEventTable ...................................................278DOCSIS......................................................................322
Cable Modems....................................................318MAC ...................................................................318
DOCSIS Module .........................................................317document conventions ............................................... xvidomain name ............................................................192downstream frequency................................................38downstream modulation..............................................41DPP .............................................................................87drop profile........................................................216, 217
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Index
G-series CMTS CLI and SNMP Reference344
duplex ......................................................... 18, 179, 188dynamic channel change........................................... 160dynamic service addition .......................................... 164dynamic service change ............................................ 164dynamic service deletion........................................... 164
Eencryption algorithm........................................... 93, 180error logs................................................................... 282event log ................................................................... 146event priority ............................................................ 202events ..64, 66, 137, 156, 175, 200, 202, 223, 271, 307,
313, 317experimental............................................................. 327
Ffan status .................................................................. 266FEC .....................................................................76, 101file..................................... 178, 179, 182, 203, 208, 220filter .............................................. 48, 50, 52, 53, 63, 69flap.............................................................. 65, 114, 247flap-list ................................................ 65, 114, 140, 232forward error correction.............................................. 76forwarding database.................................................. 144frequency............................................ 89, 101, 111, 268FTP ...................................................................182, 193
Ggateway.....................................................................192GIADDR.......................................................................31guard time................................................... 76, 101, 106
HHCS...........................................................................317helper address............................................................. 51hostname ..........................................................185, 192hybrid-fiber/coax....................................................... 317
I ICMP ......................................................................... 165ifAlias ........................................................................ 110ifXTable.....................................................................110IGMP ......................................................... 194, 195, 276IMA .............................................................................25inform....................................................................... 317initial maintenance.......... 54, 64, 66, 115, 121, 171, 252initial maintenance alignment..................................... 25interleaver........................................................... 40, 268interval usage code...................................................... 76invalid packet........................................................ 59, 97IP authentication ......................................................... 97
IP verification ..............................................................97IPDR............................................................................23
Jjitter ..........................................................................215
KKEK.............................................................................85key encryption key......................................................85
LLEDs..........................................................................137link speed....................................................................18LLC filter................................................................56–58load balancing ...........................................................126local event log .........................59, 60, 64, 277, 278, 318loopback interface .....................................................190
MMAC rewrite ........................................................61, 162MAC see media access controlmanagement information..................................317, 321manufacturer certificate ..............................................86MAP ..........................................................................170MAP message......................................54, 143, 206, 210maxburst size..............................................................76maximum burst size..................................................101maximum latency ...............................................94, 204maximum sustained traffic rate...........................94, 204maximum traffic burst ........................................94, 205media access control .................................................317MER ............................................................66, 114, 245MIB............................................................317, 321, 322MIBs
BRIDGE-MIB .......................................................321DOCS-BPI2-MIB..................................................321DOCS-BPI-MIB....................................................321DOCS-CABLE-DEVICE-MIB ..56, 146, 200, 202, 255,
277, 278, 295, 307, 321, 323DOCS-CABLE-DEVICE-TRAP-MIB........................321DOCS-QOS-MIB..........................................321, 323DOCS-SUBMGT-MIB ...........................................321enterprise MIB....................................................325ENTITY-MIB........................................................321ETHERLIKE-MIB .................................................321IF-MIB ..........................................37, 110, 255, 321INET-ADDRESS-MIB ...........................................319IP-MIB ................................................................321PBC-CMTS-MIB .............64, 200, 257, 292, 313, 325PBC-ENT-MIB .....................................................325PBC-GENERIC-MIB......................................135, 325PBC-KODIAK-M-G10-MIB............................225, 325
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Index 345
Index
RF-MIBv2-04 ......................................250, 251, 255SNMP-COMMUNITY-MIB ............................319, 322SNMP-FRAMEWORK-MIB...................................319SNMP-MPD-MIB .................................................319SNMP-NOTIFICATION-MIB .................................319SNMP-TARGET-MIB ....................................293, 319SNMP-USER-BASED-SM-MIB...............................319SNMPv2-CONF ...................................................319SNMPv2-MIB ..............................................255, 319SNMPv2-PDU .....................................................319SNMPv2-SMI ......................................................319SNMPv2-TC ........................................................319SNMPv2-TM .......................................................319SNMP-VIEW-BASED-ACM-MIB ............................319TCP-MIB .............................................................321UDP-MIB ............................................................321
minimum rate traffic .................................................305minimum reserved traffic rate.....................94, 205, 226minislot .............................................................113, 268modulation ................................................................268modulation profile ...............................76, 117, 260, 268modulation type ........................................................101MODULE-COMPLIANCE.............................................327MRTR ..................................................94, 205, 226, 305MSTR...........................................................94, 204, 206multicast .................................................55, 88, 93, 198multicast group ...........................39, 145, 194, 195, 276multicast map ...............................78, 94, 228, 229, 262
Nnetwork management system ...................................317network operations center.........................................317network time protocol ...............................................148next-hop router .........................................................192NMS ......................................................................59, 60NMS Management Server ..........................................317NMS see network management systemNOC see network operations centernoise cancellation........................................................79noise power...............................................................128notification ................................................................317NTP server.................................................147, 148, 267
OObject Identifier ........................................................325Objects
cmtsAgentCaps ..................................................328docsDevCmtsTrapControl...................................291docsDevEvControlTable .............................200, 202docsDevEventTable ....................................146, 277docsDevEvPriority......................................200, 202docsDevEvReporting ..........................................200docsDevEvSyslog ...............................................295docsDevEvThrottleAdminStatus .........................307
docsDevEvThrottleInterval .................................308docsDevFilterLLCEntry .........................................56docsIfCmtsServiceQosProfile..............................251docsSubMgtCmFilterDownDefault ........................63docsSubMgtCmFilterUpDefault .............................69docsSubMgtPktFilterEntry ....................................48docsSubMgtSubFilterDownDefault........................52docsSubMgtSubFilterUpDefault ............................53docsSubMgtTcpUdpFilterEntry .............................48ifAlias ...................................................................37ifXTable................................................................37pbcCaps .............................................................327pbcCardPortAlias................................................135pbcCardPortTable...............................................135pbcCmts.............................................................328pbcCmtsEventsEnable ........................................313pbcCmtsNotificationsControl ..............................200pbcExpr..............................................................327pbcG10CmtsCCMAction .....................................225pbcG10CmtsCcmSwitchAt ..................................225pbcG10CmtsCcmSwitchIn ..................................225pbcGeneric .........................................................328pbcGenericSystemAgentCapsR2.........................328pbcKodiakMG10AgentCaps ................................328pbcManagement.........................................327, 328pbcProducts ...............................................327, 328pbcRegs..............................................................327pbcReqs .............................................................327
Obsolete ....................................................................322offline CM..................................................................248OID....................................................................325, 328OSSI ..........................................................................322overprovision.............................................................226
PpacificBroadband.......................................................326pacificBroadband Module ..........................................325pagination .................................................................303part number ..............................................................267password ...................................................................133pbcCmtsNotificationsControl .....................................292PHY ...................................................106, 141, 249, 317ping ...........................................................................210port ...........................118, 128, 135, 177, 179, 189, 212power ..................................................................89, 237power adjustment................................................66, 114power level ..........................................42, 112, 120, 127power supply status...................................................266preamble .....................................................77, 101, 106pre-equalization.........................................................129privacy ..................................................................83–86privilege.............................................178, 180, 279, 284prompts.....................................................................284protocol data units.....................................................318provisioning.................................................................95
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Index
G-series CMTS CLI and SNMP Reference346
QQoS ...................................................................251, 262
RRADIUS .....................................................214, 219, 340random early detection .....................................216, 217ranging.................................... 54, 64, 89, 142, 239, 252ranging response....................................................... 129ranging-aborted......................................................... 136reboot ............................... 218, 227, 284, 297, 299, 311RED...................................................................216, 217redundant configuration............................ 222, 224, 265registration....................................................64, 83, 172relay agent ..................................................................90RF power............................................................. 42, 268RFC1155 ................................................................... 321RFC1157 ................................................................... 319RFC1212 ................................................................... 319RFC1213 ................................................................... 321RFC1215 ................................................................... 319RFC1493 ................................................................... 321RFC1901 ................................................................... 319RFC1902 ................................................................... 319RFC1903 ................................................................... 319RFC1904 ................................................................... 319RFC1905 ................................................................... 319RFC1906 ................................................................... 319RFC1907 ................................................................... 319RFC1908 ................................................................... 319RFC2011 ................................................................... 321RFC2012 ................................................................... 321RFC2013 ................................................................... 321RFC2233 ................................................................... 321RFC2570 ................................................................... 319RFC2571 ................................................................... 319RFC2572 ................................................................... 319RFC2573 ................................................................... 319RFC2574 ................................................................... 319RFC2575 ................................................................... 319RFC2576 ................................................................... 319RFC2578 ................................................................... 319RFC2579 ................................................................... 319RFC2580 ................................................................... 319RFC2665 ................................................................... 321RFC2669 ................................................................... 321RFC2669-EXT............................................................ 321RFC2737 ................................................................... 321RFC2851 ................................................................... 319RFC3083 ................................................................... 321rogue CM............................................. 91, 143, 237, 257running-config...................................152, 280, 300, 313
SSAM ............................................................................ 23
scheduling discipline .................................................305scrambler ............................................................76, 101secure copy ...............................................................197security association78, 93, 180, 209, 228, 261, 263, 310serial number ............................................................267service class ............43, 78, 94, 132, 204, 205, 229, 306service flows..............................................226, 241, 305shared secret .......................................................95, 263shortened last codeword .............................................77shutdown ..........................................................123, 289SID ............................................................159, 166, 237signal-to-noise ratio ...........................................104, 317SNMP ..........52, 53, 56, 63, 69, 134, 202, 255, 299, 317
agent..................................................................317entity..................................................................317manager.....................................................317–318
SNMP communities ...................................................290SNMP community string..............................................68SNR .............................................................66, 114, 268software image..........................................................299software release ........................................................297software version........................................................282spare channels ..........................................................128speed.................................................................188, 294SSH ...........................................................................197startup-config ............................152, 181, 281, 300, 313station maintenance............66, 115, 143, 171, 210, 252subscriber group......................31, 51, 99, 177, 184, 217switchback ................................................................223switchover.........................................................223, 265symbol rate .......................................................101, 268sync interval..............................................................100syslog ..................................................64, 200, 307, 308syslog server......................................................295, 318
TTACACS.....................................................219, 301, 340TCP .............................................................................48technical support.......................................................282TEK .............................................................................85Telnet ........................................198, 199, 203, 230, 302temperature ......................................................134, 266TFTP..........................................................................304TFTP server .................................................................92throttling ...........................................................307, 308timeout..............................................................230, 275timing adjustment .....................................................237TLV......................................................................70, 130traceroute..................................................................304traffic class ................................................................305traffic encryption key ..................................................85traffic policing .....................................................82, 206traffic priority ......................................................94, 306traffic scheduling ...........................46, 82, 124, 206, 305trap .............................................64, 200, 307, 308, 317trap classes........................................................291, 292
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Index 347
Index
troubleshooting .........................................................282trust.......................................................................84, 86
UUCC...........................................................................173UCD.....................................................76, 101, 166, 174UCM ..........................................................................104UDP.......................................................................48, 51unclassified traffic .................................................43, 94unregistered CM ........................................................258unverifiable packet ..........................................47, 60, 97UP-DIS.......................................................................175upgrade images .........................................................297upgrade log ...............................................................284upstream channel descriptor .......................................25Upstream Channel Monitoring...........104, 116, 125, 128username ..................................................284, 286, 312users..........................................................................285UTC time ...................................................................267
Vvalid packet .................................................................97validity period .............................................................84VLAN...................................................................16, 130VPN.............94, 130, 131, 138, 144, 235, 237, 251, 264
Wworking-config...........................................................287
••••••••••••••••••••••••••••••••••••••••••••••••••••••••••
Index
G-series CMTS CLI and SNMP Reference348