ARRIS C4® CMTS User Documentation Standard Version Issue 2.0 Software Release: 8.0.7 October 9, 2012
ARRIS Standard Software License Terms and Warranty Table Unless your company has executed a separate agreement which contains terms and conditions for software licensing of ARRIS products, you must agree to the below terms and conditions to receive download and support. ARRIS products, both Hardware and Software, contain proprietary information and trade secrets that are confidential information of ARRIS. ARRIS reserves the right to audit the use of Customer’s Hardware and Software.
Definitions and Interpretation Within this document definitions are defined as follows: "ARRIS" means ARRIS Solutions, Inc., a wholly owned subsidiary of ARRIS Group, Inc. and/or its designated affiliates. "Customer" means the person or entity however constituted to whom the Products or Services are provided. "Hardware" means equipment designed and manufactured by ARRIS, or other manufacturer's equipment offered for sale by ARRIS to Customer. "Software" means ARRIS-licensed software, including updates, and any other enhancements, modifications, and bug fixes thereto, in object code form only, and any full or partial copies thereof. Software is licensed by ARRIS separately or as part of a Product sale. Provided that the Customer has paid all applicable license fees to ARRIS, and assuming that the Customer has not negotiated a separate specific agreement or been granted a third-party license with the Software, then ARRIS grants to Customer a limited, royalty-free, nonexclusive and nontransferable, non-sublicensable license limited solely to the use of the Software’s application with the Hardware, if applicable, sold in conjunction with the Software for its intended purposes, which purposes preclude Customer’s provision of any product or service to a third party that would alleviate any third party from the obligation or need to obtain a separate license to the Software. All rights, title to and ownership of all applicable intellectual property rights in the Software, including but not limited to patents, copyrights and trade secrets remain with ARRIS and its licensors. Customer shall not attempt to acquire any other rights or transfer any ownership rights in the Software in contravention to ARRIS’ rights. ARRIS’ rights extend to any accompanying printed materials and online or electronic documentation, and any authorized copies of the above materials. The Software as used herein includes unpublished software, trade secret and confidential or proprietary information of ARRIS or its licensors and is developed at private expense. Customer may use third-party software products or modules supplied by ARRIS solely with the Products, unless the licensing terms of the third-party software specify otherwise. Customer shall not modify, create derivative works, reverse engineer, decompile, disassemble or in any manner attempt to derive the source code from the Software, in whole or in part, except and only to the extent that such activity is expressly permitted by applicable law. Customer is entitled to make a single copy of the Software solely for backup or archival purposes and all title, trademark, copyright, restricted rights or any other proprietary notices shall be reproduced in such copy. Unless otherwise agreed to in writing, Customer shall not otherwise use, copy, modify, lend, share, lease, rent, assign, sub-license, provide service bureau, hosting or subscriptions services, or distribute or transfer the Software or any copies thereof, in whole or in part, except as expressly provided in these terms and conditions. Customer further agrees not to publish or disclose any benchmark tests
ARRIS Group, Inc. Copyright 2012 Reference FRM0122, Issue 9, July 2010, Section 24
run on the Software. Customer shall not remove, obscure or alter any notice of copyright, patent, trade secret, trademark or other proprietary right or disclaimer appearing in or on any Software Products or accompanying materials. All rights not expressly granted hereunder are reserved by ARRIS. The Software may contain embedded third-party software (“Embedded Third-party Software). The licensors of such Embedded Third-party Software shall be third party beneficiaries entitled to enforce all rights and obtain all benefits which relate to such licensors under these terms and conditions. The licensors of such Embedded Third-party Software shall not be liable or responsible for any of ARRIS’ covenants or obligations under these terms and conditions, and Customer’s rights or remedies with respect to any Embedded Third-party Software under these terms and conditions shall be against ARRIS. Customer shall not directly access or use any embedded third-party software independently of the Software unless Customer obtains appropriate licenses. Under certain circumstances, ARRIS will advise that Customer needs to obtain a license for other third-party software (“Third-party Software”) for use in conjunction with the Software. Customer agrees that the terms and conditions agreed to between Customer and such Third-party Software vendor, including but not limited to warranties, indemnification and support, shall be solely between Customer and the Third-party Software vendor, and ARRIS shall not have any responsibility or liability for such Third-party Software. ARRIS Products may contain Open Source software. If Open Source is used, upon written request from an ARRIS customer, ARRIS will make available the appropriate Open Source software as per the applicable GPL. Table 1: ARRIS C4® Cable Modem Termination System (CMTS) Warranty Warranty Period from Shipment Date ARRIS Product Categories All ARRIS CMTS products including WiDOX CMTS, C3, C4, C4c, and D5 UEQ; and EGT Encoder Solutions: Encore and Quartet Encoders, VIPr Video Transcoder and System Solutions, and HEMi Headend Micro Solutions
Domestic U.S.
Outside U.S.
Hardware one (1) Year
Hardware one (1) Year
Software ninety (90) days
Software ninety (90) days
ARRIS Group, Inc. Copyright 2012 Reference FRM0122, Issue 9, July 2010, Section 24
Copyright and Trademark Information ARRIS C4® Cable Modem Termination System (CMTS) ARRIS C4® Cable Modem Termination System ARRIS C4c™ Cable Modem Termination System ARRIS DOCSIS® 3.0 C4® CMTS The capabilities, system requirements and/or compatibility with third-party products described herein are subject to change without notice. ARRIS, the ARRIS logo, Auspice®, BigBand Networks®, BigBand Networks and Design®, BME®, BME 50®, BMR®, BMR100®, BMR1200®, C3™, C4®, C4c™, C-COR®, CHP Max5000®, ConvergeMedia™, Cornerstone®, CORWave™, CXM™, D5®, Digicon®, E6000™, ENCORE®, EventAssure™, Flex Max®, FTTMax™, HEMi®, MONARCH®, MOXI®, n5®, nABLE®, nVision®, OpsLogic®, OpsLogic® Service Visibility Portal™, Opti Max™, PLEXiS®, PowerSense™, QUARTET®, Rateshaping®, Regal®, ServAssure™, Service Visibility Portal™, TeleWire Supply®, TLX®, Touchstone®, Trans Max™, VIPr™, VSM™, and WorkAssure™ are all trademarks of ARRIS Group, Inc. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and the names of their products. ARRIS disclaims proprietary interest in the marks and names of others. © Copyright 2012 ARRIS Group, Inc. All rights reserved. Reproduction in any manner whatsoever without the express written permission of ARRIS Group, Inc. is strictly forbidden. For more information, contact ARRIS.
Patent Information The ARRIS C4® Cable Modem Termination System (CMTS) is protected by U.S. and international patents including: 6,449,249 7,002,914 7,606,870 8,136,141 6,457,978 7,047,553 7,660,250 6,636,482 7,272,144 7,698,461 6,637,033 7,480,237 7,701,956 6,662,368 7,480,241 7,953,144 6,769,132 7,570,127 7,958,260 6,898,182 7,593,495 7,974,303 Additional ARRIS Group, Inc. patents pending.
ARRIS Group, Inc. Copyright 2012 Reference FRM0122, Issue 9, July 2010, Section 24
Table of Contents
Table of Contents List of Figures List of Procedures 1
About This Manual Intended Audience
1-1
Prerequisite Skill and Knowledge
1-2
Purpose
1-2
Conventions Used in this Document Admonishments
1-2
Textual Conventions
1-3
How to Contact Us
2
1-4
CLI Overview Access Levels and Modes
2-2
CLI Command Modes
2-2
CLI Syntax Conventions Designating MAC addresses and IP addresses
2-5 2-6
Keyboard Shortcuts
2-6
CLI Command Features
2-8
CLI Help Feature Configuring Passwords and Privileges
Issue 2.0
1-2
ARRIS PROPRIETARY — All Rights Reserved
2-8 2-12
v
Table of Contents
C4 CMTS Rel. 8.0.7
CLI Filtering
2-17
How to Use CLI Filtering
Show Cable Modem Column Feature
CLI
2-18 2-24
Command Descriptions List of CLI Commands
3
4
Standard and Cadant Enterprise MIBs CMTS SNMP MIB Variable Descriptions
3-2
Enterprise MIBs
3-5
SNMP Configuration with CLI
3-9
C4 CMTS Features DOCSIS 2.0 Compliance
4-1
Fault Detection and Recovery
4-3
Interfaces and Protocols
4-3
Security Features
4-4
C4 CMTS Feature Descriptions by Software Release
5
6
C4 CMTS Specifications Network Diagram
5-3
C4 CMTS Specifications
5-4
RF Electrical Specifications
5-6
Scalability
5-9
VoIP Call Capacities
5-10
Application-related Specifications
5-11
C4 CMTS Installation Requirements Safety Precautions Electrical Equipment Guidelines
vi
4-4
6-2 6-4
Electrostatic Discharge (ESD)
6-4
Installation Checklist
6-5
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
Table of Contents
Unpacking the C4 CMTS Module Protection
6-8
Installation Considerations
6-8
Rack Mounting
6-8
Power Requirements
6-9
Cooling Requirements
6-9
Rack Mounting the C4 CMTS Grounding the Chassis Main Hardware Components
6-13 6-14 6-14
Chassis — Rear View
6-16
Installing Modules in the C4 CMTS
6-17
Fan Trays
6-19 6-21
Power Conditioning Module and Cabling Power Protection Description
6-22 6-28
Chassis Maintenance
6-31
Replacing the C4 CMTS Chassis
6-32
System Control Module (SCM) SCM Overview
7-1
Installation
7-5
How to Set the Up the Terminal Emulator
7-9
SCM Replacement
7-11
SCM Upgrade to 1GB RAM (SCM II EM)
7-16
Virtual System Controller
Issue 2.0
6-12
Module Types and Chassis Slots—Front View
Air Filter
7
6-7
7-20
SCM II EM (U)
7-21
Compact Flash Disk Description
7-21
Replacing the Compact Flash
7-22
Compact Flash Disk Partitions
7-26
File System Administration
7-29
File Transfers
7-30
ARRIS PROPRIETARY — All Rights Reserved
vii
Table of Contents
8
9
C4 CMTS Rel. 8.0.7
Router Control Module (RCM) RCM Overview
8-1
Primary Software Functions
8-3
RCM Hardware
8-3
Downstream Cable Access Modules (DCAMs) Overview
9-1
16D Cable Access Module (16D CAM) 16D Physical Interface Cards (PICs)
9-10
Physical Interface Cards (PICs)
9-20 9-23
Annex
9-23
Downstream Frequency Range
9-28
XD CAM Field Software Upgrade
9-30
Overview
9-30
Sample Script for 32D CAM Provisioning
9-38
Upstream Cable Access Modules (UCAMs) Overview
10-1
Guidelines
10-2
12U Cable Access Module (12U CAM) Basic Command Set for Bringing Up a 12U CAM 24U Cable Access Module (24U CAM)
10-2 10-6 10-9
Rules and Restrictions for 12U/24U CAM Configuration
10-13
24U CAM Upstream Power Level Groups
10-14
Basic Command Set for Bringing Up a 24U CAM
10-17
Measuring SNR in the 12U/24U CAM
10-19
Modulation Profiles
viii
9-9
XD Cable Access Module (XD CAM) Downstream Parameters
10
9-2
10-23
Adjusting Channel Settings in Response to Increased CM Scaling
10-30
Explanation of Upstream Parameters
10-31
Modulation Profiles: Default and User-defined
10-40
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
Table of Contents
Optimizing a Modulation Profile Noise and SNR versus Modulation Symbol Rate
11
Before You Begin
11-1
Bring-up Procedures
11-5
Verification Steps
11-14
IPv6 Configuration (Optional)
11-22
Blank Worksheets
11-25
Control Complex Redundancy
13
CAM Sparing FlexCAM™ Hitless CAM Sparing
13-1
Guidelines for CAM Spare-groups
13-3
Configure 12U/24U CAM or 16D/XD CAM Sparing
13-4
Cable and Network IP Configuration Overview
14-1
Subinterfaces (Multiple VRIs per VRF)
14-2
Interface Configuration
14-4
Common Interface Configuring Commands
14-4
Monitoring Interfaces
14-5
802.1Q VLAN Tagging (Q-tags) CLI Commands
14-8 14-10
Loopback Interfaces for Routing Protocols
14-12
Dynamic Route Redundancy
14-16
Configuring IP Static Routes
14-17
Route Redistribution and Administrative Costing
14-17
CLI Commands Policy-Based Routing (PBR)
Issue 2.0
10-42
Basic Bring-up Procedure
12
14
10-42
14-19 14-30
Configuring PBR
14-31
CLI Commands
14-35
ARRIS PROPRIETARY — All Rights Reserved
ix
Table of Contents
15
C4 CMTS Rel. 8.0.7
Multiple VRFs
14-42
Overview
14-42
Overview of the Sample Procedure
14-43
Dynamic Routing Protocols Overview
15-1
Border Gateway Protocol (BGP)
15-2
BGP Confederations and Route Reflection
15-3
BGP Attributes
15-6
General Notes on BGP Function in the CMTS
15-7
Provisioning (CLI commands, MIBs, etc.)
15-9
Sample Configuration Command Scripts for BGP Intermediate System-Intermediate System (IS-IS)
15-20
Overview
15-20
CLNP Addressing/NSAP Address Format
15-21
IS-IS Network Topology, Unique Level 1 Areas
15-22
Dynamic Hostname Support
15-23
IS-IS Network Topology — Multi-homing
15-24
Packet Flow between IS-IS Systems
15-24
Designated Intermediate System (DIS) and Reliable Flooding of LSPs
15-24
Multiple Topology IS-IS (MT IS-IS)
15-26
Overview
15-26
Adjacencies
15-27
Broadcast Interface Adjacencies
15-27
Advertising MT Reachable Intermediate Systems in LSPs
15-27
MT IP Forwarding
15-28
Configuring MT IS-IS on the CMTS
15-28
Sample Configuration
15-29
Show commands
15-31
CLI Commands
15-34
CLI Commands for IS-IS and MT IS-IS Open Shortest Path First (OSPF)
x
15-16
15-35 15-42
Configuring OSPF
15-43
CLI Commands for OSPF
15-47
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
Table of Contents
Open Shortest Path First (OSPFv3) Advanced Features
15-57
Configuring OSPFv3 for IPv6
15-58
Summary of CLI Commands for OSPFv3
15-63
Routing Information Protocol (RIPv2)
16
15-67
RIP-related CLI Commands
15-67
RIP Authentication
15-71
Cable-side Configuration Overview
16-1
MAC Domains
16-2
CLI Commands for Cable-MACs
16-3
Channel to MAC Domain Association
16-5
Related CLI Commands
16-9
Upstream to Downstream Channel Association (Supervision)
16-10
Cable Plant Topology and Fiber Nodes
16-14
DOCSIS 3 Terminology
16-14
Fiber Node Configuration
16-16
Channel to Fiber Node Configuration
16-17
Downstream Channel Primary Capability
16-19
Calculating and Displaying Service Groups Receive Channel Configurations and Bonding Groups
17
(blank)
18
(blank)
19
IP Packet Filters, Subscriber Management
16-20 16-23
Overview
19-1
IP Packet Filters
19-2
Effect of IP Packet Filtering / Subscriber Management on IP Address Limits
19-11
Per-Interface Configuration
19-11
Default Subscriber Management Settings
Issue 2.0
15-50
ARRIS PROPRIETARY — All Rights Reserved
19-13
xi
Table of Contents
20
C4 CMTS Rel. 8.0.7
IP Packet Filters Show Commands
19-14
Debug IP Packet Capture
19-15
IP Packet Filtering Configuration Example
19-18
Baseline Privacy Interface (BPI) Baseline Privacy Overview Baseline Privacy Operational Overview Baseline Privacy Setup
20-4 20-4
Baseline Privacy Cable Modem Configuration File Settings
20-7
BPI Initialized State Configuration Settings
20-9
Digital Certificates (BPI+ Only)
20-10
Provisioning BPI X.509 Certificates Using Import/Export Commands
20-11
Provisioning X.509 Certificates
20-14
Baseline Privacy Debugging
20-16
Baseline Privacy Trap Codes
20-20
Baseline Privacy: CLI Commands
20-25
Configure Cable Command
20-25
Show Cable Command
20-27
Configure Interface Cable Commands
20-27
Show Interface Cable Command
20-28
CLI Commands BPI+ Enforce
20-29 20-30 20-31
CLI Commands
xii
20-2
Initial CMTS Base Table Setup
BPI Hybrid Mode Operation
21
20-1
20-32
DOCSIS Set-top Gateway Configuration Overview and Definitions
21-1
DSG Configuration Overview
21-4
Initial Configuration
21-5
Configuring Interfaces to Carry Tunnel Traffic
21-5
Enabling Upstream Filters
21-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
Table of Contents
DSG Configuration
22
23
Configuring Access List, Filters and Rate Limits
21-9
Configuring IP Forwarding for Basic Mode DSG
21-10
Configuring for Advanced DSG Mode
21-11
DS Cable Interface
21-13
DSG Tunnels
21-15
DSG Classifier
21-19
DSG Configuration Scenarios
21-21
Initial Setup for DSG
21-21
DSG Configuration Only
21-23
Multicast Destination IP to RFC1112 DSG Tunnel MAC
21-24
Multicast Destination IP to non-RFC1112 DSG Tunnel MAC
21-27
Unicast Destination IP
21-30
CPE Device Classes Overview
22-1
Related Terms
22-3
DHCP Options
22-3
DHCP Helper Address Provisioning
22-5
Assigning Secondary Interfaces Based on Device Class
22-6
Filter Groups Based on Device Class
22-7
CLI Changes and Additions
22-9
Integrated Upstream Agility Overview
23-1
Examples of Upstream Agility State Machines
23-4
Example 1
23-5
Example 2
23-11
Example 3
23-12
Example 4
23-14
Sample Configuration
23-15
CLI Commands
Issue 2.0
21-8
23-17
Assigning & Unassigning State Machines to Upstream Channels
23-24
Show Commands
23-25
ARRIS PROPRIETARY — All Rights Reserved
xiii
Table of Contents
C4 CMTS Rel. 8.0.7
CMTS State Machine Crosschecks
24
Channel Bonding Downstream Channel Bonding (DSCB)
24-3
RCP/RCC
24-6
Configuration Examples for Static RCC
24-10
Configuring Channel Bonding Groups
24-11
Per-packet Channel Selection for Bonding Groups
24-12 24-14
Non-Primary Channel Acquisition for Upstream Channel Bonding
24-17 24-18
Upstream Impairment Detection and Recovery
24-18
Downstream Impairment Detection and Recovery
24-18
IPv6 IPv6 Packet Structure
25-2
IPv6 Addressing Architecture
25-3
C4 CMTS Security Features for IPv6
25-9
CLI Commands
25-10
Proxy Duplicate Address Detection
25-18
DHCPv6 PDRI and Bulk Lease Query
25-18
IPv6 Prefix Stability
25-25
Using Prefix-Stability in CMTSs
25-25
Operational Concerns
25-35
IPv6 Distribute Lists
25-38
Channel Assignment Introduction
26-1
CM Channel Selection
26-2
Channel Assignment Restrictions for DOCSIS 3.0 Modems Service Flow Channel Selection
xiv
24-13
Selective Enabling of USCB within a MAC Domain Partial Service Handling on the C4/C4c CMTS
26
24-1
Configuration Example Using Sample MAC Domain 1
Upstream Channel Bonding (USCB)
25
23-33
ARRIS PROPRIETARY — All Rights Reserved
26-4 26-4
October 9, 2012
C4 CMTS Rel. 8.0.7
Table of Contents
Attribute Masks
27
28
IP Video Overview
27-1
IP Video Functionality
27-3
ASM Architecture
27-5
SSM Architecture
27-6
IP Video Provisioning
27-8
Configure Multicast Routing
27-12
Additional Configuration References
27-13
IP Video Visibility
27-14
IP Video Monitoring and Management
27-22
CLI Commands
27-25
Multicast Overview
28-1
IP Multicast
28-1
Multicast Traffic IGMP Implementation Protocol-Independent Mode—Source-Specific Multicast Multicast Routing
29
Issue 2.0
26-4
28-2 28-3 28-4 28-4
ASM/SSM Configurations
28-5
IGMP Visibility
28-7
Static IGMP Joins
28-10
CLI Commands
28-11
Connection Admission Control (CAC) Overview
29-1
General CAC Description
29-2
PacketCable CAC Description
29-2
Multicast CAC Description
29-3
Configuring CAC
29-5
Show/Display Commands
29-7
Data Consistency Checks
29-9
ARRIS PROPRIETARY — All Rights Reserved
xv
Table of Contents
30
31
C4 CMTS Rel. 8.0.7
Converged Services Overview
30-1
Converged Services
30-1
PacketCable™ Services PacketCable 1.x Overview
31-1
PacketCable Multimedia Overview
31-5
PCMM Classification for Remotely Connected Subnets
31-9
Configuration Procedures
31-12
PacketCable Settings
31-13
PC1.x Electronic Surveillance
31-22
Electronic Surveillance Configuration
31-24
Electronic Surveillance Logging Messages
31-24
Turbo Button
31-25
IKE and IPSec Configuration
32
Security AAA Feature
33
xvi
31-25
32-1
Secure Shell Protocol (SSH2)
32-15
Routing to a Null Interface
32-24
Source Verification of Cable-side IP Addresses
32-25
CPE Host Authorization
32-27
DSx DQoS VoIP on the CMTS
32-30
CMTS Advanced CM Configuration File Verification
32-31
Cable Modem MAC Deny List
32-35
Legal Intercept Overview
33-1
Abbreviations
33-4
Chassis Configuration
33-4
CLI Commands
33-5
Data Management and Maintenance
33-7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
34
35
Table of Contents
Load Balancing Load Balancing Group Definitions
34-2
CLI Commands for Load Balancing
34-12
Minimal Configuration
34-13
Additional Load-Balance Commands
34-16
Interaction with Older Cable Modems
34-23
Load Balancing of Bonded Cable Modems
34-23
Distributing Bonded CMs across Downstreams at Registration Time
34-24
Load Balancing Bonded CMs at Regular Intervals
34-25
DCC across MAC Domains Using MIBs
34-26
Downstream and Upstream Utilization Start Thresholds
34-28
Load Balance Rule-based Modem Steering
34-30
Service-type Modem Steering
34-34
Packet Throttling SCM Packet Throttling
35-1
RCM Protocol Policing
35-2
Upstream Cable Protocol Throttling
35-5
ARP Neighbor Discovery (ND) Abuse Detection Network-side ACLs
35-10
ARP/ND Abuse Counts
35-11
Token Bucket 3.0: Traffic Shaping on 16D/XD CAMs
35-14
Upstream Power Boost Cap
36
35-16
Access Control Lists Overview
36-1
Named Access Lists
36-4
Data Plane Filter IP ACLs
36-6
SCM Access
36-8
Using IGMP ACLs to Override Reserved Multicast Group IP Addresses
Issue 2.0
35-9
ARRIS PROPRIETARY — All Rights Reserved
36-11
xvii
Table of Contents
37
C4 CMTS Rel. 8.0.7
Internet Protocol Detail Record (IPDR) Overview
37-1
Operational Issues
37-3
Abbreviations
37-4
IPDR Functionality
37-5
CLI Commands
37-7
Data Management and Maintenance
38
39
Host Names, User IDs, and Password Recovery How to Administer the Host Name and User IDs
38-1
How to Add and Delete Users
38-2
User Profiles
38-4
Password Recovery
38-6
Clock Synchronization Protocol Manually Setting the Internal Clock
39-1
Configuring Time of Day (TOD) Clock Protocol
39-2
Using Network Time Protocol (NTP)
39-2
Secure NTP
39-6
Show Clock Commands
39-7
40
Service Class Names
41
Per-Subscriber Throughput Overview
42
41-1
Additional Classifier Support Overview
43
xviii
37-10
42-1
Diagnostics Running Diagnostics
43-1
CLI Output for Diagnostics
43-5
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
44
Table of Contents
Logging and the CMTS Event Messages
44-1
How Event Messages Are Routed
44-2
Event Management Subsystems
44-3
Event Message Throttling
44-5
Show Logging Commands
44-6
Configuring Event Throttling
44-9
Configuring Event Routing Generating Events and Traps
44-15
SNMP Trap Examples
44-16
Routing Events to Local Volatile Logs
45
44-18
Displaying Events on the System Console
44-19
Routing Events to the Monitor
44-20
Routing Events to the History Log
44-20
Logging OSPF Event Messages
44-21
Fully-Qualified Domain Name (FQDN) Overview
45-1
Operational Concerns
45-2
CLI Commands
45-4
46
DSx DQoS VoIP on the CMTS
47
BSoD L2VPN
Issue 2.0
44-12
Background Information
47-1
Overview
47-2
Additional Information
47-4
Enabling BSoD
47-5
CLI Commands
47-7
ARRIS PROPRIETARY — All Rights Reserved
xix
Table of Contents
C4 CMTS Rel. 8.0.7
Updates included in Release 8.0.7 CLI Changes in Release 8.0.5 Comments & Feedback Form
xx
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
List of Figures
3
Standard and Cadant Enterprise MIBs Figure 3-1:
5
6
Issue 2.0
Relationship of SNMP Tables to User-defined Elements
3-11
C4 CMTS Specifications Figure 5-1:
The C4 CMTS (front view)
5-2
Figure 5-2:
Typical Cable Network Architecture
5-3
Figure 5-3:
WEEE Symbol
5-5
C4 CMTS Installation Requirements Figure 6-1:
C4 CMTS Chassis Handles
6-3
Figure 6-2:
Internal Air Flow (side view)
6-11
Figure 6-3:
Location of Grounding Terminals
6-13
Figure 6-4:
Front View of C4 CMTS
6-15
Figure 6-5:
C4 CMTS Chassis (rear view)
6-16
Figure 6-6:
Installing the System Control Module
6-18
Figure 6-7:
Ejector Levers
6-19
Figure 6-8:
Example of High Speed Fan Tray
6-20
Figure 6-9:
Installing the Fan Tray
6-21
Figure 6-10: Installing the PCM
6-23
Figure 6-11: Cabling the PCM
6-24
Figure 6-12: C4 CMTS Front Access Panels
6-27
Figure 6-13: LED and Power Bus Switches
6-28
ARRIS PROPRIETARY — All Rights Reserved
xxi
List of Figures
7
8
9
xxii
C4 CMTS Rel. 8.0.7
Figure 6-14: C4 CMTS Power Feeds (chassis rear)
6-29
Figure 6-15: Second Level — Internal Branch Fusing
6-30
Figure 6-16: Power Control Button
6-31
System Control Module (SCM) Figure 7-1:
System Control Module and Physical Interface Card
7-2
Figure 7-2:
View of Pin-out of Serial Cable
7-7
Figure 7-3:
Connecting the Console Port to a PC
7-8
Figure 7-4:
Opening a Terminal Session on the CMTS
7-10
Figure 7-5:
Removing the DIMM
7-17
Figure 7-6:
Replacing the DIMM Module
7-18
Figure 7-7:
Labeling the SCM
7-18
Figure 7-8:
Pin-out of 4GB Flash Disk Connector
7-22
Figure 7-9:
Location of the Compact Flash Disk
7-23
Figure 7-10: Removing the Compact Flash Disk
7-23
Figure 7-11: Inserting the Compact Flash Disk
7-24
Figure 7-12: Flash Disk Partition Structure
7-26
Router Control Module (RCM) Figure 8-1:
Router Control Module and Rear Filler Panel
8-2
Figure 8-2:
RCM Crossover Connector
8-4
Figure 8-3:
Installing the RCM Crossover Connector
8-5
Figure 8-4:
Examples of an Optical XFP, Optical SFP, and Copper SFP
8-6
Figure 8-5:
Installing the XFPs and SFPs
8-8
Downstream Cable Access Modules (DCAMs) Figure 9-1:
16D CAM and Rear Physical Interface Cards (PICs)
9-3
Figure 9-2:
16D CAM Downstream Test Port
9-5
Figure 9-3:
Example of 6 MHz Frequency Grid used for Annex B
9-7
Figure 9-4:
XD Cable Access Module (CAM) and Rear Physical Interface Cards (PICs)
9-12
Figure 9-5:
XD CAM Downstream Test Port
9-15
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
10
11
13
14
15
List of Figures
Figure 9-6:
Example of 6 MHz Frequency Grid used for Annex B
9-17
Figure 9-7:
Upgraded CAMs with XD Decals
9-37
Upstream Cable Access Modules (UCAMs) Figure 10-1: 12U Cable Access Module (CAM) and the Three Types of Upstream Physical Interface Cards (PICs)
10-3
Figure 10-2: 24U Cable Access Module (CAM) and the Three Types of Upstream Physical Interface Cards (PICs)
10-10
Figure 10-3: Illustration of the Shuffle Network
10-12
Figure 10-4: Relation of FEC Codewords to Data Packet
10-44
Figure 10-5: Maximum ATDMA Data Rate vs. SNR
10-45
Basic Bring-up Procedure Figure 11-1: Network Connectivity Diagram
11-3
Figure 11-2: Network Diagram Example
11-4
Figure 11-3: C4 CMTS Slot Diagram
11-6
CAM Sparing Figure 13-1: Example of 24U and XD Spare-groups (front view)
13-5
Figure 13-2: Example of CAM Sparing PICs (chassis rear view)
13-6
Cable and Network IP Configuration Figure 14-1: Difference between Standard IP and Q-tag Encapsulation
14-8
Figure 14-2: IEEE 802.1Q/p Tag Format
14-9
Figure 14-3: Example of Packet Flow Using Loopback Interface
14-14
Figure 14-4: Flowchart Representing Decision Path for PBR or Normal Routing
14-41
Dynamic Routing Protocols Figure 15-1: Figure 1: I-BGP with Confederations to Reduce Full Mesh Peering
15-4
Figure 15-2: Figure 2: BGP Network Topology with Route Reflections and an OSPF overlay 15-5
Issue 2.0
Figure 15-3: IS-IS Level 1 and Level 2 Routing
15-22
Figure 15-4: Example of IS-IS and MT IS-IS Topologies
15-26
ARRIS PROPRIETARY — All Rights Reserved
xxiii
List of Figures
21
C4 CMTS Rel. 8.0.7
DOCSIS Set-top Gateway Configuration Figure 21-1: Logical devices in a DSG system
21-2
Figure 21-2: Block Diagram of an Advanced DSG Configuration
23
21-12
Integrated Upstream Agility Figure 23-1: State Diagram of a State Machine (Example)
24
Figure 23-2: Example of a State Machine for a Dramatic Improvement Trigger
23-11
Figure 23-3: State Diagram Using Degradation and Periodic Triggers (Example)
23-12
Figure 23-4: State Diagram Using Simple Time-of-Day (TOD) Triggers (Example)
23-14
Channel Bonding Figure 24-1: Sample MAC Domain Figure 24-2: Snapshot from Config File with Attribute Mask Set for USCB
25
27
30
xxiv
24-2 24-16
IPv6 Figure 25-1: Block Diagram of PDRI Feature
25-19
Figure 25-2: Scenario for Prefix Stability
25-26
IP Video Figure 27-1: IP Video Architecture
27-2
Figure 27-2: IP Video Subsystems
27-3
Figure 27-3: ASM Architecture
27-5
Figure 27-4: SSM Architecture
27-7
Converged Services Figure 30-1: Example of Classification for Combined Voice, Video, and Data
31
23-6
30-4
PacketCable™ Services Figure 31-1: PacketCable Network Reference Architecture
31-3
Figure 31-2: Foundations of PCMM Architecture
31-6
Figure 31-3: Network Diagram of PCMM Implementation
31-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of Figures
Figure 31-4: PCMM Support for Using Remote Subnet IPs as Subscriber IDs on the C4 CMTS
32
Security Figure 32-1: AAA Security Model
33
44-4
BSoD L2VPN Figure 47-1: Example of Modem Configuration File Screenshot Figure 47-2: Sample BSOD Configuration Using BSOD Capable and Legacy (PPoE) Modems
Issue 2.0
42-3
Logging and the CMTS Figure 44-1: Event Management Subsystems on the CMTS
47
34-37
Additional Classifier Support Figure 42-1: Example of a Network Diagram for Additional Classifier Telephony
44
33-2
Load Balancing Figure 34-1: Adding Service-Type ID to the CM Config File
42
32-3
Legal Intercept Figure 33-1: RFC 3924 Framework
34
31-10
ARRIS PROPRIETARY — All Rights Reserved
47-6 47-10
xxv
List of Figures
xxvi
C4 CMTS Rel. 8.0.7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
List of Procedures
3
Standard and Cadant Enterprise MIBs Procedure 3-1
6
7
Basic Configuration for an SNMP v1/2 Community
C4 CMTS Installation Requirements Procedure 6-1
How to Rack Mount the C4 CMTS
6-12
Procedure 6-2
How to Install the Fan Trays
6-20
Procedure 6-3
How to Install the PCMs
6-23
Procedure 6-4
How to Cable the PCM
6-24
Procedure 6-5
Replacing a PCM
6-25
Procedure 6-6
How to Replace the Chassis
6-32
System Control Module (SCM) Procedure 7-1
How to Install the SCM
7-5
Procedure 7-2
How to Install the SCM PIC
7-6
Procedure 7-3
How to Cable the SCM
7-8
Procedure 7-4
How to Open the Terminal Emulator Session
7-10
Procedure 7-5
How to Replace an SCM in a Duplex Chassis
7-11
Procedure 7-6
How to Replace an SCM in a C4c CMTS or a Simplex Chassis
7-14
Procedure 7-7
Backing up the Existing Configuration of the SCM
7-15
Procedure 7-8
Upgrading the SCM to 1 GB — Duplex System
7-16
Procedure 7-9
Upgrading the SCM to 1 GB - Simplex System
7-19
Procedure 7-10 Replacing the Compact Flash Disk on a Duplex System
Issue 2.0
3-9
ARRIS PROPRIETARY — All Rights Reserved
7-22
xxvii
List of Procedures
C4 CMTS Rel. 8.0.7
Procedure 7-11 Replacing the Compact Flash Disk on a Simplex System
8
9
10
12
7-25
Router Control Module (RCM) Procedure 8-1
To Install the RCM Crossover Connector
8-5
Procedure 8-2
Installing Fiber Optic XFPs or SFPs Into the RCM Ports
8-7
Procedure 8-3
Install Copper SFP Into GigE Ports
8-9
Downstream Cable Access Modules (DCAMs) Procedure 9-1
How to Change the Local Annex on a 16D CAM
9-24
Procedure 9-2
Assigning a DS Channel Frequency outside the 80MHz Range for Its Connector
9-27
Procedure 9-3
Create a Backup Copy of the Running Configuration
9-32
Procedure 9-4
Create a Script to Provision XD CAMs
9-32
Procedure 9-5
Convert All 16D CAMs in the Chassis to 24/32D CAMs by Reprovisioning the Downstream Cards Only 9-33
Procedure 9-6
Create a Script to Reconfigure the Chassis after Upgrading the CAMs
9-35
Procedure 9-7
Upgrading All 16D CAMs in the Chassis to XD CAMs by Reprovisioning the Entire Chassis
9-36
Upstream Cable Access Modules (UCAMs) Procedure 10-1 Before Changing the Receive Power Level Settings of the 24U CAM
10-16
Procedure 10-2 How to Create and Apply a Modulation Profile to an US Port
10-23
Procedure 10-3 How to Configure an Upstream (US) Channel
10-24
Procedure 10-4 Putting Cards and Ports into Service
10-29
Procedure 10-5 How to Take a CAM Out of Service and Delete Its Slot
10-29
Control Complex Redundancy Procedure 12-1 Add a Control Complex (Change from Simplex to Duplex)
13
12-2
CAM Sparing Procedure 13-1 Use this procedure to create 12U and 16D CAM spare-groups shown in the example shown in Figure 13-1.
xxviii
ARRIS PROPRIETARY — All Rights Reserved
13-6
October 9, 2012
C4 CMTS Rel. 8.0.7
List of Procedures
Procedure 13-2 How to Fail Back Manually Procedure 13-3 How to Delete a CAM Spare-group
14
23
25
Issue 2.0
13-10
Cable and Network IP Configuration Procedure 14-1 How to Monitor Interfaces
15
13-9
14-5
Procedure 14-2 How to Add/Delete/View a Static IP Route to the CMTS
14-17
Procedure 14-3 Example of Setting Up Five VRFs
14-44
Dynamic Routing Protocols Procedure 15-1 Use the following procedure to enable/disable MT IS-IS on the CMTS
15-28
Procedure 15-2 Change the Default Metric
15-29
Procedure 15-3 How to Enable OSPF
15-43
Procedure 15-4 How to Disable OSPF for an Interface
15-45
Procedure 15-5 How to Disable OSPF on the CMTS
15-46
Procedure 15-6 Configuring OSPFv3 with Cable-side Interfaces as Passive Interfaces
15-59
Procedure 15-7 Configuring OSPFv3 with Route Redistribution
15-61
Procedure 15-8 How to Disable OSPv3 Globally on the CMTS
15-63
Procedure 15-9 How to Enable Single Key Authentication
15-73
Procedure 15-10How to Enable Multiple Key Authentication (i.e., Key Chains)
15-74
Integrated Upstream Agility Procedure 23-1 Configuring a Sample Upstream Agility Application
23-15
Procedure 23-2 Modifying a State Machine (an example)
23-30
IPv6 Procedure 25-1 Configuring Prefix Stability Using IS-IS
25-27
Procedure 25-2 Configuring Prefix Stability Using OSPF
25-30
Procedure 25-3 Sample Distribute List for OSPFv3 PD Routes
25-38
ARRIS PROPRIETARY — All Rights Reserved
xxix
List of Procedures
28
32
33
34
C4 CMTS Rel. 8.0.7
Multicast Procedure 28-1 Configure Network to Cable ASM Data Forwarding
28-6
Procedure 28-2 Configure Network to Cable SSM Data Forwarding
28-6
Security Procedure 32-1 Configure TACACS Server to Enable Password
32-10
Procedure 32-2 Configure the CMTS to Enable Password
32-10
Procedure 32-3 Sample Procedure for Configuring TACACS Accounting
32-14
Procedure 32-4 Setting up SSH on the CMTS
32-18
Procedure 32-5 PuTTY, SSH, Public Key Authentication
32-19
Procedure 32-6 Storing or Backing up Server Keys
32-20
Procedure 32-7 Restoring Server Keys from Backup Files
32-21
Legal Intercept Procedure 33-1 Sample Configuration for Secure Access and Tap
33-5
Procedure 33-2 To create or delete an LI tap on an IPv6 modem
33-7
Load Balancing Procedure 34-1 Example of Service-type Modem Steering Configuration
38
39
xxx
34-35
Host Names, User IDs, and Password Recovery Procedure 38-1 How to Configure a Host Name and Syslog Server IP Address
38-1
Procedure 38-2 How to Configure Privilege Levels and Authentication
38-3
Procedure 38-3 Creating a Global User Profile
38-4
Procedure 38-4 Creating a User Profile
38-5
Procedure 38-5 How to Enable Password Recovery Using Application Dialog
38-6
Clock Synchronization Protocol Procedure 39-1 Configuring Time of Day (TOD) Clock Protocol
39-2
Procedure 39-2 Configure NTP for CMTS
39-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
44
Issue 2.0
List of Procedures
Logging and the CMTS Procedure 44-1 How to Route Events to the Console
44-19
Procedure 44-2 How to Route Events to the Monitor
44-20
Procedure 44-3 How to Configure the History Log
44-21
ARRIS PROPRIETARY — All Rights Reserved
xxxi
List of Procedures
xxxii
C4 CMTS Rel. 8.0.7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
1 About This Manual
C4/C4c CMTS Rel. 8.0.7
1
About This Manual
Topics
Page
Intended Audience
1
Prerequisite Skill and Knowledge
2
Purpose
2
Conventions Used in this Document
2
How to Contact Us
4
In response to emerging IP-based data and voice services, ARRIS brings to market a next-generation, carrier-class Cable Data Network Solution — the C4® Cable Modem Termination System (CMTS). ARRIS has deployed more than 4600 CMTSs supporting millions of subscribers. The CMTS has been designed to meet the needs of the Multiple System Operator (MSO) in terms of system density, wire-speed performance, and reliability. The CMTS enables MSOs to bundle high-speed data, voice, fullmotion video, and other multimedia content to residential and business customers.
Intended Audience This document is intended for MSO technical support personnel who are responsible for integrating, operating, and maintaining the CMTS.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
1-1
1 About This Manual
C4/C4c CMTS Rel. 8.0.7
Prerequisite Skill and Knowledge This document serves as an introduction to the CMTS for all administrators and users of cable modem termination systems. Ideally, users of this documentation and equipment should have a basic knowledge of the following: •
RF measuring equipment
•
Provisioning servers
•
Command Line Interface (CLI) commands
•
RF cable plant and operating methods
Purpose To provide a comprehensive overview of the CMTS including reference and procedural information required to manage and control the CMTS.
Conventions Used in this Document This section presents the textual conventions used in this documentation set.
Admonishments There are three levels of admonishments used in this documentation. The first is a simple note. NOTE Notes are intended to highlight additional references or general information related to a procedure, product, or system. The international symbols, Caution and Warning, appear in this book to indicate actions involving risk.
1-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
1 About This Manual
C4/C4c CMTS Rel. 8.0.7
CAUTION
Cautions indicate risk of dropping traffic, losing data, or disrupting the equipment. Read the accompanying instructions and proceed with caution.
WARNING
The warning symbol represents a risk of bodily injury or serious damage to the equipment. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and fiber optics and follow standard procedures for preventing accidents and serious damage.
Textual Conventions The conventions used in this guide are shown in the following table: Table 1-1: Examples of Textual Conventions Type of text
Description
Example
CLI commands and other user input
Monospaced bold (courier)
configure slot type RCM
Names of chapters and manuals
Italicized text
chapter 1, AboutThis Manual
Menu selections
Plain-faced text
From the File>Set-up menu choose…
Monospaced font
Time since the CMTS was last booted: 12 days, 2: 8: 14
System responses and screen display
(courier)
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
1-3
1 About This Manual
C4/C4c CMTS Rel. 8.0.7
How to Contact Us Product Information and Support
If you have questions about the ARRIS CMTS, please direct your technical support requests to ask.arrisi.com. The Technical Support Contact information is summarized in the following table. Contact information is also available from our Web site at: http://www.arrisi.com/about_us/contact_us/tech_support/index.asp.
Table 1-2: C4/C4c Technical Support Contacts Phone
E-mail
NORTH AMERICA +1 888 221 9797 (N. America only) +1 678 473 5656 (Worldwide)
[email protected]
LATIN AMERICA Latin America:
+56 2 678 4500
Brazil:
+55 11 2737 7629
Chile:
+56 2 678-4500
Colombia:
+57 1 381 9103
Mexico:
+1 800 522 7747 or +52 55 2282 8531
[email protected]
EUROPE +31 20 311 2525
[email protected]
+81 3 5461-7320
[email protected]
+82 31 783 4893
[email protected]
JAPAN
KOREA
ASIA
1-4
Asia
+86 755 8634 9110
China
+86 755 8634 9110 or 40088 10685
[email protected]
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
1 About This Manual
Training Information
ARRIS Training is the authorized organization for training on voice, data, and provisioning products. Web-based, instructor-led, and customized courses are available at our U.S. training center in Atlanta. On-site training is available.To obtain pricing for on-site training and other training information, visit our web site: http://www.arrisi.com/support/training/index.asp
Comments on this Document
Issue 2.0
Our goal has been to create a document that best fits your needs. We are interested in your suggestions for improving this document. Please use the Comments & Feedback Form to address any comments or questions you may have regarding this documentation.
ARRIS PROPRIETARY — All Rights Reserved
1-5
1 About This Manual
1-6
C4/C4c CMTS Rel. 8.0.7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
2
CLI Overview
Topics
Page
Access Levels and Modes
2
CLI Syntax Conventions
5
Keyboard Shortcuts
6
CLI Command Features
8
CLI Filtering
17
Show Cable Modem Column Feature
24
The Command Line Interface (CLI) is the software tool used to provide users with administrative control of the CMTS after hardware installation is complete — whether from the console or through a remote network connection. The CLI is a straightforward command interface in which commands are typed on a single line and executed by pressing the Enter key. The CLI provides command help, command completion, and keyboard sequences that enable a user to navigate a command line and scroll through a buffer that contains recently entered commands. The CLI enables system operators to enter the commands needed to add, manage, display, and remove hardware modules, networks, users, and other system entities.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-1
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Access Levels and Modes The CMTS CLI supports two main access levels: User EXEC and Privileged EXEC. User EXEC
Users first logging in to the CMTS are assigned non-privileged status. The command line prompt will be the machine name followed by a greaterthan sign (>). There are two levels of User EXEC, signified by a 0 (zero) or 1 (one). The 0 commands are associated with logging in, changing privilege levels, and logging out as shown in the following list: disable enable no enable [] end
exit [all] logout quit [all]
The level 1 commands are only a subset of the CLI commands, the ones that display non-privileged information. You are not able to enter commands to change configuration or display privileged information until you become a privileged user. Privileged EXEC
To become a privileged user, enter the enable command. Normally, you must enter a password to enter Privileged EXEC mode. You are permitted three unsuccessful attempts to enter a password before the connection attempt is refused. If the password is accepted, the end of the prompt changes to a pound sign (#). From Privileged EXEC mode, you may access global configuration mode. In this mode, you can enter commands that configure general system characteristics. You can also use global configuration mode to enter specific configuration modes. (See Table 2-1).
CLI Command Modes The CMTS supports hundreds of CLI commands. They are grouped into different functional modes. The first set of commands is available to all users including those with non-privileged access. Most of these commands are used to show system status. They are available when the CMTS is in User EXEC mode or any other mode. The other modes are available only to users with privileged access. These commands are more powerful and can be used to reconfigure the system or to adjust system performance. This command reference manual lists the CLI commands in straight alphabetical order.
2-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Table 2-1 lists some of the command modes and some of the commands needed to change from one mode to another: Table 2-1: How to Enter the Various Command Modes Mode
To enter this mode, type …
Resultant Prompt
User EXEC
+
C4>
Privileged EXEC
enable +
C4#
Global configuration
(From Privileged EXEC mode)
Access-list configuration
(From global configuration mode)
Cable modulationprofile
(From global configuration mode)
Cable interface configuration
(From global configuration mode)
Cable downstream interface configuration
(From global configuration mode)
Cable fiber-node configuration
(From global configuration mode)
C4(config-ACL num)#
access-list |
cable modulation-profile
C4(config-modprofile) C4(cfg-i-cable)#
interface cable /
interface cable-downstream /
fiber-node
Cable cable intercept (From global configuration mode) configuration cable intercept Cable MAC interface configuration
(From global configuration mode)
Cable MAC interface cable downstreambonding-group
(From global configuration mode)
Cable upstream interface configuration
(From global configuration mode)
Ethernet interface configuration
(From global configuration mode)
Gigabit Ethernet interface configuration
(From global configuration mode)
Key chain configuration
(From global configuration mode)
Issue 2.0
C4(config)#
configure
C4(cfg-i-ds)
C4(config-fibernode)# C4(config-cableintercept) C4(cfg-i-mac)
interface cable-mac
interface cable-mac cable downstream-bonding-group
interface cable-upstream /
C4(cfg-i-macdsbond)#
C4(cfg-i-us)
C4(config-ether)
interface ethernet / C4(cfg-i-gigE)
interface gigabitEthernet C4(config-keychain)#
key chain
ARRIS PROPRIETARY — All Rights Reserved
2-3
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Table 2-1: How to Enter the Various Command Modes Mode
To enter this mode, type …
Key chain key configuration
(From global configuration mode)
Loopback interface configuration
(From global configuration mode)
Null interface configuration
(From global configuration mode)
Router OSPF configuration
(From global configuration mode)
Router RIP configuration
(From global configuration mode)
Router Static configuration
(From global configuration mode)
System controller interface configuration
(From global configuration mode)
TenGigabit Ethernet interface configuration
(From global configuration mode)
key chain key
Resultant Prompt C4(configkeychain-key)# C4(config-loop)#
interface loopback C4(config-null)#
interface null
router ospf
router rip
router static
C4(config-routerospf)# C4(config-routerrip)# C4(config-routerstatic)# C4(config-system)#
interface system-controller
C4(cfg-i-10gigE)
interface tengigabitEthernet
NOTE If you have trouble entering a command, check the system prompt and enter the question mark (?) for a list of available commands. You might be in the wrong command mode or using incorrect syntax. To exit from the Command Modes, type: exit
- This exits mode and goes to the last level used.
quit
- This exits mode and goes to the last level used.
exit all - Exits all modes and goes to the top command level. z
2-4
- Exits all mdoes and goes to the top command level.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
CLI Syntax Conventions ARRIS documentation uses certain conventions to show the syntax of commands. These notations are not part of the command itself but indicate command entry options. The notations are for documentation purposes only, they are not input by the user. The CLI commands in this chapter use the syntax conventions described in the following table:
Table 2-2: Conventions for Representing Command Syntax CLI Syntax
Description
Angle brackets indicate a required value or parameter which is position-dependent and does not have keywords.
[...]
Brackets enclose optional entries—they may be included or excluded.
{...}
Braces enclose two or more entry choices; one and only one choice should be entered in the command.
[...]+
“+” Represents multiple, so the inside of the brackets must be 0 or more times.
{...}+
“+” Represents multiple, so the inside of the braces must be 11 or more times.
{...}+2-12
“2-12” represents the number of times it repeats. In this case, 2 through 12 are legal repetitions.
Parameters preceded by an asterisk indicate a wildcard. They may use an “*”, a range (2-5), or a list (1,2,5,7,9).
[word {a | b}]
|
Braces and a vertical line within brackets indicate a required choice within an optional entry. A vertical bar (the “pipe” symbol) separates entries within brackets or braces. You may select only one from the key list: [first | second | third]
Issue 2.0
Values are required for both the slot and port. They must be separated by a slash. Parameters preceded by an asterisk indicate a wildcard.
ARRIS PROPRIETARY — All Rights Reserved
2-5
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Table 2-2: Conventions for Representing Command Syntax CLI Syntax
Description
Wherever an IP address is required, you can enter a IP addresses and host name provided you have configured a DNS server host names or put the name and address into the DNS Local Host Table. Script files
You can create a script file—a text file containing CLI commands—to simplify repetitive tasks.
Designating MAC addresses and IP addresses Some commands require a Media Access Control (MAC) address or Internet Protocol (IP) address, which must be entered in standard form. The CLI displays MAC addresses in the following formats: 1111.2222.3333
a0b1c2d3e4f5
a0b1.c2d3.e4f5
a0:b1:c2:d3:e4:f5
IPv6 addresses use the standard conventions: Hex digits are case insensitive, leading zeros are optional, a pair of colons indicate successive 0’s have been dropped and only one pair of colons can be used. The following represents the same IPv6 address: 4012:0000:240E:0000:0000:0AC0:3428:121C 4021:0:240E::AC0:3428:121C 4021:0:240e::ac0:3428:121c
Keyboard Shortcuts In the CLI, you can use keyboard sequences to navigate and edit a command line. You can also use keyboard sequences to scroll through a list of recently executed commands. The following table lists the lineediting keys that are available in the CLI.
2-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
These shortcuts are available in a telnet session (LAN connection) only. They are NOT available from a serial connection. Table 2-3: CLI Editing Shortcuts Keystroke(s) Backspace
Deletes one character to left of cursor (back).
Delete
Deletes the current character.
Enter
Executes command.
Tab
Completes command entry.
Space
Completes command entry.
(Right arrow)
! (Left arrow)
(Up arrow)
(Down arrow)
Issue 2.0
Result
Moves the cursor forward one character. Moves the cursor back one characte.r Scrolls backward through all commands in the history buffer starting with the most recent. Repeat keystroke to recall successively older commands. Scrolls forward through all commands in the history buffer after recalling commands with the up arrow key. Repeat keystroke to recall successively more recent commands.
+ B
Moves the cursor back one word.
+ D
Deletes the remainder of the word.
+ F
Moves forward one word.
+ A
Move the cursor to beginning of the command line.
+ B
Move the cursor back one space.
+ C
Aborts current line (aborts a command if running).
+ D
Deletes the character at the cursor.
+ E
Move the cursor to the end of the command line.
+ F
Move the cursor forward one character.
+ K
Deletes all characters from cursor position to the end of the command line.
+ N
Scrolls forward through the list of recently executed commands. (Note: you must first scroll backwards using the + P command before this using this command.)
+ P
Scrolls backward through the list of recently executed commands.
ARRIS PROPRIETARY — All Rights Reserved
2-7
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Table 2-3: CLI Editing Shortcuts (Continued) Keystroke(s)
Result
+ T
Transposes the character to the left of the cursor with the character located at the cursor.
+ U
Deletes all characters on line to left of cursor position.
+ W
Deletes word directly before cursor.
+ Z
Enters command and then returns to root prompt.
CLI Command Features CLI features several built-in enhancements that make it easier to use. These include help, abbreviations, alias commands, filtering, and general features.
CLI Help Feature Command completion and positional help are two features that serve as memory joggers for users who are unable to remember the entire command string or parameter placement. Use of Question Mark (?)
Entering the question mark (?) at the command line prompt will display a list of the available commands. To get specific help on a command mode, command name, keyword, or an argument, use any of the following commands: Table 2-4: Command Help Command
2-8
Result
C4# help
General CLI usage information. Informs the user what “?” does, what means in the help display, show-all commands and the use of “|”.
C4# ?
Lists all commands appropriate to the command mode.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Table 2-4: Command Help Command
Result
C4# abbreviated-commandentry?
Lists commands in the current mode that begin with a particular character string.
C4# abbreviated-commandentry
Completes a partial command name.
C4# abbreviated-commandentry
Completes a partial command name.
C4# command ?
Lists the available command and options.
C4# command option ?
Lists the next available syntax option for the command.
Entering the question mark (?) after entering the complete name of a command or command option, will enable the CLI to list the available commands and options. Entering the question mark (?) in the middle of a command name, enables the CLI to list the possible command completions that match the letters you have entered so far; the letters that you typed are redisplayed. When you find the value you need, type it without losing your place in the argument. Leave a space between the keyword and the question mark. The question mark will not invalidate the command. When using context-sensitive help, the space (or lack of a space) before the question mark (?) is significant. To obtain a list of commands that begin with a particular character sequence, type in those characters followed immediately by the question mark (?). Do not include a space. Interactive Mode help
The use of help and the ? mark in interactive mode are not the same. To list the options available for a specific command, type help at the prompt. To see all the enhanced options, enter a space, question mark (?) followed by the enter key. The behavior differences are shown in the two examples below:
Example 1 C4(config)# interface cable 15/0 Entering cable interface configuration mode for slot 15 MAC port 0 C4(config-cable)# help authorization-module
- Modify authorization module values
cable
- Downstream and upstream parameter configuration
description
- Interface specific description
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-9
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
igmp
- Static join a multicast group on this port
ip
- IP address of Cable Interface
proxy-arp
- Enable proxy ARP for this cable interface
restore
- Restore the CAM interface
restricted-proxy-arp
- Restrict proxy ARP to CPEs behind different CMs
shutdown
- Shutdown both the MAC and Downstream for the interface
spare-group
- Configure a CAM sparing group
subscriber
- Commands for subscriber management
voice-limits
- Set voice data limits
Example 2
While in interactive mode, if you enter a space and then a question mark (?) followed by the enter key, a list of commands along with the available show commands will display as shown below. The additional information that you get by using ? instead of help is shown in blue.
C4(config-cable)# ? authorization-module
- Modify authorization module values
cable
- Downstream and upstream parameter configuration
cls
- Clear the terminal screen
description
- Interface specific description
echo
- Turn on echo/Print text to terminal
end
- Exit all submenus
exit
- Exit intermediate mode
help
- Show command help
history
- Display the command history
igmp
- Static join a multicast group on this port
ip
- IP address of Cable Interface
logout
- Log off this system
proxy-arp
- Enable proxy ARP for this cable interface
quit
- Exit intermediate mode
restore
- Restore the CAM interface
2-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
restricted-proxy-arp
- Restrict proxy ARP to CPEs behind different CMs
show
- Show running system information
shutdown
- Shutdown both the MAC and Downstream for the interface
spare-group
- Configure a CAM sparing group
subscriber
- Commands for subscriber management
voice-limits
- Set voice data limits
Use of the Carriage Return
The (carriage return symbol) at the end of a command help output indicates that you have the option to press Enter to complete the command and that the arguments and keywords in the list preceding the symbol are optional. If there is a mandatory parameter that needs to be entered, no will appear.
Error Indicator
The CLI provides error isolation in the form of an error indicator, a caret symbol (^). The ^ symbol appears at the point in the command string where the user has entered incorrect or unrecognized command syntax. For example, the ^ symbol in the following output shows the point at which the error occurred in the command (e.g. clock is misspelled): C4# configure clokc ^ Error: Invalid parameter
Command Completion
Command completion for command names and options is available at each level of the hierarchy. There are several options you can use to complete commands. You can abbreviate commands or keywords: enter only as many characters of the keyword as needed to keep it unambiguous. For example, you can abbreviate the configure command to config. After entering the command at the system prompt, press to execute the command. If you enter a unique set of characters and press the key or , the system will complete the command name. If you enter a set of characters that could indicate more than one command, the system will respond with the list of possible matches as shown in the following example: C4# configure cable mod modem modulation-profile
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-11
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Command completion will then work if you type either an “e” for “modem” or “u” for “modulation-profile” and press the key or . The system will complete the command name. After the command is complete at the system prompt, press to execute the command.
Configuring Passwords and Privileges A simple way of providing terminal access control in your network is by using passwords and assigning privilege levels. By default, the CMTS CLI has two levels of access to commands: User EXEC mode (level 1) and Privileged EXEC Mode (level 15). However, you can configure additional levels of access to commands, called privilege levels, to meet the needs of your users while protecting the system from unauthorized access. Up to 15 privilege levels can be configured, from level 1 to 15. Users who log on with level 15 have access to all commands. Users with privilege level 1 have access only to most show commands. The configure enable command defaults to privilege 15. If a given command is set to privilege level 7, for example, then all users having privilege levels 1 through 7 must supply the correct level 7 password before the CMTS will accept the command. By configuring the privilege level, you can limit access to each privilege level by enabling separate passwords. For example, you may want a certain set of users to be able to configure only certain interfaces, but not allow them access to other configuration options. You would create a separate privilege level for those specific interface configuration commands and distribute the password for that level to those users. Or, if you had a group of trainees, you could assign passwords to certain privilege levels, and give them these passwords only when they had completed their training. To create a new privilege level, password, and associate commands with that privilege level, use the following example beginning in global configuration mode: 1 Enter enable mode: C4# enable 2 Create the password and set the privilege level required to use the password in order to access privileged commands: C4# configure enable password privilege
2-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Where password is a string up to 16 characters long and privilege is a number 1-15. If you select level 7, for example, then levels 1-7 are all required to use the password to access privileged commands. Example
To restrict access to the show ip interface command, for example, you need to set a password for the desired privilege level and assign that level to the command. In the example that follows, the password Password7 is given to privilege level 7; privilege level 7 is assigned to the show ip interface command. C4# configure enable password Password7 privilege 7 C4# configure privilege exec level 7 show ip interface To confirm the previous command: C4# show privilege exec show ip interface To enter privilege level 7, enter the following command. The CMTS will prompt you for a password: C4# enable 7 Password: Current privilege level for 'show ip route' is 4 Use show users to display the privilege level of defined users. 3 To set the authentication method to the local list of users and passwords: C4# configure authentication testlist1 local Where testlist1 is an example of a name for this method list 4 Configure the telnet and console access to use the authentication method above for enable access: C4# configure line vty 0 6 authentication testlist1 enableauthentication 5 (Example) Set the privilege level to 8 for all configure commands: C4# configure privilege exec level 8 configure 6 (Example) Set the privilege level to 9 for all configure interface cable commands: C4# configure privilege exec level 9 configure interface cable 7 To confirm your changes: C4# show line detail
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-13
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Displaying Current Privilege Levels
To display the current privilege level you can access based on the password you used, use the following command in User EXEC Mode:
C4> show privilege The system will respond with your current privilege level. Logging In at a Specific Privilege Level
To log into the CMTS at a specific privilege level, use the following command: C4> enable X Where X is number of the privilege level, e.g. 1-15 To exit a specified privilege level, use the following command: C4> disable X Where X is number of the privilege level, e.g. 1-15
Changing Logging Notification Priority Levels
Whenever a command is executed, the default notification priority assigned to that command access level is used to generate a log indicating the execution of that CLI command. Following is a table of the default logging levels for CLI access: Table 2-5: Default Logging Level CLI Access Level
Notification Priority
1-4
7 (Informational)
5 - 15
6 (notice)
You can now indicate at what logging priority you want CLI command execution notifications to be generated. The show logging command displays the CLI access level (same as privilege) and the priority that it comes out as. For example, if you want all config commands (normally privilege level 15) to print at critical level and all show commands (privilege level 1) to print at error level, execute the following commands: configure logging priority cli 15 3 configure logging priority cli 1 4 Creating and Using Command Aliases
2-14
Use the alias command to define shorter simpler versions of commands. Command aliases can save time and can prevent typing errors when you are configuring or monitoring the CMTS.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Aliases do not persist from one CLI command session to another. You must create a text file in which each alias command appears on a separate line. Save the file with a descriptive name, for example, aliaslist.txt. Use FTP or for greater security use secure FTP (SFTP) to place the alias file to the alias directory: /system/alias/(filename). If necessary, use the following command to enable SFTP: configure ip ssh sftp If the list of alias commands is present in the alias directory and the user has logged in using a defined user profile, then the CMTS automatically executes the alias file. All of the aliases defined in this file are then available. Aliases defined in interactive CLI sessions are not exported to scripts. This means that the script writer must first use the alias command in the script itself to define his/her command aliases before using these aliases in the script. This must be done in every script where the writer intends to use command aliases. These alias definitions are not exported to other scripts or CLI sessions. You can create aliases utilizing the “pipe” character (|) but the CLI command must be in quotes, e.g.: Correct syntax: alias boot “show version detail | include boot” Incorrect syntax: alias boot show version detail | include boot
NO Command
The [no] form of a command is usually used to negate a specific function. Using the [no] form of a command will override all other commands associated with that slot/port, regardless of the parser and regardless of whether or not the parameters were matched. A slot/port with one parameter supports the [no] form automatically. If a slot/port has two or more parameters, you must specify which, if any, is the [no] form.
Pagination
The show and more commands generally display large amounts of data. If you have configured pagination, and output continues beyond what can display on your screen, a --More-- prompt will appear. By pressing any key on your keyboard, the system will display the next screen of output. If you wish to view the output on a line-per-line basis, simply hit the when the --More-- prompt appears. You may at any time hit Q to quit. If pagination has not been configured, you can press to interrupt the show command output.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-15
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
To turn pagination on, you must be in Privileged EXEC mode and type the following command: C4# configure pagination NOTE Pagination is a per-user command. So, when a new user logs in, he/she will not have pagination turned on; thus, it will never appear in the running-config.
2-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
CLI Filtering The CLI filtering feature allows you to search or filter any show or more commands that display system and protocol information. This functionality is useful when you need to sort through large amounts of command output so that you can display only those lines you are interested in. NOTE The filtering function is not available for the command show techsupport. Basic Searching
A regular expression is a phrase, number, or pattern that the CLI filtering feature matches against the show or more command output. For example, to conduct a search on a regular expression of “ power ” (with a space both before and after it) then only lines containing “ power ” will be included in the output. NOTE Normally, regular expressions are case sensitive. The use of regular expressions for the CMTS are case insensitive to make typical searching easier.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-17
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
How to Use CLI Filtering The CLI permits the following types of filtering: •
Begin - displays output beginning with the first line that contains the text string or regular expression
•
Include - displays output lines that contain the text string or regular expression and excludes lines that do not contain the text string or regular expression
•
Exclude - displays output lines that do not contain the text string or regular expression and excludes lines that do contain the text string or regular expression
•
Until - displays all lines up to and including the first line that matches the given regular expression
•
Count - Counts the number of lines that would have been shown C4# show running-config | count Piped line count: 1557 C4# show running-config | count include cable-mac Piped line count: 60
•
Page - Temporarily turns on paging, in case you have paging turned off but need it for a particular command.
The following CLI options have been added to the show and more commands: [|{begin|include|exclude|until |count |page} [“] regular expression [“]] To use this functionality, enter a show or more command as normal but add a space followed by the “pipe” character (|) at the end of the command line. Then add one of the keywords begin, include, exclude, until, count, or page, along with the regular expression that you want to filter or search on. Expanded Syntax — show | begin show | include show | exclude show | until show | count show | page more | begin more | include more | exclude
2-18
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
more | count more | page Creating Regular Expressions
Regular expressions can be a single-character pattern that matches the same character in the input string, or multiple characters that match the same multiple characters in the input string.
Special Characters
You can use keyboard characters (such as ! or ~) as single-character patterns, but certain keyboard characters have special meaning when used in regular expressions. The keyboard characters that have special meaning in the CMTS are listed in the Table 2-6:
Table 2-6: Characters with Special Meaning in Search Patterns Character
Special Meaning
.
The dot matches any single character, including white space
*
The asterisk matches any number (or none) of the single character that immediately precedes it. The preceding character can also be a regular expression. E.g., since the . (dot) means any character, then .* means “match any number of any character.”
+
The plus matches 1 or more sequences of the preceding regular expression
^
The caret matches the following regular expression at the beginning of the line.
$
The dollar sign matches the end of the line.
\
The backslash allows for literal meaning of the special characters.
[]
The brackets allow for the definitions of a set of characters to be matched. The brackets also mean the contents will be taken as a single character. (e.g. [aeiou] = any vowel)
[^ ]
Search for anything in the brackets that does not include the set of characters following the caret. (e.g. [^aeiou] = any consonant)
()
The parentheses allow for grouping and recall.
\b
Indicates the beginning/end of a word.
To remove the special meaning of any of the special characters listed in Table 2-6, put a backslash (\) in front of it. For example, when the expression m5\. is used in the command syntax, only the string m5. will be matched.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-19
2 CLI Overview
Range
C4/C4c CMTS Rel. 8.0.7
A range is a sequence of characters enclosed in brackets [ ]. It normally matches any single character from the sequence. When the sequence begins with a caret (^), it matches any single character not from the rest of the sequence. When two characters in the sequence are separated by a hyphen (-), this is shorthand for the full list of ASCII characters between them. For example, [0-9] matches any decimal digit. To include a literal bracket “]” in the sequence, make it the first character, following a possible caret. To include a literal hyphen (-), make it the first or last character. A backslash “\” followed by a single character, includes that character, however, backslashes are not necessary for most special characters, as inside a range, only the “]”, “-”, and “\” characters are treated specially. The bracket [ ] characters allow for the definitions of a set of characters to be matched. The brackets also mean the contents will be taken as a single character. For example, the following expression matches with a, e, i, o, u: [aeiou] Use the hyphen (-) character inside the square brackets to mean all the characters from the character preceding the hyphen to the character following it. For example, [0-9] is the same as [0123456789]. Also, [af] is the same as [abcdef]. The following matches a hexidecimal digit: [09a-f]. NOTE When using the hyphen (-), do not mix types. Examples of bad ranges include: [7-k], [&-%], [D-e]. The [D-e] is equivalent to [D-Za-e] which is equivalent to [a-z] because the CLI is case insensitive.
Multiple-Character Patterns
Regular expressions can also specify patterns containing multiple characters. You create multiple-character expressions by joining letters, digits, or keyboard characters that do not have special meaning. Order is important in multiple-character patterns. The expression m5& matches the character m followed by a 5 followed by a & sign. If the string does not have m5&, in that order, the pattern matching fails. The multiple-character expression a. uses the special meaning of the period character to match the letter a followed by any single character. With this example, the strings ab, a!, or a2 are all valid matches for the expression.
Wildcard Searches
To emulate a wildcard search, the expression must match any character. For this, regular expressions use the period (.) character. For example, the following regular expression matches ARRIS followed by any single character: ARRIS.
2-20
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
The asterisk (*) in the wildcard search can match with no characters or any number of characters. For example, the following regular expression does exactly the same as the wildcard pattern above: ARRIS.* When you use an asterisk (*), it means none, one, or more of the previous character in the pattern. In the example, the asterisk is preceded with a period, which means none, one, or more of any character. Multipliers
You can create more complex regular expressions that instruct the software to match multiple occurrences of a specified expression. Table 2-7 lists special characters that specify “multiples” of an expression. Table 2-7: Special Characters Used as Multipliers Character
Special Meaning
*
The asterisk matches any number (or none) of the single character that immediately precedes it. The preceding character can also be a regular expression. E.g., since . (dot) means any character, then .* means “match any number of any character.”
+
The plus matches 1 or more sequences of the preceding regular expression
Examples: To match any number of occurrences of the letter m, including none: m* To require that at least one letter m be in the string to be matched: m+ By enclosing the pattern in parentheses you can use multipliers with multiple-character patterns. The parentheses () characters are used to see this pattern as one character. In the following example, the pattern matches any number of the multiple-character string mn: (mn)* Some useful example patterns that might be helpful: Any IP address = [0-9]+\.[0-9]+\.[0-9]+\.[0-9]+ Any MAC address = [0-9a-f][0-9a-f][0-9a-f][0-9a-f]\.[0-9a-f] [0-9a-f][0-9a-f][0-9a-f]\.[0-9a-f][0-9a-f][0-9a-f][0-9a-f] Alternation
Issue 2.0
Alternation allows you to specify alternative patterns to match against a string. You separate the alternative patterns with a vertical bar (|). Either one of the alternatives can match the string.
ARRIS PROPRIETARY — All Rights Reserved
2-21
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
The expression “interface.*19” returns 4 results, the expression “include slot.*17” returns 2 results, and “include slot.*17 | interface.*19” returns the combination, as shown in the following examples: C4# show running-config | include interface.*19 configure interface ethernet 19/0 ip address 10.1.50.100 255.255.255.0 configure interface system-controller 19/0 no shutdown configure interface system-controller 19/1 no shutdown configure interface system-controller 19 no shutdown C4# show running-config | include slot.*17 configure slot 17 type RCM name "RCM A" configure snmp-server card-trap-inh slot 17 40 C4# show running-config | include slot.*17|interface.*19 configure interface ethernet 19/0 ip address 10.1.50.100 255.255.255.0 configure slot 17 type RCM name "RCM A" configure snmp-server card-trap-inh slot 17 40 configure interface system-controller 19/0 no shutdown configure interface system-controller 19/1 no shutdown configure interface system-controller 19 no shutdown Anchoring
You can match an expression pattern against the beginning or the ending of a string. By specifying that the beginning or ending of an input string contains a specific pattern, you “anchor” these expressions to a portion of the string using the special character shown in the following table. Table 2-8: Special Anchoring Character Character ^
Description The caret matches the beginning of the string
This is another use for the ^ symbol. In this example, the following regular expression matches an input string only if the string starts with 1234:
2-22
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
^1234 The next example shows that the following regular expression is a range that matches any single number, as long as it is not the numbers 1, 2, 3, or 4: [^1234] Parentheses for Recall
You can use parentheses () with multiple-character regular expressions to multiply the occurrence of a pattern. You can also use parentheses around a single or multiple-character pattern to instruct the software to remember a pattern for use elsewhere in the regular expression. To create a regular expression that recalls a previous pattern, you use parentheses to instruct memory of a specific pattern and a backslash (\) followed by an integer to reuse the remembered pattern. The integer specifies the occurrence of a parentheses in the regular expression pattern. If you have more that one remembered pattern in your regular expression, then \1 uses the first remembered pattern and \2 uses the second remembered pattern, up to nine. The following regular expression uses parentheses for recall: a(.)bc(.)\1\2 This regular expression matches the letter a followed by any character (call it character #1) followed by bc, followed by any character (character #2), followed by character #1 again, followed by character #2 again. In this way, the regular expression could match azbctzt. The software identified character #1 as z and character #2 as t and then uses z and t again later in the regular expression. As you will notice, the parentheses do not change the pattern; they only instruct the software to recall that part of the matched string. Following is an example of advanced regular expression using double parentheses: ((19.*) (slot|interface))
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-23
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
Show Cable Modem Column Feature With each release, the show cable modem command must support additional information because the list of features is expanding. Unfortunately, this command is already extremely wide and prompted us to develop a feature that would allow the user to specify exactly which columns they wish to see and which ones they don’t. This feature will allow the user to create their own output, thus maximizing their screen space and run-time. This is useful for not only interactive use but also for scripts. The show cable modem command, for instance, displays receive power and timing offset for each modem — both of which require a relatively slow access to the CAM for every modem. By eliminating the receive power and timing offset from the output, this command runs up to three times faster. Command Parameters
bonded bonded-actual bpi cable-mac cfgfile cfgfile-long cm-cpe-ip cm-down-pwr cm-down-snr cm-ip cm-mac cm-microreflec cm-sysdesc cm-time-polled cm-timing cm-type cm-up-pwr congest-down congest-up cpe-count cpe-ip cpe-mac cpe-type crc docsis-mac docsis-prov fec-corrected
2-24
Shown below are the parameters available for constructing a specific output using the show cable modem column command on the CMTS. This command will allow the user to create their own display format with up to 32 columns to display. -
Number of bonded DS and US Number actual bonded DS and US None, bpi, or bpi+ The provisioned cable-mac CM configuration filename CM configuration filename CM/CPE IP address Downstream power measured at the CM (polling) Downstream SNR measured at the CM (polling) CM IP address CM MAC address Microreflections measured at the CM (polling) System description of the CM (polling) Last time CM was polled for information Timing offset measured at the CM (polling) The type of modem that has been detected. Upstream power transmitted from the CM (polling) Congestion dropped downstream bytes Congestion dropped upstream bytes Number of currently detected CPEs IP Address of the CPE MAC Address of the CPE CPE Type CRC errors Maximum DOCSIS capability of the CM Provisioned DOCSIS capability of the CM Corrected FEC codewords
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
fec-percent-uncorrected fec-uncorrected fec-unerrored filter-cm flap-last-flap flap-prev-state flaps-prov flaps-ranging flaps-reg fpccm-online fpcm-cpe
-
fpcm-id fpcm-qos
-
hcs interface interface-docsis20 l2vpn-id l2vpn-qtag load-bal-grp microreflec policed-down power-adj qos rec-pwr response-percent service-type-curr
-
service-type-prov
-
sid snr state state-docsis20 timing uptime vendor
-
Percent Uncorrected FEC codewords Uncorrected FEC codewords Unerrored FEC codewords Filter group CM UP and DOWN for each modem Previous state before modem flapped Previous state before modem flapped CM flaps after ranging, but prior to registering CM flaps during ranging CM flaps after registering Number of online CCMs for this FlexPath CM Number of currently detected CPEs for all online CCMs in this FlexPath CM FlexPath device ID Sum of all QoS values for all online CCMs in this FlexPath CM HCS errors Cable interface Cable interface L2VPN ID name Outer VLAN Id Load Balance Group Microreflections measured at the CMTS Policing dropped downstream bytes Number of power adj greater than threshold value Aggregrate Tmax and Tmin of all flows Upstream received power measured at the CMTS Ranging requests received divided by opportunities Current Service Type Id TLV the CM signaled to the CMTS during registration Provisioned Service Type ID TLV the CM signaled to the CMTS during registration Primary SID Upstream SNR signal-to-noise ratio measured at the CMTS CM state CM state Timing offset Latest uptime, even for offline modems CM vendor name- Number of currently detected CPEs for all online CCMs in this FlexPath CM The columns feature cannot be used with other show cable modem parameters. As such, the user cannot simultaneously specify which columns they wish to see along with filtering or sorting commands. Due to a software
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2-25
2 CLI Overview
C4/C4c CMTS Rel. 8.0.7
limitation, the CLI cannot currently support the following syntax without circumventing the existing infrastructure: C4# show cable modem column . . slot 4 To reach this goal, additional syntax has been designed to give the desired flexibility: C4# configure cable modem format .. C4# show cable modem format slot 4 So, using a format name as a handle or shorthand for column output was seen as the best way to accomplish the goal of allowing the user full control over the filtering, sorting, and output functions of show cable modem. You can define formats and then create an alias for show cable modem format which would allow the user to pass parameters using the alias. Help Enhancements
Due to the large number of columns that the CMTS supports, it was thought that a listing of the available parameters would be more helpful than a full description. This command is modeled after the show cable modem vendor ? command help output which just displays a list of vendors. The show cable modem column ? command will list only the available parameters and the output would look similar to the output below: C4# show cable modem column ?
multiple-uchan
- Display multiple rows for primary and non-primary US channels per CM
---------- OR Enter one or more of the following columns -------------- A * in front of the column indicates that it will display multiple rows for CPEs ---bonded bonded-actual bpi cable-mac cfgfile cfgfile-long *cm-cpe-ip cm-down-pwr cm-down-snr cm-ip cm-mac cm-microreflec cm-sysdesc cm-time-polled cm-timing cm-type
2-26
cm-up-pwr congest-down congest-up cpe-count *cpe-ip *cpe-mac *cpe-type crc docsis-mac docsis-prov fec-corrected fec-percent-uncorrected fec-uncorrected fec-unerrored filter-cm
flap-last-flap flap-prev-state flaps-prov flaps-ranging flaps-reg fpccm-online fpcm-cpe fpcm-id fpcm-qos hcs interface interface-docsis20 l2vpn-id l2vpn-qtag load-bal-grp
ARRIS PROPRIETARY — All Rights Reserved
microreflec policed-down power-adj qos rec-pwr response-percent service-type-curr service-type-prov sid snr state state-docsis20 timing uptime vendor
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
CLI
Command Descriptions
This chapter provides detailed descriptions of each of the CMTS CLI commands. The CLI commands are organized alphabetically and apply to both the C4 CMTS and the C4c CMTS unless specified. When you log in to the CLI, you are in User EXEC mode. User EXEC — User EXEC commands are used for everyday system monitoring. They allow you to change terminal settings on a temporary basis, perform basic tests and show system information. The prompt C4> indicates User EXEC mode and the default access level is 1. The User Show commands are part of the User EXEC mode. The prompt will be C4> as in the User EXEC mode. The User Show commands display system information. The default access level of User Show commands is 1. Privileged EXEC — The Privileged EXEC mode commands are used to set operating parameters. If a Privileged EXEC password exists, the CLI prompts you to enter it to gain access. The password does not appear on the screen. Privileged EXEC mode includes the User EXEC commands. To enter Privileged EXEC mode, enter the enable command at the C4> prompt. The prompt changes to C4#. If no enable password is configured, any user may enter Privileged EXEC mode without authentication. The default access level of Privileged EXEC mode commands is 15. Global Configuration — Global Configuration commands apply to features that affect the entire system. These commands apply to system features and enable routing functions. Enter configure at the command prompt in Privileged EXEC mode to enter the Global Configure mode. The prompt will change to C4#. To return to Privileged EXEC mode, enter quit, exit or press Ctrl+Z. NOTE In the command headings the asterisk (*) represents one or more variables that have been omitted to save space and to make the heading more readable. All the pertinent variables are found in the command syntax line.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
alias Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
The alias command is used to create abbreviated versions of CLI commands. If the command is entered without any parameters, it simply displays a list of all existing aliases. To remove a specific alias, use the [no] option. There is a size limitation associated with the alias buffer. The alias limit may be reached in two ways; via the alias count, currently 256, or via the alias buffer size which is 8192 characters in length. The alias buffer size consists of all the alias names and their associated commands concatenated together. For example, you could reach the alias limit with just 81 aliases if each alias name/command has a length of 100 characters. NOTE The aliases you create do not persist in memory after the user session is closed. Aliases can be saved to a file and that file can be called in from a user’s profile. In this manner, a user can have a particular set of aliases that become available each time he or she logs in. Alternatively, the user can save to a file and manually load this file of aliases upon logging in.
Syntax
alias [ ] [no]
Parameter
Definition
[
The abbreviation or replacement name to be used as an alias for a CLI command.
]
The CLI command that the CMTS will execute when the alias is entered from the command line.
Example
The following example creates the alias slc, which can be entered in place of show linecard status. C4>
alias slc show linecard status
Related Command(s)
unalias
CLI-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
archive Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Places a file for storage on a backup server. Normally, you archive backup files or files that are important but not often used. It can refer to an old copy of current data. That copy could be one minute old or several years old. Such files can be copied to and from the backup server using the archive create/restore option.
Syntax
archive {create | restore [force]}
Parameter
create
Definition
Creates an archive with specified name
restore Restores the specified archive file. [force]
Issue 2.0
If the file exists, the option [force] will then erase it and restore the specified file from archive.
ARRIS PROPRIETARY — All Rights Reserved
CLI-3
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
cd Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
The cd command switches from the current directory to the specified directory.
Syntax
cd
Parameter
Definition
Example
The following example switches from the current directory to a directory named config_files. C4>
CLI-4
The name of the directory to which you want to go.
cd config_files
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
chkdisk Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
This command unmounts the volumes and check them for errors. If errors are found, it will correct them and re-mount the volumes.
Syntax
chkdisk [detail]
Parameter
[detail]
Definition
Displays detailed information
NOTE The chkdisk and scandisk commands always run on the System Control Module (SCM) that you are logged in to. On a duplex system it is recommended that you run these commands on the standby side in order not to affect the active SCM. To run the chkdisk or scandisk command on the standby SCM, you must use telnet to log in to the standby SCM. First telnet to the standby SCM. Be sure to add the colon “:” at the end: telnet clone: The system prompts you to log in. After a successful login the command prompt changes to indicate that you are logged into the standby controller: C4# chkdisk
NOTE The C4c CMTS is simplex only.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-5
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
clear access-list counters Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
This command clears the count indicating the number of times matched for a particular entry of the specified access list. If the optional ACL number or name is omitted, all existing access lists will be cleared.
Syntax
clear access-list counters [number | name]
CLI-6
Parameter
Definition
[number | name]
Number or name of ACL. Valid format for standard is 1--99, extended is 100199.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
clear arp-cache Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Deletes the entry from the Address Resolution Protocol (ARP) table if the IP address is specified. If the IP address is not specified, all dynamic entries from the ARP cache table will be deleted.
Syntax
clear arp-cache []
Parameter
Definition
[]
This may be any Internet address. The IP address should be in dotted decimal (nnn.nnn.nnn.nnn) format
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-7
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
clear cable filter counters Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Clears the cable IP filter match counters.
Syntax
clear cable filter counters
CLI-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
clear cable filter group * counters Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Clears the cable IP filter match counters for a specified group.
Syntax
clear cable filter group counters
Parameter
Issue 2.0
Definition
The IP filter group number.
ARRIS PROPRIETARY — All Rights Reserved
CLI-9
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
clear cable filter group * index * counters Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Clears a single cable IP filter match counter for a specified group.
Syntax
clear cable filter group index counters
Parameter
CLI-10
Definition
The IP filter group number. IP filter index within the group.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
clear cable flap-list Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Clears the flap-list. The “all” option is used to clear all flap list counts. Note that only the counts are cleared, the times and pre-flap states are not cleared.
Syntax
clear cable flap-list [] [all] [cabledownstream ] [cable-mac ] ] [ipv6 addr]}
Parameter
Definition
Optional IPv6 address of neighbor to clear.
cable /
The slot/port of the cable interface.
cable-mac ] tengigabitethernet /[.0.254>]
CLI-68
The RCM slot/gigabit port and optional subinterface number. The RCM slot/tenGigabit port and optional subinterface number.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
clear ipv6 route pd Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Clears the specified IPv6 route data.
Syntax
clear ipv6 route pd | all | cable-mac
Parameter
all cable-mac ] [fragments] [no]
Parameter
Definition
The numeric identifier of the access list This is a number from 100-199.
permit: Permits access if the condition is matched. deny: Denies access if the condition is matched.
An IP protocol number. Valid range is 0-255.
This can be the {host | any | [mask]}
This can be the {host | any | [mask]}
[dscp ] [precedence ]
Match packets with given DSCP value Match packets with given precedence value
[tos ]
Match packets with given TOS value
[fragments]
Check non-initial fragment
Related Command(s)
show access-list
CLI-92
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure access-list * remark Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Associates a comment with an existing ACL. To clear or remove the specified comment, use the [no] option. NOTE The remark text must be in quotes unless it is a single word.
Syntax
configure access-list remark [“text of remark”] [no]
Parameter
Definition
The access-list-number. This is a number from 1-99; the extended access-listnumber is 100-199
[“text of remark”]
Issue 2.0
Comment that describes the access list entry. The remark text should be in quotes. Valid range is up to 100 characters.
ARRIS PROPRIETARY — All Rights Reserved
CLI-93
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure access-list resequence Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resequences the access list index numbers.
Syntax
configure access-list resequence
CLI-94
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure access-list * tcp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures an extended Access Control List (ACL) on the CMTS if the protocol value is TCP. To remove an extended ACL, use the [no] option.
Syntax
configure access-list tcp [src-oper] [dst-oper] [dscp ] [precedence ] [tos ] [established] [no]
Parameter
Definition
The numeric identifier of the extended access list. This is a number from 100199.
Access list index number.
permit: Permits access if the condition is matched. deny: Denies access if the condition is matched.
tcp
If the protocol value is TCP, the CMTS supports the additional optional parameter string [operator [port]] after both the source and sourcewildcard options, and the additional optional parameter [established]. This function compares source or destination ports. Possible source operators can be: lt (less than) gt (greater than), eq (equal), neq (not equal), range (inclusive range). If the operator is positioned after the source and source-wildcard, it must match the source port. If the operator is positioned after the destination and destination-wildcard, it must match the destination port. The range operator requires two port numbers; all other operators require one port number.
Issue 2.0
This can be the {host | any | [mask]}
This can be the {host | any | [mask]}
ARRIS PROPRIETARY — All Rights Reserved
CLI-95
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
eq — Match only packets on a given port number gt — Match only packets with a greater port number [src-oper]
lt — Match only packets with a lower port number neq — Match only packets not on a given port number range — Match only packets in the range of port numbers eq — Match only packets on a given port number gt — Match only packets with a greater port number
[dst-oper]
lt — Match only packets with a lower port number neq — Match only packets not on a given port number range — Match only packets in the range of port numbers
[dscp ] [precedence ] [tos ] [established] | tcpflags ]
Match packets with given DSCP value Match packets with given precedence value Match packets with given TOS value Match established connections or TCP flag settings for: urg, ack, psh, rst, syn & fin
Related Command(s)
show access-list
CLI-96
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure access-list * udp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures an extended Access Control List (ACL) on the CMTS if the protocol value is UDP. To remove an extended ACL, use the [no] option.
Syntax
configure access-list udp [src-oper] [dst-oper] [dscp ] [precedence ] [tos ] [fragments] [no]
Parameter
udp
Definition
The numeric identifier of the access list This is a number from 100-199. permit: Permits access if the condition is matched. deny: Denies access if the condition is matched. If the protocol value is UDP, the CMTS supports the additional optional parameter string [operator [port]] after both the source and source-wildcard options. This function compares source or destination ports. Possible source operators can be: lt (less than) gt (greater than), eq (equal), neq (not equal), range (inclusive range). If the operator is positioned after the source and source-wildcard, it must match the source port. If the operator is positioned after the destination and destination-wildcard, it must match the destination port. The range operator requires two port numbers. All other operators require one port number.
This can be the {host | any | [mask]}
This can be the {host | any | [mask]}
[src-oper]
eq — Match only packets on a given port number gt — Match only packets with a greater port number lt — Match only packets with a lower port number neq — Match only packets not on a given port number range — Match only packets in the range of port numbers
[dst-oper]
eq — Match only packets on a given port number gt — Match only packets with a greater port number lt — Match only packets with a lower port number neq — Match only packets not on a given port number range — Match only packets in the range of port numbers
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-97
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
Match packets with given precedence value. Following are valid values:
[precedence ]
[dscp ]
Precedence value routine Match packets with routine precedence (0) priority Match packets with priority precedence (1) immediate Match packets with immediate precedence (2 flash Match packets with flash precedence (3) flash-override Match packets with flash override precedence (4) critical Match packets with critical precedence (5) internet Match packets with internetwork control precedence (6) network Match packets with network control precedence (7) Match packets with given DSCP value. Valid values are: Differentiated services codepoint values af11 Match packets with AF11 dscp (001010) af12 Match packets with AF12 dscp (001100) af13 Match packets with AF13 dscp (001110) af21 Match packets with AF21 dscp (010010) af22 Match packets with AF22 dscp (010100) af23 Match packets with AF23 dscp (010110) af31 Match packets with AF31 dscp (011010) af32 Match packets with AF32 dscp (011100) af33 Match packets with AF33 dscp (011110) af41 Match packets with AF41 dscp (100010) af42 Match packets with AF42 dscp (100100) af43 Match packets with AF43 dscp (100110) cs1 Match packets with CS1(precedence 1) dscp cs2 Match packets with CS2(precedence 2) dscp cs3 Match packets with CS3(precedence 3) dscp cs4 Match packets with CS4(precedence 4) dscp cs5 Match packets with CS5(precedence 5) dscp cs6 Match packets with CS6(precedence 6) dscp cs7 Match packets with CS7(precedence 7) dscp default Match packets with default dscp (000000) ef Match packets with EF dscp (101110)
(001000) (010000) (011000) (100000) (101000) (110000) (111000)
Match packets with given TOS value. Following are valid values:
[tos ]
[fragments]
normal min-monetary-cost max-reliability max-throughput min-delay
Type of service value Match packets with normal TOS (0 Match packets with min monetary cost TOS (1) Match packets with max reliable TOS (2) Match packets with max throughput TOS (4) Match packets with min delay TOS (8)
Check non-initial fragment
Related Command(s)
show access-list
CLI-98
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure accounting Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the accounting method lists. To remove or disable the accounting method lists, use the [no] option.
Syntax
configure accounting [no]
Parameter
Definition
Name of the method list. Accounting method. Choose from: none local tacacs
Example
To configure an accounting methods list called acct_example, use the following command: C4#
configure accounting acct_example local The following is an example of the output returned by the system: Name List Of Methods ------------------- ----------------------acct_example Local
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-99
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure aging Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the aging intervals for the ARP cache.To reset to the default, use the [no] option.
Syntax
configure aging [idle-mac ] [stale-mac ] [no]
Parameter
Definition
[idle-mac ]
[stale-mac ]
Example
Default idle-mac = 1800 seconds The length of time (in seconds) that inactive MAC addresses are maintained in the CMTS’s internal database. Valid range is 11-1000000 seconds. Default stage-mac = 604800 seconds.
The following example sets ARP aging to: C4#
CLI-100
The idle MAC aging time in seconds. Valid range is 10-1000000 seconds.
configure aging stale-mac 604800
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure arp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies the static mapping between IP and MAC addresses. To remove the static mapping between the IP and MAC address, use the [no] option. configure arp [password ]
Definition
SNMP User ID SNMP Authentication Password Subscriber’s MAC address. Valid forms for a MAC address are:
xx.xx.xx.xx.xx.xx xxxx.xxxx.xxxx xxxxxxxxxxxx
[tos ]
Issue 2.0
IP address of the mediation device UDP port. Valid range is 1-65335 The tos keyword is optional and may be used to override the default TOS byte of 0x22 for the UDP/IP encapsulation. Expiration date for the LI tap session. The hh:mm time value of the until keyword is optional and defaults to 23:59.
ARRIS PROPRIETARY — All Rights Reserved
CLI-177
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable LO1-leak-detect Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the LO1 leak detection on the Digital Multimeter (DMM). To disable the LO1 leak detection, use the [no] option.
Syntax
configure cable LO1-leak-detect [no]
CLI-178
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance across-macdomain-check Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the cross MAC-domain dynamic load balancing check interval for load balancing groups consisting of channels from all CAMs for Release 7.4 and later. To turn the checking interval off, use the [no] option or set the value to 0 (zero).
Syntax
configure cable load balance across-macdomain-check [no]
Parameter
Issue 2.0
Definition
Sets the inter-MAC-domain load balancing checking interval. Value is in seconds. A value of zero turns off the checking interval.
ARRIS PROPRIETARY — All Rights Reserved
CLI-179
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance downstream-start-threshold Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the percent of load difference between channels before load balancing is invoked. To return to the default, use the [no] option.
Syntax
configure cable load balance downstream-start-threshold [no]
.
CLI-180
Parameter
Definition
Percent utilization on a downstream channel required before load balancing is invoked.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance enable Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables dynamic load balancing for the CMTS. To disable dynamic load balancing for the CMTS, use the [no] option.
Syntax
configure cable load balance enable [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-181
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance exclude oui Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Excludes devices that match the specified Organization Unique Identifier (OUI) prefix (which is the most significant 3 bytes of a MAC address) or vendor name from being load balanced. To include devices that match the specified OUI for load balancing, use the [no] option. Following is a list of possible vendor names:
3Com
Ambit
Arris
Askey
ASUSTek
BAS
BestData
Broadcom
Conexant
Coresma
Cadant
Castlenet
Cisco
Com21
COSHIP
D-Link
Daehanet
DAKOS
Electroline
Elsa
Ericsson
GADline
GeniusNet
Hanaro
Humax
iCable_System
Infinite
Intel
Joohong
Leichu
LG
Linksys
Maspro
Matsushita
Mercury
Motorola
NEC
Netgear
Nortel
Opentech
Pace
Pacific
Panasonic
Philips
Pioneer
Ponico
PowerCom
QNS
RCA/Thomson
RiverDelta
SA
Saejin
Samsung
SMC
Sunrise
Syswave
Technotrend
Teledex
Telexy
Tellabs
Telogy
Terayon
TI
Tollgrade
Toshiba
TriGem
TurboComm
USRobotics
Woojyun
Zoom
ZyXel
Syntax
configure cable load-balance exclude oui [no]
Parameter
CLI-182
Definition
Specified OUI prefix (most significant 3 bytes of a MAC address) or vendor name
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance failed-list exclude-count Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the number of failures that will cause a cable modem to be excluded from load balancing. To reset the default, use the [no] option.
Syntax
configure cable load-balance failed-list exclude-count [no] Parameter
Issue 2.0
Definition
Excluded count.
ARRIS PROPRIETARY — All Rights Reserved
CLI-183
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance failed-list timeout Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the timeout in hours to remove all cable modems on the failed list. To reset the default, use the [no] option.
Syntax
configure cable load-balance failed-list timeout [no] Parameter
CLI-184
Definition
Age out (in hours).
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance general-group-defaults enable Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables or [disables] dynamic load balancing for general groups. To disable, use the [no] option.
Syntax
configure cable load balance general-group-defaults enable [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-185
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance general-group-defaults init-technique Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the general groups load-balance default values. To remove the general groups load-balance default values, use the [no] option.
Syntax
configure cable load balance general-group-defaults inittechnique [no]
Parameter
Definition
Unsigned integer. Valid range is 1-8388607.
broadcast-ranging direct
Use the new channel(s) directly without re-initializing or ranging
disable
No load balancing will be done for this group (all bits set to 0)
ranging
Perform either broadcast or unicast ranging on new channel before normal operation
reinit-mac unicast-ranging
CLI-186
Perform broadcast initial ranging on a new channel before normal operation
Reinitialize the MAC Perform unicast ranging on new channel before normal operation.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance general-group-defaults policy Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Assigns a policy to the general groups. To remove the general groups policy, use the [no] option.
Syntax
configure cable load-balance general-group-defaults policy [no]
Parameter
Issue 2.0
Definition
Policy number.
ARRIS PROPRIETARY — All Rights Reserved
CLI-187
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance include cm-mac Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures one or a group of CMs into a RLBG using MAC addresses. To return to the default value, use the [no] option.
Syntax
configure cable load balance include cm-mac [no]
Parameter
CLI-188
Definition
CM MAC address (1-6 bytes long).
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance include oui Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures one or a group of CMs into a RLBG using OUI. To return to the default value, use the [no] option.
Syntax
configure cable load balance include oui [no]
Parameter
Definition
The Organization Unique Identifier : most significant 3 bytes of the MAC Address; or 3Com
Elsa
NEC
Ambit
Ericsson
Netgear
Sunrise
Netwave
Syswave
Arris Askey ASUSTek BAS BestData Broadcom
GADline GeniusNet
Nortel
Hitron
Technotrend
Opentech
Humax
Pace
Teledex Telexy
iCable_System Pacific Infinite
Cadant
Intel
Castlenet
Joohong
Cisco
SMC
Leichu
Tellabs
Panasonic Philips
Telogy
Terayon
Pioneer Ponico
TI Tollgrade
Com21
LG
Conexant
Linksys
Coresma
Maspro
RCA/Thomson Ubee
COSHIP
Matsushita
RiverDelta
D-Link
Mercury
Daehanet
Motorola
DAKOS
MPlus
PowerCom
Toshiba
QNS
SA Saejin Samsung
TurboComm USRobotics
Woojyun Zoom ZyXel
Electroline
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-189
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance macdomain-check Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the intra-MAC-domain load balancing check interval. To return to the default value (300 seconds), use the [no] option.
Syntax
configure cable load balance macdomain-check [no]
Parameter
CLI-190
Definition
Sets the intra-MAC-domain load balancing checking interval. Value is in seconds.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance policy Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines a valid dynamic load-balance policy. To remove a valid dynamic loadbalance policy, use the [no] option.
Syntax
configure cable load balance policy [no]
Parameter
Issue 2.0
Definition
Policy number. Valid range is 1-4294967295.
ARRIS PROPRIETARY — All Rights Reserved
CLI-191
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance policy * rule Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Assigns a rule to the specified load-balance policy. To delete a rule from an existing policy, use the [no] option.
Syntax
configure cable load balance policy rule [no]
Parameter
CLI-192
Definition
Policy number. Valid range is 1-4294967295.
Rule number. Valid range is 1-4294967295.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * channel-weight Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the channel-weight for a rule to determine load-balancing decisions. To remove the channel-weight, use the [no] option.
Syntax
configure cable load-balance rule channelweight [equal | US-only | DS-Only | US+ | DS+] [no]
Parameter
equal
Issue 2.0
Definition
Rule number. Directs the load balancer to use DS and US channel load equally.
US-only
Directs the load balancer to only use US channel load.
DS-only
Directs the load balancer to only use DS channel load.
US+
Directs the load balancer to double US channel load over DS channel load.
DS+
Directs the load balancer to double DS channel load over US channel load.
ARRIS PROPRIETARY — All Rights Reserved
CLI-193
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * disable-period Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the time for a rule to be disabled based on time of day. To remove the disable period, use the [no] option. NOTE The NO version of this command also disables the rule.
Syntax
configure cable load-balance rule disable-period [start-time ] | [period ] [no]
Parameter
Definition
Rule number.
sec-since-midnight
Seconds elapsed since midnight. Valid range is 0-86400.
hr:min[:sec] secs hr:min[:sec]
CLI-194
Military time for hours, e.g 0-23. Length of time in seconds that load balancing is disabled. Valid range is 0-86400 Military time for hours, e.g 0-23.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * enable Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Turns on load balancing for a specified rule. To disable load balancing for a specified rule, use the [no] option.
Syntax
configure cable load balance rule enable [no]
Parameter
Issue 2.0
Definition
Rule number.
ARRIS PROPRIETARY — All Rights Reserved
CLI-195
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * method Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the method for dynamic load balancing of a specified rule. To return the type to the default value of “modem”, use the [no] option.
Syntax
configure cable load balance rule method [no]
Parameter
CLI-196
Definition
Rule number. Valid range is 1-4294967295. Modem or utilization. Default is set to modem.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * periodic-steeringd2 Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables moving D2.0 cable modems to an ATDMA channel in the load-balance group. To disable, use the [no] option.
Syntax
configure cable load balance rule periodicsteeringd2 [no]
Parameter
Issue 2.0
Definition
Rule number. Valid range is 1-4294967295.
ARRIS PROPRIETARY — All Rights Reserved
CLI-197
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * periodic-steeringd3 Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables moving D3.0 cable modems to an ATDMA channel in the load-balance group. To disable, use the [no] option.
Syntax
configure cable load balance rule periodicsteeringd3 [no]
Parameter
CLI-198
Definition
Rule number. Valid range is 1-4294967295.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * registration-steeringd2 Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables moving any D2.0 cable modems registering on a TDMA channel to an ATDMA channel in the load-balance group. To disable, use the [no] option.
Syntax
configure cable load balance rule registrationsteeringd2 [no]
Parameter
Issue 2.0
Definition
Rule number. Valid range is 1-4294967295.
ARRIS PROPRIETARY — All Rights Reserved
CLI-199
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * registration-steeringd3 Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables moving any D3.0 cable modems registering on a TDMA channel to an ATDMA channel in the load-balance group. To disable, use the [no] option.
Syntax
configure cable load balance rule registrationsteeringd3 [no]
Parameter
CLI-200
Definition
Rule number. Valid range is 1-4294967295.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * threshold Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the threshold for dynamic load balancing for a specified rule. To return the threshold to the default value of 10%, use the [no] option.
Syntax
configure cable load balance rule threshold [no]
Parameter
Issue 2.0
Definition
Rule number. Valid range is 1-4294967295. An integer from 1-100 which determines how close to equal the channels in a load balancing group will be. The default value is 10%.
ARRIS PROPRIETARY — All Rights Reserved
CLI-201
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance rule * type Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the type of dynamic load balancing for a specified rule. To return the type to the default value of both, use the [no] option.
Syntax
configure cable load balance rule type {static | dynamic | bonded | both} [no]
Definition
Rule number. Valid range is 1-4294967295. Type can be one of the following: static - Sets the rule to perform static load balancing only.
{static | dynamic | bonded| dynamic - Sets the rule to perform dynamic load balancing only. both} bonded - Sets the rule to perform static, dynamic and bonded load balancing. both - Sets the rule to perform both static and dynamic load balancing. Default value is both.
CLI-202
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance upstream-start-threshold Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the percent of load difference between channels before load balancing on an upstream channel is invoked. To reset, use the [no] option.
Syntax
configure cable load-balance upstream-start-threshold [no]
Parameter
Issue 2.0
Definition
Percent utilization on an upstream channel required before load balancing is invoked.
ARRIS PROPRIETARY — All Rights Reserved
CLI-203
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-balance utilization-modems-to-check Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the number of cable modems to check for high utilization at each macdomain-check-interval. If you set this value low, then high-utilization users are less likely to be moved to a different channel. Setting this value high makes it more likely that high-bandwidth users will be moved more frequently. To reset, use the [no] option.
Syntax
configure cable load-balance utilization-modems-to-check [no]
Parameter
CLI-204
Definition
Number of modems. The default is 10.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable load-interval Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the interval for utilization calculations. To disable the interval used for utilization calculations, use the [no] option. NOTE Changes to the cable load-interval are not immediate and will take effect after the current interval has expired.
WARNING On large systems, setting this value too low will drain CPU resources. The minimum recommended value is 300 seconds. Syntax
configure cable load-interval [no]
Parameter
Issue 2.0
Definition
The interval in seconds to collect/compute utilization data.
ARRIS PROPRIETARY — All Rights Reserved
CLI-205
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable mac-move-allowed-on-dhcp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Allows MAC movement on receipt of DHCP packets. To disable, use the [no] option.
Syntax
configure cable mac-move-allowed-on-dhcp [no]
CLI-206
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable max-qos-active-timeout Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum QoS Active Timeout the CMTS is willing to allow. If a larger value is received in a CM request, then the CMTS will return this value instead of the response. NOTE If DSx DQoS VoIP is enabled, the active timeout should be set at 30 seconds. Increasing the default value or setting the value to 0 (which represents infinity) is not recommended. The default values serve as a precaution for freeing resources in the event that any device or transmission path in the network does not perform as required. This command is for DSx DQoS; it has no effect on PacketCable.
Syntax
configure cable max-qos-active-timeout
Parameter
Definition
Maximum time in seconds. Default is 30 seconds.
Related Command(s)
configure cable max-qos-admitted-timeout
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-207
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable max-qos-admitted-timeout Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum QoS Admitted Timeout the CMTS is willing to allow. If a larger value is received in a CM request, the CMTS will return this value instead of the response. NOTE If DSx DQoS VoIP is enabled, the active timeout should be set at 30 seconds. Increasing the default value or setting the value to 0 (which represents infinity) is not recommended. The default values serve as a precaution for freeing resources in the event that any device or transmission path in the network does not perform as required. This command is for DSx DQoS; it has no effect on PacketCable.
Syntax
configure cable max-qos-admitted-timeout
Parameter
Definition
Maximum time in seconds. Default is 200 seconds.
Related Command(s)
configure cable max-qos-active-timeout
CLI-208
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable max-ucd-burst-len Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum UCD concatenation burst size.The CMTS limits the burst-len parameter within each upstream's UCD message for the Long Data Grant IUC(s) in terms of minislots using this new parameter. This limits the maximum bandwidth request size that a modem is permitted to request. NOTE Each modem is still constrained by its configuration file parameters. A DOCSIS 1.0 configuration is constrained by maximum transmit burst; A DOCSIS 1.1 configuration is constrained by maximum concatenation burst and maximum transmit burst.
Syntax
configure cable max-ucd-burst-len
Parameter
Definition
Maximum UCD concatenation burst size in bytes. Default value is set at 16128.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-209
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the IP Detail Record (IPDR) streaming feature. When IPDR streaming is enabled, records are sent to the primary collector at the next report interval.
Syntax
configure cable metering
Parameter
Definition
Changes the state of the exporter
Related Command(s)
show cable metering
CLI-210
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering collector Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the Collector entries by setting the priority range and IP address for IPDR streaming protocol. A maximum of five Collectors can be configured. To remove Collector entries, use the [no] option.
Syntax
configure cable metering collector [no]
Parameter
Definition
The priority range of the Collector. Valid numbers 1 - 255 with 1 as the highest priority.
IP address of the collector in the format of A.B.C.D
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-211
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering data-ack-timeout Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum time in seconds between the DATA-ACK messages sent by the collector to the exporter.
Syntax
configure cable metering data-ack-timeout
Parameter
Definition
Maximum elapsed time in seconds. Valid numbers are 1 - 600. The default is 60 seconds.
Related Command(s)
configure cable metering session id * service * method show cable metering
CLI-212
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering data-ack-window Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of records that the collector must receive before sending a DATA-ACK to the exporter.
Syntax
configure cable metering data-ack-window
Parameter
Definition
Maximum number of records. Valid numbers are 1 - 65535. The default is 200 data messages.
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-213
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering export Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures interim records with duplicate counter values for the IPDR streaming protocol feature. Defaults disable all-counts and exclude CPE information. To suppress interim records entries that have duplicate counter values, use the [no] option.
Syntax
configure cable metering export [all-counts] [cpe-info] [no]
Parameter
[all-counts] [cpe-info]
Definition
Export all interim records regardless of counter values. Includes CPE information with the records. CPE information is a list of CPE IPv4 addresses.
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
CLI-214
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering keep-alive-interval Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum time in seconds between KEEP-ALIVE messages sent by the collector to the exporter.
Syntax
configure cable metering keep-alive-interval
Parameter
Definition
Maximum number of seconds. Valid numbers are 1 - 600. The default is 90 seconds.
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-215
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering mode Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the DOCSIS operational mode for the IP Detail Record (IPDR) streaming feature.
Syntax
configure cable metering mode
Parameter
Definition
The operating mode of either DOCSIS 2.0 or DOCSIS 3.0.
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
CLI-216
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering query-port Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the exporter User Datagram Protocol (UDP) query-port used by the collector for service discovery for the IPDR streaming protocol.
Syntax
configure cable metering query-port
Parameter
Definition
The UDP port used for service discovery. Valid numbers are 1 - 65535. The default port number is 4737.
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-217
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering report-cycle set * start * interval Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the interval duration and the start time of the export reporting cycles for the IPDR streaming feature.
Syntax
configure cable metering report-cycle set start interval [no]
Parameter
Definition
Report cycle set ID. Valid range is 1-255.
Starting time for this report cycle set entered in hh:mm format or as “random”.
Interval duration in minutes for the export report cycle set. Values are 15 - 1440 minutes. The default interval is 60 minutes.
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
CLI-218
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering report-cycle start * interval Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the start time and interval duration of the export reporting cycles for the IPDR streaming feature.
Syntax
configure cable metering report-cycle start interval
Parameter
Definition
Time to start the export report cycles entered in hh:mm format or as “random”.
Interval duration in minutes for the export report cycles. Values are 15 - 1440 minutes. The default interval is 60 minutes.
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-219
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering session-id Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the session ID used in the header of the IPDR protocol messages.
Syntax
configure cable metering session-id
Parameter
Definition
Number of the session ID. Values are 0 and 1.
Related Command(s)
show cable metering
CLI-220
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering session id * service * method Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the session ID used in the header of the IPDR protocol messages.
Syntax
configure cable metering session id service method [data-ack-window ] [data-ack-timeout ] [allcounts] [no]
NOTE The optional parameter “all-counts” is a flag which is set to “true” by its inclusion and “false” by its exclusion. This should be remembered when modifying the parameters of a session.
Parameter
Definition
Number of the session ID.
The type of IPDR service.
One of the methods of exporting IPDR records depending on service type.
[data-ack-window ]
Maximum number of records the Collector must receive. Valid numbers are 1 65535. The default is 200 data messages
[data-ack-timeout ]
Maximum elapsed time in seconds. Valid numbers are 1 - 600. The default is 60 seconds.
[all-counts]
Export all interim records regardless of counter values
Related Command(s)
configure cable metering show cable metering
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-221
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable metering streaming-port Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the Exporter TCP streaming-port number used for streaming data to the Collector by the IPDR streaming protocol.
Syntax
configure cable metering streaming-port
Parameter
Definition
The TCP port used to stream data to the Collector. Valid numbers are 1 - 65535. The default port number is 4737
Related Command(s)
configure cable metering configure cable metering session id * service * method show cable metering
CLI-222
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable modem deny Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Populates the CM Deny List MIB table with the specified MAC address. If a cable modem, whose MAC address has been provisioned in this table, attempts to range on the CAM on the CMTS, this modem will not receive an IP address. NOTE Currently, the CM Deny List MIB table will accept no more than 1000 MAC addresses. The configure reset cable-modem command can then be entered to remove the modem(s) from the queue. -orBy waiting for the C4 CMTS T9 timer to automatically expire within 15 minutes, the C4 CMTS will remove the modem(s) from the ranging queue. To remove the specified MAC address from the CM Deny List MIB, use the [no] option.
Syntax
configure cable modem deny [no]
Parameter
Definition
MAC address
Related Command(s)
clear counters cable modem deny configure reset cable-modem show cable modem deny
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-223
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable modem format Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Configures a customized “show cable modem format”. To reset to the default settings, use the [no] option. NOTE To receive more specific parameters, type configure cable modem format ?, where is one of the parameters listed below.
Syntax
configure cable modem format [no] The name of the format, as used in show cable modem format . Some examples of the parameter include: bonded
cm-up-pwr
flap-prev-state
qos
bpi
congest-down
flaps--prov
rec-pwr
cable-mac
congest-up
flaps-ranging
response-percent
cfgfile
cpe-count
flaps-reg
service-type-curr
cfgfile-long
cpe-ip
fpccm-online
service-type-prov
cm-cpe-ip
cpe-mac
fpcm-cpe
sid
cm-down-pwr
cpe-type
fpcm-id
snr
cm-down-snr
crc
fpcm-qos
state
cm-ip
docsis-mac
hcs
state-docsis20
cm-mac
docsis-prov
interface
timing
cm-microreflec
fec-corrected
interface-docsis20
uptime
cm-sysdesc
fec-uncorrected
load-bal-grp
vendor
cm-time-polled
fec-unerrored
microflec
cm-timing
filter-cm
policed-down
cm-type
flap-last-flap
power-adj
Related Command(s)
show cable modem show cable modem column show cable modem format
CLI-224
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable modem move * cable-downstream * cable-upstream * method Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Provides various ways to move a modem on the CMTS.
Syntax
configure cable modem move cable-downstream cable-upstream method {reinit-mac | broadcast-ranging | unicast-ranging | ranging | direct}
Parameter
Definition
The 48-bit hardware address of the cable modem to be moved.
The chassis slot in which the CAM resides and port number for the downstream interface.
The slot and port for the upstream interface.
reinit-mac broadcast-ranging unicast-ranging
Issue 2.0
Move the modem by reinitializing the MAC Move the modem by performing broadcast initialization Move the modem by performing unicast ranging
ranging
Move the modem using either broadcast or unicast ranging
direct
Move the modem directly without reinitializing or ranging.
ARRIS PROPRIETARY — All Rights Reserved
CLI-225
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable modem move * downstream-freq Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Moves the cable modem to a different channel.
Syntax
configure cable modem move downstream-freq [us-channel-id ]
Parameter
us-channel-id
CLI-226
Definition
The 48-bit hardware address of the cable modem to be moved. Downstream frequency to move to. US channel ID
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable modem move * us-channel-id Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Moves the cable modem to a different channel ID.
Syntax
configure cable modem move us-channel-id
Parameter
Issue 2.0
Definition
The 48-bit hardware address of the cable modem to be moved. US channel ID
ARRIS PROPRIETARY — All Rights Reserved
CLI-227
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable modem remote-query Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the cable modem SNMP remote query settings to allow query of the cable modem (CM) performance statistics. By polling the cable modems periodically using SNMP and caching the information (e.g. IP address, MAC address, S/N ratio, and UTP), you will know at a glance the state of a single modem and the overall status of the plant. To restore the default values, use the [no] option. NOTE The remote-query function is off by default.
Syntax
configure cable modem remote-query [ [][no]
Parameter
Definition
[
Defines the time interval (in seconds) between two polling cycles of CM data collection. Valid range is from 30 to 86,400 seconds. Default = 1800 seconds.
[]
Defines the SNMP community string used for polling CMs. The community string is allowed only if the polling-rate has been input. Default = public.
To verify that the option is enabled, use the following command: C4# Example
show running-config | include remote-query The following is an example of the output returned by the system: cable modem remote-query 1800
configure snmp-server community [index [ttag ] [security ] [no]
CLI-228
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable modem remote-query source-interface Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the cable modem SNMP remote query settings to allow query of the specified interface.
Syntax
configure cable modem remote-query source-interface {
Center frequency in Hz. Valid range is 5000000 to 65000000.
Issue 2.0
The width of the upstream channel for this state in Hertz The modulation-profile number.
ARRIS PROPRIETARY — All Rights Reserved
CLI-267
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable spectrum-group * state * trigger Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the trigger conditions of the Frequency Agility State Machine. To reset to the default state, use the [no] option.
Syntax
configure cable spectrum-group state trigger
Parameter
CLI-268
[no]
Definition The number of the spectral group and has a value from 0-40.
Pointer to the unique state within state machine.
Trigger ID (can be used by all state machines).
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable spectrum-group trigger * degradation Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates a performance trigger based on worsening conditions. To delete the performance trigger, use the [no] option.
Syntax
configure cable spectrum-group trigger degradation [fec_err ] [ufec_err ] [snr ] [no]
Parameter
Issue 2.0
Definition
The trigger number and has values of 1-64
The percentage of FEC codewords with FEC errors (corrected and uncorrected) in units of one thousandth of a percent and has values ranging from 0 to 100000. The default value is 0.
The percentage of FEC codewords with uncorrected errors in units of one thousandth of a percent and has values ranging from 0 to 100000. Default value is 0.
The maximum SNR value for the current state in tenths of a dB. Default value is 1000.
ARRIS PROPRIETARY — All Rights Reserved
CLI-269
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable spectrum-group trigger * improvement Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates a performance trigger. To delete the performance trigger, use the [no] option.
Syntax
configure cable spectrum-group trigger improvement [fec_err ] [ufec_err ] [snr ] [no]
Parameter
CLI-270
Definition
The trigger number and has values of 1-64
The percentage of FEC codewords with FEC errors (corrected and uncorrected) in units of one thousandth of a percent and has values ranging from 0 to 100000. The default value is 100000.
The percentage of FEC codewords with uncorrected errors in units of one thousandth of a percent and has values ranging from 0 to 100000. Default value is 100000.
The maximum SNR value for the current state in tenths of a dB. Default value is 0.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable spectrum-group trigger * period Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates a periodic trigger. To delete the periodic trigger, use the [no] option.
Syntax
configure cable spectrum-group trigger period [no]
Parameter
Issue 2.0
Definition
The trigger number and has values of 1-64
The period of time before the trigger fires in seconds and has values from 1 to 604,800 (one week).
ARRIS PROPRIETARY — All Rights Reserved
CLI-271
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable spectrum-group trigger * time Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the Time of Day trigger. To delete this trigger condition, use the [no] option.
Syntax
configure cable spectrum-group trigger time
Parameter
Definition The trigger number and has values of 1-64 Day of the week. Must use one of the following values:
0: 1: 2: 3: 4: 5: 6: 7:
Sunday Monday Tuesday Wednesday Thursday Friday Saturday Everyday
Standard 24-hour time, e.g.:
CLI-272
hh = hour and varies from 0 to 23 mm = minutes and varies from 0 to 59 ss = seconds and varies from 0 to 59
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable submgmt default active Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Activates the system wide subscriber management filter provisioning for CPE control. To deactivate the system wide subscriber management filter provisioning for CPE control, use the [no] option.
Syntax
configure cable submgmt default active [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-273
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable submgmt default filter-group Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the specified filter group. To delete a specific filter group, use the [no] option.
Syntax
configure cable submgmt default filter-group [cm upstream 1023> | host downstream ] [cpe upstream | cpe downstream ] [mta upstream | mta downstream ] [ps upstream > | ps downstream ] [stb upstream > | stb downstream ] tea upstream > | tea downstream ] [no]
Parameter
Definition
| cm downstream ]>
Filters on either the specified upstream or downstream CM group defaults
| host downstream ]>
Filters on either the specified upstream or downstream CPE, MTA, PS, and STB group defaults
| cpe downstream ]>
Filters on either the specified upstream or downstream regular CPE group defaults
| mta downstream ]>
Filters on either the specified upstream or downstream PacketCable MTA group defaults
| ps downstream ]>
Filters on either the specified upstream or downstream Cablehome PS group defaults
| stb downstream ]>
Filters on either the specified upstream or downstream DSG STB group defaults
| tea downstream ]>
Filters on either the specified upstream or downstream TEA (TDM Emulation Adapter) group defaults
CLI-274
The filter group ID. Range is 1 - 1023.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable submgmt default learnable Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables learning of the CPE IP addresses by the CMTS. To disable, use the [no] option.
Syntax
configure cable submgmt default learnable [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-275
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable submgmt default max-cpe Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of IP addresses behind a cable modem. To revert to the default, use the [no] option.
Syntax
configure cable submgmt default max-cpe [no]
Parameter
CLI-276
Definition Maximum number of IP addresses behind a CM.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable submgmt default v6-max-cpe Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of IPv6 addresses behind a cable modem. To revert to the default, use the [no] option.
Syntax
configure cable submgmt defaultmax-cpe [no]
Parameter
Issue 2.0
Definition Maximum number of IPv6 addresses behind a CM.
ARRIS PROPRIETARY — All Rights Reserved
CLI-277
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable tcc-refid-in-first-only Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the ability to send 46.1 Ref ID in the first TCC fragment. To disable, use the [no] option.
Syntax
configure cable tcc-refid-in-first-only [no]
CLI-278
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable unicast-np-us-acquisition Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables unicast non-primary upstream channel acquisition. To disable, use the [no] option.
Syntax
configure cable unicast-np-us-acquisition [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-279
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure cable unicast-polling pri Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the settings for unicast polling priorities. To reset the unicast polling priorities, use the [no] option.
Syntax
configure cable unicast-polling pri [slow-intvl ] [fast-intvl ] [fast-period ] [no]
Parameter
Definition
DOCSIS service flow priority
[slow-intvl ]
Slow poll interval, units in tens of milliseconds
[fast-intvl ]
Fast poll interval, units in tens of milliseconds
[fast-period ]
Fast poll timeout period, units in tens of milliseconds
Example
Following are some example commands and their output: C4#
configure cable unicast-polling pri 0 slow-intvl 20 To view the results of this command, run the show cable unicastpolling command and you will see an output such as the following: slow fast fast priority interval interval period -------- -------- -------- -------0 20 0 0 1 0 0 0 2 0 0 0 3 0 0 0 4 125 25 500 5 100 20 500 6 75 15 500 7 50 10 500
c4#
CLI-280
configure cable unicast-polling pri 1 fast-intvl 21
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
To view the results of this command, run the show cable unicastpolling command.The following is a sample output: slow fast fast priority interval interval period -------- -------- -------- -------0 20 0 0 1 0 21 0 2 0 0 0 3 0 0 0 4 125 25 500 5 100 20 500 6 75 15 500 7 50 10 500
C4c#
configure cable unicast-polling pri 1 fast-period 22 slow fast fast priority interval interval period -------- -------- -------- -------0 20 0 0 1 0 21 22 2 0 0 0 3 0 0 0 4 125 25 500 5 100 20 500 6 75 15 500 7 50 10 500
C4c#
configure cable unicast-polling pri 2 slow-intvl 23 fastintvl 24 fast-period 25 slow fast fast priority interval interval period -------- -------- -------- -------0 20 0 0 1 0 21 22 2 23 24 25 3 0 0 0 4 125 25 500 5 100 20 500 6 75 15 500 7 50 10 500
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-281
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure clock network Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the network time synchronization protocol to either the NTP or TOD. To disable the active network time synchronization protocol and leave the local time of day clock to run without synchronization, use the [no] option.
Syntax
configure clock network
Filters on either the specified upstream or downstream regular CPE group defaults
| mta downstream ]>
Filters on either the specified upstream or downstream PacketCable MTA group defaults
| ps downstream ]>
Filters on either the specified upstream or downstream Cablehome PS group defaults
| stb downstream ]>
Filters on either the specified upstream or downstream DSG STB group defaults
CLI-406
The filter group ID. Range is 1 - 1023.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable sync-interval Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the interval between successive sync message transmissions in milliseconds. The sync messages allow a cable modem to lock into the 10.24 MHz system clock in the CMTS. The recommended value for this parameter is 10 msec. Decreasing the sync interval causes additional overhead because more sync messages are sent. But increasing the sync interval may prevent some cable modems from locking onto the system clock. According to the DOCSIS® RFI specification, the maximum time between sync messages should be 200 msec. To restore the default value, use the [no] option.
Syntax
configure interface cable-mac cable sync-interval [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415. Valid range for interval is 1 to 200 milliseconds Default is 10 milliseconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-407
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable tftp-enforce Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Configures TFTP enforcement. To disable TFTP enforcement (applies to IPv4 and IPv6), use the [no] option.
Syntax
configure interface cable-mac cable tftp-enforce [no]
Parameter
Lock modems violating TFTP enforce checks with limited bandwidth.
CAUTION
Using the without specifying the block/lock/mark-only parameter can be service affecting and cause modems not to register.
CLI-408
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable ucd-interval Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the interval in milliseconds between transmission of Upstream Channel Descriptor (UCD) messages. To restore the default value, use the [no] option.
Syntax
configure interface cable-mac cable ucd-interval [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415. Valid range for interval between transmission is between 20 and 2000 milliseconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-409
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable upstream-bonding-group Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Defines the static upstream bonding groups for the system. In this configuration, a specific bonding group tied to a specific MAC domain. To remove the bonding group, use the [no] option.
Syntax
configure interface cable-mac cable upstream-bonding-group [no]
Parameter
CLI-410
Definition
The MAC identifier. Valid numbers are 0-415 Static bonding group identifier. Valid numbers are 1 - 65535.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable upstream-bonding-group * attribute-mask value Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Configures the attribute mask encoding for the bonding group. To restore the default attribute mask value of 0x80000000, use the [no] option.
Syntax
configure interface cable-mac cable upstream-bonding-group attribute-mask value [no]
Parameter
Definition
The MAC identifier. Valid numbers are 0-415. Static bonding group identifier A hex string that must be greater than the default of 0x80000000
Related Command(s)
show cable bonding-group-status
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-411
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable upstream-bonding-group * cable-upstream Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Defines the upstream channels to be used in the bonding group. All the channels must be within one MAC domain. To remove the channel from the bonding group channel set, use the [no] option.
Syntax
configure interface cable-mac cable upstream-bonding-group cable-upstream /
Parameter
/
Definition
The MAC identifier. Valid numbers are 0-415. Static bonding group identifier The chassis slot in which the CAM resides and upstream port number.
Related Command(s)
show cable bonding-group-status
CLI-412
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable upstream-bonding-group dynamic enable Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables the dynamic creation of upstream bonding groups on a MAC domain. To disable dynamic creation of the bonding groups, use the [no] option. NOTE The default is set to disabled.
Syntax
configure interface cable-mac cable upstream-bonding-group dynamic enable [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415.
ARRIS PROPRIETARY — All Rights Reserved
CLI-413
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable us-freq-range Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets MDD messages in the upstream frequency upper band edge. To remove MDD messages, use the [no] option.
Syntax
configure interface cable-mac cable us-freq-range [no]
Parameter
CLI-414
Definition
The MAC identifier.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable us-freq-range extended Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets MDD messages in the extended frequency upper band edge. To remove MDD messages, use the [no] option.
Syntax
configure interface cable-mac cable us-freq-range extended [no]
Parameter
Issue 2.0
Definition
The MAC identifier.
ARRIS PROPRIETARY — All Rights Reserved
CLI-415
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable us-freq-range standard Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets MDD messages in the standard frequency upper band edge. To remove MDD messages, use the [no] option.
Syntax
configure interface cable-mac cable us-freq-range standard[no]
Parameter
CLI-416
Definition
The MAC identifier.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * cable verbose-cm-rcp Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Enables cable modems to provide verbose reporting of Receive Channel Profiles (RCP). To disable verbose reporting, use the [no] option. By default RCP reporting is set to non-verbose. RCP reporting is part of the algorithm used by the CMTS to assign RCC (Receive Channel Configurations) to cable modems. If verbose reporting of RCPs is enabled, CMs send their full Receive Channel Profiles to the CMTS. If it is not enabled (non-verbose RCP reporting), then CMs send only their RCP IDs. If the CMTS does not recognize a particular RCP ID, it uses a standard DOCSIS-defined RCP for that modem instead. Dynamic RCC channel assignments must operate with hard-coded RCPs because there are no RCP MIBs to support them. Conforming verbose RCPs must satisfy these criteria:
Syntax
•
Nx1 receive channel configuration where all receive channels connect to a single receive module
•
NxN receive channel configuration with receive channel connectivity:
•
- Rx channel 1 -> Rx Module 1 - Rx channel 2 -> Rx Module 2 - Rx channel 3 -> Rx Module 3 - Rx channel N -> Rx Module N They do not require common PHY parameter checks
•
They do not specify multiple frequency blocks per module
•
They do not specify any module-to-module connectivity requirements
•
They do not support module resequencing subset limitations
•
They do not specify the receive channel connected offset parameter (RCC Encodings Type 48.5.3)
configure interface cable-mac cable verbose-cm-rcp [no] Parameter
Definition
The MAC identifier.
Related Command(s)
configure interface cable-mac * cable dynamic-rcc
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-417
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * description Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Configures the description of the specified cable MAC. To remove the description, use the [no] option.
Syntax
configure interface cable-mac description [no]
Parameter
CLI-418
Definition
The MAC identifier.
Description of the cable MAC
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip access-group Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the access control for packets on the specified interface. To remove the access control, use the [no] option.
Syntax
configure interface cable-mac ip access-group {in | out} [no]
Parameter
Definition
The MAC identifier. Valid numbers are 0-415.
Number or name of a standard or extended IP access list. Valid ranges for IP access lists are: standard = 1-99 and extended = 100-199
{in | out}
Inbound packets or outbound packets
Related Command(s)
configure interface cable-mac * ipv6 traffic-filter
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-419
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip address Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Pertains to the default virtual router. This command assigns an IP address to the CAM interface and determines its DHCP policy. Secondary IP addresses become candidates for the dhcp-giaddr field if and only if the keywords secondary and dhcp-giaddr are both used. To disable the secondary DHCP policy, use the [no] option.
Syntax
configure interface cable-mac ip address [secondary] [dhcp-giaddr] [no]
Parameter
[secondary] [dhcp-giaddr]
Definition
The MAC identifier. IP address Local host mask Secondary IP address of CPEs Gateway IP of DHCP server. Can only be used in conjunction with [secondary] keyword
NOTE Some subnets are reserved for CMTS Internal Processor Communications (IPC). No interfaces may be configured for the following subnets: 100.0.0.x 100.0.1.x 100.0.2.x 1.1.0.x 1.1.1.x
CLI-420
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip directed-broadcast Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Enables IP directed-broadcast for this interface. To disable IP directed broadcast for this interface, [no] option.
Syntax
configure interface cable-mac ip directed-broadcast [no]
Parameter
Issue 2.0
Definition
The MAC identifier.
ARRIS PROPRIETARY — All Rights Reserved
CLI-421
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Enables IGMP on the specified interface. To leave a statically joined multicast group, use the [no] option.
Syntax
configure interface cable-mac ip igmp [no]
Parameter
CLI-422
Definition
The MAC identifier. Valid numbers are 0-415.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp access-group Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the IGMP group access group on the specified interface. To leave the IGMP access group, use the [no] option.
Syntax
configure interface cable-mac ip igmp access-group [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415.
Number or name of a standard or extended IP access list. Valid range for IP access lists are: standard = 1-99 and extended = 100-199
ARRIS PROPRIETARY — All Rights Reserved
CLI-423
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp backup-proxy-interface Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the backup IGMP proxy interface for the specified interface.
Syntax
configure interface cable-mac ip igmp backup-proxy-interface
Parameter
CLI-424
Definition
The MAC identifier. Valid numbers are 0-415. Configures the gigabitethernet as backup-proxy-interface Configures the tengigabitethernet as backup-proxy-interface
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp host-robustness Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the IGMP host robustness. To restore the default value, use the [no] option.
Syntax
configure interface cable-mac ip igmp host-robustness [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415
Robustness number. Valid range is 1-255
ARRIS PROPRIETARY — All Rights Reserved
CLI-425
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp host-version Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the IGMP host version. To restore the default value, use the [no] option.
Syntax
configure interface cable-mac ip igmp host-version [no]
Parameter
CLI-426
Definition
The MAC identifier. Valid numbers are 0-415.
Version number. Valid range is 1-3
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp join-group Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Enables joining a multicast group locally. To disable joining a local multicast group, use the [no] option.
Syntax
configure interface cable-mac ip igmp join-group [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415. SSM source IP address
ARRIS PROPRIETARY — All Rights Reserved
CLI-427
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp join-group * source Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Enables joining a multicast group locally. To disable joining a local multicast group, use the [no] option.
Syntax
configure interface cable-mac ip igmp join-group source [no]
Parameter
CLI-428
Definition
The MAC identifier. Valid numbers are 0-415. IP address SSM source IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp last-member-query Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the last member query interval. To remove the last member query interval, use the [no] option.
Syntax
configure interface cable-mac ip igmp last-member-query [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415. Last member query interval (tenths of seconds). Valid range is 0-254. Default is set at 10 seconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-429
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp multicast-static-only Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets an IGMP enabled interface to only have static multicast traffic. To remove static-only from an IGMP-enabled interface, use the [no] option.
Syntax
configure interface cable-mac ip igmp multicast-static-only [no]
Parameter
CLI-430
Definition
The MAC identifier. Valid numbers are 0-415.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp proxy-interface Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the proxy interface for the specified interface. To remove the proxy interface, use the [no] option.
Syntax
configure interface cable-mac ip igmp proxy-interface {gigabitethernet / [.] | tengigabitethernet /[.]} [no]
Parameter
gigabitethernet /
Definition
The MAC identifier. Valid numbers are 0-415. RCM slot number/gigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
RCM slot number/gigabitEthernet port number. tengigabitethernet / Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-431
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp query-interval Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the query interval. To restore the default value, use the [no] option.
Syntax
configure interface cable-mac ip igmp query-interval [no]
Parameter
CLI-432
Definition
The MAC identifier. Valid numbers are 0-415. Query interval (seconds). The valid range is 0 to (232 -1). Default is 125 seconds.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp query-max-response-time Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the query max response time. To restore the default value, use the [no] option.
Syntax
configure interface cable-mac ip igmp query-max-response-time [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415.
Query max response time (tenths of seconds). Valid range is 0-255. Default is set at 10 seconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-433
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp robustness Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the robustness (the level of tolerance) for messages lost. Setting the robustness parameter higher provides greater protection to the IGMP protocol from packet loss problems but at the cost of lost memberships. Setting it low minimizes the number of memberships lost. To restore the default value, use the [no] option.
Syntax
configure interface cable-mac ip igmp robustness [no]
Parameter
CLI-434
Definition
The MAC identifier. Valid numbers are 0-415. Defines the level of tolerance for messages lost. Valid range is 1-255. The default is 2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp static-group Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Statically adds membership to an IP multicast group on an IP virtual interface. To remove membership to an IP multicast group on an IP virtual interface, use the [no] option.
Syntax
configure interface cable-mac ip igmp static-group [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415. Multicast group IP address.
ARRIS PROPRIETARY — All Rights Reserved
CLI-435
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp static-group * source Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
This is an extension of the IGMP command configure interface cable-mac ip igmp static-group to statically add membership to an IP multicast group on an IP virtual interface. To remove membership to an IP multicast group on an IP virtual interface, use the [no] option. NOTE The IGMP code will inform PIM of the multicast address only if the source IP address is included.
Syntax
configure interface cable-mac ip igmp static-group source [no]
Parameter
Definition
The MAC identifier. Valid numbers are 0-415.
Multicast group IP address.
SSM source IP address
CLI-436
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip igmp version Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the IGMP router version.To remove IP router version, use the [no] option.
Syntax
configure interface cable-mac ip igmp version [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415.
Version number. Valid range is 1-3
ARRIS PROPRIETARY — All Rights Reserved
CLI-437
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf authentication-key Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Assigns a password to be used by neighboring routers that are using the OSPF simple password authentication key. To disable the OSPF authentication key password, use the [no] option.
Syntax
configure interface cable-mac ip ospf authentication-key [no]
Parameter
CLI-438
Definition
The MAC identifier. Password to be used by neighboring routers.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf authentication key-chain Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Specifies the set of keys that can be used on this interface. To disable the ospf authentication key-chain, use the [no] option.
Syntax
configure interface cable-mac ip ospf authentication key-chain [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Name of the key chain used on this interface
ARRIS PROPRIETARY — All Rights Reserved
CLI-439
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf auto-delete-neighbor Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Automatically deletes the neighbors when adjacency is lost. To halt the auto deletion of neighbors when adjacency is lost, use the [no] option.
Syntax
configure interface cable-mac ip ospf auto-delete-neighbor [no]
Parameter
CLI-440
Definition
The MAC identifier.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf cost Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Specifies the cost of sending a packet on an interface. To disable OSPF cost, use the [no] option.
Syntax
configure interface cable-mac ip ospf cost [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Link state metric with value range from 0 to 65535
ARRIS PROPRIETARY — All Rights Reserved
CLI-441
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf dead-interval Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the interval at which hello packets must not be seen before neighbors declare the router down. To disable OSPF dead-interval, use the [no] option. In OSPF operation the dead interval must be greater than the hello interval. It is recommended that the dead interval be set to a value greater than two times the hello interval. Defaults:
Syntax
hello interval = 10 seconds; dead interval = 40 seconds.
configure interface cable-mac ip ospf dead-interval [no]
Parameter
Definition
The MAC identifier. Link state metric with value range from 0 to 65535. Default = 40.
Fast Hello Functionality — When the dead interval is set to one second, Fast Hello timers are used. The ospfPmIfFastHelloMultiplier MIB object is used to determine the hello interval instead of the configured hello interval value. This object determines the number of OSPF HELLO packets that should be sent within one second. The default value is 5 packets and is not configurable. Thus, if you set the dead interval to one second, then you automatically change the hello interval to 200 ms. CAUTION
Any user wishing to enable Fast Hello functionality must first contact ARRIS Technical Support to determine if it is feasible for his/her site. Changing the dead interval to any value greater than one second disables the Fast Hello timers. The ospfPmIfFastHelloMultiplier MIB object is no longer used.
CLI-442
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf hello-interval Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Specifies the interval between hello packets that the software sends on the interface. To disable the OSPF hello-interval, use the [no] option.
Syntax
configure interface cable-mac ip ospf hello-interval [no]
Parameter
Issue 2.0
Definition
The MAC identifier. Hello interval in seconds from 1 to 65535. Default = 10.
ARRIS PROPRIETARY — All Rights Reserved
CLI-443
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf message-digest-key * md5 Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Configures the OSPF md5 key chain. To remove the above md5 key chain, use the [no] option.
Syntax
configure interface cable-mac ip ospf message-digest-key md5 [no]
Parameter
CLI-444
Definition
The MAC identifier. The md5 key-id The password for the md5
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf network Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Configures the OSPF network type to a type other than the default for a given media. To reset the OSPF network type back to the default, use the [no] option.
Syntax
configure interface cable-mac ip ospf network [no]
Parameter
Issue 2.0
Definition
The MAC identifier.
This is the network type. Valid types are broadcast and point-to-point.
ARRIS PROPRIETARY — All Rights Reserved
CLI-445
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac * ip ospf priority Default Access Level
Mode
Privileged – 15
Interface Cable-mac Configuration
Purpose
Sets the router priority. To disable OSPF priority, use the [no] option.
Syntax
configure interface cable-mac ip ospf priority [no]
Parameter
CLI-446
Definition
The MAC identifier.
Definition
RCM slot number/gigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Descriptive information, e.g., identifies area served. Text is limited to 32 characters.
ARRIS PROPRIETARY — All Rights Reserved
CLI-551
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * duplex Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
By default, the RCM Gigabit Ethernet ports are set to auto-negotiate. This command sets the operating mode to full duplex, half duplex or auto negotiate.
Syntax
configure interface gigabitethernet / {full | half | auto} duplex
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
{full | half | auto}
CLI-552
Sets the duplex mode to full duplex, half duplex or auto-negotiate. The RCM Gigabit Ethernet port is set to auto-negotiate.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * encapsulation dot1q Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the encapsulation type for the specified interface to Q-tag, as defined by IEEE 802.1Q. To return to default settings, use the [no] option.
Syntax
configure interface gigabitethernet / encapsulation dot1q [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Q-tag as defined by IEEE 802.1Q
ARRIS PROPRIETARY — All Rights Reserved
CLI-553
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * encapsulation dot1q * priority Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Defines the 802.1p priority bits on the egress. To return to default settings, use the [no] option.
Syntax
configure interface gigabitethernet / encapsulation dot1q priority [] [iptos] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Q-tag as defined by IEEE 802.1Q
[]
Fixed priority value
[iptos]
Maps IP TOS precedence to priority bits
CLI-554
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * encapsulation no Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Removes the encapsulation type for the specified interface, as defined by IEEE 802.1Q
Syntax
configure interface gigabitethernet
/
encapsulation no
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-555
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * flowcontrol receive Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the parameters to receive flow control information.
Syntax
configure interface gigabitethernet / flowcontrol receive no
Parameter
Definition
RCM slot number/gigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
desired
CLI-556
Directs that an auto negotiation of flow control take place with preference to process Pause frames (The port will process flow control if the far end supports/sends it).
on
Directs the specified port to be enabled to process flow control.
off
Directs the specified port to be disabled from processing flow control to the far end.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * flowcontrol send Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the parameters to send flow control information.
Syntax
configure interface gigabitethernet / flowcontrol send no
Parameter
Definition
RCM slot number/gigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
desired
Issue 2.0
Directs that an auto negotiation of flow control take place with a preference to send Pause frames (the port will send flow control to the far end if the far end supports it).
on
Directs the specified port to be enabled to send flow control.
off
Directs the specified port to be disabled from sending flow control to the far end.
ARRIS PROPRIETARY — All Rights Reserved
CLI-557
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip access-group Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Creates the network side data plane ACLs. This command is only supported for RCM physical interfaces and can be entered one time for an interface in each direction. If it is entered a second time, then the acl-index will replace the one that was previously entered. NOTE If the ACL referred to by acl-index does not exist, then all packets are passed. If the ACL referred to by acl-index does exist, and a packet does not match any of the entries in the ACL, then that packet will be dropped. To disable ACL packet filtering for a specified interface, use [no] option of the command. NOTE This only removes the interface filtering information. Any ACLs that are referred to by the access-group command are unaffected.
Syntax
configure interface gigabitethernet / ip access-group [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-558
The number assigned to a new ACL or the number for an existing ACL. Valid range is 1 to 99 for a standard access list and 100-199 for an extended access list. Specifies inbound or outbound
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip address Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Creates the virtual interface and assigns the IP address and mask of the virtual interface associated with the default route. To deletes a virtual router interface from the specified virtual router, use the [no] option of the command. All primary and secondary IP addresses for the interface are also deleted if a [secondary] is not specified. If a [secondary] is specified, then only the secondary IP address/mask is deleted and the virtual interface remains. NOTE Some subnets are reserved for CMTS Internal Processor Communications (IPC). No interfaces may be configured for the following subnets: 100.0.0.x 100.0.1.x 100.0.2.x 1.1.0.x 1.1.1.x
Syntax
configure interface gigabitethernet /
ip
address [secondary] [description] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
The IP address of the interface The IP mask associated with the interface
[secondary]
Secondary IP address or mask
[description]
Comment or description to help you remember what is attached to the specified interface.
ARRIS PROPRIETARY — All Rights Reserved
CLI-559
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip directed-broadcast Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Enables IP directed-broadcast for this interface. To disable IP directed-broadcast, use the [no] option.
Syntax
configure interface gigabitethernet /
ip
directed-broadcast [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>[
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-560
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Enables IGMP on the specified interface. To disable the IGMP on the interface, use the [no] option.
Syntax
configure interface gigabitethernet / ip igmp [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-561
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp backup-proxy-interface Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the IGMP backup proxy interface for the specified interface. To disable the IGMP backup proxy on the interface, use the [no] option.
Syntax
configure interface gigabitethernet / ip igmp backup-proxy-interface [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /[
CLI-562
Slot/port[.vrf_name]
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp host-robustness Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the IGMP host robustness.
Syntax
configure interface gigabitethernet / ip igmp host-robustness
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Robustness number. Valid range is 1-255
ARRIS PROPRIETARY — All Rights Reserved
CLI-563
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp host-version Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the IGMP host version.
Syntax
configure interface gigabitethernet / ip igmp host-version
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-564
Version number. Valid range is 1-3
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp join-group Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Enables joining a multicast group locally. To disable joining a local multicast group, use the [no] option.
Syntax
configure interface gigabitethernet / ip igmp join-group [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
SSM source IP address
ARRIS PROPRIETARY — All Rights Reserved
CLI-565
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp join-group * source Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Enables joining a multicast group locally. To disable joining a local multicast group, use the [no] option.
Syntax
configure interface gigabitethernet / ip igmp join-group source [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-566
IP address SSM source IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp last-member-query-interval Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the last member query interval.
Syntax
configure interface gigabitethernet / ip igmp last-member-query-interval
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Last member query interval (tenths of seconds)
ARRIS PROPRIETARY — All Rights Reserved
CLI-567
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp multicast-static-only Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets an IGMP enabled interface to only have static multicast traffic. To remove static-only from IGMP enabled interface, use the [no] option.
Syntax
configure interface gigabitethernet / ip igmp multicast-static-only [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-568
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp proxy-interface * Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the proxy interface (must be an RCM interface). To remove the proxyinterface, use the [no] option.
Syntax
configure interface gigabitethernet / ip igmp proxy-interface
* [gigabitethernet |
tengigiabitethernet ] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-569
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp query-interval Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the query interval.
Syntax
configure interface gigabitethernet / ip igmp query-interval
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-570
Query interval (seconds)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp query-max-response-time Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the query maximum response time.
Syntax
configure interface gigabitethernet / ip igmp query-max-response-time
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Query max response time (tenths of seconds)
ARRIS PROPRIETARY — All Rights Reserved
CLI-571
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp robustness Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the robustness.
Syntax
configure interface gigabitethernet / ip igmp robustness
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-572
Defines the number of messages lost tolerance level. The valid range of values is 1 to 255. Default is set at 2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp static-group Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Statically adds membership to an IP multicast group on an IP virtual interface. To remove membership to an IP multicast group on an IP virtual interface, use the [no] option.
Syntax
configure interface gigabitethernet / ip igmp static-group [source ] [no]
Parameter
Issue 2.0
Definition
RCM slot number/gigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is / Multicast group IP address. Qualified domain name IPv4 address
ARRIS PROPRIETARY — All Rights Reserved
CLI-573
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp static-group * source Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Allows you to join a multicast group on the specified port. To leave a specific multicast group, use the [no] option.
Syntax
configure interface gigabitethernet / ip igmp static-group source [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-574
The multicast group IP address Source Specific Multicast (SSM) source address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip igmp version Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the IGMP router version.
Syntax
configure interface gigabitethernet / ip igmp version
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Version number. Valid range is 1-3
ARRIS PROPRIETARY — All Rights Reserved
CLI-575
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf authentication key Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Assigns a password to be used by neighboring routers that are using the OSPF simple password authentication. To disable OSPF authentication key, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf authentication key [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-576
Password assigned
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf authentication key-chain Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Specifies the set of keys that can be used on this interface. To disable OSPF authentication key-chain, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf authentication key-chain [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Name of the key chain used on this interface
ARRIS PROPRIETARY — All Rights Reserved
CLI-577
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf auto-delete-neighbor Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Automatically deletes the neighbors when adjacency is lost.
Syntax
configure interface gigabitethernet / ip ospf auto-delete-neighbor
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-578
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf cost Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Specifies the cost of sending a packet on an interface. To disable OSPF authentication cost, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf cost [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Link state metric with value range from 0 to 65535
ARRIS PROPRIETARY — All Rights Reserved
CLI-579
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf dead-interval Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the interval at which hello packets must not be seen before neighbors declare the router down. To disable OSPF dead-interval, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf dead-interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-580
Dead interval in seconds from 0 to 2147483647
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf graceful-restart restart-helper Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Enables the Graceful Restart Helper and allows the receipt of opaque LSAs. To disable the Graceful Restart Helper, use the NO option.
Syntax
configure interface gigabitethernet / ip ospf graceful-restart restart-helper [no]
Parameter
/
Issue 2.0
Definition
RCM slot number/gigabitEthernet port number. Valid range for the C4 CMTS is 17-18; valid range for the C4c CMTS is 17.
ARRIS PROPRIETARY — All Rights Reserved
CLI-581
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf graceful-restart timeout Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the maximum grace period the CMTS will act as a helper for a router. To reset the timeout to the default range, use the NO option. NOTE The graceful-restart timeout can not be set to a value less than the current dead-interval.
Syntax
configure interface gigabitethernet / ip ospf graceful-restart timeout [no]
Parameter
/
CLI-582
Definition
RCM slot number/gigabitEthernet port number. Valid range for the C4 CMTS is 17-18; valid range for the C4c CMTS is 17. The timeout is in seconds. Valid range is 0-1800 seconds; default is 40.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf hello-interval Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Specifies the interval between hello packets that the software sends on the interface. To disable the OSPF hello-interval, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf hello-interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Hello interval in seconds from 1 to 65535
ARRIS PROPRIETARY — All Rights Reserved
CLI-583
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf message-digest-key * md5 Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the OSPF md5 key chain. To remove the md5 key chain on the GigE RCM, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf message-digest-key md5 [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
The md5 key-id
The password for the md5
Example
To add the md5 key chain-id of 5 with the password set as ‘password’ on the GigE RCM in slot 17 port 0, type the following command: C4#
configure interface gigabitethernet 17/0 ip ospf message-digest-key 5 md5 password The following is an example of the output returned by the system: OSPF IF entry 10.126.96.1 is md5 key added
CLI-584
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf network Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the OSPF network type to a type other than the default for a given media. To reset the OSPF network type back to the default, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf network [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
This is the network type. Valid types are broadcast and point-to-point.
ARRIS PROPRIETARY — All Rights Reserved
CLI-585
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf priority Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the router priority. To disable OSPF priority, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf priority [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-586
8-bit unsigned number that specifies the priority from 0 to 255.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf retransmit interval Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Specifies the time between link-state advertisement (LSA) retransmissions for adjacencies belonging to the interface. To disable OSPF retransmit interval, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf retransmit interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Time in seconds between transmissions from 0 to 3600
ARRIS PROPRIETARY — All Rights Reserved
CLI-587
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip ospf transmit-delay Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the estimated time it takes to transmit a link state update. To disable OSPF transmit-delay, use the [no] option.
Syntax
configure interface gigabitethernet / ip ospf transmit-delay [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-588
Seconds required to transmit a link state update from 0 to 3600
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip pim dr-priority Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the PIM Designated Router priority on the specified interface. To reset the priority, use the [no] option.
Syntax
configure interface gigabitethernet /
ip pim
dr-priority [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
DR priority, preference is given to larger value
ARRIS PROPRIETARY — All Rights Reserved
CLI-589
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip pim hello-holdtime Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the PIM router neighbor hold time option in the Hello message. To reset the hold time, use the [no] option.
Syntax
configure interface gigabitethernet /
ip pim
hello-holdtime [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-590
Hold time in seconds
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip pim message-holdtime Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the PIM router message (prune/join) hold time. To reset the hold time, use the [no] option.
Syntax
configure interface gigabitethernet /
ip pim
message-holdtime [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Prune/join message holdtime in seconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-591
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip pim message-interval Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the PIM router message (prune/join) interval. To reset the interval, use the [no] option.
Syntax
configure interface gigabitethernet /
ip pim
message-interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-592
Prune/join message interval in seconds
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip pim query-interval Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the PIM router query (hello) interval. To reset the interval, use the [no] option.
Syntax
configure interface gigabitethernet /
ip pim
query-interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Query interval in seconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-593
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip pim sparse-mode-ssm Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Enables PIM sparse-mode SSM operation on a network-side interface. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ip pim
sparse-mode-ssm [passive] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[passive]
CLI-594
Runs PIM passively (no sent/rcvd messages)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip policy route-map-policy Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Enables policy routing. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ip
policy route-map-policy [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Route map name
ARRIS PROPRIETARY — All Rights Reserved
CLI-595
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip rip authentication key Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the authentication key. Every RIP message sent on this interface will contain this key and every incoming message received will be validated based on it having this key. To reset the authentication key, use the [no] option.
Syntax
configure interface gigabitethernet /
ip rip
authentication key [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-596
A 1-16 character text string used for authentication.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip rip authentication key-chain Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Specified the set of keys that can be used on the specified interface. To remove the set of keys used on the specified interface, use the [no] option.
Syntax
configure interface gigabitethernet /
ip rip
authentication key-chain [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
A 1-16 character text string used for authentication.
ARRIS PROPRIETARY — All Rights Reserved
CLI-597
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip rip authentication mode Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the RIP authentication mode on the specified interface. By default, it is disabled on each interface. To reset the authentication mode to text mode, use the [no] option.
Syntax
configure interface gigabitethernet /
ip rip
authentication mode [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-598
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip rip authentication mode md5 Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the RIP authentication mode keyed MD5 authentication. By default, it is disabled on each interface. To disable the authentication mode, use the [no] option.
Syntax
configure interface gigabitethernet /
ip rip
authentication mode md5 [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-599
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip rip authentication mode text Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the RIP authentication mode to clear text authentication. By default, it is disabled on each interface. To disable the authentication mode, use the [no] option.
Syntax
configure interface gigabitethernet /
ip rip
authentication mode text [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-600
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip rip default-metric Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the RIP metric for the default route. To return to default settings, use the [no] option.
Syntax
configure interface gigabitethernet /
ip rip
default-metric [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Default metric is 0. Valid range is 0 or 15. If the default route metric is set to 0, the default route is not advertised.
ARRIS PROPRIETARY — All Rights Reserved
CLI-601
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip router isis Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Enables IS-IS routing for IP on the specified interface. To disable IS-IS for IP, use the [no] option.
Syntax
configure interface gigabitethernet /
ip
router isis [no] Parameter
Definition
The slot in which the targeted module resides. The slot must contain an RCM. Valid slot value is 17 or 18.
CLI-602
The Gigabit Ethernet port value on the RCM is 0-9. The valid subinterface numbers are 0 to 254.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip scm access-group Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Applies an ACL to a specific physical interface. An ACL is applied to a physical port and therefore is active on all VRFs associated with the physical port. To clear or reset the ACL association, use the [no] option.
Syntax
configure interface gigabitethernet / ip scm access-group [] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Access list number from 1-99.
ARRIS PROPRIETARY — All Rights Reserved
CLI-603
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip unreachables Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the GigEthernet interface ICMP unreachables as always sent. To reset the ICMP unreachables, use the [no] option.
Syntax
configure interface gigabitethernet /
ip
unreachables [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-604
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 address Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the GigabitEthernet interface IPv6 address. To remove, use the [no] option.
Syntax
configure interface gigabitethernet / address [eui-64] [link-local]
Parameter
ipv6
[no]
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
IPv6 address / prefix.
[eui-64]
Configures the site-local and global IPv6 addresses with an interface identifier (ID) in the low-order 64 bits of the IPv6 address.
[link-local]
Issue 2.0
Overrides the automatically generated EUI-64 link local address.
ARRIS PROPRIETARY — All Rights Reserved
CLI-605
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 enable Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Enables the GigabitEthernet interface for IPv6 processing and configures the default link-local address. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
enable [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-606
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 icmp param-problem Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Enables transmission of ICMP6 Parameter problem messages. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
icmp param-problem [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
The VRF name
ARRIS PROPRIETARY — All Rights Reserved
CLI-607
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 icmp too-big Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Enables transmission of ICMP6 too big messages. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
icmp too-big [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-608
The VRF name
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 icmp unreachables Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets all interface ICMP unreachables as always sent. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
icmp unreachables [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
The VRF name
ARRIS PROPRIETARY — All Rights Reserved
CLI-609
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 mtu Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the maximum (MTU) size in bytes for IPv6 traffic on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
mtu [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-610
Maximum size of a packet (in bytes) including the IP header.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd dad attempts Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the number of neighbor solicitation messages sent to detect duplicate addresses. To restore the default setting, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd dad attempts [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Number of neighbor solicitation messages.
ARRIS PROPRIETARY — All Rights Reserved
CLI-611
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd managed-config-flag Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the ‘managed address configuration’ flag in IPVv6 router advertisements on the specified interface. Setting this flag indicates that the cable modems and CPE devices should use DHCPv6 to obtain their IPv6 addresses. To restore the default setting, use the [no] option of the command.
Syntax
configure interface gigabitethernet / ipv6 nd managed-config-flag [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-612
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd ns-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the minimum interval for neighbor solicitation re-transmissions on the specified interface. Use the ‘no’ option to not specify a value for Retransmit Time.
Syntax
configure interface gigabitethernet / ipv6 nd ns-interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Interval in milliseconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-613
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd other-config-flag Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the ‘other stateful configuration’ flag in IPVv6 router advertisements on the specified interface. If the flag is set, this means that the CMs and CPE devices should use DHCPv6 to obtain information other than IPv6 addresses. To restore the default setting, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd other-config-flag [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-614
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd prefix Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the lifetime prefixes for the IPv6 advertisements. To remove the prefix from the advertisements, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd prefix [] [ [off-link] [no-autoconfig] [autoconfig] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[off-link] [no-autoconfig] [autoconfig]
Issue 2.0
IPv6 address Valid lifetime in seconds. Preferred lifetime in seconds. Indicates prefix is not locally reachable by hosts and must be routed. Indicates that the host may not use prefix for auto-configured IPv6 addresses. Indicates that the host may use prefix for auto-configured IPv5 addresses.
ARRIS PROPRIETARY — All Rights Reserved
CLI-615
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd prefix * at Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the lifetime and advertisements for prefix along with the date and time the prefix expires on the specified interface. To restore the default setting, use the [no] option.
Syntax
configureinterface gigabitethernet /
ipv6 nd
prefix at [off-link] [no-autoconfig] [autoconfig] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
IPv6 address
[off-link]
Indicates prefix is not locally reachable by hosts and must be routed.
[no-autoconfig] [] [off-link] [no-autoconfig] [autoconfig]
CLI-616
Indicates that the host may not use prefix for auto-configured IPv6 addresses. Valid date in year:month:day:hour:minute:second Preferred date in the format: year:month:day:hour:minute:second Indicates prefix is not locally reachable by hosts and must be routed. Indicates that the host may not use prefix for auto-configured IPv6 addresses. Indicates that the host may use prefix for auto-configured IPv5 addresses.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd prefix * infinite Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the valid lifetime not to expire for prefix on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd prefix infinite [off-link] [no-autoconfig] [autoconfig] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
IPv6 address
[off-link]
Indicates prefix is not locally reachable by hosts and must be routed.
[no-autoconfig] [autoconfig]
Issue 2.0
Indicates that the host may not use prefix for auto-configured IPv6 addresses. Indicates that the host may use prefix for auto-configured IPv5 addresses.
ARRIS PROPRIETARY — All Rights Reserved
CLI-617
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd prefix * no-advertise Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Indicates that this prefix will not be sent in router advertisements on the specified interface. To indicate that the host may not use prefix for auto-configured IPv6 addresses, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd prefix no-advertise [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-618
IPv6 address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd ra interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the interval for the router advertisement beacon on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd ra interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Maximum interval between IPv6 RA transmissions in seconds Minimum interval between IPv6 RA transmissions in seconds. Default is 3 seconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-619
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd ra lifetime Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the lifetime for the router advertisements on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd ra lifetime {0 | } [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
{0 | }
CLI-620
Lifetime, in seconds, of router advertisements. Zero indicates the CMTS is not the default router.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd ra reachable-time Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the amount of time a neighbor is considered ‘reachable’ after last confirmation.To reset to the default time, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd ra reachable-time [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Milliseconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-621
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd ra suppress Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Suppresses the router advertisements on the specified interface. To enable the router advertisements on the specified interface, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd ra suppress [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-622
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 nd reachable-time Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the amount of time the neighbor is considered “reachable” after the last confirmation. To return to the default, use the [no] option.
Syntax
configure interface gigabitethernet / ipv6 nd reachable-time [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Time in milliseconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-623
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Enables OSPF on the specified cable interface. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-624
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf area Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Enables OSPF for IPv6 on the specified cable interface. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf area [instance ] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
OSPF area ID. It can be specified as either an IP address or decimal value.
[instance ]
Integer. Controls selection of other routers on this link as your neighbors.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-625
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf cost Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the cost of sending a packet on the specified interface. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf cost [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-626
Link state metric.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf dead-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the interval at which hello packets must not be seen before neighbors declare the router down. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf dead-interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Dead interval in seconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-627
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf hello-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Specifies the interval between hello packets that the software sends on the specified interface. To disable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf hello-interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-628
Hello interval in seconds.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf mtu-ignore Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Disables checking the MTU size on incoming DBD packets. To enable, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf mtu-ignore [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-629
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf network Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the OSPF network type to a type other than the default for a given media. To return to the default, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf network [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-630
Network type. Current type supported is broadcast or point-to-point.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf priority Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the router priority. To reset to the default value, use the [no] option.
Syntax
configure interfacegigabitethernet /
ipv6
ospf priority [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Router priority.
ARRIS PROPRIETARY — All Rights Reserved
CLI-631
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf retransmit-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Specifies the time between link-state advertisement (LSA) retransmissions for adjacencies belonging to the interface. To reset to the default, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf retransmit-interval [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-632
Time in seconds between transmissions.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 ospf transmit-delay Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Sets the estimated time it takes to transmit a link state update packet on the interface. To return to the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
ospf transmit-delay [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Seconds required to transmit a link state update.
ARRIS PROPRIETARY — All Rights Reserved
CLI-633
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 router isis Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Enables IS-IS routing for IP on the specified interface. To disable IS-IS for IP, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
router isis [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-634
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ipv6 traffic-filter Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Configures the CMTS data plane filter ACL application for a specified interface/direction. To remove, use the [no] option.
Syntax
configure interface gigabitethernet /
ipv6
traffic-filter [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
IPv6 access list name.
Designates inbound or outbound packets
ARRIS PROPRIETARY — All Rights Reserved
CLI-635
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * ip vrf forwarding Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Allows the C4 CMTS System Administrator to move a gigabitethernet interface to the specified VRF.
Syntax
configure interface gigabitethernet / ip vrf forwarding
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-636
The VRF name
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis authentication key-chain Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the IS-IS authentication for LSPs.To reset the circuit type, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
authentication key-chain [] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Name of the key-chain Specifies the type of adjacencies to be formed on this interface. Valid range is level-1 or level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-637
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis authentication mode Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the IS-IS authentication mode for LSPs. To reset the circuit type, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
authentication mode [] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-638
Choose either md5 or plain text Specifies the type of adjacencies to be formed on this interface. Valid range is level-1 or level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis circuit-type Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the level of adjacency for the specified interface. The Level 1 adjacency may be established if there is at least one area address in common between this system and its neighbors. To reset the circuit type, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
circuit-type [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Specifies the type of adjacencies to be formed on this interface. Valid range is level-1, level-1-2, or level-2. If no value is specified, then value is set to level-1-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-639
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis csnp-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the complete sequence number PDUs (CSNPs) interval for the specified interface. This command only applies to the designated router on the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
csnp-interval [] [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-640
Interval of time between transmission of CSNPs on multiaccess networks. This interval only applies for the designated router. Current default is 10 seconds. Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis ds-hello-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the length of time in milliseconds between hello packets for the specified interface when it is DS. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
ds-hello-interval [] [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Milliseconds between hello packets. Valid range is 10-120000. Default value is 1000 milliseconds.
Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-641
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis hello-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Computes the hello interval based on the hello multiplier so that the resulting hold time is 1 second.
Syntax
configure interface gigabitethernet /
isis
hello-interval [minimal ] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-642
Specifies the milliseconds between hello packets (before multiplier) Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis hello-multiplier Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the number of IS-IS hello packets a neighbor must miss before the router declares the neighbor down on the specified interface. This determines how quickly a failed neighbor is detected so that routes can be recalculated. The advertised hold time in IS-IS hello packets will be set to the hello multiplier times the hello interval. Neighbors will declare an adjacency to this router down after not having received any IS-IS hello packets during the advertised hold time. The hold time can be set on a per-interface basis and can be different between different routers in one area. To restore the default value, use the [no] option. NOTE Using a smaller hello multiplier will give fast convergence, but can result in more routing instability. Incrementing the hello multiplier to a larger value will help stabilize the network. Never configure a hello multiplier lower than the default value of 3.
Syntax
configure interface gigabitethernet /
isis
hello-multiplier [] [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
This is an integer value from 2 to 100. The advertised hold time in IS-IS hello packets will be set to the hello multiplier times the hello interval. Neighbors will declare an adjacency to this router down after not having received any IS-IS hello packets during the advertised hold time. The default value is 3 Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-643
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis ipv6 metric Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Changes the default metric of 10. Use the [no] form of the command to return to the default metric.
Syntax
configure interface gigabitethernet / isis ipv6 metric [level-1 | level-2] [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-644
Metric associated with the redistributed routes. Import as either level 1 or level 2 routes.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis lsp-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the time delay between successive LSPs for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
lsp-interval [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Milliseconds between successive LSPs. Valid range is 1 to 65535.
ARRIS PROPRIETARY — All Rights Reserved
CLI-645
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis lsp-mtu Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the maximum packet size of LSPs for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
lsp-mtu [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-646
Maximum packet size of LSPs for specified interface. Valid range is 11497. Default value is 1492.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis metric Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the default metric for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
metric [] [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Integer. Valid range is 1-63. Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-647
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis priority Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the priority of the designated routers for the specified interface. The priority is used to determine which router on a LAN will be the designated router. The priorities are advertised in the hello packets. The router with the highest priority will become the Designated Intermediate System (DIS). In the case of equal priorities, the highest MAC address breaks the tie. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
priority [] [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Sets the priority value of a router and is a number from 0 to 127. The default value is 64.
[]
Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
CLI-648
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis protocol shutdown Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Disables the administrative state of IS-IS on the specified interface. To enable the administrative state of IS-IS on the specified interface, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
protocol shutdown [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-649
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis retransmit-interval Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Configures the maximum rate between LSP retransmits for the specified interface. This command is useful in very large networks with many LSPs and many interfaces to control LSP retransmission traffic. This command controls the rate at which LSPs can be resent on the interface. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
retransmit-interval [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-650
Minimum seconds before retransmitting. Valid range is 1 to 300.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis small-hello Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Allows unpadded hello packets for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
small-hello [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-651
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * isis wide-metric Default Access Level
Mode
Privileged – 15
GigEthernet interface configuration
Purpose
Allows wide metrics for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface gigabitethernet /
isis
wide-metric [] [no] Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-652
Metric value Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * restore .
Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Restores the Gigabit Ethernet card in the specified slot and port.
Syntax
configure interface gigabitethernet / restore
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-653
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * shutdown Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Takes the specified Gigabit Ethernet Router Control Module (or port) out of service.To restore the specified Gigabit Ethernet Router Control Module (or port, if specified), use the [no] option.
Syntax
configure interface gigabitethernet / shutdown [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-654
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitethernet * speed Default Access Level
Mode
Privileged – 15
Gigabit Ethernet interface configuration
Purpose
Sets the speed of the gigabit ethernet interface.
Syntax
configure interface gigabitethernet / speed [10 | 100 | 1000 | auto]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[10 | 100 | 1000 | auto]
Issue 2.0
Designates either 10, 100, 1000 Mbps or auto.
ARRIS PROPRIETARY — All Rights Reserved
CLI-655
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * description Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Allows you to add a comment or a description to help you remember what is attached to this interface. To remove the description, use the [no] option.
Syntax
configure interface loopback description [no]
Parameter
CLI-656
Definition
The Loopback interface number. Valid range is 0 or 15. Typically, 0 is used for the SCM. Descriptive information, e.g., identifies area served. Text is limited to 32 characters.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * ip address Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Configures the loopback IP address typically associated with the active System Control Module (SCM). The C4 CMTS supports 16 unique loopback interfaces. This interface is now required for OSPF. Upon creation of a loopback interface, it will be associated with a default VRF. See command, configure interface loopback ip vrf forwarding. To disable the loopback interface, use the [no] option.
Syntax
configure interface loopback ip address [description] [no]
Parameter
Definition
The Loopback interface number. Valid range is 0-15. Typically, 0 is used for the SCM.
The IP address of the loopback interface
[description]
Comment or description to help you remember what is attached to the specified interface.
Related Command(s)
configure interface loopback * ip ospf cost configure interface loopback * isis wide-metric configure interface loopback * isis wide-metric configure interface loopback * description show ip interface show ip ospf interface NOTE Some subnets are reserved for CMTS Internal Processor Communications (IPC). No interfaces may be configured for the following subnets: 100.0.0.x 100.0.1.x 100.0.2.x 1.1.0.x 1.1.1.x
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-657
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * ip ospf cost Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Defines the OSPF cost to reach the loopback interface. No other OSPF parameters are configurable. To disable the loopback interface, use the [no] option.
Syntax
configure interface loopback ip ospf cost [no]
Parameter
Definition
The Loopback interface number. Valid range is 0-15. The cost to reach the loopback interface. Valid range is 0-65535.
Related Command(s)
configure interface loopback * ip address configure interface loopback * isis wide-metric configure interface loopback * isis wide-metric show ip ospf interface
CLI-658
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * ipv6 address Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Enables ARP forwarding for this virtual router interface. To remove the IPv6 address identified in the command from the interface, use the [no] option.
Syntax
configure interface loopback ipv6 address [eui-64] [link-local] [no]
Parameter
[eui-64] [link-local]
Issue 2.0
Definition
The Loopback interface number. Valid range is 0-15. Address of interface Configures site-local and global IPv6 addresses with an interface identifier (ID) in the low-order 64 bits of the IPv6 address. Overrides the automatically generated EUI-64 link local address
ARRIS PROPRIETARY — All Rights Reserved
CLI-659
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * ipv6 enable Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Enables the specified interface for IPv6 processing. To remove all the IPv6 addresses from the interface, use the [no] option.
Syntax
configure interface loopback ipv6 enable [no]
Parameter
CLI-660
Definition
The Loopback interface number. Valid range is 0-15.
The MAC domain number (valid numbers are 0 or 1)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * ipv6 ospf area Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Enables OSPF for IPv6 on the specified loopback interface. To disable, use the [no] option.
Syntax
configure interface loopback ipv6 ospf area [instance ] [no]
Parameter
Definition
The Loopback interface number. Valid range is 0-15.
OSPF area ID. It can be specified as either an IP address or decimal value.
[instance ]
Integer. Controls selection of other routers on this link as your neighbors.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-661
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * ipv6 ospf cost Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Configures the cost of sending a packet on the specified loopback interface. To disable, use the [no] option.
Syntax
configure interface loopback ipv6 ospf cost [no]
Parameter
CLI-662
Definition
The Loopback interface number. Valid range is 0-15.
Link state metric.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * ip vrf forwarding Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Allows the C4 CMTS System Administrator to move a loopback interface to the specified VRF. NOTE A loopback interface can not be further subdivided into sub-interfaces.
Syntax
configure interface loopback ip vrf forwarding
Parameter
Definition
The Loopback interface number. Valid range is 0-15. The VRF name
Related Command(s)
configure interface loopback * ip ospf cost configure interface loopback * ip address configure interface loopback * isis wide-metric configure interface loopback * description
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-663
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * isis ipv6 metric Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Configures the IPv6 default metric for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface loopback isis ipv6 metric [] Parameter
[]
CLI-664
Definition
The Loopback interface number. Valid range is 0-15. Integer. Valid range is 1-63. Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * isis ipv6 wide-metric Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Configures the IPv6 wide metrics for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface loopback isis ipv6 wide-metric [] Parameter
[]
Issue 2.0
Definition
The Loopback interface number. Valid range is 0-15. Metric value Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-665
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * isis metric Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Configures the default metric for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface loopback isis metric [] Parameter
[]
CLI-666
Definition
The Loopback interface number. Valid range is 0-15. Integer. Valid range is 1-63. Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * isis wide-metric Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Allows wide metrics for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface loopback isis wide-metric [] Parameter
[]
Issue 2.0
Definition
The Loopback interface number. Valid range is 0-15. Metric value Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-667
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface loopback * shutdown Default Access Level
Mode
Privileged – 15
Loopback interface configuration
Purpose
Shuts down the loopback interface. To restore the loopback interface, use the [no] option.
Syntax
configure interface loopback shutdown [no]
Parameter
Definition
The Loopback interface number. Valid range is 0-15.
Related Command(s)
configure interface loopback * ip ospf cost configure interface loopback * isis wide-metric configure interface loopback * ip address configure interface loopback * description
CLI-668
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface null Default Access Level
Mode
Privileged – 15
Null interface configuration
Purpose
Configures the null interface.
Syntax
configure interface null
Parameter
Issue 2.0
Definition
Only valid number is 0 (zero)
ARRIS PROPRIETARY — All Rights Reserved
CLI-669
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface null * ipv6 icmp unreachables Default Access Level
Mode
Privileged – 15
Null interface configuration
Purpose
Enables sending ICMP unreachable messages. To disable the ICMP unreachables, use the [no] option.
Syntax
configure interface null ipv6 icmp unreachables [no]
Parameter
CLI-670
Definition
Only valid number is 0 (zero)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface null * ip unreachables Default Access Level
Mode
Privileged – 15
Null interface configuration
Purpose
Enables sending ICMP unreachable messages. To reset the ICMP unreachables, use the [no] option.
Syntax
configure interface null ip unreachables [no]
Parameter
Issue 2.0
Definition
Only valid number is 0 (zero)
ARRIS PROPRIETARY — All Rights Reserved
CLI-671
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface system-controller * soft-switch Default Access Level
Mode
Privileged – 15
System controller interface configuration
Purpose
Performs a soft-switch of the Control Complex.
Syntax
configure interface system-controller soft-switch
CLI-672
Parameter
Definition
The chassis slot in which the targeted module resides. Valid values for the C4 CMTS are 19 and 20; valid value for the C4c CMTS is 19.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Allows you to enter the Ten Gigabit Ethernet interface configuration mode for the specified interface.
Syntax
configure interface tengigabitethernet /
Parameter
Definition
RCM slot number/tengigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-673
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * description Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Allows you to add a comment or a description to help you remember what is attached to this interface. To remove the description, use the [no] option.
Syntax
configure interface tengigabitethernet / description [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-674
Descriptive information, e.g., identifies area served. Text is limited to 32 characters.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * encapsulation dot1q Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the encapsulation type for the specified interface to Q-tag, as defined by IEEE 802.1Q. To return to default settings, use the [no] option.
Syntax
configure interface tengigabitethernet / encapsulation dot1q [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Q-tag as defined by IEEE 802.1Q
ARRIS PROPRIETARY — All Rights Reserved
CLI-675
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * encapsulation dot1q * priority Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Defines the 802.1p priority bits on the egress. To return to default settings, use the [no] option.
Syntax
configure interface tengigabitethernet / encapsulation dot1q priority [] [iptos] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Q-tag as defined by IEEE 802.1Q
[]
Fixed priority value
[iptos]
Maps IP TOS precedence to priority bits
CLI-676
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * encapsulation no Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Removes the encapsulation type for the specified interface, as defined by IEEE 802.1Q.
Syntax
configure interface tengigabitethernet
/
encapsulation no
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-677
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * flowcontrol receive Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the parameters to receive flow control information.
Syntax
configure interface tengigabitethernet
/
flowcontrol receive [no]
Parameter
Definition
RCM slot number/tengigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
desired
CLI-678
Directs that an auto negotiation of flow control take place with a preference to process Pause frames (the port will process flow control if the far end supports/sends it)
on
Directs the specified port to be enabled to process flow control.
off
Directs the specified port to be disabled from processing flow control to the far end.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * flowcontrol send Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the parameters to send flow control information.
Syntax
configure interface tengigabitethernet / flowcontrol send [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
desired
Issue 2.0
Directs that an auto negotiation of flow control take place with a preference to send Pause frames. (The port will send flow control to the far end if the far end supports it)
on
Directs the specified port to be enabled to send flow control.
off
Directs the specified port to be disabled from sending flow control to the far end.
ARRIS PROPRIETARY — All Rights Reserved
CLI-679
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * igmp static-group Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Allows the specified interface to join a multicast group on the specified port. To leave a specific multicast group, use the [no] option.
Syntax
configure interface tengigabitethernet / igmp static-group [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-680
The multicast group IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * igmp static-group * source Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Allows the specified interface to join a multicast group on the specified port. To leave a specific multicast group, use the [no] option.
Syntax
configure interface tengigabitethernet / igmp static-group source [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
The multicast group IP address
IP source address
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-681
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip access-group Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Creates the network side data plane ACLs. This command is only supported for RCM physical interfaces and can be entered one time for an interface in each direction. If it is entered a second time, then the acl-index will replace the one that was previously entered. NOTE If the ACL referred to by acl-index does not exist, then all packets are passed. If the ACL referred to by acl-index does exist, and a packet doe not match any of the entries in the ACL, then that packet will be dropped. To disable ACL packet filtering for a specified interface, use the [no] option. NOTE This only removes the interface filtering information. Any ACLs that are referred to by the access-group command are unaffected.
Syntax
configure interface tengigabitethernet / ip access-group [no]
Parameter
Definition
RCM slot number/tengigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-682
The number assigned to a new ACL or the number for an existing ACL. Valid range is 1 to 99 for a standard access list and 100-199 for an extended access list. Specifies inbound or outbound
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip address Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Creates the virtual interface and assigns the IP address and mask of the virtual interface associated with the default route. To delete a virtual router interface from the specified virtual router, use the [no] option. All primary and secondary ip addresses for the interface are also deleted if a [secondary] is not specified. If a [secondary] is specified, then only the secondary IP address/mask is deleted and the virtual interface remains. NOTE Some subnets are reserved for CMTS Internal Processor Communications (IPC). No interfaces may be configured for the following subnets: 100.0.0.x 100.0.1.x 100.0.2.x 1.1.0.x 1.1.1.x
Syntax
configure interface / ip address [description] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
The IP address to be assigned to the virtual interface associated with the default route.
The IP mask to be assigned to the virtual interface associated with the default route.
[description]
Comment or description to help you remember what is attached to the specified interface.
ARRIS PROPRIETARY — All Rights Reserved
CLI-683
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip directed-broadcast Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables IP directed-broadcast for this interface. To disable IP directed-broadcast, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
directed-broadcast [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-684
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip igmp Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables IGMP on the specified interface. To disable the IGMP on the interface, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
igmp [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-685
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip igmp access-group Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the IGMP group access group. Use the [no] version to remove.
Syntax
configure interface tengigabitethernet / ip igmp access-group [no]
Parameter
Definition
RCM slot number/tengigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-686
Multicast group IP address.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip igmp static-group Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Statically adds membership to an IP multicast group on an IP virtual interface. Use the [no] version to remove the membership.
Syntax
configure interface tengigabitethernet / ip igmp static-group source [no]
Parameter
Definition
RCM slot number/tengigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Multicast group IP address. Qualified domain name IPv4 address
ARRIS PROPRIETARY — All Rights Reserved
CLI-687
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip igmp static-group * source Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Allows you to join a multicast group on the specified port. To leave a specific multicast group, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
igmp static-group source [no]
Parameter
Definition
RCM slot number/tengigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-688
The multicast group IP address Source Specific Multicast (SSM) source address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf authentication-key Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Assigns a password to be used by neighboring routers that are using the OSPF simple password authentication. To disable OSPF authentication-key, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf authentication-key [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Password assigned
ARRIS PROPRIETARY — All Rights Reserved
CLI-689
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf authentication key-chain Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Specifies the set of keys that can be used on this interface. To disable the OSPF authentication key-chain, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf authentication key-chain [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-690
Name of the key chain used on this interface
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf auto-delete-neighbor Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Automatically delete neighbors when adjacency is lost. To disable, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf auto-delete-neighbor [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-691
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf cost Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Specifies the cost of sending a packet on an interface. To disable OSPF authentication cost, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf cost [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-692
Link state metric with value range from 0 to 65535
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf dead-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the interval at which hello packets must not be seen before neighbors declare the router down. To disable OSPF dead-interval, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf dead-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Dead interval in seconds from 0 to 2147483647
ARRIS PROPRIETARY — All Rights Reserved
CLI-693
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf graceful-restart restart-helper Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables the Graceful Restart Helper and allows the receipt of opaque LSAs. To disable the Graceful Restart Helper, use the NO option.
Syntax
configure interface tengigabitethernet / ip ospf graceful-restart restart-helper [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-694
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf graceful-restart-timeout Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the maximum grace period the CMTS will act as a helper for a router. To reset the timeout to the default range, use the NO option. NOTE The graceful-restart timeout can not be set to a value less than the current dead-interval.
Syntax
configure interface tengigabitethernet /
ip
ospf graceful-restart-timeout [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
The timeout is in seconds. Valid range is 0-1800 seconds; default is 40.
ARRIS PROPRIETARY — All Rights Reserved
CLI-695
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf hello-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Specifies the interval between hello packets that the software sends on the interface. To disable the OSPF hello-interval, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf hello-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-696
Hello interval in seconds from 1 to 65535
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf message-digest-key * md5 Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the OSPF md5 key chain. To remove the md5 key chain on the GigE RCM, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf message-digest-key md5 [no]
Parameter
Definition
RCM slot number/tengigabitEthernet port number.
/
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
The md5 key-id
The password for the md5
Example
To add the md5 key chain-id of 5 with the password set as ‘password’ on the GigE RCM in slot 17 port 0, type the following command: C4#
configure interface tengigabitethernet 17/0 ip ospf message-digest-key 5 md5 password The following is an example of the output returned by the system: OSPF IF entry 10.126.96.1 is md5 key added
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-697
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf network Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the OSPF network type to a type other than the default for a given media. To reset the OSPF network type back to the default, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf network [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-698
This is the network type. Valid types are broadcast and point-to-point.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf priority Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the router priority. To disable OSPF priority, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf priority [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
8-bit unsigned number that specifies the priority from 0 to 255.
ARRIS PROPRIETARY — All Rights Reserved
CLI-699
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf retransmit-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Specifies the time between link-state advertisement (LSA) retransmissions for adjacencies belonging to the interface. To disable OSPF retransmit interval, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf retransmit-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-700
Time in seconds between transmissions from 0 to 3600
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip ospf transmit-delay Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the estimated time it takes to transmit a link state update. To disable OSPF transmit-delay, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
ospf transmit-delay [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Seconds required to transmit a link state update from 0 to 3600
ARRIS PROPRIETARY — All Rights Reserved
CLI-701
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip pim dr-priority Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the PIM Designated Router priority on the specified interface. To reset the priority, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
pim dr-priority [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-702
DR priority, preference is given to larger value
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip pim hello-holdtime Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the PIM router neighbor hold time option in the Hello message. To reset the hold time, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
pim hello-holdtime [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Hold time in seconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-703
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip pim message-holdtime Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the PIM router message (prune/join) hold time. To reset the hold time, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
pim message-holdtime [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-704
Prune/join message holdtime in seconds
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip pim message-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the PIM router message (prune/join) interval. To reset the interval, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
pim message-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Prune/join message interval in seconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-705
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip pim query-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the PIM router query (hello) interval. To reset the interval, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
pim query-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-706
Query interval in seconds
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip pim sparse-mode-ssm Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables PIM sparse-mode SSM operation on a network-side interface. To disable, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
pim sparse-mode-ssm [passive] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[passive]
Issue 2.0
Runs PIM passively (no sent/rcvd messages)
ARRIS PROPRIETARY — All Rights Reserved
CLI-707
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip policy route-map-policy Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables policy routing.To disable, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
policy route-map-policy [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-708
Route map name
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip rip authentication key Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the authentication key. Every RIP message sent on this interface will contain this key and every incoming message received will be validated based on it having this key. To reset the authentication key, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
rip authentication key [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
A 1-16 character text string used for authentication.
ARRIS PROPRIETARY — All Rights Reserved
CLI-709
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip rip authentication key-chain Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Specified the set of keys that can be used on the specified interface. To remove the set of keys used on the specified interface, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
rip authentication key-chain [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-710
A 1-16 character text string used for authentication.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip rip authentication mode Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the RIP authentication mode on the specified interface. By default, it is disabled on each interface. To reset the authentication mode to text mode, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
rip authentication mode [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-711
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip rip authentication mode md5 Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the RIP authentication mode keyed MD5 authentication. By default, it is disabled on each interface. To disable the authentication mode, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
rip authentication mode md5 [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-712
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip rip authentication mode text Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the RIP authentication mode to clear text authentication. By default, it is disabled on each interface. To disable the authentication mode, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
rip authentication mode text [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-713
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip rip default-metric Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the RIP metric for the default route. To return to default settings, use the [no] option.
Syntax
configure interface tengigabitethernet / ip rip default-metric [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-714
Default metric is 0. Valid range is 0 or 15. If the default route metric is set to 0, the default route is not advertised.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip rip receive version Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the RIP version to receive. Currently, only RIP Version 2 packets are accepted on this interface. To disable receiving RIP V2 packets on this interface, use the [no] option.
Syntax
configure interface tengigabitethernet / ip rip receive version [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-715
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip router isis Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables IS-IS routing for IP on the specified interface. To disable IS-IS for IP, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
router isis Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-716
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip scm access-group Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Applies an ACL to a specific physical interface. An ACL is applied to a physical port and therefore is active on all VRFs associated with the physical port. To clear or reset the ACL association, use the [no] option.
Syntax
configure interface tengigabitethernet / ip scm access-group [] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Access list number from 1-99.
ARRIS PROPRIETARY — All Rights Reserved
CLI-717
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip unreachables Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the Ten Gigabit Ethernet interface ICMP unreachables as always sent. To reset the ICMP unreachables, use the [no] option.
Syntax
configure interface tengigabitethernet /
ip
unreachables [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-718
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ip vrf forwarding Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Allows the CMTS System Administrator to move a tengigabitethernet interface to the specified VRF.
Syntax
configure interface tengigabitethernet /
ip
vrf forwarding
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
The VRF name
ARRIS PROPRIETARY — All Rights Reserved
CLI-719
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 address Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables ARP forwarding for this virtual router interface. To remove the IPv6 address identified in the command from the interface, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 address [eui-64] [link-local] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[eui-64] [link-local]
CLI-720
Address of interface Configures site-local and global IPv6 addresses with an interface identifier (ID) in the low-order 64 bits of the IPv6 address. Overrides the automatically generated EUI-64 link local address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 enable Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables the specified interface for IPv6 processing. To remove all the IPv6 addresses from the interface, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 enable [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-721
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 icmp param-problem Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables transmission of ICMP6 parameter problem message. To disable transmission, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 icmp param-problem [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-722
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 icmp too-big Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables transmission of ICMP6 parameter too big message. To disable transmission, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 icmp too-big [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-723
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 icmp unreachables Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables transmission of ICMP unreachables messages. To disable transmission, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 icmp unreachables [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-724
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 mtu Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the maximum (MTU) size in bytes for IPv6 traffic on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 mtu [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Maximum size of a packet (in bytes) including the IP header.
ARRIS PROPRIETARY — All Rights Reserved
CLI-725
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd dad attempts Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the Duplicate Address Detection (DAD) by setting the number of neighbor solicitation messages sent to detect duplicate addresses. To restore the default setting, use the [no] option of the command.
Syntax
configure interface tengigabitethernet / ipv6 nd dad attempts [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-726
The number of neighbor solicitation messages.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd managed-config-flag Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the ‘managed address configuration’ flag in IPVv6 router advertisements on the specified interface. Setting this flag indicates that the cable modems and CPE devices should use DHCPv6 to obtain their IPv6 addresses. To restore the default setting, use the [no] option of the command.
Syntax
configure interface tengigabitethernet / ipv6 nd managed-config-flag [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-727
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd ns-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the minimum interval for neighbor solicitation re-transmissions on the specified interface. Use the ‘no’ option to not specify a value for Retransmit Time.
Syntax
configure interface tengigabitethernet / ipv6 nd ns-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-728
Interval in milliseconds.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd other-config-flag Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the ‘other stateful configuration’ flag in IPVv6 router advertisements on the specified interface. If the flag is set, this means that the CMs and CPE devices should use DHCPv6 to obtain information other than IPv6 addresses. To restore the default setting, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd other-config-flag [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-729
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd prefix Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the lifetime prefixes for the IPv6 advertisements. To remove the prefix from the advertisements, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd prefix [] [ [off-link] [no-autoconfig] [autoconfig] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[off-link] [no-autoconfig] [autoconfig]
CLI-730
IPv6 address Valid lifetime in seconds. Preferred lifetime in seconds. Indicates prefix is not locally reachable by hosts and must be routed. Indicates that the host may not use prefix for auto-configured IPv6 addresses. Indicates that the host may use prefix for auto-configured IPv5 addresses.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd prefix * at Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the lifetime and advertisements for prefix along with the date and time the prefix expires on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd prefix at [off-link] [no-autoconfig] [autoconfig] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
IPv6 address
[off-link]
Indicates prefix is not locally reachable by hosts and must be routed.
[no-autoconfig] [] [off-link] [no-autoconfig] [autoconfig]
Issue 2.0
Indicates that the host may not use prefix for auto-configured IPv6 addresses. Valid date in year:month:day:hour:minute:second Preferred date in the format: year:month:day:hour:minute:second Indicates prefix is not locally reachable by hosts and must be routed. Indicates that the host may not use prefix for auto-configured IPv6 addresses. Indicates that the host may use prefix for auto-configured IPv5 addresses.
ARRIS PROPRIETARY — All Rights Reserved
CLI-731
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd prefix * infinite Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the valid lifetime not to expire for prefix on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd prefix infinite [off-link] [no-autoconfig] [autoconfig] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
IPv6 address
[off-link]
Indicates prefix is not locally reachable by hosts and must be routed.
[no-autoconfig] [autoconfig]
CLI-732
Indicates that the host may not use prefix for auto-configured IPv6 addresses. Indicates that the host may use prefix for auto-configured IPv5 addresses.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd prefix * no-advertise Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Indicates that this prefix will not be sent in router advertisements on the specified interface. To indicate that the host may not use prefix for auto-configured IPv6 addresses, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd prefix no-advertise [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
IPv6 address
ARRIS PROPRIETARY — All Rights Reserved
CLI-733
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd ra interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the interval for the router advertisement beacon on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd ra interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-734
Maximum interval between IPv6 RA transmissions in seconds Minimum interval between IPv6 RA transmissions in seconds. Default is 3 seconds.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd ra lifetime Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the lifetime for the router advertisements on the specified interface. To restore the default setting, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd ra lifetime {0 | } [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
{0 | }
Issue 2.0
Lifetime, in seconds, of router advertisements. Zero indicates the CMTS is not the default router.
ARRIS PROPRIETARY — All Rights Reserved
CLI-735
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd ra reachable-time Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the amount of time a neighbor is considered ‘reachable’ after last confirmation.To reset to the default time, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd ra reachable-time [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-736
Milliseconds
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 nd ra suppress Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Suppresses the router advertisements on the specified interface. To enable the router advertisements on the specified interface, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 nd ra suppress [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-737
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables OSPF on the specified cable interface. To disable, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-738
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf area Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables OSPF for IPv6 on the specified cable interface. To disable, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf area [instance ] [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
OSPF area ID. It can be specified as either an IP address or decimal value.
[instance ]
Integer. Controls selection of other routers on this link as your neighbors.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-739
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf cost Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the cost of sending a packet on the specified interface. To disable, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf cost [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-740
Link state metric.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf dead-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the interval at which hello packets must not be seen before neighbors declare the router down. To disable, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf dead-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Dead interval in seconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-741
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf hello-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Specifies the interval between hello packets that the software sends on the specified interface. To disable, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf hello-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-742
Hello interval in seconds.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf mtu-ignore Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Disables checking the MTU size on incoming DBD packets. To enable, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf mtu-ignore [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-743
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf network Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the OSPF network type to a type other than the default for a given media. To return to the default, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf network [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-744
Network type. Current type supported is broadcast or point-to-point.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf priority Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the router priority. To reset to the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf priority [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Router priority.
ARRIS PROPRIETARY — All Rights Reserved
CLI-745
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf retransmit-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Specifies the time between link-state advertisement (LSA) retransmissions for adjacencies belonging to the interface. To reset to the default, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf retransmit-interval [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-746
Time in seconds between transmissions.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 ospf transmit-delay Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Sets the estimated time it takes to transmit a link state update packet on the interface. To return to the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 ospf transmit-delay [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Seconds required to transmit a link state update.
ARRIS PROPRIETARY — All Rights Reserved
CLI-747
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 router isis Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Enables IS-IS routing for IP on the specified interface. To disable IS-IS for IP, use the [no] option.
Syntax
configure interface tengigabitethernet / ipv6 router isis Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-748
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * ipv6 traffic-filter Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the CMTS data plane filter ACL application for a specified interface/direction.
Syntax
configure interface tengigabitethernet / ipv6 traffic-filter Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
IPv6 access list name.
Designates inbound or outbound packets
ARRIS PROPRIETARY — All Rights Reserved
CLI-749
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis authentication key-chain Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the IS-IS authentication for LSPs. To reset the circuit type, use the [no] option.
Syntax
configure interface tengigabitethernet / isis authentication key-chain [] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-750
Name of the key-chain Specifies the type of adjacencies to be formed on this interface. Valid range is level-1 or level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis authentication mode Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the IS-IS authentication mode for LSPs. To reset the circuit type, use the [no] option.
Syntax
configure interface tengigabitethernet / isis authentication mode [] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Choose either md5 or plain text Specifies the type of adjacencies to be formed on this interface. Valid range is level-1 or level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-751
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis circuit-type Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the level of adjacency for the specified interface. The Level 1 adjacency may be established if there is at least one area address in common between this system and its neighbors. To reset the circuit type, use the [no] option.
Syntax
configure interface tengigabitethernet / isis circuit-type Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-752
Specifies the type of adjacencies to be formed on this interface. Valid range is level-1, level-1-2, or level-2. If no value is specified, then value is set to level-1-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis csnp-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the complete sequence number PDUs (CSNPs) interval for the specified interface. This command only applies to the designated router on the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis csnp-interval [] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Interval of time between transmission of CSNPs on multiaccess networks. This interval only applies for the designated router. Current default is 10 seconds. Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-753
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis ds-hello-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the length of time in milliseconds between hello packets for the specified interface when it is DS. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis ds-hello-interval [] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-754
Milliseconds between hello packets. Valid range is 10-120000. Default value is 1000 milliseconds.
Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis hello-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Computes the hello interval based on the hello multiplier so that the resulting hold time is 1 second.
Syntax
configure interface tengigabitethernet / isis hello-interval [minimal ] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Specifies the milliseconds between hello packets (before multiplier) Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-755
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis hello-multiplier Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the number of IS-IS hello packets a neighbor must miss before the router declares the neighbor to be down on the specified interface. This time determines how quickly a failed neighbor is detected so that routes can be recalculated. To restore the default value, use the [no] option. The advertised hold time in IS-IS hello packets will be set to the hello multiplier times the hello interval. Neighbors will declare an adjacency to this router down after not having received any IS-IS hello packets during the advertised hold time. The hold time can be set on a per-interface basis and can be different between different routers in one area. NOTE Using a smaller hello multiplier will give fast convergence, but can result in more routing instability. Incrementing the hello multiplier to a larger value will help stabilize the network. Never configure a hello multiplier lower than the default value of 3.
Syntax
configure interface tengigabitethernet / isis hello-multiplier [] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-756
This is an integer value from 2 to 100. The advertised hold time in IS-IS hello packets will be set to the hello multiplier times the hello interval. Neighbors will declare an adjacency to this router down after not having received any IS-IS hello packets during the advertised hold time. The default value is 3 Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis ipv6 metric Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Changes the default metric of 10. Use the [no] form of the command to return to the default metric.
Syntax
configure interface tengigabitethernet / isis ipv6 metric [level-1 | level-2] [no] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Metric associated with the redistributed routes. Import as either level 1 or level 2 routes.
ARRIS PROPRIETARY — All Rights Reserved
CLI-757
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis lsp-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the time delay between successive LSPs for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis lsp-interval Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-758
Milliseconds between successive LSPs. Valid range is 1 to 65535.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis lsp-mtu Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the maximum packet size of LSPs for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis lsp-mtu Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Maximum packet size of LSPs for specified interface. Valid range is 11497. Default value is 1492.
ARRIS PROPRIETARY — All Rights Reserved
CLI-759
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis metric Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the default metric for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis metric [] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
CLI-760
Integer. Valid range is 1-63. Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis priority Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the priority of the designated routers for the specified interface. The priority is used to determine which router on a LAN will be the designated router. The priorities are advertised in the hello packets. The router with the highest priority will become the Designated Intermediate System (DIS). In the case of equal priorities, the highest MAC address breaks the tie. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis priority [] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Sets the priority value of a router and is a number from 0 to 127. The default value is 64.
[]
Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-761
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis protocol shutdown Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Disables the administrative state of IS-IS on the specified interface. To enable the administrative state of IS-IS on the specified interface, use the [no] option.
Syntax
configure interface tengigabitethernet / isis protocol shutdown [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-762
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis retransmit-interval Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Configures the maximum rate between LSP retransmits for the specified interface. This command is useful in very large networks with many LSPs and many interfaces to control LSP retransmission traffic. This command controls the rate at which LSPs can be resent on the interface. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis retransmit-interval Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Minimum seconds before retransmitting. Valid range is 1 to 300.
ARRIS PROPRIETARY — All Rights Reserved
CLI-763
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis small-hello Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Allows unpadded hello packets for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis small-hello Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-764
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * isis wide-metric Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Allows wide metrics for the specified interface. To restore the default value, use the [no] option.
Syntax
configure interface tengigabitethernet / isis wide-metric [] Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[]
Issue 2.0
Metric value Specifies the type of adjacencies to be formed on this interface. If no value is specified, then modify value for both level-1 and level-2.
ARRIS PROPRIETARY — All Rights Reserved
CLI-765
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * restore Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Restores the Ten Gigabit Ethernet card in the specified slot and port.
Syntax
configure interface tengigabitethernet / restore
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-766
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure interface tengigabitethernet * shutdown Default Access Level
Mode
Privileged – 15
Ten Gigabit Ethernet interface configuration
Purpose
Takes the specified Ten Gigabit Ethernet Router Control Module (or port) out of service. To restore the specified Ten Gigabit Ethernet Router Control Module (or port, if specified), use the [no] option.
Syntax
configure interface tengigabitethernet / shutdown [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-767
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip domain-list Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines a list of default domain names to complete unqualified host names. When a domain-list exists, the CMTS will ignore the default domain name entered with the configure ip domain-name command. If a domain-list does not exist, the CMTS uses the default domain name configured by the configure ip domain-name command. To delete a name from a list, use the [no] option.
Syntax
configure ip domain-list [no]
Parameter
Definition
Domain name. Do not include the initial period that separates an unqualified name from the domain name
Related Command(s)
configure ip domain-lookup configure ip name-server
CLI-768
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip domain-lookup Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the IP Domain Naming System (DNS)-based host name-to-address translation. To disable the DNS, use the [no] option.
Syntax
configure ip domain-lookup
Related Command(s)
configure ip domain-lookup configure ip name-server
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-769
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip domain-name Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines a default domain name that can be used to complete unqualified host names (names without a dotted-decimal domain name). To disable use of the DNS, use the [no] option.
Syntax
configure ip domain-name
Parameter
Definition
Domain name for this CMTS. Do not include the initial period that separates an unqualified name from the domain name\
Related Command(s)
configure ip domain-lookup configure ip name-server
CLI-770
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip fqdn-cache enable Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables multicast fully qualified domain name (FQDN) polling. To the polling, use the [no] option.
Syntax
configure ip fqdn-cache enable [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-771
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip fqdn-cache poll-interval Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures a static polling interval in seconds for FQDN updates. To return to the default value, use the [no] option.
Syntax
configure ip fqdn-cache poll-interval [no]
Parameter
CLI-772
Definition
Poll interval in seconds. Valid range is 300 to 86400.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip fqdn-cache refresh Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Refreshes the DNS cache by stopping and then restarting the DNS resolver.
Syntax
configure ip fqdn-cache refresh
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-773
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip local policy route-map-policy Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables policy routing. To disable, use the [no] option.
Syntax
configure ip local policy route-map-policy [no]
Parameter
CLI-774
Definition
Route map name
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip multicast cable-mac-fwd-all-ds Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Forwards multicast traffic as non-MDF onto all of a cable-mac’s associated downstreams. To reset, use the [no] option.
Syntax
configure ip multicast cable-mac-fwd-all-ds [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-775
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip multicast default-group-service-class Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the name of the default service class to be used by Multicast QoS. To remove the name, use the [no] option.
Syntax
configure ip multicast default-group-service-class [no]
Parameter
Definition
Default DOCSIS QOS service class name associated with IP multicast traffic: SCNA, SCNB, SCNC, SCND, dsa_a, dsa_b, DSMTAMGCP SF-02ds.4, SF-02us.4, USMTAMGCP, ipvideo_dn DSPrimaryBE, SCN_Up_Test, SCN_Up_UGS1, SCN_Up_UGS2
SCN_Up_UGS3, SF-02-2ds.4, SF-02-2us.4, USPrimaryBE cmcsa_10M_dn, cmcsa_11M_up, cmcsa_30M_dn, cmcsa_30M_up cmcsa_40M_up, cmcsa_50M_up, cmcsa_55M_dn, cmcsa_55M_up cmcsa_80M_dn, DS-IGMP-QUERY, SCN_Down_Test SCN_Up_UGSAD1, SCN_Up_UGSAD2, SCN_Up_UGSAD3 cmcsa_160M_dn, basic_upstream
CLI-776
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip multicast mac-ip Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the MAC destination address used when forwarding packets for a given multicast IP destination address. To reset the MAC/IP binding for an IP multicast group to the RFC standard, use the [no] option.
Syntax
configure ip multicast mac-ip [no]
Parameter
Issue 2.0
Definition
Multicast group IP address. MAC destination address.
ARRIS PROPRIETARY — All Rights Reserved
CLI-777
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip multicast-routing Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables Protocol Independent Multicast (PIM) forwarding. To disable IP multicast forwarding, use the [no] option. NOTE PIM can only be enabled in the Source Specific Mode (SSM). Other PIM CLI provisioning commands will be disallowed if multicast-routing is not enabled.
Syntax
configure ip multicast-routing [no]
CLI-778
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip name-server Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies the address of one or more name servers to use for name and address resolution. To remove the addresses specified, use the [no] option.
Syntax
configure ip name-server [server-address2...server-address6] [no]
Parameter
[server-address2...serveraddress6]
Issue 2.0
Definition
IP address of name server IP addresses of additional name servers (a maximum of six domain servers)
ARRIS PROPRIETARY — All Rights Reserved
CLI-779
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip prefix-list Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Adds, modifies or removes prefix lists. To delete a prefix-list, use the [no] option.
Syntax
configure ip prefix-list [seq ][no]
Parameter
[seq ]
CLI-780
Definition
List name Sequence number. The default is the order of entry.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip prefix-list * permit Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies packets to accept.
Syntax
configure ip prefix-list [seq ] permit [ge ] [le ]
Parameter
[seq ]
Issue 2.0
Definition
List name Sequence number. The default is the order of entry. Prefix length
[ge ]
Specifies a prefix length greater than or equal to the value. It is the lowest value of a range of the length (the “from” portion of the length range)
[le ]
Specifies a prefix length less than or equal to the value. It is the highest value of a range of the length (the “to” portion of the length range)
ARRIS PROPRIETARY — All Rights Reserved
CLI-781
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip route Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures an IP route to the “default” virtual router. To delete an IP route from the “default” virtual router, use the [no] option. NOTE Note: Next hop defaults to 0.0.0.0 if not entered and shows up in Metric1 of the MIB.
Syntax
configure ip route [metric ] [null ] [vrf ] [admin-dist ][no]
Parameter
Definition
Destination prefix
Destination prefix mask
The IP address of the next hop
[metric ] [null ]
Distance metric Null interface number
[vrf ]
Virtual router name
[admin-dist ]
Administrative distance for this route
CLI-782
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip scm access Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables System Controller Module (SCM) access. SCM access provides the IP connectivity to the CMTS SCM through the client cards. To disable the SCM access, use the [no] option. NOTE The following restrictions apply: •
The SCM A, B and floating IP should all be in the same subnet.
•
The host that accesses the SCM via SCM access must NOT be in the same subnet of the floating IP
•
If SCM access is enabled and the time server IP is not in the same subnet as the SCM A, B or floating IP, you must set an ACL to allow the timer server to send a time reply to the C4 CMTS.
•
Once SCM access is enabled, FTP from the front panel may not function.
NOTE The following subnets are reserved for CMTS Internal Processor Communications (IPC) and will be rejected as invalid destination IPs if you attempt to configure a route with them: 100.0.0.x 100.0.1.x 100.0.2.x 1.1.0.x 1.1.1.x Syntax
configure ip scm access [no]
Example
Following is an example of how the command is used: C4#
configure interface loopback 0 ip address 10.1.64.2 255.255.255.252
Issue 2.0
C4#
configure ip scm access
C4#
configure access-list 3 permit any
ARRIS PROPRIETARY — All Rights Reserved
CLI-783
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Related Command(s)
configure ip scm access configure access-list * igmp configure interface loopback * ip address
CLI-784
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh ciphers Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the list of ciphers available for the SSH server. You can configure all ciphers or any combination. The default is set at all ciphers
Syntax
configure ip ssh ciphers [aes] [blowfish] [cast] [arcfour] [3des] Parameter
Issue 2.0
Definition
[aes]
Encryption cipher candidate
[blowfish]
Encryption cipher candidate
[cast]
Encryption cipher candidate
[arcfour]
Encryption cipher candidate
[3des]
Encryption cipher candidate
ARRIS PROPRIETARY — All Rights Reserved
CLI-785
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh idle-timeout Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the idle-timeout parameters for the SSH server. NOTE CLI time is in minutes but SSH2 server time is in seconds.
Syntax
configure ip ssh idle-timeout Parameter
Definition
Session idle timeout in minutes. The default is 0 (unlimited)
Example
To set the idle-timeout session for 5 minutes (300 seconds), use the following command: C4#
CLI-786
configure ip ssh idle-timeout 5
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh login Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Allows CLI login sessions.The default is allowed. To disallow CLI login sessions, use the [no] option.
Syntax
configure ip ssh login
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-787
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh max-auth-fail Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of client authentication failures. This counter is for both public key and password authentication failures.
Syntax
configure ip ssh max-auth-fail Parameter
CLI-788
Definition
Includes both CLI and sftp sessions. The default is 0 (unlimited)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh max-clients Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of client sessions. This is for both CLI and SFTP sessions.
Syntax
configure ip ssh max-clients Parameter
Issue 2.0
Definition
Maximum SSH client sessions (CLI and SFTP sessions). Default is set to 0 (unlimited)
ARRIS PROPRIETARY — All Rights Reserved
CLI-789
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh password-auth Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Allows CLI login session password authentication. The default is allowed. To disallow CLI login session password authentication, use the [no] option.
Syntax
configure ip ssh password-auth [no]
CLI-790
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh password-auth-req Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Requires CLI login session password authentication before a client is considered logged in. To disallow CLI login session password authentication, use the [no] option.
Syntax
configure ip ssh password-auth-req [no]
Related Command(s)
configure ip ssh max-clients
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-791
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh port Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the TCP port for the SSH server.
Syntax
configure ip ssh port
CLI-792
Parameter
Definition
This is the TCP port number for the SSH server. Valid range is 1-65535. Default port number is 22.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh port-forwarding Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Allows secure port forwarding. To disallow secure port forwarding, use the [no] option.
Syntax
configure ip ssh port-forwarding
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-793
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh public-key-auth Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Allows user public key authentication. To disallow user public key authentication, use the [no] option.
Syntax
configure ip ssh public-key-auth
CLI-794
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh public-key-auth-first Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Requires public key authentication to precede password authentication. To remove this requirement, use the [no] option.
Syntax
configure ip ssh public-key-auth-first [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-795
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh public-key-auth-req Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Requires user public key authentication before a client is considered logged in. To disallow, use the [no] option.
Syntax
configure ip ssh public-key-auth-req [no]
Related Command(s)
configure ip ssh public-key-auth
CLI-796
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh restart Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Halts the SSH2 server and all active SSH2 sessions and then immediately restarts the SSH server. This command functions as a “warm” reboot of the server. The functionality of this command is not the same as configure ip ssh no shutdown. NOTE No changes take place until the SSH2 server restarts. All existing sessions (including this one) are terminated on a restart; login is available after restart is complete (generally under 1 second). CAUTION
This command will not generate an error message if there are problems starting SSH. Because it is restarting the server, it assumes that keys are present and correct. Syntax
configure ip ssh restart
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-797
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh sftp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables secure FTP sessions. To disable, use the [no] version of the command.
Syntax
configure ip ssh sftp [no]
CLI-798
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip ssh shutdown Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Halts the SSH2 server and all SSH2 session processes such as CLI command shells and should be used after a change has been made.
Syntax
configure ip ssh shutdown
Example
The following command explicitly starts the C4 CMTS SSH2 server: C4#
configure ip ssh no shutdown
NOTE This command will fail if the server’s DSA host public/private key is not available. Related Command(s)
configure crypto key generate show ip unreachables
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-799
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip unreachables Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets all interface ICMP unreachables as always sent. To disable ICMP unreachables, use the [no] option.
Syntax
configure ip unreachables [no]
CLI-800
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 access-list Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the IPv6 access control lists. To restore the default values, use the [no] option.
Syntax
configure ipv6 access list [] {/ | any} [remark ][no] Parameter
Definition
The chosen name for the access-list. Note that the user must not be able to configure with CLI an IPv6 ACL by specifying an ACL number (as is permitted with IPv4 standard and extended ACLs). However, an internally generated number will be assigned to the ACL in the range 200 to 399.
[]
The optional index number for this ACL entry indicating the relative position within the ACL. If no index numbers are supplied, the entry must be appended to the end with 10+ the previous last index value.
{/ | any} [remark ]
Issue 2.0
The chosen permit or deny flag for this ACL entry. The 128-bit IPv6 address and prefix length (prefix length indicating number of bits starting from the left to be used for matching purposes). Alternatively, the ‘any’ keyword may be used for matching any source IPv6 address (all bits are ‘don’t care’). Note that there is not use of a wildcard mask with IPv6 ACLs. The ACL entry comment.
ARRIS PROPRIETARY — All Rights Reserved
CLI-801
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 access-list resequence Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the resequence of the IPv6 access control list index numbers. To restore the default values, use the [no] option.
Syntax
configure ipv6 access list resequence Parameter
Definition
The chosen name for the access-list. Note that the user must not be able to configure with CLI an IPv6 ACL by specifying an ACL number (as is permitted with IPv4 standard and extended ACLs). However, an internally generated number will be assigned to the ACL in the range 200 to 399.
CLI-802
The index for the starting entry in the ACL.
The increment amount between entries in the ACL.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 dhcp relay source-interface Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the interface to be used for the SIP field. To remove the interface, use the [no] option.
Syntax
configure ipv6 dhcp relay source-interface {cable / | cable-mac | gigabitethernet / | loopback | tengigabitethernet /} Parameter
/ /
Issue 2.0
Definition
CAM slot number/Mac domain number The MAC identifier. RCM slot number/gigabit port number [.subinf number] Loopback interface number RCM slot number/tengigabit port number [.subinf number]
ARRIS PROPRIETARY — All Rights Reserved
CLI-803
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 dhcp relay use-link-address Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the SIP field in the DHCPv6 relay forward message to use the address of the interface over which the client DHCP message was received for the SI. To remove, use the [no] option.
Syntax
configure ipv6 dhcp relay use-link-address [no]
CLI-804
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 hop-limit Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the default limit for router advertisements and all IPv6 packets originated by the router. To restore the default values, use the [no] option.
Syntax
configure ipv6 hop-limit [no] Parameter
Issue 2.0
Definition
The number of hop limits allowed. The default is 64.
ARRIS PROPRIETARY — All Rights Reserved
CLI-805
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 icmp param-problem Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables transmission of ICMP6 parameter problem message. To disable transmission, use the [no] option.
Syntax
configure ipv6 icmp param-problem [no]
CLI-806
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 icmp time-exceeded Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables transmission of ICMP6 time exceeded messages. To disable, use the [no] option.
Syntax
configure ipv6 icmp time-exceeded [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-807
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 icmp too-big Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables transmission of ICMP6 parameter too big message. To disable transmission, use the [no] option.
Syntax
configure ipv6 icmp too-big [no]
CLI-808
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 icmp unreachables Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables transmission of ICMP unreachables messages. To disable transmission, use the [no] option.
Syntax
configure ipv6 icmp unreachables [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-809
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 nd state not-present Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Sets the rate in packets/second of ICMPv6 unreachables transmitted for all non-present IPs. To reset to the default, use the [no] option.
Syntax
configure ipv6 nd state not-present {global-max-rate | max-number | max-time | mintime | rate-limit } [no]
Parameter
global-max-rate max-number
Definition
Maximum ICMP transmit rate for all non present IPv6’s Maximum number of ICMP6s sent in this state
max-time
Maximum time, in seconds, in this state while actively receiving traffic
min-time
Minimum time, in seconds, in this state while actively receiving traffic
rate-limit
CLI-810
Minimum time, in msec, between ICMP6’s
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 nd state searching Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Sets the rate in packets/second for ND solicitation messages. To reset to the default, use the [no] option.
Syntax
configure ipv6 nd state searching {global-max-rate | max-number | rate-limit } [no]
Parameter
global-max-rate max-number rate-limit
Issue 2.0
Definition
Maximum ICMP transmit rate for all non present IPv6’s Maximum number of ICMP6s sent in this state Minimum time, in msec, between ICMP6’s
ARRIS PROPRIETARY — All Rights Reserved
CLI-811
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 nd timeout Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Configures the neighbor discovery (ND) cache timeout. To remove the timeout, use the [no] option.
Syntax
configure ipv6 nd timeout [no]
Parameter
CLI-812
Definition
Neighbor cache timeout in seconds (0 = disable, 180-360000)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 neighbor * cable Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Creates a static entry in the neighbor discovery (ND) cache for a cable interface. To remove the neighbor, use the [no] option.
Syntax
configure ipv6 neighbor cable / [] [no]
Parameter
Definition
The address of the neighbor. It is in hexidecimal using 16-bit values between colons.
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
The MAC domain number (valid numbers are 0-1)
Issue 2.0
The 48-bit ethernet address used to address the node on the interface.
ARRIS PROPRIETARY — All Rights Reserved
CLI-813
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 neighbor * cable-mac Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates or deletes a static entry in the neighbor discovery (ND) cache for a cable-mac interface using the MAC address. To remove the neighbor, use the [no] option.
Syntax
configure ipv6 neighbor cable-mac [no]
Parameter
Definition
The address of the neighbor. It is in hexidecimal using 16-bit values between colons.
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
The MAC domain number (valid numbers are 0-1)
CLI-814
The 48-bit ethernet address used to address the node on the interface.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 neighbor * gigabitethernet Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates or deletes a static entry in the neighbor discovery (ND) cache for the interface using the one Gigabit Ethernet interface. To remove the neighbor, use the [no] option.
Syntax
configure ipv6 neighbor gigabitethernet [no]
Parameter
Definition
The address of the neighbor. It is in hexidecimal using 16-bit values between colons. The number of the interface in / format.
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
The 48-bit ethernet address used to address the node on the interface.
ARRIS PROPRIETARY — All Rights Reserved
CLI-815
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 neighbor * tengigabitethernet Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates or deletes a static entry in the neighbor discovery (ND) cache for the interface using the ten Gigabit Ethernet interface. To remove the ND cache, use the [no] option.
Syntax
configure ipv6 neighbor tengigabitethernet [no]
Parameter
Definition
The address of the neighbor. It is in hexidecimal using 16-bit values between colons. The number of the interface in / format.
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-816
The 48-bit ethernet address used to address the node on the interface.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 pd-route-injection Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the prefix delegation route injection. To remove, use the [no] option.
Syntax
configure ipv6 pd-route-injection
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-817
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 prefix-stability Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Enables the prefix stability feature. To disable, use the [no] option.
Syntax
configure ipv6 prefix-stability [no]
CLI-818
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
To establish static routes from the IPv6 route table. To remove the static route, use the [no] option.
Syntax
configure ipv6 route / [admin-distance ] [metric ] [no]
Parameter
Definition
Destination route address
A decimal value that indicates the length of the IPv6 prefix.
Next hop address
[admin-distance ] [metric ]
Issue 2.0
Provides static routes priority over other types of routes except for connected routes. The default admin-distance is 1. Compares this route to other routes with the same admin distance.
ARRIS PROPRIETARY — All Rights Reserved
CLI-819
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route * cable Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
To establish IPv6 static routes through a specified cable interface. To remove the static route, use the [no] option.
Syntax
configure ipv6 route / cable [admin-distance ] [metric ] [no]
Parameter
Definition
Destination route address
Decimal value that indicates the length of the IPv6 prefix. The number of the interface in / format.
Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15. The MAC domain number (valid numbers are 0-1)
[admin-distance ] [metric ]
CLI-820
Next hop address Provides static routes priority over other types of routes except for connected routes. The default admin-distance is 1. Compares this route to other routes with the same admin distance.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route * cable-mac Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
To establish IPv6 static routes through a cable-mac interface. To remove the static route, use the [no] option.
Syntax
configure ipv6 route / cable-mac [admin-distance ] [metric ] [no]
Parameter
Definition
Destination route address
Decimal value that indicates the length of the IPv6 prefix.
[admin-distance ] [metric ]
Issue 2.0
The MAC identifier (valid numbers are 0-415). Next hop address Provides static routes priority over other types of routes except for connected routes. The default admin-distance is 1. Compares this route to other routes with the same admin distance.
ARRIS PROPRIETARY — All Rights Reserved
CLI-821
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route * gigabitethernet Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
To establish IPv6 static routes through a Gigabit Ethernet interface. To remove the static route, use the [no] option.
Syntax
configure ipv6 route / gigabitethernet [admin-distance ] [metric ] [no]
Parameter
Definition
Destination route address
Decimal value that indicates the length of the IPv6 prefix. The number of the interface in / format.
Valid slot numbers for the C4 CMTS is 17-18; valid slot number for the C4c CMTS is 17 The Gigabit Ethernet port value on the RCM is (0-9).
] [admin-distance ] [metric ]
CLI-822
Next hop address Provides static routes priority over other types of routes except for connected routes. The default admin-distance is 1. Compares this route to other routes with the same admin distance.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route * null Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Establishes IPv6 static routes without an interface. It is essentially a route to nowhere. Null routes are used too prevent packets from being routed to the default route in the event of a hardware or routing failure. To remove the static route, use the [no] option. NOTE Null routes should have a less desirable admin distance than the actual destination, therefore they should be used only if the actual destination is not available due to a hardware or routing failure.
Syntax
configure ipv6 route / null [admin-distance ] [metric ][no]
Parameter
Definition
Destination route address.
A decimal value that indicates the length of the IPv6 prefix
[admin-distance ] [metric ]
Issue 2.0
Integer number, usually zero. Provides static routes priority over other types of routes except for connected routes. The default admin-distance is 1. Compares this route to other routes with the same admin distance.
ARRIS PROPRIETARY — All Rights Reserved
CLI-823
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route pd-data-retrieve Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Restores the IPv6 PD route using the IPv6 address.
Syntax
configure ipv6 route pd-data-retrieve Parameter
CLI-824
Definition
Router IPv6 address.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route pd-data-retrieve all Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Restores all the IPv6 PD routes.
Syntax
configure ipv6 route pd-data-retrieve all
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-825
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route pd-data-retrieve cable-mac Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Restores the IPv6 PD routes by cable-mac interface.
Syntax
configure ipv6 route pd-data-retrieve cable-mac Parameter
CLI-826
Definition
MAC identifier
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf area * default cost Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Specifies the cost for the default summary route sent into a stub or NSSA area. To return to the default, use the [no] option.
Syntax
configure ipv6 router ospf area default cost [no]
Parameter
Issue 2.0
Definition
OSPF area ID. It can be specified as either an IP address or decimal value. Cost for the default summary route used for a stub or NSSA area.
ARRIS PROPRIETARY — All Rights Reserved
CLI-827
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf area * nssa * Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Configures an area as a not so stubby area (NSSA). To return to the default, use the [no] option.
Syntax
configure ipv6 router ospf area nssa [no-summary] [no]
Parameter
[no-summary]
CLI-828
Definition
OSPF area ID. It can be specified as either an IP address or decimal value. Optional. Use this to specify not to send or receive summary LSA into NSSA.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf area * range * Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Consolidates and summarizes routes at an area boundary. To return to the default, use the [no] option.
Syntax
configure ipv6 router ospf area range [advertise | not-advertise] [no]
Parameter
Definition
OSPF area ID. It can be specified as either an IP address or decimal value. Format: 4-hex-digits:4-hex-digits:.../prefix length.
[advertise |
Sets the address range status to advertise and generate a Type 3 summary LSA.
not-advertise]
Sets the address range status to DoNotAdvertise. Type 3 summary LSAs are suppressed.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-829
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf area * stub Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Consolidates and summarizes routes at an area boundary. To return to the default, use the [no] option.
Syntax
configure ipv6 router ospf area stub [no-summary] [no]
Parameter
[no-summary]
CLI-830
Definition
OSPF area ID. It can be specified as either an IP address or decimal value. Optional. Use this to specify not to send or receive summary LSA into NSSA.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf as-border-router Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Defines whether this router is an autonomous border router. To return to the default, use the [no] option.
Syntax
configure ipv6 router ospf as-border-router [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-831
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf distance * Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Configures the administrative distance for OSPF routes in the same VRF. To return to the default, use the [no] option.
Syntax
configure ipv6 router ospf distance ospf [no]
Parameter
CLI-832
Definition
Administrative distance.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf distance * ospf external Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Configures the administrative distance for external OSPF routes. To return to the default, use the [no] option.
Syntax
configure ipv6 router ospf distance ospf external [no]
Parameter
Issue 2.0
Definition
Administrative distance.
External type 5 and type 7 routes.
ARRIS PROPRIETARY — All Rights Reserved
CLI-833
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf distribute-list Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Configures filtering for OSPF routes in the same VRF OSPF routes. To return to the default, use the [no] option.
Syntax
configure ipv6 router ospf distribute-list out [no]
Parameter
Definition
IPv6 access list name.
Source routing protocol
CLI-834
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf passive-interface * Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Suppresses routing updates on the specified interface. To remove the passive configuration, use the [no] option.
Syntax
configure ipv6 router ospf passive-interface {cable / | cable-mac | gigabitethernet /[.] | tengigabitethernet /[.]> [no]
Parameter
TengigabitEthernet interface
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-835
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf redistribute connected Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Redistributes routes into OSPF. To remove the redistribute configuration, use the [no] option.
Syntax
configure ipv6 router ospf redistribute connected {metric | metric-type | tag } [no]
Parameter
Definition
OSPF default metric. Used ‘transparent’ to preserve the metrics of the source protocol.
CLI-836
1 = Set OSPF External Type 1 metrics 2 = Set OSPF External Type 2 metrics Value attached to each external redistributed route.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf redistribute isis Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Redistributes static routes into OSPF. To remove the static configuration, use the [no] option.
Syntax
configure ipv6 router ospf redistribute isis [{level-1 | level-1-2 | level-2]} [metric ] [metric-type ] [tag ] [no]
Parameter
level-1 level-1-2 level-2 metric metric-type tag
Issue 2.0
Definition
Redistribute level 1 routes. Redistribute both level 1 and level 2 routes. Redistribute level 2 routes. OSPF default metric. Used ‘transparent’ to preserve the metrics of the source protocol. 1 = Set OSPF External Type 1 metrics 2 = Set OSPF External Type 2 metrics Value attached to each external redistributed route.
ARRIS PROPRIETARY — All Rights Reserved
CLI-837
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf redistribute pd Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Redistributes PD routes into OSPF. To remove the PD configuration, use the [no] option.
Syntax
configure ipv6 router ospf redistribute pd {metric | metric-type | tag } [no]
Parameter
Definition
OSPF default metric. Used ‘transparent’ to preserve the metrics of the source protocol.
CLI-838
1 = Set OSPF External Type 1 metrics 2 = Set OSPF External Type 2 metrics Value attached to each external redistributed route.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf redistribute static Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Redistributes static routes into OSPF. To remove the static configuration, use the [no] option.
Syntax
configure ipv6 router ospf redistribute static {metric | metric-type | tag } [no]
Parameter
Definition
OSPF default metric. Used ‘transparent’ to preserve the metrics of the source protocol.
Issue 2.0
1 = Set OSPF External Type 1 metrics 2 = Set OSPF External Type 2 metrics Value attached to each external redistributed route.
ARRIS PROPRIETARY — All Rights Reserved
CLI-839
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf router-id Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Configures a router ID for OSPFv3. To remove the router ID, use the [no] option.
Syntax
configure ipv6 router ospf router-id } [no]
Parameter
CLI-840
Definition
IP address representing the router ID.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router ospf shutdown Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Disables the administrative state of the OSPFv3 instance. To administratively enable the OSPFv3 instance, use the [no] option.
Syntax
configure ipv6 router ospf shutdown [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-841
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router pd distance Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Configures the administrative distance for the IPv6 Prefix Delegation route. To remove, use the [no] option.
Syntax
configure ipv6 router ospf pd distance [no] Parameter
CLI-842
Definition
Administrative distance for all PD routes in the same VRF.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 router static distance Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
Configures the administrative distance for the IPv6 static routes. To remove, use the [no] option.
Syntax
configure ipv6 router ospf statis distance [no] Parameter
Issue 2.0
Definition
Administrative distance for all static routes in the same VRF.
ARRIS PROPRIETARY — All Rights Reserved
CLI-843
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ipv6 route * tengigabitethernet Default Access Level
Mode
Privileged - 15
Global configuration
Purpose
To establish IPv6 static routes through a ten Gigabit Ethernet interface. To remove the static route, use the [no] option.
Syntax
configure ipv6 route / tengigabitethernet [admin-distance ] [metric ] [no]
Parameter
Definition
Destination route address
A decimal value that indicates the length of the IPv6 prefix The number of the interface in / format.
Valid slot numbers for the C4 CMTS is 17-18; valid slot number for the C4c CMTS is 17. The ten Gigabit Ethernet port value on the RCM is 10.
[admin-distance ] [metric ]
CLI-844
Next hop address Provides static routes priority over other types of routes except for connected routes. The default admin-distance is 1. Compares this route to other routes with the same admin distance.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip-video attribute-encoding Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the attribute bit(s) indicating the type of IP video. To delete, use the [no] option.
Syntax
configure ip-video attribute-encoding [no]
Parameter
Issue 2.0
Definition
The 32-bit attribute encoding mask in hex.
ARRIS PROPRIETARY — All Rights Reserved
CLI-845
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip-video dbc-delay-timer Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the time between DBC messages sent to a single modem for IP video. To delete, use the [no] option.
Syntax
configure ip-video dbc-delay-timer [no]
CLI-846
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ip vrf Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates a virtual router via “name”. To delete a virtual router or to turn off OSPF for the virtual router default, use the [no] option. NOTE The icmp-time-exceeded parameter must be run or traceroute through the CMTS will not work.
Syntax
configure ip vrf [icmp-time-exceeded] [ospf] [no]
Parameter
Definition
The name assigned to the virtual router
[icmp-time-exceeded] [ospf]
Turns OSPF on for the named virtual router
Example
To turn on transmission of ICMP Time Exceeded messages on the default virtual router, use the following command: C4#
Issue 2.0
Turns on transmission of ICMP Time Exceeded message
configure ip vrf default icmp-time-exceeded
ARRIS PROPRIETARY — All Rights Reserved
CLI-847
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain Parameter
Definition
The time (in msec).
Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enters the mode to enable authentication for routing protocols by identifying a group of authentication keys. Routing Information Protocol (RIP) Version 2 uses key chains. You must configure a key chain with keys to enable authentication. To remove a key chain and all of its associated keys, use the [no] option.
Syntax
configure key chain [no]
Parameter
CLI-848
Definition
A text string up to 16 characters long.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain * key Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates a key with the specified sequence number and allows you to modify data specific to this key. To remove a key with the specified sequence number, use the [no] option.
Syntax
configure key chain key [no]
Parameter
Definition
A text string up to 16 characters long.
Sequence number assigned to this key.
Related Command(s)
configure interface cable-mac * ip rip authentication key-chain configure interface gigabitethernet * ip rip authentication key-chain
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-849
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain * key * accept-lifetime Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines a specific accept lifetime for the key. To set the accept lifetime to be infinite, enter the [no] option.
Syntax
configure key chain key accept-lifetime [no]
Parameter
Definition
A text string up to 16 characters long.
Sequence number assigned to this key.
Start time is in the form of year=yyyy, month=mm, day=dd, hour=hh, minute=mm, second=ss
End time is in the form of year=yyyy, month=mm, day=dd, hour=hh, minute=mm, second=ss
CLI-850
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain * key * accept-lifetime duration Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the time that the key is valid to be received. To restore the default, use the [no] option.
Syntax
configure key chain key accept-lifetime duration [no]
Parameter
Definition
A text string up to 16 characters long.
Sequence number assigned to this key.
Issue 2.0
Time in seconds that the key is valid to be received
ARRIS PROPRIETARY — All Rights Reserved
CLI-851
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain * key * accept-lifetime infinite Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the time that the key is valid to never expire. To restore the default, use the [no] option.
Syntax
configure key chain key accept-lifetime infinite [no]
Parameter
Definition
A text string up to 16 characters long.
Sequence number assigned to this key.
CLI-852
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain * key * key-string Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the string for the key. To remove a key chain and all its keys, use the [no] option.
Syntax
configure key chain key key-string [no]
Parameter
Definition
A text string up to 16 characters long.
Sequence number assigned to this key.
Issue 2.0
A text string up to 16 characters long
ARRIS PROPRIETARY — All Rights Reserved
CLI-853
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain * key * send-lifetime Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines a specific send lifetime for the key. To set the send lifetime to be infinite, use the [no] option.
Syntax
configure key chain key send-lifetime [no]
Parameter
Definition
A text string up to 16 characters long.
Sequence number assigned to this key.
Start time is in the form of year=yyyy, month=mm, day=dd, hour=hh, minute=mm, second=ss
End time is in the form of year=yyyy, month=mm, day=dd, hour=hh, minute=mm, second=ss
CLI-854
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain * key * send-lifetime duration Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the time that the key is valid to be sent. To restore the default, use the [no] option.
Syntax
configure key chain key send-lifetime duration [no]
Parameter
Definition
A text string up to 16 characters long.
Sequence number assigned to this key.
Issue 2.0
Time in seconds that the key is valid to be sent.
ARRIS PROPRIETARY — All Rights Reserved
CLI-855
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure key chain * key * send-lifetime infinite Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the time that the key is valid to never expire. To restore the default, use the [no] option.
Syntax
configure key chain key send-lifetime infinite [no]
Parameter
Definition
A text string up to 16 characters long.
Sequence number assigned to this key.
CLI-856
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure l2vpn cable-mac Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures all cable MAC interfaces participating in the L2VPN service. CMs that attempt to register as L2VPN in non-participating cable-mac interfaces are rejected. NOTE Only designated cable MAC interfaces are able to host L2VPN CMs.
Syntax
configure l2vpn cable-mac { |all} [no]
Parameter
all
Issue 2.0
Definition
ID of the MAC interface. Range is 0 - 415. All cable-mac interfaces.
ARRIS PROPRIETARY — All Rights Reserved
CLI-857
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure l2vpn cm capability Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Permits the legacy CMs to register with L2VPN TLV encodings. Note that if neither capability is identified, then both esafe-ident and dut-filter will be set.
Syntax
configure l2vpn cm capability {esafe-ident|dut-filter} {required|optional}
NOTE The default for each capability is required. NOTE Legacy CMs may register with L2VPN TLV encodings only if both esafe-ident and dut-filter are explicitly set to optional.
Parameter
{esafe-ident |
Indicates whether TLVs that identify CMs as embedded devices are required.
dut-filter}
Indicates whether an L2VPN-forwarding CM is required to be capable of Downstream Unencrypted Traffic (DUT) filtering.
{required |
LVPN-compliant CMs are required.
optional}
CLI-858
Definition
Legacy CMs are allowed to register without L2VPN TLVs.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure l2vpn forwarding Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Controls the L2VPN forwarding state on a global, instance, L2VPN ID, or CM basis.
Syntax
configure l2vpn forwarding [l2vpnid ] [instance |] [cm-mac ] {enable|disable}
Parameter
[l2vpnid] instance |
Definition
Externally configured string that identifies a specific L2VPN The VLAN identifier used for single or dual Q-tags. Range is 2 - 4094. Optional smaller VLAN identifier used with dual Q-tags. Range is 1 - 4095.
cm-mac
CM MAC ID of the L2VPN registered cable modem
{enable | disable}
Enable or disable the global L2VPN forwarding state
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-859
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure l2vpn network-interface gigabitethernet Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the primary and optional secondary L2VPN network interfaces.
Syntax
configure l2vpn network-interface gigabitethernet [no]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-860
Specifies either single or dual Q-tag encapsulation.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure l2vpn network-interface tengigabitethernet Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the primary anf optional secondary L2VPN network interfaces.
Syntax
configure l2vpn network-interface tengigabitethernet [no]
Parameter
/
Definition
RCM slot number/tengigabitEthernet port number. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Specifies either single or dual Q-tag encapsulation.
ARRIS PROPRIETARY — All Rights Reserved
CLI-861
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure l2vpn vlanid-range Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Declares the VLAN ID ranges that are reserved for L2VPN use and allocated to single or dual Q-tag L2VPN instances.
Syntax
configure l2vpn vlanid-range [-] [no]
Parameter
vlanid-range | [-]
CLI-862
Definition
Outer VLAN ID value for a single or dual Q-tag. Range is 2 - 4094. Optional inner VLAN ID value used for dual Q-tags. Range is 2 - 4094. Specifies either single or dual Q-tag encapsulation.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure line Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures a console or vty line. To remove or disable a console or vty line, use the [no] option.
Syntax
configure line [endline] [session-timeout ] [idle-timeout ] [length ] [password ] [speed ] [authentication ] [login-authentication] [enable-authentication] [authorization ] [width ] [no]
Parameter
console vty
Definition
Configures the SCM console port. The CLI will accept 0 (zero) or 1. Configures a virtual terminal. For the CMTS, this refers to a telnet session. Range of line numbers is 0 to 15.
Integer identifying line number or first line number of a range of line numbers
[]
Integer identifying last line number of a range of line numbers
[session-timeout ] [idle-timeout ] [length ] [password ] [speed ] [authentication ] [login-authentication]
Session length in seconds. The CMTS automatically terminates the session when this interval expires. A value of zero indicates no timeout. Maximum idle time in seconds. The CMTS automatically terminates the session if no I/O activity occurs within this interval. A value of zero indicates no timeout. Page length in number of lines. A value of 0 will disable paged output. Line password Baud rate in bits per second. Valid range is 9600 to 115200 Authentication method list name (up to 16 characters) Set authentication type to ‘login’
[enable-authentication]
Allows the user to use the enable command to go into privileged mode.
[authorization ]
Authorization method list name (up to 16 characters)
[width ]
Issue 2.0
Sets the width of the terminal
ARRIS PROPRIETARY — All Rights Reserved
CLI-863
CLI Command Descriptions
Example
C4/C4c CMTS Rel. 8.0.7
Since the C4 CMTS currently supports a single console port and up to 16 telnet sessions, the following commands are possible: C4#
configure line console 0 configure line vty 0 15 configure line vty 1 The CLI will accept 0 or 1 for the console port. However, the command will set the value for both 0 and 1. It is not possible to set the two consoles with different values.
Related Command(s)
configure pagination terminal length show running-config interface cable-downstream
CLI-864
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure line * accounting Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures shell and/or command accounting. To disable shell and/or command accounting, use the [no] option.
Syntax
configure line [width ] [endline] accounting [command ] [shell] [{start-stop | stop-only}] [no]
Parameter
console vty [width ]
Configures the SCM console port. The CLI will accept 0 (zero) or 1. Configures a virtual terminal. For the CMTS, this refers to a telnet session. Range of line numbers is 0 to 15. Sets the width of the terminal
Integer identifying line number or first line number of a range of line numbers
[]
Integer identifying last line number of a range of line numbers
[command ]
Enables command accounting
[shell]
Enables shell accounting
Accounting method list
[{start-stop | stop-only}]
Issue 2.0
Definition
Sends accounting record at the initiation and termination of a session Sends accounting record only at the termination of a session
ARRIS PROPRIETARY — All Rights Reserved
CLI-865
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging console Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the sending of system logging messages to the console and sets logging level. To disable sending system logging messages to the console, use the [no] option. CAUTION
Enabling console logging at lower priorities may negatively impact system performance due to the number of log messages in conjunction with the relatively slow speed of the console port. Syntax
configure logging console [no]
Parameter
Definition
Values of priority level are:
1 2 3 4 5 6 7 8
= = = = = = = =
emergency alert critical error warning notice informational debug
Related Command(s)
trace logging no show logging console show logging debug configure privilege exec level show logging monitor show logging priority cli
CLI-866
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging debug Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables notification for the specified debug facility. If slot number is specified, then notification will be enabled only for that slot. CAUTION
Enabling debug logging impacts system performance. Excessive debug logging may degrade service. The [no] option disables notification for the specified debug facility class and subclass (optional). If the subclass is not specified, then debug notifications are disabled for all subclasses that have a facility and class that match what is
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-867
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
specified on the command line. If class is not specified, debug notifications are disabled for all classes and subclasses that have a facility that match what is specified on the command line. Syntax
configure logging debug [] [] [slot ] [filter {cmMac | ifMac | subIp}] [filter_data ] [no]
CLI-868
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
Case-sensitive string that names a functional area, such as:
ACL
AND
AuthServer
LI
LiCaleaTap
MibGC
QosMgr
SNMP
ServiceClassName
ServiceFlowCount
Throttle
ThrottlingConfig
TstRec
aging
appl
applFlow
arp
audit
authmod
bgp
bpi
brief_modem
broker
cammanager
carPolicy
ccrrcvy
channelcac
cli
clock
cm-status
cmts
counts
dappl
data
datamanagement
dataplane
dcard
dcd
dchan
dhcp
dhcpv6
diag
diskmanager
dlb
dmmappl
drv
dsdata
eappl
edr
eventrcvr
ez
flexpath
flinkmon
icmp
icmpv6
igmp
ip
ipdr
isis
ldr
learning
mac
macdm
macdmVerbose
macdomain
macmgr
map
mdd
modem
mpls
mtce
multicast
nal
ospf
ospfv3
packetcable
pbr
pim
proxy
ranging
rcc
rip
router
rsvp
scmaccess
security
socket
switch
test
tftpra
uchan
unconverted uploadbal
upstreamAgility
util
voiph
voipvh
voipvm
vpn
camsparing
voipm
Each functional area designated for logging must have the same unique name. [] []
Issue 2.0
Name given to group a set of notifications within a facility. Name given to specify a single notification within a class of notifications. Each different subclass within the same class must have a unique subclass name.
ARRIS PROPRIETARY — All Rights Reserved
CLI-869
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
[slot ]
Chassis slot number. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
[filter {cmMac | ifMac | subIp}]
Filter used
[filter_data ]
Filter data
Example
The following example will give detailed debug information on the Mac address of 0004.bdcc.75b0: C4#
configure logging debug dhcp filter cmMac filter-data 0004.bdcc.75b0 configure logging debug modem ranging filter cmMac filter cmMac 0004.bdcc.75b0
Related Command(s)
trace logging no show logging debug configure privilege exec level show logging history
CLI-870
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging facility Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the Syslog facility for all currently configured Syslog hosts. Possible values are local0, local1, local2, local3, local4, local5, local6 and local7. All notifications sent to the Syslog server will specify this facility.
Syntax
configure logging facility
Parameter
Issue 2.0
Definition
local0, local1, local2, local3, local4, local5, local6 and local7. Default facility is local0.
ARRIS PROPRIETARY — All Rights Reserved
CLI-871
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging history size Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies the number of messages that will get stored in the history table. Should the size of the logging history exceed the specified number of entries, new entries will overwrite the oldest entries.
Syntax
configure logging history size
Parameter
CLI-872
Definition
This number is the number of messages that will be stored in the history table. The default is 2000.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging host Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the IP address and facility of a Syslog host. All log messages whose priorities are enabled for Syslog transmission will be sent to the specified host. To remove the Syslog host, use the [no] option.
Syntax
configure logging host [facility [no]
Parameter
[facility ]
Example
IP address of a server in nnn.nnn.nnn.nnn.format Syslog facility. Range is local0 - local7. Default is set at local0
To configure the logging host (Syslog host) which has an IP address of 10.43.10.10 and facility local0, type the following command: C4#
Example
configure logging host 10.43.10.10 To configure the Syslog host which has an IP address of 10.43.10.25 and facility local5, the command would look like the following:
C4#
Issue 2.0
Definition
configure logging host 10.43.10.25 facility local5
ARRIS PROPRIETARY — All Rights Reserved
CLI-873
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging local-volatile Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Turns on the local volatile log (SNMP-accessible log) and sets the maximum number of entries than can be stored. Should the size of the local log exceed specified number of entries, new entries will overwrite the oldest entries. Reduce the local log size from the default of 10 only if you want the CMTS to reduce the number of events logged. To disable volatile local logging for all logging levels, use the [no] option.
Syntax
configure logging local-volatile { | size } [no]
Parameter
Definition
Values of priority level are: 1 2 3 4 5 6 7 8
{
size }
Example
emergency alert critical error warning notice informational debug
The number of messages to be stored in the local log. Valid range is 1 to 300. The default is 10 messages.
To set the volatile local logging to the information level, type the following command: C4#
CLI-874
= = = = = = = =
configure logging local-volatile 7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging monitor Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sends the system logging messages of a given priority to the telnet session by setting the logging level. The output will continue to be routed to the telnet session until either the logging to the monitor is disabled or the telnet session is disconnected. To disable delivery of all notifications to the telnet session, use the [no] option.
Syntax
configure logging monitor [no]
Parameter
Definition
Values of priority level are: 1 2 3 4 5 6 7 8
Example
emergency alert critical error warning notice informational debug
To send critical level system logging messages to the telnet session, type the following command: C4#
Issue 2.0
= = = = = = = =
configure logging monitor 3
ARRIS PROPRIETARY — All Rights Reserved
CLI-875
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging override event Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the logging of a specific event. To disable the logging of an event regardless of its priority, use the [no] option.
Syntax
configure logging override event [priority ] [no]
Parameter
event [priority ]
CLI-876
Definition
The ID assigned to the event by the system. Logging priority. Valid types are emergency, alert, critical, error, warning, notice, information, debug
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging override reset Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Clears previous provisioning of event ids.
Syntax
configure logging override reset
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-877
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging priority cli Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Allows the flexibility to assign a logging priority to a given CLI access level. The current default settings are listed in the following table:
Syntax
CLI Access Level
Default Notification Priority
0 through 4
7 (Informational)
5 through 15
6 (Notice)
configure logging priority cli
Parameter
Definition
Assigns CLI access levels 0 through 15 Assigns the logging priority assigned to the specified CLI access
Related Command(s)
configure privilege exec level show logging priority cli
CLI-878
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging proprietary Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables proprietary logging to syslog, local, and snmp destinations. Currently the default is “enabled”. To disable proprietary logging to syslog, local or snmp destinations, use the [no] option.
Syntax
configure logging proprietary [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-879
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging snmp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Causes all trappable notifications with specified priority level to be sent to an SNMP manager (if configured) as an SNMP trap. By default, the C4 CMTS generates SNMP traps for any event with a priority level of critical (3), error (4), warning (5), or notice (6). To turn off all SNMP logging for all logging levels, use the [no] option.
Syntax
configure logging snmp [no]
Parameter
Definition
Values of priority level are: 1 2 3 4 5 6 7 8
Example
emergency alert critical error warning notice informational debug
To send notifications to the SNMP manager with the warning level priority, use the following command: C4#
CLI-880
= = = = = = = =
configure logging snmp 5
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging syslog Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Causes all notifications with specified priority to be sent to the Syslog server (if an IP address has been configured). NOTE By default, the C4 CMTS routes any event with priority emergency (1), alert (2), critical (3), error (4), warning (5), or notice (6) to the Syslog server. However, to send other priority levels to Syslog or SNMP, they must first be enabled for the local volatile log or local non-volatile log. The same set of priorities are enabled for SNMP and local-volatile by default. Local-nonvolatile has no priorities enabled by default. Also by default, the C4 CMTS sends all Syslog messages to the Syslog facility local0. The facility may be changed to local1, local2, local3, local4, local5, local6, or local7. The C4 CMTS will not route events to a Syslog server unless the server’s IP address is configured. If the Syslog server is configured, but you wish to stop sending any events to it, use the [no] option of the command.
Syntax
configure logging syslog ) [no]
Parameter
Definition
Values of priority level are: 1 2 3 4
Example
emergency alert critical error
5 6 7 8
= = = =
warning notice informational debug
To send critical notifications to the Syslog server, use the following command: C4#
Issue 2.0
= = = =
configure logging syslog 3
ARRIS PROPRIETARY — All Rights Reserved
CLI-881
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging throttle Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the throttle interval to a given interval (length in seconds). To transmit the trap and Syslog messages without regard to threshold settings, use the [no] option.
Syntax
configure logging throttle [{all | stop | limit}] [interval ] [threshold ] [no]
Parameter
Definition
all - results in full throttling of all notifications
[{all | stop | limit}]
stop - results in full throttling of all notifications if the number of notifications exceeds the configured threshold within the configured interval. Transmission may only be resumed by setting the docsDevEvThrottleAdminStatus MIB object. (The stop type is intended for use by an NMS in the implementation of a closed-loop-feedback throttling mechanism.) limit - results in throttling for the remainder of the current configured interval if the number of notifications exceeds the configured threshold within that interval. Once the interval expires, transmissions of notifications begins again.
[interval ] [threshold ]
CLI-882
Sets the throttle interval to a given interval (length in seconds). The maximum is 999999999 seconds. Sets the throttle threshold below a given number of messages allowed per interval. The maximum number of messages allowed per interval is 999999999.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure logging trap Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables or disables DOCSIS® SNMP traps. To disable DOCSIS® traps only, use the [no] option.
Syntax
configure logging trap [no]
Parameter
Definition
DOCSIS
®
trap to enable or disable. Options are listed below.
init-reg-req-fail - register request failed trap init-reg-rsp-fail - register response failed trap init-reg-ack-fail - register acknowledgement failed trap dyn-serv-req-fail - dynamic service request failed trap dyn-serv-rsp-fail - dynamic service response failed trap
dyn -serv-ack-fail - dynamic services ack failed trap bpi-init - BPI init trap bpkm - BPKM trap dyn-sa - Dynamic SA trap dcc-req-fail - DCC request failed trap dcc-rsp-fail - DCC response failed trap dcc-ack-fail - DCC ack failed trap
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-883
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Example configure logging trap init-reg-req-fail configure logging trap init-reg-rsp-fail configure logging trap init-req-ack-fail configure logging trap dyn-serv-req-fail configure logging trap dyn-serv-rsp-fail configure logging trap dyn-serv-ack-fail configure logging trap bpi-init configure logging trap bpkm configure logging trap dyn-sa configure logging trap dcc-req-fail configure logging trap dcc-rsp-fail configure logging trap dcc-ack-fail
CLI-884
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ntp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the Network Time Protocol (NTP) parameters.
Syntax
configure ntp {minpoll } {maxpoll } {version }
Parameter
{minpoll }
Minimum polling interval for NTP clients and peers. Default is 6.
{maxpoll }
Maximum polling interval for NTP clients and peers. Default is 7.
{version }
Issue 2.0
Definition
NTP version used when sending message to NTP clients, servers, or peers. Default is 4.
ARRIS PROPRIETARY — All Rights Reserved
CLI-885
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ntp authentication Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the Network Time Protocol (NTP) authentication feature. To disable the NTP authentication feature, use the [no] option.
Syntax
configure ntp authentication [no]
CLI-886
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ntp authentication-key * md5 Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures an MD5 key to use with the Network Time Protocol (NTP) authentication. To remove the MD5 key used with the NTP authentication, use the [no] option.
Syntax
configure ntp authentication-key md5 [no]
Parameter
Issue 2.0
Definition
ID of the authentication key Authentication key may be 1 to 16 null-terminated 7-bit ASCII characters excluding “ “ (space character), “#” (pound sign, also called the number sign, hash key, or octothorpe), “\t” (tab), “\n” (line feed), and “\0” (null terminator) .
ARRIS PROPRIETARY — All Rights Reserved
CLI-887
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ntp server Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures an NTP unicast client of the remote server at the specified IP address. The remote server distributes time sync to the CMTS but does not synchronize itself to the CMTS. This is the most common NTP configuration for the CMTS. To remove the NTP unicast client of the remote server at the specified IP address, use the [no] option.
Syntax
configure ntp server [burst] [key ] [prefer] [minpoll ] [maxpoll ] [version ] [no]
Parameter
[burst] [key ] [prefer]
CLI-888
Definition
IP address or subnet for NTP communication Enable the burst mode. Default = off The ID of the MD5 auth key. Default = 0 which disables authentication. Sets the NTP server to be preferred server.
[minpoll ]
Minimum polling interval for NTP clients and peers. Default is 6
[maxpoll ]
Maximum polling interval for NTP clients and peers. Default is 7
[version ]
The version of NTP used when sending messages to this server or peer. Default = 4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ntp server * broadcast Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the CMTS to be an NTP broadcast client listening to some NTP broadcast server that is periodically sending time sync within the broadcast subnet identified by the specified IP address. CAUTION
To avoid loops, do not use this mode if the C4 CMTS is also configured to be a Broadcast or Multicast Server. Syntax
Issue 2.0
configure ntp server broadcast Parameter
Definition
The form of the broadcast iP address may be A1.255.255.255, B1.B2.255.255, or C1.C2.C3.255. In addition, the IP address 255.255.255.255 identifies the local subnet that the CMTS is attached to.
ARRIS PROPRIETARY — All Rights Reserved
CLI-889
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ntp server * manycast Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the CMTS to be an NTP client member of the self-configuring NTP manycast group using the multicast ip-address. The CMTS uses the group multicast IP address to discover other nearby NTP servers in the manycast group that it can obtain time sync from as a client.
Syntax
configure ntp server manycast [burst] [ttl ] [minpoll ] [maxpoll ]
Parameter
Definition
The multicast IP address is of the form 224.0.1.x, which are designated as NTP manycast group addresses. Do not use the default Internet NTP manycast group 224.0.1.1 address unless absolutely necessary because of its large membership.
[burst]
Forces the CMTS to send a sequence of time sync messages over a short period at each poll interval to the group servers.
[ttl ]
Specifies the maximum number of router hops that the CMTS will use when trying to locate nearby members of its manycast group. Default is 5
[minpoll ]
Minimum polling interval for NTP clients and peers. Default is 6
[maxpoll ]
Maximum polling interval for NTP clients and peers. Default is 7
CLI-890
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure ntp server * multicast Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the CMTS to be an NTP multicast client listening to some NTP multicast server that is periodically sending time sync on the multicast IP address identified by the specified IP address. CAUTION
To avoid loops, do not use this mode if the CMTS is also configured to be a Broadcast or Multicast Server. Syntax
configure ntp server multicast
Parameter
Issue 2.0
Definition
The IP address must be an IPv4 Class D multicast address in the form D1.D2.D3.D4.
ARRIS PROPRIETARY — All Rights Reserved
CLI-891
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure operation dul-packet-interval Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the periodic timeout, in seconds, for the 24U DUL diagnostic packet. To disable the timeout, use the [no] option.
Syntax
configure operation dul-packet-interal [no]
Parameter
CLI-892
Definition
THe timeout value in seconds. Valid range is 0 | 10-900.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure operation event Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures recovery/logging values for the specified event ID. To disable the operation event, use the [no] option.
Syntax
configure operation event [slot ] [recovery ] [logging ] [no]
Parameter
Definition
Event ID in hex format with a prefix of 0x. Valid range is 0x0-0xFFFFFFFF
[slot ]
Slot number. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
[recovery ]
Enables or disables a card recovery after an FPGA error
[logging ]
Enables or disables logging
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-893
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure operation mode Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the Upper Level Protocol (ULP) operation mode. To disable the ULP operation mode, use the [no] option.
Syntax
configure operation mode [no]
Parameter
Definition
Operation mode is one of the following:
CLI-894
5TapPts—Revert equalizer number of 24 tap points for non-ranging IUCs to 5 tap point. DSPeakTrafficRateTLV2516 — Use old MULPI spec (TLV 25.16) for DS Peak Traf Rate instead of new spec (TLV 25.27) adjrxpwrctl — Allow adjustment of rx power control by mod type bpiHybrid — Allow upgraded DOCSIS 1.0 modems to operate using BPI+ cmstatusoperational — Support the modem status of operational(8) at the CMTS cpeNacksForceCmReset — The CMTS decides internally to accept (ACK) or reject (NACK) a new CPE when its CM asks the CMTS to learn it. By default, the asssociated CM is reset if the same CPE is rejected three times. Use the no version of this operation mode to disable the default setting so that CMs will not be reset after 3 NAKs. docsis10plus — Enable the Docsis 1.0+ feature docsis20test — Enable testing mode for DOCSIS 2.0 downstreamOverride — Inhibits sending range response with downstream frequency override qossf10cms — Allow 1.0 CMs in DocsQosServiceFlowEntry nbudptcpfltr — Allow combining of Ucp and Tcp messages in same filter showCmFormatCV — Force output of “show cable modem” to be (more) Ciscolike suppress-dcd — Disable DCD without cutting off QoS distribution for multicast traffic upce — Allow Upstream Packet Classification Enforcement (default off) upstreamLockupDetect — Enable detection of upstream channel lockups upstreamLockupDetectLong — Modify upstream lockup detection to use longer data sampling interval virtualCm — enable support for virtual modemsdocsis20test — Enable testing mode for DOCSIS 2.0
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure operation overload-control sensitivity Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the sensitivity to overload parameters. To disable, use the [no] option.
Syntax
configure operation overload-control sensitivity [no]
Parameter
Issue 2.0
Definition
Sensitivity to overload (higher=faster response to changes)
ARRIS PROPRIETARY — All Rights Reserved
CLI-895
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure operation overload-control threshold Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the threshold to trigger overload. To disable, use the [no] option.
Syntax
configure operation overload-control threshold [no]
Parameter
CLI-896
Definition
Threshold to trigger overload (higher=busier CPU need to trigger overload)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables all PacketCable (both DQoS and Multimedia) services on the C4 CMTS. To disable all PacketCable services on the C4 CMTS, use the [no] option. NOTE By default, PacketCable services are disabled on the C4 CMTS. When PacketCable services are disabled, the CMTS will disallow any PacketCable signaling connections using the Common Open Policy Service (otherwise known as COPS) from the Call Management Server (CMS). As a result, all PacketCable call requests will fail.
Syntax
configure packetcable [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-897
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable dqos shutdown Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Disables only the PacketCable 1.x (DQoS) services on the C4 CMTS. To enable only PacketCable 1.x (DQoS) services on the C4 CMTS, use the [no] option.
Syntax
configure packetcable dqos shutdown [no]
CLI-898
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable dqos timer Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the Packetcable DQoS (Dynamic Quality of Service) timer.
Syntax
configure packetcable dqos timer [time]
Parameter
Definition
Where timer name is “t0” or “t1” without the quotes. t0 - limits the amount of time between the reception of a Gate-Alloc message and a Gate-Set message for the same DQoS Gate. The default value of this timer is 30 seconds. This timer has a range of 1-60 seconds.
[time]
Issue 2.0
t1 - limits the validity period for authorization of a particular PacketCable call. This timer is started whenever a Gate is established and reset whenever a Commit operation is performed on the resources authorized by the gate. Ordinarily, Timer-T1 is received in the Gate-Set message. If the value given in the Gate-Set message is zero, the Timer-T1 will be set to a provisioned value. The default value of this timer is 250 seconds. This timer has a range of 1-600 seconds. Timer range value.
ARRIS PROPRIETARY — All Rights Reserved
CLI-899
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable eventmsg batch-size Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of event messages that will be collected and combined into one packet for transmission to the RKS. NOTE The C4 CMTS uses the static port 1813 for Event Messages. The C4 CMTS listens to port 1813 all the time. When it sends a message to an RKS at whatever destination IP and port, port 1813 shows up as the source port in the UDP header.
Syntax
configure packetcable eventmsg batch-size
Parameter
CLI-900
Definition
The default value is 3. The count has a range of 2 to 10.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable eventmsg billing-events Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables event messaging while using CALEA and event messaging at the CMs. To disable event messaging at the C4 CMTS while using CALEA and event messaging at the CMs, use the [no] option. NOTE The C4 CMTS uses the static port 1813 for Event Messages. The C4 CMTS listens to port 1813 all the time. When it sends a message to an RKS at whatever destination IP and port, port 1813 shows up as the source port in the UDP header.
Syntax
configure packetcable eventmsg billing-events [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-901
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable eventmsg element-id Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the Element ID to enable event messaging. This is a number that is assigned to the C4 CMTS that will be included in all event messages from the C4 CMTS. This number is used by the RKS so that it knows that the event message came from this CMTS. The Element ID must be configured before Event Messages are generated. To disable event messaging, use the [no] option. NOTE The C4 CMTS uses the static port 1813 for Event Messages. The C4 CMTS listens to port 1813 all the time. When it sends a message to an RKS at whatever destination IP and port, port 1813 shows up as the source port in the UDP header.
Syntax
configure packetcable eventmsg element-id [no]
Parameter
CLI-902
Definition
There is no default value. This number must be configured for event messaging to work. The range is 0 to 99999.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable eventmsg max-age Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum age for PacketCable Event Messaging in minutes. NOTE The C4 CMTS uses the static port 1813 for Event Messages. The C4 CMTS listens to port 1813 all the time. When it sends a message to an RKS at whatever destination IP and port, port 1813 shows up as the source port in the UDP header.
Syntax
Issue 2.0
configure packetcable eventmsg max-age
Parameter
Definition
Maximum age for event message in minutes. Default is set for one minute.
ARRIS PROPRIETARY — All Rights Reserved
CLI-903
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable eventmsg retry limit Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Provisions the event message retry count. This count is the maximum number of times that the Event Messaging Retry Interval may expire before the C4 CMTS will switch to the secondary RKS. NOTE The C4 CMTS uses the static port 1813 for Event Messages. The C4 CMTS listens to port 1813 all the time. When it sends a message to an RKS at whatever destination IP and port, port 1813 shows up as the source port in the UDP header.
Syntax
configure packetcable eventmsg retry limit
Parameter
CLI-904
Definition
Maximum number of times the CMTS will try to send the message. The default value is 1. The count range is 0 - 9.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable eventmsg retry timer Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Provisions the event message retry timer. This is the maximum amount of time that the C4 CMTS will wait for an acknowledgement of an event message before the CMTS will assume that the message is lost. At this point, the CMTS will either retransmit the message or switch to the secondary RKS. NOTE The C4 CMTS uses the static port 1813 for Event Messages. The C4 CMTS listens to port 1813 all the time. When it sends a message to an RKS at whatever destination IP and port, port 1813 shows up as the source port in the UDP header.
Syntax
configure packetcable eventmsg retry timer
Parameter
Issue 2.0
Definition
Timer value in milliseconds. The default value of the timer is 1000 milliseconds. The valid range of this timer is 10 - 10,000 milliseconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-905
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable gate send-subscriberid Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the use of subscriber ID in every DQoS gate-open and gate-close message. To disable, use the [no] option.
Syntax
configure packetcable gate send-subscriberid [no]
CLI-906
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable pcmm shutdown Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Disables only the PacketCable Multimedia services on the C4 CMTS. To enable only PacketCable Multimedia services on the C4 CMTS, use the [no] option.
Syntax
configure packetcable pcmm shutdown [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-907
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable pcmm subscriber-id vrf Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the specific VRF for remotely connect subnet subscriberIDs. Use the [no] version to disable.
Syntax
configure packetcable pcmm subscriber-id vrf [no]
Parameter
CLI-908
Definition
VRF Name, e.g. default
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable pcmm timer t1 Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the PCMM t1 timer values.
Syntax
configure packetcable pcmm timer t1
Parameter
Issue 2.0
Definition
Timer value, in deciseconds. Default value is 300 deciseconds (30 seconds).
ARRIS PROPRIETARY — All Rights Reserved
CLI-909
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable pcmm version Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the specific version of the PCMM Common Open Policy Service (COPS). To disable the PCMM version, use the [no] option.
Syntax
configure packetcable pcmm version [no]
Parameter
CLI-910
Definition
The PCMM version.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable throttle Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the PacketCable throttling parameters. This command throttles the number of packetcable messages that can be made in a 10 second period based on the System Control Module (SCM) congestion status. This means in a normal system we will deny new phone calls if we are getting more than 12.5 connections per second when the SCM CPU is not congested, and 4.1 connections per second when we are in high congestion. NOTE The default thresholds for packetcable throttling are engineered to provide optimal service at scaling levels prescribed with each CMTS software release. Consult ARRIS Technical Support before overriding these defaults.
Syntax
configure packetcable throttle {normal-threshold |yellow-threshold | red-threshold } [transper10sec]
Parameter
Definition
normal-threshold
Maximum number of messages allowed during a 10 second period when system CPU is in a normal condition (e.g. no congestion). The default value is set for 125.
yellow-threshold
Maximum number of messages allowed during a 10 second period when system CPU is in a moderate congestion condition. The default value is set for 125.
red-threshold
Maximum number of messages allowed during a 10 second period when system CPU is in a high congestion condition. The default value is set for 41.
[transper10sec]
Number of gate transactions (request and response) that can be processed in 10 seconds.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-911
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable voice-limits allowed-emergency Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the maximum percent of the downstream and upstream channel bandwidth reserved for emergency voice. Table CLI-7: Rules/Limits on percentage values
Syntax
Maximum range
0-90
allowed-total
>=
allowed-normal
allowed-total
>=
reserved-emergency
allowed-total
>=
reserved-normal + reserved-emergency
configure packetcable voice-limits allowed-emergency [downstream | upstream]
Parameter
[downstream|upstream]
Definition
The percentage allowed for emergency voice use. Valid range is 0 to 90. See table above. Direction of channel bandwidth.
Related Command(s)
configure packetcable voice-limits set-all
CLI-912
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable voice-limits allowed-normal Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the maximum percent of the downstream and upstream channel bandwidth reserved for normal voice. Table CLI-8: Rules/Limits on percentage values
Syntax
Maximum range
0-90
allowed-total
>=
allowed-normal
allowed-total
>=
reserved-emergency
allowed-total
>=
reserved-normal + reserved-emergency
configure packetcable voice-limits allowed-normal [downstream | upstream]
Parameter
[downstream|upstream]
Issue 2.0
Definition
The percentage allowed for normal voice use. See table above. Direction of channel bandwidth.
ARRIS PROPRIETARY — All Rights Reserved
CLI-913
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable voice-limits allowed-total Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the percent of the downstream and upstream channel bandwidth allowed for all classes of voice traffic. Table CLI-9: Rules/Limits on percentage values
Syntax
Maximum range
0-90
allowed-total
>=
allowed-emergency
allowed-total
>=
reserved-normal + reserved-emergency
allowed-emergency
>=
reserved-emergency
configure packetcable voice-limits allowed-total [downstream|upstream]
Parameter
[downstream|upstream]
CLI-914
Definition
The percentage allowed for all classes of voice traffic. See table above. Direction of channel bandwidth.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable voice-limits downstream Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the percent of only the downstream channel bandwidth allowed for voice traffic.
Syntax
configure packetcable voice-limits downstream [allowedtotal | allowed-normal ]
Issue 2.0
Parameter
Definition
The percentage allowed for all or normal classes of voice traffic. Range is 0 - 90.
ARRIS PROPRIETARY — All Rights Reserved
CLI-915
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable voice-limits emergency-preemption Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the percent of channel bandwidth allowed for emergency traffic to preempt normal traffic. To disable emergency-preemption, use the [no] option.
Syntax
configure packetcable voice-limits emergency-preemption [downstream|upstream][no]
Parameter
[downstream|upstream]
Definition
The percentage allowed for emergency traffic to preempt normal traffic. Valid range is 0 to 90. Direction of channel bandwidth.
Related Command(s)
configure packetcable voice-limits set-all
CLI-916
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable voice-limits reserved-emergency Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the minimum percent of the downstream and upstream channel bandwidth reserved for emergency voice. Table CLI-10: Rules/Limits on percentage values
Syntax
Maximum range
0-90
allowed-total
>=
reserved-normal + reserved-emergency
allowed-normal
>=
reserved-normal
configure packetcable voice-limits reserved-emergency [downstream | upstream]
Parameter
[downstream|upstream]
Issue 2.0
Definition
The percentage reserved for emergency voice use. See table above. Direction of channel bandwidth.
ARRIS PROPRIETARY — All Rights Reserved
CLI-917
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable voice-limits reserved-normal Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the minimum percent of the downstream and upstream channel bandwidth reserved for normal voice. Table CLI-11: Rule/Limits on percentage values
Syntax
Maximum range
0-90
allowed-total
>=
reserved-normal + reserved-emergency
allowed-emergency
>=
reserved-emergency
configure packetcable voice-limits reserved-normal [downstream | upstream]
Parameter
[downstream|upstream]
Definition
The percentage reserved for normal voice use. See table above. Direction of channel bandwidth.
Related Command(s)
configure packetcable voice-limits set-all
CLI-918
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure packetcable voice-limits set-all Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Copies the global values to all downstream and upstream parameters.
Syntax
configure packetcable voice-limits set-all
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-919
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure pagination Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays a number of lines of consecutive CLI output and then will pause at the bottom of the screen and give you the option to load another page of information or to quit. A value of zero indicates no pagination. Non-zero values are only applicable for transports that do not support window size negotiation (serial, ssh). Transports which support window size negotiation (telnet) may override this parameter. To disable pagination and display CLI output all at once, use the [no] option.
Syntax
configure pagination [no]
Related Command(s)
configure line terminal length show running-config interface cable-downstream
CLI-920
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure power-monitor Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the power supply monitor LED. To disable the power monitor, use the [no] option. NOTE While it is never advisable to operate an active system with a simplex power conditioning module, some CMTSs, lab chassis for example, may be equipped with only one power supply. In such cases, the user may choose to disable the active power alarm by executing this command.
Syntax
configure power-monitor [no]
Parameter
Issue 2.0
Definition
Power unit number. Power units are number 0 or 1
restores or shuts down the selected power monitor
ARRIS PROPRIETARY — All Rights Reserved
CLI-921
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure privilege exec level Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the command privilege level. To reset the specified commands back to the default settings, use the [no] option. configure privilege exec level [no]
Parameter
Definition
The privilege level. Valid range is 0-15
The command or group of commands to be assigned a different level.
Example
If you wish to restrict access to the configure interface cable commands, you could use the following command: C4#
configure privilege exec level 8 configure interface cable The following is an example of the output returned by the system: Setting access level to 8 for configure interface cable
Related Command(s)
show privilege exec configure privilege exec reset
CLI-922
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure privilege exec reset Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets the command privilege to the default values.
Syntax
configure privilege exec reset
Parameter
Definition
The command or group of commands to be assigned a different level.
Related Command(s)
show privilege exec configure privilege exec reset
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-923
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure prompt Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the CLI prompt to the specified string. NOTE The configure prompt works for a single session.
Syntax
configure prompt
Parameter
Definition
The text for the new prompt
Example
The following command would change the current prompt of C4# to ARRIS# C4#
configure prompt ARRIS The system prompt would return and look like:
ARRIS# Related Command(s)
configure hostname
CLI-924
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure qos-sc name Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures a Quality of Service (QoS) service class. To remove the QoS service class, use the [no] option.
Syntax
configure qos-sc name [no]
Parameter
Definition
A predefined Quality of Service configuration referred to by the cable modem in a configuration file and used to encode a Service Flow according to the parameter values found in the SCN. The maximum length = 15 characters.
[priority ]
Allows service flows to be given priority for delay and buffering. The C4 CMTS uses this field to assign traffic priorities, which are implemented using a queuing system.
[max-tr-rate ]
Specifies the rate parameter R of a token-bucket-based rate limit for packets. R is expressed in bits per second. This rate expresses an upper boundary, not a guarantee that the rate is available.
[max-tr-burst ]
Specifies the token bucket size B (in bytes) for this Service Flow.
Specifies the minimum rate, in bits/sec, reserved for this Service Flow. If [min-res-rate ] CM requests less bandwidth than this minimum, the C4 CMTS may reallocate the excess. [min-res-pkt ]
Specifies an assumed minimum packet size (in bytes) for which the Minimum Reserved Traffic Rate will be provided.
[peak-tr-rate ]
Specifies peak traffic rate shaped.
[max-burst ]
Specifies the maximum concatenated burst (in bytes) which a Service Flow is allowed. This parameter is calculated from the FC byte of the Concatenation MAC Header to the last CRC in the concatenated MAC frame
[poll-int ]
Issue 2.0
Specifies the nominal interval (in units of microseconds) between successive unicast request opportunities for this Service Flow on the upstream channel. This parameter is typically suited for Real-Time and Non-Real-Time Polling Service.
ARRIS PROPRIETARY — All Rights Reserved
CLI-925
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
[poll-jitter ]
Specifies the maximum amount of time that the unicast request interval may be delayed from the nominal periodic schedule (measured in microseconds) for this Service Flow.
[grant-size ]
Specifies the unsolicited grant size in bytes
[grant-int ]
Specifies the nominal interval (in units of microseconds) between successive data grant opportunities for this Service Flow. Required for UGS and UGS/AD
[grant-jitter ]
Specifies the maximum amount of time (in microseconds) that the transmission opportunities may be delayed from the nominal periodic schedule for this Service Flow. Required for UGS and UGS/AD
[grant-per-int ]
For UGS, the value of this parameter indicates the actual number of data grants per NominalGrant Interval. For UGS/AD, the value of this parameter indicates the maximum number of Active Grants per Nominal Grant Interval. This is intended to enable the addition of sessions to an existing UGS Flow via the Dynamic Service Change mechanism, without negatively impacting existing sessions.
[max-lat
Maximum downstream latency — a service commitment by CMTS to forward a packet received on a network side interface to the RF interface within the specified number of microseconds.
[active-tmout ]
Specifies the maximum duration resources remain unused on an active Service Flow. If there is no activity on the Service Flow within this time interval, the CMTS MUST change the active and admitted QoS Parameter Sets to null.
[adm-tmount ]
Specifies the duration that the C4 CMTS MUST hold resources for a Service Flow’s Admitted QoS Parameter Set while they are in excess of its Active QoS Parameter Set.
[type ]
Specifies the service class schedule type. Valid types: 2 - Best Effort schedule type 3 - Non real time polling service schedule type 4 - Real time polling service schedule type 5 - UGS with activity detection schedule type 6 - UGS schedule type
[req-policy ]
Specifies which IUC opportunities the CM uses for upstream transmission requests and packet transmissions for this Service Flow, whether requests for this Service Flow may be piggybacked with data and whether data packets transmitted on this Service Flow can be concatenated, fragmented, or have payload headers suppressed.
[and-mask ] [or-mask ]
IP Type of Service overwrite. Enables CMTS to overwrite original Type of Service (ToS) byte with new value.
[required-attr-mask-value ]
Specifies the attribute mask required for the service flow. Value is a hex string between 0x00000000-0xFFFFFFFF.
CLI-926
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
[forbidden-attr-mask-value ]
Specifies the attribute mask that is not allowed for the service flow. Value is a hex string between 0x00000000-0xFFFFFFFF.
[dir]
The service flow direction. Downstream is 1 and upstream is 2.
[latency-scheduler
Example
Enables or disables latency controlled flow.
Following is an example of configuring the QoS class: C4#
configure qos-sc name SCNA priority 0 max-tr-rate 500000 max-tr burst 3044 min-res-rate 0 min-res-pkt 0 max-burst 0 poll-int 0 poll-jitter 0 grant-size 0 grant-int 0
configure qos-sc name SCNA grant-jitter 0 grants-per-int 0 max-lat 0 active-tmout 0 adm-tmout 200 type 2 req-policy 00000000 and-mask ff or-mask 00 dir 2
configure qos-sc name SCNB priority 0 max-tr-rate 5000000 max-tr-lat burst 3044 min-res-rate 0 min-res-pkt 0 max-burst 0 poll-int 0 poll-jitter 0 grant-size 0 grant-int 0
configure qos-sc name SCNB grant-jitter 0 grants-per-int 0 max-lat 0 active-tmout 0 adm-tmout 200 type 2 req-policy 00000000 and-mask ff or-mask 00 dir 2
configure qos-sc name SCNC priority 0 max-tr-rate 5000000 max-tr-burst 3044 min-res-rate 0 min-res-pkt 0 max-burst 0 poll-int 0 poll-jitter 0 grant-size 0 grant-int 0
configure qos-sc name SCNC grant-jitter 0 grants-per-int 0 max-lat 0 active-tmout 0 adm-tmout 200 type 1 req-policy 00000000 and-mask ff or-mask 00 dir 1
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-927
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset cable-modem Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets one or more cable modem(s) by specifying either the IPv4, IPv6 address(s) or MAC address(s).
Syntax
configure reset cable-modem
Parameter
CLI-928
Definition
Either IPv4, IPv6 address or MAC address of the cable modem
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset cable-modem all Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets all the cable modems in the system. NOTE This command has CTRL + C support which would abort the current process. Output is brief and updated every two seconds to monitor progress. For reference, a 24,000 CM system could take approximately 30 minutes to reset all CMs.
Syntax
configure reset cable-modem all [rate ]
Parameter
[rate ]
Issue 2.0
Definition
Maximum number of cable modems reset per second. Valid range is 1-20. Default is 20.
ARRIS PROPRIETARY — All Rights Reserved
CLI-929
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset cable-modem bonded Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets or deletes all bonded cable modems.
Syntax
configure reset cable-modem bonded [reject | slot | vendor> [no]
Parameter
[reject ] [slot [vendor ]
CLI-930
Definition
Resets or deletes cable modems on a specific interface. Filters on the CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15. Filters on cable modems for a specific vendor
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset cable-modem cable Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets all cable modems on a specified Cable Access Module (CAM) slot.
Syntax
configure reset cable-modem
Parameter
Issue 2.0
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[rate ]
Maximum number of cable modems reset per second. Valid range is 1-20. Default is 20.
ARRIS PROPRIETARY — All Rights Reserved
CLI-931
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset cable-modem cable * oui Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets every cable modem matching the specified OUI (Organization Unique Identifier, e.g. most significant 3 bytes of the MAC address) on a specified slot.
Syntax
configure reset cable-modem cable oui
Parameter
CLI-932
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[rate ]
Maximum number of cable modems reset per second. Valid range is 1-20. Default is 20.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset cable-modem cable * vendor Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets every cable modem of a particular vendor on a specified upstream interface. Following is a list of possible vendor names:
3Com
Ambit
Arris
Askey
ASUSTek
BAS
BestData
Broadcom
Cadant
Castlenet
Cisco
Com21
Conexant
Coresma
COSHIP
D-Link
Daehanet
DAKOS
Electroline
Elsa
Ericsson
GADline
GeniusNet
Hanaro
Humax
iCable_System
Infinite
Intel
Joohong
Leichu
LG
Linksys
Maspro
Matsushita
Mercury
Motorola
NEC
Netgear
Nortel
Opentech
Pace
Pacific
Panasonic
Phillips
Pioneer
Ponico
PowerCom
QNS
RCA/Thomson
RiverDelta
SA
Saejin
Samsung
SMC
Sunrise
Syswave
Technotrend
Teledex
Telexy
Tellabs
Telogy
Terayon
TI
Tollgrade
Toshiba
TriGem
TurboComm
USRobotics
Woojyun
Zoom
ZyXel
Syntax
configure reset cable-modem cable vendor
Parameter
Upstream port
Vendor name
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-933
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset cable-modem fpcm-id Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets all the cable modems in the system. NOTE This command has CTRL + C support which would abort the current process. Output is brief and updated every two seconds to monitor progress. For reference, a 24,000 CM system could take approximately 30 minutes to reset all CMs.
Syntax
configure reset cable-modem fpcm-id
Parameter
CLI-934
Definition
The FlexPath Device ID of the target FPCM.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset cable-modem vendor Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets every cable modem of a particular vendor. Following is a list of possible vendor names:
3Com
Ambit
Arris
Askey
ASUSTek
BAS
BestData
Broadcom
Cadant
Castlenet
Cisco
Com21
Conexant
Coresma
COSHIP
D-Link
Daehanet
DAKOS
Electroline
Elsa
Ericsson
GADline
GeniusNet
Hanaro
Humax
iCable_System
Infinite
Intel
Joohong
Leichu
LG
Linksys
Maspro
Matsushita
Mercury
Motorola
NEC
Netgear
Nortel
Opentech
Pace
Pacific
Panasonic
Philips
Pioneer
Ponico
PowerCom
QNS
RCA/Thomson
RiverDelta
SA
Saejin
Samsung
SMC
Sunrise
Syswave
Technotrend
Teledex
Telexy
Tellabs
Telogy
Terayon
TI
Tollgrade
Toshiba
TriGem
TurboComm
USRobotics
Woojyun
Zoom
ZyXel
Syntax
configure reset cable-modem vendor [rate]
Parameter
[rate]
Issue 2.0
Definition
Vendor name Maximum number of cable modems reset per seconds. Valid range is 1-20. Default is 20.
ARRIS PROPRIETARY — All Rights Reserved
CLI-935
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset slot Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets the module in the specified slot
Syntax
configure reset slot
Parameter
Definition
The chassis slot in which the targeted module resides. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
Example
To reset the Cable Access Module in Slot 15, use the following command: C4#
CLI-936
configure reset slot 15
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure reset system Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Resets the chassis. CAUTION
This is not a “gentle” reset. The reset happens regardless of any system activity. Syntax
configure reset system
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-937
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the route map. To remove the route-map, use the [no] option.
Syntax
configure route-map Parameter
CLI-938
Definition
Name of this route-map
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * deny Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that deny routes.
Syntax
configure route-map deny [] Parameter
Issue 2.0
Definition
Name of this route-map
[]
Sequence number
ARRIS PROPRIETARY — All Rights Reserved
CLI-939
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * deny * match as-path regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that deny routes used to match BGP autonomous system path information. To disable the function, use the [no] option.
Syntax
configure route-map deny [] match as-path regexp Parameter
CLI-940
Definition
Name of this route-map
[]
Sequence number
Regular expression to filter AS-path attribute
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * deny * match community regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that deny routes that matches a BGP community. To disable this function, use the [no] option.
Syntax
configure route-map deny [] match community regexp Parameter
Issue 2.0
Definition
Name of this route-map
[]
Matches a BGP community
Regular expression to filter on BGP community attributes
ARRIS PROPRIETARY — All Rights Reserved
CLI-941
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * deny * match ip address Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that deny routes that matches an IP address and denies routes based on destination network. Standard access-lists are not presently supported. Users desiring to filter on a standard access-list must manually convert the access-list to a prefix-list and apply the prefix-list. To disable this function, use the [no] option.
Syntax
configure route-map deny [] match ip address [] [prefix-list ] Parameter
Name of this route-map
[]
Matches a BGP community
[]
Standard access-list number. Valid range is 1-99
[prefix-list ]
CLI-942
Definition
Prefix list name
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * deny * match ip next-hop Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that deny routes that match the next-hop address of route. To disable this function, use the [no] option.
Syntax
configure route-map deny [] match ip next-hop [prefix-list ] Parameter
Name of this route-map
[]
Next-hop or sequence number of route
[prefix-list ]
Issue 2.0
Definition
Prefix-list name
ARRIS PROPRIETARY — All Rights Reserved
CLI-943
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * deny * match ip route-source Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that deny routes that matches based on address of advertising router. To disable this function, use the [no] option.
Syntax
configure route-map deny [] match ip route-source [prefix-list ] Parameter
Name of this route-map
[]
Sequence number.
[prefix-list ]
CLI-944
Definition
Prefix-list name
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * deny * match metric Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that deny routes that match the metric of the specified route. To disable this function, use the [no] option.
Syntax
configure route-map deny [] match metric ] Parameter
Name of this route-map
[]
Sequence number.
Issue 2.0
Definition
Metric value
ARRIS PROPRIETARY — All Rights Reserved
CLI-945
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * match as-path Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Used to match an autonomous system path information. To disable this feature, use the [no] option.
Syntax
configure route-map match as-path Parameter
CLI-946
Definition
Name of this route-map
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * match as-path regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Matches a BGP autonomous system path access list.
Syntax
configure route-map match as-path regexp
Parameter
Issue 2.0
Definition
Name of this route-map
Regular expression to filter AS-path attribute
ARRIS PROPRIETARY — All Rights Reserved
CLI-947
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * match community Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Matches a BGP community. To disable this feature, use the [no] option.
Syntax
configure route-map match community Parameter
CLI-948
Definition
Name of this route-map Regular expression to filter on BGP community
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * match ip address Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Distributes any routes that have a destination network number address that is permitted by a standard access list, an extended access list, or a prefix list, or to perform policy routing on packets. To remove the entry, use the [no] option.
Syntax
configure route-map match ip address [] [prefix-list ] Parameter
[] [prefix-list ]
Issue 2.0
Definition
Destination network IP address Name of a specific prefix list.
ARRIS PROPRIETARY — All Rights Reserved
CLI-949
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * match ip next-hop Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Redistributes any routes that have a next hop router address passed by one of the access lists specified. To remove the next hop entry, use the [no] option.
Syntax
configure route-map match ip next-hop [prefix-list ] Parameter
[prefix-list ]
CLI-950
Definition
Name of this route-map Name of a specific prefix list.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * match ip route-source Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Redistributes routes that have been advertised by routers and access servers at the address specified by the access lists. To remove the route-source entry, use the [no] option.
Syntax
configure route-map match ip route-source [prefix-list ] Parameter
[prefix-list ]
Issue 2.0
Definition
Name of this route-map Name of a specific prefix list.
ARRIS PROPRIETARY — All Rights Reserved
CLI-951
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * match metric Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure routes that match the metric of the specified route. To disable this function, use the [no] option.
Syntax
configure route-map match metric
Parameter
CLI-952
Definition
Name of this route-map Metric value
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures conditions that permit route.
Syntax
configure route-map permit [] Parameter
Issue 2.0
Definition
Name of this route-map
[]
Sequence number
ARRIS PROPRIETARY — All Rights Reserved
CLI-953
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * continue Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Use this command to continue the sequence of the match criteria. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] match continue [no] Parameter
CLI-954
Definition
Name of this route-map
[]
Sequence number
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * match as-path regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Use this command to match BGP autonomous system path information. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] match as-path regexp [no] Parameter
Issue 2.0
Definition
Name of this route-map
[]
Sequence number
Regular expression to filter AS-path attributes.
ARRIS PROPRIETARY — All Rights Reserved
CLI-955
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * match community Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Matches a BGP community. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] match community [no] Parameter
CLI-956
Definition
Name of this route-map
[]
Regular expression to filter on BGP community.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map* permit * match community regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Matches a BGP community. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] match community regexp [no] Parameter
Issue 2.0
Definition
Name of this route-map
[]
Sequence number
Regular expression to filter on BGP community.
ARRIS PROPRIETARY — All Rights Reserved
CLI-957
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * match ip address Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Selects a route based on the destination IP address. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] match ip address [prefix-list ] [no] Parameter
Definition
Name of this route-map
[]
Sequence number
[prefix-list ]
Prefix list number
CLI-958
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * match ip next-hop Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Matches the next-hop address of the route. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] match ip next-hop [prefix-list ] [no] Parameter
Name of this route-map
[]
Sequence number
[prefix-list ]
Issue 2.0
Definition
Prefix list name
ARRIS PROPRIETARY — All Rights Reserved
CLI-959
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * match ip route-source Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that permit routes based on matching the IP address of the advertising router. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] match ip route-source [prefix-list ] [no] Parameter
Name of this route-map
[]
Sequence number
[prefix-list ]
CLI-960
Definition
IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * match metric Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configure conditions that permit routes that match the metric of the specified route. To disable this function, use the [no] option.
Syntax
configure route-map permit [] match metric ] [no] Parameter
Name of this route-map
[]
Sequence number.
Issue 2.0
Definition
Metric value
ARRIS PROPRIETARY — All Rights Reserved
CLI-961
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set as-path prepend Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Appends a string to the autonomous system path. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] set as-path prepend [no] Parameter
CLI-962
Definition
Name of this route-map
[]
Sequence number
String of autonomous system numbers to append
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set comm-list delete no Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Removes communities from the community attribute of an update.
Syntax
configure route-map permit [] set comm-list delete no Parameter
Issue 2.0
Definition
Name of this route-map
[]
Sequence number
ARRIS PROPRIETARY — All Rights Reserved
CLI-963
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set comm-list delete regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Removes communities, using a regular expression, from the community attribute of an update.
Syntax
configure route-map permit [] set comm-list delete regexp Parameter
CLI-964
Definition
Name of this route-map
[]
Sequence number
Regular expression of communities to delete from the update
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set community Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets BGP community attributes.
Syntax
configure route-map permit [] set community [] [additive] [local-as] [no-advertise] [no-export] [internet] Parameter
Definition
Name of this route-map
[]
Sequence number Refers to a community either in the form : or a standard community. Supported standard communities are:
[]
local-AS - Do not send outside local AS (well-known community) no-advertise - Absolute no-export - do not export to next AS (well-known community) internet - Internet (well-known community)
[additive]
Add to the existing community
[local-as]
Do not send outside local AS (well-known community)
[no-advertise]
Do not advertise to any peer (well-known community)
[no-export]
Do not export to next AS (well-known community)
[internet]
Internet (well-known community)
Example
This command is also used to set the community of routes redistributed into BGP. For example: C4#
configure route-map redistribute set community internet configure router bgp redistribute ospf rout-map redistribute
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-965
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set community none Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Removes the communities of the update.
Syntax
configure route-map permit [] set community none Parameter
CLI-966
Definition
Name of this route-map
[]
Sequence number
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set dampening Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the BGP route dampening factors for the specified route. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] set dampening [no] Parameter
Issue 2.0
Definition
Name of this route-map
[]
Sequence number
Half-life time for the penalty in minutes
ARRIS PROPRIETARY — All Rights Reserved
CLI-967
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set ip next-hop Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures where the next-hop to send packets that match the specified routemap. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] set ip next-hop [no] Parameter
Name of this route-map
[]
Sequence number
CLI-968
Definition
IP address of the next hop
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set local-preference Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the local preference of routes within a specified local autonomous system. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] set local-preference [no] Parameter
Definition
Name of this route-map
[]
Sequence number
Local preference
Example
This command is also used to set the local-preference of routes redistributed into BGP. For example: C4#
configure rout-map redistribute set local-preference 50 configure router bgp redistrict ospf route-map redistribute
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-969
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set metric Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the metric value for destination routing protocols. To restore the default setting, use the [no] option.
Syntax
configure route-map permit [] set metric [no] Parameter
Name of this route-map
[]
Sequence number
CLI-970
Definition
MED value
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set origin Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the BGP origin code. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] set origin [no] Parameter
Name of this route-map
[]
Sequence number
Issue 2.0
Definition
BGP origin code: egp = remote EGP; igp = local EGP; incomplete = unknown heritage.
ARRIS PROPRIETARY — All Rights Reserved
CLI-971
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * permit * set weight Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies the BGP weight for the routing table. Weight can be altered by this command on routes learned from other BGP routers, but cannot be set on routes redistributed into BGP from other protocols. To return to the default setting, use the [no] option.
Syntax
configure route-map permit [] set weight [no] Parameter
Name of this route-map
[]
Sequence number
CLI-972
Definition
Weight
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Creates the policy route-map or enters the policy route-map command mode. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy [no] Parameter
Issue 2.0
Definition
Name of this route-map
ARRIS PROPRIETARY — All Rights Reserved
CLI-973
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set as-path prepend Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Appends a string to the autonomous system path. To return to the default setting, use the [no] option.
Syntax
configure route-map set as-path prepend [no] Parameter
CLI-974
Definition
String of autonomous system numbers to append
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set comm-list delete regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Removes communities, using a regular expression, from the community attribute of an update.
Syntax
configure route-map set comm-list delete regexp Parameter
Issue 2.0
Definition
Regular expression of communities to delete from the update
ARRIS PROPRIETARY — All Rights Reserved
CLI-975
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set community Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets BGP community attributes.
Syntax
configure route-map set community [] [additive] [local-as] [no-advertise] [no-export] [internet] Parameter
Definition
Refers to a community either in the form : or a standard community. Supported standard communities are: []
local-AS - Do not send outside local AS (well-known community) no-advertise - Absolute no-export - do not export to next AS (well-known community) internet - Internet (well-known community)
[additive]
Add to the existing community
[local-as]
Do not send outside local AS (well-known community)
[no-advertise]
Do not advertise to any peer (well-known community)
[no-export] [internet]
CLI-976
Do not export to next AS (well-known community) Internet (well-known community)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set community none Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Removes the communities of the update.
Syntax
configure route-map set community none
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-977
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set dampening Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the BGP route dampening factors for the specified route. To return to the default setting, use the [no] option.
Syntax
configure route-map set dampening [no] Parameter
CLI-978
Definition
Half-life time for the penalty in minutes
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set ip next-hop Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures where the next-hop to send packets that match the specified routemap. To return to the default setting, use the [no] option.
Syntax
configure route-map set ip next-hop [no] Parameter
Issue 2.0
Definition
IP address of the next hop
ARRIS PROPRIETARY — All Rights Reserved
CLI-979
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set local-preference Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the local preference of routes within a specified local autonomous system. To return to the default setting, use the [no] option.
Syntax
configure route-map set local-preference [no] Parameter
CLI-980
Definition
Local preference
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set metric Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the metric value for destination routing protocols. To restore the default setting, use the [no] option.
Syntax
configure route-map set metric [no] Parameter
Issue 2.0
Definition
MED value
ARRIS PROPRIETARY — All Rights Reserved
CLI-981
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set origin Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the BGP origin code. To return to the default setting, use the [no] option.
Syntax
configure route-map set origin [no] Parameter
Definition
BGP origin code: egp = remote EGP; igp = local EGP; incomplete = unknown heritage.
CLI-982
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map set weight Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies the BGP weight for the routing table. Weight can be altered by this command on routes learned from other BGP routers, but cannot be set on routes redistributed into BGP from other protocols. To return to the default setting, use the [no] option.
Syntax
configure route-map set weight [no] Parameter
Issue 2.0
Definition
Weight
ARRIS PROPRIETARY — All Rights Reserved
CLI-983
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * deny Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures conditions that deny the route. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy deny [no] Parameter
CLI-984
Definition
Name of this route-map
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * deny match ip address Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures conditions that deny a route based on the IP address. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy deny match ip address [no] Parameter
Issue 2.0
Definition
Name of this route-map
Access list name or number
ARRIS PROPRIETARY — All Rights Reserved
CLI-985
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * match ip address Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures conditions that match the IP address based on the destination network. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy match ip address [no] Parameter
CLI-986
Definition
Name of this route-map
Access list name or number
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * permit Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures conditions that permit the route. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy permit [no] Parameter
Issue 2.0
Definition
Name of this route-map Sequence number
ARRIS PROPRIETARY — All Rights Reserved
CLI-987
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * permit * match ip address Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures conditions that denies a match based on the IP address based on the destination network. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy permit match ip address [no] Parameter
CLI-988
Definition
Name of this route-map Access list name or number IPv4 or IPv6 address.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * permit * set ip backup-next-hop Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures where to output packets that match the route-map. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy permit set ip backup-next-hop [no] Parameter
Issue 2.0
Definition
Name of this route-map Sequence number IPv4 or IPv6 address.
ARRIS PROPRIETARY — All Rights Reserved
CLI-989
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * permit * set ip interface null Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures a route map to null interface to drop certain traffic. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy permit set ip interface null [no] Parameter
CLI-990
Definition
Name of this route-map
Sequence number
Null interface zero
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * permit * set ip next-hop Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures where to output packets that match the route-map. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy permit set ip next-hop [no] Parameter
Issue 2.0
Definition
Name of this route-map Sequence number IPv4 or IPv6 address.
ARRIS PROPRIETARY — All Rights Reserved
CLI-991
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * permit * set ip precedence Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the IP precedence values. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy permit set ip precedence [no] Parameter
CLI-992
Definition
Name of this route-map Sequence number
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map-policy * permit * set ip tos Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the IP TOS values. To return to the default setting, use the [no] option.
Syntax
configure route-map-policy permit set ip tos [no] Parameter
Issue 2.0
Definition
Name of this route-map Sequence number
ARRIS PROPRIETARY — All Rights Reserved
CLI-993
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set as-path prepend Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Modifies autonomous system path for BGP routes. To return to the default setting, use the [no] option.
Syntax
configure route-map set as-path prepend Parameter
CLI-994
Definition
Name of this route-map
Sequence of autonomous system to prepend onto prepend string sent to neighbor
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set comm-list delete regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Removes communities from the community attribute of an update using a regular expression. To return to the default setting, use the [no] option.
Syntax
configure route-map set comm-list delete regexp Parameter
Issue 2.0
Definition
Name of this route-map
A regular expression of communities to delete from the update
ARRIS PROPRIETARY — All Rights Reserved
CLI-995
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set community Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the communities attribute. To return to the default setting, use the [no] option.
Syntax
configure route-map set community [] [additive]
Parameter
Definition
Name of this route-map Refers to a community either in the form : or a standard community. Supported standard communities are:
CLI-996
[]
local-AS no-advertise no-export internet
- Do not send outside local AS (well-known community) - Absolute - do not export to next AS (well-known community) - Internet (well-known community)
[additive]
The community added to the existing community
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set community add Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Adds the specified community to the set of communities in the route. To return to the default setting, use the [no] option.
Syntax
configure route-map set community add [] [no]
Parameter
Definition
Name of this route-map Refers to a community either in the form : or a standard community. Supported standard communities are:
[]
Issue 2.0
local-AS no-advertise no-export internet
- Do not send outside local AS (well-known community) - Absolute - do not export to next AS (well-known community) - Internet (well-known community)
ARRIS PROPRIETARY — All Rights Reserved
CLI-997
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set community additive Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Adds to the specified community. To return to the default setting, use the [no] option.
Syntax
configure route-map set community additive [] [no]
Parameter
Definition
Name of this route-map Refers to a community either in the form : or a standard community. Supported standard communities are:
[]
CLI-998
local-AS no-advertise no-export internet
- Do not send outside local AS (well-known community) - Absolute - do not export to next AS (well-known community) - Internet (well-known community)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set community delete Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Deletes the specified community in the set of communities in the route. To return to the default setting, use the [no] option.
Syntax
configure route-map set community delete [] [no]
Parameter
Definition
Name of this route-map Refers to a community either in the form : or a standard community. Supported standard communities are:
[]
Issue 2.0
local-AS no-advertise no-export internet
- Do not send outside local AS (well-known community) - Absolute - do not export to next AS (well-known community) - Internet (well-known community)
ARRIS PROPRIETARY — All Rights Reserved
CLI-999
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set community none Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Removes the community from the route.
Syntax
configure route-map set community none
Parameter
Definition
Refers to a community either in the form : or a standard community. Supported standard communities are:
CLI-1000
local-AS no-advertise no-export internet
- Do not send outside local AS (well-known community) - Absolute - do not export to next AS (well-known community) - Internet (well-known community)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set dampening Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines the BGP route dampening factors for the specified route. To return to the default setting, use the [no] option.
Syntax
configure route-map set dampening Parameter
Issue 2.0
Definition
Name of this route-map
[]
Sequence number
Half-life time for the penalty in minutes
ARRIS PROPRIETARY — All Rights Reserved
CLI-1001
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set ip next-hop Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Defines where to output packets matching the specified route-map. To return to the default setting, use the [no] option.
Syntax
configure route-map [vrf ] set ip next-hop Parameter
[vrf ]
CLI-1002
Definition
The name assigned to the virtual router Name of this route-map Next hop IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set local-preference Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the preference of routes within the local autonomous system. To return to the default setting, use the [no] option.
Syntax
configure route-map [vrf ] set local-preference Parameter
[vrf ]
Issue 2.0
Definition
The name assigned to the virtual router Name of this route-map Local preference
ARRIS PROPRIETARY — All Rights Reserved
CLI-1003
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set metric Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the metric value for the destination routing protocol. To return to the default setting, use the [no] option.
Syntax
configure route-map [vrf ] set metric Parameter
[vrf ]
CLI-1004
Definition
The name assigned to the virtual router Name of this route-map MED value
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set origin Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the BGP origin code. To return to the default setting, use the [no] option.
Syntax
configure route-map set origin Parameter
Issue 2.0
Definition
Name of this route-map BGP origin code: egp = remote EGP; igp = local EGP; incomplete = unknown heritage.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1005
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure route-map * set weight Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies the BGP weight for the specified routing table. Weight can be altered by this command on routes learned from other BGP routers, but cannot be set on routes redistributed from other protocols. To return to the default setting, use the [no] option.
Syntax
configure route-map set weight Parameter
CLI-1006
Definition
Name of this route-map Weight
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures BGP. BGP requires a unique router-id to function correctly. The default router-id is computed from the IP addresses of the interfaces. If there are no interfaces configured, then the user will receive an error message to the effect: “No Interfaces have been assigned to this VRF, default router-Id cannot be calculated”. The user can work around this problem by entering a router id as the first bgp command. Example: “configure router bgp 100 bgp router-id 10.1.1.1 To disable BGP, use the [no] option. NOTE When configuring BGP for the first time, or when deleting an instance of BGP, the autonomous system number is required.
Syntax
configure router bgp [] Parameter
[]
Definition
Autonomous System (AS) number. Valid range is 1-65535
Related Command(s)
configure router bgp * bgp always-compare-med
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1007
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * aggregate-address Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the routes that match the aggregate IP address and mask to be aggregated. The aggregate routes and the specific routes would be advertised out. To disable, use the [no] option.
Syntax
configure router bgp aggregate-address [no] Parameter
CLI-1008
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address of the aggregate. Aggregate mask.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * aggregate-address * * as-set summary-only Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the routes so that only the aggregate route would be advertised out and the aggregate route would have the AS_PATHS of all the specific routes. To disable, use the [no] option.
Syntax
configure router bgp aggregate-address as-set summary-only [no] Parameter
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address of the aggregate. Aggregate mask.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1009
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * aggregate-address * * as-set summary-only advertisemap Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies which routes are not to get aggregated. Attributes of the not-aggregated specific routes would not be inherited by the aggregate route. The notaggregated specific routes would be advertised out in addition to the aggregate route. To disable, use the [no] option.
Syntax
configure router bgp aggregate-address as-set summary-only advertise-map [no] Parameter
CLI-1010
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address of the aggregate. Aggregate mask. Your advertised map.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * aggregate-address * * as-set summary-only attributemap Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the Community attribute on the aggregate route giving the user a chance to change, for the aggregate route, the otherwise inherited Community attributes from the specific routes. To disable, use the [no] option.
Syntax
configure router bgp aggregate-address as-set summary-only attribute-map [no] Parameter
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address of the aggregate. Aggregate mask. Your attribute map.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1011
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * aggregate-address * * as-set suppress-map Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Specifies which specific routes are not to get aggregated. However, the attributes of the suppressed specific routes are inherited by the aggregate route. The attribute-map can be used to override the inherited attributes. The nonsuppressed specific routes would be advertised out in addition to the aggregate route. Removing the option “as-set” would cause the aggregate route not to inherit the AS_PATH attributes from the specific routes. To disable, use the [no] option.
Syntax
configure router bgp aggregate-address [as-set] suppress-map [no] Parameter
CLI-1012
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address of the aggregate. Aggregate mask. Your suppressed map.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp always-compare-med Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Multi-Exit-Discriminator (MED) is not usually compared between routes from different autonomous systems. This command enables such comparison. Default is disabled. To disable the comparison, use the [no] option.
Syntax
configure router bgp [] bgp always-compare-med Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535
ARRIS PROPRIETARY — All Rights Reserved
CLI-1013
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp cluster-id Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the cluster ID if the BGP cluster has more than one route reflector. To remove the cluster ID, use the [no] option.
Syntax
configure router bgp [] bgp cluster-id Parameter
[]
CLI-1014
Definition
Autonomous System (AS) number. Valid range is 1-65535 Route Reflector cluster identifier
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp confederation identifier Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the confederation parameters. To remove the confederation parameter, use the [no] option.
Syntax
configure router bgp [] bgp confederation identifier Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 Confederation AS number that internally includes multiple autonomous systems.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1015
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp default local-preference Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Changes the default local preference. To return to the default setting, use the [no] option.
Syntax
configure router bgp [] bgp default local-preference Parameter
[]
CLI-1016
Definition
Autonomous System (AS) number. Valid range is 1-65535 Local preference value
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp deterministic-med Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables BGP deterministic comparison of the MED variable between all paths from the same autonomous system. To disable the comparison, use the [no] option.
Syntax
configure router bgp [] bgp deterministic-med Parameter
[]
Definition
Autonomous System (AS) number. Valid range is 1-65535
Related Command(s)
configure router bgp * bgp always-compare-med
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1017
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp graceful-restart Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables the BGP graceful restart capability. To restore the stem to its default condition, use the [no] option.
Syntax
configure router bgp [] bgp graceful-restart Parameter
[]
CLI-1018
Definition
Autonomous System (AS) number. Valid range is 1-65535
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp graceful-restart purge-time Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Sets the maximum time before stale routes are purged following the local BGP restart.. To restore the stem to its default condition, use the [no] option.
Syntax
configure router bgp [] bgp graceful-restart purgetime [no] Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 Time in seconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-1019
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp graceful-restart restart-time Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum time to wait for a graceful-restart-capable neighbor to recover after a restart. To restore the system to its default condition, use the [no] option.
Syntax
configure router bgp [] bgp graceful-restart restart-time Parameter
[]
CLI-1020
Definition
Autonomous System (AS) number. Valid range is 1-65535 Time in seconds
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp graceful-restart stalepaths-time Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum time to hold on to the stale paths of a gracefully restarted neighbor to come back up after a restart. All stale paths are deleted after the expiration of this timer. To restore the system to its default condition, use the [no] option.
Syntax
configure router bgp [] bgp graceful-restart stalepaths-time Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 Time in seconds
ARRIS PROPRIETARY — All Rights Reserved
CLI-1021
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp pause-threshold Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Limits the amount of work that is carried out in each cycle of the N-BASE scheduler. To unlimit the amount of work that is carried out in each cycle, use the [no] option.
Syntax
configure router bgp [] bgp pause-threshold Parameter
[]
CLI-1022
Definition
Autonomous System (AS) number. Valid range is 1-65535 Default value is 2000
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * bgp router-id
Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures a fixed BGP router ID for a BGP-speaking router. NOTE Ordinarily the AS number is optional with this command. However, it becomes mandatory if BGP is configured before any interfaces have been configured. In that case, this must be the first BGP command. To restore the default value of the router ID, use the [no] option. NOTE The default router-id is the highest loopback address, if there is one, or the highest interface address in the absence of a loopback.
Syntax
configure router bgp [] bgp router-id Parameter
[]
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address of the desired router ID
Related Command(s)
configure router bgp * bgp always-compare-med
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1023
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * distance Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the administrative distance for BGP routes. To remove the distance definition, use the [no] option.
Syntax
configure router bgp [] distance [no] Parameter
[]
CLI-1024
Definition
Autonomous System (AS) number. Valid range is 1-65535
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * distance bgp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the administrative distance for subsets of BGP routes.
Syntax
configure router bgp [] distance bgp Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535
Administrative distance for external BGP routes
Administrative distance for internal BGP routes
ARRIS PROPRIETARY — All Rights Reserved
CLI-1025
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * distribute-list * out connected Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures filtering for outbound BGP routes for routes originating from a connected source. To disable this function, use the [no] option.
Syntax
configure router bgp [] distribute-list out connected Parameter
CLI-1026
Definition
[]
Autonomous System (AS) number. Valid range is 1-65535
Access list used for filtering
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * distribute-list * out isis Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures filtering for outbound BGP routes for the IS-IS routing process. To disable this function, use the [no] option.
Syntax
configure router bgp [] distribute-list out isis Parameter
Issue 2.0
Definition
[]
Autonomous System (AS) number. Valid range is 1-65535
Access list used for filtering
ARRIS PROPRIETARY — All Rights Reserved
CLI-1027
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * distribute-list * out ospf
Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures filtering for outbound BGP routes for the OSPF routing process. To disable this function, use the [no] option.
Syntax
configure router bgp [] distribute-list out ospf Parameter
CLI-1028
Definition
[]
Autonomous System (AS) number. Valid range is 1-65535
Access list used for filtering
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * distribute-list * out rip Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures filtering for outbound BGP routes for the RIP routing process. To disable this function, use the [no] option.
Syntax
configure router bgp [] distribute-list out rip Parameter
Issue 2.0
Definition
[]
Autonomous System (AS) number. Valid range is 1-65535
Access list used for filtering
ARRIS PROPRIETARY — All Rights Reserved
CLI-1029
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * distribute-list * out static Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures filtering for outbound BGP routes for a static routing process. To disable this function, use the [no] option.
Syntax
configure router bgp [] distribute-list out static Parameter
CLI-1030
Definition
[]
Autonomous System (AS) number. Valid range is 1-65535
Access list used for filtering
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * maximum-paths Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of Equal Cost BGP paths to control the number of parallel routes an IP routing protocol can support. To restore the default value, use the [no] option.
Syntax
configure router bgp maximum-paths Parameter
Issue 2.0
Definition
Maximum path for external BGP
ARRIS PROPRIETARY — All Rights Reserved
CLI-1031
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * maximum-paths * ibgp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum paths for Internal BGP (IBGP) routes that can be installed in a routing table. To restore the default value, use the
Syntax
configure router bgp maximum-paths ibgp Parameter
CLI-1032
Definition
Maximum number of parallel routes for external BGP
Maximum number of parallel routes for internal BGP (IBGP)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * advertisement-interval Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the minimum route advertisement interval. To remove an entry, use the [no] option.
Syntax
configure router bgp [] neighbor advertisement-interval [withdraw-interval ] Parameter
Definition
[]
Autonomous System (AS) number. Valid range is 1-65535
IP address.
[advertisement-interval ] [withdraw-interval ]
Issue 2.0
Value in seconds. Minimum interval between routing updates. Valid range is 0-600 seconds. Value in seconds. Allows a withdrawn to be sent more before the next update. Valid range is 0-600 seconds.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1033
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * as-origin-interval Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the minimum interval between originating routes from the AS. To remove an entry, use the [no] option.
Syntax
configure router bgp [] neighbor as-origin-interval Parameter
[]
CLI-1034
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address. Minimum interval in seconds between routing updates. Valid range is 165535.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * confed Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the neighbor as a confederation member. To remove the member, use the [no] option.
Syntax
configure router bgp [] neighbor confed Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
CLI-1035
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * connect-retry Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the connection retry interval. To remove the member, use the [no] option.
Syntax
configure router bgp [] neighbor connect-retry Parameter
[]
CLI-1036
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address Connect retry interval value. Valid range is 1-65535
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * enforce-first-as Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the CMTS to require the neighbors to send their AS as the first AS number in their AS_SEQUENCE. To remove the restriction, use the [no] option.
Syntax
configure router bgp [] neighbor enforce-first-as Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
CLI-1037
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * maximum-prefix Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of prefixes that can be accepted from this neighbor. This command is disabled by default. To return to the default, use the [no] option.
Syntax
configure router bgp [] neighbor maximum-prefix Parameter
[]
CLI-1038
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address Specifies upper limit of route to receive from neighbor. No such limit exists by default.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * maximum-prefix * warning-only Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the router to generate a log message when the maximum prefix limit is exceeded instead of terminating the peering session. To disable this function, use the [no] option.
Syntax
configure router bgp [] neighbor maximum-prefix warning-only Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address Specifies upper limit of route to receive from neighbor. No such limit exists by default.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1039
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * next-hop-self Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of prefixes that can be accepted from this neighbor. This command is disabled by default. To disable the next-hop processing, use the [no] option.
Syntax
configure router bgp [] neighbor next-hop-self Parameter
[]
CLI-1040
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * passive Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the maximum number of prefixes that can be accepted from this neighbor. This command is disabled by default. To enable connection initiation (passive open), use the [no] option.
Syntax
configure router bgp [] neighbor passive Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
CLI-1041
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * password Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enables Message Digest 5 (MD5) authentication on TCP connections between BGP neighbors. To disable the password, use the [no] option.
Syntax
configure router bgp [] neighbor password Parameter
[]
CLI-1042
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address Specifies the case-sensitive BGP password. By default, none exists.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * prefix-list * in Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the name of the prefix list to filter inbound updates from the neighbor. To disable the prefix list to filter, use the [no] option.
Syntax
configure router bgp [] neighbor prefix-list in Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address Specifies the name of the prefix list to filter inbound updates from the neighbor. By default, no such reference exists.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1043
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * prefix-list * out Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the name of the prefix list to filter outbound updates to the neighbor. To remove the name of the prefix list to filter, use the [no] option.
Syntax
configure router bgp [] neighbor prefix-list out Parameter
[]
CLI-1044
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address Specifies the name of the prefix list to filter outbound updates to the neighbor. By default, no such reference exists.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * remote-as Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
This command creates a new neighbor. This command should only be used on directly connected neighbors or when there is only one interface that handles BGP traffic. If the neighbor is not directly connected, the first neighbor command should be configure router bgp * neighbor * update-source cablemac * remote-as on page CLI-1055 The IP address of the specified neighbor by the update-source option is used by the other routes to reference the CMTS in their neighbor commands. If the initial neighbor command does not contain the update-source, then the other routers will reference us by the directly connected physical interface on the CMTS. NOTE We do not allow the update-source to be specified after a neighbor is created.
Syntax
configure router bgp [] neighbor remote-as Parameter
[]
Definition
Autonomous System (AS) number. Valid range is 1-65535
IP address
Specifies the autonomous system number of the neighbor. REQUIRED when neighbor is created.
Related Command(s)
configure router bgp * neighbor * update-source loopback * remote-as
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1045
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * remove-private-as Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Removes private Autonomous Systems (AS) from the autonomous system path. To reestablish private AS on outbound updates, use the [no] option.
Syntax
configure router bgp [] neighbor remove-private-as [no] Parameter
[]
CLI-1046
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * route-map * in Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the name of the route-map used to apply policy for routes inbound from the neighbor. By default, no such policy reference exists. To remove a route map, use the [no] option.
Syntax
configure router bgp [] neighbor route-map in Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address Name of the route map
ARRIS PROPRIETARY — All Rights Reserved
CLI-1047
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * route-map * out Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the name of the route-map used to apply policy for routes outbound to the neighbor. By default, no such policy reference exists. To remove the name of the route-map used to apply policy for routes outbound for a neighbor, use the [no] option.
Syntax
configure router bgp [] neighbor route-map out Parameter
[]
CLI-1048
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address Outbound route-map to filter
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * route-reflector-client Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the router as a BGP route reflector and the specified neighbor as its a route reflector client. To remove a specified neighbor as a route reflector client, use the [no] option.
Syntax
configure router bgp [] neighbor route-reflector-client Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
CLI-1049
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * route-reflector-client meshed Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the router as a BGP route reflector and the specified neighbor as a meshed route reflector client. To disable this function, use the [no] option.
Syntax
configure router bgp [] neighbor route-reflector-client meshed Parameter
[]
CLI-1050
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * route-refresh Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Triggers a route refresh for the specified neighbor. NOTE This command is equivalent to clear ip mroute counters on page CLI-65
Syntax
configure router bgp [] neighbor route-refresh Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
CLI-1051
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * shutdown Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Forces an administrative shutdown of the specified neighbor. To store the specified neighbor, use the [no] option.
Syntax
configure router bgp [] neighbor shutdown Parameter
[]
CLI-1052
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * split-horizon Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures routes with a BGP next-hop equal to the neighbor’s address to not send to that neighbor. To store the specified neighbor, use the [no] option.
Syntax
configure router bgp [] neighbor split-horizon Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
ARRIS PROPRIETARY — All Rights Reserved
CLI-1053
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * timers Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the keepalive and holdtime of the specified neighbor. To clear the keepalive and holdtime of a specified neighbor, use the [no] option.
Syntax
configure router bgp [] neighbor timers Parameter
[]
CLI-1054
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address
The frequency (in seconds) that a keepalive message is sent to its peer. Valid range is 0-65535.
The interval (in seconds) after not receiving a response that a peer is considered dead. Valid range is 0-65535.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * update-source cable-mac * remote-as Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the source address for the session.
Syntax
configure router bgp [] neighbor update-source cable-mac remote-as Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address The MAC identifier. Valid numbers are 0-415. Autonomous System (AS) number of the neighbor
ARRIS PROPRIETARY — All Rights Reserved
CLI-1055
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * update-source gigabitethernet * remote-as Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the source address for the session.
Syntax
configure router bgp [] neighbor update-source gigabitethernet remote-as
Parameter
[]
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP address RCM slot number/gigabitEthernet port number.
/port>
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-1056
Autonomous System (AS) number of the neighbor
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * update-source ip-address * remote-as Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the source address for the session.
Syntax
configure router bgp [] neighbor update-source ip-address remote-as Parameter
[]
Autonomous System (AS) number. Valid range is 1-65535
IP address
Source IP address
Issue 2.0
Definition
Autonomous System (AS) number of the neighbor
ARRIS PROPRIETARY — All Rights Reserved
CLI-1057
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * update-source loopback * remote-as Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the first neighbor command for a neighbor who is not directly connected. The IP address of the specified neighbor by the update-source option is used by the other routes to reference the CMTS in their neighbor commands. If the initial neighbor command does not contain the update-source, then the other routers will reference us by the directly connected physical interface on the CMTS. NOTE We do not allow the update-source to be specified after a neighbor is created.
Syntax
configure router bgp [] neighbor update-source loopback remote-as Parameter
[]
Autonomous System (AS) number. Valid range is 1-65535
IP address
The Loopback interface number. Valid range is 0-15.
CLI-1058
Definition
Autonomous System (AS) number of the neighbor
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * neighbor * update-source tengigabitethernet * remote-as Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the source address for the session.
Syntax
configure router bgp [] neighbor update-source tengigabitethernet remote-as Parameter
[]
Definition
Autonomous System (AS) number. Valid range is 1-65535 IP addressv RCM slot number/tengigabitEthernet port number.
/
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
Autonomous System (AS) number of the neighbor
ARRIS PROPRIETARY — All Rights Reserved
CLI-1059
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * redistribute connected Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures redistribute connected routes into BGP. To disable the connected routes, use the [no] option.
Syntax
configure router bgp [] redistribute connected [metric ] [route-map ] Parameter
[] [metric ] [route-map ]
CLI-1060
Definition
Autonomous System (AS) number. Valid range is 1-65535 Metric associated with redistributed routes Route-map used to modify BGP attributes of redistributed routes
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * redistribute isis Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures redistribution routes from Intermediate System-to-Intermediate System (IS-IS) routing processes into a Border Gateway Protocol (BGP) autonomous system. To restore the system to its default condition, use the [no] option.
Syntax
configure router bgp [] redistribute isis [] [metric ] [route-map ] Parameter
Definition
[]
Autonomous System (AS) number. Valid range is 1-65535
[] [metric ] [route-map ]
Issue 2.0
Enumerates the type of IS-IS routes to redistribute into BGP. Metric associated with redistributed routes Route-map used to modify BGP attributes of redistributed routes
ARRIS PROPRIETARY — All Rights Reserved
CLI-1061
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * redistribute ospf Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures redistribution routes from OSPF routing processes into a Border Gateway Protocol (BGP) autonomous system. To disable redistribution, use the [no] option.
Syntax
configure router bgp [] redistribute ospf [match ] [metric ] [route-map ] Parameter
Definition
[]
Autonomous System (AS) number. Valid range is 1-65535
[match ] [metric ] [route-map ]
CLI-1062
The type of OSPF routes to redistribute into BGP. Metric associated with redistributed routes Route-map used to modify BGP attributes of redistributed routes
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * redistribute rip Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures redistribution routes from RIP routing processes into a Border Gateway Protocol (BGP) autonomous system. To disable the redistribution, use the [no] option.
Syntax
configure router bgp [] redistribute rip [metric ] [route-map ] Parameter
[] [metric ] [route-map ]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535 Metric associated with redistributed routes Route-map used to modify BGP attributes of redistributed routes
ARRIS PROPRIETARY — All Rights Reserved
CLI-1063
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * redistribute static Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures redistribution routes from static routes into a Border Gateway Protocol (BGP) autonomous system. To disable the redistribution, use the [no] option.
Syntax
configure router bgp [] redistribute static [metric ] [route-map ] Parameter
[] [metric ] [route-map ]
CLI-1064
Definition
Autonomous System (AS) number. Valid range is 1-65535 Metric associated with the redistributed routes. Route-map used to modify BGP attributes of redistributed routes
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router bgp * shutdown Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Disables the administrative state of BGP. To enable the administrative state of BGP, use the [no] option.
Syntax
configure router bgp [] shutdown Parameter
[]
Issue 2.0
Definition
Autonomous System (AS) number. Valid range is 1-65535
ARRIS PROPRIETARY — All Rights Reserved
CLI-1065
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Places the system into an intermediate mode. To disable IS-IS, enter the [no] option.
Syntax
configure router isis [no]
CLI-1066
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis address-family Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Enters the router specified IS-IS configuration mode. To leave the configuration mode, use the [no] option.
Syntax
configure router isis address-family [no] Parameter
Issue 2.0
Definition
ipv4
Allows setting IPv4 IS-IS parameters.
ipv6
Allows setting IPv6 IS-IS parameters.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1067
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis address-family ipv4 distance Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the administrative distance for IS-IS routes. To remove the administrative distance, use the [no] option.
Syntax
configure router isis address-family ipv4 distance [no] Parameter
CLI-1068
Definition
Administrative distance.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis address-family ipv4 distance * isis Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures the administrative distance for IS-IS routes. To remove the administrative distance, use the [no] option.
Syntax
configure router isis address-family ipv4 distance isis [external-level1 | external-level2 | internal-level1 | internal-level2] [no] Parameter
Issue 2.0
Definition
Administrative distance.
[external-level1]
Administrative distance for external level-1 IS-IS routes in the same VRF
[external-level2]
Administrative distance for external level-2 IS-IS routes in the same VRF
[internal-level1]
Administrative distance for internal level-1 IS-IS routes in the same VRF
[internal-level2]
Administrative distance for internal level-2 IS-IS routes in the same VRF
ARRIS PROPRIETARY — All Rights Reserved
CLI-1069
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis address-family ipv4 distribute-list * out * Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Configures filtering for IPv4 IS-IS routes. To remove the filtering, use the [no] option.
Syntax
configure router isis address-family ipv4 distribute-list out [connected | static | rip | ospf | bgp] [no] Parameter
[connected] [static] [rip]
CLI-1070
Definition
IP standard access list Filters IS-IS routes originating from a connected source. Filters IS-IS routes originating from a static configuration. Filters IS-IS routes originating from a RIP.
[ospf]
Filters IS-IS routes originating from a OSPF.
[bgp]
Filters IS-IS routes originating from a BGP.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis address-family ipv4 enable Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Indicates to IS-IS neighbors that the CMTS supports IPv4 TLVs. To turn off, use the [no] option.
Syntax
configure router isis address-family ipv4 enable [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1071
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis address-family ipv4 redistribute bgp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Redistributes routes from BGP routes into IS-IS. To disable the redistribution, use the [no] option.s.
Syntax
configure router isis address-family ipv4 redistribute bgp [metric ] [metric-type [no] Parameter
Definition
Import as level 1 route
Import as level 2 route
[metric ]
Metric associated with redistributed routes. Valid range is 0-16777214.
[metric-type ]
CLI-1072
Metric type associated with redistributed routes. Specify whether redistributed routes use internal or external metrics.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis address-family ipv4 redistribute connected Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Redistributes connected routes into IS-IS. To disable the redistribution, use the [no] option.s.
Syntax
configure router isis address-family ipv4 redistribute connected [metric ] [metric-type [no] Parameter
Definition
Import as level 1 route
Import as level 2 route
[metric ]
Metric associated with redistributed routes. Valid range is 0-16777214.
[metric-type ]
Issue 2.0
Metric type associated with redistributed routes. Specify whether redistributed routes use internal or external metrics.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1073
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
configure router isis address-family ipv4 redistribute ospf Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Redistributes OSPF routes into IS-IS. To disable the redistribution, use the [no] option.
Syntax
configure router isis address-family ipv4 redistribute ospf [match ] [metric ] [metric-type ] [no] Parameter
Definition
Import as level 1 route
Import as level 2 route
[match
Related Command(s)
enable
CLI-1216
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
du Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays disk (non-volatile memory) usage information.
Syntax
du
Example
To display the NV memory usage, type the following command: C4#
du The following is an example of the output returned by the system:
du reports file space in 512-byte units. 7751 ./ 649 ./cmts/ 641 ./cmts/sw/ 148 ./cmts/sw/config/ 1 ./cmts/sw/config/.profile.admin 1 ./cmts/sw/config/.profile.c4 139 ./cmts/sw/config/current.cfg 485 ./cmts/sw/mib/ 477 ./cmts/sw/mib/data/ 27 ./cmts/sw/mib/data/CardEntry.tbl 105 ./cmts/sw/mib/data/PortEntry.tbl 38 ./cmts/sw/mib/data/AuditEntry.tbl 1 ./cmts/sw/mib/data/EqDiagConfig.tbl 1 ./cmts/sw/mib/data/DiskVolumeEntry.tbl 1 ./cmts/sw/mib/data/EquipmentAudit.tbl 1 ./cmts/sw/mib/data/CadBridgeGroupGeneral.tbl 3 ./cmts/sw/mib/data/CadBridgeGroupEntry.tbl 12 ./cmts/sw/mib/data/CadBridgePortEntry.tbl 1 ./cmts/sw/mib/data/CadAging.tbl 9 ./cmts/sw/mib/data/CadIfDownstreamChannelEntry.tbl 72 ./cmts/sw/mib/data/CadIfCmtsModulationEntry.tbl 100 ./cmts/sw/mib/data/CadIfUpstreamChannelEntry.tbl 1 ./cmts/sw/mib/data/CadUpchannelParams.tbl
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1217
CLI Command Descriptions
1 1 1 6 1 1 1 1 9 1 2 1 1 1 1 1 2 1 1 2 1 1 1 1 1 1 1 1 1 1 2 1 1 1 1 1 1 1 6 2 1
CLI-1218
C4/C4c CMTS Rel. 8.0.7
./cmts/sw/mib/data/CadUnicastPollingEntry.tbl ./cmts/sw/mib/data/Dot1dTp.tbl ./cmts/sw/mib/data/DocsIfCmtsObjects.tbl ./cmts/sw/mib/data/DocsQosServiceClassEntry.tbl ./cmts/sw/mib/data/DocsDevEvent.tbl ./cmts/sw/mib/data/DocsDevEvControlEntry.tbl ./cmts/sw/mib/data/DocsDevTrapControl.tbl ./cmts/sw/mib/data/DocsSubMgtObjects.tbl ./cmts/sw/mib/data/DocsBpi2CmtsCACertEntry.tbl ./cmts/sw/mib/data/SnmpEngine.tbl ./cmts/sw/mib/data/SnmpTargetAddrEntry.tbl ./cmts/sw/mib/data/SnmpTargetParamsEntry.tbl ./cmts/sw/mib/data/SnmpTargetAddrExtEntry.tbl ./cmts/sw/mib/data/SnmpNotifyEntry.tbl ./cmts/sw/mib/data/SnmpNotifyFilterProfileEntry.tbl ./cmts/sw/mib/data/SnmpNotifyFilterEntry.tbl ./cmts/sw/mib/data/UsmUserEntry.tbl ./cmts/sw/mib/data/VacmContextEntry.tbl ./cmts/sw/mib/data/VacmSecurityToGroupEntry.tbl ./cmts/sw/mib/data/VacmAccessEntry.tbl ./cmts/sw/mib/data/VacmViewTreeFamilyEntry.tbl ./cmts/sw/mib/data/CadSysServerEntry.tbl ./cmts/sw/mib/data/CadSysServerEntry.tbl ./cmts/sw/mib/data/CadSysParams.tbl ./cmts/sw/mib/data/CadSysSystem.tbl ./cmts/sw/mib/data/CadSysSnmp.tbl ./cmts/sw/mib/data/CadSysConfiguration.tbl ./cmts/sw/mib/data/CadSysProcPolicingConfig.tbl ./cmts/sw/mib/data/CadSysSourceInterface.tbl ./cmts/sw/mib/data/SnmpCommunityEntry.tbl ./cmts/sw/mib/data/CadBpi2CmtsBaseEntry.tbl ./cmts/sw/mib/data/CadTrapLogGlobals.tbl ./cmts/sw/mib/data/CadEvControlEntry.tbl ./cmts/sw/mib/data/CadEvOverrideEntry.tbl ./cmts/sw/mib/data/CadCliAuthToLogLevelEntry.tbl ./cmts/sw/mib/data/CadIpCidrRouteEntry.tbl ./cmts/sw/mib/data/CadVrNameEntry.tbl ./cmts/sw/mib/data/CadVrEntry.tbl ./cmts/sw/mib/data/CadVrInterfaceEntry.tbl ./cmts/sw/mib/data/CadVrSecondaryIpAddrEntry.tbl ./cmts/sw/mib/data/CadVrGlobals.tbl
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
1 1 2 1 5 1 2 1 6 1 1 1 1 1 1 2 1 1 1 1 1 1 1 1 1 2 1 1 2 1 1 33 9 1 1 1 1 1 1 1 1
Issue 2.0
./cmts/sw/mib/data/CadVrDhcpServerEntry.tbl ./cmts/sw/mib/data/CadDhcpThrottle.tbl ./cmts/sw/mib/data/CadRip2IfConfEntry.tbl ./cmts/sw/mib/data/CadRip2ConfEntry.tbl ./cmts/sw/mib/data/CadOspfIfEntry.tbl ./cmts/sw/mib/data/CadOspfIfMetricEntry.tbl ./cmts/sw/mib/data/CadOspfEntprIntfEntry.tbl ./cmts/sw/mib/data/CadDQoSConfigBase.tbl ./cmts/sw/mib/data/CadLineEntry.tbl ./cmts/sw/mib/data/CadAuthMethodEntry.tbl ./cmts/sw/mib/data/CadSshConfig.tbl ./cmts/sw/mib/data/CadPasswordEntry.tbl ./cmts/sw/mib/data/CadAuthorizationMethodEntry.tbl ./cmts/sw/mib/data/CadEnablePasswordEntry.tbl ./cmts/sw/mib/data/CadPCMibBase.tbl ./cmts/sw/mib/data/CadPCCAMEntry.tbl ./cmts/sw/mib/data/CadEvMsgMibBase.tbl ./cmts/sw/mib/data/CadPolicyAclEntry.tbl ./cmts/sw/mib/data/CadClock.tbl ./cmts/sw/mib/data/CadTod.tbl ./cmts/sw/mib/data/CadNtp.tbl ./cmts/sw/mib/data/CadNtpSource.tbl ./cmts/sw/mib/data/CadNtpSourceEntry.tbl ./cmts/sw/mib/data/CadDnsClientObjects.tbl ./cmts/sw/mib/data/CadIkeObjects.tbl ./cmts/sw/mib/data/CadCosToQosMappingEntry.tbl ./cmts/sw/mib/data/DocsLoadBalSystem.tbl ./cmts/sw/mib/data/CadPCMMConfigBase.tbl ./cmts/sw/mib/data/DsgIfDownstreamEntry.tbl ./cmts/sw/mib/data/CadCmRemoteQueryPoller.tbl ./cmts/sw/mib/data/ShelfObjects.tbl ./alias/ ./alias/aliaslist.txt ./alias/bpicli.txt ./alias/c4_status.txt ./alias/call_log.txt ./alias/cmlog.txt ./alias/eight_us_chan.txt ./alias/erasecfg.txt ./alias/exportcfg.txt ./alias/importcfg.txt
ARRIS PROPRIETARY — All Rights Reserved
CLI-1219
CLI Command Descriptions
1 1 1 1 1 5 0 15 1 1 1 1 1 6881 564 582 149 148 560 401 484 562 581 582 564 562 564 564 16 0 8 0 122 8 34 72
CLI-1220
C4/C4c CMTS Rel. 8.0.7
./alias/one_us_chan.txt ./alias/preeq_off.txt ./alias/preeq_phy20.txt ./alias/preeq_stab.txt ./alias/readregs.txt ./alias/stab_setup.txt ./tftpboot/ ./certs/ ./certs/DOCSISRootCACert.der ./certs/EuroDocsisRootCert.der ./certs/EuroDocsisRootCert.der ./certs/EuroDocsisRootCertTest.der ./certs/TestDocsisCert.der ./cfgfiles/ ./cfgfiles/2D_camred_crash.cfg ./cfgfiles/dsk001.cfg ./cfgfiles/router28_2d.cfg ./cfgfiles/router28_2d_nonon.cfg ./cfgfiles/router28_2d_temp.cfg ./cfgfiles/router28_3010229_disk.cfg ./cfgfiles/router28_30399_disk.cfg ./cfgfiles/router28_40258.cfg ./cfgfiles/router28_40261.cfg ./cfgfiles/router28_40262_disk.cfg ./cfgfiles/router28_40435_disk.cfg ./cfgfiles/sav.cfg ./cfgfiles/temp.cfg ./cfgfiles/temp40435.cfg ./sec/ ./sec/ike/ ./sec/ssh/ ./sec/ssh/server/ ./time/ ./time/tziso.txt ./time/tznames.txt ./time/tzrules.txt
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
echo Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Writes character strings to standard output. Strings are separated by spaces. To turn off the echoing of data to the terminal screen, use the [no] option.
Syntax
echo [no]
Parameter
Issue 2.0
Definition
Text to print to terminal screen. Useful in scripts.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1221
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
enable Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Allows the user access to the privileged mode commands. Password protection may be used to restrict access. If password protection has been invoked, you will be prompted to enter the password. To disable privileged access and return to User EXEC mode, use the [no] option. NOTE Passwords are defined on a privilege level and not defined by individual users so each level has its own unique password.
Syntax
enable [] [no]
Parameter
Definition
[]
Sets the privilege level. If no parameter is supplied, the default level is 15.
Related Command(s)
disable configure enable configure privilege exec level
CLI-1222
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
end Default Access Level
Mode
Privileged – 0
User EXEC
Purpose
Exits all submenus.
Syntax
end
Related Command(s)
exit quit
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1223
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
erase nvram Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Restores the current configuration to the default settings. To return to the “default” base configuration, you can either power cycle the CMTS or soft-reset the system using the config reset system command.
Syntax
erase nvram
Related Command(s)
configure reset system write memory
CLI-1224
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
exc file Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Executes CLI commands in the specified file. NOTE The execution of each command contained in this file is subject to the user’s current privilege level
Syntax
exc file
Parameter
Definition
Name of file containing CLI commands you want executed.
Example
To run the script file called alias.txt, type the following command: C4#
Issue 2.0
exc file alias.txt
ARRIS PROPRIETARY — All Rights Reserved
CLI-1225
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
exit Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Exit will back the user out of one nested command; exit all will exit out of all nested commands. Exit will log the user out if the user is not nested, exit all will not.
Syntax
exit [all]
Parameter
[all]
Definition
Will exit all nested modes.
Related Command(s)
logout quit
CLI-1226
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
format Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Formats the entire flash disk (non-volative memory). CAUTION
This command is destructive and irreversible. All system images, configuration data, pmd files, non-volatile log entries, aliases, and profiles will be destroyed. The system will not boot from a formatted disk until appropriate files have been restored. Syntax
format
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1227
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
help Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
This command gives a brief description of the help availlable online. The primary form of online help is by using the question mark '?'. If the command is not valid, an error message will be displayed on the line below, simply backup until the '?' starts showing valid option. Another indicator of an invalid command is autocompletion stops working. A will show when either the command is completed or a nested mode may be used. Other commands (in addition to '?') you should be aware of: help edit - will show control keys available for editing the command line. show all-commands - will generate a list of all commands. (this can be quite extensive). If you are looking for a specific group of commands, it is suggested you use the pipe ‘|’ placed after the command to narrow your search, e.g., show all-commands | include freq . This would show all commands that have a named parameter with "freq" in it Pipe '|' may also be placed after show commands, allowing the user to count, include/exclude various output.
Syntax
help
CLI-1228
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
help edit Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
This command displays the control keys that are available for editing the command line.
Syntax
help edit
Example
The following is the output generated from this command:
Available editing keystrokes Delete current character.....................Ctrl-d Delete text up to cursor.....................Ctrl-u Delete text up to cursor.....................Ctrl-x Delete text after cursor.....................Ctrl-k Move to beginning of line....................Ctrl-a Move to end of line..........................Ctrl-e Get prior command from history...............Ctrl-p Get next command from history................Ctrl-n Move cursor left.............................Ctrl-b Move cursor right............................Ctrl-f Move back one word...........................Esc-b Move forward one word........................Esc-f Convert rest of word to uppercase............Esc-u Convert rest of word to lowercase............Esc-l Convert word to mixed case...................Esc-c Delete remainder of word.....................Esc-d Delete word up to cursor.....................Ctrl-w Transpose previous and current character.....Ctrl-t Enter command and return to root prompt......Ctrl-z
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1229
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
history Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the contents of the CLI command history buffer.
Syntax
history
Example
To display the contents of the history buffer, type the following command: C4
history The system would respond with a list of recently typed commands: !1 !2 !3 !4 !5 !6 !7 !8 !9 !10 !11 !12 !13 !14 !15 !16 !17 !18 !19 !20
Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu Thu
Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb Feb
11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11
08:45:07 08:45:09 08:46:27 08:46:56 08:47:06 08:47:26 08:47:30 08:47:33 08:47:44 08:48:01 08:48:13 08:48:28 09:09:27 09:33:40 09:36:53 09:37:15 09:37:40 09:37:43 09:46:34 09:47:51
2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005
show version show users disable show environment show ip filter all show cable qos enable show cable qos show cable qos profile show ip scm access show ip filter all show environment show cable unicast-polling show users df du configure pagination du exc file alias.txt history
Related Command(s)
show history
CLI-1230
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
kill Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Terminates the specified CLI session.
Syntax
kill
Parameter
Issue 2.0
Definition
Session ID is obtained from “show users” command.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1231
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
kill console Default Access Level
Mode
Prompt
Privileged – 15
Privileged EXEC
C4#
Purpose
Disconnects the user from the specified console session.
Syntax
kill console
Parameter
CLI-1232
Definition
Console line number. Valid range is 0 or 1
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
kill vty Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Disconnects the user from the specified VTY session.
Syntax
kill vty
Parameter
Issue 2.0
Definition
VTY line number. Valid range is 0 or 15
ARRIS PROPRIETARY — All Rights Reserved
CLI-1233
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
logout Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Exits a CLI session.
Syntax
logout
Example
To log out of a CLI session, type the following command: C4>
CLI-1234
logout
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
mkdir Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Used to create a new directory.
Syntax
mkdir
Parameter
Definition
Name of the new directory you are creating
Example
To create a new directory called “backup”, type the following command: C4#
Issue 2.0
mkdir backup
ARRIS PROPRIETARY — All Rights Reserved
CLI-1235
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
more Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the contents of a file one screen at a time if pagination is enabled. To display the next screen of output, hit any key or to feed one line, or “Q” to quit. If pagination is not enabled, the entire file will be dumped to the screen.
Syntax
more
Parameter
CLI-1236
Definition
Name of the specified file
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
ping Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
The ping (Packet Internet Groper) command is a common method of troubleshooting the accessibility of devices. It sends a series of Internet Control Message Protocol (ICMP) echo-request packets to determine if a remote host is active or inactive. It also provides the round-trip delay in communicating with the host. NOTE If you specify the System Control Module’s (SCM’s) IP address with the ‘source-ip A.B.C.D.’ optional parameter, the source IP address for the ICMP packet will be the SCM’s IP address. The ping is successful only if the echo request gets to the destination and the destination is able to reply back to the source. Press ^C (the control key + C combination) to stop the ping process.
Syntax
ping [source | hostname] [repeatcount ] [timeout ] [size ] [tos ] [ttl ] [payload ] [validate]
Parameter
[source ] [repeat-count ]
Definition
Destination IP address (in the form A.B.C.D.) of the source ping packet Source IP address of the ping packet. Number of packets to send. Maximum value for repeat count is 32768. Default is 5.
[timeout ]
Specifies the timeout in seconds that the ECHO REPLY response should be received in response to the ECHO REQUEST. Range is 1 to 255. Default is 2.
[size ]
Specifies the datagram size in bytes. The range is 100 to 1480. Default is 100.
[tos ]
Specifies the type-of-service in the IP header of each ECHO REQUEST packet. Range is 0 to 255. Default is 0.
[ttl ]
Time-to-Live for the packet. Range is 1 to 255. Default is 64
[payload ] ICMP payload pattern in hex (e.g. ab, a9, 99) [validate]
Issue 2.0
Verify received packet matches sent
ARRIS PROPRIETARY — All Rights Reserved
CLI-1237
CLI Command Descriptions
Example
C4/C4c CMTS Rel. 8.0.7
To ping IP address 10.50.8.3, type the following command: C4>
ping 10.50.8.3 The following is an example of the output returned by the system: Sending IP ping to: 10.50.8.3 ping (10.50.8.3): 100 data bytes !!!!! 5 packets transmitted, 5 packets received
CLI-1238
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
ping docsis Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
The ping DOCSIS command provides a method of detecting intermittent plant issues by pinging a specified modem or CPE. This triggers the CMTS to schedule several station maintenance opportunities and records the results. These results can be used to isolate an issue between the CMTS and an upstream channel, a node, or the cable modem itself. Press ^C (the control key + C combination) to stop the ping process.
Syntax
ping docsis [count] [verbose] Parameter
Definition
pwd The following is an example of the output returned by the system: /system/
Related Command(s)
dir
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1247
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
quit Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
If you are in interface configure mode quit will return you to global configuration mode. If you are in user mode, quit closes your CLI session. If you are in privileged mode, you will need to type disable to return to user mode. If you type quit from privileged mode, you will terminate the CLI session.
Syntax
quit [all]
Parameter
Definition
Exits all intermediate modes.
Example
If you want to return to global configuration mode from interface configure mode, type the following command: C4>
quit
Related Command(s)
exit logout
CLI-1248
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
reload Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Reloads the CMTS from the file specified in the update partition. If no file name is specified then the current active image is reloaded. If the retain-patches keyword is used, the system performs the reload without first removing the existing patch files from the C4 CMTS disk. NOTE Any image booted using the reload update command is temporary, unless it is committed. If the system reboots for any reason while executing a reload update, it automatically reverts to the active partition image thereby backing out the update image.
Syntax
reload [update ] [retain-patches] [hitless]
Parameter
Definition
[update ] [retain-patches] [hitless]
Allows standard C4 patches to be installed with the new image Uses the hitless mode
Related Command(s)
show image show version
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1249
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
reload commit Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
If the system is active and modems are registered, this command will make the current running image the active image (includes an automatic write memory) which will maintain the new image across system reboots. If the executing image is the active image on the active partition and all firmware is up-to-date, this command does nothing. If the executing image is an update image on the update partition, firmware on all modules is programmed to non-volatile memory and the image is simply copied to the active partition. NOTE Committing a new image and new firmware can take up to 40 minutes to complete. The commit process runs in the background and does not impact service.
Syntax
reload commit
Example
To commit the new image and firmware, use the following command: C4#>
reload commit When prompted, answer yes to confirm the command only if the checksum is valid.
Related Command(s)
dir show image show version
CLI-1250
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
rmdir Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Used to remove a directory.
Syntax
rmdir
Parameter
Definition
Directory name
Related Command(s)
cd mkdir
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1251
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
scandisk Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Used to scan the physical surface of the flash disk for errors. It will take several minutes to run.
Syntax
scandisk [detail]
Parameter
[detail]
Example
Definition
Displays detailed information
To run scandisk with detailed information, use the following command: scandisk detail The system will respond with the following message: This command will run on the standby SCM. This command will take several minutes to complete All disk access will be disabled while this command is in progress This should not be run on a busy system. Are you sure you want to proceed with scandisk? (y/n) NOTE The chkdisk and scandisk commands always run on the System Control Module (SCM) that you are logged in to. On a duplex system it is recommended that you run these commands on the standby side in order not to affect the active SCM. To run the chkdisk or scandisk command on the standby SCM, you must use telnet to log in to the standby SCM. First telnet to the standby SCM. Be sure to add the colon “:” at the end: telnet clone: The system prompts you to log in. After a successful login the command prompt changes to indicate that you are logged into the standby controller: C4hostname-stdby# scandisk
CLI-1252
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
scandisk halt Default Access Level
Mode
Privileged – 15
Privileged EXEC
NOTE: Valid for C4 CMTS only. Purpose
Halts the scandisk process.
Syntax
scandisk halt
NOTE The chkdisk and scandisk commands always run on the System Control Module (SCM) that you are logged in to. On a duplex system it is recommended that you run these commands on the standby side in order not to affect the active SCM. To run the chkdisk or scandisk command on the standby SCM, you must use telnet to log in to the standby SCM. First telnet to the standby SCM. Be sure to add the colon “:” at the end: telnet clone: The system prompts you to log in. After a successful login the command prompt changes to indicate that you are logged into the standby controller: C4hostname-stdby# scandisk halt
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1253
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
send Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Allows a message to be sent to one or all terminal lines. NOTE Use multiple lines as needed, , /end terminates the message and use Ctrl-C to abort.
Syntax
send { | all | console | vty} []
Parameter
TTY number. Valid range is 0-17.
all
Sends the message to all sessions
console
Sends the message to specified console session
vty
Sends the message to the specified VTY session
[]
CLI-1254
Definition
Message to be sent. Use multiple lines as needed. /end terminates message and Crtl-C will abort message.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
send all Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Sends a message to all sessions.
Syntax
send all []
Parameter
[]
Issue 2.0
Definition
Message to be sent. Use multiple lines as needed. /end terminates message and Crtl-C will abort message.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1255
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
send console Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Sends a message to a specified console session.
Syntax
send console []
Parameter
[]
CLI-1256
Definition
Console line number Message to be sent. Use multiple lines as needed. /end terminates message and Crtl-C will abort message.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
send vty Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Sends a message to a specified VTY session.
Syntax
send vty []
Parameter
[]
Issue 2.0
Definition
Console line number Message to be sent. Use multiple lines as needed. /end terminates message and Crtl-C will abort message.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1257
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show access-list Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the configured ACLs. By default, all ACLs are displayed. If an accesslist-number is given, this command will only show that ACL entry.
Syntax
show access-list []
Parameter
Definition
[]
The number assigned to the access list. Valid values are 1-99 for Standard lists and 100-199 for Extended lists.
Example
To display the configured ACLs, use the following command: C4#
show access-list The following is an example of the output returned by the system:
Standard IP access list 1 10 permit 10.10.10.0, Wildcard bits 0.0.0.255 (124 matches) Implicit ‘deny any’ (5238 matches) Extended IP access list 100 10 permit ip 10.20.0.0 0.0.0.255 10.30.50.0 0.0.0.255 (12 matches) Implicit ‘deny any’ (854916 matches) NOTE ‘any’ indicates a source-ip of 0.0.0.0 and wildcard of 255.255.255.255; the displaying of the wildcard is omitted if it is 0.0.0.0. NOTE Because of software limitations, the show access list command returns null results for match counts for some operations. These operations are related to configuring router distribution lists, redistribution, and SNMP community strings. See the list below.
CLI-1258
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
The various forms of the commands listed below do not update the match counts for any ACLs associated with the interfaces affected by these commands:
Issue 2.0
•
configure router ospf [vrf ] distribute-list …
•
configure router ospf [vrf ] redistribute …
•
configure router rip redistribute rip
•
configure router rip [vrf ] distribute-list …
•
configure router rip [vrf ] redistribute …
•
configure snmp-server community
ARRIS PROPRIETARY — All Rights Reserved
CLI-1259
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show accounting Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the accounting methods lists.
Syntax
show accounting [detail]
Parameter
[detail]
CLI-1260
Definition
Shows detailed view of the accounting methods list
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show alias Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the entire list of command aliases. If a name is specified, then only the CLI command associated with that particular alias will be displayed.
Syntax
show alias []
Parameter
Definition
The abbreviation or replacement name to be used as an alias for a CLI command.
Example
To display the currently available command aliases, type the following command: C4>
show alias
NOTE Aliases vary from user to user. The following is an example of the output returned by the system: date sls sps rev slh log clh
Issue 2.0
show clock show linecard status show port status show version show logging history show logging history clear logging history
ARRIS PROPRIETARY — All Rights Reserved
CLI-1261
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show all-commands Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the available CLI commands. This command is extremely helpful when looking for specific commands.
Syntax
show all-commands
NOTE This command generates extensive output. It is recommended that you use a filter to refine your output. Filtering the show all-commands — Following is the output listing the choices available for filtering: C4>
show all-commands | ? count page begin exclude include until
Example
Only count lines that match, no display Only lines that match with pagination Begin with the line that matches Exclude lines that match Include lines that match Display until line that matches
To display a count of all commands with the keyword BGP as an option, type the following: C4>
show all-commands | count include bgp The following is an example of the output returned by the system: Piped line count: 134
Example
To filter and display all the current available commands containing the word “loopback”, type the following command: C4>
CLI-1262
show all-commands | include loopback
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
The following is an example of the output returned by the system: configure cable intercept source-interface loopback configure cable intercept source-interface loopback [] no configure cable modem remote-query source-interface loopback configure cable modem remote-query source-interface loopback no configure diag [] [repeat ] loopback configure interface loopback configure interface loopback description configure interface loopback description no configure interface loopback ip address configure interface loopback ip address [] [] no configure interface loopback ip ospf cost configure interface loopback ip ospf [cost ] no configure interface loopback ip vrf forwarding configure interface loopback ipv6 address [eui-64] [link-local] configure interface loopback ipv6 address [] [eui-64] [link-local] no configure interface loopback ipv6 enable configure interface loopback ipv6 enable no configure interface loopback ipv6 ospf no configure interface loopback ipv6 ospf area [instance ] configure interface loopback ipv6 ospf area [] [instance ] no configure interface loopback ipv6 ospf cost configure interface loopback ipv6 ospf cost [] no configure interface loopback isis ipv6 metric [{level-1 | level-2}] configure interface loopback isis ipv6 metric [{level-1 | level-2}] no configure interface loopback isis metric [{level-1 | level-2}] configure interface loopback isis metric [{level-1 | level-2}] no configure interface loopback isis wide-metric [{level-1 | level-2}] configure interface loopback isis wide-metric [{level-1 | level-2}] no configure interface loopback shutdown no configure interface loopback shutdown configure ipv6 dhcp relay source-interface loopback configure ipv6 dhcp relay source-interface loopback [] no configure router bgp [] neighbor update-source loopback remote-as configure router isis passive-interface Loopback configure router isis passive-interface Loopback no configure snmp-server trap-source loopback configure snmp-server trap-source loopback [] no ping ipv6 [repeat-count ] [source ] [timeout ] [size ] [tos ] [ttl ] [payload ] [validate] output-interface loopback show ip interface [brief] loopback [] show ipv6 interface [brief] loopback [] show ipv6 ospf interface [brief] loopback [] show running-config [linenum] [verbose] [full] interface loopback [verbose] [linenum] [full]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1263
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show arp Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Address Resolution Protocol (ARP) table. ARP is an Internet protocol used to map IP address to MAC addresses on equipment installed in a network. If an IP address is entered (optional), it will show only the output of the specified address.
Syntax
show arp []
Parameter
Definition
IP address of a server in nnn.nnn.nnn.nnn.format
Example
To show the ARP table, type the following command: C4>
show arp The following is an example of the output returned by the system:
ARP cache timeout is 1200 seconds Row IP Address MAC Address 1 10.108.29.233 0000.ca24.3f60 2 10.108.0.10 0000.0001.1101 3 10.108.0.11 0000.0001.1102 4 10.108.0.12 0000.0001.1103 5 10.108.0.13 0000.0001.1104 . . . 281 10.44.8.214 0001.5c00.03fd 282 10.44.8.215 0001.5c00.03fd
Type Dynamic Dynamic Dynamic Dynamic Dynamic
State Active Active Active Active Active
Interface cable-mac cable-mac cable-mac cable-mac cable-mac
Static Static
Active Active
loopback 1 loopback 1
Related Command(s)
configure clock set configure hostname configure ip prefix-list configure interface ethernet * ip address configure line
CLI-1264
ARRIS PROPRIETARY — All Rights Reserved
5/0 5/1 5/2 5/3 5/4
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show async-bootp Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the current boot parameters. Most of the boot parameters are custom configurable during the boot-up sequence.
Syntax
show async-bootp
Example
To display the current boot parameters, type the following command: C4>
show async-bootp The following is an example of the output returned by the system: Chassis Type: C4 Boot selection: 1 Boot 1 count: 0 Boot 1 limit: 5 Boot 2 count: 5 Boot 2 limit: 5 SCM MAC address: 00:01:5c:20:00:fd Gateway IP address: 10.44.39.6 Ethernet port on the SCM (slot 20) is enabled SCM (slot 19) address: 10.44.39.1 SCM (slot 20) address: 10.44.39.2 SCM active address: 10.44.39.3 LAN subnet mask: 255.255.255.248 Debug mode: 4 Startup delay (in seconds): 2 Baud rate: 9600 Hostname: C4
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1265
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show audit Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the audit details.
Syntax
show audit
Example
To display the audit details, type the following command: C4>
show audit The following is an example of the output returned by the system: Audit autoscheduling: Audit LogOutput: Audit LogThrottle:
CLI-1266
enabled enabled enabled
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show audit sequence Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the audit sequence status, and if identified, for a specified sequence for all cards.
Syntax
show audit sequence
Parameter
Definition
Example
Sequence name (optional)
To display the status of the audit sequence, type the following command: C4>
show audit sequence The following is an example of the output returned by the system:
enable/ last cycle last passed last failed total passed total failed Card/Id/Name disable result count entry count entry count entry count entry count ----------------------------------------------------------------------------------------------------04/01/AuditCMMac disable notrun 0 0 0 0 0 04/02/AuditCMQos disable notrun 0 0 0 0 0 04/03/IpFilter disable notrun 0 0 0 0 0 04/04/AuditCMBpi disable notrun 0 0 0 0 0 04/05/CAMSparing disable notrun 0 0 0 0 0 05/01/AuditCMMac disable notrun 0 0 0 0 0 05/02/AuditCMQos disable notrun 0 0 0 0 0 05/03/IpFilter disable notrun 0 0 0 0 0 05/04/AuditCMBpi disable notrun 0 0 0 0 0 05/05/CAMSparing disable notrun 0 0 0 0 0 19/01/PersistentStore disable notrun 0 0 0 0 0 19/02/PacketCableGates enable passed 3 2 0 6 0 20/01/PersistentStore disable notrun 0 0 0 0 0 20/02/PacketCableGates enable notrun 0 0 0 0 0
Example
To display the audit sequence status for the AuditCMQos: C4>
Issue 2.0
show audit sequence auditcmqos
ARRIS PROPRIETARY — All Rights Reserved
CLI-1267
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
The following is an example of the output returned by the system: enable/ last cycle last passed last failed total passed total failed Card/Id/Name disable result count entry count entry count entry count entry count ----------------------------------------------------------------------------------------------------04/02/AuditCMQos disable notrun 0 0 0 0 0 05/02/AuditCMQos disable notrun 0 0 0 0 0
CLI-1268
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show audit sequence * card Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the specified audit sequence status for a single card.
Syntax
show audit sequence card
Parameter
Definition
Sequence name Card slot number. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
Example
To display the audit sequence status for the AuditCMQos on the CAM in slot 15, use the following command: C4>
show audit sequence auditcmqos card 15 The following is an example of the output returned by the system:
enable/ last cycle last passed last failed total passed total failed Card/Id/Name disable result count entry count entry count entry count entry count ----------------------------------------------------------------------------------------------------15/02/AuditCMQos enable passed 14 2000 0 24000 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1269
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show authentication Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the authentication method.
Syntax
show authentication
Example
To display the authentication method, type the following command; C4#
show authentication The following is an example of the output returned by the system:
Name ------------------ml1 ml2 default
CLI-1270
List Of Methods ---------------------------------------------------------Local None Local, None
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show authorization Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the authorization method.
Syntax
show authorization [detail]
Parameter
Definition
[detail]
Detailed view of the authorization method list
Example
To display the authorization method, type the following command: C4#
show authorization The following is an example of the output returned by the system:
Name ------------------tacacs_author author_default
Issue 2.0
List Of Methods ---------------------------------------------------------TACACS+ Group default Local
ARRIS PROPRIETARY — All Rights Reserved
CLI-1271
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable bonding-group-status Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the status of the bonding group for the given MAC address.
Syntax
show cable bonding-group-status [cable-mac ]
Parameter
Example
Definition
Static bonding group identifier. Valid range is 1-65335.
show cable bonding-group-status cable-mac 1 Cable -mac ----1 1 1 1 1 1
chSetId ---------0x01000002 0x01000003 0x01000004 0x01000005 0x01000006 0x01000007
mDSsg/ mUSsg ------D1 D1 D-inv D1 D-inv D-inv
CfgId ------1 2 3 4 5 6
AttrMask ---------0x80000000 0x80000000 0x80000000 0x80000000 0x80000000 0x80000000
Where: D1 = Indicates the downstream direction and the service group ID D-inv = Indicates the service group ID is 0. From the MIB, the value zero indicates that the bonding group does not contain channels from a single Mac Domain Downstream Service Group (MS-DS-SG) and therefore the bonding group is not valid and usable. CfgId = Indicates the downstream bonding group was created via the configure interface cable-mac cable downstreambonding-group command. A zero displayed in this column indicates the group id was defined by the CMTS.
CLI-1272
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable bundle Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the current cable bundle configuration.
Syntax
show cable bundle
Example
To show the current cable bundle configurations, type the following command: C4>
show cable bundle The following is an example of the output returned by the system: Cable Mac 1 2 3
Issue 2.0
Bundle Group cable-mac 1 cable-mac 1 cable-mac 1
ARRIS PROPRIETARY — All Rights Reserved
CLI-1273
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable channel-sets Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Provides a status of the cable channel sets for the specified cable-mac.
Syntax
show cable channel-sets [] [cable-mac ] [channel-set-id ] [full]
Parameter
Definition
Upstream (us) or Downstream (ds) direction only
[cable-mac ] [channel-set-id ] [full]
Static bonding group identifier. Valid range is 1-65335. The channel set ID Displays all configuration values, including single channel sets.
Example
The following is an example of output returned by the system: C4#
show cable channel-sets cable-mac 1 full
Cable -mac ----1 1 1 1 1 1 1 1 1 1 1
chSetId DS/US Channel Set ---------- ----- ----------------------------------------------0x00000001 DS 5/0 0x00000002 DS 5/1 0x00000003 DS 5/2 0x00000100 DS 5/0 5/1 0x01000001 DS 5/0 5/1 0x00000002 US 13/1 0x0000000c US 13/11 0x00000018 US 13/20 0x000000ff US 13/20 0x00000100 US 13/1 13/11 13/20 13/20 0x01000001 US 13/1 13/11 13/20 13/20
CLI-1274
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable dsg Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
This command shows all the interfaces that have dsg provisioning. The verbose mode will show detailed provisioning, while the normal mode will show the DSG indices provisioned against a given interface. In both output formats, if the provisioning is not complete, an indication that the data is not complete will be displayed. In the tabular format, an asterisk preceding the value will indicate that the item has not yet been provisioned and a hyphen will be used for entries that contain no data.
Syntax
show cable dsg [verbose]
Parameter
[verbose]
Issue 2.0
Definition
Using the optional parameter will display detailed provisioning.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1275
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable dsg ds-frequency-list Default Access Level
Mode
Non-privileged –1
User EXEC
Purpose
Displays the provisioned downstream channel list frequencies. If the optional channelListIndex is present, then only those entries that belong to that list will be displayed. NOTE If a downstream channel frequency-list is not associated with an interface, then the list index will be preceded by an asterisk (*). This is done to assist in identifying provisioning disconnects.
Syntax
show cable dsg ds-frequency-list [chllistindex]
Parameter
Definition
Unsigned integer used to filter the downstream frequency list information. Valid values are 1 to 65335.
[chllistindex]
Example
To display channel list 2, use the following command: C4>
show cable dsg ds-frequency-list 2 The following is an example of the output returned by the system:
List Idx ----2 2 2 * This
Chl DS Idx Frequency (Hz) ----- -------------1 62500 3 2500000 4 5000000 ds frequency list index is not associated with an interface. To display all channel lists, use the following command: C4>
show cable dsg ds-frequency-list The system output would look similar to:
CLI-1276
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
List Idx ----*1 2 2 2 * This
Issue 2.0
Chl DS Idx Frequency (Hz) ----- -------------1 62500 1 62500 3 2500000 4 5000000 ds frequency list index is not associated with an interface.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1277
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable dsg timer-list Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the provisioned timer-lists. If the user provides the timer set index, only those timer-list parameters belonging to that timerset index are disiplayed. If the optional parameter is omitted, then all timer-list entries will be displayed.
Syntax
show cable dsg timer-list [timersetindex]
Parameter
Definition
[timersetindex]
A decimal integer index corresponding to the specified timer-list to display.
NOTE If a timer list is not associated with an interface, then the timer index will be preceded by an asterisk (*). This is done to assist in identifying provisioning disconnects. Example
To display all timer lists, use the following command: C4>
show cable dsg timer-list The following is an example of the output returned by the system: Timer init oper 2-way 1-way List (tdsg1) (tsdg2) (tsdg3) (tdsg4) ----- ------- ------- ------- ------1 10 700 300 1800 *2 15 750 350 1900 * This timer list is not associated with an interface. To display a specific timer list, use the following command:
C4>
CLI-1278
show cable dsg timer-list 2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
The system output would look similar to: Timer List ----*2
init (tdsg1) ------15
oper (tsdg2) ------750
2-way (tsdg3) ------350
1-way (tdsg4) ------1900
* This timer list is not associated with an interface.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1279
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable dsg tunnel Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the information for the specified DSG tunnel.
Syntax
show cable dsg tunnel [classifier]
Parameter
Definition
[classifier]
The tunnel identifier. Displays the DSG tunnel classifier information.
Example
To display the DSG classifiers for the DSG Tunnel 1, use the following command: C4>
show cable dsg tunnel 1 The following is an example of the output returned by the system:
Tunnel Group Client ID Index Index List Index ------ ------ ---------*1 1 1
Tunnel MAC addr -------------0001.0203.0405
Service Class Name --------------DsgTunnelClass1
* This tunnel is not associated with an interface.
CLI-1280
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable dsg tunnel * classifier Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
This command displays the tunnel classifier information. If the optional classifier is used, this command will display the tunnel classifier information NOTE If the tunnel that a classifier is associated with does not contain provisioning, then the tunnel will be preceded by an asterisk (*).
Syntax
show cable dsg tunnel classifier []
Parameter
Definition
Tunnel ID associated with the classifier. Valid values are 1 to 65335.
[]
Valid values for classId are 1 - 65335.
Example
To display the DSG classifiers for DSG tunnel 1, use the following command: C4>
show cable dsg tunnel 1 classifier The following is an example of the output returned by the system:
Tunnel Class Dest Index Index Pri Source Network Dest IP Port Rng ------ ------ --- ------------------ --------------- -------*1 1 1 192.168.234.120/29 224.232.128.205 128-235 *1 2 3 10.10.10.1 128.65.83.10 0-255 * This tunnel has not been provisioned.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1281
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable dsg tunnel-group Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays DSG tunnel-group provisioning.
Syntax
show cable dsg tunnel-group [0-4294967295]
Parameter
Definition
[0-4294967295]
Example
The tunnel-group associated with the tunnel
To display the configured DSG tunnel-groups, use the following command: C4#
show cable dsg tunnel-group The following is an example of the output returned by the system:
Tunnel Group ------1 2 3 4 5 6 7 7 8 9 10 11
CLI-1282
GrpChl Index ------1 1 1 1 1 1 1 2 1 1 1 1
Slot/ Mac ----5/0 5/0 5/0 5/0 5/0 5/0 5/0 5/0 5/0 5/0 5/0 5/0
UCID List -------------------------
Vend Parm ID -------
ARRIS PROPRIETARY — All Rights Reserved
Rule Pri ------0 0 0 0 0 0 0 0 0 0 0 0
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable dsg verbose Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays detailed DSG provisioning.
Syntax
show cable dsg verbose
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1283
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable dsg vsp-list Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the provisioned vendor-specific settings including the vendor set identifier, vendor oui and vendor value pairs. If the vendor set identifier [vendorsetid] is given. then only those vendor set parameters belonging to that vendor set identifier are displayed. If the vendor set identifier is omitted, then all vendor set parameter data is displayed. NOTE If a vendor parameter set is not associated with an interface, then the set identifying number will be preceded by an asterisk (*). This is done to assist the user in identifying provisioning disconnects.
Syntax
show cable dsg vsp-list [vendorsetid]
Parameter
Definition
[vendorsetid]
Example
Identifier of the vendor set to be associated with the downstream interface.
To display all of the single vendor parameter sets, type the following command: C4>
show cable dsg vsp-list The following is an example of the output returned by the system:
list id idx ----- ----1 1
1
CLI-1284
2
OUI value -------- -------------------------------------------------00:01:02 00:01:02:03:04:05:05:07:08:09:0a:0b:0c:0d:0e:0f: 10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f: 20:21:22:23:24:25:26:27:28:29:2a:2b:2c:2d:2e:2f: 30:31 00:01:02 00:01:02:03:04:05:05:07:08:09:0a:0b:0c:0d:0e:0f: 10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f:
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
20:21:22:23:24:25:26:27:28:29:2a:2b:2c:2d:2e:2f: 30:31 1 3 00:0f:03 00:01:02:03:04:05:05:07:08:09:0a:0b:0c:0d:0e:0f: 10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f: 20:21:22:23:24:25:26:27:28:29:2a:2b:2c:2d:2e:2f: 30:31 *2 1 00:0f:03 aa:bb:cc:dd:ee:ff:aa * This vsp-list is not associated with an interface.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1285
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable enable-trap Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays trap logging information.
Syntax
show cable enable-trap
CLI-1286
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable equalizer-coeff Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the equalizer coefficient status for the entire system. Use the optional [cable-upstream /] parameter if you only need status for a specific module and upstream port.
Syntax
show cable equalizer-coeff [cable-upstream /]
Parameter
Definition
[cable-upstream /]
This refers to the module slot (Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15) and upstream port.
Example
To display the equalizer coefficient status for the entire system, type the following command: C4#
show cable equalizer-coeff The following is an example of the output returned by the system:
Slot ---4 5 9/0 9/1 10/0 10/1
Upstream Port 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 ---------------------------------------------------------------------- - - - - - - - - - - - - - - - - - - - - - - 0 0 0 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 0 0 0 0 0 0 - - - - - - - - - - - 0 0 0 0 0 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1287
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable fiber-node Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Display fiber node information.
Syntax
show cable fiber-node [] [detail] [not-valid] [cable-mac ] [mCMsg ] [mDSsg ] [mUSsg ]
Parameter
Definition
[]
Fiber node name up to 16 characters long
[detail]
Displays fiber node for all ports including ones with problems.
[not-valid]
Displays only problem fiber-nodes
[cable-mac ]
MAC identifier (valid numbers are 0-415).
[mCMsg ]
MAC domain cable modem service group identifier. Valid range is 14294967295.
[mDSsg ]
MAC domain downstream service group identifier. Valid range is 1-255.
[mUSsg ]
MAC domain upstream service group identifier. Valid range is 1-255.
Example
To display the fiber node information, type the following command: C4#
show cable fiber-node abc detail cable-mac 1 The following is an example of the output returned by the system:
Cable Fiber Node MAC mCMsg ---------------- ----- ----fn1 1 1 fn1 1 1
mDSsg/ mUSsg -----D1 U1
Ports -------------------14/0 14/1 14/2 3/0 3/1 3/2
14/3 3/3
* Indicates that downstream channel is not primary-capable.
CLI-1288
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable filter Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the cable IP filter information.
Syntax
show cable filter [group [verbose] [clearmatches]
Parameter
Definition
[group ] [verbose]
IP filter group number. Valid range is 1-1023. Displays information in list style.
[clearmatches]
Example
Clears match count after displaying it.
To show cable IP filter information, use the following command: C4#
show cable filter The following is an example of the output returned by the system:
Grp ---1 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2
Idx --1 6 9 10 11 12 13 5 8 9 11 12 13 14 15 16
Issue 2.0
Source Destination ULP ------------------ ------------------ --0.0.0.0/32 0.0.0.0/0 256 172.28.0.0/14 10.0.0.0/8 17 172.16.0.0/12 0.0.0.0/0 1 10.0.0.0/8 0.0.0.0/0 256 0.0.0.0/0 10.0.0.0/8 256 172.16.0.0/12 0.0.0.0/0 256 192.168.0.0/16 0.0.0.0/0 256 10.0.0.0/8 172.28.0.0/14 17 0.0.0.0/0 172.28.0.0/14 1 10.0.0.0/8 10.0.0.0/8 1 0.0.0.0/32 0.0.0.0/0 256 0.0.0.0/0 10.0.0.0/8 256 10.0.0.0/8 0.0.0.0/0 256 0.0.0.0/0 172.16.0.0/12 256 0.0.0.0/0 0.0.0.0/0 6 0.0.0.0/0 0.0.0.0/0 6
TOS ----00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00
SPort DPort ----- ----65 65536 6 65536 65536 65536 65 6 1
65536 65536 65536 65536 65536
6 65536 65536 65 6 65536
65536 65536 65536 65536 25 80
ARRIS PROPRIETARY — All Rights Reserved
TCP ----00,00 00,00 , 00,00 00,00 00,00 00,00 00,00 , , 00,00 00,00 00,00 00,00 00,00 00,00
Action Matched ------ ------accept 0 accept 0 accept 0 accept 0 accept 0 accept 0 accept 0 accept 0 accept 0 accept 0 accept 0 accept 0 accept 147 accept 0 drop 0 drop 0
CLI-1289
CLI Command Descriptions
2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 3 3 4 4
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 1 2 1 2
0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0
C4/C4c CMTS Rel. 8.0.7
0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 0.0.0.0/0 172.28.0.0/14
Example
6 6 6 6 6 6 6 6 6 6 6 6 6 6 6 1 256 1 17
00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00 00/00
65536 65536 65536 65536 65536 65536 65536 65536 65536 65536 65536 65536 65536 65536 65536
53 21 23 22 35 36 37 38 39 40 41 42 43 44 45 , , , ,
00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 00,00 drop 0 accept 646186499 accept 4037 accept 644362785 accept 0
To show cable IP filter information for group 1, use the following command: C4#
show cable filter group 1 The following is an example of the output returned by the system:
Grp ---1 1 1 1 1 1 1
Idx --1 6 9 10 11 12 13
Source Destination ULP ------------------ ------------------ --0.0.0.0/32 0.0.0.0/0 256 172.28.0.0/14 10.0.0.0/8 17 172.16.0.0/12 0.0.0.0/0 1 10.0.0.0/8 0.0.0.0/0 256 0.0.0.0/0 10.0.0.0/8 256 172.16.0.0/12 0.0.0.0/0 256 192.168.0.0/16 0.0.0.0/0 256
Example
TOS ----00/00 00/00 00/00 00/00 00/00 00/00 00/00
SPort DPort ----- ----65 65536 6 65536 65536 65536 65 6
65536 65536 65536 65536
TCP ----00,00 00,00 , 00,00 00,00 00,00 00,00
Action Matched ------ ------accept 0 accept 0 accept 0 accept 0 accept 0 accept 0 accept 0
To show cable IP filter information for index 6 in group 1, use the following command: C4#
show cable filter group 1 index 6 The following is an example of the output returned by the system:
Grp Idx Source Destination ULP TOS SPort DPort TCP Action Matched ---- --- ------------------ ------------------ --- ----- ----- ----- ----- ------ ------1 6 172.28.0.0/14 10.0.0.0/8 17 00/00 6 65536 00,00 accept 0
CLI-1290
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable flap-list Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Assists in troubleshooting the CMTS to cable modem connectivity. Many of these options are common to the show cable modem command. The flaplist commands show modems with non-zero flap counts. In other words, modems that have flapped since the last clear cable flap-list all command will be displayed. By default, this command will output all modems with non-zero flap counts sorted by CM MAC address.
Syntax
show cable flap-list [H.H.H] [] [cable ] [cable-downstream ] [cable-mac ] [cableupstream ] [cm-ip ][cm-ipv6 ] [cm-mac ] [count ] [cpe-ip ] [cpe-ipv6 ] [cpe-mac ] [max-ftime ] [max-lines ] [min-error ] [min-fcount ] [nonoperational] [offline] [operational] [registered] [sortflap] [sort-time] [state ] [unregistered] [vendor ]
Parameter
[] []
Definition
Filter on the MAC address of the cable modem Filter on the IP address of the cable modem Filter on the CAM slot number/MAC domain/upstream port. Valid ranges are:
[cable ]
/ / / / // //
Issue 2.0
- C4 CMTS CAM slot - C4c CMTS CAM slot - C4 CMTS 16D/XD slot/port - C4c CMTS 16D/XD slot/port - C4 CMTS 12U/24U slot/port - C4c CMTS 12U/24U slot/port - C4 CMTS 12U CAM slot/MAC domain/upstream port - C4 CMTS 24U CAM slot/MAC domain/upstream port
ARRIS PROPRIETARY — All Rights Reserved
CLI-1291
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
[cable-downstream ] [cable-mac ] [cable-upstream ]
Definition
Filter on downstream interface. Valid ranges are /. Filter on Mac Identifier Filter on the upstream port ID. Valid ranges are
[cm-ip ]
Filter on the IP address of the cable modem
[cm-ipv6 ]
Filter on CM IPv6 address
[count] [cpe-ip ] [cpe-mac
Display only CM count totals Filter on the IP address of the CPE under CM Filter on MAC address of CPE under CM
[cpe-ipv6 ]
Filter on the IPv6 address of CPE under CM.
[max-ftime ]
Filter on maximum latest flap time (in minutes). Valid range is 0-100000.
[max-lines ]
The maximum number of CMs to display. Valid range is 0-10000
[min-error ]
Filter on minimum combined CRC and HCS error count
[min-fcount ]
Filter on minimum flap count
[non-operational]
Filter on non-operational CMs
[offline]
Filter on offline CMs
[operational]
Filter on operational CMs
[registered]
Filter on registered CMs
[sort-flap]
Sort CMs by decreasing flap count
[sort-time]
Sort CMs by increasing latest flap time
CLI-1292
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
[state ]
Cable modem state. Valid states are: offline - Cable modem is not currently active ranging - Initial ranging in progress rngaborted - Ranging has failed ranged - Ranging has completed dhcpv4done - IP address has been assigned registered - The modem is active and ready for traffic denied - Service is being denied operational - Active cable modem regbpiinit - BPI registration has been completed eaestart - CMTS has received an Auth Info message for EAE from the CM dhcpv4start - CMTS has received a DHCPv4 DISCOVER message from the CM dhcpv6start - CMTS has received a DHCPv6 Solicit message from the CM dhcpv6done - CMTS has sent a DHCPv6 Reply message to the CM tftpstart - Config file download has started tftpdone - Config file download process has been completed registering - CMTS has received a Registration Request from the CM frwddisable - Registration complete, but forwarding prohibited. rfmuteall - Mute all channels non-operational - Any state other than operational online-d - The modem has registered but network access is denied
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1293
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
[unregistered]
Filter on all but registered CMs
[vendor ]
Example
3Com
Elsa
Netgear
Sunrise
Ambit
Ericsson
Netwave
Syswave
Arris
GADline
Nortel
Technotrend
Askey
GeniusNet
Opentech
Teledex
ASUSTek
Hanaro
Pace
Telexy
BAS
Humax
Pacific
Tellabs
BestData
iCable_System Panasonic
Telogy
Broadcom
Infinite
Philips
Terayon
Cadant
Intel
Pioneer
TI
Castlenet
Joohong
Ponico
Tollgrade
Cisco
Leichu
PowerCom
Toshiba
Com21
LG
QNS
TriGem
Conexant
Linksys
RCA/Thomson TurboComm
Coresma
Maspro
RiverDelta
Ubee
COSHIP
Matsushita
SA
USRobotics
D-Link
Mercury
Saejin
Woojyun
Daehanet
Motorola
Samsung
Zoom
DAKOS
MPlus
SMC
ZyXel
Electroline
NEC
The following is an example of the show cable flap-list command: C4>
show cable flap-list The following is an example of the output returned by the system:
CLI-1294
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
C4> show cable flap-list Mar 12 18:15:50 Inter Face US ---- -5/0 U0 5/0 U0 5/0 U3 5/0 U1 5/0 U5 5/0 U3 5/0 U4 5/0 U6 5/0 U1 5/0 U5 5/0 U1 5/0 U5 5/0 U1 5/0 U1 5/0 U5 5/0 U1 5/0 U5 5/0 U5 5/0 U3 5/0 U1 5/0 U1 5/0 U1 5/0 U5 5/0 U1 5/0 U3 5/0 U3 5/0 U1 5/0 U1 5/0 U5 5/0 U5 5/0 U6 5/0 U6 5/0 U1
State ---------Registered Registered Ranged Registered Registered Registered Registered Registered Ranged Registered Registered Registered Registered Registered Registered Registered Registered Registered Registered Registered Registered Registered Registered Registered Ranged Registered Registered Ranged Registered Registered Registered Ranged Registered
Pre-Flap Time Since Latest Timing State Last Flap Uptime Offset ---------- ----------- ----------- -----Ranged 0:09:34 0:08:33 1867 Ranged 0:09:55 0:08:27 2718 Registered 0:00:04 0:00:04 1223 Ranged 0:10:15 0:08:04 1223 Ranging 0:07:16 0:06:38 1254 Ranged 0:09:51 0:07:39 1227 Ranged 0:05:51 0:03:28 1225 Ranged 0:09:57 0:07:36 1257 Registered 0:00:10 0:00:10 1211 Ranged 0:09:54 0:07:45 1226 Ranging 0:03:58 0:03:20 1264 Ranging 0:07:24 0:06:41 1227 Ranging 0:02:36 0:01:41 1215 Ranging 0:03:50 0:02:59 1216 Ranged 0:09:47 0:07:25 1239 Ranging 0:04:07 0:03:29 1214 Ranged 0:09:45 0:07:37 1234 Ranging 0:07:20 0:06:43 1229 Ranging 0:06:56 0:06:17 1233 Ranged 0:10:03 0:08:01 1234 Ranging 0:03:58 0:03:10 1253 Ranging 0:04:00 0:03:24 1247 Ranged 0:09:51 0:07:21 1222 Ranging 0:03:49 0:03:25 1222 Registered 0:00:28 0:00:28 1211 Registered 0:01:30 0:01:30 1210 Ranging 0:03:49 0:02:53 1236 Registered 0:00:21 0:00:21 1240 Ranged 0:10:04 0:08:07 1230 Ranged 0:09:59 0:07:28 1252 Ranged 0:08:29 0:06:13 1232 Registered 0:00:16 0:00:16 1253 Ranging 0:02:06 0:01:23 1245
Rx Power ----0.1 0.0 0.0 -0.2 0.1 0.3 0.1 -1.4 0.0 0.0 0.7 0.6 1.0 0.3 -0.1 0.4 0.0 0.6 0.4 0.0 -0.1 0.0 0.1 0.3 0.5 0.4 0.4 -0.2 0.5 0.2 0.0 -1.2 -0.4
( Flaps ) Range Prov Reg MAC address ----- ----- ----- ---------0 2 1 0000.ca30.08ec (Arris) 0 1 1 0020.4067.8316 (Motorola) 1 1 2 0090.833b.b93d (Toshiba) 0 1 1 0090.833b.b97c (Toshiba) 1 1 1 0090.833b.b970 (Toshiba) 0 1 1 0090.833b.b96b (Toshiba) 0 2 1 0090.833b.b96e (Toshiba) 0 1 1 0090.833b.b93b (Toshiba) 1 0 3 0090.833b.b977 (Toshiba) 0 1 1 0090.833b.b981 (Toshiba) 1 1 2 0090.833b.b96c (Toshiba) 1 1 1 0090.833b.b939 (Toshiba) 1 1 2 0090.833b.b97a (Toshiba) 1 1 2 0090.8337.7b14 (Toshiba) 0 1 1 0090.833b.b937 (Toshiba) 1 1 2 0090.833b.b96a (Toshiba) 0 1 1 0090.833b.b982 (Toshiba) 1 1 1 0090.833b.b973 (Toshiba) 1 0 2 0090.833b.b948 (Toshiba) 0 1 1 0090.833b.b920 (Toshiba) 1 0 2 0090.833b.b93a (Toshiba) 1 1 2 0090.833b.b976 (Toshiba) 0 1 1 0090.833b.b97b (Toshiba) 1 1 2 0090.833b.b97e (Toshiba) 0 1 5 0090.833b.b96d (Toshiba) 0 2 4 0090.833b.b97d (Toshiba) 1 0 2 0090.833b.b94a (Toshiba) 0 1 2 0090.833b.b933 (Toshiba) 0 1 1 0090.8340.2307 (Toshiba) 0 1 1 0090.833b.b91a (Toshiba) 0 1 1 0090.833b.b972 (Toshiba) 0 1 2 0090.833b.b97f (Toshiba) 1 1 1 0090.833b.b938 (Toshiba)
Total Offline Ranging RgAbort Ranged IPcompl Online Denied -----------------------------------------------------------------------Total 33 0 0 0 5 0 28 0
The output is sorted by MAC address and includes:
Issue 2.0
•
Interface - current or last cable interface for this modem
•
US - current or last Upstream Port number for this modem
•
State - current CmtsCmStatus value for this modem
•
Pre-Flap State - the PreFlapStatus or CM status value prior to last CM flap. This will be blank if the modem has never flapped
•
Time Since Last Flap - as explained above
•
Latest Uptime - current uptime for a non-offline modem
•
Timing Offset - most recent timing offset ranging value
•
Rx Power - most recent power level ranging value
•
Range Flaps - the number of Ranging Flaps for this modem
•
Prov Flaps - the number of Provisioning Flaps for this modem
•
Reg Flaps - the number of Registration Flaps for this modem
•
Mac Address - MAC Address and vendor name of this modem
ARRIS PROPRIETARY — All Rights Reserved
CLI-1295
CLI Command Descriptions
Example
C4/C4c CMTS Rel. 8.0.7
To show only the most recent five flaps, use the following command: C4>
show cable flap-list max 5 sort-time The following is an example of the output returned by the system:
Inter Pre-Flap Time Since Latest Timing Face US State State Last Flap Uptime Offset ---- -- ---------- ---------- ----------- ----------- -----5/0 U2 Offline Ranged 0:00:49 0:01:37 1259 5/0 U6 Offline Ranged 0:01:06 0:01:37 1232 5/0 U3 Ranged Ranged 0:03:03 0:00:49 1247 5/0 U1 Ranged Ranged 0:03:27 0:01:13 1228 5/0 U0 Ranged Ranged 0:04:54 0:00:47 1228 Exceeded output limit: 5
Rx Power -----0.2 0.3 -0.1 0.5 -0.2
( Flaps ) Range Prov Reg MAC address ----- ----- ----- ---------1 3 3 0090.833b.b977 (Toshiba) 0 4 5 0090.833b.b96d (Toshiba) 1 3 2 0090.833b.b93d (Toshiba) 0 3 2 0090.833b.b933 (Toshiba) 0 3 2 0090.833b.b97f (Toshiba)
Total Offline Ranging RgAbort Ranged IPcompl Online Denied -----------------------------------------------------------------------Found 6 2 0 0 3 0 1 0
Example
To show only the five modems with the maximum number of flaps, use the following command: C4>
show cable flap-list max 5 sort-flap The following is an example of the output returned by the system:
Inter Pre-Flap Time Since Latest Timing Face US State State Last Flap Uptime Offset ---- -- ---------- ---------- ----------- ----------- -----5/0 U6 Offline Ranged 0:01:17 0:01:37 1232 5/0 U2 Offline Ranged 0:01:00 0:01:37 1259 5/0 U3 Registered Registered 0:11:40 0:11:40 1210 5/0 U3 Ranged Ranged 0:03:14 0:01:00 1248 5/0 U0 Ranged Ranged 0:05:05 0:00:58 1229 Exceeded output limit: 5
Rx Power ----0.3 -0.2 0.9 0.0 -0.8
( Flaps ) Range Prov Reg MAC addre ----- ----- ----- --------0 4 5 0090.833b 1 3 3 0090.833b 0 2 4 0090.833b 1 3 2 0090.833b 0 3 2 0090.833b
Total Offline Ranging RgAbort Ranged IPcompl Online Denied -----------------------------------------------------------------------Found 6 2 0 0 3 0 1 0
CLI-1296
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable global-settings Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays global DOCSIS® settings.
Syntax
show cable global-settings
Example
To display the settings, type the following command: C4>
show cable global-settings The following is an example of the output returned by the system:
Issue 2.0
Annex: Downstream Frequency Range: Upstream Frequency Range: Load Balance: CM registration request Timeout: Maximum QoS Active Timeout: Maximum QoS Admitted Timeout: Concatenation for DOCSIS 1.0 CM: Fragmentation for DOCSIS 1.0 CM: Max traffic burst for 1.1 CM: Peak traffic rate for 1.1 CM: Percent increase for DS SF rate: CMs required to detect US lockup: LO1 leak detect: Interval to collect utilization data: Modifying primary DS chan in RCC of Reg-Rsp-Mp: Send 46.1RefID only in first TCC frag: Allow CM service group ambiguity override: Unicast non-primary US channel acquisition: TFTP Enforce and Dynamic Shared Secret:
annex A 112-858 5-65 Enabled 30 0 200 Off On 128000 0 1 10 Disabled 0 Enabled False Disabled Disabled Enabled
ARRIS PROPRIETARY — All Rights Reserved
CLI-1297
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable host authorization Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the cable host authorization provisioning.
Syntax
show cable host authorization
CLI-1298
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable intercept Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the Legal Intercept Tap session settings.
Syntax
show cable intercept [userid ] [password ] [subscriber ]
Parameter
Definition
[userid ]
SNMP User ID
[password ]
SNMP Authentication password
[subscriber ]
CM MAC or CM/CPE IP address
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1299
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the provisioning of load balancing.
Syntax
show cable load-balance
Example
To display the load balancing provisioning, use the following command: C4#
show cable load-balance The following is an example of output returned by the system: Load Balance : Enabled Init Technique: Disable Mac Domain Check (sec) : 300 Across Mac Domain Check (sec) : 0 Downstream Start Threshold (% utilization) : 1 Upstream Start Threshold (% utilization) : 1 Failed-list age out time (in hours): 0 Failed-list exclude count: 1 Number of CMs to check per Interval: 10
CLI-1300
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance channels Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the channel load data for the Cable Access Modem (CAM) with upstream interfaces.
Syntax
show cable load-balance channels [slot ] [fiber-node ] [group ] [detail]
Parameter
Definition
[slot ]
Slot number of the CAM with upstream interfaces. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[fiber-node ] [group ] [detail]
Filters output on the fiber node name. Filters output on the group. Displays additional columns in the output.
Example
To display the channel load data for the CAM in slot 13, use the following command: C4#
show cable load-balance channels slot 13 The following is an example of output returned by the system:
Dumping DsUsLoadSet for Restricted Load Balance Group 3 Md 1 Policy 4, Active Type: BOTH, Active Method: UTILIZATION, ChannelWeightOption: DS+ Dumping DsUsLoadSet for Restricted Load Balance Group 33 Md 1 Policy 0, Active Type: BOTH, Active Method: MODEM, ChannelWeightOption: EQUAL Weighted DS IfIndex US IfIndex DS Load US Load Load ----- ------- ------- ------- ------- ------- -------5/0 400904 13/20.0 918201 1 2 3 5/0 400904 13/20.1 918202 1 2 3 5/0 400904 13/1 918049 1 1 2 5/0 400904 13/11 918129 1 1 2
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1301
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Dumping DsUsLoadSet for General Load Balance Group StatusId = 0x1001000, 16781312 Md 1, MdCmSg 2, FiberNode abc, Bundle Group: cable-mac 1 Policy 4, Active Type: BOTH, Active Method: UTILIZATION, ChannelWeightOption: DS+
CLI-1302
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance cm-service-type Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the cable modems with the CM config file and the CMTS service type provisionings.
Syntax
show cable load-balance cm-service-type [cm-mac| service-type]
Parameter
[cm-mac service-type]
Issue 2.0
Definition
Filter on the specific CM MAC address or OUI Filter on the specific service type
ARRIS PROPRIETARY — All Rights Reserved
CLI-1303
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance failed-list Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the cable modems that have failed to move to one or more channels as directed by the load balancer. This will also allow tech support to understand situations that are preventing channels from becoming balanced (e.g. channels that are in need of repair or groups of cable modems having difficulties with load balancing commands.)
Syntax
show cable load-balance failed-list [slot ] [verbose]
Parameter
Definition
[slot ]
Slot number of the CAM. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[verbose]
If this optional keyword is specified, all CM From/Target combinations will be displayed that are on the failed list including those CM From/Target combinations that have not reached the exclude-failed-count.
Example
To display the cable modems that have failed to move as directed by the load balancer, use the following command: C4>
show cable load-balance failed-list The following is an example of the output returned by the system:
FAILED LOAD_BALANCE ATTEMPTS CM MAC -----------------------------0015.96e6.9840 (Arris) 0000.cac3.1831 (Arris) 0000.cac3.212e (Arris)
Type ------US-Stat US-Dyn DS-Dyn
From Channels DS US ----------------13/1 13/1/7.0 13/0 13/0/3.0
Related Command(s)
clear cable load-balance failed-list *
CLI-1304
ARRIS PROPRIETARY — All Rights Reserved
Target Channels DS US ----------------12/0/9.0 13/1 13/1/8.0 13/1 13/1/8.0
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance group Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the provisioning for the load balance groups in a table format. Since there is a good deal of provisioning for each group and it is important to be able to see how the load-balance group provisioning differs from each other, the provisioning is displayed in a table format. NOTE If the group number is provided, then the table is shown with only one entry. If no provisioning is found for a provided group number, then the show command will generate an error indicating that the group number could not be found. If no groups are provisioned, then an error is generated indicating no groups were found.
Syntax
show cable load-balance group [ [detail]]
Parameter
Definition
[]
The group number Displays the upstream and downstream channels associated with this group.
[detail]
Example
To display the provisioning for the load balance groups, use the following command: C4>
show cable load-balance group The following is an example of the output returned by the system:
Policy Rule ---------- ---------Default(0) -
Issue 2.0
Enabled ------yes
Threshold -----10%
Type ------both
Method -----modem
Disable Start Period -----------------00:00:00 00:00:00
ARRIS PROPRIETARY — All Rights Reserved
CLI-1305
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance movable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the movable cable modems.
Syntax
show cable load-balance movable [slot ] [group ] [detail]
Parameter
Definition
[slot ]
Slot number of the CAM. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[group ] [detail]
To filter on a specific group only. Displays detailed information on the specified group.
Example
The following is an example of the output returned by the system: C4#
show cable load-balance movable slot 13 group 3 Load Balance Group US Number of Movable Status ID CMs -------------------------------------------------0x00000003 ( 3) 13/1 0 0x00000003 ( 3) 13/20.0 0 0x00000003 ( 3) 13/11 0 0x00000003 ( 3) 13/20.1 0
Example
The following is an example of the output returned by the system: C4#
show cable load-balance movable slot 13 group 3 detail
Movable CMs for Load Balance Group Status Id 0x00000003 (
3):
US: 13/1 ---------------------------------------
CLI-1306
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Total: 0 US: 13/20.0 --------------------------------------Total: 0 US: 13/11 --------------------------------------Total: 0 US: 13/20.1 --------------------------------------Total: 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1307
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance notmovable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the non-movable cable modems.
Syntax
show cable load-balance notmovable [slot ] [group ] [detail]
Parameter
Definition
[slot ]
Slot number of the CAM. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[group ] [detail]
To filter on the specified group only. Displays detailed information on the specified group.
Example
To display the non-movable cable modems on group 3 on the CAM in slot 12, use the following command: C4>
show cable load-balance notmovable slot 13 group 3 The following is an example of the output returned by the system: Load Balance Group US Number of Not Movable Status ID CMs ---------------------------------------------------0x00000003 ( 3) 13/1 0 0x00000003 ( 3) 13/20.0 0 0x00000003 ( 3) 13/11 0 0x00000003 ( 3) 13/20.1 0
CLI-1308
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance oui Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the cable modems with the partial MAC mask included or excluded from load-balancing.
Syntax
show cable load-balance oui
Parameter
Issue 2.0
Definition
The MAC address, in the xx.xx.xx.xx.xx.xx format.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1309
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance policy Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the provisioning for the load balance policies in a table format. Since there is a good deal of provisioning for each policy and it is important to be able to see how the load-balance policy provisioning differs from each other, the provisioning is displayed in a table format. NOTE If the policy number is provided, then the table is shown with only rules associated with the one policy. If no provisioning is found for a provided policy number, then the show command will generate an error indicating that the policy number could not be found. If no policies are provisioned, then an error is generated indicating no policies were found.
Syntax
show cable load-balance policy []
Parameter
Definition
[]
The policy number
Example
To display the provisioning for the load balance policy, use the following command: C4>
show cable load-balance policy The following is an example of the output returned by the system:
Steering Thres Disable Registration Periodic Channel Policy Rule Enabled -hold Type Method Start Period D2.0 D3.0 D2.0 D3.0 Weight ---------- ---------- ------- ----- ------- ------ ------------------ ----- ----- ----- ----- ------Default(0) - yes 10% both modem 00:00:00 00:00:00 --
CLI-1310
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable load-balance statistics Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the provisioning for the load balance counts in a table format. Since there is a good deal of provisioning for each policy and it is important to be able to see how the load-balance policy provisioning differs from each other, the provisioning is displayed in a table format.
Syntax
show cable load-balance statistics
Example
To display the provisioning for the load balance statistics, use this command: C4>
show cable load-balance statistics The first sample output describes a CMTS configured for load balancing based on modem counts; the second sample output is based on utilization.
Slot/ Oper LBal Init Load Dynamic Transfers Static Tranfers Port State State Group Tech %Util Counts In Out In Out ------ ----- ------- ---------- --------- ------------- --------------------- --------------------15/D0 IS enable 16779264 disable 8 0 0 15/D1 IS enable 16779264 disable 3 0 0 15/D2 IS enable 16779264 disable 3 0 0 15/D3 IS enable 16779264 disable 4 0 0 13/U0 IS enable 16779264 disable 8 0 0 0 0 13/U1 IS enable 16779264 disable 3 0 0 0 0 13/U2 IS enable 16779264 disable 3 0 0 0 0 13/U9 IS enable 16779264 disable 4 0 0 0 0 12/D0 IS enable 3531610112 disable 0 0 0 12/U0 IS enable 3531610112 disable 0 0 0 0 0 12/U1 IS enable 3531610112 disable 0 0 0 0 0 12/D1 IS enable 3540000768 disable 0 0 0 12/U6 IS enable 3540000768 disable 0 0 0 0 0 12/U7 IS enable 3540000768 disable 0 0 0 0 0 ================================================================ Slot/ Oper LBal Init Load Dynamic Transfers Static Tranfers Port State State Group Tech %Util Counts In Out In Out ------ ----- ------- ---------- --------- ------------- --------------------- --------------------15/D0 IS enable 16779264 bcastRng 40 0 0 15/D1 IS enable 16779264 bcastRng 15 0 0 15/D2 IS enable 16779264 bcastRng 15 0 0 15/D3 IS enable 16779264 bcastRng 20 0 0 13/U0 IS enable 16779264 bcastRng 40 0 0 0 0 13/U1 IS enable 16779264 bcastRng 15 0 0 0 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1311
CLI Command Descriptions
13/U2 13/U9 12/D0 12/U0 12/U1 12/D1 12/U6 12/U7 14/D9 14/D10 14/D11 11/U8 11/U9 14/D8 14/D9 14/D10 14/D11 11/U10 11/U11
IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable IS enable
C4/C4c CMTS Rel. 8.0.7
16779264 bcastRng 16779264 bcastRng 3531610112 bcastRng 3531610112 bcastRng 3531610112 bcastRng 3540000768 bcastRng 3540000768 bcastRng 3540000768 bcastRng 33566720 bcastRng 33566720 bcastRng 33566720 bcastRng 33566720 bcastRng 33566720 bcastRng 33568768 bcastRng 33568768 bcastRng 33568768 bcastRng 33568768 bcastRng 33568768 bcastRng 33568768 bcastRng
15 20 0 0 0 0 0 0 -
0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Table CLI-12: Column Headings for Load Balancing Statistics Column
Description
Interface
US or DS channel that is part of a load balance group.
Oper State
Operational State: service state of the channel.
LBal State
Load Balancing State: whether load balancing is enabled or disabled for the load balance group.
Group
Load Balance Group number. This number is assigned by the CMTS for a general group or provisioned by the user for a restricted group.
Init Tech
Dynamic Channel Change (DCC) Initialization Technique
Load
%Util
Traffic load on this channel calculated as a percentage of Channel utilization for upstreams computed by number of minislots used by the map maker for unicast grants divided by the total number of minislots available over a fixed time interval. DS channel utilization is computed as total bytes sent divided by the total available bandwidth over the measurement interval. The channel with the greatest utilization moves a modem to the channel with the least.
Count
Number of CMs per channel. The choice of the CM to be moved is determined by the provisioned values of load balance priority and load balancing policy ID. If these values are equal, then a CM is chosen randomly to be moved from the channel with the most CMs to the channel with the least.
Load
Dynamic Transfer
Static Transfer
CLI-1312
In The number of modems that have been moved as a result of Dynamic Load Out Balancing. The number of modems that have been moved as a result of Static Load In Balancing. Static load balancing can occur only when a modem is ranging. Out Static load balancing applies only to upstream channels. Downstream interfaces (channels) show only dashes (null counts) for static load balancing.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable metering Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IP Detail Record (IPDR) streaming configuration parameters and runtime information. Next to the displayed collector priority are status flags; the P flag identifies the current primary collector and the A flag identifies a connected or active collector.
Syntax
show cable metering
Example
To show the cable metering output, type the following command: C4>
show cable metering The following is an example of the output returned by the system:
IPDR: query-port: streaming-port: keep-alive-interval: SessId -----1 2 3
Service ---------samis-1 cpe cpe
enabled 4737 4737 90 Meth ----time adhoc event
Example
DAWin ----65535 200 200
DATO ---600 60 60
PaceGap ------0
AllCnts ------true -
For additional IPDR information, the following is an example using the detail option: c4>
IPDR: query-port: streaming-port: keep-alive-interval:
Issue 2.0
RepCyc -----1 1
show cable metering detail enabled 4737 4737 90
ARRIS PROPRIETARY — All Rights Reserved
CLI-1313
CLI Command Descriptions
session-id: service: method: data-ack-window: data-ack-timeout: all-counts:
C4/C4c CMTS Rel. 8.0.7
1 samis-1 time 65535 600 true
Collectors data records this collector (P=prim, A=active) exported-----------------suppressed-prior IP address interim stop interim ------ --------------- ------------ ----------------------7 10.1.175.130 0 0 0 10 10.1.175.134 0 0 0 12 10.5.32.126 0 0 0 48 10.1.64.215 0 0 0 78 10.1.64.214 0 0 0 Report Cycle 1 start ----00:00
data records this report cycle exported-----------------suppressed-interim stop interim ------------ ----------------------0 0 0
interval -------15
session-id: service: method: data-ack-window: data-ack-timeout:
2 cpe adhoc 200 60
Collectors (P=prim, A=active) priority IP address -------- --------------7 10.1.175.130 10 10.1.175.134 12 10.5.32.126 48 10.1.64.215 78 PA 10.1.64.214
data records this collector --------------------------0 0 0 0 9183
Recent activity (max 4)
CLI-1314
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
start --------------------2009 July 16 8:32:09 2009 July 16 15:46:11 2009 July 17 1:15:22 session-id: service: method: data-ack-window: data-ack-timeout: evt-pace-gap:
stop --------------------2009 July 16 9:46:21 2009 July 16 16:25:01 *
data records this adhoc session ----------------------4438 4721 24
3 cpe event 200 60 0
Collectors data records this collector (P=prim, A=active) exported------------------prior IP address start stop ------ --------------- ------------ -----------7 10.1.175.130 0 0 10 10.1.175.134 0 0 12 10.5.32.126 0 0 48 10.1.64.215 0 0 78 10.1.64.214 0 0 Report Cycle 1 start ----00:00
interval -------15
data records this report cycle exported---------------------start stop -------------- -------------0 0
Related Command(s)
configure cable metering configure cable metering session id * service * method
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1315
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays general information on functionality and display options for all cable modems registered or attempting to register. A number of different displays can be chosen as well as the user can create their own display by using the COLUMN or FORMAT options. 1 The CMs can be displayed in three different sort orders: -
sort-by
- Sort by fpcm-id, mac or interface
2 The CMs can be filtered on 23 different criteria as shown in the following table:
Single Match
CLI-1316
A.B.C.D
Filter on CM IP address
H.H.H
Filter on CM MAC address
cm-ip
Filter on CM IP address
cm-mac
Filter on CM MAC address
cpe-ip
Filter on IP address of CPE under CM
cpe-mac
Filter on MAC address of CPE under CM
ipv6 address
Filter on CM IPv6 address
fpcm-id
Filter on Flexpath CM ID
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Group Match
bonded
Filter on bonded CMs
non-operational
Filter on non-operational CMs
operational
Filter on operational CMs
rogue
Filter on rogue CMs
cable (x)
Filter on CAM interface identifier (slot or slot/port or slot/ds/us)
cable-downstream (s/p)
Filter on downstream interface (slot or slot/port)
cable-mac (x)
Filter on MAC Identifier (1-416 or slot/ds)
cable-upstream (s/p.l)
Filter on upstream interface (slot or slot/port or slot/port/log channel)
cm-ip-type
Filter on CM’s IP address type: ipv4/ipv6
cm-type
Filter by modem type std (on-flexpath), ccm (each flexpath channel) or fpcm (master flexpath id)
min-error
Filter on minimum combined CRC and HCS error count
slot
Filter on CAM slot
state
Filter on SM state
state-docsis20
Filter on CM DOCSIS 2.0 state
vendor
Filter on CM vendor name
3 The CMs can be displayed in fifteen different formats:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1317
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
bonded-uchannels
Display D3.0 per channel counts for bonded CMs
detail
Display detailed CM information
dropped
Display dropped packet information
errors
Display CRC and HCS error information
flexpath
Display only flexpath CMs, grouped by flexpath subscriber
format
Display the modems using a configured column format
noise
Display per CM and D3.0 per channel SNR counts.
offline
Display offline CM information
phy
Display physical interface information
system-description
Display CM sysDesc information
bonded-impaired
Filter on bonded CMs that are not functioning at full capacity
deny
Display denied cable modem provisioning and state
column
Display all cable modems using the specified column(s)
count
Display only CM count totals
qos
Display cable mode per subscriber throughput
summary
Cable modem summary information
summary state
Show the transitional state/other states not shown on summary page
summary mac
Display summary counts organized by MAC
summary state cable-mac
Display the transitional states/other state for a single cable-mac
Syntax
show cable modem
Example
This is the main command to display cable modem information. It has been optimized for general use. A number of different displays can be chosen as well as the user can create their own with the column or format options. C4>
show cable modem The output would look similar to:
Mar
5 09:47:03
Interface (DS-US) ------------14/3-3/0 14/3-3/0
CLI-1318
DOC Mac Bonded State SIS Qos CPE MAC address IP Address ----- ------ ----------- --- ------------- --- --------------- -----------------------1 Operational 2.0 0/0 0 0015.ce2f.9a56 10.129.31.248 1 4x4 Operational 3.0 0/0 0 0015.cf38.1a73 10.129.31.251
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
14/3-3/0 14/3-3/0 14/3-3/3 14/7-3/6 14/9-3/23
1 1 1 2 3
4x4 4x4 4x4 4x4 4x4
Operational Operational Operational Operational Operational
3.0 3.0 3.0 3.0 3.0
0/0 0/0 0/0 0/0 0/0
1 0 0 0 1
0015.cf38.1eb4 0015.cf38.1fc8 0015.cf38.1de2 0015.cf38.1abe 0015.cf38.1fbc
10.129.31.252 10.129.31.250 10.129.31.249 10.129.31.254 10.129.31.253
Total Oper Disable Init Offline --------------------------------------------------------Total 7 7 0 0 0
Where: Interface -This is the primary interface on which cable modem has registered. Downstream Slot/port – Upstream slot/port Mac - Cable-mac for the interface Bonded -This column displays the maximum count of the channels in the DS and US channel sets. These channels may or may not be used for bonding based on the service flows set up for the CM. This can have following values for bonded CMs: 1 DSChsetsize x USChSetSize 2 For FlexPath CMs, ‘f’ indicates that this is a Flexpath CM or a CCM & ‘*’ indicates that this is a Flexpath CM is the Master CM. 3 Bonded keyword in the show cable modem command output will be displayed if … The CM is bonded but there is no DS channel set associated with the RcsID, and/or the CM is bonded but there is no US channel set associated with the TcsID. 4 State - Represents the DOCSIS 3.0 state of the CM. !Operational - Dynamic Secret Failed #Operational - TFTP Enforce Failed 5 CPEs - Number of CPEs for this CM.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1319
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem bonded-impaired Default Access Level
Mode
Non-privileged
Privileged EXEC
Purpose
Displays the bonded CMs that are not functioning at full capacity with information about how they are actually functioning as well as why they are at less than full capacity. If no cable modem is specified, then the CMTS displays the status of all the impaired bonded cable modems. If you want to display a specific modem, you must enter either its MAC or IP address. The filters associated with the specific modem are optional.
Syntax
show cable modem bonded-impaired
Example
To display the status of the upstream channels on the bonded cable modems, type the following command: C4
show cable modem bonded-impaired The output would look similar to:
C4# show cable Interface (DS-US) ------------14/0- 0/0.0 +14/0- 0/0.0 +14/0- 0/0.0 14/2- 0/2.0 +14/2- 0/2.0 +14/2- 0/2.0 14/7- 0/6.0 +14/7- 0/6.0 +14/7- 0/6.0 14/6- 0/7.0 +14/6- 0/7.0 +14/6- 0/7.0 14/6- 0/7.0 +14/6- 0/7.0 +14/6- 0/7.0 14/5- 0/8.0 +14/5- 0/8.0 +14/5- 0/8.0
CLI-1320
modem bonded-impaired Actual Impair Mac Bonded Bonded Port ----- ------ ------ -------1 4x4 4x1 U0/1.0 1 4x4 4x1 U0/2.0 1 4x4 4x1 U0/3.0 1 4x4 4x1 U0/0.0 1 4x4 4x1 U0/1.0 1 4x4 4x1 U0/3.0 2 4x4 4x1 U0/7.0 2 4x4 4x1 U0/8.0 2 4x4 4x1 U0/9.0 2 4x4 4x1 U0/6.0 2 4x4 4x1 U0/8.0 2 4x4 4x1 U0/9.0 2 4x4 4x1 U0/6.0 2 4x4 4x1 U0/8.0 2 4x4 4x1 U0/9.0 2 4x4 4x1 U0/6.0 2 4x4 4x1 U0/7.0 2 4x4 4x1 U0/9.0
Impair Reason ----------badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs badTcs
DOC SIS --3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0 3.0
MAC address --------------0015.cee7.dae2 0015.cee7.dae2 0015.cee7.dae2 0015.cee7.d887 0015.cee7.d887 0015.cee7.d887 0015.cee7.daeb 0015.cee7.daeb 0015.cee7.daeb 0015.cee7.d92f 0015.cee7.d92f 0015.cee7.d92f 0015.cee7.daca 0015.cee7.daca 0015.cee7.daca 0015.cee7.d9c5 0015.cee7.d9c5 0015.cee7.d9c5
ARRIS PROPRIETARY — All Rights Reserved
IP Address -----------------10.116.0.45 10.116.0.45 10.116.0.45 10.116.0.34 10.116.0.34 10.116.0.34 10.116.0.54 10.116.0.54 10.116.0.54 10.116.0.15 10.116.0.15 10.116.0.15 10.116.0.164 10.116.0.164 10.116.0.164 10.116.0.190 10.116.0.190 10.116.0.190
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Where: Interface: A “+” before Interface column indicates one or more rows for that CM. In this case the Impair Port and Impair reason values can be different for multiple rows. Bonded: This column displays the max count of the channels in the DS and US channel sets. Actual Bonded: This indicates the actual count of DSxUS channels being used due to impaired ports. Impair Port: This gives a U or D for US or DS and the slot/port for the channel that’s impaired. Impair Reason: Indicates why the US or DS port is impaired. Possible values for this column are: badTcs, badRcs, PortDown, qamFecLockFailure, unknownMdDsSgId, unknownMdUsSgId, t1Timeout, t3Timeout, t4Timeout. Related Command(s)
show cable modem
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1321
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem bonded-uchannels Default Access Level
Mode
Non-privileged
Privileged EXEC
Purpose
Display DOCSIS 3.0 per channel counts for bonded CMs with each upstream channel shown.
Syntax
show cable modem bonded-uchannels
Example
To display the status of the upstream channels on the bonded cable modems, enter the following command: show cable modem bonded-uchannels 0013.0000.0002 The output would look similar to:
Nov 29 12:06:06 UChan FEC UChan FEC Interface Corrected Unerrored (DS-US) CM MAC address State Codewords Codewords --------- -------------- --------- ------- -------14/0-5/1 0015.cf1f.e21d Operational 0 17992 +14/0-5/0 0015.cf1f.e21d Operational 0 17928 +14/0-5/2 0015.cf1f.e21d Operational 0 17931 +14/0-5/3 0015.cf1f.e21d Operational 0 17934 14/0-5/1 0015.cf1f.e2e3 Operational 0 17994 +14/0-5/0 0015.cf1f.e2e3 Operational 0 17922 +14/0-5/2 0015.cf1f.e2e3 Operational 0 17941 +14/0-5/3 0015.cf1f.e2e3 Operational 0 17927 14/0-5/1 0015.cfb4.60f8 Operational 0 17993 +14/0-5/0 0015.cfb4.60f8 Operational 0 17939 +14/0-5/2 0015.cfb4.60f8 Operational 0 17928 +14/0-5/3 0015.cfb4.60f8 Operational 0 17924 14/0-5/1 0015.d187.3b4d Operational 0 18000 +14/0-5/0 0015.d187.3b4d Operational 0 17928 +14/0-5/2 0015.d187.3b4d Operational 0 17926 +14/0-5/3 0015.d187.3b4d Operational 0 17930 14/0-5/1 0015.d187.3b57 Operational 0 18008 +14/0-5/0 0015.d187.3b57 Operational 0 17925 +14/0-5/2 0015.d187.3b57 Operational 0 17920 +14/0-5/3 0015.d187.3b57 Operational 0 17932
CLI-1322
UChan FEC Uncorrect Codewords ------0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
UChan UChan UChan Rec UChan USSNR UChan Timing Power SM Response (db) PowerAdj Offset ---- ---------- ----- ------- ----0.0 100.0000 42.6 1 1196 0.2 100.0000 42.2 4 3133 -0.1 100.0000 43.2 0 3133 0.0 100.0000 42.6 0 3133 0.0 100.0000 42.8 1 1194 0.0 100.0000 42.0 4 3132 -0.1 100.0000 42.7 0 3131 0.0 100.0000 43.2 0 3131 0.0 100.0000 43.0 1 1195 0.0 99.9944 42.3 4 3134 0.0 99.9944 42.8 0 3133 0.0 99.9944 42.7 0 3133 0.0 100.0000 42.5 1 1194 0.0 100.0000 42.2 4 3132 0.0 99.9944 42.9 0 3132 0.0 100.0000 43.1 0 3132 0.0 99.9944 42.9 0 1196 -0.1 100.0000 42.2 3 3136 -0.1 100.0000 42.7 0 3136 0.0 99.9944 42.7 0 3136
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
14/0-5/2 +14/0-5/0 +14/0-5/1 +14/0-5/3 14/1-5/0 +14/1-5/1 +14/1-5/2 +14/1-5/3 14/1-5/0 +14/1-/1 +14/1-5/2 +14/1-5/3 14/1-5/1 +14/1-5/0 +14/1-5/2 +14/1-5/3 14/1-5/2 +14/1-5/0 +14/1-5/1 +14/1-5/3 14/2-5/1 +14/2-5/0 +14/2-5/2 +14/2-5/3 14/2-5/2 +14/2-5/0 +14/2-5/1 +14/2-5/3 14/3-5/1 +14/3-5/0 +14/3-5/2 +14/3-5/3
001d.ce12.b2fc 001d.ce12.b2fc 001d.ce12.b2fc 001d.ce12.b2fc 001d.ce12.b0c2 001d.ce12.b0c2 001d.ce12.b0c2 001d.ce12.b0c2 001d.ce12.b830 001d.ce12.b830 001d.ce12.b830 001d.ce12.b830 0015.d002.e609 0015.d002.e609 0015.d002.e609 0015.d002.e609 001d.ce12.b29c 001d.ce12.b29c 001d.ce12.b29c 001d.ce12.b29c 0015.cf1f.ea12 0015.cf1f.ea12 0015.cf1f.ea12 0015.cf1f.ea12 0015.d187.3b81 0015.d187.3b81 0015.d187.3b81 0015.d187.3b81 0015.d187.3b49 0015.d187.3b49 0015.d187.3b49 0015.d187.3b49
Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational Operational
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
17995 17973 17926 17936 18040 17928 17940 17925 18036 17929 17932 17933 17943 17886 17882 17876 18000 17966 17925 17937 17997 17933 17926 17933 17999 17933 17926 17928 17999 17928 17928 17933
0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0.0 -2.6 0.0 0.0 -2.6 0.0 0.0 0.0 -2.6 0.0 0.0 0.0 -0.1 -0.1 0.0 0.0 -0.1 -2.6 -0.2 0.0 0.0 0.0 0.0 -0.1 0.0 0.0 0.0 0.0 0.2 0.0 0.0 0.0
100.0000 99.9889 99.9888 99.9888 99.9945 99.9833 99.9833 99.9833 99.9945 99.9833 99.9833 99.9833 100.0000 99.9944 99.9944 99.9944 100.0000 99.9833 99.9833 99.9833 100.0000 100.0000 100.0000 100.0000 100.0000 99.9944 99.9944 99.9944 100.0000 100.0000 99.9944 99.9944
43.3 39.8 43.4 43.2 39.7 43.5 43.6 43.6 39.5 43.4 43.4 43.1 43.0 42.1 43.1 42.9 42.8 39.5 43.0 43.3 42.9 42.0 43.1 43.1 43.0 41.8 43.0 42.9 43.0 42.1 43.1 42.8
13 168 38 0 171 34 9 0 170 37 9 0 0 0 0 0 10 174 37 0 0 4 0 0 0 3 0 0 1 4 0 0
990 1046 1046 1046 989 1044 1043 1044 987 1043 1043 1043 1193 3133 3133 3133 987 1043 1043 1043 1192 3135 3135 3135 1191 3131 3131 3132 1188 3133 3133 3133
Total Oper Disable Init Offline --------------------------------------------------------Found 13 13 0 0 0
NOTE Note: A + (plus sign) before an interface column indicates one or more rows for the CM. Columns with Uchan as the heading will have values that are different for multiple rows. Related Command(s)
show cable modem
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1323
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem column Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
This command allows the user to create their own display format. The user can specify up to 32 columns to display. NOTE This cannot be used along with other filters. To use personally created format and filters, refer to show cable modem format. Using the show cable modem ? will list the column names and show cable modem column help will display detailed help for the columns. The following table contains the available options: bonded
cm-up-pwr
flap-last-flap
microflec
bonded-actual
congest-down
flap-prev-state
policed-down
bpi
congest-up
flaps--prov
power-adj
cable-mac
cpe-count
flaps-ranging
qos
cfgfile
*cpe-ip
flaps-reg
rec-pwr
cfgfile-long
*cpe-mac
fpcm-online
response-percent
*cm-cpe-ip
*cpe-type
fpcm-cpe
service-type-curr
cm-down-pwr
crc
fpcm-id
service-type-prov
cm-down-snr
docsis-mac
fpcm-qos
sid
cm-ip
docsis-prov
hcs
snr
cm-mac
fec-corrected
interface
state
cm-microreflec
fec-percentuncorrected
interfacedocsis20
state-docsis20
cm-sysdesc
fec-uncorrected
l2vpn-id
timing
cm-time-polled
fec-unerrored
l2vpn-qtag
uptime
cm-timing
filter-cm
load-bal-grp
vendor
cm-type
CLI-1324
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
NOTE An * in front of the column indicates that it will display multiple rows for CPEs. Syntax
show cable modem column
Example
The following is an example command using various options: C4
show cable modem column interface mac cm-type The following is an example of the output returned by the system: Interface (DS-US) MAC address CM TYPE -------------- -------------- -------15/0-13/0.0 0013.0000.0001 STD 15/0-13/0.0 0013.0000.0004 CCM 15/0-13/0.0 0013.0000.0008 CCM 15/0-13/0.1 0013.0000.0002 STD 15/0-13/0.1 0013.0000.0003 STD 15/1-13/0.0 0013.0000.0009 CCM 15/1-13/1 0013.0000.0005 CCM 15/2-13/0.0 0013.0000.000a CCM 15/2-13/2 0013.0000.0007 CCM 15/3-13/0.0 0013.0000.000b CCM 15/3-13/3 0013.0000.0006 CCM Total Oper Disable Init Offline --------------------------------------------------------Total 11 11 0 0 0 The keyword multiple-uchan will display multiple rows per CM for a US bonded CM. The first row is for the primary channel and following rows are for non-primary US interfaces. The show cable modem column multipleuchan ? will display an * in front of the columns that will display different data for primary and non-primary US channels. The following is an example of this output:
C4
show cable modem column multiple-uchan interface mac Nov 17 16:53:42
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1325
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Interface (DS-US) -------------14/1-1/1 +14/1-1/0 +14/1-1/2 +14/1-1/8 14/1-1/1 +14/1-1/0 +14/1-1/2 +14/1-1/8 14/1-1/2 +14/1-1/0 +14/1-1/1 +14/1-1/8 14/2-1/0 14/2-1/1 +14/2-1/0 +14/2-1/2 +14/2-1/8 14/3-1/2 14/4-2/0 14/4-2/0 14/4-2/2 14/4-2/2 14/4-2/2 14/5-2/0 14/5-2/0 14/5-2/0 14/5-2/2 14/5-2/2 14/5-2/2 14/6-2/0 14/6-2/0 14/6-2/0 14/6-2/2 14/6-2/2 14/6-2/2 14/7-2/1 14/7-2/1
CLI-1326
CM MAC address -------------0015.cf9a.4c3f 0015.cf9a.4c3f 0015.cf9a.4c3f 0015.cf9a.4c3f 0015.cfee.4c87 0015.cfee.4c87 0015.cfee.4c87 0015.cfee.4c87 0005.ca67.db70 0005.ca67.db70 0005.ca67.db70 0005.ca67.db70 0015.96e6.9f18 0015.cfee.4c23 0015.cfee.4c23 0015.cfee.4c23 0015.cfee.4c23 0015.a200.f40b 0015.a464.e5ed 0015.a464.f0c1 0015.a464.e647 0015.ce64.34fb 0015.ce64.417f 0015.a464.e46a 0015.a464.e9b9 0015.ce64.3a08 0015.a464.e69b 0015.a464.efe3 0015.ce64.3a56 0015.a464.eaa3 0015.a464.ec5c 0015.ce64.3cb1 0015.a464.eab8 0015.a464.eb84 0015.ce64.3e58 0015.a464.e4be 0015.a464.ecd1
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
14/7-2/1 14/7-2/1 14/7-2/1 14/7-2/1 14/7-2/1
0015.a464.ed01 0015.a464.f019 0015.a464.f025 0015.ce64.3672 0015.ce64.3e16
Total Oper Disable Init Offline --------------------------------------------------------Total 30 30 0 0 0 For the optional cm-cpe-ip parameter, the following example applies: C4# show cable modem column cm-mac cm-cpe-ip cpe-count cpe-mac
cm-mac --------------CM1MAC........ + CM1MAC........ + CM1MAC........ CM2MAC........ + CM2MAC........ CM3MAC........ + CM3MAC........ + CM3MAC........ + CM3MAC........
cpecm-cpe-ip count ---------------------------------------- ----CM1IP...................... 2 CPE1AIP..... CPE1BIP.......................... CM2IP....... 1 CPE2AIP.................... CM3IP....... 3 CPE3AIP............................... CPE3BIP............. CPE3CIP..................... -
cpe-mac --------------CPE1MAC........ CPE2MAC........ CPE1MAC..... CPE1MAC........ CPE2MAC........ CPE3MAC........
NOTE When the cm-cpe-ip parameter is used, the first row of the output for a given CM contains information specific to that CM. If the CM contains any CPE devices, then the following rows which present that CPE information will start with a plus (+) symbol. The rows with the “+” prefix belong to the same CM as the previous row(s) containing the CM information. Related Command(s)
show cable modem show cable modem format configure cable modem format
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1327
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem count Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays only the CM count totals.
Syntax
show cable modem count
Example
To display total counts for CMs, use the following command: C4
show cable modem count The following is an example of the output returned by the system: Nov 05 14:45:41 Total Oper Disable Init Offline --------------------------------------------------------Total 11 11 0 0 0
CLI-1328
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem deny Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the set of CM MAC addresses that are in the deny state. If the address is supplied, then only information on the specified MAC address will be displayed. Modems are configured using the configure cable modem deny command. Denied modems can register but do not receive an IP address.
Syntax
show cable modem deny []
Parameter
Definition
[]
MAC address
Example
To display information on the specified MAC address from the CM Deny List MIB, use the following command: C4
show cable modem deny The following is an example of the output returned by the system: MAC address ----------------
Interface (DS-US) -------------
0015.a200.f40b Unk-1/1
Last Time --------------------
Count --------------
23-Nov-2011 23:19:48 3
Related Command(s)
show cable modem configure cable modem deny
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1329
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem detail Default Access Level
Mode
Non-privileged -1
User EXEC
Purpose
Displays detailed information per CM, accessing information directly from the CAM.
Syntax
show cable modem detail
Example
To display detailed information for a single ARRIS cable modem, type the following command: C4>
show cable modem detail
The following is an example of the system output of the show cable modem detail command. Nov 05 12:31:34 5/0-13/0.0 CM 0013.0000.0001 (00.13.00) D3.0 State=Operational D1.1/atdma PrimSID=1 Cable-Mac= 1, mCMsg = 1 mDSsg = 1 mUSsg = 1 RCP_ID= 0x0010000004 RCC_Stat= 1, RCS=0x01000002 TCS=0x01000003 Timing Offset=274 Rec Power= 0.00 dBmV Proto-Throttle=Normal dsPartialServMask=0x0000 usPartialServMask=0x000006 Uptime= 0 days 1:03:27 IPv4=13.0.1.0 cfg=RegReq349 noLoadBal=0x00 Privacy=Disabled u/d SFID SID State Sched Tmin Tmax DFrms DBytes CRC HCS Slot/Ports uB 1 1 Activ BE 0 30000000 0 0 0 4 13/0.0,(1.0),(2.0),3.0 dB 2 *1 Activ 0 100000000 38390 10442080 5/0,1,2,3 Current CPE=6 Max CPE=6 CPE 0013.0100.0001 IP=13.0.1.1 Filter-Group:Up=0 Down=0 Proto-Throttle=Normal CPE 0013.0200.0001 IP=13.0.1.2 Filter-Group:Up=0 Down=0 Proto-Throttle=Normal CPE 0013.0300.0001 IP=13.0.1.3 Filter-Group:Up=0 Down=0 Proto-Throttle=Normal CPE 0013.0400.0001 IP=13.0.1.4 Filter-Group:Up=0 Down=0 Proto-Throttle=Normal CPE 0013.0500.0001 IP=13.0.1.5 Filter-Group:Up=0 Down=0 Proto-Throttle=Normal CPE 0013.0600.0001 IP=13.0.1.6 Filter-Group:Up=0 Down=0 Proto-Throttle=Normal
CLI-1330
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
In the first line of the output, there are two references to DOCSIS: •
The first one is the CM capability - taken from modem capabilities that the modem sends up in the registration request.
•
The 2nd is the type that the CM is configured to use - taken from the registration DOCSIS style of the registration request - DOCSIS 1.0 if no QoS, DOCSIS 1.1 if QoS.
The noLoadBal flag will be set to 1 if the CM has one or more static, provisioned US UGS flows in the CM config file. This is an indication that this modem will not be DCC'ed during load balancing. During a dynamic load balancing operation, noLoadBal is a bit map of reasons why this SM should not be moved. The dsPartialServMask is a bit map of 16 bits indicating which downstream channels were not acquired by a DS channel bonding capable CM during registration. The least significant bit represents downstream port 0 on a DMM and the most significant bit represents downstream port 15 on a DMM. The usPartialServMask is a bit map of 24 bits indicating which upstream channels were not acquired by a US channel bonding capable CM during registration. For each US and DS service flows: •
A letter B under the u/d column indicates a bonded service flow.
•
A letter 'C' indicates that it's a non-bonded US service flow with single channel but segment headers are enabled, i.e. MTCM CCF is on.
•
A “-” after the SFID is displayed to indicate a failure status for service flow assignment to a bonding.
•
A () around the ports for upstream and downstream indicates that the port is impaired.
Table CLI-13 provides an explanation for elements of the show cable modem detail output that are related to Current CPE and Max CPE: Table CLI-13: Explanation of Current CPE and Max CPE Output Element Current CPE = 4 IPv4 Addr=3 IPv6 Addr=4
Issue 2.0
Explanation Current count of unique CPE MAC addresses linked to the CM. Current total count of IPv4 addresses assigned to CPEs behind the CM. Current total count of IPv6 addresses assigned to CPEs behind the CM.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1331
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Table CLI-13: Explanation of Current CPE and Max CPE Output Element
Explanation Maximum count of all MAC addresses that can be linked behind the CM. The value of “Max CPE” is enforced by the CM, not the CMTS. This is in accordance with the MULPI spec.
Max CPE = 16
The value can be defined in the registration request TLV 18 MAX CPE or it can be constrained due to hardware limitations. If the TLV is missing or set to a value of zero, the actual MAC limiting value the CM uses defaults to 1, and “Max CPE=1” is displayed. If the TLV contains a value from 1 to 32, the CM limits MAC count from 1 to 32 respectively, and “Max CPE=32” is displayed. If the TLV contains a value greater than 32, the CMTS will limit MAC count per CM to 32 (the hardware defined limit), and “Max CPE=32” is displayed.
IPv4 Addr=32
Maximum count of total number of IPv4 addresses that can be assigned across all CPEs behind the CM. This count is configurable using the configure cable submgmt default max-cpe command. It takes effect only if submgmt is enabled (configure cable submgmt default active).
IPv6 Addr=64
Maximum count of total number of IPv6 addresses that can be assigned across all CPEs behind the CM. This count is configurable using the configure cable submgmt default v6-max-cpe command. It takes effect only if submgmt is enabled (configure cable submgmt default active).
NOTE There can be an apparent discrepancy between the QoS value displayed by the show cable modem command and the Tmax values of the show cable modem detail command. This is because the QoS value is the sum of the Tmax values of the service flows. If there is a service flow with a Tmax of 0, then the QoS will be displayed as 0. C4# show cable modem 0015.9613.3823 Feb 15 16:17:32 Interface DOC (DS-US) Mac Bonded State SIS Qos CPE MAC address IP Address ------------- ----- ------ ----------- --- ------------- --- --------------- ----------------------14/4-1/0 1 Operational 2.0 0/0 2 0015.9613.3823 10.233.99.192 Total Oper Disable Init Offline --------------------------------------------------------Found 1 1 0 0 0
C4# show cable modem 0015.9613.3823 detail Feb 15 16:17:37 14/4-1/0 CM 0015.9613.3823 (Arris) D2.0 State=Operational D1.1/tdma PrimSID=2127 Cable-Mac= 1, mCMsg = 2 mDSsg = 1 mUSsg = 1, RCS=0x00000005 TCS=0x00000001 Timing Offset=1512 Rec Power= 0.00 dBmV Proto-Throttle=Normal Uptime= 22 days 14:47:09 IPv4=10.233.99.192 cfg=HSD_XtremeArris3.bin LB Policy=1 LB Group=16781312 Filter-Group CM-Down:0 CM-Up:4 Privacy=Disabled MDF Capability= N/A MDF Mode= N/A u/d SFID SID State Sched Tmin Tmax DFrms DBytes CRC HCS Slot/Ports
CLI-1332
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
u 2895 2127 Activ BE 0 1174000 604 60369 0 0 1/0 d 2896 *1427 Activ 0 16515072 522 173855 14/4 u 3039 2238 Activ BE 0 0 1 133 0 0 1/0 d 3040 *1499 Activ 0 0 0 0 14/4 u 120609 5314 Activ UGS 116352 116736 963 209934 0 0 1/0 d 120610 *2980 Activ 87200 90112 1040 226720 14/4 L2VPN per CM: (Disabled) Current CPE=2, IPv4 Addr=2, IPv6 Addr=0 Max CPE=9, IPv4 Addr=16, IPv6 Addr=16 CPE 000e.a670.29b2 Filter-Group:Up=2 Down=0 Proto-Throttle=Throttled IPv4=64.53.245.76 CPE(MTA) 0015.9613.3824 Filter-Group:Up=2 Down=0 Proto-Throttle=Normal IPv4=172.25.224.151
Related Command(s)
show cable modem
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1333
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem errors Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays error counts for all cable modems.
Syntax
show cable modem errors
Example
To display error counts on the cable modem, enter the following command: C4>
show cable modem errors
Nov 29 12:36:15 Interface (DS-US) ------------10/1-10/9 10/1-10/9 14/0-5/1 14/0-5/1 14/0-5/1 14/0-5/1 14/0-5/1 14/0-5/2 14/1-5/0 14/1-5/0 14/1-5/0 14/1-5/1 14/1-5/2 14/1-5/3 14/1-5/3 14/1-5/3 14/1-5/3 14/1-5/3 14/2-5/1 14/2-5/2
CLI-1334
CRC -------0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
HCS -------0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
MAC address -------------0000.ca44.ff3e 0015.cf1f.ec58 0015.cf1f.e21d 0015.cf1f.e2e3 0015.cfb4.60f8 0015.d187.3b4d 0015.d187.3b57 001d.ce12.b2fc 0010.1881.01e4 001d.ce12.b0c2 001d.ce12.b830 0015.d002.e609 001d.ce12.b29c 0015.96dd.edc8 0015.96dd.ee85 0015.cf1f.7f68 0015.cfb7.c5b9 001b.2f8c.34da 0015.cf1f.ea12 0015.d187.3b81
(Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Broadcom) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Netgear) (Arris) (Arris)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
14/3-5/1 14/3-5/1 14/3-5/1 14/4-5/2 14/4-5/2 14/5-5/0 14/5-5/2 14/5-5/2 14/6-5/1 14/6-5/1 14/7-5/0 14/7-5/0 14/7-5/2
0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0
0015.96dd.ec27 0015.cfb7.c3fa 0015.d187.3b49 0015.96dd.e879 0015.96dd.eafb 0015.96dd.e96c 0015.96dd.ea68 0015.96dd.eea0 0015.96dd.e6ed 0015.96dd.ede0 0015.96dd.e6d5 0015.cfb7.c3df 0015.96dd.e6cf
(Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris) (Arris)
Total Oper Disable Init Offline --------------------------------------------------------Found 33 33 0 0 0
Related Command(s)
show cable modem
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1335
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem flexpath Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
This command filters through FlexPath CMs and displays the FPCM ID and the number of CCMs for that FPCM. This does not display D3.0 bonded modems.
Syntax
show cable modem flexpath
Example
To display the FlexPath CMs, enter the following command: C4>
show cable modem flexpath Jun 05 14:37:30 CCM OnFlex Path ID line --------------- ---0013.0000.0004 3 0013.0000.0008 1
DSx US --4x4 4x1
Flex Path FlexPath CPE QoS Vendor ---- --------- ------------0 12M/100M 0 3000/100M
Total Oper Disable Init Offline --------------------------------------------------------Found 2 2 0 0 0 Related Command(s)
show cable modem
CLI-1336
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem format Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
This command allows the user to create their own formatted output. The advantage of FORMAT over COLUMN is the ability to use filters and store the format for later use. This command is similar to the show cable modem column command. A format must be configured in order to execute this command. This can be done by executing the configure cable modem format command.
Syntax
show cable modem format
Parameter
Definition
The name of the configured format desired.
Related Command(s)
show cable modem configure cable modem format show cable modem column
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1337
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem offline Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays specific information on offline CMs.
Syntax
show cable modem offline
Example
To display offline CMs, enter the following command: C4>
show cable modem offline
Nov 05 14:41:37 Interface Offline (DS-US) Time ------------- --------5/0-13/0.1 0:00:07
Last UpTime -------0:50:01
Previous Timing State Offset ----------- -----Operational 0
Rx Power ----0.0
MAC address -------------0013.0000.0003 (00.13.00)
Total Oper Disable Init Offline --------------------------------------------------------Found 1 0 0 0 1 Related Command(s)
show cable modem
CLI-1338
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem phy Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays measurements from both the CMTS and the CM. CM information is collected periodically at a rate configured using the configure cable modem remote-query command. This command will not display CM measurements if the “remote-query” has not been set.
Syntax
show cable modem phy
Example
To display offline CMs, enter the following command: C4>
Nov
show cable modem phy
5 16:42:04
Last Poll Started: 2009 June 04 19:13 Completed: 2009 June 04 19:13 ---- CMTS Measurements ----- --------- CM Measurements --------Interface USPwr USSNR uReflec Timing USPwr DSPwr DSSNR uReflec Timing Last (DS-US) (dBmV) (db) (dBc) Offset (dBmV) (dBmV) (db) (dBc) Offset Polled MAC address ------------- ------ ------ ------- ------ ------ ------ ------ ------- ------ ------ -------------12/0-12/0 0.3 33.1 0 1094 38.0 -1.5 34.7 29 1094 21:28 0000.ca41.dc97 (Arris) 12/1-12/6 0.5 36.2 0 1107 34.0 0.7 35.7 29 1121 21:28 0000.ca3f.2c78 (Arris) 15/0-10/0 -0.3 31.2 0 706 16.0 23.1 37.0 29 706 21:28 0000.ca41.9d85 (Arris) 15/0-10/0 -0.3 28.8 0 705 17.0 23.2 36.4 30 706 21:28 0000.ca41.9d8b (Arris) 15/0-10/0 1.6 34.3 0 803 24.3 21.6 39.3 27 803 21:28 0015.ce03.f7a9 (Arris) 15/0-10/0 1.5 0.0 0 0 24.3 19.3 39.3 26 816 21:28 0015.cf00.0ae5 (Arris) 15/0-10/0 1.0 0.0 0 0 24.3 20.0 39.3 25 802 21:28 0015.cf22.452b (Arris) 15/0-10/0 1.0 0.0 0 0 24.3 18.9 38.9 30 802 21:28 0015.cf22.4539 (Arris) Total Oper Disable Init Offline --------------------------------------------------------Total 8 5 0 0 3
Related Command(s)
show cable modem
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1339
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem qos Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays DOCSIS 1.1 through 3.0 QOS information for a single CM. It displays information for each service flow. QOS information for DOCSIS1.0 CM can be found using the show cable qos profile command.
Syntax
show cable modem qos [cm-ip | cm-ipv6 | cm-mac | cpe-ip | cpe-mac | verbose]
Parameter
Definition
cm-ip
IP address
cm-ipv6
IPV6 address
cm-mac
MAC address
cpe-ip
CPE IP address
cpe-mac
CPE MAC address
verbose
Display detailed CM per subscriber throughput
Example
To display QoS information on a CM, enter the following command: C4>
Sfid ---3 4
Format of CM MAC or IP address
Dir Curr State --- ----US act DS act
Sid --2 0
show cable modem qos 0013.0000.0002
Sched Prio MaxSusRate Type ------ ---- ---------BE 0 30000000 0 100000000
MaxBrst
MinRsvRate
------8192 96000
---------0 0
Throughput bits/sec ---------0 4096
Related Command(s)
show cable modem
CLI-1340
ARRIS PROPRIETARY — All Rights Reserved
packets/sec ----------0 1
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem summary Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Displays a summary of the number of modems that are on each interface and the overall system. It displays counts but does not display any information about a particular modem. In the case of bonded modems, the count for each port will be equal to the number of modems on that port since a single bonded modem will be on multiple ports. The totals represents the number of modems, not channels, therefore, the sum of the ports should equal or be greater than the total number of modems. Summaries are given per slot as well as per cable-mac.
Syntax
show cable modem summary
Example
To show the cable modem summary, type the following command: C4>
show cable modem summary The following is an example of the output returned by the system:
S/P Mac Conn Total Oper Disable Init Offline %Oper Description ---------------------------------------------------------------- ----- ------------------2/0/0.0 0 0 0 0 0 0 0% 2/0/0.1 0 0 0 0 0 0 0% 2/0/1 1 0 0 0 0 0 0% 2/0/2 2 0 0 0 0 0 0% 2/1/6.0 6 0 0 0 0 0 0% 2/1/6.1 6 0 0 0 0 0 0% 2/1/7 7 0 0 0 0 0 0% ---------------------------------------------------------------- ----- ------------------Mac 2/0 Total 0 0 0 0 0 0% cable 2/0 mac-port Mac 2/1 Total 0 0 0 0 0 0% cable 2/1 mac-port Card 2 Total 0 0 0 0 0 0% ---------------------------------------------------------------- ----- ------------------5/D0 1 0 5 4 0 0 1 80% 5/D1 1 0 4 4 0 0 0 100% 5/D2 1 0 4 4 0 0 0 100% 5/D3 1 0 5 5 0 0 0 100% ---------------------------------------------------------------- ----- -------------------
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1341
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Mac 1 Total 12 11 0 0 1 91% md1 Card 5 Total 12 11 0 0 1 91% ---------------------------------------------------------------- ----- ------------------13/U0.0 1 0 7 6 0 0 1 85% 13/U0.1 1 0 2 2 0 0 0 100% 13/U1 1 0 2 2 0 0 0 100% 13/U2 1 0 2 2 0 0 0 100% 13/U3 1 0 2 2 0 0 0 100% ---------------------------------------------------------------- ----- ------------------Mac 1 Total 12 11 0 0 1 91% md1 Card 13 Total 12 11 0 0 1 91% ---------------------------------------------------------------- ----- ---------------------------------------------------------------------------------- ----- ------------------Total 12 11 0 0 1 91%
Related Command(s)
show cable modem
CLI-1342
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem summary cable-mac Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Displays summary information for a single cable-mac. The first two columns are swapped in this tailored format.
Syntax
show cable modem summary cable-mac
Parameter
Definition
cable-mac
Example
MAC identifier with optional subinterface.
To show the cable modem summary for cable-mac 1, type the following command: C4>
show cable modem summary cable-mac 1 The following is an example of the output returned by the system:
Mac S/P Conn Total Oper Disable Init Offline %Oper Description -----------------------------------------------------------------------------------1 15/D0 0 5 4 0 0 1 1 15/D1 0 4 4 0 0 0 1 15/D2 0 4 4 0 0 0 1 15/D3 0 5 5 0 0 0 1 13/U0.0 0 7 6 0 0 1 1 13/U0.1 0 2 2 0 0 0 1 13/U1 0 2 2 0 0 0 1 13/U2 0 2 2 0 0 0 1 13/U3 0 2 2 0 0 0 -----------------------------------------------------------------------------------1 Total 12 11 0 0 1 ------------------------------------------------------------------------------------
Related Command(s)
show cable modem show cable modem summary mac cable-mac
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1343
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem summary fiber-node Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Displays the cable modem summary per fiber node.
Syntax
show cable modem summary fiber-node Parameter
Definition
Name of the fiber node .
Example
To show the cable modem summary for fiber node 1, enter the following command: C4>
show cable modem summary fiber-node 1 The following is an example of the output returned by the system:
Mac S/P Conn Total Oper Disable Init Offline %Oper Description --------------------------------------------------------------- ----- ----------1 15/D0 0 5 4 0 0 1 1 15/D1 0 4 4 0 0 0 1 15/D2 0 4 4 0 0 0 1 15/D3 0 5 5 0 0 0 1 13/U0.0 0 7 6 0 0 1 1 13/U0.1 0 2 2 0 0 0 1 13/U1 0 2 2 0 0 0 1 13/U2 0 2 2 0 0 0 1 13/U3 0 2 2 0 0 0 ---------------------------------------------------------------1 Total 12 11 0 0 1 ---------------------------------------------------------------Related Command(s)
show cable modem show cable modem summary cable-mac
CLI-1344
ARRIS PROPRIETARY — All Rights Reserved
80% 100% 100% 100% 85% 100% 100% 100% 100% ----- ---------91% md1 ----- ----------
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem summary mac cable-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the cable modem summary counts organized by MAC. Note: This command is the same as the show cable modem summary cable-mac.
Syntax
show cable modem summary mac cable-mac
Parameter
cable-mac
Definition
MAC identifier with optional subinterface or slot/port.
Related Command(s)
show cable modem show cable modem summary cable-mac
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1345
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem summary slot Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the cable modem summary organized by CAM slot number.
Syntax
show cable modem summary slot
Parameter
Definition
slot
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
Example
To show the cable modem summary for slot 13, enter the following command C4
show cable modem summary slot 13 The following is an example of the output returned by the system:
S/P Mac Conn Total Oper Disable Init Offline %Oper Description ---------------------------------------------------------------- ----- ---------13/U0 1 0 7 6 0 0 1 85% 13/U0 1 0 2 2 0 0 0 100% 13/U1 1 0 2 2 0 0 0 100% 13/U2 1 0 2 2 0 0 0 100% 13/U3 1 0 2 2 0 0 0 100% ---------------------------------------------------------------- ----- ---------Mac 1 Total 12 11 0 0 1 91% md1 Card 13 Total 12 11 0 0 1 91% ---------------------------------------------------------------- ----- ---------Related Command(s)
show cable modem
CLI-1346
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem summary state Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the transitional states/other states not shown on show cable modem summary. It is helpful in debugging CM's stuck in various initialization states.
Syntax
show cable modem summary state [cable-mac | slot ]
Parameter
Definition
cable-mac
MAC identifier
slot
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
Example
To show the cable modem summary state, enter the following command: C4
show cable modem summary state
Initializing Disabled ---------------------------------------------------------------------------- --------Ranging DHCPv4 DHCPv6 CfgFile BPI Registration Fwd S/P Mac Conn Init-Done-Abrt EAE Start--Done Start--Done Start--Done Init Start--Done Dis RFMut ----------------------------------------------------------------------------------------------------2/0/0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2/0/0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2/0/1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2/0/2 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2/1/6 6 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2/1/6 6 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 2/1/7 7 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ----------------------------------------------------------------------------------------------------Mac 2/0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Mac 2/1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Card 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 -----------------------------------------------------------------------------------------------------
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1347
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
5/D0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 5/D1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 5/D2 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 5/D3 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ----------------------------------------------------------------------------------------------------Mac 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Card 5 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ----------------------------------------------------------------------------------------------------13/U0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 13/U0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 13/U1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 13/U2 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 13/U3 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ----------------------------------------------------------------------------------------------------Mac 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Card 13 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------Total 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Example
To show the cable modem summary state for cable-mac 1, enter the following command: C4
show cable modem summary state cable-mac 1
C4# show cable modem summary state cable-mac 1 Initializing Disabled ---------------------------------------------------------------------------- --------Ranging DHCPv4 DHCPv6 CfgFile BPI Registration Fwd Mac S/P Conn Init-Done-Abrt EAE Start--Done Start--Done Start--Done Init Start--Done Dis RFMut ----------------------------------------------------------------------------------------------------1 5/D0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 5/D1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 5/D2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 5/D3 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 13/U0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 13/U0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 13/U1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 13/U2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 13/U3 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ----------------------------------------------------------------------------------------------------Mac 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 -----------------------------------------------------------------------------------------------------
CLI-1348
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Example
To show the cable modem summary state for slot 13, enter the following command: C4
show cable modem summary state slot 13
C4# show cable modem summary state slot 13 Initializing Disabled ---------------------------------------------------------------------------- --------Ranging DHCPv4 DHCPv6 CfgFile BPI Registration Fwd S/P Mac Conn Init-Done-Abrt EAE Start--Done Start--Done Start--Done Init Start--Done Dis RFMut ----------------------------------------------------------------------------------------------------13/U0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 13/U0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 13/U1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 13/U2 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 13/U3 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ----------------------------------------------------------------------------------------------------Mac 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Card 13 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 -----------------------------------------------------------------------------------------------------
Related Command(s)
show cable modem
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1349
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable modem system-description Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the sysDescription from the CM. CM information is collected periodically at a rate configured using the configure cable modem remotequery command. NOTE This command will not display the sysDesc if the “remote-query” has not been set.
Syntax
show cable modem system-description
Example
To display information on CM, enter the following command: C4
show cable modem system-description
Nov 5 16:43:10 Last Poll Started: 2009 June 04 19:13 Completed: 2009 June 04 19:13 Interface (DS-US) IP Address MAC address sysDesc ------------- -------------------- -------------- ---------------------------------------------12/0-12/0 10.101.136.254 0000.ca41.dc97 ARRIS DOCSIS 2.0 Touchstone Cable Modem 12/1-12/6 10.101.135.255 0000.ca3f.2c78 Tools 4.02
show cable rcc-status verbose cable-mac 1 Cable -mac 1
1
CLI-1376
RCP-id 0010000003 Module: 1 CM-chan 1 2 3 0010000004 Module: 1 CM-chan 1 2 3 4
Stat RCC ID ChanSetId 1 1 0x1000002 MinCFreq:327000000 Downstream Frequency 5/0 327000000 5/1 333000000 5/2 339000000 3 1 0x1000001 MinCFreq:327000000 Downstream Frequency 5/0 327000000 5/1 333000000 5/2 339000000 5/3 345000000
ARRIS PROPRIETARY — All Rights Reserved
RCC-Status Valid ModConnID:0 Primary Primary Capable Capable Valid ModConnID:0 Primary Primary Capable Capable Capable
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
1
Issue 2.0
0010183381 2 1 0x1000002 Valid Module: 1 MinCFreq:327000000 ModConnID:0 CM-chan Downstream Frequency Primary 1 5/0 327000000 Primary 2 5/1 333000000 Capable 3 5/2 339000000 Capable
ARRIS PROPRIETARY — All Rights Reserved
CLI-1377
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable rcc-status cable-mac * rcp-id Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Provides the Receive Channel Configurations (RCC) status for the cable-mac interface and the Receive Channel Profile (RCP) ID specified.
Syntax
show cable rcc-status [not-valid] [verbose] cable-mac rcp-id
Parameter
Definition
[not-valid]
Show only Receive Channel Configurations (RCC) with reported errors
[verbose]
Show downstream channel configuration
MAC identifier
The Receive Channel Profile ID in hex (5 bytes)
Example C4>
show cable rcc-status cable-mac 1 rcp-id 0010183381 Cable -mac 1
CLI-1378
RCP-id 0010183381
Stat RCC ID dyn 1
ChanSetId 0x1000002
ARRIS PROPRIETARY — All Rights Reserved
RCC-Status Valid
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable rcc-status cable-mac * rcp-id * rcc Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Provides the Receive Channel Configurations (RCC) status for the cable-mac interface, the Receive Channel Profile (RCP) ID, and RCC ID specified.
Syntax
show cable rcc-status cable-mac rcp-id rcc
Parameter
Issue 2.0
Definition
MAC identifier
The Receive Channel Profile ID in hex (5 bytes)
Unique rcc id for rcp-id defined earlier
ARRIS PROPRIETARY — All Rights Reserved
CLI-1379
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable rcc-status cable-mac * rcp-id * status-id Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Provides the Receive Channel Configurations (RCC) status for the cable-mac interface, the Receive Channel Profile (RCP) ID, and status ID specified.
Syntax
show cable rcc-status cable-mac rcp-id status-id
Parameter
CLI-1380
Definition
MAC identifier The Receive Channel Profile ID in hex (5 bytes) Selection status ID
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable service-group Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Provides status of the service groups for the cable-mac interface specified.
Syntax
show cable service-group [cable-mac ] [mCMsg ] [mDSsg ] [mUSsg ]
Parameter
Definition
cable-mac
MAC identifier
[mCMsg ]
MAC domain cable modem service group identifier
[mDSsg ]
MAC domain downstream service group identifier
[mUSsg ]
MAC domain upstream service group identifier
Example
The following output results when no interface is specified. C4#
show cable service-group Cable MAC --1 2 3
C4#
mDSsg ----1 1 1
mUSsg ----1 1 1
show cable service-group cable-mac 2 Cable MAC --2
Issue 2.0
mCMsg ----1 2 3
mCMsg ----2
mDSsg ----1
mUSsg ----1
ARRIS PROPRIETARY — All Rights Reserved
CLI-1381
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable spectrum-group Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the upstream channel spectrum-group information for all state machines. Use the optional [sm-ID] for a specific state machine.
Syntax
show cable spectrum-group [sm-ID]
Parameter
[sm-ID]
CLI-1382
Definition
State machine identifier. Valid range is 1-40.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable spectrum-group state Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the upstream channel spectrum-group information for all state machines. Use the optional [sm-ID] for a specific state machine.
Syntax
show cable spectrum-group state [sm-ID]
Parameter
[sm-ID]
Issue 2.0
Definition
State machine identifier. Valid range is 1-40.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1383
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable spectrum-group trigger Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays all triggers.
Syntax
show cable spectrum-group trigger
Parameter
[sm-ID]
CLI-1384
Definition
State machine identifier. Valid range is 1-40.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable supervision Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Configures the supervisory downstream for this upstream.
Syntax
show cable supervision [cable-mac] [slot ]
Parameter
Definition
[cable-mac]
MAC identifier
[slot ]
CAM slot number (0-15)
Example
The following is an example returned by the system: C4>
show cable supervision MAC ----1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Issue 2.0
US ------3/0 3/0 3/0 3/0 3/1 3/1 3/1 3/1 3/2 3/2 3/2 3/2 3/3 3/3 3/3 3/3 3/12
DS ----14/0 14/1 14/2 14/3 14/0 14/1 14/2 14/3 14/0 14/1 14/2 14/3 14/0 14/1 14/2 14/3 14/0
ARRIS PROPRIETARY — All Rights Reserved
Method ----------Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned
CLI-1385
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
CLI-1386
3/12 3/12 3/12 3/13 3/13 3/13 3/13 3/14 3/14 3/14 3/14 3/15 3/15 3/15 3/15
14/1 14/2 14/3 14/0 14/1 14/2 14/3 14/0 14/1 14/2 14/3 14/0 14/1 14/2 14/3
ARRIS PROPRIETARY — All Rights Reserved
Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned Provisioned
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cable unicast-polling Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays settings for all eight unicast polling priorities.
Syntax
show cable unicast-polling
Example
To display the unicast polling priorities, use the following command: C4>
show cable unicast-polling The following is an example of the output returned by the system: slow fast fast priority interval interval period -------- -------- -------- -------0 0 0 0 1 0 0 0 2 0 0 0 3 0 0 0 4 125 25 500 5 100 20 500 6 75 15 500 7 50 10 500
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1387
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show chassistype Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays when you are working on a C4c CMTS or a C4 CMTS.
Syntax
show chassistype
Example
To display the chassis type, use the following command: C4>
show chassistype If you were working on a C4 CMTS, the system response would be: Chassis type: C4
CLI-1388
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show clock Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the local date and time in one second resolution when the time of day (TOD) client is active and in one millisecond resolution when the NTP client is active.
Syntax
show clock [detail] [GMT] [network] [timezone]
Parameter
Definition
[detail]
Displays the timezone abbreviation and the current DST/STD time status
[GMT]
Displays the Greenwich Mean Time
[network]
Displays the current network time synchronization protocol
[timezone]
Displays the clock timezone
Example
To display the timezone and the current DST/STD time status, type the following command: C4>
show clock detail The following is an example of the output returned by the system: 2011 November 29 13:47:37 America/Chicago (STD) Network time sync protocol is TOD TOD Server IP Address: 10.50.39.3 connection type: tcp
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1389
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers cable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the current setting for the downstream channel and all its upstream channels on the cable controller.
Syntax
show controllers cable [detail]
Parameter
Definition
[detail]
- Displays all interfaces for a given slot. - Displays specific interface. Displays additional hardware information
Example
To display the current settings for the downstream and all upstream channels of the Cable Access Module in slot 3 port 1, type the following command: C4>
show controllers cable 3/1 The following is an example of the output returned by the system:
Upstream Port 3/1 ------------Port state: Connector: Cable-Mac: Downstream Supervision Ports: Frequency (Hz): Channel width (Hz): Equalizer Coefficient State: Power (dBmV): Max Power Adj Per Range Resp (1/4 dBmV): Ranging Power Thresh For Success (1/4 dBmV): Load Balance Group Id: Max Allowable Normal Voice BW (%):
CLI-1390
IS 0 1 14/0 14/1 14/2 14/3 14600000 6400000 off 0 24 24 16779264 50
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Reserved Normal Voice BW (%): 0 Max Allowable Emergency Voice BW (%): 70 Reserved Emergency Voice BW (%): 0 Max Allowed Total (Emergency + Normal) (%): 70 Ingress Cancellation Interval: 0 Ingress Cancellation Size: 0 Map Size (800 microsecond ticks): 1 Logical Channel: 0 1 ------------------------------------------------------------Channel State IS OOS Channel-ID: 2 26 Channel Type: atdma tdma Modulation profile id: 27 2 Ranging backoff range: 2 - 7 2 - 7 Data backoff range: 2 - 8 2 - 8 Slot Size (6.25 microsecond ticks): 2 2 SCDMA active codes: SCDMA codes per slot: SCDMA frame size: SCDMA hopping seed: Spectrum Group ID: Spectrum Group State: Attribute Mask: 0x00000000 0x00000000
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1391
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers cable * authorization-module Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays authorization module information for the specified cable controller.
Syntax
show controllers cable authorization-module
Parameter
Definition
Example
- Displays all interfaces for a given slot. - Displays specific interface.
To display information on the authorization-module on port 0 of the Cable Access Module in slot 15, type the following command: C4>
show controllers cable 5/0 authorization-module The following is an example of the output returned by the system: Authorization Module ---------------------
CLI-1392
Description: Open Dynamic Flow Policy: Packet Cable Policy:
true true
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers cable * downstream Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays current settings for a downstream channel on the cable controller.
Syntax
show controllers cable downstream [detail]
Parameter
Definition
[detail]
- Displays all interfaces for a given slot. - Displays specific interface. Will show the hardware registers along with counts
Example
To show the current settings for the downstream channel on the cable controller in slot 15, type the following command: C4>
show controllers cable 15/0 downstream The following is an example of the output returned by the system:
Downstream Port 5/0 --------------Port state: Connector: Channel-ID: Cable-Mac: Primary-Capable: Upstream Ports: Cable Standard: Frequency (Hz): Interleave depth (no of taps): Modulation: Provisioned Power (tenth of dBmV): Measured Power (tenth of dBmV): Power Fine Adjustment (steps): Max Round Trip Delay(microseconds): Load Balance Group Id:
Issue 2.0
IS 0 1 1 True 13/1 13/11 13/20 Annex B from ITU-J83 327000000 32 q256 490 0 0 1600 3, 33, 16781312
ARRIS PROPRIETARY — All Rights Reserved
CLI-1393
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Max Allowable Normal Voice BW (%): Reserved Normal Voice BW (%): Max Allowable Emergency Voice BW (%): Reserved Emergency Voice BW (%): Max Allowed Total (Emergency + Normal) (%): Emergency Preemption: Token Bucket Mode: Automatic Gain Control: Attribute Mask: Counts for Downstream # Seconds since Last Snap
: 0 : 0
Frames Sent (Total) Bytes Sent (Total) Frames Sent (Mac) Bytes Sent (Mac) Max Channel Bit Rate DS Load Packet Rate DS Load Bit Rate DS Load Packet Rate (Mac) DS Load Bit Rate (Mac) DS Instant Packet Rate DS Instant Bit Rate Instant Packet Rate (Mac) Instant Bit Rate (Mac) Dropped Token NoDefer Dropped Load Pkts Dropped Load Latency Dropped Load 2Sec Dropped Priority Cutoff Dropped Reason Tx
: : : : : : : : : : : : : : : : : : :
Broadcast Frames Sent (Total) Broadcast Frames Sent (Mac) Default BroadCast Flow Frames
: 85 : 9 : 0
Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast
: : : : : : : : : : :
Frames Sent (Total) Frames Sent (Mac) Docsis Map & Sync Frames IpVideo Frames Sent IpVideo Frames Dropped Latency Frames Late IpV4 Default Flow Frames IpV6 Default Flow Frames IgmpV2 Query Flow Frames IgmpV3 Query Flow Frames Video Flows created
Unicast Frames Sent (Total) Unicast Frames Sent (Mac) Unicast IpVideo Frames
CLI-1394
50 0 70 0 70 enabled shape enabled 0x00000000
1 34 62 10 50000000 78 22 51 0 49 74 45 72 8 2 2 4 5 3
28 95 0 454512 82 95 0 0 0 0 0
: 14 : 82 : 26065
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Unicast Unicast Unicast Unicast
Latency Frames Late IpVideo Drops Video Flows created Unknown Default Flow Frames
: : : :
78 3 0 0
Docsis LowPriority MMM Flow Frames
: 0
Global Counts (all channels): Demand Bytes Dropped unknown TFID Dropped Inactive Drops due to no Destination Dropped Replicated Drops due to filtering Drops due to QOS Busy
: : : : : : :
0 1 3 2 0 1 2
Downstream Port 5/1 --------------Port state: Connector: Channel-ID: Cable-Mac: Primary-Capable: Upstream Ports: Cable Standard: Frequency (Hz): Interleave depth (no of taps): Modulation: Provisioned Power (tenth of dBmV): Measured Power (tenth of dBmV): Power Fine Adjustment (steps): Max Round Trip Delay(microseconds): Load Balance Group Id: Max Allowable Normal Voice BW (%): Reserved Normal Voice BW (%): Max Allowable Emergency Voice BW (%): Reserved Emergency Voice BW (%): Max Allowed Total (Emergency + Normal) (%): Emergency Preemption: Token Bucket Mode: Automatic Gain Control: Attribute Mask: Counts for Downstream # Seconds since Last Snap
: 1 : 0
Frames Sent (Total) Bytes Sent (Total) Frames Sent (Mac) Bytes Sent (Mac) Max Channel Bit Rate DS Load Packet Rate
: : : : : :
Issue 2.0
IS 0 2 1 False 13/1 13/11 13/20 Annex B from ITU-J83 333000000 32 q256 490 0 0 1600 3, 33, 16781312 50 0 70 0 70 enabled shape enabled 0x00000000
96 68 59 33 50000000 23
ARRIS PROPRIETARY — All Rights Reserved
CLI-1395
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
DS Load Bit Rate DS Load Packet Rate (Mac) DS Load Bit Rate (Mac) DS Instant Packet Rate DS Instant Bit Rate Instant Packet Rate (Mac) Instant Bit Rate (Mac) Dropped Token NoDefer Dropped Load Pkts Dropped Load Latency Dropped Load 2Sec Dropped Priority Cutoff Dropped Reason Tx
: : : : : : : : : : : : :
Broadcast Frames Sent (Total) Broadcast Frames Sent (Mac) Default BroadCast Flow Frames
: 71 : 31 : 0
Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast
: : : : : : : : : : :
34 20 0 551957 34 89 0 0 0 0 0
: : : : : : :
61 43 18247 74 3 0 0
Unicast Unicast Unicast Unicast Unicast Unicast Unicast
Frames Sent (Total) Frames Sent (Mac) Docsis Map & Sync Frames IpVideo Frames Sent IpVideo Frames Dropped Latency Frames Late IpV4 Default Flow Frames IpV6 Default Flow Frames IgmpV2 Query Flow Frames IgmpV3 Query Flow Frames Video Flows created
Frames Sent (Total) Frames Sent (Mac) IpVideo Frames Latency Frames Late IpVideo Drops Video Flows created Unknown Default Flow Frames
71 62 89 11 26 81 1 4 0 2 9 9 8
Docsis LowPriority MMM Flow Frames
: 0
Global Counts (all channels): Demand Bytes Dropped unknown TFID Dropped Inactive Drops due to no Destination Dropped Replicated Drops due to filtering Drops due to QOS Busy
: : : : : : :
0 0 7 8 7 6 7
Downstream Port 5/2 --------------Port state:
CLI-1396
IS
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Connector: Channel-ID: Cable-Mac: Primary-Capable: Upstream Ports: Cable Standard: Frequency (Hz): Interleave depth (no of taps): Modulation: Provisioned Power (tenth of dBmV): Measured Power (tenth of dBmV): Power Fine Adjustment (steps): Max Round Trip Delay(microseconds): Load Balance Group Id: Max Allowable Normal Voice BW (%): Reserved Normal Voice BW (%): Max Allowable Emergency Voice BW (%): Reserved Emergency Voice BW (%): Max Allowed Total (Emergency + Normal) (%): Emergency Preemption: Token Bucket Mode: Automatic Gain Control: Attribute Mask: Counts for Downstream # Seconds since Last Snap
: 2 : 0
Frames Sent (Total) Bytes Sent (Total) Frames Sent (Mac) Bytes Sent (Mac) Max Channel Bit Rate DS Load Packet Rate DS Load Bit Rate DS Load Packet Rate (Mac) DS Load Bit Rate (Mac) DS Instant Packet Rate DS Instant Bit Rate Instant Packet Rate (Mac) Instant Bit Rate (Mac) Dropped Token NoDefer Dropped Load Pkts Dropped Load Latency Dropped Load 2Sec Dropped Priority Cutoff Dropped Reason Tx
: : : : : : : : : : : : : : : : : : :
Broadcast Frames Sent (Total) Broadcast Frames Sent (Mac) Default BroadCast Flow Frames
: 98 : 6 : 0
Multicast Frames Sent (Total)
: 35
Issue 2.0
0 3 1 False Annex B from ITU-J83 339000000 32 q256 490 0 0 1600 50 0 70 0 70 enabled shape enabled 0x00000000
76 1 13 86 50000000 16 47 34 3 49 38 40 2 4 0 8 9 7 1
ARRIS PROPRIETARY — All Rights Reserved
CLI-1397
CLI Command Descriptions
Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Multicast Unicast Unicast Unicast Unicast Unicast Unicast Unicast
C4/C4c CMTS Rel. 8.0.7
Frames Sent (Mac) Docsis Map & Sync Frames IpVideo Frames Sent IpVideo Frames Dropped Latency Frames Late IpV4 Default Flow Frames IpV6 Default Flow Frames IgmpV2 Query Flow Frames IgmpV3 Query Flow Frames Video Flows created
Frames Sent (Total) Frames Sent (Mac) IpVideo Frames Latency Frames Late IpVideo Drops Video Flows created Unknown Default Flow Frames
: : : : : : : : : :
40 0 150822 87 61 0 0 0 0 0
: : : : : : :
66 1 22544 6 5 0 0
Docsis LowPriority MMM Flow Frames
: 0
Global Counts (all channels): Demand Bytes Dropped unknown TFID Dropped Inactive Drops due to no Destination Dropped Replicated Drops due to filtering Drops due to QOS Busy
: : : : : : :
CLI-1398
2 9 4 1 5 9 9
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers cable * ingress-cancellation Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays upstream ingress cancellation properties.
Syntax
show controllers cable ingress-cancellation
Parameter
Definition
Example
- Displays all interfaces for a given slot. - Displays specific interface.
To display the number of ports that have valid cable-mac, type the following command: C4>
show controllers cable 13/20 ingress-cancellation
The following is an example of the output returned by the system: Ingress Cancellation Data for Upstream 13/1: Ingress Cancellation Grant Interval: 0 Ingress Cancellation Burst Size: 0 Ingress Cancellation Bandwidth: 0 Ingress Cancellation Data for Upstream 13/11: Ingress Cancellation Grant Interval: 0 Ingress Cancellation Burst Size: 0 Ingress Cancellation Bandwidth: 0 Ingress Cancellation Data for Upstream 13/20: Ingress Cancellation Grant Interval: 0 Ingress Cancellation Burst Size: 0 Ingress Cancellation Bandwidth: 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1399
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers cable-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays cable-mac controller information.
Syntax
show controllers cable-mac [upstream] [detail]
Parameter
Definition
MAC ID
[upstream]
Displays upstream information.
[detail]
Displays detailed information.
Example
To display information on the cable-mac 1 upstream, type the following command: C4>
show controllers cable-mac 1 upstream The following is an example of the output returned by the system:
Cable Mac Description:
cable-mac 1
Authorization Module -------------------Open Dynamic Flow Policy:
true
Upstream Port 13/1 ------------Port state: Connector: Cable-Mac: Downstream Supervision Ports: Frequency (Hz): Channel width (Hz): Equalizer Coefficient State: Power (dBmV): Max Power Adj Per Range Resp (1/4 dBmV): Ranging Power Thresh For Success (1/4 dBmV): Load Balance Group Id:
CLI-1400
IS 0 1 5/0 5/1 24800000 3200000 off 0 24 24 3, 33, 16781312
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Max Allowable Normal Voice BW (%): 50 Reserved Normal Voice BW (%): 0 Max Allowable Emergency Voice BW (%): 70 Reserved Emergency Voice BW (%): 0 Max Allowed Total (Emergency + Normal) (%): 70 Ingress Cancellation Interval: 0 Ingress Cancellation Size: 0 Map Size (800 microsecond ticks): 4 Logical Channel: 0 1 ------------------------------------------------------------Channel State IS OOS Channel-ID: 2 26 Channel Type: tdma tdma Modulation profile id: 2 2 Ranging backoff range: 2 - 7 2 - 7 Data backoff range: 2 - 8 2 - 8 Slot Size (6.25 microsecond ticks): 4 4 SCDMA active codes: SCDMA codes per slot: SCDMA frame size: SCDMA hopping seed: Spectrum Group ID: Spectrum Group State: Attribute Mask: 0x00000000 0x00000000
C4#
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1401
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers cable-upstream Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the count for the number of upstream overrides that have occurred as a result of upstream load balancing.
Syntax
show controllers cable-upstream [detail]
Parameter
Definition
- Displays all interfaces for a given slot.
- Displays specific interface.
[detail]
Displays additional hardware information.
Example
To display the number of upstream overrides that have occurred on the CAM in slot 3 port 1, type the following command: C4>
show controllers cable 3 upstream 1 detail The following is an example of the output returned by the system:
Upstream Port 3/1 ------------Port state: Connector: Cable-Mac: Downstream Supervision Ports: Frequency (Hz): Channel width (Hz): Equalizer Coefficient State: Power (dBmV): Max Power Adj Per Range Resp (1/4 dBmV): Ranging Power Thresh For Success (1/4 dBmV): Load Balance Group Id: Max Allowable Normal Voice BW (%): Reserved Normal Voice BW (%): Max Allowable Emergency Voice BW (%): Reserved Emergency Voice BW (%): Max Allowed Total (Emergency + Normal) (%):
CLI-1402
IS 0 1 14/0 14/1 14/2 14/3 14600000 6400000 off 0 24 24 16779264 50 0 70 0 70
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Ingress Cancellation Interval: 0 Ingress Cancellation Size: 0 Map Size (800 microsecond ticks): 1 Logical Channel: 0 1 ------------------------------------------------------------Channel State IS OOS Channel-ID: 2 26 Channel Type: atdma tdma Modulation profile id: 27 2 Ranging backoff range: 2 - 7 2 - 7 Data backoff range: 2 - 8 2 - 8 Slot Size (6.25 microsecond ticks): 2 2 SCDMA active codes: SCDMA codes per slot: SCDMA frame size: SCDMA hopping seed: Spectrum Group ID: Spectrum Group State: Attribute Mask: 0x00000000 0x00000000
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1403
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers fabric Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the MAC DM and other Router Control Module information
Syntax
show controllers fabric [detail]
Parameter
Definition
The chassis slot in which the targeted module resides. Valid slot numbers for the C4 CMTS is 17-18; valid slot number for the C4c CMTS is 17.
[detail]
Displays additional hardware information.
Example
To display the MAC DM and information for the RCM in slot 17, type the following command: C4>
show controllers fabric 18 The following is an example of the output returned by the system:
Dev MAC Typ Class Filt MAC Address IP DS/US CM-L M 0 0015.a3eb.669b CM-L M 0 0015.a3eb.66fb CM-L M 0 0015.a3eb.66ff CM-L M 0 0015.a3eb.672f CM-L M 0 0015.a3eb.673f CM-L M 0 0015.a3eb.674f CM-L M 0 0015.a3ed.ac6b CM-L 0 0015.cf00.0a65 CM-L 0 0015.cf00.0a7f CM-L 0 0015.cf00.0a8b CM-L 0 0015.cf00.0ab1 CM-L 0 0015.cf00.0ae3 CM-L 0 0015.cf00.0af1 CM-L 0 0015.cf00.0b43 CM-L 0 0015.cf00.0b4f CM-L 0 0015.cf22.450f
CLI-1404
Address 10.139.31.213 10.139.31.214 10.139.31.200 10.139.31.223 10.139.31.215 10.139.31.216 10.139.31.193 10.139.31.195 10.139.31.218 10.139.31.220 10.139.31.196 10.139.31.222 10.139.31.219 10.139.31.207 10.139.31.221 10.139.31.217
IP Type DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP
CM MACAddress US Sl/MacDomain/Grp /FP Device Id 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2
ARRIS PROPRIETARY — All Rights Reserved
CCM Max ChId Id 9 12 8 2 5 5 5 9 1 1 5 3 1 5 1 3
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L CM-L
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0015.cf37.f793 0015.cf37.f967 0015.cf37.ffb8 0015.cf38.0051 0015.cf38.016b 0015.cf38.01b9 0015.cf38.0288 0015.cf38.0306 0015.cf38.0387 0015.cf38.0753 0015.cf38.084f 0015.cf38.0885 0015.cf38.0891 0015.cf38.0969 0015.cf38.09c6 001b.2f8c.34da
10.139.31.208 10.139.31.206 10.139.31.209 10.139.31.203 10.139.31.197 10.139.31.202 10.139.31.211 10.139.31.194 10.139.31.205 10.139.31.204 10.139.31.210 10.139.31.201 10.139.31.198 10.139.31.212 10.139.31.199 10.139.31.227
DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP DHCP
01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2 01/0x20000002/2
9 5 9 5 5 5 7 7 8 9 6 9 5 9 5 1
The example shows:
Issue 2.0
•
MAC Typ - There are four options: CM-I; CM-L; CPE-I; CPE-L, where “-I” = inactive device and “-L” = Learned (active).
•
MAC Address - MAC address
•
IP Address - IP address
•
IP Type - This column may have DHCP or Learned which depicts if the device was assigned an IP address via DHCP or “statically assigned”.
•
CM MAC Address - Cable modem’s MAC address
ARRIS PROPRIETARY — All Rights Reserved
CLI-1405
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers gigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays information for the Gigabit Ethernet RCM controller.
Syntax
show controllers gigabitethernet / [detail]
Parameter
Definition
RCM slot number/gigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[detail]
Displays detailed information
Example
To display information for the Gigabit Ethernet controller in slot 17, port 0, type the following command: C4>
show controllers gigabitethernet 17/0 The following is an example of the output returned by the system:
GigEthernet Port 0 Counts Ethernet Ingress data rate in bits/sec Number of Ingress bytes from ethernet Number of Ingress frames from ethernet Number of Ingress frames dropped due to TTL Number of Ingress frames dropped Number of Ingress IP frames Number of Ingress IP frames dropped due to Header error Number of Ingress IP frames dropped due to Unknown Proto Number of Ingress IP frames dropped due to Invalid Dest Addr Ethernet Egress data rate in bits/sec Number of Egress bytes sent to ethernet Number of Egress frames sent to ethernet
CLI-1406
ARRIS PROPRIETARY — All Rights Reserved
: : : : : : : : : : : :
7896960 197901939 1902923 0 12 1902911 0 12 0 1936896 48555074 466369
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show controllers tengigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays information for the Ten Gigabit Ethernet RCM controller.
Syntax
show controllers tengigabitethernet / [detail]
Parameter
Definition
RCM slot number/tengigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[detail]
Displays detailed information
Example
To display information for the Ten Gigabit Ethernet controller in slot 17, port 0, type the following command: C4>
show controllers tengigabitethernet 17/0 The following is an example of the output returned by the system:
Ten Gigabit Ethernet Port 0 Counts Ethernet Ingress data rate in bits/sec Number of Ingress bytes from ethernet Number of Ingress frames from ethernet Number of Ingress frames dropped due to TTL Number of Ingress frames dropped Number of Ingress IP frames Number of Ingress IP frames dropped due to Header error Number of Ingress IP frames dropped due to Unknown Proto Number of Ingress IP frames dropped due to Invalid Dest Addr Ethernet Egress data rate in bits/sec Number of Egress bytes sent to ethernet Number of Egress frames sent to ethernet
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
: : : : : : : : : : : :
7896960 197901939 1902923 0 12 1902911 0 12 0 1936896 48555074 466369
CLI-1407
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show cos-mapping Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Class of Service parameters.
Syntax
show cos-mapping
Example
To display the Class of Service parameters, type the following command: C4>
show cos-mapping The following is an example of the output returned by the system:
traffic-burst res-rate reserved-packet up-tos latency Priority Peak-Traff class-id up-max down-max down-min up-min down-min and/or mask down-max Down rate Down -------- ------- -------- -------- ------- -------- ----------- -------- -------- ---------1 3044 96000 0 0 0 ff/0 0 match-up 0 2 3044 96000 0 0 0 ff/0 0 match-up 0 3 3044 96000 0 0 0 ff/0 0 match-up 0 4 3044 96000 0 0 0 ff/0 0 match-up 0 5 3044 96000 0 0 0 ff/0 0 match-up 0 6 3044 96000 0 0 0 ff/0 0 match-up 0 7 3044 96000 0 0 0 ff/0 0 match-up 0 8 3044 96000 0 0 0 ff/0 0 match-up 0 9 3044 96000 0 0 0 ff/0 0 match-up 0 10 3044 96000 0 0 0 ff/0 0 match-up 0 11 3044 96000 0 0 0 ff/0 0 match-up 0 12 3044 96000 0 0 0 ff/0 0 match-up 0 13 3044 96000 0 0 0 ff/0 0 match-up 0 14 3044 96000 0 0 0 ff/0 0 match-up 0 15 3044 96000 0 0 0 ff/0 0 match-up 0 16 3044 96000 0 0 0 ff/0 0 match-up 0
CLI-1408
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show counts collection Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the period of time that the system counts are collected from the hardware. Rate is in minutes from 15 through 1440. NOTE Do not change the default unless instructed from an ARRIS Support person.
Syntax
show counts collection
Example
To display the period of time for system counts collection, type the following command: C4>
show counts collection The following is an example of the output returned by the system: Counts collection rate is 120
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1409
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show crypto dynamic-map Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the dynamic-maps. If a dynamic map name is given, this command will only show that dynamic map entry.
Syntax
show crypto dynamic-map [tag ] Parameter
Definition
[tag ]
Example
Name of the dynamic map.
To display the dynamic maps, type the following command: C4>
show crypto dynamic-map The following is an example of the output returned by the system: Dynamic-map: dmap 1 Peer: 10.1.2.40 Extended IP access list 102 access-list 101 permit tcp source addr: 10.1.64.238/0.0.0.0 dest addr: 10.1.2.40/0.0.0.0 Security association lifetime: 3600 seconds Transform set: TS2
CLI-1410
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show crypto ipsec security-association lifetime Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the current global Security Association lifetime in seconds.
Syntax
show crypto ipsec security-association lifetime
Example
To display the current global SA lifetime, type the following command: C4#
show crypto ipsec security-association lifetime The following is an example of the output returned by the system: Security-association lifetime: 3600 seconds
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1411
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show crypto ipsec transform-set Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the transform sets. If a transform set name is given, this command will only show that transform set entry.
Syntax
show crypto ipsec transform-set [tag ] Parameter
Definition
[tag ]
Example
Name of the transform set.
To display the transform sets, type the following command: C4>
show crypto ipsec transform-set The following is an example of the output returned by the system: Transform set: TSET1 encryption algorithm: esp-3des authentication algorithm: esp-md5-hmac encapsulation mode: transport Transform set: TSET2 encryption algorithm: esp-null authentication algorithm: esp-sha-hmac encapsulation mode: transport
CLI-1412
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show crypto isakmp Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Displays the current state of the Internet Key Exchange (IKE) daemon process (e.g. enabled vs. disabled).
Syntax
show crypto isakmp
Example
To display the current state, use the following command: C4>
show crypto isakmp If the IKE daemon had been enabled, the system response would be: The IKE daemon is running. If the IKE daemon had been disabled, the system response would be: The IKE daemon is not running.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1413
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show crypto isakmp policy Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Displays all global ISAKMP phase 1 policies (proposals).
Syntax
show crypto isakmp policy
Example
To display the ISAKMP phase 1 policies, type the following command: C4>
show crypto isakmp policy The following is an example of the output returned by the system: Protection suite priority 1 encryption algorithm: 3DES - Data Encryption Standard (168 bit keys) hash algorithm: Message Digest 5 (MD5) authentication method: Preshared Key Diffie-Hellman Group: #1 (768 bit) lifetime: 420 seconds Protection suite priority 2 encryption algorithm: 3DES - Data Encryption Standard (168 bit keys) hash algorithm: Secure Hash Standard (SHA-1) authentication method: Preshared Key Diffie-Hellman Group: #2 (1024 bit) lifetime: 1200 seconds
CLI-1414
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show crypto map Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the crypto maps. If a map name is given, only displays that crypto map entry.
Syntax
show crypto map [tag ] Parameter
Definition
[tag ]
Example
Name of the crypto map.
To display the crypto maps, type the following command: C4>
show crypto map The following is an example of the output returned by the system: Map: initmap 1 Role: initiator/responder Peer: 10.1.64.2 Extended IP access list 101 access-list 101 permit tcp source addr: 10.1.64.238/0.0.0.0 dest addr: 10.1.64.2/0.0.0.0 Security association lifetime: 3600 seconds Transform set: TS1 Map: respmap 1 Role: responder Using dynamic-map: dmap
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1415
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show disk volume * scm Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the disk volume information.
Syntax
show disk volume scm [critical-hold | major-hold | minor-hold ] [auto-delete-file]
Parameter
Definition
The volume name in the following format: /system, /update, or /active.
The chassis slot number of the System Control Module. Valid values for the C4 CMTS are 19 or 20; valid value for the C4c CMTS is 19.
[critical-hold
The threshold when exceeded will cause a trap to be sent with diskVolumeUsageLevel of diskVolumeUsageCritical
| major-hold
The threshold when exceeded will cause a trap to be sent with diskVolumeUsageLevel of diskVolumeUsageMajor
| minor-hold ]
The threshold when exceeded will cause a trap to be sent with diskVolumeUsageLevel of diskVolumeUsageMinorl
[auto-delete-file] Example
Automatically deletes unused files when critical-threshold is exceeded. Following are examples of show disk volume commands for the /system, /update, and /active volumes on the SCM in slot 19 along with the corresponding replies:
C4>
show disk volume /system scm 19 Disk volume /system at SCM slot 19: Critical threshold: 90% Major threshold: 80% Minor threshold: 70%
CLI-1416
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Auto delete unused files: off C4>
show disk volume /update scm 19 Disk volume /update at SCM slot 19: Critical threshold: 90% Major threshold: 80% Minor threshold: 70% Auto delete unused files: off
C4>
show disk volume /active scm 19 Disk volume /active at SCM slot 19: Critical threshold: 90% Major threshold: 80% Minor threshold: 70% Auto delete unused files: off
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1417
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show distribute-list Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the distribute-list information.
Syntax
show distribute-list
Parameter
CLI-1418
Definition
The destination protocol
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show environment Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the module temperature status, fan status, and power feed status.
Syntax
show environment
Example
To display the hardware status, type the following command: C4#>
show environment The following is an example of the output returned by a C4 CMTS system:
Chassis Type: C4 ==Temperature status== Slot Description HW Version ---- ------------- --------------3 CAM (0D, 24U) CAM-01240W/C04 14 CAM (16D, 0U) CAM-20032W/G04 17 RCM A RCM-01000W/E02 19 SCM A SCM-02441W/B02 ==Fan status== Unit Monitored ---------- --------Fan Tray 0 yes Fan Tray 1 yes Fan Tray 2 yes
Status -------spinning spinning spinning
Fan speed controlled:
disabled
Temperature -----------34 C ( 93 F) 39 C (102 F) 40 C (104 F) 30 C ( 86 F)
==Power feed status== Unit Monitored Status ----- --------- -----PCM A yes off PCM B yes on
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1419
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
==Hardware Active and Clock Master Status== Slot 19 Has Active Status Set Slot 19 is Clock Master
Related Command(s)
configure ftp-server
CLI-1420
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show factory-eeprom Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the information in the factory EEPROM. If the slot parameter is omitted, it will display information in the factory EEPROM of the local card.
Syntax
show factory-eeprom [slot ] [chassis}
Parameter
Definition
[slot ] [chassis]
The chassis slot in which the targeted module resides. Valid values are from 0-20. Displays the EEPROM information for the chassis.
Example
To display the factory-eeprom information of the SCM in slot 19, type the following command: C4>
show factory-eeprom slot 19 The following is an example of the output returned by the system: EEPROM information in slot 19 Model Number: SCM-02440W Model Version: B07 Options: 00 00 00 00 Serial Number: 07303CBM0100 Factory Name: PLEXUS Factory Date: 021308 Agile Issue: AE Manufacturer Deviation Flag: 0000 Bus Frequency: 99900000 Downstream Calibration Checksum: 0 Firmware 0: P302 Firmware 1: C600 Firmware 2:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1421
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Firmware 3: Firmware 4: Firmware 5: PIC EEPROM Information PIC Model Number: PICS-00440W PIC PCB Revision: D01 PIC Serial Number: 3123100908 PIC Factory Name: PIC Factory Date: PIC Agile Issue: PIC MAnufacturer Deviation Flag: PIC MAC Address: 00:01:5C:20:00:C0 PIC Type: 0000 PIC Attenuation: 0000 PIC Firmware 0: PIC Firmware 1:
CLI-1422
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show history Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the commands issued during the current CLI session.
Syntax
show history
Related Command(s)
history
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1423
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show hostname Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the name of the CMTS.
Syntax
show hostname
Example
To display the name assigned to the CMTS, type the following command: C4>
show hostname The following is an example of the output returned by the system: Hostname is C4
Related Command(s)
configure hostname
CLI-1424
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show image Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
The CMTS boots from an image file that contains all the necessary executable software code for the given release’s feature set and functionality. If no file name is specified, this command will display the image header of the current running image.
Syntax
show image []
Parameter
Definition
[]
Example
Image file directory and file name.
To display the current running image header, type the following command: C4>
show image The following is an example of the output returned by the system: No operation is in progress. Image file: /active/CMTS_V08.00.00.55.img Image Creation Timestamp: Tue Nov 22 18:39:08 2011 Image checksum: d6c48506
NOTE The above output shows a committed image. If the image is had not been committed, the first line would read: update:/CMTS_V08.00.00.55.img
Issue 2.0
•
Image file = image file name
•
Image timestamp = date when image was last updated
ARRIS PROPRIETARY — All Rights Reserved
CLI-1425
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the interface information.
Syntax
show interface
CLI-1426
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays all cable interfaces. If the optional slot/port parameters are given, then this command will display only the interfaces in the specified slot and port.
Syntax
show interface cable [/]
Issue 2.0
Parameter
Definition
[/
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
]
MAC domain number. Valid range is 0 or 1.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1427
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * allocated-bandwidth Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Samples the data rate on all interfaces and then displays the PacketCable bandwidth utilization as a percentage of the interface’s total capacity. To see the allocated bandwidth on a specific interface, use the optional slot/mac parameters.
Syntax
show interface cable [/] allocated-bandwidth
Parameter
Definition
[/
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
]
MAC domain number. Valid range is 0 or 1.
Example
To show the allocated bandwidth, type the following command: C4#
show interface cable allocated-bandwidth The following is an example of the output returned by the system:
Nov 29 14:35:08 ---Total Chan-Cable Capacity BW Port Mac (Mb/sec) Alloc 14/D0 1 55.00 0.0% 14/D1 1 55.00 0.0% 14/D2 1 55.00 0.0% 14/D3 1 55.00 0.0% 3/U0 1 30.72 0.0% 3/U1 1 30.72 0.0% 3/U2 1 30.72 0.0% 3/U3 1 30.72 0.0% 3/U12 1 30.72 0.0% 3/U13 1 30.72 0.0% 3/U14 1 30.72 0.0% 3/U15 1 30.72 0.0% 14/D4 2 55.00 0.0% 14/D5 2 55.00 0.0% 14/D6 2 55.00 0.0%
CLI-1428
------Normal Calls-------- -----Emergency Calls----- -----Multicast----Allow 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50%
Resv 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0%
Alloc Number Allow 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70% 0.0% 0 70%
Resv A lloc Number Allow Alloc Number 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0 0% 0.0% 0 0.0% 0
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
14/D7 3/U4 3/U5 3/U6 3/U7 3/U16 3/U17 3/U18 3/U19 14/D8 14/D9 14/D10 14/D11 3/U8 3/U9 3/U10 3/U11 3/U20 3/U21 3/U22 3/U23
Issue 2.0
2 2 2 2 2 2 2 2 2 3 3 3 3 3 3 3 3 3 3 3 3
55.00 30.72 30.72 30.72 30.72 30.72 30.72 30.72 30.72 55.00 55.00 55.00 55.00 30.72 30.72 30.72 30.72 30.72 30.72 30.72 30.72
0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0%
50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50% 50%
0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0%
0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0%
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70% 70%
0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0% 0%
0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0%
ARRIS PROPRIETARY — All Rights Reserved
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
-
0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0% 0.0%
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
CLI-1429
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * bit-rate Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the data rate of the specified channels.
Syntax
show interface cable [/] bit-rate
Parameter
Definition
[/
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
]
MAC domain number. Valid range is 0 or 1.
Example
To show the bit rate, type the following command: C4>
show interface cable bit-rate The following is an example of the output returned by a C4 CMTS system:
Port 3/U0 3/U1 3/U2 3/U3 3/U4 3/U5
Cable Mac 1 1 1 1 2 2
Port 14/D0 14/D1 14/D2 14/D3 14/D4
Cable Mac 1 1 1 1 2
CLI-1430
Bits/sec 0 0 0 0 0 0 Load Bits/sec 4396078 4396097 4396257 4396181 4396257
Instant Bits/sec 4399070 4398200 4398109 4397911 4392387
ARRIS PROPRIETARY — All Rights Reserved
Mac Instant Bits/sec 968 968 968 968 968
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable downstream Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the specified cable interface information for the Cable Access Module (CAM).
Syntax
show interface cable / cable downstream
Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
Example
To show the cable interface information for the CAM in slot 6 with a MAC domain number of 0 and subinterface number 1, type the following command: C4#
show interface cable 16/0 cable downstream The following is an example of the output returned by the system:
Downstream Port 0 --------------Port state: Cable Standard: Frequency (Hz): Insertion interval (centiseconds): Interleave depth (no of taps): Invited ranging attempts: Modulation: Provisioned Power (tenth of dBmV): Power Fine Adjustment (steps): Ranging interval (centiseconds): Sync interval (milliseconds): UCD interval (milliseconds): Max Round Trip Delay(microseconds):
Issue 2.0
OOS-MAN Annex B from ITU-J83 321000000 40 8 16 q64 610 0 2400 20 1600 1580
ARRIS PROPRIETARY — All Rights Reserved
CLI-1431
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Ranging Cycles Int (centiseconds): 120 Clone Group Enabled: True (Hard timeouts enabled for IM opport) Level 1 overload threshold: 90 Level 2 overload threshold: 100 Level 3 overload threshold: 500 Max Allowable Normal Voice BW (%): 50 Reserved Normal Voice BW (%): 0 Max Allowable Emergency Voice BW (%): 70 Reserved Emergency Voice BW (%): 0 Max Allowed Total (Emergency + Normal) (%): 70 Emergency Preemption: enabled TFTP Enforcement: disabled Dynamic Secret: disabled Token Bucket Mode: shape
CLI-1432
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable downstream dsg Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays all the indices used to configure a downstream (VSP-list, timer-list, dsfrequency-list, and DCD). If slot and mac are not present, then the entire table is displayed. If slot and mac are present, then only the information for the specified slot and mac will be displayed. NOTE If any indices have the value of (0), then a hyphen will be displayed. Also, if any of the indices provisioned against this interface have not yet been provisioned, that index will be preceded by an asterisk (*).
Syntax
show interface cable [/] cable downstream dsg
Parameter
Definition
[]
The chassis slot in which the targeted Cable Access Module resides. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[]
The MAC domain number. Valid numbers are 0 and 1.
Example
To display the interface 4/0, use the following command: C4>
show interface cable 4/0 downstream dsg The following is an example of the output returned by the system:
Slot/ MAC ----1/0 4/0 4/1
Vendor Param Index ------2 *1
Timer List Index ------1 -
DS Channel List ------*2 -
DCD Enabled ------true false false
Tunnel Group -------
Tunnel -------
Client ID List -------
Classifier ----------
* The index provided has no associated provisioning.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1433
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable downstream dsg dcd Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the exact DCD message that is being sent out on a given interface and the rate at which the DCD for that interface is being sent. The slot/mac are required and will be used to indicate which interfaces DCD message should be displayed.
Syntax
show interface cable / cable downstream dsg dcd
Parameter
Definition
The chassis slot in which the targeted Cable Access Module resides. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
The MAC domain number. Valid numbers are 0 and 1.
Example
To display a DCD message for interface 4/0 (note that all the data is available and displayed), use the following command: C4>
show interface cable 4/0 cable downstream dsg dcd The following is an example of the output returned by the system:
DCD Fragment Rate: 1000ms DCD Fragment 1 of 1; Cfg change count: 2 DSG Configuration Channel Frequencies 62500 2500000 Timers (sec) Initialization (Tdsg1): 2 Operation (Tdsg2): 600 Two-Way Retry (Tdsg3): 300 One-Way Retry (Tdsg4): 1800 Vendor Specific Parameters
CLI-1434
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
01:02:03 aa:bb:cc:dd:ee:ff:11:22:33:44:55 Rule Id: 1 Priority: 0 UCID List: 1,2,3,4,5,6 Client Ids Application Id: 2 Tunnel Address: 0102.0304.0506 Classifier Id: 3 Vendor Specific Parameters 01:02:03 aa:bb:cc:dd:ee:ff:11:22:33:44:55 11:43:2a 12:34:56:78:90:ab:cd DSG Classifier Id: 3 Priority: 0 Source Network: 192.168.234.120/29 Destination Ip: 224.232.128.205 Destination TCP/UDP Port Range: 128-235
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1435
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable downstream dsg tunnel-group ]
Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays tunnel group provisioning for a given interface. An optional tunnel group identifier may be provided to filter the output. NOTE If a tunnel group is not associated with an interface, then the tunnel group number will be preceded by an asterisk (*).
Syntax
show interface cable / cable downstream dsg tunnel-group []
Parameter
Definition
[
Example
Unsigned integer used to filter the output based on the tunnel group identifier.
To display all tunnel groups for interface 4/0, use the following command: C4>
show interface cable 4/0 cable downstream dsg tunnel-group The following is an example of the output returned by the system:
Tunnel Group -----1
CLI-1436
GrpChl Index ------4
slot/ mac ----4/0
UCID Vend Rule List ParmID Pri -------------------------- ------- ------1,2,3,6,8,10,11 0 0
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable downstream dsg verbose Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays all the entire table of indices used to configure a downstream (VSPlist, timer-list, ds-frequency-list, and DCD) for the specified interface, including any incomplete provisioning. NOTE This command displays the same information as the show cable dsg command, however, the data is filtered based on the slot/mac provided.
Syntax
show interface cable [/] cable downstream dsg verbose
Parameter
Definition
[]
The chassis slot in which the targeted Cable Access Module resides. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[]
The MAC domain number. Valid numbers are 0 and 1.
NOTE If any indices have the value of (0), then a hyphen will be displayed. Also, if any of the indices provisioned against this interface have not yet been provisioned, that index will be preceded by an asterisk (*). Example
To display the interface 14/0, use the following command: C4>
show interface cable 14/0 downstream dsg verbose
Related Command(s)
show cable enable-trap
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1437
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable privacy authorization Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Provides the ability to display authorization MIB table entries for all CMs or a specific CM. This is a channel-specific command. NOTE This command is applicable to BPI and BPI+ modem operation.
Syntax
show interface cable / cable privacy authorization
Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
MAC address of the cable modem.
Example
The following example displays authorization MIB entries on slot 15 channel 0. C4#
show interface cable 15/0 cable privacy authorization 00:00:ca:31:4f:c1 The following is an example of the output returned by the system:
slot/ds : 15/0 MAC : 00:00:ca:31:4f:c1 docsBpi2CmtsAuthCmBpiVersion : BPIPLUS AuthCmPublicKey: 30818902 818100c0 e835d3ad 4aa79ae3 459ac187 85106e58 9a8d1044 1dd6ba6b edc36281 f217f61d b4a6c9ee 478c26f6 8fbab971 064e5b0c c75a9a07 5db12f33 37dc06db ac854863 9b91a55a 10d283a9 a364dd30 8b41bbcf 8607cf8a 2c3fcff0 618f322e bf24f302 03010001
CLI-1438
c39d590a 7792e344 083e7abb 11ed2ea8
ARRIS PROPRIETARY — All Rights Reserved
f44148e2 5c5302cd 86ac3c18 4a06b3e8
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
docsBpi2CmtsAuthCmKeySequenceNumber : 1 AuthCmExpiresOld : Wed Oct 15 09:34:04 2003 AuthCmExpiresNew : Wed Oct 22 09:34:04 2003 AuthCmLifetime : 604800 AuthCmGraceTime : 60 AuthCmReset : NORESETREQUESTED AuthCmInfos : 1 AuthCmRequests : 1 AuthCmReplies : 1 AuthCmRejects : 0 AuthCmInvalids : 0 AuthRejectErrorCode : NONE AuthRejectErrorString : AuthInvalidErrorCode : NONE AuthInvalidErrorString : AuthPrimarySAId : 6 AuthBpkmCmCertValid : VALIDCMCHAINED AuthBpkmCmCert: 30820301 308201e9 a0030201 02021063 c0b1304a b58e7875 9f8e0fff 0d06092a 864886f7 0d010105 05003081 94310b30 09060355 04061302 30200603 55040a13 19417272 69732049 6e746572 61637469 76652c20 432e310f 300d0603 55040b13 06444f43 53495331 19301706 0355040b 77616e65 652c2047 656f7267 69613135 30330603 55040313 2c417272 61626c65 204d6f64 656d2052 6f6f7420 43657274 69666963 61746520 6f726974 79301e17 0d303231 30313031 35333333 335a170d 32323130 33333333 5a306831 0b300906 03550406 13025553 31223020 06035504 72726973 20496e74 65726163 74697665 2c204c2e 4c2e432e 31193017 0b131053 7577616e 65652c20 47656f72 67696131 1a301806 03550403 3a30303a 43413a33 313a3446 3a433130 819f300d 06092a86 4886f70d 0003818d 00308189 02818100 c0e835d3 ad4aa79a e3459ac1 8785106e 0af44148 e29a8d10 441dd6ba 6bedc362 81f217f6 1db4a6c9 ee478c26 445c5302 cd8fbab9 71064e5b 0cc75a9a 075db12f 3337dc06 dbac8548 bb86ac3c 189b91a5 5a10d283 a9a364dd 308b41bb cf8607cf 8a2c3fcf a84a06b3 e8618f32 2ebf24f3 02030100 01300d06 092a8648 86f70d01 03820101 003c59f6 6e95d5f0 72849b6f c743b77e 337b1990 f4c05e10 cce0cfe7 e32db220 5c8a9e57 b196be1e e4c8ea17 963d5d33 e490034b 3eec302e e6aefdd7 bf2f42ef 36ed5d7c 96e1b3bf f26a1f50 09018613 ce5014cb 75347366 37a88631 9837eedd b8d465b5 642de57e ff9dfb0d 7a757b19 4207c16e c166e182 7ce66062 52a0ed4d 08d8ab9b 5fd137c6 c9e10cd9 33ba26ea 8b246890 a0980ea6 11878bb0 21c99067 074b4599 6ddada32 125bc83f dc51678b c718c46f e1edb38c d2f86529 e9e6aa3b d0cbd40c 41f9c47d b2e6347d 012d0d5f dec307fa 37bf850d c0a81d94 6f4ea818 ba
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
2bbbd030 55533122 4c2e4c2e 13105375 69732043 41757468 31303135 0a131941 06035504 13113030 01010105 58c39d59 f67792e3 63083e7a f011ed2e 01050500 68975e4a e4d2853d e6146376 a50c89da 7ad6f423 b4d8c79d 0903ea0c 53c5b4bb
CLI-1439
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable privacy base Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Provides the ability to display a specific channel’s BPI base table MIB entry. This is a channel specific command. NOTE This command is applicable to BPI and BPI+ modem operation.
Syntax
show interface cable / cable privacy base Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
For a 16D/XD or 12U/24U: Displays the specific interface
Example
To display the cable interface default channel parameters for slot 5 port 0, use the following command: C4#
show interface cable 15/0 cable privacy base The following is an example of the output returned by the system:
slot/ds DefaultAuthLifetime DefaultTEKLifetime DefaultSelfSignedManufCertTrust CertValidityPeriods BPI Mandatory docsBpi2CmtsAuthentInfos AuthRequests AuthReplies AuthRejects AuthInvalids SAMapRequests SAMapReplies SAMapRejects
CLI-1440
: : : : : : : : : : : : : :
15/0 604800 43200 Untrusted FALSE bpi-plus 3 4 2 2 1 0 0 0
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable privacy multicast map Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Provides the ability to display all or specific baseline privacy multicast group/key mappings from the multicast map table MIB. The detail option of the map will display the multicast map. This is a channel specific parameter. NOTE This command is applicable to BPI and BPI+ modem operation.
Syntax
show interface cable / cable privacy multicast map [detail] Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
[detail]
Multicast parameters for CM’s multicast group/key authorization
Example
The following example displays all multicast group/key mappings on slot1 5 channel 0. C4#
show interface cable 15/0 cable privacy multicast map The following is an example of the output returned by the system:
BPI Multicast Maps Interface SAId Cable 15/128 9000
Issue 2.0
SAId Type statis
Group Address 235.1.2.3
Group Mask Encryption 255.255.255.255 des56
ARRIS PROPRIETARY — All Rights Reserved
CLI-1441
CLI Command Descriptions
Example
C4/C4c CMTS Rel. 8.0.7
To display detailed multicast parameters for the CM’s multicast group/key on slot 15 channel 0, use the following: C4#
show interface cable 15/0 cable privacy multicast map detail The following is an example of the output returned by the system:
slot/ds : 15/0 docsBpi2CmtsIpMulticastIndex : 1 IpMulticastAddressType : IPV4 IpMulticastAddress : 235.1.2.3 IpMulticastMaskType : IPV4 IpMulticastMask : 255.255.255.255 IpMulticastSAId : 9000 IpMulticastSAType : STATIC IpMulticastDataEncryptAlg : DES56CBCMODE IpMulticastDataAuthentAlg : NONE IpMulticastSAMapRequests : 0 IpMulticastSAMapReplies : 0 IpMulticastSAMapRejects : 0 IpMulticastSAMapRejectErrorCode : NONE IpMulticastSAMapRejectErrorString : IpMulticastMapControl : ACTIVE
CLI-1442
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable privacy tek Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Provides the ability to display all or specific SAId Traffic Encryption Key (TEK) MIB table entries. This is a channel specific parameter. NOTE This command is applicable to BPI and BPI+ modem operation.
Syntax
show interface cable / cable privacy tek
Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
SAId (KeyId). Valid range is 1-16383.
Example
The following example displays SAId (TEK) MIB entries on slot 5, channel 0: C4#
show interface cable 15/0 cable privacy tek The following is an example of the output returned by the system:
slot/ds SAId TEKSAType TEKDataEncryptAlg TEKDataAuthentAlg TEKLifetime TEKGraceTime TEKKeySequenceNumber TEKExpiresOld TEKExpiresNew TEKReset
Issue 2.0
: : : : : : : : : : :
15/0 6 Primary DES56CBCMODE 0 43200 60 1 Wed Oct 15 15:34:04 2003 Wed Oct 15 21:34:04 2003 FALSE
ARRIS PROPRIETARY — All Rights Reserved
CLI-1443
CLI Command Descriptions
KeyRequests KeyReplies KeyRejects TEKInvalids KeyRejectErrorCode KeyRejectErrorString TEKInvalidErrorCode TEKInvalidErrorString
CLI-1444
C4/C4c CMTS Rel. 8.0.7
: : : : : : : :
1 1 0 0 NONE NONE
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable upstream Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the cable interface information for the client modules.
Syntax
show interface cable / cable upstream
Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
The upstream channel
Example
To show the interface cable information for the upstream channel 0 on port 0 of the CAM in slot 3, type the following command: C4#
show interface cable 3/0 cable upstream 0 The following is an example of the output returned by the system: Upstream Port 3/0 ------------Port state: IS Connector: 0 Cable-Mac: 1 Downstream Supervision Ports: 14/0 14/1 14/2 14/3 Frequency (Hz): 8200000 Channel width (Hz): 6400000 Equalizer Coefficient State: off Power (dBmV): 0 Max Power Adj Per Range Resp (1/4 dBmV): 24 Ranging Power Thresh For Success (1/4 dBmV): 24 Load Balance Group Id: 16779264 Max Allowable Normal Voice BW (%): 50
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1445
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Reserved Normal Voice BW (%): 0 Max Allowable Emergency Voice BW (%): 70 Reserved Emergency Voice BW (%): 0 Max Allowed Total (Emergency + Normal) (%): 70 Ingress Cancellation Interval: 0 Ingress Cancellation Size: 0 Map Size (800 microsecond ticks): 1 Logical Channel: 0 1 -----------------------------------------------------------Channel State IS OOS Channel-ID: 1 25 Channel Type: atdma tdma Modulation profile id: 27 2 Ranging backoff range: 2 - 7 2 - 7 Data backoff range: 2 - 8 2 - 8 Slot Size (6.25 microsecond ticks): 2 2 SCDMA active codes: SCDMA codes per slot: SCDMA frame size: SCDMA hopping seed: Spectrum Group ID: Spectrum Group State: Attribute Mask: 0x00000000 0x00000000
CLI-1446
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable upstream * spectrum-group Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the upstream channel spectrum-group information.
Syntax
show interface cable / cable upstream spectrum-group
Issue 2.0
Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1. This will be the downstream transmitter that the upstream receiver is associated with.
Upstream port number.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1447
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * cable upstream * spectrum-group history Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the history of state transitions for the state machine associated with a specified upstream channel.
Syntax
show cable interface / cable upstream spectrum-group history [detail]
Parameter
CLI-1448
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1. This will be the downstream transmitter that the upstream receiver is associated with.
Upstream port number.
[detail]
Displays additional measurement/failure reasons for the state transition.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * filter-group Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the filter group provisioning for the specified CAM.
Syntax
show interface cable / filter-group
Issue 2.0
Parameter
Definition
/
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1449
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-downstream Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the status of the specified cable-downstream interface.
Syntax
show interface cable-downstream []
Parameter
Definition
[]
Identifier or
Example
To show the cable-downstream interfaces in port 2, use the following command: C4>
show interface cable-downstream 2 The response from the system would look similar to:
Downstream Port 2/0 --------------Port state: Connector: Channel-ID: Cable-Mac: Primary-Capable: Upstream Ports: Cable Standard: Frequency (Hz): Interleave depth (no of taps): Modulation: Provisioned Power (tenth of dBmV): Measured Power (tenth of dBmV): Power Fine Adjustment (steps): Max Round Trip Delay(microseconds): Load Balance Group Id: Max Allowable Normal Voice BW (%):
CLI-1450
IS 0 35 2/0 True 2/0 2/1 2/2 Annex B from ITU-J83 561000000 32 q64 500 499 0 1600 50
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Reserved Normal Voice BW (%): Max Allowable Emergency Voice BW (%): Reserved Emergency Voice BW (%): Max Allowed Total (Emergency + Normal) (%): Emergency Preemption: Token Bucket Mode: Automatic Gain Control:
0 70 0 70 enabled shape disabled
Downstream Port 2/1 --------------Port state: Connector: Channel-ID: Cable-Mac: Primary-Capable: Upstream Ports: Cable Standard: Frequency (Hz): Interleave depth (no of taps): Modulation: Provisioned Power (tenth of dBmV): Measured Power (tenth of dBmV): Power Fine Adjustment (steps): Max Round Trip Delay(microseconds): Load Balance Group Id: Max Allowable Normal Voice BW (%): Reserved Normal Voice BW (%): Max Allowable Emergency Voice BW (%): Reserved Emergency Voice BW (%): Max Allowed Total (Emergency + Normal) (%): Emergency Preemption: Token Bucket Mode: Automatic Gain Control:
Issue 2.0
IS 0 67 2/1 True 2/6 2/7 Annex B from ITU-J83 333000000 32 q64 500 498 0 1600 50 0 70 0 70 enabled shape disabled
ARRIS PROPRIETARY — All Rights Reserved
CLI-1451
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-downstream * bit-rate Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the downstream channel data rate.
Syntax
show interface cable-downstream [] bit-rate
Parameter
[]
CLI-1452
Definition
Identifier or
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-downstream * cable dsg dcd Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the DCD message fragments being sent.
Syntax
show interface cable-downstream [] cable dsg dcd
Parameter
[]
Issue 2.0
Definition
Identifier or
ARRIS PROPRIETARY — All Rights Reserved
CLI-1453
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-downstream * cable dsg tunnel-group Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the tunnel groups for the downstream MAC.
Syntax
show interface cable-downstream [] cable dsg tunnelgroup
Parameter
[]
show interface cable-downstream 15/0 mdd The response from the system would look similar to:
MDD DChan: 1; Cfg change count: 1; Fragment 1 of 1; MDD DS Channel Id: 1 Frequency: 327000000 Modulation Annex: B; Order: QAM 64 Primary Capable: True CM Status Bitmask: 0x0036 (MDD Timeout; QAM/FEC Lock MDD DS Channel Id: 2 Frequency: 333000000 Modulation Annex: B; Order: QAM 64 Primary Capable: True CM Status Bitmask: 0x0036 (MDD Timeout; QAM/FEC Lock MDD DS Channel Id: 3 Frequency: 339000000 Modulation Annex: B; Order: QAM 64 Primary Capable: True CM Status Bitmask: 0x0036 (MDD Timeout; QAM/FEC Lock MDD DS Channel Id: 4 Frequency: 345000000 Modulation Annex: B; Order: QAM 64 Primary Capable: True CM Status Bitmask: 0x0036 (MDD Timeout; QAM/FEC Lock MDD MD-DS-SG Id: 1 DS Channel Id List: 1; 2; 3; 4;
Issue 2.0
Failure; MDD Recovery; QAM/FEC Lock Recovery; )
Failure; MDD Recovery; QAM/FEC Lock Recovery; )
Failure; MDD Recovery; QAM/FEC Lock Recovery; )
Failure; MDD Recovery; QAM/FEC Lock Recovery; )
ARRIS PROPRIETARY — All Rights Reserved
CLI-1459
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
RCP Reporting Center Frequency Spacing: 6MHz Verbose Reporting: disabled IP Initialization Parameters Version: IPv4 Only MDD US Channel Id: 1 CM Status Bitmask: 0x01c0 (T4 Timeout; T3 Retries MDD US Channel Id: 2 CM Status Bitmask: 0x01c0 (T4 Timeout; T3 Retries MDD US Channel Id: 3 CM Status Bitmask: 0x01c0 (T4 Timeout; T3 Retries MDD US Channel Id: 4 CM Status Bitmask: 0x01c0 (T4 Timeout; T3 Retries US Ambiguity Resolution Channel List: 1; 2; 3; 4; Upstream upper band frequency: 42MHz Symbol Clock Locking: Locked to master CM-STATUS Event Control Event Type: SecondaryChlMddTimeout Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: QamFecLockFailure Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: SeqOutOfRange Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: MddRecovery Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: QamFecLockRecovery Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: T4Timeout Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: T3RetriesExceeded Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: T3RangingRecovery Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: CmOnBatteryBackup Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 CM-STATUS Event Control Event Type: CmAcPowerRestored Maximum Holdoff Timer: 32000 (640000ms) Maximum Number of Reports: 1 Upstream transmit power reporting: CM must report
CLI-1460
Exceeded; ) Exceeded; ) Exceeded; ) Exceeded; )
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the status of the cable-mac interface specified.
Syntax
show interface cable-mac []
Parameter
Definition
MAC identifier
Example
The following is an example of output returned by the system: C4>
Cable-mac 2 ============= Cable Oper DS Port Mac Conn State 5/4 2 1 OOS 5/5 2 1 OOS 5/6 2 1 OOS 5/7 2 1 OOS
US PORT 13/1.0
show interface cable-mac 2
Annex B(US) B(US) B(US) B(US)
Cable Oper Chan Mac Conn State Type 2 1 OOS tdma
Cable Privacy authkey default-life-time tek default-life-time default-cert-trust chk-validity-period
Freq(Hz) 327000000 333000000 339000000 345000000
Mod Power Type (.1dBmV) q256 500 q256 500 q256 500 q256 500
Spare Group -
LBal Group -
Channel Mini Mod Power Cable Freq(Hz) Width Slot Prof (dBmV) Group 12800000 3200000 4 6 0 -
LBal Group -
604800 43200 untrusted false
IGMP interface cable-mac 2: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1461
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
No multicast groups joined by this system No IRDP entries found. Subscriber default-sub-grp-down 0 default-sub-grp-up 0 default-cm-grp-down 0 default-cm-grp-up 0 Dynamic-RCC: Not enabled Annex: B Downstream Frequency Range: Upstream Frequency Range:
91-867 5-42
Ranging interval (centiseconds): Sync interval (milliseconds): UCD interval (milliseconds): Ranging Cycles Int (centiseconds): TFTP Enforcement: Dynamic Secret: Insertion interval (centiseconds): Invited ranging attempts: Multicast forwarding by DSID:
Standard 2400 10 1600 120 disabled disabled 40 16 disabled
Fibernode(s): 2 RCP-id: 0010000003 RCC: 1 Module: 1 MinCFreq:327000000 ModConnID:0 CM-chan Downstream Frequency Primary 1 5/4 327000000 Primary 2 5/5 333000000 Capable 3 5/6 339000000 Capable RCP-id: 0010000004 RCC: 3 Module: 1 MinCFreq:327000000 ModConnID:0 CM-chan Downstream Frequency Primary 1 5/4 327000000 Primary 2 5/5 333000000 Capable 3 5/6 339000000 Capable 4 5/7 345000000 Capable RCP-id: 0010183381 RCC: 2 Module: 1 MinCFreq:327000000 ModConnID:0 CM-chan Downstream Frequency Primary 1 5/4 327000000 Primary 2 5/5 333000000 Capable 3 5/6 339000000 Capable Downstream Bonding Group Status Entries ChSetId DS-SG-ID CfgId AttrMask ---------- -------- ------- ---------0x01000001 1 2 0x80000000
CLI-1462
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac * access-group Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the access control information for packets.
Syntax
show interface cable-mac [] access-group
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1463
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac * allocated-bandwidth Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the status of the allocated bandwidth for the cable-mac interface specified.
Syntax
show interface cable-mac [] allocated-bandwidth
Parameter
[]
Example
Definition
MAC identifier
The following is an example of output returned by the system:
C4> show interface cable-mac 1 allocated-bandwidth ---Total Chan------Normal Calls------Emergency Calls--Cable Capacity BW Port Mac (Mb/sec) Alloc Allow Alloc Number Allow Alloc 5/D0 1 42.00 0.0% 50% 0.0% 0 70% 0.0% 5/D1 1 42.00 0.0% 50% 0.0% 0 70% 0.0% 5/D2 1 42.00 0.0% 50% 0.0% 0 70% 0.0% 5/D3 1 42.00 0.0% 50% 0.0% 0 70% 0.0% 13/U0 1 10.24 0.0% 50% 0.0% 0 70% 0.0%
CLI-1464
ARRIS PROPRIETARY — All Rights Reserved
Number 0 0 0 0 0
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac bit-rate Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the upstream and downstream channels data rate under the mac.
Syntax
show interface cable-mac bit-rate
Example
The following is an example of output returned by the system: C4>
show interface cable-mac bit-rate
Port 2/U12 2/U13 2/U14 2/U15 2/U16 2/U17 2/U18 2/U19 2/U20 2/U21 2/U22 2/U23
Cable Mac 4 4 4 4 4 4 4 4 4 4 4 4
Bits/sec 25599456 25434088 25457168 25451312 12671840 12447848 23000688 20784192 20711520 22249744 14195264 0
Port 11/D0 11/D1 11/D2 11/D3 11/D4 11/D5 11/D6 11/D7
Cable Mac 4 4 4 4 4 4 4 4
Load Bits/sec 37299463 31718784 31706563 31599570 32092664 33389300 37238079 34763528
Issue 2.0
Instant Bits/sec 37149627 32572853 31845237 31263084 32357231 33582420 37556350 34352737
ARRIS PROPRIETARY — All Rights Reserved
Mac Instant Bits/sec 28814956 27874465 26971405 26422088 27640213 28671737 32876167 29271865
CLI-1465
CLI Command Descriptions
11/D8 11/D9 11/D10 11/D11 11/D12 11/D13 11/D14 11/D15 11/D16 11/D17 11/D18 11/D19 11/D20 11/D21 11/D22 11/D23 11/D24 11/D25 11/D26 11/D27 11/D28 11/D29 11/D30 11/D31 C4#
CLI-1466
4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4
C4/C4c CMTS Rel. 8.0.7
35527858 35079756 37446864 37890567 37891134 37334278 37748846 37766221 25571213 26249956 26218551 26307619 25390030 26273961 26287143 26253251 31597464 32266802 32286329 32302737 32211218 32282861 32283115 32310777
36001007 36374702 37487937 37957954 37961425 37930244 37959548 37946830 25569358 26223762 26139770 26410156 25566413 26125732 26401992 26263122 31592292 32406272 32199539 32205932 32241485 32314849 32306167 31948822
ARRIS PROPRIETARY — All Rights Reserved
26143089 31579200 32992546 32951164 33369972 32328147 33607337 33269943 18088333 21865394 21787681 22038711 21203208 21750289 22019157 21898078 23981956 27959808 27731674 27718734 27762207 27834785 27817909 27472640
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac * cable privacy authorization Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the authorization information for a specified cable modem.
Syntax
show interface cable-mac cable privacy authorization Parameter
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415.
MAC address of the cable modem.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1467
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac * cable privacy base Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Provides the ability to display a specific channel’s BPI base table MIB entry. This is a channel specific command. NOTE This command is applicable to BPI and BPI+ modem operation.
Syntax
show interface cable-mac cable privacy base Parameter
Definition
The MAC identifier. Valid numbers are 0-415.
Example
To display the cable interface default channel parameters for slot 5 port 0, use the following command: C4#
show interface cable-mac 1 cable privacy base The following is an example of the output returned by the system: Cable Privacy Base for cable-mac 1 ---------------------------------------------DefaultAuthLifetime : 604800 DefaultTEKLifetime : 43200 DefaultSelfSignedManufCertTrust : Untrusted CertValidityPeriods : FALSE BPI Mandatory : bpi docsBpi2CmtsAuthentInfos : 23 AuthRequests : 23 AuthReplies : 23 AuthRejects : 0 AuthInvalids : 0 SAMapRequests : 0 SAMapReplies : 0 SAMapRejects : 0
CLI-1468
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac * cable privacy multicast map Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the Baseline Privacy multicast map configuration data.
Syntax
show interface cable-mac cable privacy multicast map [detail ] Parameter
[detail ]
Issue 2.0
Definition
The MAC identifier. Valid numbers are 0-415. Displays the multicast parameters for the cable modem’s multicast group/key mapping (IP Multicast Index)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1469
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac * cable privacy tek Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Provides the ability to display all or specific SAId Traffic Encryption Key (TEK) MIB table entries. NOTE This command is applicable to BPI and BPI+ modem operation.
Syntax
show interface cable-mac cable privacy tek
Parameter
CLI-1470
Definition
MAC identifier
SAId (KeyId). Valid range is 1-16383.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac * filter-group Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the filter-group provisioning.
Syntax
show interface cable-mac filter-group
Parameter
Issue 2.0
Definition
MAC identifier .
ARRIS PROPRIETARY — All Rights Reserved
CLI-1471
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac * spectrum-group Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the upstream channel spectrum-group information.
Syntax
show cable interface cable-mac spectrum-group
Parameter
CLI-1472
Definition
MAC identifier
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * mac-scheduler Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the time-slot scheduling state and statistics.
Syntax
show interface cable / mac-scheduler [upstream ] {interval } {type } [detail]
Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
[upstream ] {interval }
The upstream port number. Valid range is 0-7 The time span in seconds to monitor changes in scheduler information.
{type } [detail]
Displays complete output at full precision.
Example
To display the time-slot scheduling state and statistics, use the following commands: C4#
show interface cable 2/0 mac-scheduler The following is an example of the output returned by the system:
MapMaker Overall Summary Statistics Total Total Total Total Upstream Cable Maps Total UcstGrnt Skipped Port Mac Sent Mslots Mslots Mslots ---------- ----- -------- -------- -------- -------2/0.0 1 43500 2735411 0 0
Issue 2.0
Total Total UGS QI UGS AD BwReq Transn Transn -------- -------- -------0 0 0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1473
CLI Command Descriptions
2/1.0 2/2.0 2/3.0 2/4.0 2/7.0 2/8.0 2/9.0 2/10.0 2/11.0
1 1 1 1 1 1 1 1 1
43508 43508 0 0 0 0 0 0 0
C4/C4c CMTS Rel. 8.0.7
2784512 2784512 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
The example shows: TotalMapsSent Total number of maps transmitted downstream for this UChannel. TotalMslots Total Minislots count for this UChannel. TotalUcastGrantedMslots Total Minislots granted to Unicast for this UChannel. TotalSkippedMslots Total Minislots not granted because the MapMaker was behind. TotalBwRequests Total number of Bandwidth Requests processed for this UChannel. This count does not include requests dropped due to SuperGreedy in hardware. TotalFragmentedGrants Total number of fragmented bandwidth grants for this UChannel. TotalUgsQiTransitions Total number of UGS QI transitions. Useful for debugging VoIP. TotalUgsadTransitions Total number of UGSAD flow transitions.Useful for debugging VoIP.
Example
show interface cable 1 mac-scheduler type req-summary
The following is an example of the output returned by the system: MapMaker Request Summary Statistics Slot/ Total Bandwidth Total Request Total Fragment Total Grants DS/US Requests Drops Grants Pendings ----------- --------------- --------------- --------------- --------------1/0/0 37405815 0 11188 118801 1/0/1 54415443 0 8920 865789 1/0/2 65353554 0 23348 1013282 1/0/3 43097487 0 9606 191574 1/0/4 0 0 0 0 1/0/5 0 0 0 0 1/0/6 0 0 0 0 1/0/7 5597 0 0 0 The example shows:
CLI-1474
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Total Bandwidth Requests Total number of Bandwidth Requests processed for this UChannel. This count does not include requests dropped due to SuperGreedy in hardware. Total Request Drops Total number of Bandwidth Requests dropped by the MapMaker without giving a grant or grant pending. This count does not include grant pending drops. Total Request Drops Total number of Bandwidth Requests dropped due to the service flow being in the super greedy state. This should not happen if the cable modem is properly policing its service flows. Total Fragment Grants Total number of fragmented bandwidth grants for this UChannel. Total Grants Pending
Total number of Grants Pending given for this UChannel.
ReqDrops TotalBwRequestSchedulerDrops + TotalBwRequestSuperGreedyDrops
Example
show interface cable 1 mac-scheduler type req
The following is an example of the output returned by the system: MapMaker Request Statistics Slot/ Total Avg Peak Total Total Total Peak DS/US BwReq BwReq/s BwReqSz ReqDrop FragGrnt GrntPend GrntPend ----------- -------- -------- -------- -------- -------- -------- -------1/0/0 37405k N/A 102 0 11188 118801 0 1/0/1 54415k N/A 110 0 8920 865789 0 1/0/2 65353k N/A 104 0 23348 1013283 1 1/0/3 43097k N/A 104 0 9608 191574 0 1/0/4 0 N/A 0 0 0 0 0 1/0/5 0 N/A 0 0 0 0 0 1/0/6 0 N/A 0 0 0 0 0 1/0/7 5597 N/A 0 0 0 0 0
The example shows: TotalBwReq Total number of Bandwidth Requests processed for this UChannel. This count does not include requests dropped due to SuperGreedy in hardware. Avg BwReq/sTotalBwRequests / Interval) Peak BwReqSz Total ReqDrop
The peak size of a Bandwidth request received since the last read. Total number of Bandwidth Requests dropped by the MapMaker without giving a grant or grant pending. This count does not include grant pending drops. Total number of Bandwidth Requests dropped due to the service flow being in the super greedy state. This should not happen if the cable modem is properly policing its service flows.
TotalFragGrnt Total GrntPend
Total number of fragmented bandwidth grants for this UChannel. Total number of Grant Pendings given for this UChannel. Total number of Grant Pendings Dropped by the MapMaker for this UChannel. These are dropped primarily for pending for too long or too many grants pending per map. Total number of Grant Pendings Promoted by the MapMaker to a higher priority (less greedy) queue for this UChannel.
Peak GrntPend
Issue 2.0
The peak number of Bandwidth requests per map received since the last read.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1475
CLI Command Descriptions
Example
C4/C4c CMTS Rel. 8.0.7
show interface cable 1 mac-scheduler type grants-pending
The following is an example of the output returned by the system: MapMaker Grants Pending Statistics Slot/ Total Grant Avg Grant Peak Grant Total Grant Total Grant DS/US Pendings Pendings/s Pendings Pend Drops Pend Promos ----------- ------------ ------------ ------------ ------------ -----------1/0/0 118801 N/A 0 0 0 1/0/1 865791 N/A 1 0 0 1/0/2 1013283 N/A 0 0 0 1/0/3 191574 N/A 0 0 0 1/0/4 0 N/A 0 0 0 1/0/5 0 N/A 0 0 0 1/0/6 0 N/A 0 0 0 1/0/7 0 N/A 0 0 0
The example shows: Total Grant Pendings Total number of Grant Pendings given for this UChannel. Avg Grant Pendings/sTotal number of Grant Pendings given for this UChannel. Peak Grant PendingsThe peak number of Bandwidth requests per map received since the last read. Total Grant Pend Drops Total number of Grant Pendings Dropped by the MapMaker for this UChannel. These are dropped primarily for pending for too long or too many grantspending per map. Total Grant Pend Promos Total number of Grant Pendings Promoted by the MapMaker to a higher priority (less greedy) queue for this UChannel.
Example
show interface cable 1 mac-scheduler type queues
The response from the system would look similar to: MapMaker Queue Statistics Slot/ Number Number Number Number Number Average DS/US Prio Need Adds Pendings Promos Drops Elements Latency ----------- ---- -------- -------- -------- -------- -------- -------- -------1/0/0 5 Needy 0 0 0 0 0 1/0/0 5 Normal 35584k 107143 0 0 0 12293 1/0/0 5 Greedy 1821266 11663 0 0 0
CLI-1476
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Slot/ Number Number Number Number Number Average DS/US Prio Need Adds Pendings Promos Drops Elements Latency ----------- ---- -------- -------- -------- -------- -------- -------- -------1/0/1 5 Needy 0 0 0 0 0 1/0/1 5 Normal 47401k 554156 0 0 0 13803 1/0/1 5 Greedy 7013701 311635 0 0 0 Slot/ Number Number Number Number Number Average DS/US Prio Need Adds Pendings Promos Drops Elements Latency ----------- ---- -------- -------- -------- -------- -------- -------- -------1/0/2 5 Needy 0 0 0 0 0 1/0/2 5 Normal 59898k 774724 0 0 0 13111 1/0/2 5 Greedy 5455207 238559 0 0 0 Slot/ Number Number Number Number Number Average DS/US Prio Need Adds Pendings Promos Drops Elements Latency ----------- ---- -------- -------- -------- -------- -------- -------- -------1/0/3 5 Needy 0 0 0 0 0 1/0/3 5 Normal 39690k 150723 0 0 0 12514 1/0/3 5 Greedy 3407221 40851 0 0 0 Slot/ Number Number Number Number Number Average DS/US Prio Need Adds Pendings Promos Drops Elements Latency ----------- ---- -------- -------- -------- -------- -------- -------- -------1/0/7 5 Needy 0 0 0 0 0 1/0/7 5 Normal 5597 0 0 0 0 5015 1/0/7 5 Greedy 0 0 0 0 0
The example shows: Prio
Corresponds to the priority in which the MAC scheduler processes bandwidth requests from the cable modems. These priorities are related to the Upstream Traffic Priority TLV specified in the cable modem configuration file. The following table illustrates this relationship: BW Request PriorityUpstream Traffic Priorities 1 2 3 4 5
Need
UGS (not applicable) 6 and 7 4 and 5 2 and 3 0 and 1
Each Bandwidth Request priority has 3 queues. They are called Needy, Normal, and Greedy for a total of 12 Bandwidth Request priority queues processed by the MAC scheduler. Subscribers who use most of their assigned bandwidth are classified as Greedy while those who use bandwidth only once in a while are classified as Needy. All other subscribers are classified as Normal.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1477
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Needy subscribers have the highest priority requesting bandwidth while Greedy subscribers will have the lowest. Therefore, a low priority Needy subscriber will receive an upstream grant earlier than a Normal subscriber and a Normal subscriber will get an upstream grant quicker than a Greedy subscriber. Number Adds
For each Bandwidth Request priority Queue, the total number of bandwidth requests added to this queue. This includes requests promoted from lower priority queues.
Number Pendings
For each Bandwidth Request priority Queue, the total number of grant pendings given to bandwidth requests on this queue.
Number Promos
For each Bandwidth Request priority Queue, the total number of bandwidth requests promoted from this queue to a higher priority (less greedy) queue.
Number Drops
For each Bandwidth Request priority Queue, the total number of requests dropped. These are dropped primarily for pending for too long or too many grants pending per map.
Number Elements For each Bandwidth Request priority Queue, the current number of bandwidth requests in the queue. Average Latency (sum(BwRequestQueuesLatencySum) / (sum(BwRequestQueuesNumAdds) (sum(BwRequestQueuesNumPromos)
Example
show interface cable 1 mac-scheduler type flows The following is an example of the output returned by the system:
MapMaker Flow Statistics UGSAD Slot/ NRTPS RTPS Active DS/US Flows Flows Flows ----------- --------- --------- --------1/0/0 0 0 0 1/0/1 0 0 0 1/0/2 0 0 0 1/0/3 0 0 0 1/0/4 0 0 0 1/0/5 0 0 0 1/0/6 0 0 0 1/0/7 0 0 0
UGSAD Polling UGS Flows Flows --------- --------0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
BE Polling Flows --------1 1 1 1 1 1 1 1
The example shows: NRTPS Flows
Current number of scheduled NRTPS flows for this UChannel.
RTPS Flows
Current number of scheduled RTPS flows scheduled for this UChannel.
UGSAD Active Flows
Current number of scheduled UGSAD flows in the Active (UGS) mode for this UChannel.
UGSAD Polling Flows
Current number of scheduled UGSAD flows in the Polling (RTPS) mode
UGS Flows
Current number of scheduled UGS flows for this UChannel.
BE Polling Flows
Current number of scheduled Best Effort Polling flows for this UChannel.
for this UChannel.
These are NRTPS request opportunities given to Best Effort flows based on the flow priority and guaranteed minimum reserved rate.
CLI-1478
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Example
show interface cable 1 mac-scheduler type mslots The following is an example of the output returned by the system:
MapMaker Minislot Statistics
Slot/ DS/US ----------1/0/0 1/0/1 1/0/2 1/0/3 1/0/4 1/0/5 1/0/6 1/0/7
Initial Periodic ReqOps Ranging Ranging -------- -------- -------3793513k 13185k 7423530 3225446k 13185k 10080k 3239385k 13185k 9677555 3572416k 13185k 5654165 4380376k 13185k 0 4380402k 13185k 0 4380413k 13185k 0 4380337k 13185k 190
1.x Data Grants -------481448k 1020299k 997913k 693253k 0 0 0 38287
Adv Phy Data Grants -------0 0 0 0 0 0 0 0
%1.x %Req %Rng Data ---- ---- ---86.3 0.5 11.0 73.4 0.5 23.2 73.7 0.5 22.7 81.3 0.4 15.8 99.7 0.3 0.0 99.7 0.3 0.0 99.7 0.3 0.0 99.7 0.3 0.0
%Adv Phy Data ---0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0
The example shows: BcstReqOpps For each IUC type, the total number of minislots granted to the Broadcast SID. Other RqstOpps REQ/Data (MCastMSlots) For each IUC type, the total number of minislots granted to Multicast SIDs. Initial Maintenance (BCastMSlots + UCastMSlots) Station Maintenance For each IUC type, the total number of minislots granted to Unicast SIDs. Short Data Grant For each IUC type, the total number of minislots granted to Unicast SIDs. Long Data Grant For each IUC type, the total number of minislots granted to Unicast SIDs. Advanced PHY Short Data Grant For each IUC type, the total number of minislots granted to Unicast SIDs. Advanced PHY Long Data Grant For each IUC type, the total number of minislots granted to Unicast SIDs. Advanced PHY Unsolicited Grant For each IUC type, the total number of minislots granted to Unicast SIDs. TotalZeroSIDs MREQS
sum(GrantedZeroSidMSlots) = (BCastMSlots + MCastMSlots + UCastMSlots + MCastMSlots)
MINITMAINT
= (BCastMSlots + UCastMSlots + UCastMSlots)
M1XDATAGRANTS
= (UCastMSlots + UCastMSlots)
MADVPHYDATAGRANTS = (UCastMSlots + UCastMSlots + UCastMSlots) totals
= (MREQS + MINITMAINT + M1XDATAGRANTS + MADVPHYDATAGRANTS + sum(GrantedZeroSidMSlots)
%Req
= ((MREQS
%Rng
= ((MINITMAINT
%1.x Data
/ totals) * 100) / totals) * 100)
= ((M1XDATAGRANTS
/ totals) * 100)
%Adv Phy Data = ((MADVPHYDATAGRANTS / totals) * 100)
MapMaker Minislot Summary Statistics
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1479
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Total Slot/ Total DS/US Mslots ----------- -----1/0/0 4395M 1/0/1 4395M 1/0/2 4395M 1/0/3 4395M 1/0/4 4395M 1/0/5 4395M 1/0/6 4395M 1/0/7 4395M
Ucast Grant Mslots -----488M 1030M 1007M 698M 0 0 0 38477
Total Bw Req Mslots -----481M 1020M 997M 693M 0 0 0 38287
Total Skip Mslots -----427k 425k 425k 425k 443k 421k 413k 432k
Total LchPad Mslots -----0 0 0 0 0 0 0 0
% Lch Actv ---100% 100% 100% 100% 100% 100% 100% 100%
% Ucst Grnt ---11% 23% 23% 16% 0% 0% 0% 0%
% Bw Req ---11% 23% 23% 16% 0% 0% 0% 0%
The example shows: Total Mslots
Total Minislots count for this UChannel.
Total Ucast Grant MslotsTotal Minislots granted to Unicast for this UChannel. Total Bw Req Mslots
Total Minislots requested via bandwidth requests for this UChannel. This count does not include requests dropped due to SuperGreedy in hardware.
Total Skip Mslots
Total Minislots not granted because the MapMaker was behind.
Total LchPad MSlots
Total Minislots allocated to the NULL SID for a logical channel which is inactive
% Lch Actv(TotalMSlots - TotalLogicalNullPadMSlots) / TotalMSlots) * 100) % Ucst Grnt(TotalUCastGrantedMSlots / TotalMSlots) * 100) % Bw Req(TotalBwRequestMSlots / TotalMSlots) * 100)
CLI-1480
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * mac-scheduler detail Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the filter group provisioning for the specified CAM.
Syntax
show interface cable / mac-scheduler detail
Issue 2.0
Parameter
Definition
/
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1481
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * mac-scheduler interval Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the timespan (in seconds) to monitor changes in scheduler information.
Syntax
show interface cable / mac-scheduler interval [detail]
Parameter
Definition
/
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
[detail]
CLI-1482
The timespan in seconds. Displays complete output at full precision.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * mac-scheduler interval * type Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the timespan (in seconds) to monitor changes in scheduler information.
Syntax
show interface cable / mac-scheduler interval type [req] [req-summary] [grants-pending] [queues] [flows] [mslots] [mslots-summary] [detail]
Parameter
Definition
/
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
[req] [req-summary]
Displays all scheduler request information. Displays a summary of scheduler request information.
[grants-pending]
Displays scheduler grant information
[queues]
Displays scheduler queue information
[flows]
Displays scheduler flow information
[mslots]
Displays all scheduler minislot information
[mslots-summary]
Issue 2.0
The timespan in seconds.
Displays a summary of scheduler minislot information
ARRIS PROPRIETARY — All Rights Reserved
CLI-1483
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * mac-scheduler interval * upstream Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the timespan (in seconds) to monitor changes in scheduler information.
Syntax
show interface cable / mac-scheduler interval upstream [detail]
CLI-1484
Parameter
Definition
/
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
Upstream port.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * multicast mcast-fwd-by-dsid Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the configured Multicast DSID-based Forwarding (MDF) capability.
Syntax
show interface cable / multicast mcast-fwd-bydsid
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1485
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * spectrum-group history Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the history of state transitions for the state machine associated with each upstream channel.
Syntax
show cable interface / spectrum-group history [detail]
Parameter
Definition
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1. This will be the downstream transmitter that the upstream receiver is associated with.
[detail]
Displays additional measurement/failure reasons for the state transition.
Example
To display the upstream channel spectrum-group history, type the following command: C4>
show cable interface / spectrum-group history The following is an example of the output returned by the system:
P=Periodic
T=TOD
D=Degradation
I=Improvement
M=Manual
Interface Time Group State Trigger 7/1/10 Sep 6 03:20:47 1 2->3->2 2(P) 7/1/10 Sep 6 02:51:29 1 1->2 1(D) *8/1/11 Sep 6 04:40:45 1 2->1 1(I) *8/1/11 Sep 6 01:55:19 1 1->2 2(D) * Slot is currently being spared
CLI-1486
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable * ugs counts Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the cable interface UGS normal or emergency call information.
Syntax
show interface cable / ugs counts [normal | emergency]
Parameter
Definition
CAM slot number.Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
MAC domain number. Valid range is 0 or 1.
[normal | emergency]
Example
Choose either normal or emergency call information.
To display the UGS normal call information for the interface on slot 15, use the following command: C4>
show interface cable 15 ugs counts normal The response from the system would look similar to:
Feb 10 11:41:40 --------Interface
15/0/0 15/0/1
Ave Calls 10 2
Last 5 Minutes -------------Normal--Min Max New Denied Calls Calls Calls Calls 2 12 0 0 0 3 1 2
-----------
Last 1 Hour --------------Normal---Ave Min Max New Denied Calls Calls Calls Calls Calls 8 0 15 36 0 1 0 3 23 0
NOTE Total calls in the “Last 5 Minutes” equals 0. The reason is that there have been no new phone calls made in the last 5 minutes. Example
To display the UGS emergency call information for the interface on slot 15, use the following command: C4#
Issue 2.0
show interface cable 15 ugs counts emergency
ARRIS PROPRIETARY — All Rights Reserved
CLI-1487
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
The response from the system would look similar to: --------Interface
15/0/0 15/0/1
Ave Calls 10 2
Last 5 Minutes -----------Emergency-Min Max New Denied Calls Calls Calls Calls 2 12 2 0 0 3 0 0
Example
-----------
Last 1 Hour
Ave Min Max Calls Calls Calls 8 0 15 1 0 3
------------Emergency-New Denied Calls Calls 3 0 0 0
To display all UGS call information for the interface on slot 5, use the following command: C4>
show interface cable 15 ugs counts The response from the system would look similar to:
----------------Interface
15/0/0 15/0/1
Ave Calls 10 2
Min Calls 2 0
Last 5 Minutes -----------------------Normal----Emergency-Max New Denied New Denied Calls Calls Calls Calls Calls 12 0 0 2 0 3 0 2 0 0
-------------------
15/0/0 15/0/1
CLI-1488
Ave Calls 8 1
Min Calls 0 0
Max Calls 15 3
Last 1 Hour ----------------------Normal----Emergency-New Denied New Denied Calls Calls Calls Calls 36 0 3 0 23 0 0 0
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-upstream Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the upstream channels on the specified Cable Access Module (CAM).
Syntax
show interface cable-upstream /
Issue 2.0
Parameter
Definition
The chassis slot in which the targeted 12U/24U Cable Access Module resides. Valid values for the C4 CMTS are 0 through 15; valid range for the C4c CMTS are 10 through 12
The upstream port. Valid range is 0 to 11 for a 12U CAM and 0 to 23 for the 24U CAM.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1489
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-upstream * allocated-bandwidth Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the status of the allocated bandwidth for the upstream interface specified.
Syntax
show interface cable-upstream [/] allocated-bandwidth
Parameter
Definition
The chassis slot in which the targeted 12U/24U Cable Access Module resides. Valid values for the C4 CMTS are 0 through 15; valid range for the C4c CMTS are 10 through 12
The upstream port. Valid range is 0 to 11 for a 12U CAM and 0 to 23 for the 24U CAM.
CLI-1490
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-upstream * bit-rate Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the upstream channel data rate.
Syntax
show interface cable-upstream [/] bit-rate
Issue 2.0
Parameter
Definition
The chassis slot in which the targeted 12U/24U Cable Access Module resides. Valid values for the C4 CMTS are 0 through 15; valid range for the C4c CMTS are 10 through 12
The upstream port. Valid range is 0 to 11 for a 12U CAM and 0 to 23 for the 24U CAM.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1491
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface cable-upstream * spectrum-group history Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the history of state transitions for the state machine associated with a specified upstream interface.
Syntax
show interface cable-upstream / spectrumgroup history [detail]
CLI-1492
Parameter
Definition
The chassis slot in which the targeted 12U/24U Cable Access Module resides. Valid values for the C4 CMTS are 0 through 15; valid range for the C4c CMTS are 10 through 12
The upstream port. Valid range is 0 to 11 for a 12U CAM and 0 to 23 for the 24U CAM.
[detail]
Displays additional measurement/failure reasons for the state transition.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface gigabitethernet * access-group Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the access control information for the Gigabit Ethernet interfaces on the Gigabit Ethernet Router Control Modules (RCMs).
Syntax
show interface gigabitethernet / access-group
Parameter
/
Definition
The slot in which the targeted module resides. The slot must contain an RCM. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1493
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface tengigabitethernet * access-group Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the access control information for the Ten Gigabit Ethernet interfaces on the Ten Gigabit Ethernet Router Control Modules (RCMs).
Syntax
show interface tengigabitethernet / access-group
Parameter
/
Definition
The slot in which the targeted module resides. The slot must contain an RCM. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-1494
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show interface utilization Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Samples the data rate on a specified interface over a specified (or default) interval and then displays the bandwidth utilization as a percentage of that interface’s total capacity. NOTE You must set the utilization interval to a non-zero value for the utilization to be calculated. Use the following command to set the utilization interval: configure cable load-interval
Syntax
show interface utilization [slot ]
Parameter
Definition
[slot ]
The chassis slot in which the targeted module resides. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
Example
To show the interface utilization of the Network Access Module in slot 14, type the following command: C4>
show interface utilization slot 7 The following is an example of the output returned by the system:
Polling rate (cable load-interval) = 300 seconds Port CableMaxRate DataRate Loaded DataRate Loaded Mac Mb/sec Mb/sec % Mb/sec % 7/0 7/0 42.88 1.29 3% 7/1 7/1 42.88 0.00 0% 7/0 7/0 30.24 0.30 1% 7/1 7/0 10.24 0.00 0% 7/2 7/0 30.72 0.00 0% 7/3 7/0 10.24 0.00 0%
Related Command(s)
configure cable load-interval
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1495
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip bgp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays entries in the Border Gateway Protocol (BGP) routing table. show ip bgp [] Parameter
[]
Definition
Network in the BGP routing table to display
Related Command(s)
show ip bgp neighbor
CLI-1496
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip bgp neighbor Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays information about the TCP and Border Gateway Protocol (BGP) connections to neighbors. show ip bgp neighbor [] Parameter
Definition
[]
Example
Address of the neighbor whose routes you have learned from. If no address is given, all neighbors are displayed.
To display the information, use the following command: C4#
show ip bgp neighbor The system would respond:
BGP neighbor is 10.70.0.10, remote AS 22, Internal link Member of vrf default Peer BGP state = Connect Peer Admin status = Up Peer Oper status = Up Passive: False Confederation Member: False Reflector: Non-Client Fsm Established Transitions: 1 Connect Retry Count: 2 Configured Hold time is 90 seconds Configured Keepalive time is 30 seconds Minimum interval between originating local AS routes is 15 seconds Interval between successive connection attempts is 120 seconds Minimum interval between advertisement runs is 5 seconds Last peer connection error code: 4 subcode: 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1497
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip bgp neighbor * advertised-routes Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays the routes that are being advertised via the Border Gateway Protocol (BGP). show ip bgp neighbor [] advertised-routes Parameter
Definition
[]
Address of the neighbor for which information is requested. If no address is given, all neighbors are displayed.
Example
To display the information, use the following command: C4#
Sample Output
show ip bgp neighbor 172.16.232.178 advertised-routes An example of the system response is:
BGP table version is 67, local router ID is 71.92.25.36 Status codes: s suppressed, d damped, h history, * valid, > best, i - internal, r RIB-failure, S Stale Origin codes: i - IGP, e - EGP, ? - incomplete
*> *> *> *> *> *> *>
Network 10.254.11.240/29 10.254.11.252/30 10.255.8.0/23 10.255.10.0/24 10.255.11.128/27 10.255.251.208/29 10.255.251.216/29
CLI-1498
Next Hop 172.16.232.179 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0
Metric LocPrf Weight 0 100 32768 0 32768 0 32768 0 32768 0 32768 0 32768 0 32768
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip bgp neighbor * advertised-routes paths Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays the advertised paths for the routes identified via the Border Gateway Protocol (BGP). show ip bgp neighbor [] advertised-routes paths
Parameter
Definition
[]
Address of the neighbor for which information is requested. If no address is given, all neighbors are displayed.
Example
To display the information, use the following command: C4#
show ip bgp neighbor 172.16.232.178 advertised-routes paths
Sample Output
An example of the system response is:
BGP table version is 67, local router ID is 71.92.25.36 Status codes: s suppressed, d damped, h history, * valid, > best, i - internal, r RIB-failure, S Stale Origin codes: i - IGP, e - EGP, ? - incomplete
*> *> *> *> *> *> *>
Network 10.254.11.240/29 10.254.11.252/30 10.255.8.0/23 10.255.10.0/24 10.255.11.128/27 10.255.251.208/29 10.255.251.216/29
Issue 2.0
Next Hop 172.16.232.179 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0 0.0.0.0
Metric LocPrf Weight Path 0 100 32768 ? 0 32768 ? 0 32768 ? 0 32768 ? 0 32768 ? 0 32768 ? 0 32768 ?
ARRIS PROPRIETARY — All Rights Reserved
CLI-1499
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip bgp quote-regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays routes matching the autonomous system path “regular expression.” show ip bgp quote-regexp Parameter
CLI-1500
Definition
A “regular expression” (within quotes) to match the Border Gateway Protocol (BGP) autonomous system paths.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip bgp regexp Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays routes matching the autonomous system path regular expression. show ip bgp regexp Parameter
Definition
Filters path list for display. Regular expression (special characters include) . - The dot matches any single character * - 0 or more of the character that immediately precedes it. + - 1 or more of the character that immediately precedes it. ^ - The caret matches the beginning of the line.
$ - The dollar sign matches the end of the line. \ - The backslash allows for literal meaning of the special characters. [ ] - Search for a set of characters ([aeiou] = any vowel) [^ ]- Search for anything NOT ([^aeiou] = any consonant) ( ) - The parentheses allow for grouping and recall. \b - beginning/end of word | - a|b = a or b
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1501
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip bgp summary Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays the status of all BGP connections. show ip bgp summary
Example
To display the status of all BGP connections, use the following command: C4#
show ip bgp summary The system would respond:
VRF default BGP router identifier 10.120.0.1, local AS number 22 Messages Messages Esatblished In Update Connect Neighbor AS Received Sent Time (sec) Elapsed Time Retry Count -------------- ----- ---------- ---------- ----------- ------------------10.70.0.10 22 29 2355 -419137 2
CLI-1502
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip domain-invquery Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Performs an inverse PTR (pointer record) Domain Naming System (DNS) query on an IP address.
Syntax
show ip domain-invquery
Parameter
Issue 2.0
Definition
The IP address to lookup.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1503
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip domain-lookup Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays all the settings for host name-to-address translation based on the IP Domain Naming System (DNS).
Syntax
show ip domain-lookup
Example
To display the IP DNS-based host name-to-address translation, type the following command: C4>
show ip domain-lookup The following is an example of the output returned by the system: DNS lookup is ENABLED Domain Servers: Pref|Server ----|-------------------1|10.44.0.11 2|10.44.0.12 Domain append list: None defined Default domain name: .lab.chi.arrisi.com
CLI-1504
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip domain-query Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Performs a Domain Naming System (DNS) query on a hostname.
Syntax
show ip domain-query
Parameter
Issue 2.0
Definition
The hostname to query.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1505
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip fqdn-cache Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the FQDN entries in the DNS resolver cache.
Syntax
show ip fqdn-cache
CLI-1506
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp groups Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IGMP group memberships.
Syntax
show ip igmp groups [] [detail] [host]
Parameter
[]
Issue 2.0
Definition
Slot/port
[detail]
Displays IGMPv3 source information
[host]
Displays IGMP host memberships
ARRIS PROPRIETARY — All Rights Reserved
CLI-1507
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp groups cable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IGMP group memberships for a cable interface.
Syntax
show ip igmp groups cable /
Parameter
CLI-1508
Definition
CAM slot number. Valid range is 0-15.
MAC domain number. Valid range is 0 or 1.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp groups cable-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Internet Group Management Protocol (IGMP) group memberships for the cable-mac interface specified.
Syntax
show ip igmp groups cable-mac
Parameter
Issue 2.0
Definition
The MAC identifier (valid numbers are 0-415).
ARRIS PROPRIETARY — All Rights Reserved
CLI-1509
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp groups detail Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays detailed IGMPv3 source information for the specified interface.
Syntax
show ip igmp groups detail [cable / | cable-mac | gigbitethernet / | tengigbitethernet /]
Parameter
Definition
cable /
CAM slot number. Valid range is 0-15. MAC domain number. Valid range is 0 or 1.
cable-mac
The MAC identifier (valid numbers are 0-415)
gigbitethernet /
The RCM slot number . The gigabitEthernet port number
tengigbitethernet /
The RCM slot number . The tengigabitEthernet port number
CLI-1510
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp groups gigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Internet Group Management Protocol (IGMP) group memberships for the gigabitEthernet interface specified.
Syntax
show ip igmp groups gigbitethernet /
Parameter
Issue 2.0
Definition
The RCM slot number
The gigabitEthernet port number
ARRIS PROPRIETARY — All Rights Reserved
CLI-1511
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp groups host Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays detailed IGMP host memberships for the specified interface.
Syntax
show ip igmp groups host [cable / | cable-mac | gigbitethernet / | tengigbitethernet /]
Parameter
Definition
cable /
CAM slot number. Valid range is 0-15. MAC domain number. Valid range is 0 or 1.
cable-mac gigbitethernet / tengigbitethernet /
Example
The MAC identifier (valid numbers are 0-415) The RCM slot number . The gigabitEthernet port number The RCM slot number . The tengigabitEthernet port number
The following is an example of output returned by the system: C4>
show ip igmp groups host cable-mac 1 IGMP Host Group/Source Membership Group Address Interface 224.0.0.22 cable-mac 1 Group filter-mode: Exclude Empty source list
CLI-1512
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp groups tengigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Internet Group Management Protocol (IGMP) group memberships for the tengigabitEthernet interface specified.
Syntax
show ip igmp groups tengigbitethernet /
Parameter
Issue 2.0
Definition
The RCM slot number
The tengigabitEthernet port number
ARRIS PROPRIETARY — All Rights Reserved
CLI-1513
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp interfaces Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the current host and router configuration status for all interfaces along with displaying all groups that are currently joined by the host on an interface.
Syntax
show ip igmp interfaces
Example
To display the IGMP interface configuration for all interfaces with IGMP provisioning, use the following command: C4>
show ip igmp interfaces The following is an example of the output returned by the system:
IGMP interface gigabitEthernet 17/0: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 Multicast groups joined by this system: 224.0.0.22 IGMP interface gigabitEthernet 17/1: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 Multicast groups joined by this system: 224.0.0.22 IGMP interface gigabitEthernet 17/2: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 No multicast groups joined by this system IGMP interface gigabitEthernet 17/3:
CLI-1514
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 Multicast groups joined by this system: 224.0.0.22 IGMP interface cable-mac 1: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 Multicast groups joined by this system: 224.0.0.22 IGMP interface cable 2/0: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 Multicast groups joined by this system: 224.0.0.22 IGMP interface cable 2/1: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 Multicast groups joined by this system: 224.0.0.22
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1515
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp interfaces cable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IGMP interface configuration for a cable interface.
Syntax
show ip igmp interfaces cable /
Parameter
Definition
CAM slot number. Valid range is 0-15.
MAC domain number. Valid range is 0 or 1.
Example
The following is an example of output returned by the system: C4>
show ip igmp groups host cable 2/0 IGMP interface cable 2/0: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 Multicast groups joined by this system: 224.0.0.22
CLI-1516
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp interfaces cable-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the current host and router configuration status for the cable-mac interface specified.
Syntax
show ip igmp interfaces cable-mac
Parameter
Definition
The MAC identifier (valid numbers are 0-415)
Example
The following is an example of output returned by the system: C4>
show ip igmp interfaces cable-mac 1 IGMP interface cable-mac 1: IGMP host configured version is 2 IGMP host version 1 querier timer is 0h0m0s IGMP host version 2 querier timer is 0h0m0s IGMP host robustness is 2 Multicast groups joined by this system: 224.0.0.22
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1517
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp interfaces gigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Internet Group Management Protocol (IGMP) interface configuration for the gigabitEthernet interface specified.
Syntax
show ip igmp interfaces gigbitethernet /
Parameter
CLI-1518
Definition
The RCM slot number
The gigabit port number
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip igmp interfaces tengigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Internet Group Management Protocol (IGMP) interface configurations for the tenGigabitEthernet interface specified.
Syntax
show ip igmp interfaces tengigbitethernet /
Parameter
Issue 2.0
Definition
The RCM slot number
The tengigabit port number
ARRIS PROPRIETARY — All Rights Reserved
CLI-1519
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip interface Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IP interfaces for the client modules.
Syntax
show ip interface
Example
To show all of the IP interfaces, type the following command: C4>
show ip interface The following is an example of the output returned by the system: cable-mac 1.0, VRF: default, IP Address: 10.129.0.1/19 Secondary IP Address(es): No Secondary Addresses Physical Address: 0001.5c22.f001 MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): 10.50.29.3 for Traffic Type "any" Directed Broadcast is disabled ICMP unreachables are always sent Multicast reserved groups joined: None Source-verify is disabled Policy routing is disabled InOctets = 56683 OutOctets = 23530 InUcastPkts= 230 OutUcastPkts= 238 InDiscards = 0 OutDiscards = 0 InErrors = 0 OutErrors = 0 InMcastPkts= 0 OutMcastPkts= 2 cable-mac 1.1, VRF: vrf_a, IP Address: 10.129.32.1/19 Secondary IP Address(es): No Secondary Addresses Physical Address: 0001.5c22.f001 MTU is 1500
CLI-1520
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): No Helper Addresses Directed Broadcast is disabled ICMP unreachables are always sent Multicast reserved groups joined: None Source-verify is disabled Policy routing is disabled InOctets = 0 OutOctets = InUcastPkts= 0 OutUcastPkts= InDiscards = 0 OutDiscards = InErrors = 0 OutErrors = InMcastPkts= 0 OutMcastPkts=
256 2 0 0 2
gigabitEthernet 17/0.0, VRF: default, IP Address: 10.79.0.2/24 Secondary IP Address(es): No Secondary Addresses SCM access ACL(s): 20 Physical Address: 0001.5c22.efe0 MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): No Helper Addresses Directed Broadcast is disabled ICMP unreachables are always sent Multicast reserved groups joined: None Policy routing is disabled InOctets = 36799 OutOctets = 47494 InUcastPkts= 262 OutUcastPkts= 253 InDiscards = 0 OutDiscards = 0 InErrors = 0 OutErrors = 0 InMcastPkts= 0 OutMcastPkts= 2 loopback 0, VRF: default, IP Address: 10.44.29.200/32 Secondary IP Address(es): No Secondary Addresses MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): No Helper Addresses
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1521
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Directed Broadcast is disabled Multicast reserved groups joined: None ethernet 19/0, IP Address: 10.44.29.1/29 ethernet 19/0, Active IP Address: 10.44.29.3/29 MTU is 1500 InOctets = 5908133 OutOctets = 7566392 InUcastPkts= 63073 OutUcastPkts= 66921 InDiscards = 6 OutDiscards = 0 InErrors = 0 OutErrors = 0 InMcastPkts= 0 OutMcastPkts= 1
CLI-1522
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip interface brief Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IP addresses for the client modules.
Syntax
show ip interface brief
Example
To show the brief ip interface, type the following command: C4>
Interface cable-mac 1.0 cable 2/0.0 gigabitEthernet 17/2.0 loopback 0 ethernet 19/0 ethernet 19/0 active
Issue 2.0
show ip interface brief Primary IP 10.1.70.129/27 10.1.70.1/25 10.1.64.70/30 10.1.64.42/30 10.1.64.227/26 10.1.64.226/26
Admin Oper Up Up Up Up Up Up
ARRIS PROPRIETARY — All Rights Reserved
State State OOS-AUTO IS IS IS IS IS
CLI-1523
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip interface * cable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IP cable interfaces only.
Syntax
show ip interface [brief] cable [/]
Parameter
Definition
[brief]
Displays brief output format
[/
Example
The chassis slot in which the CAM resides and port number.
To show the ip cable interfaces, type the following command: C4>
show ip interface cable The following is an example of the output returned by the system:
cable 15/0, VRF: default, IP Address: 10.117.0.1/19 Secondary IP Address(es): 10.118.0.1/24 10.118.1.1/24 10.118.2.1/24 10.118.4.1/24 10.118.5.1/24 10.118.6.1/24 10.118.8.1/24 10.118.9.1/24 10.118.10.1/24 10.118.12.1/24 10.118.13.1/24 10.118.14.1/24 10.118.16.1/24 10.118.17.1/24 10.118.18.1/24 10.118.20.1/24 10.118.21.1/24 10.118.22.1/24 10.118.24.1/24 10.118.25.1/24 10.118.26.1/24 10.118.28.1/24 10.118.29.1/24 10.118.30.1/24 10.118.32.1/24 10.118.33.1/24 10.118.34.1/24 10.118.36.1/24 10.118.37.1/24 10.118.38.1/24 MTU is 1300 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): 10.50.17.3 for Traffic Type "any" Directed Broadcast is disabled Multicast reserved groups joined: 224.0.0.9
CLI-1524
ARRIS PROPRIETARY — All Rights Reserved
10.118.3.1/24 10.118.7.1/24 10.118.11.1/24 10.118.15.1/24 10.118.19.1/24 10.118.23.1/24 10.118.27.1/24 10.118.31.1/24 10.118.35.1/24 10.118.39.1/24
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Source-verify is disabled InOctets = 0 InUcastPkts= 0 InDiscards = 0 InErrors = 0
Issue 2.0
OutOctets = OutUcastPkts= OutDiscards = OutErrors =
392 0 0 0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1525
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip interface * cable-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IP address for the client modules of the cable-mac interface specified.
Syntax
show ip interface [brief] cable-mac
show ip interface brief cable-mac 1 Interface cable-mac 1.0
C4>
Primary IP 10.1.70.129/25
Admin Oper State State Up IS
show ip interface cable-mac 1
cable-mac 1.0, VRF: default, IP Address: 10.1.70.129/25 Description: c4sw6 cable-mac 1 probably set to ipv4 only Secondary IP Address(es): No Secondary Addresses Physical Address: 0001.5c23.db81 MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): 10.1.64.215 for Traffic Type "any" Directed Broadcast is disabled
CLI-1526
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
ICMP unreachables are always sent Multicast reserved groups joined: None Source-verify is disabled InOctets = 642630 OutOctets = InUcastPkts= 925 OutUcastPkts= InDiscards = 0 OutDiscards = InErrors = 0 OutErrors = InMulticastPkts= 0 OutMulticastPkts=
Issue 2.0
93506 579 0 0 0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1527
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip interface * gigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Gigabit Ethernet interface information for the client modules.
Syntax
show ip interface [brief] gigabitethernet
Parameter
Definition
[brief]
Displays brief output format
Example
To show the Gigabit Ethernet interfaces, type the following command: C4>
show ip interface gigabitethernet The following is an example of the output returned by the system: GigEthernet 13/0 10.79.0.2/19 Secondary IP(s): 10.79.32.2/19 MTU is 1300 DHCP Policy mode is disabled (primary mode) Directed Broadcast is disabled Multicast reserved groups joined: None InOctets = 0 OutOctets = InUcastPkts= 0 OutUcastPkts= InDiscards = 0 OutDiscards = InErrors = 0 OutErrors =
0 0 0 0
GigEthernet 13/1 10.79.64.2/19 Secondary IP(s): 10.79.96.2/19 MTU is 1300 DHCP Policy mode is disabled (primary mode) Directed Broadcast is disabled Multicast reserved groups joined: None
CLI-1528
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
InOctets = InUcastPkts= InDiscards = InErrors =
Issue 2.0
0 0 0 0
OutOctets = OutUcastPkts= OutDiscards = OutErrors =
0 0 0 0
GigEthernet 13/2 10.79.128.2/19 Secondary IP(s): 10.79.160.2/19 MTU is 1300 DHCP Policy mode is disabled (primary mode) Directed Broadcast is disabled Multicast reserved groups joined: None InOctets = 0 OutOctets = InUcastPkts= 0 OutUcastPkts= InDiscards = 0 OutDiscards = InErrors = 0 OutErrors =
0 0 0 0
GigEthernet 13/3 10.79.192.2/19 Secondary IP(s): 10.79.224.2/19 MTU is 1300 DHCP Policy mode is disabled (primary mode) Directed Broadcast is disabled Multicast reserved groups joined: None InOctets = 0 OutOctets = InUcastPkts= 0 OutUcastPkts= InDiscards = 0 OutDiscards = InErrors = 0 OutErrors =
0 0 0 0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1529
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip interface * loopback Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the loopback interface information.
Syntax
show ip interface [brief] loopback
Parameter
Definition
[brief]
Displays brief output format
Loopback interface number. Valid range is 0-15.
Example
To show the loopback interfaces, type the following command: C4>
show ip interface loopback The following is an example of the output returned by the system: loopback 0, VRF: default, IP Address: 10.1.64.42/30 Secondary IP Address(es): No Secondary Addresses MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): No Helper Addresses Directed Broadcast is disabled Multicast reserved groups joined: None InOctets = 0 OutOctets = InUcastPkts= 0 OutUcastPkts= InDiscards = 0 OutDiscards = InErrors = 0 OutErrors = InMulticastPkts= 0 OutMulticastPkts=
CLI-1530
ARRIS PROPRIETARY — All Rights Reserved
0 0 0 0 0
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip interface * tengigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Ten Gigabit Ethernet interface information for the client modules.
Syntax
show ip interface [brief] tengigabitethernet
Parameter
Definition
[brief]
Displays brief output format
Example
To show the Ten Gigabit Ethernet interface information, type the following command: C4>
show ip interface tengigabitethernet The following is an example of the output returned by the system: gigabitEthernet 16/1, VRF: default, IP Address: 192.168.18.2 255.255.255.0 Secondary IP Address(es): No Secondary Addresses MTU is 1300 DHCP Policy mode is disabled (primary mode) Directed Broadcast is disabled Multicast reserved groups joined: 224.0.0.5 224.0.0.6 InOctets = 0 OutOctets = 1703655996 InUcastPkts= 0 OutUcastPkts= 17367 InDiscards = 0 OutDiscards = 0 InErrors = 0 OutErrors = 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1531
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip isis Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays the IS-IS redistribution information. show ip isis
CLI-1532
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip maximum-paths Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays the number of Equal Cost Multiple Paths.
Syntax
show ip maximum-paths
Parameter
Issue 2.0
Definition
The VRF name = default.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1533
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip mroute Default Access Level
Mode
Privileged – 15
Global configuration
Purpose
Displays forwarding counts for a multicast protocol and the FQDN (if applicable) associated with each source group address.
Syntax
show ip mroute
Parameter
Definition
Multicast IP address in the form
Source-address of the multicast channel and only applies for PIM-SSM routes in the form .
Example
Assume cable 15/0 is statically provisioned with the multicast channel and the RPF next-hop for the channel is a north bound router with an IP address of 192.100.10.2 and the CMTS gigabit Ethernet interface on this network is 192.100.10.1, the command would look like: C4#
show ip mroute 232.0.0.5 192.100.50.1 The following is an example of the output returned by the system: Mcast Address Source Address RPF Nbr Address 232.0.0.5 92.100.50.1 192.100.10.2 Outgoing Interface Cable 15/0
CLI-1534
Incoming Interface gigabitEthernet 14/1
Count 5000
ARRIS PROPRIETARY — All Rights Reserved
Uptime 2:12:10:30
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip multicast default-group-service-class Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays Multicast information on the name of the default service class used by Multicast Qos. The default service class used by the Multicast QoS is C4DefGrpSCN.
Syntax
show ip multicast default-group-service-class
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1535
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows general information about the OSPF routing processes.
Syntax
show ip ospf [vrf ]
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
Example
To show general information about the OSPF routing process, type the following command: C4>
show ip ospf The following is an example of the output returned by the system: Router VRF default with ID 192.168.18.2 Only cost is used when choosing among multiple AS-externalLSAs It is an area border and autonomous system boundary router Redistributing External Routes from, connected with metric type 2 mapped to 0, excludes subnets in redistribution Exit overflow interval 0 seconds Number of external LSA 10. Checksum 0x50D40 Number of new originated LSAs 14 Number of received LSAs 3 SPF default time 180 SPF Schedule time 5
CLI-1536
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf area Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF area information.
Syntax
show ip ospf [vrf ] area
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
Example
To show the OSPF area information, type the following command: C4>
show ip ospf area The following is an example of the output returned by the system: Area 0.0.0.0 Number of interfaces in this area is 0 Area has None authentication SPF algorithm executed 410 times Area ranges are: Number of LSA 3. Checksum Sum 0xfe4b Number of ABR 0. Number of ASBR 0. Area 0.0.0.100 Number of interfaces in this area is 1 Area has None authentication SPF algorithm executed 410 times Area ranges are: Number of LSA 4. Checksum Sum 0x1604d Number of ABR 0. Number of ASBR 1.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1537
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF database information.
Syntax
show ip ospf [vrf ] database [adv-router] [asbrsummary]
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[adv-router]
Advertising Router link states (as an IP address)
[asbr-summary]
Example
The ASBR summary link states link state ID (as an IP address)
To display the OSPF database information, type the following: C4>
show ip ospf database The following is an example of the output returned by the system:
Type-1 Router Link States (VRF 1 Link ID 192.168.18.2
ADV Router 192.168.18.2
Age 1320
Area 0.0.0.0) Seq# Checksum Link count 0x80000028 0x6AE8 1
Type-3 Summary Net Link States (VRF 1 Link ID 192.168.18.0
ADV Router 192.168.18.2
Age 1320
Seq# Checksum 0x80000027 0x56A6
Type-4 AS Summary Link States (VRF 1 Link ID 192.168.18.1
CLI-1538
ADV Router 192.168.18.2
Age 675
Area 0.0.0.0)
Area 0.0.0.0)
Seq# Checksum 0x80000028 0x3CBD
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Type-1 Router Link States (VRF 1 Link ID 192.168.18.1 192.168.18.2
ADV Router 192.168.18.1 192.168.18.2
Age 1307 1311
Type-2 Net Link States (VRF 1 Link ID 192.168.18.1
ADV Router 192.168.18.1
Age 1307
Area 0.0.0.100) Seq# Checksum Link count 0x80000FF9 0x2017 1 0x80000143 0xD601 1
Area 0.0.0.100) Seq# Checksum 0x800000D3 0x551F
Type-3 Summary Net Link States (VRF 1 Link ID 10.43.201.155
ADV Router 192.168.18.2
Age 1313
Area 0.0.0.100)
Seq# Checksum 0x800000DA 0x1516
Type-5 AS External Link States (VRF 1) Link ID 10.43.201.152 10.68.64.0 10.68.96.0 10.68.128.0 10.68.160.0 10.118.0.0 10.118.32.0 10.118.64.0 192.168.18.0 192.168.18.0
Issue 2.0
ADV Router 192.168.18.2 192.168.18.2 192.168.18.2 192.168.18.2 192.168.18.2 192.168.18.2 192.168.18.2 192.168.18.2 192.168.18.1 192.168.18.2
Age 1313 1313 1313 1313 1313 1313 1313 1326 562 1313
Seq# 0x8000013C 0x8000013B 0x8000013B 0x8000013B 0x8000013B 0x8000013B 0x8000013C 0x8000005A 0x800000CF 0x8000013C
Checksum 0xBA8D 0xFC6D 0x9BAE 0x3AEF 0xD831 0x6513 0x0255 0x67B2 0x4198 0x96C6
ARRIS PROPRIETARY — All Rights Reserved
CLI-1539
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database external Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays only detailed information about external Link State Advertisements (LSAs.)
Syntax
show ip ospf [vrf ] database external [adv-router]
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[adv-router]
Advertising Router link states (as an IP address)
Example
To display detailed information about external LSAs, type the following command: C4>
show ip ospf database external The following is an example of the output returned by the system:
OSPF Router with ID (192.168.18.2)
(Vrf Id 1)
Type-5 AS External Link States LS age: 1541 Options: ( E ) LS Type: AS External Link Link State ID: 10.43.201.152 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000013C Checksum: 0xBA8D Length: 36 Network Mask: /29 Metric Type: 2 (Larger than any link state path) TOS: 0
CLI-1540
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 1541 Options: ( E ) LS Type: AS External Link Link State ID: 10.68.64.0 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000013B Checksum: 0xFC6D Length: 36 Network Mask: /19 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 1541 Options: ( E ) LS Type: AS External Link Link State ID: 10.68.96.0 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000013B Checksum: 0x9BAE Length: 36 Network Mask: /19 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 1542 Options: ( E ) LS Type: AS External Link Link State ID: 10.68.128.0 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000013B Checksum: 0x3AEF
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1541
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Length: 36 Network Mask: /19 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 1542 Options: ( E ) LS Type: AS External Link Link State ID: 10.68.160.0 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000013B Checksum: 0xD831 Length: 36 Network Mask: /19 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 1580 Options: ( E ) LS Type: AS External Link Link State ID: 10.118.0.0 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000013B Checksum: 0x6513 Length: 36 Network Mask: /19 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 1580 Options: ( E ) LS Type: AS External Link
CLI-1542
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Link State ID: 10.118.32.0 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000013C Checksum: 0x255 Length: 36 Network Mask: /19 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 1593 Advertising Router: 192.168.18.2 LS Seq Number: 8000013C Checksum: 0x255 Length: 36 Network Mask: /19 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 1593 Options: ( E ) LS Type: AS External Link Link State ID: 10.118.64.0 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000005A Checksum: 0x67B2 Length: 36 Network Mask: /19 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0 LS age: 829 Options: ( DC )
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1543
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
LS Type: AS External Link Link State ID: 192.168.18.0 (External Network Number) Advertising Router: 192.168.18.1 LS Seq Number: 800000CF Checksum: 0x4198 Length: 36 Network Mask: 255.255.255.0 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 20 Forward Address: 0.0.0.0 Tag: 0 LS age: 1603 Options: ( E ) LS Type: AS External Link Link State ID: 192.168.18.0 (External Network Number) Advertising Router: 192.168.18.2 LS Seq Number: 8000013C Checksum: 0x96C6 Length: 36 Network Mask: 255.255.255.0 Metric Type: 2 (Larger than any link state path) TOS: 0 Metric: 0 Forward Address: 0.0.0.0 Tag: 0
CLI-1544
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database network Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF database network link states (as IP addresses).
Syntax
show ip ospf [vrf ] database network [adv-router]
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[adv-router]
Advertising Router link states (as an IP address)
Example
To display the OSPF database network information, type the following: C4>
Issue 2.0
show ip ospf database network
ARRIS PROPRIETARY — All Rights Reserved
CLI-1545
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database nssa-external Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF database NSSA external link states information.
Syntax
show ip ospf [vrf ] database nssa-external [adv-router]
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[adv-router]
Advertising Router link states (as an IP address)
Example
To display the OSPF database NSSA external link state information, type the following: C4>
CLI-1546
show ip ospf database nssa-external
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database opaque-area Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF Opaque Area link states.
Syntax
show ip ospf [vrf ] database opaque-area []
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[]
Issue 2.0
Link state ID (as an IP address).
ARRIS PROPRIETARY — All Rights Reserved
CLI-1547
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database opaque-area adv-router Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF Opaque Area advertising router link states.
Syntax
show ip ospf [vrf ] database opaque-area [] adv-router
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[]
CLI-1548
Link state ID (as an IP address). Advertising router (as an IP address).
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database opaque-as Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF Opaque AS link states.
Syntax
show ip ospf [vrf ] database opaque-as [] [adv-router
]
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[] [adv-router ]
Issue 2.0
Link state ID (as an IP address). Advertising Router link states (as an IP address)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1549
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database opaque-link Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF Opaque link-local states.
Syntax
show ip ospf [vrf ] database opaque-link []
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[]
CLI-1550
Link state ID (as an IP address).
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database opaque-link adv-router Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF Opaque Area link-local states.
Syntax
show ip ospf [vrf ] database opaque-link [] adv-router
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[] [adv-router ]
Issue 2.0
Link state ID (as an IP address). Advertising Router link states (as an IP address)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1551
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database router Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF database router link states information.
Syntax
show ip ospf [vrf ] database router [adv-router ]
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[adv-router ]
Example
To display the OSPF database router link states information, type the following: C4>
CLI-1552
Advertising Router link states (as an IP address)
show ip ospf database router
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf database summary Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Shows the OSPF database summary information.
Syntax
show ip ospf [vrf ] database summary [adv-router ]
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[adv-router ]
Example
To display the OSPF database summary information, type the following: C4>
Issue 2.0
Advertising Router link states (as an IP address)
show ip ospf database summary
ARRIS PROPRIETARY — All Rights Reserved
CLI-1553
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf interface Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Display OSPF interface information.
Syntax
show ip ospf [vrf default] interface [brief]
Parameter
CLI-1554
Definition
[vrf default]
Name given to VRF.
[brief]
Displays brief output
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf neighbor Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Display OSPF neighbor information.
Syntax
show ip ospf [vrf default] neighbor
Parameter
Definition
[vrf default]
Name given to VRF.
Example
To display information about OSPF neighbors, type the following command: C4>
show ip ospf neighbor The following is an example of the output returned by the system:
Vrf Name default
Issue 2.0
ID
Pri
192.168.18.1
1
State Full/DR
RxmtQlen 0
Address 192.168.18.1
ARRIS PROPRIETARY — All Rights Reserved
Permanence Dynamic
CLI-1555
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ospf virtual-links Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays parameters of the current state of the OSPF virtual link.
Syntax
show ip ospf [vrf ] virtual-links
Parameter
Definition
[vrf ]
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
CLI-1556
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip pim interface Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the PIM interface information.
Syntax
show ip pim interface
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1557
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip pim neighbor Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the PIM neighbor information.
Syntax
show ip pim neighbor
CLI-1558
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip policy Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the policy route map.
Syntax
show ip policy
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1559
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip prefix-list Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the contents of the prefix list table.
Syntax
show ip prefix-list
Parameter
CLI-1560
Definition
Name of the prefix-list
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip protocols Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays a summary of the IP routing protocols in use.
Syntax
show ip protocols
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1561
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip rip Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Will confirm RIP is enabled for the network and display the RIP configuration.
Syntax
show ip rip
Example
To display the RIP configuration, type the following command: C4>
show ip rip The following is an example of the output returned by the system: RIP Interfaces Interface 10.78.0.2 10.78.64.2 10.128.0.1 10.128.64.1 10.128.128.1 10.128.192.1 10.178.0.1 10.178.64.1 10.178.128.1 10.178.192.1 10.228.0.1 10.228.64.1 10.228.128.1 10.228.192.1
VRF default default default default default default default default default default default default default default
Df Met 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Auth Mode disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled
State disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled disabled
RIP Timers VRF default: Update interval is set to 30 seconds. VRF default: Route invalidation interval is set to 180 seconds. VRF default: Route flush interval is set to 120 seconds.
CLI-1562
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip rip database Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays RIP database information.
Syntax
show ip rip database
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1563
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip route Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays details of the active and inactive routes on all virtual routers in the CMTS.
Syntax
show ip route [vrf ] [detail] [A.B.C.D[/bits]] [bgp] [connected] [local] [netmgmt] [isis] [ospf] [rip] [static]
Parameter
Definition
Name given to VRF. To display only the default VRF, enter “default” as the VRF name.
[detail]
Shows active and inactive routes. Defaults to displaying only active routes.
[A.B.C.D[/bits]] [bgp] [connected] [local] [netmgmt]
Border Gateway Protocol Connected VRFs Local routes Net management routes
[isis]
Intermediate System to Intermediate System (IS-IS)
[ospf]
Open Shortest Path First (OSPF) routes
[rip] [static]
CLI-1564
IP address or network with optional mask bits
Routing Information Protocol (RIP) routes Static routes
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip route summary Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the total number of all routes, e.g. total number of RIP, OSPF, static, and netmgt and local routes in the box.
Syntax
show ip route summary
Example
To confirm all routes are accounted for, type the following command: C4>
show ip route summary The following is an example of the output returned by the system: IP routing table name is default(1) Route Source Routes ============ ====== Local 3
Issue 2.0
VR Total
3
Total
3
ARRIS PROPRIETARY — All Rights Reserved
CLI-1565
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip scm access Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays whether SCM access is enabled or disabled.
Syntax
show ip scm access [detail]
Parameter
Definition
[detail]
Displays SCM access information details
Example
To show the status of SCM access, use the following command: C4#>
show ip scm access The following is an example of the output returned by the system: SCM access disabled To show more detail, use the following command:
C4#>
show ip scm access detail The following is an example of the output returned by the system: SCM access disabled ACL list for interface gigabitEthernet 17/0: 20 10 permit any (918 matches)
CLI-1566
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip scm access interface-only Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays only the interface and ACL associations.
Syntax
show ip scm access interface-only
Example
To show only the interface and ACL associations, use the following command: C4#>
show ip scm access interface-only The following is an example of the output returned by the system: ACL list for interface gigabitEthernet 17/0: 20
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1567
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ssh Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Displays the currently running status of the SSH daemon, and if running, connection details for any current SSH sessions such as the connection ID, the user ID, the client IP address, the service (terminal or SFTP), Authentication method (password or public key), encryption algorithm, MAC algorithm, and the client software version.
Syntax
show ip ssh
Example
To display the current running status of the SSH daemon and connection details for any sessions, use the following command: C4>
show ip ssh The following is an example of the output returned by the system:
SSH is running Connected clients: ID User Clt Addr 6815843 c4 10.1.175.137
CLI-1568
Service terminal
Auth Meth password
Encr Alg aes128-cbc
ARRIS PROPRIETARY — All Rights Reserved
MAC Alg hmac-sha1
Clt SW OpenSSH_3.5p1
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip ssh config Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Displays the settings for the bind address, port number, idle time, max clients, max shells, supported encryption and MAC algorithms, service terminal, port forwarding, password allowed, password required, public key allowed, public key required, public key first, and the max number of authentication failures.
Syntax
show ip ssh config
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1569
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip unreachables Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the status of all interface ICMP unreachables.
Syntax
show ip unreachables
Example
To show the status of all interface ICMP unreachables, type the following command: C4>
show ip unreachables The following is an example of the output returned by the system: ICMP unreachables are always sent
CLI-1570
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 access-list Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 ACL entry information. If the optional ACLname or generated number is omitted, then all entries for all IPv6 ACLs will be displayed.
Syntax
show ipv6 access-list [aclName | aclNumber]
Parameter
[aclName] [aclNumber]
Issue 2.0
Definition
IPv6 name Internally-generated ACL number
ARRIS PROPRIETARY — All Rights Reserved
CLI-1571
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 icmp Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays global IPv6 ICMP parameters: unreachables, too-big, etc.
Syntax
show ipv6 icmp
CLI-1572
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 interface [brief] cable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 configuration for the specified slot and port.
Syntax
show ipv6 interface [brief] cable [/]
Parameter
Issue 2.0
Definition
[brief]
Displays brief output format.
CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
The value of the port (0-3)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1573
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 interface [brief] cable-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays availability of IPV6 interfaces for the specified interface.
Syntax
show ipv6 interface [brief] cable-mac
Parameter
Definition
[brief]
Displays the output in brief format
The MAC address value (0 or 1)
Example
The following is an example of output returned by the system: C4>
Interface
show ipv6 interface brief cable-mac 1 Admin State Up
cable-mac 1.0 Example
Oper State IS
Primary IP FE80::201:5CFF:FE23:DB81/10
To display all available information, use the following command: c4>
show ipv6 interface cable-mac 4
cable-mac 4.0 Admin State / Oper State Link-local address Joined group address(es)
: Down / OOS-MAN : FE80::201:5CFF:FE23:DB84/10 : FF02::1 FF02::2 FF02::1:FF23:DB84 DHCP Relay Destination(s) : 2001:1234::2:0:0:0:4 for Traffic Type "any" Maximum Transmission Unit (MTU) : 1500 bytes ND reachable time : 0 ms ND advertised retransmit interval : 1000 ms ND router advertisements are sent every : 600 sec ND router advertisements lifetime : 1800 sec Host address autoconfiguration : Statefull
CLI-1574
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 interface [brief] gigabitEthernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 configuration for the specified gigabitethernet interface.
Syntax
show ipv6 interface [brief] gigabitethernet /
Parameter
[brief]
Definition
Displays brief output format. RCM slot number/gigabitEthernet port number.
/
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1575
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 interface [brief] loopback Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Limits the display to loopback interfaces.
Syntax
show ipv6 interface [brief] loopback
Parameter
CLI-1576
Definition
[brief]
Displays brief output format.
Loopback interface number.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 interface [brief] tengigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 ND cache for the specified tengigabitethernet interface.
Syntax
show ipv6 interface [brief] tengigabitethernet /
Parameter
[brief]
Definition
Displays brief output format. RCM slot number/tengigabitEthernet port number.
/
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1577
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 isis Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the ISIS redistribution information.
Syntax
show ipv6 isis
CLI-1578
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 maximum-paths Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the number of Equal Cost Multiple Paths.
Syntax
show ipv6 maximum-paths
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1579
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 neighbors Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 ND cache entry for the IPv6 address.
Syntax
show ipv6 neighbors [][] []
Parameter
Definition
The address of the IPv6 neighbor.
The type of interface including cable, cable-mac, etc.
CLI-1580
The number associated with the interface type specified.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 neighbors cable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 ND cache entry for the specified slot and MAC domain number.
Syntax
show ipv6 neighbors cable /
Parameter
Issue 2.0
Definition
The chassis slot in which the targeted CAM resides. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
The MAC domain number (valid numbers are 0 or 1)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1581
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 neighbors cable-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the status of the IPv6 Neighbor Discovery (ND) cache.
Syntax
show ipv6 neighbors cable-mac
Parameter
Example
Definition
The cable MAC identifier.
show ipv6 neighbors cable-mac 13 The output generated would look similar to:
Row 1 2 3 4 5 6 7
IPv6 Address FC00:CADA:C414:C001:2C:F19B:365F:5A5B FC00:CADA:C414:C001:6E:4DC3:BE9:88C FC00:CADA:C414:C001:E0:D955:E7A6:EEC7 FC00:CADA:C414:C001:F4:334E:4EBE:2813 FC00:CADA:C414:C001:173:64F7:4E85:6AFA FC00:CADA:C414:C001:181:4DF:1D:BD8C FC00:CADA:C414:C001:1A7:228D:9862:8B69
CLI-1582
Link-layerAddr 0015.cfb7.7d80 0015.cfb7.82c6 0015.cfb7.9b38 0015.cfb7.8278 0015.cfb7.8239 0015.cfb7.9cb8 0015.cf1f.733e
Type Dynamic Dynamic Dynamic Dynamic Dynamic Dynamic Dynamic
State Active Active Active Active Active Active Active
ARRIS PROPRIETARY — All Rights Reserved
Interface cmac 13 cmac 13 cmac 13 cmac 13 cmac 13 cmac 13 cmac 13
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 neighbors gigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 ND cache entry for the specified slot and Gigabit Ethernet port.
Syntax
show ipv6 neighbors gigabitethernet /
Parameter
Definition
RCM slot number/gigabitEthernet port number. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1583
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 neighbors tengigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 ND cache entry for an IPv6 Ten Gigabit Ethernet interface.
Syntax
show ipv6 neighbors tengigabitethernet /
Parameter
Definition RCM slot number/tengigabitEthernet port number.
/
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
CLI-1584
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 ospf Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 OSPF status.
Syntax
show ipv6 ospf
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1585
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 ospf area Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 OSPF area information.
Syntax
show ipv6 ospf area
CLI-1586
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 ospf database Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 OSPF database information.
Syntax
show ipv6 ospf database
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1587
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 ospf database adv-router Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 OSPF database information filtered by the Advertising Router.
Syntax
show ipv6 ospf database adv-router Parameter
CLI-1588
Definition Advertising Router (as an IP address)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ipv6 ospf database external Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IPv6 OSPF database information filtered by external link states.
Syntax
show ipv6 ospf database external {
Purpose
Displays the IPv6 routes for the specified tengigabitEthernet interface.
Syntax
show ipv6 route tengigabitethernet / [vrf ] [detail] []
Parameter
Definition
[vrf ]
The name assigned to the virtual router. If name is not specified, the default name of the vrf is default.
[detail] []
Shows same routes in a non-abbreviated format. The IPv6 network of interest RCM slot number/tengigabitEthernet port number.
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1625
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip-video global Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IP video timers and parameters.
Syntax
show ip-video global
CLI-1626
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ip vrf Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the virtual router data in various levels of detail.
Syntax
show ip vrf [brief | detail | interface]
Parameter
Definition
brief
Only give VR Index to name mapping and OSPF and RIP status
detail
Provides “brief” info plus all virtual router interface information
interface
Provides only the virtual router interface information
Example
To show the virtual route brief data, type the following command: C4>
show ip vrf brief The following is an example of the output returned by the system:
Virtual Router Details: Name Index =============== ========== default 1 Example
OSPF ==== no
RIP === no
ICMP-TIME-EXCEEDED ================== no
To show the virtual route detail data, type the following command: C4>
show ip vrf detail The following output is an example of the type of information returned by the system:
Virtual Router Interfaces: Name Slot/Port =============== ========= default 5/0 default 5/0.1 default 5/0.1
Issue 2.0
IP Address ================== (P)10.106.0.1 (P)10.108.0.1 10.118.0.1
Mask =============== 255.255.224.0 255.255.224.0 255.255.224.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1627
CLI Command Descriptions
default default default default default default default default default default default default default default
C4/C4c CMTS Rel. 8.0.7
5/0.2 5/0.3 5/0.4 5/0.5 5/0.6 5/0.7 5/0.8 6/0 14/0 14/0.1 14/0.2 14/1 16/0 16/1
Virtual Router Details: Name Index =============== ========== default 1
CLI-1628
(P)10.109.0.1 (P)10.110.0.1 (P)10.111.0.1 (P)10.112.0.1 (P)10.113.0.1 (P)10.114.0.1 (P)10.115.0.1 (P)10.107.0.1 (P)10.66.0.2 (P)10.86.0.2 (P)10.96.0.2 (P)10.66.64.2 (P)10.76.0.2 (P)10.76.64.2
OSPF ==== no
RIP === no
255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0 255.255.224.0
ISIS ==== no
BGP === no
ARRIS PROPRIETARY — All Rights Reserved
ICMP-TIME-EXCEEDED ================== no
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show isis database Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IS-IS link state database.
Syntax
show isis database [detail] [l1 | l2 | level-1 | level-2]
Parameter
Issue 2.0
Definition
LSP PDU identifier
[detail]
Displays content of each link state packet
l1
Filters on level 1 database information
l2
Filters on level 2 database information
level-1
Filters on level 1 database information
level-2
Filters on level 2 database information
ARRIS PROPRIETARY — All Rights Reserved
CLI-1629
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show isis hostname Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the IS-IS dynamic hostname mapping.
Syntax
show isis hostname
CLI-1630
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show isis interface Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the interface status and configuration.
Syntax
show isis interface
Example
show isis interface The output would look similar to:
cable-mac 1.0 is Up, line protocol is Up CLNS/IS-IS protocol processing disabled gigabitEthernet 17/0 is Up, line protocol is Down CLNS/IS-IS protocol processing disabled gigabitEthernet 17/1 is Up, line protocol is Down CLNS/IS-IS protocol processing disabled gigabitEthernet 17/2 is Up, line protocol is Up CLNS/IS-IS protocol processing disabled gigabitEthernet 17/3 is Up, line protocol is Up CLNS/IS-IS protocol processing disabled gigabitEthernet 17/4 is Up, line protocol is Up CLNS/IS-IS protocol processing disabled gigabitEthernet 17/5 is Up, line protocol is Up CLNS/IS-IS protocol processing disabled gigabitEthernet 17/6 is Up, line protocol is Down CLNS/IS-IS protocol processing disabled gigabitEthernet 17/7 is Up, line protocol is Up CLNS/IS-IS protocol processing disabled gigabitEthernet 17/8 is Up, line protocol is Down CLNS/IS-IS protocol processing disabled gigabitEthernet 17/9 is Up, line protocol is Down CLNS/IS-IS protocol processing disabled tenGigabitEthernet 17/10 is Up, line protocol is Up CLNS/IS-IS protocol processing enabled MTU 1500 Circuit Type: level-1
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1631
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Interface Number 0x1000012d Circuit Admin State: enabled, Oper State: Up Level-1 Metric: 10, Wide-metric: 10, Priority: 64, Circuit Id: Hello Timer: 3000msec, Hello Multiplier: 10, DRHello Timer: 1000msec LSP Throttle: 30msec, LSP Retransmit Interval: 5sec Number of active level-1 adjacencies: 0 gigabitEthernet 18/0 is Up, line protocol is Down CLNS/IS-IS protocol processing disabled tenGigabitEthernet 18/10 is Up, line protocol is Up CLNS/IS-IS protocol processing enabled MTU 1500 Circuit Type: level-1 Interface Number 0x1000012f Circuit Admin State: enabled, Oper State: Up Level-1 Metric: 10, Wide-metric: 10, Priority: 64, Circuit Id: Hello Timer: 3000msec, Hello Multiplier: 10, DRHello Timer: 1000msec LSP Throttle: 30msec, LSP Retransmit Interval: 5sec Number of active level-1 adjacencies: 0 loopback 0 is Up, line protocol is Up CLNS/IS-IS protocol processing disabled loopback 1 is Up, line protocol is Up CLNS/IS-IS protocol processing disabled
CLI-1632
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show isis interface events Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the interface status and configuration.
Syntax
show isis interface events
Example
show isis interface events The output would look similar to:
cable-mac 1 is Up, line protocol is Up cable-mac 2 is Up, line protocol is Up cable-mac 3 is Up, line protocol is Up cable-mac 4 is Up, line protocol is Up cable 10/0 mac-port is Up, line protocol is Up cable 10/1 mac-port is Up, line protocol is Up cable 10/0 mac-port is Up, line protocol is Up CLNS/IS-IS protocol processing disabled. cable 10/1 mac-port is Up, line protocol is Up CLNS/IS-IS protocol processing disabled. gigabitEthernet 17/0 is Down, line protocol is Down gigabitEthernet 17/1 is Down, line protocol is Down gigabitEthernet 17/2 is Up, line protocol is Up gigabitEthernet 17/3 is Up, line protocol is Up gigabitEthernet 17/4 is Up, line protocol is Up gigabitEthernet 17/5 is Up, line protocol is Up gigabitEthernet 17/6 is Up, line protocol is Down gigabitEthernet 17/7 is Up, line protocol is Up gigabitEthernet 17/8 is Up, line protocol is Down gigabitEthernet 17/9 is Up, line protocol is Down tenGigabitEthernet 17/10 is Up, line protocol is Up Circuit Type: level-1 Number of: Adjacency state changes:0 Adjacencies:1 Initialization failures:0 Adjacencies rejected:0 Field len mismatches:0 Max area address mismatches:0 Auth type failures:0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1633
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Authentication validation failures:0 DIS changes:0 gigabitEthernet 18/0 is Down, line protocol is Down gigabitEthernet 18/1 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. gigabitEthernet 18/2 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. gigabitEthernet 18/3 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. gigabitEthernet 18/4 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. gigabitEthernet 18/5 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. gigabitEthernet 18/6 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. gigabitEthernet 18/7 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. gigabitEthernet 18/8 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. gigabitEthernet 18/9 is Down, line protocol is Down CLNS/IS-IS protocol processing disabled. tenGigabitEthernet 18/10 is Up, line protocol is Up Circuit Type: level-1 Number of: Adjacency state changes:0 Adjacencies:1 Initialization failures:0 Adjacencies rejected:0 Field len mismatches:0 Max area address mismatches:0 Auth type failures:0 Authentication validation failures:0 DIS changes:0
CLI-1634
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show isis neighbor Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays CLNS neighbor adjacencies.
Syntax
show isis neighbor [detail]
Parameter
[detail]
Example
Definition
Displays detailed neighbor information.
show isis neighbor The output would look similar to:
Sys Adj System ID Interface SNPA State Hold Type Type Circuit Id Protocol -------------- ---------------------- -------------- ----- ----- ---- ---- ------------------- -------0100.8500.9001 gigabitEthernet 17/9.0 000b.45b6.0100 Up 9 L1/2 L1 TR11.01 M-ISIS 0100.8500.9001 gigabitEthernet 17/9.0 000b.45b6.0100 Up 9 L1/2 L2 TR11.01 M-ISIS
NOTE If the connected router does not support MT IS-IS, the protocol will display IS-IS in the above output. If the neighbor row says ‘IS-IS’, it only indicates that the remote IS is using regular IS-IS TLVs on that interface. The CMTS can still send MT TLVs based on its own system/interface configuration. The CMTS’s MT support can be verified using the show isis protocol command. Example
To display the IS-IS neighbor detail output which includes both the remote router’s protocol (M-ISIS or IS-IS) and the remote router’s topologies (IPv4 and IPv6), use the following command: show isis neighbor detail
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1635
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
The output would look similar to: System ID Interface SNPA State Hold Type Type Circuit Id -------------- --------------------- ------------- ----- ---- ---- ---- ---------------0100.6413.8001 gigabitEthernet 17/0 0015.1515.1177 Up 8 L1 L1 STABILITY-NAM.01 Area Address(es): 47.0001 IP Address(es): 10.60.0.1 IPv6 Address(es): fe80::215:15ff:fe15:1177 Uptime: 0 days 00:49:52 Priority: 64 Support restart signalling: Yes Restart state: Not Restarting Adjacency suppressed: No Topology: IPv4, IPv6
CLI-1636
ARRIS PROPRIETARY — All Rights Reserved
Protocol --------M-ISIS
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show isis protocol Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays CLNS protocol information.
Syntax
show isis protocol
Example
show isis neighbor The output would look similar to:
IS-IS Router: default IS-IS routing Enabled IS-IS multi-topology Enabled System ID: 0100.6000.0002 IS-Type: level-1 Max LSP Lifetime: 1200 seconds Max time to delay after LSP event: 5000 milliseconds Override the routing calculation delay when the number of updates reach: infinite Routing calculation is to be paused: 10000 times Manual area address(es): 47.0001 Interfaces supported by IS-IS: gigabitEthernet 17/0 - IP - IPv6 level-L1 gigabitEthernet 18/0 - IP - IPv6 level-L1 Administrative distances: Internal level-1: 115 Internal level-2: 116 External level-1: 117 External level-2: 118 Metrics: Level-1 generates: wide Level-1 accepts: wide Level-2 generates: wide Level-2 accepts: wide
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1637
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show isis timers Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays ISIS protocol timers.
Syntax
show isis timers
Example
show isis timers The output would look similar to: Global Timers
Timer-name lsp-gen-interval (msec) lsp-refresh-interval (sec) max-lsp-lifetime (sec) spf-interval (msec)
Configured-value 30000 900 1200 5000
Default-value 30000 900 1200 5000
Interface Timers Configured-Value Interface: cable-mac 1.0 l1-csnp-time(sec): l2-csnp-time(sec): l1-hello-time(msec): l2-hello-time(msec):
State:Down
Interface: gigabitEthernet 17/0.0 l1-csnp-time(sec): l2-csnp-time(sec): l1-hello-time(msec): l2-hello-time(msec):
10 10 3000 3000
10 10 3000 3000
10 10 3000 3000
10 10 3000 3000
State:Down
Interface: tenGigabitEthernet 17/10.0 l1-csnp-time(sec): l2-csnp-time(sec):
CLI-1638
Default-value
State:Up 10 10
ARRIS PROPRIETARY — All Rights Reserved
10 10
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
l1-hello-time(msec): l2-hello-time(msec): Interface: gigabitEthernet 18/0.0 l1-csnp-time(sec): l2-csnp-time(sec): l1-hello-time(msec): l2-hello-time(msec):
Issue 2.0
3000 3000
10 10 3000 3000
10 10 3000 3000
State:Down
Interface: tenGigabitEthernet 18/10.0 l1-csnp-time(sec): l2-csnp-time(sec): l1-hello-time(msec): l2-hello-time(msec): Interface: loopback 0 l1-csnp-time(sec): l2-csnp-time(sec): l1-hello-time(msec): l2-hello-time(msec):
3000 3000
State:Up 10 10 3000 3000
10 10 3000 3000
10 10 3000 3000
10 10 3000 3000
State:Down
ARRIS PROPRIETARY — All Rights Reserved
CLI-1639
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show isis traffic Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays ISIS protocol statistics.
Syntax
show isis traffic
Example
show isis traffic The output would look similar to:
ISIS Packet Statistics: tenGigabitEthernet 17/10 Router Virtual Interface Level-1 Hellos (sent/rcvd): 73256/22074 Level-2 Hellos (sent/rcvd): 0/0 Level-1 IS Hellos (sent/rcvd): 0/0 Level-2 IS Hellos (sent/rcvd): 0/0 Level-1 ES Hellos (sent/rcvd): 0/0 Level-2 ES Hellos (sent/rcvd): 0/0 Level-1 LSPs (sent/rcvd): 0/0 Level-2 LSPs (sent/rcvd): 0/0 Level-1 CSNPs (sent/rcvd): 0/0 Level-2 CSNPs (sent/rcvd): 0/0 Level-1 PSNPs (sent/rcvd): 0/0 Level-2 PSNPs (sent/rcvd): 0/0 Level-1 Unknown PDUs (sent/rcvd): 0/0 Level-2 Unknown PDUs (sent/rcvd): 0/0 Level-1 Discarded LSPs (sent/rcvd): 0/0 Level-2 Discarded LSPs (sent/rcvd): 0/0 Level-1 Discarded CSNPs (sent/rcvd): 0/0 Level-2 Discarded CSNPs (sent/rcvd): 0/0 Level-1 Discarded PSNPs (sent/rcvd): 0/0 Level-2 Discarded PSNPs (sent/rcvd): 0/0 tenGigabitEthernet 18/10 Router Virtual Interface Level-1 Hellos (sent/rcvd): 73264/22083 Level-2 Hellos (sent/rcvd): 0/0 Level-1 IS Hellos (sent/rcvd): 0/0 Level-2 IS Hellos (sent/rcvd): 0/0 Level-1 ES Hellos (sent/rcvd): 0/0 Level-2 ES Hellos (sent/rcvd): 0/0 Level-1 LSPs (sent/rcvd): 0/0
CLI-1640
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Level-2 LSPs (sent/rcvd): 0/0 Level-1 CSNPs (sent/rcvd): 0/0 Level-2 CSNPs (sent/rcvd): 0/0 Level-1 PSNPs (sent/rcvd): 0/0 Level-2 PSNPs (sent/rcvd): 0/0 Level-1 Unknown PDUs (sent/rcvd): 0/0 Level-2 Unknown PDUs (sent/rcvd): 0/0 Level-1 Discarded LSPs (sent/rcvd): 0/0 Level-2 Discarded LSPs (sent/rcvd): 0/0 Level-1 Discarded CSNPs (sent/rcvd): 0/0 Level-2 Discarded CSNPs (sent/rcvd): 0/0 Level-1 Discarded PSNPs (sent/rcvd): 0/0 Level-2 Discarded PSNPs (sent/rcvd): 0/0 ISIS System Statistics for Level-1: Corrupted LSPs: 0 Authentication type mismatches: 0 Authentication Failures: 0 LSP L1 overloaded: 1 Manual Area Address dropped: 0 IS attempted to exceed the maximum sequence number: 0 LSP Purges Received: 0, Initiated: 0 Sequence number skip occurred: 0 PDU Field Length Mismatches: 0 Number of times SPF run: 214 Partition changes: 0 Discards for badly formed LSPs: 0, CSNPs: 0, PSNPs: 0 LSP queue length: 0 LSP fragments generated by local system: 15 LSP Retransmits: 0, Regenerated: 733 LSP purges initiated : 0 ISIS System Statistics for Level-2: Corrupted LSPs: 0 Authentication type mismatches: 0 Authentication Failures: 0 LSP L1 overloaded: 0 Manual Area Address dropped: 0 IS attempted to exceed the maximum sequence number: 0 LSP Purges Received: 0, Initiated: 0 Sequence number skip occurred: 0 PDU Field Length Mismatches: 0 Number of times SPF run: 0 Partition changes: 0 Discards for badly formed LSPs: 0, CSNPs: 0, PSNPs: 0 LSP queue length: 0 LSP fragments generated by local system: 0 LSP Retransmits: 0, Regenerated: 0 LSP purges initiated : 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1641
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show l2vpn cm-mac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the information on L2VPN instances.
Syntax
show l2vpn cm-mac
Parameter
CLI-1642
Definition
CM-MAC of cable modem
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show l2vpn l2vpnid Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the information on L2VPN instances.
Syntax
show l2vpn l2vpnid
Parameter
Issue 2.0
Definition
L2VPN ID
ARRIS PROPRIETARY — All Rights Reserved
CLI-1643
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show line Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the current line status.
Syntax
show line [detail]
Parameter
Definition
[detail]
Displays detailed utilization and performance measurements.
Example
To display the current line status, type the following command: C4>
show line The following is an example of the output returned by the system:
Tty Line --0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
-----con 0 con 1 vty 0 vty 1 vty 2 vty 3 vty 4 vty 5 vty 6 vty 7 vty 8 vty 9 vty 10 vty 11 vty 12 vty 13
CLI-1644
Enabled Session Timeout (secs) ------- --------------TRUE 0 TRUE 0 TRUE 0 TRUE 0 TRUE 0 TRUE 0 TRUE 0 TRUE 0 TRUE 0 FALSE 0 FALSE 0 FALSE 0 FALSE 0 FALSE 0 FALSE 0 FALSE 0
Idle Timeout (secs) -----------60000 60000 60000 60000 60000 60000 60000 60000 0 0 0 0 0 0 0 0
Page Length Screen Width ----------- -----0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80 0 80
ARRIS PROPRIETARY — All Rights Reserved
Speed -----9600 9600 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
16 17
vty 14 FALSE vty 15 FALSE
0 0
Example
0 0
0 0
80 80
N/A N/A
To display detailed utilization and performance measures, type the following command: C4>
show line detail The following is an example of the output returned by the system:
Tty Line
Enabled Session Timeout Idle Timeout Page Length Screen (secs) (secs) Width --- ------ ------- --------------- ------------ ----------- -----0 con 0 TRUE 0 60000 0 80 Authentication method list (login): auth1 Authentication method list (enable): auth1 Authorization method list: author_default
Speed
1 con 1 TRUE 0 60000 0 Authentication method list (login): auth1 Authentication method list (enable): auth1 Authorization method list: author_default
80
9600
2 vty 0 TRUE 0 60000 0 Authentication method list (login): auth1 Authentication method list (enable): Authorization method list: list1 Shell Accounting Method List: acct1 Shell Accounting Type: start-stop
80
N/A
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
-----9600
CLI-1645
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show linecard status Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
The show linecard status command displays the current module status information. Refer to the example below with corresponding explanatory text. If no slot number is specified, then the system will display the status of all the modules.
Syntax
show linecard status [slot]
Parameter
Definition
[slot]
The chassis slot in which the targeted module resides. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
Example
To display the status of all modules, type the following command: C4>
show linecard status The following is an example of the output returned by a C4 CMTS system:
Chassis Type: C4 Slot Description 0 1 2 14 15 17 18 19 20
CAM CAM CAM CAM CAM RCM RCM SCM SCM
CLI-1646
(0D, 12U) (0D, 12U) (0D, 24U) (16D, 0U) (16D, 0U) A B A B
Admin Oper State State Up IS Up IS Up IS Up IS Up IS Up IS Up IS Up IS Up IS
Duplex State Standby Active Simplex Active Standby Active Standby Active Standby
Serial Number 06492CMD0352 06032CMD0232 11353CTU0006 08283CSD0166 08113CSD0010 08133RCM0001 09433RCM0094 02341CBM0020 03141CBM0042
ARRIS PROPRIETARY — All Rights Reserved
HW Version CAM-01122W/K03 CAM-01122W/F09 CAM-01240W/C05 CAM-20032W/G02 CAM-20016W/E02 RCM-01000W/D03 RCM-01000W/E02 SCM-00440W/G05 SCM-02440W/B02
Prov/Det Type CAM/CAM CAM/CAM CAM/CAM DMM/DMM DMM/DMM RCM/RCM RCM/RCM SCM/SCM SCM/SCM
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
The show linecard status command will display the operational or service states of all configured and provisioned modules in the system. Each column is defined below. •
Slot = the slot number provisioned for the module
•
Description = the module type for each provisioned slot.
•
Admin State = the module’s administrative state as Up or Dn
•
Oper State = the module’s operational state The following is a list and brief description of all the possible operational states: IS IS-INIT OOS-MAN OOS-FLT OOS-DGN OOS-DNLD OOS-PUMP
•
State = designation of each module as either the Active module in a duplex configuration or as Simplex mode only.
•
Serial Number = the number on each module
•
HW Version = the hardware version for each module
•
Prov/Det Type = the provisioned module type and the detected module type. The Detected Type will be named or represented as the following: -
Issue 2.0
In service In service - undergoing initialization Out of service - shutdown manually Out of service - faulted Out of service - undergoing diagnostics Out of service - undergoing software download Out of service - FPGAs are being pumped
a dash (-) if no module is present in the slot a question mark (?) if the module is present, but the CMTS cannot detect the correct type.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1647
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays all event management subsystems and features available for logging configuration on the C4 CMTS.
Syntax
show logging
Example
To display the current logging information, type the following command: C4#
show logging The following is an example of the output returned by the system:
Throttle: type=unconstrained, threshold=0, interval=1, notifications=33423, throttled=0 Syslog:
no hosts configured notifications=33423, throttled=0, dropped=138051 priority=1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice), 7(information) SNMP:
notifications=576, throttled=0 priority=1(emergency), 2(alert), 3(critical), 4(error), 5(warning),
6(notice) Local:
size=10 Volatile: notifications=33673 priority=1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice), 7(information) Nonvolatile: notifications=0 priority=none Console:
CLI-1648
notifications=0 priority=none
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Monitor:
notifications=0 priority=none
Debug:
bpi.auth_info enabled on all slots bpi.datamanagement enabled on all slots bpi.datamanagement.general enabled on all slots bpi.general.general enabled on all slots bpi.multicast enabled on all slots bpi.multicast.sparing enabled on all slots modem.bpi.auth_key_display disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots modem.bpi.auth_request disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots modem.bpi.authentication disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots modem.bpi.key_request disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots modem.bpi.management disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots modem.bpi.map_request disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots modem.bpi.msgdump disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots modem.bpi.registration disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots modem.bpi.sparing disabled on all slots Admit Filter List cmMac 00:1d:cd:68:b5:d0 on all slots
History:
notifications=2000, size=2000
Currently Active Event Overrides:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1649
CLI Command Descriptions
0000000005 0066030102 0066030103 0066030104 0066030108 0066030109 0066030202 0066030203 0066030205 0066030206 0066030207 0066030300 0066050102 0066050103 0066050203 0066050206 0066060600 0066060700 0082010100 0082010200 2473092361 2473093380 CLI Access Level 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
CLI-1650
(0x00000005) (0x03ef8a16) (0x03ef8a17) (0x03ef8a18) (0x03ef8a1c) (0x03ef8a1d) (0x03ef8a7a) (0x03ef8a7b) (0x03ef8a7d) (0x03ef8a7e) (0x03ef8a7f) (0x03ef8adc) (0x03efd836) (0x03efd837) (0x03efd89b) (0x03efd89e) (0x03f00138) (0x03f0019c) (0x04e35ff4) (0x04e36058) (0x93686509) (0x93686904)
C4/C4c CMTS Rel. 8.0.7
Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit Inhibit
Notification Priority 7(information) 7(information) 7(information) 7(information) 7(information) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 1(emergency)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Related Command(s)
show logging debug show logging history
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1651
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging console Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the current logging configuration and utilization statistics for the system console.
Syntax
show logging console
Example
To show the current system console configuration, type the following command: C4#
show logging console The following is an example of the output returned by the system: Console:
CLI-1652
notifications=0 priority=none
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging debug Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the traces currently enabled.
Syntax
show logging debug [facility]
Parameter
Definition
Facility name
[facility]
Issue 2.0
ACL AND AuthServer LI LiCaleaTap MibGC QosMgr SNMP ServiceClassName ServiceFlowCount Throttle ThrottlingConfig TstRec aging appl applFlow arp audit authmod bcm bgp bpi brief_modem broker cammanager camsparing carPolicy ccrrcvy channelcac cli clock cm-status cmts counts dappl data datamanagement dataplane dcard dcd dchan dhcp dhcpv6 diag diskmanager dlb dmmappl docsis drv dsdata eappl edr eventrcvr ez flexpath flinkmon icmp icmpv6 igmp ip ipdr isis ldr learning mac macdm macdmVerbose macdomain macmgr map mdd modem mpls mtce multicast nal ospf ospfv3 packetcable pbr pim proxy ranging rcc rip router rsvp scmaccess security socket switch test tftpra tftpraV6 ucard uchan unconverted uploadbal upstreamAgility util voiph voipm voipvh voipvm vpn
ARRIS PROPRIETARY — All Rights Reserved
CLI-1653
CLI Command Descriptions
Example
C4/C4c CMTS Rel. 8.0.7
To display the traces currently enabled, type the following command: C4#
show logging debug The following is an example of the output returned by the system: Debug:
CLI-1654
rip.authentication enabled on all slots rip.daemon.down enabled on all slots rip.daemon.started enabled on all slots rip.daemon.stopped enabled on all slots rip.daemon.up enabled on all slots rip.general.general enabled on all slots rip.general.ifdatanotfound enabled on all slots rip.general.message enabled on all slots rip.general.route enabled on all slots rip.interface.added enabled on all slots rip.interface.removed enabled on all slots rip.message.receivedisabled enabled on all slots rip.message.senddisabled enabled on all slots rip.msgrcvd.error enabled on all slots rip.msgrcvd.request enabled on all slots rip.msgrcvd.response enabled on all slots rip.msgsent.request enabled on all slots rip.msgsent.response enabled on all slots rip.msgsent.socketerror enabled on all slots rip.msgsent.triggeredupdate enabled on all slots rip.route.added enabled on all slots rip.route.advertise enabled on all slots rip.route.error enabled on all slots rip.route.filtered enabled on all slots rip.route.invalid enabled on all slots rip.route.invalidated enabled on all slots rip.route.modified enabled on all slots rip.route.removed enabled on all slots rip.route.timer enabled on all slots rip.route.unprocessed enabled on all slots router.attemptingto.general enabled on all slots router.route.add enabled on all slots router.route.general enabled on all slots router.route.print enabled on all slots router.route.print enabled on all slots
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging history Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the contents of the log history buffer which contains all log messages sent to any logging destination. The log can be filtered to display only a subset of information.
Syntax
show logging history [last ] [beforedate ] [after-date ] [before-time ] [after-time ] [event ] [priority ] [text ] [slot ] [detail]
Parameter
[last ] [before-date ]
Definition
Displays the specified number of events Displays events before the specified date; mm=month, dd=day, and yyyy=year
[after-date ]
Displays events after the specified date; mm=month, dd=day, and yyyy=year
[before-time ]
Displays events before the specified time; hh=hour, mm=minute, ss=seconds
[after-time ]
Displays events after specified time; hh=hour, mm=minute, ss=seconds
[event ]
Displays events with the specified event id
[priority ]
Displays events with the specified priority
[text ] [slot ] [detail]
Issue 2.0
Displays events containing the matching text Displays events that occurred on the specified slot. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19. Displays detailed header information
ARRIS PROPRIETARY — All Rights Reserved
CLI-1655
CLI Command Descriptions
Example
C4/C4c CMTS Rel. 8.0.7
The following is an example of the logging history. C4#
show logging history The following is an example of the output returned by the system:
History: notifications=377, size=2000 show history filters: terse format Time Sl Pri Text... -------- -- ---- ------15:12:17 19 notc: SystemMtce: AutoRecovery Enabled 15:12:17 19 notc: SystemMtce::notifyCardStateChange(): SystemMtceCard.19: basicMtceState=INIT_CREATED 15:12:22 19 notc: CardMtceFunction: InitProgressStatus Change: old=1 new=2 15:12:59 20 notc: CLI command:c4:10.44.225.191:config session 1000 15:13:00 20 notc: SystemMtce::notifyCardStateChange(): SystemMtceCard.19: basicMtceState=INIT_CREATED 15:13:00 20 notc: Card Primary State Change: Trap Severity=cleared,Shelf Number:0,CardNumber:19,CardType=mcard,Card Subtype=mcard,Card Primary State=is 15:13:00 20 notc: Card Secondary State Change: Trap Severity=warning,Shelf Number:0,CardNumber:19,CardType=mcard,Card Subtype=mcard,Card Secondary State=initializing 15:12:34 19 notc: PSM: Using saved configuration 15:12:36 19 alrt: NAL::getOsIfIndex() invalid interface name: eth0 15:12:36 19 notc: SystemMtce: SelectActiveStandby: Selecting STANDBY (weMayGoActive=0 cloneMayGoActive=1 cloneSideNeedsRecovery=0) 15:13:13 20 notc: CloneProxy[PersistentStoreManager]::gen() : 10 events sent before Proxy is active, triggering event(32737) 15:12:37 19 notc: SystemMtce::notifyCardStateChange(): SystemMtceCard.19: basicMtceState=INIT_INITED
Related Command(s)
configure logging priority cli trace logging no
CLI-1656
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging local Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the local logging related information.
Syntax
show logging local
Example
To display the current information, type the following command: C4#
show logging local The following is an example of the output returned by the system:
Local:
Issue 2.0
size=10 Volatile: notifications=1489 priority=1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice) Nonvolatile: notifications=793 priority=1(emergency), 2(alert), 3(critical), 4(error)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1657
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging monitor Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays monitor logging related information.
Syntax
show logging monitor
Example
To display the monitor logging information, type the following command: C4#
show logging monitor The following is an example of the output returned by the system: Monitor: notifications=0 priority=none
CLI-1658
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging overrides Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays any existing SNMP logging overrides.
Syntax
show logging overrides
Example
To show the SNMP logging overrides, type the following command: C4#
show logging overrides The following is an example of the output returned by the system: Currently Active Event Overrides: 0066030300 (0x03ef8adc) Inhibit 0066060600 (0x03f00138) Inhibit 0066060700 (0x03f0019c) Inhibit 0082010100 (0x04e35ff4) Inhibit 0082010200 (0x04e36058) Inhibit
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1659
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging priority cli Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the CLI access levels 0 through 15 and the logging priority that is assigned to that particular CLI access level. The current system default settings are listed in the following table: CLI Access Level
Notification Priority
0 through 4
7 (Informational)
5 through 15
6 (Notice)
Syntax
show logging priority cli
Example
To show the CLI logging priority information, type the following command: C4#
show logging priority cli The following is an example of the output returned by the system: CLI Access Level 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
CLI-1660
Notification Priority 7(information) 7(information) 7(information) 7(information) 7(information) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Related Command(s)
configure logging priority cli show logging history
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1661
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging proprietary Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the proprietary SNMP logging status.
Syntax
show logging proprietary
Example
To show the proprietary SNMP logging status, type the following command: C4#
show logging proprietary The following is an example of the output returned by the system: Proprietary notifications are enabled for snmp, local log (volatile and non-volatile), and syslog destinations.
CLI-1662
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging snmp Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the current SNMP logging related information.
Syntax
show logging snmp
Example
To display the current SNMP logging related information, type the following command: C4#
show logging snmp The following is an example of the output returned by the system: notifications=261, throttled=0 priority=3(critical), 4(error), 5(warning), 6(notice)
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1663
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging syslog Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the current Syslog logging configuration and utilization statistic information.
Syntax
show logging syslog
Example
To display the current syslog logging configuration and utilization statistic information for the default Syslog configuration, type the following command: C4#
show logging syslog The following is an example of the output returned by the system: Syslog: no hosts configured notifications=97, throttled=0, dropped=97 priority= 1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice) If a single Syslog host had been configured, the output would look similar to the following: Syslog: hosts (ip address facility): 10.43.4.5 local0 notifications=500, throttled=0, dropped=500 priority= 1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice) If multiple Syslog hosts had been configured, the output might look like the following: Syslog: hosts (ip address facility): 10.43.4.5 local0 10.43.4.6 local5 10.43.4.7 local2 notifications=501, throttled=0, dropped=503 priority= 1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice)
CLI-1664
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging throttle Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the current throttle configuration and utilization statistics.
Syntax
show logging throttle
Example
To display the current throttle configuration, type the following command: C4#
show logging throttle The following is an example of the output returned by the system: type=unconstrained, threshold=0, interval=1, notifications=13, throttled=0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1665
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show logging trap Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays SNMP trap logging related information.
Syntax
show logging trap
Example
To display trap logging information, type the following command: C4#
show logging trap The following is an example of the output returned by the system: Enabled logging traps: None enabled Enabled CM reset traps: None enabled
CLI-1666
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show memory Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the memory usage information for the specific slot.
Syntax
show memory [detail]
Parameter
Definition
The chassis slot number. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
[detail]
Shows detailed OSE heap statistics.
Example
To display the memory usage information for the SCM in slot 19, type the following command: C4#
show memory 19 The following is an example of the output returned by the system:
Memory Statistics: Total heap size Total free bytes in heap Total heap object allocations Total heap object extant Total bytes allocated to large heap
Issue 2.0
= = = = =
466614288 410899888 ( 88% of total heap size) 509462041 68242 13639680
ARRIS PROPRIETARY — All Rights Reserved
CLI-1667
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show memory access-list Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the current utilization of the RCM’s data plane ACL memory only.
Syntax
show memory access-list
Example
To display current utilization, use the following command: C4#
show memory access-list The following is an example of the output returned by the system:
Total memory available for access lists = Total memory currently used = Total free memory for access lists =
CLI-1668
2359296 bytes 144 2359152 bytes (99% of total)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show netstat Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the currently active network connections and lists statistics for various protocols in the TCP/IP for the System Control Module.
Syntax
show netstat [slot ] [routes] [stats] [interfaces]
Parameter
Definition
[slot ]
The chassis slot in which the targeted module resides. Valid range for the C4 CMTS is 19-20; valid range for the C4c CMTS is 19.
[routes]
Keyword to show the IP routing table
[stats]
Keyword to show all statistics for TCP, UDP, IP and ICMP
[interfaces]
Keyword to show the interface statistics
Example
To display the currently active network connections and statistics for the various protocols for the SCM, type the following command: C4>
show netstat The following is an example of the output returned by the system:
IPv4 Sockets Proto Local Address UDP 127.0.0.1.49152 UDP 0.0.0.0.111 UDP 0.0.0.0.1020 UDP 0.0.0.0.49153 UDP 0.0.0.0.69 UDP 127.0.0.1.20057 UDP 127.0.0.1.20005 UDP 0.0.0.0.1018 UDP 0.0.0.0.5051 UDP 0.0.0.0.2049 UDP 127.0.0.1.278
Issue 2.0
Foreign Address 127.0.0.1.17185 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 127.0.0.1.20056 127.0.0.1.20004 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.*
ARRIS PROPRIETARY — All Rights Reserved
(state)
CLI-1669
CLI Command Descriptions
UDP 0.0.0.0.5050 UDP 0.0.0.0.49159 UDP 0.0.0.0.161 UDP 0.0.0.0.49161 UDP 0.0.0.0.123 UDP 127.0.0.1.123 UDP 127.0.0.1.49189 UDP 127.0.0.1.49190 UDP 0.0.0.0.4737 UDP 0.0.0.0.1003 tcp 0.0.0.0.17476 tcp 100.0.0.31.46 tcp 100.0.1.25.32 tcp 100.0.2.24.32 tcp 100.0.0.31.32 tcp 100.0.0.31.49154 tcp 100.0.0.31.32 tcp 100.0.2.24.49155 tcp 100.0.2.24.32 tcp 100.0.1.25.49156 tcp 100.0.0.31.3919 tcp 100.0.1.25.3919 tcp 0.0.0.0.23 tcp 0.0.0.0.21 tcp 100.0.0.31.277 tcp 100.0.0.31.32 tcp 100.0.2.24.32 tcp 0.0.0.0.4737 tcp 100.0.2.24.49213 tcp 100.0.2.24.32 tcp 100.0.1.25.40 tcp 100.0.1.25.40 tcp 100.0.0.31.62983 tcp 100.0.0.31.49289 tcp 100.0.0.31.49290 tcp 100.0.0.31.49307 tcp 100.0.0.31.49308 tcp 10.44.109.3.23 tcp 10.44.109.3.23 IPv6 Sockets Proto Local Address
CLI-1670
C4/C4c CMTS Rel. 8.0.7
0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 100.0.0.31.32 100.0.0.31.49154 100.0.2.24.32 100.0.2.24.49155 100.0.1.29.32 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 0.0.0.0.* 100.0.0.30.49162 100.0.2.16.49164 0.0.0.0.* 100.0.2.28.32 100.0.2.20.49171 0.0.0.0.* 100.0.1.29.49159 100.0.0.3.32 100.0.0.22.32 100.0.0.18.32 100.0.0.2.32 100.0.0.1.32 10.43.5.55.51840 10.43.6.54.63887
LISTEN LISTEN LISTEN LISTEN LISTEN ESTABLISHED ESTABLISHED ESTABLISHED ESTABLISHED ESTABLISHED LISTEN LISTEN LISTEN LISTEN LISTEN ESTABLISHED ESTABLISHED LISTEN ESTABLISHED ESTABLISHED LISTEN ESTABLISHED ESTABLISHED ESTABLISHED ESTABLISHED ESTABLISHED ESTABLISHED ESTABLISHED ESTABLISHED
Foreign Address
(state)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ntp * Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the Network Time Protocol (NTP) settings.
Syntax
show ntp
Parameter
Definition
The status of the NTP associations The default NTP minpoll, maxpoll, and the version
Example
To show the defaults that have been set for the NTP, type the following command: C4#
show ntp defaults The following is an example of the output returned by the system: C4 (client) default values: minpoll=6 maxpoll=10 ver=4 auth=on
Example
To show the status of the NTP associations, type the following command: C4#
show ntp associations The following is an example of the output returned by the system: 10.50.28.3 server unicast burst=off prefer=on minpoll=4 maxpoll=4 ver=4 key=0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1671
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show operation events override Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the recovery/logging values. Use the optional slot parameter for a specific interface.
Syntax
show operation events override [slot]
CLI-1672
Parameter
Definition
[slot]
Slot number. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show operation mode Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays Upper Level Protocol (ULP) operation mode status.
Syntax
show operation mode
Example
To show the ULP operation mode status, type the following command: C4> show operation mode The following is an example of the output returned by the system:
Enabled : Enabled : Enabled : Disabled : Disabled : instead of Enabled : Enabled : Disabled : Disabled : Disabled : Disabled : Disabled : Disabled : Disabled : Disabled :
Issue 2.0
(dqossf10cms) Allow 1.0 CMs in DocsQosServiceFlowEntry (adjrxpwrctl) Allow adjustment of rx power control by mod type (enbudptcpfltr) Allow combining of Udp and Tcp messages in same filter (upce) Enable Upstream Packet Classification Enforcement (DSPeakTrafficRateTLV2516) Use old MULPI spec (TLV 25.16) for DS Peak Traf Rate new spec (TLV 25.27) (cpeNacksForceCmReset) Force CM reset upon receiving 3 consecutive CPE NACKs (cmstatusoperational) Allow modem status at the CMTS to reach operational(8) (docsis20test) DOCSIS 2.0 Testing (showCmFormatCV) Force alternative output of "show cable modem" (bpiDynamicMulticast) Allow BPI dynamic multicast (docsis10plus) Docsis 1.0+ support (downstreamOverride) Downstream Frequency Override (suppress-dcd) Supression of DCD messages (virtualCm) Allow Virtual cable modems (bpiHybrid) Allow upgraded DOCSIS 1.0 modems to operate using BPI+
ARRIS PROPRIETARY — All Rights Reserved
CLI-1673
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show packetcable cops counts Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays counts of Packetcable COPS connection attempts and messages.
Syntax
show packetcable cops counts
Example
To display the counts, use the following command: C4#
show packetcable cops counts The following is an example of the output returned by the system:
Server cnx/OPN CAT/REQ KA/KA DEC/RPT /DRQ CC/CC SSQ/SSC 10.43.200.226 rx 0 0 165 0 0 0 tx 0 0 165 0 0 0 0 10.43.200.227 rx 0 0 172 5656 0 0 tx 0 0 172 5655 0 0 0 10.43.200.232 rx 0 0 984 0 0 0 tx 0 0 984 0 0 0 0 ---------------------------------------------------------------------------Total rx 0 0 1321 5656 0 0 tx 0 0 1321 5655 0 0 0
CLI-1674
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show packetcable cops servers Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the status of the current Packetcable COPS connections.
Syntax
show packetcable cops servers
Example
To display the status of these servers, use the following command: C4#
show packetcable cops servers The following is an example of the output returned by the system:
Proto
Local Addr
KA Timer _______ _______________ ______________________ _____ PC vI09 10.44.16.200 10.44.240.17.52661 10s PC vI09 10.44.16.200 10.44.249.2.57906 30s MM vI02 10.44.16.3 10.44.249.14.60231 60s MM vI02 10.44.16.200 10.44.249.18.54618 60s MM vI04 10.44.16.200 10.44.249.70.60669 60s
Issue 2.0
Server Addr.Port
PCMM IPSec UpTime PSID ______ _____ __________________ No 6 days 20:08:46 No 6 days 20:08:30 none 6 days 20:08:50 none 6 days 20:08:10 0x0 6 days 20:08:30
ARRIS PROPRIETARY — All Rights Reserved
CLI-1675
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show packetcable gate Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays Packetcable gate information.
Syntax
show packetcable gate [detail]
Parameter
Definition
Enter a 32-bit number in decimal or hex, with a prefix of 0x denoting hex. Valid range is or 0x0-0xFFFFFFFF>
[detail]
Shows detailed gate information.
Example
To show detailed PacketCable gate information, use the following command: C4#
show packetcable gate detail The system response would be similar to:
PCMM Gate-Id (hex):..................................27810003 Gate State:..........................................Authorized Gate State Reason:...................................Other PS-IP:...............................................10.44.249.18 AM-ID (hex):.........................................4 Subscriber-ID:.......................................5.0.1.0 GateSpec Direction..........................................UpStream DSCP ToS Field(hex)................................0 DSCP ToS Mask(hex).................................0 DSCP Overwrite.....................................Disabled Session Class Priority.........................................0 Premption Flag...................................0 Configurable bits................................0 Timer1.............................................0 seconds
CLI-1676
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Timer2.............................................0 seconds Timer3.............................................0 seconds Timer4.............................................0 seconds Traffic Profile Envelope is........................................Authorized Authorized Envelope Schedule Type....................................BE Priority.........................................1 Request Transmission Policy (hex)................1 Max Traffic Rate (bits/sec)......................24000000 Max Traffic Burst (bytes)........................3044 Min Reserved Traffic Rate (bits/sec).............12400 Min Reserved Traffic Rate Packet Size (bytes)....124 Classifier Protocol Id........................................17 (UDP) DSCP ToS Field (hex)...............................0 DSCP ToS Mask (hex)................................0 SourceIP:Port......................................1.1.1.1:0 DestIP:Port........................................2.2.2.2:0 Priority...........................................68 Volume-based usage limit (Kbytes)....................0 Time-based usage limit (seconds).....................0 Opaque data (hex)....................................00
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1677
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show packetcable gate dqos Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays only Packetcable dqos gates.
Syntax
show packetcable gate dqos [detail]
Parameter
First IP address
Second IP address
[detail]
CLI-1678
Definition
Show detailed dqos gate information
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show packetcable gate pcmm Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays only Packetcable pcmm gates.
Syntax
show packetcable gate pcmm [detail]
Parameter
First IP address
Second IP address
[detail]
Issue 2.0
Definition
Show detailed pcmm gate information
ARRIS PROPRIETARY — All Rights Reserved
CLI-1679
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show packetcable gatectl counters Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays only Packetcable DQoS gate control statistics and control message counters.
Syntax
show packetcable gatectl counters
Example
To display the counters, use the following command: C4#
show packetcable gatectl counters The following is an example of the output returned by the system:
Server Gate-Aloc Gate-Set Gate-Info Gate-Del Gate-Open Gate-Close 10.43.200.226 req 0 0 0 0 ack 0 0 0 0 0 0 err 0 0 0 0 10.43.200.227 req 0 1888 1884 1884 ack 0 1886 1884 1884 0 0 err 0 0 0 0 10.43.200.232 req 0 0 0 0 ack 0 0 0 0 0 0 err 0 0 0 0 ------------------------------------------------------------------------------Total 0 3774 3768 3768 0 0
CLI-1680
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show packetcable global Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays system-wide Packetcable settings.
Syntax
show packetcable global
Example
To display the global Packetcable configuration, type the following command: C4>
show packetcable global The following is an example of the output returned by the system: PacketCable DQoS Administrative state: DOWN COPS TCP port: 2126 Timer t0: 30 seconds Timer t1: 250 seconds PacketCable Multimedia Administrative state: DOWN COPS TCP port: 3918 Timer t1: 300 deciseconds Gate Message Throttling: SCM NORMAL max Gate Messages per 10 seconds: 900 SCM YELLOW max Gate Messages per 10 seconds: 900 SCM RED max Gate Messages per 10 seconds: 300 Admission Control Limits: Upstream Priority Reserved Allowed -------- ------Normal 0% 50% Emergency 0% 70% Total 70% Preemption: enabled
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
Downstream Reserved Allowed -------- ------0% 50% 0% 70% 70%
CLI-1681
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Event Messaging Parameters Enabled: no - not configured Element ID: not configured Event messaging UDP source port: 1813 Maximum number of events per batched message: 3 Batch timer: 1 minute ACK timer: 1000 milliseconds Maximum number of retransmissions to RKS: 1
CLI-1682
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show packetcable transactions Default Access Level
Mode
Non-privileged – 0
User EXEC
Purpose
Displays the counts of throttled PC Gate transactions.
Syntax
show packetcable transactions [detail]
Parameter
Definition
[detail]
Displays detailed information.
Example
To display the Packetcable transactions, type the following command: C4>
show packetcable transactions The following is an example of the output returned by the system: Since last command execution: Avg Gate Transaction rate (msg/sec): 0.0 Max Gate Transaction rate (msg/sec): 0 Since system boot maximum Gate Transaction rate (trans/sec): 0
Example
To display Packetcable transactions in detail, type the following command: C4>
show packetcable transactions detail The following is an example of the output returned by the system:
Gate Message Transaction Throttling: SCM NORMAL max Gate Transactions per 10 seconds: 180 SCM YELLOW max Gate Transactions per 10 seconds: 180 SCM RED max Gate Transactions per 10 seconds: 60 Throttle triggering results in temporarily reduced message receive rate.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1683
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Gate transaction throttle triggering per overload condition: NORMAL YELLOW RED Total Gate-Alloc 0 0 0 0 Gate-Set 0 0 0 0 Gate-Info 0 0 0 0 Gate-Delete 0 0 0 0 (total) 0 0 0 0 Since last command execution: Avg. Gate Transaction rate (trans/sec): 11.5 Maximum Gate Transaction rate (trans/sec): 27 Since system boot maximum Gate transaction rate (trans/sec): 51 Rate history for last 30 seconds: (rate of -1 indicates no transaction activity and no update) seconds ago rate (trans/sec) 1 0 2 -1 3 -1 4 -1 5 -1 6 -1 7 -1 8 -1 9 -1 10 -1 11 -1 12 -1 13 -1 14 -1 15 -1 16 -1 17 -1 18 -1 19 -1 20 -1 21 -1 22 -1 23 -1 24 -1 25 -1 26 -1 27 -1 28 -1 29 -1 30 -1
CLI-1684
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show pmd Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays all the pmd files on the system.
Syntax
show pmd
Example
To display all pmd files on the system, type the following command: C4>
show pmd The following is an example of the output returned by the system: /update/dumps size date file -------- ------------------------ -------------------14888 Mon Aug 11 07:29:20 2003 state_20_fst.pmd 30400 Fri Jul 25 05:46:58 2003 state_9_fst.pmd 21184 Fri Aug 15 07:08:20 2003 state_9_lst.pmd /clone/update/dumps size date file -------- ------------------------ -------------------604048 Mon Aug 11 07:29:30 2003 debug_20_fst.pmd 21556 Thu Aug 14 07:20:44 2003 state_19_fst.pmd 29824 Fri Jul 25 07:38:00 2003 state_9_fst.pmd 24076 Fri Aug 15 06:46:02 2003 state_9_lst.pmd
Related Command(s)
clear pmd
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1685
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show port status Default Access Level
Mode
Prompt
Non-privileged – 1
User EXEC
C4>
Purpose
Displays the port level upstream and downstream information on the module in the specified slot. NOTE This command will not report status of spare master ports. It will report only the state of the protected ports.
Syntax
show port status
Parameter
Definition
The chassis slot in which the targeted module resides. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
[/port]
Port value is 0 for the downstream on a Cable Access Module and 0-7 on the upstream ports. The Network Access Module ports are numbered 0, 1, 2, and 3.
Example
If no port is specified, this command returns status of all the ports of all the active slots similar to the following: C4>
show port status The following is an example of the output returned by the system:
Chassis type: C4 Admin Mac State 1 Up 2 Up 3 Up
Slot/Port 3/U0 3/U1
CLI-1686
Oper State IS IS IS
Description md1 md2 md3
MAC
Conn
Admin State
1 1
0 0
Up Up
Oper State IS IS
Logical Channel State 0 1 Adm Oper Adm Oper Up Up
IS IS
Description
Down OOS Down OOS
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
3/U2 3/U3 3/U4 3/U5 3/U6 3/U7 3/U8 3/U9 3/U10 3/U11 3/U12 3/U13 3/U14 3/U15 3/U16 3/U17 3/U18 3/U19 3/U20 3/U21 3/U22 3/U23 14/D0 14/D1 14/D2 14/D3 14/D4 14/D5 14/D6 14/D7 14/D8 14/D9 14/D10 14/D11 Slot/ Port escription 17/0 17/1 17/2 17/3 17/4 17/5 17/6 17/7 17/8 17/9 17/10 19/0
Issue 2.0
1 1 2 2 2 2 3 3 3 3 1 1 1 1 2 2 2 2 3 3 3 3 1 1 1 1 2 2 2 2 3 3 3 3
0 0 2 2 2 2 4 4 4 4 1 1 1 1 3 3 3 3 5 5 5 5 0 0 0 0 1 1 1 1 2 2 2 2
Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up
Admin State
Oper State
Admin Mode
Up Up Up Up Up Up Up Up Up Up Down Up
IS IS OOS OOS IS IS IS IS OOS IS OOS IS
Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto
IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS
Negotiate Negotiate Negotiate Negotiate Negotiate Negotiate Negotiate Negotiate Negotiate Negotiate Negotiate
Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up
IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS
Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down
OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS
Operational Mode
Admin (tx/rx)
Oper (tx/rx)
SFP Full SFP Full Invalid Invalid SFP Full SFP Full SFP Full SFP Full Invalid SFP Full Invalid
des/des des/des des/des des/des des/des des/des des/des des/des des/des des/des des/des
off/on off/off unk/unk unk/unk off/off off/off off/off off/off unk/unk off/off unk/unk
1000-T 100-T
1000-T 1000-T 1000-T 1000-T 1000-T
ARRIS PROPRIETARY — All Rights Reserved
D
CLI-1687
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show port status cmac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays only cable-mac information.
Syntax
show port status cmac
Example
To display the cable-mac information, use the following command: C4>
Mac 1 2 3
CLI-1688
Admin State Up Up Up
show port status cmac
Oper State IS IS IS
Description md1 md2 md3
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show port status cable-mac full Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the port-level information even if the cable-mac association is missing.
Syntax
show port status cable-mac full
Example
To display the port level information for the cable-mac interface in slot 2, use the following command: C4>
Chassis type: C4 Admin Mac State 1 Up 2 Up 3 Up
show port status cable-mac full
Oper State IS IS IS
Description md-1 md-2 md-3
The following is a list of possible port states. Oper State IS
Issue 2.0
Description Port is in service
OOS-MAN
Port out of service — shut down manually
OOS-AUTO
Port is out of service for some reason other than manual: it was not shut down manually
ARRIS PROPRIETARY — All Rights Reserved
CLI-1689
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show port status dcam Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays only cable-downstream port status.
Syntax
show port status dcam
Example
To display the downstream port status, use the following command: C4>
Slot/Port 14/D0 14/D1 14/D2 14/D3 14/D4 14/D5 14/D6 14/D7 14/D8 14/D9 14/D10 14/D11
CLI-1690
show port status dcam
MAC
Conn
1 1 1 1 2 2 2 2 3 3 3 3
0 0 0 0 1 1 1 1 2 2 2 2
Admin Oper State State Up Up Up Up Up Up Up Up Up Up Up Up
Logical Channel State 0 1 Adm Oper Adm Oper Description
IS IS IS IS IS IS IS IS IS IS IS IS
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show port status network Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays only the network information.
Syntax
show port status network
Example
To display the network information, use the following command: C4>
Slot/ Port 17/0 17/1 17/2 17/3 17/4 17/5 17/6 17/7 17/8 17/9 17/10 19/0
Issue 2.0
Admin State Up Up Up Up Up Up Up Up Up Up Down Up
Oper State IS IS OOS OOS IS IS IS IS OOS IS OOS IS
show port status network
Admin Mode Auto Negotiate Auto Negotiate Auto Negotiate Auto Negotiate Auto Negotiate Auto Negotiate Auto Negotiate Auto Negotiate Auto Negotiate Auto Negotiate Auto Negotiate
Operational Mode SFP Full 1000-T SFP Full 100-T Invalid Invalid SFP Full 1000-T SFP Full 1000-T SFP Full 1000-T SFP Full 1000-T Invalid SFP Full 1000-T Invalid
Admin (tx/rx) des/des des/des des/des des/des des/des des/des des/des des/des des/des des/des des/des
ARRIS PROPRIETARY — All Rights Reserved
Oper (tx/rx) Description off/on off/off unk/unk unk/unk off/off off/off off/off off/off unk/unk off/off unk/unk
CLI-1691
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show port status umac Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays only cable-upstream information.
Syntax
show port status umac
Example
To display the cable-upstream information, use the following command:
Slot/Port 3/U0 3/U1 3/U2 3/U3 3/U4 3/U5 3/U6 3/U7 3/U8 3/U9 3/U10 3/U11 3/U12 3/U13 3/U14 3/U15 3/U16 3/U17 3/U18 3/U19 3/U20 3/U21 3/U22 3/U23
CLI-1692
C4>
show port status umac
MAC
Conn
Admin State
Oper State
1 1 1 1 2 2 2 2 3 3 3 3 1 1 1 1 2 2 2 2 3 3 3 3
0 0 0 0 2 2 2 2 4 4 4 4 1 1 1 1 3 3 3 3 5 5 5 5
Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up
IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS
Logical Channel State 0 1 Adm Oper Adm Oper Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up
IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS IS
Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down
Description
OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS OOS
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show port transceiver Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the data for the SFP and XFP plugged into the RCM.
Syntax
show port transceiver
Example
To display the port level information for the cable-mac interface in slot 2, use the following command: C4>
slot/port: 17/10 tType : type : vendor : partNumber : revision : serialNumber : dateCode : slot/port: 18/10 tType : type : vendor : partNumber : revision : serialNumber : dateCode :
Issue 2.0
show port transceiver
XFP XFP-SR FINISAR CORP. FTLX8511D3 00 A8C02SP 080924 XFP XFP-SR FINISAR CORP. FTLX8511D3 00 A7F042Q 080813
ARRIS PROPRIETARY — All Rights Reserved
CLI-1693
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show privilege Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the user’s privilege level.
Syntax
show privilege
Example
To show your current privilege level, type the following command: C4>
show privilege The following output is an example of the type of information returned by the system if you only have access to user commands: Current privilege level is 0 If you had privileged access, the system would respond as follows: Current privilege level is 15
Related Command(s)
show logging priority cli configure line enable
CLI-1694
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show privilege exec Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the privilege level of all the commands in the command tree. If a specific command (optional) is entered, only the privilege level for that command will be displayed. NOTE Only commands that have access levels less than or equal to the current CLI access level will be displayed. For example if your CLI access level is 5, then only those command nodes that have levels of 5 or lower will be displayed.
Syntax
show privilege exec []
Parameter
Definition
[]
Example
The command whose privilege level you want to check.
To show the privilege level for all commands, type the following command: C4>
Example
show privilege exec To show the privilege level for the command show audit, type the following command:
C4>
show privilege exec show audit The following is an example of the output returned by the system: Current privilege level for ‘show audit’is 0
Related Command(s)
show logging priority cli configure line configure privilege exec level configure privilege exec reset
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1695
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show processes Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays CPU utilization statistics.
Syntax
show processes [slot ] [summary]
Parameter
Definition
[slot ]
The chassis slot in which the targeted module resides. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
[summary]
Displays cumulative CPU usage% totals per slot.
Example
To show CPU utilization statistics, type the following command: C4#
show processes The following is an example of the output returned by the system:
Total Percent Idle Time = 98.4 Name Pri Total CPU Time IDLE 255 40521.667159 TickTmr0 2 76.505744 OAMP 78 75.949445 tAtaSvc0 74 65.571785 COMM 70 56.788896 SNMP 84 41.511951 PONG 220 38.880810 IpdrExport 224 34.226715 CMTC 3 28.861399 ipnetd 50 27.456766 SMTC 1 25.800793 PCRcv 72 20.316759 APPL 77 18.911882 tNetTask 50 18.509741 Cli0a2b053 81 10.359872 iNtpd 83 10.180001 DEM 6 9.680362 IpdrContro 219 9.045612 IpdrPlatfo 218 8.741623
CLI-1696
Recent Percent Idle Time = 98.0 Recent CPU TIME PctTime Total Switches 40521.667159 97.9 3163814 76.505744 0.1 2211251 75.949445 0.1 791246 65.571785 0.1 112244 56.788896 0.1 332328 41.511951 0.1 260131 38.880810 0.0 1394347 34.226715 0.0 823117 28.861399 0.0 223534 27.456766 0.0 496621 25.800793 0.0 268480 20.316759 0.0 584059 18.911882 0.0 200578 18.509741 0.0 731060 10.359872 0.0 124042 10.180001 0.0 74126 9.680362 0.0 187202 9.045612 0.0 104162 8.741623 0.0 147757
ARRIS PROPRIETARY — All Rights Reserved
Switches 3163814 2211251 791246 112244 332328 260131 1394347 823117 223534 496621 268480 584059 200578 731060 124042 74126 187202 104162 147757
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
tNfsd0 BGRD iC4RtpAppl CONSOLE DUTL tXbdServic AUDT DPOLL RHND tappKrnlLd tExcTask tNfsd NOTD EvMsgSocke pwrmon tTelnetOut tTelnetIn_ tErfTask tTelnetd AUDS tShellServ tNfsdClose PCMain PCLowPri ntpMgr tJobTask tMountd TODC tPortmapd LRQS BRKR LDRS tFtp6d authServer FQDNPoller tCciTask APPSYSLOG rshd3919 iptftps ipcom_teln ScmIpRoute CDMON ipcom_sysl SEM trtpDbgMon LLSUPR tPcmciad tLogTask tNbioLog tAioWait tAioIoTask tAioIoTask
Issue 2.0
220 222 1 81 84 74 162 221 221 150 0 215 163 72 200 55 55 10 55 162 59 254 75 79 83 0 55 83 54 80 74 221 60 81 227 125 163 81 50 50 75 70 50 7 0 227 2 0 0 51 50 50
5.607895 5.033081 4.218792 3.736516 3.382390 3.341387 2.702273 2.378633 2.092020 1.792501 1.213419 1.102741 1.087229 0.642616 0.637003 0.505798 0.157871 0.148456 0.138700 0.095499 0.079290 0.065669 0.041792 0.040569 0.039543 0.035832 0.019748 0.010156 0.008790 0.006517 0.003640 0.003043 0.001331 0.000895 0.000665 0.000593 0.000497 0.000466 0.000412 0.000295 0.000264 0.000113 0.000081 0.000026 0.000026 0.000016 0.000013 0.000000 0.000000 0.000000 0.000000 0.000000
5.607895 5.033081 4.218792 3.736516 3.382390 3.341387 2.702273 2.378633 2.092020 1.792501 1.213419 1.102741 1.087229 0.642616 0.637003 0.505798 0.157871 0.148456 0.138700 0.095499 0.079290 0.065669 0.041792 0.040569 0.039543 0.035832 0.019748 0.010156 0.008790 0.006517 0.003640 0.003043 0.001331 0.000895 0.000665 0.000593 0.000497 0.000466 0.000412 0.000295 0.000264 0.000113 0.000081 0.000026 0.000026 0.000016 0.000013 0.000000 0.000000 0.000000 0.000000 0.000000
0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0
ARRIS PROPRIETARY — All Rights Reserved
21133 24091 95 42162 41480 53555 46512 84364 9950 796 44518 5605 10012 8162 5531 14419 3529 567 390 914 1 4121 726 700 44 346 48 76 51 158 53 30 2 3 16 3 6 2 3 2 2 1 1 1 1 1 1 0 0 0 0 0
21133 24091 95 42162 41480 53555 46512 84364 9950 796 44518 5605 10012 8162 5531 14419 3529 567 390 914 1 4121 726 700 44 346 48 76 51 158 53 30 2 3 16 3 6 2 3 2 2 1 1 1 1 1 1 0 0 0 0 0
CLI-1697
CLI Command Descriptions
tWdbTask tWdbProxyT
3 55
C4/C4c CMTS Rel. 8.0.7
0.000000 0.000000
Example
0.000000 0.000000
0.0 0.0
0 0
0 0
To show cumulative CPU usage percent totals per slot, use the following command: C4#
show processes summary The following is an example of the output returned by the system:
Slot Description 3 14 17 19
CAM CAM RCM SCM
(0D, 24U) (16D, 0U) A A
CLI-1698
Admin State Up Up Up Up
Oper State IS IS IS IS
CPU% Util 36 3 2 2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show proto-throttle-rate Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the current protocol throttle rates and the number of packets.
Syntax
show proto-throttle-rate
Example
By typing the following command: C4#
show proto-throttle-rate The following is an example of the output returned by the system: Protocol Throttle Rates ----------------------RCM global packet rate: ARP packet rate: DHCP packet rate: ICMP packet rate: IGMP packet rate: OSPF packet rate: RIP packet rate: SNMP packet rate: RCM other packet rate: SCM global packet rate:
2500 2500 750 500 500 750 500 100 500 900
packets/second packets/second packets/second packets/second packets/second packets/second packets/second packets/second packets/second packets/second
Protocol Received Counts -----------------------RCM global packets passed: RCM global packets dropped: ARP packets passed: ARP packets dropped: DHCP packets passed: DHCP packets dropped: ICMP packets passed: ICMP packets dropped: IGMP packets passed:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
235 0 143 0 92 0 0 0 0
packets packets packets packets packets packets packets packets packets
CLI-1699
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
IGMP packets dropped: OSPF packets passed: OSPF packets dropped: RIP packets passed: RIP packets dropped: SNMP packets passed: SNMP packets dropped: RCM other packets passed: RCM other packets dropped: Protocol Sent Counts -------------------RCM global packets: ARP packets: DHCP packets: ICMP packets: IGMP packets: OSPF packets: RIP packets: SNMP packets: RCM other packets:
CLI-1700
ARRIS PROPRIETARY — All Rights Reserved
0 0 0 0 0 0 0 0 0
packets packets packets packets packets packets packets packets packets
318 226 92 0 0 0 0 0 0
packets packets packets packets packets packets packets packets packets
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show qos-sc Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Quality-Of-Service (QoS) class information.
Syntax
show qos-sc [name ]
Parameter
Definition
[name ]
Example
QoS service class name.
To show the QoS class information, type the following command: C4> show qos-sc name SCNA The following is an example of the output returned by the system:
QOS Service Class Name: Relative Service Flow Priority: Max Sustained Traffic Rate (bits/sec): Max Traffic Burst (bytes): Min Reserved Rate (bits/sec): Min Reserved Packet Size (bytes): Max Concat Burst for US flow (bytes): Nominal Poll Interval (microseconds): Poll Jitter (microseconds): Unsolicited Grant Size (bytes): Nominal Grant Interval (microseconds): Grant Jitter (microseconds): Data Grants Per Nominal Grant Interval: Max Latency for DS flows (microseconds): Active Timeout (seconds): Admitted Timeout (seconds): Upstream Scheduling Service: Interface Direction:
Issue 2.0
SCNA 0 500000 3044 0 0 0 0 0 0 0 0 0 0 0 200 Best Effort Upstream
ARRIS PROPRIETARY — All Rights Reserved
CLI-1701
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show reload-status Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the reload status.
Syntax
show reload-status
CLI-1702
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show route-map Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the route map
Syntax
show route-map [detail]
Parameter
Issue 2.0
Definition
Name of a specific route map.
[detail]
Display the number of times a route map entry has been matched
ARRIS PROPRIETARY — All Rights Reserved
CLI-1703
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show route-map-policy Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the Policy Route Maps.
Syntax
show route-map-policy
CLI-1704
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show running-config Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the writable (configurable) MIB data that is saved in the C4 CMTS persistent memory. These commands may be used to enable or disable system features and set each feature’s operational parameters.
Syntax
show running-config [full] [interface] [linenumber] [verbose]
]
Parameter
Definition
[full]
Displays all configuration values, including default values.
[interface]
Displays the parameters for the specified interface.
[linenum]
Enumerates each line with its line number in the output.
[verbose]
Displays the output with ‘configure’ on each line.
Example
To show the configurable data that is saved in persistent memory, type the following command: C4#
show running-config
NOTE This command generates extensive output. If printed, the results of this command could fill well over fifty pages of text for a fully populated chassis.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1705
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show running-config interface cable-downstream Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
The show running-config interface command shows the parameters for the specified downstream cable interface.
Syntax
show running-config interface cable-downstream / [linenumber] [verbose] [full]
Parameter
Definition
The chassis slot in which the targeted CAM module resides. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
The downstream port.
[linenum]
Enumerates each line with its line number in the output.
[verbose]
Displays the output with ‘configure’ on each line.
[full]
CLI-1706
Displays all configuration values, including default values.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show running-config interface cable-mac Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the parameters for the cable-mac interface specified.
Syntax
show running-config interface cable-mac [verbose] [linenum] [full]
Parameter
[linenum]
Enumerates each line with its line number in the output.
[verbose]
Displays the output with ‘configure’ on each line.
[full]
Issue 2.0
Definition
Displays all configuration values, including default values. The MAC identifier. Valid numbers are 0-415.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1707
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show running-config interface cable-upstream Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
The show running-config interface command shows the parameters for the specified upstream cable. interface.
Syntax
show running-config interface cable-upstream / [linenumber] [verbose] [full]
Parameter
Definition
The chassis slot in which the targeted CAM module resides. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
The upstream port.
[linenum]
Enumerates each line with its line number in the output.
[verbose]
Displays the output with ‘configure’ on each line.
[full]
CLI-1708
Displays all configuration values, including default values.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show running-config interface ethernet Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
The show running-config interface command shows the parameters for the specified System Controller ethernet interface.
Syntax
show running-config interface ethernet /0 [linenumber] [verbose] [full]
Parameter
Definition
/0
The chassis slot number of the System Controller Module. Valid range for the C4 CMTS is 19-20; valid range for the C4c CMTS is 19. The only valid port value is 0 (zero).
[linenum]
Enumerates each line with its line number in the output.
[verbose]
Displays the output with ‘configure’ on each line.
[full]
Displays all configuration values, including default values.
Example
To show the configurable data that is saved in persistent memory, type the following command: C4#
Issue 2.0
show running-config interface ethernet 19/0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1709
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show running-config interface gigabitethernet Default Access Level
Mode
Prompt
Privileged – 15
Privileged EXEC
C4#
Purpose
The show running-config interface command shows the parameters for the specified GigEthernet interface.
Syntax
show running-config interface gigabitethernet / [linenumber] [verbose] [full] Parameter
Definition
RCM slot number/gigabitEthernet port number. The slot must contain an RCM. /
Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[linenum]
Enumerates each line with its line number in the output.
[verbose]
Displays the output with ‘configure’ on each line.
[full]
Displays all configuration values, including default values.
Example
To show the configurable data that is saved in persistent memory, type the following command: C4#
show running-config gigabitethernet 17/0 The following is an example of the output returned by the system:
configure interface GigEthernet 17/0 description VLAN 625 no shutdown exit interface GigEthernet 17/0.0 ip address 10.58.64.2 255.255.255.192 ip scm access-group 1 exit end
CLI-1710
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show running-config interface loopback Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
The show running-config interface command shows the parameters for the specified loopback interface.
Syntax
show running-config interface loopback [linenumber] [verbose] [full]
Parameter
The loopback interface number. Valid range is 0-15.
[linenum]
Enumerates each line with its line number in the output.
[verbose]
Displays the output with ‘configure’ on each line.
[full]
Issue 2.0
Definition
Displays all configuration values, including default values.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1711
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show running-config interface tengigabitethernet Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
The show running-config interface command shows the parameters for the specified Ten Gigabit Ethernet interface.
Syntax
show running-config interface tengigabitethernet / [linenumber] [verbose] [full]
Parameter
/
Definition
The slot in which the targeted module resides. The slot must contain an RCM. Valid range for the C4 CMTS is / Valid range for the C4c CMTS is /
[linenum]
Enumerates each line with its line number in the output.
[verbose]
Displays the output with ‘configure’ on each line.
[full]
CLI-1712
Displays all configuration values, including default values.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show session-timeout Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the telnet session timeout in minutes.
Syntax
show session-timeout
Example
To display the telnet session timeout in minutes, type the following command: C4>
show session-timeout The following is an example of the output returned by the system: Idle timeout for this session is 1000 minutes, 0 seconds Absolute timeout has been disabled for this session
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1713
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show shelfname Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the shelf name.
Syntax
show shelfname
Example
To display the current shelf name, type the following command: C4>
show shelfname The following is an example of the output returned by the system: Shelf name is C4 CMTS
CLI-1714
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show snmp community Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the SNMP community information
Syntax
show snmp community
Example
To display the SNMP community information, type the following command: C4>
show snmp community The following is an example of the output returned by the system: Community Index private public
Issue 2.0
Community Name private public
ARRIS PROPRIETARY — All Rights Reserved
Community Security Name rwtesting rotesting
CLI-1715
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show snmp contact Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays system contact information.
Syntax
show snmp contact
Example
To display the SNMP contact information, type the following command: C4>
show snmp contact The following is an example of the output returned by the system: Contact
[email protected] NOTE If no contact information has been configured or the contact information has been cleared, the system would respond: No contact info set. Use “configure snmp-server contact” to set this information.
Related Command(s)
configure snmp-server contact
CLI-1716
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show snmp engineboots Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays information about the number of SNMP engine reboots.
Syntax
show snmp engineboots
Example
To display the number of SNMP engine reboots, type the following command: C4#
show snmp engineboots The following is an example of the output returned by the system: The number of reboot of the SNMP engine is 18
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1717
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show snmp engineid Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays information about the local SNMP engine.
Syntax
show snmp engineid
Example
To display the local SNMP engine ID, type the following command: C4#
show snmp engineid The following is an example of the output returned by the system: The SNMP engine id is: 80 00 13 86 03 00 01 5c 11 ca be
CLI-1718
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show snmp group Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays information about SNMPv3 groups.
Syntax
show snmp group
Example
To display information about SNMPv3 groups, type the following command: C4#
show snmp group The following is an example of the output returned by the system:
Group Name
Vers Auth
initial
v3
noauth docsisManagerView docsisManagerView docsisManagerView
rotesting
v1
noauth docsisManagerView
docsisManagerView
rotesting
v2c
noauth docsisManagerView
docsisManagerView
rwtesting
v1
noauth docsisManagerView docsisManagerView
rwtesting
v2c
noauth docsisManagerView docsisManagerView
AuthPrivMD5User
v3
priv
docsisManagerView docsisManagerView docsisManagerView
AuthPrivSHAUser
v3
priv
docsisManagerView docsisManagerView docsisManagerView
noAuthNoPrivUser
v3
noauth docsisManagerView docsisManagerView docsisManagerView
AuthNoPrivMD5User
v3
auth
docsisManagerView docsisManagerView docsisManagerView
AuthNoPrivSHAUser
v3
auth
docsisManagerView docsisManagerView docsisManagerView
Issue 2.0
Read View
Write View
Notify View
ARRIS PROPRIETARY — All Rights Reserved
CLI-1719
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show snmp location Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the system location, or sysLocation string.
Syntax
show snmp location
Example
To display the system location, type the following command: show snmp location The following is an example of the output returned by the system: System location is Lisle, IL
CLI-1720
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show snmp user Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the list of current SNMPv3 users.
Syntax
show snmp user
Example
To display the list of current SNMPv3 users, type the following command: C4#
show snmp user The following is an example of the output returned by the system:
SNMP Engine 80 00 13 86 80 00 13 86 80 00 13 86 80 00 13 86 80 00 13 86
Issue 2.0
Id 03 03 03 03 03
00 00 00 00 00
01 01 01 01 01
5c 5c 5c 5c 5c
00 00 00 00 00
03 03 03 03 03
c0 c0 c0 c0 c0
User Name AuthPrivMD5User AuthPrivSHAUser noAuthNoPrivUser AuthNoPrivMD5User AuthNoPrivSHAUser
User Security Name AuthPrivMD5User AuthPrivSHAUser noAuthNoPrivUser AuthNoPrivMD5User AuthNoPrivSHAUser
ARRIS PROPRIETARY — All Rights Reserved
CLI-1721
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show snmp view Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the SNMPv3 views.
Syntax
show snmp view
Example
To display the SNMPv3 views, type the following command: C4#
show snmp view The following is an example of the output returned by the system: View Name docsisManagerView docsisManagerView
CLI-1722
Subtree Type 1.2.826.0.1.1578918included 1.3.6.1 included
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show spare-group Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the sparing groups.
Syntax
show spare-group
Example
To display a list of configured spare-groups, type the following command; C4>
show spare-group The following is an example of the output returned by the C4 CMTS system: Slot 4 5 6
Leader Slot 4 4 4
Mode auto
If no spare groups have been set up, the system would respond: There are no sparing groups defined
Related Command(s)
show linecard status
NOTE The C4c CMTS does not support CAM sparing.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1723
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show ssh host public-key dsa Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the SSH server’s host public key.
Syntax
show host public-key dsa
Example
To display the SSH server’s host public key, type the following command C4#
show ssh host public-key dsa The following is an example of the output returned by the system:
BE74191136BD9BE4E73242FE90E7EC1680E5237432A16CD5F0C23D2D1875134FF2BF884EFD909DBAC B62A36CD0CAC45142E63A9B71D21BA20DD7080E CDD4A76F4303B418D2FEBEC827155D798D0313447DEE33D133ECF4B2778842145F62001C46D226AA5 67A37CEDA83E2087E00AA9B25BBA57646ACF259 8107B6EEB9DB81AD
CLI-1724
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show startup-config Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the current operating configuration written to memory.
Syntax
show startup-config [linenum]
Parameter
[linenum]
Issue 2.0
Definition
Enumerates each line with its line number in the output.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1725
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show tacacs Default Access Level
Mode
Non-privileged –10
User EXEC
Purpose
Displays all configured TACACS+ server groups, the members of each group, and the operational parameters of each group member. If the detail keyword is added, then utilization and performance measurements are also displayed for each TACACS+ server.
Syntax
show tacacs [detail]
Parameter
Definition
[detail]
Show TACACS+ information in detail
Example
To display all configured TACACS+ server groups and members of each group, type the following command; C4>
show tacacs The following is an example of the output returned by the system:
TACACS+ Groups... Group Name ---------------------------------------------------------------amen tac_default TACACS+ Hosts... IP Address Port Timeout (secs) --------------- ---- ------10.44.0.18 49 5 Example
Multiplexing Over Index Single TCP Conn ----------------- ----No 1
To display the TACACS+ server group information along with utilization and performance measurements, type the following command; C4>
CLI-1726
IP Address --------------10.44.0.18 10.44.0.18
show tacacs detail
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
The following is an example of the output returned by the system: TACACS+ Groups... Group Name ---------------------------------------------------------------amen tac_default TACACS+ Hosts... IP Address Port Timeout (secs) --------------- ---- ------10.44.0.18 49 5
Multiplexing Over Index Single TCP Conn ----------------- ----No 1
TACACS+ Details... TACACS+ Server = Authentication Login Requests = Authentication Enable Requests = Authentication Pass Responses = Authentication Fail Responses = Authentication Get Data Responses = Authentication Get User Responses = Authentication Get Pass Responses = Authentication Restart Responses = Authentication Error Responses = Authentication Follow Responses = Authorization Requests = Authorization Pass Add Responses = Authorization Pass Reply Responses= Authorization Fail Responses = Authorization Error Responses = Authorization Follow Responses = Accounting Start Requests = Accounting Stop Requests = Accounting Success Responses = Accounting Error Responses = Accounting Follow Responses = Malformed Packets = Invalid Message Types = Invalid Sequence Numbers = Invalid Session Ids = Server Unreachables =
Issue 2.0
IP Address --------------10.44.0.18 10.44.0.18
10.44.0.18 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1727
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show tacacs groups Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the TACACS+ server group information.
Syntax
show tacacs groups
Example
To show the TACACS+ server group information, type the following command; C4>
show tacacs groups The following is an example of the output returned by the system:
Group Name ---------------------------------------------------------------amen tac_default
CLI-1728
ARRIS PROPRIETARY — All Rights Reserved
IP Address --------------10.44.0.18 10.44.0.18
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show tacacs hosts Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the TACACS+ server host information.
Syntax
show tacacs hosts
Example
To show the TACACS+ server host information, type the following command; C4>
show tacacs hosts The following is an example of the output returned by the system:
IP Address
Port Timeout (secs) --------------- ---- ------10.44.0.18 49 5
Issue 2.0
Multiplexing Over Index Single TCP Conn ----------------- ----No 1
ARRIS PROPRIETARY — All Rights Reserved
CLI-1729
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show tech-support Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Displays the system information for technical support. NOTE This command generates extensive output.
Syntax
show tech-support
CLI-1730
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show temperature Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the temperature of each equipped chassis slot. The temperature is monitored at approximately 90-second intervals. If the temperature of a front module falls below or rises above its operating range, a card TempOutOfRangeNotification SNMP trap is generated. See Table CLI-14 below. If the temperature continues to rise to the module’s thermal limit, the card is powered down and a card TempOverHeatNotification SNMP trap is generated. Use the optional slot parameter if you need the status of a specific module.
Table CLI-14: Module Temperature Operating Ranges in Degrees Celsius 12U/24U CAM
XD CAM
RCM
SCM2
SCM3
Card Overheated Threshold — Card Resets
100
90
90
80
80
High Temp Out of Range Notification
75
75
75
65
70
Low Temp Out of Range Notification
0
0
0
0
0
Syntax
show temperature [slot ] Parameter
Definition
[slot ]
The chassis slot in which the targeted module resides. Valid range for the C4 CMTS is 0-20; valid range for the C4c CMTS is 10-15, 17, and 19.
Example
To see the temperature of all modules in the system, type the following command: C4>
Slot ---0 1 2 14
Description ------------CAM (0D, 12U) CAM (0D, 12U) CAM (0D, 24U) CAM (16D, 0U)
Issue 2.0
show temperature
HW Version --------------CAM-01122W/K03 CAM-01122W/F09 CAM-01240W/C05 CAM-20032W/G02
Temperature -----------37 C ( 98 F) 47 C (116 F) 35 C ( 95 F) 33 C ( 91 F)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1731
CLI Command Descriptions
15 17 18 19 20
CAM RCM RCM SCM SCM
(16D, 0U) A B A B
C4/C4c CMTS Rel. 8.0.7
CAM-20016W/E02 RCM-01000W/D03 RCM-01000W/E02 SCM-00440W/G05 SCM-02440W/B02
38 41 44 29 28
C C C C C
(100 (105 (111 ( 84 ( 82
F) F) F) F) F)
To see the temperature of the Cable Access Module in slot 14 only, type the following command: C4>
show temperature slot 14 The following is an example of the output returned by the system:
Slot ---14
Description ------------CAM (16D, 0U)
CLI-1732
HW Version --------------CAM-20032W/G02
Temperature -----------33 C ( 91 F)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show terminal Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the characteristics of the current session.
Syntax
show terminal
Example
To display the current session information, type the following command: C4>
show terminal Following is an example of the output returned by the system: vty 0 Height = 44 Width = 120
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1733
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show tod Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays the Time-Of-Day services information.
Syntax
show tod
Example
To display the TOD information, type the following command: C4>
show tod Following is an example of the output returned by the system: TOD Server IP Address: 0.0.0.0 connection type: udp
CLI-1734
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show users Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Lists all CLI sessions along with the IP address of the originating hosts.
Syntax
show users
Example
To display all open CLI sessions along with their iP addresses, type the following command: C4>
show users The following is an example of the output returned by the system: Tty Line User
Issue 2.0
IP Address
Login Time
Privilege Level
2
vty 0 c4
10.43.6.54
Fri Dec 2 19:38:48 2011 15 (Privileged)
*3
vty 1 c4
10.43.5.55
Fri Dec 2 17:22:42 2011 15 (Privileged)
4
vty 2 c4
10.43.5.61
Fri Dec 2 18:47:41 2011 15 (Privileged)
5
vty 3 c4
10.43.6.99
Fri Dec 2 19:44:42 2011 15 (Privileged)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1735
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
show version Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Displays software and hardware version information for every module in the chassis.
Syntax
show version [detail] []
NOTE You may use either the show version or show version detail command to view system information.
Parameter
Definition
[detail]
Displays FPGA version information
[ | ]
Example
The following is an example of the output returned by the system: C4>
Chassis Type: C4 Slot Description 0 CAM (0D, 12U) 1 CAM (0D, 12U) 2 CAM (0D, 24U) 14 CAM (16D, 0U) 15 CAM (16D, 0U) 17 RCM A 18 RCM B 19 SCM A 20 SCM B
CLI-1736
Displays boot or card version
show version
HW Version CAM-01122W/K03 CAM-01122W/F09 CAM-01240W/C05 CAM-20032W/G02 CAM-20016W/E02 RCM-01000W/D03 RCM-01000W/E02 SCM-00440W/G05 SCM-02440W/B02
Software Version CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130
Uptime 16 days 2:51:05 16 days 2:51:05 2 days 20:31:25 16 days 2:54:14 16 days 2:54:14 16 days 2:54:13 16 days 2:54:13 16 days 2:56:42 16 days 2:56:42
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Example
To display the boot version information, use the following command: C4>
show version boot The following is an example of the output returned by a C4 CMTS system:
Chassis Type: C4 Slot Description 0 CAM (0D, 12U) 1 CAM (0D, 12U) 2 CAM (0D, 24U) 14 CAM (16D, 0U) 15 CAM (16D, 0U) 17 RCM A 18 RCM B 19 SCM A 20 SCM B
HW Version CAM-01122W/K03 CAM-01122W/F09 CAM-01240W/C05 CAM-20032W/G02 CAM-20016W/E02 RCM-01000W/D03 RCM-01000W/E02 SCM-00440W/G05 SCM-02440W/B02
Example
Software Version CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130 CMTS_V08.00.00.130
Boot Version CMTS_BOOT1_V00.08.52 CMTS_BOOT1_V00.08.52 CMTS_V08.00.00.130 CMTS_BOOT1_V00.07.09 CMTS_BOOT1_V00.07.09 CMTS_BOOT1_V00.07.09 CMTS_BOOT1_V00.07.09 CMTS_BOOT1_V00.09.62 CMTS_BOOT1_V00.09.62
Uptime 16 days 2:54:57 16 days 2:54:57 2 days 20:35:17 16 days 2:58:06 16 days 2:58:06 16 days 2:58:04 16 days 2:58:04 16 days 3:00:33 16 days 3:00:34
To display the software and hardware version information for the entire system, type the following command: C4>
show version detail The following is an example of the output returned by a C4 CMTS system:
Chassis Type: C4 Time since the CMTS was last booted: 16 days, Slot: 0 Type: CAM Model Number: CAM-01122W Model Version: K03 Serial Number: 06492CMD0352 Agile Revision: AC Man Deviation: Mezz Model Number: ARCT00232 Mezz Model Version: J02 Mezz Agile Revision: Mezz Man Deviation: CPU Type: PPC 750GX (1.2) CPU Speed: 798 MHz Bus Speed: 133.120 MHz RAM Size: 512 MB Flash Size: 8 MB CPLD Versions: SV26 SS31 BS13 MS14 PIC Version: PICC-61081W/C03
Issue 2.0
2:58:57 (hr:min:sec)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1737
CLI Command Descriptions
PIC Serial Number: PIC Agile Revision: PIC Man Deviation: FPGA Versions:
Boot Versions:
Last Boot Version: Reason Last Booted: Software Version: Uptime: Slot: 1 Type: Model Number: Model Version: Serial Number: Agile Revision: Man Deviation: Mezz Model Number: Mezz Model Version: Mezz Agile Revision: Mezz Man Deviation: CPU Type: CPU Speed: Bus Speed: RAM Size: Flash Size: CPLD Versions: PIC Version: PIC Serial Number: PIC Agile Revision: PIC Man Deviation: FPGA Versions:
Boot Versions:
CLI-1738
C4/C4c CMTS Rel. 8.0.7
EEPROM PIC_PARM2_BLK Read Error
locofoco = 21.00.44 hermes = 21.00.75 muss0 = 02.07 muss1 = 04.07 boot0 = CMTS_BOOT0_V00.00.80 boot1 = CMTS_BOOT1_V00.08.52 boot2 = CMTS_BOOT1_V00.08.52 CMTS_BOOT1_V00.08.52 [2] Coldstart Reset CMTS_V08.00.00.130 16 days 2:53:21 CAM CAM-01122W F09 06032CMD0232 AT ARCT00232 F01
PPC 750GX (1.1) 798 MHz 133.120 MHz 512 MB 8 MB SV25 SS25 BS13 MS11 ÿÿÿÿÿÿÿ/ÿÿ EEPROM PIC_PARM2_BLK Read Error
locofoco hermes muss0 muss1 boot0 boot1
= = = = = =
21.00.44 21.00.75 02.07 04.07 CMTS_BOOT0_V00.00.80 CMTS_BOOT1_V00.08.52
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Last Boot Version: Reason Last Booted: Software Version: Uptime: Slot: 2 Type: Model Number: Model Version: Serial Number: Agile Revision: Man Deviation: CPU Type: CPU Speed: Bus Speed: RAM Size: Flash Size: CPLD Versions: PIC Version: PIC Serial Number: PIC Agile Revision: PIC Man Deviation: FPGA Versions:
boot2 = CMTS_BOOT1_V00.08.52 CMTS_BOOT1_V00.08.52 [2] Coldstart Reset CMTS_V08.00.00.130 16 days 2:53:21 CAM CAM-01240W C05 11353CTU0006 AA MPC8641 rev: 3.0 1500 MHz 600. 0 MHz 2048 MB 128 MB SV16 AA16 BB16 CC16 DD02 PICC-01081W/F02 02181RDE0022
locofoco = 50.02.16 sven24 = 01.01.04 adm1166-0 = 01.11.03 adm1166-1 = 01.22.03 adm1166-2 = 01.33.03 adm1166-3 = 01.44.03 bcm3142-0_mips = 00.05.11 bcm3142-1_mips = 00.05.11 bcm3216-fpga = 19.07 bcm3216-mcpu = 01.00.03 bcm3216-scpu = 01.00.02 Boot Versions: boot0 = CMTS_BOOT0_V00.20.06 boot1 = CMTS_V08.00.00.130, built on Fri Nov 4 18;08;21 Central Daylight Time 2011 boot2 = CMTS_V08.00.00.130, built on Fri Nov 4 18;08;21 Central Daylight Time 2011 Last Boot Version: CMTS_V08.00.00.130, built on Fri Nov 4 18;08;21 Central Daylight Time 2011 [1] Reason Last Booted: Card Insert Reset
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1739
CLI Command Descriptions
Software Version: Uptime: Slot: 14 Type: Model Number: Model Version: Upgrade Version: Serial Number: Agile Revision: Man Deviation: DMM Model Number: DMM Model Version: DMM Serial Number: DMM Agile Revision: DMM Man Deviation: CPU Type: CPU Speed: Bus Speed: RAM Size: Flash Size: CPLD Versions: PIC Version: PIC Serial Number: PIC Agile Revision: PIC Man Deviation: FPGA Versions:
Boot Versions:
Last Boot Version: Reason Last Booted: Software Version: Uptime: Slot: 15 Type:
CLI-1740
C4/C4c CMTS Rel. 8.0.7
CMTS_V08.00.00.130 2 days 20:33:41 CAM CAM-20032W G02 1.1 08283CSD0166 AD DMM-00016W D03 08273DMM0098 AD BCM1480[B1] 800 MHz 400. 0 MHz 2048 MB 16 MB PICC-02004W/C03 08224RSP0118
atlas = 04.00.26 rfmuc = 04.01.18 mcc = 00.03.00.01 cc0 = 00.00.02.00 cc1 = 00.00.02.00 sven = 01.00.06.00 adm1066 = 00.42.52 boot0 = CMTS_BOOT0_V00.03.13 boot1 = CMTS_BOOT1_V00.07.09 boot2 = CMTS_BOOT1_V00.07.09 CMTS_BOOT1_V00.07.09 [1] Coldstart Reset CMTS_V08.00.00.130 16 days 2:56:30 CAM
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Model Number: Model Version: Upgrade Version: Serial Number: Agile Revision: Man Deviation: DMM Model Number: DMM Model Version: DMM Serial Number: DMM Agile Revision: DMM Man Deviation: CPU Type: CPU Speed: Bus Speed: RAM Size: Flash Size: CPLD Versions: PIC Version: PIC Serial Number: PIC Agile Revision: PIC Man Deviation: FPGA Versions:
Boot Versions:
Last Boot Version: Reason Last Booted: Software Version: Uptime: Slot: 17 Type: Model Number: Model Version: Serial Number: Agile Revision:
Issue 2.0
CAM-20016W E02 1.1 08113CSD0010 02 DMM-00016W D01 08123DMM0002 AB BCM1480[B1] 800 MHz 400. 0 MHz 2048 MB 16 MB No Pic No Pic
atlas = 04.00.26 rfmuc = 04.01.18 mcc = 00.03.00.01 cc0 = 00.00.02.00 cc1 = 00.00.02.00 sven = 01.00.06.00 adm1066 = 00.42.52 boot0 = CMTS_BOOT0_V00.03.13 boot1 = CMTS_BOOT1_V00.07.09 boot2 = CMTS_BOOT1_V00.07.09 CMTS_BOOT1_V00.07.09 [2] Coldstart Reset CMTS_V08.00.00.130 16 days 2:56:30 RCM RCM-01000W D03 08133RCM0001
ARRIS PROPRIETARY — All Rights Reserved
CLI-1741
CLI Command Descriptions
Man Deviation: CPU Type: CPU Speed: Bus Speed: RAM Size: Flash Size: CPLD Versions: PIC Version: FPGA Versions:
Boot Versions:
Last Boot Version: Reason Last Booted: Software Version: Uptime: Slot: 18 Type: Model Number: Model Version: Serial Number: Agile Revision: Man Deviation: CPU Type: CPU Speed: Bus Speed: RAM Size: Flash Size: CPLD Versions: PIC Version: FPGA Versions:
Boot Versions:
Last Boot Version: Reason Last Booted: Software Version:
CLI-1742
C4/C4c CMTS Rel. 8.0.7
BCM1255[B1] 800 MHz 400. 0 MHz 1024 MB 32 MB NA flak = 03.04.14 xspisl = 02.00.56 sven = 00.00.02.59 boot0 = CMTS_BOOT0_V00.03.13 boot1 = CMTS_BOOT1_V00.07.09 boot2 = CMTS_BOOT1_V00.07.09 CMTS_BOOT1_V00.07.09 [2] Coldstart Reset CMTS_V08.00.00.130 16 days 2:56:28 RCM RCM-01000W E02 09433RCM0094 AF BCM1255[B1] 800 MHz 400. 0 MHz 1024 MB 32 MB SS11 NA flak = 03.04.14 xspisl = 02.00.56 sven = 00.00.02.59 boot0 = CMTS_BOOT0_V00.03.13 boot1 = CMTS_BOOT1_V00.07.09 boot2 = CMTS_BOOT1_V00.07.09 CMTS_BOOT1_V00.07.09 [1] Coldstart Reset CMTS_V08.00.00.130
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
Uptime: Slot: 19 Type: Model Number: Model Version: Serial Number: Agile Revision: Man Deviation: CPU Type: CPU Speed: Bus Speed: RAM Size: Flash Size: Flash Disk Size: CPLD Versions: PIC Version: PIC Serial Number: PIC Agile Revision: PIC Man Deviation: FPGA Versions: Boot Versions:
Last Boot Version: Reason Last Booted: Software Version: Uptime: Slot: 20 Type: Model Number: Model Version: Serial Number: Agile Revision: Man Deviation: CPU Type: CPU Speed: Bus Speed: RAM Size: Flash Size: Flash Disk Size: CPLD Versions:
Issue 2.0
16 days
2:56:28
SCM SCM-00440W G05 02341CBM0020
MPC 755 (2.3) 396 MHz 99.900 MHz 512 MB 8 MB 488 MB format / 488 MB physical P301 PICS-00440W/D05 08054RMO0015
sandm = 06.21.00 boot0 = CMTS_BOOT0_V00.00.85 boot1 = CMTS_BOOT1_V00.09.62 boot2 = CMTS_BOOT1_V00.09.62 CMTS_BOOT1_V00.09.62 [2] Coldstart Reset CMTS_V08.00.00.130 16 days 2:58:57 SCM SCM-02440W B02 03141CBM0042
MPC 755 (2.3) 396 MHz 99.900 MHz 512 MB 8 MB 488 MB format / 488 MB physical P302 C502
ARRIS PROPRIETARY — All Rights Reserved
CLI-1743
CLI Command Descriptions
PIC Version: PIC Serial Number: PIC Agile Revision: PIC Man Deviation: FPGA Versions: Boot Versions:
Last Boot Version: Reason Last Booted: Software Version: Uptime:
C4/C4c CMTS Rel. 8.0.7
PICS-00440W/D05 08054RMO0015
sandm = 06.21.00 boot0 = CMTS_BOOT0_V00.00.85 boot1 = CMTS_BOOT1_V00.09.62 boot2 = CMTS_BOOT1_V00.09.62 CMTS_BOOT1_V00.09.62 [1] Coldstart Reset CMTS_V08.00.00.130 16 days 2:58:58
Related Command(s)
show image reload
CLI-1744
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
telnet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Initiates a telnet session to the specified target. The specified target can be either an IP address or hostname if the hostname has been configured on the CMTS.
Syntax
telnet [dest-port ]
Parameter
Definition
IP address or hostname (if a hostname has been configured on the CMTS) to telnet to.
[dest-port ]
Issue 2.0
Destination port address.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1745
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
terminal length Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Sets the number of lines for pagination of the console port. A value of zero indicates no pagination. Non-zero values are only applicable for transports that do not support window size negotiation (serial, ssh). Transports which support window size negotiation (telnet) may override this parameter. For Telnet sessions, a value will enable non-zero pagination. To reset to the default, use the [no] option.
Syntax
terminal length
Parameter
Definition
Sets the pagination length of the console port
Related Command(s)
configure line configure pagination show running-config interface cable-downstream
CLI-1746
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
terminal width Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Sets the terminal/console width in number of columns for wrapping.To reset the back to the default, use the [no] option.
Syntax
terminal width
Parameter
Issue 2.0
Definition
Sets the number of columns for wrap. Valid range is 1-384.
ARRIS PROPRIETARY — All Rights Reserved
CLI-1747
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
test Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Tests DOCSIS® features on the specified slot. The test commands are designed for CableLabs and are not designed for customer use.
Syntax
test
Parameter
CLI-1748
Definition
The number of the chassis slot.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging dhcp Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables the tracing of DHCP events to the logging history. This command defaults to the brief version. To see the verbose logs, use the optional keyword “verbose”.
Syntax
trace logging dhcp [verbose]
Parameter
[verbose]
Issue 2.0
Definition
The mac address used to filter the DHCP notification Verbose
ARRIS PROPRIETARY — All Rights Reserved
CLI-1749
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging dhcpv6 Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables the tracing of DHCPv6 events to the logging history. This command defaults to the brief version. To see the verbose logs, use the optional keyword “verbose”.
Syntax
trace logging dhcpv6 [verbose]
Parameter
[verbose]
CLI-1750
Definition
The mac address used to filter the DHCPv6 notification Verbose
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging ips Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables and generates an IPS file from the mated SCM. To disable tracing of CMTS behavior, use the [no] option.
Syntax
trace logging ips [] [no]
Parameter
[]
Issue 2.0
Definition
Filename used to store the IPS file
ARRIS PROPRIETARY — All Rights Reserved
CLI-1751
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging ipssh Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of ipssh events to the logging history. To disable this behavior, use the [no] option.
Syntax
trace logging ipssh
CLI-1752
ARRIS PROPRIETARY — All Rights Reserved
[no]
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace ipstack Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of an ipsstack event to the logging history. To disable tracing behavior, use the [no] option.
Syntax
trace ipstack [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1753
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging ipvideo Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables the tracing of the specified IPv4 or IPv6 address to the logging history. To disable the tracing, use the [no] version of the command.
Syntax
trace logging ipvideo [no]
Parameter
CLI-1754
Definition
The IPv4 or IPv6 address
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging modem Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables the tracing of modem events to the logging history. This command defaults to the brief version. To see the verbose logs, use the optional keyword “verbose”. To disable modem event traces, use the [no] option.
Syntax
trace logging modem [verbose] [no]
Parameter
[verbose]
Definition
The mac address of the modem Verbose
Related Command(s)
show logging debug show logging history clear logging history
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1755
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging no Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Clears all enabled traces.
Syntax
trace logging no
CLI-1756
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging packetcable Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables the tracing of PacketCable events to the logging history. To disable PacketCable event traces, use the [no] option.
Syntax
trace logging packetcable [no]
Parameter
Definition
The IP address of the MTA device.
Related Command(s)
show logging debug show logging history clear logging history
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1757
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging packetcable * Default Access Level
Mode
Privileged – 15
Cable interface configuration
Purpose
Enables all DQoS gate trace, event messaging, and all modem (except BPI and ranging) logging for a single customer as specified by the customer’s MTA IP address. To disable all DQoS gate trace, event messaging, and all modem (except BPI and ranging) logging, use the [no] option.
Syntax
trace logging packetcable [no]
Parameter
CLI-1758
Definition
Choose either the packetcable multi-media (MM) events or the packetcable DQoS events to the logging history IP address of the Multimedia Terminal Adapter (MTA)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging router Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of router events to the logging history. To disable router event traces, use the [no] option.
Syntax
trace logging router [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1759
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging router bgp Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of BGP events to the logging history. To disable BGP event traces, use the [no] option.
Syntax
trace logging router bgp
CLI-1760
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging router general Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of general router events to the logging history. To disable general router events, use the [no] option.
Syntax
trace logging router general [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1761
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging router isis Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of IS-IS router events to the logging history. To disable IS-IS router event traces, use the [no] option. trace logging router isis
CLI-1762
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging router ospf Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of OSPF router events to the logging history. To disable OSPF router event traces, use the [no] option.
Syntax
trace logging router ospf [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1763
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging router redist Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of router forwarding table events to the logging history. To disable router forwarding table event traces, use the [no] option.
Syntax
trace logging router redist [no]
CLI-1764
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
trace logging router rip Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Enables tracing of RIP router events to the logging history. To disable RIP router event traces, use the [no] option.
Syntax
trace logging router rip [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1765
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
traceroute Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Determines the path a packet takes to get to a destination. The device sends out a sequence of User Datagram Protocol (UDP) datagrams to an invalid port address at the remote host. Three datagrams are sent initially, each with a Time-To-Live (TTL) field value set to one. The TTL value of 1 causes the datagram to “timeout” as soon as it hits the first router in the path. A response is then received with an ICMP Time Exceed Message (TEM) indicating that the datagram has expired. NOTE The configure ip vrf default icmp-time-exceeded command must be run or traceroute through the CMTS will not work Another three UDP messages are now sent, each with the TTL value set to 2 which causes the second router to return ICMP TEMs. This process continues until the packets actually reach the other destination. Since these datagrams are trying to access an invalid port at the destination host, ICMP Port Unreachable Messages are returned, indicating an unreachable port, this event signals the Traceroute program that it is finished. Traceroute can also execute from the System Control Module ethernet port. If the source-ip option specifies the SCM’s IP address, then the traceroute will be sourced from the SCM’s ethernet port. The purpose behind this is to record the source of each ICMP Time Exceeded Message to provide a trace of the path the packet took to reach the destination from a given source by returning the sequence of hops the packet has traveled.
Syntax
traceroute [source-ip | hostname ] [min-ttl ] [max-ttl ] [timeout ] [probe-count ] [port-number ] [tos ]
CLI-1766
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
traceroute ipv6 Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Determines the path a packet takes to get to a destination.
Syntax
traceroute ipv6 [max-ttl ] [source ] [timeout ] [probe-count ] [minttl ] [port-number ] [tos ]
Parameter
Definition
IP address used to source the traceroute
[max-ttl ]
Specifies the max number of hops to the destination. Range is 1 to 64 hops. Default is 30.
[source ]
IP address traceroute from
[timeout ]
Specifies the timeout in seconds for each ICMP echo request “probe”. Range is 1 to 100 seconds. Default is 3.
[probe-count ]
Specifies the number of “probes” to send at each TTL level. The range is 1 to 10 probes. Default is 3.
[min-ttl ]
Specifies the starting TTL for the traceroute (first probe). This is used to start the traceroute beyond the known hops en route to the destination. Range is 1 to 64 hops. Default is 1.
[port-number ]
Specifies the starting destination port number. The port number increments by 1 for each “probe”. Range is 1 to 65535. Default is 33434.
[tos ]
Differentiated Service Class (TOS) field type of service [0] [0-255]. Default is 0.
Example
To run a traceroute on IP address 10.44.8.200, use the following command: C4>
Issue 2.0
traceroute 10.44.8.200 probe-count 10
ARRIS PROPRIETARY — All Rights Reserved
CLI-1767
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
traceroute ipv6 * output-interface cable Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Determines the path a packet takes to get to a destination from a cable interface.
Syntax
traceroute ipv6 output-interface cable slot>/
Parameter
CLI-1768
Definition
IP address used to source the traceroute
The CAM slot number. Valid range for the C4 CMTS is 0-15; valid range for the C4c CMTS is 10-15.
The MAC domain number (valid numbers are 0-1)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
traceroute ipv6 * output-interface gigabitethernet Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Determines the path a packet takes to get to a destination from a one Gigabit Ethernet interface.
Syntax
traceroute ipv6 output-interface gigabitethernet /
Parameter
Issue 2.0
Definition
IP address used to source the traceroute
The RCM slot number. Valid range for the C4 CMTS is 19-20; valid range for the C4c CMTS is 19.
The Gigabit port number (valid numbers are 0-9)
ARRIS PROPRIETARY — All Rights Reserved
CLI-1769
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
unalias Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Removes the specified command alias from the alias list.
Syntax
unalias
Parameter
Definition
The specific name you want to remove
Example
To remove the alias sls for show linecard status, type the following command: C4>
CLI-1770
unalias sls
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
wait Default Access Level
Mode
Non-privileged – 1
User EXEC
Purpose
Delays the execution of the next command by the specified number of seconds.
Syntax
wait
Parameter
Definition
Time in number of seconds. Valid range is 1-4,294,967,295 seconds.
Example
If you want to delay the next command by 10 seconds, type the following command: C4>
Issue 2.0
wait 10
ARRIS PROPRIETARY — All Rights Reserved
CLI-1771
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
write log Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Allows the user to generate a customized notification/log.
Syntax
write log [level ]
Parameter
Definition
]
Writes a memo to the log Writes to log using priority levels. Values of priority level are: 1 2 3 4 5 6 7 8
[level ]
= = = = = = = =
emergency alert critical error warning notice* informational debug
*If no level is given, the system will default to 6 (notice).
Example
If you wanted to generate a “critical” message, you would type the following command: C4#
CLI-1772
write log “This is a test” level 3
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
write memory Default Access Level
Mode
Privileged – 15
Privileged EXEC
Purpose
Writes the running configuration to memory. This command will also copy the critical /system directories and their files to the standby System Control Module (SCM).
Syntax
write memory The following is an example of the output returned by a duplex chassis: [0] Write Mem . Remote Write Mem .. [1] Bundle Archive ....... [7] . [9] Unbundle Archive ............. [21] Write memory operation completed successfully. The following is an example of the output returned by a simplex chassis: [0] Write Mem . [0] Bundle Archive ........... [10] Write memory operation completed successfully. If write memory Fails — If this command fails it is usually because there is insufficient space on the flash disk. For example, if an operator ftp’s a large file such as a software image to the /system partition by mistake, write memory will fail. The following is an example of the system response to a failed write memory command: [0] Bundle Archive . Remote Write Mem .. [1] Write memory operation failed. Warning: Check /system make sure disk space is available. Warning: Check /update make sure disk space is available. Warning: Database may be corrupted. Check the log for more details! If this occurs, perform the following steps:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-1773
CLI Command Descriptions
C4/C4c CMTS Rel. 8.0.7
1
Run the following command to display the amount of free space on the flash disk:
C4# df If one of the partitions shows 0 free blocks, that is where the failure occurred. File System /system /update /active
Free Blocks 0 480304 279104
Total User Avail 101520 484352 413864
2
List the files in that directory and delete any large files that were placed there by mistake.
3
Run the write memory command again.
NOTE If you clean up the partition that caused the failure and execute another write memory immediately, the command will execute successfully but you may see the following response: Write memory operation completed successfully. This message occurs only when you have executed the command before the CMTS had a chance to refresh the MIBs. If you can, after deleting the unnecessary files, wait a minute or two before running the running the write memory command again.
CLI-1774
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
List of CLI Commands 1 alias
CLI-2
2 archive
CLI-3
3 cd
CLI-4
4 chkdisk
CLI-5
5 clear access-list counters
CLI-6
6 clear arp-cache
CLI-7
7 clear cable filter counters
CLI-8
8 clear cable filter group * counters
CLI-9
9 clear cable filter group * index * counters
CLI-10
10 clear cable flap-list
CLI-11
11 clear cable host
CLI-13
12 clear cable load-balance counters
CLI-14
13 clear cable load-balance failed-list *
CLI-15
14 clear cable load-balance state
CLI-16
15 clear cable modem
CLI-17
16 clear cable modem all cable-downstream
CLI-18
17 clear cable modem all cable-mac
CLI-19
18 clear cable modem all cable-upstream
CLI-20
19 clear cable modem all delete
CLI-21
20 clear cable modem all rate
CLI-22
21 clear cable modem all reset
CLI-23
22 clear cable modem cable * all delete
CLI-24
23 clear cable modem cable * all reset
CLI-25
24 clear cable modem cable * bonded
CLI-26
25 clear cable modem cable-downstream * all delete
CLI-27
26 clear cable modem cable-downstream * all reset
CLI-28
27 clear cable modem cable-downstream * offline delete
CLI-29
28 clear cable modem cable-downstream * oui * delete
CLI-30
29 clear cable modem cable-downstream * oui * offline delete
CLI-31
30 clear cable modem cable-downstream * oui * reset
CLI-32
31 clear cable modem cable-mac * all reset
CLI-33
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
i
List of CLI Commands
ii
C4 CMTS Rel. 8.0.7
32 clear cable modem cable-mac * offline delete
CLI-34
33 clear cable modem cable-mac * oui * delete
CLI-35
34 clear cable modem cable-mac * oui * offline delete
CLI-36
35 clear cable modem cable-mac * oui * reset
CLI-37
36 clear cable modem cable * offline delete
CLI-38
37 clear cable modem cable * oui * delete
CLI-39
38 clear cable modem cable * oui * offline delete
CLI-40
39 clear cable modem cable * oui * reset
CLI-41
40 clear cable modem cable-upstream * all delete
CLI-42
41 clear cable modem cable-upstream * all reset
CLI-43
42 clear cable modem cable-upstream * offline delete
CLI-44
43 clear cable modem cable-upstream * oui * delete
CLI-45
44 clear cable modem cable-upstream * oui * offline delete
CLI-46
45 clear cable modem cable-upstream * oui * reset
CLI-47
46 clear cable modem fpcm-id
CLI-48
47 clear cable modem offline delete
CLI-49
48 clear cable modem oui * delete
CLI-50
49 clear cable modem oui * offline delete
CLI-51
50 clear cable modem oui * reset
CLI-52
51 clear cable proto-throttle counters
CLI-53
52 clear cable proto-throttle history
CLI-54
53 clear counters cable
CLI-55
54 clear counters cable-mac
CLI-56
55 clear counters cable modem deny
CLI-57
56 clear counters gigabitethernet
CLI-58
57 clear counters tengigabitethernet
CLI-60
58 clear crypto sa
CLI-62
59 clear ip bgp
CLI-63
60 clear ip bgp * soft
CLI-64
61 clear ip mroute counters
CLI-65
62 clear ip route
CLI-66
63 clear ipv6 access-list
CLI-67
64 clear ipv6 neighbors
CLI-68
65 clear ipv6 route pd
CLI-69
66 clear isis counters
CLI-70
67 clear line
CLI-71
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
68 clear line console
CLI-72
69 clear line vty
CLI-73
70 clear logging debug
CLI-74
71 clear logging history
CLI-75
72 clear logging local
CLI-76
73 clear logging qos-service-flow
CLI-77
74 clear packetcable cops counters
CLI-78
75 clear packetcable gate
CLI-79
76 clear packetcable gatectl counters
CLI-80
77 clear pmd
CLI-81
78 clear route-map-policy counters
CLI-82
79 cls
CLI-83
80 configure
CLI-84
81 configure absolute-timeout
CLI-85
82 configure access-list
CLI-86
83 configure access-list * icmp
CLI-87
84 configure access-list * igmp
CLI-88
85 configure access-list * ip
CLI-89
86 configure access-list * name
CLI-91
87 configure access-list * num
CLI-92
88 configure access-list * remark
CLI-93
89 configure access-list resequence
CLI-94
90 configure access-list * tcp
CLI-95
91 configure access-list * udp
CLI-97
92 configure accounting
CLI-99
93 configure aging
CLI-100
94 configure arp
CLI-101
95 configure arp state not-present global-max-rate
CLI-103
96 configure arp state not-present max-number
CLI-104
97 configure arp state not-present max-time
CLI-105
98 configure arp state not-present min-time
CLI-106
99 configure arp state not-present rate-limit
CLI-107
100 configure arp state searching global-max-rate
CLI-108
101 configure arp state searching max-number
CLI-109
102 configure arp state searching rate-limit
CLI-110
103 configure arp * tengigabitethernet
CLI-111
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
iii
List of CLI Commands
iv
C4 CMTS Rel. 8.0.7
104 configure arp timeout
CLI-112
105 configure audit autoscheduling enable
CLI-113
106 configure audit log enable
CLI-114
107 configure audit logthrottle enable
CLI-115
108 configure audit sequence * card * enable
CLI-116
109 configure audit sequence * card * run-now
CLI-117
110 configure audit sequence * enable
CLI-118
111 configure audit sequence * run-now
CLI-119
112 configure authentication
CLI-120
113 configure authorization
CLI-121
114 configure autorecovery
CLI-122
115 configure banner login
CLI-123
116 configure banner motd
CLI-125
117 configure cable admission-control multicast allowed
CLI-127
118 configure cable admission-control multicast enable
CLI-128
119 configure cable allow-cmsg-ambig-override
CLI-129
120 configure cable annex
CLI-130
121 configure cable authstring
CLI-131
122 configure cable cm-cfg-reg-req-time
CLI-132
123 configure cable concatenation-docsis10
CLI-133
124 configure cable delayed-cpe-learning-bpi
CLI-134
125 configure cable downstream-enhanced-power
CLI-135
126 configure cable dsg client-id-list *
CLI-136
127 configure cable dsg ds-frequency-list
CLI-138
128 configure cable dsg timer-list
CLI-140
129 configure cable dsg tunnel
CLI-142
130 configure cable dsg tunnel * classifier
CLI-143
131 configure cable dsg vsp-list
CLI-145
132 configure cable enable-trap
CLI-147
133 configure cable fiber-node
CLI-148
134 configure cable fiber-node * cable-downstream
CLI-149
135 configure cable fiber-node * cable-mac * load-balance enable
CLI-150
136 configure cable fiber-node * cable-mac * load-balance init-technique
CLI-151
137 configure cable fiber-node * cable-mac * load-balance policy
CLI-152
138 configure cable fiber-node * cable-upstream
CLI-153
139 configure cable fiber-node * description
CLI-154
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
140 configure cable fiber-node * force no
CLI-155
141 configure cable filter group * index
CLI-156
142 configure cable filter group * index * ip-tos
CLI-158
143 configure cable filter group * index * log
CLI-160
144 configure cable filter log no
CLI-162
145 configure cable flap-list power-adjust threshold
CLI-163
146 configure cable fragmentation-docsis10
CLI-164
147 configure cable freq-ds-max
CLI-165
148 configure cable freq-ds-min
CLI-166
149 configure cable freq-us-max
CLI-167
150 configure cable host authorization
CLI-168
151 configure cable host authorization * cpe *
CLI-169
152 configure cable intercept
CLI-170
153 configure cable intercept source-interface cable
CLI-171
154 configure cable intercept source-interface cable-mac
CLI-172
155 configure cable intercept source-interface gigabitethernet
CLI-173
156 configure cable intercept source-interface loopback
CLI-174
157 configure cable intercept source-interface tengigabitethernet
CLI-175
158 configure cable intercept * subscriber
CLI-176
159 configure cable intercept * subscriber * md * udp * until
CLI-177
160 configure cable LO1-leak-detect
CLI-178
161 configure cable load-balance across-macdomain-check
CLI-179
162 configure cable load-balance downstream-start-threshold
CLI-180
163 configure cable load-balance enable
CLI-181
164 configure cable load-balance exclude oui
CLI-182
165 configure cable load-balance failed-list exclude-count
CLI-183
166 configure cable load-balance failed-list timeout
CLI-184
167 configure cable load-balance general-group-defaults enable
CLI-185
168 configure cable load-balance general-group-defaults init-technique
CLI-186
169 configure cable load-balance general-group-defaults policy
CLI-187
170 configure cable load-balance include cm-mac
CLI-188
171 configure cable load-balance include oui
CLI-189
172 configure cable load-balance macdomain-check
CLI-190
173 configure cable load-balance policy
CLI-191
174 configure cable load-balance policy * rule
CLI-192
175 configure cable load-balance rule * channel-weight
CLI-193
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
v
List of CLI Commands
vi
C4 CMTS Rel. 8.0.7
176 configure cable load-balance rule * disable-period
CLI-194
177 configure cable load-balance rule * enable
CLI-195
178 configure cable load-balance rule * method
CLI-196
179 configure cable load-balance rule * periodic-steeringd2
CLI-197
180 configure cable load-balance rule * periodic-steeringd3
CLI-198
181 configure cable load-balance rule * registration-steeringd2
CLI-199
182 configure cable load-balance rule * registration-steeringd3
CLI-200
183 configure cable load-balance rule * threshold
CLI-201
184 configure cable load-balance rule * type
CLI-202
185 configure cable load-balance upstream-start-threshold
CLI-203
186 configure cable load-balance utilization-modems-to-check
CLI-204
187 configure cable load-interval
CLI-205
188 configure cable mac-move-allowed-on-dhcp
CLI-206
189 configure cable max-qos-active-timeout
CLI-207
190 configure cable max-qos-admitted-timeout
CLI-208
191 configure cable max-ucd-burst-len
CLI-209
192 configure cable metering
CLI-210
193 configure cable metering collector
CLI-211
194 configure cable metering data-ack-timeout
CLI-212
195 configure cable metering data-ack-window
CLI-213
196 configure cable metering export
CLI-214
197 configure cable metering keep-alive-interval
CLI-215
198 configure cable metering mode
CLI-216
199 configure cable metering query-port
CLI-217
200 configure cable metering report-cycle set * start * interval
CLI-218
201 configure cable metering report-cycle start * interval
CLI-219
202 configure cable metering session-id
CLI-220
203 configure cable metering session id * service * method
CLI-221
204 configure cable metering streaming-port
CLI-222
205 configure cable modem deny
CLI-223
206 configure cable modem format
CLI-224
207 configure cable modem move * cable-downstream * cable-upstream * method
CLI-225
208 configure cable modem move * downstream-freq
CLI-226
209 configure cable modem move * us-channel-id
CLI-227
210 configure cable modem remote-query
CLI-228
211 configure cable modem remote-query source-interface
CLI-229
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
212 configure cable modem remote-query source-interface loopback
CLI-230
213 configure cable modem vendor
CLI-231
214 configure cable modify-primary-ds-rcc
CLI-232
215 configure cable modulation-profile * atdma
CLI-233
216 configure cable modulation-profile * iuc
CLI-234
217 configure cable modulation-profile * tdma
CLI-241
218 configure cable modulation-profile * tdma-atdma
CLI-242
219 configure cable mtcm-conditional-override
CLI-243
220 configure cable multicast group-qos * scn
CLI-244
221 configure cable multicast qos group
CLI-245
222 configure cable multicast qos group * group-qos * priority
CLI-246
223 configure cable multicast qos group * group-qos * session-range * source
CLI-247
224 configure cable peak-tr-rate-upstream
CLI-248
225 configure cable percentaddtldsbandwidth
CLI-249
226 configure cable privacy add-certificate
CLI-250
227 configure cable privacy ca-cert-trust
CLI-253
228 configure cable privacy cm-cert-trust
CLI-254
229 configure cable proto-throttle * interval
CLI-255
230 configure cable proto-throttle * max-burst
CLI-256
231 configure cable proxy-tftp
CLI-257
232 configure cable relay-agent-option circuit-id
CLI-258
233 configure cable relay-agent-option qos-sc-name
CLI-259
234 configure cable source-verify leasequery message-type
CLI-260
235 configure cable source-verify leasequery version
CLI-261
236 configure cable spectrum-group
CLI-262
237 configure cable spectrum-group * hop-period
CLI-263
238 configure cable spectrum-group * min-codewords
CLI-264
239 configure cable spectrum-group * retry-period
CLI-265
240 configure cable spectrum-group * sample-period
CLI-266
241 configure cable spectrum-group * state * frequency * width * modulation-profile
CLI-267
242 configure cable spectrum-group * state * trigger
CLI-268
243 configure cable spectrum-group trigger * degradation
CLI-269
244 configure cable spectrum-group trigger * improvement
CLI-270
245 configure cable spectrum-group trigger * period
CLI-271
246 configure cable spectrum-group trigger * time
CLI-272
247 configure cable submgmt default active
CLI-273
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
vii
List of CLI Commands
C4 CMTS Rel. 8.0.7
248 configure cable submgmt default filter-group
CLI-274
249 configure cable submgmt default learnable
CLI-275
250 configure cable submgmt default max-cpe
CLI-276
251 configure cable submgmt default v6-max-cpe
CLI-277
252 configure cable tcc-refid-in-first-only
CLI-278
253 configure cable unicast-np-us-acquisition
CLI-279
254 configure cable unicast-polling pri
CLI-280
255 configure clock network
CLI-282
256 configure clock set
CLI-283
257 configure clock timezone
CLI-284
258 configure cos-mapping
CLI-296
259 configure counts collection rate
CLI-298
260 configure crypto key export
CLI-299
261 configure crypto key generate
CLI-300
262 configure crypto key import
CLI-301
263 configure crypto key zeroize
CLI-302
264 configure diag
CLI-303
265 configure disconnect ssh
CLI-304
266 configure disk volume
CLI-305
267 configure disk volume * scm * clone-access
CLI-306
268 configure enable
CLI-308
269 configure fan monitor shutdown
CLI-309
270 configure fan speed-control shutdown
CLI-310
271 configure ftp-server
CLI-311
272 configure hostname
CLI-312
273 configure interface cable-downstream
CLI-313
274 configure interface cable-downstream * cable attribute-mask value
CLI-314
275 configure interface cable-downstream * cable cable-mac
CLI-315
276 configure interface cable-downstream * cable channel-id
CLI-316
277 configure interface cable-downstream * cable dsg dcd-enable
CLI-317
278 configure interface cable-downstream * cable dsg ds-frequency-list
CLI-318
279 configure interface cable-downstream * cable dsg no
CLI-319
280 configure interface cable-downstream * cable dsg timer-list
CLI-320
281 configure interface cable-downstream * cable dsg tunnel-group
CLI-321
282 configure interface cable-downstream * cable dsg vsp-list
CLI-322
283 configure interface cable-downstream * cable frequency
CLI-323
viii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
284 configure interface cable-downstream * cable interleave-depth
CLI-324
285 configure interface cable-downstream * cable load-balance group
CLI-325
286 configure interface cable-downstream * cable max-round-trip-delay
CLI-326
287 configure interface cable-downstream * cable modulation
CLI-327
288 configure interface cable-downstream * cable power-level
CLI-328
289 configure interface cable-downstream * cable primary-capable
CLI-329
290 configure interface cable-downstream * cable rate-limit token-bucket
CLI-330
291 configure interface cable-downstream * cable show
CLI-331
292 configure interface cable-downstream * cable shutdown
CLI-332
293 configure interface cable-downstream * cable voice-limits
CLI-333
294 configure interface cable-downstream * cable voice-limits allowed-emergency
CLI-334
295 configure interface cable-downstream * cable voice-limits allowed-normal
CLI-335
296 configure interface cable-downstream * cable voice-limits allowed-total
CLI-336
297 configure interface cable-downstream * cable voice-limits emergency-preemption
CLI-337
298 configure interface cable-downstream * cable voice-limits reserved-emergency
CLI-338
299 configure interface cable-downstream * cable voice-limits reserved-normal
CLI-339
300 configure interface cable-downstream * description
CLI-340
301 configure interface cable-downstream * ip igmp static-group
CLI-341
302 configure interface cable-downstream * ip igmp static-group * source
CLI-342
303 configure interface cable-mac
CLI-343
304 configure interface cable-mac * authorization-module open-dynamic-flow-policy
CLI-344
305 configure interface cable-mac * cable annex
CLI-345
306 configure interface cable-mac * cable bundle cable
CLI-346
307 configure interface cable-mac * cable bundle cable-mac
CLI-347
308 configure interface cable-mac * cable bundle master
CLI-348
309 configure interface cable-mac * cable cm-ip-prov-mode
CLI-349
310 configure interface cable-mac * cable cm-status enabled
CLI-350
311 configure interface cable-mac * cable cm-status event-type * enabled
CLI-351
312 configure interface cable-mac * cable cm-status event-type * max-event-holdoff
CLI-352
313 configure interface cable-mac * cable cm-status event-type * max-num-reports
CLI-353
314 configure interface cable-mac * cable dhcp-giaddr
CLI-354
315 configure interface cable-mac * cable downstream-bonding-group
CLI-355
316 configure interface cable-mac * cable downstream-bonding-group * attribute-mask value
CLI-356
317 configure interface cable-mac * cable downstream-bonding-group * cable-downstream
CLI-357
318 configure interface cable-mac * cable downstream-bonding-group dynamic enable
CLI-358
319 configure interface cable-mac * cable downstream-bonding-group dynamic reseq-wait-time
CLI-359
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
ix
List of CLI Commands
C4 CMTS Rel. 8.0.7
320 configure interface cable-mac * cable downstream-bonding-group * dynamic reseq-wait-time CLI-360
x
321 configure interface cable-mac * cable downstream-bonding-group dynamic reseq-warning-threshold
CLI-361
322 configure interface cable-mac * cable downstream-bonding-group * dynamic reseq-warning-threshold
CLI-362
323 configure interface cable-mac * cable dynamic-rcc
CLI-363
324 configure interface cable-mac * cable dynamic-secret
CLI-364
325 configure interface cable-mac * cable freq-ds-max
CLI-365
326 configure interface cable-mac * cable freq-ds-min
CLI-366
327 configure interface cable-mac * cable freq-us-max
CLI-367
328 configure interface cable-mac * cable helper-address
CLI-368
329 configure interface cable-mac * cable insertion-interval
CLI-369
330 configure interface cable-mac * cable invited-ranging-attempts
CLI-370
331 configure interface cable-mac * cable load-balance group
CLI-371
332 configure interface cable-mac * cable load-balance group * enable
CLI-372
333 configure interface cable-mac * cable load-balance group * init-technique
CLI-373
334 configure interface cable-mac * cable load-balance group * policy
CLI-374
335 configure interface cable-mac * cable load-balance group * service-type
CLI-375
336 configure interface cable-mac * cable mcast-fwd-by-dsid
CLI-376
337 configure interface cable-mac * cable mdd-interval
CLI-377
338 configure interface cable-mac * cable mult-rx-chl-mode
CLI-378
339 configure interface cable-mac * cable mult-tx-chl-mode
CLI-379
340 configure interface cable-mac * cable privacy chk-validity-period
CLI-380
341 configure interface cable-mac * cable privacy default-cert-trust
CLI-381
342 configure interface cable-mac * cable privacy kek-cm * life-time
CLI-382
343 configure interface cable-mac * cable privacy kek-cm-reset
CLI-383
344 configure interface cable-mac * cable privacy kek-cm-reset * invalidate-auth
CLI-384
345 configure interface cable-mac * cable privacy kek-cm-reset * invalidate-tek
CLI-385
346 configure interface cable-mac * cable privacy kek-cm-reset * send-auth-invalid
CLI-386
347 configure interface cable-mac * cable privacy kek life-time
CLI-387
348 configure interface cable-mac * cable privacy mandatory
CLI-388
349 configure interface cable-mac * cable privacy tek life-time
CLI-389
350 configure interface cable-mac * cable privacy tek-said * life-time
CLI-390
351 configure interface cable-mac * cable privacy tek-said-reset
CLI-391
352 configure interface cable-mac * cable range-cycle-interval
CLI-392
353 configure interface cable-mac * cable ranging-interval
CLI-393
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
354 configure interface cable-mac * cable rcp-id * rcc
CLI-394
355 configure interface cable-mac * cable rcp-id * rcc * cm-channel
CLI-395
356 configure interface cable-mac * cable rcp-id * rcc * cm-channel * cable-downstream
CLI-396
357 configure interface cable-mac * cable rcp-id * rcc * cm-channel * module
CLI-397
358 configure interface cable-mac * cable rcp-id * rcc * cm-channel * primary-channel
CLI-398
359 configure interface cable-mac * cable rcp-id * rcc * description
CLI-399
360 configure interface cable-mac * cable rcp-id * rcc * module
CLI-400
361 configure interface cable-mac * cable rcp-id * rcc * module * min-center-frequency
CLI-401
362 configure interface cable-mac * cable rcp-id * rcc * vendor-specific
CLI-402
363 configure interface cable-mac * cable rcp-id * rcc * vendor-specific extended
CLI-403
364 configure interface cable-mac * cable reg-rsp-timer-t6
CLI-404
365 configure interface cable-mac * cable source-verify
CLI-405
366 configure interface cable-mac * cable submgmt default filter-group
CLI-406
367 configure interface cable-mac * cable sync-interval
CLI-407
368 configure interface cable-mac * cable tftp-enforce
CLI-408
369 configure interface cable-mac * cable ucd-interval
CLI-409
370 configure interface cable-mac * cable upstream-bonding-group
CLI-410
371 configure interface cable-mac * cable upstream-bonding-group * attribute-mask value
CLI-411
372 configure interface cable-mac * cable upstream-bonding-group * cable-upstream
CLI-412
373 configure interface cable-mac * cable upstream-bonding-group dynamic enable
CLI-413
374 configure interface cable-mac * cable us-freq-range
CLI-414
375 configure interface cable-mac * cable us-freq-range extended
CLI-415
376 configure interface cable-mac * cable us-freq-range standard
CLI-416
377 configure interface cable-mac * cable verbose-cm-rcp
CLI-417
378 configure interface cable-mac * description
CLI-418
379 configure interface cable-mac * ip access-group
CLI-419
380 configure interface cable-mac * ip address
CLI-420
381 configure interface cable-mac * ip directed-broadcast
CLI-421
382 configure interface cable-mac * ip igmp
CLI-422
383 configure interface cable-mac * ip igmp access-group
CLI-423
384 configure interface cable-mac * ip igmp backup-proxy-interface
CLI-424
385 configure interface cable-mac * ip igmp host-robustness
CLI-425
386 configure interface cable-mac * ip igmp host-version
CLI-426
387 configure interface cable-mac * ip igmp join-group
CLI-427
388 configure interface cable-mac * ip igmp join-group * source
CLI-428
389 configure interface cable-mac * ip igmp last-member-query
CLI-429
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xi
List of CLI Commands
C4 CMTS Rel. 8.0.7
390 configure interface cable-mac * ip igmp multicast-static-only
CLI-430
391 configure interface cable-mac * ip igmp proxy-interface
CLI-431
392 configure interface cable-mac * ip igmp query-interval
CLI-432
393 configure interface cable-mac * ip igmp query-max-response-time
CLI-433
394 configure interface cable-mac * ip igmp robustness
CLI-434
395 configure interface cable-mac * ip igmp static-group
CLI-435
396 configure interface cable-mac * ip igmp static-group * source
CLI-436
397 configure interface cable-mac * ip igmp version
CLI-437
398 configure interface cable-mac * ip ospf authentication-key
CLI-438
399 configure interface cable-mac * ip ospf authentication key-chain
CLI-439
400 configure interface cable-mac * ip ospf auto-delete-neighbor
CLI-440
401 configure interface cable-mac * ip ospf cost
CLI-441
402 configure interface cable-mac * ip ospf dead-interval
CLI-442
403 configure interface cable-mac * ip ospf hello-interval
CLI-443
404 configure interface cable-mac * ip ospf message-digest-key * md5
CLI-444
405 configure interface cable-mac * ip ospf network
CLI-445
406 configure interface cable-mac * ip ospf priority
CLI-446
407 configure interface cable-mac * ip ospf retransmit-interval
CLI-447
408 configure interface cable-mac * ip ospf transmit-delay
CLI-448
409 configure interface cable-mac * ip pim dr-priority
CLI-449
410 configure interface cable-mac * ip pim hello-holdtime
CLI-450
411 configure interface cable-mac * ip pim message-holdtime
CLI-451
412 configure interface cable-mac * ip pim message-interval
CLI-452
413 configure interface cable-mac * ip pim query-interval
CLI-453
414 configure interface cable-mac * ip pim sparse-mode-ssm
CLI-454
415 configure interface cable-mac * ip policy route-map-policy
CLI-455
416 configure interface cable-mac * ip rip authentication key
CLI-456
417 configure interface cable-mac * ip rip authentication key-chain
CLI-457
418 configure interface cable-mac * ip rip authentication mode
CLI-458
419 configure interface cable-mac * ip rip authentication mode md5
CLI-459
420 configure interface cable-mac * ip rip authentication mode text
CLI-460
421 configure interface cable-mac * ip rip default-metric
CLI-461
422 configure interface cable-mac * ip rip receive version
CLI-462
423 configure interface cable-mac * ip router isis
CLI-463
424 configure interface cable-mac * ip scm access-group
CLI-464
425 configure interface cable-mac * ip unreachables
CLI-465
xii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
426 configure interface cable-mac * ipv6 address
CLI-466
427 configure interface cable-mac * ipv6 dhcp relay destination
CLI-467
428 configure interface cable-mac * ipv6 dhcp relay link-address
CLI-468
429 configure interface cable-mac * ipv6 enable
CLI-469
430 configure interface cable-mac * ipv6 icmp param-problem
CLI-470
431 configure interface cable-mac * ipv6 icmp too-big
CLI-471
432 configure interface cable-mac * ipv6 icmp unreachables
CLI-472
433 configure interface cable-mac * ipv6 mtu
CLI-473
434 configure interface cable-mac * ipv6 nd dad attempts
CLI-474
435 configure interface cable-mac * ipv6 nd managed-config-flag
CLI-475
436 configure interface cable-mac * ipv6 nd ns-interval
CLI-476
437 configure interface cable-mac * ipv6 nd other-config-flag
CLI-477
438 configure interface cable-mac * ipv6 nd prefix
CLI-478
439 configure interface cable-mac * ipv6 nd prefix * at
CLI-479
440 configure interface cable-mac * ipv6 nd prefix * infinite *
CLI-480
441 configure interface cable-mac * ipv6 nd prefix * no-advertise
CLI-481
442 configure interface cable-mac * ipv6 nd ra interval
CLI-482
443 configure interface cable-mac * ipv6 nd ra lifetime
CLI-483
444 configure interface cable-mac * ipv6 nd ra suppress
CLI-484
445 configure interface cable-mac * ipv6 nd reachable-time
CLI-485
446 configure interface cable-mac * ipv6 ospf area
CLI-486
447 configure interface cable-mac * ipv6 ospf cost
CLI-487
448 configure interface cable-mac * ipv6 ospf dead-interval
CLI-488
449 configure interface cable-mac * ipv6 ospf hello-interval
CLI-489
450 configure interface cable-mac * ipv6 ospf mtu-ignore
CLI-490
451 configure interface cable-mac * ipv6 ospf network
CLI-491
452 configure interface cable-mac * ipv6 ospf priority
CLI-492
453 configure interface cable-mac * ipv6 ospf retransmit-interval
CLI-493
454 configure interface cable-mac * ipv6 ospf transmit-delay
CLI-494
455 configure interface cable-mac * ipv6 pd-route-injection
CLI-495
456 configure interface cable-mac * ipv6 router isis
CLI-496
457 configure interface cable-mac * ipv6 traffic-filter
CLI-497
458 configure interface cable-mac * ip vrf forwarding
CLI-498
459 configure interface cable-mac * isis authentication key-chain
CLI-499
460 configure interface cable-mac * isis authentication mode
CLI-500
461 configure interface cable-mac * isis circuit-type
CLI-501
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xiii
List of CLI Commands
C4 CMTS Rel. 8.0.7
462 configure interface cable-mac * isis csnp-interval
CLI-502
463 configure interface cable-mac * isis ds-hello-interval
CLI-503
464 configure interface cable-mac * isis hello-interval
CLI-504
465 configure interface cable-mac * isis hello-multiplier
CLI-505
466 configure interface cable-mac * isis ipv6 metric
CLI-506
467 configure interface cable-mac * isis lsp-interval
CLI-507
468 configure interface cable-mac * isis lsp-mtu
CLI-508
469 configure interface cable-mac * isis metric
CLI-509
470 configure interface cable-mac * isis priority
CLI-510
471 configure interface cable-mac * isis protocol shutdown
CLI-511
472 configure interface cable-mac * isis retransmit-interval
CLI-512
473 configure interface cable-mac * isis small-hello
CLI-513
474 configure interface cable-mac * isis wide-metric
CLI-514
475 configure interface cable-mac * proxy-arp
CLI-515
476 configure interface cable-mac * restricted-proxy-arp
CLI-516
477 configure interface cable-mac * shutdown
CLI-517
478 configure interface cable-mac * voice-limits
CLI-518
479 configure interface cable-mac * voice-limits emergency-preemption
CLI-519
480 configure interface cable-upstream
CLI-520
481 configure interface cable-upstream * cable attribute-mask value
CLI-521
482 configure interface cable-upstream * cable cable-mac
CLI-522
483 configure interface cable-upstream * cable channel-id
CLI-523
484 configure interface cable-upstream * cable channel-width
CLI-524
485 configure interface cable-upstream * cable connector
CLI-525
486 configure interface cable-upstream * cable databackoff
CLI-526
487 configure interface cable-upstream * cable docsis-mode
CLI-527
488 configure interface cable-upstream * cable frequency
CLI-528
489 configure interface cable-upstream * cable ingress-cancellation
CLI-529
490 configure interface cable-upstream * cable load-balance group
CLI-530
491 configure interface cable-upstream * cable map-size
CLI-531
492 configure interface cable-upstream * cable max-power-adj
CLI-532
493 configure interface cable-upstream * cable mini-slot-size
CLI-533
494 configure interface cable-upstream * cable modulation-profile
CLI-534
495 configure interface cable-upstream * cable power-level
CLI-535
496 configure interface cable-upstream * cable pre-eq-enable
CLI-536
497 configure interface cable-upstream * cable rangebackoff
CLI-537
xiv
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
498 configure interface cable-upstream * cable relay-agent-option circuit-id
CLI-538
499 configure interface cable-upstream * cable scdma
CLI-539
500 configure interface cable-upstream * cable show
CLI-540
501 configure interface cable-upstream * cable spectrum-group
CLI-541
502 configure interface cable-upstream * cable supervision
CLI-542
503 configure interface cable-upstream * cable threshold-power-offset
CLI-543
504 configure interface cable-upstream * cable voice-limits
CLI-544
505 configure interface cable-upstream * cable voice-limits emergency-preemption
CLI-545
506 configure interface cable-upstream * description
CLI-546
507 configure interface cable-upstream * shutdown
CLI-547
508 configure interface ethernet * active ip
CLI-548
509 configure interface ethernet * ip address
CLI-549
510 configure interface gigabitethernet
CLI-550
511 configure interface gigabitethernet * description
CLI-551
512 configure interface gigabitethernet * duplex
CLI-552
513 configure interface gigabitethernet * encapsulation dot1q
CLI-553
514 configure interface gigabitethernet * encapsulation dot1q * priority
CLI-554
515 configure interface gigabitethernet * encapsulation no
CLI-555
516 configure interface gigabitethernet * flowcontrol receive
CLI-556
517 configure interface gigabitethernet * flowcontrol send
CLI-557
518 configure interface gigabitethernet * ip access-group
CLI-558
519 configure interface gigabitethernet * ip address
CLI-559
520 configure interface gigabitethernet * ip directed-broadcast
CLI-560
521 configure interface gigabitethernet * ip igmp
CLI-561
522 configure interface gigabitethernet * ip igmp backup-proxy-interface
CLI-562
523 configure interface gigabitethernet * ip igmp host-robustness
CLI-563
524 configure interface gigabitethernet * ip igmp host-version
CLI-564
525 configure interface gigabitethernet * ip igmp join-group
CLI-565
526 configure interface gigabitethernet * ip igmp join-group * source
CLI-566
527 configure interface gigabitethernet * ip igmp last-member-query-interval
CLI-567
528 configure interface gigabitethernet * ip igmp multicast-static-only
CLI-568
529 configure interface gigabitethernet * ip igmp proxy-interface *
CLI-569
530 configure interface gigabitethernet * ip igmp query-interval
CLI-570
531 configure interface gigabitethernet * ip igmp query-max-response-time
CLI-571
532 configure interface gigabitethernet * ip igmp robustness
CLI-572
533 configure interface gigabitethernet * ip igmp static-group
CLI-573
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xv
List of CLI Commands
C4 CMTS Rel. 8.0.7
534 configure interface gigabitethernet * ip igmp static-group * source
CLI-574
535 configure interface gigabitethernet * ip igmp version
CLI-575
536 configure interface gigabitethernet * ip ospf authentication key
CLI-576
537 configure interface gigabitethernet * ip ospf authentication key-chain
CLI-577
538 configure interface gigabitethernet * ip ospf auto-delete-neighbor
CLI-578
539 configure interface gigabitethernet * ip ospf cost
CLI-579
540 configure interface gigabitethernet * ip ospf dead-interval
CLI-580
541 configure interface gigabitethernet * ip ospf graceful-restart restart-helper
CLI-581
542 configure interface gigabitethernet * ip ospf graceful-restart timeout
CLI-582
543 configure interface gigabitethernet * ip ospf hello-interval
CLI-583
544 configure interface gigabitethernet * ip ospf message-digest-key * md5
CLI-584
545 configure interface gigabitethernet * ip ospf network
CLI-585
546 configure interface gigabitethernet * ip ospf priority
CLI-586
547 configure interface gigabitethernet * ip ospf retransmit interval
CLI-587
548 configure interface gigabitethernet * ip ospf transmit-delay
CLI-588
549 configure interface gigabitethernet * ip pim dr-priority
CLI-589
550 configure interface gigabitethernet * ip pim hello-holdtime
CLI-590
551 configure interface gigabitethernet * ip pim message-holdtime
CLI-591
552 configure interface gigabitethernet * ip pim message-interval
CLI-592
553 configure interface gigabitethernet * ip pim query-interval
CLI-593
554 configure interface gigabitethernet * ip pim sparse-mode-ssm
CLI-594
555 configure interface gigabitethernet * ip policy route-map-policy
CLI-595
556 configure interface gigabitethernet * ip rip authentication key
CLI-596
557 configure interface gigabitethernet * ip rip authentication key-chain
CLI-597
558 configure interface gigabitethernet * ip rip authentication mode
CLI-598
559 configure interface gigabitethernet * ip rip authentication mode md5
CLI-599
560 configure interface gigabitethernet * ip rip authentication mode text
CLI-600
561 configure interface gigabitethernet * ip rip default-metric
CLI-601
562 configure interface gigabitethernet * ip router isis
CLI-602
563 configure interface gigabitethernet * ip scm access-group
CLI-603
564 configure interface gigabitethernet * ip unreachables
CLI-604
565 configure interface gigabitethernet * ipv6 address
CLI-605
566 configure interface gigabitethernet * ipv6 enable
CLI-606
567 configure interface gigabitethernet * ipv6 icmp param-problem
CLI-607
568 configure interface gigabitethernet * ipv6 icmp too-big
CLI-608
569 configure interface gigabitethernet * ipv6 icmp unreachables
CLI-609
xvi
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
570 configure interface gigabitethernet * ipv6 mtu
CLI-610
571 configure interface gigabitethernet * ipv6 nd dad attempts
CLI-611
572 configure interface gigabitethernet * ipv6 nd managed-config-flag
CLI-612
573 configure interface gigabitethernet * ipv6 nd ns-interval
CLI-613
574 configure interface gigabitethernet * ipv6 nd other-config-flag
CLI-614
575 configure interface gigabitethernet * ipv6 nd prefix
CLI-615
576 configure interface gigabitethernet * ipv6 nd prefix * at
CLI-616
577 configure interface gigabitethernet * ipv6 nd prefix * infinite
CLI-617
578 configure interface gigabitethernet * ipv6 nd prefix * no-advertise
CLI-618
579 configure interface gigabitethernet * ipv6 nd ra interval
CLI-619
580 configure interface gigabitethernet * ipv6 nd ra lifetime
CLI-620
581 configure interface gigabitethernet * ipv6 nd ra reachable-time
CLI-621
582 configure interface gigabitethernet * ipv6 nd ra suppress
CLI-622
583 configure interface gigabitethernet * ipv6 nd reachable-time
CLI-623
584 configure interface gigabitethernet * ipv6 ospf
CLI-624
585 configure interface gigabitethernet * ipv6 ospf area
CLI-625
586 configure interface gigabitethernet * ipv6 ospf cost
CLI-626
587 configure interface gigabitethernet * ipv6 ospf dead-interval
CLI-627
588 configure interface gigabitethernet * ipv6 ospf hello-interval
CLI-628
589 configure interface gigabitethernet * ipv6 ospf mtu-ignore
CLI-629
590 configure interface gigabitethernet * ipv6 ospf network
CLI-630
591 configure interface gigabitethernet * ipv6 ospf priority
CLI-631
592 configure interface gigabitethernet * ipv6 ospf retransmit-interval
CLI-632
593 configure interface gigabitethernet * ipv6 ospf transmit-delay
CLI-633
594 configure interface gigabitethernet * ipv6 router isis
CLI-634
595 configure interface gigabitethernet * ipv6 traffic-filter
CLI-635
596 configure interface gigabitethernet * ip vrf forwarding
CLI-636
597 configure interface gigabitethernet * isis authentication key-chain
CLI-637
598 configure interface gigabitethernet * isis authentication mode
CLI-638
599 configure interface gigabitethernet * isis circuit-type
CLI-639
600 configure interface gigabitethernet * isis csnp-interval
CLI-640
601 configure interface gigabitethernet * isis ds-hello-interval
CLI-641
602 configure interface gigabitethernet * isis hello-interval
CLI-642
603 configure interface gigabitethernet * isis hello-multiplier
CLI-643
604 configure interface gigabitethernet * isis ipv6 metric
CLI-644
605 configure interface gigabitethernet * isis lsp-interval
CLI-645
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xvii
List of CLI Commands
C4 CMTS Rel. 8.0.7
606 configure interface gigabitethernet * isis lsp-mtu
CLI-646
607 configure interface gigabitethernet * isis metric
CLI-647
608 configure interface gigabitethernet * isis priority
CLI-648
609 configure interface gigabitethernet * isis protocol shutdown
CLI-649
610 configure interface gigabitethernet * isis retransmit-interval
CLI-650
611 configure interface gigabitethernet * isis small-hello
CLI-651
612 configure interface gigabitethernet * isis wide-metric
CLI-652
613 configure interface gigabitethernet * restore
CLI-653
614 configure interface gigabitethernet * shutdown
CLI-654
615 configure interface gigabitethernet * speed
CLI-655
616 configure interface loopback * description
CLI-656
617 configure interface loopback * ip address
CLI-657
618 configure interface loopback * ip ospf cost
CLI-658
619 configure interface loopback * ipv6 address
CLI-659
620 configure interface loopback * ipv6 enable
CLI-660
621 configure interface loopback * ipv6 ospf area
CLI-661
622 configure interface loopback * ipv6 ospf cost
CLI-662
623 configure interface loopback * ip vrf forwarding
CLI-663
624 configure interface loopback * isis ipv6 metric
CLI-664
625 configure interface loopback * isis ipv6 wide-metric
CLI-665
626 configure interface loopback * isis metric
CLI-666
627 configure interface loopback * isis wide-metric
CLI-667
628 configure interface loopback * shutdown
CLI-668
629 configure interface null
CLI-669
630 configure interface null * ip unreachables
CLI-671
631 configure interface null * ipv6 icmp unreachables
CLI-670
632 configure interface system-controller * soft-switch
CLI-672
633 configure interface tengigabitethernet
CLI-673
634 configure interface tengigabitethernet * description
CLI-674
635 configure interface tengigabitethernet * encapsulation dot1q
CLI-675
636 configure interface tengigabitethernet * encapsulation dot1q * priority
CLI-676
637 configure interface tengigabitethernet * encapsulation no
CLI-677
638 configure interface tengigabitethernet * flowcontrol receive
CLI-678
639 configure interface tengigabitethernet * flowcontrol send
CLI-679
640 configure interface tengigabitethernet * igmp static-group
CLI-680
641 configure interface tengigabitethernet * igmp static-group * source
CLI-681
xviii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
642 configure interface tengigabitethernet * ip access-group
CLI-682
643 configure interface tengigabitethernet * ip address
CLI-683
644 configure interface tengigabitethernet * ip directed-broadcast
CLI-684
645 configure interface tengigabitethernet * ip igmp
CLI-685
646 configure interface tengigabitethernet * ip igmp access-group
CLI-686
647 configure interface tengigabitethernet * ip igmp static-group
CLI-687
648 configure interface tengigabitethernet * ip igmp static-group * source
CLI-688
649 configure interface tengigabitethernet * ip ospf authentication-key
CLI-689
650 configure interface tengigabitethernet * ip ospf authentication key-chain
CLI-690
651 configure interface tengigabitethernet * ip ospf auto-delete-neighbor
CLI-691
652 configure interface tengigabitethernet * ip ospf cost
CLI-692
653 configure interface tengigabitethernet * ip ospf dead-interval
CLI-693
654 configure interface tengigabitethernet * ip ospf graceful-restart restart-helper
CLI-694
655 configure interface tengigabitethernet * ip ospf graceful-restart-timeout
CLI-695
656 configure interface tengigabitethernet * ip ospf hello-interval
CLI-696
657 configure interface tengigabitethernet * ip ospf message-digest-key * md5
CLI-697
658 configure interface tengigabitethernet * ip ospf network
CLI-698
659 configure interface tengigabitethernet * ip ospf priority
CLI-699
660 configure interface tengigabitethernet * ip ospf retransmit-interval
CLI-700
661 configure interface tengigabitethernet * ip ospf transmit-delay
CLI-701
662 configure interface tengigabitethernet * ip pim dr-priority
CLI-702
663 configure interface tengigabitethernet * ip pim hello-holdtime
CLI-703
664 configure interface tengigabitethernet * ip pim message-holdtime
CLI-704
665 configure interface tengigabitethernet * ip pim message-interval
CLI-705
666 configure interface tengigabitethernet * ip pim query-interval
CLI-706
667 configure interface tengigabitethernet * ip pim sparse-mode-ssm
CLI-707
668 configure interface tengigabitethernet * ip policy route-map-policy
CLI-708
669 configure interface tengigabitethernet * ip rip authentication key
CLI-709
670 configure interface tengigabitethernet * ip rip authentication key-chain
CLI-710
671 configure interface tengigabitethernet * ip rip authentication mode
CLI-711
672 configure interface tengigabitethernet * ip rip authentication mode md5
CLI-712
673 configure interface tengigabitethernet * ip rip authentication mode text
CLI-713
674 configure interface tengigabitethernet * ip rip default-metric
CLI-714
675 configure interface tengigabitethernet * ip rip receive version
CLI-715
676 configure interface tengigabitethernet * ip router isis
CLI-716
677 configure interface tengigabitethernet * ip scm access-group
CLI-717
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xix
List of CLI Commands
C4 CMTS Rel. 8.0.7
678 configure interface tengigabitethernet * ip unreachables
CLI-718
679 configure interface tengigabitethernet * ipv6 address
CLI-720
680 configure interface tengigabitethernet * ipv6 enable
CLI-721
681 configure interface tengigabitethernet * ipv6 icmp param-problem
CLI-722
682 configure interface tengigabitethernet * ipv6 icmp too-big
CLI-723
683 configure interface tengigabitethernet * ipv6 icmp unreachables
CLI-724
684 configure interface tengigabitethernet * ipv6 mtu
CLI-725
685 configure interface tengigabitethernet * ipv6 nd dad attempts
CLI-726
686 configure interface tengigabitethernet * ipv6 nd managed-config-flag
CLI-727
687 configure interface tengigabitethernet * ipv6 nd ns-interval
CLI-728
688 configure interface tengigabitethernet * ipv6 nd other-config-flag
CLI-729
689 configure interface tengigabitethernet * ipv6 nd prefix
CLI-730
690 configure interface tengigabitethernet * ipv6 nd prefix * at
CLI-731
691 configure interface tengigabitethernet * ipv6 nd prefix * infinite
CLI-732
692 configure interface tengigabitethernet * ipv6 nd prefix * no-advertise
CLI-733
693 configure interface tengigabitethernet * ipv6 nd ra interval
CLI-734
694 configure interface tengigabitethernet * ipv6 nd ra lifetime
CLI-735
695 configure interface tengigabitethernet * ipv6 nd ra reachable-time
CLI-736
696 configure interface tengigabitethernet * ipv6 nd ra suppress
CLI-737
697 configure interface tengigabitethernet * ipv6 ospf
CLI-738
698 configure interface tengigabitethernet * ipv6 ospf area
CLI-739
699 configure interface tengigabitethernet * ipv6 ospf cost
CLI-740
700 configure interface tengigabitethernet * ipv6 ospf dead-interval
CLI-741
701 configure interface tengigabitethernet * ipv6 ospf hello-interval
CLI-742
702 configure interface tengigabitethernet * ipv6 ospf mtu-ignore
CLI-743
703 configure interface tengigabitethernet * ipv6 ospf network
CLI-744
704 configure interface tengigabitethernet * ipv6 ospf priority
CLI-745
705 configure interface tengigabitethernet * ipv6 ospf retransmit-interval
CLI-746
706 configure interface tengigabitethernet * ipv6 ospf transmit-delay
CLI-747
707 configure interface tengigabitethernet * ipv6 router isis
CLI-748
708 configure interface tengigabitethernet * ipv6 traffic-filter
CLI-749
709 configure interface tengigabitethernet * ip vrf forwarding
CLI-719
710 configure interface tengigabitethernet * isis authentication key-chain
CLI-750
711 configure interface tengigabitethernet * isis authentication mode
CLI-751
712 configure interface tengigabitethernet * isis circuit-type
CLI-752
713 configure interface tengigabitethernet * isis csnp-interval
CLI-753
xx
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
714 configure interface tengigabitethernet * isis ds-hello-interval
CLI-754
715 configure interface tengigabitethernet * isis hello-interval
CLI-755
716 configure interface tengigabitethernet * isis hello-multiplier
CLI-756
717 configure interface tengigabitethernet * isis ipv6 metric
CLI-757
718 configure interface tengigabitethernet * isis lsp-interval
CLI-758
719 configure interface tengigabitethernet * isis lsp-mtu
CLI-759
720 configure interface tengigabitethernet * isis metric
CLI-760
721 configure interface tengigabitethernet * isis priority
CLI-761
722 configure interface tengigabitethernet * isis protocol shutdown
CLI-762
723 configure interface tengigabitethernet * isis retransmit-interval
CLI-763
724 configure interface tengigabitethernet * isis small-hello
CLI-764
725 configure interface tengigabitethernet * isis wide-metric
CLI-765
726 configure interface tengigabitethernet * restore
CLI-766
727 configure interface tengigabitethernet * shutdown
CLI-767
728 configure ip domain-list
CLI-768
729 configure ip domain-lookup
CLI-769
730 configure ip domain-name
CLI-770
731 configure ip fqdn-cache enable
CLI-771
732 configure ip fqdn-cache poll-interval
CLI-772
733 configure ip fqdn-cache refresh
CLI-773
734 configure ip local policy route-map-policy
CLI-774
735 configure ip multicast cable-mac-fwd-all-ds
CLI-775
736 configure ip multicast default-group-service-class
CLI-776
737 configure ip multicast mac-ip
CLI-777
738 configure ip multicast-routing
CLI-778
739 configure ip name-server
CLI-779
740 configure ip prefix-list
CLI-780
741 configure ip prefix-list * permit
CLI-781
742 configure ip route
CLI-782
743 configure ip scm access
CLI-783
744 configure ip ssh ciphers
CLI-785
745 configure ip ssh idle-timeout
CLI-786
746 configure ip ssh login
CLI-787
747 configure ip ssh max-auth-fail
CLI-788
748 configure ip ssh max-clients
CLI-789
749 configure ip ssh password-auth
CLI-790
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxi
List of CLI Commands
C4 CMTS Rel. 8.0.7
750 configure ip ssh password-auth-req
CLI-791
751 configure ip ssh port
CLI-792
752 configure ip ssh port-forwarding
CLI-793
753 configure ip ssh public-key-auth
CLI-794
754 configure ip ssh public-key-auth-first
CLI-795
755 configure ip ssh public-key-auth-req
CLI-796
756 configure ip ssh restart
CLI-797
757 configure ip ssh sftp
CLI-798
758 configure ip ssh shutdown
CLI-799
759 configure ip unreachables
CLI-800
760 configure ipv6 access-list
CLI-801
761 configure ipv6 access-list resequence
CLI-802
762 configure ipv6 dhcp relay source-interface
CLI-803
763 configure ipv6 dhcp relay use-link-address
CLI-804
764 configure ipv6 hop-limit
CLI-805
765 configure ipv6 icmp param-problem
CLI-806
766 configure ipv6 icmp time-exceeded
CLI-807
767 configure ipv6 icmp too-big
CLI-808
768 configure ipv6 icmp unreachables
CLI-809
769 configure ipv6 nd state not-present
CLI-810
770 configure ipv6 nd state searching
CLI-811
771 configure ipv6 nd timeout
CLI-812
772 configure ipv6 neighbor * cable
CLI-813
773 configure ipv6 neighbor * cable-mac
CLI-814
774 configure ipv6 neighbor * gigabitethernet
CLI-815
775 configure ipv6 neighbor * tengigabitethernet
CLI-816
776 configure ipv6 pd-route-injection
CLI-817
777 configure ipv6 prefix-stability
CLI-818
778 configure ipv6 route
CLI-819
779 configure ipv6 route * cable
CLI-820
780 configure ipv6 route * cable-mac
CLI-821
781 configure ipv6 route * gigabitethernet
CLI-822
782 configure ipv6 route * null
CLI-823
783 configure ipv6 route pd-data-retrieve
CLI-824
784 configure ipv6 route pd-data-retrieve all
CLI-825
785 configure ipv6 route pd-data-retrieve cable-mac
CLI-826
xxii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
786 configure ipv6 router ospf area * default cost
CLI-827
787 configure ipv6 router ospf area * nssa *
CLI-828
788 configure ipv6 router ospf area * range *
CLI-829
789 configure ipv6 router ospf area * stub
CLI-830
790 configure ipv6 router ospf as-border-router
CLI-831
791 configure ipv6 router ospf distance *
CLI-832
792 configure ipv6 router ospf distance * ospf external
CLI-833
793 configure ipv6 router ospf distribute-list
CLI-834
794 configure ipv6 router ospf passive-interface *
CLI-835
795 configure ipv6 router ospf redistribute connected
CLI-836
796 configure ipv6 router ospf redistribute isis
CLI-837
797 configure ipv6 router ospf redistribute pd
CLI-838
798 configure ipv6 router ospf redistribute static
CLI-839
799 configure ipv6 router ospf router-id
CLI-840
800 configure ipv6 router ospf shutdown
CLI-841
801 configure ipv6 router pd distance
CLI-842
802 configure ipv6 router static distance
CLI-843
803 configure ipv6 route * tengigabitethernet
CLI-844
804 configure ip-video attribute-encoding
CLI-845
805 configure ip-video dbc-delay-timer
CLI-846
806 configure ip vrf
CLI-847
807 configure key chain
CLI-848
808 configure key chain * key
CLI-849
809 configure key chain * key * accept-lifetime
CLI-850
810 configure key chain * key * accept-lifetime duration
CLI-851
811 configure key chain * key * accept-lifetime infinite
CLI-852
812 configure key chain * key * key-string
CLI-853
813 configure key chain * key * send-lifetime
CLI-854
814 configure key chain * key * send-lifetime duration
CLI-855
815 configure key chain * key * send-lifetime infinite
CLI-856
816 configure l2vpn cable-mac
CLI-857
817 configure l2vpn cm capability
CLI-858
818 configure l2vpn forwarding
CLI-859
819 configure l2vpn network-interface gigabitethernet
CLI-860
820 configure l2vpn network-interface tengigabitethernet
CLI-861
821 configure l2vpn vlanid-range
CLI-862
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxiii
List of CLI Commands
C4 CMTS Rel. 8.0.7
822 configure line
CLI-863
823 configure line * accounting
CLI-865
824 configure logging console
CLI-866
825 configure logging debug
CLI-867
826 configure logging facility
CLI-871
827 configure logging history size
CLI-872
828 configure logging host
CLI-873
829 configure logging local-volatile
CLI-874
830 configure logging monitor
CLI-875
831 configure logging override event
CLI-876
832 configure logging override reset
CLI-877
833 configure logging priority cli
CLI-878
834 configure logging proprietary
CLI-879
835 configure logging snmp
CLI-880
836 configure logging syslog
CLI-881
837 configure logging throttle
CLI-882
838 configure logging trap
CLI-883
839 configure ntp
CLI-885
840 configure ntp authentication
CLI-886
841 configure ntp authentication-key * md5
CLI-887
842 configure ntp server
CLI-888
843 configure ntp server * broadcast
CLI-889
844 configure ntp server * manycast
CLI-890
845 configure ntp server * multicast
CLI-891
846 configure operation dul-packet-interval
CLI-892
847 configure operation event
CLI-893
848 configure operation mode
CLI-894
849 configure operation overload-control sensitivity
CLI-895
850 configure operation overload-control threshold
CLI-896
851 configure packetcable
CLI-897
852 configure packetcable dqos shutdown
CLI-898
853 configure packetcable dqos timer
CLI-899
854 configure packetcable eventmsg batch-size
CLI-900
855 configure packetcable eventmsg billing-events
CLI-901
856 configure packetcable eventmsg element-id
CLI-902
857 configure packetcable eventmsg max-age
CLI-903
xxiv
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
858 configure packetcable eventmsg retry limit
CLI-904
859 configure packetcable eventmsg retry timer
CLI-905
860 configure packetcable gate send-subscriberid
CLI-906
861 configure packetcable pcmm shutdown
CLI-907
862 configure packetcable pcmm subscriber-id vrf
CLI-908
863 configure packetcable pcmm timer t1
CLI-909
864 configure packetcable pcmm version
CLI-910
865 configure packetcable throttle
CLI-911
866 configure packetcable voice-limits allowed-emergency
CLI-912
867 configure packetcable voice-limits allowed-normal
CLI-913
868 configure packetcable voice-limits allowed-total
CLI-914
869 configure packetcable voice-limits downstream
CLI-915
870 configure packetcable voice-limits emergency-preemption
CLI-916
871 configure packetcable voice-limits reserved-emergency
CLI-917
872 configure packetcable voice-limits reserved-normal
CLI-918
873 configure packetcable voice-limits set-all
CLI-919
874 configure pagination
CLI-920
875 configure power-monitor
CLI-921
876 configure privilege exec level
CLI-922
877 configure privilege exec reset
CLI-923
878 configure prompt
CLI-924
879 configure qos-sc name
CLI-925
880 configure reset cable-modem
CLI-928
881 configure reset cable-modem all
CLI-929
882 configure reset cable-modem bonded
CLI-930
883 configure reset cable-modem cable
CLI-931
884 configure reset cable-modem cable * oui
CLI-932
885 configure reset cable-modem cable * vendor
CLI-933
886 configure reset cable-modem fpcm-id
CLI-934
887 configure reset cable-modem vendor
CLI-935
888 configure reset slot
CLI-936
889 configure reset system
CLI-937
890 configure route-map
CLI-938
891 configure route-map * deny
CLI-939
892 configure route-map * deny * match as-path regexp
CLI-940
893 configure route-map * deny * match community regexp
CLI-941
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxv
List of CLI Commands
C4 CMTS Rel. 8.0.7
894 configure route-map * deny * match ip address
CLI-942
895 configure route-map * deny * match ip next-hop
CLI-943
896 configure route-map * deny * match ip route-source
CLI-944
897 configure route-map * deny * match metric
CLI-945
898 configure route-map * match as-path
CLI-946
899 configure route-map * match as-path regexp
CLI-947
900 configure route-map * match community
CLI-948
901 configure route-map * match ip address
CLI-949
902 configure route-map * match ip next-hop
CLI-950
903 configure route-map * match ip route-source
CLI-951
904 configure route-map * match metric
CLI-952
905 configure route-map * permit
CLI-953
906 configure route-map * permit * continue
CLI-954
907 configure route-map * permit * match as-path regexp
CLI-955
908 configure route-map * permit * match community
CLI-956
909 configure route-map* permit * match community regexp
CLI-957
910 configure route-map * permit * match ip address
CLI-958
911 configure route-map * permit * match ip next-hop
CLI-959
912 configure route-map * permit * match ip route-source
CLI-960
913 configure route-map * permit * match metric
CLI-961
914 configure route-map * permit * set as-path prepend
CLI-962
915 configure route-map * permit * set comm-list delete no
CLI-963
916 configure route-map * permit * set comm-list delete regexp
CLI-964
917 configure route-map * permit * set community
CLI-965
918 configure route-map * permit * set community none
CLI-966
919 configure route-map * permit * set dampening
CLI-967
920 configure route-map * permit * set ip next-hop
CLI-968
921 configure route-map * permit * set local-preference
CLI-969
922 configure route-map * permit * set metric
CLI-970
923 configure route-map * permit * set origin
CLI-971
924 configure route-map * permit * set weight
CLI-972
925 configure route-map-policy
CLI-973
926 configure route-map-policy * deny
CLI-984
927 configure route-map-policy * deny match ip address
CLI-985
928 configure route-map-policy * match ip address
CLI-986
929 configure route-map-policy * permit
CLI-987
xxvi
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
930 configure route-map-policy * permit * match ip address
CLI-988
931 configure route-map-policy * permit * set ip backup-next-hop
CLI-989
932 configure route-map-policy * permit * set ip interface null
CLI-990
933 configure route-map-policy * permit * set ip next-hop
CLI-991
934 configure route-map-policy * permit * set ip precedence
CLI-992
935 configure route-map-policy * permit * set ip tos
CLI-993
936 configure route-map set as-path prepend
CLI-974
937 configure route-map * set as-path prepend
CLI-994
938 configure route-map set comm-list delete regexp
CLI-975
939 configure route-map * set comm-list delete regexp
CLI-995
940 configure route-map set community
CLI-976
941 configure route-map * set community
CLI-996
942 configure route-map * set community add
CLI-997
943 configure route-map * set community additive
CLI-998
944 configure route-map * set community delete
CLI-999
945 configure route-map * set community none
CLI-1000
946 configure route-map set community none 947 configure route-map * set dampening 948 configure route-map set dampening 949 configure route-map * set ip next-hop 950 configure route-map set ip next-hop 951 configure route-map * set local-preference 952 configure route-map set local-preference 953 configure route-map * set metric
CLI-977 CLI-1001 CLI-978 CLI-1002 CLI-979 CLI-1003 CLI-980 CLI-1004
954 configure route-map set metric
CLI-981
955 configure route-map * set origin
CLI-1005
956 configure route-map set origin 957 configure route-map * set weight 958 configure route-map set weight
CLI-982 CLI-1006 CLI-983
959 configure router bgp
CLI-1007
960 configure router bgp * aggregate-address
CLI-1008
961 configure router bgp * aggregate-address * * as-set summary-only
CLI-1009
962 configure router bgp * aggregate-address * * as-set summary-only advertise-map
CLI-1010
963 configure router bgp * aggregate-address * * as-set summary-only attribute-map
CLI-1011
964 configure router bgp * aggregate-address * * as-set suppress-map
CLI-1012
965 configure router bgp * bgp always-compare-med
CLI-1013
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxvii
List of CLI Commands
C4 CMTS Rel. 8.0.7
966 configure router bgp * bgp cluster-id
CLI-1014
967 configure router bgp * bgp confederation identifier
CLI-1015
968 configure router bgp * bgp default local-preference
CLI-1016
969 configure router bgp * bgp deterministic-med
CLI-1017
970 configure router bgp * bgp graceful-restart
CLI-1018
971 configure router bgp * bgp graceful-restart purge-time
CLI-1019
972 configure router bgp * bgp graceful-restart restart-time
CLI-1020
973 configure router bgp * bgp graceful-restart stalepaths-time
CLI-1021
974 configure router bgp * bgp pause-threshold
CLI-1022
975 configure router bgp * bgp router-id
CLI-1023
976 configure router bgp * distance
CLI-1024
977 configure router bgp * distance bgp
CLI-1025
978 configure router bgp * distribute-list * out connected
CLI-1026
979 configure router bgp * distribute-list * out isis
CLI-1027
980 configure router bgp * distribute-list * out ospf
CLI-1028
981 configure router bgp * distribute-list * out rip
CLI-1029
982 configure router bgp * distribute-list * out static
CLI-1030
983 configure router bgp * maximum-paths
CLI-1031
984 configure router bgp * maximum-paths * ibgp
CLI-1032
985 configure router bgp * neighbor * advertisement-interval
CLI-1033
986 configure router bgp * neighbor * as-origin-interval
CLI-1034
987 configure router bgp * neighbor * confed
CLI-1035
988 configure router bgp * neighbor * connect-retry
CLI-1036
989 configure router bgp * neighbor * enforce-first-as
CLI-1037
990 configure router bgp * neighbor * maximum-prefix
CLI-1038
991 configure router bgp * neighbor * maximum-prefix * warning-only
CLI-1039
992 configure router bgp * neighbor * next-hop-self
CLI-1040
993 configure router bgp * neighbor * passive
CLI-1041
994 configure router bgp * neighbor * password
CLI-1042
995 configure router bgp * neighbor * prefix-list * in
CLI-1043
996 configure router bgp * neighbor * prefix-list * out
CLI-1044
997 configure router bgp * neighbor * remote-as
CLI-1045
998 configure router bgp * neighbor * remove-private-as
CLI-1046
999 configure router bgp * neighbor * route-map * in
CLI-1047
1000 configure router bgp * neighbor * route-map * out
CLI-1048
1001 configure router bgp * neighbor * route-reflector-client
CLI-1049
xxviii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1002 configure router bgp * neighbor * route-reflector-client meshed
CLI-1050
1003 configure router bgp * neighbor * route-refresh
CLI-1051
1004 configure router bgp * neighbor * shutdown
CLI-1052
1005 configure router bgp * neighbor * split-horizon
CLI-1053
1006 configure router bgp * neighbor * timers
CLI-1054
1007 configure router bgp * neighbor * update-source cable-mac * remote-as
CLI-1055
1008 configure router bgp * neighbor * update-source gigabitethernet * remote-as
CLI-1056
1009 configure router bgp * neighbor * update-source ip-address * remote-as
CLI-1057
1010 configure router bgp * neighbor * update-source loopback * remote-as
CLI-1058
1011 configure router bgp * neighbor * update-source tengigabitethernet * remote-as
CLI-1059
1012 configure router bgp * redistribute connected
CLI-1060
1013 configure router bgp * redistribute isis
CLI-1061
1014 configure router bgp * redistribute ospf
CLI-1062
1015 configure router bgp * redistribute rip
CLI-1063
1016 configure router bgp * redistribute static
CLI-1064
1017 configure router bgp * shutdown
CLI-1065
1018 configure router isis
CLI-1066
1019 configure router isis address-family
CLI-1067
1020 configure router isis address-family ipv4 distance
CLI-1068
1021 configure router isis address-family ipv4 distance * isis
CLI-1069
1022 configure router isis address-family ipv4 distribute-list * out *
CLI-1070
1023 configure router isis address-family ipv4 enable
CLI-1071
1024 configure router isis address-family ipv4 redistribute bgp
CLI-1072
1025 configure router isis address-family ipv4 redistribute connected
CLI-1073
1026 configure router isis address-family ipv4 redistribute ospf
CLI-1074
1027 configure router isis address-family ipv4 redistribute rip
CLI-1075
1028 configure router isis address-family ipv4 redistribute static
CLI-1076
1029 configure router isis address-family ipv4 summary-address
CLI-1077
1030 configure router isis address-family ipv6 distance * isis
CLI-1078
1031 configure router isis address-family ipv6 distribute-list * out *
CLI-1079
1032 configure router isis address-family ipv6 enable
CLI-1080
1033 configure router isis address-family ipv6 multi-topology
CLI-1081
1034 configure router isis address-family ipv6 redistribute connected
CLI-1082
1035 configure router isis address-family ipv6 redistribute ospf
CLI-1083
1036 configure router isis address-family ipv6 redistribute pd
CLI-1084
1037 configure router isis address-family ipv6 redistribute static
CLI-1085
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxix
List of CLI Commands
C4 CMTS Rel. 8.0.7
1038 configure router isis address-family ipv6 summary-prefix
CLI-1086
1039 configure router isis authentication key-chain
CLI-1087
1040 configure router isis authentication mode
CLI-1088
1041 configure router isis distance
CLI-1089
1042 configure router isis distance * isis
CLI-1090
1043 configure router isis distribute-list * out
CLI-1091
1044 configure router isis ecmp
CLI-1092
1045 configure router isis graceful-restart help-peer
CLI-1093
1046 configure router isis graceful-restart interface wait
CLI-1094
1047 configure router isis graceful-restart t3
CLI-1095
1048 configure router isis hostname dynamic
CLI-1097
1049 configure router isis is-type
CLI-1098
1050 configure router isis lsp-gen-interval
CLI-1099
1051 configure router isis lsp-refresh-interval
CLI-1100
1052 configure router isis max-lsp-lifetime
CLI-1101
1053 configure router isis metric-style
CLI-1102
1054 configure router isis net
CLI-1103
1055 configure router isis passive-interface cable
CLI-1104
1056 configure router isis passive-interface cable-mac
CLI-1105
1057 configure router isis passive-interface gigabitethernet
CLI-1106
1058 configure router isis passive-interface loopback
CLI-1107
1059 configure router isis passive-interface tengigabitethernet
CLI-1108
1060 configure router isis redistribute bgp
CLI-1109
1061 configure router isis redistribute connected
CLI-1110
1062 configure router isis redistribute ospf
CLI-1111
1063 configure router isis redistribute rip
CLI-1112
1064 configure router isis redistribute static
CLI-1113
1065 configure router isis set-overload-bit
CLI-1114
1066 configure router isis shutdown
CLI-1115
1067 configure router isis spf-interval
CLI-1116
1068 configure router isis summary-address
CLI-1117
1069 configure router ospf * area
CLI-1118
1070 configure router ospf * area * default-cost
CLI-1119
1071 configure router ospf * area * nssa
CLI-1120
1072 configure router ospf * area * range
CLI-1121
1073 configure router ospf * area * stub
CLI-1122
xxx
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1074 configure router ospf * area * virtual-link
CLI-1123
1075 configure router ospf * as-border-router
CLI-1124
1076 configure router ospf * compatible rfc1583
CLI-1125
1077 configure router ospf * distance
CLI-1126
1078 configure router ospf * distance * ospf external
CLI-1127
1079 configure router ospf * distribute-list * out
CLI-1128
1080 configure router ospf * graceful-restart grace-period
CLI-1129
1081 configure router ospf * network * area
CLI-1130
1082 configure router ospf * passive-interface cable-mac
CLI-1131
1083 configure router ospf * passive-interface gigabitethernet
CLI-1132
1084 configure router ospf * passive-interface tengigabitethernet
CLI-1133
1085 configure router ospf * redistribute bgp
CLI-1134
1086 configure router ospf * redistribute connected
CLI-1135
1087 configure router ospf * redistribute isis
CLI-1136
1088 configure router ospf * redistribute rip
CLI-1137
1089 configure router ospf * redistribute static
CLI-1138
1090 configure router ospf * router-id
CLI-1139
1091 configure router ospf shutdown
CLI-1140
1092 configure router ospf * timer delay-spf
CLI-1141
1093 configure router ospf * timer lsa-checksum-audit
CLI-1142
1094 configure router rip * distance
CLI-1143
1095 configure router rip * distribute-list
CLI-1144
1096 configure router rip * distribute-list * in
CLI-1145
1097 configure router rip * distribute-list * out
CLI-1146
1098 configure router rip * network
CLI-1147
1099 configure router rip passive-interface *
CLI-1148
1100 configure router rip * redistribute bgp
CLI-1149
1101 configure router rip * redistribute connected
CLI-1150
1102 configure router rip * redistribute isis
CLI-1151
1103 configure router rip * redistribute ospf
CLI-1152
1104 configure router rip * redistribute static
CLI-1153
1105 configure router rip * send-only-interface
CLI-1154
1106 configure router rip * shutdown
CLI-1155
1107 configure router rip * timers flush
CLI-1156
1108 configure router rip * timers invalid
CLI-1157
1109 configure router rip * timers update
CLI-1158
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxxi
List of CLI Commands
C4 CMTS Rel. 8.0.7
1110 configure router static * distance
CLI-1159
1111 configure session-timeout
CLI-1160
1112 configure shelfname
CLI-1161
1113 configure slot * proto-throttle-rate
CLI-1162
1114 configure slot * shutdown
CLI-1164
1115 configure slot * spare-group
CLI-1165
1116 configure slot * type
CLI-1166
1117 configure snmp-server card-trap-inh slot
CLI-1167
1118 configure snmp-server community
CLI-1168
1119 configure snmp-server contact
CLI-1169
1120 configure snmp-server context
CLI-1170
1121 configure snmp-server data max-read-ahead
CLI-1171
1122 configure snmp-server data refresh-time
CLI-1172
1123 configure snmp-server data snmp-agent max-read-ahead
CLI-1173
1124 configure snmp-server data snmp-agent refresh-time
CLI-1174
1125 configure snmp-server enable traps snmp
CLI-1175
1126 configure snmp-server engineid remote
CLI-1176
1127 configure snmp-server group
CLI-1177
1128 configure snmp-server host
CLI-1178
1129 configure snmp-server location
CLI-1180
1130 configure snmp-server notify-filter profile
CLI-1181
1131 configure snmp-server port-trap-inh cable-mac
CLI-1182
1132 configure snmp-server port-trap-inh slot * port
CLI-1183
1133 configure snmp-server trap-source
CLI-1184
1134 configure snmp-server trap-source cable-mac
CLI-1185
1135 configure snmp-server trap-source ethernet
CLI-1186
1136 configure snmp-server trap-source gigabitethernet
CLI-1187
1137 configure snmp-server trap-source loopback
CLI-1188
1138 configure snmp-server trap-source tengigabitethernet
CLI-1189
1139 configure snmp-server user
CLI-1190
1140 configure snmp-server view
CLI-1192
1141 configure switch slot
CLI-1193
1142 configure tacacs group * host
CLI-1194
1143 configure tacacs host
CLI-1195
1144 configure telnet-server
CLI-1196
1145 configure timestamp
CLI-1197
xxxii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1146 configure tod server
CLI-1198
1147 configure username
CLI-1199
1148 copy
CLI-1201
1149 copy * cacert-config
CLI-1203
1150 copy cacert-config
CLI-1204
1151 copy * provcmcert-config
CLI-1205
1152 copy provcmcert-config
CLI-1206
1153 copy * rootcert-config
CLI-1207
1154 copy rootcert-config
CLI-1208
1155 copy * running-config
CLI-1209
1156 copy running-config
CLI-1210
1157 copy startup-config
CLI-1211
1158 delete
CLI-1212
1159 df
CLI-1213
1160 dir
CLI-1214
1161 disable
CLI-1216
1162 du
CLI-1217
1163 echo
CLI-1221
1164 enable
CLI-1222
1165 end
CLI-1223
1166 erase nvram
CLI-1224
1167 exc file
CLI-1225
1168 exit
CLI-1226
1169 format
CLI-1227
1170 help
CLI-1228
1171 help edit
CLI-1229
1172 history
CLI-1230
1173 kill
CLI-1231
1174 kill console
CLI-1232
1175 kill vty
CLI-1233
1176 logout
CLI-1234
1177 mkdir
CLI-1235
1178 more
CLI-1236
1179 ping
CLI-1237
1180 ping docsis
CLI-1239
1181 ping ipv6
CLI-1241
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxxiii
List of CLI Commands
C4 CMTS Rel. 8.0.7
1182 ping ipv6 * output-interface cable-mac
CLI-1243
1183 ping ipv6 * output-interface gigabitethernet
CLI-1244
1184 ping ipv6 * output-interface loopback
CLI-1245
1185 ping ipv6 * output-interface tengigabitethernet
CLI-1246
1186 pwd
CLI-1247
1187 quit
CLI-1248
1188 reload
CLI-1249
1189 reload commit
CLI-1250
1190 rmdir
CLI-1251
1191 scandisk
CLI-1252
1192 scandisk halt
CLI-1253
1193 send
CLI-1254
1194 send all
CLI-1255
1195 send console
CLI-1256
1196 send vty
CLI-1257
1197 show access-list
CLI-1258
1198 show accounting
CLI-1260
1199 show alias
CLI-1261
1200 show all-commands
CLI-1262
1201 show arp
CLI-1264
1202 show async-bootp
CLI-1265
1203 show audit
CLI-1266
1204 show audit sequence
CLI-1267
1205 show audit sequence * card
CLI-1269
1206 show authentication
CLI-1270
1207 show authorization
CLI-1271
1208 show cable bonding-group-status
CLI-1272
1209 show cable bundle
CLI-1273
1210 show cable channel-sets
CLI-1274
1211 show cable dsg
CLI-1275
1212 show cable dsg ds-frequency-list
CLI-1276
1213 show cable dsg timer-list
CLI-1278
1214 show cable dsg tunnel
CLI-1280
1215 show cable dsg tunnel * classifier
CLI-1281
1216 show cable dsg tunnel-group
CLI-1282
1217 show cable dsg verbose
CLI-1283
xxxiv
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1218 show cable dsg vsp-list
CLI-1284
1219 show cable enable-trap
CLI-1286
1220 show cable equalizer-coeff
CLI-1287
1221 show cable fiber-node
CLI-1288
1222 show cable filter
CLI-1289
1223 show cable flap-list
CLI-1291
1224 show cable global-settings
CLI-1297
1225 show cable host authorization
CLI-1298
1226 show cable intercept
CLI-1299
1227 show cable load-balance
CLI-1300
1228 show cable load-balance channels
CLI-1301
1229 show cable load-balance cm-service-type
CLI-1303
1230 show cable load-balance failed-list
CLI-1304
1231 show cable load-balance group
CLI-1305
1232 show cable load-balance movable
CLI-1306
1233 show cable load-balance notmovable
CLI-1308
1234 show cable load-balance oui
CLI-1309
1235 show cable load-balance policy
CLI-1310
1236 show cable load-balance statistics
CLI-1311
1237 show cable metering
CLI-1313
1238 show cable modem
CLI-1316
1239 show cable modem bonded-impaired
CLI-1320
1240 show cable modem bonded-uchannels
CLI-1322
1241 show cable modem column
CLI-1324
1242 show cable modem count
CLI-1328
1243 show cable modem deny
CLI-1329
1244 show cable modem detail
CLI-1330
1245 show cable modem errors
CLI-1334
1246 show cable modem flexpath
CLI-1336
1247 show cable modem format
CLI-1337
1248 show cable modem offline
CLI-1338
1249 show cable modem phy
CLI-1339
1250 show cable modem qos
CLI-1340
1251 show cable modem summary
CLI-1341
1252 show cable modem summary cable-mac
CLI-1343
1253 show cable modem summary fiber-node
CLI-1344
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxxv
List of CLI Commands
C4 CMTS Rel. 8.0.7
1254 show cable modem summary mac cable-mac
CLI-1345
1255 show cable modem summary slot
CLI-1346
1256 show cable modem summary state
CLI-1347
1257 show cable modem system-description
CLI-1350
1258 show cable modulation-profile
CLI-1351
1259 show cable multicast db cable-mac
CLI-1353
1260 show cable multicast db cm *
CLI-1354
1261 show cable multicast db grp-ip-addr
CLI-1355
1262 show cable multicast db session-type
CLI-1356
1263 show cable multicast db src-ip-addr
CLI-1357
1264 show cable multicast group-qos
CLI-1358
1265 show cable multicast qos group
CLI-1359
1266 show cable noise
CLI-1360
1267 show cable privacy ca-certificates
CLI-1363
1268 show cable privacy cm-certificates
CLI-1366
1269 show cable privacy manufacturer-cert-list
CLI-1368
1270 show cable privacy root-cert-list
CLI-1370
1271 show cable proto-throttle
CLI-1372
1272 show cable qos profile
CLI-1375
1273 show cable rcc-status cable-mac
CLI-1376
1274 show cable rcc-status cable-mac * rcp-id
CLI-1378
1275 show cable rcc-status cable-mac * rcp-id * rcc
CLI-1379
1276 show cable rcc-status cable-mac * rcp-id * status-id
CLI-1380
1277 show cable service-group
CLI-1381
1278 show cable spectrum-group
CLI-1382
1279 show cable spectrum-group state
CLI-1383
1280 show cable spectrum-group trigger
CLI-1384
1281 show cable supervision
CLI-1385
1282 show cable unicast-polling
CLI-1387
1283 show chassistype
CLI-1388
1284 show clock
CLI-1389
1285 show controllers cable
CLI-1390
1286 show controllers cable * authorization-module
CLI-1392
1287 show controllers cable * downstream
CLI-1393
1288 show controllers cable * ingress-cancellation
CLI-1399
1289 show controllers cable-mac
CLI-1400
xxxvi
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1290 show controllers cable-upstream
CLI-1402
1291 show controllers fabric
CLI-1404
1292 show controllers gigabitethernet
CLI-1406
1293 show controllers tengigabitethernet
CLI-1407
1294 show cos-mapping
CLI-1408
1295 show counts collection
CLI-1409
1296 show crypto dynamic-map
CLI-1410
1297 show crypto ipsec security-association lifetime
CLI-1411
1298 show crypto ipsec transform-set
CLI-1412
1299 show crypto isakmp
CLI-1413
1300 show crypto isakmp policy
CLI-1414
1301 show crypto map
CLI-1415
1302 show disk volume * scm
CLI-1416
1303 show distribute-list
CLI-1418
1304 show environment
CLI-1419
1305 show factory-eeprom
CLI-1421
1306 show history
CLI-1423
1307 show hostname
CLI-1424
1308 show image
CLI-1425
1309 show interface
CLI-1426
1310 show interface cable
CLI-1427
1311 show interface cable * allocated-bandwidth
CLI-1428
1312 show interface cable * bit-rate
CLI-1430
1313 show interface cable * cable downstream
CLI-1431
1314 show interface cable * cable downstream dsg
CLI-1433
1315 show interface cable * cable downstream dsg dcd
CLI-1434
1316 show interface cable * cable downstream dsg tunnel-group
CLI-1436
1317 show interface cable * cable downstream dsg verbose
CLI-1437
1318 show interface cable * cable privacy authorization
CLI-1438
1319 show interface cable * cable privacy base
CLI-1440
1320 show interface cable * cable privacy multicast map
CLI-1441
1321 show interface cable * cable privacy tek
CLI-1443
1322 show interface cable * cable upstream
CLI-1445
1323 show interface cable * cable upstream * spectrum-group
CLI-1447
1324 show interface cable * cable upstream * spectrum-group history
CLI-1448
1325 show interface cable-downstream
CLI-1450
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxxvii
List of CLI Commands
C4 CMTS Rel. 8.0.7
1326 show interface cable-downstream * bit-rate
CLI-1452
1327 show interface cable-downstream * cable dsg dcd
CLI-1453
1328 show interface cable-downstream * cable dsg tunnel-group
CLI-1454
1329 show interface cable-downstream * cable dsg verbose
CLI-1455
1330 show interface cable-downstream * cable ip-video
CLI-1456
1331 show interface cable-downstream * cable ip-video histogram
CLI-1457
1332 show interface cable-downstream * cable ip-video summary
CLI-1458
1333 show interface cable-downstream * mdd
CLI-1459
1334 show interface cable * filter-group
CLI-1449
1335 show interface cable-mac
CLI-1461
1336 show interface cable-mac * access-group
CLI-1463
1337 show interface cable-mac * allocated-bandwidth
CLI-1464
1338 show interface cable-mac bit-rate
CLI-1465
1339 show interface cable-mac * cable privacy authorization
CLI-1467
1340 show interface cable-mac * cable privacy base
CLI-1468
1341 show interface cable-mac * cable privacy multicast map
CLI-1469
1342 show interface cable-mac * cable privacy tek
CLI-1470
1343 show interface cable-mac * filter-group
CLI-1471
1344 show interface cable * mac-scheduler
CLI-1473
1345 show interface cable * mac-scheduler detail
CLI-1481
1346 show interface cable * mac-scheduler interval
CLI-1482
1347 show interface cable * mac-scheduler interval * type
CLI-1483
1348 show interface cable * mac-scheduler interval * upstream
CLI-1484
1349 show interface cable-mac * spectrum-group
CLI-1472
1350 show interface cable * multicast mcast-fwd-by-dsid
CLI-1485
1351 show interface cable * spectrum-group history
CLI-1486
1352 show interface cable * ugs counts
CLI-1487
1353 show interface cable-upstream
CLI-1489
1354 show interface cable-upstream * allocated-bandwidth
CLI-1490
1355 show interface cable-upstream * bit-rate
CLI-1491
1356 show interface cable-upstream * spectrum-group history
CLI-1492
1357 show interface gigabitethernet * access-group
CLI-1493
1358 show interface tengigabitethernet * access-group
CLI-1494
1359 show interface utilization
CLI-1495
1360 show ip bgp
CLI-1496
1361 show ip bgp neighbor
CLI-1497
xxxviii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1362 show ip bgp neighbor * advertised-routes
CLI-1498
1363 show ip bgp neighbor * advertised-routes paths
CLI-1499
1364 show ip bgp quote-regexp
CLI-1500
1365 show ip bgp regexp
CLI-1501
1366 show ip bgp summary
CLI-1502
1367 show ip domain-invquery
CLI-1503
1368 show ip domain-lookup
CLI-1504
1369 show ip domain-query
CLI-1505
1370 show ip fqdn-cache
CLI-1506
1371 show ip igmp groups
CLI-1507
1372 show ip igmp groups cable
CLI-1508
1373 show ip igmp groups cable-mac
CLI-1509
1374 show ip igmp groups detail
CLI-1510
1375 show ip igmp groups gigabitethernet
CLI-1511
1376 show ip igmp groups host
CLI-1512
1377 show ip igmp groups tengigabitethernet
CLI-1513
1378 show ip igmp interfaces
CLI-1514
1379 show ip igmp interfaces cable
CLI-1516
1380 show ip igmp interfaces cable-mac
CLI-1517
1381 show ip igmp interfaces gigabitethernet
CLI-1518
1382 show ip igmp interfaces tengigabitethernet
CLI-1519
1383 show ip interface
CLI-1520
1384 show ip interface brief
CLI-1523
1385 show ip interface * cable
CLI-1524
1386 show ip interface * cable-mac
CLI-1526
1387 show ip interface * gigabitethernet
CLI-1528
1388 show ip interface * loopback
CLI-1530
1389 show ip interface * tengigabitethernet
CLI-1531
1390 show ip isis
CLI-1532
1391 show ip maximum-paths
CLI-1533
1392 show ip mroute
CLI-1534
1393 show ip multicast default-group-service-class
CLI-1535
1394 show ip ospf
CLI-1536
1395 show ip ospf area
CLI-1537
1396 show ip ospf database
CLI-1538
1397 show ip ospf database external
CLI-1540
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xxxix
List of CLI Commands
C4 CMTS Rel. 8.0.7
1398 show ip ospf database network
CLI-1545
1399 show ip ospf database nssa-external
CLI-1546
1400 show ip ospf database opaque-area
CLI-1547
1401 show ip ospf database opaque-area adv-router
CLI-1548
1402 show ip ospf database opaque-as
CLI-1549
1403 show ip ospf database opaque-link
CLI-1550
1404 show ip ospf database opaque-link adv-router
CLI-1551
1405 show ip ospf database router
CLI-1552
1406 show ip ospf database summary
CLI-1553
1407 show ip ospf interface
CLI-1554
1408 show ip ospf neighbor
CLI-1555
1409 show ip ospf virtual-links
CLI-1556
1410 show ip pim interface
CLI-1557
1411 show ip pim neighbor
CLI-1558
1412 show ip policy
CLI-1559
1413 show ip prefix-list
CLI-1560
1414 show ip protocols
CLI-1561
1415 show ip rip
CLI-1562
1416 show ip rip database
CLI-1563
1417 show ip route
CLI-1564
1418 show ip route summary
CLI-1565
1419 show ip scm access
CLI-1566
1420 show ip scm access interface-only
CLI-1567
1421 show ip ssh
CLI-1568
1422 show ip ssh config
CLI-1569
1423 show ip unreachables
CLI-1570
1424 show ipv6 access-list
CLI-1571
1425 show ipv6 icmp
CLI-1572
1426 show ipv6 interface [brief] cable
CLI-1573
1427 show ipv6 interface [brief] cable-mac
CLI-1574
1428 show ipv6 interface [brief] gigabitEthernet
CLI-1575
1429 show ipv6 interface [brief] loopback
CLI-1576
1430 show ipv6 interface [brief] tengigabitethernet
CLI-1577
1431 show ipv6 isis
CLI-1578
1432 show ipv6 maximum-paths
CLI-1579
1433 show ipv6 neighbors
CLI-1580
xl
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1434 show ipv6 neighbors cable
CLI-1581
1435 show ipv6 neighbors cable-mac
CLI-1582
1436 show ipv6 neighbors gigabitethernet
CLI-1583
1437 show ipv6 neighbors tengigabitethernet
CLI-1584
1438 show ipv6 ospf
CLI-1585
1439 show ipv6 ospf area
CLI-1586
1440 show ipv6 ospf database
CLI-1587
1441 show ipv6 ospf database adv-router
CLI-1588
1442 show ipv6 ospf database external
CLI-1589
1443 show ipv6 ospf database inter-area prefix
CLI-1590
1444 show ipv6 ospf database link * adv-router
CLI-1591
1445 show ipv6 ospf database network * adv-router
CLI-1592
1446 show ipv6 ospf database nssa-external *
CLI-1593
1447 show ipv6 ospf database prefix *
CLI-1594
1448 show ipv6 ospf database router * adv-router
CLI-1595
1449 show ipv6 ospf database summary
CLI-1596
1450 show ipv6 ospf interface
CLI-1597
1451 show ipv6 ospf interface [brief] cable
CLI-1598
1452 show ipv6 ospf interface [brief] cable-mac
CLI-1599
1453 show ipv6 ospf interface [brief] gigabitethernet
CLI-1600
1454 show ipv6 ospf interface [brief] loopback
CLI-1601
1455 show ipv6 ospf interface [brief] tengigabitethernet
CLI-1602
1456 show ipv6 ospf neighbor
CLI-1603
1457 show ipv6 ospf neighbor gigabitethernet
CLI-1604
1458 show ipv6 ospf neighbor tengigabitethernet
CLI-1605
1459 show ipv6 pd database
CLI-1606
1460 show ipv6 pd-route-injection
CLI-1607
1461 show ipv6 protocols
CLI-1608
1462 show ipv6 route
CLI-1609
1463 show ipv6 route cable
CLI-1610
1464 show ipv6 route cable-mac
CLI-1611
1465 show ipv6 route connected
CLI-1612
1466 show ipv6 route detail
CLI-1613
1467 show ipv6 route gigabitethernet
CLI-1614
1468 show ipv6 route include-inactive
CLI-1615
1469 show ipv6 route include-pd
CLI-1616
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xli
List of CLI Commands
C4 CMTS Rel. 8.0.7
1470 show ipv6 route isis
CLI-1617
1471 show ipv6 route local
CLI-1618
1472 show ipv6 route netmgmt
CLI-1619
1473 show ipv6 route null
CLI-1620
1474 show ipv6 route ospf
CLI-1621
1475 show ipv6 route pd
CLI-1622
1476 show ipv6 route static
CLI-1623
1477 show ipv6 route summary
CLI-1624
1478 show ipv6 route tengigabitethernet
CLI-1625
1479 show ip-video global
CLI-1626
1480 show ip vrf
CLI-1627
1481 show isis database
CLI-1629
1482 show isis hostname
CLI-1096
1483 show isis hostname
CLI-1630
1484 show isis interface
CLI-1631
1485 show isis interface events
CLI-1633
1486 show isis neighbor
CLI-1635
1487 show isis protocol
CLI-1637
1488 show isis timers
CLI-1638
1489 show isis traffic
CLI-1640
1490 show l2vpn cm-mac
CLI-1642
1491 show l2vpn l2vpnid
CLI-1643
1492 show line
CLI-1644
1493 show linecard status
CLI-1646
1494 show logging
CLI-1648
1495 show logging console
CLI-1652
1496 show logging debug
CLI-1653
1497 show logging history
CLI-1655
1498 show logging local
CLI-1657
1499 show logging monitor
CLI-1658
1500 show logging overrides
CLI-1659
1501 show logging priority cli
CLI-1660
1502 show logging proprietary
CLI-1662
1503 show logging snmp
CLI-1663
1504 show logging syslog
CLI-1664
1505 show logging throttle
CLI-1665
xlii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1506 show logging trap
CLI-1666
1507 show memory
CLI-1667
1508 show memory access-list
CLI-1668
1509 show netstat
CLI-1669
1510 show ntp *
CLI-1671
1511 show operation events override
CLI-1672
1512 show operation mode
CLI-1673
1513 show packetcable cops counts
CLI-1674
1514 show packetcable cops servers
CLI-1675
1515 show packetcable gate
CLI-1676
1516 show packetcable gatectl counters
CLI-1680
1517 show packetcable gate dqos
CLI-1678
1518 show packetcable gate pcmm
CLI-1679
1519 show packetcable global
CLI-1681
1520 show packetcable transactions
CLI-1683
1521 show pmd
CLI-1685
1522 show port status
CLI-1686
1523 show port status cable-mac full
CLI-1689
1524 show port status cmac
CLI-1688
1525 show port status dcam
CLI-1690
1526 show port status network
CLI-1691
1527 show port status umac
CLI-1692
1528 show port transceiver
CLI-1693
1529 show privilege
CLI-1694
1530 show privilege exec
CLI-1695
1531 show processes
CLI-1696
1532 show proto-throttle-rate
CLI-1699
1533 show qos-sc
CLI-1701
1534 show reload-status
CLI-1702
1535 show route-map
CLI-1703
1536 show route-map-policy
CLI-1704
1537 show running-config
CLI-1705
1538 show running-config interface cable-downstream
CLI-1706
1539 show running-config interface cable-mac
CLI-1707
1540 show running-config interface cable-upstream
CLI-1708
1541 show running-config interface ethernet
CLI-1709
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xliii
List of CLI Commands
C4 CMTS Rel. 8.0.7
1542 show running-config interface gigabitethernet
CLI-1710
1543 show running-config interface loopback
CLI-1711
1544 show running-config interface tengigabitethernet
CLI-1712
1545 show session-timeout
CLI-1713
1546 show shelfname
CLI-1714
1547 show snmp community
CLI-1715
1548 show snmp contact
CLI-1716
1549 show snmp engineboots
CLI-1717
1550 show snmp engineid
CLI-1718
1551 show snmp group
CLI-1719
1552 show snmp location
CLI-1720
1553 show snmp user
CLI-1721
1554 show snmp view
CLI-1722
1555 show spare-group
CLI-1723
1556 show ssh host public-key dsa
CLI-1724
1557 show startup-config
CLI-1725
1558 show tacacs
CLI-1726
1559 show tacacs groups
CLI-1728
1560 show tacacs hosts
CLI-1729
1561 show tech-support
CLI-1730
1562 show temperature
CLI-1731
1563 show terminal
CLI-1733
1564 show tod
CLI-1734
1565 show users
CLI-1735
1566 show version
CLI-1736
1567 telnet
CLI-1745
1568 terminal length
CLI-1746
1569 terminal width
CLI-1747
1570 test
CLI-1748
1571 trace ipstack
CLI-1753
1572 trace logging dhcp
CLI-1749
1573 trace logging dhcpv6
CLI-1750
1574 trace logging ips
CLI-1751
1575 trace logging ipssh
CLI-1752
1576 trace logging ipvideo
CLI-1754
1577 trace logging modem
CLI-1755
xliv
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
List of CLI Commands
1578 trace logging no
CLI-1756
1579 trace logging packetcable
CLI-1757
1580 trace logging packetcable *
CLI-1758
1581 trace logging router
CLI-1759
1582 trace logging router bgp
CLI-1760
1583 trace logging router general
CLI-1761
1584 trace logging router isis
CLI-1762
1585 trace logging router ospf
CLI-1763
1586 trace logging router redist
CLI-1764
1587 trace logging router rip
CLI-1765
1588 traceroute
CLI-1766
1589 traceroute ipv6
CLI-1767
1590 traceroute ipv6 * output-interface cable
CLI-1768
1591 traceroute ipv6 * output-interface gigabitethernet
CLI-1769
1592 unalias
CLI-1770
1593 wait
CLI-1771
1594 write log
CLI-1772
1595 write memory
CLI-1773
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
xlv
List of CLI Commands
xlvi
C4 CMTS Rel. 8.0.7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
3
Standard and Cadant Enterprise MIBs
Topics
Page
CMTS SNMP MIB Variable Descriptions
2
Enterprise MIBs
5
SNMP Configuration with CLI
9
This document describes the CMTS Simple Network Management Protocol (SNMP) enterprise Management Information Base (MIB) variables. The enterprise MIBs described in this chapter are created for the CMTS, as opposed to the MIBs defined by the DOCSIS® standards. Simple Network Management Protocol (SNMP) is used to configure the CMTS. The CMTS is fully SNMP manageable. DOCSIS® requires that the CMTS and cable modems (CM) implement many MIB tables as defined in various Request for Comments (RFCs). Additional private MIB tables have been defined to represent the hardware and software architecture of the CMTS. NOTE To manage a CMTS, the CMTS IP address must be either discovered (via SNMP discovery) or entered manually.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
3-1
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
CMTS SNMP MIB Variable Descriptions The set of SNMP variables that the CMTS supports is called the Management Information Base or MIB. The base is made up of several parts, including elements for SNMP, standard MIBs, routing MIBs, and DOCSIS.
Table 3-1: SNMP MIBs MIB Name
Standard/Draft Number
SNMP MIBs SNMPv2-MIB
RFC 1907
SNMP-FRAMEWORK-MIB
RFC 3410
SNMP-MPD-MIB
RFC 3411
SNMP-TARGET-MIB
RFC 3412
SNMP-NOTIFICATION-MIB
RFC 3413
SNMP-USER-BASED-SM-MIB
RFC 3414
SNMP-VIEW-BASED-ACM-MIB
RFC 3415
SNMP-COMMUNITY-MIB
RFC 3584
Table 3-2: Standard MIBs MIB Name
Standard/Draft Number
Standard MIBs
3-2
BRIDGE-MIB
RFC 1493
IANAifType-MIB
(http://www.iana.org/assignments /ianaiftype-mib)
IANA-RTPROTO-MIB
RFC 2932
IF-MIB
RFC 2863
INET-ADDRESS-MIB
RFC 4001
ENTITY-MIB
RFC 2737
EtherLike-MIB
RFC 3635
IP-MIB
RFC 4293
DOCS-TEST-MIB
--
MGMD-STD-MIB
draft-ietf-magna-mgmd-mb-08.txt
IP-FORWARD-MIB
RFC 4292
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
Table 3-2: Standard MIBs (Continued) MIB Name
Standard/Draft Number
IPSEC-ISAKMP-IKE-DOI-TC
draft-ietf-ipsec-doi-tc-mid.07
OSPF-MIB
RFC 1850
OSPFv3-MIB
RFC 5643
RIPv2-MIB
RFC 1724
TCP-MIB
RFC 4022
UDP-MIB
RFC 4113
RADIUS-ACC-CLIENT-MIB
RFC 2620
RADIUS-AUTH-CLIENT-MIB
RFC 2618
Table 3-3: Routing MIBs MIB Name
Issue 2.0
Revision Date
DC-BGP-MIB
201006280000Z
DC-GMI-MIB
200407070000Z
DC-ISIS-MIB
200709190000Z
DC-MASTER-TC
200907240000Z
DC-MCAST-ROUTING-TC
200408170000Z
DC-MGMD-MIB
201103090000Z
DC-MOUNT-MIB
eng-ltd 1578918
DC-MPF-MIB
200704270000Z
DC-OSPF-MIB
201103090000Z
DC-OSPFv3-MIB
201103220000Z
DC-PIM-MIB
200510050000Z
DC-RIP-MIB
200901140000Z
DC-RTM-MIB
200908200000Z
DC-SRM-MIB
200306250000Z
ARRIS PROPRIETARY — All Rights Reserved
3-3
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
Table 3-4: DOCSIS® MIBs MIB Name
3-4
Standard/Draft Number
DOCS-IF-MIB
draft-ietf-ipcdn-docs-rfmibv2-14
DOCS-IF-EXT-MIB
draft-ietf-ipcdn-docsisevent-mib-06
DOCS-CABLE-DEVICE-MIB
RFC 4639
DOCS-BPI2-MIB
draft-ietf-ipcdn-mcns-bpi2-mib-05
DSG-IF-MIB
CM-SP-DSG-I04
DOCS-SUBMGT3-MIB
CM-SP-OSSIv3.0-I03
DOCS-IF3-MIB
CM-SP-OSSIv3.0-I03
DOCS-LOADBAL3-MIB
CM-SP-OSSIv3.0-I05
DOCS-L2VPN-MIB
CM-SP-L2VPN-I07
DOCS-QOS3-MIB
CM-SP-OSSIV3.0-I04
DOCS-IETF-CABLE-DEVICENOTIFICATION-MIB
RFC 4547
DOCS-DIAG-MIB
CM-SP-OSSIV3.0-I01
DOCS-MCAST-MIB
CM-SP-OSSIV3.0-I01
CLAB-TOPO-MIB
CM-SP-OSSIV3.0-I01
CISCO-TAP-MIB
Cisco intercept {“tap”} MIB, Rev. 200510120000Z
CLAB-DEF-MIB
CL-SP-MIB-CLABDEF-I06
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
3 Standard and Cadant Enterprise MIBs
Enterprise MIBs The enterprise MIBs are listed below along with a brief description of their functionality. ARRIS-CMTS-FFT-MIB — this MIB contains objects for observing and managing the usage of the upstream spectrum in the ARRIS CMTS. ARRIS-MIB — This is the ARRIS Enterprise MIB. EXT-CADANT-AAA-MIB — This MIB describes the proprietary AAA configuration parameters used to support authentication and authorization in the C4 CMTS. CADANT-BGP-MIB — This MIB represents ARRIS’s C4 CMTS enterprise specific Border Gateway Protocol. CADANT-CMTS-BPI2-MIB — This MIB provides the ARRIS BPI+ MIB derived from the DOCS-BPI2-MIB. CADANT-CMTS-CABLEGROUP-MIB — This MIB has been deprecated and the load balancing features described in this MIB have been incorporated in the dynamic channel load balancing defined in the DOCS-LOADBALANCING-MIB. CADANT-CMTS-DHCPRA-MIB — This MIB contains management definitions to configure, control, and report on the Dynamic Host Configuration Protocol Relay Agent (DHCPRA) in the CMTS. CADANT-CMTS-DNSCLIENT-MIB — this MIB defines configuration support for CMTS DNS resolver usage (ping, traceroute). CADANT-CMTS-DOWNCHANNEL-MIB — This MIB contains management definitions to configure, control, and report on DOCSIS® downstream channels in the CMTS. The Cadant downstream channel table provides all of the management functionality of the DOCS-IF-MIB downstream channel table. The Cadant version of the table also contains additional object definitions to support and control downstream channel features above and beyond the minimum requirements of DOCSIS®. CADANT-CMTS-EQUIPMENT-MIB — This MIB contains management information to support the equipment provisioning, hardware control, diagnostic control, and auditing control of the CMTS. CADANT-CMTS-EXPORTIMPORT-MIB — this MIB contains the management definitions for controlling the export of the current C4 configuration as a set of CLI commands. CADANT-CMTS-IF3-MIB — This MIB contains Cadant IF3 MIB information
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
3-5
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
CADANT-CMTS-IP-VIDEO-MIB — This MIB provides support for IP video configuration and data monitoring management CADANT-CMTS-LAYER2CMTS-MIB — This MIB contains the management definitions to configure, control, and report on the MAC layer, or layer 2, features of the CMTS. Port management, including interface bundling, is the most notable of these features. CADANT-CMTS-MAC-MIB — This MIB contains management definitions about the CMTS’s knowledge of CMs and CPEs. The ARP table and modem summary tables are examples of these. CADANT-CMTS-MULTICAST-MIB — This MIB contains the ARRIS Multicast MIB tables. CADANT-CMTS-NOTIFICATION-MIB — This MIB defines objects which are of the type NOTIFICATION-TYPE and are used to define SNMP traps generated from the CMTS. CADANT-CMTS-PACKETCABLE-MIB — this MIB is a general-purpose management MIB for PacketCable. CADANT-CMTS-PC-EVENTSMSG-MIB — This MIB contains configuration objects that control PacketCable event messaging between the CMTS and a record keeping server. CADANT-CMTS-PCMM-MIB — This MIB supplies the management objects which are specific to the PacketCable Multimedia client of COPS. The objects for the management of the standard COPS protocol reside in RFC 2940. CADANT-CMTS-POLICY-MIB — This MIB defines configuration objects for AMen (access control lists and distribute lists). CADANT-CMTS-PROCESS-MIB — this MIB contains objects for monitoring the current CPU and memory resources of the ARRIS CMTS. CADANT-CMTS-SPECTRUM-MGMT-MIB — this MIB contains configuration and status information for managing the integrated upstream agility features of the CMTS. CADANT-CMTS-SYSTEM-MIB — This MIB contains management definitions to configure, control, and report on the non-equipment features of the CMTS. CADANT-CMTS-TOPO-MIB — This MIB provides additional support for DOCSIS 3.0 topology configuration of fiber nodes and for the status of mac domain nodes. CADANT-CMTS-UPCHANNEL-MIB — This MIB contains management definitions to configure, control, and report on DOCSIS® upstream channels in the CMTS. The Cadant upstream channel and modulation profile
3-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
3 Standard and Cadant Enterprise MIBs
tables provide all of the management functionality of the DOCS-IF-MIB upstream channel and modulation tables. The Cadant versions of these tables also contain additional object definitions to support and control upstream channel features above and beyond the minimum requirements of DOCSIS®. CADANT-DQOS-GATE-MIB — this MIB defines configuration objects for and provides additional support for DOCSIS PacketCable Gate control. CADANT-HW-MEAS-MIB — This MIB contains management definitions to report hardware-based counts and status information. Many of the objects in this MIB form the foundation of DOCSIS®-required counts and status management objects. CADANT-IPDR-MIB — This MIB contains the management definitions to configure, control, and report on the C4 IPDR feature. CADANT-IRDP-MIB — this MIB modules defines objects to manage the ICMP Router Discover Protocol (IRDP) in the ARRIS CMTS. CADANT-L2VPN-MIB — This is the management MIB containing Cadant proprietary L2VPN MIB information. CADANT-LOADBALANCING-MIB — This MIB contains Cadant internal data schema for CAM load balancing. CADANT-MAP-STATS-MIB — this MIB contains objects to display counts and statistical information for the DOCSIS map-makers. There exists a single map-maker for each upstream channel. The map-makers hold the keys to the upstream bandwidth. Thus, one is able to gain insight into how the upstream bandwidth is being managed by analyzing the various map-maker counts and statistics in this MIB. CADANT-OSPF-MIB — This MIB is the equivalent of the standard OSPFMIB with the addition of a vrIndex column to associate an OSPF instance with its respective virtual router. CADANT-PRODUCTS-MIB — This MIB contains definitions that give structure to the Cadant enterprise OID tree. CADANT-REMOTE-QUERY-MIB — This MIB provides the managment of the CMTS Remote Query feature. It facilitates SNMP polling of remote cable modems (CMs) and includes the configureation and status objects of the CMTS CM poller and remote CMs that are polled by the CMTS CM poller. CADANT-SHOWCM-FORMAT-MIB — This MIB provides support for configuring format of show cable modem command. CADANT-CMTS-SW-MEAS-MIB — this MIB contains tables for showing per upstream logical channel statistics of UGS flows.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
3-7
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
CADANT-TC — This file contains textual convention definitions which are used by other Cadant Enterprise MIBs. CADANT-TIME-MIB — this MIB defines the objects for controlling and reporting on the various Time of Day Services in the CMTS. These Time of Day services include the TOD protocol, the NTP protocol, and manual configuration. CADANT-TRAP-LOG-MIB — this MIB contains objects for configuring syslog and trap features in the ARRIS CMTS. CADANT-VIRTUAL-ROUTER-MIB — This MIB contains management definitions to configure and control the bulk of the layer 3 features of the CMTS, including the virtual router feature. TACACS-CLIENT-MIB — this MIB defines configuration support for TACACS+.
3-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
SNMP Configuration with CLI The most basic settings for the SNMP agent i.e. hostname, location, and contact details are configurable via the following commands: hostname [no] configure snmp-server location [no] configure snmp-server contact NOTE SNMP over IPv6 is not supported in Release 7.x.
Procedure 3-1
Basic Configuration for an SNMP v1/2 Community The following script represents the basic command sequence for setting up SNMP: configure snmp-server community public security rotesting configure snmp-server community private security rwtesting configure snmp-server user rotesting rotesting v1 configure snmp-server user rwtesting rwtesting v1 configure snmp-server user rotesting rotesting v2c configure snmp-server user rwtesting rwtesting v2c configure snmp-server context "" configure snmp-server group rotesting v1 read docsisManagerView
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
3-9
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
(continued) configure snmp-server group rwtesting v1 read docsisManagerView write docsisManagerView configure snmp-server group rotesting v2c read docsisManagerView notify docsisManagerView configure snmp-server group rwtesting v2c read docsisManagerView write docsisManagerView configure snmp-server view docsisManagerView 1.3.6.1 included configure snmp-server group rotesting v2c notify docsisManagerView configure snmp-server group rotesting v1 notify docsisManagerView End of procedure Community Access — defines an access list filtering mechanism associated with the community string. Each community string defined in snmpCommunityTable can be configured with one access list number. For each community string associated with an access list number, the incoming SNMP request is permitted or denied using standard access list filtering. For more information, see configure access-list * remark on page CLI-93, and similar commands. configure snmp-server community configure snmp-server community no An SNMP community or v3 user consists of 3 parts: views, groups, and users View — defines the portion of the overall MIB tree that is visible to an SNMP user. Views are configured by using the “snmp-server view …” commands. These commands map directly to the SNMP MIB table “vacm-
3-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
ViewTreeFamilyTable” as explained in RFC3415. The CLI commands for creating/modifying/deleting views are as follows: configure snmp-server view included configure snmp-server view excluded configure snmp-server view no The MIB-family is specified as a full object-identifier i.e. “1.3.6”. For example, to define a view that includes internet, but excludes private, use the commands: configure snmp-server view testview 1.3.6.1 included configure snmp-server view testview 1.3.6.1.4 excluded
user table configure snmp-server user testuser testgroup v2c
configure snmp-server community testcommunity security testuser
group table
community table
configure snmp-server group testgroup v2c read testview
view table configure snmp-server view testview .1.3.6 included
configure snmp-server community testcommunity
ACL table configure access-list
Figure 3-1: Relationship of SNMP Tables to User-defined Elements Group — defines a set of read/write/notify (trap/inform) permissions associated with a group. It does this by associating a view with each type
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
3-11
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
of access read/write/notify. These commands map directly to the SNMP MIB table “vacmAccessTable” as explained in RFC3415. The CLI commands are: configure snmp-server group v1 [read ] [write ] [notify ] configure snmp-server group v2c [read ] [write ] [notify ] configure snmp-server group v3 [read ] [write ] [notify ] configure snmp-server group no configure snmp-server group v3 no The read, write, and notify views are each optional: if no ‘write’ view was specified then the group defines read-only permissions. For example: configure snmp-server group testgroup v3 noauth read testview User — Refers to the person that uses the client to access the SNMP server. The user can be of type SNMPv1, SNMPv2, or SNMPv3. SNMPv3 will be discussed later. These commands map directly to the SNMP MIB table “vacmSecurityToGroupTable” as explained in RFC3415. The CLI commands are: configure snmp-server user configure snmp-server user no For example: configure snmp-server user testuser testgroup v2c NOTE In order for the v1/v2c user to be utilized through SNMP, there must exist a corresponding community in the SNMP MIB table “snmpCommunityEntry”(RFC3416). The username testuser maps to the security name.
3-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
The community entry can be modified manually using the commands: configure snmp-server community [security ] For example: configure snmp-server community public security testuser The following command disables the community name testuser: configure snmp-server community testuser no NOTE The community name doesn’t have to be the same as the user name. If they are different, then it is the community name that needs to be sent in the SNMP message from the client and not the user name. The user must be associated with a group of the same type (either v1 or v2c) in order for it to work. The transport tag value in the command string below identifies an entry in the snmpTargetAddrTable whose snmpTargetAddrTagList contains this tag value. If an SNMP management request containing this community is received on a transport endpoint other than the transport endpoints identified by tag value, the incoming SNMP request is inauthentic. (reference: RFC3416) configure snmp-server community ttag The community index specifies the index in the snmpCommunityTable. It identifies an entry in the table. configure snmp-server community index Basic configuration for an SNMP v3 user
SNMPv3 users can be setup with or without authentication enabled. If authentication is enabled, privacy may also optionally be enabled. These commands map directly to the SNMP MIB table “usmUserTable” as explained in RFC3414. The CLI commands are: configure snmp-server user v3 [auth [priv ]] configure snmp-server user v3 no
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
3-13
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
For example: configure snmp-server user “v3user” “v3group” v3 auth sha “password1” priv “password2” The same principle of group view associations applies to v3 users as well as v1/v2c users. NOTE A v3 user must be associated with a v3 group. You cannot associate a v3 user with a v1 or v2c group. Configuring different notification-types
To enable/disable SNMP Authentication Failure Trap, use the following commands: configure snmp-server enable traps snmp configure snmp-server enable traps snmp no
Configuration of SNMP Notification receivers
The CLI commands for creating/modifying/deleting hosts are as follows: configure snmp-server host N.N.N.N traps [udp-port [timeout [retry ]]] configure snmp-server host N.N.N.N informs [udp-port [timeout [retry ]]] The two commands above map directly to the SNMP MIB table “snmpTargetAddrTable” as explained in RFC3413. The taglist is used to specify a list of tags as defined in the snmpNotifyTable. It is formatted as a list of 1 or more strings separated by whitespace. If more than one tag is used, then the list must be enclosed in quotes. The following command provides the syntax: configure snmp-server host N.N.N.N taglist [udpport [timeout [retry ]]] For example: configure snmp-server host 10.33.4.120 taglist "InformTag TrapV2Tag" timeout 500 retry 3
3-14
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
3 Standard and Cadant Enterprise MIBs
For example, to configure a host to receive both traps and informs: configure snmp-server host “10.1.1.1” traps configure snmp-server host “10.1.1.1” informs configure snmp-server host N.N.N.N no The tparam specifies the target parameters name defined in the snmpTargetParamsTable. The identified entry in the snmpTargetParamsTable contains SNMP parameters to be used when generating messages to be sent to this transport address. configure snmp-server host N.N.N.N tparam The target address name specifies the index in snmpTargetAddrTable. It identifies an entry in the table. configure snmp-server host N.N.N.N name The mms specifies the maximum message size. It is used to determine the maximum message size acceptable to another SNMP entity when the value cannot be determined from the protocol. configure snmp-server host N.N.N.N mms The mask value allows selected entries in the snmpTargetAddrTable to specify multiple addresses. This would typically be used to specify a subnet in an snmpTargetAddrTable rather than just a single address. The mask value is used to select which bits of a transport address must match bits of the corresponding instance of the snmpTargetAddrTAddress, in order for the transport address to match a particular entry in the snmpTargetAddrTable. The value of an instance of snmpTargetAddrTMask must always be an OCTET STRING whose length is either zero or the same as that of the corresponding instance of snmpTargetAddrTAddress. The mask is not used in generating notifications. When generating notifications, entries in the snmpTargetAddrTable only specify individual addresses. (reference: rfc3416) configure snmp-server host N.N.N.N mask (Example 1) Configure a mask to specify a subnet of 10.44.xx.xx with udp-port of 161: configure snmp-server host 10.44.0.0 udp-port 161 mask ff:ff:00:00:ff:ff
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
3-15
3 Standard and Cadant Enterprise MIBs
C4/C4c CMTS Rel. 8.0.7
(Example 2) Configure a mask to specify a subnet of 10.43.8.xx with any udp-port: configure snmp-server host 10.43.8.0 mask ff:ff:ff:00:00:00 Configuration of SNMP Notification filters
A notification-security-model may optionally be configured with an associated filter in order to restrict the trap types that can be generated using a particular model. The commands to create a filter are very similar to the commands used to create an SNMP view. Use the following commands to create filters: configure snmp-server notify-filter [profile ] [subtree ] [type ] no configure snmp-server notify-filter [profile ] [subtree ] These commands map directly to the SNMP MIB table “snmpNotifyFilterTable” as explained in RFC3413. The syntax of the parameters is similar to the “snmp-server view …” commands explained in section 4.1.1.1 of the RFC.
3-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
4
C4 CMTS Features
Topics
Page
C4 CMTS Feature Descriptions by Software Release
4
Release 7.1.x Features
13
Release 7.2.x Features
14
Release 7.4.x Features
16
Release 8.0.x Features
16
This chapter introduces the C4 CMTS and its features, functionality, and components. This chapter contains the following topics: •
Descriptive and reference information
•
Features list
DOCSIS 2.0 Compliance In December, 2004, the C4 Cable Modem Termination System (CMTS) received DOCSIS® 2.0 requalification by CableLabs® with the new software upgrade designed to support DOCSIS Set-top Gateway (DSG) technology. With this qualification, the C4 CMTS, configured with the higher density 2Dx12U CAM provided the most reliable and scalable C4 CMTS solution available. The C4 CMTS supports DOCSIS Set-Top Gateway (DSG), allowing operators to transition the signaling, provisioning, and control of advanced settop boxes from proprietary to standards-based protocols. This transition of
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
4-1
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
all services to IP-based standards is expected to streamline operations and lower capital costs for cable operators. The DOCSIS 2.0 standard greatly improves performance in the upstream path of the cable network. The growing demand for peer-to-peer file sharing, interactive gaming, and voice over IP telephony increases the need for upstream bandwidth. The following enhancements are available to CMTSs and CMs that comply with the 2.0 standard while maintaining all the DOCSIS 1.1 and 1.0 functionality:
DOCSIS 3.0 Compliance
•
Enhanced upstream capacity
•
Greater maximum upstream throughput — up to 30.72 mbps per channel
•
Greater upstream channel width — up to 6.4 Mhz
•
New upstream channel modulation rates: 8QAM, 32QAM, and 64QAM
•
Longer preamble to facilitate synchronization — up to 1536 bits
•
Higher powered preamble — QPSK-1
•
Enhanced noise cancellation and error correction
•
Synchronous-Code-Division Multiple Access (SCDMA) operation along with the standard TDMA and ATDMA techniques for combining CM signals onto a given upstream channel.
In May 2008, the C4 CMTS received DOCSIS® 3.0 Bronze-level requalification by CableLabs®in Certification Wave 58. The following features were added to the ARRIS C4 CMTS as part of the DOCSIS 3.0 initiative while maintaining total compatibility with deployed pre-3.0 DOCSIS devices:
4-2
•
Independent Scalability of Upstream and Downstream Channels
•
Management of Multiple Upstream and Downstream Channels per MAC Domain
•
Enhanced Cable Plant Infrastructure Management
•
Cable Modem Topology Resolution
•
Downstream Channel Bonding
•
IPv6 Management of CMs and Forwarding of CPE Traffic
•
Enhanced Operations Support System Interface.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
Fault Detection and Recovery The C4 CMTS employs: •
Advanced data-path integrity checks (parity, CRC, loopbacks, pings)
•
Continuous system audits
•
Multiple levels of error detection.
Fault recovery on the C4 CMTS: •
Rapidly isolates faults
•
Decreases diagnostic and repair time
•
Reduces the probability of fault propagation
•
Minimizes impact on subscriber services.
Interfaces and Protocols Open interfaces and protocols allow seamless integration with existing network management infrastructures. The primary protocols supported by the C4 CMTS include the following:
Issue 2.0
•
Simple Network Management Protocol (SNMP) — v1, v2c, and v3
•
DOCSIS 1.1, DOCSIS 2.0, DOCSIS 3.0 (Bronze), and Cadant MIBS
•
Command Line Interface (CLI)
•
File Transfer Protocol (FTP)
•
Telnet
•
Routing Information Protocol (RIPv2)
•
Open Shortest Path First (OSPFv2)
•
Open Shortest Path First (OSPFv3)
ARRIS PROPRIETARY — All Rights Reserved
4-3
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
Security Features Unique security measures ensure plant and subscriber integrity through: •
DOCSIS 1.1 BPI+ encryption
•
Administrative isolation by means of a separate physical interface
•
Packet filtering
•
Proxy ARP
•
Password and key authentication for RIP and OSPF
•
Secure Shell version 2 (SSH2)
•
Secure Shell (SSH)
•
Access Control Lists (ACLs)
•
Multi-stage Denial of Service throttling mechanisms in hardware and software
•
TACACS+
•
Protocol throttling
•
SNMP Security.
C4 CMTS Feature Descriptions by Software Release The ARRIS C4 CMTS Release 8.0 aggregated Feature Set is comprised of the Baseline Feature Set, plus the features of software Releases 3.0, 3.3, 4.0, 4.1, 4.2, 5.0, 7.0, 7.1, 7.2, 7.3 and 7.4.
4-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
Baseline Features
The ARRIS C4 CMTS feature set includes: •
Complete DOCSIS 2.0 support
•
Maximum cable interface density per rack unit
•
High scalability
•
Guaranteed Service Level Agreements (SLAs) support
•
IGMPv2 & Multicast Flow Support
•
Carrier-class availability and operation
•
Static Layer 3 Routing
•
Layer 3 Router Functionality including -
Release 3.0 Features
Issue 2.0
Router Information Protocol (RIPv2) Open Shortest Path First (OSPFv2) Equal Cost Multipath Load Balancing (ECMP)
•
FlexCAM™ Technology for CAM sparing
•
Dynamic Route Redundancy
•
Control Complex Redundancy.
The following features were added with Release 3.0: •
GigE Network Access Module (Gig-E NAM)
•
Authentication using RADIUS
•
SNMP Security
•
In-Band Management and Access Control Lists (ACLs)
•
Upstream Load Balancing (ULB)
•
Multiple syslog servers.
ARRIS PROPRIETARY — All Rights Reserved
4-5
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
Release 3.3 Features
The following features or improvements have been added for release 3.3: •
PacketCable Qualification
•
Increased subscriber limits per chassis: 24K CM
•
Increased VoIP Call Capacities
•
Improved Password Recovery
•
Loopback Interface
•
Multiple Subinterfaces per VRF
•
Loopback Interfaces for routing protocols
•
Number of filters in group increased to 31
•
Support for Authentication, Authorization, and Accounting (AAA) [RADIUS & TACACS+]
•
In-Band Management: Access to the SCM via the loopback IP address
•
Support for Packet Cable
•
Automatic System Backup during Upgrade
•
Improved Baseline Privacy Interface (BPI)
•
Domain Name System (DNS) Support for Telnet, Traceroute, and Ping.
CLI Improvements:
4-6
•
extended ping command
•
show ip interface brief
•
show temperature
•
reset all CMs
•
traceroute CLI command
•
configure authorization
•
COS and 1.0 Modems
•
configure logging priority
•
configure privilege exec level.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
4 C4 CMTS Features
Release 4.0 Features
The following features or improvements have been added for release 4.0: •
2Dx12U CAM — full DOCSIS 2.0 (A-TDMA and S-CDMA)
•
Proprietary automatic ingress noise cancellation
•
Flash disk re-partitioning
•
Graceful restart with OSPFv2
•
Real-time FFT of upstream (compatible with C3 CMTS MIBs)
•
NAM IP interface bundling
•
Increased subscriber limits per chassis: 32,000 CMs per chassis, and 3,000 CMs per downstream (500 per upstream in 1x6 operation)
•
Preemption of normal calls by new emergency calls when BW is limited
•
Additional audits: FCM, file system, 2Dx12U
•
CM reset clear trap
•
Flap List enhancements: -
•
percent of station maintenance ranging opportunities that receive a range request - number of power adjustments exceeding a threshold Number of CRC errors per CM (2D only)
•
Number of bytes dropped per CM (congestion and policing)
•
Virtual System Controller
•
CLI Improvements: -
show/copy running-config show cable qos profile assign and display an output name or description for each interface.
To look up syntax and parameters for individual CLI commands, see chapter CLI, Command Descriptions. Each entry in the alphabetical list of commands is hyperlinked to the appropriate page in the manual. •
Automatic fan speed control
•
Encryption of MD5 shared secret for routing protocols in CLI output
•
Disabled ICMP Unreachables
•
OSPF "point-to-point" interface support
•
Increased AC/DC power solution
•
Voice call requirements: -
Issue 2.0
At least 1,000 MTAs (Multimedia Terminal Adapters) per downstream At least 5,000 BHCAs with completion rate of 99.5% At least 260 half-calls per downstream.
ARRIS PROPRIETARY — All Rights Reserved
4-7
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
NOTE The voice call requirements are reduced by one-half in a mixed voice and data environment. Release 4.1 Features
Release 4.2 Features
The following features or improvements have been added for release 4.1: •
Committed Access Rate
•
Global Traffic Shaping for TCP Traffic
•
Remote Query of Cable Modems
The following features or improvements have been added for release 4.2: •
DOCSIS Set-top Gateway (DSG) Agent
•
Associate ACL with SNMP Community String
•
Advanced CM Config File Verification
•
Scalability — 52K CMs per chassis
•
Modify overload control to ensure "older" CMs range/register in reasonable time through overload conditions (chassis reboot, CAM insertion, etc.)
•
"Debug" IP Filter Packet Capture capability (ability to capture packet headers that match IP filters or similar functionality)
•
PacketCable Multimedia
•
Network side ACLs
•
Support for 16 telnet sessions
•
Clear the IP filter counters through the CLI
•
Hitless software update
•
PacketCable 1.x Voice call requirements
-
•
MTAs /downstream (1D) 1000 MTAs/downstream (2D) 1500 MTAs/C4 20000 - Lines/downstream 1800 Lines/C4 24000 - BHCA/downstream 5000 BHCA/C4 66600 - Simultaneous half calls/downstream 260 Programmable unicast request opportunity polling interval.
NOTE The voice call requirements specifically assume that only GNAMs are used. If the system contains any FastENAMs, the per-chassis line and MTA limits must be reduced to 1000.
4-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
Certain features may impact software upgrade procedures. For more information related to upgrades or for non-conformance issues, see the Cadant® C4®CMTS Software Upgrade Notes. This file is included on the software CD. In addition to the previously described features and functionality, the following section describes the C4 CMTS feature set for Release 5.0. This includes: Release 5.0 Features
The following is a list of the new features included in Software Release 5.0.x: •
FlexPathTM
•
Dynamic Load Balancing
•
Legal Intercept
•
PIM-SSM
•
IGMP ACLs
•
Secure NTP
•
DHCP Test Injection
•
Named Access-List
•
Additional Modem States
•
Integrated Upstream Agility
•
Clear cable host/modem (MAC DB)
•
ARP Throttling
•
Number of supported VRFs increased to 32
•
Downstream center frequency step size is now 125 kHz (formerly 250)
•
DOCSIS 1.1 DSx/DQOS and PacketCable 1.x Voice Scalability Improvements with Respect to Release 4.2: -
Issue 2.0
•
MTAs/downstream (1D) MTAs/downstream (2D) MTAs/C4 equipped w/GNAMs - Lines/downstream Lines/C4 - BHCA/downstream BHCA/C4 - Simultaneous half calls/downstream - Connections/second per chassis Cable Modem Deny List
•
CPE Host Authorization
•
Configure Cable Modem Vendor OUI
•
Show Cable Modem Columns.
ARRIS PROPRIETARY — All Rights Reserved
1,000 (no change) 1,500 (no change) 26,666 1,800 (no change) 32,000 5,000 (no change) 90,000 260 (no change) 25
4-9
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
NOTE NOTE: these call capacities assume that the C4 CMTS is equipped with GNAMs. If the chassis is equipped with Ethernet NAMs, the number of MTAs supported is only 10,000. Dynamic Load Balancing
The Dynamic Load Balancing feature automatically moves modems from one upstream channel to another, or from one downstream to another (including from one 2Dx12U CAM to another). Requires 2Dx12U CAMs.
Legal Intercept
Legal Intercept provides the MSOs a mechanism for meeting legal requirements to intercept all IP data and voice traffic originated or sent to subscribers on the cable network. Legal Intercept is based on Cisco’s implementation described in RFC 3924. The C4 CMTS interprets SNMP SET/GETs to enable/clear/display subscriber taps and send intercepted packets to the Mediation Device.
PIM-SSM
PIM-SSM (Source Specific Multicast) provides the capability to request multicast traffic from a single source and build a source path tree (SPT) from the edge router back to the source of the multicast stream. It also contains requirements to provide SSM multicast data plane counts.
IGMP ACLs
IGMP ACLs provide the ability to limit what multicast groups can be joined on an interface by using a standard ACL to indicate what groups are allowed to be joined.
Secure NTP
A mechanism is provided for authentication of NTP messages. For MSOs who require NTPv4 functionality, including server or peer authorization, the C4 CMTS will only support the NTPv4 symmetric key MD5 secure hash authentication method.
DHCP Text Injection
DHCP Text Injection will allow the operator to distinguish which upstream channels DHCP packets originated from as they are forwarded to the DHCP server. The upstream will be identified in the circuit ID sub-option of the DHCP relay agent option (option 82).
Named Access List
By allowing the use of a description name to identify an access list rather than a number, full modification to an existing access-list (e.g., delete, append and insert new entries) by using the ACL name is now available. Also, we are adding the ability to allow multiple remarks per access-list entry.
Additional Modem States
One additional cable modem state indicating the status of the Network Access Control for a registered CM has been added. The CM’s Network Access Control state is provided via the modem configuration file. This variable indicates whether or not CPE devices are allowed to access the network through the CM even though the CM is registered.
4-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
Integrated Upstream Agility
This provides the ability to enable or disable an Upstream Agility state machine for an upstream channel. The state machine includes permissible upstream channel frequencies and operating characteristics (e.g., channel width, modulation profile) along with rules to change from one operating characteristic to another.
Clear Cable Host/Modem
Enabled the ability to remove cable modems and CPEs from the system including removing them from the MACDB and C4 CMTS MIB tables.
ARP Throttling
Provides the ability to control the number of ARPS and ICMP packets that are generated due to traffic transmitted to IP addresses that do not have a valid (active or inactive) entry in the ARP cache.
Configure Cable Modem Vendor OUI
This feature provides the ability to configure a cable modem vendor name with the vendor’s Organizational Unique Identifier (OUI). The OUI is the first three bytes of the six byte CM MAC address.
Show Cable Modem Column
This new command will now allow you to create your own output by specifying exactly which columns you wish to see, thus maximizing your screen space and run-time.
Release 5.1.x Features
The following is a list of the new features included in Software Release 5.1.x: •
FlexPath™ DOCSIS 3.0-based Channel Bonding Enhancements
•
Enhanced Query Modem Counts on a per Upstream Basis
•
DOCSIS Set-top Gateway Configuration Simplification
•
Source IP Configuration for CM Remote Query
•
DHCP Lease Query Feature Configurability
•
Automatic Gain Control
The 5.1 enhancements to the FlexPath channel bonding solution include the following: -
3 bonded downstreams x 3 traffic-bearing unbonded upstreams 2 bonded downstreams x 2 traffic-bearing unbonded upstreams 4 bonded downstreams x 1 traffic-bearing unbonded upstream plus 3 non-traffic-bearing upstreams for return path of DOCSIS management messages Optional designation of upstream channels as FlexPath only
The Enhanced Query Modem Counts feature provides a CLI command-show cable modem summary brief--that offers modem totals on a perupstream basis. The total number of modems calculated per upstream includes registered, unregistered, and offline modems.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
4-11
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
DOCSIS Set-top Gateway (DSG) Configuration Simplification performs the automatic insertion of static multicast group memberships and the automatic insertion of multicast MAC/IP bindings when configuring DSG tunnels. Source IP Configuration for CM Remote Query allows the user to configure the IP address used for remote SNMP to get queries to any valid C4 IP address. DHCP Lease Query Feature Configurability adds a source IP address verification phase to the IP address learning process of the C4 CMTS. This configurable Cable Source Verify feature is intended to eliminate hostinitiated corruption of the layer 2 and layer 3 address spaces on the cable network. Automatic Gain Control uses an improved downstream power calibration algorithm on the 2Dx12U in order to maintain accurate downstream power levels in environments subject to fluctuating temperatures. NOTE QAM128 and Trellis Code Modulation (TCM) are not supported in Release 5.1. SCDMA is supported.
4-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
Release 7.0.x Features
The Release 7.0 C4 CMTS is an integrated DOCSIS 3.0 solution in that it contains both downstream and upstream modules and all associated CMTS components in a single chassis. The following is a list of the new features included in Software Release 7.0.x: •
Support for new hardware modules: -
Release 7.1.x Features
•
Router Control Module (RCM) 16D CAM 12U CAM (a repurposed 2Dx12U CAM configured in software to be a 12-upstream only CAM) Upstream spectrum support as follows:
•
- US - Japan - Europe DOCSIS 3.0 DS
•
DOCSIS 3.0 Topology/Infrastructure
•
DOCSIS 3.0 NMS support
•
IPv6 support on all interfaces
•
IPv6 for CM Management
•
New Hardware supported
The following new features are included in Software Release 7.1.x: •
•
Issue 2.0
5-42 MHz 5-55 MHz 5-65 MHz Channel Bonding
Multiple Virtual Routing and Forwarding (VRF) instances - Full support of OSPF in five VRFs - Limited routing protocol support for 11 VRFs (Rel. 7.1.2 and later) Cable Modem Steering — based on Service Type TLV (Rel. 7.1.2 and later)
•
Layer 3 802.1Q VLAN Tagging
•
Service Independent Intercept (SII) for Legal Intercept
•
DOCSIS 2.0-compliant IP Detail Record/Streaming Protocol (IPDR/SP)
•
Compatibility with the Intelligent Channel Optimizer (ICO) (requires an updated version of ICO software, licensed separately)
•
64 QAM Downstream Modulation
•
Increased Maximum Concatenated Burst Size
•
Baseline Privacy Interface (BPI) / DOCSIS 1.1 Hybrid Mode operation
•
DOCSIS 1.0+ Operation
ARRIS PROPRIETARY — All Rights Reserved
4-13
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
NOTE The DOCSIS 1.0+ Operation feature is not documented in this user manual; instead, it is described in an individual feature sheet. Release 7.2.x Features
4-14
The following new features are included in Software Release 7.2.x: •
Upstream Channel Bonding
•
BGP
•
IS-IS Support in IPv4 Networks
•
ARP Abuse Counts
•
Dynamic MIC/TFTP Enforce
•
Per Subscriber Throughput
•
Secure NTP
•
Global User Profile
•
TACACS+
•
DOCSIS Ping
•
DNS Client (IPv4)
•
Enhancements to BGP
•
Mixed Annex Support
•
Modem Steering
•
SSH
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
Release 7.3.x Features
The following is a list of the new features included in Software Release 7.3.x: •
Business Services over DOCSIS (BSoD) L2 VPN
•
IPv6 Support (Phase 2)
•
Encryption Support with MTCM
•
Load Balancing Enhancements
•
Integrated Upstream Agility
•
BPI+ Enforce
•
Turbo Button Support
•
D3.0 IPDR Elements
•
D3.0 Partial Service Support
•
Bonding Support for 8 Downstreams
•
Device Classes
•
Subset of PacketCable PCMM version I04 Support
•
PCMM Classification for Remotely Connected Subnets
•
Cable Modem MAC Deny list increase — up to 1,000 addresses
Table 4-1: Summary of Support Capability for CAM Types Capability Supports IPv6 CMs
2D12U
12U
16D
X
X
X
X
X
Supports IPv6 CPEs Supports IPv6 CM DS traffic
X
Supports IPv6 CM US traffic
X
X X
Supports IPv6 CPE DS traffic
X
Supports IPv6 CPE US traffic
X
Supports dual stack CPE
X
Support CM DS filtering traffic IPv4
X
Support CM US filtering traffic IPv4
X
Support CPE DS filtering traffic IPv4
X
Support CPE US filtering traffic IPv4
X
Support CM DS filtering traffic IPv6
X X
X X X X
Support CM US filtering traffic IPv6 Support CPE DS filtering traffic IPv6
X
Support CPE US filtering traffic IPv6
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
4-15
4 C4 CMTS Features
Release 7.4.x Features
Release 8.0.x Features
C4/C4c CMTS Rel. 8.0.7
The following is a list of the new features in Software Release 7.4.x: •
DHCP Prefix Delegation with Route Injection (PDRI)
•
IP Address Scaling per Chassis
•
OSPFv3
•
Cable Source Verify with DHCP Lease Query
•
DHCP Bulk Lease Query
•
Duplicate Address Detection Proxy
•
Subscriber Management Filters
•
Protocol Throttling
•
IPv6 Lawful Intercept Support (SII)
•
IPv6 CPE Support with DOCSIS 2.0+ IPv6 Cable Modems
•
Enhanced Density Downstream CAM
•
Mixed TDMA/ATDMA Channel Support for Load Balancing
•
Load Balancing Weighting toward Upstream Utilization
•
Cross-MAC Domain Dynamic Load Balancing
•
Cable Modem Move Enhancement
•
DSID Addition and Deletion
•
Counts-based US Load Balancing With Weighting
•
Modem Steering via Attribute Mask
•
Policy-Based Routing
•
12U Scaling Enhancement
•
SCDMA
•
IGMPv3-Controlled DOCSIS 3.0 IP Video
The following is a list of the new features in Software Release 8.0.x: •
24U CAM
•
IS-IS Multi-topology (MT) support
•
TFTP Enforce for IPv6-addressed Cable Modems
•
FQDN Support for IGMP Static Joins
•
Control of CM Resets due to CPE NAKs
•
Multicast CAC support for IP Video
•
Logical Channel Reduction
•
Enhanced Utilization Monitoring
The 24U CAM represents a new design using the latest DOCSIS 3.0 PHY and MAC silicon and enhanced ARRIS FPGAs for high performance. The Upstream PICs have not changed from those used with the 12U CAM, so customers can deploy the 24U CAM with a minimum of cabling interrup-
4-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
4 C4 CMTS Features
C4/C4c CMTS Rel. 8.0.7
tions and allows the 24 upstream receivers to be shared across the eight available F-connectors. The 2Dx12U CAM is not supported in Rel. 8.0. Any F-connector can have between zero and 12 receivers assigned. The sum total of the receivers assigned to the even-numbered F-connectors (0,2,4,6) cannot exceed 12, and the sum total of the receivers assigned to the odd-numbered F-connectors (1,3,5,7) cannot exceed 12. Also, upstreams 0 to 11 must be on even-numbered connectors, and upstreams 12 to 23 must be on odd-numbered connectors. Some other features of the 24U CAM with Release 8.0 include: -
Up to 6,600 total subscriber devices per CAM Up to 9+1 hitless RF sparing All 24 channels support bonding (up to four channels per bonding group)
IS-IS Multi-topology (MT) provides independent topologies for IS-IS routing and is particularly useful when IS-IS is being used both for IPv4 routing and for migration to IPv6 routing. In this software release, the C4 CMTS supports MT #0 (IPv4 unicast) and MT #2 (IPv6 unicast) as described in RFC 5120. TFTP Enforce for IPv6-addressed Cable Modems provides modem security for devices addressed via IPv6, identical to the existing C4 CMTS functionality for IPv4 modems. The intent of this feature is to reduce or prevent occurrences in which an IPv6-addressed modem has an incorrect or modified configuration file. Fully Qualified Domain Name (FQDN) Support for IGMP Static Joins allows the IGMP join command in the C4 CLI to accept an FQDN as the IP multicast source address, instead of requiring an IP multicast address. The DNS must then contain the FQDN to IP address entry so that the CMTS can obtain the corresponding IP address from the FQDN parameter. Should the source IP multicast address have to change, the MSO would change it on the DNS and the C4 CMTS will then resolve the new address via DNS and re-initiate IGMP joins as needed. Multicast CAC for IP Video (Phase 1) extends the existing voiceoriented Connection Admission Control function to multicast service flows (intended for IP Video applications). Independent CAC control is provided for multicast flows, and parameters for reserving bandwidth for multicast and for limiting the total bandwidth utilized by multicast are included. Enhanced Processor Monitoring reports the utilization levels of the various microprocessors within the C4 CMTS modules (the control plane). There is a new SNMP notification as part of the processor monitoring feature that will send traps when the overload status of a card or the system changes.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
4-17
4 C4 CMTS Features
4-18
C4/C4c CMTS Rel. 8.0.7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
5 C4 CMTS Specifications
C4/C4c CMTS Rel. 8.0.7
5
C4 CMTS Specifications
Topics
Page
Network Diagram
3
C4 CMTS Specifications
4
RF Electrical Specifications
6
Scalability
9
VoIP Call Capacities
10
This chapter introduces the C4 CMTS and its features and functionality. This chapter contains the following topics:
Issue 2.0
•
Descriptive and reference information
•
Physical design information
•
Power and electrical requirements
ARRIS PROPRIETARY — All Rights Reserved
5-1
5 C4 CMTS Specifications
C4/C4c CMTS Rel. 8.0.7
Figure 5-1 illustrates the front view of the C4 CMTS. There are a total of twenty-one slots for modules. There are four main types of modules used to equip the slots in the front. These are sometimes referred to as front cards. Smaller modules, called Physical Interface Cards, or PICs, are inserted in each slot from the rear of the chassis. The PICs provide physical connectors for terminating cable. Between the front and back slots is the midplane of the chassis. Three C4 CMTS chassis can be mounted in a single 19-inch wide, seven-foot standard rack.
Figure 5-1: The C4 CMTS (front view)
5-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
5 C4 CMTS Specifications
C4/C4c CMTS Rel. 8.0.7
Network Diagram A cable network system consists of cable modems (CMs) at subscriber premises, a C4 CMTS at the cable plant operations area, a data-over-cable management software suite integrated with the operator's other management systems, and the Hybrid Fiber Coaxial (HFC) cabling that connects it all. DOCSIS defines the standard for communication among these elements. The C4 CMTS provides data switching functions as well as the radio frequency (RF) interface to and from the cable plant. It also provides ethernet interfaces to the Internet Service Provider(s). The data-over-cable management system provides both the end-to-end network management solution and the support for subscriber provisioning. Figure 5-2 shows a typical cable network architecture.
Home
Video Resource Manager
Network Edge D5 UEQ
Video Operations
MPEG Video
10 Gbit Metro Ring
OSSI Server
DOCSIS DS DOCSIS US C4 CMTS
CPE Devices
VoD/Cache Servers
Figure 5-2: Typical Cable Network Architecture
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
5-3
5 C4 CMTS Specifications
C4/C4c CMTS Rel. 8.0.7
C4 CMTS Specifications This section is a summary of the C4 CMTS physical characteristics, operating specifications, and information on compliance with regulatory standards. Physical
Power
Safety
Electromagnetic Compatibility
Environmental
•
Mounting:
19- or 23-inch rack, or stand-alone
•
Dimensions:
Height Width Depth
•
Chassis Weight (fully equipped): 178 pounds
•
Operating voltage: nominal -48 V DC, range -44 to -72 V DC Note: Once powered up the C4 CMTS will continue to operate if within this voltage range.
•
Start-up voltage range: -44 to -67.5 VDC Note: If powered down, the C4 CMTS will not restart successfully if the voltage is not in the range of -44 to -67.5 VDC. This offset from the operating range provides a cushion against multiple possible power cycles. Attempted start-ups at the voltage extremes are subject to power fluctuations that could result in multiple power cycles and damage to the equipment.
•
Chassis Power Consumption: 2800W maximum
•
The -44 V guaranteed operating limit translates to a maximum current draw of 64A at 2800W.
(622 mm) (442 mm) (508 mm) (80.9 Kg)
The C4 CMTS meets the following safety standards: •
UL60950 (1999) Third Edition
•
CAN/CSA-C22.2, No. 950-95
•
IEC60950-1 (2001), First Edition
The C4 CMTS meets the following: •
GR-1089-CORE, Issue 3 (FCC - Part 15, Class A)
•
EN 300 386 v1.3.1 (CISPR 22, Class A)
Mechanical — •
NEBS GR-63-CORE
•
ETS 300 019
-
5-4
24.5" 17.4" 20.0"
In-use (Class3.1E) Storage (Class 1.2) Transportation (Class 2.3)
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
5 C4 CMTS Specifications
C4/C4c CMTS Rel. 8.0.7
Thermal — The C4 CMTS meets the following environmental standards: •
NEBS GR-63-CORE, ETS 300 019
-
Operating temperature Short term1: -5 to +55ºC Long term: +5 to +40ºC Non-operating temperature: -40 to +70ºC Operating humidity Short term: 5 to 90%, non-condensing Long term: 5 to 85% Non-operating humidity: 5 to 95%, non-condensing
Other — •
NEBS Level 3 Criteria (SR-3580)
•
Acoustic Noise Criteria:
•
NEBS (GR-63-CORE) ETSI (ETS 300 753) Altitude Criteria (NEBS GR-63-CORE)
•
Illumination Criteria (NEBS GR-63-CORE) WARNING
This product may contain chemical(s) known to the State of California to cause cancer, birth defects, or other reproductive harm. WEEE (Waste Electrical and Electronic Equipment)
As indicated by the symbol below, disposal of this product in participating European Community member states is governed by Directive 2002/96/EC of the European Parliament and of the Council on waste electrical and electronic equipment (WEEE). WEEE could potentially prove harmful to the environment; as such, upon disposal of the C4 CMTS and its components, the Directive requires that this product must not be disposed as unsorted municipal waste, but rather collected separately and disposed of in accordance with local WEEE ordinances.
Figure 5-3: WEEE Symbol 1. Short term refers to a period of not more than 96 consecutive hours and a total of not more than 15 days in one year. (This equals a total of 360 hours in a given year, but no more than 15 occurrences in that one-year period. (Telcordia, GR-63-CORE, Section 4.1.2, Issue 2, April 2002.)
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
5-5
5 C4 CMTS Specifications
C4/C4c CMTS Rel. 8.0.7
RF Electrical Specifications The following table lists the downstream RF electrical specifications. Table 5-1: Downstream RF Electrical Specifications Specification
16D or XD CAM
Center frequency range supported:
57 - 999 MHza
Frequency step size:
125 kHzb
Modulation types
64QAM, 256QAM
Downstream channel width: North America (Annex B) Europe (Annex A) Europe (using Annex B)
6 MHz 8 MHz 6 MHz with 6 or 8 MHz channel spacing
Annex B symbol rates in Msym/sec
64QAM: 256QAM:
5.056941 5.360537
Annex A symbol rate in Msym/sec
64QAM or 256QAM:
6.952
Raw Bit Rate Annex B: 64QAM 256QAM
30.342 Mbps 42.884 Mbps
Annex A:
64QAM 256QAM
41.712 Mbps 55.616 Mbps Overall: 41-60 dBmV Channels used per connectorc:
RF output level
1: 41-60 dBmV
5: 41-51 dBmV
2: 41-56 dBmV
6: 41-50 dBmV
3: 41-54 dBmV
7: 41-49 dBmV
4: 41-52 dBmV
8: 41-49 dBmV
Return loss
> 14 dB in-band
Output impedance
75Ω
a. NOTE: The 16D hardware supports DS center frequencies up to 999 MHz, but for the best performance, it is advisable to go no higher than 960 MHz. If the 999 MHz is attempted, the downstream maximum frequency must be set appropriately using the configure freq-ds-max command. b. For the XD CAM, please see Frequency Grid and Agility, page 9-6. c. The 16D CAM supports 1-4 channels per connector. The XD CAM in Annex B supports 1-8 channels per connector. The XD CAM in Annex A supports 1-8 channels on connectors 0 and 2; 1-4 channels on connectors 1 and 3.
5-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
5 C4 CMTS Specifications
C4/C4c CMTS Rel. 8.0.7
The following table lists the upstream RF electrical specifications. Table 5-2: Upstream RF Electrical Specifications Specification
12U/24U
Frequency Range
5 - 65 MHz
RF channel frequency resolution
show interface cable-upstream 3 Upstream Port 3/0 ------------Port state: IS Connector: 0 Cable-Mac: 1 Downstream Supervision Ports: 14/0 Frequency (Hz): 12000000 Channel width (Hz): 3200000 Equalizer Coefficient State: off Power (dBmV): 0 Max Power Adj Per Range Resp (1/4 dBmV): 24 Ranging Power Thresh For Success (1/4 dBmV): 24 Load Balance Group Id: 16779264 Max Allowable Normal Voice BW (%): 50 Reserved Normal Voice BW (%): 0 Max Allowable Emergency Voice BW (%): 70 Reserved Emergency Voice BW (%): 0 Max Allowed Total (Emergency + Normal) (%): 70 Ingress Cancellation Interval: 0 Ingress Cancellation Size: 0 Map Size (800 microsecond ticks): 1 Logical Channel: 0 1 ------------------------------------------------------------Channel State IS OOS
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-7
10 Upstream Cable Access Modules (UCAMs)
Channel-ID: Channel Type: Modulation profile id: Ranging backoff range: Data backoff range: Slot Size (6.25 microsecond ticks): SCDMA active codes: SCDMA codes per slot: SCDMA frame size: SCDMA hopping seed: Spectrum Group ID: Spectrum Group State: Attribute Mask:
C4/C4c CMTS Rel. 8.0.7
1 tdma 2 2 - 7 2 - 8 2 0x00000000
25 tdma 2 2 - 7 2 - 8 2 0x00000000
Table 10-6 shows the commands to restore default values for a number of upstream and downstream parameters. These are the settings which most users will choose for basic configuration. In each command the default values can be replaced as needed. Table 10-6: Accepting Default Parameters for Cable Upstream Channels of a 12U CAM Command
Purpose
configure interface cable-upstream cable modulation-profile 2
Accept default modulation profile. Default = 2.
configure interface cable-upstream cable channel-width 3200000
Accept default channel width. Default = 3.2 MHz.
configure interface cable-upstream cable power-level 0
Accept default upstream power level. Default = 0. Power range varies with channel width selection. Range = -4 to 3 dBmV if channel width is 3.2 MHz (see Table 10-2, Table 10-3, and Table 10-4 for upstream receive power levels).
10-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
24U Cable Access Module (24U CAM) The 24U CAM provides full DOCSIS 3.0 functionality and supports the following: •
Uses of the same PIC as the 2D12U and 12U CAM with eight upstream RF physical connectors (numbered 0-7) giving an average of three upstreams per connector.
•
Up to twenty-four 2.56-30.72 Mbps physical upstream channels (numbered 0-23).
•
The supported channel types are: SCDMA, TDMA, ATDMA, and TDMA&ATDMA.
•
Range of upstream frequencies configurable for North America, Japan, or Europe: -
5-42 MHz (DOCSIS) 5-55 MHz (Japan) 5-65 MHz (EuroDOCSIS)
NOTE In Release 8.0, the hardware has been designed to support an upstream frequency range of 5-85 MHz but currently the software will only support a range of 5-65 MHz.
NOTE The maximum upstream frequency can be set independent of the Annex or region of operation.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-9
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
PICs Even
Faceplate
ARRIS PIC-CAM (E)
OOS
POWER
Odd
ARRIS ARRIS
PIC-CAM PIC-SCM (O) PIC-SCM
D0
D0
D1
D1
Spare
ARRIS PIC-CAM SPARE
Out of Service
U0
Power
U0 U1
U1
U2 U3
Upstream: Port 0-7 - available
U3 U4
U4 U5 U5 U6
U6 U7 U7
Sparing LED
Figure 10-2: 24U Cable Access Module (CAM) and the Three Types of Upstream Physical Interface Cards (PICs)
10-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
NOTE Any unused connectors (either downstream or upstream) should have a 75 Ohm termination in place. Primary Software Function
LED Status
The primary software function on the 24U CAM includes: •
CM Ranging and Registration
•
MAC Address Learning
•
DOCSIS functions: Packet Classification, Service Flows, Dynamic Services (DSx), BPI+, CM Upstream Bandwidth Scheduling (MAPs), Payload Header Suppression (PHS), Packet defragmentation, packet de-concatenation, and counts collection
•
Upstream Policing
•
Operations, Administration, Maintenance & Provisioning (OAM&P) including initialization and fault recovery code
•
PacketCable DSx processing.
The LED status descriptions for the 24U CAM are listed in Table 10-7 below: Table 10-7: 24U CAM LED Descriptions Front LEDs
Shuffle Network
Power
Out of Service
On
Off
Powered and in normal service state.
Module Status
Flashing
On
Flashing = 1.6 second period. Module power is off: either slot is not provisioned or module has been disabled.
Persistent Fast Flashing
On
Fast flashing = 6 times/second. Normal when card is first powered or restored. If fast flashing persists for more than 2 seconds, there is a serious power problem.
On
On
Powered and out of service.
On
Flashing
Off
Off
Downloading data from SCM, initializing or running diagnostics. The slot has no power.
The Shuffle network spreads upstream channels across multiple PHY chips as the MSO populates the RF connectors in order from top to bottom. When fewer than eight F-connectors are wired (e.g. connectors 0 through 3), the shuffle network will enable the operator to access all 24 upstreams. The 24U CAM will support 24 upstream channels using eight connectors through the current 12U PIC. With the Shuffle network, connectors 0, 2, 4, 6 are connected to the first chip (upstream receivers 0 through 11) and connectors 1, 3, 5, 7 will be
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-11
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
connected to the second chip (upstream receivers 12 through 23) as shown in the figure below.
0 2 4 6
MAC Receiver 2
1 3 5 7
RF0 RF1 RF2 RF3
Amp & Filter
RF4 RF5 RF6 RF7
Figure 10-3: Illustration of the Shuffle Network ARRIS designed the 24U CAM with a Shuffle network so that operators can populate cables onto the 24U CAM connectors in order from top to bottom and still easily utilize up to all 24 upstreams available on the CAM. To assign US channels (receiver) to connectors, use the following command: configure interface cable-upstream cable connector [no] where: us_port = The upstream port. Valid range is 0-23 number = The upstream connector on the PIC. Valid range is 0-7. The [no] version of the command will unassign (decouple) the US channel (receiver) from the connector. The following table specifies the valid US channels (receiver) / connector combinations. Table 10-8: Valid US Channels/Connector
10-12
Upstream Channel Receiver
Connector
0-11 (first receiver)
0, 2, 4, 6
12-23 (second receiver)
1, 3, 5, 7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Rules and Restrictions for 12U/24U CAM Configuration Before growing and configuring a 12U/24U CAM with its upstreams, you should review the following rules and restrictions. Slot Provisioning
Annex Upstream (US) Channel to Physical Connector Mapping
The 12U CAM must be grown in a CAM slot provisioned for a 12U CAM and the 24U CAM must be grown in a CAM slot provisioned for a 24U CAM. CAM sparing can only be done by like cards: a 12U can spare only for a group consisting of 12Us and a 24U can spare only for a group consisting of 24Us. All the CAMs in a sparing group must be of the same type. The CMTS supports multiple annexes in one system. See Mixed Annex
Support on page 9-23.
Guidelines for mapping upstream channels to physical connectors: •
There must be no frequency overlap among the upstream channels using the same connector.
•
The CMTS displays the following error message when the user attempts to change an upstream power level or channel width to a value that is not valid for that power level group: Upstream channel power level conflict with another channel using the same connector. If you receive the above message, the power level and channel width will remain unchanged.
The following guidelines are specific to the 12U CAM: •
There are 8 physical connectors and 12 upstream channels on the 12U CAM. If all channels are enabled then at least one physical connector will receive more than one upstream channel.
•
Any upstream or all of the upstreams can be connected to any one of the physical upstream connectors.
The following guidelines are specific to the 24U CAM:
Issue 2.0
•
There are 8 physical connectors and 24 upstream channels on the 24U CAM. When all upstreams are active, at least two connectors will be in use.
•
Upstream channels 0-11 are connected to connectors 0, 2, 4 and 6 while upstream channels 12-23 are connected to connectors 1, 3, 5 and 7.
•
Upstream channels connected to a single physical connector may vary in channel width and power levels as long as the variance falls within a user-configured power level group. The tables (Tables 10-7 through
ARRIS PROPRIETARY — All Rights Reserved
10-13
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
10-11) below describe the upstream receiver power level groups. All of the power levels for all of the channels connected to a single physical connector must fall within the same table.
24U CAM Upstream Power Level Groups All upstream Rx (receive) values are measured in dBmV. Power after attenuation may vary slightly from one CAM to another.
Table 10-9: US Receiver Power Level Group 1 1.6 MHz
3.2 MHz
6.4 MHz
-13
-10
-7
-12
-9
-6
-11
-8
-5
-10
-7
-4
-9
-6
-3
-8
-5
-2
Table 10-10: US Receiver Power Level Group2
10-14
1.6 MHz
3.2 MHz
6.4 MHz
-7
-4
-1
-6
-3
0
-5
-2
1
-4
-1
2
-3
0
3
-2
1
4
-1
2
5
0
3
6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Table 10-11: US Receiver Power Level Group 3
1.6 MHz
3.2 MHz
6.4 MHz
1
4
7
2
5
8
3
6
9
4
7
10
5
8
11
6
9
12
7
10
13
8
11
14
Table 10-12: US Receiver Power Level Group 4
Issue 2.0
1.6 MHz
3.2 MHz
6.4 MHz
9
12
15
10
13
16
11
14
17
12
15
18
13
16
19
14
17
20
15
18
21
16
19
22
17
20
23
ARRIS PROPRIETARY — All Rights Reserved
10-15
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Table 10-13: US Receiver Power Level Group 5
Procedure 10-1
1.6 MHz
3.2 MHz
6.4 MHz
18
21
24
19
22
25
20
23
26
21
24
27
22
25
28
23
26
29
Before Changing the Receive Power Level Settings of the 24U CAM If there are multiple upstream channels on a single 24U CAM connector and the user is trying to change the receive power level setting on one or more US channels and the new setting causes a change in the power level group (see Tables above), then the user must complete the following steps: 1 Unassign (decouple) the corresponding connector (for all upstream channels that are on that connector). 2 Set the receive power level for all upstream channels on that connector. 3 Add the connector back for all upstream channels on that connector. End of procedure
NOTE The above procedure will not apply when the user changes receive power level setting on one or more upstream channels on the same connector and the new setting does not cause a change in the amplifier attenuation settings. That is, the new and old receive power level settings occur within the same amplifier attenuation setting (per the tables listed in the 24U CAM Upstream Power Level Groups on page 10-14). The following is an example of setting the upstream channels receive power level (attenuation) that will cause a change in the amplifier attenuation settings. Upstream channels 3/0 and 3/1 have the following initial power and channel width settings (3.2 and 6.4 MHz and power level 0):
10-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
configure configure configure configure configure configure configure configure configure configure
interface interface interface interface interface interface interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream
Default Admin States
3/0 3/1 3/0 3/1 3/0 3/1 3/0 3/1 3/0 3/1
shutdown shutdown cable connector no cable connector no cable power-level 10 cable power-level 10 cable connector 0 cable connector 0 shutdown no shutdown no
The default administrative states for the slot/port (receiver) on the 12U CAM and the 24U CAM is UP. NOTE If an upstream channel is configured for ATDMA or SCDMA, then only DOCSIS 2.0 and 3.0 modems will register on those channels.
Basic Command Set for Bringing Up a 24U CAM The set of commands provided in Table 10-14 is the bare minimum for turning up a 24U CAM in a given slot. The values chosen for these commands are meant to be examples. Actual values will vary. Table 10-14: Example of Basic Command Sequence for Configuring a 24U in Slot 5 Command
Purpose
Configure the Upstream Parameters configure slot 5 type 24UCAM
Provision slot 5 as a 24U slot.
configure slot 5 no shutdown
Restore 24U in slot 5.
configure interface cable-mac 1
Assign MAC domain
configure interface cable-mac 1 no shutdown
Restore cable-mac 1
configure interface cable-upstream 5/0 cable cable-mac 1
Assign a channel to cable-mac 1
Configure the Upstream Frequencies and Connectors configure interface cable-upstream 5/0 cable connector 0
Assign upstream channel 0 of CAM 5, to connector 0.
configure interface cable-upstream 5/0 cable frequency 12000000
Configure upstream channel 0 of CAM 5, to use frequency 12 MHz.
configure interface cable-upstream 5/0 cable supervision 14/0
Specify that DS channel 14/0 carries the supervision for channel 5/0.
Put CAM in Service configure interface cable-upstream 5/0 no shutdown
Issue 2.0
Restore upstream channel 0 of CAM 5 to service.
ARRIS PROPRIETARY — All Rights Reserved
10-17
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Table 10-14: Example of Basic Command Sequence for Configuring a 24U in Slot 5 (Continued) Command
Purpose
configure interface cable-upstream 5/0.0 no shutdown
Restore the logical channel to service.
show interface cable-upstream 5
Confirm channel settings for slot 5.
To view the channel settings resulting from configuring the 24U CAM (note that this example shows that a downstream was previously configured), enter: C4>show interface cable-upstream 5 Upstream Port 5/0 ------------Port state: IS Connector: 0 Cable-Mac: 1 Downstream Supervision Ports: 14/0 Frequency (Hz): 12000000 Channel width (Hz): 3200000 Equalizer Coefficient State: off Power (dBmV): 0 Max Power Adj Per Range Resp (1/4 dBmV): 24 Ranging Power Thresh For Success (1/4 dBmV): 24 Load Balance Group Id: 16781312 Max Allowable Normal Voice BW (%): 50 Reserved Normal Voice BW (%): 0 Max Allowable Emergency Voice BW (%): 70 Reserved Emergency Voice BW (%): 0 Max Allowed Total (Emergency + Normal) (%): 70 Ingress Cancellation Interval: 0 Ingress Cancellation Size: 0 Map Size (800 microsecond ticks): 4 Logical Channel: 0 1 ------------------------------------------------------------Channel State IS OOS Channel-ID: 1 25 Channel Type: tdma tdma Modulation profile id: 2 2 Ranging backoff range: 2 - 7 2 - 7 Data backoff range: 2 - 8 2 - 8 Slot Size (6.25 microsecond ticks): 4 4 SCDMA active codes: SCDMA codes per slot: SCDMA frame size:
10-18
-
-
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
SCDMA hopping seed: Spectrum Group ID: Spectrum Group State: Attribute Mask:
0x00000000
0x00000000
Table 10-15 shows the commands to restore default values for a number of upstream and downstream parameters. These are the settings which most users will choose for basic configuration. In each command the default values can be replaced as needed.
Table 10-15: Accepting Default Parameters for Cable Upstream Channels of a 24U CAM Command
Purpose
configure interface cable-upstream cable modulation-profile 2
Accept default modulation profile. Default = 2.
configure interface cable-upstream cable channel-width 3200000
Accept default channel width. Default = 3.2 MHz.
configure interface cable-upstream cable power-level 0
Accept default upstream power level. Default = 0. Power range varies with channel width selection. Range = -10 to 26 dBmV if channel width is 3.2 MHz (see Table 10-9, Table 10-10, Table 10-11, Table 10-10, and Table 10-13 for upstream receive power levels).
Measuring SNR in the 12U/24U CAM For the upstream channel Signal-to-Noise Ratio (SNR) in the C4 CMTS, there are two types of SNR: Channel SNR and Modem SNR. Channel SNR is calculated on a upstream channel basis and the per Modem SNR is calculated from the primary upstream service flow (primary SID) of the modem. TDMA and SCDMA Long Term Slicer Error Power is also used for calculation of the logical channel SNR. If the current Channel SNR is 0 (no traffic on the upstream), the SNR algorithm uses Long Term SNR calculation based from PHY Slicer error which is based upon all IUC’s including contention IUCs (i.e. 1 and 3). Two pieces of information are used in calculating SNR: symbol errors and burst counts. The SNR calculation is performed once the burst count is greater than a certain threshold. The threshold varies depending on whether it is the initial ranging period or during data traffic.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-19
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
The SNR reading is 0.0dB when:
Channel SNR Calculations
•
The logical upstream channel is not in service (IS state) or
•
No modem is registered on the upstream channel
In normal operations, SNR readings reflect upstream channel conditions. The SNR readings will decrease as noise level goes up. In an ideal condition, when noise is not present or very low, the SNR value in decibels is in the high 30’s. Two SNR calculations are performed in the CAM for Channel SNR. SNR based from MAC (IUC4 plus all data IUCs) does not include contention Interval Usage Codes (IUCs) such as 1 and 3. The second SNR calculation is based on all IUCs including IUC1 and IUC3. The two SNR values can be obtained with show cable noise cable-upstream slot/uport detail CLI command. The show cable noise CLI command outputs only the SNR without the contention IUCs. The channel SNR calculation is the same between the 12U and 24U CAM. The SNR is based on the MAC (IUC4 + all data IUCs) excluding contention IUC1 and IUC3. A burst count threshold of 100 packets is used in the calculation and the MIB attribute for this SNR is docsIfSigQSignalNoise. The show cable noise CLI command outputs this SNR whereas the show cable noise cable upstream slot/uport detail CLI command outputs additional SNR calculations based from the PHY chips where the SNR calculation includes all IUCs including contention IUCs. Besides the SNR measurement, the CMTS uses FEC counters to provide additional information to describe the condition of an upstream channel. The CLI command show cable noise outputs the SNR from IUC4 + all data IUCs and FEC counts as shown below:
Upstream Cable Port Mac
SNR(dB)
MicroReflection
FEC_Unerrored
FEC_Corrected
FEC_Uncorrected
Codewords In Error(%) ----------------------------------------------------------------------------------------------------3/0 1 38.6 0 4229 0 0 0.00e+00 3/1 1 38.5 0 3000 0 0 0.00e+00 3/12 1 44.2 0 7757 0 0 0.00e+00 3/13 1 41.6 0 8537 0 0 0.00e+00
NOTE The MicroReflection column is shown in the table, but is not supported in any release. As SNR values decreases, the probability of FEC Corrected and FEC Uncorrected increases.
10-20
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
CLI commands show cable noise cable-upstream slot/port detail shows both calculated SNR values. For 12U CAM, Channel SNR is output as shown below: show cable noise cable-upstream 3/0 detail CAM/US: 3/0 Cable-Mac: 1 SNR from MAC BCM3214, IUC4 + all data IUCs
:
37.9
SNR from PHY BCM3140, TDMA all IUCs
:
37.7
For 24U CAM, Channel SNR is output as shown below: show cable noise cable-upstream 3/0 detail CAM/US: 3/0 Cable-Mac: 2 SNR from BCM3142, IUC4 + all data IUCs SNR from BCM3142, TDMA all IUCs Modem SNR Calculation
: :
38.7 37.9
Modem SNR calculation between 12U and 24U CAM has some variation. Below shows the Modem SNR:
Table 10-16: SNR Calculations for Modem SNR Card Type
12U Channel SNR
24U Channel SNR
Initial Ranging Period
During Traffic/Idle
•
Calculation is based on IUC4 (station maintenance) reading only.
•
Calculation is based on all IUCs except IUC1 and IUC3.
•
Burst counts threshold is 5 packets
•
Burst counts threshold is 50 packets
•
CLI show cable modem noise
•
CLI show cable modem noise
•
MIBs attribute: docsIf3CmtsCmUsStatusSignalNoise MIB attribute is based on the primary flow SNR.
•
MIBs attribute: docsIf3CmtsCmUsStatusSignalNoise MIB attribute is based on the primary flow SNR.
•
Calculation is based on all IUCs except IUC1 and IUC3.
•
Calculation is based on all IUCs except IUC1 and IUC3.
•
Burst counts threshold is 5 packets
•
Burst counts threshold is 50 packets
•
CLI show cable modem noise
•
CLI show cable modem noise
•
MIBs attribute: docsIf3CmtsCmUsStatus SignalNoise MIB attribute is based on the primary flow SNR.
•
MIBs attribute: docsIf3CmtsCmUsStatusSignalNoise MIB attribute is based on the primary flow SNR.
CLI command show cable modem noise outputs as below
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-21
10 Upstream Cable Access Modules (UCAMs)
UChan Interface USSNR CM MAC address (DS-US) (db) --------------- ------------- -----0015.cf9a.4c01 14/0-3/13 38.2 +0015.cf9a.4c01 14/0-3/0 38.6 +0015.cf9a.4c01 14/0-3/1 38.9 +0015.cf9a.4c01 14/0-3/12 38.1 0015.d187.3b7d 14/2-3/12 38.6 +0015.d187.3b7d 14/2-3/0 38.5 +0015.d187.3b7d 14/2-3/1 38.5 +0015.d187.3b7d 14/2-3/13 38.5 0015.cfb7.c5a1 14/2-3/13 38.0 0015.cfb7.c5e3 14/3-3/12 38.6 0015.d0a1.a0f3 14/4-3/0 39.2 0015.cfb7.c394 14/5-3/13 38.1 0015.d002.e6f6 14/6-3/12 38.2 +0015.d002.e6f6 14/6-3/0 38.5 0015.d002.e6f6 14/6-3/1 38.2 +0015.d002.e6f6 14/6-3/13 38.1 NOTE: the plus sign “+” indicates a
10-22
UChan FEC UChan FEC Unerrored Corrected Codewords Codewords --------- --------1064 0 1058 0 1056 0 1059 0 494 0 493 0 492 0 492 0 834 0 498 0 1598 0 895 0 503 0 500 0 502 0 496 0 non-primary channel
ARRIS PROPRIETARY — All Rights Reserved
C4/C4c CMTS Rel. 8.0.7
UChan FEC Uncorrect Codewords --------0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
UChan FEC % Uncorrected Codewords -------------0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00 0.00e+00
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Modulation Profiles The pre-defined modulation profiles discussed in this section are used as a means to define the values of the several parameters needed to configure an upstream (US) channel. These modulation profiles are each given an ID number. They can be modified or used as a starting point to create other modulation profiles for upstream channel definitions that better suit the customers’ applications and environments. Default Modulation Profile
The Modulation Profile ID 2 uses QPSK and TDMA, and it is the default profile. The following sections show you how to define a new modulation profile. NOTE Modulation profile ID 2 can be modified but it cannot be deleted.
Procedure 10-2
How to Create and Apply a Modulation Profile to an US Port This procedure can be used to modify existing modulation profiles or to add new ones. Modulation profiles must be created and then associated with specified upstream ports. Table 10-17: Existing or New Modulation Profile IF YOU SPECIFY AN
THEN THE PROCEDURE WILL
existing modulation profile ID
change an existing modulation profile
unused modulation profile ID
add a new modulation profile
1 Use the following command to alter an existing modulation profile or create a new one (default modulation-profile id = 2): configure cable modulation-profile Where: n = The number of the modulation-profile created or modified. type = IUC Type (see following note)
The CMTS confirms the creation (or modification) of the profile: Modulation profile id set to n
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-23
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
NOTE Default values for the various modulation profile parameters may change according to the IUC selected. See Modulation Profile Parameters, page 10-33 for a complete listing. 2 Use the following command to apply an existing modulation profile to an upstream port. Do not enter a range of ports; the command must be repeated for each upstream port. configure interface cable-upstream / cable modulation-profile 3 Verify the parameters of the new (modified) modulation profile: show cable modulation-profile The system response is similar to the following output: Modulation profile 2 Interval Chan Mod Pre Dif FEC FEC Scr Max Guar L Scr ---Atdma--- Prea -----Scdma----Usage Type Type Len Enc CW amb Bur Time C amb Int Int mble TCM Int Sp Sub Code En Len Seed Siz Size S En Depth Block Type En Size En Cod -----------------------------------------------------------------------------------------------1 request tdma qpsk 56 F 0 16 338 0 8 F T - 3 initial tdma qpsk 640 F 5 34 338 0 48 F T - 4 station tdma qpsk 384 F 5 34 338 0 48 F T - 5 short tdma qpsk 84 F 6 78 338 45 8 T T - 6 long tdma qpsk 96 F 8 220 338 0 8 T T - -
End of procedure
Procedure 10-3
How to Configure an Upstream (US) Channel Perform this procedure for US channel 0 and repeat as necessary for all channels on this CAM. The valid range for US channels is 0–11 (12U CAM) or 0-23 (24U CAM). Some steps are optional. By not executing the optional steps, default settings are applied.
Valid Center Frequencies
In the first step, set the center frequency of the upstream channel. The range of valid center frequencies varies according to the channel width selected. The overall upstream bandwidth in North America is from 5–65 MHz. The first valid center frequency in Hertz is 5,000,000 plus ½ of the channel width. The last valid frequency is 65,000,000 minus ½ of the channel width. Thus, 5-65 MHz is the overall upstream range. To calculate valid upstream center frequencies, refer to Table 10-18 below.
10-24
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
NOTE The CLI supplies meaningful error messages for some but not all invalid combinations of channel width and frequency. If the CLI has no error message to give, a generic SNMP-level message is displayed. Table 10-18: Range of Valid Center Frequencies for Upstream Channels in North America Then first valid center frequency is…
And the last valid center
If channel width is…
1600000
5800000
64200000
3200000
6600000
63400000
6400000
8800000
61800000
frequency is…
1 (Required) Set the center frequency of the US port in Hertz : configure interface cable-upstream / cable frequency Refer to Notes on DOCSIS 3.0 Upstream Frequency Range on page 10-38 for more information on changing the maximum allowable center frequencies.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-25
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
2 If desired, set US channel width in Hertz (default = 3200000): configure interface cable-upstream / cable channel-width {200000 | 400000 | 800000 | 1600000 | 3200000 | 6400000} Where 1600000, 3200000, and 6400000 represent the valid values for channel bandwidth in Hz. Setting the Rx Power Levels
The default receive power level of the CMTS is 0 dBmV. 1 If desired, change the input Rx power to any level from -10 to 26 dBmV (default = 0 dBmV). As shown in Table 10-19, the valid range varies according to the upstream bandwidth. configure interface cable-upstream / cable power-level If the width of a channel is changed and the receive power level is no longer valid, the CMTS automatically adjusts the receive power to the nearest valid value. Table 10-19: Rx Power Ranges for US Channel Widths of 12U/24U US Channel Width in Hz
Valid Rx Power Range (dBmV)
1600000
-13 to +23
a
-10 to +26a
3200000
6400000a
-7 to +29a
a. Setting power levels above 23dBmV is not recommended.
NOTE Resetting the receive power level in a single step from minimum to maximum in a given power range may prevent CM range requests from being received. For example, if the US channel bandwidth is 3200000 Hz and the power level is reset from -10 to 26 dBmV, then the CMs might not register. The CMTS avoids this by resetting the power in one or more steps according to the max-power-adj parameter found in the CMTS cable upstream provisioning. Refer to the tables in 24U CAM Upstream Power Level Groups, page 10-14, to make sure your settings fall within the proper table.
10-26
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
2 If desired, change the maximum power adjustment parameter using the following command (range = 1–48; default = 24 units, which equals 6 dBmV): configure interface cable-upstream / cable max-power-adj Where:
= Maximum size of the CMTS range response power adjustments in units of 0.25 dBmV.
3 If desired, set the start and end values for databackoff parameter (default = 2-8): configure interface cable-upstream / cable databackoff - Where:
the first is the valid range for the start value the second is the valid range for the end value. The start value must be less than or equal to the end value.
4 If desired, enable or disable equalizer coefficient for this port. configure interface cable-upstream / cable pre-eq-enable Where:
true = enabled and false = disabled.
5 If desired, select modulation profile ID (default = 2): configure interface cable-upstream / cable modulation-profile Where:
= the modulation profile numeric identifier
6 If desired, set the start and end values for range backoff parameter (default = 2-7): You must enter the start and end values separated by a dash. configure interface cable-upstream / cable rangebackoff - Where:
the first is the valid range for the start value the second is the valid range for the end value. the start value must be less than or equal to the end value.
7 If desired, put US port in service: configure interface cable-upstream / no shutdown
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-27
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
8 If desired, put US logical channel in service: configure interface cable-upstream / no shutdown 9 If desired, modify some or all of the following parameters for this US channel: C4# configure interface cable-upstream cable ? attribute-mask - Configure attributes for this channel for channel assignment cable-mac - Assign an upstream to a specific cable mac channel-id - Provision the channel identifier for the upstream channel-width - Provision the channel-width for an upstream connector - Provision the connector for an upstream databackoff - databackoff docsis-mode - Provision the docsis mode for an upstream frequency - Provision the frequency for an upstream ingress-cancellation - Upstream ingress cancellation properties load-balance - Turn on/off dynamic load balancing for the upstream channel map-size - Provision the map size for an upstream max-power-adj - Provision the max power adjust for an upstream mini-slot-size - Provision the mini slot size for an upstream modulation-profile - Provision the modulation profile for an upstream power-level - Provision the power level for an upstream pre-eq-enable - Use pre-equalization technique to reduce upstream signal distortion rangebackoff - rangebackoff relay-agent-option - Relay agent circuit ID sub-option scdma - Upstream SCDMA properties show - Display the upstream configuration spectrum-group - Enables frequency agility on this port supervision - Provision the supervisory downstream for this upstream. threshold-power-offset - Provision the power offset threshold for an upstream voice-limits - Set voice data limits
Refer to the CLI Command Descriptions for additional information on this command. 10 Repeat this procedure as needed for the remaining US ports, 0–11 (12U CAM) or 0-23 (24U CAM), on this CAM. End of procedure
10-28
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Procedure 10-4
Putting Cards and Ports into Service This procedure assumes that the US and DS channels have already been configured. This example is for a 24U CAM: 1 The following command brings the CAM online: configure slot no shutdown Where:
slot = the number of the slot, 0-15.
2 Bring up the upstream channel: configure interface cable-upstream / no shutdown 3 Bring up the logical channel: configure interface cable-upstream / no shutdown 4 Repeat steps 2 and 3 as needed for additional upstream channels. 5 Restore the mac-port: configure interface cable-mac no shutdown End of procedure
Procedure 10-5
How to Take a CAM Out of Service and Delete Its Slot This procedure is used to remove a CAM and the slot in which it resides out of service. 1 If the CAM to be taken out of service is part of a spare group, first remove the card from the spare group. configure slot spare-group no 2 Take the CAM out of service: configure slot shutdown Where:
slot = the number of the slot, 0-15.
3 Verify module status: show linecard status
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-29
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
The system response should confirm that the module is out of service. 4 Deprovision the slot: configure no slot Where:
slot = the number of the slot, 0-15.
5 Save your changes: write memory End of procedure
Adjusting Channel Settings in Response to Increased CM Scaling Table 10-20 presents recommendations for channel parameters with respect to cable modem scaling and feature loads.
Table 10-20: Recommended Settings as Cable Modem Scaling Increases Cable Modems per CAM
Ranging Backoff
Insertion
Ranginga
BPI?
CAM Sparing
Up to 1000b
2-5
10-40
2400
OK
Yes
Any
None
1000-2000c
3-7
20-40
1500-2400
OK
Yes
Any
None
5-9
20-40
1500
OK
Yes
Any
None
2000-4500 (12U only) 2000-6600 24U only)
Interval in Centisecs
Service Flow BW/Data Upstream Rate Priority Restrictions
a. If CAM Sparing is not configured, the Ranging Interval can be left at the default value of 2400 centiseconds. Reducing the Ranging Interval is done for the purpose of improving CAM Sparing results on larger scale systems b. If BPI+ is enabled on modems, use 40 centisecond insertion interval when supporting 500-1000 modems. c. If BPI+ is enabled on modems, use 40 centisecond insertion interval.
10-30
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Explanation of Upstream Parameters Modulation profiles are pre-defined sets of upstream channel parameters which make it easier to configure or reconfigure upstream channels. This document describes the parameters used in modulation profiles. Where possible, it lists the default values of these parameters. For greater technical detail on these parameters and their functions, see the DOCSIS Radio Frequency Interface Specification. In order to understand all of the parameters used in modulation profiles, some terms must be defined: IE — Information Element — portions of the allocation MAP used to define transmission opportunities for cable modems. Each IE is a 32-bit quantity, of which the most significant 14 bits represent the Service ID (SID), the middle 4 bits represent the Interval Usage Code (IUC), and the low-order 14 bits represent the minislot offset. SID — Service ID. SIDs are assigned to upstream Service Flows. The CMTS allocates upstream bandwidth to SIDs, therefore to the cable modems served by the SIDs. SIDs are also used in Quality of Service functions. Certain values of SIDs are defined in the RFI specification and convey specific meanings for the service flows they represent: •
0x3FFF implies all CMs (broadcast)
•
0x3FFx where x is a value of 0x1 to 0xE used to indicate that a data message must fit in x number of minislots. This can only be used in the Request/Data IE (broadcast).
•
0x3Exx This can only be used in the Request IE to allow different priorities to use the request region (broadcast). If If If If If If If If
bit bit bit bit bit bit bit bit
0x01 0x02 0x04 0x08 0x10 0x20 0x40 0x80
is is is is is is is is
set, set, set, set, set, set, set, set,
priority priority priority priority priority priority priority priority
0 1 2 3 4 5 6 7
can can can can can can can can
request request request request request request request request
The following SID values have special meaning for 12U or 24U CAMs: 0x1FFF used for FFT (fast Fourier Transform) measurements 0x1FFE used for ingress cancellation
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-31
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Redefining the values of an upstream modulation profile affects all the upstream channels that are using that modulation profile. To display what upstream modulation profile is used on an upstream channel, use one of the following CLI commands: show controllers cable-upstream / configure interface cable-upstream / cable show The system response contains a line similar to the following: Modulation profile id: 2 To redefine the values of an upstream modulation profile, use the following CLI command: configure cable modulation-profile iuc [mod ] [pre-len ] [diff ] [fec-tbytes ] [fec-len ] [seed ] [burst-len ] [last-cw ] [scrambler ] [guard-time-size ] [int-depth ] [int-blocksize ] [pre-type ] [tcm ] [int-stepsize ] [spreader ] [subframe-code ] [docsis-mode ]
Modulation Profile Values
Default values for the various modulation profile parameters may change according to the IUC selected. To display the values associated with a modulation profile number 2, for example, use the following command: show cable modulation-profile 2 Sample output:
Modulation profile 2 Interval Chan Mod Pre Dif FEC FEC Scr Max Guar L Scr ---Atdma--- Prea -----Scdma----Usage Type Type Len Enc CW amb Bur Time C amb Int Int mble TCM Int Sp Sub Code En Len Seed Siz Size S En Depth Block Type En Size En Cod -----------------------------------------------------------------------------------------------1 request tdma qpsk 56 F 0 16 338 0 8 F T - 3 initial tdma qpsk 640 F 5 34 338 0 48 F T - 4 station tdma qpsk 384 F 5 34 338 0 48 F T - 5 short tdma qpsk 84 F 6 78 338 45 8 T T - 6 long tdma qpsk 96 F 8 220 338 0 8 T T - -
10-32
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Table 10-21: Modulation Profile Parameters Parameter ID
Description Identifier. The number of the modulation profile. The CMTS supports a range of up to two billion modulation profile IDs.
Interval Usage Code. The IUC typically has an assigned numeric value. It defines what kind of Information Element (IE) is being sent from the CMTS to the cable modems: • • • • • •
1 2 3 4 5 6
=Request =Request/Data =Initial Ranging =Periodic Ranging =Short Data Grants =Long Data Grants
• 9 =Advanced PHY Short Data Grant • 10 =Advanced PHY Long Data Grant • 11 =Advanced PHY Unsolicited Grant
1 Request This portion of the upstream map interval is used by cable modems to request bandwidth for data transmission. If the class of the SID associated with the request IE is broadcast, then cable modems must contend with each other for upstream bandwidth. If the class of the SID associated with the request IE is unicast, then this is an opportunity for a single cable modem to request additional bandwidth. 2 Request/Data Either data requests or short data messages can be sent in this portion of the upstream map interval. A multicast SID must be used to indicate the size of the data message that can be sent. This IE is not used by the CMTS map algorithm and as such changes made to this IE will have no affect on upstream data transmissions.
IUC
3 Initial Ranging (Also called Initial Maintenance). This IE allows cable modems a method to adjust their timing, frequency, and transmit power so that they can reliably communicate with the CMTS. The timing adjustments allow for the round trip delay of the fiber optic/coax plant plus the time to transmit the range request message. A DOCSIS 1.X cable modem can send a range request message only during this IE. A DOCSIS 2.0 cable modem can send a range request message or an initial range request message depending upon the type of the upstream channel. Normally, range request messages are sent in this IE when it contains a broadcast SID, meaning cable modems must contend with each other when transmitting. An initial range request message can be sent either with a broadcast SID or with a unicast SID depending upon the situation. 4 Periodic Ranging (Also called Station Maintenance). This IE is used so that cable modems can perform station maintenance. This IE is unicast. Only the range request message — no other data — can be sent in this IE. 5 Short Data Grants This unicast IE gives permission to a specific cable modem to transmit one or more Protocol Data Units (PDUs). The cable modem uses this region in the upstream map interval if the number of minislots required to send the message is less than or equal to the maximum burst interval specified for a short data grant in the Upstream Channel Descriptor (UCD) message. The reason that grants can be split into short and long data grants is for the sake of FEC encoding. Short data grants are used only when a cable modem is transmitting via an upstream channel that is compatible with DOCSIS 1.X. 6 Long Data Grants This unicast IE gives permission to a specific cable modem to transmit one or more PDUs. The cable modem uses this region in the upstream map interval if the number of minislots required to send the message is greater than the maximum burst interval for a short data grant in the Upstream Channel Descriptor (UCD) message. The reason that grants can be split into short and long data grants is for the sake of FEC encoding. Long data grants are used only when a cable modem is transmitting via an upstream channel that is compatible with DOCSIS 1.X.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-33
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Table 10-21: Modulation Profile Parameters (Continued) Parameter
Description
Interval Usage Codes (continued) NOTE: The following Advanced PHY types are provided for channels carrying combined DOCSIS 1.x and DOCSIS 2.0 bursts and also for channels carrying DOCSIS 2.0 bursts only. IUC, cont.
9 Advanced PHY Short This IE is the same as a short data grant except that it is used when the cable modem is communicating via an upstream channel that is only DOCSIS 2.0 compatible. 10 Advanced PHY Long This IE is the same as a long data grant except that it is used when the cable modem is communicating via an upstream channel that is only DOCSIS 2.0 compatible. 11 Advanced PHY UGS This IE is new with DOCSIS 2.0. It allows parameters to be optimized for UGS flows, which normally carry VoIP.
mod
Modulation type Values 3–6 must not be used when the upstream channel is only DOCSIS 1.X compatible. A DOCSIS 1.X only compatible channel is signified in the UCD message with a descriptor encoded with a type 4 TLV. A type 5 TLV signifies that the channel is DOCSIS 2.0 compatible. 1 = QPSK 2 = 16QAM
3 = 8QAM 4 = 32QAM 5 = 64QAM
diff
Differential Encoding True = enabled; False = disabled.
fec-tbytes
Forward Error Correction (T) The number of bytes with errors that can be corrected with FEC in the size specified in the codeword information byte length. A value of zero indicates that FEC is disabled. For each byte that can be corrected there are two additional FEC parity bytes that are added to the FEC codeword. The FEC codeword contains both the FEC information bytes and the FEC parity bytes. The number of codeword parity bytes is 2xT, where T = 0-10 for a DOCSIS 1.x upstream channel and 0-16 for a DOCSIS 2.0 upstream channel.
fec-len
Forward Error Correction, Length of Codeword (K) The number of bytes in the information bytes of the FEC codeword. Assuming that FEC is enabled, the FEC codeword can contain from 16 to 253 information bytes. The FEC codeword contains both the FEC information bytes and the FEC parity bytes and can be between 18 and 255 bytes. A shorter codeword will increase the amount of overhead but allow for more errors to be corrected in the total data frame. Preamble Length The preamble serves to put the FEC and randomizer (also called the scrambler) into known states before the data is transmitted. The preamble also helps the receiver to receive an upstream burst accurately. DOCSIS 1.X (type 4 TLV in the UCD) requires the preamble length to be between 0 and 1024 bits. DOCSIS 2.0 (type 5 TLV in the UCD) requires the preamble length to be between 0 and 1536 bits. 12U or 24U CAM
pre-len
• For a TDMA or tdma-atdma upstream channel, IUCs of 3 and 4 with 16 QAM must have a preamble length in the range of 200 to 768. • All other cases for IUCs of 3 and 4 must have a preamble length in the range of 100 to 768. • For a TDMA or tdma-atdma upstream channel, IUCs of 1, 5 and 6 with 16 QAM must have a preamble length in the range of 80 to 256. • All other cases for IUCs of 1, 5 and 6 must have a preamble length in the range of 40 to 256. • For IUCs 9, 10 and 11, the preamble length must be in the range of 40 to 512. Note: Even with the above guidelines, it is possible to choose parameters such that the Preamble Superstring which contains the preamble strings for all the different IUCs does not fit within either the 1024 or the 1536 bit limits. Contact technical support for further assistance if experiencing these problems.
seed
10-34
The 15-bit seed value for the scrambler polynomial. The pseudo-random generator (randomizer) is used so that the data stream will not produce a long string of either 1's or 0's. Changing the seed for the pseudo-random generator will cause the generator to produce a different pattern of ones and zeroes if the same input data is sent to the pseudorandom generator. Some seeds will work better than others for producing a good distribution of 1's and 0's without a contiguous string of either 1's or 0's. The range of possible values is from 0-32767.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
10 Upstream Cable Access Modules (UCAMs)
Table 10-21: Modulation Profile Parameters (Continued) Parameter
Description
burst-len
Burst length The maximum number of minislots that can be used by the IE. For both short data and advanced PHY short data grant IEs, this field must be present and must contain a non-zero value. In general, a zero value implies that the IE is not limited. Range = 0–255.
guard-time-size
Guard Time This is the amount of time measured in symbols that must exist between successive frames. By definition SCDMA channels have no additional time between frames; consequently, this parameter cannot be used for SCDMA. This field is required for non-SCDMA channels and according to the RFI specification must contain a value of at least 5 symbols. This value may be derivable from other network and architectural parameters. Range = 8–96 symbols.
last-cw
Last Codeword This indicates whether the last FEC codeword is of a fixed length or shortened. True = shortened; False = fixed length.
scrambler
This field indicates whether the scrambler or randomizer is enabled or not. True = enabled; False = disabled.
int-depth
ATDMA Byte Interleaver Depth This parameter must be present for all IUCs with an ATDMA upstream channel or IUCs 9, 10 and 11 with a tdma-atdma upstream channel. For all other cases, this parameter must not be present. There are three different states for the ATDMA Byte Interleaver signified by the values: 0 = dynamic mode, 1 = off, 2floor(2048/(K + 2T)) = fixed mode. In fixed mode, there is one FEC codeword per row and the depth is the number of rows in the interleaving matrix. In dynamic mode, the system chooses the row and column sizes of the interleaving matrix to obtain optimum burst noise robustness.
int-blocksize
ATDMA Byte Interleaver Block Size This parameter must be present for all IUCs with an ATDMA upstream channel or IUCs 9, 10 and 11 with a tdma-atdma upstream channel. For all other cases, this parameter must not be present. This parameter represents the number of bytes that can be used by the ATDMA interleaver when in the dynamic mode of operation. Range = 2*(K+2T) – 2048. To obtain optimum benefit of the ATDMA interleaver, use a value of 2048.
pre-type
Preamble Type For DOCSIS 2.0 upstream channels, there are two possible constellation patterns that can be used for the QPSK preamble: qpsk0 and qpsk1. With qpsk1 the preamble’s constellation is at a higher power level when compared to qpsk0. DOCSIS 1.x channels must use the qpsk0 constellation pattern.
tcm
Trellis Coded Modulation TCM must only be used with an SCDMA upstream channel. TCM causes one bit in the symbol to be used for encoding purposes. This bit acts like a parity bit for decoding the rest of the bits in the symbol. Since one bit is removed from the symbol for encoding purposes, the data throughput is similar to what is received if the next lower value for the modulation type is used. The values for the TCM are either on or off.
int-stepsize
SCDMA Interleaver Step Size In an SCDMA upstream channel, interleaving is performed on a sub-frame basis. The interleaver step size determines the manner in which symbols are interleaved within the sub-frame. This option must be present for a SCDMA channel and must not be present for all other upstream channel types. Range = 1–31.
spreader
SCDMA Spreader In an SCDMA upstream channel, there are two modes of spreader operation: on and off. According to the RFI specification, IUC 3 must use spreader off, and IUCs 1, 9, 10 and 11 must use spreader on. And IUC 4 can use either on or off. However, the CMTS only supports the usage of spreader off for IUC 4. This option must be present for an SCDMA channel and must not be present for all other upstream channel types.
subframe-code
SCDMA Codes per Sub-Frame In an SCDMA upstream channel, interleaving is performed on a sub-frame basis. The codes per sub-frame define the size of the sub-frame. A sub-frame can vary in size from 1 code up to the total number of active codes. This option must be present for an SCDMA channel and must not be present for all other upstream channel types. Upstream DOCSIS-Mode This parameter contains the type of the upstream channel which must correspond to one of the following values:
docsis-mode
Issue 2.0
• • • •
tdma (default)show atdma scdma tdma-atdma
ARRIS PROPRIETARY — All Rights Reserved
10-35
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
According to the DOCSIS RFI Specification, another value that is typically associated with upstream modulation profiles is the preamble offset start value. It indicates where in the possible string of the preamble bits the actual preamble actually starts. This value is determined by the CMTS. The string of possible preamble bits is included in the UCD message. Once you have equipped the CMTS with CAMs and put them in service, the upstream channels have to be configured. Use the following command to choose the desired modulation profile and other parameters that determine the upstream channel’s characteristics: configure interface cable-upstream cable where parameter is replaced by one of the parameters listed in Table 10-22, Parameters Used in Configure Interface Cable Upstream (Channel) Command, on page 10-37. NOTE Logical channels are sometimes called subinterfaces. When changing the following upstream parameters, if no logical channel (n.0) is specified, then the command syntax assumes logical channel 0. • Modulation profile ID • Ranging backoff range • Data backoff range • Map size (in 800 microsecond ticks) • Slot size (in 6.25 microsecond ticks) • SCDMA active codes • SCDMA frame size • SCDMA hopping seed • SCDMA codes per slot For all other upstream parameters, if you do not specify a logical channel, then the CLI code will apply the change to the physical interface. In other words, both logical channels of the upstream will be affected. For example, the following command does not specify a logical channel, and it affects the entire upstream: configure interface cable-upstream 5/0 no shutdown The following command brings up only logical channel 0: configure interface cable-upstream 5/0.0 no shutdown
10-36
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
The following command assigns modulation profile 3 to upstream channel 5/0: configure interface cable-upstream 5/0 cable modulation-profile 3
Table 10-22: Parameters Used in Configure Interface Cable Upstream (Channel) Command Parameter
Definition
connector
Upstream connector on the PIC. Range = 0–7
frequency
channel-width
Upstream channel width in Hz. Values = 1600000, 3200000, or 6400000. Default = 3200000.
pre-eq-enable
If true, send equalizer coefficients back.
power-level
Power level (dBmV). Range depends on channel width: Default = 0 dBmV. 12U/24U CAMs (DOCSIS 3.0) Channel Width Range Recommended 1600000 Hz -13 to +23 -13 to +17 3200000 Hz -10 to +26 -10 to +20 6400000 Hz -7 to +29 -7 to +23
max-power-adj
Maximum CM power adjustment per range response message. Range = 1 to 48. Default = 24.
threshold-poweroffset
Maximum power offset in increments of .25 dB from RX target for ranging success. Range = 4 to 32. Default = 24 (Note: DOCSIS recommends only 4-24).
Center frequency in Hz. Range =
voice-limits
Set voice data limits
ingress-cancellation
Upstream ingress cancellation properties
show
Display the upstream configuration.
(42) (55) (65)
5100000 – 41900000 5100000 – 54900000 5100000 – 64900000
NOTE: The following parameters pertain to logical channels. DOCSIS-mode is determined by the modulation profile. This parameter is used for display purposes in the show commands. Valid types: tdma, atdma, scdma, tdma-atdma
docsis-mode description
Comment or text string to help users to remember what is attached to this interface.
modulation-profile
Modulation profile identification number. Default = 2
rangebackoff
Random backoff window used when retrying ranging requests. Range = 1–16. Default = 2–7.
databackoff
-
Random backoff window used when retrying transmissions. Range = 0–16; start value must be less than end value. Default = 2–8.
map-size
Average map size in 800 microsecond ticks. Range = 1-13. Default = 4.
spectrum-group
Enables upstream agility on the specified upstream channel using the state machine identifier. This is an integer value between 1 and 40.
relay-agent-option circuit-id
if-index text hex
Enables the relay agent circuit ID sub-option on a specified upstream channel by using either the upstream ifIndex, an ASCII string (32 characters max), or by hex string (64 characters max).
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-37
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Table 10-22: Parameters Used in Configure Interface Cable Upstream (Channel) Command Parameter
scdma
Definition active-codes frame-size hopping-seed codes-per-slot
Number of active SCDMA codes: from 64 to 128 SCDMA frame size in units of spreading intervals 5-bit seed used for code hopping sequence initialization Number of SCDMA codes per mini-slot The range of minislot size depends on the channel width. Each tick is 6.25 microseconds long.
mini-slot-size
Number of Ticks 2/4/8/16/32/64/128 1 a /2/4/8/16/32/64/128 1 b /2/4/8/16/32/64/128
Channel Width 1600 3200 6400 b
a. The mini-slot-size of 1 applies only to DOCSIS 2.0 or 3.0 ATDMA channels. b. The channel-width of 6400 kHz is valid only for DOCSIS 2.0 or higher channels.
12U/24U Ingress Noise Cancellation
The following CLI command is used to enable ingress cancellation: configure interface cable-upstream / cable ingress-cancellation [interval ] [size ] The recommended values for the interval and size parameters are as follows: Interval 100 Size 0
Notes on DOCSIS 3.0 Upstream Frequency Range
DOCSIS 3.0 (North America) provides for an extended upstream frequency range of 42 – 85 MHz. The 12U CAM supports an upstream range of 5 – 65 MHz: it is limited by hardware constraints to a maximum of 65 MHz. The 24U CAM hardware has been designed to support a range of 5-85 MHz, but currently the software will only support a range of 5-65 MHz. Use the following command to set the maximum upstream frequency for all channels (global) within the chassis: configure cable freq-us-max {42 | 55 | 65} [no] The default maximum upstream frequency for global Annex A is 65 MHz; for Annex B it is 42. The maximum upstream frequency of 55 MHz must be explicitly set. The no parameter sets the upstream frequency range to the default value specified by the current Annex.
10-38
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
10 Upstream Cable Access Modules (UCAMs)
Use the following command to set the maximum upstream frequency for a specific cable-mac within the chassis: configure interface cable-mac cable freq-us-max {42 | 55 | 65} To display the global upstream frequency range, use the following command: show cable global-settings To display the upstream frequency range on a specific cable-mac (which takes precedence over the global setting), use the following command: show interface cable-mac | include upstream
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-39
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Modulation Profiles: Default and User-defined In the CMTS there is a default modulation profile that is automatically created for the user: modulation profile 2. Modulation profile 1 supported a previous version of the upstream CAM and is no longer available. CMTS users are free to create user-defined modulation profiles. User-defined modulation profiles provide a shortcut method for a user to easily create modulation profiles just by specifying the desired channel type and modulation rate. User-defined modulation profiles can be assigned to any number from 3–n to create a new profile. (It is recommended that you do not use 2; otherwise you will overwrite the default). If you choose a number that is already in use, then the existing modulation profile will be overwritten by the new one. There is almost no limit to the number you can create. Each user-defined modulation profile is defined by a channel type, such as tdma, and a modulation type, such as 16QAM. The user-defined profile defines most of the parameters for that modulation and channel type. For example, if you want to use the user-defined profile for TDMA and 16QAM to create modulation profile 20, enter the following command: configure cable modulation-profile 20 tdma qam-16 Modulation profile 20 as defined by the above command: Interval Chan Mod Pre Dif FEC FEC Scr Max Guar L Scr ---Atdma--- Prea -----Scdma----Usage Type Type Len Enc CW amb Bur Time C amb Int Int mble TCM Int Sp Sub Code En Len Seed Siz Size S En Depth Block Type En Size En Cod --------------------------------------------------------------------------------------------1 request tdma qpsk 56 F 0 16 338 0 8 F T - 3 initial tdma qpsk 640 F 5 34 338 0 48 F T - 4 station tdma qpsk 384 F 5 34 338 0 48 F T - 5 short tdma q16 168 F 6 78 338 23 8 T T - 6 long tdma q16 192 F 8 220 338 0 8 T T - -
Basically, user-defined modulation profiles allow the user to specify the channel type and the modulation rate for the data IUCs and the rest of the information for the modulation profile is filled in with recommended values. These recommended values are generic values that should work across a wide variety of plants. Users may want to optimize these values to the specific needs of their cable plant. The following channel types are currently supported: atdma scdma tdma tdma-atdma
10-40
-
Use Use Use Use
preconfigured preconfigured preconfigured preconfigured
ATDMA modulation profile SCDMA modulation profile 12U CAM TDMA modulation profile TDMA-ATDMA modulation profile
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
These user-defined modulation profiles are controlled by the CMTS software. These modulation profiles may evolve and change slightly with different software versions. configure cable modulation-profile 100 ? atdma iuc scdma tdma tdma-atdma
-
Use IUC Use Use Use
preconfigured type preconfigured preconfigured preconfigured
ATDMA modulation profile SCDMA modulation profile CAM TDMA modulation profile TDMA-ATDMA modulation profile
configure cable modulation-profile 100 atdma ? qam-8 qam-16 qam-32 qam-64 qpsk
-
Default Default Default Default Default
ATDMA ATDMA ATDMA ATDMA ATDMA
QAM-8 modulation profile QAM-16 modulation profile QAM-32 modulation profile QAM-64 modulation profile QPSK modulation profile
configure cable modulation-profile 100 scdma ? qam-8 qam-16 qam-32 qam-64 qpsk
-
Default Default Default Default Default
SCDMA SCDMA SCDMA SCDMA SCDMA
QAM-8 modulation profile QAM-16 modulation profile QAM-32 modulation profile QAM-64 modulation profile QPSK modulation profile
configure cable modulation-profile 100 tdma ? qam-16 qpsk
- Default TDMA QAM-16 profile - Default TDMA QPSK modulation profile
configure cable modulation-profile 100 tdma-atdma ? qpsk qam-8 qam-16 qam-32
-
Default Default Default Default
Displaying Modulation Profiles
TDMA-ATDMA QPSK modulation profile TDMA - QPSK for data IUCs and ATDMA - QAM8 for data IUCs TDMA - QAM16 for data IUCs and ATDMA - QAM16 for data IUCs TDMA - QAM16 for data IUCs and ATDMA - QAM32 for data IUCs
Use the following command to view a modulation profile: C4# show cable modulation-profile n Where n = the number of the desired profile.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-41
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
Optimizing a Modulation Profile This section is meant to serve as a guide to some of the issues that are involved in optimizing a modulation profile. Optimizing a modulation profile involves many factors; this document does not claim to explain them all. What you are really trying to do is to optimize throughput in the upstream channel connected to the CMTS and still maintain an acceptable packet error rate. This distinction is important because noise on the upstream channel plays a big role in determining the best modulation profile to use. Additionally, noise on an upstream channel is not consistent over time. Because of this if a single modulation profile is used, then this modulation profile must be able to handle the worst case noise that is expected on the upstream channel and still achieve a reasonable level of performance.
Noise and SNR versus Modulation Symbol Rate Unfortunately, different types of noise are typically seen on an upstream channel, and each type has a different effect on the upstream channel. There is the Average White Gaussian Noise (AWGN) that is always present and is typically referred to as the noise floor. There may be impulse and ingress noise, both of which may cause the noise floor to spike. NOTE Impulse noise is a spike in the time domain and ingress noise results in a spike in the frequency domain. There are various techniques that can be used to reduce the effects of each of these types of noise. For example, having all the cable modems transmit at a higher power level (assuming there is enough power headroom) gives a better Signal to Noise Ratio (SNR) because the modem’s bursts are at a higher power level while the AWGN remains at about the same level. Forward Error Correction (FEC), Ingress Cancellation Block (ICB), and interleaving can be used to correct ingress and impulse noise. Noise affects the SNR. The SNR is the primary indicator of what modulation rate can be used on the upstream channel. If one assumes that an upstream channel has no ingress or impulse noise, then theoretically the following modulation rates would work as long as the SNR of the upstream channel is higher than the stated threshold shown in Table 10-23. Table 10-23 is based on theory. In the real world the thresholds shown here would be too low. The amount of margin that needs to be added is dependant upon the types of noise present in the plant and how that noise
10-42
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
varies over time. Even in a clean plant, we would recommend a margin of at least 4 dB. For a plant with a high noise level, the margin should be increased. Additionally, the CMTS is effective in eliminating AWGN, less effective for impulse noise, and still less effective for ingress noise. Therefore, the amount of SNR margin may also be varied depending upon the type of noise that is present in the system. Table 10-23: Minimum SNR Thresholds under Lab Conditions
FEC
If the Modulation Rate Is…
Then the SNR Threshold Must Be at Least:
64 QAM
21 dB
32 QAM
18 dB
16 QAM
15 dB
8 QAM
12 dB
QPSK
9 dB
Forward Error Correction (FEC) can correct errors that occur in the upstream channel; however, this comes with a cost of additional overhead. FEC is typically expressed in terms of two parameters, T and k. T is used to represent the number of byte errors that can be corrected. The k parameter is used to specify the number of bytes over which the T number of byte errors can be corrected and is called the codeword length. The cost of correcting up to T byte errors in k data bytes is that there is an additional 2 * T bytes of overhead. Note, the values for T are shown in the FEC column in the show cable modulation-profile CLI command. The values for k are shown in the FEC CW Len column in the show cable modulation-profile CLI command. show cable modulation-profile 6 Typical output:
Modulation profile 6 Interval Chan Mod Pre Dif FEC FEC Scr Max Guar L Scr ---Atdma--- Prea -----Scdma----Usage Type Type Len Enc CW amb Bur Time C amb Int Int mble TCM Int Sp Sub Code En Len Seed Siz Size S En Depth Block Type En Size En Cod --------------------------------------------------------------------------------------------1 request tdma qpsk 56 F 0 16 338 0 8 F T - 3 initial tdma qpsk 640 F 5 34 338 0 48 F T - 4 station tdma qpsk 384 F 5 34 338 0 48 F T - 5 short tdma q16 168 F 6 75 338 7 8 T T - 6 long tdma q16 192 F 10 220 338 0 8 T T - -
Figure 10-4 illustrates the relation between code words and the packet, and between the T and k parameters. For detailed information on these
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-43
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
parameters, see sections 6.2.5, 6.2.19, and 8.3.3 of the DOCSIS RFI specification, version 2.0. (CM-SP-RFIv2.0-I10-051209) Upstream Burst Data Packet
Preamble
FEC Codeword
...
FEC Codeword
k FEC Data Bytes
...
FEC Codeword
Guard Time
2 * T FEC Parity Bytes
Figure 10-4: Relation of FEC Codewords to Data Packet A slight decrease in SNR can cause a large increase in the Packet Error Rate (PER). There comes a point where simply adding additional FEC to attempt to correct for the upstream errors is no longer efficient. Once this point is reached, it is more efficient to use a lower modulation rate with less FEC overhead than to continue to increase the FEC protection. Figure 10-5, obtained using the ICO tool, illustrates that it can be more efficient to use a lower FEC setting and a lesser modulation rate. Ideally the channel will operate as far towards the upper left of this chart as possible. The Shannon curve displays what is theoretically possible. The curves for the different modulation rates show the effect of increasing the value of T for the FEC for each of the different modulation rates for the specified modulation profile parameters. In this case, the default 64 QAM ATDMA modulation profile was used. Because the lab chassis used to obtain the data in Figure 10-5 was provisioned with a very short cable plant, these numbers approach the theoretical values listed above for SNR. They do not reflect real-world noise levels. In the 64 QAM modulation profile, if the SNR of the plant is about 20 dB, then a high T value is required to limit the Packet Error Rate (PER) to 0.1%. The highest bit rate one can achieve is about 8 Mbps. However, if we reduce the modulation to 32 QAM and decrease the FEC T value, the bit rate goes up to 12 Mbps under the same conditions. For practical reasons the minimum value of k must be at least 16. Because of this, if there are not 16 data bytes either to be sent or remaining to be sent, then the modem must pad out this data to be 16 bytes. This especially comes into play for IUC 1 where the request frame is 6 bytes. Therefore, to have even the minimal values for FEC of T = 1 and k = 16 for IUC
10-44
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
1, would mean that there must be 18 total bytes (k + 2T) required to transmit 6 bytes of data. Given this amount of overhead, it is normally better to use a low order of modulation such as QPSK and no FEC for IUC 1, assuming the noise on the plant allows this to work.
BITRATE
QAM64
AN SH
NO
N
QAM32 QAM16
QAM8
QPSK
SNR Figure 10-5: Maximum ATDMA Data Rate vs. SNR The type of traffic that is sent in the upstream direction can affect the optimal FEC values also. For example, assuming there is a lot of ACKs and small packets (i.e. 64-byte packets), then the FEC codeword length should be set so that there is no need to pad out the remaining 16 bytes. Assuming a 6-byte MAC header, it would take 70 bytes to send the 64-byte packet. Also assuming BPI is enabled then there is an additional 5-byte extended header such that it would take 75 bytes to send a 64-byte packet. Note, that the preamble is not included in FEC and should not be included in these calculations. In general, the predominant packet size
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-45
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
plus the associated overhead determines that the k value should not be a value between 1 and 15; otherwise there is additional overhead in padding of the codeword. In the case of a DOCSIS 2.0 upstream, the modulation profile will include an IUC 11. The IUC 11 is used for UGS data flows. The thing that most commonly uses UGS data flows is VoIP. There are several different codecs that are used in the industry; however, typically there is only one codec with one sampling period (5, 10 or 20 milliseconds) on a given cable plant. This tends to cause all of the upstream UGS data packets to be of the same size. Knowing the size of these UGS data packets, the value of k for the FEC should be such that no additional padding is required for FEC. Preamble Lengths
The preamble length is something that is displayed in the show cable modulation-profile CLI command in the Pre Len column. This value represents the number of bits that are in the preamble. In general the preamble is transmitted as a QPSK symbol no matter what the modulation type for the IUC actually is. One exception to this is that a 16 QAM TDMA upstream channel will use 16 QAM symbols or 4 bits per symbol. The preamble length is used by the upstream receiver to decode the upstream burst even if the upstream burst is not perfectly aligned with the proper spot in the upstream spectrum. The preamble helps to recognize where an upstream burst actually begins, and is also used to perform equalization on the upstream burst, provided that the preamble is long enough. In general a longer preamble is desired for IUC 3, Initial Ranging, since this is the first time that the CMTS has heard from this modem. Additionally, the extra equalization also helps in IUC3. The amount of gain for equalization does not normally warrant the additional overhead in terms of length of the preamble especially in IUCs other than the ranging IUCs (IUCs 3 and 4). The point where the PHY chip switches from simply recognizing the start of the preamble and making sure that it has the correct pattern to recognizing when extra symbols are used for equalization depends upon several parameters. Some of these parameters are not currently configurable and require very detailed knowledge of how the PHY chip operates. As such, this paper will not explain all of the details behind the following numbers. The point where equalization begins for preambles using QPSK on IUCs 3 and 4 is currently after 136 bits. For IUCs 3 and 4 when 16 QAM is used, equalization begins after 272 bits. For non-ranging IUCs (any IUC except IUCs 3 and 4) for preambles using QPSK, equalization begins after 132 bits. For non-ranging IUCs (any IUC except 3 and 4) for preambles using 16 QAM, equalization begins after 264 bits.
10-46
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
10 Upstream Cable Access Modules (UCAMs)
If there is a lot of impulse noise in the upstream channel, then it is probably worth using shorter preambles to lower the probability that an impulse will actually hit a preamble. Note that if an impulse actually hits a preamble that most likely the entire frame will be discarded because of a bad preamble. Part of the reason behind this is that the preamble is not protected with FEC. As such with a lot of impulse noise on the upstream channel, the preamble lengths should be shortened. Because of the way that the PHY receiver works in the CMTS, for an SCDMA channel type, there is a slight benefit that can be gained if the preamble length is a multiple of the SCDMA frame size in symbols. The default value for the SCDMA frame size is sixteen symbols. Since the preamble for SCDMA is always QPSK, which is two bits per symbol, there is a slight benefit if the preamble is a multiple of 32. Differential Encoding
Differential encoding can be enabled since it is a feature in the DOCSIS RFI specifications; however, there is no real gain to be had in doing this. This mode is rarely used in the field; therefore we recommend that you leave Differential Encoding disabled. (For more information, see http://www.cablemodem.com/specifications.)
Scrambler Seeds
This is a value that tends to be tied to the PHY hardware. These values have already been optimized by the PHY manufacturer. Therefore, do not change the values that come with the default modulation profiles for the scrambler seed.
Maximum Burst Size
This value is contained is something that is displayed in the show cable modulation-profile CLI command in the Max(imum) Bur(st) Size column. This value is in terms of maximum number of minislots that may be used by the associated IUC. A value of 0 for the maximum burst size means that there is no limitation on the size at least in the modulation profile. NOTE The short data grant (IUC 5) and the advanced phy short data grant (IUC 9) must have non-zero values. It is important to understand the type of traffic that is to be sent upstream and the relative priority of that traffic when adjusting this parameter. For example, if there is VoIP traffic on an upstream that uses a TDMA channel type, then the VoIP traffic should be given a higher priority in terms of FEC protection. Assuming that there is more FEC associated with a short data grant (IUC 5) than with a long data grant (IUC 6), then the maximum burst size should be set such that the higher priority traffic, in this case VoIP, uses the IUC with the higher level of FEC protection.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
10-47
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
When the modulation profile is for an ATDMA or an SCDMA channel, the modulation profile will contain the UGS IUC 11. The VoIP traffic will tend to use this IUC on a DOCSIS 2.0 upstream channel. In this case make sure you do not include the UGS data packets into the process of determining the best value for the maximum burst size. Guard Time Size
The guard time size is given in the Guar Time Size column in the show cable modulation-profile CLI command. The guard time size is related to processing delays with a non-SCDMA upstream channel and is defined to be zero for an SCDMA upstream channel. The times for nonSCDMA channels are already optimized based upon the hardware to be as small as possible without losing data. If the numbers are increased, then upstream bandwidth is lost without any additional gains. Changing the default is not recommended.
Shortened Last Codeword
A codeword is specified by the k parameter for FEC. Assuming the data packet is not an even multiple of k, then the last codeword used to transmit a data packet will have less than k bytes to send. This parameter controls the format of that last codeword. The last codeword must always contain at least 16 bytes whether shortened or not. This parameter control whether or not the last codeword must contain k bytes or if it can contain between 16 and k bytes. If the last codeword can contain between 16 and k bytes, the last codeword is allowed to be shortened and this parameter has a values of true (T). If the last codeword must be padded out to contain k bytes, then the shortened last codeword value is set to false (F). The shortened last codeword is displayed in the LCS (Last Codeword Shortened) field in the show cable modulation-profile CLI command. In general having the shortened last codeword set to true will improve upstream efficiency in that there is less overhead associated with the additional padding in the last codeword. The default modulation profiles in general for IUCs 1, 3 and 4 do not have this set to true, simply because the messages sent on IUCs 1, 3 and 4 are of a fixed length and the values for k are already optimized for this length. As such there is no benefit to turning on shortened last codeword with the default modulation profiles unless the value of k is changed for these modulation profiles to a nonoptimal value.
Scrambler Enable
The scrambler enable is shown in the show cable modulation-profile CLI command in the Scramb En column. The scrambler might be better called a randomizer. Having this field set to true enables hardware that randomizes the bit stream to avoid a long pattern of either zeroes or ones. This helps in the overall transmission efficiency of the entire system. In general this should always be set to true (T).
ATDMA Interleaver Depth
With an ATDMA upstream channel, there is the capability of using an interleaver that is not available in the DOCSIS 1.X version of TDMA. This interleaver works on a byte basis. When enabled, the interleaver will change
10-48
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
10 Upstream Cable Access Modules (UCAMs)
the order in which bytes are transmitted. This has a side effect of causing additional latency in the upstream direction. The benefit is the additional protection against impulse noise. In general an impulse will corrupt some number of bytes that are transmitted consecutively with time. If the bytes are all from the same FEC codeword, and if FEC is not able to correct for this problem, then the data is lost. However, by ordering the transmission of bytes such that bytes from multiple FEC codewords are intermixed, the same impulse will hit fewer bytes from the same FEC codeword giving a better chance that FEC will be able to recover the corrupted data. The ATDMA interleaver depth is shown in the show cable modulationprofile CLI command in the Atdma Int Depth column. This value controls how this interleaver works. A value of 0, puts the interleaver into a dynamic mode such that the interleaver adjusts the way that it interleaves the data based upon the size of the data to transmit. A value of 1, turns off this interleaver. Any other value directly controls how many FEC codewords are interleaved together. When directly controlling how many FEC codewords are interleaved together, the value has a range from 2 to the floor (2048 / (k + 2T)) where k and T are the FEC parameters described in the FEC section of this document. The default modulation profiles use the dynamic mode of operation in order to get as much protection from impulse noise as possible. If a system has extremely tight restrictions in terms of upstream latency, then the amount of interleaving may be changed to either be off or of a lesser amount. This comes at the cost of reduced impulse noise immunity. ATDMA Interleaver Block Size
This is another control for the ATDMA byte interleaver and is shown in the show cable modulation-profile CLI command in the Atdma Int Block field. According to the DOCSIS 2.0 RFI specification, both the CMTS and a cable modem must contain 2048 bytes of memory to perform the ATDMA byte interleaving. This parameter controls how much of that memory is used. The parameter can vary from 2 * (k + 2T) up to 2048 where k and T are the FEC parameters described in the FEC section. When the ATDMA byte interleaver is in the dynamic mode of operation, this parameter should really be left at the 2048 value; otherwise, the byte interleaver will perform sub-optimally. Note, the dynamic mode of operation and a block size of 2048 are used in the default modulation profiles.
Preamble Type
Issue 2.0
An upstream channel using either ATDMA or SCDMA, has the capability to change the power level at which the preamble is transmitted. This is displayed in the show cable modulation-profile CLI command in the Preamble Type column. There are two different values that are possible for the preamble power levels. The first value is QPSK0 which corresponds to the transmit levels that are used by a DOCSIS 1.x upstream channel. The second value is QPSK1, which uses a higher power level. For actual differences in the power levels, see the DOCSIS 2.0 RFI specification.
ARRIS PROPRIETARY — All Rights Reserved
10-49
10 Upstream Cable Access Modules (UCAMs)
C4/C4c CMTS Rel. 8.0.7
By transmitting at a higher power level, there are times when a preamble of type QPSK1 will be heard when the QPSK0 preamble type would not be heard. Therefore QPSK1 is used for the default modulation profiles. SCDMA TCM Enable
SCDMA upstream channels can use Trellis Coded Modulation (TCM). The Scdma Tcm En column of the show cable modulation-profile command shows whether it is enabled. Theoretically there is a slight gain to be had by using TCM. However, in practice there are sometimes problems with TCM. There are cases where TCM will actually compound problems and cause more errors than it solves. Consequently, these issues tend to offset the possible gain. TCM is not enabled in the default modulation profiles.
SCDMA Interleaver Step Size
This parameter controls how the interleaver actually interleaves symbols in an SCDMA frame. It appears in the show cable modulationprofile command in the Scdma Int Size column. According to the DOCSIS RFI specification, this parameter has a value from 1 to 31. The PHY chip that is used places an additional restriction in the value must be at least 1 and has a maximum of SCDMA frame size minus 1. The SCDMA frame size is also called the SCDMA spreading interval. In general increasing this number will helps reduce impulse noise. The cost associated with increasing this value is additional latency. The default modulation profiles have a value of 5 for this parameter.
SCDMA Spreader Enable
According to the DOCSIS RFI specification, if SCDMA is enabled, IUC 3 must have the spreader off and the IUCs 1, 9, 10 and 11 must have the spreader on. This only leaves IUC 4. The specification states that it can have the spreader on or off. However, the current version of the software only supports spreader off for IUC 4. Therefore, all of the values for the spreader must remain the same as what is currently in the default modulation profiles. This is shown in the show cable modulation-profile command in the Scdma Sp En column.
SCDMA Codes Per Subframe
This parameter is used in with the SCDMA interleaver step size to determine how data is interleaved with SCDMA. This parameter is shown in the show cable modulation-profile command in the Scdma Sub Code column. When interleaving with SCDMA, preamble and TCM-encoded symbols are interleaved in one way and non-TCM-encoded symbols are interleaved in another. This parameter has the greatest effect on the preamble and TCMencoded symbols. Since in general TCM is not recommended, this simply leaves the preamble symbols. As such this parameter does not tend to have much effect on the overall performance of the system.
10-50
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
11
Basic Bring-up Procedure
Topics
Introduction
Page
Before You Begin
1
Bring-up Procedures
5
Verification Steps
14
IPv6 Configuration (Optional)
22
This chapter provides the basic procedure to bring up a C4 CMTS system for Release 8.x. This is not a software upgrade procedure: it assumes that the chassis is not yet in service. Installing the chassis, modules, and cards and configuring the system are addressed in this chapter. It is advisable to read through this information and become familiar with the order of operation before you begin. This chapter is based on a minimal configuration for a duplex system and bring-up. The minimal configuration and examples used in this chapter will consist of one System Control Module (SCM), one Router Control Module (RCM), one 24U Cable Access Module (CAM) and a 32D CAM. Most systems will be configured in redundant mode which means that each of the boards will have a spare or be part of a sparing group.
Before You Begin In order to properly set up the C4 CMTS for Release 8.0, several items are required to make the installation run smoothly. These include: 1 Chassis installation and powering
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
11-1
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
2 Hybrid Fiber Coax (HFC) network connectivity 3 The IP network plan for this C4 CMTS 4 Set up of the provisioning environment for the new C4 CMTS Chassis Installation and Powering
It is assumed that the C4 CMTS has been mounted in a rack in the headend and cabled for power prior to starting the Release 8.0 C4 CMTS installation. Do not power up the chassis until told to do so in the procedure. DC Power — For additional information on power on the system, refer to the C4 CMTS User Guide chapter on “Installing/Replacing Modules and Initial System Configuration.”
HFC Network Connectivity
A useful tool for planning the C4 CMTS configuration is the Network Connectivity Plan, as shown in Figure 11-1, page 11-3. This plan details the physical connections needed for the C4 CMTS to reach the HFC plant as well as how the C4 CMTS will be connected to the Operator Network for Internet Access and provisioning, monitoring, and control. Another useful tool for the C4 CMTS configuration is the HFC Network Connectivity Worksheets provided at the end of this chapter. These worksheets help with the channel and spectrum mapping tasks that are necessary for DOCSIS 3.0 deployments. This information is reflected in the C4 CMTS running configuration and is gathered to make that configuration complete. Blank worksheets for configuring your network connectivity plan are located at the end of this chapter.
11-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
D0-3
D0
D4-7
D1
D8-11
U0
D12-15
U1
U3
U4
U5
U6
U7
Figure 11-1: Network Connectivity Diagram
IP Network Plan
Issue 2.0
A network diagram is used to illustrate and document your specific network. Figure 11-2 is an example of a basic network with sample IP addresses displayed. The IP addresses shown here are also used in subse-
ARRIS PROPRIETARY — All Rights Reserved
11-3
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
quent examples in this chapter. (See the blank form for actual use at the end of this section.)
Next Hop Router 192.168.176.1 255.255.255.0
RCM 17/0 192.168.176.2 255.255.255.0
DHCP TFTP TOD 10.43.210.1
MAC Domain 1 192.168.180.1 255.255.255.0
CMTS Figure 11-2: Network Diagram Example Configuration of Back Office Servers
The following servers must be correctly provisioned to support the DOCSIS and non-DOCSIS devices and services. DHCP Server — A Dynamic Host Configuration Protocol (DHCP) server is needed to provide IP addresses to the modems and Customer Premise Equipment (CPE). The following options are required for registering modems: •
Option 2 — time offset
•
Option 3 — router (IP address of CAM primary address)
•
Option 4 — time server (IP address of the time server)
•
Option 66 — boot server host name (IP address of the TFTP server)
•
Option 67 — bootfile name (name of the modem configuration file)
TFTP Server — This server is required to send the modem configuration file to the modem. Time of Day Server — This server provides the time of day to the modems.
11-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
Bring-up Procedures The following is a high-level list of the steps of this procedure: 1. Install Cards, Rear PICs, Filler Panels, PCMs, and Fans 2. Set Up Console Cable 3. Power Up the Chassis 4. Configure Slots 5. Configure RCM Ethernet Connections 6. Configure MAC Domains 7. Configure Downstream Parameters 8. Configure Upstream Parameters 9. Configure Fiber Node and Topology 10. Configure a Dynamic Bonding Group 11. Configure RCC Management 12. Local Authentication 13. Managing the C4 CMTS 14. Configure the SNMP 15. Configure Clock 16. Save the Configuration 17. Cable CAMs and RCM 18. Configure/Verify Back Office Systems 19. Verify the C4 CMTS Configuration 20. Verify Modem Registration (21) IPv6 Configuration (Optional)
A C4 CMTS with one 32D CAM, one 24U CAM, one RCM and one SCM is configured to serve a set of 4 optical nodes. Both DOCSIS 2.0 and 3.0 CMs will be put into service. The DOCSIS 3.0 CMs are provisioned with IPv6 addresses, while the DOCSIS 2.0 CMs obtain IPv4 addresses. All CPE are provisioned as IPv4 devices.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
11-5
11 Basic Bring-up Procedure
1. Install Cards, Rear PICs, Filler Panels, PCMs, and Fans
C4/C4c CMTS Rel. 8.0.7
The C4 CMTS chassis hardware is configured as follows: •
The chassis has 21 slots that can be filled with various modules
•
Slots are numbered from 0-20 counting from left to right
•
Slots 19 and 20 are reserved for SCMs
•
Slots 17 and 18 are reserved for RCMs
The 32D CAM provides downstream channels for as few as one or as many as sixteen different MAC domains.The 32D CAM is designed to run in the client-card slots to the right side of the chassis, beginning with slot 15, then 14, and so on working to the left. It is advisable to begin with slot 14, reserving slot 15 for later use as a spare 32D CAM. The 24U CAM is responsible for upstream RF reception. The 24U CAMs are designed to be installed from left to right in the chassis, beginning with slot 0. For this configuration example, an SCM is installed in Slot 19, and RCM in slot 17, and a 32D CAM will be installed in slot 14. A 24U CAM will be installed in slot 1. In this example, blank slots are available for additional cards. Refer to Figure 11-3 to view the sample configuration. The rear spare Physical Interface Cards (PICs) are different for 24U and 32D CAMs.
B
B
B
B
B
B
B
B
B
B
B
B
L
L
L
L
L
L
L
L
L
L
L
L
A
A
A
A
A
A
A
A
A
A
A
A
N
N
N
N
N
N
N
N
N
N
N
N
K
K
K
K
K
K
K
K
K
K
K
K
1
32D
24U C A M
32D
24U S P A R E 0
C S A P M A R E 14 15
B L
R R S S C C C C M M M M
A N K
17 18 19 20
Figure 11-3: C4 CMTS Slot Diagram 2. Set Up Console Cable
The operator console is necessary for the initial power up and configuring of the C4 CMTS. You may use an asynchronous terminal or a PC with asynchronous terminal emulation software, such as HyperTerm or Teraterm. The C4 CMTS is shipped with a black roll-over cable that has a 9-pin connector on one end and an RJ-45 connector on the other. The RJ-45 end
11-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
plugs into the front of the SCM card into the RS-232 port. The other end plugs into a computer or terminal server. The default connection settings for the computer COM port are: •
9600 Baud rate
•
8 data bits
•
No parity
•
1-stop bit
•
Flow control Xon/Xoff
Once a successful connection is made, you should get a login prompt. 3. Power Up the Chassis
At this point, power up the chassis.The SCM and RCM are configured automatically and come into service. As the C4 CMTS is coming up, the system output displays the system activity.
4. Configure Slots
Use the following commands for basic slot configuration: configure configure configure configure configure configure configure configure configure configure configure configure
5. Configure RCM Ethernet Connections
slot slot slot slot slot slot slot slot slot slot slot slot
14 type 32DCAM-B 15 type 32DCAM-B 0 type 24UCAM 1 type 24UCAM 0 spare-group 0 auto 1 spare-group 0 15 spare-group 15 auto 14 spare-group 15 14 no shutdown 15 no shutdown 0 no shutdown 1 no shutdown
Enter the following CLI commands to configure the RCM ethernet port:
configure interface gigabitEthernet 17/0 ip address 192.168.176.2 255.255.255.0 configure interface gigabitEthernet 17/0 no shutdown
This example uses static routing. To apply a default route, enter: configure ip route 0.0.0.0 0.0.0.0 192.168.176.1
6. Configure MAC Domains
Issue 2.0
This section configures the MAC Domain on your system.
ARRIS PROPRIETARY — All Rights Reserved
11-7
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
NOTE Each MAC domain must consist of channels from exactly one 32D CAM and exactly one 24U CAM. In other words, the MAC domain cannot include ports from more than one 32D CAM or from more than one 24U CAM. Configure and assign the MAC domain: configure configure configure configure configure
interface interface interface interface interface
cable-mac cable-mac cable-mac cable-mac cable-mac
1 1 1 1 1
description BigMac cable cm-ip-prov-mode ipv4only ip address 192.168.180.1 255.255.255.0 cable helper-address 10.43.210.1 no shutdown CAUTION
If an IPv4 or IPv6 address on a cable interface is changed or removed, or if a subnet mask on a cable interface is changed, then be well aware that all cable modems and CPEs using addresses on the changed/removed IPv4/IPv6 subnet will be stranded. They will have no communication with other cable modems or CPEs. The stranded cable modems and CPEs will remain stranded until they acquire IPv4/IPv6 addresses on a subnet of that interface. Also, CPEs behind a cable modem that is stranded that attempt to acquire an IP address using DHCP will not have access to the DHCP server. This modification or removal includes any IPv4/IPv6 address on a cable interface, either primary or secondary. When an IPv4 or IPv6 address or subnet mask is modified or removed from a cable interface, all IPv4/IPv6 cable modems on that subnet should be reset. 7. Configure Downstream Parameters
This section configures a single 32D CAM in slot 14. The 32D has the following characteristics: •
4 physical connectors: each one can output 8 downstream channels
•
The downstream channel frequencies are grouped eight per connector. For each connector there is an 80 MHz frequency range available for those four channels.
•
DS carriers 0-7 are associated with connector D0
•
DS carriers 8-15 are associated with connector D1
•
DS carriers 16-23 are associated with connector D2
•
DS carriers 24-31 are associated with connector D3
To configure the downstream interfaces, enter:
11-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
configure configure configure configure configure configure configure configure
interface interface interface interface interface interface interface interface
cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream
14/0 14/1 14/2 14/3 14/4 14/5 14/6 14/7
cable cable cable cable cable cable cable cable
cable-mac cable-mac cable-mac cable-mac cable-mac cable-mac cable-mac cable-mac
1 1 1 1 1 1 1 1
To configure the 32D CAM downstream interfaces to the cable-mac, enter: configure configure configure configure configure configure configure configure
interface interface interface interface interface interface interface interface
cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream
14/0 14/1 14/2 14/3 14/4 14/5 14/6 14/7
cable cable cable cable cable cable cable cable
configure configure configure configure configure configure configure configure
interface interface interface interface interface interface interface interface
cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream cable-downstream
14/0 14/1 14/2 14/3 14/4 14/5 14/6 14/7
no no no no no no no no
8. Configure Upstream Parameters
frequency frequency frequency frequency frequency frequency frequency frequency
321000000 327000000 333000000 339000000 345000000 351000000 357000000 363000000
shutdown shutdown shutdown shutdown shutdown shutdown shutdown shutdown
This section provides a procedure to configure four upstream channels that are connected to the four nodes. Each upstream in this example is configured with the same frequency and modulation profile. Each upstream has a unique upstream channel id and is supervised by all four downstream channels. NOTE On the 24U CAM, upstreams 0 - 11 must be assigned to even connectors; upstreams 12 - 23 must be assigned to odd connectors. To configure the upstream channels, enter:
configure configure configure configure
Issue 2.0
interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream
1/0 1/1 1/2 1/3
cable cable cable cable
cable-mac cable-mac cable-mac cable-mac
1 1 1 1
ARRIS PROPRIETARY — All Rights Reserved
11-9
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
configure configure configure configure
interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream
1/0 1/1 1/2 1/3
cable cable cable cable
connector connector connector connector
0 0 0 0
configure configure configure configure
interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream
1/0 1/1 1/2 1/3
cable cable cable cable
frequency frequency frequency frequency
10000000 20000000 30000000 40000000
configure configure configure configure configure configure configure configure
interface interface interface interface interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream
1/0 1/0 1/0 1/0 1/0 1/0 1/0 1/0
cable cable cable cable cable cable cable cable
supervision supervision supervision supervision supervision supervision supervision supervision
14/0 14/1 14/2 14/3 14/4 14/5 14/6 14/7
configure configure configure configure configure configure configure configure
interface interface interface interface interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream
1/1 1/1 1/1 1/1 1/1 1/1 1/1 1/1
cable cable cable cable cable cable cable cable
supervision supervision supervision supervision supervision supervision supervision supervision
14/0 14/1 14/2 14/3 14/4 14/5 14/6 14/7
configure configure configure configure configure configure configure configure
interface interface interface interface interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream
1/2 1/2 1/2 1/2 1/2 1/2 1/2 1/2
cable cable cable cable cable cable cable cable
supervision supervision supervision supervision supervision supervision supervision supervision
14/0 14/1 14/2 14/3 14/4 14/5 14/6} 14/7
configure configure configure configure configure configure configure configure
interface interface interface interface interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream cable-upstream
1/3 1/3 1/3 1/3 1/3 1/3 1/3 1/3
cable cable cable cable cable cable cable cable
supervision supervision supervision supervision supervision supervision supervision supervision
14/0 14/1 14/2 14/3 14/4 14/5 14/6 14/7
11-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
configure configure configure configure
interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream
1/0 1/1 1/2 1/3
configure configure configure configure
interface interface interface interface
cable-upstream cable-upstream cable-upstream cable-upstream
1/0.0 1/1.0 1/2.0 1/3.0
9. Configure Fiber Node and Topology
no no no no
shutdown shutdown shutdown shutdown no no no no
shutdown shutdown shutdown shutdown
This section provides commands to configure the fiber node data and assign the channels that were defined in the previous procedures to those fiber nodes. Configure fiber node 1:
configure cable fiber-node FN1 configure cable fiber-node FN1 cable-upstream 1/0 1/1 1/2 1/3 configure cable fiber-node FN1 cable-downstream 14/0 14/1 14/2 14/3 14/4 14/5 14/6 14/7 10. Configure a Dynamic Bonding Group
This section is provides the commands to create the bonding groups. There are two ways to configure bonding groups: dynamic and static. This example uses only dynamic. (See chapter 24, Channel Bonding for more information.) Note that the RCC is configured here as well. Dynamically configure the downstream bonding group by entering:
configure interface cable-mac 1 cable downstream-bonding-group dynamic enable configure interface cable-mac 1 cable dynamic-rcc configure interface cable-mac 1 cable verbose-cm-rcp To dynamically configure the upstream bonding group, enter: configure interface cable-mac 1 cable upstream-bonding-group dynamic enable configure interface cable-mac 1 cable mult-tx-chl-mode 11. Configure RCC Management
In this Basic Bring-up, the RCC configuration is created while configuring bonding groups in the procedure above. DOCSIS 3.0 allows for two methods of configuring the CM Receive Channel Configuration (RCC). Like bonding group configurations, there can be static and dynamic RCC configurations in Release 7.x and later. The Static method consists of explicitly defining all the different combinations that could occur on any given node with specific downstream channels. For an example of static RCC configuration, see Configuration Examples for Static RCC on page 24-10.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
11-11
11 Basic Bring-up Procedure
12. Local Authentication
C4/C4c CMTS Rel. 8.0.7
To create a new user on the system, enter:
configure username tempuser password Use the default method list (local database) by entering: configure enable password configure authentication default local configure line vty 0 15 authentication default login-authentication configure line vty 0 15 authentication default enable-authentication
13. Managing the C4 CMTS
Managing consists of various system administration tasks, including those related to accounting, security, and configuration. This is accomplished through in-band or out-of-band management or both. Management functions can use telnet, SSH, SNMP, and other protocols. Among the other management protocols are TOD, IPDR, DNS, TACACS, RADIUS, Syslog, NTP, and Event Messaging and COPS for PacketCable. In-band Management — This means that the telnet/ssh/snmp sessions are carried through the Ethernet interfaces on the RCM line card. Pro: Access Control Lists (ACLs) can be applied to increase security Con: In-band management uses the same interfaces as all the modem traffic. To provision in-band management, permit and define a standard ACL by entering:
configure access-list 1 permit any configure interface gigabitEthernet 17/0 ip scm access-group 1 configure ip scm access
Out-of-band Management — This means that the telnet/snmp sessions are carried through the Ethernet interfaces on the SCM card, so that management traffic is not being carried on the same channels as data traffic. Pro: The IPs can be put on a private network and only management traffic is carried on these links Con: ACLs can not be applied to these interfaces. The interface is 10MBPS and half duplex. The C4 CMTS requires a reboot if these need to be changed. To provision out-of-band management, enter the following commands:
11-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
To configure SCM slot 19 IP address and subnet mask: configure interface ethernet 19/0 ip address 10.44.101.1 255.255.255.248 To configure the active SCM IP address and subnet mask for SCM 19: configure interface ethernet 19/0 active ip 10.44.101.3 255.255.255.248 To configure SCM slot 20 IP address and subnet mask: configure interface ethernet 20/0 ip address 10.44.101.2 255.255.255.248 To configure the active SCM IP address and subnet mask for SCM 20: configure interface ethernet 20/0 active ip 10.44.101.3 255.255.255.248 To configure the SCM default gateway: configure ip route vrf management 0.0.0.0 0.0.0.0 10.44.101.6 To save the configuration, enter the write memory command. NOTE The chassis reboot in the following step is only required only if you are using the Out-of-Band Management configuration and changing the IPs. Save the changes and reboot the system (if Out-of-Band management is configured) by entering: write memory configure reset system 14. Configure the SNMP
configure snmp-server configure snmp-server configure snmp-server configure snmp-server configure snmp-server configure snmp-server configure snmp-server configure snmp-server configure snmp-server docsisManagerView configure snmp-server docsisManagerView
Issue 2.0
The following command sequence enables the Simple Network Management Protocol (SNMP) to work. You should change community strings for security purposes. community public security rotesting community private security rwtesting user rotesting rotesting v1 user rwtesting rwtesting v1 user rotesting rotesting v2c user rwtesting rwtesting v2c context "" group rotesting v1 read docsisManagerView group rwtesting v1 read docsisManagerView write group rotesting v2c read docsisManagerView notify
ARRIS PROPRIETARY — All Rights Reserved
11-13
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
configure snmp-server group rwtesting v2c read docsisManagerView write docsisManagerView
configure snmp-server view docsisManagerView 1.3.6.1 included configure snmp-server group rotesting v2c notify docsisManagerView configure snmp-server group rotesting v1 notify docsisManagerView
15. Configure Clock
To set the network timing synchronization protocol, enter the following commands: configure ntp server 10.44.101.9 configure clock timezone America/Chicago configure clock network nt For more information on the purpose and syntax of these commands, please use the alphabetical List of CLI Commands to find links to the command reference page for each command.
16. Save the Configuration
Write the configuration to memory to save the configurations: write memory
Verification Steps This section provides the procedures to complete the bring-up of your system. 17. Cable CAMs and RCM
In this step, the Operator needs to connect the cables to the CAMs, RCM, and SCM if out of band management is configured. In this example, a single cable from the 16D PIC connected to connector 1 will be cabled to provide service to nodes 1-4. Another 4 cables will be connected to the first four connectors on the 12U PIC on the rear of the chassis. These individual upstreams will then be connected individually to the four nodes per the network diagram in Figure 11-2, Network Diagram Example, on page 11-4.
18. Configure/Verify Back Office Systems
The provisioning servers and other Back Office servers and data collectors should be configured to allow for the first modem to receive IP and CM configurations. Since different offices use various provisioning servers and environments, this procedure is customer-specific and site-dependent.
11-14
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
19. Verify the C4 CMTS Configuration
A number of commands can be used to verify the installation and configuration of the system at this point. Verify the slot provisioning by entering the following command to show the slot provisioning: show linecard status The following is an example of the output:
C4# show linecard status Chassis Type: C4 Slot Description
Admin Oper State State
Duplex State
Serial
HW Version
Prov/Det
Number
Type
0
CAM (0D, 24U)
Up
IS
Standby
11283CTU0029 CAM-01240W/C04
CAM/CAM
1
CAM (0D, 24U)
Up
IS
Simplex
11283CTU0034 CAM-01240W/C04
CAM/CAM
14
CAM (32D, 0U)
Up
IS
Simplex
08113CSD0005 CAM-20032W/E02
DMM/DMM
15
CAM (32D, 0U)
Up
IS
Standby
08113CSD0023 CAM-20032W/E02
DMM/DMM
17
RCM A
Up
IS
Standby
18
RCM B
Up
IS
Active
09433RCM0040 RCM-01000W/E02
RCM/RCM
19
SCM A
Up
IS
Standby
06483CBM0093 SCM-02440W/B06
SCM/SCM
20
SCM B
Up
IS
Active
06063CBM0071 SCM-02440W/B06
SCM/SCM
08133RCM0021 RCM-01000W/D02
RCM/RCM
Show the fiber node database and the topology information: show cable fiber-node The following is an example of the output: C4# show cable fiber-node Cable Fiber Node MAC mCMsg ---------------- ----- ----FN1 1 2 FN1 1 2
mDSsg/ mUSsg -----D1 U1
Ports -------------------14/0 14/1 14/2 14/3 1/0 1/1 1/2 1/3
14/4
14/5
14/6
14/7
* Indicates that downstream channel is not primary-capable.
Verify the MAC Domain configuration:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
11-15
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
show interface cable-mac What follows is an example of the show interface cable-mac 1 output: C4# show interface cable-mac 1 brief Cable-mac 1 ============= Cable DS Port
Mac
Oper
Mod
Conn State Annex Freq(Hz)
Power
Type (.1dBmV)
Spare
LBal
Group
Group
14/0
1
0
IS B(US) 321000000 q256
490
-
16781312
14/1
1
0
IS B(US) 327000000 q256
490
-
16781312
14/2
1
0
IS B(US) 333000000 q256
490
-
16781312
14/3
1
0
IS B(US) 339000000 q256
490
-
16781312
14/4
1
0
IS B(US) 345000000 q256
490
-
16781312
14/5
1
0
IS B(US) 351000000 q256
490
-
16781312
14/6
1
0
IS B(US) 357000000 q256
490
-
16781312
14/7
1
0
IS B(US) 363000000 q256
490
-
16781312
Cable US PORT
Mac
Oper
Chan
Conn State Type
Channel Mini Mod Freq(Hz) Width
Power Spare
LBal
Slot Prof (dBmV) Group
Group
1/0
1
0
IS
tdma
10000000 3200000 4
2
0
-
16781312
1/1
1
0
IS
tdma
20000000 3200000 4
2
0
-
16781312
1/2
1
0
IS
tdma
30000000 3200000 4
2
0
-
16781312
1/3
1
0
IS
tdma
40000000 3200000 4
2
0
-
16781312
If you desire more detailed information on the cable-mac, use show interface cable-mac instead. To display the supervisory downstream for the upstream, enter: show cable supervision
11-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
An example of the show interface cable supervision output: C4# show cable supervision MAC
US
-----
Issue 2.0
-------
DS
Method
-----
-----------
1 1
1/0 1/0
14/0 14/1
Provisioned Provisioned
1
1/0
14/2
Provisioned
1
1/0
14/3
Provisioned
1
1/0
14/4
Provisioned
1
1/0
14/5
Provisioned
1
1/0
14/6
Provisioned
1
1/0
14/7
Provisioned
1
1/1
14/0
Provisioned
1
1/1
14/1
Provisioned
1
1/1
14/2
Provisioned
1
1/1
14/3
Provisioned
1
1/1
14/4
Provisioned
1
1/1
14/5
Provisioned
1
1/1
14/6
Provisioned
1
1/1
14/7
Provisioned
1
1/2
14/0
Provisioned
1
1/2
14/1
Provisioned
1
1/2
14/2
Provisioned
1
1/2
14/3
Provisioned
1
1/2
14/4
Provisioned
1
1/2
14/5
Provisioned
1
1/2
14/6
Provisioned
1
1/2
14/7
Provisioned
1
1/3
14/0
Provisioned
1
1/3
14/1
Provisioned
1
1/3
14/2
Provisioned
1
1/3
14/3
Provisioned
1
1/3
14/4
Provisioned
1
1/3
14/5
Provisioned
1
1/3
14/6
Provisioned
1
1/3
14/7
Provisioned
ARRIS PROPRIETARY — All Rights Reserved
11-17
11 Basic Bring-up Procedure
20. Verify Modem Registration
C4/C4c CMTS Rel. 8.0.7
For status on a specific cable modem, enter: show cable modem detail An example of output for the show cable modem detail command:
C4# show cable modem detail 001d.cdf9.35f8 Feb 17 09:28:02 14/7-1/1 CM 001d.cdf9.35f8 (Arris) D3.0 State=Operational D1.1/tdma PrimSID=8192 Cable-Mac= 1, mCMsg = 2 mDSsg = 1 mUSsg = 1 RCP_ID= 0x0010000008 RCC_Stat= 1, RCS=0x01000001 TCS=0x01000001 Timing Offset=770 Rec Power= 0.00 dBmV Proto-Throttle=Normal dsPartialServMask=0x00000000 usPartialServMask=0x00000000 Uptime= 0 days 12:37:18 IPv4=192.168.180.9 cfg=basic.bin LB Policy=0 LB Group=16781312 Filter-Group CM-Down:0 CM-Up:0 Privacy=Ready Ver=BPI Plus Authorized DES56 Primary SAId=8192 Seq=2 MDF Capability= GMAC Promiscuous(2) MDF Mode= MDF Disabled(0) u/d SFID SID State Sched Tmin Tmax DFrms DBytes CRC HCS Slot/Ports uB 3 8192 Activ BE 0 2000000 2077 241735 0 0 1/0,1,2,3 dB 4 *2 Activ 0 2000000 1568 157631 14/0,1,2,3,4,5,6,7 L2VPN per CM: (Disabled) Current CPE=1, IPv4 Addr=1, IPv6 Addr=0 Max CPE=16, IPv4 Addr=32, IPv6 Addr=64 CPE 001d.cdf9.35fa Filter-Group:Up=0 Down=0 Proto-Throttle=Normal IPv4=192.168.180.10
To display the status of the bonding group for a given MAC address, enter: show cable bonding-group-status An example of the show cable bonding-group-status output: C4# show cable bonding-group-status Cable -mac
mDSsg/ chSetId
mUSsg
CfgId
AttrMask
-----
----------
-------
-------
----------
1
0x01000001
D1
dynamic
---
1
0x01000001
U1
dynamic
---
An example of the show cable rcc-status output: C4# show cable rcc-status verbose
11-18
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
Cable -mac 1
RCP-id 0010000008 Module: 1 CM-chan 1 2 3 4 5 6 7 8
Stat RCC ID ChanSetId dyn 1 0x1000001 MinCFreq:321000000 Downstream Frequency 14/7 363000000 14/0 321000000 14/1 327000000 14/2 333000000 14/3 339000000 14/4 345000000 14/5 351000000 14/6 357000000
RCC-Status Valid ModConnID:0 Primary Primary Capable Capable Capable Capable Capable Capable Capable
For a more detailed report, use the show cable rcc-status verbose command: C4# show cable rcc-status verbose Cable -mac 1
RCP-id 0010000004 Module: 1 CM-chan 1 2 3 4
Stat RCC ID ChanSetId RCC-Status dyn 36 0x1000002 Valid MinCFreq:621000000 ModConnID:0 Downstream Frequency Primary 14/2 633000000 Primary 14/0 621000000 Capable 14/1 627000000 Capable 14/3 639000000 Capable
For overall status of cable modems, enter: show cable modem summary Here is an example of the show cable modem summary output:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
11-19
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
C4# show cable modem summary S/P Mac Conn Total Oper Disable Init Offline %Oper Description ---------------------------------------------------------------- ----- --------1/U0 1 0 27 27 0 0 0 100% 1/U1 1 0 11 11 0 0 0 100% 1/U2 1 0 13 13 0 0 0 100% 1/U3 1 0 9 9 0 0 0 100% ---------------------------------------------------------------- ----- --------Mac 1 Total 48 48 0 0 0 100% BigMac Slot 1 Total 48 48 0 0 0 100% ---------------------------------------------------------------- ----- --------14/D0 1 0 14 14 0 0 0 100% 14/D1 1 0 15 15 0 0 0 100% 14/D2 1 0 6 6 0 0 0 100% 14/D3 1 0 5 5 0 0 0 100% 14/D4 1 0 4 4 0 0 0 100% 14/D5 1 0 4 4 0 0 0 100% 14/D6 1 0 4 4 0 0 0 100% 14/D7 1 0 8 8 0 0 0 100% ---------------------------------------------------------------- ----- --------Mac 1 Total 48 48 0 0 0 100% BigMac Slot 14 Total 48 48 0 0 0 100% ---------------------------------------------------------------- ----- ------------------------------------------------------------------------ ----- --------Total 48 48 0 0 0 100% For the status of the cable modems, enter: show cable modem
An example of the show cable modem output:
11-20
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
C4# show cable modem Sep 30 14:49:16 Interface (DS-US) ------------14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/0-1/0 14/1-1/0 14/1-1/0 14/1-1/0 14/1-1/0 14/1-1/1 14/1-1/1 14/1-1/1 14/1-1/1 14/1-1/1 14/1-1/2 14/1-1/2 14/1-1/2 14/1-1/2 14/1-1/3 14/1-1/3 14/2-1/0 14/2-1/0 14/2-1/0 14/2-1/2 14/2-1/3 14/3-1/0 14/3-1/0 14/3-1/0 14/3-1/1 14/3-1/2 14/6-1/0 14/7-1/0 14/7-1/0 14/7-1/1 14/7-1/2 14/7-1/2
Issue 2.0
DOC Mac Bonded State SIS Qos CPE ----- ------ ----------- --- ------------- --1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 4x4 Operational 3.0 2000/2000 0 1 4x4 Operational 3.0 2000/2000 0 1 4x4 Operational 3.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 4x4 Operational 3.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0 1 Operational 2.0 2000/2000 0
MAC address --------------0015.a463.15b3 0015.a463.20ab 0015.a463.2129 0015.a464.e69b 0015.a464.ec5c 0015.ce64.3a08 0015.ce64.3a74 0015.ce64.3cab 0015.ce64.3d1a 0015.ce64.3d2f 0015.ce64.3d35 0015.ce64.3e10 0015.ce64.3e61 0015.ce64.3e64 0015.ce64.39d2 0015.ce64.3bc7 0015.ce64.3ca2 0015.ce64.3e4c 0015.a463.15c8 0015.a464.e46a 0015.ce64.3c7b 0015.ce64.3cd8 0015.ce64.3df5 0015.a463.140c 0015.ce64.3cde 0015.ce64.3cf6 0015.ce64.417f 0015.ce64.3e46 0015.ce64.3e5e 0015.cfee.4c13 0015.cfee.4c2f 0015.cfee.4cbb 0015.ce64.3de9 0015.ce64.3fb1 0015.a463.2429 0015.a464.efe3 0015.ce64.3b55 0015.ce64.3c96 0015.ce64.39d5 0015.cfee.4ccb 0015.a464.eab8 0015.ce64.3fa8 0015.ce64.3f00 0015.ce64.3b13 0015.ce64.3dbc
ARRIS PROPRIETARY — All Rights Reserved
IP Address ----------------------192.168.180.177 192.168.180.158 192.168.180.175 192.168.180.37 192.168.180.35 192.168.180.38 192.168.180.163 192.168.180.168 192.168.180.187 192.168.180.167 192.168.180.162 192.168.180.189 192.168.180.165 192.168.180.176 192.168.180.23 192.168.180.171 192.168.180.192 192.168.180.172 192.168.180.173 192.168.180.36 192.168.180.190 192.168.180.22 192.168.180.179 192.168.180.159 192.168.180.170 192.168.180.169 192.168.180.40 192.168.180.97 192.168.180.191 192.168.180.11 192.168.180.43 192.168.180.6 192.168.180.166 192.168.180.7 192.168.180.157 192.168.180.34 192.168.180.164 192.168.180.41 192.168.180.186 192.168.180.12 192.168.180.39 192.168.180.199 192.168.180.194 192.168.180.198 192.168.180.195
11-21
11 Basic Bring-up Procedure
14/7-1/2 14/7-1/3 14/7-1/3
1 1 1
C4/C4c CMTS Rel. 8.0.7
Operational 2.0 Operational 2.0 Operational 2.0
2000/2000 2000/2000 2000/2000
0 0 0
0015.ce64.3f45 0015.ce64.3639 0015.ce64.3f30
192.168.180.197 192.168.180.200 192.168.180.196
Total Oper Disable Init Offline --------------------------------------------------------Total 48 48 0 0 0
To display the service groups, enter: show cable service-group An example of the show cable service-group output: show cable service-group Cable MAC --1
mCMsg ----2
mDSsg ----1
mUSsg ----1
IPv6 Configuration (Optional) This section assigns the IPv4 subnets and IPv6 prefixes that will be configured in the C4 CMTS. In Release 7.x, the setup of IP subnets and prefixes has been augmented with support for IPv6. This allows the operator to run either IPv4 or IPv6 or both protocols in a chassis. Release 7.x enhancements and changes to the configuration include: •
For installations with 16D CAMs and 12Us, the IPv4 and IPv6 addresses are assigned on a per-MAC domain basis or bundled across multiple MAC Domains.
•
IPv6 addresses cannot be assigned to the SCM ports in Release 8.x.
The C4 CMTS can be configured to prefer IPv6 addressing of DOCSIS 3.0 CMs and DOCSIS 2.0 CMs that have support for IPv6 and still provide IPv4 services to pre-DOCSIS 3.0 CMs. To complete this configuration:
11-22
•
The IPv4 and IPv6 addresses must be assigned to both the RCM interface ports as well as the RF/MAC Domains/CAMs as described above
•
The back office servers used to support the DOCSIS devices as well as CPE must be configured to support both IPv4 and IPv6 operation
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
Enter the following CLI commands to configure the RCM Ethernet ports: configure interface gigabitEthernet 17/0 no shutdown configure interface gigabitEthernet 17/0.0 ip address 10.58.0.2 255.255.255.0 configure interface gigabitEthernet 17/0.0 ipv6 enable configure interface gigabitEthernet 17/0.0 ipv6 address FE80::/10 EUI-64 link-local configure interface gigabitEthernet 17/0.0 ipv6 address FC00:CADA:C408:1700::2/64 configure interface gigabitEthernet 17/0.0 ip igmp configure interface gigabitEthernet 17/0.0 ipv6 no nd ra suppress
IP Address Prefixes and Subnets
When the C4 CMTS is configured for service, the back office systems that support the installation must also be configured and properly setup to support the DOCSIS and non-DOCSIS devices services by the C4 CMTS. This means that if the C4 CMTS is operating with both IPv4 and IPv6 devices, the time servers, provisioning servers (DHCP and tftp) and NMS devices are all capable of operating with either IPv4 or IPv6. Also, the DHCP servers need to be configured with the proper IPv4 and IPv6 address information and the correct DHCP options for both legacy DOCSIS, and DOCSIS 3.0 devices. NOTE In configuring the MAC domain in the procedure above, the IP Provisioning Mode was set to IPv6 only. To support legacy DOCSIS 2.0 CMs on the same channels in the MAC domain, IPv4 addresses must also be configured. Configure the IPv6 on the RF:
configure interface cable-mac 1.0 ip address 10.108.0.1 255.255.224.0 configure interface cable-mac 1.0 ipv6 enable configure interface cable-mac 1.0 ip address 10.108.32.1 255.255.224.0 secondary configure interface cable-mac 1.0 ipv6 address FC00:CADA:C408:C001::1/64 configure interface cable-mac 1.0 cable helper-address 10.50.8.3
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
11-23
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
configure interface cable-mac 1.0 ip igmp configure interface cable-mac 1.0 ipv6 dhcp relay destination FC00:CADA:C408:ED00::3
configure interface cable-mac 1.0 ipv6 nd managed-config-flag configure interface cable-mac 1.0 ipv6 nd other-config-flag configure interface cable-mac 1.0 ipv6 no nd ra suppress
To display a brief summary of the IPv6 status and configuration for each interface, enter command: show ipv6 interface brief An example of the output in brief format: C4# show ipv6 interface brief Interface
Admin State
Oper State
Primary IP
cable-mac 1.0 cable-mac 1.0 gigabitEthernet 17/0.0 gigabitEthernet 17/0.0
Up Up Up Up
IS IS IS IS
FE80::201:5CFF:FE23:5A81/10 FC00:CADA:C408:C001::1/64 FE80::201:5CFF:FE23:5A40/10 FC00:CADA:C408:1700::2/64
The following is an example of the output returned by the system when the ping command is used to test connectivity: C4# ping ipv6 FC00:CADA:C408:C001::1 Sending IP ping to: FC00:CADA:C408:C001::1 ping (FC00:CADA:C408:C001::1): 100 data bytes !!!!! 5 packets transmitted, 5 packets received To display the contents of the IPv6 route table entries for the IPv6 address, enter: show ipv6 route An example of the output:
11-24
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
11 Basic Bring-up Procedure
C4/C4c CMTS Rel. 8.0.7
C4# show ipv6 route Dist/ IPv6 Route Dest / mask ========================= ::/0 FC00:CADA:C408:1700::/64 FC00:CADA:C408:C001::/64
Act === Yes Yes Yes
PSt === IS IS IS
Next Hop ============================== FC00:CADA:C408:1700::1 FC00:CADA:C408:1700::2 FC00:CADA:C408:C001::1
Metric Protocol Interface ======= ========= ============= 1/0 netmgmt gigE 17/0.0 0/0 local gigE 17/0.0 0/0 local cMac 1.0
Blank Worksheets Use the blank worksheets on the following pages to help you plan and record your system configuration.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
11-25
11 Basic Bring-up Procedure
Cable-mac
Cable-mac
Cable-mac
Cable-mac
11-26
C4/C4c CMTS Rel. 8.0.7
Interface/Port ______________
Frequency ______________
Fiber-node _____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
______________
______________
_____________
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
11 Basic Bring-up Procedure
Upstream Parameters
Space
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
11-27
11 Basic Bring-up Procedure
11-28
ARRIS PROPRIETARY — All Rights Reserved
C4/C4c CMTS Rel. 8.0.7
October 9, 2012
12 Control Complex Redundancy
C4/C4c CMTS Rel. 8.0.7
12
Control Complex Redundancy
Topics
Overview
Page
Overview
1
Add a Control Complex (Change from Simplex to Duplex)
2
A control complex consists of one SCM and its associated RCM. The SCM in slot 19 and the RCM in slot 17 make up the control complex in a simplex system. In order to have control complex redundancy (CCR) the CMTS must be a duplex system. In a duplex CMTS both control complexes are equipped; one is active the other is standby. CCR ensures high reliability for system-wide Operations Administration Maintenance and Provisioning (OAM&P), switching, and routing. The control complex redundancy feature provides 1+1 active/standby redundancy between two pairs of SCM/RCM modules. The failure of an active SCM/RCM pair immediately causes a failover to the standby SCM/RCM pair. Key characteristics of control complex redundancy include:
Issue 2.0
•
Reduced customer impact on any SCM or RCM failure (hardware or software)
•
Hot standby SCM/RCM pair with complete replication of configuration and customer data
•
Fault correlation between active and standby SCM/RCM pairs
•
Software infrastructure support for replication of software components between active and standby SCM/RCM pairs
ARRIS PROPRIETARY — All Rights Reserved
12-1
12 Control Complex Redundancy
C4/C4c CMTS Rel. 8.0.7
NOTE Routing protocols restart after a control complex failover. Convergence time varies based upon the specific configuration. For a summary of the types of the SCM card, see Table 7-2, Types of System Control Modules (SCMs), on page 7-4.
Procedure 12-1
Add a Control Complex (Change from Simplex to Duplex) Use this procedure to add a redundant control complex. This procedure assumes that the original control complex (i.e. the SCM in slot 19 and the RCM in slot 17) are in service. NOTE Ensure that your system is committed before starting this procedure. Use the reload commit command if necessary.
CAUTION
Do not insert the SCM 20 or RCM 18 modules until instructed to do so later in this procedure. 1 Configure a second SCM slot: configure slot 20 type SCM 2 Configure a second RCM slot: configure slot 18 type RCM 3 Put slots 20 and 18 in the administrative up state: configure slot 20 no shutdown configure slot 18 no shutdown 4 (Optional) If using out-of-band management, configure the IP address of the second SCM in slot 20: configure interface ethernet 20/0 ip address In the next step you assign the out-of-band ethernet active IP address (19/0 and 20/0). It remains the active IP even after a failover.
12-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
12 Control Complex Redundancy
C4/C4c CMTS Rel. 8.0.7
NOTE If you are currently using telnet to access the SCM 19, you will be disconnected and have to log back in to the system. 5 (Optional) If SCM 19 does not have an active IP address, assign one using the following command: configure interface ethernet 19/0 active ip [] Where valid slot number = 19 or 20, either can be used to set the active IP. In this case use slot 19 because the SCM is not yet present in slot 20. If the IP mask is not provided, it defaults to the mask of the SCM interface ip address. 6 Save the duplex configuration to memory: write memory 7 Reset the chassis: configure reset system 8 Wait for slots 17 and 19 to go in-service. 9 Insert an SCM card in slot 20 and the associated Even SCM Physical Interface Card (PIC) at the rear of the chassis. (Optional) If applicable to your configuration, add the Ethernet cable to either the front of the SCM card or at the rear of the chassis. 10 Insert an RCM card in slot 18. The SCM and RCM cards in slots 20 and 18 respectively are initialized automatically and come into service when they are inserted. 11 Install the crossover connector between the RCMs. (See chapter 8, Router Control Module (RCM) for more details on the crossover connector installation.) NOTE It may take up to 20 minutes for the CMTS to synchronize the active and the standby SCM. 12 Verify that new SCM and RCM are standby: show linecard status
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
12-3
12 Control Complex Redundancy
C4/C4c CMTS Rel. 8.0.7
13 Save your configuration changes by entering: write memory 14 To establish the current image as the active image, enter: reload commit End of procedure
NOTE If you wish to revert to a simplex chassis from duplex, first contact ARRIS Technical Support.
12-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
13
CAM Sparing
Topics
Page
FlexCAM™ Hitless CAM Sparing
1
Guidelines for CAM Spare-groups
3
Configure 12U/24U CAM or 16D/XD CAM Sparing
4
NOTE The 2Dx12U CAM is not supported in Release 8.0.
FlexCAM™ Hitless CAM Sparing CAM sparing minimizes traffic loss and customer impact in case of a hardware or software failure. When an active CAM in a spare-group fails, the spare CAM takes over. The cable modems that were connected to the upstream and downstream channels on the failed CAM are immediately connected to the spare CAM. Cable modems do not have to re-register and they incur minimal data loss. Failback from the spare CAM to a recovered CAM can be set to take place automatically or manually. CAM sparing is an important element of system reliability. It greatly reduces customer impact and loss of traffic in the event of CAM failure. The spare CAM is used until the failed module is diagnosed, repaired, or replaced, or until there is a software recovery. The service outage is minimized because intervention by maintenance personnel is not required. When a failover occurs, the CMTS automatically reconfigures the spare CAM to take over the functions of the failed module. This includes configuration of downstream and upstream channels and port administrative
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
13-1
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
status. Depending on how you configure the CMTS, the spare CAM remains the active module or automatically switches back to the original active CAM once that CAM comes back online. CAM Sparing PIC LEDs
The rear slots of spare-group leader CAMs are equipped with sparing PICs. Other CAM slots are equipped with regular PICs. All types of CAM PICs have an LED at the bottom of their faceplates. These LEDs show which CAM in a spare-group has failed and which CAM is its group leader. Under normal conditions all sparing LEDs will be off. When a CAM in a sparegroup fails, traffic is transferred to its spare-group leader. In this case, the sparing LEDs of the failed CAM PIC and of the spare-group leader CAM PIC are on.
Definitions
Failover — Active CAM fails and the spare CAM takes over Failback— The recovered CAM becomes active, taking over for the spare. NOTE If a CAM has failed over to the sparing CAM, the CMTS does not accept the command to remove the failed CAM from the spare-group. You must first fail back to the original CAM, then you can remove it from the sparegroup.
Benefits of Hitless CAM Sparing
A great benefit of Hitless CAM Sparing is the minimal subscriber impact upon CAM failure. When an active CAM goes down, the CMs remain online. When a failover occurs, active CMs typically do not re-register, and they sustain minimal subscriber impact. Inactive CMs may flap after a failover, especially if their CPE IPs have timed out. Other benefits of hitless CAM sparing include: •
Uninterrupted service to the subscriber if a CAM goes down in the middle of a session where the end user is sending or receiving data
•
System administrators can take active CAMs out of service without serious impact
•
Reduces the amount of down time in the event of CAM failure.
The goal of CAM sparing is to preserve data flows such as voice calls, video, best effort, and other subscriber services. Size of Hitless CAM Sparegroups
13-2
The C4 CMTS supports CAM sparing within the following limits: •
XD CAM
Up to 8:1
•
16D CAM
Up to 8:1
•
12U CAM
Up to 11:1
•
24U CAM
Up to 9:1
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
For example, the CMTS supports 8:1 CAM sparing for the 16D CAM. In other words, the largest possible 16D CAM spare-group has eight active CAMs and one spare.
Guidelines for CAM Spare-groups A spare-group consists of one spare CAM (the spare-group leader) and one or more active CAMs protected by the spare-group leader.
Guidelines for Upstream Spare-groups
Issue 2.0
•
CAMs are not required to be part of a spare-group.
•
A chassis may have several spare-groups, depending on how many slots are used as spares and on the size of the spare-groups.
•
Any CAM can be used as spare-group leader, but it must be the first CAM added to the group.
•
The spare-group must be homogenous: the group leader and all of the members of the spare-group must be the same type of CAM.
•
CAMs from two different spare-groups cannot be interspersed. If slot 8 has been added to spare-group 0, then CAMs 1-7 cannot belong to any CAM spare-group except 0. In the same way, if slot 9 has been added to spare-group 15, then slots 10-14 can only be added to sparegroup 15.
•
There can be an unspared CAM or an unpopulated front slot within a spare-group, but the rear slot must have the correct PIC in it. For example, slot 0 can be the upstream spare-group leader for slots 1, 2, 3, 4, and 6, with slot 5 being either unpopulated or not added to any spare-group. In this case in which slot 5 is unpopulated, rear slot 5 must be equipped with an upstream non-spare PIC. If it is not, a failover from CAM 6 to the spare-group leader in slot 0 would not succeed because traffic on CAM 6 could not be re-routed through the backplane from slot 6 to slot 0.
•
The spare-group leader must have a special Physical Interface Card called a sparing PIC. The upstream Sparing PIC is a different card than the downstream Sparing PIC.
•
If you decide to turn a sparing leader slot into an active one, you may use the same CAM but you must replace the sparing PIC with a nonsparing PIC.
•
An upstream spare-group must be homogenous: a 12U CAM can spare only for other 12U CAMs; a 24U CAM can spare only for other 24U CAMs.
•
Upstream CAM spare-groups are designated by the lowest-numbered slot in the group. The spare-group leader of an upstream spare-group is always the lowest-numbered slot in that group.
ARRIS PROPRIETARY — All Rights Reserved
13-3
13 CAM Sparing
Guidelines for Downstream Spare-groups
Calculating Signal Loss during Failover
C4/C4c CMTS Rel. 8.0.7
•
An downstream spare-group must be homogenous: a 16D CAM can spare only for other 16D CAMs; an XD CAM can spare only for other XD CAMs. All the XD CAM slots in a spare-group must also be provisioned for the same annex.
•
Downstream CAM spare-groups are named for the highest-numbered slot. The group leader of a downstream spare-group is always the highest-numbered slot in that group.
When failover occurs the RF signal to the failed CAM is rerouted from the PIC of the failed CAM through the intervening PICs and backplane to the PIC of the now-active spare CAM. This longer path produces some signal loss. Although station maintenance begins immediately and compensates for the upstream loss, there is a period of at least a few seconds, depending on the number of modems supported, that the signal is weakened.
Configure 12U/24U CAM or 16D/XD CAM Sparing Figure 13-1 provides an example of a chassis equipped with 24U and XD CAMs arranged in spare-groups. Note that the 24U CAM spare-group builds from left to right: its spare is the lowest-numbered CAM in the group. The XD spare-group builds from right to left: its spare is the highest-numbered CAM in the group. For the CAM sparing shown in Figure 13-1 you would need seven nonspare upstream CAM PICs, six non-spare downstream CAM PICs, and two sparing PICs. The five different types of CAM PICs are listed below. TYPE OF PIC
FACEPLATE LABEL
Downstream sparing PIC:
PIC-CAM 16D (SPARE)
Downstream PIC:
PIC-CAM 16D
Upstream sparing PIC:
PIC-CAM (SPARE)
Upstream odd slot:
PIC-CAM (O)
Upstream even slot:
PIC-CAM (E)
The Odd and Even upstream CAM PICs are functionally identical but their connectors are offset to make cabling easier. The upstream and downstream sparing PICs are not interchangeable.
13-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
0
1
US Spare
2
3
4
5
6
24UCAMs
7
8
9
10
11
12
13 14
XD CAMs
15
16
DS Spare
17
18
19
20
RCMs SCMs Filler Panel (contains no module)
Figure 13-1: Example of 24U and XD Spare-groups (front view)
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
13-5
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
D0-3
D0-3
D0-3
D0-3
D0-3
D0-3
D0
D0
D0
D0
D0
D0
D0
D0
D4-7
D4-7
D4-7
D4-7
D4-7
D4-7
D1
D1
D1
D1
D1
D1
D1
D1
D8-11
D8-11
D8-11
D8-11
D8-11
D8-11
U0
U0
D12-15
D12-15
D12-15
D12-15
D12-15
D12-15
U1
U0 U0
U0 U1
U2 U3
U1
U1
U1
U3
U3
U4 U5
U5
U6
U5 U6
U6 U7
U7
U4 U5
U6
U7 U7
U4
U5
U6
U3 U4
U5
U6
U7
U3
U4
U5 U6
U2 U3
U4
U5
U1
U2 U3
U4
U0 U1
U1
U2 U3
U4
U0 U0
U6 U7
U7
U7
0
SCM PICs Filler Panel (Slot 19 contains (contains PIC with MAC no module) Address) Filler Panels (RCM has no PIC)
Downstream PICs DS Sparing PIC
Upstream PICs
US Sparing PIC
Figure 13-2: Example of CAM Sparing PICs (chassis rear view) To configure the spare-groups shown in the example in Figure 13-1, you would use the commands shown in the procedure below. If using the following procedure for 12U CAMs, enter the CAM slot type 12UCAM instead of 24UCAM. If using 16D CAMs for the downstream, the CAM slot should be 16DCAM instead of 32DCAM-B (Annex B) or 24DCAMA (Annex A).
Procedure 13-1
Use this procedure to create 12U and 16D CAM spare-groups shown in the example shown in Figure 13-1. Automatic failback can reduce exposure to traffic loss because the spare CAM is restored to the standby state as soon as the faulty CAM comes back up. Manual allows you to defer the failback to a more convenient time, such as a maintenance window.
13-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
1 Provision the 24U CAM slots: configure slot 0 type 24UCAM configure slot 1 type 24UCAM configure slot 2 type 24UCAM configure slot 3 type 24UCAM configure slot 4 type 24UCAM configure slot 5 type 24UCAM configure slot 6 type 24UCAM configure slot 7 type 24UCAM configure slot 8 type 24UCAM 2 Configure spare-group 0 for the 24U CAMs: configure slot 0 spare-group 0 manual configure slot 1 spare-group 0 configure slot 2 spare-group 0 configure slot 3 spare-group 0 configure slot 4 spare-group 0 configure slot 5 spare-group 0 configure slot 6 spare-group 0 configure slot 7 spare-group 0 configure slot 8 spare-group 0
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
13-7
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
3 Provision the XD slots. In this example we are provisioning the slots for 32D CAMs and for Annex B: configure slot 9 type 32DCAM-B configure slot 10 type 32DCAM-B configure slot 11 type 32DCAM-B configure slot 12 type 32DCAM-B configure slot 13 type 32DCAM-B configure slot 14 type 32DCAM-B configure slot 15 type 32DCAM-B 4 Configure spare-group 15 for the XD CAMs. The spare-group leader is found in the highest-numbered slot of the 32D spare-group: configure slot 15 spare-group 15 manual configure slot 9 spare-group 15 configure slot 10 spare-group 15 configure slot 11 spare-group 15 configure slot 12 spare-group 15 configure slot 13 spare-group 15 configure slot 14 spare-group 15 5 Confirm that the spare-groups have been created: show spare-group Slot 0 1 2 3 4 5 6 7 8 9 10
13-8
Leader Slot 0 0 0 0 0 0 0 0 0 15 15
Mode manual
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
11 12 13 14 15
15 15 15 15 15
manual
End of procedure
Procedure 13-2
How to Fail Back Manually If you have configured a CAM spare-group for manual failback, user traffic is handled by the spare CAM until it is manually forced back to the original CAM by doing a shutdown / no shutdown on the spare-group leader. 1 (If necessary) Display the CAM spare-groups: show spare-group Example output: Slot 0 1
Leader Slot 0 0
Mode manual
2 Verify the status of the spare-group leader and original CAM: show linecard status The original CAM must be IS (in-service) and Protected. The spare-group leader after a failover is IS and Active. Sample output: 0
CAM (24U)
Up
IS
Active
11073CTU0009 CAM-01240W/B06
CAM/CAM
1
CAM (24U)
Up
IS
Protected
11153CTU0012 CAM-01240W/B06
CAM/CAM
3 Force user traffic back to the original CAM by shutting down the sparegroup leader: configure slot shutdown Where:
slot = the slot number of the spare-group leader
4 Restore the CAM sparing leader to service: configure slot no shutdown Where:
Issue 2.0
slot = the slot number of the spare-group leader
ARRIS PROPRIETARY — All Rights Reserved
13-9
13 CAM Sparing
C4/C4c CMTS Rel. 8.0.7
5 Verify the status of the spare-group leader and original CAM: show linecard status The status of the spare-group leader should again be IS and Standby. NOTE It may take a certain period of time before the cards are back to the normal state. Look for sync message similar to the following: 03:46:22 01 notc: DAppl- Sync completed with spare CAM 0 End of procedure
Procedure 13-3
How to Delete a CAM Spare-group The CAM spare-group cannot be deleted if one of its CAMs has failed over to the sparing leader. 1 Delete a member of the spare-group: configure slot spare-group no Repeat this command for each of the remaining CAMs in the spare-group. 2 Take the spare-group leader out of service: configure slot shutdown 3 Delete the spare-group leader: configure slot spare-group no 4 Display the spare-groups to confirm the deletion of the desired group: show spare-group End of procedure
13-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
14
Cable and Network IP Configuration
Topics
Page
Subinterfaces (Multiple VRIs per VRF)
2
Interface Configuration
4
802.1Q VLAN Tagging (Q-tags)
8
Loopback Interfaces for Routing Protocols
12
Dynamic Route Redundancy
16
Configuring IP Static Routes
17
Route Redistribution and Administrative Costing
17
Policy-Based Routing (PBR)
30
Multiple VRFs
42
Overview This section outlines the basic configuration tasks required to implement routing (layer 3) functionality in the CMTS. The CMTS supports 1024 IP address interfaces. RCM Card and Port Configuration
The SCM and RCM cards are configured automatically when they come into service. The procedure to configure the RCM ports is found in step 5. Configure RCM Ethernet Connections of the Basic Bring-up Procedure.
Network ACLs
For information on configuring network ACLs, see Data Plane Filter IP ACLs on page 36-6.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-1
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Subinterfaces (Multiple VRIs per VRF) A subinterface is a Virtual Router Interface (VRI), a logical layer 3 interface. Multiple subinterfaces may be defined on a single interface and associated with the same VRF. Multiple subinterfaces may be defined per physical port and associated with the same VRF, such that there is a many-to-one relationship between subinterfaces and VRFs, per cable-side physical interface. The CMTS system administrator must also be allowed to change the association between a subinterface and a VRF. The default VRF is the global VRF that is always present in the CMTS. It can neither be created nor destroyed. Note that upon creation of a subinterface, it is implicitly associated with the default VRF. The relationship of a subinterface to a VRF is many-to-one when viewed from the perspective of a single CAM physical interface or cable bundle. Each ingress cable-side IP packet must classify to one and only one subinterface. This classification to a subinterface will be based solely on the source IP address and source physical port of the packet. For broadcast DHCP packets that have a source IP address of 0.0.0.0, the following rules apply:
14-2
•
If the DHCP packet is sourced from a CM, then the packet will classify to the lowest numbered subinterface that has a DHCP-Server defined.
•
If the DHCP packet is sourced from a CPE, then the packet must be classified to the subinterface of the CPE’s associated CM.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Rules of Operation and Guidelines for Subinterfaces
•
The CMTS supports up to 150 interfaces (both interfaces and subinterfaces count towards the total of 150).
•
A subinterface is associated with the default VRF upon creation.
•
The sum of all subinterface IP addresses may not exceed the total CMTS system limitation of 998 IP addresses. The 998 limit represents all primary and secondary IP addresses associated with each subinterface.
•
The following items may be provisioned per subinterface:
-
•
IP addresses, both primary and secondary DHCP Relay Agent including: primary/policy mode selection, secondary dhcp-giaddr identification, DHCP Lease Query (cable source verify) functionality and DHCP Server IP address definitions - IP filter groups - Directed broadcast support - RIP and OSPF - IGMP - IRDP - SCM access. The DHCP Relay Agent supports the definition of 10 DHCP Server IP addresses per subinterface.
•
The DHCP Relay Agent classifies ingress CM DHCP packets to the lowest numbered subinterface associated for each unique DHCP Server IP address.
•
When the DHCP Relay agent is forwarding a packet originating from a CPE, it will forward the packet using as its giaddr the primary or a secondary address, depending on the dhcp-giaddr mode of the subinterface, that is, of the subinterface associated with the CM that the CPE is behind. The packet will be forwarded to each unique DHCP server IP address for CPEs provisioned on that subinterface.
•
If there are no DHCP servers for CPEs defined for the subinterface associated with the CM that a CPE is behind, then the DHCP Relay agent will forward a packet originating from a CPE to each unique DHCP server IP address for CPEs using as its giaddr the primary address or a secondary address, depending on the dhcp-giaddr mode of the subinterface, in other words, the lowest numbered subinterface provisioned with that server address. This allows MSOs to provide a service where different CPEs behind a single cable modem could be serviced by different ISPs on different subinterfaces. It would require the CMTS to be provisioned such that the CMs and CPE would be on different subinterfaces. In addition, it provides a mechanism where different giaddrs could be sent to different DHCP servers by defining those DHCP servers on different subinterfaces.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-3
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
The subinterfaces for CMs would be provisioned with DHCP servers marked for use with CMs only, and the subinterfaces for CPEs would be provisioned with DHCP servers marked for use with CPEs only (although DHCP server addresses could be the same values). Example: If the command config router rip network 10.0.0.0 has been executed, then all net10 interfaces are running RIP and will automatically advertise interface (10.x.x.x) IP addresses associated with any subinterface that is defined on the default VRF. •
Subinterfaces cannot be defined for SCM ports.
Interface Configuration Common Interface Configuring Commands This section describes common interface commands which support IP address and helper syntaxes for the 2Dx12U Cable Access Module in the CMTS. How to Configure CAM Interface for DHCP Policy
The following command is accepted only for provisioned CAM slot/port combinations in the system. This command assigns an IP address to the CAM interface and determines its DHCP policy. configure interface cable-mac ip address [secondary] [dhcp-giaddr] Secondary IP addresses become candidates for the dhcp-giaddr field if and only if the keywords secondary and dhcp-giaddr are both used. The command in the example below assigns an IP address of 10.10.1.1 to the specified CAM interface. It enables DHCP policy for this interface — secondary IP addresses are candidates for the dhcp-giaddr field. configure interface cable-mac 5 ip address 10.10.1.1 255.255.255.0 secondary dhcp-giaddr
Configure the Helper (DHCP) Addresses
The following command defines the cable-helper information for a CAM slot/port. This command assumes the default route table. configure interface cable-mac cable helperaddress [cable-modem|host|any]
14-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
If no host type is specified, this command defaults to a value of any. This interface is by definition associated with the default router. Configure DHCP Relay Agent Mode for CAM Port
The DHCP Relay Agent needs to be enabled for each CAM port as follows: config interface cable-mac cable dhcp-giaddr {primary | policy} Primary Operation — When the DHCP Relay Agent is defined for Primary operation on a specific CAM physical interface, the Primary IP address of the interface is used to populate the gi_addr field of all DHCP messages originating from either CMs or Hosts (CPEs). Policy Operation — When the DHCP Relay Agent is defined for Policy operation on a specific CAM physical interface, the Primary IP address of the interface is used to populate the gi_addr field with all DHCP messages originating from CMs. For Hosts (CPEs), a designated secondary IP address of the interface is used. If multiple secondary IP addresses are defined for dhcp-giaddr support, then the DHCP Relay Agent uses roundrobin selection, choosing the next entry in the list with each new DHCP transaction.
Monitoring Interfaces After configuring the CMTS interfaces, the system is ready to route traffic. Once traffic is generated, you may view the counters for these interfaces by using the procedures in this section.
Procedure 14-1
How to Monitor Interfaces Execute the following steps from the SCM prompt to verify traffic is being routed through the CMTS. 1 Display information about the virtual interfaces in the system, including data counts: show ip interface The output will look similar to the following (only a portion of output is shown): cable-mac 1.0, VRF: default, IP Address: 10.129.0.1/19 Secondary IP Address(es): No Secondary Addresses
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-5
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Physical Address: 0001.5c22.f001 MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): 10.50.29.3 for Traffic Type "any" Directed Broadcast is disabled ICMP unreachables are always sent Multicast reserved groups joined: None Source-verify is disabled Policy routing is disabled InOctets
=
0
OutOctets
=
0
InUcastPkts=
0
OutUcastPkts=
0
InDiscards =
0
OutDiscards =
0
InErrors
=
0
OutErrors
=
0
InMcastPkts=
0
OutMcastPkts=
0
2 Display all interface information about the physical ports in the system, including byte and packet counts: show interface The counts displayed will be the same as those described below except that each count represents the data for one physical interface (only a portion of output is shown): cable-mac 1 AdminState:Up Description: md1 Physical Address: 0001.5c22.f001 MTU is 1500 Inbound access list is not set Outbound access list is not set InOctets = 0 OutOctets = InUcastPkts= 0 OutUcastPkts= InDiscards = 0 OutDiscards = InErrors = 0 OutErrors = InFiltered = 0 InMcastPkts= 0 OutMcastPkts=
OperState:OOS-AUTO
Type:
0 0 0 0 0
3 Display information about active and inactive routes: show ip route detail
14-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Sample output: Codes:
(L1) internal level-1, (S) summary, (I) internal,
(L2) internal level-2, (IA) internal area, (E) external
(eL1) external level-1, (E1) external type-1,
VRF Name IP Route Dest. Act PSt Next Hop Metric Protocol =============== ================== === === =============== ====== ======== default 0.0.0.0/0 Yes IS 10.79.0.1 0 netmgmt default 10.44.29.200/32 Yes IS 10.44.29.200 0 local default 10.79.0.0/24 Yes IS 10.79.0.2 0 local default 10.79.1.0/24 Yes IS 10.79.1.2 0 local default 10.79.4.0/24 Yes IS 10.79.4.2 0 local default 10.79.5.0/24 Yes IS 10.79.5.2 0 local default 10.79.6.0/24 Yes IS 10.79.6.2 0 local default 10.79.7.0/24 Yes IS 10.79.7.2 0 local default 10.79.9.0/24 Yes IS 10.79.9.2 0 local default 10.79.11.0/24 Yes IS 10.79.11.2 0 local default 10.129.0.0/19 Yes IS 10.129.0.1 0 local default 10.129.32.0/19 Yes IS 10.129.32.1 0 local vrf_a 10.44.29.200/32 Yes IS 10.44.29.200 0 local vrf_a 10.79.0.0/24 Yes IS 10.79.0.2 0 local vrf_a 10.79.1.0/24 Yes IS 10.79.1.2 0 local vrf_a 10.79.4.0/24 Yes IS 10.79.4.2 0 local vrf_a 10.79.5.0/24 Yes IS 10.79.5.2 0 local vrf_a 10.79.6.0/24 Yes IS 10.79.6.2 0 local vrf_a 10.79.7.0/24 Yes IS 10.79.7.2 0 local vrf_a 10.79.9.0/24 Yes IS 10.79.9.2 0 local vrf_a 10.79.11.0/24 Yes IS 10.79.11.2 0 local vrf_a 10.129.0.0/19 Yes IS 10.129.0.1 0 local vrf_a 10.129.32.0/19 Yes IS 10.129.32.1 0 local
(eL2) external level-2 (E2) external type-2
Dist Route Age Interface ==== ============ ========= 1 0 04:40:31 gigE 17/0.0 0 0 04:40:37 loop 0 0 0 04:40:31 gigE 17/0.0 0 0 00:20:43 gigE 17/1.0 0 0 00:54:06 gigE 17/4.0 0 0 04:40:30 gigE 17/5.0 0 0 00:02:05 gigE 17/6.0 0 0 00:06:50 gigE 17/7.0 0 0 00:12:17 gigE 17/9.0 0 0 00:20:43 gigE 17/1.1 0 0 04:39:11 cMac 1.0 0 0 04:39:11 cMac 1.1 0 0 04:40:37 loop 0 0 0 04:40:31 gigE 17/0.0 0 0 00:20:43 gigE 17/1.0 0 0 00:54:06 gigE 17/4.0 0 0 04:40:30 gigE 17/5.0 0 0 00:02:05 gigE 17/6.0 0 0 00:06:51 gigE 17/7.0 0 0 00:12:17 gigE 17/9.0 0 0 00:20:43 gigE 17/1.1 0 0 04:39:11 cMac 1.0 0 0 04:39:11 cMac 1.1
End of procedure Reserved Subnets
NOTE The following subnets are reserved for CMTS Internal Processor Communications (IPC) and will be rejected as invalid destination IPs if you attempt to configure a route with them: 100.0.0.x 1.1.0.x
100.0.1.x 1.1.1.x
100.0.2.x
NOTE For more detailed information on the output for these and other monitoring commands, See chapter 44, Logging and the CMTS.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-7
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
802.1Q VLAN Tagging (Q-tags) MSOs often deploy Layer 3 Virtual Private Networks (VPNs) for commercial customers or other Internet Service Providers (ISPs). They also use VPNs to segregate their VoIP traffic from their data traffic for traffic engineering purposes. The CMTS serves as the Provider Edge (PE) access router. It is required to segregate VPN traffic within the CMTS domain using subinterfaces and Virtual Route Forwarders (VRFs). It must signal the VPN association to the adjacent northbound Provider (P) router. The CMTS does this using a layer 2 virtual circuit (VC) mechanism with 802.1Q Virtual LAN (VLAN) tags embedded in the traffic. This allows a single physical network interface, such as a gigabit ethernet, to host multiple logical subinterfaces identified by Q-tags, thereby multiplexing traffic from multiple VPNs over a single physical link. Normally subinterfaces in the CMTS segregate packets by source IP address (SIP) prefix only. This works well on the cable side, but not on the network side. Network subinterfaces typically have incoming SIPs that belong to remote subnets not hosted by the CMTS. The Q-tag feature extends the existing network subinterface function to include layer 2 VCs based on the presence of a Q-tag containing a VLANid in the ethernet header, as in Figure 14-1. Standard IP
802.1Q
CAM
NAM
DMAC
DMAC’
SMAC
SMAC’
Etype 0800 Payload IP hdr
Etype 8100 Etype 0800
IMPOSE / DISPOSE
VLAN
Payload IP hdr
SIP DIP
SIP DIP
Figure 14-1: Difference between Standard IP and Q-tag Encapsulation
14-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
In this case subinterface traffic that arrives or leaves the RCM port is encapsulated in an ethernet frame that has a Q-tag ethertype (0x8100, as in Figure 14-2) positioned in front of a native ARP or IP ethertype (0x0806 or 0x0800 respectively). Each physical network interface may have from 0 to 255 subinterfaces defined. Each encapsulated subinterface then behaves like a separate physical interface with the Q-tag as the VC identifier.
Tag Protocol ID (TPID)
Bits
Tag Control Information (TCI)
0x8100
Pri
0
VLANid
16
3
1
12
Bits
Figure 14-2: IEEE 802.1Q/p Tag Format
NOTE This feature does not provide true VLAN support as defined by IEEE 802.1Q for switching tagged ethernet frames between ports. It merely uses the Q-tag as a means to multiplex multiple ethernet VCs onto a single physical ethernet link. Q-tags also carry the IEEE 802.1p priority (p-bits). The network subinterface can assign either a fixed priority value to the p-bits for all egress Qtags or a dynamic bi-directional mapping between the IP TOS precedence bits and the Q-tag p-bits for ingress and egress IP frames. Otherwise, the egress p-bits are set to zero by default and ingress p-bits are ignored. IP TOS precedence bits, IP Differentiated Services Code Point (DSCP) bits, Class Selector (CS) bits, and 802.1p priority bits are all defined identically and therefore may be interchanged without any conversion. This capability makes it possible for intervening layer 2 switches to give the appropriate Quality of Service (QoS) treatment to ethernet frames being switched between adjacent routers. Also, the DOCSIS 2.0 service flow TOS overwrite capability may be used to impose a TOS byte on IP frames forwarded by cable modems to the CMTS based on flow classification rules. Thus, dynamic IP TOS precedence bit mapping to Q-tag p-bits at the network subinterfaces allows DOCSIS priorities to be propagated through the adjacent network side layer 2 switches. For more information, see IEEE standard 802.1Q, Virtual Bridged Local Area Networks, at http://standards.ieee.org/getieee802/802.1.html. One Q-tag per Network Interface
Issue 2.0
This feature supports only the static configuration of one Q-tag per network subinterface. To avoid fragmentation, only one Q-tag (adding
ARRIS PROPRIETARY — All Rights Reserved
14-9
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
only 32 bits) will be imposed on the egress frame by the RCM port creating a maximum ether frame size of 1522 octets when a Q-tag is present. NOTE The ARRIS Q-tag feature provides Virtual Circuit (VC) identity to the RCM ports. It does not support VLAN switching between RCM ports or CAM ports.
CLI Commands Use the following command to show ARP configuration on an RCM interface: show arp (Partial output) ARP cache aging has been disabled Row IP Address MAC Address 1 10.59.0.1 0017.0fac.0000 2 10.59.1.1 0017.0fac.0000 3 10.59.2.1 0017.0fac.0000 4 10.59.3.1 0017.0fac.0000 5 10.59.4.1 0017.0fac.0000 6 10.59.128.1 0017.0fac.0000 7 10.109.0.0 ffff.ffff.ffff 8 10.109.0.1 0001.5c22.0f41 9 10.109.3.240 0000.0000.0000
Type Dynamic Dynamic Dynamic Dynamic Dynamic Dynamic Static Static Dynamic
State Active Active Active Active Active Active Not Present Active Searching
Interface gigabitEthernet gigabitEthernet gigabitEthernet gigabitEthernet gigabitEthernet gigabitEthernet cable-mac 1.0 cable-mac 1.0 cable-mac 1.0
Static Static Static Static Static Static Static Static Static Static
Not Present Not Present Active Not Present Not Present Active Not Present Not Present Active Not Present
cable-mac cable-mac cable-mac cable-mac cable-mac cable-mac cable-mac cable-mac cable-mac cable-mac
17/0 17/1 17/2 17/3 17/4 18/0
• • • 41 42 43 44 45 46 47 48 49 50
14-10
10.109.191.255 10.159.160.0 10.159.160.1 10.159.191.255 10.109.192.0 10.109.192.1 10.109.223.255 10.159.192.0 10.159.192.1 10.159.223.255
ffff.ffff.ffff ffff.ffff.ffff 0001.5c22.0f4b ffff.ffff.ffff ffff.ffff.ffff 0001.5c22.0f4d ffff.ffff.ffff ffff.ffff.ffff 0001.5c22.0f4d ffff.ffff.ffff
ARRIS PROPRIETARY — All Rights Reserved
11.0 11.0 11.0 11.0 13.0 13.0 13.0 13.0 13.0 13.0
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Use the following command to show interface configuration on a GigE RCM interface: show ip interface (Partial output) cable-mac 1.0, VRF: default, IP Address: 10.109.0.1/19 Secondary IP Address(es): 10.159.0.1/19 Physical Address: 0001.5c22.0f41 MTU is 1500 DHCP Policy mode is enabled DHCP Server Helper Address(es): 10.50.9.3 for Traffic Type "any" Directed Broadcast is disabled ICMP unreachables are always sent Multicast reserved groups joined: None Source-verify is disabled InOctets = 693824 OutOctets = 3208492 InUcastPkts= 1174 OutUcastPkts= 18935 InDiscards = 0 OutDiscards = 0 InErrors = 0 OutErrors = 0 InMulticastPkts= 0 OutMulticastPkts= 0
Example of Configuration
Below is a sample command sequence to implement Q-tagging on the CMTS. Packets originating from this VRF will have this tag and any packet arriving with that tag will get directed to this subinterface. 1 Create a new VRF: configure ip vrf tag70 2 Assign an IP to a new subinterface: configure interface gigabitethernet 17/1.1 10.41.1.130 255.255.255.128
ip address
3 Assign a description to the new subinterface: configure interface gigabitethernet 17/1.1 description “tag 70”. Assign a tag to the new subinterface: configure interface gigabitethernet 17/1.1 encapsulation dot1q 70
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-11
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
4 Move the new subinterface into the VRFs: configure interface gigabitethernet 17/1.1 ip vrf forwarding tag70 5 Create a cable subinterface: configure interface cable-mac 1.1 ip address 10.108.64.1 255.255.254.0 6 Move the cable subinterface into the new VRFs: configure interface cable-mac 1.1 ip vrf forwarding tag70
Loopback Interfaces for Routing Protocols This section deals with the RCM-based loopback interface that may be used by OSPF. This interface has all the characteristics of a physical interface IP address, including packet counts, admin provisioning, socket-layer accessibility, and so on. This new interface type has a presence on the SCM when in-band management is enabled. Automatic import of the loopback interface into the SCM protocol stack is consistent with existing in-band management functionality. Currently, all RCM-based interface IP addresses are imported into the SCM to allow SCM-based applications to process traffic destined for one of the CMTS interface IP addresses. Packet redirection from the RCM to the SCM is a hardware decision based on the IP packet type. Definitions
Loopback interface — A logical IP interface that is not associated with any one physical interface. It must be reachable via any active physical interface. Active IP address — The IP address that is associated with the FEP of the active SCM, formerly called the floater IP. The active IP address is the one given to the FEP of the active SCM. It must be used for out-of-band SCM management only. When in-band management is enabled, the RCM will not route IP datagrams destined for the active IP address to the SCM. Abbreviations: FEP Front Ethernet Port
14-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
RCM SCM ECMP AS LSA Characteristics of the Loopback Interface
Router Control Module System Control Module Equal Cost Multi-Path Autonomous System Link State Advertisement
Observe the following guidelines when configuring and administering loopback interfaces: •
The CMTS supports 16 unique loopback interfaces, ranging from 0-15.
•
The subnet mask may be /32; this implies a host address.
•
Upon creation of a loopback interface, it will be associated with the default VRF.
•
If the loopback is taken down, no physical interface is taken OOS.
•
If OSPF is enabled on the loopback interface, the network associated with the loopback address must be advertised in a router LSA. The existing ospf command must be used: network area .
•
Like physical interfaces, a loopback may reside in only one area.
•
Routing protocols (RIPv2 or OSPFv2) will not advertise the active IP address.
•
The active IP address will not have a presence on the RCM.
•
When in-band management is enabled, loopback interfaces associated with the default VRF are imported into the SCM’s protocol stack.
•
If multiple loopback interfaces exist, the lowest value loopback interface is used as the source IP address for SCM-originated IP datagrams.
Figure 14-3, Example of Packet Flow Using Loopback Interface, on page 14-14, depicts a network configuration where a loopback interface is defined for in-band management. In this figure the active IP address is used for out-of-band management. This network topology shows the loopback interface used as the “forwarding address” of OSPF Type-7 LSAs that advertise CAM-side prefixes. Since the loopback interface IP address was previously announced in a Router LSA and is part of the OSPF AS, ECMP is available, from the 6509 to the CMTS, for packets destined for RIP advertised networks.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-13
14 Cable and Network IP Configuration
LS Age
C4/C4c CMTS Rel. 8.0.7
0
Options | LS Type
Switch
N/P (Type-7-LSA)
List State ID
192.9.1.0
Advertising Router
OSPF-NSSA ECMP available
C4s Router ID
LS Sequence Number
Bridge
0x80000001
LS CheckSum Length
RCM
36
Network Mask
GigEthernet 10.80.0.2/19
GigEthernet 10.80.32.2/19
255.255.255.0
Forwarding Address
10.100.10.1
External Route tAG
0
Loopback 10.100.10.1
OSPF
SCM
Client/Server SCM Apps
RIPV2
Loopback 10.100.10.1
RIP Route Redistribution into OSPF
CAM 3/0
SCM 1 10.80.64.2/19
2
1
E=0 (Type 1 metric), TOS 0, cost 1
Metric
SCM 1 10.80.64.1/19
RIPv2 CM Packets
CM RIPv2 Packets
CAM 5/0
Cable Bundle Master: 3/0 1
In-band Management RCM Interface / loopback IP Addresses
2
Out-of-band Management SCM Interface or floater IP Address
10.130.0.1/19 192.9.1.1/24 CM+Router 10.130.0.20
CM+Router 10.130.0.10
CPE 192.9.1.20
CPE 192.9.1.10
Figure 14-3: Example of Packet Flow Using Loopback Interface
14-14
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Table 14-1: CLI Commands for Active and Loopback Interface Command
Purpose
configure interface ethernet /0 active ip [] Defines the active IP address on the SCM. Valid slot numbers are 19 and 20: either one may be used to define the active IP address. If the IP mask is not provided, then it defaults to the mask of the SCM interface ip address. configure interface ethernet /0 no active ip [ []] Removes the active IP address associated with the SCM FEP. The IP address and mask are not required configure interface loopback [ ip address ] [shutdown] [no] Defines the syntax to assign an IP address to a loopback interface and admin state (shutdown or restored to service). configure interface loopback ip vrf forwarding Moves a loopback interface to the VRF specified. configure interface loopback ip ospf cost Defines the OSPF cost to reach the loopback interface. No other OSPF parameters are configurable. show ip ospf interface [brief] Shows all interfaces that have OSPF enabled. See show ip ospf interface [brief] on page 14-15. show ip interface Shows all interfaces with byte and packet counts in and out. show ip route [detail] Shows all interfaces as local routes with no physical interface defined.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-15
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Dynamic Route Redundancy The Dynamic Route Redundancy (DRR) feature allows the CMTS to dynamically update a specific route in hardware based on a change in the network topology. The update only occurs if a redundant route for a specific IP prefix exists in software. The following events cause the CMTS to recalculate the least cost route and potentially update the hardware forwarding engine: •
The cost of an active route is updated and as a consequence it is no longer the least cost route. The CMTS installs the least cost route from a pool of redundant routes to the specific IP prefix.
•
The physical interface associated with a route is taken out of service. All routes over the physical interface are marked as inactive and are replaced by a redundant route for each IP prefix assuming one exists.
•
RIP or OSPF network topology changes may cause the CMTS to pick an alternative route if the protocol running determines that a route it advertised is no longer reachable.
•
Equal Cost Multi-Path (ECMP) Load Balancing, as it is implemented in the CMTS, is a natural extension to Dynamic Route Redundancy. This feature allows the CMTS to load balance traffic on an IP prefix basis across four unique routes. Load balancing is achieved by examining the source IP address of the IP datagram when determining which of several routes to use. Note that the unique routes must be of the same cost. The cost of a route is determined by the protocol type and metric. If multiple routes to a specific prefix exist with different metrics or protocol types, then only the least cost routes are considered. In this case the CMTS defaults to the previously described DRR functionality, where sub-optimal routes are only used if a least cost route becomes inactive. This first piece of information that must be considered when determining the cost of a route is the protocol type. It takes precedence over the metric value. Local routes have the greatest precedence when determining a least cost route. RIP routes have the least. Protocol precedence is not changeable within the CMTS. Here are the protocol rankings: 1. Local 2. Static 3. OSPF 4. RIP
14-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Configuring IP Static Routes
Procedure 14-2
How to Add/Delete/View a Static IP Route to the CMTS 1 To add an IP Route: configure ip route [metric ] Where the value assigned to the metric parameter defines the weight or cost of the route. 2 To delete an IP Route: configure no ip route 3 To display the IP Routes: show ip route End of procedure
Route Redistribution and Administrative Costing Route redistribution is defined as the ability to import and export IP routing information from one routing protocol domain to another. In addition, Local (CMTS interface networks) and Static (Net Management) routes may be imported into a protocol domain. The dynamic routing protocols RIPv2 and OSPF may be run at the same time. The Route Table Manager (RTM) is responsible for choosing the best group of routes provided by each routing protocol. Its choice is based on the administrative distance assigned to each protocol group. It should be noted this approach requires that the administrative distance of each protocol entity, including static and connected routes, must be unique.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-17
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
This feature supports route redistribution at the following levels: •
From static to RIPv2 and OSPF
•
From connected (local) to RIPv2 and OSPF
•
From RIP to OSPF
•
From OSPF to RIPv2
This feature supports different types of distribution lists (filtering):
Definitions
•
RIP input (per interface or global)
•
RIP output (per interface or global)
•
Route redistribution RIPv2 to OSPF
Forwarding Information Base (FIB) — A subset of the RTM RIB contains the “best” routes for each IP prefix. This information is passed to the Active Routes Interface (ARI) and hardware forwarding engine. Routing Information Base (RIB) — A database containing all the known routes learned from various disparate sources (e.g. RIP, OSPF, IS-IS). Routing Protocol Manager (RPM) — Each protocol, including static routes, must have an RPM to communicate with the RTM. Static Route Manager (SRM) — Software entity used to control ECMP for static routes.
Abbreviations
14-18
•
ACL: Access Control List
•
ARI: Active Routes Interface
•
ECMP: Equal Cost Multi-Path
•
FIB: Forwarding Information Base
•
OSPF: Open Shortest Path First
•
RIB: Routing Information Base
•
RIP: Routing Information Protocol
•
RPM: Routing Protocol Manager
•
RTM: Route Table Manager
•
SRM: Static Route Manager
•
VRF: Virtual Routing and Forwarding
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
14 Cable and Network IP Configuration
CLI Commands The CMTS supports route redistribution between all protocols with filtering based on distribute-lists. RIP Redistribution Commands
The CMTS CLI supports the following RIP redistribute commands: configure router rip [no] redistribute static [metric METRIC] configure router rip [no] redistribute connected [metric METRIC] configure router rip [no] redistribute ospf [metric METRIC] [match {internal | external1 | external2}] configure router rip [no] redistribute bgp [metric METRIC] configure router rip [no] redistribute isis [metric METRIC] [level-1 | level-2 | level-1-2]
OSPF Redistribution Commands
The CMTS CLI supports the redistribution of static, connected, RIP, BGP, and IS-IS routes using the following OSPF redistribute commands: configure router ospf [no] redistribute static [metric METRIC] [metric-type {1 | 2}] [tag TAG-NUM] [subnets] configure router ospf [no] redistribute connected [metric METRIC] [metric-type {1 | 2}] [tag TAG-NUM] [subnets] configure router ospf [no] redistribute rip [metric METRIC] [metric-type {1 | 2}] [tag TAG-NUM] [subnets] configure router ospf [no] redistribute bgp [metric METRIC] [metric-type {1 | 2}] [tag TAG-NUM] [subnets] configure router ospf [no] redistribute isis [metric METRIC] [metric-type {1 | 2}] [tag TAG-NUM] [subnets] [level-1 | level-2 | level-1-2]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-19
14 Cable and Network IP Configuration
BGP Redistribution Commands
C4/C4c CMTS Rel. 8.0.7
The CMTS supports the redistribution of static, connected, RIP, OSPF, and IS-IS routes using the following BGP redistribute commands: configure router bgp [no] redistribute static [metric METRIC] configure router bgp [no] redistribute connected [metric METRIC] configure router bgp [no] redistribute rip [metric METRIC] configure router bgp [no] redistribute ospf [metric METRIC] [match {internal | external1 | external2}] configure router bgp [no] redistribute isis [metric METRIC] [level-1 | level-2 | level-1-2]
IS-IS Redistribution Commands
The CMTS supports the redistribution of static, connected, RIP, OSPF, and BGP routes using the following IS-IS redistribute commands: configure router isis [no] redistribute static {level1 | level-2 | level-1-2} [metric METRIC] [metric-type {internal | external}] configure router isis [no] redistribute connected {level-1 | level-2 | level-1-2} [metric METRIC] [metric-type {internal | external}] configure router isis [no] redistribute rip {level-1 | level-2 | level-1-2} [metric METRIC] [metric-type {internal | external}] configure router isis [no] redistribute ospf {level-1 | level-2 | level-1-2} [metric METRIC] [metric-type {internal | external}] [match {internal | external1 | external2}] configure router isis [no] redistribute bgp {level-1 | level-2 | level-1-2} [metric METRIC] [metric-type {internal | external}]
14-20
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Filtering RIP Routes
To filter RIP routes on an ingress interface, use the following command: configure router rip [no] distribute-list in {cable | tengigabitethernet | gigEthernet} SLOT/PORT The CMTS applies filtering to the destination IP prefixes of RIPv2 updates based on the ingress interface. The ACL defined is a standard ACL (range 0-99). The CMTS CLI supports filtering inbound rip updates with the following syntax: configure router rip [no] distribute-list in The CMTS processes inbound RIP updates with the following rules: 1 Extract the next network from the inbound update. 2 Check the interface that it entered. 3 Is there a distribute list applied to that interface? •
Yes: Is the network denied by that list?
•
Yes: the network does not make it to the routing table; return to step 1. - No: the network is allowed; continue to step 4. No: Go to step 4.
4 Is there a global distribute list? •
Yes: Is the network denied by that list?
•
Issue 2.0
Yes: the network does not make it to the routing table; return to step 1. - No: the network makes it to the routing table; return to step 1. No: The network makes it to the routing table; return to step 1.
ARRIS PROPRIETARY — All Rights Reserved
14-21
14 Cable and Network IP Configuration
Distribute List Out Configure Commands
C4/C4c CMTS Rel. 8.0.7
To filter redistributed RIP routes, use the following commands: configure router rip [no] distribute-list ACL-NUM out {cable | tengigabitethernet | gigEthernet} SLOT/PORT configure router rip [no] distribute-list ACL-NUM out static configure router rip [no] distribute-list ACL-NUM out connected configure router rip [no] distribute-list ACL-NUM out ospf configure router rip [no] distribute-list ACL-NUM out bgp configure router rip [no] distribute-list ACL-NUM out isis Although not specifically associated with route redistribution, the CMTS continues to support filtering IP routes based on an egress interface. The CadPolicyAclTable MIB must be used when creating an ACL. The ACL defined must be a standard ACL (range 0-99). Execution of this command will create an entry in the cadDistListOutTable. If the corresponding route redistribution command has already been executed, then each entry in the ACL table will create an entry in the rtmRedistTable. There must also be a wildcard match entry in the rtmRedistTable for either the permit_all or deny_all ACL case, with the rtmRedistFlag set to AMB_TRUE or AMB_FALSE. The priority (rtmRedistPriority) must be set to a value greater than (implies lower priority) the more specific matches. Distribute-lists also control RIP route advertisement per physical interface. For example: configure access-list 10 deny 130.10.0.0 0.0.255.255 configure access-list 10 permit 0.0.0.0 255.255.255.255 configure router rip distribute-list 10 out ospf
14-22
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Filtering Redistributed OSPF Routes
To filter redistributed OSPF routes, use the following commands: configure router ospf [no] distribute-list ACL-NUM out static configure router ospf [no] distribute-list ACL-NUM out connected configure router ospf [no] distribute-list ACL-NUM out rip configure router ospf [no] distribute-list ACL-NUM out bgp configure router ospf [no] distribute-list ACL-NUM out isis The CMTS continues to support distribute-lists for filtering RIP IP prefixes that are redistributed into OSPF. The CadPolicyAclTable MIB must be used when creating an ACL. The ACL defined must be a standard ACL (range 099). Execution of this command will create an entry in the cadDistListOutTable. If the corresponding route redistribution command has already been executed, then each entry in the ACL table will create an entry in the rtmRedistTable. There must also be a “wildcard” match entry in the rtmRedistTable for either the “permit_all” or “deny_all” ACL case, with the rtmRedistFlag set to AMB_TRUE or AMB_FALSE. Note: the priority (rtmRedistPriority) must be set to a value greater than (implies lower priority) the more specific matches. For example: configure access-list 10 deny 130.10.0.0 0.0.255.255 configure access-list 10 permit 0.0.0.0 255.255.255.255 configure router ospf distribute-list 10 out rip
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-23
14 Cable and Network IP Configuration
Filtering Redistributed BGP Routes
C4/C4c CMTS Rel. 8.0.7
To filter redistributed BGP routes, use the following commands: configure router bgp [no] distribute-list ACL-NUM out static configure router bgp [no] distribute-list ACL-NUM out connected configure router bgp [no] distribute-list ACL-NUM out rip configure router bgp [no] distribute-list ACL-NUM out ospf configure router bgp [no] distribute-list ACL-NUM out isis
Although not specifically associated with route redistribution, the CMTS continues to support filtering IP routes based on an egress interface. The existing CadPolicyAclTable MIB must be used when creating an ACL. The ACL defined must be a standard ACL (range 0-99). Execution of this command will create an entry in the cadDistListOutTable. If the corresponding route redistribution command has already been executed, then each entry in the ACL table will create an entry in the rtmRedistTable. There must also be a “wildcard” match entry in the rtmRedistTable for either the “permit_all” or “deny_all” ACL case, with the rtmRedistFlag set to AMB_TRUE or AMB_FALSE. Note: the priority (rtmRedistPriority) must be set to a value greater than (implies lower priority) the more specific matches. For example: C4# config access-list 10 deny any C4# config access-list 10 permit 0.0.0.0 255.255.255.255 C4# config router bgp C4(config-router-bgp)# distribute-list 10 out ospf
14-24
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Filtering Redistributed IS-IS Routes
To filter redistributed IS-IS routes, use the following commands: configure router isis [no] distribute-list ACL-NUM out static configure router isis [no] distribute-list ACL-NUM out connected configure router isis [no] distribute-list ACL-NUM out rip configure router isis [no] distribute-list ACL-NUM out ospf configure router isis [no] distribute-list ACL-NUM out bgp The existing CadPolicyAclTable MIB must be used when creating an ACL. The ACL defined must be a standard ACL (range 0-99). Execution of this command will create an entry in the cadDistListOutTable. If the corresponding route redistribution command has already been executed, then each entry in the ACL table will create an entry in the rtmRedistTable. There must also be a “wildcard” match entry in the rtmRedistTable for either the “permit_all” or “deny_all” ACL case, with the rtmRedistFlag set to AMB_TRUE or AMB_FALSE. Note: the priority (rtmRedistPriority) must be set to a value greater than (implies lower priority) the more specific matches. For example: C4# config access-list 10 deny 130.10.0.0 0.0.255.255 C4# config access-list 10 permit 0.0.0.0 255.255.255.255 C4# config router isis C4(config-router-isis)# distribute-list 10 out ospf
Filtering Outbound RIP Updates
To filter outbound rip updates originating at the CMTS, use the following commands: configure router rip [no] distribute-list out The CMTS processes outbound RIP updates with the following rules:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-25
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
1 Select the next network to receive an outbound update. 2 Check which interface it is being sent out on. 3 Is there a distribute list applied to that interface? •
Yes: Is the network denied by that list?
•
Yes: the network does not go out; return to step 1. No: the network goes out; continue to step 4. No: Go to step 4.
4 Check the routing process from which we derive the route. 5 Is there a distribute list applied to that process? •
Yes: Is the network denied by that list?
•
Yes: the network does not go out; return to step 1. No: the network goes out; continue to step 6. No: Go to step 6.
6 Is there a global distribute list? •
Yes: Is the network denied by that list?
•
Distance Configure Commands
Yes: the network does not go out; return to step 1. No: the network goes out; return to step 1. No: The network makes it; go to step 1.
To change the static route administrative distance, use the following commands: configure router static distance configure router static no distance Where
int = an integer 1-255 = administrative distance range
The distance must be validated to ensure that it is unique among all the protocols. If the user attempts to start a protocol whose administrative distance conflicts with a protocol that is already running, the attempt will fail until the user corrects the problem. To change the RIP route administrative distance, use the following command: configure router rip distance configure router rip no distance
14-26
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Where
int
= an integer 1-255 = administrative distance range
The distance must be validated to ensure that it is unique among all the protocols. If the user attempts to start a protocol whose administrative distance conflicts with a protocol that is already running, the attempt will fail until the user corrects the problem. To change the OSPF route administrative distance, use the following command: configure router ospf distance ospf external EXTERNAL-VALUE configure router ospf no distance Where
int = an integer 1-255 = administrative distance range
To set the administrative distance for both internal and external (type 5, 7 LSA) OSPF routes, use the following command: configure router ospf [vrf ] distance ospf external Where
int = an integer 1-255 = internal distance range int2= an integer 1-255 = external distance range
To change the BGP administrative distance for both internal (I-BGP) and external (E-BGP) routes, use the following command: configure router bgp distance bgp Where
int = an integer 1-255 = administrative distance range
To change the IS-IS route administrative distance, use the following commands: configure router isis distance configure router isis distance isis [externallevel1 ] [external-level2 ] [internal-level1 ] [internal-level2 ] configure router isis no distance Where
int = an integer 1-255 = administrative distance range
The CMTS sets the administrative distance for internal ISIS routes and external level-1 and level-2 routes. Specific distances (if supplied) override the value supplied by IS-IS-VALUE.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-27
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
For example: configure router isis (config-router-isis)# distance 100
Displaying Route Information
To display redistribution settings, use the following command: show ip {rip | isis | bgp | ospf} To display redistributed route information for all protocols, use the following command: show ip protocols This existing command must be enhanced to display what protocols (static or connected) are being redistributed as well as the administrative distance of each protocol. Example Output: Routing Protocol is "ospf default" Redistribution: ON static, admin distance: 1 connected, admin distance: 0 Routing for Networks: 22.22.22.22/32 192.168.202.2/32 192.168.203.2/32 Routing Information Sources: Gateway Last Update 192.168.202.1 0 days 0:19:16 192.168.202.2 0 days 0:27:58 Default Distance: Internal: 30 External: 110 To display the distribute-lists for each protocol: show distribute-list [rip | ospf | bgp | isis] The output is similar to the distribute-list portion of the show running config command. To display the administrative distance for each route: show ip route
14-28
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
This show command must be enhanced to show the administrative distance for each route based on the protocol type. In the sample output below, the Metric column is the metric value or cost of a specific route. The Dist column is the administrative distance for a particular routing protocol (e.g. OSPF). Example of output: Codes:
(L1) internal level-1, (S) summary, (I) internal,
(L2) internal level-2, (IA) internal area, (E) external
(eL1) external level-1, (E1) external type-1,
VRF Name IP Route Dest. Act PSt Next Hop Metric Protocol =============== ================== === === =============== ====== ======== default 0.0.0.0/0 Yes IS 192.168.202.1 1 ospf(E2) default 0.0.0.0/0 Yes IS 192.168.203.1 1 ospf(E2) default 22.22.22.22/32 Yes IS 22.22.22.22 0 local default 192.168.129.0/24 Yes IS 192.168.202.1 20 ospf(E2) default 192.168.129.0/24 Yes IS 192.168.203.1 20 ospf(E2) default 192.168.136.0/24 Yes IS 192.168.202.1 20 ospf(E2) default 192.168.136.0/24 Yes IS 192.168.203.1 20 ospf(E2) default 192.168.145.0/24 Yes IS 192.168.202.1 20 ospf(E2) default 192.168.145.0/24 Yes IS 192.168.203.1 20 ospf(E2) default 192.168.176.0/24 Yes IS 192.168.202.1 20 ospf(E2) default 192.168.176.0/24 Yes IS 192.168.203.1 20 ospf(E2) default 192.168.177.0/24 Yes IS 192.168.202.1 20 ospf(E2) default 192.168.177.0/24 Yes IS 192.168.203.1 20 ospf(E2) default 192.168.190.0/24 Yes IS 192.168.202.1 20 ospf(E2) default 192.168.190.0/24 Yes IS 192.168.203.1 20 ospf(E2) default 192.168.196.0/24 Yes IS 192.168.202.1 20 ospf(E2) default 192.168.196.0/24 Yes IS 192.168.203.1 20 ospf(E2) default 192.168.197.0/24 Yes IS 192.168.202.1 20 ospf(E2) default 192.168.197.0/24 Yes IS 192.168.203.1 20 ospf(E2) default 192.168.202.0/24 Yes IS 192.168.202.2 0 local default 192.168.203.0/24 Yes IS 192.168.203.2 0 local default 192.168.205.0/24 Yes IS 192.168.205.1 0 local
(eL2) external level-2 (E2) external type-2
Dist Route Age Interface ==== ============ ========= 110 0 02:00:23 gigE 17/0.0 110 0 02:00:23 gigE 18/0.0 0 0 02:12:13 loop 0 110 0 02:00:24 gigE 17/0.0 110 0 02:00:24 gigE 18/0.0 110 0 02:00:24 gigE 17/0.0 110 0 02:00:24 gigE 18/0.0 110 0 02:00:24 gigE 17/0.0 110 0 02:00:24 gigE 18/0.0 110 0 02:00:24 gigE 17/0.0 110 0 02:00:24 gigE 18/0.0 110 0 02:00:24 gigE 17/0.0 110 0 02:00:24 gigE 18/0.0 110 0 02:00:24 gigE 17/0.0 110 0 02:00:24 gigE 18/0.0 110 0 02:00:24 gigE 17/0.0 110 0 02:00:24 gigE 18/0.0 110 0 02:00:24 gigE 17/0.0 110 0 02:00:24 gigE 18/0.0 0 0 02:12:08 gigE 17/0.0 0 0 02:01:09 gigE 18/0.0 0 0 02:10:25 cMac 1.0
To display the total number of all routes: show ip route summary IP routing table name is default(1) Route Source Routes ============ ====== Local 4 OSPF Type 2 External 17 OSPF Total VR Total
Issue 2.0
17 21
ARRIS PROPRIETARY — All Rights Reserved
14-29
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
IP routing table name is tag70(2) Route Source Routes ============ ====== Local 4 VR Total 4 Total
25
Policy-Based Routing (PBR) IP packets are normally directed by routing protocols and route tables, which make forwarding decisions based on the destination IP addresses of packets. Policy-based Routing (PBR) enables network engineers to create policies for packets with matching criteria, causing them to take paths that differ from the next-hop path specified by the route table. To enable PBR, the user must configure a route map and apply it to an interface. PBR is then applied to all incoming packets arriving at that interface. The principal benefits of PBR include the following: •
Forwarding is based not on destination IP address but on packet attributes such as source IP or packet type.
•
Route maps can improve service by enforcing Quality of Service (QOS) sorting at the edge router.
•
Cost-savings can be achieved by segregating slow bulky traffic from time-sensitive traffic.
•
Traffic can be separated according to desired characteristics and load balanced across multiple and unequal paths.
NOTE The route maps used by the BGP routing protocol are part of a separate feature and are not affected by commands to create or configure policybased route maps. For more information on BGP-related route maps, see BGP and Route Maps.
14-30
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Configuring PBR Configuring PBR involves creating a route map with match and set commands and then applying the route map to an interface. Route map statements can result in a permit or deny action on matching packets. Deny means that normal destination-based routing will be used to forward the packet; permit means that some set command will be used to route the packet. Route maps are given unique names (map-tags in CLI) and can have up to ten statements. Each statement is assigned a sequence number. Because the CMTS supports a maximum of 2,048 route map statements, if each route map contains a maximum of ten statements, the C4/C4c CMTS could support a maximum of 204 route maps. Types of PBR commands:
PBR Match Commands
Issue 2.0
•
match ip address
•
set ip tos
•
set ip precedence
•
set ip next-hop
•
set ip backup-next-hop
•
set ip interface null 0.
The following guidelines should be observed when creating match statements: •
This implementation of PBR can use standard access control lists to match source IP addresses or extended ACLs to specify match criteria for source and destination IP, application, protocol type, or ToS.
•
In any one sequence number (map entry) only one ACL can be specified for the match IP address command. However, multiple match IP address ACLs can be concatenated into the one ACL specified by the sequence number.
•
If the route map is applied to a packet and no match is found, the packet is not dropped; instead, it is forwarded using destination-based routing.
•
If a route map is created with no match criteria, then it will be applied to all packets that come in to the specified interface. All set operations will be performed on all packets (unless the set fails).
•
Only one match statement is allowed for each sequence number. When a packet matches the match statement with the lowest sequence number, only the corresponding set statements in that route-map will be processed. If the set statements fail, then the packet will fall back to normal destination-based routing. The packet will not be checked for additional matches.
ARRIS PROPRIETARY — All Rights Reserved
14-31
14 Cable and Network IP Configuration
Set IP ToS
C4/C4c CMTS Rel. 8.0.7
The set ip tos command is used to set the 5 ToS bits; values 0 through 8 are used (one of the bits is reserved). Table 14-2: Setting ToS Values ToS Value | name
Description
0 | normal
Sets the normal ToS
1 | min-monetary-cost
Sets the min-monetary-cost ToS
2 | max-reliability
Sets the max reliable ToS
4 | max-throughput
Sets the max throughput ToS
8 | min-delay
Sets the min delay ToS
The ToS value for DOCSIS classification is not supported. Set IP Precedence Values
The set ip precedence [number | name] route map configuration command enables you to set the three IP precedence bits in the IP packet header. With three bits, you have eight possible values for the IP precedence; values 0 through 7 are defined. Table 14-3: Setting IP Precedence Values Precedence Value| name 0 | routine
Description Sets the routine precedence
1 | priority
Sets the priority precedence
2 | immediate
Sets the immediate precedence
3 | flash
Sets the flash precedence
4 | flash-override
Sets the Flash override precedence
5 | critical
Sets the critical precedence
6 | internet
Sets the internetwork control precedence
7 | network
Sets the network precedence
The C4/C4c CMTS does not use the new precedence value for DOCSIS classification, but if it is included it can be used in routers or devices north of the CMTS. Set IP Next-hop
14-32
The set IP next-hop command specifies the IP address of the adjacent next-hop router in the path toward the packet's destination. The ipaddress must be the address of an adjacent router. The address must be in the same subnet as the C4 CMTS interface address, but not be the same as the C4 CMTS interface address or the subnet broadcast address. With the set ip next-hop command, the routing table is checked only to determine whether the next hop can be reached, not whether the ultimate destination is reachable. Use the NO version of the command to delete it from a route map. For an illustration see the flowchart in Figure 14-4.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Set IP Backup Next-hop
The set IP backup next-hop command provisions a backup next-hop IP address. If the next-hop ip address is unreachable, then the CMTS uses the backup next-hop address. If it is not provisioned or if the backup-nexthop is unreachable, then the CMTS resorts to normal destination-based routing. Use the NO version of the command to delete it from a route map. For an illustration see the flowchart in Figure 14-4.
Set IP Interface Null 0
The set IP interface null0 command is a way to drop packets. By routing undesired packets to the null interface, the CMTS drops them and prevents them from going to a default route and possibly causing a routing loop.
Some Operational Guidelines
The user should be aware of the following:
Local PBR
Issue 2.0
•
PBR is also applied to packets destined to IP addresses of the C4/C4c CMTS. A misconfigured policy could cause the CMTS not to receive packets that it should receive.
•
The C4/C4c CMTS does not support PBR for IPv6 packets.
•
PBR cannot be used on packets coming in to SCM interfaces 19/0 or 20/0.
•
If a route map matches a packet to an ACL that contains a deny keyword, then the effect of that deny is to cause the packet to be forwarded using destination-based (not policy-based) routing.
•
A route map cannot be changed from permit to deny, or from deny to permit. To make such a change you must first remove the route map, make the change, and add it.
•
If the same sequence number is used in two route map commands in the same route map, then the first one is overwritten by the second.
•
A route map can be created that references an ACL before the ACL is defined. If the route map is used before the ACL is defined, then the packet will be routed normally.
•
The only set interface statement supported is set interface null 0, which is used to drop packets.
•
PBR can work in conjunction with multiple VRFs. PBR is configured on a sub-interface which may be assigned to a VRF also. If a next-hop is used in the route-map command, the next-hop IP needs to be in the same VRF (or the default VRF) as the ingress interface. If no next-hop is specified for the route-map (e.g., a set IP ToS is used without a set next-hop), the packet is routed using the normal VRF routing mechanism.
The C4/C4c CMTS supports local PBR to apply policies to In-band Management port of the SCM. In-band Management (also called SCM access) is enabled by the configure ip scm access command.
ARRIS PROPRIETARY — All Rights Reserved
14-33
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Policies can be applied to the following types of packets: •
telnet
•
NTP
•
FTP
•
DNS
•
TFTP
•
PacketCable event messaging
•
RADIUS
•
PacketCable CALEA CD
•
SYSLOG
•
SSH
•
SNMP
•
COPS without IPSec
•
SNMP traps
•
COPS with IPSec.
•
TACACS+
The following packet types, when they originate on the RCM, are not affected by local PBR and cannot be directed by a route map:
Counts
14-34
•
Ping
•
Traceroute
•
RIP
•
OSPFv2
•
OSPFv3
•
IS-IS
•
BGP
The CMTS keeps packet and byte counts for the following events: •
The ACL counter will be incremented when the packet matches the ACL specification. This ACL check is done before the PBR set action is evaluated.
•
A PBR match occurs and the PBR match count is incremented when a packet arrives at a PBR-enabled interface and all of the set commands of the route map work.
•
Packets that match at least one match statement, but then had one or more set statements fail are counted by the PBR failed counter. In practice this means that either the set next-hop or set backup-nexthop failed.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
CLI Commands The following table is a listing of the common PBR commands. Table 14-4: Some Examples of PBR CLI Commands Purpose
CLI Command
The first command configures a route map named ReRoute which configure route-map-policy ReRoute permit 100 match ip address 10 matches on access list number 10. The second command overwrites the first and sets the ReRoute map to match on ACL 20. The first command configures route map named ReRoute to match to set the next-hop ip address to 1.2.3.4. The second command overwrites sequence number 100 and sets the next-hop ip address to 5.6.7.8.
configure route-map-policy ReRoute permit 100 match ip address 20 configure route-map-policy ReRoute permit 100 set ip next-hop 1.2.3.4 configure route-map-policy ReRoute permit 100 set ip next-hop 5.6.7.8
This command configures a route map name ReRoute which matches on access list number 30. The packets which match the ACL are forwarded using destination-based (not policy-based) routing because the route map type is deny.
configure route-map-policy ReRoute deny 200 match ip address 30
Deletes the route map named ReRoute.
configure no route-map-policy ReRoute
Deletes only sequence number 30 from the route map named
ReRoute.
configure no route-map-policy ReRoute 30
Configures a local policy route map named my_route_map.
configure ip local policy route-map-policy my_route_map
Specifies the IP address of the adjacent next-hop router in the path toward the packet's destination.
configure route-map-policy my_route_map permit 10 set ip next-hop 10.69.1.1
Provisions a backup next-hop IP address.
configure route-map-policy my_route_map permit 10 set ip backup-next-hop 10.69.2.1
Provisions an IP null interface for packets that you wish to drop.
configure route-map-policy my_route_map permit 10 set ip interface null 0
Apply the route map to a cable mac or gigabit interface.
configure interface cable-mac 1.1 ip policy route-map-policy my_route_map configure interface gigabitethernet 17/0.1 ip policy route-map-policy my_route_map
clear route-map-policy counters my_route_map Clears the counters that pertain to the specified route map. If no route map is specified, the second command clears counters clear route-map-policy counters for all route maps. Displays the match and set clauses for each sequence entry of each route map. It also displays matching packet and byte counts show route-map-policy and failed packets and byte counts for each map entry. Displays interfaces for which PBR is enabled and the route maps that are assigned to each of those interfaces.
show ip policy
Displays address, VRF, protocol, and policy configuration for the specified interface.
show ip interface cable-mac 1.1
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-35
14 Cable and Network IP Configuration
Sample PBR Script 1
C4/C4c CMTS Rel. 8.0.7
This sample script applies a route map named testroutemap to interface cable-mac 1. If the packets entering the C4 CMTS from interface cablemac 1 match ACL 155, they are sent to the interface connected to a router with the IP address 67.59.234.169. 1 Create an extended ACL 155 to match packets with destination IP address in the 11.0.0.0/8 or 14.0.0.0/8 subnets and the precedence value set as routine: configure access-list 155 permit ip any 11.0.0.0 0.255.255.255 precedence routine configure access-list 155 permit ip any 14.0.0.0 0.255.255.255 precedence routine 2 Configure route map named testroutemap and sequence number 10 to match ACL 155: configure route-map-policy testroutemap permit 10 match ip address 155 3 Set the next hop address to 67.59.234.169: configure route-map-policy testroutemap permit 10 set ip next-hop 67.59.234.169 4 Apply the route map named testroutemap to interface cable-mac 1: configure interface cable-mac 1 ip policy route-map-policy testroutemap 5 Run the following show commands to confirm your configuration: show access-list Sample output:
Extended IP access list 155 10 permit ip any 11.0.0.0 0.255.255.255 20 permit ip any 14.0.0.0 0.255.255.255
precedence routine precedence routine
(0 matches) (0 matches)
show ip interface cable-mac 1 Sample output: Secondary IP Address(es): No Secondary Addresses Physical Address: 0001.5c22.9041 MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): 10.50.22.3 for Traffic Type "any" Directed Broadcast is disabled
14-36
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
ICMP unreachables are always sent Multicast reserved groups joined: None Source-verify is disabled Policy routing is enabled, using policy route map: testroutemap InOctets = 303291 OutOctets = 4382 InUcastPkts= 23 OutUcastPkts= 38 InDiscards = 0 OutDiscards = 0 InErrors = 0 OutErrors = 0 InMcastPkts= 616 OutMcastPkts= 4 show route-map-policy show ip policy See Show Commands on page 14-39, for sample system responses to the two commands above.
Sample PBR Script 2
The following script is offered as an example of an implementation of PBR. PBR can be applied to one or more C4/C4c CMTS interfaces. The two chosen in the following procedure are meant as examples. 1 Create standard access lists 20, 30 & 40: configure access-list 20 permit 10.10.20.0 0.0.0.255 configure access-list 30 permit 10.10.30.0 0.0.0.255 configure access-list 40 permit 10.10.40.0 0.0.0.255 2 Configure route map named routemap1 and sequence number 10 to match ACL 20; set the next-hop to 10.69.1.1; and set the backup next-hop to 10.69.2.1: configure route-map-policy routemap1 permit 10 match ip address 20 configure route-map-policy routemap1 permit 10 set ip next-hop 10.69.1.1 configure route-map-policy routemap1 permit 10 set ip backup-next-hop 10.69.2.1
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-37
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
3 Configure routemap1, sequence number 20, to match ACL 30; set the next-hop to 10.69.3.1; and set the backup next-hop to 10.69.4.1; and set the ToS to normal: configure route-map-policy routemap1 permit 20 match ip address 30 configure route-map-policy routemap1 permit 20 set ip next-hop 10.69.3.1 configure route-map-policy routemap1 permit 20 set ip backup-next-hop 10.69.4.1 configure route-map-policy routemap1 permit 20 set ip tos normal 4 Configure routemap1, sequence number 30, to drop all packets: configure route-map-policy routemap1 permit 30 set ip interface null 0 5 Configure route map named routemap2, sequence number 20, to match ACL 40 and set the next-hop to 10.69.5.1: configure route-map-policy routemap2 permit 20 match ip address 40 configure route-map-policy routemap2 permit 20 set ip next-hop 10.69.5.1 6 Apply routemap1 to interface cable-mac 1.1: configure interface cable-mac 1.1 ip policy route-map-policy routemap1 7 Apply routemap2 to the gigabit Ethernet interface 17/2.1: configure interface gig 17/2.1 ip policy route-mappolicy routemap2 8 Apply routemap2 to local policy (packets from the SCM): configure ip local policy route-map-policy routemap2
14-38
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
9 Run the following show commands to confirm your configuration: show route-map-policy show ip policy show ip interface cable-mac 1.1 show ip interface gigabitinterface 17/2.1 Show Commands
Below are examples of show commands to be used with PBR. They are followed by sample system responses: show route-map-policy Route-map routemap1, permit, sequence 10 Match clauses: ip address (access-lists): 20 Set clauses: ip next-hop 10.69.1.1 ip backup-next-hop 10.69.2.1 Policy routing matches: 0 packets, 0 bytes Policy routing failed : 0 packets, 0 bytes permit, sequence 20 Match clauses: ip address (access-lists): 30 Set clauses: ip next-hop 10.69.3.1 ip backup-next-hop 10.69.4.1 ip tos normal Policy routing matches: 0 packets, 0 bytes Policy routing failed : 0 packets, 0 bytes permit, sequence 30 Match clauses: Set clauses: ip interface null Policy routing matches: 0 packets, 0 bytes Policy routing failed : 0 packets, 0 bytes Route-map routemap2, permit, sequence 20 Match clauses: ip address (access-lists): 40 Set clauses: ip next-hop 10.69.5.1 Policy routing matches: 0 packets, 0 bytes Policy routing failed : 0 packets, 0 bytes
show ip policy
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-39
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Interface --------------------------------------Local gigabitEthernet 17/2.1 cable-mac 1.1
Route map --------routemap2 routemap2 routemap1
show ip interface cable-mac 1.1 cable-mac 1.1, VRF: vrf_a, IP Address: 10.119.32.1/19 Secondary IP Address(es): No Secondary Addresses Physical Address: 0001.5c22.05c1 MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): No Helper Addresses Directed Broadcast is disabled ICMP unreachables are always sent Multicast reserved groups joined: None Source-verify is disabled Policy routing is enabled, using policy route map: routemap1 InOctets = 0 OutOctets = 768 InUcastPkts= 0 OutUcastPkts= 8 InDiscards = 0 OutDiscards = 0 InErrors = 0 OutErrors = 0 InMcastPkts= 0 OutMcastPkts= 4 show ip interface gigabitEthernet 17/2.1 gigabitEthernet 17/2.1, VRF: default, IP Address: 10.99.0.2/24 Secondary IP Address(es): No Secondary Addresses Physical Address: 0001.5c22.05a2 MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): No Helper Addresses Directed Broadcast is disabled ICMP unreachables are always sent Multicast reserved groups joined: None Policy routing is enabled, using policy route map: routemap2 InOctets = 0 OutOctets = 128 InUcastPkts= 0 OutUcastPkts= 0 InDiscards = 0 OutDiscards = 0 InErrors = 0 OutErrors = 0 InMcastPkts= 0 OutMcastPkts= 2
14-40
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
No
PBR enabled on L3 subinterface?
Normal Routing
Yes No
Policy Based Routing
Match clause in the route-map entry?
Yes
Yes
Increment PBR match counter
No Able to get next route-map entry?
No ACL match? Yes
Yes
(Increment ACL match counter) ACL Permit?
Successful connected route lookup (VRF, IP)?
No
Yes
Successful ARP lookup? No
No No
Route-map Permit?
Yes
Yes Set Precedence only?
Yes
Set backup next-hop? (Set IP=backup next-hop)? No
Yes
Increment PBR failed counter
No Set next-hop? (Set IP = next-hop)
Increment PBR match counter
Yes
No Set Interface null0? Yes
No (incomplete route-map)
Discard
Figure 14-4: Flowchart Representing Decision Path for PBR or Normal Routing
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-41
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Multiple VRFs Overview The Mutliple Virtual Routing and Forwarding (Multiple VRFs) feature of the C4 CMTS was developed primarily to support multiple service providers. Virtual routing is a form of policy routing that allows the administrator to assign subscribers to an ISP via simple IP interface configuration on the C4 CMTS. The administrator is responsible for programming the DHCP server to assign the proper IP addresses to the subscriber CMs and CPEs. However, the C4 CMTS must allow for multiple network configurations, including DHCP servers that vary in location and number. Separate routing tables are maintained for each VRF. Each data packet routed through the C4 CMTS is associated with a VRF and is routed using the corresponding route table. Multi VRF Functionality
•
Both cable and network side interfaces can be configured and assigned to a VRF instance. Network side interfaces can use QTAGs to create logical subinterfaces which may be assigned to a VRF. Cable side interfaces use the SIP of the ingress packets to associate a logical subinterface with a VRF instance.
•
Multiple instances of VRFs can be created each with its own route table. Dynamic routing protocols can be configured in each VRF (i.e. OSPF, RIP). Static routes can be configured into each VRF.
•
A default VRF instance is always automatically created. This VRF is a superset of all of the interfaces in other VRFs. This VRF is used for management traffic which is sourced or synchronized to the C4 CMTS (e.g. Telnet, SNMP, Ping, DHCP, etc.). The default VRF has a special property where it may route traffic to any other VRF.
•
Data traffic is isolated by VRF. Data traffic between two devices within the same VRF scope will be routed within the C4 CMTS. Data traffic between two devices in separate VRF scopes will not be routed within the C4 CMTS unless explicitly configured.
14-42
•
The VRF feature supports only IPv4.
•
There are limits to the number of VRFs and the number of configured routing protocol instances. Please contact ARRIS Tech Support when using this feature.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
Abbreviations
Operational Guidelines
OSPF
Open Shortest Path First Version 2
Q-tag
802.1Q VLAN Tagging
RIP
Routing Information Protocol
VRF
Virtual Routing and Forwarding
The C4 CMTS can support up to a total of eleven (11) VRFs: the “default” VRF plus ten additional VRFs with the following restrictions: •
Static routing is supported in all 11 VRFs
•
OSPFv2 can be supported in up to 5 VRFs
•
RIPv2 can be supported in up to 5 VRFs
•
BGP, IS-IS, and OSPFv3 are supported in only one VRF, which must be the “default” VRF.
•
Multiple protocols can operate in the same VRF (e.g., a common example is to have RIPv2 and OSPFv2 operate in the same VRF with RIP being redistributed into OSPFv2).
•
Even though the CLI may allow for configurations beyond the restrictions described here (e.g., more than 11 VRFs), those configurations are not supported.
Overview of the Sample Procedure The configuration example that follows is for demonstration purposes. Such a configuration is not likely to be encountered in the field, but it serves to show what commands are available.
Issue 2.0
•
In the example below we use the default VRF and create four additional ones. You may configure five non-default VRFs: just substitute a new vrf (vrf5) for the default.
•
This sample procedure has RIP being redistributed into OSPF and OSPF being redistributed into RIP in every VRF. This is not a recommended configuration. MSOs might configure one VRF with RIP into OSPF and another VRF with OSPF into RIP, but in most cases you will see only RIP redistributed into OSPF.
•
This procedure also has one RCM interface and one cable-mac in each VRF. You can have multiple interfaces (RCM or cable-macs) in a VRF. One VRF does not have to match the other VRFs in terms of the number of interfaces. The default VRF, for example, could have three RCM ports and four cable-macs. VRF1 could have only one RCM port and three cable-macs, and so on.
ARRIS PROPRIETARY — All Rights Reserved
14-43
14 Cable and Network IP Configuration
Procedure 14-3
C4/C4c CMTS Rel. 8.0.7
Example of Setting Up Five VRFs In this procedure you will add four non-default VRFs to the existing default VRF. This procedure assumes that the following interfaces are using these IP addresses: Type GigE GigE GigE GigE GigE Cable-mac Cable-mac Cable-mac Cable-mac Cable-mac
Interface 17/1.0 17/1.1 17/1.2 18/1.1 18/1.2 1 2 3 4 5
Address/subnet 10.0.0.1 /24 20.0.0.1 /24 30.0.0.1 /24 40.0.0.1 /24 50.0.0.1 /24 110.0.0.1 /24 120.0.0.1 /24 130.0.0.1 /24 140.0.0.1 /24 150.0.0.1 /24
These are the commands you would use to define the interfaces listed above: configure interface gigabitEthernet 17/1.0 ip address 10.0.0.1 255.255.255.0 configure interface gigabitEthernet 17/1.1 ip address 20.0.0.1 255.255.255.0 configure interface gigabitEthernet 17/1.2 ip address 30.0.0.1 255.255.255.0 configure interface gigabitEthernet 18/1.1 ip address 40.0.0.1 255.255.255.0 configure interface gigabitEthernet 18/1.2 ip address 50.0.0.1 255.255.255.0 configure interface cable-mac 1 ip address 110.0.0.1 255.255.255.0 configure interface cable-mac 2 ip address 120.0.0.1 255.255.255.0 configure interface cable-mac 3 ip address 130.0.0.1 255.255.255.0 configure interface cable-mac 4 ip address 140.0.0.1 255.255.255.0 configure interface cable-mac 5 ip address 150.0.0.1 255.255.255.0
14-44
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
1 Create the VRFs: configure ip vrf vrf1 configure ip vrf vrf2 configure ip vrf vrf3 configure ip vrf vrf4 2 The purpose of this step is to associate the interfaces with VRFs. configure interface gigabitEthernet 17/1.0 ip vrf forwarding default configure interface gigabitEthernet 17/1.1 ip vrf forwarding vrf1 configure interface gigabitEthernet 17/1.2 ip vrf forwarding vrf2 configure interface gigabitEthernet 18/1.1 ip vrf forwarding vrf3 configure interface gigabitEthernet 18/1.2 ip vrf forwarding vrf4 configure interface cable-mac 1 ip vrf
forwarding default
configure interface cable-mac 2 ip vrf
forwarding vrf1
configure interface cable-mac 3 ip vrf
forwarding vrf2
configure interface cable-mac 4 ip vrf
forwarding vrf3
configure interface cable-mac 5 ip vrf
forwarding vrf4
3 The use of sub-interfaces requires q-tags. Assign Q-tags to the subinterfaces: configure interface gigabitEthernet 17/1.1 encapsulation dot1q 100 configure interface gigabitEthernet 17/1.2 encapsulation dot1q 101 configure interface gigabitEthernet 18/1.1 encapsulation dot1q 102 configure interface gigabitEthernet 18/1.2 encapsulation dot1q 103
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-45
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
4 (Optional) Enable RIP on one or more of the VRFs: configure router rip vrf default enable configure router rip vrf vrf1 enable configure router rip vrf vrf2 enable configure router rip vrf vrf3 enable configure router rip vrf vrf4 enable
5 (Optional) Configure the interfaces to which RIP runs: configure router rip vrf default network 10.0.0.0 configure router rip vrf vrf1 network 20.0.0.0 configure router rip vrf vrf2 network 30.0.0.0 configure router rip vrf vrf3 network 40.0.0.0 configure router rip vrf vrf4 network 50.0.0.0 configure router rip vrf default network 110.0.0.0 configure router rip vrf vrf1 network 120.0.0.0 configure router rip vrf vrf2 network 130.0.0.0 configure router rip vrf vrf3 network 140.0.0.0 configure router rip vrf vrf4 network 150.0.0.0
6 (Optional) Configure the router ID for the OSPF instances: configure router ospf vrf default router-id 10.0.0.1 configure router ospf vrf vrf1 router-id 20.0.0.1 configure router ospf vrf vrf2 router-id 30.0.0.1 configure router ospf vrf vrf3 router-id 40.0.0.1 configure router ospf vrf vrf4 router-id 50.0.0.1
14-46
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
7 Create the OSPF areas: configure router ospf vrf default network 10.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf vrf1 network 20.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf vrf2 network 30.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf vrf3 network 40.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf vrf4 network 50.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf default network 110.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf vrf1 network 120.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf vrf2 network 130.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf vrf3 network 140.0.0.0 0.0.0.255 area 0.0.0.0 configure router ospf vrf vrf4 network 150.0.0.0 0.0.0.255 area 0.0.0.0
8 (Optional) Enable OSPF on all five VRFs: configure router ospf vrf default enable configure router ospf vrf vrf1 enable configure router ospf vrf vrf2 enable configure router ospf vrf vrf3 enable configure router ospf vrf vrf4 enable
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
14-47
14 Cable and Network IP Configuration
C4/C4c CMTS Rel. 8.0.7
9 (Optional) Redistribute RIP into OSPF: configure router ospf vrf default redistribute rip configure router ospf vrf vrf1 redistribute rip configure router ospf vrf vrf2 redistribute rip configure router ospf vrf vrf3 redistribute rip configure router ospf vrf vrf4 redistribute rip
End of procedure Additional Information
14-48
The procedure above is for demonstration purposes. Adapt it to the requirements of your site and application. •
You may configure five non-default VRFs: just substitute a new vrf (vrf5) for the default.
•
This sample procedure has RIP being redistributed into OSPF. MSOs might configure one VRF with RIP into OSPF and another VRF with OSPF into RIP, but in most cases you will only see RIP redistributed into OSPF.
•
This procedure also has one RCM interface and one cable-mac in each VRF. You can have multiple interfaces (RCM or cable-mac) in a VRF. One VRF does not have to match the other VRFs in terms of the number of interfaces. The default VRF, for example, could have three RCM ports and four cable-macs. VRF1 could have only one RCM port and three cable-macs, and so on.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
15
Dynamic Routing Protocols
Topics
Page
Overview
1
Border Gateway Protocol (BGP)
2
Intermediate System-Intermediate System (IS-IS)
20
Multiple Topology IS-IS (MT IS-IS)
26
Open Shortest Path First (OSPF)
42
Open Shortest Path First (OSPFv3)
50
Routing Information Protocol (RIPv2)
67
Overview This section contains links to the various routing protocols currently supported in the CMTS. NOTE For more information regarding routing protocol event messages, see chapter 44, Logging and the CMTS.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-1
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Border Gateway Protocol (BGP) This section outlines the basic configuration tasks required to implement Border Gateway Protocol version 4 (BGP-4) functionality in the CMTS. The CMTS supports a full complement of features associated with Interior BGP (I-BGP) and Exterior BGP (E-BGP), with a few noted exceptions. BGP runs only on the default VRF, but is also supported on subinterfaces that are not on the default VRF. Some MSOs use BGP as the protocol of choice for advertising CMTS CAMside IP prefixes. In such an application I-BGP is used throughout their regional networks with a full mesh of interconnected peering routers. The CMTS in this environment is required to run I-BGP peering sessions with various routers in a particular Regional Area Network (RAN). I-BGP peers typically communicate using loopback interfaces. Loopback interfaces are not assigned to any particular interface; therefore, a particular BGP session is not interrupted by an interface failure. Interface IP addresses may also be changed without impacting BGP sessions. Typically, I-BGP networks require the following: Definitions
•
BGP Autonomous System: A routing domain in which all routers are associated with the same AS. I-BGP peering sessions occur within an AS.
•
BGP Route Reflector: A route reflector supports the readvertisement of routes between I-BGP peers.
•
BGP Route Reflector Client: Depends on a route reflector to advertise its routes to the entire BGP AS.
Table 15-1: Number of IPv4 and IPv6 Routes Supported by the C4 CMTS Total IPv4 IPv6
a
PDRI
Dynamic
Static
8,000
10,000c
2,000
32,000 20,000b
a. The IPv6 routes are in addition to the IPv4 total. b. The total of IPv6 routes allowed is the sum total of the totals for PDRI, Dynamic, and Static routes. c. The total number of IPv6 dynamic routes is a combination of OSPFv3 and IS-ISv6 routes.
15-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Abbreviations
•
AS: Autonomous System
•
BGP-4: Border Gateway Protocol version 4
•
ECMP: Equal Cost Multi-Path
•
E-BGP: Exterior Border Gateway Protocol
•
RCM: Fabric Control Module
•
I-BGP: Interior Border Gateway Protocol
•
MP-BGP: Multi-protocol BGP
•
NLRI: Network Layer Reachability Information
•
RAN: Regional Area Network
•
RCM: Router Control Module
•
RIB: Routing information Base
•
SCM: System Control Module
•
VRF: Virtual Routing and Forwarding
BGP Confederations and Route Reflection Since I-BGP full mesh topologies scale at a rate of N(N-1)/2, two methods have been developed to reduce the number of BGP peering sessions. The first method breaks the Autonomous System into smaller entities. This method is termed AS confederations. Figure 15-1 depicts a BGP autonomous system that is broken down into sub-ASs. Within each sub-AS, a full mesh exists between all peers; however, a single E-BGP peering session is sufficient for interconnection between sub-ASs. Note that from the perspective of ASs outside of the confederation, the original AS does not appear any different. That is, the sub-As configuration is contained with-in the original AS.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-3
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
AS1, with confederations
Sub-AS: 10
Sub-AS: 12
I-BGP Peering
I-BGP Peering
E-BGP Peering
AS2, no confederations
E-BGP Peering
Sub-AS: 11 E-BGP Peering I-BGP Peering
Figure 15-1: Figure 1: I-BGP with Confederations to Reduce Full Mesh Peering Route reflectors are commonly used to reduce the number of peering groups. This second method is detailed in Figure 15-2, showing a complete RAN running I-BGP with route reflection. This network topology provides a substantial scalability benefit to the CMTS in that it does not need to establish a peering session with each BGP enabled router in the RAN. To allow BGP sessions to be established between peering routers via loopback interfaces, the routers must communicate the reachability of the various loopback interfaces. Typically these interfaces have a network mask of /32. Advertisement of loopback interfaces is accomplished using an overlay OSPF network. In this example, each region is defined as a RAN with a single OSPF area. OSPF summarization occurs at each area border router, and therefore OSPF SPF calculations occur for each RAN.
15-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
15 Dynamic Routing Protocols
In Figure 15-2, the CMTS acts as a route reflector client.
Figure 15-2: Figure 2: BGP Network Topology with Route Reflections and an OSPF overlay
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-5
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
BGP Attributes BGP attributes are applied to the complete group of routes in the BGP Update message. The CMTS supports the following BGP-4 attributes: •
Origin: Indicates how the IP prefixes became known to BGP. -
• •
Next-Hop: Identifies the next hop for the group of routes. This could be a third-party next-hop.
•
Multi-Exit-Discriminator: Allows for choosing the optimal link for a group of routes when more than one connection exists between two ASs.
•
Local-Pref: Allows for choosing the optimal link for a group of routes when multiple connections exists to different intermediate ASs.
•
Aggregator: Identifies the AS that performed route aggregation.
•
Communities: Ability to associate a unique identifier with a route. The following well-known communities are supported:
•
15-6
IGP: Prefix was learned from an interior gateway protocol (e.g. OSPF). - EGP: Prefix was learned via EGP. - Incomplete: Protocol was learned from a source other than IGP/EGP. For example, static or local routes. AS-Path: A list of ASs the group of routes has passed through.
- No-Export: The route must stay local to the AS. - No-Advertise: The route must stay local to the router. - No-Export-Subconfed: The route must stay local to a sub-AS. Extended Communities: Needed for route targets on VPN-IPv4 routes.
•
MP-(Un)Reach-NLRI: Multi-protocol attribute needed for carrying VPN-IPv4 routes.
•
Capabilities: Used to advertise capabilities of the router. Needed for route refresh and VPN extensions.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
General Notes on BGP Function in the CMTS The following points are meant to help understand the BGP-4 implementation on the CMTS:
Issue 2.0
•
BGP-4 on the CMTS complies with RFC 1771 and the MIB RFC 1657.
•
Definition of BGP-4 on the CMTS is for either E-BGP or I-BGP. If the CMTS is used in an E-BGP configuration, it must be for an MSO’s internal network only. Given the size of the CMTS hardware routing table, approximately 32k routes, the CMTS must not be defined as an AS-border router running E-BGP to the internet.
•
The CMTS supports a single instance of BGP, and it must be on the default VRF.
•
I-BGP routes have a default administrative distance of 200.
•
E-BGP routes have a default administrative distance of 20.
•
BGP-4 supports Autonomous System Confederations. This feature is useful in reducing full mesh configurations in I-BGP. A BGP AS is split into multiple sub-ASs. Within a sub-AS, there is a full mesh of I-BGP.
•
BGP-4 supports Equal Cost Multi-path. In addition to being supported for E-BGP, ECMP must be supported when multiple next-hops exist for a prefix within an AS. This implies ECMP is available for I-BGP configurations. The allowable range for ECMP is 1-4 routes. A value of 1 implies that ECMP is disabled.
•
BGP-4 supports Route Reflection. This is an alternative to full mesh IBGP. A route reflector is responsible for re-advertising routes to an entire AS, but a route reflector client requires no additional functionality beyond the original BGP specification.
•
BGP-4 supports the Communities Attribute: this allows similar routes to be grouped for the same policy treatment
•
BGP-4 sends BGP Updates on card/port maintenance state changes. For example, if port maintenance indicates a state change in a CAM subnet, this change triggers a BGP Update to all peers indicating the reachability of the CAM-side subnets.
•
BGP-4 supports Route-Refresh. This feature allows the CMTS to dynamically request a re-advertisement of the Adj-RIB-Out from a BGP peer.
•
BGP-4 supports Capabilities Advertisement. This feature is required to advertise BGP capabilities to peers, such as route refresh. When VPN extensions are available and two BGP speakers wish to exchange labeled VPN-IPv4 NLRI, they must use BGP Capabilities Advertisement to ensure both peers are capable of processing such NLRI.
•
The CMTS, acting as a BGP Server, allows for a socket bind to any provisioned CMTS IP interface, including loopback interfaces. For IBGP connections, loopback interfaces are the preferred IP address
ARRIS PROPRIETARY — All Rights Reserved
15-7
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
when establishing connections since they represent the router itself and not any particular interface that is subject to state changes.
BGP and Route Maps
15-8
•
Additionally, the CMTS supports binding to a “wildcard” address. A “wildcard” address is assumed if the “update source” parameter is not defined during the creation of a BGP instance.
•
BGP supports Route Reflector Client (RRC) and Confederation, but does not support peer groups or route filtering. In the anticipated use of the CMTS as an RRC, there will be only a handful of routers north of the CMTS. Therefore, the neighbor commands contain the ip addresses of the neighbors, but not of peer groups.
•
The CMTS supports BGP route filtering, which is required for CMTS peers with multiple ISPs and is recommended in confederations. Without this filtering, the CMTS could advertise routes received from one peer to another peer, becoming an unintentional transit router.
•
The CMTS permits system administrators to redistribute static, connected, RIP, or OSPF routes into BGP.
•
The CMTS supports BGP Route Aggregation.
Support for the BGP routing protocol requires more complicated filtering of routes. This type of filtering is beyond the syntactic definition of distribute-lists. Distribute-lists rely on standard ACLs to filter on a destination IP prefix. For BGP, route-maps may be used to control the redistribution of IP routes from BGP into another protocol (match functionality) or to redistribute routes from another protocol into BGP (set functionality). MIB support built into the routing protocol software allows for the following BGP filtering to be used for route redistribution (in addition to destination IP address filtering): •
Next-Hop: Allows route redistribution to be controlled based on the advertising router (next-hop). May also be used with other routing protocols
•
BGP Community Number (match or set): 4 byte value identifying a BGP community
•
BGP Extended Community Number (match or set): 8 byte value identifying a BGP community
•
BGP Origin (set): Allows the origin attribute to be set for routes redistributed into BGP
•
Multi-Exist Discriminator (set): Allows a MED attribute value to be set for routes redistributed into BGP
•
Local Preference: Allows a Local Preference attribute to be set for routes redistributed into BGP.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
BGP Route Redistribution
BGP route maps may be applied to redistribution commands having the following form: configure router bgp redistribute [metric ] [route-map ] Where: AS is the name of the Autonomous System routing-protocol is either static, connected, RIP, ISIS, or OSPF Route maps applied by the command above are limited to the following four commands: configure route-map set community [] [none] [local-AS] [no-advertise] [no-export] [internet] configure route-map set local-preference configure route-map set metric configure route-map set origin {igp | egp | incomplete} Where: word is the name of the route map Route maps may contain other commands, but these commands will not be applied to route redistribution.
Provisioning (CLI commands, MIBs, etc.) Below is a table with the CLI commands that are used for configuring and using BGP routing together with a brief description. For more information on these commands and their parameters, see CLI Command Descriptions. NOTE BGP requires a unique router-id to function correctly. The default routerid is computed from the IP addresses of the interfaces. If there are no interfaces configured, then the CMTS displays an error message that reads “No Interfaces have been assigned to this VRF, default router-Id cannot be calculated.”
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-9
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
First, the BGP router must be configured: configure router bgp 100 bgp router-id 10.1.1.1 Table 15-2: List of Commands Related to BGP Purpose
Command
Global BGP commands: Configures a fixed BGP router ID for a BGP-speaking router. The valid range is 1-65535 and this is the number of the Autonomous System.
configure router bgp bgp router-id
Configures the administrative distance for subsets of BGP routes in the same VRF.
configure router bgp [] distance bgp
Configures the administrative distance for BGP routes in the same VRF.
configure router bgp [] distance
Configures BGP. This command should be entered before interface configuration. Controls BGP administrative state (up or down).
configure router bgp [] no shutdown
Disables the administrative state of BGP.
configure router bgp [] shutdown
Removes all BGP configuration.
configure router bgp [] no
Configures the cluster ID if the BGP cluster has more than configure router bgp [] bgp cluster-id one route reflector. Configures the confederation parameters.
configure router bgp [] bgp confederation identifier
Changes the default local preference.
configure router bgp [] bgp default local-preference
Enables BGP deterministic comparison of the MED variable between all paths from the same autonomous system.
configure router bgp [] bgp deterministic-med
Enables the BGP graceful restart capability for the specified VRF.
configure router bgp [] bgp graceful-restart
Configures the maximum time to wait for a gracefulrestart-capable neighbor to recover after a restart.
configure router bgp [] bgp graceful-restart-time
Configures the maximum time to hold on to the stale paths of a gracefully restarted neighbor to come back up after a restart. All stale paths are deleted after the expiration of this timer.
configure router bgp [] bgp graceful-restart stalepaths-time
Limits the amount of work that is carried out in each cycle configure router bgp [] bgp pause-threshold of the N-BASE scheduler. Configures the maximum number of Equal Cost BGP paths to control the number of parallel routes an IP routing protocol can support.
configure router bgp maximum-paths ibgp
Configures the routes that match the aggregate IP address and mask to be aggregated. The aggregate routes and the specific routes would be advertised out.
configure router bgp aggregate-address
15-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-2: List of Commands Related to BGP (Continued) Purpose
Command
Configures the routes so that only the aggregate route would be advertised out and the aggregate route would have the AS_PATHS of all the specific routes. Specifies which routes are not be get aggregated. Attributes of the un-aggregated specific routes would not be inherited by the aggregate route. The un-aggregated specific routes would be advertised out in addition to the aggregate route.
configure router bgp aggregate-address as-set summary-only configure router bgp aggregate-address as-set summary-only advertise-map
Sets the Community attribute on the aggregate route configure router bgp aggregate-address giving the user a chance to change, for the aggregate as-set summary-only attribute-map route, the otherwise inherited Community attributes from the specific routes. Specifies which specific routes are not to get aggregated. However, the attributes of the suppressed specific routes are inherited by the aggregate route. The attribute-map configure router bgp aggregate-address can be used to override the inherited attributes. The non- [as-set] suppress-map suppressed specific routes would be advertised out in addition of the aggregate route. Removing the optional “as-set” would cause the aggregate route not to inherit the AS_PATH attributes from the specific routes. Clears a BGP connection using BGP soft reconfiguration. This will not reset the session.
clear ip bgp | soft [out]
Clears all peers in specified VRF or AS. To clear a specific BGP neighbor address, use the IP address.
clear ip bgp |
Route-map configuration commands: Defines the route map.
configure route-map
Configures conditions that deny routes used to match BGP autonomous system path information.
configure route-map deny [] match as-path regexp
Configures conditions that deny routes that match a BGP community.
configure route-map deny [] match community regexp
Configures conditions that deny routes that matches an IP address and denies routes based on destination network. Standard access-lists are not presently supported. Users configure route-map deny [] match ip address desiring to filter on a standard access-list must manually [prefix-list ] convert the access-list to a prefix-list and apply the prefixlist. Configures conditions that deny routes that match the next-hop address of route.
configure route-map deny [] match ip next-hop [prefix-list ]
Configures conditions that deny routes that match based on address of advertising router.
configure route-map deny [] match ip routesource [prefix-list ]
Configures conditions that deny routes.
configure route-map deny
Use this command to match an autonomous system path information.
configure route-map match as-path
Matches a BGP autonomous system path access list.
configure route-map match as-path regexp
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-11
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-2: List of Commands Related to BGP (Continued) Purpose
Command
Matches a BGP community.
configure route-map match community
Configures conditions that permit routes that match the next-hop address of route.
configure route-map match ip address [prefix-list ]
Redistributes any routes that have a next hop router address passed by one of the access lists specified.
configure route-map match ip next-hop [prefix-list ]
Redistributes routes that have been advertised by routers and access servers at the address specified by the access lists.
configure route-map match ip route-source [prefixlist ]
Configures conditions that permit route.
configure route-map * deny * match as-path regexp
Use this command to match BGP autonomous system path information.
configure route-map regexp
permit [] match as-path
Matches a BGP community.
configure route-map
permit [] match community
Matches a BGP community.
configure route-map permit [] match community regexp
Selects a route based on the destination IP address.
configure route-map permit [] match ip address [prefix-list ]
Matches the next-hop address of the route.
configure route-map permit [] match ip nexthop [prefix-list ]
Configures conditions that permit routes based on matching the IP address of the advertising router.
configure route-map permit [] match ip routesource [prefix-list ]
Appends a string to the autonomous system path.
configure route-map permit [] set as-path prepend
Removes communities from the community attribute of an update.
configure route-map permit [] set comm-list delete no
Removes communities, using a regular expression, from the community attribute of an update.
configure route-map permit [] set comm-list delete regexp
Sets BGP community attributes.
configure route-map permit [] set community
Removes the communities of the update.
configure route-map permit [] set community none
Configures where the next-hop sends packets that match the specified route-map.
configure route-map permit [] set ip next-hop
Sets the local preference of routes within a specified local autonomous system.
configure route-map permit [] set localpreference
Sets the metric value for destination routing protocols.
configure route-map permit [] set metric
Sets the BGP origin code.
configure route-map permit [] set origin
Specifies the BGP weight for the routing table. Weight can be altered by this command on routes learned from other configure route-map permit [] set weight BGP routers, but cannot be set on routes redistributed into BGP from other protocols. Modifies autonomous system path for BGP routes.
15-12
configure route-map set as-path prepend
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-2: List of Commands Related to BGP (Continued) Purpose
Command
Removes communities from the community attribute of an update using a regular expression.
configure route-map set comm-list delete regexp
Sets the community attribute.
configure route-map set community
Removes the community from the route.
configure route-map set community none
Defines where to output packets matching the specified route-map.
configure route-map set ip next-hop
Sets the preference of routes within the local autonomous configure route-map set local-preference system. Configures the metric value for the destination routing protocol.
configure route-map set metric
Sets the BGP origin code.
configure route-map set origin
Specifies the BGP weight for the specified routing table. Weight can be altered by this command on routes learned configure route-map set weight from other BGP routers, but cannot be set on routes redistributed from other protocols. Instructs the route-map to go to next specified route-map sequence number. Note: If adding multiple communities, configure route-map permit continue match must be set to exclude other route matches.
Configuring BGP neighbors: This command creates a new neighbor. This command should only be used on directly connected neighbors or when there is only one interface that handles BGP traffic. If the neighbor is not directly connected, the first neighbor command should be configure router bgp
[] neighbor update-source loopback remote-as
configure router bgp [] neighbor remote-as
The IP address of the specified neighbor by the updatesource option is used by the other routes to reference the CMTS in their neighbor commands. If the initial neighbor command does not contain the update-source, then the other routers will reference us by the directly connected physical interface on the CMTS. Configures the minimum route advertisement interval.
configure router bgp [] neighbor advertisement-interval [withdraw-interval ]
Configures the minimum interval between originating routes from the AS.
configure router bgp [] neighbor as-origininterval
Configures the neighbor as a confederation member.
configure router bgp [] neighbor confed
Configures the connection retry interval.
configure router bgp [] neighbor connect-retry
Enables the BGP speaker (the local router) to send the default route 0.0.0.0 to a neighbor for use as a default originate. Disabled by default.
configure router bgp [] neighbor defaultoriginate
Configures the CMTS to require the neighbors to send their AS as the first AS number in their AS_SEQUENCE.
configure router bgp [] neighbor enforcefirst-as
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-13
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-2: List of Commands Related to BGP (Continued) Purpose
Command
Configures the maximum number of prefixes that can be configure router bgp [] neighbor maximumaccepted from this neighbor. This command is disabled by prefix default. Configures the router to generate a log message when the maximum prefix limit is exceeded, instead of terminating the peering session.
configure router bgp [] neighbor maximumprefix warning-only
Configures the maximum number of prefixes that can be accepted from this neighbor. This command is disabled by configure router bgp [] neighbor next-hop-self default. Configures the maximum number of prefixes that can be accepted from this neighbor. This command is disabled by configure router bgp [] neighbor passive default. Enables Message Digest 5 (MD5) authentication on TCP connections between BGP neighbors.
configure router bgp [] neighbor password
Configures the name of the prefix list to filter inbound updates from the neighbor.
configure router bgp [] neighbor prefix-list in
Configures the name of the prefix list to filter outbound updates to the neighbor.
configure router bgp [] neighbor prefix-list out
Removes private Autonomous Systems (AS) from the autonomous system path.
configure router bgp [] neighbor removeprivate-as
Configures the name of the route-map used to apply policy for routes inbound from the neighbor. By default, no such policy reference exists.
configure router bgp [] neighbor route-map in
Configures the name of the route-map used to apply configure router bgp [] neighbor route-map policy for routes outbound to the neighbor. By default, no out such policy reference exists. Configures the router as a BGP route reflector and the specified neighbor as its a route reflector client.
configure router bgp [] neighbor routereflector-client
Configures the router as a BGP route reflector and the specified neighbor as a meshed route reflector client.
configure router bgp [] neighbor routereflector-client meshed
Triggers a route refresh for the specified neighbor.
configure router bgp [] neighbor route-refresh
Forces an administrative shutdown [restore] of the specified neighbor.
configure router bgp [] neighbor [no] shutdown
Configures routes with a BGP next-hop equal to the neighbor’s address to not send to that neighbor.
configure router bgp [] neighbor split-horizon
Configures the keepalive and holdtime of the specified neighbor.
configure router bgp [] neighbor timers
Configures the source address for the session.
configure router bgp [] neighbor update-source cable remote-as
Configures the source address for the session.
configure router bgp [] neighbor update-source gigabitEthernet remote-as
Configures the source address for the session.
configure router bgp [] neighbor update-source gigabitethernet remote-as
15-14
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-2: List of Commands Related to BGP (Continued) Purpose
Command
Configures the source address for the session.
configure router bgp [] neighbor update-source ip-address remote-as
Route redistribution commands: Configures redistribute connected routes into BGP.
configure router bgp [] redistribute connected
Configures redistribution routes from Intermediate System-to-Intermediate System (IS-IS) routing processes configure router bgp [] redistribute isis [] [metric ] [route-map ] into a Border Gateway Protocol (BGP) autonomous system. Configures redistribution routes from OSPF routing processes into a Border Gateway Protocol (BGP) autonomous system.
configure router bgp [] redistribute ospf [match ] [metric ] [routemap ]
Configures redistribution routes from RIP routing processes into a Border Gateway Protocol (BGP) autonomous system.
configure router bgp [] redistribute rip
Configures redistribution routes from static routes into a Border Gateway Protocol (BGP) autonomous system.
configure router bgp [] redistribute static
Configures filtering for outbound BGP routes for the OSPF configure router bgp [] distribute-list out routing process. Configures filtering for outbound BGP routes for the RIP routing process.
configure router bgp [] distribute-list out rip
Configures filtering for outbound BGP routes for a static routing process.
configure router bgp [] distribute-list out static
Configures filtering for outbound BGP routes for BGP routes originating from a connected source.
configure router bgp [] distribute-list out connected
Configures filtering for outbound BGP routes for the IS-IS configure router bgp [] distribute-list out routing process. isis
Show commands: Displays the distribute-list information.
show distribute-list
Displays entries in the Border Gateway Protocol (BGP) routing table.
show ip bgp
Displays information about the TCP and Border Gateway Protocol (BGP) connections to neighbors.
show ip bgp neighbor []
Displays routes that are being advertised by BGP.
show ip bgp neighbor [] advertised-routes
Displays the advertised paths for routes identified.
show ip bgp neighbor [] advertised-routes paths
Displays routes matching the autonomous system path “regular expression.”
show ip bgp quote-regexp
Displays routes matching the autonomous system path “regular expression.”
show ip bgp regexp
Displays the status of all BGP connections.
show ip bgp summary
Displays the IP interfaces for the client modules.
show ip interface
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-15
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-2: List of Commands Related to BGP (Continued) Purpose
Command
Displays contents of prefix list table.
show ip protocols
Displays details of the active and inactive routes on all virtual routers in the CMTS.
show ip scm access
Displays route-map information.
show route-map
Sample Configuration Command Scripts for BGP The following three scripts are meant as examples only. They provide the command sequences for configuring BGP on the CMTS for operation with two neighbors, route reflection, or AS confederation, respectively. MSOs should customize BGP configuration to suit their own network environments and applications.
Basic Configuration for Two Neighbors
The following commands show the basic configuration for two neighbors:
configure router bgp 2 bgp router-id 128.96.52.147 configure router bgp 2 neighbor 128.96.50.2 remote-as 2 configure router bgp 2 neighbor 128.96.50.2 shutdown configure router bgp 2 neighbor 128.96.50.2 as-origin-interval 5 configure router bgp 2 neighbor 128.96.50.2 advertisement-interval 15 configure router bgp 2 neighbor 128.96.50.2 connect-retry 60 configure router bgp 2 neighbor 128.96.50.2 no shutdown configure router bgp 2 neighbor 128.96.51.3 remote-as 2 configure router bgp 2 neighbor 128.96.51.3 shutdown configure router bgp 2 neighbor 128.96.51.3 as-origin-interval 5 configure router bgp 2 neighbor 128.96.51.3 advertisement-interval 15 configure router bgp 2 neighbor 128.96.51.3 connect-retry 60
15-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
configure router bgp 2 neighbor 128.96.51.3 no shutdown configure router bgp 2 shutdown no
Sample Configuration of BGP with Route Reflection
The commands below are an example of configuring BGP with route reflection:
configure router bgp 2 bgp router-id 128.96.52.147 configure router bgp 2 bgp cluster-id 1.2.3.4 configure router bgp 2 aggregate-address 10.20.0.0 255.255.0.0 summary-only configure router bgp 2 neighbor 128.96.50.2 remote-as 2 configure router bgp 2 neighbor 128.96.50.2 as-origin-interval 5 configure router bgp 2 neighbor 128.96.50.2 advertisement-interval 15 configure router bgp 2 neighbor 128.96.50.2 connect-retry 60 configure router bgp 2 neighbor 128.96.50.2 no shutdown configure router bgp 2 neighbor 128.96.51.3 remote-as 2 configure router bgp 2 neighbor 128.96.51.3 as-origin-interval 5 configure router bgp 2 neighbor 128.96.51.3 advertisement-interval 15 configure router bgp 2 neighbor 128.96.51.3 route-reflector-client configure router bgp 2 neighbor 128.96.51.3 connect-retry 60 configure router bgp 2 neighbor 128.96.51.3 no shutdown configure router bgp 2 neighbor 128.96.52.4 remote-as 2 configure router bgp 2 neighbor 128.96.52.4 as-origin-interval 5 configure router bgp 2 neighbor 128.96.52.4 advertisement-interval 15 configure router bgp 2 neighbor 128.96.52.4 connect-retry 60 configure router bgp 2 neighbor 128.96.52.4 no shutdown
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-17
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
configure router bgp 2 shutdown no
Sample Configuration with AS Confederation
The commands below are an example of an Asynchronous System confederation configuration:
configure router bgp 2 bgp router-id 128.96.52.147 configure router bgp 2 bgp confederation identifier 600 configure router bgp 2 neighbor 128.96.50.2 remote-as 3 configure router bgp 2 neighbor 128.96.50.2 confed configure router bgp 2 neighbor 128.96.50.2 as-origin-interval 5 configure router bgp 2 neighbor 128.96.50.2 advertisement-interval 15 configure router bgp 2 neighbor 128.96.50.2 connect-retry 60 configure router bgp 2 neighbor 128.96.50.2 no shutdown configure router bgp 2 neighbor 128.96.51.3 remote-as 4 configure router bgp 2 neighbor 128.96.51.3 confed configure router bgp 2 neighbor 128.96.51.3 as-origin-interval 5 configure router bgp 2 neighbor 128.96.51.3 advertisement-interval 15 configure router bgp 2 neighbor 128.96.51.3 connect-retry 60 configure router bgp 2 neighbor 128.96.51.3 no shutdown configure router bgp 2 shutdown no
Sample Route Map configure route-map
The commands below are an example of a route map. CMTS-IN permit 10 match ip address prefix-list FILTER
#residential routes get 910:4000 configure route-map CMTS-ROUTES permit 20 match ip address prefix-list RESIDENTIAL
15-18
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
configure route-map
CMTS-ROUTES permit 20 set community 910:4000
#RIP routes get 910:6000 configure route-map
CMTS-ROUTES permit 60 match ip address prefix-list RIP
configure route-map
CMTS-ROUTES permit 60 set community 910:6000
#CM routes get 910:8001 configure route-map
CMTS-ROUTES permit 70 match ip address prefix-list CM
configure route-map
CMTS-ROUTES permit 70 set community 910:8001
#CSVOIP routes get 910:5000 and 910:6000 configure route-map
CMTS-ROUTES permit 80 match ip address prefix-list CSVOIP
configure route-map
CMTS-ROUTES permit 80 set community 910:5000
configure route-map
CMTS-ROUTES permit 80 continue 90
#all other routes get 910:6000 configure route-map
Issue 2.0
CMTS-ROUTES permit 90 set community 910:6000
ARRIS PROPRIETARY — All Rights Reserved
15-19
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Intermediate System-Intermediate System (IS-IS) Overview IS-IS is a routing protocol developed by the ISO. In this link-state protocol, IS routers exchange routing information based on a single metric to determine network topology. It is similar to Open Shortest Path First (OSPF) in the TCP/IP network. The C4/C4c CMTSs support: •
both IPv4 and IPv6
•
Q-tags with IS-IS traffic for both IPv4 and IPv6
•
approximately 30,000 IPv4 routes or 10,000 IPv6 routes in the IS-IS populated routing table.
NOTE IS-IS runs only on the default VRF. This version of IS-IS does not support multiple VRFs. Abbreviations
ACL — Access Control List AFI — Authority & Format Identifier AS — Autonomous System CLNP — Connectionless Network Protocol CSNP — Complete Sequence Number Packet DIS — Designated Intermediate System ECMP — Equal Cost Multi-Path ES-IS — End System to Intermediate System (not supported) FIB — Forwarding Information Base IGP — Interior Gateway Protocol IIH — Intermediate System to Intermediate System Hello packet IS-IS — Intermediate System to Intermediate System ITU — International Telecommunications Union
15-20
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
LLC — Logical Link Control LSP — Link State Packet (IS-IS) LSA — Link State Advertisement (OSPF) MT ID — MT ID is a 12-bit field containing the ID of the topology being announced. MTU — Maximum Transmission Unit OSI — Open System Interconnection NSEL — NSAP Selector NSAP — Network Service Access Point PDU — Protocol Data Unit PSNP — Partial Sequence Number Packet RIB — Routing Information Base RTM — Route Table Manager SPF — Shortest Path First SNP — Sequence Number Packet VRF — Virtual Routing and Forwarding TLV — Type Length Value
CLNP Addressing/NSAP Address Format The CLNP node-based addressing scheme is one of the concepts retained for use in advertising IP networks. CLNP network addressing is mandatory on IP routers and therefore both CLNP and IP addresses need to be provisioned on the CMTS. The CLNP address is analogous to an IP loopback interface in so far as it is node-based versus interface-based. As such, a single CLNP address suffices per IS-IS node, within a specific IS-IS area. Each CLNP (NSAP) address is composed of three parts: an area identifier (area ID) prefix, followed by a system identifier (SysID), and an Nselector. A group of routers within a specific area shares the same area ID. IS-IS routers may be multi-homed, implying they reside in multiple Level 1 areas (or Level 2 backbone) and therefore require multiple NSAP addresses. Since IS-IS is an IGP, the NSAP addressing scheme need not be globally unique and private IP addresses may be defined within an AS.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-21
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
IS-IS Network Topology, Unique Level 1 Areas IS-IS defines a multi-layered hierarchy called Level 1 and Level 2 routing. Level 1 routers belong to a common area and are engaged in level one routing. These routers are aware of their local topology only and require Level 2 routers to communicate inter-area routing information. In practice, most Level 2 routers are also Level 1 routers; that is, they serve a local area and connect to the IS-IS backbone. Figure 15-3 depicts an IS-IS two-level network topology with both NSAP and IP addressing. NSAP addresses are based on the defined IP loopback addresses and must be manually provisioned as such. Each router in a Level 1 area builds an area unique LSP database with its peers. Disjointed Level 1 areas must be joined together via a Level 2 (backbone) area.
IS-IS Backbone Level 2 Routing
R1 Level 2 adjacency only
R3 IP Address(loopback): 192,168.1.23 NSAP: 49.0001.1921.6800.1023.00
IP Address(loopback): 192,168.3.23 NSAP: 49.0003.1921.6800.3023.00
R2 Level 1, Level 2 Adjacencies
IP Address(loopback): 192,168.2.23 NSAP: 49.0002.1921.6800.2023.00
IS-IS Area 1 Level 1 (intra-area) Routing R4 Level 1 adjacency only
IP Host
IS-ISArea Area22 IS-IS Level1 1(intra-area) (inta-area) Level Routing Routing
IP Address(loopback): 192,168.1.24 NSAP: 49.0001.1921.6800.1024.00
R5 Level 1 adjacency only
IP Address(loopback): 192,168.2.24 NSAP: 49.0002.1921.6800.2024.00
IP Host IP Host
IP Host
Figure 15-3: IS-IS Level 1 and Level 2 Routing
15-22
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
By default, Level 1 areas are considered “stub” areas because they rely on a default route to forward traffic out of the area. However, route leaking from Level 2 and Level 1 areas allows for more intelligent inter-area routing. In Figure 15-3 IP hosts are not assigned NSAP addresses and do not in any way participate in IS-IS routing. Adjacencies formed are based on interface circuit-type (either Level 1, Level 2, or both) and the provisioned area ID in the NSAP address. Note: the circuit-type is encoded in the IIH packet. Figure 15-3 defines the following adjacencies: •
Router R1: Circuits are Level 2 only since the router resides completely in a Level 2 area. R1 will form Level 2 adjacencies with R2 and R3.
•
Routers R2 and R3: These routers are considered Border routers since north-bound circuits are defined as Level 2, and south-bound circuits are defined as Level 1. R2 defines adjacencies with R1 and R5 while R3 defines adjacencies with R1 and R4.
•
Routers R4 and R5: Circuits may be defined as Level 1 only since these are edge routers connected to the IS-IS backbone.
Dynamic Hostname Support The CMTS will support use of the dynamic hostname in IS-IS link state packets (LSPs). As described in RFC 5301, the CMTS will support the use of TLV 137 to communicate its hostname and receive hostname updates from peer routers. In the IS-IS routing domain, a system ID is used to represent each router. The system ID is part of the network entity title that is configured for each IS-IS router. The dynamic hostname mechanism uses link-state protocol (LSP) flooding to distribute the router-name-to-system-ID mapping information across the entire network. Every router on the network will try to install the system ID-to-router name mapping information in its routing table. If a router that has been advertising the dynamic name type, length, value (TLV) on the network suddenly stops the advertisement, the mapping information last received will remain in the dynamic host mapping table for up to one hour, allowing the network administrator to display the entries in the mapping entry during a time when the network experiences problems. Entering the show isis hostname command displays the entries in the system-ID-to-router-name mapping table.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-23
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
IS-IS Network Topology — Multi-homing Multi-homing is the ability to define multiple NSAP addresses, one per area. Effectively, multi-homing merges multiple IS-IS areas into one large unified area. The LSP database thus becomes unified across the individual Level 1 areas. It should be noted that IS-IS multi-homing is not analogous to the IP concept of sub-interfaces with multiple secondary IP addresses. IP multi-homing implies that multiple logical subnets can be defined on the same physical link. The primary purpose of IS-IS multi-homing is to merge otherwise disparate Level 1 areas. Multi-homing provides the benefit of not having to take down an IS-IS network during as NSAP address renumbering, IS-IS area merging, or IS-IS splitting.
Packet Flow between IS-IS Systems IS-IS defines three packet type categories, similar to that defined in OSPF: Hello packets, Link State packets, and Sequence Number packets. As is the case with OSPF, Hello packets are used to establish and maintain adjacencies between directly connected IS-IS neighbors. Link State packets are used to distribute the actual IP routing information and Sequence Number packets control the distribution of Link State packets to allow for correct synchronization of the Link State database.
Designated Intermediate System (DIS) and Reliable Flooding of LSPs The DIS is sometime referred to as the Pseudonode, which is an abstraction for representing broadcast links as network nodes. This reduces the amount of router-to-router communications on a broadcast network and as a consequence, reduces the amount of information (IS-IS PDUs) that is exchanged when multiple nodes interconnect on a LAN. The election of the DIS is based on interface priority and, as a tie breaker, the MAC address used to encapsulate the Hello packet. As is the case with OSPF, the DIS plays the critical role of LSP flooding; however it should be noted that unlike OSPF, there does not exist the concept of a backup DIS (known in OSPF nomenclature as a BDR). If the DIS becomes unavailable, then DIS election must be restarted. To help mitigate a DIS outage, the hello interval for DIS routers is set at three times the rate of non-DIS routers. This scheme allows for quick detection of DIS failures and replacement. In addition to flooding responsibilities, the DIS will advertise a pseudonode LSP, which represents the broadcast link itself. This LSP has a zero cost and allows for communication on the broadcast link between individual non-DIS routers. The DIS router is not guaranteed to remain the DIS if a
15-24
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
15 Dynamic Routing Protocols
new router with a higher priority shows up on the LAN; likewise, there is no mechanism for making a router ineligible for DIS operation. IS-IS peers are said to be adjacent after Hello packets are exchanged but before the LSP database synchronization is complete. This differs from OSPF, and may cause transient routing problems when adjacent routers do not have a complete forwarding table representing routes within the ISIS domain. Use of the LSP overload bit can help solve this issue by informing adjacent routers that traffic should not be sent to a router whose LSP overload bit is set. On broadcast links, periodic flooding by all IS-IS nodes is used to ensure that adjacent peers maintain a consistent view of the LSP database for a particular IS-IS Domain. That is, all IS-IS nodes broadcast their LSPs to all attached devices. These flooded LSPs are not acknowledged and require support from the DIS to maintain a consistent view of the LSP database. To help support reliable flooding of LSPs, the DIS periodically sends out a CSNP that contains a summary of every known LSP within the IS-IS domain. To purge a LSP from the IS-IS domain, the remaining lifetime field is set to 0, and the LSP is flooded throughout the network. Only the originator of the LSP may purge it from the domain.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-25
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Multiple Topology IS-IS (MT IS-IS) Overview This section describes how the CMTS will implement MT IS-IS based on RFC 5120. While the feature fixes the limitations of the current IS-IS IPv6 implementation and maintains the current IS-IS IPv6 functionalities, the CMTS software will support only two topologies in Release 8.0: a topology for IPv6 and a common topology for IPv4. IS-IS for IPv6 was implemented in Release 7.4 (per RFC 5308 - Routing IPv6 with IS-IS). IS-IS could be configured as IPv4 only, IPv6 only or IPv4IPv6 only but only a single SPF (Shortest Path First) would run per level for IPv4 or IPv6. To overcome the single SPF limitation, MT IS-IS is being implemented in the CMTS. When MT IS-IS is enabled, the CMTS will maintain multiple instances of the IS-IS routing tree and will run two separate SPFs — one for standard topology IPv4 and the other for IPv6 topology.
Area 2
Area 1
IPv4 only IPv4-IPv6
Figure 15-4: Example of IS-IS and MT IS-IS Topologies In Figure 15-4, Router B in Area 1 is IPv4 only and all other routers are IPv4-IPv6. If MT IS-IS is not enabled, the best path from A to D is A -> B -> C -> D but any IPv6 traffic from A -> D would be lost in Router B. When MT IS-IS is enabled, two separate SPFs will run and maintain two separate topologies — IPv4 and IPv6. As a result, the best IPv4 path from A to D is A -> B -> C -> D and the best IPv6 path from A to D would be A -> E -> F -> C -> D.
15-26
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Adjacencies Users need to know what they are running, IPv4 or IPv6, in order for the adjacency to be included in the correct topology. If the interface only supports the IPv4 topology, the CMTS will not use the new MT TLV in the IS-IS Hello packet and it will not be advertised in the new TLV. Thus, the exclusion of MT TLV in the IIH implies that this interface is only part of the IPv4 topology.
Broadcast Interface Adjacencies All the routers on a LAN that implement the MT extension may advertise their MT capability TLV in their IIHs. If there is at least one adjacency on the LAN interface that belongs to this MT capable router, the corresponding MT IS Reachable TLV will be included in its LSP. Adjacency will always be established between two routers on a LAN whether they have a common MT or not. This guarantees that all the routers on the LAN can correctly elect the same DIS. If the CMTS receives an LSP from another router with an unsupported MT, the LSP will be installed into the database but no routes will be calculated using that LSP.
Advertising MT Reachable Intermediate Systems in LSPs The CMTS will include within its LSPs (in the Reachable Intermediate TLVonly) adjacent nodes that are participating in the corresponding topology and advertise such TLVs only if it participates itself in the corresponding topology. There is no change to the pseudo-node LSP construction. The Standard Reachable Intermediate Systems TLV is acting here as MT IPv4 (ID #0), the equivalent of the newly introduced MT Reachable Intermediate Systems TLV. A router must announce the MT IS TLV when there is at least one adjacency on the interface that belongs to this MT, otherwise it may announce the MT IS TLV of an adjacency for a given MT if this interface participates in the LAN. To display the current configuration, use the show isis database detail command.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-27
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
MT IP Forwarding The CMTS will support MT IPv4 (ID #0) and MT IPv6 (ID #2) on the same interface. Each MT belongs to a Distinct Address Family and routes learned within that topology will be installed in a separate RIB. The RIB associated with MT IPv4 (ID#0) is the default IPv4 VRF. To display all active IPv4 routes in this RIB, use the show ip route isis command. To display all active IPv6 routes in the RIB associated with the IPv6 (MT#2), use the show ipv6 route isis command.
Configuring MT IS-IS on the CMTS There are only two new commands introduced as part of the MT IS-IS implementation. Procedure 15-1 is used to enable or disable MT IS-IS. The second, Procedure 15-2, is needed only if the default IS-IS IPv6 metric of 10 needs to be changed.
Procedure 15-1
Use the following procedure to enable/disable MT IS-IS on the CMTS NOTE IS-IS must be disabled at the system level before enabling or disabling MT. To enable MT IS-IS, use the following steps: 1 Disable IS-IS at the system level with the following command:
C4#configure router isis shutdown 2 Enable MT IS-IS on the CMTS: C4#configure router isis address-family ipv6 multi-topology 3 Once MT IS-IS has been enabled, IS-IS can once again be enabled with the following command: C4#configure router isis shutdown no
To disable MT IS-IS, use the following steps:
15-28
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
1 IS-IS must again be disabled at the system level before disabling MT ISIS. Use the following command: C4#configure router isis shutdown 2 Disable MT IS-IS using the following command: C4#configure router isis address-family ipv6 multi-topology no 3 Once MT IS-IS has been disabled, IS-IS can once again be enabled with the following command: C4#configure router isis shutdown no End of procedure
Procedure 15-2
Change the Default Metric 1 Use the following command only if the default metric needs to be changed. To return to the default metric of 10, use the [no] parameter.
configure interface gigabitethernet 17/1 isis ipv6 metric [level-1 | level-2] [no] End of procedure
Sample Configuration The following sample configuration shows a CMTS directly connected to another router – The following information is from the C4 CMTS: C4# show running-config verbose interface gigabitEthernet 17/9 configure interface gigabitEthernet 17/9 no shutdown configure interface gigabitEthernet 17/9.0 ip address 10.85.9.2 255.255.255.0 configure interface gigabitEthernet 17/9.0 ipv6 enable configure interface gigabitEthernet 17/9.0 ipv6 address fc00:cada:c435:1709::2/64 configure interface gigabitEthernet 17/9.0 ip router isis configure interface gigabitEthernet 17/9.0 ipv6 router isis
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-29
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
configure interface gigabitEthernet 17/9.0 isis protocol no shutdown configure interface gigabitEthernet 17/9.0 ipv6 no nd ra suppress The following information is also from the C4 CMTS: C4# show running-config verbose | begin router isis configure router isis net 47.0001.0100.8500.9002.00 configure router isis metric-style wide level-1-2 configure router isis address-family ipv4 enable configure router isis address-family ipv6 multi-topology configure router isis address-family ipv6 redistribute connected level-2 configure router isis address-family ipv6 enable configure router isis no shutdown The following information is from the next-hop router: TR11#show running-config interface gigabitEthernet 2/20 Building configuration... Current configuration : 282 bytes ! interface GigabitEthernet 2/20 description C4-35,port 17/9 ip address 10.85.9.1 255.255.255.0 ip router isis ipv6 address FC00:CADA:C435:1709::1/64 ipv6 router isis end The following information is also from the next-hop router: TR11#show running-config | router isis router isis net 47.0001.0100.8500.9001.00 metric-style wide no hello padding
15-30
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
15 Dynamic Routing Protocols
log-adjacency-changes redistribute connected redistribute static ip ! address-family ipv6 multi-topology redistribute static exit-address-family !
Show commands The following section contains a group of commands most commonly used to display MT IS-IS information. To display the IS-IS neighbor output including the remote router’s MT setting, use the following command: C4#show isis neighbor The system output would look similar to the following: Sys Adj System ID Interface SNPA State Hold Type Type Circuit Id Protocol -------------- ---------------------- -------------- ----- ----- ---- ---- ------------------- -------0100.8500.9001 gigabitEthernet 17/9.0 000b.45b6.0100 Up 9 L1/2 L1 TR11.01 M-ISIS 0100.8500.9001 gigabitEthernet 17/9.0 000b.45b6.0100 Up 9 L1/2 L2 TR11.01 M-ISIS
NOTE If the connected router does not support MT IS-IS, the protocol will display IS-IS in the above output. If the neighbor row says ‘IS-IS’, it only indicates that the remote IS is using regular IS-IS TLVs on that interface. The CMTS can still send MT TLVs based on its own system/interface configuration. The CMTSs MT support can be verified using the show isis protocol command. If you are not seeing IPv6 routes and you think you should, then an inconsistent configuration between the C4 CMTS and the northern router may be the cause.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-31
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
To display the multi-topology system status, use the following command: C4#show isis protocol The system display will look similar to the following: IS-IS Router: default IS-IS routing Enabled IS-IS multi-topology Enabled System ID: 0100.6000.0002 IS-Type: level-1 Max LSP Lifetime: 1200 seconds Max time to delay after LSP event: 5000 milliseconds Override the routing calculation delay when the number of updates reach: infinite Routing calculation is to be paused: 10000 times Manual area address(es): 47.0001 Interfaces supported by IS-IS: gigabitEthernet 17/0
- IP - IPv6
level-L1
gigabitEthernet 18/0
- IP - IPv6
level-L1
Administrative distances: Internal level-1: 115 Internal level-2: 116 External level-1: 117 External level-2: 118 Metrics: Level-1 generates: wide Level-1 accepts:
wide
Level-2 generates: wide Level-2 accepts:
15-32
wide
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
To display the IS-IS neighbor detail output which includes both the remote router’s protocol (M-ISIS or IS-IS) and the remote router’s topologies (IPv4 and IPv6), use the following command: C4#show isis neighbor detail The system output would look similar to the following: System ID Interface SNPA State Hold Type Type Circuit Id -------------- --------------------- ------------- ----- ---- ---- ---- ---------------0100.8500.9001 gigabitEthernet 17/9 000b.45b6.0100 Up 9 L1/2 L1 TR11.01 Area Address(es): 47.0001 IP Address(es): 10.60.0.1 IPv6 Address(es): fe80::215:15ff:fe15:1177 Uptime: 0 days 00:49:52 Priority: 64 Support restart signalling: Yes Restart state: Not Restarting Adjacency suppressed: No Topology: IPv4, IPv6
Protocol --------M-ISIS
NOTE If the only “IS-IS” is displayed in the Protocol column above, this command will not display the Topology. This line was added in Release 8.0 to display MT IS-IS functionality. Using the command show isis database detail (where in this example is the LSP PDU identifier “TR11.00-06”) to display the IS-IS database detail, including the MT extensions, use the following command: C4# show isis database detail TR11.00-06 The system output would look similar to the following: IS-IS Level-2 Link State Database LSPID -------------------TR11.00-06 Metric: 0 Metric: 0 Metric: 0 Metric: 10
LSP Seq Num ----------0x000001BF IPv6 (MT-IPv6) IPv6 (MT-IPv6) IPv6 (MT-IPv6) IPv6 (MT-IPv6)
LSP Checksum ------------
LSP Holdtime ------------
0xF0E8 602 2001:1111:2222:3333:/64 2001:1234:0:3:/64 2001:1234:0:4:/64 2002:2001:3001:3002:/64
ATT/P/OL -------0/0/0
To display the IPv4 IS-IS route information, use the following command: C4#show ip route isis
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-33
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
The system output would look similar to the following: Codes:
(L1) internal level-1, (S) summary, (I) internal,
(L2) internal level-2, (IA) internal area, (E) external
(eL1) external level-1, (E1) external type-1,
(eL2) external level-2 (E2) external type-2
VRF Name IP Route Dest. Act PSt Next Hop Metric Protocol Dist Route Age Interface =============== ================== === === =============== ====== ======== ==== ============ ========= default 3.3.3.0/24 Yes IS 10.85.9.1 30 isis(L1) 115 0 00:11:39 gigE 17/9.0 default 4.4.4.0/24 Yes IS 10.85.9.1 30 isis(L1) 115 0 00:11:39 gigE 17/9.0
By adding the “ipv6” parameter to the command, the IPv6 IS-IS route information will be displayed: C4# show ipv6 route isis The system output would look similar to the following: Codes:
(L1) internal level-1, (eL2) external level-2 (E1) external type-1, (E) external ACT Active-IS,
IPv6 Route Dest / mask ====================== ::/0 2001:1111:2222:3333/64 2001:1234:0:3::/64 2001:1234:0:4::/64 2002:2001:3001:3002/64
Act === ACT ACT ACT ACT ACT
(L2) internal level-2, (S) summary, (E2) external type-2,
(eL1) external level-1, (IA) inter-area, (I) internal,
IS Inactive-IS,
OOS Inactive-OOS Dist/ Next Hop Metric Protocol ============================== ======= ========= fc00:cada:c435:1700::1 1/0 netmgmt fe80::20b:45ff:feb6:100 115/20 isis(L1) fe80::20b:45ff:feb6:100 116/10 isis(L2) fe80::20b:45ff:feb6:100 116/10 isis(L2) fe80::20b:45ff:feb6:100 115/20 isis(L1)
RouteAge ======== 00:13:46 00:10:52 00:08:07 00:08:07 00:10:52
Interface ========== gigE 17/0.0 gigE 17/9.0 gigE 17/9.0 gigE 17/9.0 gigE 17/9.0
CLI Commands Below is a table listing many of the CLI commands that you will use in configuring and using both MT IPv4 (ID #0) and MT IPv6 (ID #2) routing. The easiest way to look up an individual command is to use the List of CLI Commands. Command entries are listed alphabetically and are linked to their descriptions in the CLI command reference chapter, CLI Command Descriptions.
15-34
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
CLI Commands for IS-IS and MT IS-IS Table 15-3: List of Commands Related to IS-IS and MT IS-IS Purpose
Command
Clears the IS-IS counters.
clear isis counters configure interface cable ip router isis [no] configure interface cable ipv6 router isis [no] configure interface cable-mac ip router isis [no] configure interface cable-mac ipv6 router isis [no]
Enables [disables] IS-IS routing for IPv4 / IPv6 on the specified interface.
configure interface loopbacka ip router isis [no] configure interface loopbacka ipv6 router isis [no] configure interface gigabitEthernet ip router isis [no] configure interface gigabitEthernet ipv6 router isis [no] configure interface tenGigabitEthernet ip router isis [no] configure interface tenGigabitEthernet ipv6 router isis [no] configure interface cable isis authentication key-chain [no] configure interface cable-mac isis authentication key-chain [no]
Configures the IS-IS authentication for LSPs.
configure interface gigabitEthernet isis authentication key-chain [no] configure interface tenGigabitEthernet isis authentication key-chain [no] configure interface cable isis authentication mode [no] configure interface cable-mac isis authentication mode [no]
Configures the IS-IS authentication mode for LSPs.
configure interface gigabitEthernet isis authentication mode [no] configure interface tenGigabitEthernet isis authentication mode [no]
Configures the level of adjacency for the specified interface. The Level 1 adjacency may be established if there is at least one area address in common between this system and its neighbors.
configure interface cable isis circuit-type [no] configure interface cable-mac isis circuit-type [no] configure interface gigabitEthernet isis circuit-type [no] configure interface tenGigabitEthernet isis circuit-type [no]
Configures the complete sequence number PDUs (CSNPs) interval for the specified interface. This command only applies to the designated router on the specified interface.
configure interface cable isis csnp-interval [no] configure interface cable-mac isis csnp-interval [no] configure interface gigabitEthernet csnp hello-interval [no] configure interface tenGigabitEthernet isis csnp-interval [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-35
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-3: List of Commands Related to IS-IS and MT IS-IS (Continued) Purpose
Command configure interface cable isis ds-hello-interval [no]
configure interface cable-mac isis ds-hello-interval [no] Configures the length of time in milliseconds between hello packets for the configure interface gigabitEthernet isis ds-hello-interval [no] specified interface when it is DIS. configure interface tenGigabitEthernet isis ds-hello-interval [no] configure interface cable isis hello-interval [no] Computes the hello interval based on the hello multiplier so that the resulting hold time is 1 second.
configure interface cable-mac isis hello-interval [no] configure interface gigabitEthernet isis hello-interval [no] configure interface tenGigabitEthernet isis hello-interval [no] configure interface cable isis hello-interval minimal
Computes the hello interval based on the hello multiplier so that the resulting hold time is 1 second.
configure interface cable-mac isis hello-interval minimal configure interface gigabitEthernet isis hello-interval minimal configure interface tenGigabitEthernet isis hello-interval minimal
Configures the number of IS-IS hello packets a neighbor must miss before the router declares the neighbor to be down on the specified interface. This time determines how quickly a failed neighbor is detected so that routes can be recalculated.
configure interface cable isis hello-multiplier [no] configure interface cable-mac isis hello-multiplier [no] configure interface gigabitEthernet isis hello-multiplier [no] configure interface tenGigabitEthernet isis hello-multiplier [no] configure interface cable isis lsp-interval [no]
Configures the time delay between successive LSPs for the specified interface.
configure interface cable-mac isis lsp-interval [no] configure interface gigabitEthernet isis lsp-interval [no] configure interface tenGigabitEthernet isis lsp-interval [no] configure interface cable isis lsp-mtu [no]
Configures the maximum packet size of LSPs for the specified interface.
configure interface cable-mac isis lsp-mtu [no] configure interface gigabitEthernet isis lsp-mtu [no] configure interface tenGigabitEthernet isis lsp-mtu [no]
15-36
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-3: List of Commands Related to IS-IS and MT IS-IS (Continued) Purpose
Command configure interface cable isis metric [no] configure interface cable-mac isis metric [no]
Configures the default metric for the specified interface.
configure interface loopbacka isis metric [no] configure interface gigabitEthernet isis metric [no] configure interface tenGigabitEthernet isis metric [no]
Configures the metric for the MT #2 IPv6 topology. Configures the priority of the designated routers for the specified interface. The priority is used to determine which router on a LAN will be the designated router. The priorities are advertised in the hello packets. The router with the highest priority will become the Designated Intermediate System (DIS). In the case of equal priorities, the highest MAC address breaks the tie.
configure interface gigabitEthernet isis ipv6 metric [no]
configure interface cable isis priority [no] configure interface cable-mac isis priority [no] configure interface gigabitEthernet isis priority [no] configure interface tenGigabitEthernet isis priority [no]
configure interface cable isis protocol shutdown [no] configure interface cable-mac isis protocol shutdown [no] configure interface loopbacka isis protocol shutdown [no]
Disables [enables] the administrative state of IS-IS on the specified interface.
configure interface gigabitEthernet isis protocol shutdown [no] configure interface tenGigabitEthernet isis protocol shutdown [no]
Configures the maximum rate between LSP retransmissions for the specified interface. This command is useful in very large networks with many LSPs and many interfaces to control LSP retransmission traffic. This command controls the rate at which LSPs can be resent on the interface.
configure interface cable isis retransmit-interval [no] configure interface cable-mac isis retransmit-interval [no] configure interface gigabitEthernet isis retransmit-interval [no] configure interface tenGigabitEthernet isis retransmit-interval [no] configure interface cable isis small-hello [no]
Allows unpadded small hello packets for the specified interface.
configure interface cable-mac isis small-hello [no] configure interface gigabitEthernet isis small-hello [no] configure interface tenGigabitEthernet isis small-hello [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-37
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-3: List of Commands Related to IS-IS and MT IS-IS (Continued) Purpose
Command configure interface cable isis wide-metric [no] configure interface cable-mac isis wide-metric [no]
Allows wide metrics for the specified interface.
configure interface loopbacka isis wide-metric [no] configure interface gigabitEthernet isis wide-metric [no] configure interface tenGigabitEthernet isis wide-metric [no]
Configures filtering for outbound BGP routes on the specified VRF for the ISIS routing process.
configure router bgp [] distribute-list out isis
Configures redistribution of routes from Intermediate System-to-Intermediate System (IS-IS) routing processes into a Border Gateway Protocol (BGP) autonomous system.
configure router bgp [] redistribute isis
Places the system into an intermediate mode. NOTE: Use the NO command to remove all the IS-IS configuration.
configure router isis [no]
Allows user to enter CLI address family IPv4 mode.
configure router isis address-family ipv4
Enables IS-IS routing for IP on the router level
configure router isis address-family ipv4 enable [no]
Allows user to enter CLI address family IPv6 mode.
configure router isis address-family ipv6
Enables IS-IS routing for IPv6 on the router level
configure router isis address-family ipv6 enable [no]
Configures the router IS-IS authentication configure router isis authentication key-chain [no] key-chain. Configures the router IS-IS authentication configure router isis authentication mode [no] mode. Configures administrative distance for ISconfigure router isis distance [no] IS routes. Configures administrative distance for subsets of the IS-IS routes in the same VRF.
configure router isis distance isis [no]
Configures filtering for outbound IS-IS routes in the same VRF.
configure router isis distribute-list out [no]
Configures the number of equal costs routes.
configure router isis ecmp [no]
Modifies the graceful-restart parameters for IS-IS to help the peer to restart.
configure router isis graceful-restart help-peer [no]
15-38
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-3: List of Commands Related to IS-IS and MT IS-IS (Continued) Purpose
Command
Modifies the graceful-restart parameters for IS-IS to wait the specified time to establish adjacencies before completing the start/restart. Use the second command to negate the wait time.
configure router isis graceful-restart interface wait configure router isis graceful-restart interface [no]
Modifies the graceful-restart parameters for IS-IS for the maximum time before completing the restart procedures.
configure router isis graceful-restart t3 [no]
Configures the routing level.
configure router isis is-type [no]
Configures the generation rate of the LSPs.
configure router isis lsp-gen-interval [no]
Configures the link-state-packet (LSP) refresh interval.
configure router isis lsp-refresh-interval [no]
Configures the maximum time that linkstate-packets (LSPs) can remain in a router’s database without being refreshed.
configure router isis max-lsp-lifetime [no]
Configures the type of metric the CMTS will generate or accept.
configure router isis metric-style
Configures an IS-IS network entity title (NET). NETs define the area addresses for configure router isis net [no] the IS-IS area and the system ID of the router. configure router isis passive-interface cable [no] configure router isis passive-interface cable-mac [no] Suppresses routing updates on the specified interface.
configure router isis passive-interface gigabitEthernet [no] configure router isis passive-interface loopbacka [no] configure router isis passive-interface tenGigabitEthernet [no]
Redistributes BGP routes into IS-IS.
configure router isis redistribute bgp [no]
The second command is 7.x syntax.
configure router isis address-family ipv4 redistribute bgp [no]
Redistributes connected routes into IS-IS. configure router isis redistribute connected [no] The second command is 7.x syntax.
configure router isis address-family ipv4 redistribute connected [no]
Redistributes connected IPv6 routes into IS-IS.
configure router isis address-family ipv6 redistribute connected [no]
Redistributes OSPF routes into IS-IS.
configure router isis redistribute ospf [no]
The second command is 7.x syntax.
configure router isis address-family ipv4 redistribute ospf [no]
Redistributes RIP routes into IS-IS.
configure router isis redistribute rip [no]
The second command is 7.x syntax.
configure router isis address-family ipv4 redistribute rip [no]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-39
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-3: List of Commands Related to IS-IS and MT IS-IS (Continued) Purpose
Command
Redistributes static routes into IS-IS.
configure router isis redistribute static [no]
The second command is 7.x syntax.
configure router isis address-family ipv4 redistribute static [no]
Redistributes IPv6 static routes into IS-IS. configure router isis address-family ipv6 redistribute static [no] Turns on [off] Multi-topology IS-IS
configure router isis multi-topology [no]
To configure the router to signal other routers not to use it as an intermediate hop in their shortest path first (SPF) calculations, use the set-overload-bit command in router configuration mode. It configure router isis set-overload-bit will cause to originate LSPs with the Overload bit set. This bit will be set if the level-1 or level-2 database is running short of a resource such as memory. Disables the administrative state of IS-IS. configure router isis shutdown Configures the IS-IS throttling of shortest path first (SPF) calculations.
configure router isis spf-interval [no]
Change aggregate addresses for the VRF. configure router isis summary-address [no] The second command is 7.x syntax.
configure router isis address-family ipv4 summary-address [no]
Change aggregate IPv6 addresses for the VRF.
configure router isis address-family ipv6 summary-prefix [no]
Configures filtering for outbound OSPF routes on the specified VRF for the IS-IS routing process.
configure router ospf [vrf ] distribute-list out isis [no]
Configures redistribution routes from Intermediate System-to-Intermediate System (IS-IS) routing processes into OSPF.
configure router ospf [vrf ] redistribute isis [no]
Configures filtering for outbound RIP routes on the specified VRF for the IS-IS routing process.
configure router rip [vrf ] distribute list out isis [no]
Configures redistribution routes from ISIS routing processes into RIP.
configure router rip [] [vrf ] redistribute isis [no]
Displays the IS-IS redistribution information.
show distribute-list
Displays the IS-IS IPv4 / IPv6 redistribution information.
show ip isis
Displays the IPv4 / IPv6 IS-IS route information.
show ip route isis
show ipv6 isis
show ipv6 route isis
Displays IS-IS link state database for the specified VRF.
show isis database
Displays IS-IS interface status and configuration for the specified VRF.
show isis interface
15-40
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Table 15-3: List of Commands Related to IS-IS and MT IS-IS (Continued) Purpose
Command
Displays IS-IS events specific to a circuit and level for the specified VRF.
show isis interface events
Displays CLNS neighbor adjacencies for the specified VRF.
show isis neighbor [detail]
Displays CLNS protocol information for the show isis protocol specified VRF. Displays IS-IS protocol statistics for the specified VRF.
show isis traffic
Enables tracing of IS-IS router events to the logging history.
trace logging router isis [no]
a. The loopback interface is always passive.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-41
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Open Shortest Path First (OSPF) OSPF is a dynamic link state routing protocol developed by the Internet Engineering Task Force (IETF). OSPF: •
Supports Classless Inter-Domain Routing (CIDR)
•
Provides for routing update authentication, both simple and MD5
•
Uses IP multicast when sending/receiving the updates
•
Responds quickly to topology changes with a smaller amount of routing protocol traffic.
The OSPF specification is published as Request For Comments (RFC) 2328. Link State Routing Protocol Description
The OSPF routing protocol maintains a link state database of all subnets available on the network. This includes details about which routers are attached to the links. If a link goes down, the router that is directly attached to it immediately sends a Link State Advertisement (LSA) to its neighbor routers. Information about the link state propagates throughout the network. Each router reviews its database and re-calculates the routing table independently.
Routing Metrics
A router learns multiple paths to a particular destination network and chooses the path with the best metric in its routing table. Different routing protocols use different types of metrics. Rather than counting the number of hops as a metric, OSPF bases its path descriptions on link states that take into account additional network information. OSPF also lets the user assign cost metrics to each interface so that some paths are given preference. OSPF uses a user-defined cost for each interface. This cost is added together for each hop when calculating the cost of a route. This metric could be the same as number of hops if each interface along the route uses a cost of 1. The cost of the route displayed by the show ip route command is the sum of the interface costs.
ECMP
OSPF also has the concept of ECMP (Equal Cost MultiPath) routes. These are routes to the same dest IP (destination IP address) and prefix which use different next hop IPs but the same cost. The CMTS can distribute packets across at most four ECMP routes. ECMP routes can also be used with static routes. The CMTS bases its choice of best route first on longest prefix, then route type (local, netmgmt, OSPF, RIP), and finally on route cost.
15-42
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Configuring OSPF This section outlines the tasks required to configure a network and CMTS for OSPF. The procedures and commands in this section assume that IP addresses have already been configured for the network and OSPF interfaces. The sequence includes: 1 Reviewing a network diagram for interface information and architecture. 2 Enabling OSPF globally. 3 Configuring the network according to standard configuration parameters: set router id, hello timer, dead timer, network type (broadcast, point-topoint, virtual link), and authentication. 4 Verifying OSPF is running as configured. It is beyond the scope of this User Guide to supply recommendations for reviewing network architecture for all OSPF configuration possibilities; however, the following sections identify the CLI commands required for basic OSPF configuration on the CMTS.
Procedure 15-3
How to Enable OSPF Use this procedure to enable OSPF on the CMTS: 1 Enter the following command to give the default router an identification number: configure router ospf vrf default router-id 1.1.1.1 Where: 1.1.1.1 is the router ID 2 By default, OSPF is disabled on the CMTS. Enter the following command to enable OSPF: configure router ospf vrf default no shutdown There is no system response if the command is successful. This is a “silent success” command. 3 By default, OSPF is disabled for all interfaces. Enabling OSPF for an interface does not affect the global enable/disable state on the CMTS. Enter the following command to enable OSPF for an interface: configure router ospf [vrf default] network area
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-43
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Where: and can be specified as either a decimal value or as an IP address. The inverse mask is also called the wildcard mask. 4 Enter the following command to advertise routes for the locally connected interfaces (i.e. CAMs) and to redistribute the default ospf route based on metric-types, tags, and subnets: configure router ospf vrf default redistribute connected [metric ] [metric-type ] [tag ] Where the values and defaults are as follows: -
metric (optional) is the metric used for redistributed route. Values 1-4294967295. Default is 1. metric-type (optional) is the external link type associated with the default route advertised into the OSPF routing domain. Values are 1 (internal route) or 2 (external route). Default is 2. tag (optional) is the 32 bit decimal value that OSPF attaches to the external route. Default is 0.
5 Validate OSPF status: show ip ospf The output should indicate as follows: Router VRF default with ID 255.255.255.255 Only cost is used when choosing among multiple ASexternal-LSAs Exit overflow interval 0 seconds Number of external LSA 0. Checksum 0x0 Number of new originated LSAs 2 Number of received LSAs 5 6 Confirm that OSPF is enabled for the interface: show ip ospf interface Sample output: gigabitEthernet 17/0 Router Virtual Interface of Virtual Router: default Internet Address is 192.168.176.2 / 255.255.255.0 Internet Secondary Address(es): No Secondary Addresses Area ID: 0.0.0.0
15-44
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Network type: Point-to-point Cost: 1 Transmit delay: 1 Admin state: Enabled Interface state: Point-to-point Priority: 1 Designated router: 0.0.0.0 Backup designated router: 0.0.0.0 Not a graceful-restart helper
Timer intervals (in seconds): Hello: 1 Retransmit: 5 Dead: 4 Poll: 120 Counts: Events: 1 LSAs: 0 Authentication Type: None
gigabitEthernet 17/1 Router Virtual Interface of Virtual Router: default Internet Address is 192.168.177.2 / 255.255.255.0 Internet Secondary Address(es): No Secondary Addresses Area ID: 0.0.0.0 Network type: Point-to-point Cost: 1 Transmit delay: 1 Admin state: Enabled Interface state: Point-to-point Priority: 1 Designated router: 0.0.0.0 Backup designated router: 0.0.0.0 Not a graceful-restart helper
Timer intervals (in seconds): Hello: 1 Retransmit: 5 Dead: 4 Poll: 120 Counts: Events: 1 LSAs: 0 Authentication Type: None
End of procedure
Procedure 15-4
How to Disable OSPF for an Interface CAUTION
Care should be exercised when using the following command, because the OSPF network command can be used to enable OSPF on one, some, or all network interfaces. Most instances of OSPF in the field will have a network command for each interface, but some sites will use network
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-45
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
commands for multiple interfaces to save time and reduce commands. Be sure that your “ospf no network” command matches the mask and area of the network interface(s) on which you wish to disable OSPF. 1 Use the following command to disable OSPF for an interface or interfaces: configure router ospf no network area Where: ip-address is the IP prefix of the desired network interface, wildcard-mask is the IP address type mask that includes “don’t care bits,” and area-id is the area that is to be associated with the OSPF address range. 2 Confirm that OSPF is disabled for the network: show ip ospf interface End of procedure
Procedure 15-5
How to Disable OSPF on the CMTS 1 Use the following commands to disable OSPF: configure router ospf shutdown 2 Validate OSPF status: show ip ospf The output should include the following line: Router VRF default with ID 1.1.1.1 (disabled) 3 Validate vrf status: show ip vrf Sample output:
15-46
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
15 Dynamic Routing Protocols
C4/C4c CMTS Rel. 8.0.7
Virtual Router Details: Name Index =============== ========== default 1
OSPF ==== no
RIP === no
ISIS ==== no
BGP === no
ICMP-TIME-EXCEEDED ================== no
End of procedure
CLI Commands for OSPF The following list is meant as summary of the OSPF-related commands. They do not have to be performed in the order listed and not all commands will pertain to your plant and application. Table 15-4: List of Commands Related to OSPF Purpose
Command
Defines an OSPF area as a stub area. External routes can not be imported into these areas. Configures an area as a not so stubby area (NSSA). This area allows for generation of type-7 LSAs.
configure router ospf [vrf default] area stub [no]
configure router ospf [vrf default] area nssa [no]
Sets up a virtual link between two routers.
configure router ospf [vrf default] area show crypto isakmp sa
Local --------------10.1.171.11 10.1.171.11
Issue 2.0
Remote --------------10.1.240.82 10.1.2.48
Lifetime (sec) State Conn Role Enc Hash Grp Limit Remain ------ ---- ---- ---- ---- --- ------ -----mature 21 resp 3des md5 1 6000 4072 mature 20 resp 3des md5 1 6000 4057
ARRIS PROPRIETARY — All Rights Reserved
31-33
31 PacketCable™ Services
C4/C4c CMTS Rel. 8.0.7
C4> show crypto ipsec sa Interface: loopback 0 Local Remote --------------- --------------10.1.171.11 10.1.2.48 10.1.171.11 10.1.2.48 10.1.171.11 10.1.2.48 10.1.171.11 10.1.2.48 10.1.171.11 10.1.240.82 10.1.171.11 10.1.240.82 Interface total SA count: 6
Dir --in in out out in out
Life Limit Life Remain Type SPI State Enc Auth (sec) (sec) Packets ---- ---------- ------ ---- ---- ---------- ----------- ---------esp 0x3067015b mature 3des md5 6000 4006 6 esp 0x4a90df1e mature 3des md5 6000 4032 2029 esp 0x3bd152b8 mature 3des md5 6000 4006 6 esp 0x66deea04 mature 3des md5 6000 4032 2089 esp 0x187eb4fe mature 3des md5 6000 4021 3331 esp 0x00000bf2 mature 3des md5 6000 4021 4567
The "Packets" in the "show crypto ipsec sa" display should be increasing on one outbound IPSec SA and increasing on one or more incoming IPSec SAs per peer. This is a good hint that the intended traffic (COPS and/or Event messaging, for example) is flowing through the IPSec SAs. If IKE and/or IPSec SAs fail to be created properly, the first step should be to manually compare the Phase 1 and Phase 2 security parameters configured on the CMTS and the IKE peer to ensure compatibility. The next step is to inspect the CMTS syslogs to diagnose the problem. Make sure that INFO syslogs are enabled as this is where much IKE and IPSec information is recorded.
31-34
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
31 PacketCable™ Services
C4/C4c CMTS Rel. 8.0.7
IKE and IPSec Command Summary
The following commands are used to manage IKE and IPSec functionality on the CMTS: configure access-list clear crypto sa configure crypto dynamic-map configure crypto dynamic-map match address configure crypto dynamic-map set peer configure crypto dynamic-map set security-association lifetime configure crypto dynamic-map set transform-set configure crypto ipsec security-association lifetime seconds configure crypto ipsec transform-set configure crypto ipsec transform-set authentication configure crypto ipsec transform-set encryption configure crypto ipsec transform-set mode configure crypto isakmp enable configure crypto isakmp key configure crypto isakmp local-address configure crypto isakmp policy configure crypto map ipsecisakmp configure crypto map ipsecisakmp dynamic
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
31-35
31 PacketCable™ Services
C4/C4c CMTS Rel. 8.0.7
configure crypto map ipsecisakmp match address configure crypto map ipsecisakmp set peer configure crypto map ipsecisakmp set security-association lifetime seconds configure crypto map ipsecisakmp set transform-set show crypto dynamic-map show crypto ipsec sa show crypto ipsec security-association lifetime show crypto ipsec transform-set show crypto isakmp show crypto isakmp policy show crypto isakmp sa
31-36
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
32
Security
Topics AAA Feature
Page 1
Secure Shell Protocol (SSH2)
15
Routing to a Null Interface
24
Source Verification of Cable-side IP Addresses
25
CPE Host Authorization
27
DSx DQoS VoIP on the CMTS
30
CMTS Advanced CM Configuration File Verification
31
Cable Modem MAC Deny List
35
AAA Feature NOTE Remote Authentication Dial-In User Service (RADIUS) is not supported in Release 8.0. The AAA feature enhances the authentication, authorization, and accounting capabilities of the CMTS through the introduction of the TACACS+ protocol. This protocol not only standardizes the interface to a network element’s AAA capabilities, but it also enables centralized admin-
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-1
32 Security
C4/C4c CMTS Rel. 8.0.7
istration of security policies across a network of heterogeneous elements. AAA allows a customer to:
Definitions and Abbreviations
•
Maintain a central database of user IDs, user groups, passwords, and authentication policies
•
Customize access policies for the CMTS command set
•
Maintain standardized, centralized security accounting records.
authentication — the process of identifying an individual administrator, usually based on a username and password. authorization — the process of granting individuals access to system resources or functions based on the level of service assigned to them. accounting — the process of tracking an individual's activity while accessing a system’s resources, including the amount of time spent on the system, the services accessed, and amount of data transferred. line — a point of origin for CLI sessions. The CMTS supports a single console line (the SCM serial port), and up to sixteen virtual terminal lines (telnet sessions). vty — Virtual terminal
The AAA Model
The AAA security model is an architectural framework for the implementation and management of common security functions within a network of heterogeneous elements. The model distinguishes authentication (verification of a user’s identity) from authorization (verification that a user’s actions are permissible) and offers accounting services with respect to both. Moreover, the model separates security policy from policy enforcement, thereby enabling a distributed security scheme with centralized policy management for each independent function. Figure 32-1 provides a network-level illustration.
32-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
login attempt
Router
Authentication Servers
Authorization Servers login attempt
Accounting Servers
command xyz
C4 CMTS
Figure 32-1: AAA Security Model In Figure 32-1, the CMTS and the Router are AAA clients that defer login authentication and command authorization responsibilities to remote servers. Information regarding each authentication or authorization exchange is forwarded to accounting servers where historical records of user activity are maintained. Note that the AAA model itself does not demand a distributed security scheme but simply offers enough flexibility to accommodate it. Any or all of the AAA functions can be administered locally at an element. For example, an element can defer login authentication to a remote authority while authorizing each command locally based on element-specific policy such as the user’s privilege level. Similarly, an element can authenticate locally (e.g., from a password file) while deferring authorization to an external server on a per-command basis. TACACS+1 is a TCP-based protocol supporting distinct request/response transactions for authentication, authorization, and accounting. TACACS+ supports full payload encryption via Message Digest version 5 (MD5) and offers authentication for a wide variety of user services including login, Point-to-Point Protocol (PPP), Serial Line IP (SLIP), privilege-level change (e.g., entering enable mode), and password change. It employs an unbounded, server-controlled challenge-response mechanism in which the server may issue any number of challenges to a user prior to accepting or 1. Terminal Access Controller Access-Control System Plus
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-3
32 Security
C4/C4c CMTS Rel. 8.0.7
rejecting a service request. If the server rejects a service request, the client drops the connection. Otherwise, the client establishes the service parameters (e.g., session timeout, idle timeout, privilege level) as directed by the server and initiates the service. Only TACACS+ directly supports authorization for user activities via independent request/response transactions. With TACACS+, the client forwards each user command along with any associated arguments to the server where the accept/reject decision is made. On acceptance, the server may add additional arguments to the command line or may even override the entire argument list. The client is responsible for executing the accepted command with the server-supplied argument additions or overrides. TACACS+ supports both shell and command accounting. The client autonomously forwards start-of-service and end-of-service information to an accounting server. This information can include the number of bytes or packets transmitted or received, the elapsed time in seconds, the reason for termination, and so on. For shell accounting, successful authentication represents the start of service and session termination represents the end of service. For command accounting, successful authorization represents the start of service and command completion represents the end of service. Line Interfaces
Login and enable services are available via telnet sessions over the SCM maintenance ethernet interface and via the SCM console. Since each interface offers a different level of physical security, each may require a different level of AAA services or possibly none at all. Cisco refers to these interfaces as “lines” and provides AAA configuration capabilities on a perline basis. The line interface is also the target of non-AAA configuration parameters such as data rate, session timeout value, idle timeout value, pagination, and line password. Cisco’s line interface model is included as part of this feature.
AAA Functions Supported by the CMTS
Since the CMTS does not support network-based services such as PPP or SLIP, only login and enable services are considered for authorization. Only command services are considered for authorization for similar reasons.
32-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
Key capabilities include:
TACACS+ Servers and Server Groups
•
Configuration of login authentication methods on a per-line basis
•
Configuration of enable authentication methods on a per-line basis
•
Single connection
•
Line-based authentication
•
Enable-based authentication
•
Local authentication
•
Authentication via TACACS+
•
Configuration of authorization methods on a per-interface basis
•
Local authorization
•
Authorization via TACACS+
•
Shell and command accounting via TACACS+
TACACS+ uses TCP/IP for all client/server communication and requires payload encryption via MD5. A TACACS+ client must be provisioned with server-specific parameters such as IP address, port number, and shared secret. Some network architectures may require multiple servers for reliability purposes. Other architectures may require independent TACACS+ servers (or server clusters) for each AAA function. The CMTS supports six independently configurable TACACS+ servers. The current implementation of TACACS+ has the following characteristics:
Authentication Method Lists
Issue 2.0
•
Configuration information will include the server’s IP addresses, port number, shared secret, and timeout value.
•
There is support for three independently configurable TACACS+ server groups. Configuration information must include the group name and a list of TACACS+ servers belonging to the group.
•
A single TACACS+ server may be assigned to multiple server groups. Multiple TACACS+ server groups may share common backup servers.
•
All TACACS+ server and server group configuration information persists across system reboots and power-cycles.
•
By default no TACACS+ servers exist; the default configuration does not contain TACACS+ server configuration information.
•
By default no TACACS+ server groups exist; the default configuration does not contain TACACS+ server group configuration information.
The authentication function may be assigned to one or more TACACS+ server groups or to any of several local methods including the line password, the enable password, or the local user/password file. Moreover, authentication may be assigned to several of these methods in order of preference such that method n is employed if method n-1 is not available. This ordered list of methods is referred to as an authentication method list.
ARRIS PROPRIETARY — All Rights Reserved
32-5
32 Security
C4/C4c CMTS Rel. 8.0.7
The CMTS supports six independently configurable authentication method lists. The system is capable of maintaining unique parameter values for at least six authentication method lists. This provides four independent lists for console and vty login and enable authentication, plus two additional lists for testing configuration changes. The authentication method lists have the following characteristics:
Authorization Method Lists
•
Configuration information includes the name of the list and an ordered list of authentication methods (TACACS+, local password file, line password, enable password, and none).
•
By default, no authentication method lists exist; the default configuration does not contain authentication method list configuration information.
•
Authentication method list configuration information persists across system reboots and power-cycles.
The authorization function may be assigned either to one or more TACACS+ server groups or to the privilege level associated with the current user ID. As with authentication, authorization may be assigned to multiple methods in order of preference such that method n is employed if method n-1 is not available. This ordered list of methods is referred to as an authorization method list. The CMTS supports three independently configurable authorization method lists. The authorization method lists have the following characteristics:
Accounting Method Lists
32-6
•
Configuration information includes the list’s name and an ordered list of authorization methods (TACACS+, local, and none). (There are two independent lists for console and vty authorization, plus one additional list for testing configuration changes).
•
By default, no authorization method lists exist; the default configuration does not contain authentication method list configuration information.
•
Authorization method list configuration information persists across system reboots and power-cycles.
Accounting may be assigned to one or more TACACS+ server groups or to the local logging function of the CMTS. As with authentication and authorization, accounting may be assigned to multiple methods in order of preference such that method n is employed if method n-1 is not available. This ordered list of methods is referred to as an accounting method list.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
The CMTS supports six independently configurable accounting method lists. The accounting method lists have the following characteristics:
Lines
•
Configuration information includes the list’s name and an ordered list of accounting methods (TACACS+, local, and none) (four independent lists for console and vty shell and command accounting, plus two additional lists for testing configuration changes).
•
By default, no accounting method lists exist; the default configuration does not contain authentication method list configuration information.
•
Accounting method list configuration information persists across system reboots and power-cycles.
A line is any point of origin for a CLI session. The CMTS currently supports two types of lines: console lines and vty (virtual terminal) lines. A console line is a CLI session over the SCM’s console port, while a vty line is a CLI session over telnet. All lines are independently configurable. This allows an operator to modify the configuration of a given line without affecting the configuration of other lines of the same type. For example, a user logged in on vty 0 may disable/enable pagination without disturbing the state of pagination on vty lines 1 through 15. The following is a summary of the provisioning of the line interfaces: •
Configuration information includes at least session timeout, idle timeout, pagination mode, and password. The C4 CMTS maintains unique parameter values for one console line and sixteen vty (telnet) lines numbered 0 through 15. The session timeout provides the maximum session length in seconds. A value of zero (default) indicates no timeout. The idle timeout provides the maximum idle time in seconds. A value of zero (default) indicates no timeout. The pagination mode provides the number of lines of consecutive output to display before pausing and prompting. A value of zero (default) indicates no pagination. The password provides the line password used for authentication if line-based authentication is active. By default, the line password is undefined.
•
The configuration of login authentication, enable authentication, authorization, shell accounting, and command accounting services are supported on a per-line basis.
•
By default, there are two console lines, consoles 0 and 1. Console 0 is the new-start configuration port and is physically secure.
•
Issue 2.0
By default, there are seven (7) vty lines, but another nine can be activated to make a total of sixteen (16).
ARRIS PROPRIETARY — All Rights Reserved
32-7
32 Security
C4/C4c CMTS Rel. 8.0.7
Vty lines are not new-start configuration ports and are not necessarily physically secure. They exist only if they are manually configured. This implies that telnet services are not available on the CMTS by default. •
By default, login authentication is disabled on all lines. Until authentication is manually configured, access to any of the configured lines is granted without challenge.
•
By default, enable authentication is disabled on all lines. Until enable authentication is manually configured, access to enable mode on any of the configured lines is granted without challenge.
•
By default, authorization is disabled on all lines. Until authorization is manually configured, any command may be entered on any line without challenge. Note that this does not include the enable command. The enable command represents a change of privilege level; therefore, it is subject to authentication rather than authorization.
•
By default, accounting is disabled on all lines. Until accounting is manually configured, no authentication or authorization activities may generate accounting records.
•
All line configuration information persist across system reboots and power-cycles. This includes line-specific parameters (e.g., time-outs, baud rate), authentication information, authorization information, and accounting information.
Common CLI Commands for AAA Using TACACS
Use the following command to configure TACACS+ servers and TACACS+ server groups. Each server may be configured with an IP address, shared secret, TCP port number, and timeout value. Each group may be configured with a group name and one or more TACACS+ servers. All hosts are automatically assigned to the TACACS+ server group named tac_default. NOTE This TACACS+ tac_default group will not exist until a configure tacacs host command has been completed (i.e., there is no empty group with this name).
configure tacacs [no] {group string host ipAddress | host ipAddress [key string] [port integer] [timeout integer] [single-connection]}
32-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
CAUTION
If the TACACS+ server is configured with CLI authorization, then single connection configuration should be used. Without single connection, command authorization will open a unique TCP connection for each command. This could cause scripts to run out of available ports. Consider the following examples: configure tacacs host 10.9.8.7 key hostTacKey configure tacacs host 10.9.8.6 key hostTacKey configure tacacs host 10.9.8.5 key hostTacKey timeout 4 configure tacacs group group1 host 10.9.8.7 configure tacacs group group1 host 10.9.8.6 This sequence defines three TACACS+ servers, 10.9.8.7, 10.9.8.6, and 10.9.8.5, all of which use the same shared secret (hostTacKey). Servers 10.9.8.7 and 10.9.8.6 use the default timeout value of 0 which implies no timeout, while server 10.9.8.5 uses the timeout value of 4. All servers are members of the default TACACS+ server group, while servers 10.9.8.7 and 10.9.8.6 are assigned to TACACS+ server group group1. Use the following command to display all configured TACACS+ server groups, their members, and the operational parameters of each member. If the detail keyword is added, then utilization and performance measurements are also displayed for each TACACS+ Server. show tacacs [detail] Keywords specifying authentication methods may appear in any order, and they may be repeated. The order of keywords specifying authentication methods is significant in that method n is applied if and only if method n1 is unavailable. configure [no] authentication listName [line] [enable] [local] [tacacs {groupName | default}] [none] The following commands are valid examples: configure authentication list1 tacacs tac_default local configure authentication list2 tacacs group2 line none They define two authentication method lists: list1 and list2. The first list specifies two authentication methods: the default TACACS+ server group and the local user/password file. The second list specifies three authenti-
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-9
32 Security
C4/C4c CMTS Rel. 8.0.7
cation methods: TACACS+ server group group2, the line password, and finally no authentication. configure [no] authorization listName [local] [tacacs {groupName | default}] [none] As with authentication, the keywords specifying authorization methods may appear in any order, and they may be repeated. The order of keywords specifying authorization methods is significant in that method n is applied if and only if method n-1 is unavailable. Enable TACACS Authentication
To help ensure greater security on a TACACS server for individual users, the following procedure configures the server as necessary:
Procedure 32-1
Configure TACACS Server to Enable Password 1 Click the User Setup option on the server. 2 Select the List All Users option. This displays all the users that are configured on the server. 3 Determine the specific user and select. 4 Locate the TACACS+ Enable Password option under the Advanced TACACS Setting option. 5 Select Use Separate Password 6 Enter and confirm the user password. End of procedure
Procedure 32-2
Configure the CMTS to Enable Password 1 Enter the following command to set up the local enable password: configure enable password privilege 2 To configure the key for the TACACS host, enter: configure tacacs host key NOTE This key must match the TACACS server key.
32-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
3 To map the group name to the TACACS server IP address, enter: configure tacacs group host 4 To configure authentication method list(s), enter configure authentication tacacs group local none 5 To configure a console or telnet session for authenticating the method list: configure line vty authentication enableauthentication configure line console authentication enableauthentication
Use the following command to configure accounting method lists: configure [no] accounting listName [local] [tacacs {groupName | default}] As with authentication and authorization, the keywords specifying accounting methods may appear in any order, and they may be repeated. The order of keywords specifying accounting methods is significant in that method n is applied if and only if method n-1 is unavailable. The following commands are valid examples: configure accounting list1 tacacs default local configure accounting list2 tacacs group2 They define two accounting method lists: list1 and list2. The first list forwards accounting records to the default TACACS+ group or to the local log if the default TACACS+ group is unavailable. The second list forwards accounting records to TACACS+ group2. Use the following command to configure lines, either consoles or virtual terminals (VTYs): configure line { console | vty } startLine [endLine] [no] [session-timeout integer] [idle-timeout integer] [length integer] [password [hidden] string] ] [speed integer] [authentication [login | enable] authenticationList] [authorization authorizationList] [accounting {shell | command integer} [stop-only] accountingList]
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-11
32 Security
C4/C4c CMTS Rel. 8.0.7
Since the CMTS currently supports a single console port and up to sixteen remote sessions, the commands shown in Table 32-1 are possible: Table 32-1: Examples of Commands for Configuring Console Port and Remote Sessions Command
Purpose
configure line console 0
To configure the SCM console port
configure line vty 0 15
To configure all remote sessions
configure line vty 1
To configure the second remote session only
Each of these commands should cause the CLI to enter line configuration mode where any of the remaining parameters may be set or unset. Use the following command to view the status of the active lines: show line [detail] Use the following command to set a password or encrypted password for granting access to privileged commands. See Configuring Passwords and Privileges on page 2-12, for details.
Enabling CLI Password Control for Privileged Commands
configure enable password Use the following command to add a local user password: configure user password TACACS+ Defaults
The following table lists default values for the TACACS configuration commands.
Table 32-2: TACACS+ Default Values Command Keyword
Default Value
Group
TACACS Server Group Name
tac_default
Host
IP address of TACACS Server
None
Key
Shared Secret
None
Port
TACACS server’s TCP port number
49
Time in seconds that the CMTS waits for a response from the TACACS server before aborting a TACACS transaction.
3
Timeout Single-connect
32-12
Description
If true, indicates that the server supports multiplexing multiple TACACS+ sessions over a single connection.
ARRIS PROPRIETARY — All Rights Reserved
false
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
CAUTION
If the TACACS+ server is configured with CLI authorization, then single connection configuration should be used. Without single connection, command authorization will open a unique TCP connection for each command. This could cause scripts to run out of available ports.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-13
32 Security
Procedure 32-3
C4/C4c CMTS Rel. 8.0.7
Sample Procedure for Configuring TACACS Accounting This procedure assumes that TACACS servers, hosts, and groups have already been configured. 1 Enable global TACACS: configure accounting acct1 [method_list_name] name [tacacs_group_name]
tacacs
2 Enable local accounting: configure accounting acct4 [method_list_name] local 3 To configure TACACS accounting on a per vty line basis, choose from the commands in this step. Shell Accounting — These commands enable shell accounting, which logs only when a new session is started and stopped or just stopped. configure line vty [0 – 15] accounting acct1 [method_list_name] shell start-stop configure line vty [0 – 15] accounting acct1 [method_list_name] shell stop-only Command Accounting — This logs only when commands using privilege levels 0 thru 15 are executed. configure line vty [0 – 15] accounting acct1 [method_list_name] command [0-15] 4 To configure TACACS accounting on a console line, choose from the commands in this step. Shell Accounting — These commands enable shell accounting, which logs only when a new session is started and stopped or just stopped. configure line console [0/1] accounting acct1 [method_list_name] shell start-stop configure line console [0 /1] accounting acct1 [method_list_name] shell stop-only Command Accounting — This logs only when commands using privilege levels 0 thru 15 are executed. configure line console [0/1] accounting acct1 [method_list_name] command [0-15]
32-14
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
5 To check the accounting method lists configured on the system: show accounting 6 To deconfigure accounting (tacacs and local) from a vty line: configure line vty [0-15] accounting acct1 [method_list_name] no 7 To deconfigure accounting (tacacs and local) from a console line: configure line console [0/1] accounting acct1 [method_list_name] no 8 To see all TACACS AAA+ activities on a system: show tacacs detail End of procedure
Secure Shell Protocol (SSH2) The CMTS Secure Shell protocol version 2 (SSH2) feature provides enhanced privacy and security, including:
Setting up the SSH Server
•
Secure encrypted connection capabilities using an SSH2 server
•
User authentication by internal password
•
TACACS+ authentication, or user digital signatures (public keys)
•
Secure connections to the CMTS CLI (ssh) and file systems (sftp)
•
Support for up to 16 SSH clients.
You may use the following commands to enable SSH: configure crypto key generate dsa configure ip ssh restart
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-15
32 Security
Feature Description
C4/C4c CMTS Rel. 8.0.7
SSH is a secure user authentication and connection protocol that operates over TCP/IP. The following characteristics apply to the CMTS implementation of SSH2: •
SSH can work with insecure legacy remote connection protocols such as Telnet and FTP, or can be configured to replace them
•
SSH clients connect to SSH servers using TCP port 22
•
SSH multiplexes multiple sessions over a single TCP port. UDP is not supported.
•
SSH uses encryption to secure all traffic in the connection
•
Connection cipher is auto-negotiated from a list of candidates such as 3DES, Arcfour, Blowfish, etc.
•
A Diffie-Hellman key exchange establishes the transmission key for the SSH session
•
SSH can use passwords or user public keys to authenticate users
•
The CMTS SSH2 server supports secure CLI login
•
The CMTS also supports SSH-EXEC (enables use of SSH within PERL).
NOTE Secure CLI looks and performs the same as existing CLI. Users must enter an enabling password to execute configuration commands. After successful user authentication, the SSH2 server creates a CLI shell process. SSH2 Security Highlights and Compatibility
CLI Commands
SSH2 allows for the following security features: •
Users can be authenticated via user public keys (instead of only passwords)
•
User passwords and enabling authorizations may be authenticated via TACACS
•
SSH2 is not backward compatible with SSH1
•
The CMTS supports SSH protocol version 2 (SSH2) only
•
SSH2 clients include openSSH for Unix, and PuTTY, SecureCRT® & SecureFX® for Windows.1
CLI commands are provided to configure, operate, and maintain the SSH2 server.
1. SecureCRT and SecureFX are registered trademarks of VanDyke Software, Inc.
32-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
Management Commands — Use the following command to display active SSH sessions: show ip ssh To generate the DSA public and private keys, use the following command: configure crypto key generate dsa NOTE Use the configure ip ssh shutdown command carefully. If the SSH2 server is shutdown, you will not be able to use the SSH2 client to issue the restart command. Configuring the Server
The commands in this section are used to change the SSH server's default settings. Use the following command to display the SSH server configuration: show ip ssh config Use the following command to change the default port from 22 to another port number: configure ip ssh port Use the following command to set the time in minutes the session can remain idle before it will timeout. The default is zero, which stands for unlimited — no amount of idle time will cause the session to timeout: configure ip ssh idle-timeout Use the following command to list the available ciphers. The default is all: configure ip ssh [aes] [blowfish] [cast] [arcfour] [3des] Use the following command to allow or disallow password authentication: configure ip ssh [no] password-auth Use the following command to allow or disallow user digital signature (public key) authentication. configure ip ssh [no] public-key-auth Restart the SSH2 server after a configuration change. Configuration changes take effect only after you restart the SSH2 server: configure ip ssh restart
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-17
32 Security
C4/C4c CMTS Rel. 8.0.7
NOTE Restart the SSH2 server after a configuration change. Configuration changes take effect only after you restart the SSH2 server using the configure ip ssh restart command.
Managing User Public Keys
To add a user public key to the CMTS, follow these steps: 1 Consult Table 32-3, Supported Key Formats, on page 32-19 2 Upload the user's PEM- or SSH2-formatted public key files into the following location on the CMTS: /system/sec/ssh/user. 3 The user public file must have the following naming convention: .pem or .pk2 where the User Name is the user’s login name. 4 Use legacy FTP to upload the user's public key file only — do not upload the private key file!
Verification of SSH and PuTTY Setup
Use the following to procedures to set up SSH on the CMTS and to use the PuTTy utility for public key authentication.
Procedure 32-4
Setting up SSH on the CMTS 1 If you have executed the configure crypto key generate dsa command (Setting up the SSH Server, page 32-15), you should have a /system/ssh/server directory. Use the cd command to enter that directory. cd /system/ssh/server If not, use mkdir to create the directory. 2 Generate the public and private keys: configure crypto key generate dsa 3 Restart the SSH2 server: configure ip ssh restart End of procedure
32-18
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
Table 32-3: Supported Key Formats
Support for Server Keys Support for User Public Keys in Release File extension Create key using
DER PEM
IETF/SSH2
OpenSSHa
Yes
No
No
5.x, 7.x, and later
7.x and later
(none)
.pk2
n/a
PuTTYgen / SSH2
n/a
.pem b
openSSH / openSSL
a. OpenSSH key formats can be converted to SSH2 formats using the following command: ssh-keygen -e -f id_dsa.pub > id_dsa.pk2 b. See Procedure 32-5, PuTTY, SSH, Public Key Authentication, below.
Procedure 32-5
PuTTY, SSH, Public Key Authentication Follow this procedure if you wish to connect securely to the CMTS using PuTTY and SSH with public key authentication: 1 Telnet to a Unix machine which is configured with openSSL crypto and sshkeygen utilities. login: serial pwd: serial 2 Execute the command: ssh-keygen -t dsa -f id_dsa.pem The file id_dsa.pem will be the private key file. If id_dsa.pem already exists, overwrite it. 3 You will be prompted for a pass phrase. If you want to be prompted for this pass phrase when you authenticate to the CMTS, enter one. If not, you can hit Enter twice. The pass phrase is the SSH password; it must be at least 4 characters long. 4 Execute the command: openssl dsa -in id_dsa.pem -outform PEM -pubout -out .pem Replace with the desired username, for example, C4. If you entered a pass phrase when the key was created, you will be prompted to enter it again.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-19
32 Security
C4/C4c CMTS Rel. 8.0.7
5 A file will be created called ".pem". This is this user's public key file and must be sent using FTP to the CMTS running SSH. Place the file in /system/sec/ssh/user. You may have to create the /user directory. 6 At the CMTS, restart the SSH server: configure ip ssh restart 7 From your PC, run PuTTYgen. PuTTYgen can be downloaded from: http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html 8 On the menu bar select Conversions --> import key. Open the private key file you created above called id_dsa.pem. If you entered a pass phrase when the key was created you will be prompted to enter it again. 9 Click the Save private key button to save the private key file with a ".ppk" extension; call it .ppk or something that correlates it with the username you entered above. This is PuTTY's private key file format and is different from OpenSSH and ssh.com (IETF SECSH). 10 From your PC, open PuTTY. Create a profile for connecting to the SSH server. On the left side of the PuTTY window you will see a pane called “Category”. Select Connection --> SSH --> Auth, and in the “Private key file for authentication” browse to the public key file (the .ppk file you converted with PuTTYgen). Go back to 'Sessions'. Enter the IP address, SSH, Name of 'Saved Session' file and save your profile. 11 Connect to the CMTS. Login with , whatever filename you called the .pem public key file you FTP’d to the CMTS. If you entered a pass phrase you will be prompted to enter this as well. Proceed to login to the CMTS in the same way as with telnet. End of procedure
Procedure 32-6
Storing or Backing up Server Keys Server keys must be DER-encoded in PEM format. OpenSSH format is not supported. To store backup copies of public and private keys follow these steps:
32-20
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
1 Export the server public and private keys to files: configure crypto key export public-key configure crypto key export private-key 2 (Alternative) In a CLI session, enter the following command: show running-config | include ssh Capture the output and save it to a file. 3 You can use legacy ftp or copy ftp to save the file(s) to a remote system, but it is recommended that you use secure FTP (SFTP). End of procedure
Procedure 32-7
Restoring Server Keys from Backup Files 1 Use legacy ftp or copy ftp to copy the backup files you created in Procedure 32-6 from the remote system to the CMTS. 2 Import the keys into the MIB tables with the following commands: configure crypto key import public-key configure crypto key import private-key 3 (Alternative) If you saved a running-config file, execute the following command: exc file Where filename is the name of the running-config file. 4 Use secure FTP (SFTP) to upload the server’s private key file. End of procedure
Feature Dependencies
Issue 2.0
No alarms are associated with the CMTS SSH feature. No performance monitoring is provided with the CMTS SSH feature. No new hardware is needed to support this feature. If the SSH server's host public/private DSA key pair is not recovered after a system outage, then a new key pair will be generated before the SSH server can be started.
ARRIS PROPRIETARY — All Rights Reserved
32-21
32 Security
C4/C4c CMTS Rel. 8.0.7
Table 32-4: SSH Server Operating Parameters Parameter
CLI Command (config)
Comment
TCP port
ip ssh port
Default is port 22.
Session idle timeout (minutes)
ip ssh idle-timeout
Default is 0 (unlimited). Note well that CLI time is in minutes but SSH2 server time is in seconds.
Max SSH clients
ip ssh max-clients
The default is 0, but the value of zero represents the maximum number available. The maximum number of SSH clients is equal to the number of enabled vty lines. So if the max-clients parameter is set to 5, then the maximum number of clients is 5. If it is set to 0, and there are 16 vty lines enabled, then the maximum number of SSH clients is 16.
Choice of cipher set (choose any or all)
ip ssh ciphers [aes] [blowfish] [cast] [arcfour] [3des]
Available ciphers are aes, blowfish, cast, arcfour, and 3des. Default is all ciphers are available.
Allow/Disallow password authentication
ip ssh password-auth ip ssh no password-auth
Password authentication is allowed. If disallowed, any password authentication from the client is rejected. If both password and public key authentications are disallowed then all client authentication requests will be rejected. Default is allowed.
Allow/Disallow user public key authentication
ip ssh public-key-auth ip ssh no public-key-auth
User public key authentication is allowed. If disallowed then any public key authentication from the client is rejected. If both password and public key authentications are disallowed then all client authentication requests will be rejected. Default is allowed.
Require/Do Not Require ip ssh password-auth-req password ip ssh no password-auth-req authentication
The server requires password authentication before a client is considered logged in. Password authentication must be allowed; otherwise, this command has no effect. If not required, the client can choose whether or not to use password authentication. Default is not required.
Require/Do Not Require ip ssh public-key-auth-req public key ip ssh no public-key-auth-req authentication
The server requires public key authentication before a client is considered logged in. Public-key-auth must be allowed, otherwise this command has no effect. If not required, the client can choose whether or not to use public key authentication. Default is not required.
Require/Do Not Require ip ssh public-key-auth-first public key ip ssh no public-key-auth-first authentication first
If both password and public key authentications are required, this command requires public key authentication to be performed first. If it is not required then the client can choose in which order to authenticate. Default is not required.
Max number of client authentication failure
Server rejects a client authentication if the number of failed authentication ip ssh max-auth-fail attempt exceeds this number. This counter is for both public key and password authentication failures. Default is 3.
Allow/Disallow secure CLI login sessions
ip ssh login ip ssh no login
Secure CLI login sessions are allowed. If disallowed, then no CLI sessions are available. Default is allowed.
Allow/Disallow secure port forwarding
ip ssh port-forwarding ip ssh no port-forwarding
Port forwarding is allowed. If disallowed, then no port forwarding is available. Default is allowed.
Allow/Disallow legacy Telnet connections
telnet-server no telnet-server
Starts or stops the internal telnet server. Default = enabled.
Allow/Disallow legacy FTP connections
ftp-server no ftp-server
Legacy FTP control connections on port 21 are allowed. If disallowed, port 21 is closed and FTP control connection requests are rejected. This command takes effect immediately. Default is allowed.
Allow/Disallow legacy ip ssh sftp-server Secure FTP connections no ip ssh sftp-server
32-22
SFTP connections on the configured SSH port are allowed. If disallowed, the SFTP service requests are denied preventing SFTP access. This command may require restarting the SSH service. This will drop active SSH connections (including SSH-EXEC). Default is allowed. Note that the SSH service must be enabled for SFTP.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
NOTE If the TACACS+ server is configured for enable authorization, the user will have the configure privilege level upon logging in. Also, if a Control Complex failover or switchover occurs, the SSH console sessions will be lost and must be reestablished.
Table 32-5: CLI Commands for Generating SSH Server Host Key CLI Command
Description Generate the host private/public key pair for the CMTS SSH server. Specify dsa format for the SSH2 server. The DSA host public key may be distributed to clients before an SSH session is started. To maintain security, the host private key should never be copied off the CMTS.
configure crypto key generate dsa
Note well that this command does not start the CMTS SSH server daemon process (see CLI command configure ip ssh no shutdown). Also, the SSH server’s host public/private key pair(s) must be created before the SSH server is started. This means the DSA key pair must be created for the SSH2 server. This command does not appear in the show running config command output. Delete the SSH server’s host public/private key pair(s).
configure crypto key zeroize dsa
If the SSH2 server is running and the DSA key pair is deleted, the server will terminate immediately. Prerequisites: it is desirable to use the configure ip ssh shutdown command to stop the SSH server before deleting any of its host key pairs.
show ssh host public-key dsa
SSH Server Operation and Maintenance Commands
Displays the SSH server’s host public key. Specify dsa format. This could be used to cut and paste the public key into an SSH client via a terminal session. DSA public keys are for SSH2 clients
The commands in Table 32-6, CLI Commands for SSH Server Operation and Maintenance, on page 32-23 start, stop, and monitor the CMTS SSH
server and its running sessions. These commands set the parameters for the SSH server the next time it runs. If the server is already running, then restart the server with configure ip ssh restart.
Table 32-6: CLI Commands for SSH Server Operation and Maintenance Command configure ip ssh no shutdown
Description Starts the SSH server’s daemon process ipssh. This command will fail if the SSH2 server’s DSA host key pair is not available. Stops the SSH server’s daemon process ipssh. All active SSH sessions are killed.
configure ip ssh shutdown
Issue 2.0
Use the configure disconnect ssh command to terminate individual running SSH sessions.
ARRIS PROPRIETARY — All Rights Reserved
32-23
32 Security
C4/C4c CMTS Rel. 8.0.7
Table 32-6: CLI Commands for SSH Server Operation and Maintenance (Continued) Command
Description
configure ip ssh restart
Stops the SSH server’s demon process, kills all SSH sessions, and automatically restarts the SSH daemon process. May be used to restart the SSH server from within an SSH session (which will be killed). This is the equivalent of configure ip ssh shutdown followed by configure ip ssh no shutdown.
show ip ssh
View all running SSH sessions. This command displays the connection id, the user id, the client IP address), Authentication method (password or public key), encryption algorithm, MAC algorithm, and the client software version.
show ip ssh config
View the SSH2 server operating parameters. This command displays the settings for the bind address, port number, idle time, max clients, max shells, supported encryption and MAC algorithms, service terminal, port forwarding, password allowed, password required, public key allowed, public key required, public key first, and max number of authentication failures.
configure disconnect ssh
Kills a running SSH session identified by connection id.
Routing to a Null Interface A null interface is a pseudo-interface that can neither receive nor forward packets. Any packets routed to a null interface are dropped. Routing to a null interface is a way to filter traffic that is simpler than using Access Control Lists. It functions like a global Access Control List (ACL) since a single entry in the routing table applies to all ingress interfaces. With this feature enabled, the CMTS system administrator can define a route in the CMTS routing table to a null interface. A Classless InterDomain Routing (CIDR) match with this defined route on the destination IP address of an ingress IP datagram results in the dropping of the packet. Routing to a null interface can be used to discard certain IP prefixes in order to remove the potential for routing loops. By default the packets routed to the null interface are discarded silently, but the CMTS can be configured to return an Internet Control Message Protocol (ICMP) “destination unreachable” error to the source IP. The cost of the route is zero by default, but it can be increased by user command. CLI Commands
To enable the sending of ICMP unreachable messages: configure interface null 0 ip unreachables The only valid interface number for this command is 0. The result is global.
32-24
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
To add a route to the null interface: configure ip route [destination ip] [destination mask] null 0 To add an IPv6 route to the null interface: configure ipv6 route null [admin-distance ] [metric ] To display IP routes: show ip route Or … show ipv6 route
Source Verification of Cable-side IP Addresses The CMTS Cable Source Verify feature is intended to eliminate hostinitiated corruption of the layer 2 and layer 3 address spaces on the cable network. The feature adds a source IP address verification phase to the IP address learning process of the CMTS. Each unknown source address received in an IP, ARP, or ND packet on a cable-side interface is subjected to a configurable series of address validation checks prior to learning. If any check fails, the address remains unlearned and all IP, ARP, and ND packets sourced from that address are dropped. The CMTS examines source addresses of directly connected hosts to verify that their IP addresses do not belong to other hosts. Also, the CMTS inhibits the traffic of an indirectly connected host if the return route to that address is not via the cable modem that originated the packet. Source Verify via Internal Database — The CMTS maintains an internal database (MAC DB) of CPE source IPs (SIPs), MAC addresses, and associated CMs. The database is populated through DHCP snooping for dynamically assigned CPE IP addresses or through either MAC learning or DOCSIS® pre-provisioning for statically assigned CPE IP addresses. This database along with the routing tables serves as the default authority for SIP verification. Source Verify via DHCP Server — This facility allows the CMTS to query a DHCP server for the CM MAC address associated with a given SIP when that SIP is not present in the MAC DB of the CMTS. It does this using a DHCP LEASEQUERY message. Cable Source Verify supports multiple versions of the lease query protocol for IPv4. For IPv6 there is only one version.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-25
32 Security
C4/C4c CMTS Rel. 8.0.7
Source Verify via Authoritative DHCP Server — With authoritative DHCP lease query, any indication returned by the DHCP server that indicates that the server has no knowledge of the address results in denial of packet forwarding. This implies that all CPE IP addresses (whether directly attached or not) will be either dynamically assigned by the DHCP server or statically reserved at the DHCP server. New for IPv6
Users of Cable Source Verify and IPv6 should be aware of the following: Lease Query Option 47 — The C4 CMTS verifies IPv6 source address leases based on the association of the CPE with the CM. If a CPE is using an IPv6 source address assigned by the DHCPv6 server to a CPE behind a different or unknown CM, then these packets will be denied. This requires that the DHCPv6 server respond to a request for a lease query option 47 (OPTION_LQ_RELAY_DATA) which contains the CM MAC address. If the DHCPv6 server does not or cannot provide this option, then these packets will be denied by the CMTS. IPv6 Address Learning and Invalid IPv6 Prefixes — If Cable Source Verify is enabled, then any IPv6 source address using an expired prefix will not be learned. If any IPv6 prefix expires or is deleted, the CMTS removes all of the learned IPv6 source addresses using that prefix from the MAC database and from the CAMs. NOTE If Source Verify is enabled in DHCP authoritative mode, and if an IPv6 prefix is advertised for auto-configuration, then hosts attempting to autoconfigure their IP addresses using that IPv6 prefix will be denied.
CLI Commands
The following command enables source verification for all packets for the specified mac-id: configure interface cable-mac cable sourceverify [dhcp [authoritative]] Use the following command to select the desired version of the DHCP lease query protocol: configure cable source-verify leasequery version [draft-0|draft-2|draft-4|rfc-4388] Where:
draft-0 is the default.
Use the following command to select the DHCP lease query message type: configure cable source-verify leasequery message-type [type]
32-26
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
Where:
type = a number from 9 to 13, representing the message type value when operating in one of the draft protocol modes
When the CMTS is operating in RFC 4388 mode, the RFC-defined values are always used. To determine how the CMTS is configured for cable source verification, run the following command: show running-config full verbose | include source-verify Or … show ip interface cable-mac A sample response from the CMTS: configure interface cable-mac 1.0 cable source-verify dhcp authoritative
CPE Host Authorization The CPE Host Authorization feature provides an alternative or a supplement to DHCP Lease Query, also known as Cable Source Verify. It is another means of preventing the spoofing of IP addresses. It permits the CMTS operator to provision multiple IP addresses to a single MAC address. When the CAM receives a packet from an unknown source MAC address or from a known MAC address having an IP address that differs from the previous MAC-IP binding, a learning event is generated by the hardware. This new information is forwarded to the RCM. There, the MAC Data Manager (MACDM) performs several checks for source verification before assigning an IP address to a MAC address. If the request satisfies all the checks, the new learned information is added to internal databases of the CMTS and copied into the CAM hardware. NOTE CPE Host Authorization is not supported for IPv6 addresses. The following list describes the additional checks used by this feature to govern the flow of CPE traffic through the system: •
Issue 2.0
When the host authorization feature is turned on, packets from an unknown source will be dropped.
ARRIS PROPRIETARY — All Rights Reserved
32-27
32 Security
C4/C4c CMTS Rel. 8.0.7
Packets from unknown sources currently are dropped only if Cable Source Verify is on or if subscriber management cpe control is on for the particular modem. This feature adds one additional condition to cause packets from an unknown source to be dropped. •
If a CPE MAC learning event indicates that a MAC address has moved from being active behind one modem to being active behind another where it has been provisioned as having authorized IP addresses behind the new modem, the movement is not denied. Currently, the MAC learning event prohibits an active MAC from being moved to a new modem if source verify is on. This requirement supersedes that check if host authorization has been provisioned for a CPE behind a modem.
•
If host authorization is enabled and a CPE IP learning event occurs for an IP address that has been provisioned for host authorization, and the learning event indicates a different CM or CPE than the one provisioned, then the IP learning will be denied. The CMTS issues an error message:
IP address authorized for use by CM xx:xx:xx:xx:xx:xx/ CPE xx:xx:xx:xx:xx:xx. •
If host authorization is enabled and a CPE IP learning event occurs for an IP address that has been provisioned for host authorization, and the learning event indicates that the correct CM and CPE have been provisioned, and furthermore, if other source verify checks pass, and the MAC is not currently assigned an IP address, then the IP learning is allowed and the IP address is assigned with the type IPTYPE_PROVISIONED. If other source verify checks fails, then the MAC/IP binding is denied for those other reasons. One of those other checks performed ensures that a less secure source does not take away an address from a more secure source. CPE Host Authorization is considered more secure than DHCP, for example. So when a match with host authorization table occurs, the IP type is changed to IPTYPE_PROVISIONED. This prevents the less secure/more secure check from retracting that IP address.
32-28
•
If a CPE IP learning event occurs for an IPv4 address that has been provisioned for host authorization, and host authorization is enabled, the learning event indicates the correct CM and CPE that have been provisioned, all other source verify check pass, and the MAC is currently assigned an IP address, then the IP learning will be allowed, but instead of assigning the MAC address the new IP address, the new IP address will be added behind the MAC as a /32 subnet in the CAM hardware.
•
When a host authorization IP address is removed from the provisioning, if that IP address is currently assigned to a MAC address, that IP address for that MAC address is cleared. Because adding and
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
removing IPs is expected to be rare, a situation in which a MAC address does not have primary addresses but does have secondary addresses is permitted. •
When a host authorization IP address is removed from the provisioning, if that IP address is currently not assigned to a MAC address, the /32 subnet for that IP address is deleted from the CAM hardware.
•
When a host authorization IP address is added to the provisioning and host authorization is enabled, that IP address is checked to see if is entered in the MAC Database (MACDB) behind the wrong CM or CPE. If a mismatch is found, the IP address in the MACDB is invalidated.
•
When host authorization is enabled, each entry in the host authorization table is checked to see if an entry exists in the MACDB associating that IP address with the wrong CM or CPE. If a mismatch is found, the IP address in the MACDB is invalidated.
•
When a host authorization MIB table entry is created, a check will be made to see if any other entries have been made with the same CPE MAC address, and if so, the new entry’s CM MAC address will be the same as the existing entry’s CM MAC address. If it is not the same, then the new creation is rejected.
•
When a host authorization MIB table entry is created, a check is made to see if there are other entries using the same IP address. If the same IP address is already used, the new creation is rejected.
The CMTS supports a maximum of 1000 MIB entries in the Host Authorization table and up to 32 entries for a single CPE/MAC address. CLI Commands
The CPE Host Authorization feature is enabled or disabled with the following command: configure cable host authorization To create a static mapping between an IP address and a CM/CPE MAC pair use the following command: configure [no] cable host authorization cpe The NO version of the command above deletes the static mapping. To see which MAC addresses are associated with which IP addresses, use the following command: show cable modem detail If a secondary IP is being used by a given MAC address, the system response labels it SEC IP, not SUBNET.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-29
32 Security
C4/C4c CMTS Rel. 8.0.7
To determine if source verify is enabled for a given mac-id, enter the following command: show interface cable-mac The following is a partial output for this command, highlighting the source verify setting: C4# show interface cable-mac 1 Cable-mac 1 NOTE: MAC 1 is in bundle mastered by MAC 1. cable-mac 1.0, VRF: default, IP Address: 192.168.196.2/24 Description: CABLE-MAC1 Secondary IP Address(es): 10.1.1.1/30 192.168.198.2/24 Physical Address: 0001.5c31.4c01 MTU is 1500 DHCP Policy mode is disabled (primary mode) DHCP Server Helper Address(es): 10.43.210.1 for Traffic Type "any" Directed Broadcast is disabled ICMP unreachables are always sent Multicast reserved groups joined: None Source-verify is set to DHCP
DSx DQoS VoIP on the CMTS Dynamic Services (DSx) / Dynamic Quality of Service (DQoS) provides for guaranteed Quality of Service for voice applications using DOCSIS 1.1 Dynamic Services (DSx) functionality. This mode accepts DSx signaling from any DSx-capable modem. DSx DQoS VoIP does not provide full PacketCable™ operation within the CMTS. DSx DQoS Provisioning on the CMTS
The following command should be run for all cable-macs which will be used for DSx DQoS call processing: configure interface cable-mac authorizationmodule open-dynamic-flow-policy This command allows for authorization of non-PacketCable DQoS through DSx signaling on the CAM. Open-dynamic-flow-policy will be enabled (the default is enabled). Enabling open-dynamic-flow-policy is required when running with non-ARRIS MTAs. If only ARRIS Touchstone™ Telephony Modems or Touchstone™ Telephony Ports are used, this setting can be disabled to provide a higher level of protection against theft of service.
32-30
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
The following CLI command can be used to alter timers on the CMTS: configure cable max-qos-admitted-timeout Default =
200
configure cable max-qos-active-timeout Default =
30
NOTE If DSx DQoS VoIP is enabled, the admitted timeout should be set at 200 seconds (the default), and the active timeout should be set to 30 seconds. This command is for DSx DQoS; it has no effect on PacketCable. The defaults ensure that inactive resources are released. Increasing these default values or setting them to 0 (which represents infinity) is not recommended. The default values serve as a precaution for freeing resources in the event that any device or transmission path in the network does not perform as required.
CMTS Advanced CM Configuration File Verification A common type of theft-of-service occurs when users replace or modify their assigned configuration files in order to gain a higher class of service. Another type of theft-of-service occurs when subscribers crack the Message Integrity Check (MIC) in order to generate their own high bandwidth configurations with valid MICs. The implementation of this feature consists of two parts, TFTP Enforcement to ensure that modems are using the configuration files downloaded from the proper server, and Dynamic Shared Secret Verification, which uses a Message Integrity Check (MIC) modified by the CMTS to verify that these files have not been altered. This feature can be applied to all modems or selectively to all IPv4 or to all IPv6 modems. Modems found to be in violation are called rogues. Operators can take action against them in the following ways:
Issue 2.0
•
Reject the modem by preventing it from registering
•
Lock the modem by limiting the CM’s bandwidth to 10 kbps
•
Block Internet access by preventing the CM from learning any CPEs
•
Mark the modem by indicating in show commands that the CM registered incorrectly, but allow it to register with full function.
ARRIS PROPRIETARY — All Rights Reserved
32-31
32 Security
C4/C4c CMTS Rel. 8.0.7
The Block and Lock settings also serve to deny CM requests for dynamic service flows. TFTP Enforcement
TFTP Enforcement is configurable on a per-MAC domain basis. If enabled, it is applied equally to all modems in the MAC domain. The CMTS implements this feature by relaying Trivial File Transfer Protocol (TFTP) requests and responses between the cable modems and TFTP servers, while monitoring the contents of the configuration files. After a modem receives an IP address from the DHCP server, it requests its TFTP configuration file. The CMTS verifies that the file name in the TFTP request is correct and relays the request to the correct server. By default TFTP Enforcement is disabled.
Dynamic Shared Secret Verification
Dynamic Shared Secret Verification is configurable on a per-MAC domain basis. If enabled, it is applied equally to all modems in the MAC domain. Before sending the correct configuration file to the CM, the CMTS extracts information from the file, stores it for later verification, and modifies the CMTS MIC using a secret key. When the modem sends up its registration request, the CMTS confirms that the information in the registration request matches the information gathered during the TFTP transfer. If the registration information is valid, the registration is allowed to proceed normally. If the CMTS detects a MIC mismatch it assumes that the cable modem’s configuration file has been altered. The CMTS verifies the MIC by dynamically creating a shared secret when the cable modem is registering, and using this key to create a new MIC which only the CMTS can verify. This shared secret is valid only for that particular session with that particular cable modem. A new dynamically generated shared secret is used each time the cable modem registers. By default this function is disabled.
Table 32-7: CLI Commands for TFTP Enforce and Dynamic Secret Purpose
Command
Enable TFTP Enforce on a cable-mac. Note: if no parameter is specified, then the enforcement action defaults to reject.
configure interface cable-mac cable tftp-enforce [block | lock | mark-only]
Disable TFTP Enforce for all modems on a cable-mac.
configure interface cable-mac cable tftp-enforce no
configure interface cable-mac Enable Dynamic Secret on a cable-mac. An enforcement cable dynamic-secret {block | lock | action must be specified. mark | reject} Disable Dynamic Secret for all modems on a cable-mac.
32-32
configure interface cable-mac cable dynamic-secret no
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
Table 32-7: CLI Commands for TFTP Enforce and Dynamic Secret (Continued) Purpose
Command
Globally enable [disable] both TFTP Enforce and Dynamic Secret. Note: by default these are enabled for configure cable proxy-tftp [no] both IPv4 and IPv6. All that is required is to enable it on the cable-mac. Globally enable TFTP Enforce and Dynamic Secret for all configure cable proxy-tftp [ipv4-only | IPv4 or all IPv6 modems. ipv6-only] If the previous command has been executed, re-enable TFTP Enforce and Dynamic Secret for all IPv4 and all configure cable proxy-tftp IPv6 modems. Show status of TFTP Enforce and Dynamic Secret. Shows one of four states: enabled, disabled, IPv4 modems only, IPv6 modems only.
show cable global-settings
Note: If the global setting is enabled, then cable-mac settings determine which modems have TFTP or Dynamic Secret. The global settings disabled, IPv4, and IPv6, override the cable-mac settings.
Show status of TFTP Enforce and Dynamic Secret for a specific cable-mac.
show interface cable-mac
Show modems that failed TFTP Enforce or Dynamic Secret.
show cable modem rogue
Display general data on all modems.
show cable modem
The outputs of the show cable modem and show cable modem detail commands print a pound sign “#” before the modem state if the modem failed TFTP Enforce checks during modem registration and an exclamation point “!” before the modem state if the modem failed the Dynamic Shared Secret checks during modem registration. If the CM fails both the TFTP Enforce and Dynamic Shared Secret verifications, only the pound sign (#) is displayed. Modems that fail these security checks are marked in the show commands whether the mark-only parameter was used or not in the commands to enable this feature.
The following is an example of the system output of the show cable modem rogue command. C4> show cable modem rogue Sep
8 18:41:58
Interface DOC (DS-US) Mac Bonded State SIS Qos CPE MAC address IP Address ----------- ---- ------ -------- --- ------- --- --------------- ----------------------------------14/7-1/4 2 #Offline 2.0 0 001a.666a.f212
Log Messages
Issue 2.0
Log messages are generated when a CM fails TFTP Enforce or Dynamic Secret checks. Below are examples of such messages:
ARRIS PROPRIETARY — All Rights Reserved
32-33
32 Security
C4/C4c CMTS Rel. 8.0.7
TFTP Enforce Failure: cable-mac ifIndex 0x20000002: CM 00:15:ce:c4:8d:81: IP 10.119.31.239: Cable Modem did not TFTP correct file name Dynamic Secret Failure: cable-mac ifIndex 0x20000002: CM 00:15:96:54:1a:e3: IP 10.119.31.237: Verification of dynamic CMTS MIC failed
TFTP Relay Agent and the Upgrade Server TLV
If a TFTP server sends a cable modem configuration file that contains an upgrade server TLV that is null, then the TFTP relay agent populates the TLV with the IP address of the TFTP server. If the TFTP server sends a cable modem configuration file that contains an upgrade filename TLV that does not contain an upgrade server TLV, then the TFTP relay agent inserts an upgrade server TLV with the IP address of the TFTP server. The upgrade server TLV is not added or altered unless the configuration file contains an upgrade filename TLV and the upgrade server TLV is missing or zero. If the relay agent does modify a configuration file by adding the IP address of a server, it recalculates and overwrites both the CM MIC and CMTS MIC TLVs. And if the addition of a TLV by this feature causes the an additional TFTP data block to be sent to the modem, then the TFTP relay agent coordinates how the CM and TFTP server will handle that extra data block. This TFTP relay agent functionality makes it possible to use one set of CM configuration files across a large network where there are multiple TFTP servers with different IP addresses.
Option 125, Sub-option 2
This applies only when the CMTS is acting as a TFTP relay agent when the TFTP Enforce feature or the Dynamic Shared Secret feature is enabled. This option uses the Vendor Identifying Vendor-Specific (TLV 125) for CableLabs (OID enterprise 4491) and is called the DHCPv4 TFTP Servers Option. This option was introduced in DOCSIS 3.0 and applies only to DOCSIS 3.0 (and higher) IPv4 modems. When DHCP OFFER or ACK messages are sent to a DOCSIS 3.0 modem, and if those messages contain option 125 data for enterprise 4491 and sub-option 2, then the CMTS derives the TFTP server address from the first IP address contained in suboption 2. Only the first TFTP server is supported. If other servers are specified in sub-option 2, they are ignored. If this TLV and sub-option contain no data, then the CMTS derives the TFTP server address from the siaddr field.
DHCPv6 Servers Address— Option 32
Because the CMTS acts as a TFTP relay agent for IPv6 CM registration, this option is always required. The CMTS derives the TFTP server address from DHCPv6 advertise and reply messages that contain option 32. The C4/C4c CMTS supports only the first TFTP server address specified in Option 32. If other servers are specified, they are ignored and removed from the message.
32-34
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
32 Security
C4/C4c CMTS Rel. 8.0.7
Cable Modem MAC Deny List This feature enables MSOs to prevent certain cable modems from obtaining IP addresses from the C4 CMTS. The purpose of this feature is to prevent malicious subscribers from cloning MAC addresses, changing configuration files, sending virus attacks, or initiating ping storms. The CM MAC Deny list supports a total of 1,000 CM MAC addresses. When MSOs detect the same MACs on multiple systems, they can add them to the deny list on the CMTSs where those MACs do not belong. If a malicious user is detected by the C4 CMTS, his or her modem can be added to the MAC Deny list. Whenever a CM MAC address is added to this list, that modem is prevented from acquiring an IP address. When a modem on the MAC Deny list attempts to range and register, the C4 CMTS generates a debug logging message showing the time of the attempt, the interface, and number of attempts so far. MAC-Deny Modems are not included on the modem flap list. Their attempts to register are not included in the flap count. The list of MACDeny modems is not provided by the show cable modem command. See Table 32-8 below for the CLI commands that pertain to this feature. Table 32-8: CLI Commands for Provisioning the CM MAC Deny List Purpose Add [remove] a CM MAC to the list.
CLI Command configure [no] cable modem deny
Clear the attempt information captured for a particular CM MAC address in the CM Deny List. If the is clear counters cable modem deny [] not supplied, then counters for all CMs listed are cleared. Show interface, time, and count information for specified show cable modem deny [] CM or for all listed CMs (if no address is specified).
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
32-35
32 Security
32-36
C4/C4c CMTS Rel. 8.0.7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
33 Legal Intercept
C4/C4c CMTS Rel. 8.0.7
33
Legal Intercept
Topics
Page
Overview
1
Abbreviations
4
Chassis Configuration
4
CLI Commands
5
Data Management and Maintenance
7
Overview The CMTS Legal Intercept (LI) feature provides operators a standardsbased mechanism for meeting legal requirements to intercept all IP data and voice traffic originating from or destined to subscribers on their network. The feature supports the Simple Law Enforcement Monitoring (SLEM) concept outlined in RFC 3924 to enable the interception of all IP traffic associated with a subscriber’s cable modem. See Figure 33-1 for an illustration of the RFC 3924 framework. The SLEM approach relies on the CISCO-TAP-MIB (cTapMIB) to support the secure remote configuration of tap sessions with one or more Mediation Devices (MDs) via SNMPv3 (or local configuration via CLI) and to specify the data streams to be intercepted. In the CMTS, the only data stream specification that is supported in the cTapMIB is the current layer 2 (aka an 802 stream) “subscriber interface” designated by the CM MAC address (or any MAC address of a bonded CM) that is registered to the subscriber. In this model, the subscriber’s CM may be offline when the tap session is configured or it may reboot and move to a different downstream
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
33-1
33 Legal Intercept
C4/C4c CMTS Rel. 8.0.7
channel during the lifetime of the tap session. In either case, the CMTS will identify the target CM when it registers regardless of where it appears in the CMTS, and will reestablish the tap session automatically without external intervention.
L1 Administration Function HI1
MD Provisioning Interface
HI2
IRI IAP Intercept Related Information Intercept Access Point IRI IAP
Law Enforcement Agency LEA
Mediation Device IRI
HI3
Intercept Request
User Content
Intercepted Content
Content Intercept Access Point Content IAP
User Content
Figure 33-1: RFC 3924 Framework For a modem that is being tapped, the CMTS will encapsulate both IPv4 and IPv6 traffic. The encapsulation header will be an IPv4 header, but the data encapsulated can be either an IPv4 or IPv6 packet. This means the CMTS will replicate and encapsulate all traffic with an ethertype of either 0x0800 or 0x86dd. ARP traffic (ethertype 0x0806) is not tapped. The CMTS supplies the captured packets to an MD that handles the collection of this information for delivery to the Law Enforcement Agency (LEA). Tap sessions are managed using SNMPv3 control. This feature includes an implementation of the cable intercept CLI command set that permits local configuration of tap sessions as well. NOTE For security reasons Legal Intercept should be configured for SNMPv3 access only.
33-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
33 Legal Intercept
C4/C4c CMTS Rel. 8.0.7
References
Simple Law Enforcement Monitoring (SLEM) presentation, www.ietf.org/proceedings/03jul/slides/plenary-10.pdf. CISCO-TAP-MIB, ftp://ftp-sj.cisco.com/pub/mibs/v2/CISCO-TAP-MIB.my.
Feature Operation
The operation of this feature includes the following highlights: 1 Feature activation is transparent to the subject. 2 The feature provides authentication, auditing, and logging mechanisms to prevent unauthorized creation or detection of intercepts. 3 Supports 320 simultaneous Service Independent Intercept (SII) taps. (Note: A maximum of 127 subscribers can be set up with LI Taps on each 12U CAM due to hardware limitations.) 4 Support for FlexPath Contributing Cable Modems (CCMs) by configuring the same tap session for each CM associated with the bonded Flexpath CM group. 5 Support for co-existence of Legal Intercept and PacketCable Electronic Surveillance (Note: PacketCable Electronic Surveillance takes precedence over LI in flows created by PacketCable 1.x). 6 Content delivery encapsulation format is compatible with PacketCable Electronic Surveillance. 7 Support for activation of tap sessions for CMs that are not currently registered at the CMTS. 8 Support for tap sessions that persist across CM reboots. 9 Support for data stream specification at Layer 2 (802 stream) only, as designated by a CM MAC address. 10 Support for tap sessions across all DSx activity. 11 The CMTS supports taps on IPv6-registered cable modems. 12 The output of the show running config command encrypts the identity of a subscriber intercepted by a config cable intercept command and suppresses userid and password values that may have been used to execute the command. 13 Only one LI tap session per subscriber is permitted. Any attempt to add a second tap or to change the parameters of the existing tap are rejected. The existing tap must be deleted before it can be replaced or altered.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
33-3
33 Legal Intercept
C4/C4c CMTS Rel. 8.0.7
14 If an LI tap session is manually deleted or automatically removed when it reaches its expiration time as defined by the until keyword, the CALEA tap on the same subscriber, if there is one, is not affected. 15 LI taps persist after a Control Complex fail-over in a duplex chassis.
Abbreviations CALEA
Communications Assistance for Law Enforcement Act
CPE
Customer Premise Equipment
DF
Distribution Function (for CALEA taps)
DHCP
Dynamic Host Configuration Protocol
DIP
Destination IP Address
IAP
Intercept Access Point
IP
Internet Protocol
IRI
Intercept Related Information
LEA
Law Enforcement Agency
LI
Legal Intercept
MAC
Media Access Control
MD
Mediation Device
MTA
Multimedia Terminal Adapter
RCM
Router Control Module
SIP
Source IP Address
SLEM
Simple Law Enforcement Monitoring
Chassis Configuration Chassis configuration of the LI feature consists of two steps:
33-4
•
Configuration of the Legal Intercept request
•
Configuration of secure access
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
33 Legal Intercept
C4/C4c CMTS Rel. 8.0.7
The Legal Intercept request can be configured directly using the CMTS and the configure cable intercept CLI command. It can also be done using a MD and SNMPv3. The CLI and the SNMPv3 agent have simultaneous access to the same underlying cTapMIB object. Therefore, the operator must manage simultaneous access appropriately. For security reasons the cable intercept and show cable intercept commands are password protected by the same user ID and password used to authorize remote SNMPv3 access to the CMTS by the MD. The userid and password created in the following procedure are set by the snmp-server command to restrict access to the MIB view and are the same for the configure cable intercept command.
CLI Commands The following section provides the commands used to create and manage secure access.
Procedure 33-1
Sample Configuration for Secure Access and Tap The following procedure serves as an example of how to create a view, group, and user for secure access. The names chosen here for the view, group, and user are arbitrary. 1 To create the view to manage access: configure snmp-server view cTapMIB included An example using a view named LI-TAP-VIEW: configure snmp-server view LI-TAP-VIEW cTapMIB included 2 To define the administrator group with read/write access:
configure snmp-server group v3 noauth read write notify
An example using a group named LI-TAP-ADMINS: configure snmp-server group LI-TAP-ADMINS v3 noauth read LI-TAP-VIEW write LI-TAP-VIEW notify LI-TAP-VIEW
3 To add a user to a group: configure snmp-server user
Issue 2.0
v3 auth md5
ARRIS PROPRIETARY — All Rights Reserved
33-5
33 Legal Intercept
C4/C4c CMTS Rel. 8.0.7
NOTE No spaces are allowed in the user name. An example using user name JohnDoe and password TopSecret: configure snmp-server user JohnDoe LI-TAP-ADMINS v3 auth md5 TopSecret
4 Use the following command to set the source interface for the SNMPv3 messages and the UDP/IP encapsulated intercept traffic. If you do not use this command to set the source interface for LI, then the CMTS uses the same source interface value that is used for SNMP traps. configure snmp-server trap-source loopback | cable / | cable-mac | ethernet / | gigabitEthernet / | loopback | tengigabitEthernet /
For example: configure snmp-server trap-source loopback 0 5 To define which SNMP traps should be sent: configure snmp-server notify-filter profile LI-TAP-NOTIFY subtree cTapMIBNotifications type included
6 Enter config-cable-intercept mode: configure cable intercept User Id: JohnDoe Password: TopSecret 7 The CM MAC address may be used to indicate which subscriber is to be intercepted: C4(config-cable-intercept)# subscriber [disable|enable] md udp [tos ] until [userid ] [password ]
An example using the subscriber’s CM MAC: C4(config-cable-intercept)# subscriber 0001.0203.aaaa md 192.168.100.199 udp 12345 until 06/19/2010
The md, udp, and until keywords are required when creating a new LI tap session. If no time is specified for the until option, it defaults to 23:59, at which time the session will be removed. Use the disable option to create a tap session that is inactive but that you wish to activate later. Use the tos keyword only if you wish to override the default value of 0x22 for UDP/IP encapsulation. Use the no form of the command to delete the LI tap session. 8 (Optional) To remove the tap created in the previous step, enter the following command: C4(config-cable-intercept# no subscriber 0001.0203.aaaa
33-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
33 Legal Intercept
C4/C4c CMTS Rel. 8.0.7
9 To confirm the status of the tap sessions for a specific subscriber or all tap sessions: show cable intercept [subscriber ] [userid ] [password ]
If you include the keyword subscriber this command displays tap session status for that subscriber only. An example to display all tap sessions is: show cable intercept The output of the command above shows a list of the statuses for all tap sessions for all subscribers. Sample output: Tap Mediation Dev Status CM MAC Addr IP Addr UDP TOS Expires CCC-ID Packets ------- ---------------- --------------- ----- ---- ---------------- ---------- ---------Online 0000.CAAA.CB0B 10.56.1.9 3000 0x22 1/1/2020-13:0 1 4
End of procedure
Procedure 33-2
To create or delete an LI tap on an IPv6 modem 1 Execute the following command to create an LI tap for a modem that is registered with an IPv6 address and IPv6 CPE:
configure cable intercept user mdaccess pass mdaccess subscriber enable md udp 30001 until
2 Execute the following command to delete an LI tap on an IPv6 modem: configure cable intercept user mdaccess pass mdaccess subscriber no
End of procedure
Data Management and Maintenance Syslog Reports
Issue 2.0
The LI feature creates a syslog report whenever a tap is created. The user ID and the interface where the change originated (either CLI or SNMP) are displayed in this report. The identity of the subscriber (the CM MAC address) is obscured in the syslog report for security reasons. For the SNMP interface, the trap is sent to the SNMP host and may be reported in the external Syslog.
ARRIS PROPRIETARY — All Rights Reserved
33-7
33 Legal Intercept
C4/C4c CMTS Rel. 8.0.7
For example: configure cable intercept userid JohnDoe password ********** subscriber 0015.A200.F40B enable md 192.168.180.150 udp 12345 until 01/01/201112:34 Tap mib is active on contentId 1
33-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
34
Load Balancing
Topics Load Balancing Group Definitions
Page 2
CLI Commands for Load Balancing
12
Load Balancing of Bonded Cable Modems
23
DCC across MAC Domains Using MIBs
26
Downstream and Upstream Utilization Start Thresholds
28
Load Balance Rule-based Modem Steering
30
Service-type Modem Steering
34
Load Balancing prevents any one channel from becoming overburdened so long as excess capacity is available on another reachable channel. The feature may perform this function through both static and dynamic load balancing. Static load balancing is performed at initial channel assignment time during a CM’s registration process. Dynamic load balancing automatically moves modems from one upstream channel to another, and/or from one downstream to another (including from one CAM to another) after registration. In this chapter, various aspects of load balancing are described. Immediately following the description is one or more boxes containing a brief description of the CLI command(s) used to provision that aspect.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-1
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Load Balancing Group Definitions General Load Balancing Group (GLBG)
A general load balancing group (GLBG) represents the set of upstream and downstream channels which reach a single fiber node. In this arrangement, a CM connected to the fiber node would be able to tune to any (or possibly all) of the channels in the general load balancing group. Since the CM may be associated with only one MAC Domain at a time, only the channels associated with a common MAC Domain may be used simultaneously. Unlike previous CMTS releases, in Release 7 and later, general load balancing groups are calculated by the CMTS when the fiber node command is entered with MAC Domain channels. The CMTS will automatically create a general load balancing group for each MAC Domain-Cable Modem-Service Group (MD-CM-SG). As a requirement for load balancing, any unique Upstream or Downstream channel pair must only be configured behind a single fiber node. The CMTS supports cross-MAC Domain dynamic load balancing across all CAM types, including 12U, 24U, 16D, and XD CAMs (24D and 32D).
Default Parameters for New GLBGs
The operator may choose to provision the default parameters to be used for all GLBGs yet to be created. Changes to these default parameters will not affect GLBGs which are in existence when the change is made if those groups have been specifically provisioned with their own parameters.
configure cable load-balance general-group-defaults ... This family of commands configures the default parameters for general load balancing groups (GLBGs) within the CMTS. These commands have no effect on GLBGs that have been specifically provisioned with their own parameters. enable
Enables load balancing in GLBGs.
enable no
Disables load balancing in GLBGs.
init-technique [unicast-ranging | reinit-mac | broadcast-ranging | ranging | direct | disable]
34-2
Sets the default initialization technique to be used when changing channels in GLBGs. Note that the disable option stops the load balancing. Default value is disabled.
policy
Sets default load balancing policy for GLBGs.
policy no
Returns default load balancing policy for new GLBGs back to default policy 0.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Modification of Parameters for an Existing GLBGs
If an operator wishes to provision changes to a GLBG with channels from a 12U, 24U, 16D or XD CAM that is already in existence, then the combination of the fiber node name and the MAC Domain number will provide the keys to the MD-CM-SG and therefore also to the GLBG for that MD-CMSG.
configure cable fiber-node cable-mac load-balance ... This family of commands configures the parameters for an existing general load balancing group (GLBG). These commands have no effect on RLBGs or the default parameters for GLBGs. enable
Enables load balancing in the GLBG.
enable no
Disables load balancing in the GLBGs.
Sets the initialization technique to be used when init-technique [reinit-mac | broadcast-ranging | changing channels in the GLBG. unicast-ranging | ranging | Note that the disable option stops the load direct | disable] balancing. policy
Sets load balancing policy for the GLBG.
policy no
Returns load balancing policy for the GLBG back to default policy 0.
no
Returns load balance back to default settings.
Restricted Load Balancing Group (RLBG)
Restricted Load Balancing groups are provisioned for a specific set of cable modems. Modems can be added or deleted from a Restricted Load Balance Group by either specifying the RLBG group number in the CM configuration file in TLV 43.1 or by adding a service type to the group and the modems in CLI commands. NOTE All load balancing groups that are manually provisioned are restricted groups.
configure interface cable-mac cable load-balance group ... This family of commands configures an RLBG that contains upstream and downstream channels of 12U CAMs, 24U CAMs, 16D CAMs, and XD CAMs.
Issue 2.0
(carriage return)
Create an RLBG for channels of a 12U, 24U, 16D, or XDCAM.
no
Delete the RLBG.
enable
Enables load balancing in the RLBG.
enable no
Disables load balancing in the RLBG.
ARRIS PROPRIETARY — All Rights Reserved
34-3
34 Load Balancing
C4/C4c CMTS Rel. 7.4
init-technique [reinit-mac | broadcast-ranging | unicast-ranging | ranging | direct | disable]
Sets the initialization technique to be used when changing channels in the RLBGs.
policy
Sets load balancing policy for the RLBG.
policy no
Returns load balancing policy for the RLBG back to default setting.
Note that the disable option stops the load balancing.
To add a service type to the RLBG, use the following command: configure interface cable-mac cable load-balance group service-type To add a modem to the service type name associated with the RLBG, use the following command: configure cable load-balance include cm-mac [macaddress of modem] mac-mask ffff.ffff.ffff service-type NOTE Cross-MAC Domain dynamic load balancing is not supported with Restricted Load Balancing Groups. General and Restricted Load Balancing Groups
The DOCSIS 3.0 specification restricts both general and restricted load balancing groups to a single MAC Domain cable modem service group (MD-CM-SG). A general load balancing group is automatically created by the CMTS to correspond to each MD-CM-SG so general load balancing group provisioning is not necessary. Restricted load balancing groups may be provisioned as subsets of the MD-CM-SG. Any CM which is not placed into a restricted load balancing group will be placed into the general load balancing group for its MD-CM-SG if its place in the cable plant topology can be determined.
Load Balancing Policy
A Load Balancing Policy is described by a set of conditions (rules) that govern the load balancing process for a cable modem. A policy may be referenced by multiple load balancing groups. A policy ID value is intended to be a numeric reference to a policy. However, the policy ID may refer to a non-existing or inactive policy instance in which case it indicates no policy is associated. The Policy ID of value 0 is the default policy.
34-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
NOTE If no policy is assigned to a load balance group, the default policy with the values of method (modem), weight (equal), threshold (10) and type (both) is used.
configure cable load-balance policy ... This family of commands manages a load balancing policy: no
Deletes an existing policy.
rule
Creates a new load balancing policy or adds a rule to a new or existing policy.
rule no
Deletes a rule from an existing policy.
Load Balancing Policy Rule
A load balancing policy rule governs autonomous load balancing operations. Each rule may be enabled, fully disabled, or disabled for a particular period each day independently of the load balancing group’s enable/disable state. A rule ID value is intended to be a numeric reference to a rule. However, the rule ID may refer to a non-existing or inactive rule instance in which case it indicates no rule is associated. Each rule has an associated type, a method, a threshold, and a weight. These parameters are explained below. There are also steering parameters associated with the rule. (See section Load Balance Rule-based Modem Steering, page 34-30 for more details.) A load balance rule may be referenced by multiple policies.
configure cable load-balance rule ... This family of commands manages when a load balancing policy rule is in effect: no
Deletes an existing rule.
enable
Enables rule.
enable no
Disables rule.
disable-period Disables the rule for a period beginning at a start-time [start-time [:]] and lasting for a period. [period [:]] disable period no
Issue 2.0
Removes the disable period and sets the rule to disabled.
ARRIS PROPRIETARY — All Rights Reserved
34-5
34 Load Balancing
Load Balancing Policy Rule Type
C4/C4c CMTS Rel. 7.4
There are four types of load balancing rules: •
Static
•
Dynamic
•
Both
•
Bonded
Static Load Balancing of CMs occurs during the initial ranging phase.The first opportunity for load balancing is when a CM initially ranges. During this time, the CM may be requested to move to a different upstream channel. The mechanism used to move modems at this stage is compatible with all CM versions. Dynamic Load Balancing means load balancing is done using the Dynamic Channel Change (DCC) directive and occurs via DCC immediately after registration time and at the macdomain-check intervals. This applies only to DOCSIS 1.1 and later non-bonded modems. Both indicates that the load balancer performs both static load balancing at the initial maintenance ranging time and dynamic load balancing at registration time and at the regular dynamic load balancing intervals. The load balancer does not permit these two types of load balancing to conflict with each other. As a CM first ranges, if it should be moved, then it is given an upstream channel override in the range response message. This CM is marked as “load balanced” so that it will not be asked to move again after it completes registration. (The exception to this case is if the CM is a member of a restricted group and it must move to another channel in that restricted group.) A CM that is moved to a new upstream channel is marked as “load balanced” so that it will not be given an upstream channel override when it ranges on the new channel. Bonded Load Balancing means all of the above in addition to including bonded cable modems as part of the dynamic load balancing process. The caveats are that since bonded modems are DCC'd with init-technique reinit-mac, they are only chosen if no 1.1 or 2.0 modems are available to move, and only the primary DS/US of a bonded modem is moved. NOTE Only the reinit-mac initialization technique is supported for load balancing on bonded CMs.
34-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
configure cable load-balance rule type ... This family of commands controls the type of a load balancing policy rule: no
Sets the rule type back to the default value. The default is both.
static
Sets the rule to perform static load balancing only.
dynamic
Sets the rule to perform dynamic load balancing only.
bonded
Sets the rule to perform static, dynamic and bonded load balancing.
both
Sets the rule to perform both static and dynamic load balancing.
Load Balancing Policy Rule Method
The C4 CMTS load balancing is based on either CM count or channel utilization. Either of these methods may be provisioned per load balancing group policy. These methods are mutually exclusive for a load balancing group. CM COUNT — This method (defined as method modem in CLI output) periodically compares the number of CMs per channel in a load balancing group. The choice of the CM to be moved is determined by the provisioned values of load balance priority and load balancing policy ID. If these values are over the configured threshold, then a CM is chosen randomly. CHANNEL UTILIZATION — This method (defined as method utilization in CLI output) compares channel utilization of the channels in a load balancing group. Channel utilization for upstreams will be computed by number of minislots used by the map maker for unicast grants divided by the total number of minislots available over a fixed time interval. Channel utilization for downstreams is computed as total bytes sent divided by the total available bandwidth over the measurement interval. The channel pair with the greatest utilization moves a modem to the channel pair with the least utilization. A CM with a lower load balance priority (more likely to be load balanced) will always be chosen to be load balanced over a CM with a higher priority. Load balance priority can be set only with TLV 43.2 in the CM config file.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-7
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Cross-checks are performed to verify that the CM to be moved: •
Has a CM config boot file version level DOCSIS 1.1 or higher
•
Is able to register on the target upstream channel (for example, a DOCSIS 1.1 modem cannot register on a channel provisioned for ATDMA or SCDMA)
•
Has not previously failed to move to the target upstream/downstream channel pair (as shown on the failed list)
•
Has no UGS service flows or any service flows that are dynamically created (e.g. packetcable multimedia gates)
•
Is not under electronic surveillance
•
Is not in multiple receive channel mode (i.e. no service flows bonded across multiple downstreams), unless rule type is bonded
•
Has no dynamic multicast service flows, such as IP Video.
•
Is not a Flexpath modem
•
Is not governed by a load balancing policy that is disabled
•
Is not on the load balancing exclude list
•
Is not in a restricted load balancing group
The CMTS maintains lists of the CMs which have failed to load balance and of the channels to which they failed to move. These lists can be purged by using the command clear cable load-balance state. Purging these lists is recommended when making hardware changes, for example, when replacing CAMs or other modules.
configure cable load-balance rule ... This family of commands controls the type of a load balancing policy rule: method no
Returns the method to the default. (Default is modem.)
method modem
Uses modem count (number of CMs) that are using a channel to determine load.
method utilization Uses the bandwidth utilization of each channel to determine load. threshold
Sets the percentage (1-100%) of load difference between channels that is tolerated before load balancing will be started.
threshold no
Sets the percentage of load difference back to the default (10%).
Relative Weighting
34-8
Weighting allows the operator to configure the relative levels of prioritization on which to base the load balancing decision. One value provides the setting for the load balance rule which determines the relative weighting of the US and DS channels.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
The weight types are described in order of precedence: a
equal — Directs the load balancer to use DS and US load equally to determine load balance decisions
b
usOnly — Directs the load balancer to use only the US channel load
c
dsOnly — Directs the load balancer to use only the DS channel load
d
usPlus — Directs the load balancer to double the US channel load over DS channel load. Weighting is 66% US and 33% DS.
e
dsPlus — Directs the load balancer to double the DS channel load over US channel load. Weighting is 66% DS and 33% US.
configure cable load-balance rule channel-weight {equal | US-only | DS-only | US+ | DS+ } [no] This command configures relative weighting of upstream channels versus downstream channels for load balancing decisions.
no
Returns the channel-weight to the default value of "equal”. The show cable load-balance policy and show cable loadbalance channels commands display the load balancing rule’s channel-weight value. These are shown in sample outputs in Show Commands, page 34-17.
Configuring the Number of Modems to Be Checked
You can set the number of modems to be checked for utilization at each load balancing interval. If you set this value low, then high-utilization users are less likely to be moved to a different channel. Setting this value high makes it more likely that high-bandwidth users will be moved more frequently.
configure cable load-balance utilization-modems-to-check x Where x is a value from 1-100. The default is 10. This setting has no effect on load balance groups that are configured to use the modem count method.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-9
34 Load Balancing
Using Multiple Rules
C4/C4c CMTS Rel. 7.4
It is possible to configure a policy with more than one load balancing rule. In such cases the CMTS uses the following algorithm to determine which load balancing rules to follow: •
If one rule is disabled and another is enabled at any given time, the CMTS uses the type, method, and threshold parameters from the rule that is enabled.
•
If all rules are disabled, there is no load balancing.
•
In the case of multiple rules enabled at the same time, the CMTS uses the type, threshold, method, and weight parameters that cause the most active load balancing. Each parameter is chosen independently and may come from one or more enabled rules.
The following is a priority list from highest to lowest: 1 The order of preference for type is: a
bonded
b
both
c
dynamic
d
static
2 The order of preference for method is: a
utilization
b
modem count
3 The threshold used is the lowest value. 4 The order of precedence for weight type is:
Cross-CAM Dynamic Load Balancing
34-10
a
equal
b
usOnly
c
dsOnly
d
usPlus
e
dsPlus
The cross-MAC Domain dynamic load balancing moves the cable modem assignment from one MAC Domain to a different one based on the conditions of one or more of its upstream or downstream channels. The new MAC Domain will have different US and DS channels because a channel cannot be in more than one MAC Domain.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
The following guidelines apply to the cross-MAC Domain dynamic load balancing feature:
Dynamic Load Balance Intervals
•
Up to four cable-macs residing on the same fiber node are supported.
•
Up to three upstream CAMs and/or three downstream CAMs residing on the same fiber node are supported.
•
The MAC Domains are members of the same cable bundle.
•
General Load Balancing Groups must be configured with the same load balancing policy.
The CMTS implements the dynamic load balancing as a periodic audit. The period between audit runs is configurable by the operator. There are two system parameters for load balancing activation for all restricted and general load balancing groups: •
MAC-domain-check-interval interval between checks for load balancing within a single MAC Domain.
•
across-MAC-domain-check interval interval between checks for load balancing across MAC Domains.
Both of these parameters are specified in seconds. If the interval value is set to zero, then periodic dynamic load balancing is disabled. Zero is the default for the across-MAC-domain-check; 300 seconds is the default for the MAC-domain-check-interval. For normal operations these parameters should not be set below 60 seconds. In special cases requiring rapid load balancing these values may be temporarily set to lower values. For example, when adding new downstream or upstream channels to a system, rapid load balancing can be used to quickly move cable modems to the new channels. When the channels reach balance, these parameters should be set back to a value of 60 seconds or more to avoid excessive cable modem moves between channels during normal operation. At every MAC-domain-check-interval the CMTS analyzes the load on the channels within a MAC Domain using one of the two methods (count or utilization). If needed, it initiates a Dynamic Channel Change (DCC) of a modem from the heaviest loaded channel pair to the lightest. In this way the channels within a single MAC Domain gradually approach being balanced over time without excessive impact on system performance.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-11
34 Load Balancing
C4/C4c CMTS Rel. 7.4
configure cable load-balance macdomain-check ... This command configures the intra-MAC-domain load balancing check interval.
Sets the intra-MAC-domain load balancing checking interval. Value is in seconds.
no
Returns intra-MAC-domain checking interval to default value. (Default is 300 seconds.) At the end of each across-MAC-domain-check interval the CMTS analyzes the need for load balancing across MAC Domains. Each CAM reports the load for each of its downstream channels that belong to load balancing groups. If needed, the CMTS directs the MAC Domain channel with the heaviest load to DCC a single modem to the most lightly loaded MAC Domain channel in that load balancing group.
configure cable load-balance across-macdomain-check ... This command configures the cross MAC Domain dynamic load balancing check interval for load balancing groups consisting of channels from all CAMs for release 7.4 and later.
Sets the intra-MAC-domain load balancing checking interval. Value is in seconds.
no
Returns intra-MAC-domain checking interval to default value. (Default is 0.)
NOTE Cross MAC Domain dynamic load balancing and intra-MAC-Domain load balancing are independent processes in the CMTS.
CLI Commands for Load Balancing This section provides the procedure to create a minimal configuration for your system as well as additional commands used to configure and display Load Balancing information. For more details, see the “List of Commands”.
34-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Minimal Configuration If no load balancing configuration commands are entered, by default, load balancing would be configured as follows (and shown in the example output below). •
A general group default policy (0) is created.
•
A default rule is created and associated with the general group default policy. It has the following default settings:
•
- The rule is “enabled” - The type is “both” - The method is “modem” - The threshold is “10 percent” - The channel-weight is “equal” - All steering attributes are false - The disable-period is not set. A GLBG is created for each MD-CM-SG
•
Each GLBG is associated with the general group default policy, therefore, each GLBG is enabled.
•
The “init-technique” of the general group default policy is disabled, which in effect, disables periodic load balancing for each of the GLBGs.
The following are additional load balancing default settings: •
The periodic load balancing interval is set to 300 seconds.
•
The periodic cross-MAC-domain/cross-CAM load balancing interval is set to 0 seconds (disabled).
•
The downstream-start-threshold is set to 1 percent.
•
The upstream-start-threshold is set to 1 percent.
•
The failed-list exclude-count is set to 1.
•
The failed-list timeout is set to 0, which implies that modems that fail a DCC will remain on the failed list indefinitely.
To display the default load balance values for the minimal configuration, enter: C4# show cable load-balance Load Balance :
Enabled
Init Technique:
Disable
Mac Domain Check (sec) :
300
Across Mac Domain Check (sec) :
0
Downstream Start Threshold (% utilization) : 1
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-13
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Upstream Start Threshold (% utilization) :
1
Failed-list age out time (in hours):
0
Failed-list exclude count:
1
Number of CMs to check per Interval:
10
C4# show cable load-balance group
Group -----------------16781312 25171968 33562624 41953280 50343936 58734592
EnaInit Cable bled Policy Tech mCMsg ---- ---------- --------- ----yes yes yes yes yes yes
0 0 0 0 0 0
disable disable disable disable disable disable
2 3 4 5 6 7
Mac Fiber-Node Type Service Type Id ----- ---------------- ---------- ----------------------1 2 3 4 5 6
FN1 FN1 FN1 FN1 FN1 FN1
General General General General General General
-
C4# show cable load-balance policy Steering Thres Disable Registration Periodic Channel Policy Rule Enabled -hold Type Method Start Period D2.0 D3.0 D2.0 D3.0 Weight ---------- ---------- ------- ----- ------- ------ ------------------ ----- ----- ----- ----- ------Default(0) - yes 10% both modem 00:00:00 00:00:00 -
If the default load-balance parameters meet your configuration needs, the next step is to configure the init-technique. (See more details on init-technique at DCC across MAC Domains Using MIBs, page 34-26.) Entering the following command will provide the parameter options and descriptions: configure cable load-balance general-group-defaults init-technique ? where the parameters are: unicast-ranging - Performs unicast ranging on new channel before normal operation reinit-mac - Reinitialize the MAC broadcast-ranging — Perform broadcast initial ranging on a new channel before normal operation ranging - Perform either broadcast or unicast ranging on new channel before normal operation direct - Use the new channel(s) directly without re-initializing or ranging disable — No load balancing will be done for this group.
34-14
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Setting the init-technique is the minimum configuration change required to enable load balancing. An example of this command is: configure cable load-balance general-group-defaults init-technique ranging Other recommended changes are: configure cable load-balance failed-list timeout 48 configure cable load-balance failed-list exclude-count 3 This results in a load balancing configuration that looks as follows. C4# show cable load-balance Load Balance :
Enabled
Init Technique:
Ranging
Mac Domain Check (sec) :
300
Across Mac Domain Check (sec) :
0
Downstream Start Threshold (% utilization) : 1 Upstream Start Threshold (% utilization) :
1
Failed-list age out time (in hours):
48
Failed-list exclude count:
3
Number of CMs to check per Interval:
10
C4# show cable load-balance group
Group -----------------16781312 25171968 33562624 41953280 50343936 58734592
Issue 2.0
EnaInit Cable bled Policy Tech mCMsg ---- ---------- --------- ----yes yes yes yes yes yes
0 0 0 0 0 0
ranging ranging ranging ranging ranging ranging
2 3 4 5 6 7
Mac Fiber-Node Type Service Type Id ----- ---------------- ---------- ----------------------1 2 3 4 5 6
FN1 FN1 FN1 FN1 FN1 FN1
General General General General General General
ARRIS PROPRIETARY — All Rights Reserved
-
34-15
34 Load Balancing
C4/C4c CMTS Rel. 7.4
C4# show cable load-balance policy Steering Thres Disable Registration Periodic Channel Policy Rule Enabled -hold Type Method Start Period D2.0 D3.0 D2.0 D3.0 Weight ---------- ---------- ------- ----- ------- ------ ------------------ ----- ----- ----- ----- ------Default(0) - yes 10% both modem 00:00:00 00:00:00 -
Additional Load-Balance Commands This section provides other commands that support load balancing in the C4 CMTS. Command to Change Method The following is an example of how to change the default method of modem count to utilization: configure cable load-balance policy 1 rule 1 configure cable load-balance rule 1 method utilization configure cable load-balance general-group-defaults policy 1 Move Commands The commands provided here are used to manually move CMs to a new upstream or downstream channel. These commands can be used even if load balancing is disabled. This first command is used to manually move a CM to a new upstream and/or downstream channel (either intra or inter MAC Domain). It also supports moving the CM to a new MAC Domain on a different set of upstream or downstream CAMs. The following command utilizes DCC to move a modem (this does not work for D1.0 modems): NOTE This move command will be denied if a voice/UGS flow or multicast flow is up on the modem. configure cable modem move cable-downstream cable-upstream method {reinit-mac | broadcast-ranging | unicast-ranging |ranging | direct}
34-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
The command below can move a CM to a different channel that may or may not be on the same C4 CMTS. If issued with only the us-channel-id parameter but without the downstream frequency identified, this command applies only to a CM staying in the same CMTS. This command moves CMs by re-initing the CM followed by a downstream frequency override and/or an upstream channel override in the range response. It can be used to move all types of modems, including DOCSIS 1.0 modems. Enter the following command to move the CM to different channels: configure cable modem move [downstream-freq ] [us-channel-id ] Where chan is the US DOCSIS channel ID. Range = 1-255. Show Commands The commands in this section display the status of load balance groups or to identify cable modems that failed to respond to load balance commands. For more details on commands and parameters, see chapter CLI, Command Descriptions. Examples of outputs to various show commands are provided in the following pages. To display the load balance statistics: show cable load-balance statistics Sample output: Slot/ Oper LBal Init Load Dynamic Transfers Static Tranfers Port State State Group Tech %Util Counts In Out In Out ------ ----- ------- ---------- --------- ------------- --------------------- --------------------14/D0 IS enable 16781312 ucastRng 7 0 0 14/D1 IS enable 16781312 ucastRng 5 1 0 14/D2 IS enable 16781312 ucastRng 10 0 1 14/D3 IS enable 16781312 ucastRng 8 0 0 1/U0 IS enable 16781312 ucastRng 4 1 0 0 0 1/U1 IS enable 16781312 ucastRng 19 0 1 0 0
To display the provisioning for load balance groups: show cable load-balance group
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-17
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Sample output: EnaInit Cable Group bled Policy Tech mCMsg ---------- ---- ---------- --------- ----16781312 25171968 33562624 41953280
yes yes yes yes
1 1 1 1
bcastRng bcastRng bcastRng bcastRng
Mac Fiber-Node Type Service Type Id ----- ---------------- ---------- ----------------------
2 3 4 5
1 2 3 4
1 2 3 4
General General General General
-
To display provisioning for the load balance policy : show cable load-balance policy Sample output:
Policy ---------Default(0) 1
ThresRule Enabled hold Type ------ ------- ------ ----yes 10% both 1 yes 20% bonded
Method ---modem modem
Steering Disable Registration Periodic Start Period D2.0 D3.0 D2.0 D3.0 ----------------- ---- --- --00:00:00 00:00:00 00:00:00 00:00:00 True True True True
Channel Weight -----equal
To see which modems failed to respond to load balancing commands: show cable load-balance failed-list verbose Sample output: FAILED LOAD_BALANCE ATTEMPTS CM MAC ------------------------0013.0000.0003 (00.13.00)
Type -----DS-Dyn
From Channels DS US ------------5/0 13/0.0
Target Channels DS US ---------------5/2 13/2.0
Failed Timestamp Count ------- -----------------2 2010 1 20 14:38:33
The following commands display the channel load balance data for the various Channel Weight values: C4# show cable load-balance channels Dumping DsUsLoadSet for General Load Balance Group StatusId = 0x1001000, 16781312 Md 1, MdCmSg 2, FiberNode abc, Bundle Group: cable-mac 1 Policy 1, Active Type: BOTH, Active Method: MODEM, ChannelWeightOption: EQUAL Weighted DS IfIndex US IfIndex DS Load US Load Load ----- ------- ------- ------- ------- ------- -------5/2 400920 13/2.0 918057 20 20 40 5/2 400920 13/0.0 918041 20 15 35 5/0 400904 13/0.0 918041 15 15 30 5/3 400928 13/0.0 918041 10 15 25 5/3 400928 13/9.0 918113 10 10 20 5/1 400912 13/1.0 918049 10 10 20
34-18
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
C4# configure cable load-balance rule 1 channel-weight US-only C4# show cable load-balance channels Dumping DsUsLoadSet for General Load Balance Group StatusId = 0x1001000, 16781312 Md 1, MdCmSg 2, FiberNode 1, Bundle Group: cable-mac 1 Policy 1, Active Type: BONDED, Active Method: MODEM, ChannelWeightOption: US ONLY Weighted DS IfIndex US IfIndex DS Load US Load Load ----- ------- ------- ------- ------- ------- -------14/0 990728 1/1.0 131617 9 14 14 14/1 990736 1/1.0 131617 6 14 14 14/2 990744 1/1.0 131617 6 14 14 14/3 990752 1/1.0 131617 6 14 14 14/0 990728 1/0.0 131609 9 13 13 14/1 990736 1/0.0 131609 6 13 13 14/2 990744 1/0.0 131609 6 13 13 14/3 990752 1/0.0 131609 6 13 13
C4# configure cable load-balance rule 1 channel-weight US+ C4# show cable load-balance channels slot 1 Dumping DsUsLoadSet for General Load Balance Group StatusId = 0x1001000, 16781312 Md 1, MdCmSg 2, FiberNode 1, Bundle Group: cable-mac 1 Policy 1, Active Type: BONDED, Active Method: MODEM, ChannelWeightOption: US+ Weighted DS IfIndex US IfIndex DS Load US Load Load ----- ------- ------- ------- ------- ------- -------14/0 990728 1/1.0 131617 9 14 37 14/0 990728 1/0.0 131609 9 13 35 14/1 990736 1/1.0 131617 6 14 34 14/2 990744 1/1.0 131617 6 14 34 14/3 990752 1/1.0 131617 6 14 34 14/1 990736 1/0.0 131609 6 13 32 14/2 990744 1/0.0 131609 6 13 32 14/3 990752 1/0.0 131609 6 13 32
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-19
34 Load Balancing
C4/C4c CMTS Rel. 7.4
C4# configure cable load-balance rule 1 channel-weight DS-only C4# show cable load-balance channels Dumping DsUsLoadSet for General Load Balance Group StatusId = 0x1001000, 16781312 Md 1, MdCmSg 2, FiberNode 1, Bundle Group: cable-mac 1 Policy 1, Active Type: BONDED, Active Method: MODEM, ChannelWeightOption: DS ONLY Weighted DS IfIndex US IfIndex DS Load US Load Load ----- ------- ------- ------- ------- ------- -------14/0 990728 1/1.0 131617 9 14 9 14/1 990736 1/1.0 131617 6 14 6 14/2 990744 1/1.0 131617 6 14 6 14/3 990752 1/1.0 131617 6 14 6 14/0 990728 1/0.0 131609 9 13 9 14/1 990736 1/0.0 131609 6 13 6 14/2 990744 1/0.0 131609 6 13 6 14/3 990752 1/0.0 131609 6 13 6
C4# configure cable load-balance rule 1 channel-weight DS+ C4# show cable load-balance channels Dumping DsUsLoadSet for General Load Balance Group StatusId = 0x1001000, 16781312 Md 1, MdCmSg 2, FiberNode 1, Bundle Group: cable-mac 1 Policy 1, Active Type: BONDED, Active Method: MODEM, ChannelWeightOption: DS+ Weighted DS IfIndex US IfIndex DS Load US Load Load ----- ------- ------- ------- ------- ------- -------14/0 990728 1/1.0 131617 7 13 27 14/1 990736 1/1.0 131617 6 13 25 14/2 990744 1/1.0 131617 6 13 25 14/3 990752 1/1.0 131617 6 13 25 14/0 990728 1/0.0 131609 7 12 26 14/1 990736 1/0.0 131609 6 12 24 14/2 990744 1/0.0 131609 6 12 24 14/3 990752 1/0.0 131609 6 12 24
Failed List Operation
Modems may appear in the load balance failed list multiple times, once for each DS/US channel pair that it has failed to move to. The load balancing software will consider a DS/US channel pair as a valid target for a given modem unless that modem has failed to move to that channel pair the exclude-count (default is 1) number of times. Until the modem has failed the exclude-count number of times for every DS/US channel-pair in the associated fiber-node, the modem will still be considered a candidate for load balancing. Modems can appear on the failed list for a number of reasons including the modem does not handle DCC well, the fiber-node/connectors on the CMTS
34-20
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
are configured incorrectly or there was an RF issue causing the DCCs to fail for a period of time. Following a period of RF issues on a given fibernode, it is recommended that the failed list be cleared to give the load balancing software a larger pool of modems from which to choose so that the load balancing software is more effective. The list can be cleared as needed by support personnel with the command: clear cable load-balance state Aging out Failed Modems — Modems on the failed-to-load-balance list will be aged out when the timeout value is non-zero. configure cable load-balance failed-list timeout x Where x is the number of hours that a failed modem stays on the list. The minimum setting is one hour. The default value of 0 means that the modems will never be removed from this list unless you manually clear the list. It is recommended that this value be set to a value such as 48 to allow for transient DCC issues caused by things such as cable cuts, etc. Time is taken from the CMTS's internal clock. It does not automatically adjust for calendar changes such as daylight savings time. To confirm the aging-out setting, use the following command: show cable load-balance Failed-list exclude-count — By default a modem will only be allowed to fail being moved to a given DS/US channel pair a single time. It has been observed that load balancing is more effective when the default value of 1 is changed to a value like 3. This prevents the failed-list from getting excessively large, which limits the number of modems that are available and may negatively impact the effectiveness of the load balancing software. configure cable load balance failed-list exclude count x
Where x is the number of times that the modem has failed to move to each DS/US channel pair in the load balance group. Displaying the failed-list — To display the general list failed modems, enter: show cable load balance failed-list The failed list by default only shows the modems that have reached the exclude-count limit for any given channel pairs. To see failures to channel pairs that have not yet reached the exclude-count limit, use the verbose option below: show cable load balance failed-list verbose
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-21
34 Load Balancing
C4/C4c CMTS Rel. 7.4
If the exclude-count parameter is set to the default value of 1, then the verbose option has no effect on the output of the show command. Exclude Modems from Load Balancing — Modems that continually fail to move to less loaded channels when instructed to do so by a load balancing DCC or should not be DCC'd for other reasons can be excluded from subsequent load balancing attempts by either adding the modem to the exclude-list or by creating a restricted load balance group that is disabled. One way to exclude a modem from load balancing is to add the Organizationally Unique Identifier (OUI) to the exclude-list: configure cable load-balance exclude oui 001596 The other way to exclude a modem from load balancing is to create a restricted load balance group that is disabled and assign modems to that group. Use the following commands to create a restricted load balance group: configure interface cable-mac 1 cable load-balance group 99 configure cable load-balance policy 99 rule 99 configure interface cable-downstream 14/0 cable load-balance group 99 configure interface cable-upstream 1/0.0 cable load-balance group 99 configure interface cable-mac 1 cable load-balance group 99 policy 99 configure interface cable-mac 1 cable load-balance group 99 init-technique disable configure interface cable-mac 1 cable load-balance group 99 enable To add a modem to this group: configure cable load-balance include cm-mac 00.15.96.2a.65.9c mac-mask ff.ff.ff.ff.ff.ff group 99
You can configure any modem to that group even if it is not in the same cable-mac. Then reset the modem to make it an active part of this group: clear cable modem delete To see what group a modem is assigned to, enter either of the following: show cable modem column mac load-bal - or show cable modem detail
34-22
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Interaction with Older Cable Modems Load balancing uses DCC commands to move Cable Modems after they are registered. DOCSIS 1.0 CMs and their configuration files do not support DCC. These CMs can still be load balanced on upstream channels within a MAC Domain by static load balancing. Static load balancing will move the CMs to a less loaded upstream channel via an upstream channel override as the CMs first range, prior to their registration. Once a DOCSIS 1.0 CM is registered it remains on its upstream channel until it is reset. If you configure a policy for a load balancing group, set the TYPE to BOTH, in order to use static load balancing for DOCSIS 1.0 CMs and Dynamic Load Balancing for DOCSIS 1.1 and later CMs. By default, a load balancing group TYPE is set to BOTH. DOCSIS 1.1 and 2.0 CMs with CM software released prior to 2005 are known to have some difficulties with DCC commands. The following suggestions should maximize the chances for older CMs to successfully move between channels: •
If at all possible, upstream channels within a dynamic load balancing group should have identical modulation profiles and channel width.
•
If using ATDMA or SCDMA channels, dynamic interleaving should be disabled.
•
If moving older CMs running Baseline Privacy Interface (BPI) across MAC Domains, the recommended DCC technique is reinit-mac. Any other technique for moving the CMs should be tested in the lab. Older CMs running BPI are known to have a problem with BPI rekeying after being moved across MAC Domains with initialization techniques other than reinit-mac. When this problem occurs, the DCC succeeds, but the CM cannot send or receive data.
Load Balancing of Bonded Cable Modems There are two types of load balancing that may occur on a bonded cable modem. The first type only affects D3.0 bonded modems. For this type, the CMTS will give the bonded modem a Receive Channel Set (RCS) based on the DS load of the channels at the time the bonded modem is registering. This RCS is sent to the modem in the Registration Response (REGRSP). The CMTS will choose the least loaded DS channels for the RCS, effectively load balancing the primary and all non-primary DS channels of that bonded modem. To enable this type of load balancing, the bonded
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-23
34 Load Balancing
C4/C4c CMTS Rel. 7.4
modems only need to be associated with a load balancing group that is enabled. This functionality is effective for balancing the DS channels for bonded modems. The second type of load balancing that can occur to a bonded modem is very similar to the 'dynamic' DCC type of load balancing that occurs for D1.1 and D2.0 modems, except it allows the DCC of bonded modems. This type is effective for both D2.0b and D3.0 bonded modems. By default this is disabled because bonded modems can only be DCC'd with the reinit-mac technique regardless of the init technique configured in the CLI, which is disruptive to end users. Similar to the Dynamic type load balancing, the CMTS will load balance via DCC the bonded modems at periodic intervals. Keep in mind that this will load balance only the primary US and primary DS of the bonded modem. The non-primary DS/US channels of a bonded modem cannot be moved via DCC. This type of load balancing requires the 'bonded' type to be specified in the load balance rule. The CMTS will only choose to move a bonded modem if there are no non-bonded modems that it can move instead. NOTE Cross-MAC Domain movement of both downstream and/or upstream bonded CMs is supported but only with the re-init MAC initialization technique. Load balancing on bonded 3.0 CMs affects only the primary US and DS channels.
Distributing Bonded CMs across Downstreams at Registration Time When a CM sends a bonded registration request and the CM is in an MD-CM-SG that corresponds to an enabled load balance group, the C4 will attempt to assign a Receive Channel Set (RCS) that includes the least loaded downstreams in the MD-CM-SG. The RCS is sent to the modem in the range response prior to registration. This only applies to DOCSIS 3.0 CMs since DOCSIS 2.0b CMs do not support changing their primary DS channel when they register. When assigning the RCS for DOCSIS 3.0 CMs, the CMTS may change both the primary and non-primary downstreams in the RCS sent in the registration response based on load.
34-24
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Load balancing of the downstreams in the RCS only occurs when all of the following is true: •
DOCSIS 3.0 load balancing is enabled.
•
The modem is a DOCSIS 3.0 modem with Multiple Receive Channel Mode (MRCM) enabled for both the MAC Domain and the modem.
•
There are multiple candidates where: -
Channel sets are of equal size. i.e., same number of downstream in each set. Channel sets both equally satisfy the service flow attributes.
This feature presumes that dynamic bonding groups and dynamic Receive Channel Configurations (RCCs) are enabled. This is because dynamic bonding groups will provide the maximum number of downstreams to choose from when attempting to find the least loaded downstream set for the RCS. Also, this feature is to be used with general, i.e., not restricted, load balancing groups.
Load Balancing Bonded CMs at Regular Intervals At regular intervals, (set by load-balance macdomain-check) the dynamic load balancer will audit the channel load in each load balance group. If the load balance group has its rule type set to bonded, then bonded CMs are considered to be candidates for moving from heavily loaded channels to the lightest loaded channels. Since DCC is used to load balance D3.0 modems, only the primary DS or primary US of the CM will be moved. NOTE Non-bonded DOCSIS 3.0 modems will be treated like DOCSIS 2.0 modems with regard to load balancing.
NOTE Bonded CMs will always be moved using DCC init technique reinit-mac. Multiple rules can be assigned to a load balance policy and a load balance group. If there are multiple rules enabled for a policy, then the load balancer gives priority to rules of type bonded over rules of the other types (static, dynamic, both). This allows an MSO to set up a configuration where a rule of type bonded may be disabled at certain times of the day. For example, they may want to load balance bonded CMs only during the maintenance window, since a DCC of a bonded CM causes it to flap. They may also set up a second rule of type both that is enabled at all times. The net effect is that non-bonded CMs will be load balanced at all times using
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-25
34 Load Balancing
C4/C4c CMTS Rel. 7.4
the initialization technique assigned to the group, and during the maintenance window bonded CMs will also be considered for load balancing using the reinit-mac init technique. An example of setting up bonded modem load balancing is: configure cable load-balance rule 1 enable configure cable load-balance policy 1 rule 1 configure cable load-balance rule 1 type bonded configure cable load-balance general-group-defaults policy 1 An example of setting up bonded modem load balancing so that it occurs only between 2 a.m. and 4 a.m.: configure cable load-balance rule 1 disable-period start-time 04:00:00 period 22:00:00 The following additional rule can be assigned to the policy so that nonbonded load balancing occurs during the remainder of the day: configure cable load-balance rule 2 enable configure cable load-balance rule 2 type both configure cable load-balance policy 1 rule 2
DCC across MAC Domains Using MIBs This feature provides an interface that supports the manual Dynamic Channel Change (DCC) of CMs across Mac Domains on either separate US CAMs or the same US CAM. NOTE The configure cable modem move command allows for this same functionality and is the preferred method. An MSO can send a DCC command to a specific CM by setting the fields in the docsLoadbal3ChgOverGroup MIB.
34-26
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
This Load Balancing feature supports setting and acting on the following docsLoadBalChgOverGroup values: •
docsLoadbal3ChgOverGroupMacAddress
•
docsLoadbal3ChgOverGroupInitTech
•
docsLoadbal3ChgOverGroupdownFrequency
•
docsLoadbal3ChgOverGroupMdlfIndex
•
docsLoadbal3ChgOverGroupUsChSet
•
docsLoadbal3ChgOverGroupCommit.
The DCC command accepts only a single upstream channel ID, therefore, the docsLoadbal3ChgOverGroupUsChSet MIB can only be set to a single US channel ID. The range is 1-255. The CMTS supports several cross-checks when setting the MIB value, including: •
The Mac Domain IfIndex must exist.
•
A downstream must exist and match the docsLoadbal3ChgOverGroupdownFrquency.
•
The upstream channel ID must exist on the CMTS on the specified Mac Domain.
The command will be rejected with an error message if any of these items are invalid when a ChgOverGroupCommit is attempted. DCC Init Technique
DCC’ing a CM across Mac Domains requires the reinit-mac to successfully accomplish the process. If any other init technique is used, the command will be rejected in Release 7.3 and earlier. When setting the init technique bits in the MIB, refer to the following values: •
0x80 = reinit-mac
•
0x40 = broadcast-ranging
•
0x20 = unicast-ranging
•
0x10 = ranging
•
0x08 = direct
All of the above init techniques are supported for D1.1 and D2.0 cable modems. This applies to both dynamic cross-MAC Domain load balancing as well as load balancing across MAC Domains using MIBs and DCC.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-27
34 Load Balancing
Moving to an SCDMA US Channel
C4/C4c CMTS Rel. 7.4
In the case of modem steering or load balancing a CM to an SCDMA upstream channel, the following apply: •
If the general load balance group specifies either initialization type 0 or 1, then that technique is used as is (no overriding is necessary).
•
If the GLBG specifies an init technique greater than 1 (type 2, 3 or 4), then it will be overridden to be type 1 (broadcast initial ranging).
Bonded CMs always use the reinit-mac initialization technique. Summary of Rules for DCC Init
The following list summarizes the load balancing rules for various types of CMs: •
DOCSIS 1.0 CMs: No DCC is allowed.
•
DOCSIS 1.1 and 2.0 CMs: DCC with all init techniques is supported.
•
DOCSIS 2.0b and 3.0 CMs: CMs are always moved using the reinit-mac technique.
Downstream and Upstream Utilization Start Thresholds Separate load balancing start thresholds are set globally for upstream and downstream channels. They are used to prevent the load balancing feature from moving CMs when channels are lightly loaded. An MSO can use start thresholds to define when channel loading is great enough to begin moving modems from channels that have exceeded the threshold to lightly loaded channels. If no channels in the load balance group exceed either start threshold, the load balancer does not attempt to balance the channels. By default, the minimum start thresholds are set to 1%, which means they have will have no effect unless explicitly configured to be a higher value. For example, an MSO might set this minimum threshold to a value of 30%, based on the reasoning that if all the channels in a load balance group are under 30% loaded, it is not necessary for the channels to be in balance. In load balancing the start threshold is not the same as the rule threshold. The start threshold determines when load balancing is allowed to begin; the rule threshold defines how much of a difference between the highest and least loaded channels is acceptable. If the rule threshold is set to 10%, and the most heavily loaded channel in the group is 50% full and the least loaded channel is 40% full, then no CMs will be moved. Once the heaviest channel becomes 51% full or the lightest channel becomes 39%
34-28
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
full, then load balancing will start to move modems, assuming that the start threshold has been exceeded. Load balancing occurs only when the rule threshold is exceeded. By default, the rule threshold is set to 10%. Table 34-1: Effect of Start and Rule Thresholds on Load Balancing If threshold settings are
And if Channel…
Then Load Balancing
But if Channel…
Then Load Balancing
Rule = 10% Start = 30%
A is 30% loaded B is 10% loaded
does not move modems
A is 31% loaded B is 10% loaded
does move modems from Channel A to B
Rule = 10% Start = 30%
A is 40% loaded B is 30% loaded
does not move modems
A is 40% loaded B is 29% loaded
does move modems from Channel A to B
When the load balancing method is set to utilization, it is obvious to see if the rule threshold (a percentage) is exceeded because the load on each channel is a percentage. However, when the load balancing method is set to modem, it's not as obvious because the DS load and US load for each channel is the count of the modems on each channel, not a percentage. To determine if the rule threshold is exceeded, the rule threshold is converted to a count for both the DS and US. This is done by multiplying the rule threshold (as a percentage) with the DS load of the heaviest loaded channel pair, and by multiplying the rule threshold (as a percentage) with the US load of the loaded heaviest channel pair. For example, if the loaded heaviest channel pair has 50 modems on the DS and 40 modems on the US, for a rule threshold of 10%, the count threshold is 5 for the DS and 4 for the US. In this case, load balancing would continue to occur when the difference in load between the heaviest loaded channel pair and the lightest channel pair was greater than 5 for the DS or greater than 4 for the US. To configure the thresholds used as an example in Table 34-1, use the following commands: configure cable load-balance downstream-start-threshold 30 configure cable load-balance upstream-start-threshold 30 To verify your settings, use the following show command: show cable load-balance Load Balance : Enabled Mac Domain Check (sec) : 30 Across Mac Domain Check (sec) : 0 Downstream Start Threshold (% utilization) : 30
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-29
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Upstream Start Threshold (% utilization) : Failed-list age out time (in hours): Failed-list exclude count: Number of CMs to check per Interval:
30 0 1 10
NOTE If the start thresholds for downstream channels are exceeded, the load balancer will move CMs to balance the downstream even if the start thresholds for that downstream’s upstream channels have not been exceeded. And if the thresholds for an upstream channel have been exceeded, the load balancer will move modems to achieve upstream balancing even if the downstream channel thresholds have not been exceeded.
Load Balance Rule-based Modem Steering You can configure the Modem Steering feature to move DOCSIS 2.0 or 3.0 modems, if they register on a TDMA or TDMA/ATDMA (T-A) channel, to the least loaded ATMDA or SCDMA channel. The move takes place either immediately following registration or periodically. DOCSIS 2.0 modems use the init-technique which is associated with their load balance group. Bonded modems use the reinit-mac technique. Modem Steering with Mixed TDMA/ATDMA Channel Support
The modem steering feature with mixed mode channels supports modem steering from either a TDMA or T-A channel to an ATDMA or SCDMA channel as long as the load balancing policy is set to steering. NOTE This applies to both registration and periodic modem steering.
NOTE Modem steering only moves modems within a cable-mac.
34-30
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
CAUTION
Caution should be used when enabling the DOCSIS 2.0 modem steering feature as some modems have issues successfully re-registering if they receive a DCC immediately following their initial registration. The C4 CMTS provides for intra- and inter-MAC Domain load balancing among the TDMA, T-A, ATDMA, and SCDMA upstream channel types, depending on the modem version as described below. If the configuration is such that the modem steering flags are set to enable steering on D2.0 devices but set to disable D3.0 modem steering, then the following applies: •
D3.0 cable modems (CMs) are load balanced across the set of available TDMA, T-A, ATDMA, and SCDMA channels.
•
D2.0 CMs are steered to ATDMA or SCDMA channels.
•
D2.0 CMs are load balanced across the set of available ATDMA and SCDMA channels.
•
D1.1 and D1.0 modems are load balanced across the set of available TDMA and T-A channels.
If the modem steering flags are set to enable both D2.0 and D3.0 CMs, load balancing is supported as follows: •
D2.0 and D3.0 CMs are load balanced across ATDMA and SCDMA channels.
•
D2.0 and D3.0 CMs are steered to ATDMA and SCDMA channels.
•
D1.1 and D1.0 CMs are load balanced among remaining TDMA and TA upstream channels.
NOTE When steering a modem either to or from an Upstream SCDMA channel, the C4 CMTS will use init-technique broadcast ranging regardless of the init-technique specified by the CLI. The exception is if the init-technique is reinit-mac in which case, reinit-mac will be used. Balancing D2.0 Modems While Steering D3.0 Devices
This load balancing enhancement allows for utilizing bandwidth capabilities of the ATDMA and SCDMA channels for D3.0 modems while providing even distribution options for the D2.0 CMs across the remaining TDMA and T-A channel types. NOTE This applies to both registration and periodic modem steering.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-31
34 Load Balancing
C4/C4c CMTS Rel. 7.4
This enhancement supports configurations where modem steering flags are set to enable steering on D3.0 devices but set to disable D2.0 device steering. The C4 CMTS provides for intra- and inter-MAC Domain load balancing among the TDMA, T-A, ATDMA, and SCDMA upstream channel types, depending on the modem version. The following configurations apply: •
D2.0 CMs are inter- and intra-MAC Domain load balanced across available TDMA, T-A, ATDMA, and SCDMA channels.
•
D1.1 and D1.0 CMs are load balanced across available TDMA and T-A channels.
•
D3.0 CMs are steered to ATDMA and SCDMA channels.
•
D3.0 CMs are load balanced across available ATDMA and SCDMA channels.
NOTE Cross-checks verify that the CM to be moved has a CM config boot file version level greater than DOCSIS 1.0. Use the following commands to configure rule-based modem steering: configure cable load-balance rule x registration-steeringD2 configure cable load-balance rule x registration-steeringD3 configure cable load-balance rule x periodic-steeringD2 configure cable load-balance rule x periodic-steeringD3 Where x is the number of the rule. When enabling either registration or periodic D3.0 modem steering on the C4 CMTS in conjunction with USCB, it is recommended that any D2.0 capable US channels (ATDMA/SCDMA) in the mac-domain be configured such that they are the lowest numbered channels in the cable-mac. This applies to configurations in which the cable-mac(s) configured for the D3.0 modems contain a mix of non-D2.0 (TDMA & T-A) and D2.0 (ATDMA & SCDMA) channels and the number of upstreams configured in the cablemac is greater than the number of US channels being bonded. This is done to help ensure that the non-primary US channels of the bonded modem will end up on D2.0 capable channels. The Transmit Channel Set (TCS) calculated by the CMTS (if all US channels have acceptable US power levels) is chosen from lowest to highest channel-id. Since load balancing of bonded modems is limited to the DCC of the primary US and the primary DS, non-primary US channels of the
34-32
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
USCB D3.0 modem will not be steerable to the D2.0 capable US channels once they are assigned. Configuring the cable-mac as recommended will prevent the non-primary US channels from using the non-D2.0 channels. The primary US channel will be steered to an ATDMA channel by modem steering. The following is an example of a 4x4 configuration:
Cable-mac 13 ============= Cable Oper DS Port Mac Conn State 11/0 13 0 IS 11/1 13 0 IS 11/2 13 0 IS 11/3 13 0 IS 11/4 13 1 IS 11/5 13 1 IS 11/6 13 1 IS 11/7 13 1 IS
Annex B(US) B(US) B(US) B(US) B(US) B(US) B(US) B(US)
Freq(Hz) 501000000 513000000 525000000 537000000 549000000 561000000 573000000 585000000
Cable Oper Mac Conn State 13 1 IS 13 1 IS 13 1 IS 13 1 IS 13 1 IS 13 1 IS
Chan Type atdma atdma atdma atdma t-a tdma
Freq(Hz) 8200000 11400000 18000000 28000000 32400000 38800000
US PORT 4/4.0 4/5.0 4/6.0 4/7.0 4/10.0 4/11.0
Mod Power Type (.1dBmV) q256 500 q256 500 q256 500 q256 500 q256 500 q256 500 q256 500 q256 500 Channel Width 3200000 3200000 3200000 3200000 3200000 3200000
Mini Slot 4 4 4 4 4 4
Spare Group 15 15 15 15 15 15 15 15
Mod Power Prof (dBmV) 115 0 115 0 115 0 115 0 105 0 6 0
LBal Group 117475328 117475328 117475328 117475328 117475328 117475328 117475328 117475328 LBal Group 117475328 117475328 117475328 117475328 117475328 117475328
Use the following show command to display the setting for the DOCSIS 2.0/3.0 registration steering feature: show cable load-balance policy Sample output:
Policy Rule ---------- ---------Default(0) 1 1
Issue 2.0
Enabled -------yes yes
Threshold Type ------ ------10% both 20% bonded
Disable Method Start Period ------ -----------------modem 00:00:00 00:00:00 modem 00:00:00 00:00:00
ARRIS PROPRIETARY — All Rights Reserved
Steering Registration Periodic D2.0 D3.0 D2.0 D3.0 ----- ----- ----- ----True True True True
34-33
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Service-type Modem Steering Service-type modem steering is designed to steer modems to specific interfaces. Service-type modem steering works in conjunction with the Load Balancing feature in the CMTS. The operator assigns a particular service-type ID to the modems to be steered and to the restricted load balancing groups containing the specific interfaces to which he/she wants those modems assigned. The service-type ID refers to the type of cable data service. The desired service-type ID is assigned to a modem either by associating its MAC address or its Organization Unique Identifier (OUI) with a particular service-type ID. Another way is by adding a Type-Length-Value (TLV) representing the service type to the modem’s config file. If there is a match between the service-type ID of the restricted load balancing group and the service-type ID defined in the modem’s config file or associated with its MAC address or OUI, then the CMTS assigns that modem to one or more upstream/ downstream pairs of that restricted load balancing group as soon as the modem registers. NOTE Service-type modem steering is supported by the 12U, 24U, 16D, and XD CAMs (24D and 32D). The following factors will prevent a cable modem from responding to the Service-type modem steering feature: •
Dynamic Load Balancing is disabled at the CMTS. By default load balancing is enabled on the CMTS. To turn it off, use configure cable load-balance enable no.
•
34-34
Dynamic Load Balancing is disabled for the load balancing group to which the modem belongs.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
By default a load balance group is enabled when created. To disable, use configure interface cable-mac x cable load-balance group y enable no.
Procedure 34-1
•
The cable modem has an OUI that is on the list of OUIs excluded from load balancing
•
The cable modem is a FlexPath modem. FlexPath has its own method for directing modems.
•
The cable modem has a policy that is disabled or is set for static load balancing only
•
The restricted load balance group has a policy that is disabled or is set to static load balancing only
•
The cable modem is on the failed list and has failed to move to all the channels in its restricted load balance group.
Example of Service-type Modem Steering Configuration The following procedure is an example of how to configure and enable the Service-type modem steering feature. 1 Create a restricted group and apply the service-type ID to that group:
configure interface cable-mac 1 cable load-balance group 100 configure interface cable-mac 1 cable load-balance group 100 enable configure interface cable-mac 1 cable load-balance group 100 init-technique ranging configure interface cable-mac 1 cable load-balance group 100 service-type "abc" In this example the restricted load balance group is given the number 100, the initialization technique is ranging, and the service type is named abc. NOTE If no init-technique is set then the default is broadcast-ranging except for the case of 2.0B or 3.0 CMs which must get an initialization technique of reinit-mac. 2 Assign the interfaces to the restricted load balance group: configure interface cable-downstream 14/0 cable load-balance group 100 configure interface cable-downstream 14/1 cable load-balance group 100 configure interface cable-downstream 14/2 cable load-balance group 100
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-35
34 Load Balancing
C4/C4c CMTS Rel. 7.4
configure interface cable-downstream 14/3 cable load-balance group 100 configure interface cable-upstream 1/0.0 cable load-balance group 100 configure interface cable-upstream 1/1.0 cable load-balance group 100 In this example the downstream channels are slot 14 channels 0-3. The upstream channels are slot 1 channels 0 and 1.
3 Confirm the creation of the restricted group and service type: show cable load-balance group 100 Sample system response: Group
Enabled
------- ---100 yes
Policy
Init Tech
Cable mCMsg
Mac
Fiber-Node
Type
Service Type Id
------- --------- ----- ----- ------------ ---------- --------0 ranging 1 Restricted abc Unlike general groups, restricted groups do not have MD-CM-SGs or fiber nodes assigned to them. 4 Assign modems to the service type:
configure cable load-balance include cm-mac 0015.cf1b.b1b2 mac-mask ffff.ffff.ffff service-type "abc" configure cable load-balance include cm-mac 000f.9f00.0000 mac-mask ffff.ff00.0000 service-type "abc"
5 (Optional) Add the TLV to the CM confide file. This will set TLV 43.11 in the CM config file. When the CM registers, it will be steered to the US/DS pair in group 100. (See Figure 34-1 below.)
34-36
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
34 Load Balancing
C4/C4c CMTS Rel. 7.4
Figure 34-1: Adding Service-Type ID to the CM Config File 6 (Optional) As an alternative to setting the service-type ID in the config file, use the following CLI command to associate OUIs with the desired servicetype ID: configure cable load-balance include oui arris service-type “abc” 7 Confirm the assignment of service type abc using the OUI: show cable load-balance oui Sample system response: INCLUDE (OUI/CM-MAC) I/X MAC address Mac mask Group --- -------------- -------------- ------I 0015.cf1b.b1b2 ffff.ffff.ffff I 000f.9f00.0000 ffff.ff00.0000 -
C4Prov Srv Type -------------abc abc
I/X:I=include/X=exclude
8 (Optional) You can also use the include command to set 1-6 bytes of a CM MAC to the desired service type: configure cable load-balance include cm-mac 0000ca service-type “abc” NOTE If a CM config file and the CMTS provisioning specify different servicetype IDs, the CMTS provisioned value takes precedence.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
34-37
34 Load Balancing
C4/C4c CMTS Rel. 7.4
9 Enter the following command to display the service type provisioned for cable modems and the CMTS: show cable load-balance cm-service-type Sample output (incomplete): MAC Address Grp Id CMProv Srv Type Grp Id C4Prov Srv Type Policy Id -------------- ---------- ------------------ ---------- --------------- ---------000f.9f7a.eaf8 0 (xyz) 100 abc 0 In this example, the CMTS service type takes precedence over the CM provisioning. The CM provisioned service type, xyz, is in parentheses to indicate that it is not being used.
34-38
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
35
Packet Throttling
Topics
Page
SCM Packet Throttling
1
RCM Protocol Policing
2
Upstream Cable Protocol Throttling
5
ARP/ND Abuse Counts
11
Token Bucket 3.0: Traffic Shaping on 16D/XD CAMs
14
SCM Packet Throttling Packet throttling prevents or limits the impact of denial of service (DoS) attacks or of defective cable modems or CPEs that generate excessive numbers of DHCP or ARP packets. The CMTS has the ability to throttle the rate at which packets are forwarded to the SCM modules. Packet throttling for the SCM is indiscriminate: you can throttle the overall packet rate but not individual packet types. To configure protocol throttling for the SCM, use the following command: configure slot 19 proto-throttle-rate Where
Issue 2.0
slot number = packets =
19 or 20 number of packets per second
ARRIS PROPRIETARY — All Rights Reserved
35-1
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
valid range =
0-65535 0 = “allow none”.
RCM Protocol Policing This feature is also known as Improved Denial-of-Service Attack Protection. This feature allows the CMTS to select and police packets destined for the RCM processor according to packet protocol type. By selectively throttling undesired protocol packets, the CMTS can continue to function as a router during malicious attacks. This alleviates the impact of various denial of service (DoS) attacks, because critical packets continue to be processed by the CMTS. Use the following command to set global or protocol-specific packet throttling for the RCM: configure slot proto-throttle-rate {arp|bgp|cops|dhcp|icmp|igmp|isis| ospf|ospfv3|pim|rip|snmp|snmp-cm|telnet|tftp|other} Where
slot number = packets per second =
17 or 18 for the RCM a valid range of 0-65535 0 = “allow none”.
If none of the optional protocol types are specified, the command serves to set the global throttle rate (total of all packet types) allowed through the RCM. Use the following command to display protocol-throttling settings and counts: show proto-throttle-rate The following is a example of the system output: Protocol Throttle Rates ----------------------RCM global packet rate:
35-2
2500 packets/second
ARP packet rate:
700 packets/second
DHCP packet rate:
750 packets/second
ICMP packet rate:
500 packets/second
OSPF packet rate:
750 packets/second
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
IPv6 OSPF packet rate:
750 packets/second
RIP packet rate:
500 packets/second
IGMP packet rate:
500 packets/second
SNMP packet rate:
650 packets/second
TFTP packet rate:
750 packets/second
IS-IS packet rate:
750 packets/second
ND packet rate:
700 packets/second
IPv6 ND packet rate:
700 packets/second
IPv6 DHCP packet rate:
500 packets/second
IPv6 ICMP packet rate:
500 packets/second
MLD packet rate:
500 packets/second
IPv6 MLD packet rate:
500 packets/second
BGP packet rate:
500 packets/second
PIM packet rate:
100 packets/second
SNMP-CM packet rate:
100 packets/second
COPS packet rate:
300 packets/second
TELNET packet rate:
300 packets/second
RCM other packet rate:
500 packets/second
SCM global packet rate:
900 packets/second
Protocol Received Counts -----------------------RCM global packets passed: RCM global packets dropped: ARP packets passed:
0 packets 1041 packets
ARP packets dropped:
0 packets
DHCP packets passed:
670 packets
DHCP packets dropped: ICMP packets passed: ICMP packets dropped: OSPF packets passed:
Issue 2.0
52201 packets
0 packets 198 packets 0 packets 30252 packets
OSPF packets dropped:
0 packets
RIP packets passed:
0 packets
RIP packets dropped:
0 packets
IGMP packets passed:
0 packets
IGMP packets dropped:
0 packets
ARRIS PROPRIETARY — All Rights Reserved
35-3
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
SNMP packets passed: SNMP packets dropped:
0 packets
TFTP packets passed:
0 packets
TFTP packets dropped:
0 packets
IS-IS packets passed:
0 packets
IS-IS packets dropped:
0 packets
ND packets passed:
0 packets
ND packets dropped:
0 packets
IPv6 DHCP packets passed:
0 packets
IPv6 DHCP packets dropped:
0 packets
IPv6 ICMP packets passed:
0 packets
IPv6 ICMP packets dropped:
0 packets
MLD packets passed:
0 packets
MLD packets dropped:
0 packets
BGP packets passed:
252 packets
BGP packets dropped:
0 packets
PIM packets passed:
0 packets
PIM packets dropped:
0 packets
SNMP-CM packets passed:
35-4
1800 packets
17989 packets
SNMP-CM packets dropped:
0 packets
COPS packets passed:
0 packets
COPS packets dropped:
0 packets
TELNET packets passed:
0 packets
TELNET packets dropped:
0 packets
RCM other packets passed:
0 packets
RCM other packets dropped:
0 packets
SCM global packets passed:
0 packets
SCM global packets dropped:
0 packet
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
Upstream Cable Protocol Throttling This feature is also called subscriber-side throttling or DHCP/ARP Throttling. Upstream channels on the cable or subscriber side of the network can be inundated by DHCP and ARP packets coming from modems and customer-premise equipment (CPE). These DHCP or ARP requests may come from malicious users, viruses, spyware, or faulty equipment. The IPv6 Upstream Cable Protocol Throttling feature throttles IPv6 DHCPv6 packets in the same way that IPv4 DHCP packets are throttled. It throttles IPv6 ND (Neighbor Discovery) packets (Neighbor Solicitation, Router Solicitation, Router Advertisement, Redirect and Neighbor Advertisement) in the same way that IPv4 ARP packets (ARP Request and ARP reply) were throttled in Release 7.3 and earlier. The C4/C4c CMTS throttles all DHCPv4 and DHCPv6 packets the same based on their leaky bucket settings. The CMTS treats all of the ARP Request packets, ARP Reply packets, ND Neighbor Solicitation packets, ND Neighbor Advertisement packets, Router Solicitation packets, Router Redirect packets, and Router Advertisement packets the same, throttling them collectively using the ARP/ND leaky bucket settings. Once configured, the CMTS throttles upstream cable-side IPv6 packets based on their MAC addresses. The max-burst parameter defines the number of packets that are allowed before throttling begins. The rate of throttling is defined by the interval parameter. Once the max-burst limit is reached for a given MAC address, throttling begins. Packets for that MAC address are dropped until one or more intervals have passed. Each time an interval passes the CMTS lowers the packet counter by one, allowing an additional packet for that MAC address to pass through. Thus, once a source MAC has reached the max-burst limit, the CMTS allows it only one packet per interval. IPv6 Neighborhood Discovery (ND) is a set of protocol messages (rfc 2461) and processes that determine relationships between neighboring nodes. There are five types of ND packets that are throttled by this feature: •
Router Solicitation (RS — type 133)
•
Router Advertisement (RA — type 134)
•
ND neighbor solicitation (type 135)
•
ND neighbor advertisement (type 136)
•
Redirect (type 137)
Type is an option that is formatted in the type-length-variable (TLV) format.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
35-5
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
IPv6 DHCPv6 (rfc3351) enables DHCP servers to pass configuration parameters to IPv6 nodes. There are five types of DHCPv6 server messages that are throttled by this feature: •
Solicit (type 1)
•
Advertise (type 2)
•
Request (type 3)
•
Reply (type 4)
•
Renew (type 5)
Type is an option that is formatted in the type-length-variable (TLV) format. The ARP Neighbor Discovery (ND) Abuse Detection feature provides a means to monitor the first 32 devices (i.e. MAC addresses) that are ARP and/or ND throttled on an interface, and count the number of ARP request and IPv6ND Neighbor Solicitation packets, or ARP reply packets and IPv6 ND Neighbor Advertisements that are dropped due to throttling for the devices. There are seven types of ARP/ND packets that are monitored and throttled by this feature. Four are types of request packets and three are replies. ARP/ND requests that this feature throttles: •
ARP request (Ether Type 0x0806)
•
IPv6 Router Solicitation (RS – type 133)
•
IPv6 Neighbor Solicitation (type 135)
•
IPv6 Redirect (type 137)
ARP/ND replies that this feature throttles: •
Arp reply (Ether Type 0x0806)
•
IPv6 Router Advertisement (type 134)
•
IPv6 Neighbor Advertisement (type 135)
NOTE This feature is fully supported by the 12U/24U CAM. ND Abuse Detection is only available on the 12U/24U CAM. The operator can enable throttling for ND packets even if IPv4 ARP throttling is disabled. In the same way, he or she can enable DHCP or DHCPv6 throttling or both.
35-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
CMTS Configuration
Use the following command to enable [disable] throttling of cable-side IPv4 DHCP or ARP requests: configure cable proto-throttle [no] Use the following command to enable [disable] throttling of cable-side IPv6 DHCP packets: configure cable proto-throttle dhcpv6 [no] Use the following command to enable [disable] throttling of cable-side Neighbor Discovery (ND) packets: configure cable proto-throttle nd [no] Use the following commands to provision the degree of throttling: configure cable proto-throttle [interval ] | [max-burst ] Where: interval is a period of time from 1-10 seconds; the default is 5. This parameter defines the rate of transmission after throttling begins. Throttling begins once the max-burst limit has been exceeded. If the interval is set to five, then after throttling begins, no more than one packet can be sent every five seconds. max-burst defines the maximum number of ARP or DHCP packets allowed from that source per second. The default is 10, which means that up to ten packets per second can be sent before throttling begins. Once configured, the CMTS throttles DHCP or ARP packets on the basis of their MAC address. The max-burst parameter defines the number of packets that are allowed per second before throttling begins. Raising the max-burst increases the number of DHCP or ARP packets allowed per second for a given MAC address before throttling begins. The rate of throttling is defined by the interval parameter. Raising the interval reduces the rate of accepted packets for a given MAC address. Each DHCP/ARP packet increments the counter towards the max-burst limit. Once the max-burst limit is reached for a given MAC address, throttling begins. Each time an interval passes the CMTS lowers the counter by one, allowing an additional packet from that MAC address to pass through. Thus, once the CM or CPE has reached the max-burst limit, it is allowed one packet per interval. If, for example, the max-burst is set to five, and the CM or CPE after reaching its limit waits five intervals without sending any DHCP/ARP packets, then it is allowed up to five requests in a burst before its DHCP or ARP packets are again throttled.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
35-7
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
Use the following command to determine which subscribers are exceeding the rates: show cable proto-throttle detail Sample output from the command above: ARP throttling is: DHCP throttling is: DHCPv6 throttling is: IPv6 ND throttling is: max-burst: 10 interval: 5
on off off on
Drop Counts: Interface DHCP ARP ND DHCPv6 --------------------------------------------------------------------------------Cable 1 0 175 325 0 Cable 5 0 0 0 0 Interface Type Throttled-mac CM-mac -----------------------------------------------------------------------cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aec8 0015.cf04.c4a7 cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aec9 0015.cf04.c4a8 cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aeca 0015.cf04.c4a9 cable-mac 1 (14/3-1/3.0) CPE 0000.054f.ae7d 0015.cf04.c653 cable-mac 1 (14/3-1/3.0) CPE 0000.054f.ae7e 0015.cf04.c654 cable-mac 1 (14/3-1/3.0) CPE 0000.054f.ae81 0015.cf04.c655 cable-mac 1 (14/3-1/3.0) CPE 0000.054f.ae82 0015.cf04.c656
Use the show cable modem detail command to see if a modem or CPE is being throttled. See show cable modem detail on page CLI-1330, for an example of this command output. Look for “Proto-Throttle”. To clear all cable modem throttling counts and information, whether or not any modems or CPE have been throttled, use the following command: clear cable proto-throttle history To clear all cable-side proto-throttle counters, use the following command: clear cable proto-throttle counters
35-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
ARP Neighbor Discovery (ND) Abuse Detection Excessive numbers of Address Resolution Protocol (ARP) and Internet Control Message Protocol (ICMP) packets impair system performance. This feature allows the CMTS operator control over how many ARP requests are generated because of IP addresses that have no valid entry, whether active or inactive in the ARP cache of the CMTS. The ICMP unreachable messages are generated when an ARP request is sent for an invalid IP address. Table 35-1: CLI Syntax for ARP Configuration CLI Command
Purpose
configure arp state … 1.
2.
… searching rate-limit
Limits the minimum amount of time between ARP request transmissions while an ARP cache entry is in the searching state. Range = 100 - 86,400,000 milliseconds. Default = 333 milliseconds.
… searching
Sets the maximum number of ARP requests transmitted for an ARP entry in the searching state. After this number is reached, the next request causes the entry to transition to the notPresent state. Range = 0 - 65,535. Default = 3 requests.
max-number
3.
…searching global-max-rate
Sets the maximum number of ARP requests transmitted for an ARP entry in the searching state. After this number is reached, the next request causes the entry to transition to the notPresent state. Range = 0 - 65,535.
4.
… not-present rate-limit
Limits the minimum amount of time between ICMP unreachable transmissions while an ARP cache entry is in the notPresent state. Range = 100 - 86,400,000 milliseconds. Default = 333 milliseconds.
… not-present
max-number
Sets the maximum number of ICMP unreachables transmitted for an ARP entry in the notPresent state. After this number is reached, the next ICMP unreachable packet causes the entry to transition to the searching state, unless the notPresent minimum time (set by command number 6) has not been reached. Range = 0 - 65,535. Default = 3 ICMP unreachable transmissions.
max-time
Sets the maximum amount of time an ARP cache entry can be in the notPresent state. When this limit is exceeded, the ARP cache entry transitions to the searching state, unless the notPresent minimum time (set by command number 6) has not been reached. Range = 1 - 604,800 seconds. Default = 3 seconds.
min-time
Sets the minimum amount of time an ARP cache entry is in the notPresent state. This variable takes precedence over the values set in the previous two commands. ARP entries aged out because of inactivity are removed whether the notPresent minimum time value set by this command is elapsed or not. Range = 1 - 604,800 seconds. Default = 3 seconds.
5.
6.
… not-present
7.
… not-present
8.
… not-present global-max-rate
Issue 2.0
Sets the maximum number of ICMY unreachables transmitted for all NotPresent IPs. Range = 0 - 65,535.
ARRIS PROPRIETARY — All Rights Reserved
35-9
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
Network-side ACLs The following script is an example of throttling used to block access to certain ports which are commonly targeted by hackers: configure configure configure configure configure configure configure configure configure configure configure configure configure configure configure configure
access-list access-list access-list access-list access-list access-list access-list access-list access-list access-list access-list access-list access-list access-list access-list access-list
111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111
deny udp any any eq deny tcp any any eq deny tcp any any eq deny tcp any any eq deny udp any any eq deny udp any any eq deny udp any any eq deny udp any any eq deny tcp any any eq deny tcp any any eq deny tcp any any eq deny tcp any any eq deny tcp any any eq deny tcp any any eq deny tcp any any eq permit ip any any
1434 445 4444 135 135 137 138 139 139 33571 5554 9996 3127 3128 3198
configure interface gigabitEthernet 17/1 ip access-group 111 in configure interface gigabitEthernet 17/1 ip access-group 111 out For a list of well-known port numbers, go to the following website: http://www.iana.org/assignments/port-numbers. For more information, consult the security response web pages provided by Symantec™ and other vendors of software security. These sites provide information on which ports are being targeted by viruses, worms, and other security threats.
35-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
ARP/ND Abuse Counts This feature is an extension of DHCP/ARP Throttling; it provides a means of controlling CMs or CPEs that are generating excessive DHCP, ARP, or Neighbor Discovery packets. DHCP/ARP Throttling must be enabled for ARP/ND Abuse Counts to function. This feature monitors the first 32 devices (i.e., MAC addresses) subject to ARP/ND request throttling on an interface plus the first 32 devices subject to ARP/ND reply throttling on an interface. It then counts the number of ARP/ND request or reply packets dropped due to throttling of those devices. Two new CLI show commands are provided to display the number of ARP/ND request and ARP/ND reply packets dropped respectively for the devices that are being monitored and counted. These CLI commands provide the option to display only those devices that have dropped more than a specified minimum number of ARP/ND packets. Additional CLI commands are available to clear the ARP/ND abuse counts and the throttling history. Once enabled, this feature maintains lists of up to 32 MAC addresses per ARP/ND packet type being dropped because of throttling. Each interface list contains counts for the first 32 MAC addresses that get throttled. If a given MAC address becomes inactive, it is dropped from the list and replaced by the next MAC to experience dropped packets due to throttling. ARP/ND abuse counts do not persist across a CAM sparing event, but do persist after a Control Complex side switch. CLI Commands
Cable-side proto-throttling must be enabled in order to activate ARP/ND Abuse Counts. Cable-side throttling is enabled using the following command: configure cable proto-throttle arp
The no form of the command disables Cable-side proto-throttling as well as ARP Abuse Counts: configure no cable proto-throttle arp Use the following commands to show the number of ARP requests and replies that are throttled: show cable proto-throttle arp-nd-requests-throttled [] show cable proto-throttle arp-nd-replies-throttled []
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
35-11
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
Where minimum count to display = an integer from 0 to 65,535 When the counter reaches the maximum of 65,535 it must be cleared. ARP throttling continues even if the counter is full. Use the following command to clear the ARP abuse counts and MAC information shown in the two command outputs above: clear cable proto-throttle counters This command clears all of the protocol throttling counters, not just the ARP and ND counters. The following is an example of the output returned for ARP requests with no minimum set: show cable proto-throttle arp-nd-requests-throttled ARP throttling is: max-burst: interval:
on 10 5
Arp-ND-Replies Interface Type Throttled-mac CM-mac Throttled --------------------------------------------------------------------------------cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aec8 0015.cf04.c4a7 50 cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aec9 0015.cf04.c4a8 100 cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aeca 0015.cf04.c4a9 25
The following is an example of output to the show ARP replies command, with the minimum set to 30: show cable proto-throttle arp-nd- replies-throttled 30 ARP throttling is: on IPv6 ND throttling is: on max-burst: 10 interval: 5 Arp-ND-Requests Interface Type Throttled-mac CM-mac Throttled --------------------------------------------------------------------------------cable-mac 1 (14/0-1/2.0) CPE 0000.054f.ae7d 0015.cf04.c653 50 cable-mac 1 (14/0-1/2.0) CPE 0000.054f.ae7e 0015.cf04.c654 100 cable-mac 1 (14/0-1/2.0) CPE 0000.054f.ae81 0015.cf04.c655 150
If you wish to see the ARP drop counts on a per-CAM basis, use the following command: show cable proto-throttle
35-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
A typical output would resemble the following: ARP throttling is: DHCP throttling is: DHCPv6 throttling is: IPv6 ND throttling is: max-burst: 10 interval: 5
on off off on
Drop Counts: Interface DHCP ARP ND DHCPv6 -------------------------------------------------------------------------------------------Cable 1 0 175 325 0 Cable 5 0 0 0 0
The detailed version of this command provides the MAC addresses of the device being throttled and its cable modem. show cable proto-throttle detail ARP throttling is: DHCP throttling is: DHCPv6 throttling is: IPv6 ND throttling is: max-burst: 10 interval: 5
on off off on
Drop Counts: Interface DHCP ARP ND DHCPv6 -------------------------------------------------------------------------------------------Cable 1 0 175 325 0 Cable 5 0 0 0 0 Interface Type Throttled-mac CM-mac -----------------------------------------------------------------------cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aec8 0015.cf04.c4a7 cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aec9 0015.cf04.c4a8 cable-mac 1 (14/0-1/2.0) CPE 0000.054f.aeca 0015.cf04.c4a9 cable-mac 1 (14/3-1/3.0) CPE 0000.054f.ae7d 0015.cf04.c653 cable-mac 1 (14/3-1/3.0) CPE 0000.054f.ae7e 0015.cf04.c654 cable-mac 1 (14/3-1/3.0) CPE 0000.054f.ae81 0015.cf04.c655 cable-mac 1 (14/3-1/3.0) CPE 0000.054f.ae82 0015.cf04.c656
Use the following command to clear the count information of the command output above: clear cable proto-throttle counters
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
35-13
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
Token Bucket 3.0: Traffic Shaping on 16D/XD CAMs Overview
With the rapid convergence of different types of Internet traffic flows (voice, video, data, gaming, streaming media, etc.), the various forms of Quality of Service (QoS) mechanisms are being called upon to better manage the bandwidth that is shared by these various traffic flows. Proper application of QoS is essential if statistical multiplexing is employed in the network. Statistical multiplexing permits X subscribers (each requiring a bandwidth of W) to share a single channel providing a total bandwidth T, even if T < XW. On average, this is possible due to the fact that many subscribers are idle for some fraction of their operating time. However, in a system that capitalizes on statistical multiplexing, the total bandwidth converging on a link may periodically exceed the total bandwidth T that can be supported by the link. Under these overload conditions, QoS mechanisms must make decisions about which packets to drop, which packets to route, and what order to use when routing those successful packets.
Traffic Shaping versus Traffic Policing
Currently, the CMTS uses Weighted Random Early Detection (WRED), a congestion avoidance mechanism, along with policing to decide which packets to drop. Another QoS mechanism is traffic shaping. In general, traffic shaping and traffic policing both accomplish very similar goals. Both mechanisms change the handling of packet streams in a particular service flow to better match the service for which the customer subscribed. However, the two mechanisms accomplish this task in slightly different ways. Traffic shaping intelligently delays packets to slow down the effective packet transmission rate, while traffic policing intelligently drops packets. When traffic policing drops TCP packets, for example, this triggers the TCP congestion control algorithm and causes the source to throttle back the transmission rate. In order to maximize throughput, a large burst size is needed by policing in order to reduce the frequency of dropped packets. As the desired bandwidth is made larger and larger, the burst size must also increase. Larger burst sizes result in longer periods of time when the transmission rate for a flow is not limited, producing undesirable interactions with other service flows. Downstream traffic shaping helps to avoid this problem and accommodates a larger range of desired bandwidths. In addition, a two-tiered shaping mechanism is desirable for shaping to different rates before and after the DOCSIS burst is consumed. Traffic shaping temporarily stores packets in buffers in such a way that packets on different flows can be transmitted out of order while maintaining packet order within a flow. Buffers are not reused until they have transmitted or dropped their packets. Policing is done in hardware in the CMTS. The policing engine determines whether a packet is nonconforming and whether shaping is enabled for the flow carrying that packet. Instead of dropping the non-conforming packet, the policing block
35-14
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
calculates how long the packet must be delayed to make it conform. A new shaper block is implemented immediately before the output queue. When the shaper receives a packet, it places it into a time-bin in a calendar queue scheduler, which releases the packet upon completion of the delay that was calculated by the policing block. NOTE Packets arriving from the fabric for PacketCable voice and UGS flows are not shaped. They are placed in a separate queue and are serviced in a strict priority manner before the calendar queue packets. The shaping feature gives preference to PacketCable voice and UGS flows over all other traffic. No other prioritizing is done by the CAM when shaping is enabled. The CAM does not implement any new dropping mechanisms, such as WRED. Policing calculations are still the primary method of limiting bandwidth on individual flows, and the back pressure mechanism of the Router Control Module (RCM) fabric is still used to trigger WRED in the fabric for congestion control and Tmin rate enforcement. In order to implement a “Power Burst” function, the policer uses a dual leaky bucket mechanism. The first leaky bucket uses the DOCSIS Tmax and burst size. The second leaky bucket limits the transmission rate during the period that packets conform to the first leaky bucket, rather than letting a user use the full bandwidth of the link. The second leaky bucket uses a new parameter named Tpeak and has a burst size of 0. A delay value is calculated for each leaky bucket; the larger value is used to delay packets. The CMTS implementation of this feature can be summarized as follows:
Enabling Traffic Shaping
•
Traffic shaping applies only to downstream traffic.
•
Packets that must be held more than two seconds in order to conform to the shaping norms are dropped.
•
Disabling policing on the CMTS also disables traffic shaping on the CAM because policing determines whether a flow is conforming or not.
•
Traffic shaping does not affect PacketCable voice and UGS packets.
To enable traffic shaping on the 16D/XD CAMs, use the following command: configure interface cable-downstream cable rate-limit token-bucket [shaping] Where: slot MAC
Issue 2.0
The chassis slot in which the targeted Cable Access Module resides. Valid values are 0 through 15. Refers to the MAC domain number. Valid numbers are 0 or 1.
ARRIS PROPRIETARY — All Rights Reserved
35-15
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
shaping Disabling Traffic Shaping
(Optional) Sets the MIB to enable traffic shaping.
To disable traffic shaping, use the following commands: For a 16D/XD CAM: configure interface cable-downstream cable rate-limit token-bucket no Use the following command to set the peak traffic rate for DOCSIS 1.0 cable modems that have been mapped to a DOCSIS 1.1 Class of Service. See the configure cos-mapping command in the CLI Command Reference chapter of the user documentation for more information. configure cos-mapping down-peak-traffic-rate Use the following command to set the peak traffic rate for DOCSIS 1.1 modems assigned to a particular service class (qos-sc = Quality of Service — Service Class Name): configure qos-sc name peak-tr-rate NOTE A peak traffic rate of zero means that peak traffic rate is not utilized. A peak traffic rate with a value less than Tmax for a given flow indicates that the peak traffic rate is limited to the Tmax for that flow.
Upstream Power Boost Cap The Upstream Power Boost feature enables support for upstream Peak Traffic Rate and is similar to the downstream functionality that is supported. Traffic is limited to the peak rate (Tpeak) while a modem is bursting beyond the maximum rate (Tmax). The Tpeak rate is a value greater than the Tmax rate. Once the specified number of bytes have been consumed at the higher rate, the traffic is then throttled back to the Tmax rate. Use the following command to globally enable the Peak Traffic Rate service flow for upstream service flows: configure [no] cable peak-tr-rate-upstream Outputs from the test cm sf and show cable modem qos verbose commands provide both downstream and upstream service flow information.
35-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
35 Packet Throttling
C4/C4c CMTS Rel. 8.0.7
Upstream Tpeak can be configured via Service Class Name or by explicitly setting it in the modem’s config file (TLV 24.27). To configure Tpeak using service class name: configure qos-sc name dir 2 peak-tr-rate 5000000 configure qos-sc name max-tr-burst 40000000 configure qos-sc name peak-tr-rate 10000000 This command sets the Tpeak for the SCN. When modems register, they get the Tpeak from the CMTS. Be sure to set the Tpeak value larger than the value of the upstream TMAX.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
35-17
35 Packet Throttling
35-18
C4/C4c CMTS Rel. 8.0.7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
36 Access Control Lists
C4/C4c CMTS Rel. 8.0.7
36
Access Control Lists
Topics
Page
Overview
1
Named Access Lists
4
Data Plane Filter IP ACLs
6
SCM Access
8
Overview An ACL, or Access Control List, is an indexed, ordered list of entries. It classifies packets based on criteria such as Source IP, Destination IP, Application port for the IPv4 protocol type. Beginning with Release 7.3, IPv6 ACLs are supported with entries created using the Source IP only. Each entry in the list contains a user-configured set of evaluation criteria and either a permit or deny statement. When a packet is classified by an ACL, the fields in its header are compared one by one with the entries in the ACL, starting with the entry with the lowest index value. When a match is found, the comparison process is stopped and the packet is either permitted to continue or denied (dropped) according to the action specified in the ACL. The use of ACLs within the CMTS, and within any router for that matter, is considered a fundamental capability. ACLs are used in conjunction with
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
36-1
36 Access Control Lists
C4/C4c CMTS Rel. 8.0.7
one or more ACL applications. It is the ACL application that initiates a packet classification search in a particular ACL and takes action on the packet based on whether the matched ACL entry was a permit or deny. For example, the data plane filter ACL application classifies packets and either transmits them (permit action) or drops them (deny action). It is important to note that, depending on the nature of the ACL application, implementation is provided either within the hardware-based data plane infrastructure, or within the software-based control plane. Note that there are two applications that can be configured to reference an ACL for filtering purposes on the Router Control Module (RCM) data plane. These are described in more detail in this chapter and include: •
Data Plan Filter ACLs
•
SCM Access ACLs
In Release 7.x, the CMTS relies on the RCM to provide generic support for Data Plane Filter ACLs on all Ethernet and CAM interfaces. In addition, the CMTS enables a user to enter a command to display the number of times each ACL entry was matched. The CMTS supports IPv4 standard access lists, which have a range of 1-99. Extended access lists are also supported for IPv4 but not for IPv6. These lists have a range of 100-199. The CMTS supports a total of 2048 access list entries and up to 1024 entries per access list. Determining the maximum number of ACL entries that the Data Plane can hold is notably affected by those created using the range keyword. Entries created with a range take up more physical space than those created without ranges. NOTE IPv6 ACLs are limited to include entries with Source IP only. The CMTS does not support IPv6 ACL entries with any other match criteria. The C4 CMTS does not support extended IPv6 ACLs. IPv6 ACLs are assigned an access list name rather than a number by the operator. A number from 200-399 is automatically generated internally. CLI Commands
This section lists some of the CLI commands that support IPv4 and IPv6 Access Control Lists.
For IPv4: For IPv4 standard ACLs, the access list ID number must be in the range of 1-99 with filtering based on source IP address only.
36-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
36 Access Control Lists
C4/C4c CMTS Rel. 8.0.7
Use the following command to delete an IPv4 ACL: configure access-list no Use the no form of these commands to disable access filtering for a particular interface. Use the following command to resequence the access list index numbers.: configure access-list resequence [] Use this command to display ACLs defined by a parameter given, or to show all with no parameters: show access-list [access-list-number] Use the following command to permit or deny, and define a standard IPv4 ACL: configure access-list {permit | deny} {{ []} | {host } | any} Use this command to configure a Data Plane Filter ACL on 12U/24U cableside, gigabitethernet, or tengigabitethernet interface. If an ACL is applied to a physical port, it is active for all virtual routes associated with that physical port: configure [no] interface {gigabitEthernet | tengigabitEthernet | cable} ip access-group For cable MACs, use the following command to use Data Plane Filter ACLs to set access control on a MAC domain: configure [no] interface cable-mac ip access-group
For IPv6 ACLs: Use the following command to define an IPv6 ACL: configure ipv6 access-list []{permit | deny} {/| any} [remark ] NOTE Wildcard masks are not supported with IPv6 ACLs. Prefix length is used for matching purposes. Also, the any keyword may be used for matching any source IPv6 address. Use the no form of the command to delete an IPv6 ACL. Use the following command to resequence the access list index numbers.:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
36-3
36 Access Control Lists
C4/C4c CMTS Rel. 8.0.7
configure ipv6 access-list resequence seqstart> Use this command to display ACLs defined by a parameter given, or to show all with no parameters: show ipv6 access-list DosFs not included, card in socket 0 ignored ## isoDrv:Img: /active/CMTS_V08.00.05.36.img Checksum: 0x11a60b35 File Size 79480832 ## SANDM: Img Fpga version is 06210000 and current is 06210000 Downloading /cdrom/ppc.zzz
Stored File Size 79480832
Disk
Uncompressing image ...from 02180000 to 00100000 Copying uncompressed image Launching software application at: 00008000 image size: 6107680 Board Init Starting::: Initializing Bridge Initializing Interrupt Controller Initializing I2C Initializing Seeproms Reading Seeprom Data Initializing MMU Configuring PCI Bus 1 Basic HW Init Done..... Instantiating /ram as rawFs, device = 0x1 Target Name: vxTarget User: target muxDevLoad failed for device entry 0!
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
38-9
38 Host Names, User IDs, and Password Recovery
C4/C4c CMTS Rel. 8.0.7
Instantiating /ipram as rawFs, device = 0x10001 Formatting /ipram for DOSFS Instantiating /ipram as rawFs, device = 0x10001 Formatting...Retrieved old volume params with %38 confidence: Volume Parameters: FAT type: FAT32, sectors per cluster 0 0 FAT copies, 0 clusters, 0 sectors per FAT Sectors reserved 0, hidden 0, FAT sectors 0 Root dir entries 0, sysId (null) , serial number 30000 Label:" " ... Disk with 1024 sectors of 512 bytes will be formatted with: Volume Parameters: FAT type: FAT12, sectors per cluster 1 2 FAT copies, 1010 clusters, 3 sectors per FAT Sectors reserved 1, hidden 0, FAT sectors 6 Root dir entries 112, sysId VXDOS12 , serial number 30000 Label:" " ... OK. Adding 14301 symbols for standalone. VxWorks Copyright 1984-2007
Wind River Systems, Inc.
CPU: IBM 750L (3.2) Runtime Name: VxWorks Runtime Version: 6.5 BSP version: 2.0/18 Created: Jan 26 2012, 17:06:42 ED&R Policy Mode: Deployed WDB Comm Type: WDB_COMM_NETWORK WDB: Ready. Copyright (c) 2002-2011 ARRIS Group, Inc. All Rights Reserved DATA CONNECTION (c) is a registered trademark of DATA CONNECTION LIMITED in the US and other countries. Copyright (R) 2005- 2009 Data Connection Limited Portions of the IPDR software were authored by IPDR.org The Regular Expression Source Code and its use is covered by the GNU LESSER GENERAL PUBLIC LICENSE version 3. June 29, 2007 -----------------------------------------------------------START-UP MODE: Run the CMTS Application PASSWORD: Password recovery is disabled FRONT ETHERNET INTERFACE PARAMETERS: IP address for the System Controller's ethernet port: 10.44.108.1 Subnet mask for the above IP address: 255.255.255.248 IP address of default gateway to other networks: 10.44.108.6 FACTORY PARAMETERS: Model Number: SCM-02440W Serial Number: 06483CBM0093 PCB Revision: B06 PIC PARAMETERS: Model Number: PICS-00440W
38-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
38 Host Names, User IDs, and Password
Serial Number: 02261RMO0004 PCB Revision: D02 PARAMETERS: After board is reset, start-up code will wait 2 seconds -----------------------------------------------------------##################################################################### ##################################################################### To change any of this, press and key within 2 seconds ##################################################################### #####################################################################
3
M ? type
M and press enter
For each of the following questions, you can press to select value shown in brackets, or you can enter a new value
4
PASSWORD: Enable Password Recovery ?[No]YES User will be automatically authenticated upon boot FRONT ETHERNET INTERFACE PARAMETERS: Enable the System Controller's ethernet port ? [Yes] IP address for the System Controller ethernet port?[10.44.108.1] Use a subnet mask for the front Ethernet port interface?[Yes] Subnet mask for the above IP address?[255.255.255.248] Do you want to specify a default gateway router?[Yes] IP address for the default gateway router?[10.44.108.6] Copyright (c) 2002-2011 ARRIS Group, Inc. All Rights Reserved DATA CONNECTION (c) is a registered trademark of DATA CONNECTION LIMITED in the US and other countries. Copyright (R) 2005- 2009 Data Connection Limited Portions of the IPDR software were authored by IPDR.org The Regular Expression Source Code and its use is covered by the GNU LESSER GENERAL PUBLIC LICENSE version 3. June 29, 2007 -----------------------------------------------------------START-UP MODE: Run the CMTS Application PASSWORD: Password recovery is enabled FRONT ETHERNET INTERFACE PARAMETERS: IP address for the System Controller's ethernet port: 10.44.108.1 Subnet mask for the above IP address: 255.255.255.248 IP address of default gateway to other networks: 10.44.108.6 FACTORY PARAMETERS: Model Number: SCM-02440W Serial Number: 06483CBM0093 PCB Revision: B06 PIC PARAMETERS: Model Number: PICS-00440W Serial Number: 02261RMO0004 PCB Revision: D02 PARAMETERS:
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
38-11
38 Host Names, User IDs, and Password Recovery
C4/C4c CMTS Rel. 8.0.7
After board is reset, start-up code will wait 2 seconds -----------------------------------------------------------##################################################################### ##################################################################### To change any of this, press and key within 2 seconds ##################################################################### #####################################################################
5
(M)odify any of this or (C)ontinue?[M]
c
PPC Application kernel software version CMTS_V08.00.05.36, built on Thu Jan 26 17:07:12 Central Standard Time 2012 Formatting /ram for DOSFS Instantiating /ram as rawFs, device = 0x1 Formatting...Retrieved old volume params with %38 confidence: Volume Parameters: FAT type: FAT32, sectors per cluster 0 0 FAT copies, 0 clusters, 0 sectors per FAT Sectors reserved 0, hidden 0, FAT sectors 0 Root dir entries 0, sysId (null) , serial number 6df0000 Label:" " ... Disk with 40960 sectors of 512 bytes will be formatted with: Volume Parameters: FAT type: FAT16, sectors per cluster 2 2 FAT copies, 20383 clusters, 80 sectors per FAT Sectors reserved 1, hidden 0, FAT sectors 160 Root dir entries 512, sysId VXDOS16 , serial number 6df0000 Label:" " ... OK. SCM.19-C> c4: setting CLOCK_REALTIME to FRI FEB 03 22:07:00 2012 i2c: Initializing devices - PPC-I2C: /i2c0 DosFs not included, card in socket 0 ignored ## isoDrv:Img: /active/CMTS_V08.00.05.36.img Checksum: 0x11a60b35 File Size 79480832 ##
Stored File Size 79480832
Disk
SCM card software version CMTS_V08.00.05.36, built on Thu Jan 26 17:57:50 Central Standard Time 2012 /system/ - Volume is OK /update/ - Volume is OK /active/ - Volume is OK MemMgr_Init()
6
Please wait for 5 seconds until initialization completes ====================================================================== connecting to SCM 19 ====================================================================== Warning: Authentication has been disabled for console access. Reboot this SCM to enable authentication
End of procedure
38-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
39 Clock Synchronization Protocol
C4/C4c CMTS Rel. 8.0.7
39
Clock Synchronization Protocol
Topics
Page
Manually Setting the Internal Clock
1
Configuring Time of Day (TOD) Clock Protocol
2
Using Network Time Protocol (NTP)
2
Secure NTP
6
Show Clock Commands
7
To synchronize the CMTS to a network time server, you must choose either Time of Day (TOD) or Network Time Protocol (NTP) as your synchronization protocol. If you intend to enable PacketCable, you must use NTP. If preferred, you may operate the CMTS on a local clock without synchronizing it to a network.
Manually Setting the Internal Clock If there is an active network time protocol, you must first disable it before adjusting the clock on the CMTS. 1 Use the following command to disable network synchronization: config clock no network
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
39-1
39 Clock Synchronization Protocol
C4/C4c CMTS Rel. 8.0.7
2 Manually set the CMTS internal clock: config clock set yyyy:mm:dd:hh:mm:ss End of procedure
Configuring Time of Day (TOD) Clock Protocol The TOD server provides the time of day to cable modems and other customer premises equipment (CPE) connected to the CMTS cable interfaces. The cable modem uses the TOD server to get the current date and time so that it can accurately time-stamp its Simple Network Management Protocol (SNMP) messages and error log entries.
Procedure 39-1
Configuring Time of Day (TOD) Clock Protocol 1 Configure the TOD server IP address and protocol for Transmission Control Protocol (TCP) or User Datagram Protocol (UDP) commands: configure tod server {tcp|udp} 2 Configure the CMTS to use the TOD time synchronization protocol: configure clock network tod 3 Confirm the current clock network protocol as well as the local time using the following command: show clock detail End of procedure
Using Network Time Protocol (NTP)
Procedure 39-2
Configure NTP for CMTS The purpose of this procedure is to configure the CMTS as an NTP client. This means that the CMTS clock is synchronized to the NTP server.
39-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
39 Clock Synchronization Protocol
C4/C4c CMTS Rel. 8.0.7
NOTE PacketCable requires the use of NTP for network synchronization. Use step 1 if the NTP client is unicast; otherwise, go to step 2. For NTP to synchronize properly, the current time must be manually set to within 1000 seconds of the actual time before enabling. (See RFC 1305.) See Manually Setting the Internal Clock on page 39-1. 1 Configure the NTP client: configure ntp server [broadcast] [burst] [key] [manycast] [maxpoll ] [minpoll ] [multicast] [prefer] [version ] For more information, see configure ntp server and related commands in the CLI reference chapter. Here are some of the pertinent defaults: burst mode key minpoll maxpoll version
= = = = =
off 0 6 7 4
2 Use one of the following commands to configure the CMTS as an NTP client listening to a broadcast or multicast server, or if is to be part of an NTP manycast group: configure ntp server broadcast configure ntp server multicast configure ntp server manycast 3 Set the NTP re-synchronization timer: configure ntp minpoll configure ntp maxpoll Where
4-11 are exponents of 2. In other words, the possible values are 24, 25, 26 … 211, which equal 16, 32, 64 … 2048.
These commands are used to set the default values for NTP minpoll, maxpoll, and version parameters that will be assumed by subsequent configure ntp server | peer commands. The defaults are: minpoll = 6, maxpoll= 7, version = 4.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
39-3
39 Clock Synchronization Protocol
C4/C4c CMTS Rel. 8.0.7
PacketCable requires that the maximum interval between consecutive attempts to synchronize the CMTS local time of day clock must not exceed one hour. Therefore, NTP.MAXPOLL must not exceed 11 (that is 211 or 2048 seconds, which equals approximately 34 minutes). The CLI command configure ntp maxpoll has a default value of 7. Also, the new CLI command configure ntp minpoll sets the default minimum polling interval in the same way, where minpoll is strictly less than or equal to maxpoll. 4 Configure the time zone: When no parameter is given (or invalid input is detected), this command enters interactive mode. In interactive mode, a list of available canonical time zone (TZ) names is displayed based on a given country name or ISO3166 country code. The local TZ name may then be selected by line number from the displayed list of TZ names for that country. In the example given below the time zones for the USA are requested. C4# configure clock timezone Enter country name or 2 letter code: US 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22.
US US US US US US US US US US US US US US US US US US US US US US
+404251-0740023 +421953-0830245 +381515-0854534 +364947-0845057 +394606-0860929 +382232-0862041 +411745-0863730 +384452-0850402 +415100-0873900 +450628-0873651 +470659-1011757 +394421-1045903 +433649-1161209 +364708-1084111 +332654-1120424 +340308-1181434 +611305-1495401 +581807-1342511 +593249-1394338 +643004-1652423 +515248-1763929 +211825-1575130
America/New_York Eastern Time America/Detroit Eastern Time - Michigan - most locations America/Louisville Eastern Time - Kentucky - Louisville area America/Kentucky/Monticello Eastern Time - Kentucky - Wayne County America/Indianapolis Eastern Standard Time - Indiana - most locations America/Indiana/Marengo Eastern Standard Time - Indiana - Crawford County America/Indiana/Knox Eastern Standard Time - Indiana - Starke County America/Indiana/Vevay Eastern Standard Time - Indiana - Switzerland County America/Chicago Central Time America/Menominee Central Time - Michigan - Wisconsin border America/North_Dakota/Center Central Time - North Dakota - Oliver County America/Denver Mountain Time America/Boise Mountain Time - south Idaho & east Oregon America/Shiprock Mountain Time - Navajo America/Phoenix Mountain Standard Time - Arizona America/Los_Angeles Pacific Time America/Anchorage Alaska Time America/Juneau Alaska Time - Alaska panhandle America/Yakutat Alaska Time - Alaska panhandle neck America/Nome Alaska Time - west Alaska America/Adak Aleutian Islands Pacific/Honolulu Hawaii
Please select a time zone location by line number: (1-22) 9 Chicago is selected. By requesting CLI help on the command you can see how to configure the time offset using Greenwich Mean Time: configure clock timezone ?
39-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
39 Clock Synchronization Protocol
C4/C4c CMTS Rel. 8.0.7
WORD country name/zone location e.g. America/Chicago, or GMT offset e.g. GMT-6 For more information on time zone codes, see configure clock timezone on page CLI-284. Use the following command to set the time zone offset in hours (and minutes, if applicable) from Greenwich: configure clock timezone GMT[+|-hh[:mm]] Use the no form of the command to disable the time zone setting: configure clock [no] timezone Use the following command to display clock configurations and the time: show clock detail 2012 February 4 09:53:39 CDT (DST) Network time sync protocol is TOD TOD Server IP Address: 10.50.28.3 connection type: tcp These commands select the local TZ and DST rules based on canonical or GMT offset. The TZ and DST adjustments are made automatically whenever the local time is displayed or logged (see show clock detail or show log history command). When a canonical is given, the built-in local TZ and Daylight Saving Time (DST) rules for that time zone location name are activated. This includes automatic adjustment of local time for TZ & DST and setting of the time zone abbreviation according to the rules. Examples of canonical TZ names are Europe/Paris, America/Chicago, or Asia/Hong_Kong. When a GMT offset is given, the local TZ is set accordingly, but no DST adjustments are made when local time is displayed or logged. 5 Configure the CMTS to use NTP network synchronization: configure clock network ntp 6 Confirm the NTP configuration: show ntp Where:
associations displays the status of NTP associations defaults displays default settings for NTP minpool, maxpool, and version
For example: show NTP defaults
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
39-5
39 Clock Synchronization Protocol
C4/C4c CMTS Rel. 8.0.7
minpoll=6 maxpoll=7 ver=4 End of procedure
Secure NTP NTPv4 provides a mechanism for optional authentication of NTP messages. The PacketCable standard does not require the CMTS to support this mechanism, but some MSOs do require NTPv4 functionality including authentication. The following CLI commands control whether NTP authentication mode is active or disabled: configure ntp authentication configure ntp no authentication The default mode for authentication is enabled when configured by the configure ntp server command. When NTP authentication mode is disabled, all client key configurations are ignored. NTPv4 symmetric key authentication is based on a shared secret — the key — that is used to create a secure hash of the contents of an NTP message using the MD5 message digest method. The MD5 secure hash ensures that the NTP message was created by an authorized client or server and that no other entity has modified it in transit. Note that the contents of an authenticated NTP message are not encrypted and may be readily inspected; only the MD5 secure hash checksum is encrypted using the shared secret. NTPv4 provides for both symmetric key and public key server or peer authentication methods. However, the CMTS only supports the symmetric key MD5 secure hash authentication method. Use the following CLI command to install the symmetric key strings (aka shared secrets) into the local NTP authentication-key database: configure ntp authentication-key md5 where: =
key identifier or ID, which must be an integer. Range = 1-4,294,967,295 (232-1) 0 = no authentication. = authentication key, an ASCII string 1-16 characters long. Any existing ASCII key string for the given key ID will be replaced when this command is executed. Use the no form of the command to remove a key ID and its associated string.
39-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
39 Clock Synchronization Protocol
C4/C4c CMTS Rel. 8.0.7
On the CMTS, NTP authentication key strings may be 1 to 16 null-terminated 7-bit ASCII characters excluding ‘ ’ (space), ‘#’ (pound), ‘\t’ (tab), ‘\n’ (line feed), and ‘\0’ (null). Both the client and server must agree on an acceptable key ID and ASCII key string pair. The authentication-key database is indexed by key ID. It must not be shared with any other application in the CMTS. The NTP symmetric key strings are associated with key identifiers used to organize a local database of NTP authentication key strings. Note that the key identifier is also transmitted with the NTP messages so that the client and server can locate the appropriate local key string that encrypts or decrypts the secure hash. Therefore, the client and server both have to agree on a common key ID and a common key string for that key ID. The CLI command configure ntp server uses the key parameter to select the pre-defined ASCII key string from the NTP authentication key database that is used when transmitting authenticated NTP messages between the client and the target server. Examples of command syntax: configure ntp authentication-key 33 md5 KeyString1234567 configure ntp server 10.10.10.10 key 33 configure ntp authentication-key 55 md5 aShortKey configure ntp no authentication-key 55
Show Clock Commands Use the following commands to view NTP status: show clock show clock detail show clock GMT show ntp These commands display the local date and time in one-second resolution when the TOD client is active and in 1 millisecond resolution when the NTP client is active. The output of show clock detail also shows the TZ abbreviation and the current DST/STD time status.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
39-7
39 Clock Synchronization Protocol
C4/C4c CMTS Rel. 8.0.7
If you wish to see the time expressed as Greenwich Mean Time, use show clock GMT.
39-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
40 Service Class Names
C4/C4c CMTS Rel. 8.0.7
40
Service Class Names
Topics
Introduction
Page
SCN Example
3
Service Class Examples
3
Commands for Adding Service Class Names
6
Service Class Names (SCNs) are names that serve as handles for Quality of Service (QoS) parameter sets which can be used to simplify configuration. SCNs identify the QoS parameter sets that are stored in the CMTS. The SCNs are referenced by configuration files when defining service flows. Service Flows (SFs) contain classifiers which determine which packets are included in the SF. The QoS parameter set determines how the packets in the SF are treated. NOTE If there are parameters defined in the config file but also defined in an SCN referenced by that config file, the config file parameters override those found in the SCN. If you define an SCN in a config file but do not define it on the CMTS, you will receive an error and registration will be denied. The config files use this information as part of setting up the service flows that govern the levels of service awarded to cable modems. Service Class Names are intended to be visible to external Operations Support Systems (OSSs). They impact billing operations because they identify SF counters that are used in the MIBs and in the billing records. From a subscriber’s perspective, service classes refer to different levels of service, each with minimum and maximum guaranteed data rates, priori-
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
40-1
40 Service Class Names
C4/C4c CMTS Rel. 8.0.7
ties, and billing rates. A Multiple System Operator (MSO) might choose to offer its subscribers three classes of service and call them, for example, gold, silver, and bronze. Subscribers opting for Gold Service would pay a premium and would be given priority over others. They would benefit from higher bandwidth even during peak access times. Bronze subscribers would pay a minimum rate. Their upstream and downstream rates would be much lower. Silver would be fine for most subscribers, but even Bronze would be much faster and more reliable than dial-up service. NOTE The service class names used in this section are provided as an example only. The MSO may name and configure service class names according to their preference or standard. An SCN is an ASCII string associated with a predefined set of QoS parameters provisioned in the CMTS. The SCN is named in the configuration file. When a cable modem registers, its configuration file causes a service flow to be created using the QoS parameters defined by its SCN. A Service Class Name: •
Enables billing and other OSSs to distinguish service flows by SCN
•
Simplifies the CM configuration file
•
Simplifies the TFTP configuration file
•
Allows higher-layer applications to create a service flow by Service Class Name; these SCNs typically correspond to advertised levels of subscriber service
•
Has a maximum length of 15 characters and is case-sensitive
•
Cannot include spaces unless the name is enclosed in quotation marks (e.g., “Gold Service”).
The Service Class Name is expanded to its defined set of QoS parameters at the time the CMTS successfully admits the service flow. The QoS MIB defines the parameters listed in Table 40-2, QoS Parameters Included in a Service Class Name, on page 40-4. For greater detail on these parameters, refer to CableLabs’ Radio Frequency Interface Specification, SP-RFIv1.1I07-010829, Section 8 and Appendix C. NOTE Typically SCNs are configured using CLI, but they may also be configured in the CMTS via SNMP using a CM management system. This CM management system would define SCNs and define CM configurations as part of a service-level definition process.
40-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
40 Service Class Names
C4/C4c CMTS Rel. 8.0.7
SCN Example
The following examples illustrate scenarios in which service class names are assigned into tiered services – for example Gold, Silver and Bronze. Gold Example — This service class may be structured as follows: •
GoldUp—Scheduling Type = 7 (BE), Traffic Priority = 5, a high-priority flow, Maximum Traffic Rate = 192
•
GoldDown—Scheduling Type = 7 (BE), Traffic Priority = 5, a highpriority flow, Maximum Traffic Rate = 1024
Silver Example — This service class may be structured as follows: •
SilverUp—Scheduling Type = 7 (BE), Traffic Priority = 3, a mediumpriority flow, Maximum Traffic Rate = 128
•
SilverDown—Scheduling Type = 7 (BE), Traffic Priority = 3, a mediumpriority flow, Maximum Traffic Rate = 512
Bronze Example — This service class may be structured as follows:
Service Class Examples
•
BronzeUp—Scheduling Type = 7 (BE), Traffic Priority = 1, a lowpriority flow, Maximum Traffic Rate = 64
•
BronzeDown—Scheduling Type = 7 = (BE), Traffic Priority = 1, a lowpriority flow, Maximum Traffic Rate = 256
Table 40-1 compares typical throughputs of sample service classes. Each advertised subscriber service should have a corresponding SCN. These SCNs are called on by the configuration files used to register CMs and by the CMTS to build SFs for subscribers.
Table 40-1: Examples of Tiered Services and Bit Rates
Issue 2.0
Name
Direction
Maximum Traffic Rate in Kbps
Traffic Priority
GoldUp
upstream
192
5
GoldDown
downstream
1024
5
SilverUp
upstream
128
3
SilverDown
downstream
512
3
BronzeUp
upstream
64
1
BronzeDown
downstream
256
1
ARRIS PROPRIETARY — All Rights Reserved
40-3
40 Service Class Names
C4/C4c CMTS Rel. 8.0.7
Additional SCN Examples
Extra service flows could be added using the following service class examples: •
VoIPup—Scheduling Type = 5 (UGS-AD), a strict priority flow configured for G.711 voice.
•
VoIPdown—Scheduling Type = 0, Traffic Priority = 7, a strict priority flow.
•
MPEGup—Scheduling Type = 4 (rtPS), a strict priority flow. Each tiered service could have flow parameters adjusted to provide greater throughput for higher tiers.
•
MPEGdown—Scheduling Type = 0, Traffic Priority = 6, a strict priority flow.
•
FTPup—Scheduling Type = 3 (nrtPS), a Waited Round Robin (WRR) flow. This could have a Traffic Priority = 2.
•
FTPdown—Scheduling Type = 0, Traffic Priority = 2, a WRR flow.
Table 40-2: QoS Parameters Included in a Service Class Name Parameter
Keyword Syntax
Purpose
All Flows ServiceClassName (SCN)
name
A predefined Quality of Service that is applied to cable modems by a configuration file and used to encode a Service Flow according to the parameter values found in the SCN. This name is case sensitive; maximum length = 15 characters.
Priority
[priority ]
Allows service flows to be given priority for delay and buffering. The CMTS uses this field to assign traffic priorities, which are implemented using a queuing system.
MaxTrafficRate
[max-tr-rate ]
This parameter is the rate parameter R of a token-bucket-based rate limit for packets. R is expressed in bits per second. This rate expresses an upper boundary, not a guarantee that the rate is available.
MaxTrafficBurst
[max-tr-burst ] Specifies the token bucket size B (in bytes) for this Service Flow.
MinReservedRate
[min-res-rate ]
Specifies the minimum rate, in bits/sec, reserved for this Service Flow. If CM requests less bandwidth than this minimum, the CMTS may reallocate the excess.
MinReservedPkt
[min-res-pkt ]
Specifies an assumed minimum packet size (in bytes) for which the Minimum Reserved Traffic Rate will be provided.
ActiveTimeout
Specifies the maximum duration resources remain unused on an active Service Flow. If [active-tmout ] there is no activity on the Service Flow within this time interval, the CMTS MUST change the active and admitted QoS Parameter Sets to null.
AdmittedTimeout Direction
[adm-tmout ]
Specifies the duration that the CMTS MUST hold resources for a Service Flow’s Admitted QoS Parameter Set while they are in excess of its Active QoS Parameter Set. Indicates direction: 1 = downstream 2 = upstream
dir
Upstream Flow Only Parameters MaxConcatBurst
40-4
[max-burst ]
Specifies the maximum concatenated burst (in bytes) which a Service Flow is allowed. This parameter is calculated from the FC byte of the Concatenation MAC Header to the last CRC in the concatenated MAC frame.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
40 Service Class Names
C4/C4c CMTS Rel. 8.0.7
Table 40-2: QoS Parameters Included in a Service Class Name (Continued) Parameter
Keyword Syntax
Purpose
SchedulingType
[type ]
Specifies which upstream scheduling service is used for upstream transmission requests and packet transmissions. If this parameter is omitted, then the Best Effort service MUST be assumed.
NomPollInterval
[poll-int ]
Specifies the nominal interval (in units of microseconds) between successive unicast request opportunities for this Service Flow on the upstream channel. This parameter is typically suited for Real-Time and Non-Real-Time Polling Service.
TolPollJitter
[poll-jitter ]
Specifies the maximum amount of time that the unicast request interval may be delayed from the nominal periodic schedule (measured in microseconds) for this Service Flow.
UnsolicitGrantSize
[grant-size ]
Specifies the unsolicited grant size in bytes.
[grant-int ]
Specifies the nominal interval (in units of microseconds) between successive data grant opportunities for this Service Flow. Required for Unsolicited Grant Services (UGS) and UGS Activity Detection (UGS/AD)
[grant-jitter ]
Specifies the maximum amount of time (in microseconds) that the transmission opportunities may be delayed from the nominal periodic schedule for this Service Flow. Required for UGS and UGS/AD
[grants-per-int ]
For UGS, the value of this parameter indicates the actual number of data grants per NominalGrant Interval. For UGS/AD, the value of this parameter indicates the maximum number of Active Grants per Nominal Grant Interval. This is intended to enable the addition of sessions to an existing UGS Flow via the Dynamic Service Change mechanism, without negatively impacting existing sessions.
[and-mask ] [or-mask ]
IP Type of Service overwrite. Enables CMTS to overwrite original Type of Service (ToS) byte with new value.
[req-policy ]
Specifies which IUC opportunities the CM uses for upstream transmission requests and packet transmissions for this Service Flow, whether requests for this Service Flow may be piggybacked with data and whether data packets transmitted on this Service Flow can be concatenated, fragmented, or have payload headers suppressed.
NomGrantInterval
TolGrantJitter
GrantsPerInterval
TosAndMask TosOrMask
RequestPolicyOct
Downstream Flow Only Parameters MaxLatency
Peak Rate
Issue 2.0
[max-lat ]
Maximum downstream latency — a service commitment by CMTS to forward a packet received on a network side interface to the RF interface within the specified number of microseconds.
peak-tr-rate
This is the peak rate in bps that can be achieved beyond TMAX after the burst (max-tr-burst) has been used. For example, if TMAX = 2 Mbps and Max-tr-burst = 8 MB = 64 Mbits, then you could set the Peak Rate to 6 Mbps. Since we have 64 Mbits available in the burst, we will transmit at Peak at 6 Mbps for 16 seconds, then fall back to 2 Mbps.
ARRIS PROPRIETARY — All Rights Reserved
40-5
40 Service Class Names
Commands for Adding Service Class Names
C4/C4c CMTS Rel. 8.0.7
Use the following CLI commands to add a Service Class named hsd_down for a downstream configuration: configure qos-sc name hsd_down max-tr-rate 8000000 configure qos-sc name hsd_down max-tr-burst 5000000 configure qos-sc name hsd_down peak-tr-rate 15000000 configure qos-sc name hsd_down max-lat 100 configure qos-sc name hsd_down active-tmout 0 configure qos-sc name hsd_down adm-tmout 200 configure qos-sc name hsd_down dir 1 Use the following CLI commands to add a Service Class named hsd_down for an upstream configuration: configure qos-sc name hsd_name max-tr-rate 256000 configure qos-sc name hsd_up min-res-pkt 0 configure qos-sc name hsd_up grant-size 109 configure qos-sc name hsd_up grant-int 10000 configure qos-sc name hsd_up grant-jitter 1000 configure qos-sc name hsd_up grants-per-int 1 configure qos-sc name hsd_up max-lat 0 configure qos-sc name hsd_up active-tmout 0 configure qos-sc name hsd_up adm-tmout 200 configure qos-sc name hsd_up type 6 configure qos-sc name hsd_up req-policy 000001ff configure qos-sc name hsd_up and-mask 00 configure qos-sc name hsd_up or-mask 28 configure qos-sc name hsd_up dir 2
40-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
40 Service Class Names
C4/C4c CMTS Rel. 8.0.7
Related command(s): show qos-sc [name ] The following output for this command is based on the configuration examples above: C4# show qos-sc QOS Service Class Name:
hsd_up
Relative Service Flow Priority:
0
Max Sustained Traffic Rate (bits/sec):
256000
Max Traffic Burst (bytes):
3044
Min Reserved Rate (bits/sec):
0
Min Reserved Packet Size (bytes):
0
Max Concat Burst for US flow (bytes):
1522
Nominal Poll Interval (microseconds):
0
Poll Jitter (microseconds):
0
Unsolicited Grant Size (bytes):
109
Nominal Grant Interval (microseconds):
10000
Grant Jitter (microseconds):
1000
Data Grants Per Nominal Grant Interval:
1
Max Latency for DS flows (microseconds):
0
Active Timeout (seconds):
0
Admitted Timeout (seconds):
200
Upstream Scheduling Service: Grant Service Request Policy:
Unsolicited 000001ff
TosQos and-mask:
0x00
TosQos or-mask:
0x28
Interface Direction:
Upstream
Peak Traffic Rate:
QOS Service Class Name: Relative Service Flow Priority: Max Sustained Traffic Rate (bits/sec):
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
0
hsd_down 0 8000000
40-7
40 Service Class Names
C4/C4c CMTS Rel. 8.0.7
Max Traffic Burst (bytes): Min Reserved Rate (bits/sec):
0
Min Reserved Packet Size (bytes):
0
Max Concat Burst for US flow (bytes):
1522
Nominal Poll Interval (microseconds):
0
Poll Jitter (microseconds):
0
Unsolicited Grant Size (bytes):
0
Nominal Grant Interval (microseconds):
0
Grant Jitter (microseconds):
0
Data Grants Per Nominal Grant Interval:
0
Max Latency for DS flows (microseconds):
100
Active Timeout (seconds):
0
Admitted Timeout (seconds):
200
Upstream Scheduling Service: Request Policy:
Best Effort 00000000
TosQos and-mask:
0x00
TosQos or-mask:
0x00
Interface Direction: Peak Traffic Rate:
40-8
5000000
ARRIS PROPRIETARY — All Rights Reserved
Downstream 15000000
October 9, 2012
41 Per-Subscriber Throughput
C4/C4c CMTS Rel. 8.0.7
41
Per-Subscriber Throughput
Topics
Page
Overview
1
Overview The CMTS Per Subscriber Throughput feature provides two new outputs to the show cable modem qos command. The Quality of Service service class for either the CM MAC address or CM IP address is output in two different formats, depending on whether the verbose parameter is entered. show cable modem qos
The purpose of this command is to display the cable modem QoS on the specified CM MAC address, CM IP address, CPE-MAC address, or CPE IP address. show cable modem qos [|||] [verbose] Parameter
Issue 2.0
Definition
The 48-bit hardware address of the cable modem Internet address assigned by the DHCP server to the cable modem. IP address is in the nnn.nnn.nnn.nnn format MAC address of the CPE under the cable modem
ARRIS PROPRIETARY — All Rights Reserved
41-1
41 Per-Subscriber Throughput
C4/C4c CMTS Rel. 8.0.7
Parameter
Definition
[verbose]
IP address of the CPE under the cable modem Displays detailed report on the cable modem QoS.
To display QoS information on the specified MAC address, use the following command: show cable modem qos 0000.caca.0c48 The following is an example of the output returned by the system: Sfid --9 10 11 12
Dir --US DS US DS
Curr State ---act act act act
Sid --5 0 6 0
Sched Type ----BE BE BE BE
Prio MaxSusRate MaxBrst
MinRsvRate
--1 1 7 7
-------0 0 0 12000
-------0 10000000 0 10000000
-----1522 1522 1522 1522
Throughput bits/sec -------0 0 0 0
packets/sec ---------0 0 0 0
To display QoS information in a detailed format on a CM IP address, use the following command: show cable modem qos 010.071.064.001 verbose The following is an example of the output returned by the system:
Sfid Direction Current State Sid Traffic Priority Maximum Sustained rate Maximum Burst Minimum Reserved rate Minimum Packet Size Admitted QoS Timeout Active QoS Timeout Maximum Concatenated Burst Scheduling Type Request/Transmission policy IP ToS Overwrite [AND-mask, OR-mask] Current Throughput
41-2
: : : : : : : : : : : : : : : :
9 US Active 5 1 0 bits/sec 1522 bytes 0 bits/sec 64 bytes 0 seconds 0 seconds 3000 bytes Best Effort 0x0000008a 0xfc, 0x00 0 bits/sec, 0 packets/sec
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
41 Per-Subscriber Throughput
C4/C4c CMTS Rel. 8.0.7
Sfid Direction Current State Sid Traffic Priority Peak rate Maximum Sustained rate Maximum Burst Minimum Reserved rate Minimum Packet Size Admitted QoS Timeout Active QoS Timeout Maximum Latency Current Throughput
: : : : : : : : : : : : : :
10 DS Active 0 1 0 bits/sec 10000000 bits/sec 1522 bytes 0 bits/sec 64 bytes 0 seconds 0 seconds 0 usecs 0 bits/sec, 0 packets/sec
Sfid Direction Current State Sid Traffic Priority Maximum Sustained rate Maximum Burst Minimum Reserved rate Minimum Packet Size Admitted QoS Timeout Active QoS Timeout Maximum Concatenated Burst Scheduling Type Request/Transmission policy IP ToS Overwrite [AND-mask, OR-mask] Current Throughput
: : : : : : : : : : : : : : : :
11 US Active 6 7 0 bits/sec 1522 bytes 0 bits/sec 64 bytes 0 seconds 0 seconds 3000 bytes Best Effort 0x00000088 0xfc, 0x00 0 bits/sec, 0 packets/sec
Sfid Direction Current State Sid Traffic Priority Peak rate Maximum Sustained rate Maximum Burst Minimum Reserved rate Minimum Packet Size Admitted QoS Timeout Active QoS Timeout Maximum Latency Current Throughput
: : : : : : : : : : : : : :
12 DS Active 0 7 0 bits/sec 10000000 bits/sec 1522 bytes 12000 bits/sec 64 bytes 0 seconds 0 seconds 0 usecs 0 bits/sec, 0 packets/sec
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
41-3
41 Per-Subscriber Throughput
41-4
ARRIS PROPRIETARY — All Rights Reserved
C4/C4c CMTS Rel. 8.0.7
October 9, 2012
C4/C4c CMTS Rel. 8.0.7
42
42 Additional Classifier Support
Additional Classifier Support
Overview The Additional Classifier Support feature allows customers to establish network connectivity between legacy voice equipment that uses Time Division Multiplexing (TDM), for example, a customer-premise PBX and a VoIP network north of the CMTS. The TDM-based equipment is connected to a gateway controller that uses PRI1 interfaces. This type of equipment requires more DOCSIS upstream flows (SIDs) than are typically supported by a cable modem. Enabling this feature permits additional classifiers per upstream flow from the modem. Used in conjunction with Multiple Grants Per Interval (MGPI), it permits the cable modem to support a number of phone calls that is greater than the number of UGS upstream flows that it (the modem) supports. In such an application the gateway controller communicates with the VoIP network elements. These might include a SIP Application Server and a Session Border Controller (SBC). The maximum active call capacity is dependent on all of the network elements including the call server, customer premise PBX, and other services that may be passing through the cable modem. Conventional VoIP traffic allows one call to be carried over a single dynamic upstream flow on a modem with a constant (fixed) Tmin/Tmax. When using this feature, multiple calls can be placed on a single flow. This is achieved using MGPI. The dynamic Tmin and Tmax of the flow vary up and down in discrete increments when observed over time as telephone calls carried by the flows come and go. The actual traffic per unit of time varies in the same way as seen in the output of the “show cable modem detail” command. The number of calls on a single flow is determined by the application server. This feature requires that the gateway device behind a CM be made known to the C4 CMTS by the modem configuration file. The 43.8 TLV of the config file must be set to a value of 0x00015C and the 43.200 TLV must have a value of 1. The maximum active call capacity is dependent on the call server, and other services may be passing through the cable modem. The two PRIs behind the cable modem and gateway support up to 46 active calls. The
1. The Primary Rate Interface is a standardized telecommunications service level within the Integrated Services Digital Network (ISDN) specification for carrying multiple voice and data transmissions between a network and a user.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
42-1
42 Additional Classifier Support
C4/C4c CMTS Rel. 8.0.7
CMTS does not maintain classifier counts for dynamic upstream classifiers for CMs that have additional classifier support turned on. Operational Concerns
Users of this feature should be aware of the following: •
The C4 CMTS supports only the flow aggregated version of Multiple Grants Per Interval (MGPI).
•
The CMTS does not support CALEA for CMs that are suppressing upstream classifiers. CALEA must be supported by other network elements.
•
Legal Intercept is supported.
The MGPI feature affects the output for the show interface allocated-bandwidth command. The columns showing the number of active calls actually show the number of active call flows. So, if two calls are sharing the same UGS flow using MGPI, the column will show one flow but not two calls. In order for this feature to work properly, Upstream Packet Classification Enforcement (UPCE) must be disabled on the C4/C4c CMTS. UPCE is disabled by default. If necessary, use the following command to disable UPCE: configure no operation mode upce
42-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
42 Additional Classifier Support
C4/C4c CMTS Rel. 8.0.7
IP Network
SIP Server SBC
HFC
WBM760 Ethernet
Gateway PRI
PBX
Abbreviations SIP Session Initiated Protocol SBC Session Border Controller HFC Hybrid Fiber-Coax (network) WBM Wide-Band Modem (bonded CM) PRI Primary Rate Interface PBX Private Branch eXchange
Figure 42-1: Example of a Network Diagram for Additional Classifier Telephony
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
42-3
42 Additional Classifier Support
42-4
ARRIS PROPRIETARY — All Rights Reserved
C4/C4c CMTS Rel. 8.0.7
October 9, 2012
43 Diagnostics
C4/C4c CMTS Rel. 8.0.7
43
Diagnostics
Topics
Page
Running Diagnostics
1
CLI Output for Diagnostics
5
This chapter provides an overview of the card diagnostic procedures for the CMTS. The card diagnostics can be used to determine if there is a problem with one of the cards in the CMTS chassis. You can use card diagnostics to isolate a problem to a particular card and even to a particular element on that card. The card diagnostic failure information can be used by the ARRIS support team to identify the root cause of the failure.
Running Diagnostics The CLI provides a command to initiate card diagnostics for the following modules:
Issue 2.0
•
CAM
•
RCM
•
SCM
ARRIS PROPRIETARY — All Rights Reserved
43-1
43 Diagnostics
C4/C4c CMTS Rel. 8.0.7
CAUTION
Diagnostics are initiated only after the module is taken out of service. Therefore, diagnostics may be service affecting if the system is not in a duplex or CAM sparing configuration.
All diagnostic commands and results are logged to the system log automatically at the informational level and are also sent to the same terminal display associated with the CLI session. See chapter 44, Logging and the CMTS, for complete logging information and procedures. The following rules apply to running diagnostics on the CMTS: •
Module level diagnostics should be performed whenever a module fails to boot up, crashes, generates a serious error message, or is suspected of being faulty, or when it is requested by support personnel.
•
Diagnostics can be run only manually and only on modules that are taken out of service and shut down, but powered up.
•
An RCM must be active in order to run diagnostics on the CAMs.
Use the following procedure to verify new, replaced, or repaired modules or to test suspected faulty modules. The simplest diagnostic mode is to run all of the diagnostics for a given slot. First shutdown that module: configure slot shutdown Then run all diagnostics for that slot: configure diag Consult with ARRIS support representative for more information regarding diagnostics.
43-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
43 Diagnostics
C4/C4c CMTS Rel. 8.0.7
Diagnostic Example
The following is an example to begin running diagnostics by displaying the status of the line cards: show linecard status
Chassis Type: C4 Slot Description
4 5 14 15 17 19
CAM CAM CAM CAM RCM SCM
(0D, 24U) (0D, 24U) (32D, 0U) (32D, 0U) A A
Admin Oper State State
Duplex State
Serial Number
HW Version
Up Up Up Up Up Up
Standby Active Active Standby Active Active
11203CTU0015 11203CTU0013 08283CSD0121 08423CSD0099 07523RCM0036 07303CBM0100
CAM-01240W/B08 CAM-01240W/B08 CAM-20032W/G02 CAM-20032W/G02 RCM-01000W/C08 SCM-02440W/B07
IS IS IS IS IS IS
Prov/Det Type CAM/CAM CAM/CAM DMM/DMM DMM/DMM RCM/RCM SCM/SCM
The following is an example of 16D CAM diagnostics: configure slot 11 shutdown Card in slot 11 has been shutdown configure diag 11 Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot Slot
11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11: 11:
Issue 2.0
Resetting card to enter Diagnostic mode Please wait while card is being reset Please wait while card is being reset Please wait while card is being reset Please wait while card is being reset Please wait while card is being reset Reset completed. Card is in diagnostic mode. Test #1 - I2C Function Test (ID 3.10) Passed Test #2 - SPI MUX Function Test (ID 3.2) Passed Test #3 - PCI Function Test (ID 3.9) Passed Test #4 - PCA9545 Register Test (ID 3.1) Passed Test #5 - MAX6642 Function Test (ID 3.21) Passed Test #6 - DS1721 Function Test (ID 3.16) Passed Test #7 - Adm1066 DAC Function Test (ID 3.15) Passed Test #8 - Adm1066 ADC Function Test (ID 3.15) Passed Test #9 - Adm1066 DAC Function Test (ID 3.15) Passed Test #10 - Adm1066 ADC Function Test (ID 3.15) Passed Test #11 - Adm1066 DAC Function Test (ID 3.15) Passed Test #12 - Adm1066 ADC Function Test (ID 3.15) Passed Test #13 - Adm1026 GPIO Function Test (ID 4.11) Passed Test #14 - Adm1026 GPIO Function Test (ID 4.11) Passed Test #15 - Adm1026 Voltage Function Test (ID 4.11) Passed Test #16 - Adm1026 Voltage Function Test (ID 4.11) Passed Test #17 - EEPROM Memory Test (ID 3.17) Passed
ARRIS PROPRIETARY — All Rights Reserved
43-3
43 Diagnostics
Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Passed Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11: Slot 11:
C4/C4c CMTS Rel. 8.0.7
Test #18 - Svengooly Register Test (ID 3.4) Passed Test #19 - SPI Function Test (DMM-portion) (ID 3.11 (DMM-portion)) Passed Test #20 - PCA9554 Register Test (ID 5.2) Passed Test #21 - PCA9554 Function Test (ID 5.3) Passed Test #22 - MCC Register Test (ID 4.2) Passed diagnostic test in progress diagnostic test in progress diagnostic test in progress Test #23 - BCM1480 / MCC Loopback Test (ID 4.7) Passed diagnostic test in progress Test #24 - BCM3215 - Device 0 Register Test (ID 3.6) Passed Test #25 - BCM3215 - Device 0 DW8051 CPU Function Test (ID 3.5) Passed diagnostic test in progress diagnostic test in progress diagnostic test in progress Test #26 - BCM3215 - Device 0 Memory Test (ID 3.14) Passed Test #27 - BCM3215 - Device 1 Register Test (ID 3.6) Passed Test #28 - BCM3215 - Device 1 DW8051 CPU Function Test (ID 3.5) Passed diagnostic test in progress diagnostic test in progress diagnostic test in progress Test #29 - BCM3215 - Device 1 Memory Test (ID 3.14) Passed Test #30 - ADuC832 Register Test (ID 4.3) Passed Test #31 - Downstream Power Level Function Test (ID 4.12) Not Run Test #33 - BCM5461 Function Test (ATLAS-portion) (ID 3.12 (ATLAS-portion)) diagnostic Test #34 Test #35 Test #36 Test #37 Test #38 Test #39 Test #40 -
test in progress ATLAS Memory Test (ID 3.13) Passed BCM5461 - Phy 0 Register Test (ID 3.7) Passed BCM5461 - Phy 0 Function Test (ID 3.12) Passed BCM5461 - Phy 1 Register Test (ID 3.7) Passed BCM5461 - Phy 1 Function Test (ID 3.12) Passed BCM5461 - Phy 4 Register Test (ID 3.7) Passed BCM5461 - Phy 4 Function Test (ID 3.12) Passed
Slot 11: Diagnostic test
completed, status = Passed
Use the following command to restore the 16D CAM in slot 11: configure slot 11 no shutdown NOTE The same procedure applies to both the RCM and SCM.
43-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
43 Diagnostics
C4/C4c CMTS Rel. 8.0.7
CLI Output for Diagnostics Logging
The history log contains a synopsis of diagnostic activity. NOTE In order for the output of the diagnostics to be logged, you must enable the information level to the local-volatile log, as in the command below: configure logging local-volatile 7
For example, the log excerpt below is for a 16D CAM diagnostic test. show logging history History: notifications=2000, size=2000 show history filters: terse format Time Sl Pri Text... -------- -- ---- ------11:40:57 17 info: NTP : synchronized to 100.0.0.31, stratum=6 11:41:03 02 info: NTP : synchronized to 100.0.0.31, stratum=6 11:41:11 19 notc: SystemMtce::notifyCardStateChange(): SystemMtceCard.5: basicMtceState=DIAGNOSTIC 11:41:11 19 info: Slot 11: Reset completed. Card is in diagnostic mode. 11:41:12 19 info: DiagnosticControllerCard: Test Done: testCnt=1: testID=3.10: testName=I2C Function Test: timestamp=: result=Passed Trap Severity=warning,Shelf Number:0,CardNumber:5,Port Number=8,Port Type=dport,Port Secondary State=diagnostic 11:41:12 19 notc: PORT Secondary State Change: Trap Severity=warning,Shelf Number:0,CardNumber:5,Port Number=9,Port Type=dport,Port Secondary State=diagnostic 11:41:12 19 notc: PORT Secondary State Change: 11:41:12 19 notc: PORT Secondary State Change: 11:41:13 19 info: DiagnosticControllerCard: Test Done: testCnt=2: testID=3.2: testName=SPI MUX Function Test: timestamp=: result=Passed 11:41:14 19 info: DiagnosticControllerCard: Test Done: testCnt=3: testID=3.9: testName=PCI Function Test: timestamp=: result=Passed 11:41:22 19 info: DiagnosticControllerCard: Test Done: testCnt=17: testID=3.17: testName=EEPROM Memory Test: timestamp=: result=Passed 11:41:23 19 info: DiagnosticControllerCard: Test Done: testCnt=18: testID=3.4: testName=Svengooly Register Test: timestamp=: result=Passed 11:41:24 19 info: DiagnosticControllerCard: Test Done: testCnt=19: testID=3.11 (DMM-portion): testName=SPI Function Test (DMM-portion): timestamp=: result=Passed 11:41:25 19 info: DiagnosticControllerCard: Test Done: testCnt=20: testID=5.2: testName=PCA9554 Register Test: timestamp=: result=Passed 11:41:26 19 info: DiagnosticControllerCard: Test Done: testCnt=21: testID=5.3: testName=PCA9554 Function Test: timestamp=: result=Passed 11:41:27 19 info: DiagnosticControllerCard: Test Done: testCnt=22: testID=4.2: testName=MCC Register Test: timestamp=: result=Passed
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
43-5
43 Diagnostics
C4/C4c CMTS Rel. 8.0.7
11:42:14 19 info: DiagnosticControllerCard: Test Done: testCnt=23: testID=4.7: testName=BCM1480 / MCC Loopback Test: timestamp=: result=Passed 11:46:07 19 info: DiagnosticControllerCard: Test Done: testCnt=36: testID=3.12: testName=BCM5461 - Phy 0 Function Test: timestamp=: result=Passed 11:46:17 19 info: DiagnosticControllerCard: Test Done: testCnt=37: testID=3.7: testName=BCM5461 - Phy 1 Register Test: timestamp=: result=Passed 11:46:28 19 info: DiagnosticControllerCard: Test Done: testCnt=38: testID=3.12: testName=BCM5461 - Phy 1 Function Test: timestamp=: result=Passed 11:46:38 19 info: DiagnosticControllerCard: Test Done: testCnt=39: testID=3.7: testName=BCM5461 - Phy 4 Register Test: timestamp=: result=Passed 11:46:48 19 info: DiagnosticControllerCard: Test Done: testCnt=40: testID=3.12: testName=BCM5461 - Phy 4 Function Test: timestamp=: result=Passed 11:46:58 19 info: DiagnosticControllerCard: Cmd Done: cmd=configure diag 5 : Timestamp=THU APR 14 11:46:58 2008 11:46:58 19 info: Slot 11: Diagnostic test completed, status = Passed 11:46:58 19 notc: CLI command:(No Auth):10.5.7.166:configure diag 5
Diagnostic Failures
When a module fails diagnostics, an error report is printed to the CLI console and to the log. These error reports are similar to the following example: -----------------------------Generating Function: BlockMemDiag::memTestAllBits Result
:Failed
Result Note
:Memory integrity failure
Expected Result
:0x29
Actual Result
:0x00
XOR Exp vs Actual
:0x29
Fault Location
:0x0001.1e00; Physical Address: 0x0000.23c0
-----------------------------Slot 17: Test #9 - FLAK Memory Test (ID 2.22) Failed Slot 17: Diagnostic test
Diagnostic Failure Recovery
completed, status = Failed
When a diagnostic test fails, it may indicate a hardware fault. It may be evidence that the module cannot provide reliable service. Send the diagnostic output to ARRIS Technical Support. If necessary, they will instruct you to replace the failed card and to return it to the factory for repair. See How to Contact Us on page 1-6 for information on ARRIS Technical Support.
43-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
44
Logging and the CMTS
Topics
Page
Event Messages
1
Generating Events and Traps
15
Routing Events to Local Volatile Logs
18
In order to provide maintenance personnel with real-time and historical operational state data, the CMTS must proactively monitor and route event messages. Operators can use several CLI commands to access event messages. This chapter first describes the logging mechanisms and then the commands used to generate, filter, and collect these important status messages.
Event Messages The CMTS generates asynchronous event messages, or events, in two ways: as part of normal operations and in response to error conditions. The CMTS uses asynchronous notification management (ANM) to log messages. Logging occurs when any unsolicited event is generated.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-1
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Network management personnel can define and route event messages to several management subsystems. These subsystems include: •
A syslog server (up to eight syslog servers are supported)
•
One or more SNMP management stations
•
The local log: volatile and non-volatile (also found in the docsDevEventTable MIB table)
•
The CMTS console
•
Up to 16 telnet or SSH sessions
•
The logging history buffer
Other logging functionality can be managed through the DOCS-CABLEDEVICE-MIB.1 Each of these management subsystems is described later in this chapter.
How Event Messages Are Routed Event messages are routed according to their priority values. They are logged and subsequently used during system maintenance or network troubleshooting activities. All events carrying a routable priority are also stored in the volatile logging history buffer. Priority-based Event Routing — Each event is assigned an event priority. The event priority indicates the type and impact of the event on the CMTS operations.
1. See the draft-ietf-ipcdn-device-mibv2-01 for a complete description of this DOCSIS® MIB. See also CLI Overview.
44-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Priority values range from 1 to 8. Each priority value is defined in Table 44-1, Event Priority Value Descriptions. Table 44-1: Event Priority Value Descriptions Value
Name
1
Emergency
2
Alert
3
Critical
4
Error
5
Warning
6
Notice
7
Informational
8
Debug
Event Routing Sequence
Descriptions and Examples Unrecoverable and fatal CMTS hardware or software fault Recoverable and non-fatal hardware or software fault Service-affecting problem impacting the whole cable system Service-degrading condition related to two or more Cable Modems Service-degrading condition related to a single subscriber Non-failure condition related to the CMTS itself Non-failure condition related to a subscriber Non-failure condition related to internal hardware or software state For the SNMP management station and Syslog server, event routing is based first on the priority and then throttle control. Event throttling is explained in more detail later in this chapter. For the local log, system console, and telnet sessions, the routing is based only on the priority associated with the event. A brief description and graphic of these management subsystems and routing sequence appears in the following section.
Event Management Subsystems Figure 44-1 shows how events are routed to one or more of the event management subsystems within the CMTS. Each event management subsystem is described in the following sections. SNMP Management Station
The Simple Network Management Protocol Management station is an application that uses SNMP protocol to manage a device. The SNMP Management station receives and processes traps (also known as events) originating from the CMTS. Traps are useful for reducing the length of time between when an event occurs and when it is noticed by a manager.1 Events are routed first according to their priority, then they are under throttle control before arriving at the SNMP Management Station.
1. This time is called the event reaction latency.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-3
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
messages
Logging
feedback
Multiple Modules within the C4 CMTS
System Control Module
Priority Routing Takes Place Here
HISTORY Internal (volatile) queue
T H R O T T L E
SNMP Mngmnt Station* Syslog Server*
Local Log Volatile Local Log Non-volatile System Console
*The DOCSIS® OSS specification requires that all events routed to SNMP or Syslog first be routed to the local volatile or the local non-volatile management subsystem.
Monitor (Telnet)
Figure 44-1: Event Management Subsystems on the CMTS Syslog Server
Syslog is a standard protocol for centralized reporting of system events. Its roots are in the Unix environment, but most modern devices use the Syslog protocol to report important events, operating parameters and even debug messages. Events are routed first by priority, then throttle control before arriving at the Syslog server. The CMTS supports up to eight syslog servers.
Local Log (volatile)
The volatile local log stores messages only in the DOCSIS® cable device MIB (docsDevEvent) and is only accessible via SNMP.
Local Log (non-volatile)
The non-volatile local log stores messages in the DOCSIS® cable device MIB. It also stores CMTS specific logs and places them in persistent storage — the flash disk.
System Console
The system console is the RS232 port in the System Control Module. This is the serial interface to the command line interface (CLI). There is a limit of one system console session at any given time.
Monitor
The monitor is the current telnet session. Events are seen only by the telnet session (monitor) that requested them.
History
The logging history buffer is a circular buffer that stores the last number of events that are delivered to any destination. All events that have a priority enabled for at least one destination are stored in the logging history. The default number of events stored in the logging history is 2000.
44-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Event Message Throttling Overview
Using a throttle control protects the data network from exceeding a known threshold during bursts of event messages. Any number of asynchronous events transmitted into an operator’s management network may require throttling, especially if management traffic is carried in-band with user traffic. The CMTS implements a single system-wide throttle that applies to both Syslog message and SNMP TRAP transmissions. The network throttle can be set to one of four types: •
Unconstrained = no throttling
•
Limit = message rates are maintained below a defined threshold
•
Stop = messages are inhibited after reaching a defined threshold
•
All = all event messages are inhibited
By default, the CMTS network throttle type is unconstrained. Throttling Set to Limit
When throttling is set to Limit, then CMTS limits the amount of traffic transmitted onto the management network within a given time interval. This message rate is limited by a provisionable threshold. Should the number of events exceed this threshold, all events are inhibited for:
Throttling Set to Stop (Closed-loop Feedback)
•
until the throttling type is reset, or …
•
the interval begins again.
For closed-loop feedback throttling, the CMTS works together with a network management subsystem to jointly police the amount of traffic transmitted on the network. The CMTS automatically inhibits event transmissions when the number of events becomes excessive. Unlike Limit Throttling, transmission remains inhibited until a management subsystem directs the CMTS to resume.1
1. See the RFC-2669, “DOCSIS® Cable Device MIB Cable Device Management Information Base for DOCSIS® compliant Cable Modems and Cable Modem Termination Systems” for more information.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-5
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Show Logging Commands This section describes various logging commands used to configure and retrieve event messages. For a complete listing of all commands available at the show logging level, use the CLI help for that parameter. The system output for the show logging ? command is reproduced below. C4# show logging ? console debug history local monitor overrides priority
-
proprietary snmp syslog throttle trap
-
Frequently Used Show Logging Commands
Display console logging related information Display debug logging related information Display logging history related information Display local logging related information Display monitor logging related information Display any existing logging overrides Displays information about the priority of specific notifications Display proprietary logging status Display SNMP logging related information Display syslog logging related information Display logging threshold and interval Display trap logging information
Use the following commands to display detailed logging information for the CMTS: •
show logging
•
show logging throttle
•
show logging debug
•
show logging history
Each is explained in the sections that follow. Display Logging Information
Use the following command to display logging: show logging
44-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
This sample output displays all event management subsystems and features available for logging configuration on the CMTS. C4# show logging Throttle: type=unconstrained, threshold=0, interval=1, notifications=13089, throttled=0 Syslog:
hosts (ip address facility): 10.50.39.3 local0 notifications=13089, throttled=0, dropped=841 priority=1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice), 7(information), 8(debug)
SNMP:
notifications=1377, throttled=0 priority=1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice), 7(information), 8(debug)
Local:
Console:
Monitor:
size=300 Volatile: notifications=13508 priority=1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice), 7(information), 8(debug) Nonvolatile: notifications=0 priority=none notifications=0 priority=none notifications=0 priority=none
History: notifications=2000, size=2000 Currently Active Event Overrides: 0066030102 (0x03ef8a16) Inhibit 0066030103 (0x03ef8a17) Inhibit 0066030104 (0x03ef8a18) Inhibit 0066030108 (0x03ef8a1c) Inhibit 0066030109 (0x03ef8a1d) Inhibit 0066030202 (0x03ef8a7a) Inhibit 0066030203 (0x03ef8a7b) Inhibit 0066030205 (0x03ef8a7d) Inhibit 0066030206 (0x03ef8a7e) Inhibit 0066030207 (0x03ef8a7f) Inhibit 0066030300 (0x03ef8adc) Inhibit 0066050102 (0x03efd836) Inhibit 0066050103 (0x03efd837) Inhibit 0066050203 (0x03efd89b) Inhibit 0066050206 (0x03efd89e) Inhibit 0066060600 (0x03f00138) Inhibit 0066060700 (0x03f0019c) Inhibit 0082010100 (0x04e35ff4) Inhibit 0082010200 (0x04e36058) Inhibit 2473092361 (0x93686509) Inhibit 2473093380 (0x93686904) Inhibit
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-7
44 Logging and the CMTS
CLI Access Level 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
C4/C4c CMTS Rel. 8.0.7
Notification Priority 7(information) 7(information) 7(information) 7(information) 7(information) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice) 6(notice)
Display Event Throttle Settings
Use the following command to show the configured throttle settings and utilization statistics. show logging throttle This command returns the following output: Throttle: type=unconstrained, threshold=0, interval=1, notifications=23, throttled=0
Display Debug Information
The show logging debug command assists with troubleshooting certain facilities of the system. The facility, class, and subclass can be specified with the show logging debug command.
Display Logging History
Use this command when determining system status events. show logging history
44-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
The output example for this command, including variable syntax, is given below. C4# show logging history ? after-date after-time before-date before-time detail event last priority slot text
-
Display Display Display Display Display Display Display Display Display Display
events after this date (mm/dd/yyyy) events after this time (hh:mm:ss) events before this date (mm/dd/yyyy) events before this time (hh:mm:ss) detailed header information events with this event id this many last events events with given priority events that occurred on this slot events with matching text
An example output for the last 10 events in logging history is given below. C4# show logging history last 10 History: notifications=1000, size=1000 show history filters: terse format: last 10 Time -------21:56:47 23:06:51 23:06:51 11:32:11 11:32:11 11:32:23 11:32:30 11:32:37 09:28:09 09:28:09
Sl -19 19 19 19 19 19 19 19 19 19
Pri ---notc: notc: notc: notc: notc: notc: notc: notc: notc: notc:
Text... ------CLI command:c4:10.43.8.201:quit CLI command:c4:10.43.4.158:config session 1000 CLI command:c4:10.43.4.158:enable CLI command:c4:10.43.4.38:config session 1000 CLI command:c4:10.43.4.38:enable CLI command:c4:10.43.4.38:config session 1000 CLI command:c4:10.43.4.38:enable CLI command:c4:10.43.4.38:show proto-throttle-rate CLI command:c4:10.43.4.20:config session 1000 CLI command:c4:10.43.4.20:enable
Configuring Event Throttling This section outlines the basic commands required to implement event throttling with the CMTS. Use the commands in this section as an example of how to rate limit messages or implement closed-loop feedback. The commands allow you
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-9
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
to display throttle settings, change throttle thresholds and intervals, and to set the throttle types. The commands include: configure logging throttle threshold configure logging throttle interval configure logging throttle [limit | stop | all] Each is explained in more detail in the following sections. configure logging throttle threshold 20 Where 20 is the number of events above which you want to begin throttling messages. The range is 1 to 4294967294. configure logging throttle interval 60 Where 60 is the interval, in seconds, from 1 to 4294967294. This interval corresponds to the threshold that throttling begins — if there are more than 20 events in a minute (60 seconds). Example of Throttling
Use the following command sequence to throttle logging to 1 event per second: configure logging throttle threshold 1 configure logging throttle interval 1 configure logging throttle limit Display the logging configuration: show logging The CMTS displays the logging settings, including how many event messages have been throttled. Sample output: Throttle: type=limit, threshold=1, interval=1, notifications=1356, throttled=85 Wait five seconds to allow the CMTS to refresh and display the logging configuration again: show logging Sample output: Throttle: type=limit, threshold=1, interval=1, notifications=1405, throttled=113
44-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
This second output shows that the number of throttled event messages has risen to 113. Change Event Throttle Type
Use this command, if throttling conditions permit, to reset the throttling type to the default, or unconstrained configuration. configure logging throttle [limit|stop|all|interval|threshold] Where limit = message rate limiting at a given threshold stop = closed-loop feedback throttling all = complete throttling of all CMTS events interval = time during which the trap threshold applies threshold = number of trap and syslog events to be transmitted per interval before throttling. configure no logging throttle
Event Throttling Example 1
Use the following series of commands to view existing throttle settings, configure a throttle which inhibits all messages if the message rate exceeds 100 messages within 90 seconds, and verify that the change was implemented: show logging throttle configure logging throttle threshold 100 configure logging throttle interval 90 configure logging throttle stop show logging throttle End of example
Event Throttling Example 2
Use the following series of commands to view existing throttle settings, configure a throttle which inhibits all SNMP and Syslog messages, and verify that the change was implemented: show logging throttle configure logging throttle all show logging throttle End of example
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-11
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Event Throttling Example 3
Use the following series of commands to view existing throttle settings, set the throttle to allow all SNMP and Syslog messages, and verify that the change was implemented: show logging throttle configure no logging throttle show logging throttle End of example
Configuring Event Routing Event messages may be routed to the Syslog host, SNMP servers, local volatile log, local non-volatile log, console, or monitor. Each location has specific restrictions and parameters which are explained in the sections that follow. Syslog Server Description
A Syslog server may be used to collect messages from the CMTS. To configure priority-based routing of CMTS events to a Syslog server, the Syslog host IP address must first be configured. You are not required to configure Syslog event priorities and the Syslog facility, but you should be if you desire values other than the defaults. The CMTS does not route events to a Syslog server unless the server’s IP address is configured. If the Syslog server is configured, but you wish to stop sending any events to it, enter the following CLI command: configure no logging syslog
Restrictions and Defaults for Syslog Server
You may configure from one to eight Syslog servers. By default, the CMTS routes any event with priority critical (3), error (4), warning (5), or notice (6) to the Syslog server(s). However, to send other priority levels to Syslog or SNMP, they must first be enabled for the local volatile log or local non-volatile log. Also by default, the CMTS sends all Syslog messages to the Syslog facility local0. The facility may be changed to local0, local1, local2, local3, local4, local5, local6, or local7.
44-12
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Multiple Syslog Servers
CLI Commands for Multiple Syslog Servers
The CMTS has the ability to send logging messages to multiple (from one to eight) syslog servers. Multiple syslog servers share the following characteristics: •
All syslog servers share the same priority table: if one server is configured to receive priority notifications, they will all receive the notifications
•
Throttling is shared by all syslog servers: if throttling is set to inhibit notifications, then none of the servers will receive them
•
The syslog notification counter is pegged (incremented) each time a notification is sent to any syslog server
•
The dropped counter is pegged (incremented) each time a notification fails to be sent to any configured syslog server.
In order to add or remove a syslog server, use the following command: config [no] logging host [facility ] The facility defaults to local0. To change the facility for all currently configured syslog servers, enter the following command: configure logging facility To display syslog configuration and utilization statistics: show logging syslog The sample output below reflects a CMTS configured for four syslog servers: C4# show logging syslog Syslog:
hosts (ip address 10.10.0.10 10.10.0.13 10.10.0.12 10.10.0.11
facility): local0 local3 local2 local1
notifications=1319, throttled=0, dropped=3
Configure Syslog Server to Existing Network
This command configures the Syslog server to 10.16.1.2 (this host IP address is meant as an example): configure logging host 10.16.1.2
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-13
44 Logging and the CMTS
Configure Local Facility First
C4/C4c CMTS Rel. 8.0.7
This command sends all Syslog messages to the Syslog facility. In this example it is called local4. configure logging facility local4
Send All Informational Messages to Syslog
The following command sends all informational messages (priority 7) to facility local4 of the Syslog server. The command will fail if priority 7 is not first enabled for the local volatile or local non-volatile logs. configure logging syslog 7
Disable Informational Messages to Syslog
This command disables all informational messages previously routed to the Syslog server. configure no logging syslog 7
Override Priority Settings
This command overrides the priority setting and allows a specified event ID to do one of three things: •
admit, or
•
control by priority, or
•
inhibit.
configure logging override event The outcome is dependent upon the current priority settings. Use the show log history detail command to find the ID number of a given event. Overriding an event is a way to keep the log buffer from overflowing; typically it is used to prevent the system from logging a particular low-priority event or problem that cannot be corrected right away.
Event Routing Example 1
Use the following series of commands as an example to route emergency (1) and alerts (2) messages to the Syslog server, and to verify that the change was implemented: configure logging syslog 1 configure logging syslog 2 show logging syslog End of example
44-14
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Generating Events and Traps Use the commands in this section to configure a SNMP server and to generate or eliminate SNMP traps. Configure SNMP Server to Existing Network
This command configures the SNMP server to 10.16.1.1 (this host IP address is meant as an example): configure snmp-server host 10.16.1.1
Restrictions and Defaults for SNMP Server
Clear the priorities for SNMP (and Syslog) before clearing the priorities for local volatile and non-volatile servers. By default, the CMTS generates SNMP traps for any event with a priority level of critical (3), error (4), warning (5), or notice (6).
Display SNMP Traps
show logging snmp This command shows the SNMP trap generation configuration and utilization statistics. configure logging snmp 7 This command generates SNMP traps for informational messages (event priority 7). NOTE This command will fail if the priorities are not first enabled for the local volatile log or local non-volatile logs.
Eliminate SNMP Traps
The following command eliminates trap generation for all event priorities: configure no logging SNMP
Enabling Traps
The following command enables DOCSIS®-defined traps according to the Object ID name.1 configure logging trap
1. See “Appendix H, Format and Content for Event, SYSLOG and SNMP Traps” of the SP-OSSIv1.1-I06-020830 DOCSIS® specification for more information.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-15
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
See the example output below for the trap types available for this command. C4# configure logging trap ? bpi-init bpkm dcc-ack-fail dcc-req-fail dcc-rsp-fail dyn-sa dyn-serv-ack-fail dyn-serv-req-fail dyn-serv-rsp-fail init-reg-ack-fail init-reg-req-fail init-reg-rsp-fail Disable Logging Traps
-
BPI init trap BPKM trap DCC ack failed trap DCC request failed trap DCC response failed trap Dynamic SA trap Dynamic services ack failed trap Dynamic services request failed trap Dynamic services response failed trap Register acknowledgement failed trap Register request failed trap Register response failed trap
The following command turns off trap logging: configure no logging trap
SNMP Trap Examples SNMP Trap Example 1
Use the following series of commands to enable emergency (1) and alerts (2) traps to the Syslog server: configure logging snmp 1 configure logging snmp 2 End of example
SNMP Trap Example 2
Use the following commands to disable generating traps for the priority levels emergency and alerts: configure no logging snmp 1 configure no logging snmp 2 End of example Table 44-2 provides a summary of commands used to control SNMP traps. Use the commands to enable or disable the commands listed. A brief explanation of each command is provided.
44-16
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Table 44-2: SNMP Trap Control Type of Filter
CLI Command Options
Explanation
configure cable enable-trap … CM Status Change
cmflap-notification cminit-ip-notification cminit-ranging-notification cminit-reg-notification cmonoff-notification
configure logging snmp Severity (The eight priority levels for SNMP traps Level are the same as the event message priorities.) Trap Recipient and Filter
Per Modem Activity
Issue 2.0
1 2 3 4
trap trap trap trap trap
if a CM returns after dropping off (flapping) when a CM resets while getting IP when a CM resets while ranging when a CM resets while online (registered) when a CM completes its registration
emergency alert critical error
5 6 7 8
warning notice informational debug
configure snmp-server host The filter profile to be used for a standard filter to notify-filter generate notifications. configure snmp-server host The filter profile to be used for user-defined filters to notify-filter tparam configure logging trap … bpi-init bpkm dcc-ack-fail dcc-req-fail dcc-rsp-fail dyn-sa dyn-serv-ack-fail dyn-serv-req-fail dyn-serv-rsp-fail init-reg-ack-fail init-reg-req-fail init-reg-rsp-fail
configure snmp-server card-trap-inh slot Per Card or Port configure snmp-server port-trap-inh slot Level port Per MIB Subtree OID
Send Send Send Send Send
BPI init trap BPKM trap DCC ack failed trap DCC request failed trap DCC response failed trap Dynamic SA trap Dynamic services ack failed trap Dynamic services request failed trap Dynamic services response failed trap Register acknowledgement failed trap Register request failed trap Register response failed trap Sets the inhibit status for the card or port. Values are expressed as hexadecimal integers: 80 inhibits the primary trap 40 inhibits the secondary trap 20 inhibits the duplex trap 10 inhibits the linkUplinkDown trap (example: c0 = 80 + 40 = primary and secondary traps inhibited)
configure snmp-server notify-filter profile Sets filter profile to be used for generating notifications. subtree type affected, and whether it is included or excluded.
ARRIS PROPRIETARY — All Rights Reserved
44-17
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Routing Events to Local Volatile Logs This section contains commands used to route events to the local logs. Local Log Restrictions and Defaults
By default, the CMTS routes any event with priority emergency (1), alert (2), critical (3), and error (4) to the local logs . In addition, the local volatile logs also receive events with the warning (5) and notice (6) priorities. Before clearing the priorities for local volatile servers, the priorities must first be cleared for Syslog and SNMP.
Configure Local Logging Levels
The following command sets events to report for priority level 4
Disable All Local Logging Levels
The following command clears both the local volatile logs.
Disable Specific LocalVolatile Logging Level
The following command clears priority level 4 event messages for the local volatile log.
configure logging local-volatile 4
clear logging local
configure no logging local-volatile 6 NOTE This command will fail if the specified priority is not first disabled for Syslog and SNMP. See the sample error message that follows: Priority 6 must be disabled for syslog and SNMP before it can be disabled for local-volatile Error: Bad command SCM#
Show Logging Configuration Local:
44-18
The following is an example of system output from the show logging local command:
size=10 Volatile: notifications=1489 priority=1(emergency), 2(alert), 3(critical), 4(error), 5(warning), 6(notice) Nonvolatile: notifications=793 priority=none
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Managing the Local Logs
This section contains examples to change the local log configuration parameters. The following command changes the number of events maintained in the local logs to 100. configure logging local-volatile size 100 By default, the CMTS maintains the 10 most recent event types in the local volatile log.
Displaying Events on the System Console If desired, CMTS events may be displayed on the system console. By default, no events are displayed on the console. The system console display is the RS-232 port on the System Control Module. There is a limit of one console session per CMTS.
Procedure 44-1
How to Route Events to the Console Perform the following steps, in sequence to properly route messages to the console and then return the console to its initial configuration. 1 Display the system console configuration and utilization statistics: show logging console 2 Display additional event priorities on the console, issuing the following command once for each priority: configure logging console x Where x is an event priority value (1-8). 3 Eliminate the display of all event priorities on the system console: configure no logging console End of procedure
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
44-19
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
Routing Events to the Monitor The monitor routes messages to the TCP/IP socket which is attached to a telnet session.
Procedure 44-2
How to Route Events to the Monitor Use this procedure to send output to the screen of a telnet session. 1 Send output to the monitor of a telnet session: config logging monitor x Where x is an event priority value (1-8) The output will continue to be routed to the telnet session until either the logging to the monitor is disabled or the telnet session is disconnected. 2 Disable delivery of all notifications to a specific destination: config no logging monitor End of procedure
Displaying Debug Messages on the Monitor Example
For example, to display all debug messages to the telnet window from which the command is entered: # config logging monitor 8 Where 8 is the debug priority level. End of example
Routing Events to the History Log The CMTS routes any event whose priority has been configured for Syslog, local log, SNMP, or the console to a RAM-based history. By default, the history maintains the 2000 most recent events. Restrictions and Defaults for the History Log
44-20
The logging history is a circular buffer that stores the last 2000 events that are delivered to any destination. With the exception of the debug priority (8), which is reserved for ARRIS Tech Support, all events that have a priority enabled for at least one destination are stored in the logging
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
44 Logging and the CMTS
C4/C4c CMTS Rel. 8.0.7
history. For debug priority (8), the events are stored in the logging history only if they are enabled using the config logging debug command.
Procedure 44-3
How to Configure the History Log 1 Display the history size and dump the contents of the logging history: show logging history 2 Change the number of events maintained in the RAM history: configure logging history size x Where x is the number of events. 3 (If desired) Clear the logging history: clear logging history End of procedure
Logging OSPF Event Messages CAUTION
Logging of debug messages should be enabled only with assistance from ARRIS Technical Support. If enabled and used improperly, the user could flood the system with event messages. This flood of messages could impair CPU performance. OSPF event log messages can help to identify misconfigurations or routing inconsistencies. For example, packets received on:
Issue 2.0
•
Non-multicast interfaces
•
Interfaces with mismatched destination IPs or subnets
•
Inactive interfaces
•
Interfaces without masks
ARRIS PROPRIETARY — All Rights Reserved
44-21
44 Logging and the CMTS
44-22
C4/C4c CMTS Rel. 8.0.7
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
45 Fully-Qualified Domain Name (FQDN)
C4/C4c CMTS Rel. 8.0.7
45
Fully-Qualified Domain Name (FQDN)
Topics
Page
Overview
1
Operational Concerns
2
CLI Commands
4
Overview The term fully qualified domain name refers to a complete name for a host or computer connected to the Internet. The name is said to be complete because it contains the host name, domain name or names, and root. A Domain Name System (DNS) server uses it to resolve the FQDN to the correct IP address. This feature is intended for MSOs that use IGMP statically provisioned IPv4 multicast groups or the advanced mode DOCSIS Set-top Gateway (DSG). The advanced mode requires that a DSG source IP address and a multicast group address be manually configured on each C4 or C4c CMTS. Whenever these addresses change they must again be manually configured on each CMTS. This feature enables the MSO to replace the DSG tunnel addresses or statically provisioned source addresses for multicast groups with FQDNs. If a change is required, the MSO can simply update the new source address and group address information of the FQDN in the DNS server instead of manually in all of the CMTSs.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
45-1
45 Fully-Qualified Domain Name (FQDN)
C4/C4c CMTS Rel. 8.0.7
In addition, the CMTS allows the use of a hostname in the configuration of the classifiers and static IGMP joins. If only the hostname is specified, the CMTS utilizes its configured IP domain name to complete the FQDN for the DNS lookup. With this feature enabled, the CMTSs in the network check the DNS server periodically using the provisioned FQDNs. If new information is available, the CMTS automatically removes the prior multicast configuration and joins the multicast group using the new source address. The end result is an automatic propagation of the new multicast configuration without manual intervention except for entering the appropriate DNS record on the DNS server. The C4 CMTS maintains the DNS server list and the default domain name list for all applications. The CMTS bases the frequency of the DNS query messages on both the current Time-To-Live (TTL) value of the FQDN to IP binding and on the poll interval setting. When the TTL expires, a query is sent by the CMTS to the DNS server to again resolve the FQDN. Limited Support for FQDN Feature
Support for this feature is limited to the following applications: •
DOCSIS Set-top Gateway (DSG) tunnel classifiers for pre-DOCSIS 3.0 Set-top boxes (STBs) on MDF-disabled MAC domains
•
Statically joined IGMPv3 (non-DSG) pre-DOCSIS 3.0 cable modems on MDF-disabled MAC domains.
•
This feature supports the association of an FQDN with only an IPv4 source address. Association with an IPv6 address is not supported.
•
An FQDN cannot be used for the multicast destination or group.
•
The frequency of CMTS DNS queries is based on the Time-To-Live (TTL) value of the FQDN-to-IP binding.
•
This feature does not support IGMP static host joins. It supports only IGMP static router joins.
•
When the FQDN-to-IP binding changes, the C4 CMTS reestablishes only the affected DSG or IGMP statically provisioned multicast groups. Forwarding packet counts in this case are cleared. These counts are not carried forward because they are specific to the source/group addresses.
•
Other than the enhancements specified in this document, the operation of statically-joined IGMP will be consistent with that in Release 7.4.
•
The C4 CMTS supports a maximum of 25 FQDN cache entries.
Operational Concerns
45-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
45 Fully-Qualified Domain Name (FQDN)
C4/C4c CMTS Rel. 8.0.7
•
When the FQDN-to-IP binding changes, the Downstream Channel Descriptor (DCD) messages will be modified if they include DSG tunnel classifiers. The classifiers will be modified to reflect the new IP address.
•
If the C4 CMTS polling reveals that the FQDN-to-IP binding has changed, then any DSG or IGMP data forwarding based on that binding must be stopped. This happens when the polling response does not indicate a binding or when it indicates that the FQDN is bound to something other than an IPv4 unicast address.
•
When an FQDN to IP address binding is removed, dependent DCD messages will be modified according to the following conditions:
-
•
If affected DSG tunnel classifier(s) are currently included in the DCD, the classifier(s) will be removed from the DCD. - If affected DSG tunnel classifier(s) are the sole classifier(s) for tunnel(s) that are currently included in the DCD, the tunnel(s) will be removed from the DCD. When an FQDN to IP address binding is regained, dependent DCD messages will be modified according to the following conditions:
-
•
•
If affected DSG tunnel classifier(s) were removed from the DCD, the classifier(s) will be reestablished in the DCD to reflect the IP address. - If affected DSG tunnel classifier(s) were the sole classifier(s) for tunnel(s) previously removed from the DCD, the tunnel(s) will be reestablished in the DCD. If for whatever reason the DNS server does not respond to queries from the CMTS, then at some point the FQDNs go into a timeout state. The C4/C4c maintains FQDNs in this state and assumes that the IP addresses of these FQDNs are still valid until the DNS server comes back online and changes them. The CMTS permits FQDN and PQDN names to be up to 154 characters in length.
-
•
The default domain name may be up to 96 characters in length. Domain names consist of one or more parts called labels. Each such label cannot exceed 63 characters in length. The C4 CMTS enforces RFC 3696 and RFC 1035 rules for domain naming. These rules are also called the LDH (Letter-Digit-Hyphen) rules.
-
Issue 2.0
“The LDH rule, as updated, provides that the labels (words or strings separated by periods) that make up a domain name must consist of only the ASCII alphabetic and numeric characters, plus the hyphen. No other symbols or punctuation characters are permitted, nor is blank space. If the hyphen is used, it is not
ARRIS PROPRIETARY — All Rights Reserved
45-3
45 Fully-Qualified Domain Name (FQDN)
-
C4/C4c CMTS Rel. 8.0.7
permitted to appear at either the beginning or end of a label. There is an additional rule that essentially requires that top-level domain names not be all-numeric.” (From RFC 3696.) “The labels must follow the rules for ARPANET host names. They must start with a letter, end with a letter or digit, and have as interior characters only letters, digits, and hyphen.” (From RFC 1035.)
CLI Commands
Table 45-1: CLI Commands for FQDN Purpose
Syntax
To enable [disable] multicast FQDN polling:
configure ip fqdn-cache enable [no]
To configure static FQDN cache polling interval: The NO version of this command restores the default value of this poll-interval.
configure ip fqdn-cache poll-interval [no]
To configure a domain name in the DSG tunnel classifier: The NO version of this command ignores all the optional parameters and removes the entire row associated with the given tunnel and classifier.
configure cable dsg tunnel classifier [priority ] [source-network ] [dest-ip ] [destport-range ] [include-indcd] [no]
Network-side Interfaces configure interface {gigabitEthernet | To configure domain names in static IGMP layer 2 tengigabitEthernet} ip igmp static-group router joins: [source ] [no] To configure domain names in static IGMP layer 3 configure interface {gigabitEthernet | router joins: tengigabitEthernet} .subInterface ip igmp The NO versions of these commands remove the static-group [source ] [no] provisioning for the static-group and source. NOTE: All Layer3 join commands MUST include the subInterface number. This applies even to the ".0". Cable-side Interfaces (layer 2 joins) configure interface cable-mac ip igmp staticTo configure domain names in static IGMP layer 2 group [source ] [no] router joins: configure interface cable-downstream / ip
The NO versions of these commands remove the igmp static-group [source ] [no] provisioning for the static-group and source.
45-4
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
45 Fully-Qualified Domain Name (FQDN)
C4/C4c CMTS Rel. 8.0.7
Table 45-1: CLI Commands for FQDN (Continued) Purpose
Syntax
Cable-side Interfaces (layer 3 joins) To configure domain names in static IGMP layer 3 configure interface cable-mac .subInterface ip router joins: igmp static-group [source ] [no]
NOTE: All Layer3 join commands MUST include the subInterface number. This applies even to the ".0". To refresh the C4 application-maintained FQDN to configure ip fqdn-cache refresh IP binding: To display the current entries in the FQDN cache show ip fqdn-cache of the C4 and the enable setting and poll interval: To display the list of DNS servers configured for use on the C4:
show ip domain-lookup
To display which DSG tunnel source IPs are associated with which FQDNs:
show cable dsg tunnel [] classifier []
To display IGMP source information for a given interface and the FQDN (if applicable) associated show ip igmp groups detail with each source IP address: To display forwarding counts for a multicast protocol and the FQDN (if applicable) associated with each source IP address:
show ip mroute
Sample system output for show ip fqdn-cache: Administrative state: UP Poll Interval: 1800 seconds Name : IP Addr : State : Last Poll:
Sample1-DSG-server.arrisi.com 10.192.68.4 Active 2011 March 24 09:49:25
Name : dsg-srv1.lab.arrisi.com IP Addr : State : Not initialized Last Poll: Never Name : dsg-srv2.lab.arrisi.com IP Addr : State : IP does not exist Last Poll: 2011 March 24 09:49:25
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
45-5
45 Fully-Qualified Domain Name (FQDN)
C4/C4c CMTS Rel. 8.0.7
Name : dsg-srv3.lab.arrisi.com IP Addr : State : Invalid IP Last Poll: 2011 March 24 09:49:25 Name : IP Addr : State : Last Poll: FQDN Rejection Scenarios
45-6
dsg-srv4.lab.arrisi.com 10.192.68.4 Timeout 2011 March 24 09:49:25
Under certain circumstances attempts to configure an FQDN will fail or generate a log message. The following are some typical examples: •
If a DSG tunnel classifier with explicit source and group addresses has been configured, it must be deprovisioned before the same classifier can be used for an FQDN. If you do not first deprovision the DSG tunnel classifier, the CLI command to assign an FQDN will fail.
•
If on the contrary a DSG tunnel classifier has been configured with an FQDN, then this DSG tunnel classifier cannot be reconfigured with explicit source and group addresses. The DSG tunnel classifier must first be deprovisioned before it can be reconfigured with explicit source and group addresses.
•
If the FQDN feature has configured an IGMP statically provisioned multicast group that has been resolved to an IP address, any attempt by the user to create an IGMP statically provisioned multicast group with the same source and group addresses will fail.
•
If the FQDN feature has configured an IGMP statically provisioned multicast group that has not yet been resolved to an IP address, and the user creates an IGMP statically provisioned multicast group with explicit addresses, and after that the FQDN resolves to the same source address, then this FQDN will be saved. The CMTS will generate a log message to notify the user that this configuration may not be what he or she intended. The saved FQDN will take effect only if the IGMP statically provisioned multicast group with explicit IP addresses is deprovisioned.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
46 DSx DQoS VoIP on the CMTS
C4/C4c CMTS Rel. 8.0.7
46
DSx DQoS VoIP on the CMTS
Dynamic Services (DSx) / Dynamic Quality of Service (DQoS) provides for guaranteed Quality of Service for voice applications using DOCSIS 1.1 Dynamic Services (DSx) functionality. This mode accepts DSx signaling from any DSx-capable modem. DSx DQoS VoIP does not provide full PacketCable™ operation within the CMTS. DSx DQoS Provisioning on the CMTS
The following command should be run for all cable-macs which will be used for DSx DQoS call processing: configure interface cable-mac authorizationmodule open-dynamic-flow-policy This command allows for authorization of non-PacketCable DQoS through DSx signaling on the CAM. Open-dynamic-flow-policy must be enabled (the default is enabled). Enabling open-dynamic-flow-policy is required when running with non-ARRIS MTAs. If only ARRIS Touchstone™ Telephony Modems or Touchstone™ Telephony Ports are used, this setting can be disabled to provide a higher level of protection against theft of service. The following CLI command can be used to alter timers on the CMTS: configure cable max-qos-admitted-timeout Default =
200
configure cable max-qos-active-timeout Default =
Issue 2.0
30
ARRIS PROPRIETARY — All Rights Reserved
46-1
46 DSx DQoS VoIP on the CMTS
C4/C4c CMTS Rel. 8.0.7
NOTE If DSx DQoS VoIP is enabled, the admitted timeout should be set at 200 seconds (the default), and the active timeout should be set to 30 seconds. This command is for DSx DQoS; it has no effect on PacketCable. The defaults ensure that inactive resources are released. Increasing these default values or setting them to 0 (which represents infinity) is not recommended. The default values serve as a precaution for freeing resources in the event that any device or transmission path in the network does not perform as required.
46-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
47
BSoD L2VPN
Topics
Page
Background Information
1
Overview
2
Additional Information
4
Enabling BSoD
5
CLI Commands
7
This chapter is meant for customers using Business Services over DOCSIS for Layer 2 Virtual Private Networks. (BSoD L2VPN).
Background Information The following paragraph from the DOCSIS BSoD specification is a description of the background and business application of this feature:
Data networking between the multiple sites of commercial businesses represents a significant business opportunity for cable operators. Commercial data networks are usually implemented with private pointto-point data connections such as Frame Relay, ISDN, or ATM virtual circuits, often with equipment that provides transparent delivery of layer 2 Ethernet LAN packets. A service that interconnects subscriber enterprise LANs with Layer 2 forwarding is called Transparent LAN Service (TLS). (Data-Over-Cable Service Interface Specifications Business Services over DOCSIS®, Layer 2 Virtual Private Networks, CM-SP-L2VPN-I08-080522, May 22, 2008.)
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
47-1
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
This same specification goes on to explain that a TLS can be created using BSoD. From the point of view of the business enterprise using BSoD, the TLS may include CPE from more than one CMTS in the cable operator’s network, other LANs attached to CMs, and any other LANs bridged to the customer’s VLAN in the IEEE 802.1Q-compliant bridge in the cable operator’s backbone. The CPE in the TLS can be managed or operated just as if they were on a private Ethernet LAN, with IP addresses assigned by the TLS enterprise and taken from its subnet. The IP subnet of the TLS does not need to be coordinated with the enterprise clients or customers on the cable side of the TLS. Finally, the LAN subscribers in the TLS are isolated from the other customers in the cable operator’s HFC network(s) and from other L2VPNs.
Overview The BSoD L2VPN feature provides point-to-point transparent Layer-2 forwarding between a CM and a network-side Layer-2 device using one or two provider-imposed Q-tags to multiplex the packets belonging to each L2VPN instance on the designated L2VPN network interface between the C4 CMTS and the network-side device. These provider Q-tags are imposed or deposed by the CMTS and are not transmitted to or received from CPE devices on the cable interfaces. Any customer Q-tags imposed by CPE devices are considered to be part of the L2VPN payload and are not considered to be service delimiting to the CMTS. BSoD does not require the CMTS to learn MAC addresses. MAC address learning is not required in the downstream direction because of the one-to-one mapping between the Q-tags and the downstream CM. It is not required in the upstream direction because all traffic for all L2VPN instances arrives on known L2VPN upstream service flows (SFs) and is vectored to a single active egress L2VPN network interface. Since CPE-imposed Q-tags are not trusted as L2VPN membership tokens, all L2VPN traffic from CPE must arrive on one or more upstream SFs designated during CM registration as belonging to the L2VPN instance. This is done with an L2VPN TLV encoding in the CM configuration file that provides the upstream Q-tags and Priority values to be used when transmitting these packets on the active L2VPN egress network interface. An L2VPN instance may be configured with either one or two 12-bit Q-tags. Single Q-tag encapsulated L2VPN instances provide a numbering space of up to 4,000 values; dual Q-tag encapsulated L2VPN instances provide up to 16 million values.1 However, the CMTS supports a maximum of 16,000 L2VPN instances identified by either single or dual Q-tags that may be taken from anywhere 1. Dual Q-tags are also known as Q-in-Q or QinQ.
47-2
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
within the Q-tag number space. An outer Q-tag may have a Q-tag only in the range of 2-4094 because Q-tags 0, 1, and 4095 are reserved by IEEE 802.1Q while inner Q-tags may be numbered from 1-4095. Within a given CM one or more SFs may share the same Q-tags, so the CM configuration file may contain either a single L2VPN TLV encoding that applies to all SFs or it may contain individual L2VPN TLV encodings that apply only to a single SF. Either way, individual SFs are configured for L2VPN treatment in the CMTS during CM registration. The CMTS does not support L2VPNs that are defined in dynamic SFs. When a downstream Q-tagged packet arrives on the active L2VPN ingress network interface in the RCM, the Q-tags uniquely identify the CM belonging to the L2VPN instance and hence the downstream cable port. Only individual values of the Q-tags identify L2VPN instances because there is no service type encoding in the Q-tags. This means that the Q-tag number space for single (or outer) Q-tags on a given physical network interface is shared between the existing L3VPN VRF Q-tag subinterface feature and this L2VPN Q-tag feature. Since the L3VPN VRF Q-tag feature only uses a single Q-tag, only the outer Q-tag of a Q-tag pair must be inspected to determine if the packet is to receive L2VPN or L3VPN forwarding treatment. Also note that the L2VPN Q-tags are assigned by L2VPN TLV encodings embedded in CM configuration files while L3VPN Q-tags are assigned in subinterface encapsulation commands by the CLI. Use the following command to designate the range of Q-tags that are reserved to L2VPNs. This will prevent Q-tag collisions between the L2VPN and the L3VPN features. configure l2vpn [no] vlanid-range [- ]
{single-qtag | dual-qtag}
When a downstream L2VPN packet arrives at the CAM, the packet is transmitted only on the downstream channel used by the CM. It is encrypted using BPI+ to ensure that it is received only by the target CM hosting the L2VPN instance. This BPI+ encryption is applied to individually-addressed (unicast MAC) and as well as to group-addressed (multicast/broadcast MAC) packets that belong to the L2VPN instance. This ensures that L2VPN group-addressed packets transmitted on the downstream channel are rejected by other CMs that do not have the correct BPI+ SAID to decrypt the L2VPN packet. Furthermore, when the target CM is L2VPN-compliant under the BSoD L2VPN specification, then this CM forwards the L2VPN packet only to the Cable Modem Customer Interface (CMCI) preventing its own eCM IP host stack or other embedded eSAFE devices from receiving the packet. On the other hand a non-compliant CM forwards all unencrypted downstream IP and ARP broadcast packets to the CMCI as well as to all internal eSAFE devices and the eCM IP host stack. Not all cable modems are L2VPN capable. An L2VPN-compliant CM reports its L2VPN capabilities during registration. The preferred mode of operation is to provide subscribers with L2VPN-compliant CMs when carrying native
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
47-3
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
IP/ARP traffic in the L2VPN tunnels. This ensures the maximum privacy for the L2VPN subscriber and the maximum performance for the CM and CMTS. The CMTS only supports non-compliant CMs when explicitly enabled by CLI command. CMs that signal L2VPN capabilities are always permitted to register with correct L2VPN TLV encodings, but noncompliant CMs are allowed to register with L2VPN TLV encodings only when this policy is explicitly allowed. L2VPN-compliant CMs must register with L2VPN capabilities that include Downstream Unencrypted Traffic (DUT) filtering mode and eSAFE host identification. In particular, the CMTS does not perform DHCP snooping for eSAFE host MAC addresses, nor does it support Downstream IP Multicast Encryption (DIME) for non-compliant CMs. Thus, these CMs form L2VPN tunnels that are called leaky because the packets can be forwarded to endpoints outside the VPN tunnel. It is the cable operator’s responsibility (via explicit CLI commands) to allow these non-compliant CMs to register with L2VPN TLV encodings.
Additional Information Customers using the ARRIS implementation of BSoD L2VPN should be aware of the following:
47-4
•
The ARRIS CMTS provides the point-to-point L2VPN service model but not the point-to-multipoint model described in the DOCSIS spec.
•
Each modem using BSoD must have a unique config file with its own unique Q-tag or Q-tag pair.
•
Modems using BSoD must have BPI+ enabled.
•
The chassis must be equipped with the following modules: RCM, 16D CAMs or XD CAMs, and 12U or 24U CAMs.
•
Single and Dual Q-tags are supported, other types of Network System Interface (NSI) encapsulation are not supported.
•
The CMTS supports a maximum of 16,000 dual-tag L2VPNs.
•
The CMTS supports a maximum of 4,093 single-tag L2VPNs.
•
FlexPath bonded modems do not support this feature.
•
The use of L2VPN non-compliant modems is permitted in this implementation per the DOCSIS BSoD spec, but results in leaky L2VPN tunnels which fail to exclude unencrypted ARP and IP broadcasts. If you wish to configure BSoD using non-compliant modems, and if these non-compliant modems are PPPoE clients, then the leakage is benign because such clients ignore non-PPPoE traffic.
•
BSoD tunnels are not considered to be a part of general ISP traffic; therefore, they are not included in Legal Intercept captures.
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
Enabling BSoD The following is a listing of basic tasks for enabling the BSoD feature. Steps 1 and 2 are beyond the scope of this document. 1 Determine which Business customer will be using the L2VPN service. Assign the appropriate VPNID and Q-tags to the customer by creating a unique CM config file for each customer’s modem. 2 Update the provisioning server so that the modems get the proper configuration files. 3 Configure the CMTS L2VPN feature. a
Enable L2VPN on the CMTS:
configure l2vpn forwarding enable b
Enable L2VPN forwarding for each cable-mac which will be servicing a L2VPN modem:
configure l2vpn cable-mac 1 configure l2vpn cable-mac 2 configure l2vpn cable-mac 3 c
Configure the primary and secondary Network interfaces:
configure l2vpn network-interface gigabitEthernet 17/9 primary configure l2vpn network-interface gigabitEthernet 18/9 secondary
d
(Optional) If you want to support non-compliant L2VPN modems, you must set the L2VPN CM capability to optional:
configure l2vpn cm capability optional e
Configure the assigned Q-tag ranges to be used for VPN service:
(Note: Q-tags may also be used for layer 3 sub-interfaces and need to be specifically assigned to be used for L2VPN.) configure l2vpn vlanid-range 201-240 single-qtag configure l2vpn vlanid-range 300 dual-qtag configure l2vpn vlanid-range 1200-1224 single-qtag configure l2vpn vlanid-range 1300-1400 dual-qtag
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
47-5
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
The following snapshot is an example of the modem configuration file displaying tags and VPN identifiers:
Figure 47-1: Example of Modem Configuration File Screenshot
47-6
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
CLI Commands
Table 47-1: List of L2VPN CLI Commands Purpose or Explanation Configure the primary and secondary network interfaces. The optional secondary interface is used only if the primary is down.
Command Syntax configure l2vpn [no] network-interface / { primary | secondary }
Configure cable MAC interfaces participating in the configure l2vpn [no] cable-mac { | *} L2VPN service. CMs that attempt to register as L2VPN in non-participating cable-mac interfaces are rejected. The asterisk “*” is used to select all cable-macs. Permit non-compliant CMs to register with L2VPN TLV encodings. L2VPN-compliant modems are allowed to configure l2vpn cm capability { esafe-ident | dut-filter } { required | optional } register by default; non-compliant CMs must be explicitly enabled to use L2VPN settings. Declare the VLAN ID ranges that are reserved for L2VPN use and allocated to single or dual Q-tag L2VPN instances.
configure l2vpn [no] vlanid-range [ to ] { single-qtag | dual-qtag }
Globally enable or disable the L2VPN forwarding. The configure l2vpn forwarding { enable | disable } L2VPN forwarding is disabled by default. Enable or disable L2VPN forwarding for a single VPN ID.
configure l2vpn forwarding l2vpnid { enable | disable }
Enable or disable L2VPN forwarding for a single cable configure l2vpn forwarding cm-mac { enable | disable } modem. Enable or disable L2VPN forwarding for a single L2VPN configure l2vpn forwarding instance [ : < inner-vlanid> ] { enable | disable } instance.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
47-7
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
Table 47-2 lists the CLI show commands that will be most useful with regard to VPNs. Following the table are examples of system outputs for each of these commands. Table 47-2: List of Useful Show Commands for L2VPN and BSoD Purpose or Explanation
Command Syntax
Display the configuration and state of the L2VPN settings.
show l2vpn
Display the configuration and state of a specific L2VPNID.
show l2vpn l2vpnid
Display the configuration and state of the specific Q-tag or Q-tag pair within an L2VPN. Display the specific cable-modem by MAC address.
show l2vpn l2vpnid [ [ : ]] The colon “:” is used to separate the inner Q-tag from the outer in a Q-tag pair, for example, 20:20. If you entered 202, the CMTS would look for single Q-tag number two hundred and two. show l2vpn cm-mac
Sample output for the show cable modem detail command: 14/2-1/3 CM 001c.ea27.4f2a (Cisco) D2.0 State=Operational D1.1/atdma PrimSID=2 Cable-Mac= 1, mCMsg = 2 mDSsg = 1 mUSsg = 1, RCS=0x00000003 TCS=0x00000004 Timing Offset=979 Rec Power= 0.00 dBmV Proto-Throttle=Normal Uptime= 0 days 0:00:14 IPv4=192.168.180.3 cfg=single-202.bin LB Policy=0 LB Group=16781312 Filter-Group CM-Down:0 CM-Up:0 Privacy=Ready Ver=BPI Plus Authorized DES56 Primary SAId=2 Seq=1 MDF Capability= GMAC Explicit(1) MDF Mode= MDF Disabled(0) u/d SFID SID State Sched Tmin Tmax DFrms DBytes CRC HCS Slot/Ports u 3 2 Activ BE 0 0 1 315 0 0 1/3 d 4 *2 Activ 8000 0 1 182 14/2 u 5 3 Activ BE 0 0 0 0 0 0 1/3 L2VPN per CM: (Enabled) Cadant u/d SFID Classifier L2VPN Name u 3 - Cadant d 4 1 Cadant Current CPE=0, IPv4 Addr=0, IPv6 Addr=0 Max CPE=32, IPv4 Addr=32, IPv6 Addr=64
47-8
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
Sample output for the show l2vpn command: L2VPN forwarding status: enable L2VPN Primary Network Interface: gigabitEthernet 17/0 L2VPN Secondary Network Interface: none
Current Status Active
CM requirements: ----------------
esafe-ident required
dut-filter required
CableMac Interfaces: -------------------1 Outer VLANid -----------2-4000
Q-tag type ---------single-qtag
L2VPNIDs in use --------------Cadant
Sample output for the show l2vpn l2vpnid command, where “Cadant” is the ID of the layer 2 VPN: C4# show l2vpn l2vpnid Cadant Downstream Forwarding Channel CM MAC State ---------- -------------- ---------14/2 001c.ea27.4f2a enable
Reported Capabilties VLANids SAID SFID-Dsid pairs ------------- --------- ----- --------------esafe & dut 202 2 3-0, 4-0, 5-0
Sample output for the show l2vpn cl2vpnid command, where 202 is the ID of the specific Q-tag: C4# show l2vpn l2vpnid Cadant 202 DS=14/2 CM=001c.ea27.4f2a Forwarding=enable VLANids=202 Reported Capabilities= esafe & dut SFID-Dsid pairs= 3-0, 4-0, 5-0 Upstream Packets 0 Bytes 0 Discards Downstream Packets 0 Bytes 0 Discards
SAID=2
0
Sample output for the show l2vpn cm-mac command, where 001c.ea27.4f2a is the specific MAC address requested: C4# show l2vpn cm-mac 001c.ea27.4f2a DS=14/2 CM=001c.ea27.4f2a Forwarding=enable VLANids=202 Reported Capabilities= esafe & dut SFID-Dsid pairs= 3-0, 4-0, 5-0 Upstream Packets 0 Bytes 0 Discards Downstream Packets 0 Bytes 0 Discards
Issue 2.0
SAID=2
0 0
ARRIS PROPRIETARY — All Rights Reserved
47-9
47 BSoD L2VPN
C4/C4c CMTS Rel. 8.0.7
Sample BSOD configuration Using BSOD capable and Legacy (PPPoE) Modems CPE C IP 192.168.10.11 PPPoE
Routed Network
PPPoE Aggregator
Switch
Provider Network Switch
CPE D IP 172.16.10.5
Switch L2VPN Traffic
Dual Qtag 300:242
CPE A IP 192.168.10.1 PPPoE
RF Single Qtag 298
CPE B IP 172.16.10.1
C4 CMTS L2 Configuration: configure l2vpn forwarding enable configure l2vpn cm capability optional configure l2vpn network-interface gigabitEthernet 17/0 primary configure l2vpn cable-mac 1 configure l2vpn vlanid-range 201-299 single-qtag configure l2vpn vlanid-range 300 dual-qtag
Figure 47-2: Sample BSOD Configuration Using BSOD Capable and Legacy (PPoE) Modems
47-10
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4 CMTS Rel. 8.0.7
Updates included in Release 8.0.7
Updates included in Release 8.0.7 (8.0.5)
Added lists of IPv6 source and destination address scopes that are passed.
19-5
(8.0.5)
Added statement regarding enhanced ower for XD CAMs in Annex A.
9-19
(8.0.5)
Added statement that Q-tags are supported for IS-IS traffic for both IPv4 and IPv6.
(8.0.5)
Added table of IPv4 and IPv6 supported routes.
(8.0.5)
Cleaning up stale routes for IPv6 Prefix Stability (IGP Snooping).
(8.0.5)
Corrected the default group name from "default" to "tac_default".
(8.0.5)
CPE Host Authorization feature changed to support up to 32 entries.
32-29
(8.0.5)
Dynamic Hostname Support for IS-IS.
15-23
(8.0.5)
IPv6 Distribute Lists
25-38
(8.0.5)
IPv6 Prefix Stability
25-25
(8.0.5)
Number of IPv4 and IPv6 Routes Supported.
15-2
(8.0.5)
PD 178195: Guidelines for Using Reconfiguration Scripts or Making Multiple RF Parameter Changes
9-23
(8.0.5)
PD 186090: Revised temperature out-of-range thresholds.
(8.0.5)
PD00181913: corrected certain text and CLI examples of this section that referred to extended, not standard, ACLs.
(8.0.5)
PD180668 - Added numbers for DS and US service flows and DS classifiers for SCM II and SCM II EM.
5-9
(8.0.5)
PD182513 - Revised Purpose statement of the format command and removed obsolete parameters.
CLI-1227
(8.0.5)
Updated QAM Output Power table to included the upper limit of 51 dBmV for Annex A XD CAMs when enhanced power is enabled.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
15-20 5-9 25-37 32-8
CLI-1731 36-11
9-18
i
Updates included in Release 8.0.7
ii
ARRIS PROPRIETARY — All Rights Reserved
C4 CMTS Rel. 8.0.7
October 9, 2012
CLI Changes in Release 8.0.5
(8.0.5)
Added the "key" parameter to the configure ntp server command.
CLI-888
(8.0.5)
Added the "noise" parameter to the show cable modem command.
CLI-1318
(8.0.5)
Added the "retain-patches" parameter to the reload command.
CLI-1249
(8.0.5)
Added the 5TapPts parameter to the configure operation mode command.
CLI-894
(8.0.5)
configure cable downstream-enhanced-power [no]
CLI-135
(8.0.5)
configure cable relay-agent-option qos-sc-name [no]
CLI-259
(8.0.5)
configure ipv6 prefix-stability [no]
CLI-818
(8.0.5)
configure ipv6 router ospf distribute-list out [no]
CLI-834
(8.0.5)
configure ipv6 router ospf redistribute isis [{level-1 | level-1-2 | level-2]} [metric ] [metric-type ] [tag ] [no]
CLI-837
(8.0.5)
configure route-map set community add [] [no]
CLI-997
(8.0.5)
configure route-map set community additive [] [no]
CLI-998
(8.0.5)
configure route-map set community delete [] [no]
CLI-999
(8.0.5)
configure router isis address-family ipv6 distribute-list * out *
CLI-1079
(8.0.5)
configure router isis hostname dynamic [no]
CLI-1097
(8.0.5)
Corrected parameters for the configure interface cable-mac * ip rip authentication mode command.
CLI-458
(8.0.5)
Corrected the group-qos parameter in the configure cable multicast qos group [group-qos ] priority
CLI-246
(8.0.5)
Corrected the group-qos range in the configure cable multicast qos group [group-qos ] session-range source command. CLI-247
(8.0.5)
Corrected the md5 string length from 31 to 16.
Issue 2.0
ARRIS PROPRIETARY — All Rights Reserved
CLI-887
i
CLI Changes in Release 8.0.5
C4 CMTS Rel. 8.0.7
(8.0.5)
Corrected the Purpose statement for the configure router isis address-family ipv4 distribute-list * out * command.
CLI-1070
(8.0.5)
Expanded definition of word parameter for the configure ntp authentication-key * md5 * command.
CLI-887
(8.0.5)
Removed the reference to VRF in the show route-map command.
CLI-1703
(8.0.5)
show isis hostname
CLI-1096
(8.0.5)
show isis hostname
CLI-1630
ii
ARRIS PROPRIETARY — All Rights Reserved
October 9, 2012
C4® Cable Modem Termination System (CMTS)
Issue 2.0
Comments & Feedback Form Your feedback will help us to improve the quality and usefulness of our publications. Please rate this document (1 = Poor; 5 = Excellent): Accuracy
1
2
3
4
5
Readability
1
2
3
4
5
Examples
1
2
3
4
5
Organization
1
2
3
4
5
Completeness
1
2
3
4
5
Did you find errors in this document? If so, please specify the error(s) and page number(s). _________________________________________________________________________________________ _________________________________________________________________________________________ _________________________________________________________________________________________
How does this documentation compare to that of other vendors? _________________________________________________________________________________________ _________________________________________________________________________________________ _________________________________________________________________________________________ General Comments / Suggestions for improvement: _________________________________________________________________________________________ _________________________________________________________________________________________ _________________________________________________________________________________________
Name: ____________________________________________________ Company: __________________________________
Title: _____________________
Department: ________________________________
Street: ________________________________________ City: ____________________________________ State/Prov: _____________________
Country: ___________________________
Zip:_______________
Date: _______________________________, 20 _ _ Software Release 8.0.7
October 9, 2012
ARRIS PROPRIETARY — All Rights Reserved
DO NOT CUT - FOLD AT LINE AND TAPE
Postage Required
ARRIS, Inc. Attn: User Documentation 2400 Ogden Avenue Suite 180 Lisle, IL 60532-3999
DO NOT CUT - FOLD AT LINE AND TAPE
C4® Cable Modem Termination System (CMTS)
ARRIS PROPRIETARY — All Rights Reserved
Issue 2.0
ARRIS C4® CMTS User Documentation © 2002 – 2012 ARRIS Group, Inc. All rights reserved All information contained in this document is subject to change without notice. ARRIS reserves the right to make changes to equipment design or program components, as progress in engineering, manufacturing methods, or other circumstances may warrant. ARRIS, Cadant, C4, and C4c are trademarks of ARRIS Group, Inc. All other trademarks are the property of their respective holders. October 9, 2012 Issue 2.0
Release 8.0.7 Standard Version
