8_1_5_C4_Standard_29May13

2756
ARRIS C4 ® CMTS User Documentation Standard Version Issue 2.0 Software Release: 8.1.5 May 29, 2013

Transcript of 8_1_5_C4_Standard_29May13

  • ARRIS C4 CMTSUser Documentation

    Standard Version

    Issue 2.0

    Software Release: 8.1.5

    May 29, 2013

  • ARRIS Group, Inc. Copyright 2013

    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 informa-tion and trade secrets that are confidential information of ARRIS. ARRIS reserves the right to audit the use of Customers 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 Softwares application with the Hardware, if applicable, sold in conjunction with the Software for its intended purposes, which purposes preclude Customers 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 licen-sors. 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 propri-etary 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 Reference FRM0122, Issue 9, July 2010, Section 24

  • run on the Software. Customer shall not remove, obscure or alter any notice of copyright, patent, ARRIS Group, Inc. Copyright 2013

    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 condi-tions. 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 Customers 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 soft-ware 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 soft-ware (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

    ARRIS Product Categories

    Warranty Period from Shipment Date

    Domestic U.S. Outside U.S.

    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

    Hardware one (1) Year

    Software ninety (90) days

    Hardware one (1) Year

    Software ninety (90) daysReference FRM0122, Issue 9, July 2010, Section 24

  • ARRIS Group, Inc. Copyright 2013

    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 2013 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 InformationThe 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 8,218,438 6,636,482 7,272,144 7,698,461 8,332,911 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. Reference FRM0122, Issue 9, July 2010, Section 24

  • CLI Command Modes 2-2

    CLI Syntax Conventions 2-5

    Designating MAC addresses and IP addresses 2-6

    Keyboard Shortcuts 2-6

    CLI Command Features 2-8CLI Help Feature 2-8

    Configuring Passwords and Privileges 2-12Table 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 1-2

    Admonishments 1-2

    Textual Conventions 1-3

    How to Contact Us 1-4

    2 CLI Overview

    Access Levels and Modes 2-2Issue 2.0 ARRIS Group, Inc. All Rights Reserved v

  • Table of Contents C4 CMTS Rel. 8.1.5

    CLI Filtering 2-17How to Use CLI Filtering 2-18

    Show Cable Modem Column Feature 2-24

    CLI Command Descriptions

    List of CLI Commands

    3 Standard and Cadant Enterprise MIBs

    CMTS SNMP MIB Variable Descriptions 3-2

    Enterprise MIBs 3-5

    SNMP Configuration with CLI 3-9

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

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

    6 C4 CMTS Installation Requirements

    Safety Precautions 6-2

    Electrical Equipment Guidelines 6-4

    Electrostatic Discharge (ESD) 6-4

    Installation Checklist 6-5vi ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 Table of Contents

    Unpacking the C4 CMTS 6-7Module Protection 6-8

    Installation Considerations 6-8

    Rack Mounting 6-8

    Power Requirements 6-9

    Cooling Requirements 6-9

    Rack Mounting the C4 CMTS 6-12

    Grounding the Chassis 6-13

    Main Hardware Components 6-14

    Module Types and Chassis SlotsFront View 6-14

    Chassis Rear View 6-16

    Installing Modules in the C4 CMTS 6-17

    Fan Trays 6-19

    Air Filter 6-21

    Power Conditioning Module and Cabling 6-22

    Power Protection Description 6-28

    Chassis Maintenance 6-31

    Replacing the C4 CMTS Chassis 6-32

    7 System Control Module (SCM)

    SCM Overview 7-2

    SCM/SCM II Ethernet Interfaces 7-3

    SCM 3 Ethernet Interfaces 7-3

    Installation 7-7

    How to Set Up the Terminal Emulator 7-11

    SCM Replacement 7-14

    SCM Upgrade to 1GB RAM (SCM II EM) 7-19

    Virtual System Controller 7-23

    SCM II EM (U) 7-24

    SCM 3 7-24

    SCM 3 Operational Interaction 7-25

    Out-of-Band Management on the SCM 3 7-25Issue 2.0 ARRIS Group, Inc. All Rights Reserved vii

  • Table of Contents C4 CMTS Rel. 8.1.5

    Upgrading a C4 CMTS to an SCM 3 7-26Compact Flash 7-34

    Replacing the Compact Flash 7-34

    Compact Flash Disk Partitions 7-39

    File System Administration 7-42

    File Transfers 7-43

    8 Router Control Module (RCM)

    RCM Overview 8-1

    Primary Software Functions 8-3

    RCM Hardware 8-3

    9 Downstream Cable Access Modules (DCAMs)

    Overview 9-1

    16D Cable Access Module (16D CAM) 9-2

    16D Physical Interface Cards (PICs) 9-9

    XD Cable Access Module (XD CAM) 9-10

    Operational Considerations for the XD CAM 9-11

    RF Power Monitoring and Recovery 9-21

    Physical Interface Cards (PICs) 9-21

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

    10 Upstream Cable Access Modules (UCAMs)

    Overview 10-1

    Guidelines 10-2

    12U Cable Access Module (12U CAM) 10-2

    Basic Command Set for Bringing Up a 12U CAM 10-6

    24U Cable Access Module (24U CAM) 10-9viii ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 Table of Contents

    Rules and Restrictions for 12U/24U CAM Configuration 10-1324U 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 10-22

    Adjusting Channel Settings in Response to Increased CM Scaling 10-29

    Explanation of Upstream Parameters 10-30

    Modulation Profiles: Default and User-defined 10-39

    Optimizing a Modulation Profile 10-42

    Noise and SNR versus Modulation Symbol Rate 10-42

    11 Basic Bring-up Procedure

    Before You Begin 11-1

    Bring-up Procedures 11-5

    Verification Steps 11-14

    IPv6 Configuration (Optional) 11-22

    Blank Worksheets 11-25

    12 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

    14 Cable and Network IP Configuration

    Overview 14-1

    Interface Configuration 14-4

    Common Interface Configuring Commands 14-4

    Monitoring Interfaces 14-5

    802.1Q VLAN Tagging (Q-tags) 14-8

    CLI Commands 14-10

    Loopback Interfaces for Routing Protocols 14-12Issue 2.0 ARRIS Group, Inc. All Rights Reserved ix

  • Table of Contents C4 CMTS Rel. 8.1.5

    Dynamic Route Redundancy 14-16Configuring IP Static Routes 14-17

    Route Redistribution and Administrative Costing 14-17

    CLI Commands 14-19

    Policy-Based Routing (PBR) 14-30

    Configuring PBR 14-31

    CLI Commands 14-35

    Multiple VRFs 14-42

    Overview 14-42

    Overview of the Sample Procedure 14-43

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

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

    IS-IS Network Topology Multi-homing 15-24

    Packet Flow between IS-IS Systems 15-25

    Designated Intermediate System (DIS) and Reliable Flooding of LSPs 15-25

    IS-IS Point-to-Point. 15-26

    Multiple Topology IS-IS (MT IS-IS) 15-30

    Overview 15-30

    Adjacencies 15-31

    Broadcast Interface Adjacencies 15-31

    Advertising MT Reachable Intermediate Systems in LSPs 15-31x ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 Table of Contents

    MT IP Forwarding 15-32Configuring MT IS-IS on the CMTS 15-32

    Sample Configuration 15-33

    Show commands 15-35

    CLI Commands 15-38

    CLI Commands for IS-IS and MT IS-IS 15-39

    Open Shortest Path First (OSPF) 15-45

    Configuring OSPF 15-46

    CLI Commands for OSPF 15-50

    Open Shortest Path First (OSPFv3) 15-53

    Advanced Features 15-59

    Configuring OSPFv3 for IPv6 15-61

    Summary of CLI Commands for OSPFv3 15-66

    Routing Information Protocol (RIPv2) 15-70

    RIP-related CLI Commands 15-70

    RIP Authentication 15-74

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

    Receive Channel Configurations and Bonding Groups 16-23Issue 2.0 ARRIS Group, Inc. All Rights Reserved xi

  • Table of Contents C4 CMTS Rel. 8.1.5

    17 IP Packet Filters, Subscriber ManagementOverview 17-1

    IP Packet Filters 17-2

    Effect of IP Packet Filtering / Subscriber Management on IP Address Limits 17-10

    Per-Interface Configuration 17-10

    Default Subscriber Management Settings 17-12

    IP Packet Filters Show Commands 17-13

    Debug IP Packet Capture 17-14

    IP Packet Filtering Configuration Example 17-17

    18 Baseline Privacy Interface (BPI)

    Baseline Privacy Overview 18-1

    Baseline Privacy Operational Overview 18-2

    Baseline Privacy Setup 18-4

    Initial CMTS Base Table Setup 18-4

    Baseline Privacy Cable Modem Configuration File Settings 18-9

    BPI Initialized State Configuration Settings 18-11

    Digital Certificates (BPI+ Only) 18-12

    Provisioning BPI X.509 Certificates Using Import/Export Commands 18-13

    Provisioning X.509 Certificates 18-15

    Baseline Privacy Debugging 18-18

    Baseline Privacy Trap Codes 18-22

    Baseline Privacy: CLI Commands 18-25

    Configure Cable Command 18-25

    Show Cable Command 18-26

    Configure Interface Cable Commands 18-26

    Show Interface Cable Command 18-27

    BPI Hybrid Mode Operation 18-28

    CLI Commands for BPI Hybrid Mode 18-29

    BPI+ Enforce 18-30

    CLI Commands 18-31xii ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 Table of Contents

    19 DOCSIS Set-top Gateway ConfigurationOverview 19-1

    DSG 3.0 19-5

    DSG Configuration Overview 19-8

    Configuring Interfaces to Carry Tunnel Traffic 19-9

    Enabling Upstream Filters 19-12

    DSG Configuration 19-12

    Configuring Access List, Filters and Rate Limits 19-13

    Configuring IP Forwarding for Basic Mode DSG 19-14

    Configuring for Advanced DSG Mode 19-15

    DS Cable Interface 19-17

    DSG Tunnels 19-19

    DSG Classifier 19-23

    Sample DSG Configuration Scenarios 19-25

    Initial Setup for DSG 19-25

    DSG Configuration Only 19-27

    Multicast Destination IP to RFC1112 DSG Tunnel MAC 19-28

    Multicast Destination IP to non-RFC1112 DSG Tunnel MAC 19-31

    20 CPE Device Classes

    Overview 20-1

    Related Terms 20-3

    DHCP Options 20-3

    DHCP Helper Address Provisioning 20-5

    Assigning Secondary Interfaces Based on Device Class 20-6

    Filter Groups Based on Device Class 20-7

    CLI Changes and Additions 20-9

    21 Integrated Upstream Agility

    Overview 21-1

    Examples of Upstream Agility State Machines 21-4

    Sample Configuration 21-15

    CLI Commands 21-16Issue 2.0 ARRIS Group, Inc. All Rights Reserved xiii

  • Table of Contents C4 CMTS Rel. 8.1.5

    Assigning/Unassigning State Machines to US Channels 21-22Show Commands 21-23

    CMTS State Machine Crosschecks 21-28

    22 Channel Bonding

    Downstream Channel Bonding (DSCB) 22-1

    Configuration Example Using Sample MAC Domain 1 22-3

    RCP/RCC 22-6

    Configuration Examples for Static RCC 22-9

    Configuring Channel Bonding Groups 22-11

    Per-packet Channel Selection for Bonding Groups 22-12

    Upstream Channel Bonding (USCB) 22-13

    Selective Enabling of USCB within a MAC Domain 22-13

    Non-Primary Channel Acquisition for Upstream Channel Bonding 22-16

    Partial Service Handling on the C4/C4c CMTS 22-17

    Upstream Impairment Detection and Recovery 22-17

    Downstream Impairment Detection and Recovery 22-17

    23 IPv6

    Overview 23-1

    IPv6 Packet Structure 23-2

    IPv6 Addressing Architecture 23-3

    C4 CMTS Security Features for IPv6 23-9

    CLI Commands 23-10

    Proxy Duplicate Address Detection 23-18

    DHCPv6 PDRI and Bulk Lease Query 23-18

    IPv6 Prefix Stability 23-25

    Using Prefix-Stability in CMTSs 23-25

    Operational Concerns 23-35

    IPv6 Distribute Lists 23-38

    24 Channel Assignment

    Introduction 24-1xiv ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 Table of Contents

    CM Channel Selection 24-2Channel Assignment Restrictions for DOCSIS 3.0 Modems 24-4

    Service Flow Channel Selection 24-4

    Attribute Masks 24-4

    25 IP Video

    Overview 25-1

    IP Video Functionality 25-3

    ASM Architecture 25-5

    SSM Architecture 25-6

    IP Video Provisioning 25-8

    Configure Multicast Routing 25-12

    Additional Configuration References 25-13

    IP Video Visibility 25-14

    IP Video Monitoring and Management 25-22

    CLI Commands 25-25

    26 Multicast

    Overview 26-1

    IP Multicast 26-1

    Multicast Traffic 26-2

    IGMP Implementation 26-3

    Protocol-Independent ModeSource-Specific Multicast 26-4

    Multicast Routing 26-4

    ASM/SSM Configurations 26-5

    IGMP Visibility 26-7

    Static IGMP Joins 26-11

    Forced Downstream Replication of Multicast Traffic 26-13

    Operational Guidelines 26-14

    Effects of Enabling MDF on the MAC Domain 26-15

    CLI Commands 26-16Issue 2.0 ARRIS Group, Inc. All Rights Reserved xv

  • Table of Contents C4 CMTS Rel. 8.1.5

    27 Connection Admission Control (CAC)Overview 27-1

    General CAC Description 27-2

    PacketCable CAC Description 27-2

    Multicast CAC Description 27-3

    Configuring CAC 27-5

    Show/Display Commands 27-7

    Data Consistency Checks 27-9

    28 Converged Services

    Overview 28-1

    Converged Services 28-1

    29 PacketCable Services

    PacketCable Overview 29-1

    PacketCable Multimedia Overview 29-5

    PCMM Classification for Remotely Connected Subnets 29-9

    Configuration Procedures 29-12

    PacketCable Settings 29-13

    PC1.x Electronic Surveillance 29-22

    Electronic Surveillance Configuration 29-24

    Electronic Surveillance Logging Messages 29-24

    PC 2.0 Lawfully Authorized Electronic Surveillance 29-25

    DSx DQoS VoIP 29-31

    Turbo Button 29-32

    30 Security

    AAA Overview 30-1

    RADIUS 30-6

    RADIUS Servers and Server Groups 30-6

    TACACS+ 30-9

    TACACS+ Servers and Server Groups 30-10xvi ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 Table of Contents

    SSH2 30-18Server Management 30-19

    CLI Commands for SSH 30-20

    Routing to a Null Interface 30-24

    Source Verification of Cable-side IP Addresses 30-25

    CPE Host Authorization 30-27

    CMTS Advanced CM Configuration File Verification 30-30

    Cable Modem MAC Deny List 30-34

    31 Legal Intercept

    Overview 31-1

    Chassis Configuration 31-4

    CLI Commands 31-4

    Data Management and Maintenance 31-6

    32 Load Balancing

    Load Balancing Group Definitions 32-2

    Load Balancing of Voice Bearer Flows 32-12

    CLI Commands for Load Balancing 32-13

    Minimal Configuration 32-14

    Additional Load-Balance Commands 32-17

    Interaction with Older Cable Modems 32-24

    Load Balancing of Bonded Cable Modems 32-25

    Distributing Bonded CMs across Downstreams at Registration Time 32-26

    Load Balancing Bonded CMs at Regular Intervals 32-26

    DCC across MAC Domains Using MIBs 32-28

    Downstream and Upstream Utilization Start Thresholds 32-30

    Load Balance Rule-based Modem Steering 32-32

    Service-type Modem Steering 32-35

    33 Packet Throttling

    SCM Packet Throttling 33-1Issue 2.0 ARRIS Group, Inc. All Rights Reserved xvii

  • Table of Contents C4 CMTS Rel. 8.1.5

    RCM Protocol Policing 33-2Upstream Cable Protocol Throttling 33-5

    ARP Neighbor Discovery (ND) Abuse Detection 33-9

    Network-side ACLs 33-10

    ARP/ND Abuse Counts 33-11

    Broadcast ARP and Multicast NS Reduction 33-14

    Token Bucket 3.0: Traffic Shaping on 16D/XD CAMs 33-16

    Upstream Power Boost Cap 33-18

    34 Access Control Lists

    Overview 34-1

    Named Access Lists 34-4

    Data Plane Filter IP ACLs 34-6

    SCM Access 34-8

    Using IGMP ACLs to Override Reserved Multicast Group IP Addresses 34-11

    35 Internet Protocol Detail Record

    Overview 35-1

    Abbreviations 35-2

    Exporter Services 35-2

    IPDR Session Methods 35-2

    IPDR Records 35-3

    Method and Record Usage 35-4

    IPDR Document 35-4

    Sequence of Records 35-4

    Exporter Address 35-5

    Collector Connectivity 35-5

    Redundancy 35-5

    Simultaneous Sessions 35-6

    IPDR Inter-Operations 35-7

    Data Acknowledgement 35-7

    Keep Alive 35-7xviii ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 Table of Contents

    Missed Interval 35-7Surveillance 35-8

    Connection Logs 35-8

    Session Logs 35-8

    SNMP Traps 35-8

    IPDR Configuration 35-9

    Parameters 35-9

    CLI Commands 35-10

    36 Host Names, User IDs, and Password Recovery

    How to Administer the Host Name and User IDs 36-1

    How to Add and Delete Users 36-2

    User Profiles 36-4

    Password Recovery 36-6

    37 Clock Synchronization Protocol

    Manually Setting the Internal Clock 37-1

    Configuring Time of Day (TOD) Clock Protocol 37-2

    Using Network Time Protocol (NTP) 37-2

    Secure NTP 37-6

    Show Clock Commands 37-7

    38 Service Class Names

    39 Per-Subscriber Throughput

    Overview 39-1

    40 Additional Classifier Support

    Overview 40-1

    41 Diagnostics

    Running Diagnostics 41-1

    CLI Output for Diagnostics 41-5Issue 2.0 ARRIS Group, Inc. All Rights Reserved xix

  • Table of Contents C4 CMTS Rel. 8.1.5

    42 Logging and the CMTSEvent Messages 42-1

    How Event Messages Are Routed 42-2

    Event Management Subsystems 42-3

    Event Message Throttling 42-5

    Show Logging Commands 42-6

    Configuring Event Throttling 42-9

    Configuring Event Routing 42-12

    Generating Events and Traps 42-15

    SNMP Trap Examples 42-16

    Routing Events to Local Volatile Logs 42-18

    Displaying Events on the System Console 42-19

    Routing Events to the Monitor 42-20

    Routing Events to the History Log 42-20

    Logging OSPF Event Messages 42-21

    43 Fully-Qualified Domain Name (FQDN)

    Overview 43-1

    Operational Concerns 43-2

    CLI Commands 43-4

    44 BSoD L2VPN

    Background Information 44-1

    Overview 44-2

    Additional Information 44-4

    Enabling BSoD 44-5

    CLI Commands 44-7

    Updates included in Release 8.1.5

    CLI Changes in Release 8.1.5

    Comments & Feedback Formxx ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • 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-24Figure 6-12: C4 CMTS Front Access Panels 6-27

    Figure 6-13: LED and Power Bus Switches 6-28List of Figures

    3 Standard and Cadant Enterprise MIBs

    Figure 3-1: Relationship of SNMP Tables to User-defined Elements 3-11

    5 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

    6 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-19Issue 2.0 ARRIS Group, Inc. All Rights Reserved xxi

  • List of Figures C4 CMTS Rel. 8.1.5

    Figure 6-14: C4 CMTS Power Feeds (chassis rear) 6-29Figure 6-15: Second Level Internal Branch Fusing 6-30

    Figure 6-16: Power Control Button 6-31

    7 System Control Module (SCM)

    Figure 7-1: System Control Module and Physical Interface Card 7-2

    Figure 7-2: SCM Faceplate Designations 7-6

    Figure 7-3: View of Pin-out of Serial Cable 7-9

    Figure 7-4: Connecting the Console Port to a PC 7-10

    Figure 7-5: Opening a Terminal Session on the CMTS 7-12

    Figure 7-6: Removing the DIMM 7-20

    Figure 7-7: Replacing the DIMM Module 7-21

    Figure 7-8: Labeling the SCM 7-21

    Figure 7-9: Pin-out of 4GB Flash Disk Connector 7-34

    Figure 7-10: Location of the Compact Flash Disk 7-35

    Figure 7-11: Removing the Compact Flash Disk 7-36

    Figure 7-12: Inserting the Compact Flash Disk 7-36

    Figure 7-13: Flash Disk Partition Structure 7-39

    8 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

    9 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 Spectrum Window for Annex B Using a 6 MHz Frequency Grid 9-7

    Figure 9-4: XD Cable Access Module (CAM) and Rear Physical Interface Cards (PICs) 9-14xxii ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 List of Figures

    Figure 9-5: XD CAM Downstream Test Port 9-17Figure 9-6: Example of Spectrum Window with Annex B 6 MHz Frequency Grid 9-19

    Figure 9-7: Upgraded CAMs with XD Decals 9-37

    10 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

    11 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

    13 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

    14 Cable and Network IP Configuration

    Figure 14-1: Subinterfaces (Multiple VRIs per VRF) 14-2

    Figure 14-2: Difference between Standard IP and Q-tag Encapsulation 14-8

    Figure 14-3: IEEE 802.1Q/p Tag Format 14-9

    Figure 14-4: Example of Packet Flow Using Loopback Interface 14-14

    Figure 14-5: Flowchart Representing Decision Path for PBR or Normal Routing 14-41

    15 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 OSPF Overlay 15-5Issue 2.0 ARRIS Group, Inc. All Rights Reserved xxiii

  • List of Figures C4 CMTS Rel. 8.1.5

    Figure 15-3: IS-IS Level 1 and Level 2 Routing 15-23Figure 15-4: Example of IS-IS and MT IS-IS Topologies 15-30

    19 DOCSIS Set-top Gateway Configuration

    Figure 19-1: Logical Devices in a DSG System 19-2

    Figure 19-2: Show Cable Modem Output Showing MDF Settings for DOCSIS 2.0 and 3.0 Modems 19-8

    Figure 19-3: Block Diagram of an Advanced DSG Configuration 19-16

    21 Integrated Upstream Agility

    Figure 21-1: State Diagram of a State Machine (Example) 21-6

    Figure 21-2: Example of a State Machine for a Dramatic Improvement Trigger 21-11

    Figure 21-3: State Diagram Using Degradation and Periodic Triggers (Example) 21-12

    Figure 21-4: State Diagram Using Simple Time-of-Day (TOD) Triggers (Example) 21-14

    22 Channel Bonding

    Figure 22-1: Sample MAC Domain 22-2

    Figure 22-2: Snapshot from Config File with Attribute Mask Set for USCB 22-15

    23 IPv6

    Figure 23-1: Block Diagram of PDRI Feature 23-19

    Figure 23-2: Scenario for Prefix Stability 23-26

    25 IP Video

    Figure 25-1: IP Video Architecture 25-2

    Figure 25-2: IP Video Subsystems 25-3

    Figure 25-3: ASM Architecture 25-5

    Figure 25-4: SSM Architecture 25-7

    28 Converged Services

    Figure 28-1: Example of Classification for Combined Voice, Video, and Data 28-4xxiv ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 List of Figures

    29 PacketCable ServicesFigure 29-1: PacketCable Network Reference Architecture 29-3

    Figure 29-2: Foundations of PCMM Architecture 29-6

    Figure 29-3: Network Diagram of PCMM Implementation 29-8

    Figure 29-4: PCMM Support for Using Remote Subnet IPs as Subscriber IDs on the C4 CMTS 29-10

    Figure 29-5: PC 2.0 LAES Functional Layout 29-26

    30 Security

    Figure 30-1: AAA Security Model 30-3

    31 Legal Intercept

    Figure 31-1: RFC 3924 Framework 31-2

    32 Load Balancing

    Figure 32-1: Adding Service-Type ID to the CM Config File 32-38

    40 Additional Classifier Support

    Figure 40-1: Example of a Network Diagram for Additional Classifier Telephony 40-3

    41 Diagnostics

    42 Logging and the CMTS

    Figure 42-1: Event Management Subsystems on the CMTS 42-4

    43 Fully-Qualified Domain Name (FQDN)

    44 BSoD L2VPN

    Figure 44-1: Example of Modem Configuration File Screenshot 44-6

    Figure 44-2: Sample BSOD Configuration Using BSOD Capable and Legacy (PPoE) Modems 44-10Issue 2.0 ARRIS Group, Inc. All Rights Reserved xxv

  • List of Figures C4 CMTS Rel. 8.1.5xxvi ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • Procedure 7-4 How to Open the Terminal Emulator Session 7-12

    Procedure 7-5 How to Replace an SCM in a Duplex Chassis 7-14

    Procedure 7-6 How to Replace an SCM in a C4c CMTS or a Simplex Chassis 7-17

    Procedure 7-7 Backing up the Existing Configuration of the SCM 7-18Procedure 7-8 Upgrading the SCM to 1 GB Duplex System 7-19

    Procedure 7-9 Upgrading the SCM to 1 GB Simplex System 7-22

    Procedure 7-10 Upgrade to an SCM 3 with the Compact Flash from an SCM II EM(U) 7-27List of Procedures

    3 Standard and Cadant Enterprise MIBs

    Procedure 3-1 Basic Configuration for an SNMP v1/2 Community 3-9

    6 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

    7 System Control Module (SCM)

    Procedure 7-1 How to Install an SCM 7-7

    Procedure 7-2 How to Install the SCM PIC 7-8

    Procedure 7-3 How to Cable the SCM 7-10Issue 2.0 ARRIS Group, Inc. All Rights Reserved xxix

  • List of Procedures C4 CMTS Rel. 8.1.5

    Procedure 7-11 Upgrade to an SCM 3 Using the Serial Console Port (RS 232) Only 7-28Procedure 7-12 Upgrade to an SCM 3 Using the OOBM Ethernet Interface (via rear port of the SCM PIC) 7-29

    Procedure 7-13 Upgrade to an SCM 3 Using the OOBM Ethernet Interface (via front port of the SCM 3 Module) 7-31

    Procedure 7-14 Replacing the Compact Flash Disk on a Duplex System 7-34

    Procedure 7-15 Replacing the Compact Flash Disk on a Simplex System 7-37

    8 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

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

    10 Upstream Cable Access Modules (UCAMs)

    Procedure 10-1 Before Changing the Receive Power Level Settings of the 24U CAM 10-15

    Procedure 10-2 How to Create and Apply a Modulation Profile to an US Port 10-22

    Procedure 10-3 How to Configure an Upstream (US) Channel 10-23

    Procedure 10-4 Putting Cards and Ports into Service 10-28

    Procedure 10-5 How to Take a CAM Out of Service and Delete Its Slot 10-28xxx ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 List of Procedures

    12 Control Complex RedundancyProcedure 12-1 Add a Control Complex (Change from Simplex to Duplex) 12-2

    13 CAM Sparing

    Procedure 13-1 Create the 12U and 16D CAM Spare-groups Shown in the Example in Figure 13-1. 13-6

    Procedure 13-2 How to Fail Back Manually 13-9

    Procedure 13-3 How to Delete a CAM Spare-group 13-10

    14 Cable and Network IP Configuration

    Procedure 14-1 How to Monitor Interfaces 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-43

    15 Dynamic Routing Protocols

    Procedure 15-1 Use the following procedure to enable/disable MT IS-IS on the CMTS 15-32

    Procedure 15-2 Change the Default Metric 15-33

    Procedure 15-3 How to Enable OSPF 15-46

    Procedure 15-4 How to Disable OSPF for an Interface 15-48

    Procedure 15-5 How to Disable OSPF on the CMTS 15-49

    Procedure 15-6 Configuring OSPFv3 with Cable-side Interfaces as Passive Interfaces 15-62

    Procedure 15-7 Configuring OSPFv3 with Route Redistribution 15-64

    Procedure 15-8 How to Disable OSPv3 Globally on the CMTS 15-66

    Procedure 15-9 How to Enable Single Key Authentication 15-76

    Procedure 15-10How to Enable Multiple Key Authentication (i.e., Key Chains) 15-77

    19 DOCSIS Set-top Gateway Configuration

    Procedure 19-1 Enabling Multicast DSID-based Forwarding (MDF) and DSG Support for DOCSIS 3.0 19-5Issue 2.0 ARRIS Group, Inc. All Rights Reserved xxxi

  • List of Procedures C4 CMTS Rel. 8.1.5

    21 Integrated Upstream AgilityProcedure 21-1 Configuring a Sample Upstream Agility Application 21-15

    Procedure 21-2 Modifying a State Machine (an example) 21-27

    23 IPv6

    Procedure 23-1 Configuring Prefix Stability Using IS-IS 23-27

    Procedure 23-2 Configuring Prefix Stability Using OSPF 23-30

    Procedure 23-3 Sample Distribute List for OSPFv3 PD Routes 23-38

    26 Multicast

    Procedure 26-1 Configure Network to Cable ASM Data Forwarding 26-6

    Procedure 26-2 Configure Network to Cable SSM Data Forwarding 26-6

    Procedure 26-3 Use an ACL to Allow Restricted IGMP Range 26-10

    Procedure 26-4 Use an ACL to Deny a Specific Multicast Group 26-10

    Procedure 26-5 Provision Forced Downstream Replication of Multicast Traffic 26-13

    Procedure 26-6 Disable Forced Downstream Replication of Multicast Traffic 26-14

    29 PacketCable Services

    Procedure 29-1 To Configure SNMPv3 User View for PC 2.0 LAES 29-29

    30 Security

    Procedure 30-1 Configure TACACS Server to Enable Password 30-14

    Procedure 30-2 Configure the CMTS to Enable Password 30-14

    Procedure 30-3 Sample Procedure for Configuring TACACS Accounting 30-17

    31 Legal Intercept

    Procedure 31-1 Sample Configuration for Secure Access and Tap 31-4

    Procedure 31-2 To create or delete an LI tap on an IPv6 modem 31-6xxxii ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4 CMTS Rel. 8.1.5 List of Procedures

    32 Load BalancingProcedure 32-1 Example of Service-type Modem Steering Configuration 32-37

    36 Host Names, User IDs, and Password Recovery

    Procedure 36-1 How to Configure a Host Name and Syslog Server IP Address 36-1

    Procedure 36-2 How to Configure Privilege Levels and Authentication 36-3

    Procedure 36-3 Creating a Global User Profile 36-4

    Procedure 36-4 Creating a User Profile 36-5

    Procedure 36-5 How to Enable Password Recovery Using Application Dialog 36-6

    37 Clock Synchronization Protocol

    Procedure 37-1 Configuring Time of Day (TOD) Clock Protocol 37-2

    Procedure 37-2 Configure NTP for CMTS 37-2

    42 Logging and the CMTS

    Procedure 42-1 How to Route Events to the Console 42-19

    Procedure 42-2 How to Route Events to the Monitor 42-20

    Procedure 42-3 How to Configure the History Log 42-21Issue 2.0 ARRIS Group, Inc. All Rights Reserved xxxiii

  • List of Procedures C4 CMTS Rel. 8.1.5xxxiv ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 1 About This Manual1 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, full-motion 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 Group, Inc. All Rights Reserved 1-1

  • 1 About This Manual C4/C4c CMTS Rel. 8.1.5

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

    NOTENotes 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 Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 1 About This ManualCAUTIONCautions indicate risk of dropping traffic, losing data, or disrupting the equipment. Read the accompanying instructions and proceed with caution.

    WARNINGThe 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

    System responses and screen displayMonospaced font

    (courier)

    Time since the CMTS was last booted: 12 days, 2: 8: 14

    Issue 2.0 ARRIS Group, Inc. All Rights Reserved 1-3

  • 1 About This Manual C4/C4c CMTS Rel. 8.1.5How 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.

    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

    Table 1-2: C4/C4c Technical Support Contacts

    Phone E-mail

    NORTH AMERICA

    +1 888 221 9797 (N. America only)[email protected]

    +1 678 473 5656 (Worldwide)

    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]

    JAPAN

    +81 3 5461-7320 [email protected]

    KOREA

    +82 31 783 4893 [email protected]

    ASIA

    Asia +86 755 8634 9110

    China +86 755 8634 9110 or 40088 10685

    [email protected] ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 1 About This Manual

    is available.To obtain pricing for on-site training and other training infor-

    mation, visit our web site:

    http://www.arrisi.com/support/training/index.asp

    Comments on this Document 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. Issue 2.0 ARRIS Group, Inc. All Rights Reserved 1-5

  • 1 About This Manual C4/C4c CMTS Rel. 8.1.51-6 ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview2 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 opera-tors to enter the commands needed to add, manage, display, and remove hardware modules, networks, users, and other system entities. Issue 2.0 ARRIS Group, Inc. All Rights Reserved 2-1

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5Access 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 greater-than 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 privi-lege levels, and logging out as shown in the following list:

    disable exit [all] enable no logout enable [] quit [all] end

    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 Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

    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)

    configureC4(config)#

    Access-list configuration

    (From global configuration mode)

    access-list | C4(config-ACL num)#

    Cable modulation-profile

    (From global configuration mode)

    cable modulation-profile C4(config-mod-

    profile)

    Cable interface configuration

    (From global configuration mode)

    interface cable /C4(cfg-i-cable)#

    Cable downstream interface configuration

    (From global configuration mode)

    interface cable-downstream /

    C4(cfg-i-ds)

    Cable fiber-node configuration

    (From global configuration mode)

    fiber-node C4(config-fiber-

    node)#

    Cable cable intercept configuration

    (From global configuration mode)

    cable interceptC4(config-cable-

    intercept)

    Cable MAC interface configuration

    (From global configuration mode)

    interface cable-mac C4(cfg-i-mac)

    Cable MAC interface cable downstream-bonding-group

    (From global configuration mode)

    interface cable-mac cable downstream-bonding-group

    C4(cfg-i-mac-dsbond)#

    Cable upstream interface configuration

    (From global configuration mode)

    interface cable-upstream /

    C4(cfg-i-us)

    Ethernet interface configuration

    (From global configuration mode)

    interface ethernet /C4(config-ether)

    Gigabit Ethernet interface configuration

    (From global configuration mode)

    interface gigabitEthernet C4(cfg-i-gigE)

    Key chain configuration

    (From global configuration mode)

    key chain C4(config-keychain)#Issue 2.0 ARRIS Group, Inc. All Rights Reserved 2-3

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    Table 2-1: How to Enter the Various Command ModesNOTEIf 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 - Exits all mdoes and goes to the top command level.

    Key chain key configuration

    (From global configuration mode)

    key chain key C4(config-

    keychain-key)#

    Loopback interface configuration

    (From global configuration mode)

    interface loopback C4(config-loop)#

    Null interface configuration

    (From global configuration mode)

    interface null C4(config-null)#

    Router OSPF configuration

    (From global configuration mode)

    router ospfC4(config-router-

    ospf)#

    Router RIP configuration

    (From global configuration mode)

    router ripC4(config-router-

    rip)#

    Router Static configuration

    (From global configuration mode)

    router staticC4(config-router-

    static)#

    System controller interface configuration

    (From global configuration mode)

    interface system-controller C4(config-system)#

    TenGigabit Ethernet interface configuration

    (From global configuration mode)

    interface tengigabitEthernet C4(cfg-i-10gigE)

    Mode To enter this mode, type Resultant Prompt2-4 ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI OverviewCLI Syntax Conventions

    ARRIS documentation uses certain conventions to show the syntax of commands. These notations are not part of the command itself but indi-cate 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 entriesthey 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]

    Values are required for both the slot and port. They must be separated by a slash.

    Parameters preceded by an asterisk indicate a wildcard.Issue 2.0 ARRIS Group, Inc. All Rights Reserved 2-5

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    Table 2-2: Conventions for Representing Command SyntaxDesignating 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 insensi-tive, leading zeros are optional, a pair of colons indicate successive 0s 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 line-editing keys that are available in the CLI.

    IP addresses and host names

    Wherever an IP address is required, you can enter a host name provided you have configured a DNS server or put the name and address into the DNS Local Host Table.

    Script files You can create a script filea text file containing CLI commandsto simplify repetitive tasks.

    CLI Syntax Description2-6 ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

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

    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)

    Moves the cursor forward one character.

    (Left arrow)

    Moves the cursor back one characte.r

    (Up arrow)

    Scrolls backward through all commands in the history buffer starting with the most recent. Repeat keystroke to recall successively older commands.

    (Down arrow)

    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.Issue 2.0 ARRIS Group, Inc. All Rights Reserved 2-7

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    Table 2-3: CLI Editing Shortcuts (Continued)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:

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

    Keystroke(s) Result

    Table 2-4: Command Help

    Command 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.2-8 ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

    Table 2-4: Command HelpEntering 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 argu-ment. 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

    C4# abbreviated-command-entry?

    Lists commands in the current mode that begin with a particular character string.

    C4# abbreviated-command-entry Completes a partial command name.

    C4# abbreviated-command-entry 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.

    Command Result Issue 2.0 ARRIS Group, Inc. All Rights Reserved 2-9

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    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 interface2-10 ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

    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 charac-ters 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 Group, Inc. All Rights Reserved 2-11

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    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 Priv-ileged 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 priv-ilege 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 priv-ilege 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 privi-lege 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 config-uration 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 Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

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

    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 detailIssue 2.0 ARRIS Group, Inc. All Rights Reserved 2-13

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    Displaying Current Privilege To display the current privilege level you can access based on the pass-

    Levels word 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:

    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 priv-ilege) 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

    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.

    Table 2-5: Default Logging Level

    CLI Access Level Notification Priority

    1 - 4 7 (Informational)

    5 - 15 6 (notice)2-14 ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

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

    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 bootIncorrect 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 asso-ciated with that slot/port, regardless of the parser and regardless of whether or not the parameters were matched. A slot/port with one param-eter 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 Group, Inc. All Rights Reserved 2-15

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    To turn pagination on, you must be in Privileged EXEC mode and type the

    following command:

    C4# configure pagination

    NOTEPagination 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 Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI OverviewCLI 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.

    NOTEThe filtering function is not available for the command show tech-support.

    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.

    NOTENormally, 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 Group, Inc. All Rights Reserved 2-17

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    How to Use CLI FilteringThe 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 Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

    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:

    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 expres-sion m5\. is used in the command syntax, only the string m5. will be matched.

    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.Issue 2.0 ARRIS Group, Inc. All Rights Reserved 2-19

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    Range 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 char-acter. A backslash \ followed by a single character, includes that char-acter, 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, [a-f] is the same as [abcdef]. The following matches a hexidecimal digit: [0-9a-f].

    NOTEWhen 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 charac-ters. 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 char-acter:

    ARRIS.2-20 ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

    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 soft-ware to match multiple occurrences of a specified expression. Table 2-7 lists special characters that specify multiples of an 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 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.

    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 expressionIssue 2.0 ARRIS Group, Inc. All Rights Reserved 2-21

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5

    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.

    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:

    Table 2-8: Special Anchoring Character

    Character Description

    ^ The caret matches the beginning of the string2-22 ARRIS Group, Inc. All Rights Reserved May 29, 2013

  • C4/C4c CMTS Rel. 8.1.5 2 CLI Overview

    ^1234The 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 spec-ifies 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 remem-bered 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 iden-tified 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 Group, Inc. All Rights Reserved 2-23

  • 2 CLI Overview C4/C4c CMTS Rel. 8.1.5Show Cable Modem Column Feature

    With each release, the show cable modem command must support addi-tional 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 dont. 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 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.

    bonded - Number of bonded DS and US bonded-actual - Number actual bonded DS and U