TS Provisioning R61S13

Touchstone® Telephony

Provisioning Guide Releas Release e 6.1 6.1 Standa Standard rd 1.3 1.3 Date: June 2009

Chapter 1: Installing and Upgrading Touchstone Touchstone Firmware This chapter provides procedures used to install and upgrade TouchTouchstone firmware on local DHCP and TFTP servers.

Chapter 2: Provisioning Modes You can provision Touchstone Touchstone Telephony Telephony products using a variety of PacketCable-compliant PacketCable-compliant and non-compliant tools.

Chapter 3: Provisioning You can provision provision Touchstone Touchstone Telephony Telephony products using using the inforinformation and procedures outlined in this chapter.

Chapter 4: Advanced WTM552 Provisioning Touchstone firmware provides several advanced WTM552-specific features.

Chapter 5: SIP Support and Implementation SIP (Session Initiation Protocol) is a signaling protocol used in IP telephon telephony y and other other applicatio applications. ns. This chapter chapter describe describess SIP support in Touchstone firmware.

Chapter 6: MIB Reference This chapter lists the MIBs referenced by the TS6.1 firmware.

Appendix A: Example Files This appendix provides provides a list of example example data and telephony telephony provisioning file templates included with TS6.1.

Appendix B: Configuring the Service Provider Root PacketCable requires a Service Provider certificate hierarchy, which allows other network elements to authenticate the service provider’s provider’s servers.

Appendix C: Line Li ne Parameters by Countr y These tables show the default tones and ring definitions definitions for each supported country template.

ii © 2004–2009 ARRIS All rights reserved Printed in the USA The infor information mation in this document document is subject to change change without notice. notice. The statements statements,, configuratio configurations, ns, technical technical data, data, and recommendati recommendations ons in this document document are believed believed to be accurate accurate and reliable, reliable, but are presented presented without without express express or implied implied warranty warranty.. Users must take take full responsibi responsibility lity for for their applications applications of any products products specified specified in this document. document. The information in this document document is proprietar proprietary to ARRIS. ARRIS, ARRIS, C3™, C4®, C4®, and Touchst Touchstone® one® are trademar trademarks or registered registered trademar trademarks of ARRIS Group, Group, Inc. Cadan Cadant® t® is a registered registered trademar trademark of ARRIS Group, Group, Inc. All other trademar trademarks and registered registered trademar trademarks are the property property of their respective respective holders. holders.

Touchstone® ouchstone® Telepho Telephony ny Release 6.1 S Standa tandard rd 1.3 1.3 June 2009

Publication history June 2009

Release 6.1 Standard 1.3 version of this document for TS6.1 MSUP3.

January 2009

Release 6.1 Standard 1.0 version of this document for TS6.1.

October 2007


May 2007


December 2006

Release 5.0 Standard 2.0 version of this document for TS5.0 MSUP. MSUP.

October 2006

Release 5.0 Standard 1.0 version of this document.

August 2006


December 2005

Release 4.5 Standard 2.0 version of this document for TS4.5 MSUP 2.

November 2005


April 2005


March 2005


Provis Provision ioning ing Guide Guide Releas Release e 6.1 Stan Standar dard d 1.3 June June 2009 2009

iv

Publication history

February 2005


August 2004

Release 4.2 Standard 1.0 version of this document. Release 4.1 Standard 2.0 version of this document.

April 2004


September 2003



Contents Audience ....................... ................................... ........................ ....................... ....................... ........................ .................... ........ xv In this Document ....................... ................................... ....................... ....................... ........................ .................... ........ xv Terminology ....................... ................................... ........................ ....................... ....................... ........................ ............... ... xvi

Installing and Upgrading Touchstone Touchstone Firmware

1

Load Name Extensions ....................... ................................... ....................... ....................... ....................... ........... 1 Examples ...................... .................................. ........................ ........................ ....................... ....................... ............... ... 2 About ARRIS Enhanced Firmware Fir mware Loading ....................... ................................... ............... ... 2 Upgrade Process ...................... .................................. ........................ ....................... ....................... ............... ... 3 Enhanced Firmware Loading Options ....................... ................................... ................. ..... 5 ArrisCmDevSwAdminStatus Feature Switch ....................... .............................. ....... 5 ArrisCmDevSwTable isCmDevSwTable MIB ........................ ................................... ....................... ........................ .............. 6 Example Lineup ...................... .................................. ........................ ....................... ....................... ................. ..... 7 Example Configuration File Excerpt ...................... .................................. ..................... ......... 7 Upgrading from NCS to SIP Loads ...................... .................................. ....................... ........... 8 Minimizing Firmware Download Service Servi ce Impacts ....................... .............................. ....... 9 Considerations ...................... .................................. ........................ ....................... ....................... ....................... ........... 10 Loop Voltage Management Reset Timer ....................... .................................. ........... 10 Dual Mode Telephony Modem Considerations Considerations ......................... ......................... 10 Procedure: Procedure: Installing the Firmware ................................. ............................................. ............... ... 12 Requirements ...................... .................................. ........................ ....................... ....................... ................... ....... 12 Adding the CVC ...................... .................................. ........................ ....................... ....................... ............... ... 12 Installing the Firmware on a File Server ...................... .................................. .............. 13 Configur Configuring the eMTA eMTA to Download Download its Firmware Firmware ......... ............. ........ ........ ...... 13 Setting Up ARRIS Enhanced Firmware Loading ...................... ...................... 13 Procedure: Procedure: Upgrading Touchstone Touchstone Firmware ................ ............................ ................. ..... 15 Upgrading from TS4.2 or Earlier Versions ....................... ................................ ......... 15 Upgrading from Earlier NCS Loads to SIP Loads ..................... ..................... 15 Upgrading from Earlier NCS Loads to TS6.1 NCS Loads ........ 15 Considerations for D11PLUS Loads ...................... .................................. ................... ....... 16 Upgrading from Earlier SIP Loads to TS6.1 SIP Loads ............ ............ 16 Upgrading to .EURO Loads ............................... ........................................... ....................... ........... 16 Line Parameter Provisioning Changes ....................... ................................... ............... ... 16 Upgrading the Firmware through Provisioning ............... .......................... ........... 16 Upgrading the Firmware through SNMP ...................... .................................. .............. 17 Changing Configuration Files for Upgrades from TS4.2 ........... 18


vi

Contents

Provisioning Modes

19

Overview ........................ ................................... ....................... ........................ ....................... ....................... ................... ....... 19 Provisioning Modes ....................... ................................... ........................ ....................... ....................... ............... ... 19 PacketCable PacketCable Provisioning Modes ....................... ................................... ....................... ........... 19 ARRIS-proprietary Provisioning Modes ....................... ................................... .............. 20 SIP-only Provisioning Modes ........................ ................................... ....................... ................. ..... 22 Selecting a Provisioning Mode ........................ ................................... ....................... ..................... ......... 23 Overview ....................... ................................... ........................ ........................ ....................... ....................... .............. 23 Provisioning Selection Flowchart ....................... ................................... ....................... ........... 24 Results ....................... .................................. ....................... ........................ ....................... ....................... ................. ..... 24 Provisioning Event Sequences ........................ ................................... ....................... ..................... ......... 25 PacketCable PacketCable Sequence ....................... ................................... ....................... ....................... ............... ... 25 PacketCable PacketCable (no KDC)/HYBRID Sequence ....................... .............................. ....... 27 GUPI (including variants)/Basic.1 Sequence ............................ ............................ 28 Basic.2 Sequence ....................... ................................... ........................ ....................... ...................... ........... 29 Single MAC/Config File Sequence ....................... ................................... ..................... ......... 30 Setting Up the Provisioning Provisioning Server Data ................................. ................................... 30 Verifying MTA MTA Provisioning and Endpoint Status Status ...................... ...................... 30 DHCP Support by Provisionin Provisioning g Mode ........ ............ ........ ........ ........ ........ ........ ........ ........ ........ ...... 31 Options Required in All Provisioning Modes ...................... ............................. ....... 31 PacketCable PacketCable Modes ...................... .................................. ....................... ....................... ..................... ......... 31 GUPI Mode ....................... ................................... ........................ ....................... ....................... ..................... ......... 32 ARRIS Modified Version of Simplified PacketCable Provisioning (Basic.1 and Basic.2) ........................ .................................... ....................... ...................... ........... 32 Single MAC/Config File Mode ....................... .................................. ....................... ................. ..... 33 DOCSIS Only Mode ...................... .................................. ....................... ....................... ..................... ......... 33 DHCP Option 43 Suppor t ....................... ................................... ....................... ...................... ........... 33 DHCP Option 60 Suppor t ....................... ................................... ....................... ...................... ........... 34 DHCP Option 51 Suppor t ....................... ................................... ....................... ...................... ........... 34 Provisioning Considerations for for European Loads ...................... ........................... ..... 35 Flow MTA15: MTA15: SNMP Enrollment INFORM ....................... ................................ ......... 35 Flow MTA19: MTA19: SNMPv3 SET ........................ ................................... ....................... ................... ....... 35 Flow MTA23: MTA23: TFTP Configuration File Request ....................... ......................... 35 Flow MTA25: MTA25: SNMP INFORM ....................... .................................. ....................... ................. ..... 35 Provisioning Considerations for SIP Loads ...................... .................................. ............... ... 36 SIP Registration Behavior ............................... .......................................... ....................... ............... ... 36 SIP Feature Switch ....................... ................................... ....................... ....................... ..................... ......... 36 Information Required for SIP ........................ ................................... ....................... ................. ..... 36

Provisioning

39

Overview ........................ ................................... ....................... ........................ ....................... ....................... ................... ....... 39 Provisioning Management Features ........................ ................................... ....................... .............. 39 Backoff and Retry Mechanism Support ....................... ................................... .............. 39 About IPsec ....................... ................................... ........................ ....................... ....................... ..................... ......... 39 Service Interr Interruptions uptions during Firmware mware Upgrades Upgrades ........ ............ ........ ........ ...... 40 Call Management Servers ........................ ................................... ....................... ..................... ......... 40 Configuration File Recovery .................. .............................. ....................... ....................... .............. 41 Provisioning CM and MTA MTA Features ........................ ................................... ....................... .............. 41 Full DQoS Mode ....................... ................................... ........................ ....................... ....................... .............. 41


Contents

vii

DSX QoS Mode ........................................................................ 41 Multi-Line Considerations .........................................................42 Voice and Signaling Ports ......................................................... 42 Interface Index Scheme ............................................................ 42 Interface Types ................................................................... 43 CODECs and Packetization Rates Supported ..........................43 G.729 CODEC Support ...................................................... 44 G.729 CODEC Negotiation ................................................ 44 G.729 Fax and Modem Suppor t ......................................... 46 G.729 Bandwidth Considerations ....................................... 46 CODECs and Supported Lines (Model 6 and later) .................. 46 TM602 Engineering Rules .................................................. 47 TM604 and TM608 Lines 1–4 ............................................ 47 TM608 Lines 5–8 ................................................................ 47 CODECs and Supported Lines (Model 5 and earlier) ............... 48 Dial Pulse Support .................................................................... 48 European Productization Support ............................................. 49 VMWI Behavior in North American Loads .......................... 49 Provisioning RIP ....................................................................... 49 Default Settings .................................................................. 50 Requirements .....................................................................50 Dual Mode Telephony Modem Considerations ................................ 51 Configuration Files and Signed Loads ...................................... 51 Certificates ................................................................................ 51 Ranging ..................................................................................... 51 DMDM Status ............................................................................ 52 Feature Switches ............................................................................. 52 CallP Feature Switch ................................................................ 52 Example ............................................................................. 59 Feature Switches Affecting the SDP .................................. 60 Switch Settings Removed in TS4.3 .................................... 66 Switch Settings Removed in TS4.4 .................................... 67 Switch Settings Removed in TS4.5 .................................... 67 MTA Feature Switch .................................................................. 68 CM Feature Switch ................................................................... 69 Secondary CM Feature Switch ................................................. 70 SIP Feature Switch ................................................................... 71 Country Code Templates ................................................................. 74 Configuration File Provisioning Notes ............................................. 74 Support for TLV-41 (Downstream Channel Lists) ...................... 74 Embedding ARRIS-Proprietary MIBs within TLV-43 ................. 74 Changes and Considerations for TLV-39 Suppor t ..................... 75 Cable Cut Recovery on DOCSIS 1.1 Upstreams ............... 76 DTM602 Considerations ........................................................... 78 DTM602 ifAdminStatus Settings ........................................ 78 Filter Configuration ............................................................. 78 Monitoring MTA Provisioning Status ................................................ 78 Firmware Upgrade Status ......................................................... 80 Procedure: Configuring Alarm and Log Reporting ......................... 81 Overview ................................................................................... 81

Provisioning Guide Release 6.1 Standard 1.3 June 2009

viii

Contents

Standard Mode ....................... ................................... ........................ ....................... ....................... ............... ... 81 TS4.1 and Older Compatible Provisioning Method ................... ................... 82 About the Event Tables Tables ....................... ................................... ....................... ....................... ............... ... 82 Procedure: Procedure: Updating the KDC ........................ ................................... ....................... ..................... ......... 85 Configuring the KDC to use the CableLabs Test Test Root .............. .............. 85 Using the Test Root Download Feature ....................... ................................... .............. 86 Procedure: Procedure: Controlling Controlling General eMTA eMTA Functionalit Functionality y ........ ............ ........ ........ ...... .. 88 Controlling Access to Troubleshooting Troubleshooting Pages ........................... ........................... 88 Hiding FQDN and IP Information mation in the Event Event Log ........ ............ ........ ....... ... 88 Controlling Data Shutdown Functionality ....................... .................................. ........... 90 Reading Firmware Load Information ...................... .................................. ................... ....... 90 Changing the ifInOctets Counter Operation ................... .............................. ........... 90 Setting the Telephony Port CA CATV TV Relay ....................... ................................... .............. 91 Setting the Loop Voltage Management Policy Policy ....................... .......................... ... 91 Setting the Telnet/SSH Timeout ........................ ................................... ....................... .............. 92 Configuring Battery Over-Temperature Over-Temperature Protection .................... .................... 92 Controlling the Dynamic Equalizer ................................. ............................................ ........... 93 Configuring TFTP Block Size ........................ ................................... ....................... ................. ..... 94 Procedure: Procedure: Controlling Cable Cable Modem Functionality ...................... ........................ 95 Setting Allowed CPE Counts ........................ ................................... ....................... ................. ..... 95 Toggling the DOCSIS Mode ........................ ................................... ....................... ................... ....... 95 Controlling the WAN Isolation State ....................... ................................... ................... ....... 96 Setting IPv6 Forwarding .......................... ...................................... ....................... ...................... ........... 97 Setting DOCSIS 1.0 Fragmentation Fragmentation Support ....................... ............................ ..... 97 Procedure: Procedure: Controlling MTA MTA Functionality ....................... ................................... ............... ... 98 About Monitoring Functionality ....................... .................................. ....................... ............... ... 98 Configuring Loop Current ....................... ................................... ....................... ...................... ........... 98 Configuring Gain Control ........................ .................................... ....................... ...................... ........... 99 Adjusting Delta Del ta Rx/Tx Gain ....................... .................................. ....................... ................... ....... 101 Configuring Dial Pulse P ulse Suppor t ....................... .................................. ....................... .............. 101 Configuring the Echo Cancellation Tail Length ...................... ........................ 102 Configuring the Ringing Wavefor Waveform ...................... .................................. ................... ....... 102 Configuring the Dynamic RTP Port Range ...................... ............................. ....... 103 Configur Configuring Non-Phase Non-Phase Reversed Reversed Modem Tone Tone Handling Handling ..... ..... 103 Setting the Upstream U pstream Buffer Depth ...................... .................................. ................... ....... 103 Controlling Active QoS Timeout ........................ ................................... ...................... ........... 104 Configuring Line Indexes ........................ .................................... ....................... .................... ......... 104 Controlling Caller Cal ler ID Behavior ................... .............................. ....................... ................... ....... 105 Configuring TDD Notification Override ....................... ................................... .............. 105 Enabling and Disabling Local VQM ....................... ................................... ................. ..... 106 Enabling and Disabling Remote VQM ....................... ................................... .............. 106 Controlling ToS ToS Byte Marking ....................... .................................. ....................... ............... ... 107 Controlling T.38 and Fax-Only Modes ...................... .................................. ............... ... 107 Configur Configuring T.38 MaxDatagr MaxDatagram am Size ........ ............ ........ ........ ........ ........ ........ ........ ...... .. 107 Configuring RFC 2833 End of Event Duration ........................ ........................ 108 Configuring Automatic Call Resource Recovery ..................... ..................... 108 Setting Persistent Line Status ....................... .................................. ....................... ............... ... 108 Procedure: Procedure: Configur Configuring ToD Server Interaction Interaction ........ ............ ........ ........ ........ ....... ... 110 Configuring ToD Re-Synchronization .............. ......................... ....................... .............. 110 Configuring Provisioning ToD Timeout ....................... ................................... .............. 110


Contents

ix

Configuring ToD Offset ....................... ................................... ....................... ....................... .............. 111 Configuring Daylight Savings Time Policy Policy ....................... .............................. ....... 111 Procedure: Procedure: Configuring Jitter Buffers Buffers ........................ .................................... ................... ....... 113 Setting Standard Jitter Buffer Parameters Parameters ....................... .............................. ....... 113 Setting Voice Band Data Jitter Buffer Parameters Parameters .................. .................. 113 Configuring Custom Jitter Buffer Settings ...................... ............................... ......... 114 Procedure: Procedure: Provisioning SIP Support ....................... .................................. .................... ......... 115 Per-Line Proxy/Registrar Objects ........................ ................................... .................... ......... 115 T.38 Provisioning Overview ....................... .................................. ....................... ................... ....... 115 Global Call Feature Control ........................ ................................... ....................... ................. ..... 116 Per-line Call Feature Control ....................... .................................. ....................... ................. ..... 117 E.164 Address Considerations ....................... .................................. ....................... .............. 118 CM Configuration File Changes ........................ ................................... ...................... ........... 118 MTA MTA Configuration File Changes ........................ ................................... .................... ......... 119 Setting up Timers ...................... .................................. ........................ ....................... ...................... ........... 121 Configuring Per-Line Proxy Proxy and Registrar ....................... .............................. ....... 122 Post-Provisioning Post-Provisioning SIP Lines ........................ ................................... ....................... ................. ..... 123 Specifying a SIP Domain Name ........................ ................................... ...................... ........... 124 Procedure: Procedure: Provisioning SIP SIP Features Features ........................ .................................... ................. ..... 125 Requirements ...................... .................................. ........................ ....................... ....................... ................. ..... 125 Call Feature Control ...................... .................................. ....................... ....................... ................... ....... 125 Proxy Dialing Features ............................ ........................................ ....................... .................... ......... 125 Supported Dialing Features ................................ ........................................... .................... ......... 126 Setting up Dialing Features ................. ............................. ....................... ....................... .............. 127 Configuring Warmline or Hotline ....................... .................................. ...................... ........... 128 Configuring Repeat Dialing Di aling ....................... .................................. ....................... ................... ....... 129 Configuring T.38 and Fax-Only Modes ...................... .................................. .............. 130 Configur Configuring Distinctiv Distinctive e Ring/Aler Ring/Alert Tones ........ ............ ........ ........ ........ ........ ........ ...... 130 Specifying an Emergency Number ...................... .................................. ................... ....... 131 Specifying a BYE Delay D elay ...................... .................................. ....................... ....................... .............. 131 Procedure: Procedure: SIP Loopback Testing ........................ ................................... ....................... .............. 133 Loopback Suppor t ....................... ................................... ........................ ....................... .................... ......... 133 Procedure: Procedure: Provisioning DHCP Options ...................... .................................. ................. ..... 134 About DHCP Reinit ....................... ................................... ....................... ....................... ................... ....... 134 DHCP Configuration-related MIB Objects ...................... ............................... ......... 134 Filtering DHCP Broadcast Packets ...................... .................................. ................... ....... 134 Procedure: Procedure: Configur Configuring Non-Ser Non-Service Affecting Affecting IP Address Renewal ....................... .................................. ....................... ........................ ....................... ....................... ................. ..... 136 Backoff/Retry Timing ....................... ................................... ....................... ....................... ................. ..... 136 arrisCmDevDhcpNoSvcImpact Settings ...................... ................................. ........... 137 Log Messages ....................... ................................... ........................ ....................... ....................... ............... ... 137 Recommendations ...................... .................................. ........................ ....................... .................... ......... 137 DHCP Interaction ....................... ................................... ....................... ....................... ............... ... 138 ‘‘dontSend’’ ‘‘dontSend’’ Considerations ................... ............................... ........................ ............... ... 138 ‘‘sendIgnore’’ ‘‘sendIgnore’’ Considerations ................... ............................... ........................ .............. 139 Additional Considerations .............................. .......................................... ................... ....... 140 Procedure: Procedure: Provisioning European European Support ...................... ................................. ........... 141 Configuring Power Ring Frequency ....................... ................................... ................. ..... 141 Configuring On-Hook Caller ID ....................... .................................. ....................... .............. 141 Configur Configuring Visual Message Message Waiting Waiting Indicator Indicator ........ ............ ........ ........ ....... ... 142


x

Contents

Configuring Tone Operations ........................ ................................... ....................... ............... ... 143 Configuring Hook Flash Timing ........................ ................................... ...................... ........... 143 Procedure: Procedure: Configuring Call Progress Tones .......................... ............................... ..... 144 MIB Tables ...................... .................................. ........................ ....................... ....................... ..................... ......... 144 Procedure: Procedure: Configur Configuring Hook Flash Timing ........ ............ ........ ........ ........ ........ ........ ...... 147 Default Timing Ti ming Settings ....................... ................................... ....................... ....................... .............. 147 Procedure: Procedure: Provisioning Preset Preset Downstream Downstream Frequencies ..........148 .......... 148 Preset Frequency MIB Objects ....................... .................................. ....................... .............. 148 Procedure: Procedure: Provisionin Provisioning g Voice and Signaling Signaling Packet Packet Priority ....... ....... 1 149 49 ToS-related MIBs ...................... .................................. ........................ ....................... ...................... ........... 149 Procedure: Procedure: Provisioning RIP ........................ ................................... ....................... ..................... ......... 150 Requirements ...................... .................................. ........................ ....................... ....................... ................. ..... 150 Basic RIP Provisioning .............. .......................... ........................ ....................... ...................... ........... 150 RIP Remote Provisioning (WTM552/WTM652) ...................... ...................... 151

Advanced WTM552 and WTM652 Provisioning

153

General Provisioning Notes ....................... ................................... ....................... ....................... .............. 153 WRM Provisioning File Error Reporting Repor ting ....................... .................................. ........... 153 WRM Provisioning Error Handling ....................... ................................... ................... ....... 154 Aging out CPE MAC Addresses ....................... .................................. ...................... ........... 155 WTM552- and WTM652-Specific MIB Objects ....................... .............................. ....... 155 Accessing the WRM MIB through the CM IP Address ............ ............ 161 About Remote Provisioning ....................... ................................... ....................... ....................... .............. 162 CLI Interaction with Remote Provisioning ............................... ............................... 162 About L2TP Support ...................... .................................. ........................ ....................... ....................... .............. 163 Procedure: Procedure: Provisioning Wireless Mesh Networ king .................... .................... 164 About Wireless Mesh Networ king ...................... .................................. ..................... ......... 164 Configuring a BSSID ................... ............................... ........................ ....................... .................... ......... 164 Setting up L2TP Tunneling .................... ................................ ....................... ...................... ........... 164 Configuring Remote Provisioning ....................... .................................. .................... ......... 165 Procedure: Procedure: Setting the Router Mode ........................ ................................... .................... ......... 166 Available WRM Modes ...................... .................................. ....................... ....................... ............... ... 166 Procedure: Procedure: Provisioning WPA-Enter WPA-Enterprise Support ...................... ........................ 167 Requirements ...................... .................................. ........................ ....................... ....................... ................. ..... 167 Provisioning WPA-Enter WPA-Enterprise Access using usi ng the Web Pages .. 167 Provisioning WPA-Enter WPA-Enterprise Access using the CLI ............... ............... 168 Procedure: Procedure: Configuring WRM Features Features .................... ................................ ................... ....... 170 Configur Configuring Wireless Wireless Pow Power Level Level ....................... ................................... ................... ....... 170 Configuring Wireless Channel Auto-Detect ............................ ............................ 170 Configuring WRM Bandwidth Limits ...................... .................................. ................. ..... 171 Configur Configuring WRM CPE Isolation Isolation using the CLI ........ ............ ........ ........ ...... .. 171 171 Configuring WRM CPE Isolation using SNMP ....................... ......................... 172

SIP Support and Implementation

173

SIP Concepts ...................... .................................. ........................ ........................ ....................... ...................... ........... 173 Dialogs ....................... .................................. ....................... ........................ ....................... ....................... ............... ... 173 Transactions ansacti ons ......................... ............ ......................... ........................ ......................... ......................... .............. .. 173 Authorization ....................... ................................... ........................ ....................... ....................... ................. ..... 174 Registration ....................... ................................... ........................ ....................... ....................... ................... ....... 174


Contents

xi

Subscriptions ...................... .................................. ........................ ....................... ....................... ................. ..... 175 Implicit Subscriptions .................................. ............................................. ...................... ........... 175 Call Legs ....................... ................................... ........................ ........................ ....................... ...................... ........... 175 Basic Call Flow ....................... ................................... ....................... ....................... ................... ....... 176 Basic Call Flow with PRACK .................... ............................... ....................... .............. 176 Forking ....................... ................................... ........................ ....................... ....................... ................... ....... 177 Call Forking Trace ....................... ................................... ....................... ....................... ............... ... 178 Offer/Answer Offer/Answer ....................... ................................... ........................ ....................... ....................... ................. ..... 178 PRACK ....................... ................................... ........................ ....................... ....................... ................... ....... 179 Session Timer ....................... ................................... ........................ ....................... ....................... ............... ... 179 SRV ........................ ................................... ....................... ........................ ....................... ....................... ................... ....... 179 Message Retransmission ................................ ........................................... ....................... .............. 180 SIP Message Overview ....................... ................................... ....................... ....................... .............. 181 INVITE ...................... .................................. ........................ ....................... ....................... ..................... ......... 181 CANCEL ....................... ................................... ........................ ....................... ....................... ................. ..... 181 BYE ....................... .................................. ....................... ........................ ....................... ....................... .............. 181 UPDATE UPDATE ....................... ................................... ........................ ....................... ....................... ................. ..... 181 SUBSCRIBE ....................... ................................... ........................ ....................... ...................... ........... 181 NOTIFY ...................... .................................. ........................ ....................... ....................... ................... ....... 181 REFER ....................... ................................... ........................ ....................... ....................... ................... ....... 182 INFO ....................... ................................... ........................ ........................ ....................... ...................... ........... 182 PRACK ....................... ................................... ........................ ....................... ....................... ................... ....... 182 Response Codes ...................... .................................. ........................ ....................... ...................... ........... 182 1XX - Provisional Responses ...................... .................................. ..................... ......... 183 2XX - Successful ...................... .................................. ....................... ....................... ................. ..... 183 3XX - Redirection ....................... ................................... ....................... ....................... ............... ... 183 4XX - Request Failure ........................ ................................... ....................... ................... ....... 183 5XX - Server Failure ................... ............................... ....................... ....................... ............... ... 183 6XX - Global Gl obal Failures ....................... ................................... ....................... .................... ......... 183 Overview of SIP Features .................... ................................ ....................... ....................... ................... ....... 184 SIP Proxy Penalty Box ...................... .................................. ....................... ....................... ............... ... 184 Barge-In ....................... .................................. ....................... ........................ ....................... ....................... .............. 185 Loopback ...................... .................................. ........................ ........................ ....................... ...................... ........... 185 Repeat Dialing ...................... .................................. ........................ ....................... ....................... ............... ... 185 Provisioning Considerations ........................ .................................... ....................... ...................... ........... 186 Provisioning Details Detail s ...................... .................................. ....................... ....................... ................... ....... 186 Digit Map ...................... .................................. ........................ ....................... ....................... ................. ..... 186 Proxy Address ...................... .................................. ........................ ....................... .................... ......... 187 Registrar Address ....................... ................................... ....................... ....................... ............... ... 187 Loopback ...................... .................................. ........................ ....................... ....................... ................. ..... 187 Packetization Packetization Rate ...................... .................................. ....................... ....................... ............... ... 187 Provisioned CODEC Array ....................... .................................. ....................... .............. 187 Repeat Dialing ...................... .................................. ....................... ....................... ..................... ......... 187 Call Forwarding Forbidden Numbers N umbers ....................... ................................ ......... 188 Call Waiting setting Persistent Persistent Across Reboot ................. ................. 188 Default G.711 ....................... ................................... ........................ ....................... .................... ......... 189 Domain Override ...................... .................................. ....................... ....................... ................. ..... 189 Emergency Calls C alls ...................... .................................. ....................... ....................... ................. ..... 189 Pulse Dialing ...................... .................................. ........................ ....................... ...................... ........... 190 Line Specific Features ................................ ........................................... ...................... ........... 190


xii

Contents

Distinctive Ringing ...................... .................................. ....................... ....................... ............... ... 190 Dialing Features ....................... ................................... ....................... ....................... ................. ..... 191 Call Transfer ....................... ................................... ........................ ....................... ...................... ........... 191 Feature Capabilities ........................ .................................... ....................... ...................... ........... 192 Registration ...................... .................................. ........................ ....................... ....................... .............. 193 Timers ...................... .................................. ........................ ....................... ....................... ..................... ......... 193 SIP Feature Switch ....................... ................................... ....................... ....................... ................... ....... 194 Minimal Example ....................... ................................... ........................ ....................... ...................... ........... 194 Troubleshooting SIP ...................... .................................. ........................ ....................... ....................... .............. 195 Internal MTA MTA States ...................... .................................. ....................... ....................... ................... ....... 197 SIP Logging ...................... .................................. ........................ ....................... ....................... ................... ....... 198 SIP Traces ....................... ................................... ........................ ....................... ....................... ..................... ......... 200 References ....................... .................................. ....................... ........................ ....................... ....................... ............... ... 201

MIB Reference

203

Supported MIBs ...................... .................................. ........................ ....................... ....................... ................... ....... 203 ARRIS Proprietar Propr ietary MIBs ....................... ................................... ....................... ...................... ........... 203 DOCSIS MIBs ....................... ................................... ........................ ....................... ....................... ............... ... 204 PacketCable PacketCable MIBs ....................... ................................... ....................... ....................... ..................... ......... 204 Network-related MIBs ....................... ................................... ....................... ....................... ............... ... 205 Imports and Definitions ....................... ................................... ....................... ....................... .............. 206 Duplicate and Obsolete MIBs ........................ ................................... ....................... ..................... ......... 207 Duplicate MIBs ...................... .................................. ........................ ....................... ....................... ............... ... 207 MIB Objects Removed in TS4.1 ........................ ................................... ...................... ........... 207 Removed Battery MIBs ....................... ................................... ....................... ....................... .............. 208 Deprecated MIB Objects ....................... ................................... ....................... ...................... ........... 209 Order of Compilation ....................... ................................... ........................ ....................... ...................... ........... 210

Appendix A: Example Files

213

Listing of Templates ....................... ................................... ........................ ....................... ....................... .............. 213 Location of Template Files ........................ ................................... ....................... ................... ....... 213 MTA MTA Configuration Files ........................ .................................... ....................... ...................... ........... 213 Cable Modem Configuration Files ...................... .................................. ..................... ......... 214 Text Files ....................... ................................... ........................ ........................ ....................... ...................... ........... 215 SNMP Co-existence Example Configuration File ....................... .......................... ... 215 Firmware Upgrade Example ........................ .................................... ....................... ...................... ........... 216 Gateway Dial Pulse Example ........................ ................................... ....................... ..................... ......... 219 SIP CM Configuration File Example ........................ ................................... ...................... ........... 219 SIP MTA MTA Configuration File Example ....................... ................................... ..................... ......... 221 Example WRM Configuration ........................ ................................... ....................... ..................... ......... 223 Enhanced Cordless Telephone Configuration ...................... ............................... ......... 225

Appendix B: Configuring the Service Provider Root

235

Service Provider Root Provisioning .......................... ...................................... ..................... ......... 236 MIBs ....................... .................................. ....................... ........................ ....................... ....................... ................... ....... 236 Using the Default Embedded Root ...................... .................................. .............. 238 Using the Embedded Test Root ....................... ................................... ................. ..... 238 Using the Downloadable Test Test Root Feature ..................... ..................... 238


Contents

xiii

Appendix C: Line Parameters by Country

239

Country Code Templates ....................... ................................... ....................... ....................... ................. ..... 239 Provisioning Ring Cadence ....................... ................................... ....................... ....................... .............. 240 North American ican Ring Cadences Cadences ........ ............ ........ ........ ........ ........ ........ ........ ........ ........ ...... 240 Provisioning European Ring Cadences ....................... .................................. ........... 241 Argentina Ring Cadences ....................... .................................. ....................... ..................... ......... 243 Austria Ring Cadences ....................... ................................... ....................... ....................... .............. 244 Belgium Ring Cadences ....................... ................................... ....................... ...................... ........... 245 France Ring Cadences ....................... ................................... ....................... ....................... .............. 246 Germany/Germany2 Ring Cadences ....................... ................................... ............... ... 247 Hungary Ring Cadences ....................... ................................... ....................... ...................... ........... 247 Israel Ring Cadences ...................... .................................. ....................... ....................... ................. ..... 248 Japan Ring Cadences ....................... ................................... ....................... ....................... ............... ... 249 Mexico Ring Cadences ....................... ................................... ....................... ....................... .............. 249 MexicoC Ring Cadences ........................ ................................... ....................... ..................... ......... 250 Netherrlands/Neth Nethe lands/Nether erlands09 lands09 Ring Cadences Cadences ........ ............ ........ ........ ........ ...... .. 251 Norway Ring Cadences C adences ........................ .................................... ....................... ...................... ........... 252 Panama Ring Cadences ....................... ................................... ....................... ...................... ........... 252 Poland/Poland1010/Slovakia Poland/Poland1010/Slovakia Ring Cadences ...................... ......................... ... 253 Slovenia Ring Cadences ....................... ................................... ....................... ...................... ........... 253 Switzerland Ring Cadences ........................ ................................... ....................... ................. ..... 253 Customizing Default Ring Cadences ....................... ................................... ............... ... 254 Default Tone Settings ...................... .................................. ........................ ....................... ...................... ........... 255

Index

275


xiv


Contents

About This Document This document describes installation and provisioning of Touchstone™ Telephony modems using using TS6.1 firmware.

Audience This manual assumes that you have a basic understanding of SNMP management systems, DOCSIS® and PacketCable™ standards, and a working knowledge knowledge of cable data and telephony telephony networks.

In this Document This document contains the following following information: • Chapter 1, ‘‘Installing ‘‘Installing and Upgrading Touchstone Touchstone Firmware,’ Firmware,’’ describes how to install and upgrade upgrade Touchstone Touchstone firmware. • Chapter 2, ‘‘Provisioning ‘‘Provisioning Modes, Modes,’’’ describes provisioning provisioning modes, the the communication sequence associated with each mode, mode, and how how provisioning modes affect DHCP. • Chapter 3, ‘‘Provisioning ‘‘Provisioning,’ ,’’’ provides provisioning provisioning notes and and procedures. • Chapter 4, ‘‘Advanced ‘‘Advanced WTM552 WTM552 and WTM652 Provisioning, Provisioning,’’’ discusses provisoning of WTM552- and WTM652-specific features: remote Wireless Router Module (WRM) provisioning, public and private BSSID support, L2TP support, and Wireless Mesh Networking support. • Chapter 5, ‘‘SIP ‘‘SIP Support and Implementation,’ Implementation,’’ discusses features features and provisioning specific to Touchstone SIP loads.


xvi

About This Document

• Chapter 6, ‘‘MIB Reference,’’ provides a brief overview of standard and proprietary MIBs used in system management. • Appendix A, ‘‘Example Files,’’ provides complete and partial examples of provisioning files. • Appendix B, ‘‘Configuring the Service Provider Root,’’ describes how to change the Service Provider certificate for use with KDC servers. • Appendix C, ‘‘Line Parameters by Country,’’ defines the default tones and ring definitions for each supported country template.

Terminology The following is a list of terms and abbreviations used in this manual. Best Effort (BE) The default Service Flow type. BE is intended for non-telephony applications, where jitter and latency are of little importance. Call Agent (CA) A device that maintains call state, and controls the line side of calls. The CA is often a portion of a Call Management Server (CMS). Call Management Server (CMS) A generic term for the devices connecting a VoIP network to the PSTN. A CMS includes both a Call Agent (CA) and the PSTN gateway, and controls audio call connections. CALFV Call Forwarding Unconditional (dialing feature). CallP Call Processing. Firmware controlling the current state of a call. CALRT Call Return (dialing feature). CAS

CPE Alert Signal. A method of encoding signaling information in a telephone connection. CBR

Constant Bit Rate. A data service that provides a guaranteed, fixed amount of bandwidth. Technically, it is not possible to provide actual CBR services over an IP network due to factors such as contention and latency. UGS service flows and low-latency hardware such as the ARRIS™ Cadant® C4 CMTS, however, can provide an approximation suitable for carrier-grade telephone service.

Touchstone® Telephony Release 6.1 Standard 1.3 June 2009

About This Document

xvii

CFFDS Call Forwarding Unconditional Disable (dialing feature). CIDTE Caller iD Temp Enable (dialing feature). Classifier Rules used to classify packets into a Service Flow. The device compares incoming packets to an ordered list of rules at several protocol levels. Each rule is a row in the docsQosPktClassTable. A matching rule provides a Service Flow ID (SFID) to which the packet is classified. All rules need to match for a packet to match a classifier. Packets that do not match any classifiers are assigned to the default (or primary) Service Flow. CLWPD Call Waiting Permanent Disable (dialing feature). CM

Cable Modem. Typically a device installed at the subscriber premises that provides a high-speed data (Internet) connection through the HFC network. CMTS Cable Modem Termination System. A device at a cable headend that connects to cable modems over an HFC network to an IP network. CODEC Coder-decoder. In VoIP products, one of several possible schemes of converting audio (i.e. a phone call) to digital data and vice versa. Attributes of a codec include fidelity (e.g. voice quality), bandwidth, and latency. CPE

Customer Premises Equipment. Subscriber-owned equipment connected to the network. Technically, a cable modem, MTA, or NIU falls into this category, although many operators do not designate them as such. CVC

Code Verification Certificate, an encryption key that allows secure downloading of encrypted firmware over the HFC network. DHCP Dynamic Host Configuration Protocol. An IP protocol used to provide an IP address and location of services (such as DNS and TFTP) needed by a device connecting to the network. DNS

Domain Name Service (Server). An IP service that associates a domain name (such as www.example.com) with an IP address.


xviii

About This Document

Downstream In an HFC network, the direction from the headend to the subscriber. Some older cable documentation may refer to this as the forward path. DOCSIS Data Over Cable Service Interface Specification. The interoperability standards used for data communications equipment on an HFC network. DQoS Dynamic Quality of Service. The mechanism by which the MTA chooses the proper quality of service settings for a particular service flow. Touchstone firmware supports both full PacketCable DQoS and ‘‘DSx QoS’’ for interoperability with non-PacketCable compliant networks. eMTA Embedded MTA. A device, such as the ARRIS Touchstone Telephony Modem, that contains both an MTA and a cable modem. Euro-DOCSIS The European version of DOCSIS. Euro-DOCSIS specifies an 8 MHz downstream bandwidth (vs. 6 MHz for DOCSIS); other minor differences exist as well. FQDN Fully Qualified Domain Name. The name used to identify a single device on the Internet. See RFC2821 for details. FSK

Frequency Shift Keying. A method of encoding signaling information in a telephone connection. Global Universal Provisioning Interface (GUPI) A PacketCable subset, intended to accommodate a wide range of partially-compliant equipment. SNMP communication uses SNMPv1 or SNMPv2, with INFORM disabled. IPsec and media encryption are disabled. Headend The ‘‘central office’’ in an HFC network. The headend houses both video and data equipment. In larger MSO networks, a ‘‘master’’ headend often feeds several ‘‘remote’’ headends to provide distributed services. HFC

Hybrid Fiber-Coaxial. A broadband, bi-directional shared media transmission system using fiber trunks between the headend and fiber nodes, and coaxial distribution cable between the fiber nodes and subscriber premises.


About This Document

xix

IANA

Internet Assigned Numbers Authority. The coordinating body that: assigns IP addresses to regional Internet registries; recognizes toplevel domains; and assigns protocol numbers for well-known services. Jitter

Variance in packet arrival time. Jitter is a factor in applications such as telephony, where the originating device sends packets at a constant rate. Latency The time required for a signal element (e.g. packet) to pass through a device or network. KDC

Kerberos Key Distribution Center. LCO

Local Connection Options. A structure that describes the characteristics of the media data connection from the point of view of the CMS creating the connection. MAC

Media Access Control. A general term for the link-level networking layer and associated protocols. MAC protocols used in HFC data networks include Ethernet, the DOCSIS RF interface, and HomePNA. Maintenance window The usual period of time for performing maintenance and repair operations. Since these activities often affect service to one or more subscribers, the maintenance window is usually an overnight period (often 1 a.m. to 5 a.m. local time). MD5

Message Digest 5. A one-way hashing algorithm that maps variable length plaintext into fixed-length (16-byte) ciphertext. MD5 files, built by a provisioning server, contain provisioning data for each NIU on the network. MIB

Management Information Base. The data representing the state of a managed object in an SNMP-based network management system. Often used colloquially to refer to a single object or variable in the base; e.g. ‘‘the lcCmtsUpMaxCbrFlows MIB.’’ MSO

Multi-System Operator. A cable company that operates multiple headend locations, usually in several cities.


xx

About This Document

MPI

Micro-Processor Interface. Modem component.

An internal Touchstone Telephony

MTA

Multimedia Terminal Adapter. A subscriber premises device that contains the network interface, codecs, and all signalling and encapsulation functions required for telephony transport, CLASS features signalling, and QoS signalling. The MTA is an integral part of Touchstone Telephony embedded MTA (eMTA) products. NCS

Network-based Call Signaling. The PacketCable protocol used to control calls. NIU

Network Interface Unit. A generic term for a device providing data and telephony connections at a subscriber site. Also referred to as embedded MTA (eMTA). NMS

Network Management System. Software, usually SNMP-based, that allows you to monitor and control devices on the network. In a VoIP network, managed devices include NIUs, CMTS, servers, PSTN interface devices, and routers. An NMS works by reading and setting values of MIB variables presented by each device. NVRAM Non-volatile RAM. A block of non-volatile memory used to store settings that should persist across reboots. Off-net A call between a Touchstone phone line and a line on the PSTN. On-net A call between two Touchstone phone lines. Depending on the CMS used, the connection may be established directly between the MTAs or be routed through a gateway. PacketCable A CableLabs-led initiative aimed at developing interoperable interface specifications for delivering advanced, real-time multimedia services over two-way cable plant. PCM

Pulse Code Modulation. A commonly employed algorithm to digitize an analog signal (e.g. voice) into a digital bit stream using simple analog to digital conversion techniques. PCM is employed in the popular G.711 codec. PLO

Permanent Lock-Out. A line card may enter this state when left offhook with no connection after a certain amount of time.


About This Document

xxi

POS

Point of Sale (terminal). Typically, an electronic cash register. PSTN Public Switched Telephone Network. QAM

Quadrature Amplitude Modulation. A method of modulating digital signals onto an RF carrier, involving both amplitude and phase coding. QAM16 modulation encodes four digital bits per state and is used on upstream carriers; QAM64 and QAM256 encode six or eight bits (respectively) for use on downstream carriers. QoS

Quality of Service. An attribute of a Service Flow, defining limitations or guarantees for data rate, latency, and jitter. QPSK Quadrature Phase Shift Keying. A method of modulating digital signals onto an RF carrier, using four phase states to encode two digital bits. Quarantine A state where an endpoint (phone line) may potentially buffer events. Events not quarantined are processed normally. Processing of quarantined events may be delayed, potentially indefinitely. RF

Radio Frequency. SDP

Session Description Protocol. SDP describes multimedia sessions for the purposes of session announcement, session invitation, and other forms of multimedia session initiation. Service Flow A unidirectional, MAC-layer transport service that provides traffic shaping, policy, and priority according to QoS parameters defined for the flow. SFID

Service Flow ID. A number used to identify a particular Service Flow. SLAC Subscriber Line Audio Circuit. An internal Touchstone Telephony Modem component. SIP

Session Initiation Protocol. A signaling protocol for Internet conferencing, telephony, presence, events notification and instant messaging.


xxii

About This Document

SNMP Simple Network Management Protocol. TFTP Trivial File Transfer Protocol. Used in DOCSIS networks to transfer firmware and provisioning files to network devices. TM

Telephony Modem. Uniform Resource Identifier (URI) A way to identify a specific phone line for an MTA. For example sip:@. Unsolicited Grant Service (UGS) A Service Flow type used for applications such as telephony in which latency and jitter are critical. Packets have a fixed size and interval. Within the constraints of IP networking, UGS flows attempt to deliver a constant bit rate (CBR) stream of data. Upstream The path from a subscriber device to the headend. Some older cable documentation may refer to this as the return path or reverse path. VACM View-based Access Control Model. An SNMP MIB for controlling access to management information. VF

Voice Frequency. VoIP

Voice Over Internet Protocol. A generic term for technology that allows telephone calls to be made across an Internet connection instead of a traditional two-wire copper connection. WTM

Wireless Telephony Modem.


1 Installing and Upgrading Touchstone Firmware This chapter provides procedures used to install and upgrade Touchstone firmware on local DHCP and TFTP servers.

Load Name Extensions A variety of TS6.1 loads are available to support specific Touchstone hardware, applications, protocols, or regions. Each load has a unique extension to identify its function. Load names begin with TS0601 xx_date_, where xx is the revision number and date indicates the date (in YYMMDD format) that the load was built. The following table shows extensions used to further identify the loads. Some loads may have multiple extensions. Extension

NA EU TELNET_ON D11PLUS MODEL_4_5 MODEL_6 SIP MODEL5_ML MODEL6_ML EURO

Description

North American signed firmware image. European signed firmware image. Telnet access permanently enabled. Features to transition from DOCSIS 1.0+ to DOCSIS 1.1. Supports all 1- to 4-line Model 4 and Model 5 Telephony Modems, and Model 4 Telephony Ports. Supports all 1- to 4-line Model 6 Telephony Modems. Supports SIP signaling (non-SIP loads use NCS signaling). Supports TM508 and TM512 multi-line Telephony Modems. Supports TM608 multi-line Telephony Modems. Supports Euro-PacketCable provisioning changes and IETF MIBs.


2

Chapter 1

Extension

Description

MODEL_5_WR Supports the WTM552 wireless router module. MODEL_6_WR Supports the WTM652 wireless router module. EPA T{ (TS5.2 and later) Expanded Provisioning Announcement: enables the arrisMtaDevSpecialConfigurationOverrideEnable object by default, and allows specifying the provisioning mode using DHCP Option 122 Sub-option 6 instead of using the ARRIS provisioning method MIB objects. WDOCSIS (TS5.3 and later) Fixed wireless DOCSIS (WiDOX™) support for use with ARRIS WM502 Wireless Telephony Modems. Note:

OPT177 loads have been discontinued as of TS5.1. TS6.1 advertises both Option 122 and Option 177 support, with Option 122 listed first in the capabilities. TS6.1 accepts the first of these two options that the provisioning system offers.

Examples

The following examples show how load names describe the functionality of the load. TS0601xx_date_NA.MODEL_6.img TS0601xx_date_EU.MODEL_6.img North American and European firmware images for Model 6 Telephony Modems. TS0601xx_date_EU.MODEL_4_5.EURO.img European signed firmware image for Model 4 and Model 5 Telephony Modems, and TP402/404, with support for Euro-PacketCable provisioning changes and IETF MIB support. TS0601xx_date_EU.MODEL_6.EURO.img European signed firmware image for Model 6 Telephony Modems, with support for Euro-PacketCable provisioning changes and IETF MIB support.

About ARRIS Enhanced Firmware Loading The ARRIS Enhanced Firmware Loading feature (patent pending) is part of TS4.1 and newer versions of Touchstone firmware. For DOCSIS 1.1 and 2.0 loads, it provides the ability to embed a common firmware load lineup table in configuration files that matches firmware loads to Touchstone eMTAs. It supports a multiple-vendor common configuration file that works with multiple Touchstone eMTAs, while still being backward compatible with nonARRIS equipment. TS6.1 and newer versions extend Enhanced Firmware Loading to support IPv6 addressing.


3

Installing and Upgrading Touchstone Firmware

By eliminating the need for customized configuration files by product type, Enhanced Firmware Loading simplifies firmware upgrades and improves the general quality of the process.

Upgrade Process

Note 1:

Telephony Modems do not begin or continue a firmware upgrade when running on battery power. This prevents a potential corruption issue if a battery were to fail while an upgrade is in progress.

Note 2:

TS5.3 makes some changes to the upgrade process. Previous firmware versions could reject a firmware download while a call was in progress; TS5.3 can download and store the new firmware while a call is in progress and apply the new load once all lines are idle. When a Touchstone eMTA ranges and registers with the headend and receives the arrisCmDevSwTable object (see ‘‘Enhanced Firmware Loading Options’’ on page 5 for a listing of relevant MIB objects) in its configuration file, it proceeds as follows: Download Acceptance 1 If the eMTA is running on battery power, the eMTA rejects the download and the process stops. Otherwise, it proceeds to step 2. 2 (TS5.2 and newer) The eMTA checks the docsDevSwAdminStatus object. If the value is allowProvisioningUpgrade, proceed to step 3. Otherwise, the device uses the standard docsDevSoftware MIBs for its upgrade decision-making. A setting of upgradeFromMgt is not allowed in the configuration file and returns an error condition. 3 The eMTA checks the arrisCmDevSwAdminStatus object. • If its value is allowArrisProvisioningUpgrade, proceed to step 4. • If its value is ignoreArrisProvisioningUpgrade, the device uses the standard docsDevSoftware objects for its upgrade decision-making. A setting of upgradeFromArrisMgt is not allowed in the configuration file and returns an error condition (see the Touchstone Telephony Troubleshooting Guide for details). 4 The eMTA scans the arrisCmDevSwTable, looking for matches between arrisCmDevSwHwModel and its known model type. • If it finds a match, it checks the optional arrisCmDevSwHwRev for a match to its known hardware revision. A blank entry for arrisCmDevSwHwRev is a match only if there is no entry with an explicit match to the eMTA’s hardware revision.


4

Chapter 1

Upon finding a match, proceed to step 5. • If it cannot match the model type or find a qualifying revision, then the system logs an error (see the Touchstone Telephony Troubleshooting Guide for details) and aborts to the standard DOCSIS upgrade process. 5 The eMTA checks the value of arrisCmDevSwServerAddressType to determine whether the CM uses IPv4 or IPv6 addressing (the MTA always uses IPv4). 6 The eMTA reads arrisCmDevSwServerAddress from the arrisCmDevSwTable to obtain the TFTP server address. 7 The eMTA reads the value of arrisCmDevSwFilename from the arrisCmDevSwTable for the firmware file name to download, then downloads its firmware from the specified server. Download Application After downloading the firmware: 1 The eMTA checks the arrisMtaDevSwDnldNoSvcImpact object. If the value is disabled, the eMTA immediately applies the firmware and resets. Otherwise, proceed to step 2. 2 The eMTA checks for calls in process and applies the new firmware load only if all MTA lines are idle. Any of the following conditions constitute an active connection for the purpose of firmware application: • One or more lines off-hook • Connection currently assigned to the line (including for 911 calls) • Playing VMWI • Ringing a line 3 If an active connection exists, the eMTA waits for all lines to go idle then starts a 30-second timer. 4 If the timer expires with no lines becoming active, the eMTA applies the firmware and resets; otherwise, it returns to step 3. Note that Touchstone firmware disables Enhanced Firmware Loading if the value of docsDevSwAdminStatus is not allowProvisioningUpgrade. This change allows deployment of provisioning files where the docsDevSwAdminStatus object is not specified, but the Enhanced Firmware Loading and the normal upgrade TLVs are specified. Upgrading this behaves as follows:


5


• Non-ARRIS devices upgrade using the DOCSIS upgrade objects. • ARRIS devices automatically use Enhanced Firmware Loading to run the correct firmware load. • An ARRIS eMTA, manually-upgraded using SNMP, has the docsDevSwAdminStatus set to ignoreProvisioningUpgrade; this disables Enhanced Firmware Loading on that device. To restore the firmware load specified in the load lineup, change docsDevSwAdminStatus to allowProvisioningUpgrade and reset the modem using docsDevResetNow. During the server communication and firmware image file download, there is no interruption to eMTA operation. During this phase of the procedure, all operation continues normally. However, per the DOCSIS and PacketCable specifications, once the image is downloaded into the eMTA, the device must automatically execute a reset operation to copy the new image into the active flash memory and apply the functionality of the new image.

Enhanced Firmware Loading Options

Enhanced Firmware Loading is controlled by several SNMP MIB variables, described below. These variables are all ARRIS-specific and do not interfere with non-ARRIS eMTAs. All of these variables can be added to the vendorspecific section of configuration files. ARRIS PacketACE (version 3.2 and higher) also supports these objects for easy addition to configuration files. Each object can also be controlled remotely via standard SNMP MIB browser software. Touchstone firmware can reject a firmware upgrade while a call is in progress, complying with a PacketCable 1.5 requirement to minimize service impacts. See the Touchstone Telephony Provisioning Guide for details.

ArrisCmDevSwAdminStatus Feature Switch

Enhanced Firmware Loading has a feature switch named arrisCmDevSwAdminStatus that parallels the standard DOCSIS docsDevSwAdminStatus object. This object has three different settings: upgradeFromArrisMgt(1) Immediately upgrade the device using Enhanced Firmware Loading. If a valid entry cannot be found, then an error condition is returned. This is not a valid setting in configuration files. allowArrisProvisioningUpgrade(2) Allow provisioning file upgrade using Enhanced Firmware Loading. This setting overrides the DOCSIS upgrade mechanism unless a valid entry cannot be found in the load lineup table for the device. If a valid entry cannot be found, then an error is returned and the standard DOCSIS upgrade mechanism takes over. ignoreArrisProvisioningUpgrade(3) Disable Enhanced Firmware Loading and use the standard DOCSIS upgrade mechanism. This is the power up default setting for all ARRIS products.


6

Chapter 1

ArrisCmDevSwTable MIB

MIB column variable

The arrisCmDevSwTable drives the main decision-making algorithm of Enhanced Firmware Loading. The table can handle up to 32 load lineups. If you try to add more than 32 entries to this table, the eMTA generates an illegal SNMP SET during the ranging and registering process. Per DOCSIS specification, the eMTA does not range and register until this problem is corrected. Each row of the table contains the following MIB objects: Description

Valid Setting

Req/Opt

ArrisCmDevSwCustomerLoadId

A customer-defined string that can be added to identify load lineups. This string is unused by the firmware upgrade mechanism.

1–64 byte ASCII string*

Optional

ArrisCmDevSwHwModel

Defines which Touchstone hardware model type this row applies to.


Required

ArrisCmDevSwH-

Defines the Touchstone hardware revision of the currently defined model.

Integer, 0 to 255

Optional

Any valid IP

Required

vSwServerAddress

Defines an IP address of the TFTP server to use for firmware upgrades.

arrisCmDevSwServerAddressType

Sets the CM address type: IPv4 or IPv6.

1 (IPv4) or 2 (IPv6)

Required

ArrisCmDevSwFile-

Defines what file name the device should request from TFTP server.


Required

wRev arrisCmDe-

name

* – 1 byte reserved for null terminator The following list shows common arrisCmDevSwHwModel ASCII strings for loads supporting Enhanced Firmware Loading:


7


Example Lineup

• TM102A

• TP402A

• TM501A

• WTM552B

• TM602H

• TM102B

• TP404A

• TM501B

• WTM552G

• DTM602G

• TM102D

• TM401A

• TM502A

• WTM552H

• TM604G

• TM102E

• TM401B

• TM502B

• TM508A

• TM604H

• TM202A

• TM402A

• TM502C

• TM512A

• TM608G

• TM202B

• TM402B

• TM502G

• TM601A

• WTM652A

• TM202P

• TM402C

• TM502H

• TM601B

• WTM652B

• TP204A

• TM402G

• TM504G

• TM602A

• WTM652G

• TP302A

• TM402H

• TM504H

• TM602B

• TP304A

• TM402P

• WTM552A

• TM602G

Below is an example firmware lineup table for various ARRIS Touchstone products. This table is mirrored in the following configuration file excerpt. In this example, Enhanced Firmware Loading is assumed enabled by setting arrisCmDevSwAdminStatus to allowArrisProvisioningUpgrade(2).

Customer Load Id

Model

HW Revision

TFTP IP Addr.

Upgrade Filename

Lab NA TM502 Rev. 2

TM502G

2

10.1.50.21

TS060118_09022008_NA_MODEL_4_5.img

Node 3 NA TM602 Rev. 1

TM602A

1

10.1.50.21

TS060118_09022008_NA_MODEL_6.img

Euro TM402 Rev. 3

TM402Q

3

10.1.51.21

TS040109_09302003_EU.img

Euro TM402 Non-Rev. 3

TM402Q

blank (see note 1)

10.1.51.21

TS040108_09222003.img

Node 1 TM202 Non-Rev. 2

TM202P

blank (see note 1)

10.1.52.21

TS030203_090503A.img

Node 2 TM202 Rev. 2

TM202P

2

10.1.52.21

TS030203_090503A.img

Note 1:

Not specifying a hardware revision makes that entry a wildcard for any unspecified hardware revisions.

Example Configuration File Excerpt

The following configuration file excerpt implements the load lineup shown above. This excerpt would typically be placed in a vendor-specific section of a configuration file. SnmpMib = arrisCmDevSwAdminStatus.0 2 SnmpMib = arrisCmDevSwCustomerLoadId.1 "Lab NA TM502 Rev. 2" SnmpMib = arrisCmDevSwHwModel.1 "TM502G" SnmpMib = arrisCmDevSwHwRev.1 2 SnmpMib = arrisCmDevSwServer.1 10.1.50.21 SnmpMib = arrisCmDevSwFilename.1 "TS0500_07112006.bin" SnmpMib = arrisCmDevSwCustomerLoadId.2 "Node 3 NA TM402 Rev. 3" SnmpMib = arrisCmDevSwHwModel.2 "TM402P" SnmpMib = arrisCmDevSwHwRev.2 3 SnmpMib = arrisCmDevSwServer.2 10.1.50.21 SnmpMib = arrisCmDevSwFilename.2 "TS0500_07112006.bin" SnmpMib = arrisCmDevSwCustomerLoadId.3 "Euro TM402 Rev. 3"


8

Chapter 1

SnmpMib = arrisCmDevSwHwModel.3 "TM402Q" SnmpMib = arrisCmDevSwHwRev.3 3 SnmpMib = arrisCmDevSwServer.3 10.1.51.21 SnmpMib = arrisCmDevSwFilename.3 "TS0401_09302003.bin" SnmpMib = arrisCmDevSwCustomerLoadId.4 "Euro TM402 Non-Rev. 3" SnmpMib = arrisCmDevSwHwModel.4 "TM402Q" SnmpMib = arrisCmDevSwServer.4 10.1.51.21 SnmpMib = arrisCmDevSwFilename.4 "TS0401_09222003.bin" SnmpMib = arrisCmDevSwCustomerLoadId.5 "Node 1 TM202 Non-Rev. 2" SnmpMib = arrisCmDevSwHwModel.5 "TM202P" SnmpMib = arrisCmDevSwServer.5 10.1.52.21 SnmpMib = arrisCmDevSwFilename.5 "TS030203_090503A.bin" SnmpMib = arrisCmDevSwCustomerLoadId.6 "Node 2 TM202 Rev. 2" SnmpMib = arrisCmDevSwHwModel.6 "TM202P" SnmpMib = arrisCmDevSwHwRev.6 2 SnmpMib = arrisCmDevSwServer.6 10.1.52.21 SnmpMib = arrisCmDevSwFilename.6 "TS030203_090503A.bin"

Upgrading from NCS to SIP Loads

Upgrading from NCS loads newer than TS4.4.20 to TS6.1 SIP loads is straightforward: replace the load name in the provisioning file, and add SIP MIB objects as required, then reboot the eMTA. Customers upgrading from TS4.4.20 or earlier NCS-based versions of Touchstone firmware to a TS4.5 or newer SIP-based release must first upgrade to TS4.4.20 or a newer release (either NCS- or SIP-based) as an intermediate step before upgrading to a newer SIP load. The upgrade proceeds as follows: 1 The operator initiates an upgrade to the intermediate release. 2 The eMTA upgrades the boot loader firmware, then reboots both the CM and MTA. 3 The eMTA automatically upgrades the firmware image then reboots (normal MTA upgrade sequence). 4 The operator initiates the upgrade to the new SIP release. 5 The eMTA automatically upgrades to the SIP firmware image then reboots (normal MTA upgrade sequence). Note:

ARRIS recommends using either TS4.4.28B or TS4.4.41 as the intermediate load (both loads are NCS-based), especially if you plan for any delays between the intermediate release and the final SIP release.


9


Minimizing Firmware Download Service Impacts Firmware downloads or upgrades require the eMTA to be rebooted to take effect; the reboot naturally would drop any call in progress. Touchstone firmware provides two ways to minimize service impacts due to firmware upgrades. • Touchstone firmware can reject SNMP-initiated downloads while a call is in progress. When a download is rejected for this reason, the eMTA generates the ‘‘No system resources available to perform SW upgrade’’ event: Nov 17 19:43:35 2005 AALN/1:mta161.dev35 <7> <4115> <37> <00:00:CA:CB:22:FB>

If the rejection event is provisioned as an alarm, clear the alarm by rebooting the MTA. • Touchstone firmware uses the two-phase process described above to download and apply a firmware update. When the arrisMtaDevSwDnldNoSvcImpact object is set to enabled, the eMTA applies the firmware load and reboots only if all lines are idle; otherwise, it waits for all lines to go on-hook for 30 seconds before applying the new load. Touchstone firmware supports the arrisMtaDevSwDnldNoSvcImpact object to enable or disable rejection of downloads while a call is in progress: • To force the eMTA to wait to apply new loads until all lines go onhook, set the arrisMtaDevSwDnldNoSvcImpact object to enable (default for D11PLUS loads). • To allow application of downloads while a call is in progress, set the arrisMtaDevSwDnldNoSvcImpact object to disable (default). When the arrisMtaDevSwDnldNoSvcImpact object is set to enable, the MTA delays applying downloaded firmware when any line is in the active state. A line is considered to be in the active state when the esafeDevServiceIntImpact object (defined by eDOCSIS specifications) returns a value of ‘‘significant.’’ The object is set to ‘‘significant’’ when any line of an eMTA is in the ‘‘offHook’’ or ‘‘onHookPlusNCSActivity’’ states. The following conditions are considered ‘‘significant:’’ • One or more lines off-hook • Connection currently assigned to the line (including for 911 calls) • Playing VMWI • Ringing a line


10

Chapter 1

Note 1:

Touchstone firmware does not automatically retry a rejected firmware download request. Manually retry the upgrade as described in ‘‘Upgrading Touchstone Firmware’’ on page 15, preferably during a scheduled maintenance window. An operator may force the upgrade by disabling the arrisMtaDevSwDnldNoSvcImpact object before initiating the upgrade.

Note 2:

If the subscriber begins or takes a call after firmware downloading begins, the eMTA reboots and drops the call when the download is complete.

Note 3:

When the CM configuration file specifies a new load, firmware downloads initiated during eMTA initialization are unaffected since there is no service available during initialization.

Considerations This section describes potential considerations to keep in mind when upgrading or downgrading Touchstone firmware.

Loop Voltage Management Reset Timer

The arrisMtaDevLoopVoltageResetTimeout object is used with Policy 3 to set the maximum amount of time that the eMTA maintains loop voltage between initialization and MTA registration. If the MTA has not registered before the timer expires, the eMTA drops loop voltage. This object uses one byte of NVRAM to store the timer value. Touchstone firmware scales this value to set the actual timer as follows: Version

prior to TS5.1

TS5.1 and later

Action

The maximum value is 1000 seconds, in 4-second increments. The firmware divides the MIB object value by 4 before storing the timer, and multiplies by 4 when reading the timer value from NVRAM. The maximum value is 1800 seconds, in 8-second increments. The firmware divides the MIB object value by 8 before storing the timer, and multiplies by 8 when reading the timer value from NVRAM.

• When upgrading to TS5.1 from previous versions, the effective value of the arrisMtaDevLoopVoltageResetTimeout object doubles since the firmware now multiplies by 8 instead of by 4. This causes a one-time doubling of the effective timeout value. • Conversely, when downgrading from TS5.1 to earlier versions, the effective value of the arrisMtaDevLoopVoltageResetTimeout is cut in half since the firmware multiplies by 4 instead of by 8.


11


When either upgrading or downgrading, the one-time re-interpretation of the timeout value can be avoided if the provisioning process completes before the timer expires.

Dual Mode Telephony Modem Considerations

Downgrading Dual Mode Telephony Modems to firmware versions earlier than TS6.1 is not recommended. One of the following results occur: • North American certificates are lost, and the modem becomes EuroDOCSIS only (for example, TM602B instead of TM602B/DM). Upgrading the modem to TS6.1 or newer does not restore the North American certificates. • The Telephony Modem rejects the downgrade.


12

Chapter 1

Installing the Firmware Use this procedure to install TS6.1 firmware on primary and backup DHCP and TFTP servers.

Requirements

You need the following to install TS6.1 firmware: • Touchstone firmware load • Access to the TFTP file servers • Location of the firmware directory on the file servers • Access to the provisioning server (to change eMTA provisioning files)

Action

Perform the following tasks as needed. Task

Page

Adding the CVC Installing the Firmware on a File Server Configuring the eMTA to Download its Firmware Setting Up ARRIS Enhanced Firmware Loading

Adding the CVC

12 13 13 13

Follow these steps to use the ARRIS manufacturer CVC for cryptographic verification of the Touchstone firmware load. 1 Use your configuration file editor to set the Manufacturer CVC TLV to include the contents of the ARRIS CVC certificate file. Use the appropriate CVC for your eMTA: • TM402P, TM502A, TM502G, TM504G, TM508A, TM512A, WTM552A, WTM552G, TM601A, TM602A, TM602G, DTM602G, TM604G, TM608G, WTM652A, WTM652G, TP402A, TP404A: use ARRIS−NA−CVC • TM402B, TM402Q, TM501B, TM502B, TM502C, TM502H, TM504H, WTM552B, WTM552H, TM601B, TM602B, TM602H, TM604H, WTM652B: use ARRIS−EURO-CVC Note:

If you are using PacketACE, it prompts you to specify a CVC when entering the Manufacturer CVC TLV value.

2 Use your provisioning server to specify the Touchstone firmware load. The load is cryptographically signed, so the eMTA can validate the load against the manufacturer’s CVC using the DOCSIS 1.1 secure firmware download feature. Use the appropriate firmware load for your eMTA.


13


3 Proceed to ‘‘Installing the Firmware on a File Server’’ on page 13.

Installing the Firmware on a File Server

Follow these steps to install the TS6.1 firmware on a file server. 1 Log into the file server, using an account with administrative privileges. Use an FTP client (make sure to use the binary transfer mode) or a network file sharing service to access the file server. 2 Change to the appropriate server directory for firmware storage. 3 Download the TS6.1 firmware file to the server. 4 Make sure that the firmware file has read access for all eMTAs.

Configuring the eMTA to Download its Firmware

Follow these steps to configure the Touchstone Telephony eMTA provisioning data to download its firmware during registration. Use your provisioning server to perform this task. 1 Set the docsDevSwServer object to the address of the file server containing the TS6.1 firmware. 2 Set the docsDevSwFilename object to the name of the TS6.1 firmware file.

Setting Up ARRIS Enhanced Firmware Loading

Follow these steps to set up Enhanced Firmware Loading in a configuration file. See ‘‘About ARRIS Enhanced Firmware Loading’’ on page 2 for details about the feature. 1 Use a provisioning server, or PacketACE version 5.8 or newer, to create an entry in the arrisCmDevSwTable with the following settings: • arrisCmDevSwCustomerLoadId (optional): name of the load lineup. • arrisCmDevSwHwModel: the Touchstone eMTA model (see the Touchstone Telephony Feature Guide for a list of valid model names). • arrisCmDevSwHwRev (optional): the hardware revision of the eMTA. Leave blank for this entry to apply to all revisions of the same model. • arrisCmDevSwServerAddressType: Either 1 to use IPv4 addressing for the CM, or 2 for IPv6 addressing (the MTA always uses IPv4 addressing). • arrisCmDevSwServerAddress: the IP address of the TFTP server containing the firmware load for eMTAs matching the model and revision.


14

Chapter 1

• arrisCmDevSwFilename: the file name of the firmware load for eMTAs matching the model and revision. 2 In the configuration file, set the arrisCmDevSwAdminStatus object to allowArrisProvisioningUpgrade. Note:

The eMTA uses Enhanced Firmware Loading to download its firmware during the next reboot, unless the eMTA is running on battery power.

3 Do one of the following to force the eMTA to immediately download its firmware file, if desired: Reboot the eMTA, either directly or by setting the docsDevResetNow object to true from the network manager. In the network manager, set the eMTA’s arrisCmDevSwAdminStatus object to upgradeFromArrisMgt. Note:

If the eMTA is running on battery power, it disables firmware upgrades until AC power is restored.


15


Upgrading Touchstone Firmware Use this procedure to upgrade from previous versions of Touchstone firmware.

Upgrading from TS4.2 or Earlier Versions

Updating from TS4.2 or earlier versions requires changes to configuration files to complete the upgrade process. The following table shows the MIB changes: Old MIB Object

New MIB Object

arrisCmDevProvMethodIndicator

arrisMtaDevProvMethodIndicator

ppCfgPortDialingMethod

arrisMtaDevEndPntDialingMethod

The old MIBs are still available, but deprecated. The new MIBs override the original MIBs if the configuration file contains both. See ‘‘Changing Configuration Files for Upgrades from TS4.2’’ on page 18 for instructions.

Upgrading from Earlier NCS Loads to SIP Loads

Customers upgrading from TS4.4.20 or earlier NCS-based versions of Touchstone firmware to a TS4.5 or newer SIP-based release must first upgrade to TS4.4.20 or a newer release (either NCS- or SIP-based) as an intermediate step before upgrading to a newer SIP load.

Upgrading from Earlier NCS Loads to TS6.1 NCS Loads

Customers upgrading from TS4.4 or TS4.5 NCS loads can upgrade directly to TS6.1 NCS-based loads. Note that such upgrades have the same considerations for configuration file contents and MIB usage as for upgrading from any TS4.4/TS4.5 release to any TS6.1 release. Upgrading from an earlier version requires upgrading to TS4.4.20 or newer and then to TS6.1. The upgrade proceeds as follows: 1 The operator initiates an upgrade to the intermediate release. 2 The eMTA upgrades the boot loader firmware, then reboots both the CM and MTA. 3 The eMTA automatically upgrades the firmware image then reboots (normal MTA upgrade sequence). 4 The operator initiates the upgrade to the new SIP release. 5 The eMTA automatically upgrades to the new firmware image then reboots (normal MTA upgrade sequence). Note:

ARRIS recommends using either TS4.4.28B or TS4.4.41 as the intermediate load (both loads are NCS-based), especially if you plan for any delays between the intermediate release and the final release.


16

Considerations for D11PLUS Loads

Chapter 1

D11PLUS loads change the arrisMtaDevSvcDnldNoSvcImpact default value from disabled to enabled. If you are upgrading to or downgrading from TS6.1, make sure this object is set as desired in the configuration file. The −6/+6 line card template is the default for D11PLUS loads. If you are using this template, you must specify a different template in the configuration file before downgrading to TS5.2 or earlier versions. Verify that gain adjustments (using the arrisMtaDevGainControl objects) are correct for use with the new template.

Upgrading from Earlier SIP Loads to TS6.1 SIP Loads

Customers upgrading from any SIP-based load can upgrade directly to TS6.1 SIP-based loads without any added considerations.

Upgrading to .EURO Loads

Upgrading from earlier North American loads to TS6.1 Euro firmware is service affecting. Touchstone eMTAs must be upgraded before changing the provisioning server to support Euro-PacketCable provisioning. However, the eMTA does not complete registration until the provisioning server is upgraded.

Line Parameter Provisioning Changes

If TS5.1 or earlier provisioning files contain changes to call progress tones or ring cadences, the MIB definitions must be changed in the provisioning files when upgrading to TS6.1. See the Touchstone Telephony Provisioning Guide for current MIB object definitions.

Action

Perform any of the following tasks as necessary. Task

Page

Upgrading the Firmware through Provisioning Upgrading the Firmware through SNMP Changing Configuration Files for Upgrades from TS4.2

Upgrading the Firmware through Provisioning

16 17 18

Follow these steps to upgrade the Touchstone firmware load using a provisioning server. 1 Install the new firmware, using the steps in ‘‘Installing the Firmware on a File Server’’ on page 13. 2 Use the provisioning server to add or verify the following items in the cable modem configuration file: • ManufacturerCVC (the CVC, needed only for secure downloading) • UpgradeFileName (file name of the firmware load)


17


• UpgradeServer (IP address of the server containing the load) • SnmpMib = docsDevSwAdminStatus.0 2 (allowProvisioningUpgrade) 3 During the maintenance window, use your provisioning server or element manager to reset each Touchstone eMTA. The eMTAs download the new firmware, then reset. Note:

See ‘‘Upgrading from Earlier NCS Loads to SIP Loads’’ on page 15 for information about upgrading from NCS to SIP. 4 Verify that the eMTA has the new load by checking the value of the docsDevSwOperStatus object (using an SNMP server). The value should read completeFromProvisioning(3).

Upgrading the Firmware through SNMP

Follow these steps to upgrade the Touchstone firmware load using an SNMP manager. See the Touchstone Telephony Feature Guide for information about the Touchstone Firmware Upgrade System. 1 Using the provisioning server, add the ManufacturerCVC to the configuration file. 2 Using the SNMP manager, set the following docsDevSoftware objects: • todocsDevSwServerAddressType—set 1 for IPv4 server addressing or 2 for IPv6 addressing. • docsDevSwServerAddress—IP address of the server containing the load Note:

If you are upgrading to TS6.1 from an earlier version, you must replace docsDevSwServer with docsDevSwServerAddress if you are upgrading to IPv6. If you are using IPv4 addressing, you can upgrade this MIB object or continue to use the object.

• docsDevSwFilename—file name of the load • docsDevSwAdminStatus—set to 1 (upgradeFromMgt) The eMTA downloads the new firmware, then resets.

Note:

See ‘‘Upgrading from Earlier NCS Loads to SIP Loads’’ on page 15 for information about upgrading from NCS to SIP. 3 Verify that the eMTA has the new load by checking the value of the docsDevSwOperStatus object.


18

Chapter 1

The value of the object should read completeFromMgt(3).

Changing Configuration Files for Upgrades from TS4.2

Follow these steps to update configuration files from TS4.2 or earlier versions. 1 For the following provisioning methods, replace the old arrisCmDevProvMethodIndicator object with the arrisMtaDevProvMethodIndicator object and set it to the appropriate value. • docsisOnly(0) • fullPacketCable(1) • packetCableMinusKDC(2) • gupi(4) • singleMAC(5) 2 For the following provisioning methods, set the old arrisCmDevProvMethodIndicator object to docsisOnly and set the arrisMtaDevProvMethodIndicator object to the appropriate value. • basic1(6) • basic2(7) • gupiEncryptedMtaConfig(8) Setting the arrisCmDevProvMethodIndicator object to docsisOnly ensures that any devices containing loads prior to TS4.3 can upgrade. Once the MTA has upgraded its firmware, it uses the provisioning method set by the arrisMtaDevProvMethodIndicator object.


2

Provisioning Modes You can provision Touchstone Telephony products using a variety of PacketCable-compliant and non-compliant tools.

Overview Typically, you provision the network using a PacketCable-compliant provisioning server. The server provides both provisioning tools to create data files, and servers (DHCP, DNS, TFTP) to store and transfer firmware loads and provisioning data to both the CMTS and all attached cable modems and MTAs. In some cases, the provisioning server may not be PacketCable-compliant but supports one or two MAC addresses per eMTA.

Provisioning Modes Touchstone firmware supports all PacketCable 1.5 provisioning modes. For backward compatibility, and compatibility with non-compliant provisioning servers, Touchstone firmware also supports a variety of propriety provisioning modes.

PacketCable Provisioning Modes

TS6.1 supports the standard PacketCable 1.5 provisioning modes: PacketCable SECURE (Full PacketCable) (default) This mode is also called ‘‘Full PacketCable.’’ The data and telephony components have unique IP addresses, MAC addresses, and configuration files (i.e. two of each per eMTA). When the eMTA registers, it makes two separate DHCP and TFTP requests.


20

Chapter 2

SNMP communication uses SNMPv3, sending an SNMPv3 INFORM. The MTA and provisioning system support Kerberos mutual authentication and Kerberized SNMPv3 messaging. IPsec is supported, and may be enabled or disabled using the pktcMtaDevCmsIpsecCtrl object (enabled by default). Media encryption (voice security) can be enabled on a per-call basis using NCS signaling (the LCO/SDP options) or disabled per MTA using a feature switch. The feature switch is stored in NVRAM. Note:

EURO (NCS-based) SECURE provisioning.

loads support

only

PacketCable

PacketCable HYBRID Similar to the ARRIS-proprietary ‘‘PacketCable without KDC’’ provisioning mode. HYBRID flows are identical to the SECURE flow but remove the Kerberos message exchange, and use SNMPv2c instead of SNMPv3.

There are two HYBRID flows, HYBRID.1 and HYBRID.2; the primary difference between the two is that HYBRID.2 uses the ‘‘provisioning complete’’ SNMP INFORM. IPsec is disabled. Media encryption can be controlled on a perMTA basis using a feature switch. PacketCable BASIC Similar to the ARRIS-proprietary BASIC provisioning modes. Simplified provisioning flows with no Kerberos or SNMPv3 security, and no SNMP enrollment using SNMP INFORM.

There are two BASIC flows, BASIC.1 and BASIC.2; the primary difference between the two is that BASIC.2 uses the ‘‘provisioning complete’’ SNMP INFORM. When using a PacketCable BASIC mode, the downloaded configuration file must contain the MIB object pktcMtaDevConfigHash. The MTA calculates the hash value of the provisioning file and verifies that the calculated hash and the hash value contained in the MIB object match. If they do not match, provisioning fails. This step is not required by ARRIS-proprietary BASIC modes.

ARRIS-proprietary Provisioning Modes

To improve compatibility with non-compliant equipment, ARRIS supports various provisioning modes for Touchstone eMTAs and firmware; each has multiple options to enable and disable PacketCable features. The supported provisioning modes are: PacketCable without KDC A PacketCable subset, using SNMPv1 or SNMPv2 (sending an SNMPv2 INFORM).


Provisioning Modes

21

IPsec is disabled. Media encryption can be controlled on a perMTA basis using a feature switch. Global Universal Provisioning Interface (GUPI) A PacketCable subset, intended to accommodate a wide range of partially-compliant equipment. SNMP communication uses SNMPv1 or SNMPv2, with INFORM disabled.

IPsec and media encryption are disabled. ARRIS Simplified PacketCable Provisioning (Basic.1) Similar to GUPI. SNMP communication uses SNMPv1 or SNMPv2, with enrollment and status INFORMs disabled. Basic.1 advertises itself to the provisioning server using DHCP Option 60. ARRIS Simplified PacketCable Provisioning (Basic.2) Similar to Basic.1, but sends the SNMP status INFORM to the provisioning server. GUPI MAC with TFTP Server Override Similar to GUPI, but provides the TFTP server address as an FQDN in the CM configuration file, instead of in the MTA DHCP Offer. The MTA DHCP Offer must contain a valid DNS server address to resolve the TFTP server’s FQDN.

The CM configuration file must set the arrisMtaDevTFTPServerAddrOverrideFQDN MIB object to the FQDN of the TFTP server. Single MAC/Single Configuration File For use with certain provisioning servers that support only one IP address, MAC address, and configuration file per eMTA. The eMTA makes one DHCP and TFTP request. SNMP communication uses SNMPv1 or SNMPv2, with INFORM disabled. The configuration file includes MTA provisioning parameters. IPsec and media encryption are disabled. DOCSIS Only A data-only mode (no telephony support). Uses a single IP address for the cable modem component, making a DHCP and TFTP request during registration.


22

SIP-only Provisioning Modes

Chapter 2

SIP loads support three extra provisioning modes.

CAUTION Ser vice-affecting The following provisioning methods are to be used only with SIP loads. Selecting those modes with NCS loads switches the provisioning mode to DOCSIS-only. Global Universal Provisioning Interface (GUPI) with MTA Configuration File Encryption Similar to GUPI with support for decrypting the encrypted MTA configuration file (patent pending). IPsec and media encryption are disabled. GUPI MAC MTA Similar to GUPI, intended for use with SIP loads. The MTA ignores the MTA configuration file name in the DHCP ACK message and requests a file name using the MTA MAC address with a .bin extension. An example of the requested file name would be 0000CA123456.bin GUPI Encrypted MAC MTA Identical to GUPI MAC MTA provisioning, with support for decrypting the encrypted provisioning file.


Provisioning Modes

23

Selecting a Provisioning Mode Touchstone hardware is PacketCable 1.5-compliant, and is designed to interoperate with a variety of partially-compliant equipment. Touchstone firmware provides a flexible method of selecting a provisioning mode.

Overview

During MTA registration, the MTA advertises the supported PacketCable version (1.5 or 1.0) and supported provisioning modes (BASIC, HYBRID, SECURE) in DHCP Option 60. The provisioning server responds with the selected PacketCable provisioning mode in DHCP Option 122 sub-option 6. You can add two MIB objects to the CM configuration file to control or override the normal provisioning flow: arrisMtaDevProvMethodIndicator (DPMI) Include this object in the CM configuration file to force selection of a specific provisioning mode (however, a value of 1 specifies PacketCable-compliant provisioning). The value of this object overrides the value of arrisCmDevProvMethodIndicator, a deprecated object that provided a similar function in earlier versions of Touchstone firmware. The following table shows supported values for the DPMI object:

Value

Description

0 1 2 4 5 6 7 8 9 10 11

DOCSIS-only provisioning PacketCable (see below) PacketCable minus KDC GUPI Single MAC/Single Configuration File Basic.1 Basic.2 GUPI with MTA configuration file encryption (SIP only) GUPI MAC MTA (SIP only) GUPI Encrypted MAC MTA (SIP only) GUPI MAC with TFTP Server Override

arrisMtaDevSpecialConfigurationOverrideEnable If this object is present in the CM configuration file with a value of 0x80000000, the MTA advertises SECURE, HYBRID, and BASIC support in option 60 of the DHCP DISCOVER; and selects SECURE, HYBRID, or an ARRIS BASIC provisioning mode depending on the contents of option 122 sub-option 6 of the DHCP OFFER.


24

Chapter 2

This has the following implications: • The DPMI value can affect both the advertised provisioning modes and the selected provisioning mode. • Touchstone MTAs advertise PacketCable 1.5 compliance only if the CM configuration file omits both the arrisMtaDevProvMethodIndicator and the arrisMtaDevSpecialConfigurationOverrideEnable objects. If either object is included, the MTA advertises PacketCable 1.0 compliance. • Even if the MTA advertises PacketCable 1.0 compliance, it may be directed to use a PacketCable 1.5 provisioning mode. This will be successful unless the DPMI value overrides the provisioning server. • There is no way to force the MTA to select a HYBRID provisioning mode through the CM configuration file.

Provisioning Selection Flowchart

The selection works as shown in the flowchart below.

Results

The arrisMtaDevPacketcableProvisioningFlow object contains the selected provisioning mode: Value

Description

0 1 2 3 4 5

PacketCable SECURE PacketCable HYBRID.2 PacketCable HYBRID.1 PacketCable BASIC.2 PacketCable BASIC.1 ARRIS-proprietary mode


Provisioning Modes

25

Star tMTA Provisioning

CM config file contains OverrideEnable set to ’enabled’? (see Note 1)

NO

ARRIS Device Provisioning Method Indicator (DPMI) in config file? (see Note 2)

NO

MTAadver tises PacketCable 1.5 with BASIC, HYBRID,and SECURE flows in DHCP Option 60

Y E S

MTAadver tises PacketCable 1.0 with BASIC flows in DHCP Option 60

YES

Is the DMPI value 6or7 (BASIC.1 or BASIC.2)?

YES

Y E S

ARRIS Device Provisioning Method Indicator (DPMI) in config file? (see Note 2)

N O

N O

DHCP Option 122 Subopt. 6 ’BASIC’ or ’HYBRID’ in MTADHCP OFFER?

PacketCable 1.5 BASIC or HYBRID provisioning

YES

N O

MTAadver tises PacketCable 1.0 with BASIC, HYBRID,and SECURE flows in DHCP Option 60

DHCP Option 122 Subopt. 6 a valid REALM name in MTADHCP OFFER? NO

Is the DPMI value 1, 6, or 7 (BASIC or Full PacketCable)?

NO

r e h t o

Y E S

BASIC

DHCP fails to validate REALM name – provisioning attempt fails

Y E S

Value of DHCP Option 122 Suboption 6 in MTADHCP OFFER?

H Y B R I D

ARRIS proprietar y provisioning

ARRIS BASIC.1 or BASIC.2 provisioning

PacketCable 1.5 HYBRID provisioning

PacketCable 1.5 SECURE provisioning

Retry DHCP

Note 1: arrisMtaDevSpecialConfigurationOverrideEnable object is ignored if included in the MTAconfiguration file Note 2: arrisMtaDevProvMethodIndicator.0 object Example 1: Pktc 1.005210101000201020901010e090305060708090a0e0c0c01000d010110010912020007 Example 2: Pktc 1.005210101000201020901010e090305060708090a0e0c0c01000d010110010912020004

Provisioning Event Sequences The following diagrams show the normal sequence of events required when a PacketCable compliant eMTA registers on the cable data network. The dark shaded areas are the events omitted when using each provisioning scheme.


26

PacketCable Sequence

Chapter 2

The following diagram shows the full PacketCable event sequence. All events are included.


Provisioning Modes

PacketCable (no KDC)/HYBRID Sequence

27

The following diagram shows the PacketCable (no KDC) and PacketCable HYBRID event sequence. This sequence skips several events in the MTA provisioning; the shaded steps below are skipped.


28

GUPI (including variants)/Basic.1 Sequence

Chapter 2

The following diagram shows the sequence for: • GUPI • Basic.1 and PacketCable BASIC.1 • GUPI with MTA configuration file encryption (SIP only) • GUPI MAC MTA (SIP only) • GUPI Encrypted MAC MTA (SIP only) • GUPI MAC MTA with TFTP Server Override This sequence skips several steps in the MTA provisioning.

Note:

PacketCable BASIC.1 requires that the MTA provisioning file contain the pktcMtaDevConfigHash object, with a value equal to the hash of the provisioning file. The MTA calculates the hash and compares it to the value of this object; if the values do not match, provisioning fails. ARRIS BASIC.1 does not perform this check.


Provisioning Modes

Basic.2 Sequence

29

The following diagram shows the Basic.2 and PacketCable BASIC.2 event sequence. This sequence is identical to GUPI and Basic.1, but does not skip the last step in the MTA provisioning.

Note:

PacketCable BASIC.2 requires that the MTA provisioning file contain the pktcMtaDevConfigHash object, with a value equal to the hash of the provisioning file. The MTA calculates the hash and compares it to the value of this object; if the values do not match, provisioning fails. ARRIS BASIC.2 does not perform this check.


30

Chapter 2

Single MAC/Config File Sequence

The following diagram shows the event sequence for single MAC/config file provisioning.

Setting Up the Provisioning Server Data

Set up the provisioning data as follows to use a non-PacketCable compliant provisioning server: • The MTA DHCP offer may not use DNS (option 6), SNMP, or security (Kerberos or Ticket Granting). • The FQDN must be in IPv4 format (i.e. an IP address such as 10.1.2.3 rather than a domain name such as tt4.example.net). Note 1:

DNS is not supported for FQDN when using GUPI or singleMAC/config file provisioning.

Note 2:

All PacketCable provisioning modes, and ARRIS Basic.1 and Basic.2 modes, require a PacketCable-compliant provisioning server.

Verifying MTA Provisioning and Endpoint Status

The MIB object pktcMtaDevProvisioningState indicates the status of the MTA initialization process. The MIB object pktcNcsEndPntStatusError indicates whether the endpoint has successfully registered with the call server.


Provisioning Modes

31

DHCP Support by Provisioning Mode The following sections list DHCP parameters used by each provisioning mode.

Options Required in All Provisioning Modes

The following DHCP options are required in all CM and MTA offers. The eMTA cannot function without a subnet mask and at least one router, DNS server, and Syslog server. Option

Description

1 3 6 7

Subnet mask IP address of the gateway router (one or more) IP address of the DNS servers (one or more) IP address of the log servers (one or more)

Note:

In addition to the required options listed above, ARRIS strongly recommends including option 4 (IP address of the ToD server) in all CM and MTA offers.

PacketCable Modes

These options are valid for Full PacketCable and PacketCable minus KDC provisioning modes. Note that options 122 and 177 are mutually exclusive (specify one or the other, not both). CM DHCP Option 4: ToD Server IP Address CM DHCP Option 122 (DOCSIS 1.1/2.0 loads only): • SubOption 1: Service Provider’s Primary DHCP (required) • SubOption 2: Service Provider’s Secondary DHCP (optional) MTA DHCP Option 122 (DOCSIS 1.1/2.0 loads only): • SubOption 3: Service Provider’s SNMP Entity (required) • SubOption 4: AS REQ/REP Exchange Backoff and Retry for SNMPv3 Key Management (optional) • SubOption 5: AP REQ/REP Exchange Backoff and Retry for SNMPv3 Key Management (optional) • SubOption 6: Kerberos Realm (FQDN) (Full PacketCable, Basic.1, Basic.2: required; GUPI, PacketCable Minus KDC: optional) • SubOption 7: Authorization method (TGT for MTA) (optional) • SubOption 8: Provisioning Timer (minutes) (optional)


32

Chapter 2

• SubOption 9: Security Ticket Invalidation (optional) Note:

By default, the eMTA performs a ‘‘reinit’’ when it receives an SNMP Entity (sub-option 3) that differs from the original entity IP address. The arrisMtaDevDhcpOptionOverride MIB object allows you to provision the eMTA to accept a changed SNMP entity. This may be necessary for operation with certain DHCP servers that re-assign S NMP entities for load-balancing. See ‘‘Provisioning DHCP Options’’ on page 134 for details. CM DHCP Option 177: • SubOption 1: Service Provider’s Primary DHCP (required) • SubOption 2: Service Provider’s Secondary DHCP (optional) MTA DHCP Option 177: • SubOption 3: Service Provider’s SNMP Entity (required) • SubOption 4: Service Provider Network Primary DNS • SubOption 5: Service Provider Network Secondary DNS • SubOption 6: Kerberos Realm (FQDN) • SubOption 7: Authorization method (TGT for MTA) • SubOption 8: Provisioning Timer (minutes)

Note:

An ARRIS MTA provisioned using PacketCable minus KDC ignores any security parameters included in the DHCP OFFER/ACK (option 122 sub-options 4, 5, 6, 7 or option 177 sub-options 6, 7, 8) as well as security parameters included in the configuration file.

GUPI Mode

GUPI mode uses separate CM and MTA offers. CM DHCP Option 122 (DOCSIS 1.1/2.0 loads only) or 177: • SubOption 1: Service Provider’s Primary DHCP (required) • SubOption 2: Service Provider’s Secondary DHCP (optional) • SubOption 6: Kerberos Realm (FQDN) (ignored) MTA DHCP Option 122 or 177: ignored MTA offer: MTA FQDN is configured in the MTA DHCP offer (Options 12 and 15). SubOption 3 must contain the Service Provider’s SNMP Entity. DNS is optional. Note:

An ARRIS MTA provisioned using GUPI ignores any security parameters which are included in the DHCP OFFER/ACK (option 122 sub-options 4, 5, 6, 7 or option 177 sub-options 6, 7, 8) as well as security parameters included in the configuration file.


Provisioning Modes

ARRIS Modified Version of Simplified PacketCable Provisioning (Basic.1 and Basic.2)

33

Basic.1 and Basic.2 use separate CM and MTA offers. CM DHCP Option 122 or 177: • SubOption 1: Service Provider’s Primary DHCP (required) • SubOption 2: Service Provider’s Secondary DHCP (optional) MTA DHCP Option 122 or 177: • SubOption 3: Service Provider’s SNMP Entity (required) • SubOption 6: Kerberos Realm (FQDN) (required; realm name is either BASIC.1 or BASIC.2) MTA offer: MTA FQDN is configured in the MTA DHCP offer (Options 12 and 15). DNS is required. Note:

Single MAC/Config File Mode

Security parameters are required in the configuration file.

One offer requested and made. MTA FQDN is configured in the DHCP Offer (options 12 or 15). DNS is optional. The address is supplied in the standard DHCP option (option 6). Note:

An ARRIS MTA provisioned using Single MAC/Config file ignores any security parameters which are included in the DHCP OFFER/ACK (option 122 sub-options 4, 5, 6, 7 or option 177 sub-options 6, 7, 8) as well as security parameters included in the configuration file.

DOCSIS Only Mode

One offer requested and made.

DHCP Option 43 Support

TS6.1 sends DHCP option 43 (Vendor-Specific Information) in CM DHCP Discover messages (except for Basic.1 and Basic.2 which send this option in MTA Request and Discover messages), with the following sub-options:

The DHCP options should not contain MTA option 122 or option 177 suboptions 1 and 2 (MTA primary and secondary DHCP server addresses).

Sub-option

Name

Value

2 3 4

Device type eSAFE type Serial number

‘‘ECM’’ ‘‘ECM:EMTA’’ Varies (e.g. ‘‘20034512K203RP’’)

5 6 7 8

HW Version SW Version Boot ROM Vendor ID

Hardware version of modem (e.g. ‘‘04’’) Firmware version (e.g. ‘‘5.2.37’’) Boot ROM version (e.g. ‘‘4.02’’) ‘‘0000CA’’


34

Chapter 2

Sub-option

Name

Value

9 10

Model Number Vendor Name

eMTA model number (e.g. ‘‘TM602G’’) ‘‘ARRIS Interactive, L.L.C.’’

In addition, Euro-DOCSIS modems send the following sub-options: Sub-option

Name

Value

200

Vendor Name

‘‘ARRIS Interactive, L.L.C.’’

201 202

Modem Type SW Version

203

HW Version

eMTA model number (e.g. ‘‘TM602H’’) Firmware version and build (e.g. ‘‘TS.05.00.111506’’) Hardware version of modem


TS6.1 uses DHCP option 60 (Vendor Class Identifier) in DHCP Discover messages to specify the DOCSIS support required. The option contains the string ‘‘docsis 2.0’’ to indicate DOCSIS 2.0 support.


DHCP option 51, described in RFC 2132, allows a client device to request a particular lease time for its IP address. The option contains a 32-bit number specifying the requested lease time in seconds. By default, Touchstone firmware sends DHCP option 51 in DHCP Request messages during IP address renew and rebind operations. Under certain circumstances, some DHCP servers may interpret an eMTA Renew request containing DHCP option 51 as a lease extension request and returns only the remaining lease time. The arrisCmDhcpOption51Override MIB object allows you to exclude option 51 in DHCP requests for CM, MTA, or both components. The allowed values for this object are: Value off(1) onCm(2) onMta(3) onCmAndMta(4)

Description

(default) Both the CM and MTA components send option 51. Only the MTA component sends option 51. Only the CM component sends option 51. Neither the CM nor MTA component sends option 51.

An alternative method to disabling option 51 transmission is to configure the DHCP server’s ‘‘lease override’’ parameter. See the documentation or support for your DHCP server for details.


Provisioning Modes

35

Provisioning Considerations for European Loads Provisioning changes are necessary to transition from a Touchstone North American load to the EURO load. The basic flow sequence remains the same; however, some OIDs change from the North American PacketCable MIBs to the IETF PacketCable MIBs. The objects that require OID changes are highlighted below. Note:

Flow MTA15: SNMP Enrollment INFORM

EURO (NCS-based) loads support only Full PacketCable provisioning.

pktcMtaDevProvisioningEnrollment and its contents:

• sysDescr (remains the same) • pktcMtaDevSwCurrentVers • pktcMtaDevTypeIdentifier • ifPhysAddress (previously pktcMtaDevMacAddress) • pktcMtaDevCorrelationId

Flow MTA19: SNMPv3 SET

• pktcMtaDevConfigFile • pktcMtaDevProvConfigHash • pktcMtaDevProvConfigKey

Flow MTA23: TFTP Configuration File Request

North American PacketCable configuration files must be updated to use Euro-PacketCable OIDs.

Flow MTA25: SNMP INFORM

pktcMtaDevProvisioningStatus and its contents:

• pktcMtaDevConfigFile • pktcMtaDevProvConfigHash • pktcMtaDevProvConfigKey


36

Chapter 2

Provisioning Considerations for SIP Loads The information in this section is needed for provisioning Touchstone eMTAs with SIP loads.

SIP Registration Behavior

All SIP Touchstone firmware loads use the same algorithm for normal registration and re-registration: • Registration begins after a randomized wait time between 1 and (MaxWaitDelay) seconds. • After registration, the MTA attempts to re-register after a random time between 50% and 75% of the expiration time. • If registration is unsuccessful (for example, the MTA receives no response or a 401 response), the MTA retries registration at intervals specified by RFC 3261. Two SIP MIB objects, sipCfgRegTimerMin and sipCfgRegTimerMax, customize the back-off time for unsuccessful registration attempts. The MTA uses the following formula to calculate the delay: time = min( TimerMax, (TimerMin × 2ˆ(#failures-1)) ) The default values are 60 and 1800 seconds, and can be changed by specifying new values in the MTA configuration file.

SIP Feature Switch

The SIP feature switch sipCfgSipFeatureSwitch enables features that may be required for operation with certain SIP endpoints and proxies. See ‘‘SIP Feature Switch’’ on page 71 for details about the SIP feature switch.

Information Required for SIP

The SIP load requires three pieces of information to function properly: Outbound Proxy The destination device for all outbound messages. The setting is used as the domain in the Request-URI for all outgoing INVITE messages. The eMTA supports a ‘‘global’’ proxy that applies to all lines, and a per-line proxy that applies to a single line. See ‘‘Configuring Per-Line Proxy and Registrar’’ on page 123 for details. Registrar Registration messages are sent to the outbound proxy’s IP address, but the Request-URI address is provisioned as the registrar address. This setting may or may not be the same as the outbound proxy setting. The eMTA supports a ‘‘global’’ registrar that applies to all lines, and a per-line registrar that applies to a single line. See


Provisioning Modes

37

‘‘Configuring Per-Line Proxy and Registrar’’ on page 123 for details. Domain Settings The domain is set as part of the DHCP process of the Telephony Modem using DHCP Option 15. This domain is used in all to and from URIs that the Telephony Modem generates.

The following are examples of REGISTER and INVITE messages with the following provisioning when bit 0x04000000 of the SIP Feature Switch is not set (bit value = 0): Domain

arris-i.org

sipCfgProxyAdr

ser.arris-i.org;5060

sipCfgRegistrarAdr

registrar.arris-i.org;5060

User-id (phone #)

7705552001

Called Number

7705552002

REGISTER sip:registrar.arris-i.org:5060 SIP/2.0 From: "SIP1 Line1"; tag=94b73228-a013d16-13c4-20-21829ddd-20 To: "SIP1 Line1" Call-ID: 94b6e3b0-a013d16-13c4-20-22ce4f5-20 CSeq: 1 REGISTER Via: SIP/2.0/UDP 10.1.61.22:5060;branch=z9hG4bK-20-7ed6-6787cc6b Allow: INVITE,ACK,BYE,CANCEL,NOTIFY Max-Forwards: 70 Contact: "SIP1 Line1" Content-Length: 0 INVITE sip:[email protected]:5060 SIP/2.0 From: "SIP1 Line1"; tag=94b73808-a013d16-13c4-62-4e4a1883-62 To: Call-ID: [email protected] CSeq: 1 INVITE Via: SIP/2.0/UDP 10.1.61.22:5060;branch=z9hG4bK-62-180b5-631cc050 Allow: INVITE,ACK,BYE,CANCEL,NOTIFY Max-Forwards: 70 Contact: Content-Type: application/SDP Content-Length: 168

Here are examples of REGISTER and INVITE with IP address-based provisioning with bit 0x04000000 set (bit value = 1):


38

Chapter 2

Domain

arris-i.org

sipCfgProxyAdr

10.1.63.10;5060

sipCfgRegistrarAdr

10.1.63.11;5060

sipCfgSipFeatureSwitch

0x04000000

User-id (phone #)

7705552001

Called Number

7705552002

REGISTER sip:10.1.63.11:5060 SIP/2.0 From: "SIP1 Line1"; tag=94b73228-a013d16-13c4-20-21829ddd-20 To: "SIP1 Line1" Call-ID: 94b6e3b0-a013d16-13c4-20-22ce4f5-20 CSeq: 1 REGISTER Via: SIP/2.0/UDP 10.1.61.22:5060;branch=z9hG4bK-20-7ed6-6787cc6b Allow: INVITE,ACK,BYE,CANCEL,NOTIFY Max-Forwards: 70 Contact: "SIP1 Line1" Content-Length: 0 INVITE sip:[email protected]:5060 SIP/2.0 From: "SIP1 Line1"; tag=94b73808-a013d16-13c4-62-4e4a1883-62 To: Call-ID: [email protected] CSeq: 1 INVITE Via: SIP/2.0/UDP 10.1.61.22:5060;branch=z9hG4bK-62-180b5-631cc050 Allow: INVITE,ACK,BYE,CANCEL,NOTIFY Max-Forwards: 70 Contact: Content-Type: application/SDP Content-Length: 168


3

Provisioning

You can provision Touchstone Telephony products using the information and procedures outlined in this chapter.

Overview Typically, you provision the network using a PacketCable-compliant provisioning server. The server provides both provisioning tools to create data files, and servers (DHCP, DNS, TFTP) to store and transfer firmware loads and provisioning data to both the CMTS and all attached cable modems and MTAs. In some cases, the provisioning server may not be PacketCable-compliant but supports one or two MAC addresses per eMTA.

Provisioning Management Features This section discusses management features that are generally configured by provisioning. See the Touchstone Telephony Management Guide for features designed to be controlled while the eMTA is in service.

Backoff and Retry Mechanism Support

ARRIS employs the registration and back-off mechanisms as specified by the PacketCable™ MTA Device Provisioning Specification, PKT-SP-PROVC01-071129. This specification is available through the CableLabs® PacketCable website 〈http://www.packetcable.com〉. See this specification for details on specified registration throttling and associated back-off mechanisms.


40

About IPsec

Chapter 3

IPsec (Internet Protocol Security) is a collection of Internet standards used to encrypt and authenticate IP packets, to provide message integrity and privacy. IPsec provides security at the network layer (all TCP and UDP packets, and layers above). IPsec is controlled by setting the pktcMtaDevCmsIpsecCtrl object for each CMS that the MTA can communicate with; you can include this object in the MTA configuration file. The object is indexed by the CMS FQDN. Set the object to true(1) to enable IPsec between the MTA and a particular CMS, and false(2) to disable it. Note:

Service Interruptions during Firmware Upgrades

Touchstone eMTAs use only the IPsec ESP transport mode.

ARRIS eMTA devices are compliant with the relevant DOCSIS and PacketCable specifications related to firmware downloading. However, there are two major parts to a firmware upgrade process. The first part is the server communication and firmware image download; the second part is the actual firmware upgrade. During the server communication and firmware image file download, there is no interruption to eMTA operation. During this phase of the procedure, all operation continues normally. However, per the DOCSIS and PacketCable specifications, once the image is downloaded into the eMTA, the device must automatically reset to copy the new image into the active flash memory and apply the functionality of the new image. By completing the non-service affecting image download process before invoking the mandatory reset, the Touchstone eMTA minimizes service interruptions as a result of a firmware upgrade. To further minimize service interruptions, TS4.5 MSUP2 and newer versions of Touchstone firmware can reject firmware download requests when a line is in the active state. TS5.3 and later versions use a two-stage download and application process to apply upgrades when all lines are idle. See ‘‘Minimizing Firmware Download Service Impacts’’ on page 9 for details.

Call Management Servers

Touchstone firmware accepts up to 64 call management server IP addresses identified in the MTA configuration file. Each call server DNS entry can have up to six IP addresses associated with it, so assigning multiple IP addresses to a CMS reduces the total number of unique servers that can be listed. Support for multiple CMSs allows for load balancing, where an MTA can be redirected to use a CMS with a lighter load. When IPsec is activated, Touchstone eMTAs store up to 10 security associations, limiting the number of CMSs that it can communicate with at any given time. However, by setting the ‘‘CMS Redirect’’ bit (0x00400000) in the CallP Feature Switch (see ‘‘CallP Feature Switch’’ on page 52), and by listing up to 9 CMSs in the configuration file, the Telephony Modem can bypass the 10-CMS limit, and support redirection to any other CMS on the customer network.


Provisioning

41

See the Touchstone Telephony Feature Guide for more details.

Configuration File Recovery

eMTAs using the DOCSIS-only provisioning mode with TS6.1 allow configuration file upgrades to override the provisioned load with the current load. After four attempts (an attempt is defined as a T4 timeout or reboot) to download the new load, the eMTA reverts to trying the current load instead of the new load. This prevents the eMTA from remaining out of service when a bad load is specified in the configuration file. The new mechanism also gives priority to SNMP downloads that are started manually. In previous firmware versions, previous download attempts could interfere with manual attempts.

Provisioning CM and MTA Features You can provision the following cable modem and MTA features using a configuration file or SNMP management tool.

Full DQoS Mode

Touchstone firmware defaults to Dynamic Quality of Service (DQoS) provisioning. Full DQoS simplifies provisioning tasks by requiring only that the primary Best Effort (BE) and MGCP (signaling) flows be provisioned. The firmware dynamically sets up and tears down UGS service flows, using a standard set of parameters designed for efficient use in DOCSIS-based networks, as needed. The CMS controls the bandwidth authorization as specified in the PacketCable DQoS specifications. Full DQoS provides an added layer of security by authenticating eMTAs that contact it during call setup. Each session is authorized; the session authorization uses a handle (the Gate ID) assigned by the CMTS, passed to the CMS, and sent to the MTA using an NCS message, to match requests with authorizations. Upon receiving call-signaling information, the MTA passes the Gate-ID to the CMTS in a DSA/DSC message.

DSX QoS Mode

Touchstone firmware supports an ARRIS-proprietary feature that implements QoS using UGS flows for voice transmission using DOCSIS 1.1 DSx messaging. This functionality provides a level of QoS in a network where the CMS and CMTS do not support the PacketCable Full DQoS model. DSx QoS functionality can be activated using a feature switch. vated, the firmware sends the appropriate DSx messages Add/Modify/Delete the UGS service flows. DSx messages between the CMTS and the eMTA, and do not involve the CMS dation or requests for setting up or monitoring the UGS flows.

When actineeded to flow only in any vali-


42

Chapter 3

Note:

When using this functionality with the ARRIS C4 CMTS, PacketCable authorization needs to be disabled. Contact your next level of support for instructions.

Multi-Line Considerations

The TM508 and TM512 multi-line Telephony Modems require ‘‘MODEL_5_ML’’ loads. The TM608 Telephony modem requires ‘‘MODEL_6_ML’’ loads. All multi-line Telephony Modems require provisioning of extra lines. See ‘‘Interface Index Scheme’’ below for the default ifIndex range.

Voice and Signaling Ports

TS6.1 firmware uses a random selection of ports in the range 49152 through 65535 for RTP- and RTCP-based voice communications. The port numbers cannot be modified or used for other purposes. By default, the MTA uses port 2727 on the upstream, and port 2427 on the downstream, to send and receive signaling information. You can change the default port number in the MTA configuration file. You can also change the transmit port by sending an NCS message from the call server once the MTA is operating. See the Touchstone Telephony Troubleshooting Guide for details.

Interface Index Scheme

Touchstone firmware generally conforms to the eDOCSIS specification, CMSP-eDOCSIS-I13-070803, for ifIndex designations. The following table lists the specified defaults. Interface

Type

1 2 3 4 5–15 16 17 18 19–31 32 +

Primary CPE interface (Ethernet) CATV MAC interface RF downstream channel RF upstream channel Other CPE interfaces (telephony, USB) PacketCable eMTA Reserved for eSTB-IP26 Reserved for eSTB-DSG27 Reserved for other eDOCSIS interfaces Other CPE interfaces

Telephony interfaces begin with ifIndex 9. Note that multi-line products (TM508 and TM512) conflict with the eDOCSIS specification, since the index range for telephony interfaces on these products is 9 to 20 (TM512) or 9 to 16 (TM508).


Provisioning

43

Interface Types

The IANAifType textual convention defines the interface types associated with entries in the ifTable. Interface types used in Touchstone products include: ifType

6 127 MAC layer 128 129 160 198

CODECs and Packetization Rates Supported

Description

Ethernet DOCSIS cable DOCSIS cable downstream DOCSIS cable upstream USB MTA telephony line (Voice over Cable)

In addition to continued support for the G.711 CODEC, Touchstone firmware supports the following PacketCable™ optional and recommended CODECs: • G.728 • G.729, G.729B, G.729AB, G.729E • G.726-16, G.726-24, G.726-32, G.726-40 • telephone-event (RFC 2833 DTMF relay) Touchstone NCS firmware loads choose a CODEC based on the negotiated CODEC list received from the call agent. The G.711 CODEC is the default, unless the CMS directs the eMTA to negotiate a different CODEC with other MTAs. Call agents offering G.729 should also offer ‘‘telephone-event’’ so the eMTA can successfully transmit DTMF tones when using a compressed voice CODEC. Touchstone SIP firmware loads offer CODECs based on the contents of the sipCfgProvisionedCodecArray MIB object. If you choose to offer G.729 in this array, you should also offer DTMF relay as compressed CODECs can distort DTMF tones sent through the network. The following is an example array string: G729;telephone-event

This CODEC array would set G.729 as the default with DTMF relay enabled. While ‘‘PCMU’’ or ‘‘PCMA’’ are not specified, the SIP firmware automatically switches to the G.711 CODEC when needed for fax or modem calls, based on the value of the sipCfgDefaultG711 object. Implementation of CODECs is defined by the PacketCable Audio/Video Codes Specification, PKT-SP-CODEC-C01-071129.


44

Chapter 3

The supported packetization rates in TS6.1 are 10 and 20 ms.

G.729 CODEC Support

The Touchstone Telephony Modem supports the G.729 CODEC to perform toll-quality voice compression such as G.729. The G.729 CODEC is defined in ITU-T Rec. G.729 Annex A, Reduced Complexity 8 kbit/s CS-ACELP Speech Codec, November 1996, and can compress voice as low as 8 kb/s. Sometimes the G.729 CODEC is referred to as G.729A, since other variations such as G.729E have been subsequently defined.

G.729 CODEC Negotiation

By IANA definition and PacketCable specification, compliant Call Agents use ‘‘G729’’ in the NCS Local Connection Options (LCO) to instruct an endpoint to use the G.729 CODEC. Touchstone firmware also supports ‘‘G729A’’ since some Call Agents use this syntax. IANA also defines a static payload type of 18 for G.729, which is used by default unless negotiated to use a different dynamic payload type in the allowed range of 96 through 127. The following is an example Create Connection (CRCX) command issued by a Call Agent, instructing the endpoint to use the G.729 CODEC: CRCX 1001 aaln/[email protected] MGCP 1.0 NCS 1.0 C: 28963 L: mp:20, a:G729 M: inactive

The endpoint responds to this message and provides its Local Connection Descriptor indicating the use of G.729: 200 1001 OK I: 7A438 v=0 o=- 54445402 54445402 IN IP4 10.1.36.216 s=c=IN IP4 10.1.36.216 t=0 0 m=audio 51538 RTP/AVP 18 b=AS:24 a=mptime:20 a=rtpmap:18 G729/8000/1 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 101 a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=rtpmap:101 telephone-event/8000/1 a=cpar: a=fmtp:101 0-15,144,149,159


Provisioning

45

a=cdsc: a=cpar: a=cpar: a=cpar: a=cpar:

11 image udptl t38 a=T38FaxVersion:0 a=T38FaxRateManagement:transferredTCF a=T38FaxMaxDatagram:160 a=T38FaxUdpEC:t38UDPRedundancy

The Call Agent may also specify a backup CODEC in a CRCX such as the following: CRCX 1001 aaln/[email protected] MGCP 1.0 NCS 1.0 C: 28963 L: mp:20;20, a:G729;PCMU M: inactive

The endpoint responds accordingly: 200 1001 OK I: 7A438 v=0 o=- 54445402 54445402 IN IP4 10.1.36.216 s=c=IN IP4 10.1.36.216 t=0 0 m=audio 51538 RTP/AVP 18 0 b=AS:24 a=mptime:20 a=rtpmap:18 G729/8000/1 a=rtpmap:0 PCMU/8000/1 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 101 a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=rtpmap:101 telephone-event/8000/1 a=cpar: a=fmtp:101 0-15,144,149,159 a=cdsc: 11 image udptl t38 a=cpar: a=T38FaxVersion:0 a=cpar: a=T38FaxRateManagement:transferredTCF a=cpar: a=T38FaxMaxDatagram:160 a=cpar: a=T38FaxUdpEC:t38UDPRedundancy

In this example, the endpoint can autonomously fall back to PCMU if necessary.


46

Chapter 3

G.729 Fax and Modem Support

Since the G.729 CODEC highly compresses audio, it can not adequately support analog fax or modem transmission. Depending upon the call setup, the endpoint responds as follows when local fax or modem tones are detected: • If a fax tone is detected, T.38 Fax Relay is allowed by the Call Agent, and the use of T.38 is negotiated between endpoints, then a T.38 Start event is generated and the fax is transmitted using T.38 Fax Relay. • Otherwise, if either PCMU or PCMA is allowed by the Call Agent and negotiated with the far end as a backup CODEC, the endpoint automatically switches to PCMU or PCMA respectively. • Otherwise, the endpoint simply notifies the fax or modem detection event to the Call Agent, if specifically requested to do so. Then, the Call Agent can modify the connection to use either PCMU or PCMA. Using PCMU or PCMA as a backup CODEC to G.729 provides the following advantages: • Upon detection of fax or modem tones, the endpoint can quickly switch to PCMU or PCMA without waiting for specific instructions from the Call Agent to do so. This helps to prevent fax or modem failure which may occur if the endpoint has to wait too long for instructions to switch to PCMU or PCMA. • When PCMU or PCMA is negotiated as a backup CODEC, and DQoS is in use, the CMTS reserves bandwidth between the Telephony Modem and CMTS when the call is initially set up. If the Telephony Modem needs to switch to PCMA or PCMU the necessary bandwidth is already reserved.

G.729 Bandwidth Considerations

There is one disadvantage to specifying PCMA or PCMU as a backup CODEC: when DQoS is in use, the CMTS always reserves enough bandwidth for PCMA or PCMU even when G.729 is being used. This extra bandwidth is wasted during normal voice calls, but may be used for Best Effort data traffic. Note:

When only G.729 is allowed (i.e. PCMU and PCMA are not allowed as a backup CODEC), the CMTS reserves only the bandwidth needed to carry the call. However, there is no guarantee that extra bandwidth would be available if a switch to PCMU or PCMA became necessary, which would result in a failed fax or modem call.


Provisioning

CODECs and Supported Lines (Model 6 and later)

47

This section describes how low bit-rate CODECs and T.38/SuperG3 FAX relay interact for Model 6 and later Telephony Modems.

TM602 Engineering Rules

The following rules apply to the TM602: • Two instances of T.38/SuperG3 fax relay total for lines 1-2; T.38/SG3 can be supported on any line • One instance of low bit-rate (LBR) CODEC for lines 1-2; low bit-rate CODECs can be supported on any line The following table shows CODEC support for each line and call leg. Line

1

Leg

2

1

T.38/SG3 LBR G.711 T.38/SG3

2

1

2

G.711 G.711

T.38/SG3 LBR G.711 LBR

G.711 G.711 G.711

TM604 and TM608 Lines 1–4

The following rules apply to the TM604 and lines 1 through 4 of the TM608. • One instance of T.38/SuperG3 fax relay total for lines 1–4; T.38/SG3 can be supported on any line • One instance of Low Bit Rate code (LBR) for lines 1–4; LBR codec can be supported on any line The following table shows CODEC support for each line and call leg. Line Leg

1 1

2 2

T.38/SG3

1

G.711

3

4

2

1

2

1

2

G.711

G.711

G.711

G.711

G.711

G.711

G.711

G.711

G.711

G.711

G.711

T.38/SG3

G.711

G.711

G.711

G.711

LBR

G.711

G.711

G.711

G.711

G.711

G.711

G.711

G.711

G.711

LBR

G.711

TM608 Lines 5–8

The following rules apply to lines 5 through 8 of the TM608. • T.38 fax relay can be supported on each line for lines 5-8


48

Chapter 3

• One instance of Low bit rate codec (LBR) can be supported on each line for lines 5-8; The following table shows CODEC support for each line and call leg. Line

5

Leg

1

6 2

T.38

CODECs and Supported Lines (Model 5 and earlier)

1

7 2

T.38

1

8 2

T.38

1

2

T.38

G.711

G.711

G.711

G.711

G.711

G.711

G.711

G.711

LBR

G.711

LBR

G.711

LBR

G.711

LBR

G.711

LBR

G.711

G.711

G.711

T.38

LBR

G.711

When the MTA uses compressed (non-G.711) CODECs, the maximum number of compressed calls per MTA allowed depends on the number of lines supported by the MTA: Number of lines

Compressed calls allowed

1 or 2 4

2 4

8 12

8 12

For this restriction, a three-way call counts as two calls.

Dial Pulse Support

Dial pulse support may be required to support subscriber equipment such as older rotary phones or alarm systems. Touchstone firmware provides two methods of dial pulse support: • Gateway (IPDT) dial pulse—Touchstone MTAs detect dial pulses and relay the information to the network as DTMF tones. • Softswitch (CMS) dial pulse—Touchstone MTAs relay dial pulses to the CMS. The support method used depends on the network configuration, and is selected by setting the ARRIS-proprietary arrisMtaDevEndPntDialingMethod MIB as follows:


Provisioning

49

Value

Method

Description

1 2

Tone Pulse

(default) Enables DTMF detection only. Enables pulse dialing detection (CMS dial pulse).

3

Tone & Pulse

4

Pulse with DTMF Relay

5

Tone & Pulse with DTMF Relay

Enables both DTMF and pulse dialing detection (CMS dial pulse). Enables pulse dialing detection with DTMF in-band relay (patent pending) enabled (gateway dial pulse). Enables both DTMF and pulse dialing detection with DTMF in-band relay enabled (gateway dial pulse).

Note:

The arrisMtaDevEndPntDialingMethod MIB replaces the ppCfgPor tDialingMethod MIB, which has been deprecated. In TS4.2 and earlier firmware versions, a value of 2 enabled both DTMF and pulse dialing. When upgrading, check configuration files and change this object as needed. See ‘‘Configuring Dial Pulse Support’’ on page 101 for more information.

European Productization Support

The .EURO load provides support for Euro-PacketCable compliance. The EURO load adds the following functionality: • Configurable power ring frequency using the pktcSigPowerRingFrequency MIB. • Supports different methods of on-hook caller ID using the pktcSigDevCIDMode MIB. • Configurable visual message waiting indicator using the pktcSigDevVmwiMode MIB. • Configurable hook flash timing using the pktcNcsEndPntConfigMinHookFlash and the pktcNcsEndPntConfigMaxHookFlash MIB objects. Configurable tone operations, using the pktcSigDevToneTable and pktcSigDevMultiFreqToneTable MIBs, are available in both NA and EURO loads.

VMWI Behavior in North American Loads

North American NCS loads, by default, use VMWI or VMWI with ring splash to set a ‘‘message waiting’’ indicator. .EURO loads send DTAS before VMWI by default. When using the North American TS6.1 firmware load, setting the country code to ‘‘Netherlands’’ or ‘‘Netherlands09’’ switches the load to use DTAS mode for setting VMWI.


50

Provisioning RIP

Chapter 3

This section describes RIPv2 provisioning and defaults. Default Settings

The following is the default RIP configuration when enabled. These defaults apply to all Telephony Modems. • RIP direction (LAN interface): disabled In general, CPE devices behind the Telephony Modem do not run RIP; therefore, it is not necessary to propagate RIP information to the CPE. • RIP direction (WAN interface): – WTM552/WTM652: Out Only – Others: transmit RIP-V2 The Telephony Modem needs to propagate its LAN subnet to the CMTS. However, since all outbound routes from the Telephony Modem go through the CMTS, the CMTS does not have to propagate its routes to the Telephony Modem. • Mode: – WTM552/WTM652: RIP_2M (multicast) – Others: RIPv2 • Link cost: 1 • Authentication: disabled • Advertisement interval: 30 seconds Requirements

The following are requirements to implement RIP: • RIP must be enabled on the CMTS cable interface (for example, the command configure router rip shutdown no enables RIP on the ARRIS C4® CMTS) A public IP address/mask must be assigned to the Telephony Modem’s LAN interface. Public IP addresses must be reserved for CPE devices, which can be assigned as follows: – static addresses – external customer DHCP server – WTM552/WTM652 built-in DHCP server


Provisioning

51

Dual Mode Telephony Modem Considerations The TM601B/DM, TM602B/DM, and WTM652B/CE Dual Mode Telephony Modems can automatically register to both North American and European plants. These models are intended for customers who have both DOCSIS and Euro-DOCSIS plants and require a single product. This section describes provisioning considerations for Dual Mode Telephony Modems. TS6.1 MSUP2 and later versions of Touchstone firmware provide support for mixed DOCSIS environments (that is, both North American and Euro-DOCSIS downstreams on the same plant). A dual-mode Touchstone device ranged on one annex can be moved to the other annex type using Downstream Frequency Override in a RNG-RSP message.

Configuration Files and Signed Loads

Use European CVCs in configuration files for Dual Mode units. This allows configuration files for a normal European unit to work for Dual Mode Telephony Modems as well. If the firmware load for a Dual Mode unit is signed, it should be European signed. North American CVCs and load signatures are not supported.

Cer tificates

Dual Mode Telephony Modems are programmed with four certificates, a European and North American certificate each for the CM and MTA. When the Telephony Modem boots up, it checks the value of the Dual Mode Discovered Market (DMDM) stored in NVM, and uses the certificates that correspond to that region. If the DMDM value is uninitialized, which would be the case the first time the Telephony Modem is installed or after a factory reset, it uses European signed certificates. If the ranging algorithm detects a different plant type than expected by the DMDM, the Telephony Modem resets so it can use the other certificates.

Ranging

The general ranging process for a Dual Mode Telephony Modem is: 1 The Telephony Modem begins scanning for frequencies based on the value of the DMDM. If this is the first time the Telephony Modem has begun ranging, it defaults to Euro-DOCSIS scanning. 2 If the Telephony Modem cannot find a carrier of the programmed annex type, it switches annexes and repeats the scanning process until it finds a carrier. 3 if the Telephony Modem finds a carrier type different from that stored in the DMDM, it changes the DMDM value and resets to switch certificates.


52

DMDM Status

Chapter 3

Use the arrisCmDevDualModeDiscoveredMarket MIB object to retrieve the current DMDM value. Non-Dual Mode Telephony Modems always return 0 for this object. To view or change the DMDM value from the CLI, use the NVM command pdmm.

Feature Switches TS6.1 supports several feature switches that enable extended features, or improve interoperability with non-PacketCable compliant equipment.

CallP Feature Switch

The TS6.1 firmware provides an ARRIS-specific MIB, ppCfgMtaCallpFeatureSwitch, used to configure the Telephony Modem for the specific sub-set of PacketCable features supported by the selected network configuration. This allows the flexibility to interoperate with other vendors by providing the ability to enable or disable the proper functionality. The default is full Packet-Cable compatibility. The feature switch is a 32-bit value, where each bit enables or disables a certain feature. Most of these values should only be changed with the guidance of ARRIS technical support, but some flags may be changed as necessary: The following is a list of CallP Feature Switches that can be adjusted at your discretion. The default value is 0x8233 for NCS loads, and 0x0020 for SIP loads. Note:

SIP loads support a subset of the available bit values. The following table indicates whether each bit value is available only for NCS or for both NCS and SIP loads. Bit

Description

0x00000001 Enable NCS Piggyback Messages (NCS only) Set this bit to allow transmission of NCS piggybacked messages (that is, sending more than one NCS message in a UDP packet). Note:

NCS redirection may not function properly with this feature disabled. 0x00000002 Enable Lockstep Quarantine Mode (NCS only) Set this bit to allow endpoints to enter the lockstep quarantine mode. When this bit is set, the gateway must receive a new Notification Request command after sending a Notify command. Until this happens, the endpoint is in a lockstep state, and events that occur and are to be detected are simply stored in the quarantine buffer until receiving the Notification Request command.


Provisioning

53

Bit

Description

MGCP Error Codes (NCS only) Set this bit to allow the MTA to send error code response messages that are specified in MGCP, but not yet specified in NCS. The following error messages are enabled. Note:

The CMS must be able to support these error mes-

sages. Attempt to create a 3rd connection on a line when only two are supported: NCS = 502 The transaction could not be executed, because the endpoint does not have sufficient resources.

0x00000004

MGCP = 540 Per Endpoint Connection Limit Exceeded Can’t get a DSP resource to support a given connection since they are all in use by other lines: NCS = 502 The transaction could not be executed, because the endpoint does not have sufficient resources MGCP = 403 The transaction could not be executed, because the endpoint does not have sufficient resources at this time Can’t support the currently requested combination of connections due to DSP (or other) limitation : NCS = 502 The transaction could not be executed, because the endpoint does not have sufficient resources

MGCP = 502 The transaction could not be executed, because the endpoint does not have sufficient resources (permanent condition). 0x00000008 T.38 Capability Descriptor (NCS only) Set this bit to reduce the SDP capability descriptor to only send T.38-related information.


54

Chapter 3

Bit

Description

0x00000010

Enable SDP Compliance (NCS only) Set this bit to enable the transmission of all mandatory SDP parameters (default). Clearing this bit reduces the length of the SDP parameter list, by suppressing transmission of nonessential Telephony Modem parameters. The suppressed parameters are origin (o), bandwidth (b), session name (s), time start/stop (t), and T.38 capabilities. Reducing the length of the SDP parameter list may be required to communicate with a CMS that does not support SDP lists longer than 512 bytes, or when the CMS (for whatever reason) cannot interpret the SDP. Note 1:

Some commercially available gateways are not able to support emergency communications, such as E911 calls, with this setting. In this situation, use the ‘‘Suppress SDP Capability Attribute Parameters’’ switch setting instead of this switch setting.

Note 2:

Clearing this bit disables T.38 strict mode functionality (T.38 loose mode is still available). 0x00000020 DQoS SF (Max Traffic Rate) PacketCable compliant (SIP and NCS) Clear this bit to set a downstream maximum traffic rate value of 10,000,000 bits/sec for compatibility with older CMTS revisions that do not correctly handle downstream traffic rate limiting per PacketCable DQoS specifications. When using full PacketCable DQoS, set this bit (the default) for PacketCable compliance. 0x00000080 Omit MPTIME parameter in returned SDP (NCS only) Set this bit to omit the ‘‘a=mptime’’ and ‘‘a=ptime’’ parameters in the MTA’s SDP message for DOCSIS 1.1 operation.


Provisioning

55

Bit

Description

0x00000100 Suppress SDP Capability Attribute Parameters (SIP and NCS) Set this bit to suppress media capabilities (including T.38) from being transmitted in the SDP parameter list. The origin (o), bandwidth (b), session name (s), and time start/stop (t) bits are included in the transmitted SDP parameter list. Clear this bit (default) to enable transmission of T.38 capabilities in the SDP parameter list. Reducing the length of the SDP parameter list may be required to communicate with a CMS that does not support SDP lists longer than 512 bytes, or when the CMS (for whatever reason) cannot interpret the SDP. However, some network gateways may require the o, b, s, and t parameters in the SDP parameter list in order to process emergency communications. Note:

Setting this bit disables T.38 strict mode functionality (T.38 loose mode is still available). 0x00000200 RSIP Wildcarding (NCS only) Set this bit to allow transmission of wildcarded RSIP data. 0x00000800 No Gate-ID No Service (NCS only) Set this bit to disable Best Effort calls. When this feature is enabled, the Telephony Modem rejects all Create Connection (CRCX) commands that do not contain a DQoS Gate-ID. Since the Gate-ID is considered to be persistent, the Telephony Modem also rejects Modify Connection (MDCX) commands, unless a previous MDCX or CRCX command for that connection contained a DQoS Gate-ID. The rejection message uses NCS error code 526 (no bandwidth). 0x00001000 Nuera RFC 2833 messaging without request using payload 127 (NCS only) Some CMS vendors use RFC 2833 to have the MTA pass detected telephony events (e.g. offhook, onhook, digits) to a PSTN gateway in-band — similar to ABCD robbed-bit signaling. Set this bit to instruct the MTA to generate RFC 2833 events with a payload type of 127 without specifically being instructed to do so (for compatibility with the Nuera RDT). Clear this bit (the default) to generate RFC 2833 events using NCS signaling and SDP exchange. 0x00004000 DSX/Access only DQoS (NCS and SIP) Set this bit to use DSX/Access DQoS only between the CM and CMTS.


56

Chapter 3

Bit

Description

0x00008000 Allow endpoint to send provisional responses (NCS only) Set this bit (the default) to allow the MTA to send a provisional response to the CMS if execution of the CRCX or MDCX commands takes additional time to execute. The ARRIS MTA sends this provisional response if DQoS is to be performed, due to the extra amount of time it takes to set up bandwidth between the CM and CMTS. Once the provisional response is issued, the CMS should stop retransmitting the command. When the MTA has completed the transaction, it transmits a ‘‘final’’ response back to the CMS. This ‘‘final’’ response must be acknowledged by the CMS; otherwise, the MTA retransmits it until it is acknowledged. Clear this bit to provide compatibility with CMS vendors that are not capable of supporting provisional responses per PacketCable ECN MGCP-N-02218. 0x00010000 Payload Header Suppression (NCS and SIP) Set this bit to allow Payload Header Suppression of voice packets between the CM and CMTS. Note:

This bit only affects PHS for RTP voice packet streams. Its setting does not affect PHS for DOCSIS data packets, which is controlled through the DOCSIS MIB. Conversely, DOCSIS MIB settings do not affect PHS for RTP voice packets. 0x00020000 Allow multiple connections per line (NCS only) When this bit is cleared (the default), the MTA allows up to two simultaneous connections per endpoint for compatibility with CMS vendors that need multiple connections for supporting features such as 3-way calling and call waiting. Set this bit to allow only one connection per endpoint. Note:

In general, if the CMS is used in an IPDT solution (e.g. Nuera RDT) where every call is on-net to off-net, then multiple connection support is most likely not needed. 0x00040000 DQoS Tolerated Grant Jitter (NCS and SIP) Set this bit to change the upstream Tolerated Grant Jitter value in the upstream Service Flow parameter set for voice from the PacketCable-compliant value of 800µs to 2000µs. When using Full DQoS mode, the bit must be set to 0 which is the default setting.


Provisioning

57

Bit

Description

0x00080000 LUCENT RFC-2833 messaging without request using payload 94 (NCS only) Some CMS vendors use RFC 2833 to have the MTA pass detected telephony events (e.g. offhook, onhook, digits) to a PSTN gateway in-band, similar to ABCD robbed-bit signaling. For compatibility with Lucent iMerge, set this bit to instruct the MTA to generate RFC 2833 events with a payload type of 94 during call setup, without specifically being instructed to do so. Clear this bit (the default) to generate RFC 2833 events using NCS signaling and SDP exchange. 0x00100000 Allow AES encryption for RTP/RTCP (NCS only) Clear this bit (the default) to allow the negotiation of voice encryption, which is a requirement of PacketCable, and is enabled by default on a per call basis. Set this bit to disable this feature, and reduce the size of the MTA’s SDP message since encryption parameters are not included. Note:

If the CMS (and far end) can handle the increased size of the SDP with AES encryption enabled, then set this bit to 0, as the far end is capable of negotiating voice security parameters (including NULL encryption) and the CMS will instruct the MTA on whether to use encryption or not on a per-call basis. 0x00200000 Reserve for RECVONLY/SENDONLY/REPLCATE modes (NCS and SIP) Set this bit to COMMIT both the upstream and downstream parameter sets for the following connection modes: RECVONLY, SENDONLY, REPLCATE. If the bit is cleared (the default), the MTA will COMMIT the active direction and RESERVE the inactive direction per PacketCable specifications. Note:

0x00400000

When using Full PacketCable DQoS mode or SIP loads, always set this bit to 0. CMS Redirect (NCS only) Set this bit to allow a CMS to redirect the MTA to another CMS that is not provisioned in the MTA CMS table, allowing the MTA to communicate with the CMS without attempting to establish an IPsec association first. Setting this bit is for redirect cases only, the MTA does not respond to call servers not provisioned in the MTA’s CMS table.


58

Chapter 3

Bit

Description

0x00800000

Add brackets around IP for MTA FQDN (NCS only) Set this bit to enable the eMTA to send an NCS message with a bracketed IP address as part of the MTA FQDN when communicating with the call server. For call servers that use IP address information instead of FQDNs, the brackets surrounding the IP address are mandatory. The following example shows the messaging format with this feature switch enabled. RSIP 78 aaln/1@[10.10.13.11] MGCP 1.0 NCS 1.0

0x01000000 Send DTMF digits via RFC 2833 with payload 101 without request (NCS only) Set this bit to instruct the MTA to generate RFC 2833 DTMF events using a payload type defined in a proprietary MIB object without being instructed to do so by the CMS. This feature allows the MTA to act as if the CMS requested RFC 2833 DTMF digits to be sent using the defined payload type. When this bit is cleared (the default), the CMS specifically instructs the MTA to send RFC 2833 DTMF digits, and CODEC negotiation with the far end determines the payload type to use. 0x02000000 Provisionable Ring Cadences (NCS and SIP) Set this bit to enable provisionable ring cadences using the NCS Signaling MIB. This feature is applicable only to nonNorth American countries since North America already uses provisioned ring cadences. When this feature is disabled, the hard-coded country template based ring cadences are used which are not limited to 6 second durations as the provisioned values currently are. Note:

The setting of this bit does not affect European loads. 0x04000000 Custom flash timing (NCS and SIP) Set this bit to use flash timing values 90 ms (Flash Time Min) and 800 ms (Flash Time Max). 0x08000000 Use alternate (non-sequential) Caller ID delivery order (NCS and SIP) Set this bit to have the MTA present Caller ID in an alternate (non-sequential) order. This may be required for compliance with some CPE devices that expect Caller ID information to be presented in a non-standard format. Clear this bit (the default) to use a sequential order based on the parameter type (date/time, then number, then name).


Provisioning

59

Bit

Description

0x10000000 Delay DLCX against connection on on-hook only line (for VMWI) (NCS only) Set this bit to delay processing of a Delete Connection message from the CMS for a line that is on-hook, to allow any queued RTP packets in the DSP jitter buffer to be played out. In the case of VMWI, this prevents the DSP connection from being closed while delivering FSK signals for VMWI. The default setting for this bit is cleared (0). 0x20000000 Enable Automatic OSI Delay (NCS only) Set this bit to have the MTA automatically generate OSI (Open Switch Interval) to the CPE upon far end termination of a call (i.e. the MTA receives a DLCX command for the last connection on the endpoint). The arrisMtaDevAutomaticOsiDelay object specifies the delay, in 100 ms increments, before sending the OSI. The MTA cancels OSI generation if any of the following events occur before the timer expires: • line goes on-hook • hook flash on the line • a new connection is created on the line • CMS receives OSI request The valid range for the MIB object is 0 (no delay) to 100 (10 seconds). 0x40000000 Voice Activity Detection (NCS and SIP) This feature is currently not supported. The bit should be cleared. For non-PacketCable configuration settings, contact your ARRIS Technical Support representative. For more information, see the PacketCable Network-Based Call Signaling Protocol Specification,

Example

If your configuration requires DSx-QoS and PHS, set the feature switch to include the 0x4000 and 0x10000 flags, using PacketACE or a provisioning server. If no other flags are required, the setting would be as follows: SnmpMib = ppCfgMtaCallpFeatureSwitch.0 hexstr: 00.01.C2.33 = 00.00.82.33 (default) + 00.01.40.00 (additional features)


60

Chapter 3

Feature Switches Affecting the SDP

The following feature switches affect the SDP, returned in response to a Create (CRCX) or Modify (MDCX) Connection command. Bit

Description

0x00000008 Reduce the capability descriptor in the SDP to T38 only (default = 0, no reduction). 0x00000010 SDP compliancy (default = 1, generates compliant SDP). 0x00000080 Omit mptime parameter in returned SDP (default = 0, mptime included). 0x00000100 Omit capability parameters in returned SDP (default = 0, capability descriptors included). 0x00001000 NUERA RFC 2833 messaging without request using payload 127 (default = 0, telephone-event is negotiated normally). 0x00080000 LUCENT RFC 2833 messaging without request using payload 94 (default = 0, telephone-event is negotiated normally). 0x00100000 Allow AES encryption for RTP/RTCP (default = 1, AES encryption is negotiated normally). 0x01000000 Send DTMF digits via RFC 2833 with payload 101 without request (default = 0, telephone-event is negotiated normally). The following CRCX command is used to generate all the SDP examples, unless otherwise specified: CRCX 19901 aaln/[email protected] MGCP 1.0 NCS 1.0 C: 1234 M: recvonly L: mp:20,

a:PCMU,

fxr/fx:t38-loose,

xrm/mcr:on

The default feature switch settings generate the following SDP: v=0 o=- 381749076 381749076 IN IP4 10.1.36.219 s=c=IN IP4 10.1.36.219 t=0 0 m=audio 65496 RTP/AVP 0 b=AS:81 a=rtcp-xr:voip-metrics a=mptime:20 a=rtpmap:0 PCMU/8000/1 a=X-pc-secret:base64:ZNos/qs530eSDJ4FvdL2GJBR62lS5UKyQ7n9og4 IaaDbA9Blpg6lM2PfOaHEGg== U5Q5N/eWnimq9Q/yjWwY2hACRIY6a9qqEQ Us8tm54lEmEE6LXkCB51+3sqxlQg== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 101


Provisioning

61

a=cpar: a=fmtp:18 annexb=no a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1 a=cpar: a=rtpmap:2 G726-32/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=rtpmap:101 telephone-event/8000/1 a=cpar: a=fmtp:101 0-15,144,149,159 a=cdsc: 11 image udptl t38 a=cpar: a=T38FaxVersion:0 a=cpar: a=T38FaxRateManagement:transferredTCF a=cpar: a=T38FaxMaxDatagram:161 a=cpar: a=T38FaxUdpEC:t38UDPRedundancy

When the SDP Compliance switch ( 0x00000010) is disabled, and all other switches are set to their default values, the SDP becomes: v=0 c=IN IP4 10.1.36.219 m=audio 54136 RTP/AVP 0 a=mptime:20 a=rtpmap:0 PCMU/8000/1 a=X-pc-secret:base64:+JLpxeajZEoknvXbL7YSSK87FP5iIga4HWr3G0k CJ6fjxE6tFLhNx920eXVCmw== Y6XT294www0KXeqt3x0jqspuzcEU/bNA/r RTOJ1jBviqsw/JaO91i/tKDTbTdw== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70

Note that the Capability Descriptor is suppressed; therefore, the settings for both ‘‘Omit Capability Descriptor’’ and ‘‘Reduce Capability Descriptor’’ are irrelevant. Other features are unaffected. When the ‘‘Omit Capability Descriptor’’ switch (0x00000100) is enabled, and all other switches are set to their default values, the SDP becomes: v=0 o=- 381749076 381749076 IN IP4 10.1.36.219 s=c=IN IP4 10.1.36.219 t=0 0 m=audio 65496 RTP/AVP 0 b=AS:81 a=rtcp-xr:voip-metrics a=mptime:20 a=rtpmap:0 PCMU/8000/1 a=X-pc-secret:base64:ZNos/qs530eSDJ4FvdL2GJBR62lS5UKyQ7n9og4 IaaDbA9Blpg6lM2PfOaHEGg== U5Q5N/eWnimq9Q/yjWwY2hACRIY6a9qqEQ Us8tm54lEmEE6LXkCB51+3sqxlQg== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70


62

Chapter 3

The Capability Descriptor has been omitted from the default SDP; therefore, the ‘‘Reduce Capability Descriptor’’ setting is irrelevant. When the ‘‘Reduce Capability Descriptor’’ switch (0x00000008) is enabled, and all other switches are set to their default values, the SDP becomes: v=0 o=- 381749076 381749076 IN IP4 10.1.36.219 s=c=IN IP4 10.1.36.219 t=0 0 m=audio 65496 RTP/AVP 0 b=AS:81 a=rtcp-xr:voip-metrics a=mptime:20 a=rtpmap:0 PCMU/8000/1 a=X-pc-secret:base64:ZNos/qs530eSDJ4FvdL2GJBR62lS5UKyQ7n9og4 IaaDbA9Blpg6lM2PfOaHEGg== U5Q5N/eWnimq9Q/yjWwY2hACRIY6a9qqEQ Us8tm54lEmEE6LXkCB51+3sqxlQg== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70 a=sqn: 0 a=cdsc: 1 image udptl t38

In this example, the Capability Descriptor is reduced to only the information required to relay support for UDPTL T.38 to the far end. This allows the far end to support T.38 strict mode as defined in the PacketCable 1.5 NCS specification. When the ‘‘Omit mptime’’ switch (0x00000080) is enabled, and all other switches are set to their default values, the SDP becomes: v=0 o=- 382093395 382093395 IN IP4 10.1.36.219 s=c=IN IP4 10.1.36.219 t=0 0 m=audio 58810 RTP/AVP 0 b=AS:81 a=rtcp-xr:voip-metrics a=rtpmap:0 PCMU/8000/1 a=X-pc-secret:base64:XI51bgXR5MNUdaKXisS0tjYCc90x3f7jA+ojyam W/O/M2BlCaejlrRLOdApR6w== 6LbN8ULCFGMjcR2T3l1uZuBcfWM2vfGn09 YTmR6OhHfQwC4eE+WWSX7AarnFPA== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 101 a=cpar: a=fmtp:18 annexb=no a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1


Provisioning

63

a=cpar: a=rtpmap:2 G726-32/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=rtpmap:101 telephone-event/8000/1 a=cpar: a=fmtp:101 0-15,144,149,159 a=cdsc: 11 image udptl t38 a=cpar: a=T38FaxVersion:0 a=cpar: a=T38FaxRateManagement:transferredTCF a=cpar: a=T38FaxMaxDatagram:161 a=cpar: a=T38FaxUdpEC:t38UDPRedundancy

In this example, neither the a=ptime nor the a=mptime parameters are included in the SDP since the packetization rate is the default (20 ms). If the Call Agent had specified a different packetization rate (for example, 10 ms), then the a=ptime parameter is included as follows: v=0 o=- 382093395 382093395 IN IP4 10.1.36.219 s=c=IN IP4 10.1.36.219 t=0 0 m=audio 58810 RTP/AVP 0 b=AS:81 a=rtcp-xr:voip-metrics

a=ptime:10 a=rtpmap:0 PCMU/8000/1 a=X-pc-secret:base64:XI51bgXR5MNUdaKXisS0tjYCc90x3f7jA+ojyam W/O/M2BlCaejlrRLOdApR6w== 6LbN8ULCFGMjcR2T3l1uZuBcfWM2vfGn09 YTmR6OhHfQwC4eE+WWSX7AarnFPA== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 101 a=cpar: a=fmtp:18 annexb=no a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1 a=cpar: a=rtpmap:2 G726-32/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=rtpmap:101 telephone-event/8000/1 a=cpar: a=fmtp:101 0-15,144,149,159 a=cdsc: 11 image udptl t38 a=cpar: a=T38FaxVersion:0 a=cpar: a=T38FaxRateManagement:transferredTCF a=cpar: a=T38FaxMaxDatagram:161 a=cpar: a=T38FaxUdpEC:t38UDPRedundancy

When the ‘‘Allow AES Encryption’’ switch (0x00100000) is disabled, and all other switches are set to their default values, the SDP becomes; v=0 o=- 381749076 381749076 IN IP4 10.1.36.219


64

Chapter 3

s=c=IN IP4 10.1.36.219 t=0 0 m=audio 65496 RTP/AVP 0 b=AS:81 a=rtcp-xr:voip-metrics a=mptime:20 a=rtpmap:0 PCMU/8000/1 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 101 a=cpar: a=fmtp:18 annexb=no a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1 a=cpar: a=rtpmap:2 G726-32/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=rtpmap:101 telephone-event/8000/1 a=cpar: a=fmtp:101 0-15,144,149,159 a=cdsc: 11 image udptl t38 a=cpar: a=T38FaxVersion:0 a=cpar: a=T38FaxRateManagement:transferredTCF a=cpar: a=T38FaxMaxDatagram:161 a=cpar: a=T38FaxUdpEC:t38UDPRedundancy

The last three CPFS bits (0x00001000, 0x00080000, and 0x01000000) are related to RFC 2833. They are used in specific configurations and are designed to skip CODEC negotiation. For example, when the ‘‘Nuera RFC2833’’ feature is enabled, and all other switches are set to their default values, the SDP becomes: v=0 o=- 382250430 382250430 IN IP4 10.1.36.219 s=c=IN IP4 10.1.36.219 t=0 0 m=audio 63672 RTP/AVP 0 b=AS:81 a=rtcp-xr:voip-metrics a=mptime:20 a=rtpmap:0 PCMU/8000/1 a=X-pc-secret:base64:Qb8GFLNXP4Z3yiyxFx1Ws9vLph9qG6bTIXezUlz rwia7iiNvPPkVYdZhZ77NEQ== zZjgwXRR2j5F04lDXefPTV06PT8g31Hn5V Ea6NJvFPFsPiraDeDI35EI8KO+4A== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 127 a=cpar: a=fmtp:18 annexb=no a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1


Provisioning

65

a=cpar: a=rtpmap:2 G726-32/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=rtpmap:127 telephone-event/8000/1 a=cpar: a=fmtp:127 0-15,144,149,159 a=cdsc: 11 image udptl t38 a=cpar: a=T38FaxVersion:0 a=cpar: a=T38FaxRateManagement:transferredTCF a=cpar: a=T38FaxMaxDatagram:161 a=cpar: a=T38FaxUdpEC:t38UDPRedundancy

Note that this feature does not add SDP attributes, but modifies the Capability Descriptor slightly. Payload type 127 is used for RFC 2833 support. When the ‘‘Lucent RFC2833’’ switch is enabled, and all other switches are set to their default values, the SDP becomes: v=0 o=- 382318343 382318343 IN IP4 10.1.36.219 s=c=IN IP4 10.1.36.219 t=0 0 m=audio 49688 RTP/AVP 0 b=AS:81 a=rtcp-xr:voip-metrics a=mptime:20 a=rtpmap:0 PCMU/8000/1 a=X-pc-secret:base64:Kue6n+ZSGpXrB2iAJIAUQNst6AtAS7Ad7zC3oGP ry9XKdURiy4Y6iLaDEhk5lg== GgaMtuqF7/egjksBpQ8SZeWnXCAlr1EeNH AHV7EY0fv03Y0MYAYa1zz/lvO5dg== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 94 a=cpar: a=fmtp:18 annexb=no a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1 a=cpar: a=rtpmap:2 G726-32/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=rtpmap:94 telephone-event/8000/1 a=cpar: a=fmtp:94 0-15,144,149,159 a=cdsc: 11 image udptl t38 a=cpar: a=T38FaxVersion:0 a=cpar: a=T38FaxRateManagement:transferredTCF a=cpar: a=T38FaxMaxDatagram:161 a=cpar: a=T38FaxUdpEC:t38UDPRedundancy

This feature does not add SDP attributes, but modifies the Capability Descriptor. In this case, payload type 94 is used for RFC 2833 support.


66

Chapter 3

Note:

The three feature switches that affect RFC 2833 negotiation are mutually exclusive. At most, only one of the bits may be set in the CallP Feature Switch. Enabling multiple RFC 2833 features may result in unexpected behavior. When the ‘‘RFC2833 Digits’’ switch (0x01000000) is enabled, and all other switches are set to their default values, the SDP becomes: v=0 o=- 382360201 382360201 IN IP4 10.1.36.219 s=c=IN IP4 10.1.36.219 t=0 0 m=audio 53560 RTP/AVP 0 101 b=AS:81 a=rtcp-xr:voip-metrics a=mptime:20 a=rtpmap:0 PCMU/8000/1

a=rtpmap:101 telephone-event/8000/1 a=fmtp:101 0-15 a=X-pc-secret:base64:rwZISK4HN5wlZzehiOBSEJXsRQbexmiwm1Ou4pE nXFr4lSTXQYdAsKFT5lhkkw== tWyPwAvBg6EbSs4+FoY7rWOn0l8pcQPxGm iwlNGPfo3Suehu0CncQ2egC4JQ6w== a=X-pc-csuites-rtp:62/51 64/51 60/51 60/50 a=X-pc-csuites-rtcp:81/70 81/71 82/70 82/71 80/70 a=sqn: 0 a=cdsc: 1 audio RTP/AVP 0 8 15 18 96 97 98 2 99 101 a=cpar: a=fmtp:18 annexb=no a=cpar: a=rtpmap:96 G729E/8000/1 a=cpar: a=rtpmap:97 G726-16/8000/1 a=cpar: a=rtpmap:98 G726-24/8000/1 a=cpar: a=rtpmap:2 G726-32/8000/1 a=cpar: a=rtpmap:99 G726-40/8000/1 a=cpar: a=fmtp:101 0-15,144,149,159 a=cdsc: 11 image udptl t38 a=cpar: a=T38FaxVersion:0 a=cpar: a=T38FaxRateManagement:transferredTCF a=cpar: a=T38FaxMaxDatagram:161 a=cpar: a=T38FaxUdpEC:t38UDPRedundancy

Note that this feature affects the SDP, including the Capability Descriptor. ‘‘101’’ is added to the m= line and two new attributes indicate that the endpoint is prepared to receive RFC 2833 digits.

Switch Settings Removed in TS4.3

The following feature switch settings were removed in TS4.3:


Provisioning

67

Bit

Description

0x00000008 0x00000040 0x00000080

MGCP version 1.0 if set Include comments in response messages Allow any FQDN if set

0x00000100 0x00000800 0x00002000 0x00400000

Do not put line card in standby mode Use hard-coded digit map DQoS mode Allow CMS to control loop rev. and caller ID


The following feature switch settings were removed in TS4.4: Bit

Description

0x00800000

Use the RxGainControl and TxGain Control MIB values


The following feature switch settings were removed in TS4.5: Bit

Description

0x00000400

NCS Flexibility (standard behavior for release TS4.5 and newer).


68

MTA Feature Switch

Chapter 3

TS4.1 and later versions of Touchstone firmware support an MTA feature switch that allows you to enable several features, described below. The ppCfgMtaFeatureSwitch object is a 32-bit value, where each bit enables or disables a certain feature. The following values are currently available: Bit Value

Description

0x00000000 Default behavior. 0x00000001 hashBypass Disables hash checking of the configuration file during provisioning. Disabling hash checking may be required to maintain compatibility with older non-PacketCable compliant provisioning systems. D11PLUS loads ignore this setting, and always bypass hash checking. 0x00000002 maxCPEBypass MTA MAC addresses are not counted against the MaxCpeAllowed MIB. This is required to enable telephony if policy requires this MIB to have a value of 1. Without this switch setting, you must set the MaxCpeAllowed MIB to 2 or higher to enable telephony. D11PLUS loads ignore this setting, and always ignore the MTA in the CPE count. 0x00000004 mtaFilterBypass MTA packets bypass the CM CPE filters (interface 0). This switch has no effect on filters applied against interface 16 (MTA). D11PLUS loads ignore this setting, and always bypass the CPE filters. proprietaryCoex 0x00000008 Enables ARRIS-proprietary MTA coexistence and notification features. See the Touchstone Telephony Management Guide for details. 0x00000010 kdcLoadBalancerSkip The MTA bypasses IP checks for KDC responses if the KDC load balancer replaces the original KDC IP address. 0x00000020 usmUserCompareSkip Skips the comparison of the PacketCable USM user name with the user name in a received SNMPv3 packet. This setting is required for use with cloned USM user names with certain provisioning servers such as Cisco BACC. 0x0000040 snmpInformBypass The MTA bypasses the final SNMP INFORM check. The MTA provisioning status will be ‘‘pass with warnings.’’


Provisioning

69

Bit Value

Description

0x0000080

ifIndexShiftEnable Enables changing the starting ifIndex for voice lines, using the arrisMtaDevEnableIndexTenEleven MIB object.

0x0000100

pktcVersionSelector Set this bit to select PacketCable 1.5 support.

0x0000200

mtaProvHaltNoTod Set this bit to stop PacketCable provisioning when no ToD server is available. Setting this bit can reduce network congestion by preventing MTAs from continuously retrying the provisioning sequence when the ToD server is unreachable.

The default MTA feature switch value is 0, except for D11PLUS loads which have a default value of 0x06. Note:

If you include MTA feature switch settings in the configuration, set the object in the CM configuration file, not the MTA configuration file.

CM Feature Switch

The arrisCmDevModemFeatureSwitch object is a group of flags that enable or disable extended features of ARRIS cable modems. A second object, arrisCmDevModemFeatureSwitch2, provides additional feature controls as described in the next section. The supported bits are (starting with the most significant bit): Bit Value

Description

0x01 enableIpv6Multicast Set this bit to enable forwarding of IPv6 multicast packets. octetCounterChange 0x08 Set this bit to set the ifInOctets counter to exclude SYNC and MAP packets from being counted on interface 3 (the downstream RF interface). 0x10 concatDisable Clear this bit to enable fragmentation support for use with DOCSIS 1.0 CMTS products that support this feature. 0x20 usbDisable Set this bit to disable the USB interface on Touchstone cable and telephony modems.


70

Chapter 3

Bit Value

Description

0x40 wanIsolationOverride Set this bit to disable the WAN Isolation switch on Touchstone cable and telephony modems. Internet access remains enabled regardless of the position of the WAN isolation switch (Standby button). Note:

This feature switch setting is specific to specific hardware used in Japan deployments. Use the arrisCmDevWanIsolationState object to override this functionality in other markets. 0x80 badMapDiscard Set this bit to discard invalid MAP messages. The default value is 0.

Secondary CM Feature Switch

The arrisCmDevModemFeatureSwitch2 object provides additional CM feature options. The default switch value is 0. Bit Value

Description

0x04000000 wrmResetControl Set this bit to disable the ‘‘reset to factory default’’ functionality of the WRM Reset button. 0x08000000 wrmMaxCPEBypass (deprecated) Skip counting the WTM552/WTM652 WRM module as a CPE device. TS6.1 ignores this bit setting and always skips the WRM module in the CPE count. 0x20000000 allowCpeOverflowWrap Set this bit to enable the eMTA to re-use slots in the CPE MAC forwarding table as new CPEs connect to the eMTA. This may be useful where a Telephony Modem is deployed in a public access area. Note:

Enabling this feature is non-compliant with DOCSIS standards. 0x40000000 enableBroadcastDhcpProtection Set this bit to filter DHCP broadcast packets not destined for CPE devices. This option prevents potential hackers from obtaining provisioning data by sniffing downstream DHCP traffic. Note:

Enabling this feature is non-compliant with DOCSIS standards. 0x80000000 disableTftpTimeoutOption Set this bit to disable TFTP timeout.


Provisioning

SIP Feature Switch

71

The SIP feature switch MIB object sipCfgSipFeatureSwitch is a group of flags that enable or disable extended features in the SIP load. The supported flags are: Bit Value

Description

0x00000020

Signal hook flash events with a SIP INFO message using the standard method Set this bit to instruct the MTA to signal a hook flash event using a standard SIP INFO message: Content-Type: application/hook-flash signal=hf Note:

0x00000040

0x00000200

0x00000400

0x00000800

If this bit is set, do not set bit 0x00080000. Stutter dialtone on hook flash Set this bit to force the MTA to play stutter dialtone when the subscriber performs a hook flash. The default behavior is to use the dialing feature configuration. Use reINVITE instead of UPDATE for session timer refresh Set this bit to force the MTA to use reINVITE messages to refresh the session timer. The default behavior is to use UPDATE messages. Play busy on call rejection Set this bit to force the MTA to play local busy tone when an outbound call is rejected. SIP proxy penalty box Set this bit to enable the SIP Proxy Penalty Box feature. When SRV lookups are enabled, and a proxy does not respond to an MTA message for 32 seconds, the MTA places the SRV record in the penalty box. The penalty box can hold up to five proxy addresses. Proxies are released from the penalty box under the following conditions: • A sixth proxy times out; the first proxy to be placed in the penalty box is then released. • The MTA is reset. • The sipCfgPenaltyBoxTimeout object is set to a nonzero time (default: 24 hours), the specified number of hours have elapsed, and the proxy responds to a REGISTER message. • All other known proxies have message send failures.


72

Chapter 3

Bit Value

Description

0x00002000

Do not send SDP in provisional 1XX response on incoming INVITES with 100Rel enabled Set this bit to send the SDP in the 200 OK response (when the user picks up) instead of the provisional response (180). Use Inactive media attribute when holding media When putting an endpoint on hold, the MTA sends a session description with media attribute ‘‘inactive’’ instead of ‘‘sendonly.’’

0x00004000

0x00008000

0x00010000

0x00020000

0x00040000

0x00080000

Remove unneeded auth headers from a Call Leg after a 401 or 407 response Set this bit to remove all authorization headers (except the one matching the nonce specified in the 401 or 407 response) from subsequent call-leg messages. This option is needed to support proxies that support only one authorization header in a message. Play local ringtone upon receipt of 180 without SDP Set this bit to play ringtone if the MTA receives a 180 response without an SDP. If the MTA receives media and an SDP, it silences local ringtone. Generate remote ringtone Set this bit to play ringtone over the connection to the originating party. When set, the MTA responds to an incoming call with a 183 (Session Progress) message with an SDP, and plays ringback tone over the media connection. This option is needed for use with certain carrier-grade proxy servers that expect SIP endpoints to support remote ringback if they support PRACK and UPDATE. Bit 0x00800000 must be cleared (100rel support enabled) as well, to enable remote ringback; the MTA plays ringback tone when instructed. Limit SDP Origin number updates Set this bit to leave the SDP version number unchanged when the SDP does not change. Signal hookflash events with a SIP INFO message Set this bit to inform the proxy of a hookflash event with an INFO message. Use this feature only in environments where the proxy expects to handle a hookflash. The proxy also informs the MTA to play certain tones using an incoming INFO message. The INFO message has the following format: Content-Type: application/broadsoft event flashhook Note:

If this bit is set, do not set bit 0x00000020.


Provisioning

73

Bit Value

Description

0x00200000

Send silent packets over held connection Set this bit to transmit silent RTP (keepalive) packets, if the MTA was previously sending media. Enable SRV lookup for servers Set this bit to use SRV lookups for the server addresses (must be set in the MTA configuration file).

0x00400000

0x00800000

0x01000000 0x02000000

0x04000000

0x08000000

0x10000000

0x20000000

0x40000000

0x80000000

The DNS server must be be configured to provide SRV records, or it falls back to normal A records. Use SRV to load balance proxies or to specify a backup proxy to use in case of failure to communicate with the primary. Disable 100Rel support Set this bit to disable RFC 3262/PRACK/100rel support. By default, in this mode the answer SDP of an incoming call is sent in the 180 or 183 response to an INVITE. This may be changed with bit 0x00002000. Uses an IP Address of 0.0.0.0 for held SDP creation. Disable CW-CID Set this bit to disable CallerID over Call Waiting (CW−CID). This may be required for certain subscriber equipment. Domain Override Set this bit to use the provisioned proxy FQDN or IP address specified in the configuration file, instead of the MTA FQDN, in To/From headers and the Request URI. The default behavior is to use the domain setting from MTA DHCP Option 15. RFC 3323 Privacy Header Usage Set this bit to enable the RFC 3323 privacy header instead of using PacketCable 2.0 methods. Advanced flash handing Set this bit to enable European advanced flash feature support (where the flash is followed by a DTMF digit). See ‘‘Configuring Hook Flash Timing’’ on page 147 for a detailed description. The normal mode of operation handles flash using North American standards. RFC 3842 handshake Set this bit to enable an RFC 3842-compliant SubscribeNotify handshake for message waiting indicator (VMWI) support. The normal VMWI scheme uses unsolicited Notify messages. MTA FQDN Set this bit to use the MTA FQDN instead of the IP address in the contact header field of SIP messages. Telephony URI Scheme (currently not supported).


74

Chapter 3

The default value is 0 for all SIP loads.

Country Code Templates Touchstone firmware supports a number of ring and tone templates for various countries. See ‘‘Appendix C: Line Parameters by Country’’ on page 239 for details.

Configuration File Provisioning Notes CM and MTA provisioning files, as described in DOCSIS and PacketCable specifications, use TLV (Type/Length/Value) objects to specify configuration parameters. This section provides information useful in provisioning Touchstone products through configuration files.

Suppor t for TLV-41 (Downstream Channel Lists)

TLV-41 provides Downstream Channel List support. When provisioned in the CM configuration file, downstream channel lists provide the ability to specify an allowed range of downstream frequencies to use during downstream scanning operations. When Downstream Channel Lists are specified in the configuration file, the CM does not use any frequencies outside of the provisioned range without specifically being directed to so by the CMTS. Also, this list overrides the last operational channel value stored in NVRAM. If the CM (portion of the MTA) loses sync with the CMTS, the CM retains the provisioned list of downstream channels provided in the configuration file, and uses them to search for a new downstream during subsequent MAC re-initialization and downstream scanning. Full details on the operation of this feature and TLV-41 parameters can be found in Appendix C of the DOCSIS 2.0 RFI specification (SPRFIv2.0-I11-060206).

Embedding ARRIS-Proprietar y MIBs within TLV-43

In TS4.4 and newer versions, all ARRIS MIBs (TLV-11) may be embedded within the Vendor Specific Information TLV (TLV-43). The TLV-43 Vendor ID field must contain the ARRIS Organization Unique Identifier (OUI); the OUI is a three-byte representation of the ARRIS MAC Address (0000CA). Multiple ARRIS TLV-11s may be embedded within a single TLV-43. Note:

Always use the 0000CA OUI value, even if the Telephony Modem OUI has another value. See the Touchstone Telephony Feature Guide for a complete list of OUIs assigned to ARRIS.


Provisioning

75

The following is an example (encoded by PacketACE) of an ARRIS TLV-11 embedded within a TLV-43. VendorSpecific = ARRISVendorId SnmpMib = arrisMtaDevLoopVoltagePolicy.0 always_voltage_present VendorSpecific = ARRISVendorId SnmpMib = arrisMtaDevLoopVoltageResetTimeout.0 800

See the PacketACE User’s Guide for details about encoding TLV-11 objects within a TLV-43.

Changes and Considerations for TLV-39 Support

TS6.1 fully supports TLV-39, used to enable or disable registration on a DOCSIS 2.0 upstream. This support has several implications. In previous versions, if the configuration file contained TLV-39 and was set to Disabled, and the MTA locks onto a CMTS downstream where only DOCSIS 2.0 upstreams are provisioned, the MTA never completes registration because no DOCSIS 1.1 upstreams are available. With full support for TLV-39, if the provisioning file sets TLV-39 to disabled, the MTA advertises itself as a DOCSIS 2.0 device even when registering on a DOCSIS 1.1 upstream. The following flowchart shows the registration process.


76

Chapter 3

MTAlocks on DS during initial registration

Is a D2.0 US available?

NO

NVRAM Flag for DOCSIS 2.0 left alone

Y E S

YES

NVRAM Flag for DOCSIS 2.0 remains at Enabled

N O

DHCP (opt 60) and Registration Request with DOCSIS 1.1 device

NVRAM flag for DOCSIS 2.0 set to Enabled

MTA registers on D1.1 US

DHCP (opt 60) and Registration Request to DOCSIS 2.0 device

TLV-39 in Configuration file = Disable

Has device ever seen a D2.0 US?

NO




MTA stays on DOCSIS 2.0 US

MTAregisters on D2.0 US

DHCP (opt 60) and registration request to DOCSIS 2.0 device

MTAregisters on D1.1 US

Y E S

Is D1.1 US available on this DS?

YES

MTA re-reranges on DOCSIS 1.1 US

N O

Begin scanning for another downstream

Cable Cut Recovery on DOCSIS 1.1 Upstreams

Touchstone eMTAs cache the upstream frequency to decrease recovery time after an outage. However, if the eMTA was operating on a DOCSIS 1.1 upstream before the outage, and discovers a DOCSIS 2.0 upstream during recovery, the eMTA may discard the cached frequency and use the DOCSIS 2.0 upstream. The following flowchart shows the recovery process.


Provisioning

77

MTA cable cut occurs on D1.1 US and unit re-scans

Is a D2.0 US available?

NO

NVRAM Flag for DOCSIS 2.0 left alone

Y E S

Has device ever seen a D2.0 US?

NO


Y E S

MTA registers on D1.1 US savedin cache Is NVRAM flag set for D2.0 set to Enabled?

YES

NVRAM Flag for DOCSIS 2.0 remains at Enabled

N O


MTA US cache frequencyfor D1.1 US cleared

MTAregisters on D1.1 US savedin cache

NVRAM flag for DOCSIS 2.0 set to Enabled


TLV-39 in Configuration file = Disable

NO


MTAstays on DOCSIS 2.0 US

Y E S

DHCP (opt 60) and registration request to DOCSIS 2.0 device


MTA re-ranges on DOCSIS 1.1 upstream


78

DTM602 Considerations

Chapter 3

When deploying the DTM602 Telephony Modem, keep the following considerations in mind to avoid disabling functionality.

DTM602 ifAdminStatus Settings

The embedded DECT base is internally connected to the Telephony Modem Ethernet interface. If you set ifAdminStatus.1 to down(2), then the DECT base is unable to communicate with the Internet. The handset can still make and receive calls, but operates as a plain telephone with no extra features.

Filter Configuration

The DTM602 embedded DECT base communicates with an external server to receive initial provisioning and firmware updates. To ensure that the DECT base is able to establish this connection, change any DOCSIS filters to allow inbound and outbound traffic with a source or destination IP address of 72.5.228.0/24. Traffic to port number 5060 must be allowed as well. If this subnet or port are blocked, the DECT module will not be able to register; the handset can still make and receive calls, but operates as a plain telephone with no extra features.

Monitoring MTA Provisioning Status The arrisMtaDevProvState MIB object reports the current provisioning state of the MTA. The possible values of this MIB object represent the following steps of the provisioning sequence, and depend on the provisioning method used: • dhcpBound(1) • dnsReqProvSvrIP(2) • kdcHostNameDnsReq(3) • kdcHostNameDnsRply(4) • kdcIpDnsReq(5) • kdcIpDnsRply(6) • asReqSent(7) • asRplyRcvd(8) • tgsReqSent(9)


Provisioning

79

• tgsRplyRcvd(10) • apReqSent(11) • apRplyRcvd(12) • enrollmentInform(13) • cfgUrlSet(14) • dnsReqTftpSvrIp(15) • cfgFileReq(16) • rcvCfgFile(17) • syslogMsgProvComplete(18) • statusInform(19) • provcomplete(20) The following table shows the provisioning states that can be reported for each provisioning method. Provisioning Method

docsisOnly

States Reported

None enrollmentInform(13) cfgUrlSet(14)

fullPacketCable

PacketCableMinusKDC, hybrid1, hybrid2

dnsReqTftpSvrIp(15) cfgFileReq(16) rcvCfgFile(17) syslogMsgProvComplete(18) statusInform(19) provcomplete(20) dhcpBound(1) dnsReqProvSvrIP(2) enrollmentInform(13) cfgUrlSet(14) dnsReqTftpSvrIp(15) cfgFileReq(16) rcvCfgFile(17) syslogMsgProvComplete(18) statusInform(19) provcomplete(20)


80

Chapter 3

Provisioning Method

Gupi, gupiEncryptedMtaConfig, gupiMacMta, gupiEncryptedMacMta

singleMAC

basic1

basic2

Firmware Upgrade Status

States Reported

dhcpBound(1) dnsReqProvSvrIP(2) dnsReqTftpSvrIp(15) cfgFileReq(16) rcvCfgFile(17) syslogMsgProvComplete(18) provcomplete(20) None dhcpBound(1) dnsReqProvSvrIP(2) dnsReqTftpSvrIp(15) cfgFileReq(16) rcvCfgFile(17) syslogMsgProvComplete(18) provcomplete(20) dhcpBound(1) dnsReqProvSvrIP(2) dnsReqTftpSvrIp(15) cfgFileReq(16) rcvCfgFile(17) syslogMsgProvComplete(18) statusInform(19) provcomplete(20)

The arrisMtaDevSWUpgradeStatus object reports the current firmware upgrade status of the device. Its value is a direct copy of docsDevSwOperStatus. The possible values for this MIB are: • inProgress(1) • completeFromProvisioning(2) • completeFromMgt(3) • failed(4) • other(5)


Provisioning

81

Configuring Alarm and Log Reporting Use this procedure to configure how Touchstone eMTAs generate and send events (alarms and logs). The Touchstone Telephony Troubleshooting Guide provides detailed descriptions of alarms and logs. Touchstone MTA events function within the context of the PKTC-EVENTMIB. Touchstone CM events function within the context of the DOCSCABLE-DEVICE-MIB.

Overview

TS6.1 firmware provides the capability to provision logs and alarms utilizing two different methods. • The standard mode provides the ability to provision: – separate Syslog server and trap receiver addresses for alarms and logs. – multiple trap receivers allowing multiple monitoring stations if desired. – different reporting schemes for each event if desired. • A compatibility mode, that allows the TS6.1 firmware to use provisioning from previous firmware releases (see ‘‘TS4.1 and Older Compatible Provisioning Method’’ on page 82). You can use both provisioning methods as desired. However, if you use the same servers for both methods, the Telephony Modem sends duplicate reports to that server.

Standard Mode

When the eMTA generates an event, each event can be sent to any combination of: • local event log CM events are stored locally in the docsDevEventTable. The DataOver-Cable Service Interface Specifications, CM-SPOSSIv2.0-I10-070803, describes the reporting of DOCSIS and vendorspecific events. MTA events are stored locally in the pktcDevEventTable. The default configuration sends CM and MTA events only to the local event log. • SNMP trap server To report CM or MTA events, you can configure the CM or MTA in either NmAccess mode or SNMP co-existence mode. SNMP co-existence mode supports multiple trap destinations. See the Touchstone Telephony Management Guide for detailed information.


82

Chapter 3

• Syslog server (MTA logs) The eMTA sends MTA logs to the Syslog server whose IP address is specified in the pktcDevEvSyslogAddress object. The eMTA receives its MTA Telephony Syslog Server IP Address in the MTA DHCP OFFER, option 7. The value of the option must be one of the following: – 0.0.0.0—Disable Syslog logging for the MTA. – FF.FF.FF.FF—Use the CM log server as the Syslog server. – Valid IP address of the Telephony Syslog server. The pktcDevEvSyslogAddress MIB value can also be configured from the MTA configuration file. • Syslog server (CM logs) The eMTA sends CM logs to the Syslog IP address specified in docsDevEvSyslogAddress; the docDevEvSyslogAddressType object specifies whether the address is IPv4 or IPv6 format. The CM receives its Syslog IP Address in the CM DHCP options. To disable Syslog transmission for the CM, set the IP address to 0.0.0.0 (IPv4) or 0 (IPv6).

TS4.1 and Older Compatible Provisioning Method

For backwards compatibility with previous releases, Touchstone firmware provides a proprietary method of configuring the trap/Syslog destination IP address. By setting the ppCfgMtaTeleSyslogServIpAddr MIB object in the MTA configuration file, the MTA reports ARRIS proprietary alarms as traps/Syslog events to the specified IP address. If this IP address is set, each ARRIS alarm event reports to the local event database, an SNMP trap and a Syslog message. Each log report can also be modified by setting the new value to the pktcDevEvFixedReporting MIB.

About the Event Tables

The PKTC-EVENT-MIB provides two tables to describe events and control their reporting: the pktcDevEvProgrammableTable and the pktcDevEvFixedTable. The primary difference between the two tables is that entries in the programmable table allow for changes to the message text. Currently, the programmable table contains alarms, and the fixed table contains logs, although this is not a requirement. The following table provides an overview of the alarms and logs. In addition, the pktcDevEvProgrammableTable defines several PacketCable alarms for battery telemetry. The ARRIS Power Supply Telemetry Alarm (and Log) supports these status events.


Provisioning

83

Instance

Origin

Text

1 2 3

ARRIS ARRIS ARRIS

Voice Line Diag Failed Voice Line Diag Passed Voice Line State Change

6 7 8 10

ARRIS ARRIS ARRIS ARRIS

Voice Line Protection State Change Voice Line Loop Current Change to High Voice Line Loop Current Change to Normal State Change

11 14 15

ARRIS ARRIS ARRIS

CATV changed Power Supply Telemetry MTA TFTP: No Channel

16 17 18 19 20 21 22 23

ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS

MTA TFTP: Successful MTA TFTP: File Not Found MTA TFTP: Protocol Error: TFTP Init MTA TFTP: Protocol Error: TFTP Open MTA TFTP: Protocol Error: TFTP Read MTA TFTP: Protocol Error: TFTP Close MTA TFTP: Protocol Error: TFTP DB Access MTA TFTP: Config File Error

24 25 26 27 43 44 45

ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS

46

ARRIS

47

ARRIS

49 65525 65526 65527 65528 65529 65530 65533 65534 1040600

ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS ARRIS

2417164292

ARRIS

MTA TFTP: Failed MTA PROV: Failed MTA PROV: Successful! Touchstone Firmware Upgrade Failed/Successful SSH LOGIN ACCEPTED SSH LOGIN REJECTED No system resources available to perform firmware upgrade MTA DHCP RENEW: Lease Renewal delay; Voice line offhook MTA DHCP REBIND: Lease Renewal delay; Voice line offhook VQ Threshold MTA PROV HALT: No TOD available SIP Authentication Failure SIP Authentication Timeout SIP Proxy Loss of Communications Power Supply Telemetry Log Call Agent Loss of Communications Voice Line Failure Voice Line Total Failure Missing TFTP Server Address Override FQDN in CM config MTA Root Certificate download Failed


84

Chapter 3

Instance

Origin

Text

2417164293 2417164294

ARRIS ARRIS

MTA Root Certificate download Retry MTA Security: Service Provider Certificate Chain Validation Failed

2417164296

ARRIS

2417164297

ARRIS

Touchstone Firmware Upgrade Failed Before Download Attempt Touchstone Firmware Upgrade Failed

2417164298 2417164299

ARRIS ARRIS

Touchstone Firmware Upgrade Successful Touchstone Firmware Upgrade Aborted due to Battery AC-FAIL Condition

The pktcDevEvSyslogAddress MIB object specifies the address of the Syslog server to receive event notifications.

Action

Follow these steps to configure alarm and log reporting. You can configure individual eMTAs through an SNMP manager, or all eMTAs by using a provisioning server to add the MIB objects to the MTA configuration file. 1 Set the pktcDevEvSyslogAddress MIB object to the IP address of a Syslog server. 2 For each event in the pktcDevEvProgrammableTable, set the pktcDevEvProgrammableReporting MIB object to one of the following values: Value

Events Reported to

0x08 0x80 0xA0 0xC0 0xE0

none Local event log only Local event log and Syslog server Local event log and Trap server Local event log, Syslog server, and Trap server

For example, to configure ‘‘AC Fail’’ events to go to a Syslog server (and the local log), set the following MIB object: pktcDevEvProgrammableReporting.65535.4491 = 0xA0 Note:

If you want to report events to Syslog or trap servers, you must report those events to the local event log as well.

3 For each event in the pktcDevEvFixedTable, set the pktcDevEvFixedReporting MIB object to one of the values shown in step 2.


Provisioning

85

Updating the KDC Use this procedure if you require secure MTA provisioning and secure NCS.

TS6.1 firmware commonly uses one of the following embedded certificates: • CableLabs Real Service Provider Root certificate (default). The Real Root certificate is only issued to authorized MSOs and Service Providers. • CableLabs Test Service Provider Root certificate. The Test Root certificate is an alternative to the Real Root certificate for the purpose of lab testing. If you prefer to use the test certificate, you must configure the Kerberos Key Distribution Center (KDC) with the Test Root certificate. • IPfonix Test Service Provider Root certificate (used primarily with earlier versions of Touchstone eMTA firmware). If you continue to use the IPfonix certificate, you must reconfigure the CM provisioning files. Note:

Due to limitations in the DNS UDP packet size (512 bytes) there is a limit of ten ‘‘A’’ records that can be supported by the Touchstone firmware. The ‘‘A’’ record maps the FQDN of the Kerberos server to its IP address. Without an ‘‘A’’ record, it is not possible to acquire the IP address of the Kerberos server. For more information, see ‘‘Appendix B: Configuring the Service Provider Root.’’

Action

Perform either of the following tasks as needed. Task

Page

Configuring the KDC to use the CableLabs Test Root Using the Test Root Download Feature

Configuring the KDC to use the CableLabs Test Root

85 86

To use the CableLabs Real Service Provider Root certificate, do nothing. Follow these steps to use the test root certificate: 1 Generate a KDC certificate chained to your KDC certificate hierarchy (Real/Test Root CA, Service Provider CA, Local System Operator CA). • the realm name that you are using • the KDC’s FQDN 2 Proceed as follows, depending on your KDC:


86

Chapter 3

If you are using. . .

Alopa KDC

Then. . .

Modify the kdcConfig.org file as follows: • modify the KDC realm name to contain the realm name that you are using; for example,

IPfonix KDC

• Modify the principal name to contain the KDC’s FQDN; for example, Generate the KDC private key and include it in the KDC_private_key file.

If you are using a different KDC server, or need more help, contact your next level of support. 3 Place the certificates on your KDC. The directory path to place the certificates is: • IPfonix: KDCDir /windows/PacketCable/certificates/ • Alopa: /opt/Alopa/MetaServ/KDC/config/certs/ 4 Install the configuration file: • IPfonix: Place the KDC_private_key file in KDCDir /windows/ • Alopa: Place the kdcConfig.org file in /opt/Alopa/MetaServ/KDC/config/ 5 Change the realm org name in the MTA configuration file from "Really Amazing Telephone Company" to CableLabs. 6 Restart your KDC.

Using the Test Root Download Feature

This option allows you to continue using the KDC with the IPfonix test root configuration (supported in older versions of Touchstone eMTA firmware). The eMTA’s CM configuration file must contain three MIB objects, which instruct the eMTA to download a test root. The test root is stored only in the eMTA’s RAM memory and therefore the download is required after each reboot. Follow these steps to use this option. 1 Place your IPfonix Test Root certificate on your TFTP server. This server is normally the same server as the configuration file TFTP server. Note:

The certificate must use the X.509 DER-encoded format.

2 Edit your CM configuration file to contain the following MIB objects with the following values:


Provisioning

87

• ppCfgMtaDevSPTestRootCertAdminStatus: Set to downloadTestRootCer t. • ppCfgMtaDevSPTestRootCertFilename: Set to the file name containing the IPfonix Test Root. • ppCfgMtaDevSPTestRootCertServer: Set to the IP address of the TFTP server. 3 Reboot the MTA.


88

Chapter 3

Controlling General eMTA Functionality Use this procedure to enable and disable general functionality on Touchstone eMTAs as desired.

Action


Page

Controlling Access to Troubleshooting Pages Hiding FQDN and IP Information in the Event Log Controlling Data Shutdown Functionality Reading Firmware Load Information Changing the ifInOctets Counter Operation Setting the Telephony Port CATV Relay Setting the Loop Voltage Management Policy Setting the Telnet/SSH Timeout Configuring Battery Over-Temperature Protection Controlling the Dynamic Equalizer Configuring TFTP Block Size

Controlling Access to Troubleshooting Pages

88 89 90 90 91 91 91 92 92 93 94

Touchstone firmware provides troubleshooting information using an HTTP (web) interface. Follow these steps to control access to troubleshooting information after the cable modem registers (access is always available before registration completes). These MIB objects are read-only, so they must be set in the configuration file. 1 In the configuration file, set the arrisCmDevHttpLanAccess MIB object to control access to the troubleshooting pages from the cable modem LAN (Ethernet and USB) interfaces: • off(1) • basic(2) (default) • advanced(3) • until-registered(4) 2 Use the arrisCmDevHttpWanAccess MIB object to control access to the troubleshooting pages from the cable modem WAN (RF) interface: • off(1) (default) • basic(2) • advanced(3)


Provisioning

Hiding FQDN and IP Information in the Event Log

89

The Event Log web page, described in the Touchstone Telephony Troubleshooting Guide, displays the FQDN (or IP address) of the MTA for MTArelated events in the Endpoint Name field. TS6.1 firmware can hide this information from basic users for security purposes. Note:

Users with access to the Advanced pages (using the Password of the Day) can always see FQDN and IP address information. Follow these steps to enable or suppress FQDN and IP information in the Event Log. 1 To suppress FQDN and IP information, set the arrisMtaDevEventHideFQDNAndIPAddress MIB object to enabled(1) in the CM or MTA configuration file and reboot the MTA. For basic users, the Event Log page replaces FQDN and IP information by asterisks:

Note:

Users that have entered the correct Password of the Day can see FQDN and IP information on the Advanced Event Log webpage regardless of the setting of the arrisMtaDevEventHideFQDNAndIPAddress object.

2 To display FQDN and IP information to all users, set the arrisMtaDevEventHideFQDNAndIPAddress object to disabled(0) in the CM or MTA configuration file and reboot the MTA. This is the default setting.


90

Chapter 3

The Event Log page displays FQDN and IP information to all users:

Controlling Data Shutdown Functionality

When the Telephony Modem loses AC power, one of the default actions it takes to conserve battery power is to shut down the data services running over the Ethernet ports (all models) and USB ports (Model 5 and newer) after 15 minutes of power loss. Follow these steps to configure the shutdown time or disable data shutdown altogether. 1 Enable or disable data shutdown by setting the value of the arrisMtaDevPwrSupplyEnableDataShutdown object. The allowed values are: • Enabled(1)—The Telephony Modem discontinues data services after the period of time defined in the arrisMtaDevPwrSupplyDataShutdownTime object. This is the default value. • Disabled(2)—The Telephony Modem allows the subscriber to continue using data services while the modem is running on battery power. Disabling data shutdown can reduce the battery holdup time. 2 Set the time between initial loss of AC power and data shutdown by changing the value of the arrisMtaDevPwrSupplyDataShutdownTime object. Specify the timeout period in seconds. The default is 900 seconds (15 minutes).

Reading Firmware Load Information

Follow these steps to see information about an eMTA’s firmware load. 1 To see the name of the firmware image in use on the eMTA, read (GET) the value of the arrisCmDevSwImageName object. 2 To see the build date and time of the firmware image in use on the eMTA, read (GET) the value of the arrisCmDevSwImageBuildTime object.


Provisioning

Changing the ifInOctets Counter Operation

91

In TS4.1 and later versions of Touchstone firmware, you can change the ifInOctets counter to exclude SYNC and MAP packets from being counted on interface 3 (the downstream RF interface). You may want to use this feature to match the way that Broadcom-based cable modems use the ifInOctets counter to maintain compatibility with existing commercial monitoring products in the field. Follow these steps to configure the counter. 1 To exclude counting octets from SYNC and MAP packets on interface 3, set the bit in the 0x08 position of the arrisCmDevModemFeatureSwitch object. 2 To include counting octets from SYNC and MAP packets on interface 3, clear the bit in the 0x08 position of the arrisCmDevModemFeatureSwitch object.

Setting the Telephony Port CATV Relay

Touchstone Telephony Ports have a CATV relay that allows you to enable or disable CATV service to a subscriber. Follow these steps to set the relay: 1 To allow CATV service, set the ppCfgMtaCableTvEnable object to on(1). 2 To disable CATV service, set the ppCfgMtaCableTvEnable object to off(2).

Setting the Loop Voltage Management Policy

Follow these steps to set the loop voltage policy. See the Touchstone Tele phony Feature Guide for details about each policy. Note:

The MIB objects described in this task may be set only in the configuration file. 1 In the configuration file, set the arrisMTADevLoopVoltagePolicy object to the appropriate value: • AlwaysVoltagePresent(1) • RF-CarrierVoltagePresent(2) • InServiceVoltagePresent(3) • NormalOperation(4) (default) 2 For MTAs using policy 3, modify the reset timer (if necessary) by setting the arrisMtaDevLoopVoltageResetTimeout object in the configuration file. Valid range: 0 to 1800 seconds, in multiples of 8 seconds. Default: 300 seconds. The line card drops loop voltage after a CM reset, if the MTA has not been successfully provisioned before the Reset Timeout timer expires. Note 1:

This object is only used with policy option 3 and is ignored if a policy setting of other than 3 is used.


92

Chapter 3

Note 2:

If the timer value is set to a value that is not a multiple of 8, Touchstone firmware rounds the value down to the nearest multiple of 8. The exception is when the timer is set to the default value of 300; in this case, the arrisMtaDevLoopVoltageResetTimeout object uses and displays a value of 300 seconds.

3 For MTAs using policy 3, modify the plant maintenance timer (if necessary) by setting the arrisMtaDevLoopVoltageMaintTimeout object in the configuration file. Valid range: 0 to 1440 minutes (24 hours). 4 Reset the MTA to enable the new loop voltage policy on the MTA.

Setting the Telnet/SSH Timeout

TS5.0 and later versions of Touchstone firmware allow setting a session timeout that automatically terminates a CLI session (either telnet or SSH) after a specified period of inactivity. You can set (or disable) the CLI timeout through SNMP. Follow these steps to set the CLI timeout. 1 To set the CLI timeout from an SNMP manager, set the arrisCmDevCLITimeout object to the time (in minutes) the CLI may be idle until timeout. Valid range: 1 to 1440 minutes, or use 0 to disable the timeout. Default: 1440.

Configuring Battery Over-Temperature Protection

Follow these steps to configure the battery over-temperature protection feature. 1 Configure reporting for the ‘‘Power Supply Telemetry’’ alarm as described in ‘‘Configuring Alarm and Log Reporting’’ on page 81. 2 To immediately enable the battery over-temperature protection feature, set the arrisMtaDevPwrSupplyOverTempAlarmControl object to enable using an SNMP manager. Note 1:

Over-temperature protection is always enabled for TM602G and TM602H Telephony Modems. Protection cannot be disabled on these models.

Note 2:

On non-TM602 Telephony Modems, this feature is disabled by default. The setting for this object is not stored in non-volatile memory, so the feature is disabled when the MTA is reset.

Note 3:

The valid settings for this object are: disable(0), enable(1), pendingenable(2), and pendingdisable(3). The last two values are read-only; the eMTA ignores attempts to set this object to the ‘‘pending’’ values.

3 To permanently enable the battery over-temperature protection feature, enable the arrisMtaDevPwrSupplyOverTempAlarmControl MIB object in the CM configuration file.


Provisioning

93

4 To set the over-temperature threshold, set the arrisMtaDevPwrSupplyOverTempAlarmThreshold object. Valid range: 50 to 70 (degrees C). Default: 60. Note 1:

The normal operating temperature for Touchstone eMTAs is 0°C to 50°C.

Note 2:

You can also use the CLI Telemetry alarm command to enable the protection feature and to set the threshold temperature.

5 To read the current battery temperature, read the arrisMtaDevPwrSupplyTemperature object. The value returned is the temperature, in degrees C. 6 To read data associated with the highest recorded battery charger temperature, read the following objects: arrisMtaDevPwrSupplyHighestTemperature The highest recorded charger temperature, in degrees C. arrisMtaDevPwrSupplyHighestTemperatureTime A string containing the time and date of the highest recorded charger temperature.

This data is available only when the arrisMtaDevPwrSupplyOverTempAlarmControl object is enabled. 7 To clear data associated with the highest recorded battery charger temperature, set the arrisMtaDevPwrSupplyHighestTemperatureClear to 1. 8 (TM602G/CT Telephony Modems only) Enable or disable the hightemperature battery shutdown feature by setting the arrisMtaDevPwrSupplyHiTempBatteryShutdownControl object. This feature is disabled by default. When enabled, the Telephony Modem shuts off the battery when the battery temperature exceeds 75°C ±10%. The Telephony Modem turns on the battery once battery temperature has fallen to 65°C ±10%.

Controlling the Dynamic Equalizer

Follow these steps to enable or disable the dynamic equalizer. 1 To configure the dynamic equalizer using SNMP, set the arrisCmDevDEAControl object to one of the following values: Non-Persistent

Persistent

Enable

on(1)

onPerm(3)

Disable

off(2)

offPerm(4)


94

Chapter 3

The default is on(1). 2 To configure the dynamic equalizer using a configuration file, set the arrisCmDevDEAControl object in either the CM or MTA configuration file and reboot the eMTA. When set through a configuration file, the eMTA does not save the setting in non-volatile memory.

Configuring TFTP Block Size

Increasing the TFTP block size can improve throughput when downloading upgraded firmware loads or other files. Follow these steps to change the block size. 1 In the configuration file, or using an SNMP manager, set the arrisCmDevTftpBlkSize to the desired block size. Larger block sizes provide better throughput. Valid range: 32 to 1448 octets, or 0 to use the default block size of 512. 2 If you make the change in the configuration file, reset the eMTA to force the change to take effect.


Provisioning

95

Controlling Cable Modem Functionality Use this procedure to enable and disable cable modem functionality on Touchstone eMTAs as desired.

Action


Page

Setting Allowed CPE Counts Toggling the DOCSIS Mode Controlling the WAN Isolation State Setting IPv6 Forwarding Setting DOCSIS 1.0 Fragmentation Support

Setting Allowed CPE Counts

95 96 96 97 97

The eDOCSIS specifications 〈 http://www.cablemodem.com/ downloads/specs/CM-SP-eDOCSIS-I13-070803.pdf〉 require that the default value for the MaxCpeAllowed TLV be 1, and that an MTA interface be treated as a CPE—thus, data service on a Telephony Modem that is provisioned with voice capabilities is effectively disabled by default. Follow these steps to enable data functionality. 1 Open the CM configuration file with PacketACE or another configuration editor. 2 Do one of the following to enable MTA service: • Change the MaxCpeAllowed TLV to 2 or higher. • Set the 0x02 bit of the ppCfgMtaFeatureSwitch object to exclude the MTA interface from the CPE count (automatically enabled in D11PLUS loads). Note:

The WTM552/WTM652 wireless router module (WRM) and the DTM602’s DECT module are treated as separate CPE devices, requiring either a minimum MaxCpeAllowed value of 3 for full functionality, or setting the secondary CM feature switch (arrisCmDevModemFeatureSwitch2) to bypass the WRM or DECT modules as needed. The MTA feature switch does not exclude the WRM from the CPE count.

3 Save the configuration file, then reset any affected Telephony Modems to force the change to take effect.


96

Toggling the DOCSIS Mode

Chapter 3

A Touchstone eMTA can automatically configure itself for DOCSIS 2.0 operation based on the presence of DOCSIS 2.0 upstreams. Follow these steps to manually set the desired operating mode. 1 Use the arrisCmDevEnableDocsis20 object to control the operating mode: • true(1)—enables DOCSIS 2.0 operating mode • false(2)—enables DOCSIS 1.1 operating mode (default) If you change the value using SNMP, the cable modem reboots.

You may prefer to add this MIB to the configuration file and reset the eMTA during the next maintenance window. If the MIB is in the configuration file, the eMTA only resets the first time the value changes. Note:

Model 4 and newer Telephony Modems automatically update DOCSIS settings from DOCSIS 1.1 to DOCSIS 2.0 when communicating with a DOCSIS 2.0 CMTS using either an A−TDMA or S−CDMA carrier. When the eMTA detects the DOCSIS 2.0 UCD, it switches to DOCSIS 2.0 mode, caches the downstream frequency in NVRAM, and reboots so the new settings can take effect.

Controlling the WAN Isolation State

You can use the arrisCmDevWanIsolationState object to read the state of a subscriber’s Standby button (located on the front panel of Model 4 eMTAs), or to control the subscriber’s access to the Internet. Additionally, TS4.1 and newer firmware releases can override the subscriber’s Standby button setting. Possible uses of this feature might be in response to a customer service call when the subscriber has inadvertently pressed the Standby button on the eMTA, or to disable a subscriber’s access to the Internet. 1 To read the state of the Standby button, read (GET) the value of the arrisCmDevWanIsolationState object and evaluate it as follows: • off-InactiveMode(1)—Data traffic is allowed to pass freely between the subscriber’s network and the outside network (i.e. the Internet). The Standby button is enabled. • on-ActiveMode(2)—The subscriber network is isolated from the Internet. Data traffic does not pass between the subscriber’s network and the Internet. The Standby button is enabled. • off-InActiveMode-ButtonDisabled(3)—Data traffic passes freely between the subscriber’s network and the outside network (i.e. the Internet). The subscriber’s setting of the Standby Button is disabled. • on-ActiveMode-ButtonDisabled(4)—The subscriber’s network is isolated from the Internet. The subscriber’s setting of the Standby button is disabled.


Provisioning

97

2 To override the Standby button setting and disable the subscriber’s ability to change this setting, set the arrisCmDevWanIsolationState object as follows: • offInActiveModeButtonDisabled(3)—The Standby button functionality is disabled, and data traffic is allowed to pass freely between the subscriber’s network and the outside network (i.e. the Internet). • onActiveModeButtonDisabled(4)—The Standby button functionality is disabled, and data traffic is not allowed to pass freely between the subscriber’s network and the outside network (i.e. the Internet). Note 1:

Subscribers may accidentally push the Standby button on their cable modems and then call in a trouble report stating that they have lost Internet access. Otherwise, the eMTA is operating correctly. Verifying the WAN Isolation state should be one of the first things that your support staff should check when responding to this type of trouble call.

Note 2:

Model 5 and newer Telephony Modems do not have a Standby button. However, the arrisCmDevWanIsolationState object is still valid and works as described otherwise on Model 4 and newer hardware.

Setting IPv6 Forwarding

Follow these steps to enable or disable IPv6 forwarding on the eMTA. The default setting disables forwarding. 1 Set the least significant bit (0x01) of the arrisCmDevModemFeatureSwitch object to enable IPv6 forwarding. Note:

TS6.1 does not support filtering of IPv6 packets at the eMTA.

2 Clear the least significant bit (0x01) of the arrisCmDevModemFeatureSwitch object to disable IPv6 forwarding.

Setting DOCSIS 1.0 Fragmentation Support

While DOCSIS 1.0 does not require fragmentation support, some CMTS vendors support it. Follow these steps to enable or disable DOCSIS 1.0 fragmentation support on an eMTA. The default setting enables the support. 1 Clear the 0x10 bit of the arrisCmDevModemFeatureSwitch object to enable DOCSIS 1.0 fragmentation support. 2 Set the 0x10 bit of the arrisCmDevModemFeatureSwitch object to disable DOCSIS 1.0 fragmentation support. Note:

Disabling fragmentation support may be required to allow the cable modem to register on certain older DOCSIS 1.0 CMTS units.


98

Chapter 3

Controlling MTA Functionality Use this procedure to enable and disable MTA functionality on Touchstone eMTAs as desired.

About Monitoring Functionality

The features described in this procedure are generally controlled through the MTA configuration file. See the Touchstone Telephony Management Guide for monitoring features, such as statistics and message reporting through Syslog, which may be controlled while the MTA is in service.

Action


Configuring Loop Current Configuring Gain Control Adjusting Delta Rx/Tx Gain Configuring Dial Pulse Support Configuring the Echo Cancellation Tail Length Configuring the Ringing Waveform Configuring the Dynamic RTP Port Range Configuring Non-Phase Reversed Modem Tone Handling Setting the Upstream Buffer Depth Controlling Active QoS Timeout Configuring Line Indexes Controlling Caller ID Behavior Enabling and Disabling Local VQM Configuring TDD Notification Override Enabling and Disabling Remote VQM Controlling ToS Byte Marking Controlling T.38 and Fax-Only Modes Configuring T.38 MaxDatagram Size Configuring RFC 2833 End of Event Duration Configuring Automatic Call Resource Recovery Setting Persistent Line Status

Configuring Loop Current

Page

98 99 101 101 102 102 103 103 104 104 104 105 106 106 106 107 107 108 108 108 108

Touchstone Telephony Modems support a ‘‘boost,’’ or high loop current mode to compensate for faulty CPE or wiring. Use this setting, for example, to alleviate issues related to off-hook not being detected or fax machines failing to operate properly due to increased current draw by the equipment. Loop current varies depending on boost mode and country template: • Normal mode: 23 mA


Provisioning

99

• Boost mode (Model 6 Telephony Modems and North American templates): 40 mA • Boost mode (all others): 33 mA eMTAs using North American country templates (that is, the value of the ppCfgMtaCountryTemplate object is one of northAmerica57(1), northAmerica33(17), northAmerica09(18) or northAmerica66(32)) default to high (boost) loop current. Other country templates default to normal loop current. Note:

If you set the loop current through SNMP, the eMTA does not retain the setting over reboots. If you set the loop current in the configuration file, the setting is written to NVRAM and retained over reboots. 1 To specify normal loop current (the default for non-North American loads), set the ppCfgPortLoopCurrent.line object to 1 , where line is the line number to set (beginning with .1). 2 To specify high loop current (the default for North American loads), set the ppCfgPortLoopCurrent.line object to 2. Note 1:

High loop current reduces battery hold-up times.

Note 2:

Single-line Telephony Modems (TM401, TM501, and TM601) do not support high loop current.

Configuring Gain Control

Follow these steps as necessary to configure gain control settings. 1 Adjust MTA-generated on-hook and default off-hook FSK tones (CID and VMWI) by setting the arrisMtaDevGainControlFSK object. Valid range: − 10 to 2 (dBm). Default: 0. 2 Adjust the transmit digital gain adjustment for MTA-generated onhook and default off-hook CAS tone by setting the arrisMtaDevGainControlCAS object. Valid range: − 2 to 2 (dBm). Default: 0. 3 To set off-hook FSK and CAS tone levels that are different from the on-hook levels: a Set the off-hook FSK tone level by setting the arrisMtaDevLevelControlOffHookFSK MIB object. Valid range: − 32 to − 10 (dBm). Default: − 15. b Set the off-hook CAS tone level by setting the arrisMtaDevLevelControlOffHookCAS MIB object. Valid range: − 32 to − 10 (dBm). Default: − 15. c Enable the off-hook gain settings by setting the arrisMtaDevLevelControlOffHookEnable MIB object to enable(1). The default is disable(0), which uses the established arrisMtaDevGainControlFSK and arrisMtaDevGainControlCAS objects for both on-hook and off-hook levels.


100

Chapter 3

4 Adjust the transmit digital gain adjustment for MTA-generated Call Progress tones (dial tone, busy tone, ringback, etc.) to the CPE by setting the arrisMtaDevGainControlLocalTone object. Valid range: −2 to 2 (dBm). Default: 0. 5 Adjust the transmit digital gain adjustment for MTA-generated Call Progress tones (ringback) to the network by setting the arrisMtaDevGainControlNetworkTone object. Valid range: −2 to 2 (dBm). Default: 0. 6 Adjust the transmit digital gain adjustment for MTA-generated DTMF tones to the CPE by setting the arrisMtaDevGainControlLocalDTMF object. Valid range: − 15 to 9 (dBm). Default: 0. 7 Adjust the transmit digital gain adjustment for MTA-generated DTMF tones to the network by setting the arrisMtaDevGainControlNetworkDTMF object. Valid range: − 9 to 9 (dBm). Default: 0. 8 Adjust the transmit digital gain adjustment for voice by setting the arrisMtaDevGainControlTxVoice object. Valid range: • D11PLUS loads: − 16 to 16 (dBm). • Other loads: − 2 to 2 (dBm). Default: 0. Note:

This setting does not affect local tone or FSK levels.

9 Adjust the receive digital gain adjustment for voice by setting the arrisMtaDevGainControlRxVoice object. Valid range: −2 to 2 (dBm). Default: 0.


Provisioning

Adjusting Delta Rx/Tx Gain

101

You can adjust both delta Receive gain (Rx—from the MTA to the CPE) and delta Transmit (Tx—from the CPE to the MTA) gain as necessary. Follow these steps to provision delta Rx/Tx gain.

CAUTION Service affecting Changing the delta Rx/Tx Gain from the default value based on the country template used may affect overall voice transmission quality, local tone levels, digit detection, and modem/fax tone detection. PESQ scores may also be affected when additional loss is introduced. 1 Add the following Rx/Tx Gain MIB objects to the CM configuration file, using any valid line index for the eMTA: • arrisMtaDevGainControlTxVoice • arrisMtaDevGainControlRxVoice Note:

Even though the deltaRx/Tx Gain MIB objects are defined to be line-based, setting the MIB for any valid line sets the delta gain for all lines. Also, if the same delta Rx/Tx Gain MIB object appears multiple times in the CM configuration file using different indexes, only the last one is used to set the gain settings. The valid range for the Rx/Tx Gain MIB objects is −2 dB to 2 dB, in 1 dB increments. The default value for each MIB object is 0 dB.

Configuring Dial Pulse Support

Follow these steps to configure dial pulse support on Touchstone MTAs. See ‘‘Dial Pulse Support’’ on page 48 for more information.

CAUTION Change to functionality The arrisMtaDevEndPntDialingMethod MIB object values have changed as of TS4.3. If MTA configuration files use this MIB object to enable pulse detection, upgrade the firmware first and then the configuration file during a scheduled maintenance window. Note:

In TS6.1, the arrisMtaDevEndPntDialingMethod object setting is stored in non-volatile memory when set through SNMP after the eMTA has completed registration. 1 To enable Gateway (IPDT) dial pulse support, set the arrisMtaDevEndPntDialingMethod object to 5 (pulse and DTMF detection). 2 To enable softswitch (CMS) dial pulse support, set the arrisMtaDevEndPntDialingMethod object to 3 (pulse and DTMF detection).


102

Chapter 3

3 To disable dial pulse detection, set the arrisMtaDevEndPntDialingMethod object to 1. This may be necessary in certain situations where internal house wiring problems cause occasional ‘‘phantom’’ dial pulse digits.

Configuring the Echo Cancellation Tail Length

TS4.3 increased the default echo cancellation tail length for TM402 and later MTAs from 8 ms to 32 ms. Follow these steps to configure the desired echo cancellation tail length. 1 In the MTA configuration file, add the arrisMtaDevEchoCancellerTailLength object and set it to eightMs or thir tyTwoMs as desired. 2 Reset the MTA. The MTA sets the echo cancellation tail as configured, then marks the MIB read-only.

Configuring the Ringing Waveform

TM402 and newer Telephony Modems support both trapezoidal and sinusoidal ringing waveforms when used with North American country templates. You may need to change the waveform if certain non-EIA compliant subscriber equipment does not recognize the trapezoidal waveform (in short, the phone does not ring). As of TS5.2, the following defaults apply: • North American templates: sinusoidal ringing • All other country code templates: trapezoidal ringing Note:

Non-North American country code templates using other than 20 Hz ringing do not support sinusoidal ringing. Configure the ringing waveform as follows.

CAUTION Potentially service-affecting Sinusoidal ringing is only supported for North American templates, and other templates using 20 Hz ringing, on Model 4 and later hardware. Use of this feature with other templates, or with other hardware, may result in loss of service. 1 Set the arrisMtaDevEndPntRingingWaveform object using one of the following methods: a In the MTA configuration file, add the arrisMtaDevEndPntRingingWaveform object and set it to sinusoidal or normal as desired. Then reset the MTA to have the change take effect.


Provisioning

103

b Use an SNMP manager to access the MTA and set the arrisMtaDevEndPntRingingWaveform object to sinusoidal or normal as desired. Note:

Setting this MIB in the configuration file does not write the setting to NVRAM; therefore, if you remove the MIB from the configuration file and reset the MTA, it reverts to using the trapezoidal waveform. Setting the MIB through SNMP does write the setting to NVRAM.

Configuring the Dynamic RTP Port Range

Follow these steps to configure the dynamic RTP port range. 1 Set the arrisMtaCfgRTPDynPortStar t object to the starting UDP port number in the desired range. Valid range: 1024 to 65535. Default: 49152. Note that the IANA defines the following ranges: • 0 – 1023: Well-known ports • 1024 – 49151: Registered ports • 49152 – 65535: Dynamic and private ports 2 Set the arrisMtaCfgRTPDynPortEnd object to the ending UDP port number in the desired range. Valid range: 1024 to 65535. Default: 65535.

Configuring NonPhase Reversed Modem Tone Handling

Touchstone firmware supports handling of non-phase reversed CED fax/modem tones. You may need to enable this feature to support low-speed analog modems which do not support non-phase reversed CED tones. 1 Set the arrisMtaDevDspHandleNonPhaseReversedTone object to one of the following values as appropriate: • off(1)—do not handle non-phase reversed tones. This behavior is identical to TS4.1 and earlier versions of Touchstone firmware. • onECANEnable(2) (default)—handle non-phase reversed tones with the echo canceller enabled. • onECANDisabled(3)—handle non-phase reversed tones with the echo canceller disabled. For TS5.0 MSUP and later releases: if this object is set through an SNMP manager, the eMTA stores the value in non-volatile memory. If this object is set in the configuration file, the eMTA does not store the value in non-volatile memory.


104

Setting the Upstream Buffer Depth

Chapter 3

Touchstone firmware allows for provisioning the RTP transmit buffer depth by specifying a MIB object in the configuration file. This object can be written only in the configuration file at initialization. Once MTA registration is complete, the MTA sets the RTP buffer depth and marks the MIB read-only. 1 In the MTA configuration file, add the arrisMtaDevRTPTxQueueSize object and set its value. Valid range: 2 to 4 (packets). Default: 2. Note:

The MIB setting is enforced only for RTP voice packets. The total buffer depth can increase to a maximum of 7 packets for RFC 2833 events, or for fax and analog modem call RTP packets.

2 Reset the MTA. The MTA sets the RTP transmit buffer depth as configured, then marks the MIB read-only.

Controlling Active QoS Timeout

TS6.1 allows configuration of Active QoS Timeout for DSx DQoS applications. Follow these steps to enable and set the timeout for upstream service flows.

CAUTION Service affecting Setting Active QoS timeout when using the Full PacketCable provisioning mode can impact service in undefined ways. Avoid this feature when using Full PacketCable provisioning. 1 Enable the ‘‘DSX/Access only DQoS’’ CallP Feature Switch (0x4000). Active QoS timeout is only available when DSX/Accessonly DQoS is enabled. 2 Set the arrisCmDevDocsQosParamSetActiveTimeout object to a value between 0 and 65535, representing the desired timeout (in seconds). A value of 0 disables active QoS timeout. The new timeout setting takes effect with the next call.

Configuring Line Indexes

The default ifIndex for phone lines starts at 9. Follow these steps to set the starting index to 10, as may be required for certain applications with singleline eMTAs. Note:

You can configure this feature only through the CM configuration file.

1 In the configuration file, either add the value 0x80 to the MTA Feature Switch ppCfgMtaFeatureSwitch, or set the arrisMtaDevEnableIndexTenEleven object to enable(1). 2 Reset the CM.


Provisioning

105

Upon reboot, the MTA now advertises its voice lines beginning with ifIndex 10.

On single-line MTAs, setting either MIB object changes the endpoint ID from aaln/1 to aaln/2.

Note:

Controlling Caller ID Behavior

The arrisMtaDevDefaultReasonNoCIDName MIB object specifies what data the MTA sends to the CPE device when the CID signal request includes no Caller ID name. 1 Set the MIB object either directly through a network manager, or in the MTA configuration file. Possible values are: Value

Sends

unavailable(0)

‘O’

private(1)

‘P’

sendnothing(2)

’00’

sdmf(3)

number

excludeName(4)

(blank)

Description

Caller ID displays typically show ‘‘Out of area’’ or ‘‘Unavailable.’’ This is the default for all country templates except Switzerland. Caller ID displays typically show ‘‘Private.’’ Sends NULL data to the CPE device. Sends the number in NA SDMF format. Omits name parameters or any reason for the missing name.

2 To configure the delay before sending the FSK data to the CPE (in response to an ACK from the CPE), set the arrisMtaDevOffHookFskDelay object to the desired delay time in milliseconds. Valid range: 0 to 500 ms. The default value depends on the load and selected template as follows: • North American loads: 261 ms (same value used in previous firmware versions) • European loads: 100 ms (T12 timer value) • Israel country template: 50 ms (overrides the default for both North American and European loads) Note:

The scwidDelay command in the CallP sub-menu can also display and set the delay value.

3 If you make these changes in the configuration file, restart the MTA.


106

Configuring TDD Notification Override

Chapter 3

Follow these steps to enable or disable overriding CMS requests to provide notification of TDD detection events. 1 Set the arrisMtaDevTDDReportToCMS object as follows: • disable(0): does not report detection of TDD events to the CMS. • enable(1): reports detection of TDD events to the CMS (default). 2 If you make this change in the configuration file, restart the MTA.

Enabling and Disabling Local VQM

Follow these steps to enable or disable local Voice Quality Monitoring using SNMP or the CLI (the web-based interface does not support enabling or disabling VQM). VQM is enabled by default. 1 To enable or disable VQM using SNMP, set the arrisMtaDevVqmEnable object. Use 0 to disable VQM, or 1 to enable VQM. 2 To enable or disable VQM from the CLI: a Enter the MTA submenu: mta ↵

b Use the following command to enable or disable VQM: vqLocEnable flag ↵

Where flag is 0 to disable VQM, or 1 to enable VQM. 3 To set the size of the VQM buffer, set the arrisMtaDevVqmHistorySize object. Valid range: 2 to 50 (calls). Default: 10.

Enabling and Disabling Remote VQM

Follow these steps to enable or disable remote Voice Quality Monitoring using SNMP or the CLI (the web-based interface does not support enabling or disabling VQM). Remote VQM is disabled by default. 1 To enable or disable remote VQM using SNMP, set the arrisMtaDevVqmEnableRemote object. Use 0 to disable remote VQM, or 1 to enable remote VQM. 2 To enable or disable remote VQM from the CLI: a Enter the MTA submenu: mta ↵

b Use the following command to enable or disable VQM: vqRemEnable flag ↵


Provisioning

107

Where flag is 0 to disable VQM, or 1 to enable VQM.

Controlling ToS Byte Marking

TS5.2 and later versions of Touchstone firmware set the ToS byte in RTCP packets to a value of 46 (expedited forwarding). Follow these steps to change the value of the RTCP ToS byte. 1 Using an SNMP network manager, change the arrisMtaDevRtcpTosValue object to the desired value. Valid range: 0 to 63. The ToS marking changes immediately for all RTCP packets. Note:

The value of this object is shifted two bits before being loaded into the ToS byte.

2 To make the change permanent, add the arrisMtaDevRtcpTosValue MIB object (with the desired value) to the MTA provisioning file.

Controlling T.38 and Fax-Only Modes

Follow these steps to configure T.38 fax detection and fax-only mode. See ‘‘Configuring T.38 and Fax-Only Modes’’ on page 130 for SIP-specific alternative configuration instructions. 1 Set the pktcEnNcsEndPntFaxDetection object (use the line number as an index, starting with 1) to configure whether the MTA detects CNG (calling) tones and starts T.38 mode. The default value, false(2), disables detection of CNG tones on the endpoint. Disabling CNG detection prevents the MTA from using T.38 mode, which may be desired when the fax machines are capable of Super G3 (which uses a higher transmission rate). Note:

If you make this change using an SNMP browser, the new setting takes effect on the next connection.

2 If needed, set the pktcEnNcsMinimumDtmfPlayout object to specify the minimum time, in milliseconds, that the MTA plays out a digit tone when receiving an RFC 2833 digit event on the specified endpoint. The actual play-out time is the maximum of this setting and the time specified in the RFC 2833 packet. Valid range: 40 to 100 , or 0 (the default), which always uses the time specified in the RFC 2833 packet. 3 Set fax-only mode by adding the arrisMtaDevEndPntFaxOnlyLineTimeout MIB object to the MTA configuration file. This MIB object is specific to a line, so it must be specified with the line number; for example, arrisMtaDevEndPntFaxOnlyLineTimeout.1 for line 1. The value specifies the timeout, in seconds, after which the MTA drops the call if it does not detect fax or modem tones. Valid range: 0 (disabled) to 600 seconds. The default is 0.


108

Configuring T.38 MaxDatagram Size

Chapter 3

Follow these steps to configure the MaxDatagram size for T.38. 1 In the MTA configuration file, set the ppCfgPortT38MaxDatagram object to the desired datagram size. Valid range: 160 to 65535 octets. Default: 160. 2 Reset the MTA to have the new datagram size take effect.

Configuring RFC 2833 End of Event Duration

Follow these steps to configure RFC 2833 DTMP end event duration. 1 In an SNMP manager or in the configuration file, set the arrisMtaDevDTMFEndEventForceAscending object as follows: • disable(0): Allows the event duration to be shorter than the last ‘‘interim’’ event duration. • enable(1): Forces the event duration to be at least as long as the last ‘‘interim’’ event duration. Note:

You can set this object through either the CM or MTA IP address.

2 If you set this object in a configuration file, reset the Telephony Modem to download the new configuration.

Configuring Automatic Call Resource Recovery

Follow these steps to configure automatic call resource recovery. 1 In an SNMP manager or in the configuration file, set the arrisMtaDevAutomaticCallResourceRecovery object to the desired delay time. The valid range is 0 (disables automatic recovery) to 3600 (seconds). Note:

D11PLUS loads use a default value of 60 seconds; other loads use a default of 0.

2 If you made the changes in the configuration file, reset the MTA to allow the change to take effect.

Setting Persistent Line Status

Follow these steps to set persistent line status. 1 To set line status using SNMP, set the arrisMtaDevPersistentLineStatus object to either ignore(0) or forceDisable(1). Note:

You must set this object using an SNMP manager. If this object is included in a configuration file, the MTA ignores the setting.

2 To set line status using the CLI, enter the following commands: Console> callp ↵ Call Processing> spls {line} {state} ↵


Provisioning

109

Where: line

is the line number: 1 to the number of lines supported by the Telephony elephony Modem. Modem. state

is either 0 to use normal state processing, or 1 to force-disable the line.


110

Chapte Cha pterr 3

Configuring ToD ToD Server Interaction Touchstone eMTAs interact with time of day (ToD) servers according to established standards. Touchstone firmware provides several enhancements to the standard ToD support: • Periodic Periodic resynchroni resynchronizatio zation—al n—allow lowss correction correction of eMTA eMTA clock drift. drift. • ToD timeout behavior—when behavior—when the ToD ToD server does not respond during provisioning, either retry the provisioning sequence or wait for the ToD server to respond. • ToD offset—force offset—force a change in the offset offset from UTC UTC before a scheduled scheduled DHCP Renew operation; this may be necessary in SIP deployments where the MTA MTA clock is used as a source for Calling Line Presentation Presentation (CLIP) information.

Action


Page

Configuring ToD Re-Synchronization Configuring Configurin g Provisioning ToD Timeout Configuring Configurin g ToD Offset Configuring Daylight Savings Time Policy

Configuring ToD Re-Synchronization

110 110 111 111

TS5.0 and later versions of Touchstone firmware support the ability to periodically resynchronize the eMTA eMTA’s clock with the ToD ToD server. server. The eMTA eMTA uses the same backoff backoff and retry mechanism for contacting contacting the ToD ToD server as that used during registration. registration. Follow these steps to configure this feature. 1 To enable enable re-synchron re-synchronizati ization on in a running running eMTA, eMTA, set the arrisCmDevTODSyncTimeOut object to the time (in hours) between re-synchronization attempts. Valid range: 1 to 4320 hours (180 days), or 0 (default) to disable resynchronization. 2 To enable enable re-synchro re-synchronizat nization ion throug through h the configurat configuration ion file, file, add the arrisCmDevTODSyncTimeOut object to the configuration file and reboot the eMTA.

Configuring Provisioning ToD Timeout

PacketCab PacketCable le standards standards require require an eMTA eMTA to obtain obtain its time and date date from a ToD server. server. When no ToD server is available, available, eMTAs eMTAs can either either continually continually retry the provisioning sequence until the ToD server responds (default), or stop the the provision provisioning ing sequence sequence until until the ToD ToD server server responds. responds. Follow Follow these steps to configure the desired response.


Provisioning

111

CAUTION Service affecting This procedure procedure requires requires an MTA MTA reset to take effect. effect. Perform Perform these steps steps only during a scheduled maintenance window. 1 To stop the the provision provisioning ing sequence sequence on ToD ToD timeout, timeout, set the the 0x0000200 bit of the MT MTA Feature switch to to 1 in the provisioning file. 2 To retry the provisio provisioning ning sequence sequence on ToD ToD timeou timeout, t, set set the the 0x0000200 bit of the the MTA MTA Feature Feature switch switch to 0 in the provisioning file. 3 Reset Reset the the MTA MTA to load load the the new new featur featuree switc switch h valu value. e.

Configuring ToD Offset

Time of Day changes, including for Daylight Savings Time shifts, normally occur during during DHCP DHCP Renew Renew operation operations. s. It may be necessa necessary ry to manually manually change the offset, offset, especially in SIP deployments deployments where where the MTA MTA clock is used as a source for Calling Line Presentation (CLIP) information. 1 To change change the the ToD ToD off offset set,, set the the arrisCmDevTODTimeOffset MIB object object to the desired desired offset offset (in seconds seconds). ). Valid range: range: −43200 (−12 hours) to 46800 (+13 hours). Note:

This object is only accessible accessible through the CM IP address. address.

2 When a DHCP exchange exchange occurs (Renew, (Renew, Rebind, or initial), initial), the offset offset specified in the DHCP exchange overrides the value set in this MIB object.

Configuring Daylight Savings Time Policy

TS6.1 supports local (eMTA-based) provisioning of Daylight Savings Time (DST) policy, using the arrisCmDevDSTPolicy MIB MIB obje object ct.. Foll Follo ow thes thesee steps to configure DST policy. 1 Make the following following configurati configuration on chang changes es to ensure ensure DST policy policy works as intended: • Disable Disable any any DHCP server server functio functionalit nality y that would would change change the time time offset offset for DST DST.. For exampl example, e, if your your time zone zone is EST EST,, the offset offset should reflect the (non-summer) EST setting. • Configure ToD ToD re-synchronization re-synchronization (see ‘‘Configuring ‘‘Configuring ToD ToD Re-Synchroni chronizat zation ion’’’ above above)) to refres refresh h the eMT eMTA ToD setti setting ng befor beforee the DST change.


112

Chapte Cha pterr 3

2 In the CM configu configurat ration ion file, file, add add the arrisCmDevDSTPolicy MIB object. The content of the object is: start= M / D D/W H / H ;end= ;end= M D / D/W H / H

where. . .

is the. . .

M D

month: day:

W H

weekday: hour:

1 (Jan) to 12 (Dec) ±1 to 31. 31. If W is 0, the the day day must must be pospositive and indicates the exact day of the month. month. If W is not 0, DST starts starts or ends ends on or after the specified weekday following the day if positi positive ve,, or on or before before the specified weekday if negative. negative. 1 (Mon) to 7 (Sun), or 0 for the exact day 0 (midnight) to 23 (11 p.m.)

For example, the the USA DST policy since 2007 would be expressed as: as: start=3/8/7/02; end=11/1/7/02

3 If you have have made this this change change in in the configu configuratio ration n file, restar restartt the eMTA eMTA to allow allow the chan change ge to take take effec effect. t.


Provisioning

113

Configuring Jitter Buffers Touchstone firmware provides three sets of MIB objects to adjust the MTA jitter buffer: buffer: • Standard— Standard—used used for for typical typical voice voice calls. calls. • Voice Band Data (VBD)—used (VBD)—used for calls involving involving data transfer, transfer, including fax, modem, and POS terminals. • Custom—pr Custom—provi ovides des more precise precise contro controll over over jitter jitter buff buffer er settin settings. gs. Custom settings may be useful under certain network conditions or applications. If you change change these MIB objects objects with with an SNMP manager manager,, the new settings settings take effect starting with the next next phone call.

Action

Perform any any of the following following tasks as necessary. necessary. Task

Page

Setting Standard Jitter Buffer Parameters Setting Voice Band Data Jitter Buffer Parameters Parameter s Configuring Custom Jitter Buffer Settings

Setting Standard Jitter Buffer Parameters

113 113 114

Follow these steps to set standard standard jitter buffer buffer parameters. 1 Set the arrisMtaDevVPJitterBufferMode object to either 1 (adaptive, the default) or 2 (fixed). 2 Configure the nominal nominal voice voice call jitter jitter buffer buffer size by setting setting the arrisMtaDevVPNomJitterBuffer object. object. The value value represe represents nts a mulmultiple tiple of the packetization packetization rate. rate. Valid range: range: 1 to 4. Defau efault lt:: 1. 3 Configure the maximum voice call jitter buffer buffer size by setting the arrisMtaDevVPMaxJitterBuffer object. The value represents a multiple of the packetiza packetization tion rate. rate. Valid range: range: 1 to 4. Defau efault lt:: 3. Note:

The minimum jitter buffer buffer setting must be less than than the nominal setting, which in turn must be less than the maximum jitter buffer setting.

Setting Voice Band Data Jitter Buffer Parameters

Follow these steps to enable and configure jitter buffer buffer and override settings for Voice Voice Band Data (fax, modem, POS terminal) calls. 1 Set the arrisMtaDevVbdOverwriteLineBitmap to control jitter buffer overrid overridee on each line. line. The least least signifi significant cant bit bit controls controls line 1, so a 3 enable value of 3 enabless overr override ide on on lines lines 1 and 2. On a TM512 TM512,, a value value of 0xfff enables override on all 12 lines.


114

Chapte Cha pterr 3

2 Configure the minimum, nominal, and maximum jitter buffer buffer settings settings for Voice Voice Band Data calls by by setting the following following objects. objects. The valid range for all three objects is 10 to 160 ; the following following table table shows shows the default value for each object. Object

Default Value

Description

arrisMtaDevVbdOverwriteMinJitterBuffer

20

arrisMtaDevVbdOverwriteNomJitterBuffer

70

arrisMtaDevVbdOverwriteMaxJitterBuffer

160

Minimum fax/modem call jitter buffer buffer setting. Nominal fax/modem call jitter buffer buffer setting. Maximum fax/modem call jitter buffer setting.

Note:

The minimum jitter buffer buffer setting must be less than than the nominal setting, which in turn must be less than the maximum jitter buffer setting.

Configuring Custom Jitter Buffer Settings

Follow these steps to configure custom jitter buffer buffer settings. Note:

Custom jitter jitter buffer settings use units of milliseconds, milliseconds, rather rather than packet multiples used by the standard and VBD methods. 1 Enable custom custom jitter jitter buffer buffer settings by setting the arrisMtaDevCustomJitterBufferEnabled object to on(1). The default default is off(0). When custom jitter buffer settings are enabled, the default settings are: • Minimum: Minimum: 5 milli millisecon seconds ds • Nominal: Nominal: 10 milliseco milliseconds nds • Maximum Maximum:: 60 60 milli millisecon seconds ds 2 Configure the minimum, minimum, nominal, nominal, and maximum maximum custom custom jitter buffer buffer settings by by setting the following following objects. objects. The valid valid range for all three objects is 5 to 160 (milliseconds).


Provisioning

115

Provisioning SIP Support TS6.1 provides SIP support for MTAs. This feature requires modifications to the CM configuration file and a new MTA configuration file. This feature requires a specialized firmware load. See the Touchstone Telephony Feature Guide for details about SIP support.

Per-Line Proxy/Registrar Objects

The following table describes MIB objects for per-line proxy/registrar support. These objects must be set in the configuration file to be effective. For details about the SIP registration process, see ‘‘SIP Registration Behavior’’ on page 36. MIB Object

Description (Per-line)

Global

Per-line

sipCfgRegistrarAdr

sipCfgPortRegistrarAdr

Registrar Server

sipCfgPortRegistrarPort

Registrar Server port. The per-line setting is only valid if paired with a setting for sipCfgPortRegistrarAdr.

sipCfgRegistrarType

sipCfgPortRegistrarType

The type of address specified by the sipCfgPortRegistrarAdr object. It is

only valid if paired with a setting for sipCfgPortRegistrarAdr. When both

objects are defined in the configuration file, this value overrides the setting in the sipCfgRegistrarType for this line. Valid values for this setting are ipv4(0) and dns(1). sipCfgProxyAdr

sipCfgPortProxyAdr

Proxy Server address

sipCfgPortProxyPort

Proxy Server port. It is only valid if paired with a setting for sipCfgPortProxyAdr .

sipCfgProxyType

sipCfgPortProxyType

The type of address specified by the sipCfgPortProxyAdr object. It is only

valid if paired with a setting for sipCfgPortProxyAdr. When both objects are

defined in the configuration file, this value overrides the setting in sipCfgProxyType for this line. Valid values

for this setting are ipv4(0) and dns(1).

Use the line number as the index for each object; for example, sipCfgPortProxyAdr.2 specifies the proxy IP address for line 2. Per-line proxy/registrar is a device-only change; it cannot be changed using post-provisioning.

Note:


116

T.38 Provisioning Overview

Chapter 3

The MIB object sipCfgPortT38Mode controls T.38 behavior. It allows the following values: Value t38Off(1) t38Loose(2)

t38Strict(3)

Description

(default) Disables T.38. Enables T.38 Loose mode. In loose mode, the MTA can use T.38 for fax transmission whether or not the remote endpoint has indicated T.38 support. Enables T.38 Strict mode. In strict mode, the MTA can use T.38 for fax transmission only if the far end indicated support for T.38 during session negotiation.

The MIB object arrisMtaDevEndPntFaxOnlyLineTimeout configures faxonly mode for a line. This value of this object specifies the time, in seconds, to wait for fax or modem tones after receiving the SDP from the remote endpoint. If the time expires before detecting fax or modem tones, the MTA drops the call. Valid range: 0 to 600. The MIB object sipCfgPortMaxT38HSRedLevel sets the maximum highspeed redundancy level used for T.38 fax relay, in both send and receive directions. The value of this object is the number of older data packets included in each T.38 datagram when transferring fax data. The actual redundancy level used is determined by negotiation with the remote endpoint. Valid range: 0 to 2. Default: 1.

Global Call Feature Control

The sipCfgPortFeatureSettings object allows you to control operation of the following call features: • outbound Caller ID • anonymous call rejection • call waiting • three-way calling The sipCfgPortFeatureSettings object is structured as a collection of bit flags, as shown in the following table. The default value is 0.


Provisioning

117

Bit

Description

0x40

callerIdPermanentDisable Set this bit to set the default outbound Caller ID method to ‘‘restrictive.’’ The default setting presents Caller ID. anonCallRejectionEnable Set this bit to enable anonymous call rejection. The subscriber can use a ‘‘star’’ code to disable anonymous call rejection if desired. The default setting permits anonymous calls. callWaitingPermanentDisable Set this bit to disable Call Waiting. The subscriber can use a ‘‘star’’ code to enable Call Waiting if desired. The default setting is to enable Call Waiting. threeWayCallingDisable Set this bit to disable hook flash processing during an active call. The default setting is to allow hook flash processing. callIdReceiptDisable Set this bit to disable local CallerID display.

0x20

0x10

0x08

0x04 0x02

callTransferEnable Set this bit to enable Call Transfer. The bit can only be set in the configuration file.

Two objects control the persistence of Call Waiting settings: sipCfgCallWaitingStarCodeSurvivesReset Set this object to true(2) to enable storage of the Call Waiting Permanent Disable state in non-volatile memory. The default is false(1). Note:

If a subscriber disables Call Waiting (using a star code) with this object enabled, and the Telephony Modem is subsequently reissued to another subscriber, the new subscriber may assume that Call Waiting is disabled.

sipCfgResetCallWaitingStarCode Set this object to 0xFFFFFFFF, using an SNMP browser, to clear the Call Waiting Permanent Disable state from non-volatile memory for all lines.

Per-line Call Feature Control

Ten MIB objects provide per-line control over common calling features, allowing subscribers to order each feature separately. Each object is a map of 32 bits; the least significant bit represents line 1. Setting a bit to 0 disables the corresponding feature for that line. These MIB objects must be set in the MTA configuration file, and are not persistent across reboots. The default value for all these objects is 0xFFFFFFFF (feature enabled on all lines).


118

Chapter 3

Feature

MIB Object

sipCfgCallerIdDisplayCapability Caller ID Display sipCfgCallerIdSendCapability Caller ID Send Anonymous Call Rejection sipCfgAnonCallRejectionCapability sipCfgCallWaitingCapability Call Waiting sipCfgThreeWayCallCapability Three-way Calling sipCfgCallTransferCapability Call Transfer sipCfgCallForwardCapability Call Forwarding

Call Return Call Redial Call Hold

sipCfgCallReturnCapability

sipCfgCallRedialCapability sipCfgCallHoldCapability

Each Telephony Modem ignores bits beyond its line capacity. For example, on a TM602 Telephony Modem, 0x00000003 is equivalent to 0xFFFFFFFF.

E.164 Address Considerations

Touchstone eMTAs, running TS6.1 MSUP3 or later SIP loads, support display of E.164 addresses in Caller ID. The eMTA removes a leading + character, as well as any visual-separator characters, in the E.164 address. The visual-separator string is defined as follows: visual-separator = "-" / "." / "(" / ")" Note:

Action

E.164 behavior, and the visual-separator string, are not configurable.

Perform the following tasks as necessary: Task

CM Configuration File Changes MTA Configuration File Changes Setting up Timers Configuring Per-Line Proxy and Registrar Post-Provisioning SIP Lines Specifying a SIP Domain Name

CM Configuration File Changes

Page

118 119 121 123 123 124

Follow these steps to modify the cable modem configuration file for SIP support. 1 Modify the PcIpClassification MIB. The Classification for Upstream and Downstream packets should be set up with a different port number to indicate the correct SIP source port(s). PcIpSourcePortStart and PcIpSourcePortEnd should be set to 5060 in both UpstreamPacketClassification and DownstreamPacketClassification. See Appendix A for a sample configuration file lookup.


Provisioning

119

2 (optional) Set the arrisMtaCfgRTPDynPortStart and arrisMtaCfgRTPDynPortEnd MIBs to the desired port range used for sending SIP RTP voice packets. The valid range for the start and end ports is 1024 to 65535. The default range is 49152 to 65535.

MTA Configuration File Changes

Follow these steps to enable SIP support in the MTA configuration file. 1 Modify the ppCfgMtaCallpFeatureSwitch MIB. To use QoS for a SIP eMTA load the value of the feature switch must be set to 0x4020 or decimal 16416. If these bits are not set in the feature switch, the RTP packets are transmitted using Best Effort. Other QoS specific settings may be needed depending on the CMTS (and its firmware load) used. 2 Enable the MTA device by modifying the pktcMtaDevEnabled MIB. The MIB is used to control the MTA device; it is not line specific. The value has to be set to true to provide dial tone on individual lines. 3 To enable individual lines, set the ifAdminStatus object for the line to 1 and also set the user name field for the corresponding line. The object ifAdminStatus.9 corresponds to line 1, ifAdminStatus.10 corresponds to line 2, and so on. 4 Add a ppcfgMtaCountryTemplate MIB setting to change tones, line card configuration, and certain Euro-PacketCable defaults (such as CallerID and VMWI) to match local requirements. 5 Enter the SIP user name by modifying the sipCfgPortUserName MIB. This is the user name; it should be the phone number for that line of the MTA. This will be used in the caller ID number at a later date. 6 For line specific provisioning, sipCfgPortUserName.1 and .2 represent the different line numbers. The user name must be less than 255 characters. If a string contains any special characters, the entire string must be enclosed within double quotes. To enable service, this must be set along with the pktcMtaDevEnabled set to true as well as the ifAdminStatus set to true for the line. 7 Enter the display name by modifying the sipCfgPortDisplayName object. This is the display name in the SIP messages that will be used for the caller name delivery at a later date. The name must be less than 255 characters. If a string contains any special characters the entire string must be enclosed within double quotes "". 8 Enter the login name by modifying the sipCfgPortLogin object. The login name is to be specified for each device to meet the requirements for HTTP digest authentication. The login is provisioned in the SIP configuration file for the eMTA. To provide login name privacy, this setting when read displays as "XXXXXXX" (255 Max).


120

Chapter 3

9 Enter the password by modifying the sipCfgPortPassword object. The password is the paired requirement for the HTTP authentication on SIP messages. The string can be set only when downloading the configuration file. In order to provide password privacy, this setting when read displays as "XXXXXXX" (255 Max). 10 Enter the interface admin status by modifying the ifAdminStatus MIB. For SIP eMTAs, ifAdminStatus.9 is for line 1, ifAdminStatus.10 is for line 2, and so on. Both values need to be set to 1 to enable the interfaces, same as the existing NCS settings. To bring the MTA lines into service, the pktcMtaDevEnabled flag has to be set to true and a value must be set for the sipCfgPortUserName for the corresponding line. 11 Enter the SIP proxy server address and type by modifying the sipCfgProxyAdr and the sipCfgProxyType objects. Specify the SIP proxy server address using either DNS or IPv4 format. If the proxy type is set to DNS, then the domain name can be used. If the IPv4 address format is used, specify a regular IP address. The port number is optional with a default value set to 5060. The correct pair of information (proxy address and type) is required for successful provisioning. No default value is assumed. 12 Enter the SIP registrar address and type by modifying the sipCfgRegistrarAdr and sipCfgRegistrarType MIBs. Specify the SIP registration server (registrar) address using either DNS or IPv4 format. The registrar can be the same address as the proxy server, but it will have to be specified again. If the registrar type is set to DNS, then the domain name can be used. If the IPv4 address format is used, specify a regular IP address. The port number is optional with a default value set to 5060. The correct pair of information (registrar address and type) is required for successful provisioning. No default value is assumed. 13 Enter the digit map specification by modifying the sipCfgDigitMap object. The digit map support on ARRIS SIP MTA is specified in the configuration file using TLV43 and sub-TLV69. It applies to all the lines on the Telephony Modem. The format of the string is the same as a digit map used in MGCP. It can be set only in the configuration file. The maximum length for the digit map is 2048 characters. 14 If desired, modify the digit map timers: • Tpar (partial dial time-out)—modify the pktcNcsEndPntConfigPartialDialTO object. The default is 16 seconds.

• Tcrit (critical dial timeout)—modify the pktcNcsEndPntConfigCriticalDialTO object. The default is 4 seconds.


Provisioning

121

Note:

SIP loads support the NCS digit map timers.

15 Set the SIP call feature switch by modifying the sipCfgSipFeatureSwitch object. Each bit corresponds to a supported SIP call feature. See ‘‘SIP Feature Switch’’ on page 71 for valid settings. The default value is 0. 16 Enter the SIP provisioned CODEC by modifying the sipCfgProvisionedCodecArray object. This is the list of CODECs offered in the OFFER SDP. The order of this list is also the order of preference used in the OFFER SDP. The CODEC list is a string separated by semi-colons ’;’ for example ’PCMU;PCMA;G726-32’. The supported CODECs are PCMU, PCMA, G728, G729, G729E, G726-16, G726-24, G726-32, G726-40, and telephone-event. The default string is ‘‘PCMU;PCMA.’’ 17 Enter the packetization rate by modifying the sipCfgPacketizationRate object. The supported packetization rates are 10 and 20 milliseconds. The default value is 20ms. 18 (optional) Set the arrisMtaCfgRTPDynPortStart and arrisMtaCfgRTPDynPortEnd objects to the desired port range used for sending SIP RTP voice packets. The valid range for the start and end ports is 1024 to 65535. The default range is 49152 to 65535. 19 Globally enable or disable calling features, if desired, by adding the sipCfgPortFeatureSettings object. See ‘‘Call Feature Control’’ on page 125 for a list of calling features this this object controls. 20 Enable or disable calling features on a per-line basis, if desired, by adding the sipCfg featureCapability object for the specific features. See ‘‘Per-line Call Feature Control’’ on page 117 for a list of calling features that can be enabled or disabled on each line.

Setting up Timers

Touchstone firmware provides MIB objects for controlling the registration and retransmission (T1) timers. These objects must be set in the MTA configuration file. Note:

The default values for these objects correspond to RFC 3261 guide-

lines. TS6.1 and later versions of Touchstone firmware also provide MIB objects for controlling the session expiry and registration expiry timers. 1 To configure the registration wait time, set the sipCfgRegTimerMin and sipCfgRegTimerMax objects to the desired minimum and maximum wait times. The defaults for these objects are 0 and 1800 seconds, respectively. At startup, an MTA waits for a random amount of time (bounded by these objects) before beginning registration.


122

Chapter 3

2 To change the T1 timer value, in milliseconds, set the sipCfgT1 object. T1 is the base interval for the exponential back-off algorithm, used for retransmitting INVITE messages. Default: 500 (ms). 3 To change the number of transmission attempts for outgoing INVITE messages, set the sipCfgMaxRetrans object. The default is 7. The defaults for this object and sipCfgT1 provide the following retransmission timing: a Initial INVITE (0 s) b First retransmission (0.5 s) (500 ms delay) c Second retransmission (1.5 s) (1 s delay) d Third retransmission (3.5 s) (2 s delay) e Fourth retransmission (7.5 s) (4 s delay) f Fifth retransmission (15.5 s) (8 s delay) g Sixth (final) retransmission (31.5 s) (16 s delay) 4 To specify a preferred session expiry timeout value, set the sipCfgSessionExpires object to the desired value (in seconds). When this object is set, the Telephony Modem configures the SIP INVITE message depending on the value of the object: Value

0 1–89 90+

INVITE Behavior

No Session-Expires header included. The Session-Expires header includes a value of 1800. The Session-Expires header includes the value specified in the object.

The default is 1800 seconds. Set this object to 0 to allow the proxy to control the session expiry timer. 5 To specify a suggested registration expiry timer value, set the sipCfgRegExpires object to the desired value. The Telephony Modem includes the specified expiry value in the REGISTER request contact header. The actual expiry time is the lesser of the suggested value and the expiry value returned in the 200 OK response. The default value is 0, which omits the expiry value from the REGISTER request.


Provisioning

Configuring PerLine Proxy and Registrar

123

Follow these steps to provision per-line proxy and registrar. Each MIB object specified must be set in the MTA configuration file. These objects override the default proxy and registrar settings, so any line that does not specify per-line MIB objects uses the default proxy and registrar. 1 Override the default proxy address, port, and address type by setting the sipCfgPortProxyAdr, sipCfgPortProxyPort, and sipCfgPortProxyType objects in the MTA configuration file; for example: { SnmpMIB sipCfgPortProxyAdr.line ”host ” } { SnmpMIB sipCfgPortProxyPort.line port } { SnmpMIB sipCfgPortProxyType.line type }

Where: • line is the line number to use the override; • host and port are the IP address or FDQN, and port number of the SIP proxy; • type is the IP address type (0 for IPv4 and 1 for DNS). 2 Override the default registrar address, port, and address type by setting the sipCfgPortRegistrarAdr, sipCfgPortRegistrarPort, and sipCfgPortRegistrarType objects in the MTA configuration file; for example: { SnmpMIB sipCfgPortRegistrarAdr.line ”ipaddr ” } { SnmpMIB sipCfgPortRegistrarPort.line port } { SnmpMIB sipCfgPortRegistrarType.line type }

Where: • line is the line number to use the override; • ipaddr and port is the IP address and port number of the SIP registrar; • type is the IP address type (0 for IPv4 and 1 for DNS). 3 Restart the MTA to make the per-line proxy/registrar settings take effect.

Post-Provisioning SIP Lines

Follow these steps to change the provisioning status of one or more lines without rebooting the MTA. Note 1:

This task applies only to line-level parameters.

Note 2:

TS6.1 allows provisioning status to change without affecting calls in progress; previous versions would take lines out of service during the update. The following MIB objects require a restart of the SIP stack and are not updated by this feature:


124

Chapter 3

• sipCfgProxyAdr • sipCfgProxyType • sipCfgRegistrarAdr • sipCfgRegistrarType • sipCfgT1 • sipCfgT2 • sipCfgT4 • sipCfgGenLing er • sipCfgInviteLinger • sipCfgTimerF • sipCfgMaxRetrans 1 Create a configuration file containing the line-level parameters to change, and make the file available for download on a reachable TFTP server. 2 Using an SNMP network manager, set the arrisMtaDevSipConfigFileURL object to the URL of the configuration file. 3 Using an SNMP network manager, set the arrisMtaDevSipDwnldConfig object to on(2). The MTA downloads the configuration file and applies the line-level changes.

4 To make the configuration changes permanent, modify the standard configuration file to reflect the changes. Note:

If the post-provisioning changes are not copied to the standard configuration file, the MTA loses those changes when re-initialized.

Specifying a SIP Domain Name

Follow these steps to specify a SIP domain name other than the domain specified in the proxy or provisioned FQDN. 1 Add the sipCfgDomainOverride object to the configuration file. This object must contain the desired domain name. Note:

When this object is set, the eMTA ignores the ‘‘Domain Override" SIP Feature Switch setting.

2 Restart the MTA to download and apply the updated configuration.


Provisioning

125

Provisioning SIP Features Use this procedure to configure end-user features with SIP loads.

Requirements

To provision SIP features, you must first modify the CM and MTA configuration files as described in ‘‘Provisioning SIP Support’’ on page 115.

Call Feature Control

The sipCfgPortFeatureSettings object allows you to control operation of the following call features: • outbound Caller ID • anonymous call rejection • call waiting • three-way calling The sipCfgPortFeatureSettings object is structured as a collection of bit flags, as shown in the following table. The default value is 0. Bit

Description

0x40

callerIdPermanentDisable Set this bit to set the default outbound Caller ID method to ‘‘restrictive.’’ The default setting presents Caller ID. anonCallRejectionEnable Set this bit to enable anonymous call rejection. The subscriber can use a ‘‘star’’ code to disable anonymous call rejection if desired. The default setting permits anonymous calls. callWaitingPermanentDisable Set this bit to disable Call Waiting. The subscriber can use a ‘‘star’’ code to enable Call Waiting if desired. The default setting is to enable Call Waiting. threeWayCallingDisable Set this bit to disable hook flash processing during an active call. The default setting is to allow hook flash processing. callIdReceiptDisable Set this bit to disable local CallerID display. callTransferEnable Set this bit to enable Call Transfer. The bit can only be set in the configuration file.

0x20

0x10

0x08

0x04 0x02


126

Proxy Dialing Features

Chapter 3

Some dialing features require the MTA to handle the tones, but the proxy handles the actual messaging. These are known as hybrid features. Five MIB objects control the setup and requirements for hybrid dialing features. The index number of each object groups the objects by dialing feature. These objects replace the sipCfgDialProxyMap object supported in loads prior to TS5.2. sipCfgDialProxyNumber The dialing feature number. See the table below for dialing feature values. sipCfgDialProxyCode A string containing the dialing code that activates the feature (for example, ‘‘*88’’). sipCfgDialProxyTone The response tone; either stutterTone(1) or dialTone(2). sipCfgDialProxyActive A 32-bit string that identifies which lines enable the dialing feature. The least significant bit corresponds to line 1; for example, the value 3 activates the dialing feature on lines 1 and 2. sipCfgDialProxyMessageType For a proxy-based dialing feature, determines the type of message sent to the proxy: invite(1) or refer(2). Most dialing features should use invite(1). sipCfgDialProxyMethod (optional) Determines how the dialing code is passed to the proxy: default(0) prepends the dialing code to the dial string; pc20(1) sends the dialing code to the proxy as the host of the SIP URI and the dial string in a user parameter in the SIP URI.

Supported Dialing Features

Supported dialing features are: Value

Feature

anonCallReject(1)

Anonymous Call Reject (ANNCJ)

anonCallRejectDisable(2)

Anonymous Call Reject Disable (ANCJD)

callForwardBusy(30)

Call Forward Busy (CALBE)

callForwardBusyDisable(31)

Call Forward Busy Disable (CALBD)

callForwardUncond(32)

Call Forward Fixed/Variable (Unconditional) (CALFV)

callForwardUncondDisable(33)

Call Forward Fixed/Variable Disable (CFFDS)

callForwardNoAnswer(34)

Call Forward No Answer (CALFN)

callForwardNoAnswerDisable(35)

Call Forward No Answer Disable (CFNAD)

warmline(36)

Warmline

warmlineDisable(37)

Disable Warmline

callReturn(50)

Call Return (CALRT)


Provisioning

127

Value

Action

Feature

callReDial(60)

Call Redial

callHold(61)

Call Hold

repeatDialingEnable(62)

Enable Repeat Dialing

repeatDialingCancel(63)

Cancel Repeat Dialing

callWaitTempDisable(70)

Call Waiting Temp Disable (CALWD)

callWaitPermDisableToggle(71)

Call Waiting Permanent Disable Toggle (CLWPD)

callWaitPermanentDisable(72)

Call Waiting Permanent Disable

callWaitPermanentEnable(73)

Call Waiting Permanent Enable

callerIDPermBlockToggle(90)

Caller ID Permanent Block Toggle (CIDPB)

callerIDTempEnable(91)

Caller ID Temp Enable (CIDTE)

callerIDTempBlock(92)

Caller ID Temp Block (CIDTB)


Page

Setting up Dialing Features Configuring Warmline or Hotline Configuring Repeat Dialing Configuring T.38 and Fax-Only Modes Configuring Distinctive Ring/Alert Tones Specifying an Emergency Number Specifying a BYE Delay

Setting up Dialing Features

127 128 129 130 130 131 131

Add the MIB objects described below to the MTA configuration file to set up dialing features. The sipCfgDialFeatMap MIB object, provided in earlier loads, is supported for backwards compatibility but no longer documented. The MIB objects for each feature are distinguished by the index; for example, sipCfgDialFeatName .1 and sipCfgDialFeatName .2 are two different features. Note:

Certain dialing features, including Hotline, Warmline, and Repeat Dialing, require further configuration. See the appropriate task for any extended configuration required. 1 Add the sipCfgDialFeatName object to enable particular dialing features. 2 Add the sipCfgDialFeatCode object to define a dialing code for a particular feature. You can specify up to three codes, separated by a comma, for each feature. For example, use *70,1170 to allow either *70 or 1170 to activate a feature. 3 Add the sipCfgDialFeatTone object to specify the confirmation tone used when activating a feature. The choices are stutterTone (default) and dialTone.


128

Chapter 3

4 Add the sipCfgDialFeatActive object to assign a feature to one or more lines on the MTA. The value for this object is a bit mask; each bit represents one line. The least significant bit corresponds to line 1. Examples: A value of 0.0.0.3 enables the dialing feature for line 1 and line 2. A value of 0.0.0.2 enables the feature only for line 2. 5 Set the sipCfgDialFeatMode object to enable the feature for the appropriate dialing phases. This object is a set of bits: Bit Value

Description

0x02 0x01

Busy Initial dialing

These bits can be combined; a value of 3 allows the dialing code to be used both during initial dial tone and during a busy signal. The default is 1. 6 For hybrid features—those features where the MTA handles the tones, but the proxy handles the actual messaging—add the objects described in ‘‘Proxy Dialing Features’’ on page 126.

Configuring Warmline or Hotline

The SIP load includes support for specifying a hotline or warmline number in the configuration file. A hotline automatically dials the specified number as soon as the specified line goes off-hook; a warmline automatically dials the specified number after providing dial tone for a specified amount of time. Add the objects described below to the MTA configuration file to set up a hotline or warmline for a specific line. For an example configuration, see ‘‘SIP MTA Configuration File Example’’ on page 221. 1 In the configuration file, set the sipCfgPortWarmOrHotlineNumber object to the phone number to dial. This object is specific to a line, so it must be specified with the line number; for example, sipCfgPortWarmOrHotlineNumber.2 for line 2. 2 In the configuration file, set the sipCfgPortWarmLineTimeout object to the timeout value (in seconds) for a warmline, or to 0 for a hotline. This object is specific to a line, so it must be specified with the line number; for example, sipCfgPortWarmLlineTimeout.1 for line 1. 3 To allow the subscriber to specify a warmline number, add an entry to the sipCfgDialFeatTable in the configuration file. The following example specifies *53 as the feature code for warmline dialing, enabling the feature on lines 1 and 2. SnmpMib = sipCfgDialFeatName.15 warmline SnmpMib = sipCfgDialFeatCode.15 "*53" SnmpMib = sipCfgDialFeatTone.15 stutterTone SnmpMib = sipCfgDialFeatActive.15 hexstr: 0.0.0.3


Provisioning

129

The sipCfgDialFeatActive object specifies the lines on which the specified feature is active. It consists of a series of bits, with the least significant bit corresponding to line 1. Other effects are: • Setting the warmline feature code uses the value set in the sipCfgPortWarmLineTimeout MIB object for the timeout. If the object is not set for a line in the configuration file, the default is 5 seconds. • The sipCfgPortWarmOrHotlineNumber MIB object, whether set in the configuration file or by the subscriber, shows the currentlyconfigured warmline number. If the subscriber disables warmline, This object contains a 0-length string.

Configuring Repeat Dialing

Follow these steps to configure the Repeat Dialing feature. 1 Add two entries to the sipCfgDialFeatTable in the MTA configuration file, to set up and cancel Repeat Dialing. The following example enables Repeat Dialing when the subscriber presses *5 during a busy signal, and cancels Repeat Dialing with #5: /* enable SnmpMib = SnmpMib = SnmpMib = SnmpMib = SnmpMib =

Repeat Dialing */ sipCfgDialFeatName.1 Integer 62; sipCfgDialFeatCode.1 String "*5"; sipCfgDialFeatTone.1 Integer 1; /* stutter */ sipCfgDialFeatActive.1 HexString 0x00000003; sipCfgDialFeatMode.1 Integer 2; /* busy mode only */

/* cancel SnmpMib = SnmpMib = SnmpMib = SnmpMib =

Repeat Dialing */ sipCfgDialFeatName.2 Integer 63; sipCfgDialFeatCode.2 String "#5"; sipCfgDialFeatTone.2 Integer 1; /* stutter */ sipCfgDialFeatActive.2 HexString 0x00000003;

2 Add the sipCfgBusyDigitMap MIB object to the MTA configuration file, specifying the strings that can be matched while the MTA is playing a busy tone: SnmpMib = sipCfgBusyDigitMap.0 String "*x|#x";

3 Add the following MIB objects to the MTA configuration file to set related timers: sipCfgRepeatDialingInterval The time, in seconds, between repeat dialing attempts. Default: 30 seconds. sipCfgRepeatDialingTimeout The time, in seconds, that Repeat Dialing is active (and unsuccessful) before the MTA cancels the feature. Default: 1800 seconds.


130

Chapter 3

sipCfgRepeatDialingSessionProgressTimer The time, in seconds, the MTA waits after receiving a ‘‘183 Session Progress’’ provisional response before alerting the subscriber. This delay is needed because many PSTN calls receive this response before receiving a negative INVITE. Default: 2 seconds.

4 Reset the MTA to enable the feature.

Configuring T.38 and Fax-Only Modes

Follow these steps to configure T.38 and fax-only modes for a line. Each MIB object specified must be set in the MTA configuration file. 1 Set the T.38 mode by adding the sipCfgPortT38Mode MIB object to the MTA configuration file. This MIB object is specific to a line, so it must be specified with the line number; for example, sipCfgPortT38Mode.2 for line 2. Valid settings are: t38Off(1), t38Loose(2), and t38Strict(3). The default is t38Off. 2 Set fax-only mode by adding the arrisMtaDevEndPntFaxOnlyLineTimeout MIB object to the MTA configuration file. This MIB object is specific to a line, so it must be specified with the line number; for example, arrisMtaDevEndPntFaxOnlyLineTimeout.1 for line 1. The value specifies the timeout, in seconds, after which the MTA drops the call if it does not detect fax or modem tones. Valid range: 0 (disabled) to 600 seconds. The default is 0. Note:

Prior to TS6.1, this feature was controlled by the sipCfgPortFaxOnlyTimeout object. This object is still supported for backwards compatibility.

Configuring Distinctive Ring/Alert Tones

Follow these steps to set the expected Alert-Info strings for distinctive ringing and alert (Call Waiting) tones. Each MIB object specified must be set in the MTA configuration file. 1 In the MTA configuration file, set the following MIB objects: MIB Object

Description

sipCfgAlertInfoR0

The value of the Alert-Info header field to instruct the MTA to play the R0 ring cadence. The value of the Alert-Info header field to instruct the MTA to play either the R1 ring cadence (call not active) or the WT1 call waiting tone (call active).

sipCfgAlertInfoR1


Provisioning

131

MIB Object

Description

sipCfgAlertInfoR2

The value of the Alert-Info header field to instruct the MTA to play either the R2 ring cadence (call not active) or the WT2 call waiting tone (call active). The value of the Alert-Info header field to instruct the MTA to play either the R3 ring cadence (call not active) or the WT3 call waiting tone (call active).

sipCfgAlertInfoR3

sipCfgAlertInfoR4

sipCfgAlertInfoR5

sipCfgAlertInfoR6

sipCfgAlertInfoR7

The value of the Alert-Info header field to instruct the MTA to play either the R4 ring cadence (call not active) or the WT4 call waiting tone (call active). The value of the Alert-Info header field to instruct the MTA to play the R5 ring cadence. The value of the Alert-Info header field to instruct the MTA to play the R6 ring cadence. The value of the Alert-Info header field to instruct the MTA to play the R7 ring cadence.

The default value for each MIB object is , where x is the ring cadence (0 through 7). You may need to change these if the SIP proxy sends different Alert-Info strings.

Specifying an Emergency Number

Follow these steps to specify an emergency number for special processing. Outgoing calls to the emergency number can only be terminated by the emergency operator; flash, Call Waiting, and Call Transfer are disabled for the duration of the call. 1 Add the sipCfgEmergencyNumber object to the MTA configuration file. Specify the emergency number as a string; for example, ‘‘911.’’ 2 Restart the MTA to download and apply the updated configuration.

Specifying a BYE Delay

In a PSTN environment, the called party typically can hang up for a few seconds without disconnecting the call. Follow these steps to provide the same behavior on a Touchstone SIP eMTA. 1 Add the sipCfgPortCallByeDelay object to the MTA configuration file. Its value is the time, in seconds, that the MTA delays sending a BYE after the subscriber hangs up. The default value of 0 disables this feature.


132

Chapter 3

The MTA disconnects the call if: • The subscriber was the calling party; the BYE delay does not apply in this case. • The subscriber was called, hangs up the phone, and does not pick up before the delay time expires. • The calling party hangs up and the subscriber’s eMTA receives a BYE. 2 Restart the MTA to download and apply the updated configuration.


Provisioning

133

SIP Loopback Testing Use this procedure to configure SIP loopback.

Loopback Support

Touchstone SIP loads support the following loopback types: • Media loopback—loopback passes through the DSP on the mirroring side. This is analogous to MGCP netwtest (network continuity test). • Packet loopback—re-encapsulates RTP data in IP, UDP, and RTP headers. This is analogous to MGCP netwloop (network loopback). These loopback types are initiated from the Call Agent. TS5.2 and later SIP loads also support remote initiated loopback. Using remote initiated loopback, the MTA starts either media loopback or packet loopback when receiving a call from a phone number provisioned in the sipCfgMediaLoopbackNumber or sipCfgPacketLoopbackNumber MIB objects. When running loopback tests, the MTA automatically goes off-hook without ringing and performs the desired loopback test.

Action

Follow these steps to configure remote initiated loopback. 1 To set a media loopback number, add the sipCfgMediaLoopbackNumber object to the MTA configuration file. 2 To set a packet loopback number, add the sipCfgPacketLoopbackNumber object to the MTA configuration file. 3 After saving the configuration file, restart the MTA to make the changes take effect. 4 To start a loopback test, call any line on the MTA from the numbers specified in the above MIB objects.


134

Chapter 3

Provisioning DHCP Options Use this procedure to configure optional DHCP behavior. You can enable or disable the following options: DHCP Option

Description

option 51

Lease time request—on by default; may be disabled for improved interoperability with certain DHCP servers. Provisioning Server Address (SNMP entity)—by default, the eMTA performs a ‘‘DHCP reinit’’ if a DHCP Renew ACK message contains a different server address than that provided in the initial DHCP Offer. This behavior may be disabled for improved operation with DHCP servers that attempt to load-balance provisioning server assignments.

option 122/177 sub-option 3

Note:

To configure non-service affecting DHCP renew, see ‘‘Configuring Non-Service Affecting IP Address Renewal’’ on page 136.

About DHCP Reinit

A ‘‘DHCP reinit’’ is a restart of the DHCP process either by the CM or MTA component of a Touchstone eMTA. Each component treats a reinit differently: • CM: the eMTA rescans for downstream carriers. • MTA: the eMTA restarts with the initial DHCP Discover message (step MTA-1 of the PacketCable provisioning process; see ‘‘PacketCable Sequence’’ on page 26). The DHCP reinit is service-affecting; the MTA drops any call in progress as a side-effect of the reinit.

DHCP Configuration-related MIB Objects

The following MIB objects control DHCP option behavior. They can be set in either the CM or MTA configuration file, or in an SNMP network manager. These object settings are not persistent. • arrisCmDhcpOption51Override • arrisMtaDevDhcpOptionOverride • sipCfgDhcp60AnnouncementMode (SIP loads only)


Provisioning

Filtering DHCP Broadcast Packets

135

The arrisCmDevModemFeatureSwitch2 MIB object provides a switch to enable filtering of broadcast DHCP packets not destined for CPE attached to the eMTA. This option prevents potential hackers from obtaining provisioning data by sniffing downstream DHCP traffic. Note:

Enabling this feature violates DOCSIS specifications, so filtering is disabled by default.

Action

Follow these steps to enable or disable DHCP option transmission. The settings do not persist across reboots, so you must set them in the configuration file to make them permanent. 1 To configure DHCP option 51 behavior, set the arrisCmDhcpOption51Override object as follows: Value

Description

off(1)

(default) Both the CM and MTA components send option 51. Only the MTA component sends option 51.

onCm(2) onMta(3) onCmAndMta(4)

Only the CM component sends option 51. Neither the CM nor MTA component sends option 51.

2 To configure DHCP option 122/177 behavior, set the arrisMtaDevDhcpOptionOverride object as follows: Value off(1)

on(2)

Description

(default) Enables SNMP entity checking. The eMTA performs a DHCP reinit if the entity received in an ACK message differs from that received in the original OFFER. Disables SNMP entity checking.

3 (SIP loads only) To configure advertisement of the ‘‘ARRIS SIP HW_REV compatibility mode’’ string in DHCP Option 60 messages, set the sipCfgDhcp60AnnouncementMode object to enable(1). Note:

Specifying the ‘‘GUPI MAC with TFTP Server Override’’ provisioning mode automatically force-enables the announcement (the announcement cannot be disabled).


136

Chapter 3

Configuring Non-Service Address Renewal

Affecting

IP

When a Touchstone eMTA with a dynamic IP address reaches about halfway through the current lease time, it begins attempting to renew or rebind its IP address lease. If the Renew or Rebind gives the eMTA a new IP address, or responds with a DHCP NAK, the eMTA performs a DHCP reinit (see ‘‘About DHCP Reinit’’ on page 134) and drops any calls in progress. Touchstone firmware provides a configuration setting to either delay sending the initial request, or ignore server responses that change the eMTA’s IP address, while a phone line is off-hook. Use this procedure to configure the desired behavior.

CAUTION Potential network conflicts Configuring the eMTA to ignore DHCP server responses could lead to IP address duplication and network conflicts. See ‘‘Recommendations’’ below for more details.

Backoff/Retry Timing

If the Telephony Modem is waiting to send a DHCP Request message, or does not receive a DHCP server response, it begins a backoff/retry sequence. The sequence follows the method defined by RFC 2131: the eMTA sends a Request at half the remaining lease time, another Request at half the new remaining time, repeating until the Renew period ends and Rebind begins. If the Telephony Modem is waiting for all lines to go on-hook before sending a DHCP message, it immediately sends the message when the last line goes on-hook.


Provisioning

arrisCmDevDhcpNoSvcImpact Settings

137

Configure non-service affecting DHCP Renew using the arrisCmDevDhcpNoSvcImpact MIB object. The allowed values for this object are: Value off(1) dontSend(2)

Description

(default) Disables DHCP lease renewal interruption. When an endpoint is off-hook, the Telephony Modem suppresses transmission of RENEW/REBIND REQUEST messages and all RESPONSE messages until the endpoint goes on-hook. The Telephony Modem observes the normal backoff/retry mechanism for suppressed messages, described in ‘‘Backoff/Retry Timing’’ above. If the IP address lease time expires before all lines go on-hook, the Telephony Modem performs a DHCP reinit as required by RFC 2131 (see ‘‘About DHCP Reinit’’ on page 134) and drops any calls in progress.

sendIgnore(3)

If all lines go on-hook during a RENEW/REBIND operation, the Telephony Modem immediately transmits the appropriate message to the DHCP server and processes responses as required by RFC 2131. When the endpoint is off-hook, the Telephony Modem sends RENEW/REBIND REQUEST messages and processes valid ACK RESPONSE messages that do not attempt to change the current IP address. However, the Telephony Modem ignores all NAK RESPONSE messages, and any ACK RESPONSE messages that include an IP address assignment other than that of the current address, until the endpoint goes on-hook. After sending a REQUEST message, the Telephony Modem observes the backoff/retry mechanism described in ‘‘Backoff/Retry Timing’’ above. If all lines go on-hook before the next RENEW/REBIND re-transmission, the Telephony Modem immediately processes the DHCP response message and performs a DHCP reinit.

Log Messages

Touchstone firmware provides four log messages which note lease renewal delays when this feature is active. See the Touchstone Firmware Troubleshooting Guide for detailed descriptions of each log message.


138

Recommendations

Chapter 3

Enabling this feature can affect normal DHCP operations. Therefore, ARRIS recommends that this feature be enabled only during a maintenance window in which DHCP re-scoping or network IP address reassignment operations are being performed. The feature should then be disabled for normal DHCP operation. If you prefer to leave this feature enabled all the time, carefully consider which option to use and understand the trade-offs between the choices. For example, while the dontSend option potentially increases the chances that a long standing call will prevent the MTA from renewing its IP address before the lease expires, use of the sendIgnore option causes the MTA to ignore DHCP NAK responses. Note:

Because of these issues, and those described below, ARRIS strongly recommends careful consideration before choosing to use either the dontSend or sendIgnore options.

DHCP Interaction

When a DHCP server sends a DHCP NAK response to an eMTA: 1 RFC 2131 requires the eMTA to immediately stop using the current IP address and to reinitialize to obtain a new IP address. There is no client-side response or acknowledgment allowed to the server for this command. 2 The DHCP server, according to RFC 2131, is to assume that the eMTA also adheres to RFC 2131 and will immediately vacate the address. This means that the DHCP server could rightly reassign that address to another eMTA at any time after sending a client the DHCP NAK response. When using the sendIgnore option, after receiving (and ignoring) a DHCP NAK response from the server during DHCP Renew/Rebind operations, the eMTA continues to operate on the current IP address. Meanwhile, the DHCP server assumes the eMTA has stopped using that address. So if the server then reassigns that IP address to another client while the eMTA is still using it for an active call, a duplicate IP address will be created in the network. Duplicate IP addresses have been known to cause both no dial tone reports and even network-wide outages.

‘‘dontSend’’ Considerations

The dontSend(2) option has the following advantages and limitations. Advantages • Does not drop calls when attempting a DHCP Renew (except for rare cases as described in Limitations below).


Provisioning

139

• Fully adheres to RFC 2131 (DHCP specification). • Does not create a scenario for potentially assigning duplicate IP addresses, compared to the sendIgnore(3) alternative of not releasing the IP address if a DHCP NAK is received. Limitations • A DHCP Renew backoff/retry sequence can potentially drop a call if the call originates during the time between when the DHCP Renew message is transmitted and before the server response is received. This window of time is very short for DHCP transactions where the server sends a response. If a response is received and the DHCP server only changes or renews the lease time on the existing IP address, then there is no service impact to the call. However, if the DHCP server responds with a DHCP NAK, the eMTA performs a DHCP reinit (as required by RFC 2131) and drops the call. • If the IP address lease time expires while waiting for all lines to go on-hook, the eMTA performs a DHCP reinit (as required by RFC 2131) and drops any active calls.

‘‘sendIgnore’’ Considerations

The sendIgnore(3) option has the following advantages and limitations.

CAUTION Potential network conflicts ARRIS strongly recommends extremely careful consideration before choosing this option. Use of this option could potentially lead to IP address duplication and conflicts in the network. Advantages • Does not drop calls when a DHCP Renew or Rebind is attempted for the current address (except for rare cases as described in Limitations below). • Allows standard renewal of current IP address lease time, minimizing risks that the lease expires during an active call. Limitations • A call originated during the time between when the message is transmitted, and before the server response is received, can be dropped. This window of time is very short for DHCP transactions where the server sends a response.


140

Chapter 3

• Ignoring DHCP NAK responses creates a scenario for potentially assigning duplicate network IP addresses.

Additional Considerations

Some DHCP servers may have a configurable option to control the amount of time an IP address is held by a server before allowing it to be reassigned to another client device. Some DHCP servers also support a ‘‘ping before offer’’ option in which they ping the network to see if another client is using an IP address before assigning that address to another client. Reportedly, enabling this capability causes significant increase in DHCP processing overhead and response time. Consult with your DHCP vendor to understand potential server-client interactions.

Action

Follow these steps to configure non-service affecting DHCP renew. 1 To create a default setting, set the arrisCmDevDhcpNoSvcImpact MIB object in the CM or MTA configuration file. For example: SnmpMib = arrisCmDevDhcpNoSvcImpact.0 1

The setting takes effect after rebooting the eMTA. Note:

If the configuration file does not have a setting for arrisCmDevDhcpNoSvcImpact, the default is off(1).

2 To change the setting while the eMTA is running, set the arrisCmDevDhcpNoSvcImpact MIB object using an SNMP manager. The new setting takes effect immediately and persists until the eMTA reboots or is changed again.


Provisioning

141

Provisioning European Support The TS6.1 .EURO load provides support only for full Euro-PacketCable provisioning. This requires that new features be configured and existing MIBs be modified. This feature requires a specialized firmware load. See the Touchstone Telephony Feature Guide for details about European support.

Action


Page

Configuring Power Ring Frequency Configuring On-Hook Caller ID Configuring Visual Message Waiting Indicator Configuring Tone Operations Configuring Hook Flash Timing

Configuring Power Ring Frequency

141 141 142 143 143

Follow these steps to configure the power ring frequency. 1 Select the pktcSigPowerRingFrequency object and input the appropriate frequency for your network. The following frequencies are valid: • 20 Hz (1) • 25 Hz (2) (default for Belgium, Germany, Netherlands, Netherlands09, Poland, Spain, Norway, and Switzerland) • 33.33 Hz (3) • 50 Hz (4) (default for Austria, France, and Hungary) • 15 Hz (5) • 16 Hz (6) • 22 Hz (7) • 23 Hz (8) • 45 Hz (9)

Configuring OnHook Caller ID

Follow these steps to configure the on-hook Caller ID functionality. 1 Set the protocol by modifying the pktcSigDevCallerIdSigProtocol object. Supported protocols are fsk(1) (default) and dtmf(2). 2 Select the pktcSigDevCIDMode object and select from one of the following modes:


142

Chapter 3

• duringRingingETS—The FSK containing the Caller ID information is sent between the first and second ringing pattern. The delay between the end of the first ringing pattern and the start of the transmission for of the FSK containing the Caller ID information is configurable using the pktcSigDevCIDFskAfterRing object. • dtAsETS (default for Austria, Belgium, France, Germany, Netherlands, Netherlands09, Norway, Spain, and Switzerland)—The FSK is sent after the Dual Tone Alert Signal but before the first ring pattern. • rpAsETS (default for Hungary and Poland)—The FSK is sent after a Ring Pulse but before the first ring pattern. The delay between the end of the Ring Pulse Alert Signal and the start of transmission of the FSK containing the Caller ID information is configured with the pktcSigDevCIDFskAfterRPAS object. • lrAsETS—The Line Reversal occurs first, then the Dual Tone Alert Signal, and finally the FSK is sent but before the first ring pattern. The delay between the end of the Line Reversal and the start of the Dual Tone Alert Signal is configurable via the pktcSigDevCIDDTASAfterLR object. Note 1:

The delay between the Dual Tone Alert Signal and the start of transmission of the FSK containing the Caller ID information for both the dtAsETS and lrAsETS Caller ID methods is configurable using the pktcSigDevCIDFskAfterDTAS object.

Note 2:

The delay between the end of the complete transmission of the FSK containing the Caller ID information and the start of the first ring pattern for dtAsETS, rpAsETS, and lrAsETS caller ID methods is configurable via the pktcSigDevCIDRingAfterFSK object.

Configuring Visual Message Waiting Indicator

Follow these steps to configure visual message waiting indicator. 1 Select the pktcSigDevVmwiMode object and select from one of the following modes: • dtAsETS (default for Austria, Belgium, France, Germany, Netherlands, Netherlands09, Norway, Spain, and Switzerland)—The FSK is sent after the Dual Tone Alert Signal but before the first ring pattern. • rpAsETS (default for Hungary)—The FSK is sent after the Ring Pulse. The delay between the end of the Ring Pulse Alert Signal and the start of the transmission of the FSK containing the VMWI information is configurable via the pktcSigDevVmwiFskAfterRPAS object. • lrAsETS (default for Poland)—The Line Reversal occurs first, then the Dual Tone Alert Signal, and finally the FSK is sent. The delay between the end of the Line Reversal and the start of the Dual Tone Alert Signal for VMWI information is configured with the


Provisioning

143

pktcSigDevVmwiDTASAfterLR object. Note:

The delay between the end of the Dual Tone Alert Signal and the start of the transmission of the FSK information containing the VMWI information for the dtAsETS and lrAsETS alerting signal methods is configurable via the pktcSigDevVmwiFskAfterDTAS object.

Configuring Tone Operations

TS5.2 and later versions of Touchstone firmware allow configuration of call progress tones for North American and European templates. See ‘‘Configuring Call Progress Tones’’ on page 144 for instructions.

Configuring Hook Flash Timing

TS5.2 and later versions of Touchstone firmware allow configuration of hook flash timing for North American and European templates. See ‘‘Configuring Hook Flash Timing’’ on page 147 for instructions.


144

Chapter 3

Configuring Call Progress Tones Use this procedure to configure call progress tones. Touchstone .EURO loads have supported provisioning of call progress tones through the pktcSigDevToneTable since TS5.0. TS5.2 and newer versions provide this support for North American loads as well, only when the country code setting (set by ppCfgMtaCountryTemplate ) is one of the North American country codes.

MIB Tables

TS5.2 and newer versions of Touchstone firmware use two MIB tables to define call progress tones. See ‘‘Default Tone Settings’’ on page 255 for a list of default tone definitions for each country code type. pktcSigDevToneTable Defines the tone type, repeat count, and whether the last tone should be held steady after completing the cadence. Each entry in the table contains the following objects:

• pktcSigDevToneType: the index for the table (see below). • pktcSigDevToneWholeToneRepeatCount: the number of times to repeat the entire sequence. • pktcSigDevToneSteady: set to true(1) to keep the last tone in the sequence on until reaching the timeout. pktcSigDevMultiFreqToneTable Defines the actual frequencies for each tone defined in the tone table. Each entry in this table contains the following objects:

• pktcSigDevToneNumber: A secondary index, indicating the sequence number of the defined tone. Up to eight tones may be defined for a tone type. • pktcSigDevToneFirstFrequency, pktcSigDevToneSecondFrequency, pktcSigDevToneThirdFrequency, pktcSigDevToneFourthFrequency: Up to four frequencies per defined tone. To disable a frequency, set it to 0. • pktcSigDevToneFreqMode: Determines how the frequencies define the tone: – firstModulatedBySecond(1): The first frequency is modulated by the second frequency, according to the percentage specified by pktcSigDevToneFreqAmpModePrtg. The third and fourth frequencies are ignored. – summation(2): All specified frequencies are added together without adding modulation.


Provisioning

145

• pktcSigDevToneFreqAmpModePrtg: The percentage of amplitude modulation to apply when using the firstModulatedBySecond setting. • pktcSigDevToneDbLevel: The decibel level for each tone. The default is −40 dBm. • pktcSigDevToneOnDuration: The time, in milliseconds, to play the defined tone. • pktcSigDevToneOffDuration: The time, in milliseconds, of silence before the next tone. • pktcSigDevToneFreqRepeatCount: The number of times to play the defined tone. The pktcSigDevToneType object acts as the index for both tables. The index is one of the following values: • busy (1) • confirmation (2) • dial (3) • messageWaiting(4) • offHookWarning (5) • ringBack (6) • reOrder (7) • stutterdial (8) • callWaiting1 (9) • callWaiting2 (10) • callWaiting3 (11) • callWaiting4 (12) The pktcSigDevToneSteady object, when set to true(1), keeps the last tone on. The pktcSigDevToneWholeToneRepeatCount object defines how many times to repeat the on/off sequence. The following tones are not supported in the MIB tables or through the supported line package: • alertingSignal (13) • specialDial(14)


146

Chapter 3

• specialInfo (15) • release (16) • congestion (17) • userDefined1 (18) • userDefined2 (19) • userDefined3 (20) • userDefined4 (21)

Action

Follow these steps to configure call progress tones. 1 Modify the pktcSigDevToneTable table to define the repeat count and whether the last tone in the sequence is steady. 2 Modify the pktcSigDevMultiFreqToneTable To define the frequencies and duration of each tone in the sequence. 3 To modify a Call Waiting tone, follow the first two steps and then: a Set the pktcNcsEndPntConfigCallWaitingDelay object to define the amount of delay between repeats of the Call Waiting tones. Note:

The pktcSigDevToneWholeToneRepeatCount object is ignored for the Call Waiting tones.

b Set the pktcNcsEndPntConfigCallWaitingMaxRep object to define the repeat count for the Call Waiting tones. Note:

Do not use the pktcSigDevMultiFreqToneTable to configure the delay between repeated Call Waiting tones.


Provisioning

147

Configuring Hook Flash Timing Follow these steps to configure hook flash timing. Touchstone .EURO loads have supported provisioning of hook flash timing since TS5.0. TS5.2 and newer versions provide this support for North American loads as well.

Default Timing Settings

See ‘‘Country Code Templates’’ on page 239 for a list of default hook flash timings for each supported country code.

Action

Follow these steps to set hook flash timings. 1 Set the pktcNcsEndPntConfigMinHookFlash MIB object to the minimum time a line needs to be on hook for a valid hook flash. The range is 20 to 1000 milliseconds. 2 Set the pktcNcsEndPntConfigMaxHookFlash MIB object to the maximum time the line needs to be on hook for a valid hook flash. The range is 20 to 1000 milliseconds.


148

Chapter 3

Provisioning Preset Downstream Frequencies Use this procedure to provision one or more preset downstream frequencies. This feature allows Touchstone eMTAs to quickly lock onto a known downstream during initial registration. You can also add preset frequencies using the Scanning Override screen, described in the Touchstone Telephony Troubleshooting Guide.

Preset Frequency MIB Objects

The following MIB objects control preset frequencies. You can make changes to these objects using an SNMP manager or through the configuration file. arrisCmDevPresetFrequency Entries in a table of up to 20 preset frequencies. arrisCmDevClearPresetFrequencies Set to true(1) to clear the preset frequency table. arrisCmDevClearCachedFrequencies Set to true(1) to clear the cached frequencies.

Action

Follow these steps to provision the preset frequency table. 1 Set an entry in the table by entering the frequency (in Hz) in one of the arrisCmDevPresetFrequency objects; for example, use arrisCmDevPresetFrequency.1 to set the first entry. 2 To clear the entire preset frequency table, set the arrisCmDevClearPresetFrequencies object to true(1). 3 To clear cached frequencies, set the 4 object to true(1). 5 If you make any changes in the configuration file, reboot the eMTA to load the changes.


Provisioning

149

Provisioning Voice and Signaling Packet Priority Use this procedure to set the priority of voice and signaling packets. This may be necessary to give voice traffic priority in non-PacketCable portions of the network, especially when the CMTS and call server or CMS are located at different sites.

ToS-related MIBs

IP packets contain a ToS (Type of Service) field in the header, which allows devices to specify the priority and traffic type of packets. Routers can use this information to process and prioritize traffic. Two PacketCable MIB objects allow setting the ToS field: • pktcSigDefCallSigTos—sets the ToS field for signaling packets • pktcSigDefMediaStreamTos—sets the ToS field for voice packets These objects no longer exist in the European loads. The following DSCP objects are used: pktcSigDefCallSigDscp and pktcSigDefMediaStreamDscp. The following diagram shows the structure of the ToS field for both voice and signaling packets:

Valid range: 0 to 63.

Action

Follow these steps to provision voice and signaling packet priority. 1 Create an MTA provisioning file, or open an existing file, using PacketACE or another provisioning file editor. 2 Create a setting for the pktcSigDefCallSigTos object with the desired signaling priority. For example, if you want the priority for signaling packets to be 3, set the value to 24 (3*8). 3 Create a setting for the pktcSigDefMediaStreamTos object with the desired voice priority. For example, if you want the priority for voice packets to be 5, set the value to 40 (5*8).


150

Chapter 3

Provisioning RIP Use this procedure to provision RIP.

Requirements

The following are requirements to implement RIP: • IPv4 addressing is required. • RIP must be enabled on the CMTS cable interface (for example, the command configure router rip shutdown no enables RIP on the ARRIS C4® CMTS) • A public IP address/mask must be assigned to the Telephony Modem’s LAN interface. • Public IP addresses must be reserved for CPE devices, which can be assigned as follows: – static addresses – external customer DHCP server – WTM552 or WTM652 built-in DHCP server

Action

Perform either of the following tasks as needed. Task

Page

Basic RIP Provisioning RIP Remote Provisioning (WTM552/WTM652)

Basic RIP Provisioning

150 151

Follow these steps to enable RIP using the provisioning file. This applies to all Touchstone devices running TS6.1, except the WTM552 and WTM652 models. See ‘‘RIP Remote Provisioning (WTM552/WTM652)’’ on page 151 for WTM552 and WTM652 provisioning. 1 Add the following information to the CM configuration file: MaxCpeAllowed = 16 SnmpMib = arrisCmDevRouterLanIpAddr.0 ipaddr SnmpMib = arrisCmDevRouterLanSubNetMask.0 ipmask SnmpMib = arrisCmDevRouterLanEnable.0 enable

• Set MaxCpeAllowed as needed to enable CPE devices to communicate with the HFC network.


Provisioning

151

• Set ipaddr to the IP address for the router. • Set ipmask to the IP mask for the router subnet (usually 255.255.255.0). 2 Reset the eMTA to load the new configuration.

RIP Remote Provisioning (WTM552/ WTM652)

Follow these steps to enable RIP on the WTM552 or WTM652, using remote provisioning. For more information about remote provisioning, see the Touchstone Telephony Troubleshooting Guide. 1 Add the following commands to the remote provisioning file: sdc sdc sdc sdc sdc sdc sdc

set set set set set set set

rip lan lan lan lan lan rip

enable nat disable ip ipaddr mask ipmask dhcp enable net low high iface 1 ver 3 dir 3

• Set ipaddr to the router IP address. • Set ipmask to the IP mask for the router subnet (usually 255.255.255.0). • Set low and high to the range of IP addresses you want to assign to CPE devices. 2 Reset the Wireless Telephony Modem to load the new provisioning.


152


Chapter 3

4

Advanced WTM552 and WTM652 Provisioning Touchstone firmware provides WTM652-specific features:

several

advanced

WTM552-

and

• Remote Provisioning—provides a method to configure the Wireless Router Module (WRM) from the headend. • Public and Private BSSID support—the WRM supports one public BSSID (available for end-user configuration) and multiple private BSSIDs (configured only through remote provisioning). • L2TP Support—Touchstone firmware supports L2TP configuration for Wireless Mesh Networking. Touchstone firmware supports the Siemens/BelAir Wireless Mesh application for use with 802.11-based Enhanced Cordless Telephones. Of the four enhancements listed above, Remote Provisioning may be used to simplify home networking for end-users, as well as for Wireless Mesh Networking. The other features are meant primarily to support Wireless Mesh Networking. TS6.1 provides WPA-Enterprise support as well.

General Provisioning Notes The WRM is treated as a separate CPE, requiring a minimum MaxCpeAllowed value of 3 for full functionality (the MTA, wireless router module, and connected subscriber equipment are treated as separate CPEs in accordance with eDOCSIS standards).


154

WRM Provisioning File Error Reporting

Chapter 4

TS6.1 provides support to report and help debug provisioning file errors. The primary tool is the provf.html web page, which shows the following information: • provisioning file name • time the file was downloaded • IP address of the TFTP server • provisioning file status (for example: OK, file not found, error) • first error found (if any) To enable viewing the provisioning file page, use the following sequence of WRM CLI commands: redirect set hpg enable ↵ redirect set rm enable ↵ (only if remote access is required ) redirect save

Alternatively, you can set the arrisWrmDevHpg and (if remote access is required) the arrisWrmDevRmEnable MIB objects to enable(1) to allow access to the error page. To access the provf.html page, you must use a WRM IP address. To find the WRM IP address, use the following CLI commands: Console> wrm ↵ Wireless Router> display ↵

The output of the display command shows, among other information, the WRM IP addresses for remote access (under the ‘‘Internet:’’ items) and for LAN access (under the ‘‘LAN:’’ items). The URL http://WRM_ipaddr /provf.html displays the provisioning information, including any provisioning file errors. Use the proper IP address for WAN or LAN access.

WRM Provisioning Error Handling

WRM MIB objects can be set in the CM configuration file. The WRM handles provisioning errors depending on the type of error: • Bad value: If the WRM detects an out of range value, or a value of an improper type, it rejects only that setting. Example: The object arrisWrmDevLanIpAddr.0 is set to a bad value such as 255.255.255.255. The WRM rejects this attempt to set the object, but can still apply settings for other objects.

• Logic error: If the WRM cannot immediately detect an improper setting, it finds the error while attempting to save. In this case, none of the WRM object settings are applied.



155

Example: The object arrisWrmDevLanIpPoolStart.0 is set to a bad value such as 1. The value is not immediately detected as erroneous, since it is in the valid range for the object, but the setting is in error since it would include the WRM IP address in the DHCP address pool. The WRM detects the problem when attempting to save the configuration; the save fails and all MIB object settings are ignored.

+

Aging out CPE MAC Addresses

Touchstone firmware provides an option that allows the MTA to age out learned CPE MAC addresses as the learned address table fills up. Newer table entries are added in a Least Recently Used (LRU) fashion and take the place of older entries.

+ + + +

Note 1:

This feature is not specific to the WTM552 or WTM652, but is most + useful when deploying these Telephony Modems as public-access hotspots. +

Note 2:

This feature violates DOCSIS specifications, and is thus disabled by + default. + To configure the Telephony Modem to age out CPE MAC addresses, set bit + 0x20000000 of the arrisCmDevModemFeatureSwitch2 MIB object. + To view the current list of learned CPE MAC addresses, walk the + dot1dTpFdbTable. +

WTM552- and WTM652-Specific MIB Objects The following MIB objects apply specifically to the WRM. arrisCmDevRouterMode Sets the WRM operating mode as follows:

• useExistingSetting(0) • routerEnabled(1) • routerDisabled(2) (AP mode) • routerDisabled-Fixed(3) (AP_only mode) arrisCmDevWirelessRegion Sets the wireless region. The default setting is based on the model: United States for DOCSIS (A/G) units, Europe for EuroDOCSIS (B/H) units, or Japan for Japanese (C) units. The region setting is persistent across reboots. A reset to factory defaults resets the region setting as well. Note:

If you specify the wireless region in both the configuration file and the remote provisioning file, the configuration file value overwrites the remote provisioning value.


156

Chapter 4

arrisCmDevModemFeatureSwitch2 Bit 5 (0x04000000) of the secondary CM Feature Switch controls the behavior of the WRM Reset button. When this bit is enabled, pressing the WRM Reset button performs a reset as normal but the ‘‘reset to factory defaults’’ function (pressing the button for 8 seconds) is disabled.

The new ARRIS-WRM-DEVICE-MIB allows complete provisioning and management of the WTM552 or WTM652 Wireless Router Module (WRM). The following object is equivalent to the sdc save command. arrisWrmDevSaveSettings If set to true(1), the WRM checks the configuration for consistency; if it does not find any errors, it saves the new settings and reboots. If writing the object returns ‘‘Error: Inconsistent value,’’ check the configuration for problems and re-try.

The following objects control LAN IP parameters in the WRM. arrisWrmDevNATEnable Enables or disables Network Address Translation (NAT) on the WRM. Note:

NAT must be disabled in order to transmit RIP information.

arrisWrmDevLanIpAddr The IP address for the WRM LAN interface. All IP addresses assigned by the WRM’s DHCP server are based from this IP address. arrisWrmDevLanIpMask The subnet Mask for the WRM LAN interface. Together with arrisWrmDevLanIpAddr, this object defines the subnet on the WRM LAN interface. arrisWrmDevLanIpPoolStart Determines the first IP address in the WRM’s DHCP IP address pool.

The value of this object only determines the last 8 bits of the IP address. The first 3 bytes (24 bits) of the IP address come from the first 3 bytes of arrisWrmDevLanIpAddr. arrisWrmDevLanIpPoolEnd Determines the last IP address in the WRM’s DHCP IP Address pool.

The value of this object only determines the last 8 bits of the IP address. The first 3 bytes (24 bits) of the IP address come from the first 3 bytes of arrisWrmDevLanIpAddr.



157

arrisWrmDevLanDhcp Set to enable(1) to enable the WRM DHCP server, or disable(2) to disable it. arrisWrmDevLanLease Sets the lease time of addresses assigned by the DHCP server: forever(0), halfHour(1), oneHour(2), twoHours(3), halfDay(4), oneDay(5), twoDays(6), oneWeek(7), or twoWeeks(8). arrisWrmDevLanDomain A string containing the domain name of the WRM LAN. arrisWrmDevWlanAp Set to enable(1) to configure the WRM as an access point, or disable(2) to configure the WRM as a standalone or master.

The following objects control WLAN IP parameters in the WRM. arrisWrmDevWlanApDhcpc Enables or disables the DHCP client when in AP mode. arrisWrmDevWlanApConfigTable A table containing MIB objects which control WLAN basic parameters. Parameters related to WLAN security are covered in arrisWrmDevWlanApSecuConfigTable. The following eight objects are part of this table. arrisWrmDevWlanApConfigIndex Part of the arrisWrmDevWlanApConfigTable. The index that uniquely identifies the SSID to which this entry is applicable. Two SSIDs are available; index 0 is the public BSSID, and 1 is the private BSSID. arrisWrmDevWlanApConfigChannel The channel number. Valid range: auto(0) to automatically select an unused channel, or 1 to 11 to specify a channel. arrisWrmDevWlanApConfigMode Sets the wireless mode: 0: off (wireless disabled) 1: 802.11g and 802.11b 2: 802.11g only 3: 802.11b only arrisWrmDevWlanApConfigSsid Part of the arrisWrmDevWlanApConfigTable. A string containing the SSID name. arrisWrmDevWlanApConfigSSidBroad Part of the arrisWrmDevWlanApConfigTable. Set to enable(1) to broadcast the SSID, or disable(2) to disable broadcasting.


158

Chapter 4

arrisWrmDevWlanApConfigProtec Part of the arrisWrmDevWlanApConfigTable. Set to 1 to enable WLAN protect mode, or 0 to disable. Enabling protect mode can reduce wireless network interference, but can also reduce the physical range or throughput. arrisWrmDevWlanApConfigQos Part of the arrisWrmDevWlanApConfigTable. Set to 1 to enable WLAN 802.11e QoS, or 0 to disable. arrisWrmDevWlanApSecuConfigTable This table contains objects that control WLAN security parameters not covered in the arrisWrmDevWlanApConfigTable. The next 12 entries are part of this table. arrisWrmDevWlanApSecuConfigIndex Part of the arrisWrmDevWlanApSecuConfigTable. The index that uniquely identifies the SSID to which this entry is applicable. Two SSIDs are available; index 1 is the public BSSID, and 2 is the private BSSID. arrisWrmDevWlanApSecuConfigEnable Part of the arrisWrmDevWlanApSecuConfigTable. Sets the WLAN security mode. One of: disable(0), wep(1), wpa(2), wpa2(3), or wpa_wpa2(4). arrisWrmDevWlanApSecuConfigWep Part of the arrisWrmDevWlanApSecuConfigTable. Sets the authentication mode for WEP. One of: open(1), share(2), or auto(3). arrisWrmDevWlanApSecuConfigWepK_type Part of the arrisWrmDevWlanApSecuConfigTable. Sets the WEP key size. One of: bit_64(1): 64-bit bit_128(2): 128-bit arrisWrmDevWlanApSecuConfigWepK_index Part of the arrisWrmDevWlanApSecuConfigTable. Selects the WEP key index to use. Valid range: 1 to 4. arrisWrmDevWlanApSecuConfigWepK_gen Part of the arrisWrmDevWlanApSecuConfigTable. Selects the WEP passphrase, used to generate group keys. The string can be up to 64 characters long. arrisWrmDevWlanApSecuConfigWepK_man Part of the arrisWrmDevWlanApSecuConfigTable. Manually specifies the WEP key. For a 64-bit WEP key, use 10 hexadecimal digits. for a 128-bit WEP key, use 26 hexadecimal digits.



159

arrisWrmDevWlanApSecuConfigWpaEncry Part of the arrisWrmDevWlanApSecuConfigTable. Specifies the WPA encryption mode. One of: tkip(0) or aes(1). arrisWrmDevWlanApSecuConfigWpaphrase Part of the arrisWrmDevWlanApSecuConfigTable. Specifies the guest passphrase (not currently supported). arrisWrmDevWlanApSecuConfigWpaObsecu Part of the arrisWrmDevWlanApSecuConfigTable. Set to enable(1) to enable WPA Obscure PSK, or disable(2) to disable. arrisWrmDevWlanApSecuConfigWpa2phrase Part of the arrisWrmDevWlanApSecuConfigTable. Specifies the WPA2 guest passphrase (not currently supported). arrisWrmDevWlanApSecuConfigWpa2Obsecu Part of the arrisWrmDevWlanApSecuConfigTable. Set to 1 to enable WPA2 Obscure PSK, or 0 to disable. arrisWrmDevWlanApPowerLevel Sets the WRM wireless power range; one of: high(0), middle(1), or low(2).

The following objects control WRM bandwidth. arrisWrmDevWlanQoSConfigEnable Enables or disables bandwidth limitations on WRM Ethernet and wireless interfaces. arrisWrmDevWlanQoSConfigTotalBandwidth Sets the maximum interface speeds for the entire WRM, in kbps. Valid range: 100 to 100000 kbps. arrisWrmDevWlanQoSConfigHomeBandwidth Sets the maximum interface speed for the WRM Ethernet and SSID1 wireless interfaces. Valid range: 100 to 100000 kbps. arrisWrmDevWlanQoSConfigPrivateBandwidth Sets the maximum interface speed for the WRM SSID2 wireless interface. Valid range: 100 to 100000 kbps.

The following objects control communication between CPE devices on the WRM. arrisWrmDevWlanApIsolationInter Enables or disables direct communication between CPE devices on the same SSID. arrisWrmDevWlanApIsolationExtra Enables or disables direct communication between CPE devices on different SSIDs on the same WRM.


160

Chapter 4

arrisWrmDevWlanApConfigLanAccess Enables or disables direct communication between CPE devices on the wireless interface and devices on the Ethernet ports (including the WRM configuration web pages).

The following objects control RIPv2 parameters in the WRM device, that are not covered by the standard rip2 MIBs. arrisWrmDevRip2Table The objects in this table control RIPv2 parameters in the WRM device that are not covered by rip2IfConfTable. arrisWrmDevRip2KeyId An unsigned 8-bit value that contains the Key Identifier or Key-ID. This identifies the key used to create the Authentication Data for this RIP-2 message whenever rip2IfConfAuthType has a value other than noAuthentication. arrisWrmDevRip2AdvertisementInt The interval, in seconds, between transmits of routing table updates. arrisWrmDevRipTransmitStatus active(1), inactive(2), Returns active(1) when the WRM is actively transmitting RIP updates, or inactive(2) otherwise. To enable transmission of RIP updates, rip2IfConfSend must be active and arrisWrmDevNATEnable must be disabled. arrisWrmDevRipReceiveStatus Returns active(1) when the WRM is receiving RIP updates, or inactive(2) otherwise. To enable receiving RIP updates, rip2IfConfReceive must be active.

The following object controls the web page password. arrisWrmDevPwd A string containing the password to the WRM web pages. The default is blank (no password). Note:

Once you have changed the WRM password, you cannot return to the default blank password by setting this object. To restore the default, you must either factory-reset the WRM or use the WRM configuration pages.

The following objects relate to provisioning file troubleshooting. arrisWrmDevProvStatus The provisioning file status; one of: −3: Error: File not found −2: Error: failure during provisioning file download −1: no provisioning file specified

0: no errors found 1+: number of errors found in the provisioning file



161

arrisWrmDevProvFileName A string containing the provisioning file name. arrisWrmDevProvFile A long string (up to 2048 octets) containing provisioning commands. This object allows the CM configuration file to contain WRM provisioning as well. arrisWrmDevProvDLTime Returns the time of day when the provisioning file was downloaded. arrisWrmDevHpg Set to enable(1) to enable the hidden page (Provisioning File Errors page), or disable(2) to disable.

Accessing the WRM MIB through the CM IP Address

TS6.1 supports accessing the WRM MIB objects through the CM IP address. If the CM receives an SNMP packet with an OID for a WRM object, the CM internally passes the request to the WRM and then passes the response to the requester. The following limitations apply:

CAUTION Loss of functionality Specify either a separate WRM configuration file, or use the arrisCmDevWrmProvFile object to configure the WRM card. If you specify both, the WRM constantly reboots between the two. If this happens, power down the Telephony Modem and correct the provisioning problem before continuing. • WRM MIB objects cannot be specified in the CM configuration file. Use the arrisCmDevWrmProvFile object to specify WRM provisioning commands inside the CM configuration file. • WRM MIB objects cannot be accessed using SNMPv3. • A MIB walk includes either CM MIBs or WRM MIBs, but not both.


162

Chapter 4

About Remote Provisioning TS6.1 supports remote provisioning of the Wireless Router Module (WRM) in both AP and Router modes, using a downloaded configuration file. The configuration file is a plain text file, containing WRM CLI redirect commands, replacing the redirect prefix with sdc. See the Touchstone Telephony Troubleshooting Guide for a list of valid commands). To specify a remote provisioning file, the DHCP server must send an OFFER with the following data: • Option 66: IP address of the TFTP server where the configuration file is located. Alternatively, you can set the arrisCmDevWrmProvServer object in the CM configuration file to specify the TFTP server address. • Option 67: Name of the configuration file. Alternatively, you can set the arrisCmDevWrmProvFileName object in the CM configuration file to specify the remote provisioning file name, or the arrisCmDevWrmProvFile object in the CM configuration file to specify the contents of a remote provisioning file (up to 2048 octets). When the Wireless Telephony Modem receives those options, it downloads the specified file or configuration and executes the commands in the file. Lines beginning with ‘‘#’’ are treated as comments.

CLI Interaction with Remote Provisioning

If an operator uses the CLI to change the WRM configuration, the CLI changes override any settings made by the remote provisioning file. Making changes using the CLI, then using the redirect save command instead of apply_config, disables remote provisioning. The WTM552 and WTM652 ignore the remote provisioning file, including after resets, until one of the following events occurs: • An operator enters the command apply_config at the CLI. • The remote provisioning file changes on the TFTP server. This behavior allows for extended testing of configuration changes without concern for resets. Once testing is complete, you can restore remote provisioning by either changing the provisioning file to reflect the desired changes, or using the apply_config command to override changes made using the CLI. Note:

Configuration changes made using the CLI that do not appear in the remote provisioning file persist across reboots, regardless of whether the Wireless Telephony Modem reads the remote provisioning file.



163

About L2TP Support L2TP support is available for Wireless Mesh Networking through the CLI (including remote provisioning). For example, the following command enables L2TP and sets the remote server address: redirect set wan type l2tp srv_ip 172.21.5.110

See the Touchstone Telephony Troubleshooting Guide for details.


164

Chapter 4

Provisioning Wireless Mesh Networking Use this procedure to set up Wireless Mesh Networking.

About Wireless Mesh Networking

Wireless Mesh Networking requires the following provisioning: • private BSSID • L2TP tunnel These must be configured through remote provisioning.

Action

Perform each of the following tasks. Task

Page

Configuring a BSSID Setting up L2TP Tunneling Configuring Remote Provisioning

Configuring a BSSID

164 164 165

Follow these steps to configure a private BSSID for Wireless Mesh Networking. 1 Add the following lines to a remote provisioning file. Replace dect phone with the proper BSSID for the telephone network. sdc set wlan ap2 ssid dectphone ↵ sdc set wlan ap2 ssid broad enable ↵

2 Proceed to ‘‘Setting up L2TP Tunneling.’’

Setting up L2TP Tunneling

Follow these steps to configure L2TP for Wireless Mesh Networking. 1 Add the following lines to a remote provisioning file. sdc sdc sdc sdc sdc sdc sdc

set set set set set set set

l2tp_bcp l2tp_bcp l2tp_bcp l2tp_bcp l2tp_bcp l2tp_bcp l2tp_bcp

enable ↵ account name pwd passwd ↵ hostname l2tphost ↵ serv_ip ipaddr ↵ vlan_tag enable ↵ vlan_id vid ↵ tun_pkt_dir n ↵

where. . .

is. . .

name passwd

The L2TP user ID. The password for the L2TP account.



l2tphost ipaddr vid n

165

The name of the L2TP host. The IP address of the L2TP host. The VLAN ID. 0 if only Wireless Mesh Networking uses L2TP; 1 if all packets use L2TP.

2 Proceed to ‘‘Configuring Remote Provisioning.’’

Configuring Remote Provisioning

Follow these steps to prepare the Wireless Telephony Modem and the provisioning server for remote provisioning. 1 Obtain the following information: • Path and name of the remote provisioning file on the TFTP server • TFTP server IP address 2 Set up the DHCP server or provisioning server to deliver the following information to the Wireless Telephony Modem in a DHCP OFFER: • DHCP Option 66: IP address of the TFTP server where the configuration file is located. • DHCP Option 67: Path and name of the configuration file. See the instructions for your provisioning/DHCP server for complete details. 3 Restart the Wireless Telephony Modem when all provisioning files and information are in place.


166

Chapter 4

Setting the Router Mode Use this procedure to set the Wireless Router Module (WRM) operating mode.

Available WRM Modes

The following WRM modes are supported: • User defined — the mode is set in the WTM552 or WTM652 WRM configuration web pages. • Router — normal router function. • AP (Access Point) — routing is disabled; the WRM functions as a wireless access point. • AP_only — routing is disabled; the WRM functions as a wireless access point. The operating mode cannot be changed in the WRM configuration web pages.

Action

Follow these steps to configure the router mode. 1 In the configuration file, or using an SNMP manager, set the arrisCmDevRouterMode MIB object to one of the following values: • useExistingSetting(0) • routerEnabled(1) • routerDisabled(2) (AP mode) • routerDisabled-Fixed(3) (AP_only mode) Note:

If you set this object to a value other than 0, the Wireless Telephony Modem immediately reverts and ignores mode settings made through the WRM web pages.

2 If you make this change in the configuration file, restart the MTA.



167

Provisioning WPA-Enterprise Support Use this procedure to provision WPA-Enterprise support using the WRM web pages or the CLI.

Requirements

To successfully deploy a WPA-Enterprise network, you need to configure a RADIUS server to distribute access keys. You must include the IP address and port number of the RADIUS server in the Wireless Telephony Modem configuration. To configure the WRM web pages from a remote location, the Remote Management feature must be enabled. You must then access the Wireless Telephony Modem from an IP address authorized for remote managment. To configure the WTM552 or WTM652 using the CLI, you must have the correct Password of the Day.

Action

Perform one of the following tasks: Task

Page

Provisioning WPA-Enterprise Access using the Web Pages Provisioning WPA-Enterprise Access using the CLI

Provisioning WPAEnterprise Access using the Web Pages

167 169

Follow these steps to provision WPA-Enterprise access using the WRM web pages. 1 Access the WRM web pages using the procedures in the Touchstone Telephony Troubleshooting Guide. 2 Use the WRM link to display the WRM web pages. Click the Wireless Setup link on the left side of the page, then Security from the sub-menu. The Wireless Telephony Modem displays the Security page:


168

Chapter 4

3 Select or fill in in the fields as follows: Security Mode WPA/WPA2-Enterprise Authentication WPA-Enterprise Encryption Technique TKIP Primary Radius Server The IP address of the RADIUS server. Primary Radius Port The port number for authentication. Primary Shared Key The password used to authenticate on the RADIUS server. Secondary Radius Server (optional) The IP address of a second RADIUS server. Secondary Radius Port (optional) The port number of the second RADIUS server, used for authentication. Secondary Shared Key (optional) The password used to authenticate on the secondary RADIUS server. 4 Click the Save button to save the security configuration.



Provisioning WPAEnterprise Access using the CLI

169

Follow these steps to provision WPA-Enterprise access using the WTM552 or WTM652 CLI. 1 Access the CLI using the procedures in the Touchstone Telephony Troubleshooting Guide . 2 Enter the following commands to configure WPA-Enterprise support: redirect redirect redirect redirect redirect

where. . . ap# method flag ipaddr port key

set set set set set

wlan wlan wlan wlan wlan

ap# ap# ap# ap# ap#

secu secu secu secu secu

8021x method 8021x encry flag 8021x rad_ip1 ipaddr 8021x rad_port1 port 8021x key1 key

is. . .

either ap1 for the public access point, or ap2 for the private access point. the access method: wpa, wpa2, or wpa_wpa2. either 0 to disable encryption, or 1 to enable it. the IP address of the RADIUS server. the port number of the RADIUS server. the authentication key.

3 (optional) Enter the following commands to configure a secondary RADIUS server: redirect set wlan ap# secu 8021x rad_ip2 ipaddr redirect set wlan ap# secu 8021x rad_port2 iport redirect set wlan ap# secu 8021x rad_key2 key

Where ipaddr , port , and key are the IP address, port, and authentication key for the secondary RADIUS server. 4 Enter the command redirect save to save the configuration.


170

Chapter 4

Configuring WRM Features The following features are available in TS6.1 MSUP2 and newer firmware versions.

Action

Perform any of the following tasks as desired. Task

Page

Configuring Wireless Power Level Configuring Wireless Channel Auto-Detect Configuring WRM Bandwidth Limits Configuring WRM CPE Isolation using the CLI Configuring WRM CPE Isolation using SNMP

Configuring Wireless Power Level

170 170 171 172 172

Follow these steps to set the wireless power level. 1 To set the power level from the CLI, enter the following commands: Console> wrm ↵ Wireless Router> redirect set wlan power level ↵

where level is one of: Value

Power Level

Range (dB)

Average (dB)

0 1 2

Low Medium High

10–14 12–16 14–18

12 14 16

2 To set the power level using an SNMP browser, set the arrisWrmDevWlanApPowerLevel object. The allowed values and results are identical to those shown in the table above.

Configuring Wireless Channel Auto-Detect

Follow these steps to allow the WRM to auto-detect and select an unused wireless channel. 1 To set channel auto-detect from the CLI, enter the following commands: Console> wrm ↵ Wireless Router> redirect set wlan {ap1 | ap2} channel auto ↵

where ap1 or ap2 select the public or private wireless LAN, respectively.



171

2 To set channel auto-detect using SNMP, set the arrisWrmDevWlanApConfigChannel object to auto(0).

Configuring WRM Bandwidth Limits

Follow these steps to set bandwidth limits. 1 To configure bandwidth limits using the CLI, enter the following commands: Console> wrm ↵ Wireless Router> redirect set qos mode flag ↵ Wireless Router> redirect set qos speed total public private ↵

where. . .

is. . .

flag

either 1 to enable bandwidth limits, or 0 to disable limits.

total

the total bandwidth, in kbps, alloted to all WRM interfaces (Ethernet and wireless). Valid range: 100 to 1000000 kbps.

public

the total bandwidth, in kbps, alloted to the Ethernet and public wireless interfaces. Valid range: 100 to 1000000 kbps.

private

the total bandwidth, in kbps, alloted to the private wireless interface. Valid range: 100 to 1000000 kbps.

2 To configure bandwidth limits using SNMP, set the following MIB objects: arrisWrmDevWlanQoSConfigEnable Set to enable(1) to enable bandwidth limits, or disable(0) to remove limits. arrisWrmDevWlanQoSConfigTotalBandwidth the total bandwidth, in kbps, alloted to all WRM interfaces (Ethernet and wireless). Valid range: 100 to 1000000 kbps. arrisWrmDevWlanQoSConfigHomeBandwidth the total bandwidth, in kbps, alloted to the Ethernet and public wireless interfaces. Valid range: 100 to 1000000 kbps. arrisWrmDevWlanQoSConfigPrivateBandwidth the total bandwidth, in kbps, alloted to the private wireless interface. Valid range: 100 to 1000000 kbps.


172

Configuring WRM CPE Isolation using the CLI

Chapter 4

Follow these steps to set CPE isolation policies using the CLI. 1 Enter the WRM sub-mode: Console> wrm ↵ Wireless Router>

2 To set the isolation status for CPE devices on the same wireless interface, enter the following command: Wireless Router> redirect set wlan isolation inter flag ↵

where flag is either enable to block direct communication, or disable to allow direct communication. 3 To set the isolation status for CPE devices on different wireless interfaces (but the same WRM), enter the following command: Wireless Router> redirect set wlan isolation extra flag ↵

4 To set the isolation status for CPE devices on the WRM Ethernet ports (and the WRM configuration web pages), enter the following command: Wireless Router> redirect set wlan isolation ap lan access flag ↵

Configuring WRM CPE Isolation using SNMP

where. . .

is. . .

flag

is either enable to allow direct communication, or disable to block direct communication.

ap

1 for the public SSID, or 2 for the private SSID.

Follow these steps to set CPE isolation policies using SNMP. 1 To set the isolation status for CPE devices on the same wireless interface, set the arrisWrmDevWlanApIsolationInter object to either enable(1) to block direct communication (isolation is enabled), or disable(2) to enable direct communication. 2 To set the isolation status for CPE devices on different wireless interfaces (but the same WRM), set the arrisWrmDevWlanApIsolationExtra object to either enable(1) to block direct communication (isolation is enabled), or disable(2) to enable direct communication. 3 To set the isolation status for CPE devices on the WRM Ethernet ports (and the WRM configuration web pages), set the arrisWrmDevWlanApConfigLanAccess object to either enable(1) to allow direct communication (default), or disable(2) to disable direct communication.


5

SIP Support and Implementation SIP (Session Initiation Protocol) is a signaling protocol used in IP telephony and other applications. This chapter describes SIP support in Touchstone firmware. The features and implementation described in this chapter apply only to SIP loads.

SIP Concepts The following are definitions and concepts useful for working with SIP.

Dialogs

RFC 3261 (section 12) defines dialogs as follows: A dialog represents a peer-to-peer SIP relationship between two user agents that persists for some time. A dialog is identified at each UA with a dialog ID, which consists of a Call-ID value, a local tag and a remote tag. Touchstone firmware uses several types of dialogs; for example: • registration dialog : keeps the proxy informed of the location/phone number of the MTA. • callleg dialog: the signaling for an entire call. Each of these dialog types use a common method of communication. The CSeq: header provides a unique ID so that responses are properly associated with the requests.


174

Chapter 5

Transactions

A transaction is a brief communication between two endpoints with SIP messages. Each transaction typically includes a request/response pair (an exception to this rule is an INVITE/reINVITE message). A transaction may be part of a dialog, initiate a dialog, or outside of a dialog. The transactions outside a dialog may be traced by using the sip_transc command in the CallP sub-mode.

Authorization

SIP authentication currently uses the HTTP digest algorithm. Any request can be authenticated. The authentication mechanism works as follows: 1 The proxy challenges the request by rejecting it with a 401 or 407 response. 2 The MTA re-sends the request with an authorization header. The 401/407 message includes a nonce (number used once) that the MTA hashes with its username and password. This prevents an intruder from snooping the session to re-use the communication to authenticate. The proxy periodically requires a new nonce to be used. The list of authorization headers persist until the dialog is torn down. The MTA may modify this list to prevent the list from getting too long. Each new 401/407 message typically adds a new authorization header to this list. Note:

PacketCable 2.0 requires more sophisticated authorization methods which Touchstone firmware currently does not support.

Registration

A SIP device must register with a registrar periodically. The registrar associates the SIP URI (including the phone number) with the device and stores this association in a database. This allows the proxy to determine how to locate the device to ring the phone on incoming calls. Registration is not required for outbound calls. TS5.2 and earlier versions would not play dial tone or allow outbound calls to be placed until the MTA had registered at least once. TS6.1 and later versions allows outbound calls before registration, allowing emergency calls without registering first. Each registration succeeds when the registrar responds with a 200 OK message. This response includes an ‘‘expires’’ value in either the Expires: header or the Contact Header. The MTA attempts to re-register with the registrar at a random time period between one-half and the full expiration value. This expiration value is specified in seconds. In TS6.1 and later versions, the MTA can offer an expiration value to the proxy. The MTA’s offer is the lower of the expiration value specified in the configuration file and the expiration value specified in the registrar response. The proxy is not bound to accept the offer. The sip_reg command in the CallP sub-mode. allows tracing of SIP registration-related messaging.



Subscriptions

175

Touchstone firmware partially implements SIP subscription. Two features that make use of subscriptions are call transfer and VMWI. A subscription is a dialog that is initiated by the device, expecting notification of certain events. For example, the SUBSCRIBE method is used to subscribe to VMWI updates. This allows the proxy server to notify the MTA when messages are waiting. Each SUBSCRIBE method subscribes to a specific event package. This informs the proxy what information the device is requesting. In the VMWI feature, the event package requested is the ‘‘message-summary’’ event package.

Implicit Subscriptions

A call transfer is initiated when the SIP endpoint sends a REFER message. This REFER message creates an implicit subscription. The receiver of the REFER message uses NOTIFY messages to inform the endpoint of the call transfer status. The REFER message is either sent over the call’s existing dialog or uses a Target Dialog: header. The Target Dialog method is used if the far-end includes a ‘‘tdialog’’ item in its Supported: header.

Call Legs

The MTA initiates a call by sending an INVITE message. Touchstone firmware includes an SDP with this INVITE message. The SDP informs the far-end what types of CODECs are supported and where to send the audio. The proxy usually responds with a provisional response (100 Trying) to indicate that it is in the process of reaching the far end. After the far-end receives the INVITE, it usually responds with a one of the following codes: 180 The far-end is providing power ringing and the originator should provide local ringback tone. 183 The far-end is providing power ringing and providing remote ringback tone in the form of audio media. INVITE messages within an established call (dialog) are commonly called reINVITE messages. reINVITE messages are used to modify the media of an existing call; for example, to put the call on hold or reactivate a call. It may also to be to redirect media, change to an uncompressed CODEC for fax calls, or to negotiate T.38 for a fax call. The easiest way to tell if a message is intended to be a new INVITE or a reINVITE is the tag in the TO: header. • Plain INVITE: To: • reINVITE: To: ;tag=95490288-a013d1f-13c4-50029-bb-6edc1cd1-bb


176

Chapter 5

Basic Call Flow

The following diagram shows signaling flows for a basic call.

Basic Call Flow with PRACK

The following diagram shows signaling flows for a basic call using PRACK.



177

See ‘‘PRACK’’ on page 179 for information about PRACK.

Forking

During a call, proxy servers can make flexible routing decisions to decide where to send a request. A proxy server can send an INVITE to a number of locations at the same time. This type of parallel search is known as forking. Multiple 2xx responses may arrive at the UAC for a single INVITE request due to a forking proxy. Each response is distinguished by the tag parameter in the To: header field, and each represents a distinct dialog, with a distinct dialog identifier.


178

Chapter 5

CODEC negotiation in Call Leg forking is done per-dialog. This means that if the offer is included in the initial INVITE, an answer can be in a response, for example a 183, in one dialog. Another answer can be in a 200 in another dialog. Proxies may use this feature to negotiate an intermediate media gateway for voice mail or other similar systems. Without Call Leg forking, the only way to achieve this intermediate media gateway is to use a 183 with SDP but without PRACK. This 183 contains a ‘‘hint’’ answer but does not constitute a final answer in offer/answer terms. The MTA communicates with this ‘‘hinted’’ media gateway if it receives the 183, but it is not guaranteed.

Call Forking Trace

The following diagram shows the signaling flow for call forking.

Offer/Answer

The Offer/Answer RFC (RFC 3264) explains how negotiation is done to set up a media path between two endpoints. In the basic version, the first SDP in a transaction is the ‘‘Offer.’’ The second SDP in the final response (200) is the ‘‘Answer.’’ If the offer is included in an INVITE request, the answer is included in the 200 OK. If the offer is included in the response, the answer is included in the ACK. If the offer is included in an INVITE message, a ‘‘hint’’ about the answer may be included in a 1xx message. If this is the case, the answer must still be included in the final response. This changes if PRACK is enabled.



179

PRACK

PRACK, or provisional acknowledgment, is also known as 100Rel. Its goal is to make provisional (1xx) responses reliable. This reliability means that 1xx messages can include answers in an offer/answer pair. This adds more complexity and options to the offer/answer exchange. A 180 may include an SDP that is the answer. If this is the case, the offer/answer is complete and an SDP is invalid in the 200. For more information, see RFC 3262. If the UAC receives a reliable provisional response with an offer (this would occur if the UAC sent an INVITE without an offer, in which case the first reliable provisional response will contain the offer), it MUST generate an answer in the PRACK. If the UAC receives a reliable provisional response with an answer, it MAY generate an additional offer in the PRACK. If the UAS receives a PRACK with an offer, it MUST place the answer in the 2xx to the PRACK. You can tell if PRACK is enabled by 100rel in the Supported: header field. However, not all provisional (1xx) responses are reliable in this situation. The RSeq: header is used in the provisional response to indicate it desires to be transmitted reliably. PRACK messages use the RAck: header to acknowledge these provisional responses.

Session Timer

SIP connections use a session timer to prevent calls from staying up indefinitely because an endpoint was turned off or unplugged. This requires the endpoint to ‘‘refresh’’ after a period of time. If the endpoint fails to refresh the connection, the connection is destroyed. There are two methods of refreshing the connection: • UPDATE messages (preferred method). The MTA looks at the Allow: header of previous messages on the call to determine if the UPDATE message is allowed. CODEC negotiation is optional in UPDATE messages, which prevents QoS from being redone. • reINVITE messages. If UPDATE messages are not allowed, or SIP feature switch 0x00000200 is enabled, the endpoint uses a reINVITE to refresh the session. CODEC selection and QoS are renegotiated.

SRV

SRV is a type of DNS lookup that determines the TTL, priority, weight, and port of a particular target. To query for a record, the MTA must specify that it would like to talk using SIP, and a specific transport (TCP or UDP) to a particular name. The DNS server then responds with a record entry. This record entry can be used to determine the port and target for communication. The target is typically a FQDN that the MTA uses in a subsequent standard DNS lookup (A record) to get the IP address for communication.


180

Chapter 5

Priority is used to specify a primary/secondary relationship for backup scenarios. The lower the number, the higher the priority. Weight is used to load-balance between multiple proxies. The weight values are relative to other entries with the same priority value. Example of SRV record: _Service._Proto.Name TTL Class SRV Priority Weight Port Target The UNIX dig command can be used to query a DNS server. Use the dig man page to decipher all the options. The following is an example query and response: dig @10.1.63.10 SRV _sip._udp.ser.arris-i.org ; <<>> DiG 9.2.3 <<>> @10.1.63.10 SRV _sip._udp.ser.arris-i.org ;; global options:

printcmd

;; Got answer: ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 34337 ;; flags: qr aa rd ra; QUERY: 1, ANSWER: 3, AUTHORITY: 1, ADDITIONAL: 4 ;; QUESTION SECTION: ;_sip._udp.ser.arris-i.org.

IN

SRV

_sip._udp.ser.arris-i.org. 120

IN

SRV

10 10 5060 serc.arris-i.org.


IN

SRV

30 10 5060 ser.arris-i.org.


IN

SRV

10 10 5060 serb.arris-i.org.

120

IN

NS

pc-alps.arris-i.org.

serb.arris-i.org.

120

IN

A

10.1.63.12

serc.arris-i.org.

120

IN

A

10.1.63.13

ser.arris-i.org.

120

IN

A

10.1.63.10

pc-alps.arris-i.org.

120

IN

A

10.1.63.10

;; ANSWER SECTION:

;; AUTHORITY SECTION: arris-i.org. ;; ADDITIONAL SECTION:

;; Query time: 30 msec ;; SERVER: 10.1.63.10#53(10.1.63.10) ;; WHEN: Fri Jun ;; MSG SIZE

Message Retransmission

6 15:46:51 2008

rcvd: 236

When the transport is UDP, each request is retransmitted with an exponential backoff routine. This means that the interval between each retransmission doubles after each retransmission. The initial interval is T1 seconds (.5 seconds by default). Retransmissions stop when the originator receives a response from the far-end. The final response will be retransmitted if it receives a second copy of the original request.



181

For INVITE messages, retransmissions stop after Timer B expires (7 transmissions later by default). Non-INVITE messages use a similar exponential backoff that doubles until timer T2 expires. At this point, the interval remains at T2 until Timer F expires.

SIP Message Overview

This section provides a brief description of SIP message types.

INVITE

An INVITE message is sent to initiate a call or received on incoming calls. It usually contains an SDP to attempt media negotiation. The INVITE message is also used to update the media in an active call. Touchstone firmware may send an INVITE upon a hookflash before switching between call waiting connections or to initiate a 3-way call. The INVITE message is accepted with a 200 OK and the 200 OK is acknowledged by the original sender with an ACK message. See ‘‘Response Codes’’ on page 183 for failure codes and what they may mean.

CANCEL

A CANCEL message is used to terminate an outbound call that has not yet been answered by the far end.

BYE

A BYE message is used to terminate an active call.

UPDATE

The UPDATE message can be used to negotiate media before an INVITE completes. It is also the preferred method for refreshing a session timer, since CODEC negotiation and QoS updates can be skipped.

SUBSCRIBE

Currently only used to request VMWI. See RFC 3842.

NOTIFY

The NOTIFY message is used to send information during a subscription. This may be status of a call transfer or VMWI info.


182

Chapter 5

REFER

The REFER message is currently used during Call Transfer. It is sent by the transferrer towards the party being transferred. The receiver then looks at the Refer-To: header to determine who to connect to and which active call to replace. The REFER message implicitly creates a subscription. For this reason, REFER messages are printed out if the SIP subscription trace is used.

INFO

The INFO message is used in some environments to indicate tones that should be played to the phone (if INFO was received) or events that occur on the phone (INFO is sent following a hookflash). The proxy can handle call waiting and 3-way calling internally. Only one connection exists per line in this environment. The media is mixed on a media gateway if a conference call occurs. TS6.1 MSUP3 and newer versions of Touchstone firmware support SIP INFO message handling according to RFC 2976, section 2.2. The following responses are possible: • 200 OK: sent with no message body if the INFO request was successfully recieved for an existing call. • 481 Call Leg/Transaction Does Not Exist: sent if the INFO request does not match an existing call leg. Previous versions always responded with ‘‘501 Not Implemented.’’ The eMTA sends INFO messages in response to the subscriber performing a hookflash if one of the following SIP Feature Switch bits are set: • 0x00000020 (use the standard Content-Type ‘‘application/hook-flash’’ to signal the hookflash) • 0x00080000 (use Content-Type ‘‘application/broadsoft’’ to signal the hookflash)

PRACK

Part of RFC 3262 (100rel). This message is used to acknowledge a provisional response, making it reliable. The 1XX (provisional) message includes an RSeq header and a Required: 100rel line. If an offer or answer is included in a 1XX, it is considered an official part of offer/answer. In other words, a 1XX response with an SDP, but without an offer or answer, is not reliable but simply a ‘‘hint’’ at the media desired. If it is reliable, the SDP is not a hint but should correspond to the official negotiation of offer/answer.



Response Codes

183

This section provides an abbreviated listing of SIP response codes. See RFC 3261, section 21 for complete descriptions.

1XX - Provisional Responses

Provisional responses, also known as informational responses, indicate that the server contacted is performing some further action and does not yet have a definitive response. A server sends a 1xx response if it expects to take more than 200 ms to obtain a final response. Note that 1xx responses are not transmitted reliably (unless PRACK is enabled). Final Responses are 2XX through 6XX.

2XX - Successful

The request was successful.

3XX - Redirection

3xx responses give information about the user’s new location, or about alternative services that might be able to satisfy the call.

4XX - Request Failure

4xx responses are definite failure responses from a particular server. The client SHOULD NOT retry the same request without modification (for example, adding appropriate authorization). However, the same request to a different server might be successful.

5XX - Server Failure

5xx responses are failure responses given when a server itself has erred.

6XX - Global Failures

The called system was contacted successfully, but the callee is busy and does not wish to take the call at this time. The response may indicate a better time to call, in the Retry-After: header field. If the callee does not wish to reveal the reason for declining the call, the callee uses status code 603 (Decline). This status response is returned only if the client knows that no other endpoint (such as a voice mail system) will answer the request. Otherwise, 486 (Busy Here) should be returned.


184

Chapter 5

Overview of SIP Features This section describes some important features of the SIP loads.

SIP Proxy Penalty Box

The SIP Proxy Penalty Box feature can be used with SRV to address multiple SIP proxies. In the event of a message send failure (the proxy has not responded to a message for the MTA for 32 seconds), the particular SRV record that was used for the failed message is blacklisted. This feature prevents the MTA from experiencing multiple 32 second delays when a proxy is down. This feature can greatly improve MTA performance because message send failures cause long delays in call completion and registration. To use the Penalty Box feature, enable the following SIP feature switch settings: useSrvLookups (0x00400000) - enable SRV lookup for servers proxyPenaltyBox (0x00000800) - Use penalty box for unresponsive proxies TS6.1 introduces a Penalty Box timer, sipCfgPenaltyBoxTimeout, that sets the time (in hours) to hold entries in the Penalty Box. When the timer expires, the proxy is released. The default time is 24 (hours). Setting the timer to 0 restores the pre-TS6.1 behavior where the proxies are held until all known proxies fail to respond or a sixth proxy is added (which releases the first held proxy). The Penalty Box can hold up to five proxy addresses. If all available proxies are in the Penalty Box, then the proxy that has been blacklisted for the longest time is removed from the Penalty Box. Normal SRV load balancing rules of priority and weight are applied to the set of proxy addresses that are not in the Penalty Box. Those rules are as follows: • The SRV record with the highest priority is always used first. • For SRV records with the same priority, weight is used to randomly choose an SRV record. The penalty box can hold up to five proxy addresses. Proxies are released from the penalty box under the following conditions: • A sixth proxy times out; the first proxy to be placed in the penalty box is then released. • The MTA is reset. • The sipCfgPenaltyBoxTimeout object is set to a non-zero time (default: 24 hours), the specified number of hours have elapsed, and the proxy responds to a REGISTER message.



185

• All other known proxies have message send failures. Examples: SRV record ‘‘Alpha’’ has priority 1, weight 50. SRV record ‘‘Beta’’ has priority 2, weight 50. Initially, all SIP messages are sent to proxy Alpha because it has higher priority. If Alpha fails to respond for 32 seconds, then it is placed in the Penalty Box, and all subsequent SIP messages are sent to Beta instead. If Beta fails, it will be placed in the Penalty Box, and Alpha will be removed from the Penalty Box. All subsequent SIP messages will be sent to proxy Alpha. The MTA continues to alternate between the two proxies any time that a message send failure occurs. Now assume that Alpha and Beta have the same priority. Initially, the MTA uses the SRV weights to randomly select one of the two proxies for each SIP message that goes out. If a message send failure occurs, the proxy that failed is placed in the penalty box, and the other proxy is used exclusively. From this point, the MTA behaves identically to the first example, alternating between proxies each time that a send failure occurs. If the MTA resets, then the Penalty Box is emptied, and SRV weight is once again used to determine which proxy to use.

Barge-In

The Join: header (RFC 3911) may used to barge-in to an existing call. A brief tone is played to the existing call as the calls are conferenced together.

Loopback

The SIP MTA can terminate loopback calls. When a loopback call is received, the phone does not ring. It automatically answers the call and loops back media or packets to the originator. The MTA has a 2 call per line resource limitation. The user may make a call or receive a call while a loopback call is in progress. If another call is placed, either by an incoming call or a new outbound call, the loopback call is disconnected. Packet Loopback is analogous to NETWLOOP. Media Loopback is analogous to NETWTEST. The Loopback Draft 〈 http://www.ietf.org/internet-drafts/ specifies the draft-ietf-mmusic-media-loopback-08.txt〉 CODEC negotiation involved in setting up a loopback call. Touchstone firmware also supports a proprietary loopback method that uses a MIB object to specify phone numbers that cause a loopback call to be created if the MTA receives a call from one of these provisioned numbers. See ‘‘Loopback’’ on page 187 for details.


186

Repeat Dialing

Chapter 5

To use repeat dialing, it must first be provisioned as a MTA feature. A provisioning example is below. # Set up Repeat Dialing as star code *70 {SnmpMib sipCfgDialFeatName.1 repeatDialingEnable} {SnmpMib sipCfgDialFeatCode.1 "*70" } {SnmpMib sipCfgDialFeatTone.1 stutterTone} # Works on first 4 lines {SnmpMib sipCfgDialFeatActive.1 0.0.0.F} {SnmpMib sipCfgDialFeatMode.1 02}

When the MTA is playing busy tone after calling a busy subscriber, the user may press *70 to begin repeat dialing. The phone rings when the other endpoint is no longer busy. INVITE messages are sent every 10 seconds by default. This interval is configurable by sipCfgRepeatDialingInter val. The MTA continues trying this endpoint until the timer set to the value of sipCfgRepeatDialing expires. The sipCfgRepeatDialingSessionProgressTimer object helps avoid false alarms by waiting for a period of time before considering a 183 message a successful attempt. PSTN connections often send a 183 to play busy tone prior to disconnecting with a 486 message.

Provisioning Considerations This section describes SIP provisioning considerations.

Provisioning Details

This section describes various SIP features that can be configured in the provisioning file.

Digit Map

SIP digit maps are identical to NCS digit maps: • An x indicates any digit. • The | (pipe) character separates different entries. After each digit is pressed, the digit collector looks at each entry in the digit map to determine if any entry is complete. If an entry is complete, dialing is complete. There are some exceptions when star codes are specified. For a star code (VSC) to be handled, it must be in the digit map and possibly in another MIB object. The below example is 10 digit dialing with 2 digit star codes. {SnmpMib sipCfgDigitMap.0 "xxxxxxxxxx|*xx"}



187

Proxy Address

The proxy address specifies the destination where the MTA sends all SIP requests. You must also specify the proxy type, IP or DNS. {SnmpMib sipCfgProxyAdr.0 "ser.arris-i.org;5060"} {SnmpMib sipCfgProxyType.0 dns}

Registrar Address

The registrar address specifies the text of the top line of the REGISTER request. {SnmpMib sipCfgRegistrarAdr.0 "registrar.arris-i.org;5060"} {SnmpMib sipCfgRegistrarType.0 dns}

Loopback

The following MIB objects allow incoming calls to be looped back to the originator. A match is done on the incoming call and compared to the strings below to determine which type of loopback occurs. {SnmpMib sipCfgMediaLoopbackNumber.0 "7705558001"} {SnmpMib sipCfgPacketLoopbackNumber.0 "7705558002"}

Packetization Rate

The packetization rate can be set to 10 or 20 milliseconds. {SnmpMib sipCfgPacketizationRate.0 20}

Provisioned CODEC Array

A semicolon-delimited list of CODEC types. This only affects outbound calls. The MTA attempts to negotiate the CODECs in the list. CODECs are listed in order of preference and used only on initial outbound INVITE messages. Incoming requests answer with the CODECs supported in the initial offer’s order. {SnmpMib sipCfgProvisionedCodecArray.0 "PCMU;PCMA;G729;telephone-event"}

Repeat Dialing

The following MIB objects control repeat dialing.


188

Chapter 5

sipCfgRepeatDialingInterval Specifies the time between attempts to connect to other party. sipCfgRepeatDialingTimeout A timer value that specifies how long the MTA should keep trying to connect to the other party. sipCfgRepeatDialingSessionProgressTimer Specifies the length of time after a 183 is received before considering the repeat dialing attempt successful. Often a 183 is received prior to a negative response. This timer prevents false positives.

These are the default values. {SnmpMib sipCfgRepeatDialingInterval 10} {SnmpMib sipCfgRepeatDialingTimeout 30} {SnmpMib sipCfgRepeatDialingSessionProgressTimer 60}

Call Forwarding Forbidden Numbers

There are certain phone numbers (eg. 911) that Call Forwarding should not accept as forwarding numbers. The sipCfgCallForwardForbiddenNumbers MIB object specifies which numbers are not allowed as forwarding numbers. This object can be set only in the configuration file. Multiple numbers may be specified separated by | as follows: {SnmpMib sipCfgCallForwardForbiddenNumbers.0 "911|900|1900|0"} Note:

The emergency number set in sipCfgEmergencyNumber is also not allowed as a forwarding number.

Call Waiting setting Persistent Across Reboot

If the sipCfgCallWaitingStarCodeSurvivesReset MIB object is set to true, the call waiting state is set in non-volatile memory to ensure the state persists if the MTA reboots. {SnmpMib sipCfgCallWaitingStarCodeSurvivesReset.0 true}

To clear this setting, to re-locate the MTA to another customer that may have a different preference or for some other reason, use the sipCfgResetCallWaitingStarCode MIB object to clear the NVM setting. The MIB object controls the setting of this value on a per-line basis, using a bit string to indicate which lines should be reset. # reset lines 1 and 2 {SnmpMib sipCfgResetCallWaitingStarCode.0 0x00000003}



189

Default G.711

When using G.729 as the primary voice CODEC, the MTA must switch to a G.711 CODEC to support faxes transmission. Touchstone firmware switches to PCMU in this situation by default. Some customers require PCMA as the pass-through CODEC. Use the sipCfgDefaultG711 MIB object to specify a different pass-through CODEC, as follows: {SnmpMIb sipCfgDefaultG711.0 pcma}

Domain Override

The sipCfgDomainOverride MIB object specifies the string to use in the domain in all outbound SIP signaling messages. {SnmpMib sipCfgDomainOverride.0 "arris-i.org"}

Emergency Calls

Emergency calls have special treatment. This special treatment is determined based on the outbound dialed string. Provision the emergency number using the sipCfgEmergencyNumber object, as follows: {SnmpMib sipCfgEmergencyNumber.0 911}

The end user is never allowed to terminate an emergency call. If the user goes on hook, the MTA does not send a BYE message. Instead, the call is put on "Network Hold" as follows: 1 When the end user goes on-hook during an emergency call, the Touchstone MTA sends an INVITE (priority:emergency SDP:a=inactive). This causes the PSAP operator to hear a tone that indicates that the user went on-hook. 2 The PSAP operator can send an INVITE (prioirty:emergency SDP:a=sendrecv) that causes the MTA to ring. If the user goes offhook before receiving such an INVITE, then it should send the invite to re-establish two-way communications. 3 The Network Hold Timer specifies the maximum time that an emergency call is preserved in the Network Hold state. The timer is started every time that the user goes on-hook during an emergency call, and is cleared if the user goes off hook. If the Network Hold Timer expires, then the MTA sends a BYE message to finally terminate the call. The default value for the Network Hold Timer is 45 minutes. See PKT-SP-RSTF-I02-070925 section 8.5.5.8 for more details on Network Hold for Emergency Calls, including call flows for various Network Hold scenarios.


190

Chapter 5

Pulse Dialing

The arrisMtaDevEndPntDialingMethod MIB object enables pulse dialing. The object is indexed by line number. {SnmpMib arrisMtaDevEndPntDialingMethod.1 toneAndPulse}

Line Specific Features

The sipCfgPortFeatureSettings MIB object enables various line-specific features. The object is a bit-mask; each bit controls a specific feature as shown in the following table. Bit

Feature

0x80

Default

0x40 0x20 0x10

Caller ID disabled Anonymous call rejection Call Waiting disabled

0x08 0x04 0x02

Disable Three-Way Calling Disable Caller ID display Enable Call Transfer

Example: {SnmpMib sipCfgPortFeatureSettings.1 02}

Distinctive Ringing

Several distinctive ringing types, corresponding to R0 through R7, are defined by the country template. If the Alert-Info: header is received, Touchstone firmware compares the header to the strings specified in the MIB objects sipCfgAler tInfoR0 through sipCfgAler tInfoR7. If the header matches one of these, the MTA plays the corresponding R0–R7 tone. The following configuration shows the default string settings. {SnmpMib sipCfgAlertInfoR0.0 "< http://127.0.0.1/Bellcore-dr0 >"} {SnmpMib sipCfgAlertInfoR1.0 "< http://127.0.0.1/Bellcore-dr1 >"} {SnmpMib sipCfgAlertInfoR2.0 "< http://127.0.0.1/Bellcore-dr2 >"} {SnmpMib sipCfgAlertInfoR3.0 "< http://127.0.0.1/Bellcore-dr3 >"} {SnmpMib sipCfgAlertInfoR4.0 "< http://127.0.0.1/Bellcore-dr4 >"} {SnmpMib sipCfgAlertInfoR5.0 "< http://127.0.0.1/Bellcore-dr5 >"} {SnmpMib sipCfgAlertInfoR6.0 "< http://127.0.0.1/Bellcore-dr6 >"} {SnmpMib sipCfgAlertInfoR7.0 "< http://127.0.0.1/Bellcore-dr7 >"}



191

Dialing Features

The sipCfgDialFeatTable specifies dialing features that are handled by the MTA. The following example assigns Anonymous Call Reject to the *40 dialing code. # Set up Anonymous Call Rejection as star code *40 {SnmpMib sipCfgDialFeatName.1 anonCallReject} {SnmpMib sipCfgDialFeatCode.1 "*40" } {SnmpMib sipCfgDialFeatTone.1 stutterTone} # Works on first 4 lines {SnmpMib sipCfgDialFeatActive.1 0.0.0.F} # optional -- currently only used for # repeat dialing (where its value should be 02) {SnmpMib sipCfgDialFeatMode.1 01}

Hybrid features, which are passed up to the proxy in an INVITE message, are controlled by the sipCfgDialProxyTable. The following example assigns *50 as a hybrid feature. # Active star code *50 as a hybrid feature {SnmpMib sipCfgDialProxyCode.1 "*50" } {SnmpMib sipCfgDialProxyTone.1 stutterTone} # Works on first 4 lines {SnmpMib sipCfgDialProxyActive.1 0.0.0.F} # optional -- default is to use INVITE, # may be used to send REFER instead. {SnmpMib sipCfgDialProxyMessageType.1 01}

Proxy features are sent directly to the proxy in an INVITE message. No configuration is necessary to handle these features.

Call Transfer

Uses the target dialog (RFC 4538) if supported by far-end; otherwise, sends REFER on the existing Call Leg. In most cases, call transfer is initiated by the pivot phone going on hook. This triggers a transfer if Call Transfer is enabled, and the call is in one of the threeWayCalling, callingHolding, or conference states. When advanced flash digit handling is enabled, call transfer can be initiated by the 4 digit. The transfer is performed by the pivot phone. The pivot phone sends a REFER message to the original call. This REFER message includes a ReferTo: header which notifies the party being transferred who to contact. Embedded in the ReferTo: header is a Replaces: header (RFC 3891). The party receiving the REFER message then sends an INVITE to the party referenced in the ReferTo: header. The Replaces: header is then copied to its own header in this INVITE. The party receiving the INVITE with the Replaces: header uses this header to determine which call to disconnect and replace with the transferred party.


192

Chapter 5

Feature Capabilities

Ten MIB objects allow control of certain features on a per-line basis. The objects follow a naming convention of sipCfg feat Capability, where feat is the specific feature. Each MIB object consists of a hexadecimal bit string (32 bits wide) where each bit is a flag corresponding to a different line. These objects can be only set in the configuration file. When a feature capability of a particular line is set to zero (off), that feature is disabled for that line regardless of the value of any other MIB object, including sipCfgFeatureSettings. By default, all feature capabilities are enabled for every line; all ten MIB objects default to the hex value FFFFFFFF (which is a string of 32 ones). When a feature is enabled, the user may still enable or disable the feature using dial codes. However, if the feature capability is disabled in the configuration file, the dial code to enable that feature does not work. The following table lists the controllable features and the corresponding MIB object controlling its capability: Feature

Caller ID Display Caller ID Send

MIB Object

sipCfgCallerIdDisplayCapability sipCfgCallerIdSendCapability

Anonymous Call Rejection sipCfgAnonCallRejectionCapability sipCfgCallWaitingCapability Call Waiting sipCfgThreeWayCallCapability Three Way Calling sipCfgCallTransferCapability Call Transfer sipCfgCallForwardCapability Call Forwarding sipCfgCallReturnCapability Call Return sipCfgCallRedialCapability Call Redial sipCfgCallHoldCapability Call Holding Examples: To disable three-way calling for lines 1 and 3, add the following line to the configuration file: {SnmpMib sipCfgThreeWayCallCapability.0 FFFFFFFA} Note:

For an 8- or 12-line Telephony Modem, this is identical to setting the value to 00000FFA because only the 12 least significant bits are used. To disable three-way calling for all lines on a Telephony Modem, modify the setting as follows: {SnmpMib sipCfgThreeWayCallCapability.0 00000000}

To enable three-way calls for all lines, delete any settings for sipCfgThreeWayCallCapability from the configuration file and reset the modem.



193

For any of these changes to take effect, the modem needs to be reset to download the updated configuration file.

Registration

Several proprietary MIB objects control registration. By default, the registration is received from the registrar in the 200 OK response to a REGISTER request. The sipCfgRegExpires object can specify a suggestion to the registrar for a desired registration expiry value. If the specified value is non-zero, the MTA uses the smaller of the expiry value returned by the registrar in the 200 OK or the value specified in sipCfgRegExpires. If sipCfgRegExpires is unconfigured or specified to zero, no expires value is specified in the REGISTER request. {SnmpMib sipCfgRegExpires.0 1800}

If a REGISTER attempt fails, the MTA enters a backoff algorithm to retry registration. This backoff algorithm is exponential. The initial backoff starts at the value specified by sipCfgRegTimerMin (default: 60 seconds). The interval between retry attempts doubles until it is greater than the value specified by sipCfgRegTimerMax (default: 1800 seconds). The interval between retries is not to exceed the value specified by sipCfgRegTimerMax. {SnmpMib sipCfgRegTimerMin.0 60} {SnmpMib sipCfgRegTimerMax.0 1800}

Initial registration uses the NCS PacketCable MIB for MWD to determine the time to wait before registering. This default is 10 minutes. This may be adjusted to a value (in seconds) with the following MIB object. The indices are different for PacketCable MIBs. Line 1 uses index 9, line 2 uses index 10 and so on. {SnmpMib pktcNcsEndPntConfigMWD.9 20}

Each REGISTER attempt is not a single message. The MTA will retry REGISTER messages based on the retransmission algorithm specified in RFC 3261. By default, the MTA retries 7 times over a 32-second interval. The retransmission algorithm is also exponential. The basis interval is specified by T1 (sipCfgT1). The total time to retransmit is specified by TimerF (sipCfgTimerF).

Timers

• Timer T1 — sipCfgT1 (PacketCable 2.0 MIB also specified) specifies the initial interval between retransmission attempts. • Timer T2 — PacketCable 2.0 MIB; see RFC 3261 for details.


194

Chapter 5

• Timer T4 — PacketCable 2.0 MIB; see RFC 3261 for details. • Timer B — sipCfgTimerB specifies the number of retransmission attempts or the time to keep retransmitting INVITE messages. The sipCfgMaxRetrans object (deprecated) specifies the number of retries. • Timer F — sipCfgTimerF specifies the time to keep retransmitting nonINVITE messages. • Timers D and H — sipCfgInviteLinger • Timer K — sipCfgGenLing er

SIP Feature Switch

The SIP feature switch enables or disables extended features in the SIP load. See ‘‘SIP Feature Switch’’ on page 71 for a detailed description of each switch.

Minimal Example

The following configuration file fragment provides a minimal example of SIP configuration. set mcns_config_params { {TelephonyConfigFileBeginEnd 1} # MTA Enabled {SnmpMib pktcMtaDevEnabled.0 1} # Proxy Address {SnmpMib sipCfgProxyAdr.0 "ser.arris-i.org;5060"} {SnmpMib sipCfgProxyType.0 1} # Registrar Address -- used in REGISTER request URI {SnmpMib sipCfgRegistrarAdr.0 "registrar.arris-i.org;5060"} {SnmpMib sipCfgRegistrarType.0 1} #### Line 1 Configuration # Phone Number {SnmpMib sipCfgPortUserName.1 7705558001} # Caller-ID Display {SnmpMib sipCfgPortDisplayName.1 "David Line1"} # Proxy Authentication Username {SnmpMib sipCfgPortLogin.1 traff} # Proxy Authentication Password {SnmpMib sipCfgPortPassword.1 password} # Line 1 Enabled {SnmpMib ifAdminStatus.9 1 }



195

# Try registration time within 10 seconds of getting config file {SnmpMib pktcNcsEndPntConfigMWD.9

10}

#### Line 2 Configuration # Phone Number {SnmpMib sipCfgPortUserName.2 7705558002} # Caller-ID Display {SnmpMib sipCfgPortDisplayName.2 "David Line2"} # Proxy Authentication Username {SnmpMib sipCfgPortLogin.2 traff} # Proxy Authentication Password {SnmpMib sipCfgPortPassword.2 password} # Line 2 Enabled {SnmpMib ifAdminStatus.10 1 } # Try registration time within 10 seconds of getting config file {SnmpMib pktcNcsEndPntConfigMWD.10 10} {TelephonyConfigFileBeginEnd 255} }

Troubleshooting SIP An MTA config file dump often helps determine the current settings on a SIP MTA [ [

1] Console> / mta 2] MTA> co

MD5 Dump Utility SnmpMib = pktcMtaDevEnabled.0 1 SnmpMib = sipCfgDigitMap.0 8888|0[t#]|00|101xxxx0[t#]|01[2-9] xxxxxxx.[t#]|101xxxx01[2-9]xxxxxxx.[t#]|011xxxxxxx.[t#]| 101xxxx011xxxxxxx.[t#]|[2-9]11|[01][2-9]11|101xxxx[2-9]11| 101xxxx[01][2-9]11|*xx|11xx|[2-9]xxxxxx[t#]|[01][2-9]xxxxxx[t#]| 101xxxx[2-9]xxxxxx[t#]|101xxxx[01][2-9]xxxxxx[t#]| [2-9]xx[2-9]xxxxxx|[01][2-9]xx[2-9]xxxxxx| 101xxxx[2-9]xx[2-9]xxxxxx|101xxxx[01][2-9]xx[2-9]xxxxxxx| [2-9]x#|#[2-9]x SnmpMib = sipCfgBusyDigitMap.0 *x SnmpMib = sipCfgProxyAdr.0 ser.arris-i.org;5060 SnmpMib = sipCfgProxyType.0 1 SnmpMib = sipCfgRegistrarAdr.0 registrar.arris-i.org;5060 SnmpMib = sipCfgRegistrarType.0 1 SnmpMib = sipCfgFeatureSwitch.0 0x8000 SnmpMib = sipCfgProvisionedCodecArray.0 PCMU;PCMA


196

Chapter 5

SnmpMib = sipCfgPacketizationRate.0 20 SnmpMib = sipCfgDialFeatMap.0 #SIP Dial Features: SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib

= = = = =

sipCfgDialFeatName.1 61 sipCfgDialFeatCode.1 *22,1122 sipCfgDialFeatTone.1 1 sipCfgDialFeatActive.1 0x3 sipCfgDialFeatMode.1 0x1

SnmpMib = sipCfgAlertInfoR0.0 < file://Bellcore-dr0 > SnmpMib = sipCfgAlertInfoR1.0 < file://Bellcore-dr1 > SnmpMib = sipCfgAlertInfoR2.0 < file://Bellcore-dr2 > SnmpMib = sipCfgAlertInfoR3.0 < file://Bellcore-dr3 > SnmpMib = sipCfgAlertInfoR4.0 < file://Bellcore-dr4 > SnmpMib = sipCfgAlertInfoR5.0 < file://Bellcore-dr5 > SnmpMib = sipCfgAlertInfoR6.0 < file://Bellcore-dr6 > SnmpMib = sipCfgAlertInfoR7.0 < file://Bellcore-dr7 > SnmpMib = sipCfgDomainOverride.0 SnmpMib = sipCfgEmergencyNumber.0 SnmpMib = sipCfgRegTimerMin.0 60 SnmpMib = sipCfgRegTimerMax.0 1800 SnmpMib = sipCfgT1.0 500 SnmpMib = sipCfgMaxRetrans.0 4 SnmpMib = sipCfgMediaLoopbackNumber.0 SnmpMib = sipCfgPacketLoopbackNumber.0 SnmpMib = sipCfgRepeatDialingInterval.0 60 SnmpMib = sipCfgRepeatDialingTimeout.0 1800 SnmpMib = sipCfgRepeatDialingSessionProgressTimer.0 2 SnmpMib = sipCfgCallWaitingCapability.0 ffffffff SnmpMib = sipCfgCallerIdDisplayCapability.0 ffffffff SnmpMib = sipCfgCallerIdSendCapability.0 ffffffff SnmpMib = sipCfgAnonCallRejectionCapability.0 ffffffff SnmpMib = sipCfgCallForwardCapability.0 ffffffff SnmpMib = sipCfgThreeWayCallCapability.0 ffffffff SnmpMib = sipCfgCallTransferCapability.0 ffffffff SnmpMib = sipCfgCallReturnCapability.0 ffffffff SnmpMib = sipCfgCallRedialCapability.0 ffffffff SnmpMib = sipCfgCallHoldCapability.0 ffffffff SnmpMib = sipCfgProxyDigitMap.0 x.[t#] SnmpMib = sipCfgCallWaitingStarCodeSurvivesReset.0 1l SnmpMib = sipCfgResetCallWaitingStarCode.0 3 Proxy Dial Features: SnmpMib = sipCfgDialProxyCode.2 *70 SnmpMib = sipCfgDialProxyTone.2 1 SnmpMib = sipCfgDialProxyActive.2 00000003 SnmpMib = sipCfgDialProxyMessageType.2 1 SnmpMib = sipCfgDialProxyVSCType.2 1 SnmpMib = sipCfgDialProxyCode.1 *50 SnmpMib = sipCfgDialProxyTone.1 1 SnmpMib = sipCfgDialProxyActive.1 00000003 SnmpMib = sipCfgDialProxyMessageType.1 2 SnmpMib = sipCfgDialProxyVSCType.1 1 SnmpMib = sipCfgDialProxyCode.0 *90 SnmpMib = sipCfgDialProxyTone.0 1 SnmpMib = sipCfgDialProxyActive.0 00000003 SnmpMib = sipCfgDialProxyMessageType.0 1 SnmpMib = sipCfgDialProxyVSCType.0 0 #Line 1 Parameters SnmpMib = sipCfgPortUserName.1 7705558001 SnmpMib = sipCfgPortDisplayName.1 David Line1



SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib

197

= = = = = = = = = = = =

sipCfgWarmOrHotlineNumber.1 sipCfgWarmLineTimeout.1 0 sipCfgPortProxyAdr.1 sipCfgPortProxyPort.1 5060 sipCfgPortProxyType.1 0 sipCfgPortRegistrarAdr.1 sipCfgPortRegistrarPort.1 5060 sipCfgPortRegistrarType.1 0 sipCfgPortFeatureSettings.1 0x2 sipCfgPortT38Mode.1 1 sipCfgPortMaxT38HSRedLevel.1 1 sipCfgPortFaxOnlyTimeout.1 0

#Line 2 Parameters SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib SnmpMib

Internal MTA States

= = = = = = = =

sipCfgPortUserName.2 7705558002 sipCfgPortDisplayName.2 David Line2 sipCfgWarmOrHotlineNumber.2 sipCfgWarmLineTimeout.2 0 sipCfgPortProxyAdr.2 sipCfgPortProxyPort.2 5060 sipCfgPortProxyType.2 0 sipCfgPortRegistrarAdr.2

The following list describes internal MTA states when running SIP firmware loads. • IDLE — Phone is on-hook, no calls are active. A loopback call could be taking place. • PREDIAL — Phone is off-hook and dial tone is being played. • DIALING — Phone is off-hook and at least one digit was placed. The digits dialed have not matched a complete digitmap entry. • CALLING — Phone is off-hook and an INVITE has been sent to the far end. Digits have already been collected. • RINGING — Phone is on-hook and ringing because of an incoming call. • CONNECTED — Phone is off-hook. The far-end is connected. • CONNECTED_ALERTING — Phone is off-hook and has an active connection. An inbound call was just received. • CALL_WAITING — Phone is off-hook and has one active leg and one held leg. • THREE_WAY_CALLING — Phone is off-hook and has one active leg and one held leg. This is pre-conference. • CONFERENCE — Phone is off-hook and connected with two parties. Media is mixed at the pivot.


198

Chapter 5

• CONFERENCE_BEFORE_ANSWER — Phone is off-hook and connected with a single party. The other outbound call is outstanding and has not been answered. Media is mixed and both parties hear ringback. Will automatically move to CONFERENCE when the outbound call answers. • STRANDED_CALL — Phone is on-hook but an active call exists. The phone is ringing.

SIP Logging

Enable log types 65, 66, 67, 68, and 69 when troubleshooting any SIP issue. 1 Change to the Log Directory: [

1] Console> / log

2 Enable logs 67 and 68: [ 2] Log Utilities> disp 67 1 disp 67 1 Display enabled for logType 67 (LOG_SIP_STATE) [ 3] Log Utilities> disp 68 1 disp 68 1 Display enabled for logType 68 (LOG_SIP_INPUT) [ 4] Log Utilities> disp 65 1 disp 65 1 Display enabled for logType 65 (LOG_SIP_STACK) [ 6] Log Utilities> disp 66 1 disp 66 1 Display enabled for logType 66 (LOG_SIP_DBG) [ 7] Log Utilities> disp 69 1 disp 69 1 Display enabled for logType 69 (LOG_SIP_STACKDBG)

3 All of these may be turned on in TS6.1 and newer releases with the following: [

8] Log Utilties> sip 1

4 Confirm the desired LOG levels are turned on: [ 4] Log Utilities> disp USAGE: display <0=OFF,1=ON> Arris Log Display Report Levels ------------------------------01 SYS On 02 MEM On 03 FLASH On 04 FLASHDEBUG Off



199

05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

TLM WDTDIAG WDT DISPLAY SWDNLD NVM NVMDEBUG DSP DSPERROR QERROR RESET TASKERROR ARP_SYS DP DP_DIAG DP_DEBUG CALLP_SYS CALLP_EPP CALLP_DBG CALLP_TRC CALLP_TRC_EPPR CALLP_TRC_EPPTONE CALLP_TRC_EPPTMR CALLP_MSG CALLP_EVT CALLP_QOS_DBG CALLP_QOS_ERR CALLP_DYN CALLP_STATS CALLP_DNS SNMP SNMP_DBG PPDB PPDB_DBG MTA ROOTSM PROVSM PPMTC PPFSM PPFSM_SWR PPFSM_DB LINEFSM_SWR LINEFSM_DB LINEFSM PPMTC_CLI ALM ALM_DBG HPNA SWERR LC

Off Off On Off On On Off Off On On On On Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off On Off On Off Off Off Off Off Off Off Off Off Off Off Off On Off Off On On


200

Chapter 5

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

SIP Traces

TI PCSEC RTCP_DEBUG AVLLIB RTCP_TRC LOG_AUTO EXT_EXC LOG_USB LOG_ALT SIP_DC LOG_SIP_STACK LOG_SIP_DBG LOG_SIP_STATE LOG_SIP_INPUT LOG_SIP_STACKDBG LOG_ETH LOG_WRM LOG_WRM_DEBUG LOG_RF

On Off Off Off Off Off Off Off Off Off On On On On On Off On Off Off

Follow these steps to perform SIP traces: 1 Change to the Callp Directory: [

1] Console> / callp

2 To turn on printouts of all SIP messages associated with a call: [ 2] Call Processing> sip 1 sip 1 Return Status: 0

3 To turn on the printouts for SIP transactions (not associated with call): For example: OPTIONS, PING requests/responses [ 2] Call Processing> sip_t 1 sip_t 1 Return Status: 0

4 To turn on the printouts for SIP registrations: [ 2] Call Processing> sip_r 1 sip_r 1 Return Status: 0

5 To turn on the printouts for SIP subscriptions, used for solicited VMWI (RFC 3841) and call transfer — SUBSCRIBE and REFER messages: [ 2] Call Processing> sip_s 1 sip_s 1 Return Status: 0



201

References Touchstone SIP firmware loads fully or partially conform to the following specifications: • RFC 3261 — primary SIP specification • RFC 3264 — Offer Answer • RFC 3842 — VMWI: Voice Message Waiting Indicator • RFC 2327 — SDP: Session Description Protocol • RFC 3262 — (PRACK/100Rel

Reliability

of

Provisional

Responses

in

SIP

• RFC 4538 — Request Authorization through Dialog Identification in SIP (target dialog) • RFC 3891 — SIP ‘‘Replaces’’ Header (Call Transfer) • RFC 4028 — SIP Session Timer • RFC 3911 — SIP ‘‘Join’’ Header


202


Chapter 5

6

MIB Reference This chapter lists the MIBs referenced by the TS6.1 firmware. See the Touchstone Telephony Troubleshooting Guide for a partial list of MIB variables used for troubleshooting.

Supported MIBs The TS6.1 firmware supports all standard MIB objects required by DOCSIS. Note 1:

To comply with PacketCable specifications, Touchstone firmware restricts CM-related MIB access to the CM IP address, and MTA-related MIB access to the MTA IP address.

Note 2:

MIB objects which contain 64-bit types (such as Counter64) require SNMPv2 or higher for access. SNMPv1 only supports up to 32-bit types.

ARRIS Proprietary MIBs

The following ARRIS-specific MIBs are required for full SNMP support of Touchstone cable modems and are included on the firmware CD. ARRIS-MIB A header for the ARRIS enterprise MIB. ARRIS-CM-DEVICE-MIB The portion of the ARRIS enterprise MIB that applies to Touchstone Cable Modems. PACKETPORT-MIB The portion of the ARRIS enterprise MIB that applies to Touchstone eMTAs. ARRIS-MTA-DEVICE-MIB The portion of the ARRIS enterprise MIB that applies to status monitoring for Touchstone batteries and Loop Voltage Management settings.


204

Chapter 6

ARRIS-SIP-MIB The portion of the ARRIS enterprise MIB that applies to SIP support.

DOCSIS MIBs

DOCS-CABLE-DEVICE-MIB (RFC-2669) Provides controls and status information in the CMTS and cable modems. DOCS-IF-MIB (RFC-2670) Describes MCNS compliant Radio Frequency (RF) interfaces in CMTS and cable modems. DOCS-BPI-MIB (RFC-2083) Describes the Baseline Privacy Interface (BPI) implementation in the CMTS and cable modems. DOCS-BPI2-MIB Describes the Baseline Privacy Plus Interface (BPI+) implementation in the CMTS and cable modems. DOCS-QOS-MIB Describes the management information for Quality Of Service (QOS) in DOCSIS 1.1. DOCS-SUBMGT-MIB Describes the subscriber management interface for cable modems. DOCS-IF-EXT-MIB Extensions to the DOCS-IF-MIB. DOCS-CABLE-DEVICE-TRAP-MIB An extension of the CABLE DEVICE MIB defined in RFC 2669. It defines various trap objects for both cable modems and the CMTS. ESAFE-MIB Describes the objects necessary to configure functionality of eSAFE components of a device containing an eDOCSIS compliant cable modem and one or more eSAFE elements.

PacketCable MIBs

CLAB-DEF-MIB A header for the PacketCable MIB. PKTC-MTA-MIB Supplies basic management objects for MTA devices. PKTC-SIG-MIB Contains all objects and provisioning data for each endpoint (or telephone line). PKTC-IETF-MTA-MIB Euro-PacketCable equivalent of PKTC-MTA-MIB.


MIB Reference

205

PKTC-IETF-SIG-MIB Euro-PacketCable equivalent of PKTC-SIG-MIB. PKTC-EVENT-MIB Supplies the basic objects required for reporting events (for example, logs and alarms).

Network-related MIBs

IF-MIB (RFC-2233) Describes generic objects for network interface sub-layers. BRIDGE-MIB (RFC-1493) An interface to IEEE 802.1D-style bridges. EtherLike-MIB (RFC-2665) Status objects and counters associated with an Ethernet interface. IP-MIB (RFC-2011) The MIB module for managing IP and ICMP implementations, but excluding their management of IP routes. UDP-MIB (RFC-2013) The MIB module for managing UDP implementations. IGMP-STD-MIB (RFC-2933) IGMP protocol support. USB-MIB Describes the cable modem USB interface. SNMP-NOTIFICATION-MIB, SNMP-TARGET-MIB (RFC-2573) Defines MIB objects that provide mechanisms to remotely configure the parameters used by an SNMP entity for the generation of notifications. SNMP-USER-BASED-SM-MIB (RFC-2574) The management information definitions for the SNMP User-based Security Model (USM). SNMP-USER-BASED-ACM-MIB, SNMP-VIEW-BASED-ACM-MIB (RFC-2575) The management information definitions for the SNMP View-based Access Control Model (ACM). SNMP-COMMUNITY-MIB (RFC-2576) This MIB module defines objects to help support coexistence between SNMPv1, SNMPv2, and SNMPv3. SNMP-USM-DH-OBJECTS-MIB (RFC-2786) The management information definitions for providing forward secrecy for key changes for the usmUserTable, and for providing a method for kick-starting access to the agent via a Diffie-Helman key agreement.


206

Impor ts and Definitions

Chapter 6

RFC1155-SMI Common definitions for the structure and identification of management information for TCP/IP-based internets. RFC1157-SNMP Defines the SNMP protocol. SNMPv2-PDU Describes SNMP Protocol Data Units. SNMPv2-TM Defines textual conventions and objects for transporting SNMP over various network protocols. SNMPv2-MIB (RFC-1907) Defines SNMPv2 entities. SNMP-FRAMEWORK-MIB (RFC-2571) Defines the SNMP management architecture. SNMP-MPD-MIB (RFC-2572) SNMP Message Processing and Dispatching. SNMPv2-SMI (RFC-2578) (RFC 1907). SNMPv2-TC (RFC-2579) Common textual conventions, used throughout the MIBs. SNMPv2-CONF (RFC-2580) Definitions for conformance groups. INET-ADDRESS-MIB (RFC-2851) Defines textual conventions for representing Internet addresses. An Internet address can be an IPv4 address, an IPv6 address or a DNS domain name. DIFFSERV-DSCP-TC (RFC-3289) Defines textual conventions used in the PKTC-IETF-SIG-MIB. INTEGRATED-SERVICES-MIB (RFC-2713) Defines textual conventions used in the PKTC-IETF-SIG-MIB.


MIB Reference

207

Duplicate and Obsolete MIBs

Duplicate MIBs

The following PacketPort MIBs are deprecated in favor of equivalent PacketCable MIBs. ARRIS continues to make them available as read-only variables for customers using them in their network management and monitoring. Old PacketPort MIB ppCfgPortAdminState ppCfgPortCallAgentName ppCfgPortCallAgentUdpPort ppCfgPortMtaAdminState

MIB Objects Removed in TS4.1

Description and Replacement MIB

Administrative status of the line. Use ifAdminStatus The call agent name. Use pktcNcsEndPntConfigCallAg entId The call agent UDP port. Use pktcNcsEndPntConfigCallAgentUdpPort MTA administrative status. Use ifAdminStatus or pktcMtaDevEnableID

The following MIB objects are no longer used or available as of TS4.1. MIB

Reason for deletion

ppCfgPortCallAgentIpAddress

No longer used. Redundant information.

ppCfgPortProvSignalingProt

NCS is only supported signaling protocol.

ppCfgPortTpar

Duplicate of PacketCable NCS timer

ppCfgPortTcrit


ppCfgPortBusyToneTimeOut


ppCfgPortDialToneTimeOut


ppCfgPortMsgWaitTimeOut


ppCfgPortOffHookWarnTimeOut


ppCfgPortRingingTimeOut


ppCfgPortRingBackTimeOut


ppCfgPortReorderTimeOut


ppCfgPortStutterDialToneTimeOut


ppCfgPortMaxWaitDelay

Duplicate of PacketCable NCS timer Does nothing, packetization rate is controlled by CODEC negotiation. Does nothing, CODEC is controlled by CODEC negotiation. Duplicate of PacketCable MIB object for FQDN Duplicate of PacketCable MIB object for SNMP Entity Duplicate of PacketCable MIB object for SNMP Entity

ppCfgPortPacketizationPeriod ppCfgPortCodec ppCfgMtaFullyQualName ppCfgMtaTeleServProvServIpAddr ppCfgMtaTeleServProvServName


208

Chapter 6

MIB

Reason for deletion

ppCfgMtaTeleServProvDhcpIpAddr

Duplicate of PacketCable MIB object for DHCP 1 Duplicate of PacketCable MIB object for DHCP 1 Duplicate of PacketCable MIB object for DNS 1 Duplicate of PacketCable MIB object for DNS 2 Duplicate of PacketCable MIB object for configuration file location Duplicates arrisCmDevProvMethodIndicator Duplicate of PacketCable MIB object for configuration file location Duplicate of PacketCable MIB object for configuration file location Duplicate of PacketCable MIB object for NCS ToS setting No longer supported. Too many call servers with different versions of firmware for this to work Duplicate of PacketCable MIB object for configuration file location Duplicate of PacketCable MIB object for configuration file location Not supported, should be audited through NCS Duplicate of PacketCable MIB and values don’t match CableLabs definitions

ppCfgMtaTeleServProvDhcpName ppCfgMtaPrimTeleNetDnsAddr ppCfgMtaSecTeleNetDnsAddr ppCfgMtaConfigFileAccName ppCfgMtaProvMethodIndicator ppCfgMtaTeleConfigServerIpAddr ppCfgMtaTeleConfigServerName ppCfgMtaNcsCallSigTos ppCfgMtaCallServerType

ppCfgMtaClientSeed ppCfgMtaHttpAdvLink ppSurvPortDigitMap ppSurvMtaCodecCapTable ppSurvMtaSigCapTable ppSurvMtaPeccode ppSurvMtaInitialProvAck ppSurvMtaProvStatusAck ppSurvMtaProvState ppSurvMtaDevCorrelationId ppCfgMtaInternetIsolationState ppSurvMtaActiveSwBank ppSurvMtaSoftwareLoadBankA ppSurvMtaSoftwareLoadBankB ppCfgPortDialingMethod


Only supporting NCS. No longer using this hardware code style. Old proprietary provisioning method before the PacketCable inform was used. Old proprietary provisioning method before the PacketCable inform was used. Duplicate of PacketCable MIB (PacketCable MIB is more granular). Old proprietary provisioning method before the PacketCable inform was used. Duplicate of arrisCmDevWanIsolationState MIB. Dual bank MTA loads no longer supported. Dual bank MTA loads no longer supported. Dual bank MTA loads no longer supported. Replaced by arrisMtaDevEndPntDialingMethod

MIB Reference

Removed Battery MIBs

209

The following battery-related MIBs are obsolete as of TS5.0. Attempting to read them returns a value of 0; setting them has no effect. • arrisMtaDevPwrSupplyLowBatteryThresh • arrisMtaDevPwrSupplyTypicalIdlePwr • arrisMtaDevPwrSupplyReplaceBatThresh • arrisMtaDevPwrSupplyChargeState • arrisMtaDevPwrSupplyRatedBatCapacity • arrisMtaDevPwrSupplyTestedBatCapacity • arrisMtaDevPwrSupplyBatStateOfCharge • ppCfgMtaBatteryReplaceReporting

Deprecated MIB Objects

The following MIB objects were deprecated in TS5.0. Object

Reason for deletion

arrisCmDevProvMethodIndicator

Replaced by arrisMtaDevProvMethodIndicator

ppCfgMtaLanHttpAccess

Replaced by arrisCmDevHttpLanAccess

ppCfgMtaWanHttpAccess

Replaced by arrisCmDevHttpWanAccess

The following MIB objects are deprecated in TS6.1. They currently remain supported for backward-compatibility with IPv4 networks, but should be replaced with the IPv6-compatible objects as needed. Object

arrisCmDevSwServer

Replacement Objects

Replaced by arrisCmDevSwServerAddressType and arrisCmDevSwServerAddress

arrisCmDevDhcpCmIpAddr

Replaced by arrisCmDevDhcpIpMode and arrisCmDevDhcpCmIpAddrV6

arrisCmDevDhcpCmSubNetMask

Replaced by arrisCmDevDhcpCmSubNetMaskV6

arrisCmDevDhcpCmGatewayIpAddr

Replaced by arrisCmDevDhcpCmGatewayIpAddrV6

arrisCmDevDhcpPrimaryDhcpServerIpAddr

Replaced by arrisCmDevDhcpPrimaryDhcpServerIpAddrV6

arrisCmDevDhcpTftpSvrIpAddr

Replaced by arrisCmDevDhcpTftpSvrIpAddrV6

arrisCmDevDhcpTimeSvrIpAddr

Replaced by arrisCmDevDhcpTimeSvrIpAddrV6


210

Chapter 6

Order of Compilation Some SNMP managers, notably SNMPc, are sensitive to the order in which MIB files are to be compiled. The following list is the recommended order for compilation. • standard.mib • snmp_tc.mib • snmpv2.mib • snmpv3.mib • SNMP-COMMUNITY-MIB.mib • rfc1213.mib • rfc1215.mib • rfc1493.mib • rfc1643.mib • rfc1907.mib • rfc2011.mib • rfc2013.mib • ianaif.mib • rfc2233.mib • rfc2786.mib • rfc2933.mib • rfc2670_50.mib • qos_50.mib • bpi.mib • bpiplus.mib • dhkeychg.mib • rfc2665_50.mib • rfc2669_50.mib • DOCS-IF-EXT-MIB.mib • DOCS-CABLE-DEVICE-TRAP-MIB_50.mib


MIB Reference

211

• lcheader.mib • lancity_50.mib • clabs.mib • mtai02rv_50.mi2 • sigi02rs_50.mi2 • pkevt_50.mib • arrishdr.mib • arris_capability.mib • pp.mib • usb_50.mib Note:

Files whose names contain the string ‘‘_50’’ are modified for use with SNMPc V5.0. If you are using a different NMS, substitute the files without the string (for example, use rfc2670.mib instead of rfc2670_50.mib).


212


Chapter 6

7

Appendix A: Example Files The following is a list of example data and telephony provisioning file templates included with TS6.1. See the PacketACE Configuration Tools User’s Guide for more information about using the templates.

Listing of Templates ARRIS may update these templates when updating PacketACE or Touchstone firmware, so you should keep your own templates in a separate directory. The following templates are provided (additional templates may be added in later releases).

Location of Template Files

The PacketACE installer places template files in the directory C:\Program Files\ARRIS\PacketACE\ACE_Templates

MTA Configuration Files

The following is a list of example MTA configuration files included with PacketACE. ARRIS_proprietary_mibs.mta Provides default values for all ARRIS proprietary MIBs. PCABLE_mandatory_params.mta Mandatory PacketCable parameters. PCABLE_mandator y_params_2line.mta Mandatory PacketCable parameters for a Touchstone Telephony Modem.


214

Chapter 7

PCABLE_mandator y_params_4line.mta Mandatory PacketCable parameters for a Touchstone Telephony Port. MTA_PacketCable .mta Basic PacketCable configuration for a Touchstone Telephony Modem using TS4.2. MTA_DOCSIS10_PLUS.mta Basic DOCSIS 1.0+ configuration for a Touchstone Telephony Modem using TS4.2.

Cable Modem Configuration Files

The following is a list of example MTA configuration files included with PacketACE. DOCSIS10_mandatory_params.cm Mandatory parameters for a DOCSIS 1.0 compatible cable modem. DOCSIS11_mandatory_params.cm Mandatory parameters for a DOCSIS 1.1 compatible cable modem. DOCSIS20_mandatory_params.cm Mandatory parameters for a DOCSIS 2.0 compatible cable modem. DOCSIS11_NACVC.cm Cable modem configuration with embedded ARRIS North American Manufacturer’s CVC. DOCSIS11_EUROCVC.cm Cable modem configuration with embedded ARRIS European Manufacturer’s CVC. DOCSIS11_NACVC_SwUpgrade .cm Cable modem configuration with ARRIS CVC that initiates a secure firmware upgrade through the configuration file (North American load). DOCSIS11_EUROCVC_SwUpgrade .cm Cable modem configuration with ARRIS CVC that initiates a secure firmware upgrade through the configuration file (European load). DOCSIS11_BASIC.cm Basic configuration for a Touchstone eMTA, configured as a DOCSIS 1.0 cable modem, using TS4.0. DOCSIS11_BASIC.cm Basic configuration for a Touchstone eMTA, configured as a DOCSIS 1.1 cable modem, using TS4.0. DOCSIS11_http_basic.cm Basic configuration for a Touchstone eMTA, configured as a DOCSIS 1.1 cable modem, with the basic cable modem web-based troubleshooting interface enabled.



215

DOCSIS11_http_off.cm Basic configuration for a Touchstone eMTA, configured as a DOCSIS 1.1 cable modem, with the basic cable modem web-based troubleshooting interface disabled. DOCSIS11_to_DOCSIS20.com Cable modem configuration file that toggles the eMTA from DOCSIS 1.1 to DOCSIS 2.0 mode, using TS4.0. DOCSIS20_to_DOCSIS11.com Cable modem configuration file that toggles the eMTA from DOCSIS 2.0 to DOCSIS 1.1 mode., using TS4.0. DOCSIS11_CPS.cm Touchstone eMTA CM configuration using the CPS provisioning mode. DOCSIS11_DocsisOnly.cm Touchstone eMTA CM configuration using the DOCSIS provisioning mode. DOCSIS11_PacketCable.cm Touchstone eMTA CM configuration using the Full PacketCable provisioning mode. DOCSIS11_GUPI.cm Touchstone eMTA CM configuration using the GUPI provisioning mode. DOCSIS11_PCMINUSKDC.cm Touchstone eMTA CM configuration using the PacketCable (no KDC) provisioning mode. SingleConfig.sng Touchstone Telephony Modem CM/MTA configuration using the single MAC/single configuration file provisioning mode.

Text Files

In addition to binary CM and MTA configuration files, ARRIS provides a plain-text equivalent of each file (using a .txt extension). Using PacketACE, you can cut and paste all or part of appropriate text files into your own configuration files to modify them as needed.

SNMP Co-existence Example Configuration File The following listing shows the MIBs and TLVs necessary to implement SNMP co-existence. The configuration is based on a minimal DOCSIS 1.1 cable modem configuration file. NetworkAccess = 1 UpstreamServiceFlow =


216

Chapter 7

SfReference = 1 SfQosSetType = 7 SfSchedulingType = 2 DownstreamServiceFlow = SfReference = 2 SfQosSetType = 7 PrivacyEnable = 0 SnmpMib = snmpCommunityName.comm1 "my_password" SnmpMib = snmpCommunitySecurityName.comm1 "rwAccess" SnmpMib = snmpCommunityStorageType.comm1 volatile SnmpMib = snmpCommunityStatus.comm1 createAndGo SnmpMib = vacmGroupName.1 rwAccess "rwAccess" SnmpMib = vacmSecurityToGroupStorageType.1 rwAccess volatile SnmpMib = vacmSecurityToGroupStatus.1 rwAccess createAndGo SnmpMib = vacmGroupName.2 rwAccess "rwAccess" SnmpMib = vacmSecurityToGroupStorageType.2 rwAccess volatile SnmpMib = vacmSecurityToGroupStatus.2 rwAccess createAndGo SnmpMib = vacmAccessContextMatch.rwAccess

1 1 exact

SnmpMib = vacmAccessReadViewName.rwAccess

1 1 "docsisManagerView"

SnmpMib = vacmAccessWriteViewName.rwAccess SnmpMib = vacmAccessNotifyViewName.rwAccess SnmpMib = vacmAccessStorageType.rwAccess SnmpMib = vacmAccessStatus.rwAccess

1 1 "docsisManagerView" 1 1 "docsisManagerView"

1 1 volatile

1 1 createAndGo

SnmpMib = vacmAccessContextMatch.rwAccess

2 1 exact

SnmpMib = vacmAccessReadViewName.rwAccess

2 1 "docsisManagerView"

SnmpMib = vacmAccessWriteViewName.rwAccess SnmpMib = vacmAccessNotifyViewName.rwAccess SnmpMib = vacmAccessStorageType.rwAccess SnmpMib = vacmAccessStatus.rwAccess

2 1 "docsisManagerView" 2 1 "docsisManagerView"

2 1 volatile

2 1 createAndGo

SNMPv3NotificationReceiver = SNMPv3NrIpAddress = 10.1.50.100 SNMPv3NrTrapType = 1 SNMPv3NotificationReceiver = SNMPv3NrIpAddress = 10.1.50.80 SNMPv3NrTrapType = 2

Firmware Upgrade Example The following configuration file provides an example of how to configure the Touchstone Firmware Upgrade system. NetworkAccess = 1 UpgradeServer = 10.1.50.31 UpgradeFileName = "Non-ARRIS-product.img" SnmpMib = docsDevSwAdminStatus.0 2 MaxCpeAllowed = 16 BaselinePrivacy =



217

AuthorizeWaitTimeout = 10 ReauthorizeWaitTimeout = 10 KekGraceTime = 600 OpWaitTimeout = 10 RekeyWaitTimeout = 10 TekGraceTime = 600 AuthorizeRejectWaitTimeout = 60 SAMapWaitTimeout = 1 SAMapMaxRetries = 4 UpstreamServiceFlow = SfReference = 1 SfClassName = "USPrimaryBE" SfQosSetType = 7 SfTrafficPriority = 1 SfMaxTrafficRate = 0 SfMaxTrafficBurst = 3044 SfMinReservedRate = 0 SfMinReservedRatePktsize = 64 SfActiveQosTimeout = 0 SfAdmittedQosTimeout = 200 SfMaxConcatBurst = 3044 SfSchedulingType = 2 SfRqTxPolicy = 128 SfIpTosOverwrite = 64512 UpstreamServiceFlow = SfReference = 2 SfClassName = "USMTAMGCP" SfQosSetType = 7 SfTrafficPriority = 7 SfMaxTrafficRate = 0 SfMaxTrafficBurst = 1522 SfMinReservedRate = 0 SfMinReservedRatePktsize = 64 SfActiveQosTimeout = 0 SfAdmittedQosTimeout = 200 SfMaxConcatBurst = 3000 SfSchedulingType = 2 SfRqTxPolicy = 136 SfIpTosOverwrite = 64512 DownstreamServiceFlow = SfReference = 101 SfClassName = "DSPrimaryBE" SfQosSetType = 7 SfTrafficPriority = 1 SfMaxTrafficRate = 100000000 SfMaxTrafficBurst = 1522 SfMinReservedRate = 0 SfMinReservedRatePktsize = 64 SfActiveQosTimeout = 0 SfAdmittedQosTimeout = 200


218

Chapter 7

SfMaxDownstreamLatency = 0 DownstreamServiceFlow = SfReference = 102 SfClassName = "DSMTAMGCP" SfQosSetType = 7 SfTrafficPriority = 7 SfMaxTrafficRate = 10000000 SfMaxTrafficBurst = 1522 SfMinReservedRate = 12000 SfMinReservedRatePktsize = 64 SfActiveQosTimeout = 0 SfAdmittedQosTimeout = 200 SfMaxDownstreamLatency = 5000 UpstreamPacketClassification = PcServiceFlowReference = 2 PcReference = 2 PcRulePriority = 1 PcActivationState = 1 PcIpClassification = PcIpProtocol = 17 PcIpSourceAddress = 0.0.0.0 PcIpSourceMask = 0.0.0.0 PcIpDestAddress = 0.0.0.0 PcIpDestMask = 0.0.0.0 PcIpSourcePortStart = 2427 PcIpSourcePortEnd = 2427 DownstreamPacketClassification = PcServiceFlowReference = 102 PcReference = 102 PcRulePriority = 1 PcActivationState = 1 PcIpClassification = PcIpProtocol = 17 PcIpSourceAddress = 0.0.0.0 PcIpSourceMask = 0.0.0.0 PcIpDestAddress = 0.0.0.0 PcIpDestMask = 0.0.0.0 PcIpDestPortStart = 2427 PcIpDestPortEnd = 2427 PrivacyEnable = 0 SnmpMib = arrisCmDevSwAdminStatus.0 2 SnmpMib = arrisCmDevSwCustomerLoadId.1 "ARRIS Philly Lab NA TTM402 Rev. 2" SnmpMib = arrisCmDevSwHwModel.1 "TM402P" SnmpMib = arrisCmDevSwHwRev.1 2 SnmpMib = arrisCmDevSwServer.1 10.1.50.21 SnmpMib = arrisCmDevSwFilename.1 "TS0401_09222003.bin" SnmpMib = arrisCmDevSwCustomerLoadId.2 "ARRIS Philly Node 3 NA TTM402 Rev. 3" SnmpMib = arrisCmDevSwHwModel.2 "TM402P" SnmpMib = arrisCmDevSwHwRev.2 3 SnmpMib = arrisCmDevSwServer.2 10.1.50.21



219

SnmpMib = arrisCmDevSwFilename.2 "TS0401_09302003.bin" SnmpMib = arrisCmDevSwCustomerLoadId.3 "Euro TTM402 Rev. 3" SnmpMib = arrisCmDevSwHwModel.3 "TM402Q" SnmpMib = arrisCmDevSwHwRev.3 3 SnmpMib = arrisCmDevSwServer.3 10.1.51.21 SnmpMib = arrisCmDevSwFilename.3 "TS0401_09302003.bin" SnmpMib = arrisCmDevSwCustomerLoadId.4 "Euro TTM402 Non-Rev. 3" SnmpMib = arrisCmDevSwHwModel.4 "TM402Q" SnmpMib = arrisCmDevSwServer.4 10.1.51.21 SnmpMib = arrisCmDevSwFilename.4 "TS0401_09222003.bin" SnmpMib = arrisCmDevSwCustomerLoadId.5 "ARRIS Detroit Node 1 TTM202 Non-Rev. 2" SnmpMib = arrisCmDevSwHwModel.5 "TTM202P" SnmpMib = arrisCmDevSwServer.5 10.1.52.21 SnmpMib = arrisCmDevSwFilename.5 "TS030203_090503A.bin" SnmpMib = arrisCmDevSwCustomerLoadId.6 "ARRIS Detroit Node 2 TTM202 Rev. 2" SnmpMib = arrisCmDevSwHwModel.6 "TTM202P" SnmpMib = arrisCmDevSwHwRev.6 2 SnmpMib = arrisCmDevSwServer.6 10.1.52.21 SnmpMib = arrisCmDevSwFilename.6 "TS030203_090503A.bin"

Gateway Dial Pulse Example The following configuration file provides an example of how to configure Gateway dial pulse support. TelephonyConfigFileBeginEnd = 1 SnmpMib = pktcMtaDevEnabled.0 true SnmpMib = arrisMtaDevEndPntDialingMethod.1 toneAndPulseWithDTMFRelay SnmpMib = arrisMtaDevEndPntDialingMethod.2 toneAndPulseWithDTMFRelay SnmpMib = pktcSigDefCallSigTos.0 0 SnmpMib = pktcSigDefMediaStreamTos.0 0 SnmpMib = pktcSigTosFormatSelector.0 ipv4TOSOctet SnmpMib = pktcMtaDevRealmOrgName.DEV50 "Really Amazing Telephone Company" SnmpMib = pktcNcsEndPntConfigCallAgentId.9 "[email protected]" SnmpMib = pktcNcsEndPntConfigCallAgentId.10 "[email protected]" SnmpMib = pktcNcsEndPntConfigCallAgentUdpPort.9 2727 SnmpMib = pktcNcsEndPntConfigCallAgentUdpPort.10 2727 SnmpMib = pktcMtaDevCmsKerbRealmName.SN05.DEV2 "SWLAB.ATL.ARRIS" SnmpMib = pktcMtaDevCmsIpsecCtrl.SN05.DEV2 true SnmpMib = pktcNcsEndPntConfigMWD.9 10 SnmpMib = pktcNcsEndPntConfigMWD.10 10 SnmpMib = pktcMtaDevCmsUnsolicitedKeyNomTimeout.SN05.DEV2 20000 SnmpMib = pktcMtaDevRealmOrgName.SWLAB.ATL.ARRIS "Really Amazing Telephone Company" TelephonyConfigFileBeginEnd = 255


220

Chapter 7

SIP CM Configuration File Example The following is an example of a CM configuration file for SIP support. {NetworkAccess Yes} {MaxCpeAllowed 4} {MaxClassifiers 20} {PrivacyEnable 1} {SnmpMib ppCfgMtaCallpFeatureSwitch.0 16384} {SnmpMib arrisMtaProvMethodIndicator.0 4} {UpstreamServiceFlow {SfReference 1} {SfQosSetType 7} {SfTrafficPriority 1} {SfMaxTrafficRate 0} {SfMaxTrafficBurst 8192} {SfMinReservedRate 0} {SfMinReservedRatePktsize 64} {SfActiveQosTimeout 0} {SfAdmittedQosTimeout 0} {SfMaxConcatBurst 0} {SfSchedulingType 2} {SfRqTxPolicy 0} {SfIpTosOverwrite 64512} } {UpstreamServiceFlow {SfReference 2} {SfQosSetType 7} {SfTrafficPriority 7} {SfMaxTrafficRate 0} {SfMaxTrafficBurst 8192} {SfMinReservedRate 0} {SfMinReservedRatePktsize 64} {SfActiveQosTimeout 0} {SfAdmittedQosTimeout 0} {SfMaxConcatBurst 0} {SfSchedulingType 2} {SfRqTxPolicy 0} {SfIpTosOverwrite 64512} } {DownstreamServiceFlow {SfReference 101} {SfQosSetType 7} {SfTrafficPriority 1} {SfMaxTrafficRate 100000000} {SfMaxTrafficBurst 96000} {SfMinReservedRate 0} {SfMinReservedRatePktsize 64} {SfActiveQosTimeout 0}



221

{SfAdmittedQosTimeout 0} {SfMaxDownstreamLatency 20000} } {DownstreamServiceFlow {SfReference 102} {SfQosSetType 7} {SfTrafficPriority 7} {SfMaxTrafficRate 100000000} {SfMaxTrafficBurst 96000} {SfMinReservedRate 12000} {SfMinReservedRatePktsize 64} {SfActiveQosTimeout 0} {SfAdmittedQosTimeout 0} {SfMaxDownstreamLatency 5000} } {UpstreamPacketClassification {PcServiceFlowReference 2} {PcReference 2} {PcRulePriority 64} {PcActivationState 1} {PcIpClassification {PcIpProtocol 17} {PcIpSourcePortStart 5060} {PcIpSourcePortEnd 5060} } {PcIeee8021Classification {PcIeee8021VlanId 0} } } {DownstreamPacketClassification {PcServiceFlowReference 102} {PcReference 102} {PcRulePriority 1} {PcActivationState 1} {PcIpClassification {PcIpProtocol 17} {PcIpDestPortStart 5060} {PcIpDestPortEnd 5060} } }

SIP MTA Configuration File Example The following is an example of an MTA configuration file for SIP support. TelephonyConfigFileBeginEnd = 1 SnmpMib = pktcMtaDevEnabled.0 true


222

Chapter 7

SnmpMib = sipCfgPortUserName.1 "7705553001" SnmpMib = sipCfgPortDisplayName.1 ""Caller-ID Line 1"" SnmpMib = sipCfgPortLogin.1 "arris1" SnmpMib = sipCfgPortPassword.1 "password1" SnmpMib = ifAdminStatus.9 up SnmpMib = sipCfgPortUserName.2 "7705553002" SnmpMib = sipCfgPortDisplayName.2 ""Caller-ID Line 2"" SnmpMib = sipCfgPortLogin.2 "arris1" SnmpMib = sipCfgPortPassword.2 "password1" SnmpMib = ifAdminStatus.10 up SnmpMib = sipCfgProxyAdr.0 "10.1.63.11;5060" SnmpMib = sipCfgProxyType.0 ipv4 SnmpMib = sipCfgRegistrarAdr.0 "10.1.63.11;5060" SnmpMib = sipCfgRegistrarType.0 ipv4 SnmpMib = sipCfgSipFeatureSwitch.0 hexstr: 0.0.0.0 SnmpMib = sipCfgProvisionedCodecArray.0 "PCMA;PCMU" SnmpMib = sipCfgPacketizationRate.0 twentyMilliSeconds VendorSpecific

=

ARRISVendorID

SIPDigitMap

=

"8888|0[t#]|00|101xxxx0[t#]|

01[2-9]XXXXXXX.[t#]|101xxxx01[2-9]XXXXXXX.[T#]|011xxxxxxx.[t#]| 101xxxx011xxxxxxx.[t#]|[2-9]11|[01][2-9]11|101xxxx[2-9]11|101xxxx[01][2-9]11|*xx| 11xx|[2-9]xxxxxx[t#]|[01][2-9]xxxxxx[t#]|101xxxx[2-9]xxxxxx[t#]| 101xxxx[01][2-9]xxxxxx[t#]|[2-9]xx[2-9]xxxxxx|[01][2-9]xx[2-9]xxxxxx| 101xxxx[2-9]xx[2-9]xxxxxx|101xxxx[01][2-9]xx[2-9]xxxxxxx|[2-9]x#| #[2-9]xxx[2-9]xxxxxx|101xxxx[01][2-9]xx[2-9]xxxxxxx|[2-9]x#|#[2-9]x" VendorSpecific = ARRISVendorID SIPDialProxyMap = "*50,1,1|*51,2,3|" SnmpMib = arrisMtaCfgRTPDynPortStart.0 49152 SnmpMib = arrisMtaCfgRTPDynPortEnd.0 65535 SnmpMib = sipCfgDialFeatName.1 anonCallReject SnmpMib = sipCfgDialFeatCode.1 "*77,1177" SnmpMib = sipCfgDialFeatTone.1 stutterTone SnmpMib = sipCfgDialFeatActive.1 hexstr: 0.0.0.1 SnmpMib = sipCfgDialFeatName.2 anonCallRejectDisable SnmpMib = sipCfgDialFeatCode.2 "*87,1187" SnmpMib = sipCfgDialFeatTone.2 dialTone SnmpMib = sipCfgDialFeatActive.2 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.3 callForwardBusy SnmpMib = sipCfgDialFeatCode.3 "*90,1190" SnmpMib = sipCfgDialFeatTone.3 stutterTone SnmpMib = sipCfgDialFeatActive.3 hexstr: 0.0.0.0 SnmpMib = sipCfgDialFeatName.4 callForwardBusyDisable SnmpMib = sipCfgDialFeatCode.4 "*91,1191" SnmpMib = sipCfgDialFeatTone.4 stutterTone SnmpMib = sipCfgDialFeatActive.4 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.5 callForwardUncond SnmpMib = sipCfgDialFeatCode.5 "*72,1172" SnmpMib = sipCfgDialFeatTone.5 stutterTone SnmpMib = sipCfgDialFeatActive.5 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.6 callForwardUncondDisable SnmpMib = sipCfgDialFeatCode.6 "*79,1179" SnmpMib = sipCfgDialFeatTone.6 stutterTone



223

SnmpMib = sipCfgDialFeatActive.6 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.7 callForwardNoAnswer SnmpMib = sipCfgDialFeatCode.7 "*92,1192" SnmpMib = sipCfgDialFeatTone.7 stutterTone SnmpMib = sipCfgDialFeatActive.7 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.8 callForwardNoAnswerDisable SnmpMib = sipCfgDialFeatCode.8 "*93,1193" SnmpMib = sipCfgDialFeatTone.8 stutterTone SnmpMib = sipCfgDialFeatActive.8 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.9 callReturn SnmpMib = sipCfgDialFeatCode.9 "*69,1169" SnmpMib = sipCfgDialFeatTone.9 stutterTone SnmpMib = sipCfgDialFeatActive.9 hexstr: 0.0.0.0 SnmpMib = sipCfgDialFeatName.10 callWaitTempDisable SnmpMib = sipCfgDialFeatCode.10 "*70,1170" SnmpMib = sipCfgDialFeatTone.10 stutterTone SnmpMib = sipCfgDialFeatActive.10 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.11 callWaitPermDisableToggle SnmpMib = sipCfgDialFeatCode.11 "*78,1178" SnmpMib = sipCfgDialFeatTone.11 stutterTone SnmpMib = sipCfgDialFeatActive.11 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.12 callerIDPermBlockToggle SnmpMib = sipCfgDialFeatCode.12 "*65,1165" SnmpMib = sipCfgDialFeatTone.12 stutterTone SnmpMib = sipCfgDialFeatActive.12 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.13 callerIDTempEnable SnmpMib = sipCfgDialFeatCode.13 "*82,1182" SnmpMib = sipCfgDialFeatTone.13 stutterTone SnmpMib = sipCfgDialFeatActive.13 hexstr: 0.0.0.3 SnmpMib = sipCfgDialFeatName.14 callerIDTempBlock SnmpMib = sipCfgDialFeatCode.14 "*67,1167" SnmpMib = sipCfgDialFeatTone.14 stutterTone SnmpMib = sipCfgDialFeatActive.14 hexstr: 0.0.0.3 TelephonyConfigFileBeginEnd = 255

To configure a Warm Line, add the following lines to the configuration file: SnmpMib SnmpMib SnmpMib SnmpMib

sipCfgPortWarmOrHotlineNumber.1 7706669051 sipCfgPortWarmOrHotlineNumber.2 7706669050 sipCfgPortWarmLineTimeout.1 5 sipCfgPortWarmLineTimeout.2 5

To configure a Hot Line, add the following lines to the configuration file: SnmpMib SnmpMib SnmpMib SnmpMib

sipCfgPortWarmOrHotlineNumber.1 7706669051 sipCfgPortWarmOrHotlineNumber.2 7706669050 sipCfgPortWarmLineTimeout.1 0 sipCfgPortWarmLineTimeout.2 0


224

Chapter 7

Example WRM Configuration The following is an example WTM552 or WTM652 configuration file. sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc

set lan ip 192.168.0.1 set lan mask 255.255.255.0 set lan dhcp disable set lan net 2 100 set wlan ap1 region 1 set wlan ap1 ssid neutral set wlan ap1 ssid broad enable set wlan ap enable set wlan ap2 mode 0 set wlan ap2 channel 6 set wlan ap1 ecu wep set wlan ap1 secu wep auto set wlan ap1 secu wep k_type 128 set wlan ap1 secu wep k_index 1 set wlan ap1 secu wep k_man ca61adc302 set wlan ap2 secu wpa phrase abcdefghigk set wlan ap2 secu wpa encry TKIP set wlan access wan all set wlan access lan sel 192.168.0.2 set wlan access lan sel 192.168.0.3 set pwd 123456 set ctrl gp 1 set ctrl sch default set ctrl block service icq set ctrl del all set ctrl add test 1 5000 5000 set ddns 0 set ddns luis 123456 luis_test set sap disable dialpad set sap add test udp in 51200 51201 udp out 51200 51201 set dmz disable set dmz 192.168.0.2 set url enable set url add sohu set sch 0 08:00 12:00 13:00 18:00 set gp 1 add 192.168.0.2 set vs enable web delete rt vs all set vs default set vs update web 192.168.0.2 tcp 80 80 set wan id host sc806sm set wan id domain sercomm set wan id mac 00c002806302 set wan type 1 set wan type user pa pwd 123456



225

sdc sdc sdc sdc sdc sdc sdc sdc set sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc sdc # sdc sdc

set set set set set set set set log set set set set set set set set set set set set set set set set set set set set set set set

wan type l2tp srv_ip 172.21.5.110 wan type ras_plan 256 wan ip dynamic wan dns dynamic wan dns addr 61.177.7.1 wan dns addr1 61.177.7.1 wan dns addr2 61.177.7.1 log enable 2 mail full log mail title test log mail port 25 log mail enable 1 log mail [email protected] smtp_ip 172.21.1.250 25 log mail alert enable log sch 1 time 12 upnp disable upnp enable 0 secu fw enable secu fw level 0 secu enable 0 tz 3 rm disable rm port 80 rtbl enable rtbl add 172.21.5.11 255.255.255.0 172.21.5.110 2 rtbl del 172.21.5.11 255.255.255.0 acl enable all acl disable 2 acl add 1 2 5 5000 6000 1 0 acl add 1 2 5 3000 4000 1 1 1 3 2 4 telnet timeout 500 telnet port 23

save reboot

Enhanced Cordless Telephone Configuration The following configuration file provides an example of how to configure a WTM552 or WTM652 for Enhanced Cordless Telephone support. NetworkAccess = 1 UpgradeFileName = "MSO_SELF_INSTALL_TEST.img" SnmpMib = docsDevNmAccessIp.1 68.87.64.0 SnmpMib = docsDevNmAccessIpMask.1 255.255.192.0 SnmpMib = docsDevNmAccessCommunity.1 "hDaFHJG7" SnmpMib = docsDevNmAccessControl.1 readWrite


226

Chapter 7

SnmpMib = docsDevNmAccessInterfaces.1 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.1 createAndGo SnmpMib = docsDevNmAccessIp.2 172.16.0.0 SnmpMib = docsDevNmAccessIpMask.2 255.240.0.0 SnmpMib = docsDevNmAccessCommunity.2 "hDaFHJG7" SnmpMib = docsDevNmAccessControl.2 readWrite SnmpMib = docsDevNmAccessInterfaces.2 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.2 createAndGo SnmpMib = docsDevNmAccessIp.3 172.16.0.0 SnmpMib = docsDevNmAccessIpMask.3 255.240.0.0 SnmpMib = docsDevNmAccessCommunity.3 "T3FWNkl5" SnmpMib = docsDevNmAccessControl.3 read SnmpMib = docsDevNmAccessInterfaces.3 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.3 createAndGo SnmpMib = docsDevNmAccessIp.4 12.242.25.0 SnmpMib = docsDevNmAccessIpMask.4 255.255.255.0 SnmpMib = docsDevNmAccessCommunity.4 "07ylcx5r" SnmpMib = docsDevNmAccessControl.4 readWrite SnmpMib = docsDevNmAccessInterfaces.4 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.4 createAndGo SnmpMib = docsDevNmAccessIp.5 12.242.16.0 SnmpMib = docsDevNmAccessIpMask.5 255.255.248.0 SnmpMib = docsDevNmAccessCommunity.5 "1e6ukpf4" SnmpMib = docsDevNmAccessControl.5 readWrite SnmpMib = docsDevNmAccessInterfaces.5 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.5 createAndGo SnmpMib = docsDevNmAccessIp.6 24.128.113.128 SnmpMib = docsDevNmAccessIpMask.6 255.255.255.240 SnmpMib = docsDevNmAccessCommunity.6 "1Mcl0c41$" SnmpMib = docsDevNmAccessControl.6 read SnmpMib = docsDevNmAccessInterfaces.6 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.6 createAndGo SnmpMib = docsDevNmAccessIp.7 24.34.240.0 SnmpMib = docsDevNmAccessIpMask.7 255.255.240.0 SnmpMib = docsDevNmAccessCommunity.7 "1e6ukpf4" SnmpMib = docsDevNmAccessControl.7 readWrite SnmpMib = docsDevNmAccessInterfaces.7 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.7 createAndGo SnmpMib = docsDevNmAccessIp.8 24.34.224.0 SnmpMib = docsDevNmAccessIpMask.8 255.255.240.0 SnmpMib = docsDevNmAccessCommunity.8 "xygi7vnz" SnmpMib = docsDevNmAccessControl.8 read SnmpMib = docsDevNmAccessInterfaces.8 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.8 createAndGo SnmpMib = docsDevNmAccessIp.9 24.153.72.0 SnmpMib = docsDevNmAccessIpMask.9 255.255.248.0 SnmpMib = docsDevNmAccessCommunity.9 "T3FWNkl5" SnmpMib = docsDevNmAccessControl.9 read SnmpMib = docsDevNmAccessInterfaces.9 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.9 createAndGo



227

SnmpMib = docsDevNmAccessIp.10 24.153.72.0 SnmpMib = docsDevNmAccessIpMask.10 255.255.240.0 SnmpMib = docsDevNmAccessCommunity.10 "hDaFHJG7" SnmpMib = docsDevNmAccessControl.10 readWrite SnmpMib = docsDevNmAccessInterfaces.10 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.10 createAndGo SnmpMib = docsDevNmAccessIp.11 68.87.64.0 SnmpMib = docsDevNmAccessIpMask.11 255.255.192.0 SnmpMib = docsDevNmAccessCommunity.11 "T3FWNkl5" SnmpMib = docsDevNmAccessControl.11 read SnmpMib = docsDevNmAccessInterfaces.11 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.11 createAndGo SnmpMib = docsDevNmAccessIp.12 24.153.72.0 SnmpMib = docsDevNmAccessIpMask.12 255.255.248.0 SnmpMib = docsDevNmAccessCommunity.12 "v8low3sq" SnmpMib = docsDevNmAccessControl.12 readWrite SnmpMib = docsDevNmAccessInterfaces.12 hexstr: 40.00 SnmpMib = docsDevNmAccessStatus.12 createAndGo SnmpMib = docsDevFilterIpDefault.0 discard SnmpMib = docsDevFilterIpStatus.36 createAndGo SnmpMib = docsDevFilterIpControl.36 accept SnmpMib = docsDevFilterIpIfIndex.36 2 SnmpMib = docsDevFilterIpDirection.36 both SnmpMib = docsDevFilterIpBroadcast.36 false SnmpMib = docsDevFilterIpSaddr.36 0.0.0.0 SnmpMib = docsDevFilterIpSmask.36 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.36 0.0.0.0 SnmpMib = docsDevFilterIpDmask.36 0.0.0.0 SnmpMib = docsDevFilterIpProtocol.36 256 SnmpMib = docsDevFilterIpStatus.37 createAndGo SnmpMib = docsDevFilterIpControl.37 accept SnmpMib = docsDevFilterIpIfIndex.37 16 SnmpMib = docsDevFilterIpDirection.37 both SnmpMib = docsDevFilterIpBroadcast.37 false SnmpMib = docsDevFilterIpSaddr.37 0.0.0.0 SnmpMib = docsDevFilterIpSmask.37 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.37 0.0.0.0 SnmpMib = docsDevFilterIpDmask.37 0.0.0.0 SnmpMib = docsDevFilterIpProtocol.37 256 SnmpMib = docsDevFilterIpContinue.37 true SnmpMib = docsDevFilterIpStatus.38 createAndGo SnmpMib = docsDevFilterIpControl.38 discard SnmpMib = docsDevFilterIpIfIndex.38 1 SnmpMib = docsDevFilterIpDirection.38 outbound SnmpMib = docsDevFilterIpBroadcast.38 false SnmpMib = docsDevFilterIpSaddr.38 0.0.0.0 SnmpMib = docsDevFilterIpSmask.38 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.38 10.0.0.0 SnmpMib = docsDevFilterIpDmask.38 255.0.0.0 SnmpMib = docsDevFilterIpProtocol.38 256


228

Chapter 7

SnmpMib = docsDevFilterIpSourcePortLow.38 1 SnmpMib = docsDevFilterIpSourcePortHigh.38 65535 SnmpMib = docsDevFilterIpDestPortLow.38 1 SnmpMib = docsDevFilterIpDestPortHigh.38 65535 SnmpMib = docsDevFilterIpStatus.39 createAndGo SnmpMib = docsDevFilterIpControl.39 accept SnmpMib = docsDevFilterIpIfIndex.39 1 SnmpMib = docsDevFilterIpDirection.39 outbound SnmpMib = docsDevFilterIpBroadcast.39 false SnmpMib = docsDevFilterIpSaddr.39 0.0.0.0 SnmpMib = docsDevFilterIpSmask.39 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.39 0.0.0.0 SnmpMib = docsDevFilterIpDmask.39 0.0.0.0 SnmpMib = docsDevFilterIpProtocol.39 256 SnmpMib = docsDevFilterIpSourcePortLow.39 1 SnmpMib = docsDevFilterIpSourcePortHigh.39 65535 SnmpMib = docsDevFilterIpDestPortLow.39 1 SnmpMib = docsDevFilterIpDestPortHigh.39 65535 SnmpMib = docsDevFilterIpStatus.40 createAndGo SnmpMib = docsDevFilterIpControl.40 accept SnmpMib = docsDevFilterIpIfIndex.40 1 SnmpMib = docsDevFilterIpDirection.40 inbound SnmpMib = docsDevFilterIpBroadcast.40 false SnmpMib = docsDevFilterIpSaddr.40 0.0.0.0 SnmpMib = docsDevFilterIpSmask.40 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.40 68.80.0.0 SnmpMib = docsDevFilterIpDmask.40 255.240.0.0 SnmpMib = docsDevFilterIpProtocol.40 17 SnmpMib = docsDevFilterIpSourcePortLow.40 1 SnmpMib = docsDevFilterIpSourcePortHigh.40 65535 SnmpMib = docsDevFilterIpDestPortLow.40 67 SnmpMib = docsDevFilterIpDestPortHigh.40 67 SnmpMib = docsDevFilterIpStatus.41 createAndGo SnmpMib = docsDevFilterIpControl.41 accept SnmpMib = docsDevFilterIpIfIndex.41 1 SnmpMib = docsDevFilterIpDirection.41 inbound SnmpMib = docsDevFilterIpBroadcast.41 false SnmpMib = docsDevFilterIpSaddr.41 0.0.0.0 SnmpMib = docsDevFilterIpSmask.41 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.41 68.80.0.0 SnmpMib = docsDevFilterIpDmask.41 255.248.0.0 SnmpMib = docsDevFilterIpProtocol.41 6 SnmpMib = docsDevFilterIpSourcePortLow.41 1 SnmpMib = docsDevFilterIpSourcePortHigh.41 65535 SnmpMib = docsDevFilterIpDestPortLow.41 80 SnmpMib = docsDevFilterIpDestPortHigh.41 80 SnmpMib = docsDevFilterIpStatus.42 createAndGo SnmpMib = docsDevFilterIpControl.42 accept SnmpMib = docsDevFilterIpIfIndex.42 1 SnmpMib = docsDevFilterIpDirection.42 inbound



229

SnmpMib = docsDevFilterIpBroadcast.42 false SnmpMib = docsDevFilterIpSaddr.42 0.0.0.0 SnmpMib = docsDevFilterIpSmask.42 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.42 68.80.0.0 SnmpMib = docsDevFilterIpDmask.42 255.248.0.0 SnmpMib = docsDevFilterIpProtocol.42 6 SnmpMib = docsDevFilterIpSourcePortLow.42 1 SnmpMib = docsDevFilterIpSourcePortHigh.42 65535 SnmpMib = docsDevFilterIpDestPortLow.42 443 SnmpMib = docsDevFilterIpDestPortHigh.42 443 SnmpMib = docsDevFilterIpStatus.43 createAndGo SnmpMib = docsDevFilterIpControl.43 accept SnmpMib = docsDevFilterIpIfIndex.43 1 SnmpMib = docsDevFilterIpDirection.43 inbound SnmpMib = docsDevFilterIpBroadcast.43 false SnmpMib = docsDevFilterIpSaddr.43 0.0.0.0 SnmpMib = docsDevFilterIpSmask.43 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.43 68.87.64.0 SnmpMib = docsDevFilterIpDmask.43 255.255.255.0 SnmpMib = docsDevFilterIpProtocol.43 256 SnmpMib = docsDevFilterIpSourcePortLow.43 1 SnmpMib = docsDevFilterIpSourcePortHigh.43 65535 SnmpMib = docsDevFilterIpDestPortLow.43 1 SnmpMib = docsDevFilterIpDestPortHigh.43 65535 SnmpMib = docsDevFilterIpStatus.44 createAndGo SnmpMib = docsDevFilterIpControl.44 accept SnmpMib = docsDevFilterIpIfIndex.44 1 SnmpMib = docsDevFilterIpDirection.44 inbound SnmpMib = docsDevFilterIpBroadcast.44 false SnmpMib = docsDevFilterIpSaddr.44 0.0.0.0 SnmpMib = docsDevFilterIpSmask.44 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.44 68.32.0.0 SnmpMib = docsDevFilterIpDmask.44 255.224.0.0 SnmpMib = docsDevFilterIpProtocol.44 6 SnmpMib = docsDevFilterIpSourcePortLow.44 1 SnmpMib = docsDevFilterIpSourcePortHigh.44 65535 SnmpMib = docsDevFilterIpDestPortLow.44 80 SnmpMib = docsDevFilterIpDestPortHigh.44 80 SnmpMib = docsDevFilterIpStatus.45 createAndGo SnmpMib = docsDevFilterIpControl.45 accept SnmpMib = docsDevFilterIpIfIndex.45 2 SnmpMib = docsDevFilterIpDirection.45 outbound SnmpMib = docsDevFilterIpBroadcast.45 false SnmpMib = docsDevFilterIpSaddr.45 0.0.0.0 SnmpMib = docsDevFilterIpSmask.45 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.45 68.80.0.0 SnmpMib = docsDevFilterIpDmask.45 255.248.0.0 SnmpMib = docsDevFilterIpProtocol.45 6 SnmpMib = docsDevFilterIpSourcePortLow.45 1 SnmpMib = docsDevFilterIpSourcePortHigh.45 65535


230

Chapter 7

SnmpMib = docsDevFilterIpDestPortLow.45 80 SnmpMib = docsDevFilterIpDestPortHigh.45 80 SnmpMib = docsDevFilterIpStatus.46 createAndGo SnmpMib = docsDevFilterIpControl.46 accept SnmpMib = docsDevFilterIpIfIndex.46 2 SnmpMib = docsDevFilterIpDirection.46 outbound SnmpMib = docsDevFilterIpBroadcast.46 false SnmpMib = docsDevFilterIpSaddr.46 0.0.0.0 SnmpMib = docsDevFilterIpSmask.46 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.46 68.80.0.0 SnmpMib = docsDevFilterIpDmask.46 255.248.0.0 SnmpMib = docsDevFilterIpProtocol.46 6 SnmpMib = docsDevFilterIpSourcePortLow.46 1 SnmpMib = docsDevFilterIpSourcePortHigh.46 65535 SnmpMib = docsDevFilterIpDestPortLow.46 443 SnmpMib = docsDevFilterIpDestPortHigh.46 443 SnmpMib = docsDevFilterIpStatus.47 createAndGo SnmpMib = docsDevFilterIpControl.47 accept SnmpMib = docsDevFilterIpIfIndex.47 0 SnmpMib = docsDevFilterIpDirection.47 both SnmpMib = docsDevFilterIpBroadcast.47 true SnmpMib = docsDevFilterIpSaddr.47 0.0.0.0 SnmpMib = docsDevFilterIpSmask.47 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.47 0.0.0.0 SnmpMib = docsDevFilterIpDmask.47 0.0.0.0 SnmpMib = docsDevFilterIpStatus.48 createAndGo SnmpMib = docsDevFilterIpControl.48 accept SnmpMib = docsDevFilterIpIfIndex.48 2 SnmpMib = docsDevFilterIpDirection.48 inbound SnmpMib = docsDevFilterIpBroadcast.48 false SnmpMib = docsDevFilterIpSaddr.48 0.0.0.0 SnmpMib = docsDevFilterIpSmask.48 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.48 0.0.0.0 SnmpMib = docsDevFilterIpDmask.48 0.0.0.0 SnmpMib = docsDevFilterIpProtocol.48 256 SnmpMib = docsDevFilterIpSourcePortLow.48 1 SnmpMib = docsDevFilterIpSourcePortHigh.48 65535 SnmpMib = docsDevFilterIpDestPortLow.48 1 SnmpMib = docsDevFilterIpDestPortHigh.48 65535 SnmpMib = docsDevFilterIpStatus.50 createAndGo SnmpMib = docsDevFilterIpControl.50 accept SnmpMib = docsDevFilterIpIfIndex.50 2 SnmpMib = docsDevFilterIpDirection.50 outbound SnmpMib = docsDevFilterIpBroadcast.50 false SnmpMib = docsDevFilterIpSaddr.50 0.0.0.0 SnmpMib = docsDevFilterIpSmask.50 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.50 68.80.0.0 SnmpMib = docsDevFilterIpDmask.50 255.240.0.0 SnmpMib = docsDevFilterIpProtocol.50 17 SnmpMib = docsDevFilterIpSourcePortLow.50 1



231

SnmpMib = docsDevFilterIpSourcePortHigh.50 65535 SnmpMib = docsDevFilterIpDestPortLow.50 67 SnmpMib = docsDevFilterIpDestPortHigh.50 67 SnmpMib = docsDevFilterIpStatus.55 createAndGo SnmpMib = docsDevFilterIpControl.55 accept SnmpMib = docsDevFilterIpIfIndex.55 2 SnmpMib = docsDevFilterIpDirection.55 outbound SnmpMib = docsDevFilterIpBroadcast.55 false SnmpMib = docsDevFilterIpSaddr.55 0.0.0.0 SnmpMib = docsDevFilterIpSmask.55 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.55 68.32.0.0 SnmpMib = docsDevFilterIpDmask.55 255.224.0.0 SnmpMib = docsDevFilterIpProtocol.55 6 SnmpMib = docsDevFilterIpSourcePortLow.55 1 SnmpMib = docsDevFilterIpSourcePortHigh.55 65535 SnmpMib = docsDevFilterIpDestPortLow.55 80 SnmpMib = docsDevFilterIpDestPortHigh.55 80 SnmpMib = docsDevFilterIpStatus.56 createAndGo SnmpMib = docsDevFilterIpControl.56 accept SnmpMib = docsDevFilterIpIfIndex.56 2 SnmpMib = docsDevFilterIpDirection.56 outbound SnmpMib = docsDevFilterIpBroadcast.56 false SnmpMib = docsDevFilterIpSaddr.56 0.0.0.0 SnmpMib = docsDevFilterIpSmask.56 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.56 68.87.64.0 SnmpMib = docsDevFilterIpDmask.56 255.255.255.0 SnmpMib = docsDevFilterIpProtocol.56 256 SnmpMib = docsDevFilterIpSourcePortLow.56 1 SnmpMib = docsDevFilterIpSourcePortHigh.56 65535 SnmpMib = docsDevFilterIpDestPortLow.56 1 SnmpMib = docsDevFilterIpDestPortHigh.56 65535 SnmpMib = docsDevFilterIpStatus.57 createAndGo SnmpMib = docsDevFilterIpControl.57 accept SnmpMib = docsDevFilterIpIfIndex.57 0 SnmpMib = docsDevFilterIpDirection.57 both SnmpMib = docsDevFilterIpBroadcast.57 false SnmpMib = docsDevFilterIpSaddr.57 0.0.0.0 SnmpMib = docsDevFilterIpSmask.57 0.0.0.0 SnmpMib = docsDevFilterIpDaddr.57 192.168.100.0 SnmpMib = docsDevFilterIpDmask.57 255.255.255.0 SnmpMib = docsDevFilterIpProtocol.57 6 SnmpMib = docsDevFilterIpSourcePortLow.57 1 SnmpMib = docsDevFilterIpSourcePortHigh.57 65535 SnmpMib = docsDevFilterIpDestPortLow.57 1 SnmpMib = docsDevFilterIpDestPortHigh.57 65535 SnmpMib = ppCfgMtaFeatureSwitch.0 hexstr: 0A SnmpMib = docsDevSwAdminStatus.0 allowProvisioningUpgrade SnmpMib = arrisCmDevHttpWanAccess.0 advanced SnmpMib = arrisCmDevHttpLanAccess.0 basic SnmpMib = arrisMtaDevVPNomJitterBuffer.0 packetizationRatex1


232

Chapter 7

SnmpMib = arrisMtaDevVPJitterBufferMode.0 adaptive BaselinePrivacy = AuthorizeWaitTimeout = 10 ReauthorizeWaitTimeout = 10 KekGraceTime = 600 OpWaitTimeout = 10 RekeyWaitTimeout = 10 TekGraceTime = 600 AuthorizeRejectWaitTimeout = 60 SAMapWaitTimeout = 1 SAMapMaxRetries = 4 UpgradeServer = 0.0.0.0 MaxCpeAllowed = 1 UpstreamPacketClassification = PcReference = 1 PcServiceFlowReference = 1 PcRulePriority = 64 PcActivationState = 1 PcIpClassification = PcIpProtocol = 17 PcIpSourcePortStart = 2427 PcIpSourcePortEnd = 2427 UpstreamPacketClassification = PcReference = 3 PcServiceFlowReference = 1 PcRulePriority = 63 PcActivationState = 1 PcEthernetLLC = PcEtherDsapMactype = hexstr: 03.08.28 UpstreamPacketClassification = PcReference = 4 PcServiceFlowReference = 2 PcRulePriority = 1 PcActivationState = 1 PcIpClassification = PcIpProtocol = 256 DownstreamPacketClassification = PcReference = 101 PcServiceFlowReference = 101 PcRulePriority = 64 PcActivationState = 1 PcIpClassification = PcIpProtocol = 17 PcIpDestPortStart = 2427 PcIpDestPortEnd = 2427 DownstreamPacketClassification = PcReference = 102 PcServiceFlowReference = 102 PcRulePriority = 1 PcActivationState = 1



233

PcIpClassification = PcIpProtocol = 256 UpstreamServiceFlow = SfReference = 1 SfQosSetType = 7 SfTrafficPriority = 4 SfMaxTrafficRate = 64000 SfMaxTrafficBurst = 3044 SfMinReservedRate = 0 SfMinReservedRatePktsize = 64 SfMaxConcatBurst = 3044 SfSchedulingType = 2 SfRqTxPolicy = 224 UpstreamServiceFlow = SfReference = 2 SfClassName = "hsd" SfQosSetType = 7 SfTrafficPriority = 1 SfMaxTrafficRate = 1000000 SfMaxTrafficBurst = 10000000 SfMinReservedRate = 0 SfMinReservedRatePktsize = 64 SfMaxConcatBurst = 3044 SfSchedulingType = 2 SfRqTxPolicy = 128 DownstreamServiceFlow = SfReference = 101 SfQosSetType = 7 SfTrafficPriority = 4 SfMaxTrafficRate = 64000 SfMaxTrafficBurst = 96000 SfMinReservedRate = 0 SfMinReservedRatePktsize = 64 DownstreamServiceFlow = SfReference = 102 SfQosSetType = 7 SfTrafficPriority = 1 SfMaxTrafficRate = 17600000 SfMaxTrafficBurst = 100000000 SfMinReservedRate = 0 SfMinReservedRatePktsize = 64 MaxClassifiers = 20 PrivacyEnable = 1


234


Chapter 7

8 theAppendix B: Configuring Service Provider Root PacketCable requires a Service Provider certificate hierarchy, which allows other network elements to authenticate the service provider’s servers. The following figure shows the hierarchy.

The CableLabs Service Provider Root CA issues certificates only to authorized MSOs or Service Providers. This creates a problem for vendors or manufacturers who need to interoperate with the KDC and cannot obtain a Service Provider CA certificate under this root. One solution is to create a test root hierarchy and use it instead of the real root hierarchy for the purpose of lab testing. The MTA is manufactured with the CableLabs Service Provider Root certificate in order to verify and validate the certificates obtained in the AS_Reply message from the KDC. In the case where the KDC is configured with a test root, the MTA must also be configured with the same test root.


236

Chapter 8

Service Provider Root Provisioning Touchstone firmware versions prior to TS3.2 (June 2003) embedded the IPFonix test root digital certificate. TS3.2 firmware released after June 2003, and all subsequent versions, embeds the official PacketCable test root digital certificate from CableLabs, Inc. TS6.1 can support networks using the IPFonix test root digital certificate or MSO-generated test root digital certificates by allowing any valid test root certificate to be downloaded from a specified TFTP location. Three MIBs (described in ‘‘MIBs’’ below) control this support. The capability to download the certificates includes a retry mechanism to allow automatic recovery in the event of failure to download the certificate from the server. This mechanism retries the download 16 times, then waits for a period of time before retrying the download. The cycle repeats three times, and then the Telephony Modem resyncs and starts the configuration process over again. During this process, the Telephony Modem generates download retry/failure logs, described in the Touchstone Telephony Troubleshooting Guide.

CAUTION Service affecting If the Telephony Modem is configured to use secure downloading, the Telephony Modem does not restart the provisioning cycle and thus does not provide service.

MIBs

The CM configuration file transports the Service Provider Root MIBs to the Telephony Modem. Once the device has rebooted and downloaded the CM configuration file, then the Telephony Modem uses its private MIBs to determine how to proceed. There are three ARRIS private MIBs that can be set in the CM configuration file: • ppCfgMtaDevSPTestRootCertAdminStatus—instructs the Telephony Modem to either use the embedded test root or download and use a test root certificate from a TFTP server • ppCfgMtaDevSPTestRootCertServer—for the download option, this MIB specifies the IP address of the TFTP server containing the root certificate file • ppCfgMtaDevSPTestRootCertFilename—for the download option, this MIB specifies the file name on the TFTP server that contains the test root certificate


Appendix B: Configuring the Service Provider Root

237

The ppCfgMtaDevSPTestRootDownloadState object displays the status of the download, if the download option is chosen. Following is the definition of the MIB objects: ppCfgMtaDevServiceProviderTestRootCert OBJECT IDENTIFIER ::= { ppCfgMtaDevSecurity 1 } ppCfgMtaDevSPTestRootCertServer OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS read-write STATUS current DESCRIPTION "The IP address of the TFTP server used for downloading Service Provider Test Root Certificates to this device. Returns 0.0.0.0 if the TFTP server address is unknown or unassigned. This object can only be changed by the configuration file." ::= { ppCfgMtaDevServiceProviderTestRootCert 1 } ppCfgMtaDevSPTestRootCertFilename OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-write STATUS current DESCRIPTION "The file name of the Service Provider Test Root Certificate to be downloaded to this device from the TFTP server. Returns an empty string if the certificate filename is unknown or unassigned. This object can only be changed by the configuration file." ::= { ppCfgMtaDevServiceProviderTestRootCert 2 } ppCfgMtaDevSPTestRootCertAdminStatus OBJECT-TYPE SYNTAX INTEGER { ignoreCertSettings(0), useEmbeddedTestRootCert(1), downloadTestRootCert(2) } MAX-ACCESS read-write STATUS current DESCRIPTION "Controls the usage of Root Certificates by the MTA device. If set to downloadTestRootCert(2), the MTA will download the Service Provider Test Root Certificate specified by ’ppCfgMtaDevSPTestRootCertFilename’ from the TFTP server specified by ’ppCfgMtaDevSPTestRootCertServer’. If set to useEmbeddedTestRootCert(1), the MTA will use the factory-installed Test Root Certificate embedded in the device. If the value of this object is ignoreCertSettings(0), all of the Test Root Certificate settings (i.e. TestRootCertServer, TestRootCertFilename) are ignored and the MTA will, by default, use the factory-installed Real Root Certificate embedded in the device. This object can only be changed by the configuration file. At initial startup, this object has a default value of ignoreCertSettings(0)." DEFVAL { ignoreCertSettings } ::= { ppCfgMtaDevServiceProviderTestRootCert 3 } ppCfgMtaDevSPTestRootDownloadState OBJECT-TYPE SYNTAX INTEGER { noDownload(0), downloadRequested(1), inProgress(2), completed(3), failed(4) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the current state of the Service Provider Test Root Certificate download process. noDownload(0) indicates that no certificate download has been requested. downloadRequested(1) indicates a Test Root Certificate download is desired, most likely as a result of a downloadTestRootCert request. inProgress(2) indicates that a TFTP download is underway. completed(3) indicates that the last Test Root Certificate download was completed successfully. failed(4) indicates that the last attempted download failed. At initial startup, this object has a default value of noDownload(0)." DEFVAL { noDownload }


238

Chapter 8

::= { ppCfgMtaDevServiceProviderTestRootCert 4 }

Using the Default Embedded Root

To use the embedded real root, which is the default factory setting, either remove the ppCfgMtaDevSPTestRootCertAdminStatus object from the CM configuration file, or set it to ignoreCer tSettings.

Using the Embedded Test Root

Select the embedded test root by setting the ppCfgMtaDevSPTestRootCertAdminStatus object to useEmbeddedTestRootCert. The ppCfgMtaDevSPTestRootCertFilename and ppCfgMtaDevSPTestRootCertServer MIBs are ignored.

Using the Downloadable Test Root Feature

Download a test root to the MTA by setting the ppCfgMtaDevSPTestRootCertAdminStatus object to downloadTestRootCer t. Set ppCfgMtaDevSPTestRootCertServer to the IP address of the TFTP server and ppCfgMtaDevSPTestRootCertFilename to the file name. If the file name or the IP address of the TFTP server are missing or invalid, the download fails. The certificate must use the X.509 DER-encoded format.


9

Appendix C: Line Parameters by Countr y The following tables show the default tones and ring definitions for each supported country template.

Country Code Templates Use the ppCfgMtaCountryTemplate object to set the country code template. TS6.1 firmware supports the following country code templates: Gain settings (dB)

Name

North America 5/7 (1) Chile (2) Japan (3) Australia (4) Austria (5) France (6) Germany (7) Ireland (8) Netherlands (9) (Euro-DOCSIS default) Portugal (10) Spain (11) Belgium (12) Poland (13) Israel (14) Czech Republic (15) Brazil (16)

Flash time (ms) (NA load only)

Tx

Rx

Min

Max

−5 −3 −4 −3 −3 −3 −3 −3 −3

−7 −9.5 −8 −9.5 −9.5 −9.5 −9.5 −9.5 −9.5

250 40 200 250 85 300 300 250 300

1200 600 1200 1200 500 500 500 1200 500

−3 −3 −3 −3 −2 −3 −3

−9.5 −9.5 −9.5 −9.5 −4 −9.5 −9.5

100 90

300 650

50 50 200 250 220

600 520 800 1200 320


240

Chapter 9

Name

Gain settings (dB)

North America 3/3 (17) (DOCSIS default) North America 0/9 (18) Netherlands 0/9 (19) Japan (20) (Japan default) Hungary (21) Sweden (22) Norway (23) Slovakia (24) Japan 600L412 (25) (see note) Mexico (26) Panama (27) MexicoC (28) Switzerland (29) Poland1010 (30) Germany2 (31) North America 6/6 (32) (D11PLUS default) Argentina (33) Slovenia (34)

Flash time (ms) (NA load only)

Tx

Rx

Min

Max

−3

−3

250

1200

0 0 −4

−9 −9

250 300

1200 500

−8

200

1200

−3

−9.5

−3 −3 −3

−9.5 −9.5 −9.5

60 250 90

200 1200 800

250 200

1200 1200

100

800

220 100 88

320 800 600

−4

−12

0 −3

−7 −9.5

0 −3 −13 −3 −6

−7 −9.5 −19.5 −9.5 6

70 300 250

250 500 1200

0 −3

−7 −9.5

100 60

1100 200

Note:

Code 25 (Japan 600L412) is provided for lab environment tests only. ARRIS does not support field deployment using this template as it does not meet certain NTT specifications.

Provisioning Ring Cadence

North American Ring Cadences

The following ring cadences may be provisioned using the PacketCable NCS Signaling MIB (see PKT-SP-MIB-SIG-C01-071129). The following table shows the default ring cadences for North America.



241

Name

Description

Default

L/RG L/R0 L/R1

Standard Ringing Distinctive Ringing #0 Distinctive Ringing #1

2 seconds on, 4 seconds off 2 seconds on, 4 seconds off 2 seconds on, 4 seconds off

L/R2

Distinctive Ringing #2

L/R3


L/R4


L/R5


800 ms on, 400 ms off, 800 ms on, 4 seconds off 400 ms on, 200 ms off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off 300 ms on, 200 ms off, 1 second on, 200 ms off, 300 ms on, 4 seconds off 500 ms on, 5.5 seconds off (not repeated)

L/R6 L/R7 L/RS

Distinctive Ringing #6 Distinctive Ringing #7 Ring Splash

L/RT

Ringback Tone

2 seconds on, 4 seconds off 2 seconds on, 4 seconds off 500 ms on, 5.5 seconds off (not repeated) 2 seconds on, 4 seconds off

Touchstone firmware uses the default ring cadences shown above when the country template is provisioned to be one of the following: • northAmerica57 • northAmerica33 • northAmerica09 • northAmerica66 Template (i.e. hard-coded country-specific) based ring cadences are used by default when the country template is provisioned. This default behavior may be overridden by setting the ‘‘Provisioned Ring Cadences’’ CallP Feature Switch setting, and updating the MTA configuration file with the provisioning for the appropriate MIBs to define ring cadences (for example, pktcSigDevRgCadence). To make this setting, add 0x02000000 to the current feature switch setting in the CM configuration file.

Provisioning European Ring Cadences

European standard ring cadence and ring splash may be provisioned through the PKTC-IETF-MTA-MIB objects pktcSigDevRgCadence (standard ring), pktcSigDevR0Cadence through pktcSigDevR7Cadence, and pktcSigDevRsCadence (ring splash). These objects consist of the following fields: length

repeat

cadence

(2 octets)

(1 octet)

(. . .)


242

Chapter 9

The fields are: • length—(2 octets) The length, in bits, required to describe the ring cadence. Valid range: 1 to 264. • repeat —(1 octet) Either 0x80 to indicate a non-repeating cadence, or 0x00 to indicate a repeating cadence. • cadence—The bits describing the ring cadence. Each bit represents 50 ms; 1 represents ring and 0 represents silent. If the length is not divisible by 8, the last bits are ignored. For example, the default standard ring cadence for Belgium 00.50.00.FF.FF.F0.00.00.00.00.00.00.00, which corresponds to:

is

• 00 50: 80 bits (4 seconds total) • 00: repeating • FF.FF.F0: 1 second on • 00.00.00.00.00.00.00: 3 seconds off Note:

The pktcSigDevRsCadence (ring splash) object must always be nonrepeatable. The eMTA rejects any attempt to make the ring splash repeatable.



Argentina Ring Cadences

243

The following table shows the default ring cadences for Argentina. Name

Description

Default

RG

Standard Ringing

1000 ms on, 4000 ms off

R0 R1

Distinctive Ringing #0 Distinctive Ringing #1

R2


1000 ms on, 4000ms off 1000 ms on, 500 ms off, 300 ms on, 400 ms off 1000 ms on, 500 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off

R3


1000 ms on, 500 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off

R4


R5


R6


R7


RS

Ring Splash

1000 ms on, 500 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off 1000 ms on, 500 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off 1000 ms on, 500 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off 300 ms on, 400 ms off 1000 ms on, 500 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off, 300 ms on, 400 ms off 300 ms on, 400 ms off, 300 ms on, 400 ms off 300 ms on


244

Austria Ring Cadences

Chapte Cha pterr 9

The following table shows the default ring cadences for Austria. Name

Description

Default

RG

Standard Standard Ringing Ringing

1000 ms on, 5000 ms off

R0 R1

Dist Distin inct ctiv ivee Ring Ringin ing g #0 Dist Distin inct ctiv ivee Ring Ringin ing g #1

2000 2000 ms on, on, 4000 4000 ms off off 2000 2000 ms on, on, 4000 4000 ms off off

R2

Dist Distin inct ctiv ivee Ring Ringin ing g #2

R3


R4


R5


800 800 ms on, on, 400 400 ms off, off, 800 ms on, 4000 ms off 400 400 ms on, on, 200 200 ms off, off, 400 ms on, 200 ms off, 800 ms on, 4000 ms off 300 300 ms on, on, 200 200 ms off, off, 1000 ms on, 200 ms off, 300 ms on, 4000 ms off 500 500 ms on, on, 5500 5500 ms off off

R6 R7 RS RT

Dist Distin inct ctiv ivee Ring Ringin ing g #6 Dist Distin inct ctiv ivee Ring Ringin ing g #7 Ring Ring Splash Splash Ringback Tone

2000 2000 ms on, on, 4000 4000 ms off off 2000 2000 ms on, on, 4000 4000 ms off off 450 ms on 1000 ms on, 5000 ms off



Belgium Ring Cadences

2 45

The following table shows the default ring cadences for Belgium. Name

Description

Default

RG


1 second second on, 3 seconds seconds off

R0


R1


R2


1 seco second nd on, on, 300 300 ms off, off, 250 ms on, 2450 ms off 1 seco second nd on, on, 300 300 ms off, off, 1 second on, 1700 ms off 800 800 ms on, on, 400 400 ms off, off, 800 ms on, 4 seconds off

R3


R4


R5

Distin Distincti ctive ve Ringin Ringing g #5

R6


400 400 ms on, on, 200 200 ms off, off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off 300 300 ms on, on, 200 200 ms off, off, 1 second on, 200 ms off, 300 ms on, 4 seconds off 500 ms on, 5.5 second secondss off off (not repeated) 2 seco second ndss on, on, 4 seco second ndss off off

R7 RS RT

Dist Distin inct ctiv ivee Ring Ringin ing g #7 Ring Splash Splash Ringback Tone

2 seco second ndss on, on, 4 seco second ndss off off 300 ms on (not repeated) repeated) 1 second on, 3 seconds off


246

France Ring Cadences

Chapte Cha pterr 9

The following table shows shows the default ring cadences for France. Name

Description

Default

RG


1500 ms on, 3500 ms off

R0


R1


R2


1350 1350 ms on, 300 ms off, off, 350 ms on, 3 seconds off off (see note) 1350 1350 ms on, 300 ms off, off, 1350 1350 ms on, 2 seconds off off (see note) 800 ms on, 400 ms off, off, 800 ms on, 4 seconds off

R3


R4


R5


R6


400 ms on, 200 ms off, off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off 300 ms on, 200 ms off, off, 1 secsecond on, 200 ms off, 300 ms on, 4 second off 500 ms on, 5.5 second secondss off off (not repeated) 2 seco second ndss on, on, 4 seco second ndss off off

R7 RS RT


2 seco second ndss on, on, 4 seco second ndss off off 700 ms on (not repeated) repeated) 1.5 seconds on, 3.5 seconds off



Germany/Germany2 Ring Cadences

Hungary Hungar y Ring Cadences

2 47

The following following table shows shows the default ring ring cadences for Germany Germany and Germany2. Name

Description

Default

RG R0 R1 R2

Standard Standard Ringing Ringing Dist Distin inct ctiv ivee Ring Ringin ing g #0 Dist Distin inct ctiv ivee Ring Ringin ing g #1 Dist Distin inct ctiv ivee Ring Ringin ing g #2

R3


1000 ms on, 4000 ms off 2 seco second ndss on, on, 4 seco second ndss off off 2 seco second ndss on, on, 4 seco second ndss off off 800 800 ms on, on, 400 400 ms off, off, 800 ms on, 4 seconds off 400 400 ms on, on, 200 200 ms off, off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off

R4


R5


R6 R7


300 300 ms on, on, 200 200 ms off, off, 1 second on, 200 ms off, 300 ms on, 4 seconds off 500 ms on, 5.5 second secondss off off (not repeated) 2 seco second ndss on, on, 4 seco second ndss off off 2 seco second ndss on, on, 4 seco second ndss off off

RS RT

Ring Splash Splash Ringback Tone

450 ms on (not repeated) repeated) 1 second on, 4 seconds off

The following table shows the default ring cadences for Hungary. Name

Description

Default

RG R0 R1 R2

Standard Standard Ringing Ringing Dist Distin inct ctiv ivee Ring Ringin ing g #0 Dist Distin inct ctiv ivee Ring Ringin ing g #1 Distin Distincti ctive ve Ringin Ringing g #2

1250 ms on, 3750 ms off 2 seco second ndss on, on, 4 seco second ndss off off 2 seco second ndss on, on, 4 seco second ndss off off 800 ms on, 400 ms off, off, 800 ms on, 4 seconds off

R3


400 ms on, 200 ms off, off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off

R4


R5


R6 R7 RS RT

Dist Distin inct ctiv ivee Ring Ringin ing g #6 Dist Distin inct ctiv ivee Ring Ringin ing g #7 Ring Splash Splash Ringback Tone

300 ms on, 200 ms off, off, 1 second second on, 200 ms off, 300 ms on, 4 seconds off 500 ms on, 5.5 second secondss off off (not repeated) 2 seco second ndss on, on, 4 seco second ndss off off 2 seco second ndss on, on, 4 seco second ndss off off 450 ms on (not repeated) repeated) 1.25 seconds on, 3.75 seconds off


248

Israel Ring Cadences

Chapte Cha pterr 9

The following table shows shows the default ring cadences for Israel. Signal

Description

Default

RG


1s on, 4s off

R0 R1


2s on, 4s off 2s on, 4s off

R2


R3


R4


R5


800ms on, 400ms off, 800ms on, 4000ms off 400ms on, 200ms off, 400ms on, 200ms off, 800ms on, 4000ms off 300ms on, 200ms off, 1000ms on, 200ms off, 300ms on, 4000ms off 500ms on, 5500ms off

R6 R7 RS DR

Distinctive Ringing #6 Distinctive Ringing #7 Call Forward Ring Splash Delayed Delayed Ringing Ringing

2s on, 4s off 2s on, 4s off 650ms on (not repeated) 1s on, 4s off

SR PR

Special Special Ringing Ringing Precedence Ringing

CR CAR TR1

Continuou Continuouss Ringing Ringing CPE Activation Ring Splash Teen Ring

1.65s on, 3.35s off 0.3s on, 0.35s off, 0.65s on, 0.3s off, 0.3s on, 0.35s off, 0.65s on, 2s off 6s on, 4s off 650ms on 1s on, 0.65s off, 1s on, 2.35s off



Japan Ring Cadences

Mexico Ring Cadences

2 49

The following table shows the default ring cadences for Japan. Name

Description

Default

RG


1 second second on, 2 seconds seconds off

R0 R1


R2


R3


1 seco second nd on, on, 2 seco second ndss off off 800 800 ms on, on, 400 400 ms off, off, 800 ms on, 4 seconds off 300 300 ms on, on, 300 300 ms off, off, 300 ms on, 2100 ms off 300 300 ms on, on, 200 200 ms off, off, 1 second on, 200 ms off, 300 ms on, 4 seconds off

R4 R5 R6

Distin Distincti ctive ve Ringin Ringing g #4 Distin Distincti ctive ve Ringin Ringing g #5 Dist Distin inct ctiv ivee Ring Ringin ing g #6

500 ms on, 5.5 second secondss off off 500 ms on, 5.5 second secondss off off 1 seco second nd on, on, 2 seco second ndss off off

R7 RS RT


1 seco second nd on, on, 2 seco second ndss off off 500 ms on (not repeated) repeated) 1 second on, 4 seconds off

The following table shows the default ring cadences for Mexico. Name

Description

Default

RG R0

Standard Standard Ringing Ringing Dist Distin inct ctiv ivee Ring Ringin ing g #0

R1


R2


1 sec on, 4 sec off 1300 1300 ms on, on, 300 300 ms off, off, 300 ms on, 3100 ms off 500 500 ms on, on, 250 250 ms off, off, 1000 ms on, 250 ms off, 500 ms on, 3500 ms off 800 800 ms on, on, 400 400 ms off, off, 800 ms on, 4000 ms off

R3


400 400 ms on, on, 200 200 ms off, off, 400 ms on, 200 ms off, 800 ms on, 4000 ms off

R4


R5 R6 R7

Dist Distin inct ctiv ivee Ring Ringin ing g #5 Dist Distin inct ctiv ivee Ring Ringin ing g #6 Dist Distin inct ctiv ivee Ring Ringin ing g #7

300 300 ms on, on, 200 200 ms off, off, 1000 ms on, 200 ms off, 300 ms on, 4000 ms off 500 500 ms on, on, 5500 5500 ms off off 2000 2000 ms on, on, 4000 4000 ms off off 2000 2000 ms on, on, 4000 4000 ms off off

RS RT

Ring Ring Splash Splash Ringback Tone

250 ms on 1000 ms on, 4000 ms off


250

MexicoC Ring Cadences

Chapter 9

The following table shows the default ring cadences for MexicoC. Name

Description

Default

RG

Standard Ringing

1 sec on, 4 sec off

R0


R1


R2


R3


R4


1000 ms on, 500 ms off, 1000 ms on, 3500 ms off 500ms on, 500 ms off, 500 ms on, 500 ms off, 1000 ms on, 3000 ms off 500 ms on, 500 ms off, 1000 ms on, 500 ms off, 500 ms on, 3000 ms off 400 ms on, 200 ms off, 400 ms on, 200 ms off, 800 ms on, 4000 ms off 300 ms on, 200 ms off, 1000 ms on, 200 ms off, 300 ms on, 4000 ms off

R5 R6 R7 RS RT

Distinctive Ringing #5 Distinctive Ringing #6 Distinctive Ringing #7 Ring Splash Ringback Tone


500 ms on, 5500 ms off 2000 ms on, 4000 ms off 2000 ms on, 4000 ms off 250 ms on 1000 ms on, 4000 ms off


Netherlands/ Netherlands09 Ring Cadences

251

The following table shows the default ring cadences for all Netherlands templates. Name

Description

Default

RG R0

Standard Ringing Distinctive Ringing #0

R1


R2


R3


R4


R5


1000 ms on, 4000 ms off 1.3 seconds on, 300 ms off, 300 ms on, 3.1 seconds off 1.3 seconds on, 300 ms off, 1.3 seconds on, 2.1 seconds off 800 ms on, 400 ms off, 800 ms on, 4 seconds off 400 ms on, 200 ms off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off 300 ms on, 200 ms off, 1 second on, 200 ms off, 300 ms on, 4 seconds off 500 ms on, 5.5 seconds off (not repeated)

R6 R7 RS RT

Distinctive Ringing #6 Distinctive Ringing #7 Ring Splash Ringback Tone

2 seconds on, 4 seconds off 2 seconds on, 4 seconds off 450 ms on (not repeated) 1 second on, 4 seconds off


252

Norway Ring Cadences

Panama Ring Cadences

Chapter 9

The following table shows the default ring cadences for Norway. Name

Description

Default

RG

Standard Ringing

1000 ms on, 4000 ms off

R0 R1


1000 ms on, 4000 ms off 1000 ms on, 4000 ms off

R2


R3 R4


800 ms on, 400 ms off, 800 ms on, 4000 ms off 1000 ms on, 2000 ms off 800 ms on, 200 ms off, 200 ms on, 200 ms off, 400 ms on, 1400 ms off

R5


R6 R7


200 ms on, 200 ms off, 400 ms on, 200 ms off, 200 ms on, 200 ms off, 400 ms on, 1400 ms off 1000 ms on, 4000 ms off 1000 ms on, 4000 ms off

RS RT

Ring Splash Ringback Tone

450 ms on 1000 ms on, 4000 ms off

The following table shows the default ring cadences for Panama. Name

Description

Default

RG R0

Standard Ringing Distinctive Ringing #0

R1


R2


R3


R4


R5 R6 R7 RS RT

Distinctive Ringing #5 Distinctive Ringing #6 Distinctive Ringing #7 Ring Splash Ringback Tone

1000 ms on, 4000 ms off 1300 ms on, 300 ms off, 300 ms on, 3100 ms off 1300 ms on, 300 ms off, 1300 ms on, 2100 ms off 800 ms on, 400 ms off, 800 ms on, 4000 ms off 400 ms on, 200 ms off, 400 ms on, 200 ms off, 800 ms on, 4000 ms off 300 ms on, 200 ms off, 1000 ms on, 200 ms off, 300 ms on, 4000 ms off 500 ms on, 5500 ms off 2000 ms on, 4000 ms off 2000 ms on, 4000 ms off 650 ms on 1200 ms on, 4650 ms off



Poland/ Poland1010/Slovakia Ring Cadences

Slovenia Ring Cadences

253

The following table shows the default ring cadences for Poland and Slovakia. Name

Description

Default

RG R0 R1 R2

Standard Ringing Distinctive Ringing #0 Distinctive Ringing #1 Distinctive Ringing #2

1 second on, 4 seconds off 2 seconds on, 4 seconds off 2 seconds on, 4 seconds off 800 ms on, 400 ms off, 800 ms on, 4 seconds off

R3


400 ms on, 200 ms off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off

R4


R5


R6 R7 RS


300 ms on, 200 ms off, 1 second on, 200 ms off, 300 ms on, 4 seconds off 500 ms on, 5.5 seconds off (not repeated) 2 seconds on, 4 seconds off 2 seconds on, 4 seconds off 450 ms on (not repeated)

RT

Ringback Tone

1 second on, 4 seconds off

The following table shows the default ring cadences for Slovenia. Name

Description

Default

L/RG L/R0 L/R1 L/R2


L/R3


L/R4


L/R5


L/R6 L/R7


L/RS

Ring Splash

1 second on, 4 seconds off 2 seconds on, 4 seconds off 2 seconds on, 4 seconds off 800 ms on, 400 ms off, 800 ms on, 4 seconds off 400 ms on, 200 ms off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off 300 ms on, 200 ms off, 1 second on, 200 ms off, 300 ms on, 4 seconds off 500 ms on, 5.5 seconds off (not repeated) 2 seconds on, 4 seconds off 2 seconds on, 4 seconds off, 300 ms on, 400 ms off 650 ms on (not repeated)


254

Switzerland Ring Cadences

Customizing Default Ring Cadences

Chapter 9

The following table shows the default ring cadences for Switzerland. Name

Description

Default

L/RG L/R0 L/R1 L/R2


1 seconds on, 4 seconds off 2 seconds on, 4 seconds off 2 seconds on, 4 seconds off 800 ms on, 400 ms off, 800 ms on, 4 seconds off

L/R3


400 ms on, 200 ms off, 400 ms on, 200 ms off, 800 ms on, 4 seconds off

L/R4


L/R5


L/R6 L/R7 L/RS


300 ms on, 200 ms off, 1 second on, 200 ms off, 300 ms on, 4 seconds off 500 ms on, 5.5 seconds off (not repeated) 2 seconds on, 4 seconds off 2 seconds on, 4 seconds off 450 ms on

Any of the above ring cadences may be customized in the MTA configuration file. All MIB objects are MTA based; therefore, the first cadence is index 0. To enable customization, set the Provisioned Ring Cadences CallP Feature Switch (0x02000000) bit in the MTA configuration file. See ‘‘Provisioning European Ring Cadences’’ on page 241 for more information. The ring cadence is internally represented as a 64-bit string and provisioned in hex format. The ring cadence representation starts with the first 1 in the bit string pattern. Leading zeros are ignored, thus shortening the overall ring cadence duration. Each bit represents 100 ms of ringing (or tone in the case of L/RT); 1 is ring on, 0 is ring off. All 64 bits must be provisioned. The least significant 4 bits are used for representing repeatable characteristics: 0000 indicates that the ring cadence repeats, and 1000 indicates a non-repeatable ring cadence. Therefore, only the first 60 bits are used to represent the actual ring cadence for a maximum duration of 6 seconds. As mentioned earlier, shorter ring cadences may be provisioned by padding the ring cadence with leading zeros. For example, a ring cadence of 0.5 seconds on, 4 seconds off, repeatable, has a value of 0x0001F00000000000 and would be provisioned in the MTA configuration file as 00.01.F0.00.00.00.00.00.



255

Default Tone Settings The following tables show default tones for each country template. The columns in each table are as follows: type The type of tone (busy, dial tone). level The tone level, in dB. Freq. Type Either 1 (first frequency modified by the second) or 2 (summation). # Freq. The number of frequencies used to generate the tone (1–4). Frequencies The frequencies used to generate the tone. # on/off The number of on/off cycles in the tone pattern (1–4). 1st tone – 4th tone The duration, in milliseconds, of the on/off segments of each tone cycle. rep. count The number of times the tone pattern is repeated. tone steady Which of the four tones, if any, are held indefinitely after the pattern completes (used, for example, with stutter dial).


256


Chapter 9


257


258


Chapter 9


259


260


Chapter 9


261


262


Chapter 9


263


264


Chapter 9


265


266


Chapter 9


267


268


Chapter 9


269


270


Chapter 9


271


272


Chapter 9


273


274


Chapter 9

10

A access-only DQos feature switch 55 active QoS timeout, setting 104 adding manufacturer CVC 12 manufacturer CVC 12 address aging feature switch, enable MAC 70 E.164 118 addresses, aging out CPE MAC 155 adjusting Rx/Tx gain 101 Advanced flash feature switch 73 AES encryption for RTP/RTCP feature switch 57 encryption parameters, SDP 57 affecting SDP, feature switch 60 aging feature switch, enable MAC address 70 CPE MAC addresses 155 alarms log reporting, configuring 81 configuring 81 allowed CPE counts, setting 95 anonymous call rejection 117, 125 arrisCmDevClearCachedFrequencies, MIB 148 arrisCmDevClearPresetFrequencies, MIB 148 arrisCmDevCLITimeout, MIB 92 arrisCmDevDEAControl, MIB 93–94 arrisCmDevDhcpCmGatewayIpAddrV6, MIB 209 arrisCmDevDhcpCmIpAddrV6, MIB 209 arrisCmDevDhcpCmSubNetMaskV6, MIB 209 arrisCmDevDhcpIpMode, MIB 209 arrisCmDevDhcpNoSvcImpact, MIB 137, 140 arrisCmDevDhcpPrimaryDhcpServerIpAddrV6, MIB 209 arrisCmDevDhcpTftpSvrIpAddrV6, MIB 209 arrisCmDevDhcpTimeSvrIpAddrV6, MIB 209 arrisCmDevDocsQosParamSetActiveTimeout, MIB 104 arrisCmDevDSTPolicy, MIB 111–112 arrisCmDevDualModeDiscoveredMarket, MIB 52 arrisCmDevEnableDocsis20, MIB 96 arrisCmDevHttpLanAccess, MIB 88, 209 arrisCmDevHttpWanAccess, MIB 88, 209 arrisCmDevModemFeatureSwitch, MIB 69, 91, 97 arrisCmDevModemFeatureSwitch2, MIB 69–70, 95, 135, 155–156 arrisCmDevPresetFrequency, MIB 148 arrisCmDevProvMethodIndicator, MIB 18, 23 arrisCmDevRouterMode, MIB 155, 166 arrisCmDevSwAdminStatus, MIB 3, 5, 7, 14 ArrisCmDevSwCustomerLoadId, MIB 6

Index

arrisCmDevSwCustomerLoadId, MIB 13 ArrisCmDevSwFilename, MIB 6 arrisCmDevSwFilename, MIB 4, 14 ArrisCmDevSwHwModel, MIB 6 arrisCmDevSwHwModel, MIB 3, 6, 13 ArrisCmDevSwHwRev, MIB 6 arrisCmDevSwHwRev, MIB 3, 13 arrisCmDevSwImageBuildTime, MIB 90 arrisCmDevSwImageName, MIB 90 arrisCmDevSwServerAddress, MIB 4, 6, 13, 209 arrisCmDevSwServerAddressType, MIB 4, 6, 13, 209 arrisCmDevSwTable, MIB 3, 6, 13 arrisCmDevTftpBlkSize, MIB 94 arrisCmDevTODSyncTimeOut, MIB 110 arrisCmDevTODTimeOffset, MIB 111 arrisCmDevWanIsolationState, MIB 70, 96–97 arrisCmDevWirelessRegion, MIB 155 arrisCmDevWrmProvFile, MIB 161–162 arrisCmDevWrmProvFileName, MIB 162 arrisCmDevWrmProvServer, MIB 162 arrisCmDhcpOption51Override, MIB 34, 134–135 arrisMtaCfgRTPDynPortEnd, MIB 103, 119, 121 arrisMtaCfgRTPDynPortStart, MIB 103, 119, 121 arrisMtaDevAutomaticCallResourceRecovery, MIB 108 arrisMtaDevAutomaticOsiDelay, MIB 59 arrisMtaDevCustomJitterBufferEnabled, MIB 114 arrisMtaDevDefaultReasonNoCIDName, MIB 105 arrisMtaDevDhcpOptionOverride, MIB 32, 134–135 arrisMtaDevDspHandleNonPhaseReversedTone, MIB 103 arrisMtaDevDTMFEndEventForceAscending, MIB 108 arrisMtaDevEchoCancellerTailLength, MIB 102 arrisMtaDevEnableIndexTenEleven, MIB 69, 104 arrisMtaDevEndPntDialingMethod, MIB 48–49, 101–102, 190, 208 arrisMtaDevEndPntFaxOnlyLineTimeout, MIB 107, 116, 130 arrisMtaDevEndPntRingingWav eform, MIB 102–103 arrisMtaDevEventHideFQDNAndIPAddress, MIB 89 arrisMtaDevGainControl, MIB 16 arrisMtaDevGainControlCAS, MIB 99 arrisMtaDevGainControlFSK, MIB 99 arrisMtaDevGainControlLocalDTMF, MIB 100 arrisMtaDevGainControlLocalTone, MIB 100 arrisMtaDevGainControlNetworkDTMF, MIB 100 arrisMtaDevGainControlNetworkTone, MIB 100 arrisMtaDevGainControlRxVoice, MIB 100–101 arrisMtaDevGainControlTxVoice, MIB 100–101 arrisMtaDevLevelControlOffHookCAS, MIB 99 arrisMtaDevLevelControlOffHookEnable, MIB 99 arrisMtaDevLevelControlOffHookFSK, MIB 99 arrisMtaDevLoopVoltageMaintTimeout, MIB 92 arrisMTADevLoopVoltagePolicy, MIB 91 arrisMtaDevLoopVoltageResetTimeout, MIB 10, 91–92


276

arrisMtaDevOffHookFskDelay, MIB 105 arrisMtaDevPacketcableProvisioningFlow, MIB 24 arrisMtaDevPersistentLineStatus, MIB 108 arrisMtaDevProvMethodIndicator, MIB 18, 23–24, 209 arrisMtaDevProvState, MIB 78 arrisMtaDevPwrSupplyDataShutdownTime, MIB 90 arrisMtaDevPwrSupplyEnableDataShutdown, MIB 90 arrisMtaDevPwrSupplyHighestTemperature, MIB 93 arrisMtaDevPwrSupplyHighestTemperatureClear, MIB 93 arrisMtaDevPwrSupplyHighestTemperatureTime, MIB 93 arrisMtaDevPwrSupplyHiTempBatteryShutdownControl, MIB 93 arrisMtaDevPwrSupplyOverTempAlarmControl, MIB 92 arrisMtaDevPwrSupplyOverTempAlarmThreshold, MIB 93 arrisMtaDevPwrSupplyTemperature, MIB 93 arrisMtaDevRtcpTosValue, MIB 107 arrisMtaDevRTPTxQueueSize, MIB 104 arrisMtaDevSipConfigFileURL, MIB 124 arrisMtaDevSipDwnldConfig, MIB 124 arrisMtaDevSpecialConfigurationOverrideEnable, MIB 2, 23–24 arrisMtaDevSvcDnldNoSvcImpact, MIB 16 arrisMtaDevSwDnldNoSvcImpact, MIB 4, 9–10 arrisMtaDevSWUpgradeStatus, MIB 80 arrisMtaDevTDDReportToCMS, MIB 106 arrisMtaDevTFTPServerAddrOverrideFQDN, MIB 21 arrisMtaDevVbdOverwriteLineBitmap, MIB 113 arrisMtaDevVbdOverwriteMaxJitterBuffer, MIB 114 arrisMtaDevVbdOverwriteMinJitterBuffer, MIB 114 arrisMtaDevVbdOverwriteNomJitterBuffer, MIB 114 arrisMtaDevVPJitterBufferMode, MIB 113 arrisMtaDevVPMaxJitterBuffer, MIB 113 arrisMtaDevVPNomJitterBuffer, MIB 113 arrisMtaDevVqmEnable, MIB 106 arrisMtaDevVqmEnableRemote, MIB 106 arrisMtaDevVqmHistorySize, MIB 106 arrisWrmDevHpg, MIB 154, 161 arrisWrmDevLanDhcp, MIB 157 arrisWrmDevLanDomain, MIB 157 arrisWrmDevLanIpAddr, MIB 156 arrisWrmDevLanIpMask, MIB 156 arrisWrmDevLanIpPoolEnd, MIB 156 arrisWrmDevLanIpPoolStart, MIB 156 arrisWrmDevLanLease, MIB 157 arrisWrmDevNATEnable, MIB 156, 160 arrisWrmDevProvDLTime, MIB 161 arrisWrmDevProvFile, MIB 161 arrisWrmDevProvFileName, MIB 161 arrisWrmDevProvStatus, MIB 160 arrisWrmDevPwd, MIB 160 arrisWrmDevRip2AdvertisementInt, MIB 160 arrisWrmDevRip2KeyId, MIB 160 arrisWrmDevRip2Table, MIB 160 arrisWrmDevRipReceiveStatus, MIB 160 arrisWrmDevRipTransmitStatus, MIB 160 arrisWrmDevRmEnable, MIB 154 arrisWrmDevSaveSettings, MIB 156 arrisWrmDevWlanAp, MIB 157 arrisWrmDevWlanApConfigChannel, MIB 157, 171 arrisWrmDevWlanApConfigIndex, MIB 157 arrisWrmDevWlanApConfigLanAccess, MIB 160, 172 arrisWrmDevWlanApConfigMode, MIB 157 arrisWrmDevWlanApConfigProtec, MIB 158 arrisWrmDevWlanApConfigQos, MIB 158 arrisWrmDevWlanApConfigSsid, MIB 157 arrisWrmDevWlanApConfigSSidBroad, MIB 157 arrisWrmDevWlanApConfigTable, MIB 157–158 arrisWrmDevWlanApDhcpc, MIB 157 arrisWrmDevWlanApIsolationExtra, MIB 159, 172 arrisWrmDevWlanApIsolationInter, MIB 159, 172 arrisWrmDevWlanApPowerLevel, MIB 159, 170 arrisWrmDevWlanApSecuConfigEnable, MIB 158 arrisWrmDevWlanApSecuConfigIndex, MIB 158

Chapter 10

arrisWrmDevWlanApSecuConfigTable, MIB 157–159 arrisWrmDevWlanApSecuConfigWep, MIB 158 arrisWrmDevWlanApSecuConfigWepK_gen, MIB 158 arrisWrmDevWlanApSecuConfigWepK_index, MIB 158 arrisWrmDevWlanApSecuConfigWepK_man, MIB 158 arrisWrmDevWlanApSecuConfigWepK_type, MIB 158 arrisWrmDevWlanApSecuConfigWpa2Obsecu, MIB 159 arrisWrmDevWlanApSecuConfigWpa2phrase, MIB 159 arrisWrmDevWlanApSecuConfigWpaEncry, MIB 159 arrisWrmDevWlanApSecuConfigWpaObsecu, MIB 159 arrisWrmDevWlanApSecuConfigWpaphrase, MIB 159 arrisWrmDevWlanQoSConfigEnable, MIB 159, 171 arrisWrmDevWlanQoSConfigHomeBandwidth, MIB 159, 171 arrisWrmDevWlanQoSConfigPrivateBandwidth, MIB 159, 171 arrisWrmDevWlanQoSConfigTotalBandwidth, MIB 159, 171 attribute parameters feature switch, suppress SDP capability 55 authorization headers, remove 72 automatic call resource recovery 108 OSI 59

B backoff/retry timing 136 bandwidth considerations, G.729 46 battery MIBs, obsolete 209 over-temperature protection, configuring 92 boost mode 98 bracketed IP address feature switch 58 broadcast DHCP filtering feature switch, enable 70, 135 buffer custom jitter 114 depth, provisioning upstream 104 provisioning jitter 113 busy tone, SIP local 71 BYE delay, SIP 131 bypass feature switch, MTA maxCpeAllowed 68 feature switch, WRM MaxCpeAllowed 70 hash checking feature switch 68 KDC load balancer checks feature switch 68 SNMP INFORM checks feature switch 68 byte, RTCP ToS 107

C cadences feature switch, provisionable ring 58 provisioning ring 240 Call Management Server 40 call anonymous 117, 125 rejection handling, SIP 71 recovery, automatic 108 Call Waiting, disabling 117, 125 Caller ID 105 feature switch, non-sequential 58 outbound method 117, 125 capability attribute parameters feature switch, suppress SDP 55 feature switch, T.38 53 T.38-only, SDP 53 certificate IPFonix 236 PacketCable test root digital 236 Service Provider Root 236 using the default root 238 certificates MIBs for root 236 private MIBs 236 using default 238


Index

changes, MIBs, PacketCable OID 35 changing Endpoint 105 ifInOctets counter operation 91 channel lists, downstream 74 charger temperature, highest recorded 93 checking feature bypass hash 68 disable hash 68 checks feature bypass KDC load balancer 68 bypass SNMP INFORM 68 CLI interaction with remote provisioning 162 timeout, setting 92 CM example, SIP 219 feature switch 69 CMS see Call Management Server CMS redirect feature switch 57 CODEC G.729 44 G.729 44 CODECs supported 43 supported by SIP 121 co-existence example, SNMP 215 coexistence feature switch, MTA 68 COMMIT or RESERVE feature switch 57 comparison feature switch, skip USM user name 68 compliance feature switch, SDP 54 concatenation feature switch 69 configuration DTM602 filter 78 example, WRM 223 file encryption, GUPI, with MTA 22 SIP, T.38 130 T.38 107 configuring alarms 81 alarms and log reporting 81 battery over-temperature protection 92 distinctive ringing 130 line index 104 logs 81 loop current 98 Payload header Suppression 56 ring frequency 141 ToD timeout 110 connections per line feature switch, multiple 56 considerations downgrading, dual mode 11 dual-mode 51 European loads, provisioning 35 provisioning, DTM602 78 containing TLV-11s, TLV-43 74 control feature switch, WRM reset 70 controlling data shutdown 90 functionality 88, 95 MTA functionality 98 count SYNC/MAP packets feature switch 69 counter operation, changing ifInOctets 91 country code templates 239 CPE setting allowed 95 MAC addresses, aging out 155 current, configuring loop 98 custom jitter buffer 114 CVC, adding adding manufacturer 12 adding, manufacturer 12

277

CW-CID feature switch, disable 73

D data shutdown, controlling 90 daylight savings time policy 111 DECT phone example 225 default certificates, using 238 hook flash timing settings 239 certificate, using 238 delay DLCX feature switch 59 SIP BYE 131 deprecated MIBs 209 depth, provisioning upstream buffer 104 DHCP filtering feature switch, enable broadcast 70, 135 lease override 34 lease time request 34 option 43 support 33 option 51 support 34 option 60 support 34 option 7 82 options, provisioning 134 options required 31 parameters, provisioning modes 31 reinit 134 dial pulse example, gateway 219 support 101 Dialing feature, SIP, Repeat 129 dialing features supported, SIP 126 disable CW-CID feature switch 73 hash checking feature switch 68 TFTP timeout feature switch 70 USB feature switch 69 disabling, Call Waiting 117, 125 discard invalid MAP feature switch 70 discontinued loads, OPT177 2 distinctive ringing, configuring 130 DLCX feature switch, delay 59 docDevEvSyslogAddressType, MIB 82 docsDevEventTable, MIB 81 docsDevEvSyslogAddress, MIB 82 docsDevResetNow, MIB 5, 14 docsDevSoftware, MIB 3, 17 docsDevSwAdminStatus, MIB 3–5, 17 docsDevSwFilename, MIB 13, 17 docsDevSwOperStatus, MIB 17, 80 docsDevSwServer, MIB 13, 17 docsDevSwServerAddress, MIB 17 docsDevSwServerAddressType, MIB 17 DOCSIS 1.0 fragmentation support 97 domain override feature switch 73 SIP 124 dot1dTpFdbTable, MIB 155 downgrading, dual mode considerations 11 downstream channel lists 74 DownstreamPacketClassification, MIB 118 DQos see Dynamic Quality of Service DQos feature switch, access-only 55 DQoS feature switch, DSx 55 PacketCable compliant feature switch 54 tolerated grant jitter feature switch 56 DSx DQoS feature switch 55 QoS 41


278

DTM602 considerations, provisioning 78 filter configuration 78 MaxCPEAllowed interaction 95 DTMF with, RFC2833 66 relay 43 RFC2833 feature switch, send 58 dual mode considerations, downgrading 11 dual-mode considerations 51 duplicate MIBs 207 duration, RFC2388 end of event 108 dynamic equalizer 93 Dynamic Quality of Service 41 dynamic RTP port range, provisioning 103

E E.164 address 118 earlier NCS loads to SIP, firmware upgrade, from 8 NCS loads to TS4.5 SIP, firmware upgrade, from 15 echo cancellation tail, provisioning 102 emergency number, SIP 131 enable broadcast DHCP filtering feature switch 70, 135 ifIndex shift feature switch 69 IPv6 forwarding feature switch 69 MAC address aging feature switch 70 encryption RTP/RTCP feature switch, AES 57 GUPI, with MTA configuration file 22 parameters, SDP, AES 57 end of event duration, RFC2388 108 Endpoint, changing ID 105 endpoint, lockstep quarantine 52 Enhanced Firmware Loading 2 equalizer, dynamic 93 error feature switch, MGCP 53 reporting, WRM provisioning file 154 esafeDevServiceIntImpact, MIB 9 EURO provisioning restriction for 20, 35 loads, upgrading, to 16 European flash support 73 provisioning considerations for 35 Event see Alarms; Logs. event notification, TDD 106 tables, PacketCable 82 example DECT phone 225 firmware upgrade 216 gateway dial pulse 219 hotline 223 SIP CM 219 SIP MTA 221 SNMP co-existence 215 warmline 223 WRM configuration 223

F fax support, G.729 46 fax-only line 116 mode 107, 130 feature SIP, Repeat Dialing 129 access-only DQos 55

Chapter 10

Advanced flash 73 AES encryption for RTP/RTCP 57 affecting SDP 60 bracketed IP address 58 bypass hash checking 68 bypass KDC load balancer checks 68 bypass SNMP INFORM checks 68 CM 69 CMS redirect 57 COMMIT or RESERVE 57 concatenation 69 count SYNC/MAP packets 69 delay DLCX 59 disable CW-CID 73 disable hash checking 68 disable TFTP timeout 70 disable USB 69 discard invalid MAP 70 domain override 73 DQoS SF PacketCable compliant 54 DQoS tolerated grant jitter 56 DSx DQoS 55 enable broadcast DHCP filtering 70, 135 enable ifIndex shift 69 enable IPv6 forwarding 69 enable MAC address aging 70 flash timing 58 halt on no ToD 69 lockstep quarantine mode 52 MGCP error codes 53 MTA 68 MTA coexistence 68 MTA FQDN 73 MTA maxCpeAllowed bypass 68 mtaFilterBypass 68 multiple connections per line 56 NCS piggyback 52 non-sequential Caller ID 58 omit MPTIME parameter 54 Payload Header Suppression 56 provisionable ring cadences 58 provisional response 56 RFC2833 payload type 94 57 RFC2833, related 64 RFC3323 privacy header 73 RFC3842 handshake 73 RSIP wildcarding 55 SDP compliance 54 send DTMF via RFC2833 58 SIP 71 SIP proxy penalty box 71 skip USM user name comparison 68 SRV lookup 73 suppress SDP capability attribute parameters 55 T.38 capability descriptor 53 WAN isolation override 70 WRM MaxCpeAllowed bypass 70 WRM reset control 70 features SIP hybrid 128 supported, SIP dialing 126 field, ToS 149 file encryption, GUPI, with MTA configuration 22 error reporting, WRM provisioning 154 filter configuration, DTM602 78 filtering feature switch, enable broadcast DHCP 70, 135 firmware installation 1 upgrade example 216 upgrade, from earlier NCS loads to SIP 8 upgrade, from earlier NCS loads to TS4.5 SIP 15


Index

upgrade, MIB 6 upgrade, minimizing service impacts 9 upgrade, options 5 upgrade, process 3 service interruption during 40 upgrade status 80 upgrading 2 upgrading, from TS4.2 and earlier 18 upgrading, through provisioning 16 upgrading, through SNMP 17 flash feature switch, Advanced 73 processing, hook 117, 125 support, European 73 timing feature switch 58 provisioning hook 147 timing settings, default hook 239 for root certificates, MIBs 236 forwarding feature switch, enable IPv6 69 IPv6 packets 97 FQDN feature switch, MTA 73 fragmentation support, DOCSIS 1.0 97 frequency, configuring ring 141 from earlier NCS loads to SIP, firmware upgrade 8 earlier NCS loads to TS4.5 SIP, firmware upgrade 15 TS4.2 and earlier, firmware upgrading 18 controlling 88, 95 controlling MTA 98

G G.729 bandwidth considerations 46 CODEC negotiation 44 CODEC support 44 fax support 46 modem support 46 gain adjusting Rx/Tx 101 provisioning 99 gateway dial pulse example 219 Global Universal Provisioning Interface 21 grant jitter feature switch, DQoS tolerated 56 GUPI 21 with MTA configuration file encryption 22

H halt on no ToD feature switch 69 handling, SIP call rejection 71 handshake feature switch, RFC3842 73 hash checking feature switch, bypass 68 feature switch, disable 68 header feature switch, RFC3323 privacy 73 headers, remove authorization 72 highest recorded charger temperature 93 hook flash processing 117, 125 flash timing, provisioning 147 flash timing settings, default 239 hotline 128 example 223 hybrid features, SIP 128

I ifAdminStatus, MIB 78, 119–120, 207 ifAdminStatus.10, MIB 120

279

ifAdminStatus.9, MIB 120 ifIndex MIB 42, 69, 104–105 shift feature switch, enable 69 ifInOctets counter operation, changing 91 MIB 69, 91 ifPhysAddress, MIB 35 ifTable, MIB 43 index configuring line 104 interface 42 Indicator, Message Waiting 73 INFO messages, SIP 182 INFORM checks feature switch, bypass SNMP 68 installation, firmware 1 interaction DTM602, MaxCPEAllowed 95 remote provisioning, CLI 162 time of day 110 WTM552, MaxCPEAllowed 95 WTM552/WTM652, MaxCPEAllowed 153 WTM652, MaxCPEAllowed 95 interactions with QoS timeout, PacketCable provisioning 104 interface index scheme 42 invalid MAP feature switch, discard 70 IP feature switch, bracketed 58 ports 42 security 40 IPFonix certificate 236 IPsec 40 IPv6 forwarding feature switch, enable 69 packets, forwarding 97 isolation override feature switch, WAN 70

J jitter buffer, custom 114 buffer, provisioning 113 feature switch, DQoS tolerated grant 56

K KDC see Key Distribution Center KDC load balancer checks feature switch, bypass 68 updating 85 Kerberos Key Distribution Center, updating 85 Kerberos through DHCP 31 Key Distribution Center, updating, Kerberos 85

L lease override, DHCP 34 request, DHCP 34 line fax-only 116 feature switch, multiple connections per 56 index, configuring 104 ports, voice 42 status, persistent 108 lines, post-provisioning SIP 123 lists, downstream channel 74 load checks feature switch, bypass KDC 68 WDOCSIS 2


280

Chapter 10

loads

ArrisCmDevSwCustomerLoadId 6 arrisCmDevSwCustomerLoadId 13 ArrisCmDevSwFilename 6 arrisCmDevSwFilename 4, 14 ArrisCmDevSwHwModel 6 arrisCmDevSwHwModel 3, 6, 13 ArrisCmDevSwHwRev 6 arrisCmDevSwHwRev 3, 13 arrisCmDevSwImageBuildTime 90 arrisCmDevSwImageName 90 arrisCmDevSwServerAddress 4, 6, 13, 209 arrisCmDevSwServerAddressType 4, 6, 13, 209 arrisCmDevSwTable 3, 6, 13 arrisCmDevTftpBlkSize 94 arrisCmDevTODSyncTimeOut 110 arrisCmDevTODTimeOffset 111 arrisCmDevWanIsolationState 70, 96–97 arrisCmDevWirelessRegion 155 arrisCmDevWrmProvFile 161–162 arrisCmDevWrmProvFileName 162 arrisCmDevWrmProvServer 162 arrisCmDhcpOption51Override 34, 134–135 arrisMtaCfgRTPDynPortEnd 103, 119, 121 arrisMtaCfgRTPDynPortStart 103, 119, 121 arrisMtaDevAutomaticCallResourceRecovery 108 arrisMtaDevAutomaticOsiDelay 59 arrisMtaDevCustomJitterBufferEnabled 114 arrisMtaDevDefaultReasonNoCIDName 105 arrisMtaDevDhcpOptionOverride 32, 134–135 arrisMtaDevDspHandleNonPhaseReversedTone 103 arrisMtaDevDTMFEndEventForceAscending 108 arrisMtaDevEchoCancellerTailLength 102 arrisMtaDevEnableIndexTenEleven 69, 104 arrisMtaDevEndPntDialingMethod 48–49, 101–102, 190,

OPT177, discontinued 2 to SIP, firmware upgrade, from earlier NCS 8 upgrading, SIP 16 upgrading, to EURO 16 local busy tone, SIP 71 lockstep quarantine, endpoint 52 quarantine mode feature switch 52 log reporting, configuring alarms and 81 logs, configuring 81 loop current, configuring 98 voltage management, reset timer 10 voltage management, setting policy 91 loopback test remote 133 SIP 133

M MAC address aging feature switch, enable 70 addresses, aging out CPE 155 management reset timer, loop voltage 10 setting policy, loop voltage 91 manufacturer CVC, adding 12 MAP feature switch, discard invalid 70 MaxCpeAllowed 95 maxCpeAllowed bypass feature switch, MTA 68 MaxCpeAllowed bypass feature switch, WRM 70 MaxCPEAllowed interaction DTM602 95 WTM552 95 WTM552/WTM652 153 WTM652 95 MaxCpeAllowed, MIB 68 maximum traffic rate 54 Message Waiting Indicator 73 messages, SIP SIP INFO 182 SIP PRACK 182 SIP REFER 182 methods, SIP provisioning 22 MGCP error codes feature switch 53 MIB arrisCmDevClearCachedFrequencies 148 arrisCmDevClearPresetFrequencies 148 arrisCmDevCLITimeout 92 arrisCmDevDEAControl 93–94 arrisCmDevDhcpCmGatewayIpAddrV6 209 arrisCmDevDhcpCmIpAddrV6 209 arrisCmDevDhcpCmSubNetMaskV6 209 arrisCmDevDhcpIpMode 209 arrisCmDevDhcpNoSvcImpact 137, 140 arrisCmDevDhcpPrimaryDhcpServerIpAddrV6 209 arrisCmDevDhcpTftpSvrIpAddrV6 209 arrisCmDevDhcpTimeSvrIpAddrV6 209 arrisCmDevDocsQosParamSetActiveTimeout 104 arrisCmDevDSTPolicy 111–112 arrisCmDevDualModeDiscoveredMarket 52 arrisCmDevEnableDocsis20 96 arrisCmDevHttpLanAccess 88, 209 arrisCmDevHttpWanAccess 88, 209 arrisCmDevModemFeatureSwitch 69, 91, 97 arrisCmDevModemFeatureSwitch2 69–70, 95, 135, 155–156 arrisCmDevPresetFrequency 148 arrisCmDevProvMethodIndicator 18, 23 arrisCmDevRouterMode 155, 166 arrisCmDevSwAdminStatus 3, 5, 7, 14

208 arrisMtaDevEndPntFaxOnlyLineTimeout 107, 116, 130 arrisMtaDevEndPntRingingWav eform 102–103 arrisMtaDevEventHideFQDNAndIPAddress 89 arrisMtaDevGainControl 16 arrisMtaDevGainControlCAS 99 arrisMtaDevGainControlFSK 99 arrisMtaDevGainControlLocalDTMF 100 arrisMtaDevGainControlLocalTone 100 arrisMtaDevGainControlNetworkDTMF 100 arrisMtaDevGainControlNetworkTone 100 arrisMtaDevGainControlRxVoice 100–101 arrisMtaDevGainControlTxVoice 100–101 arrisMtaDevLevelControlOffHookCAS 99 arrisMtaDevLevelControlOffHookEnable 99 arrisMtaDevLevelControlOffHookFSK 99 arrisMtaDevLoopVoltageMaintTimeout 92 arrisMTADevLoopVoltagePolicy 91 arrisMtaDevLoopVoltageResetTimeout 10, 91–92 arrisMtaDevOffHookFskDelay 105 arrisMtaDevPacketcableProvisioningFlow 24 arrisMtaDevPersistentLineStatus 108 arrisMtaDevProvMethodIndicator 18, 23–24, 209 arrisMtaDevProvState 78 arrisMtaDevPwrSupplyDataShutdownTime 90 arrisMtaDevPwrSupplyEnableDataShutdown 90 arrisMtaDevPwrSupplyHighestTemperature 93 arrisMtaDevPwrSupplyHighestTemperatureClear 93 arrisMtaDevPwrSupplyHighestTemperatureTime 93 arrisMtaDevPwrSupplyHiTempBatteryShutdownControl 93 arrisMtaDevPwrSupplyOverTempAlarmControl 92 arrisMtaDevPwrSupplyOverTempAlarmThreshold 93 arrisMtaDevPwrSupplyTemperature 93 arrisMtaDevRtcpTosValue 107 arrisMtaDevRTPTxQueueSize 104 arrisMtaDevSipConfigFileURL 124 arrisMtaDevSipDwnldConfig 124 arrisMtaDevSpecialConfigurationOverrideEnable 2, 23–24


Index

arrisMtaDevSvcDnldNoSvcImpact 16 arrisMtaDevSwDnldNoSvcImpact 4, 9–10 arrisMtaDevSWUpgradeStatus 80 arrisMtaDevTDDReportToCMS 106 arrisMtaDevTFTPServerAddrOverrideFQDN 21 arrisMtaDevVbdOverwriteLineBitmap 113 arrisMtaDevVbdOverwriteMaxJitterBuffer 114 arrisMtaDevVbdOverwriteMinJitterBuffer 114 arrisMtaDevVbdOverwriteNomJitterBuffer 114 arrisMtaDevVPJitterBufferMode 113 arrisMtaDevVPMaxJitterBuffer 113 arrisMtaDevVPNomJitterBuffer 113 arrisMtaDevVqmEnable 106 arrisMtaDevVqmEnableRemote 106 arrisMtaDevVqmHistorySize 106 arrisWrmDevHpg 154, 161 arrisWrmDevLanDhcp 157 arrisWrmDevLanDomain 157 arrisWrmDevLanIpAddr 156 arrisWrmDevLanIpMask 156 arrisWrmDevLanIpPoolEnd 156 arrisWrmDevLanIpPoolStart 156 arrisWrmDevLanLease 157 arrisWrmDevNATEnable 156, 160 arrisWrmDevProvDLTime 161 arrisWrmDevProvFile 161 arrisWrmDevProvFileName 161 arrisWrmDevProvStatus 160 arrisWrmDevPwd 160 arrisWrmDevRip2AdvertisementInt 160 arrisWrmDevRip2KeyId 160 arrisWrmDevRip2Table 160 arrisWrmDevRipReceiveStatus 160 arrisWrmDevRipTransmitStatus 160 arrisWrmDevRmEnable 154 arrisWrmDevSaveSettings 156 arrisWrmDevWlanAp 157 arrisWrmDevWlanApConfigChannel 157, 171 arrisWrmDevWlanApConfigIndex 157 arrisWrmDevWlanApConfigLanAccess 160, 172 arrisWrmDevWlanApConfigMode 157 arrisWrmDevWlanApConfigProtec 158 arrisWrmDevWlanApConfigQos 158 arrisWrmDevWlanApConfigSsid 157 arrisWrmDevWlanApConfigSSidBroad 157 arrisWrmDevWlanApConfigTable 157–158 arrisWrmDevWlanApDhcpc 157 arrisWrmDevWlanApIsolationExtra 159, 172 arrisWrmDevWlanApIsolationInter 159, 172 arrisWrmDevWlanApPowerLevel 159, 170 arrisWrmDevWlanApSecuConfigEnable 158 arrisWrmDevWlanApSecuConfigIndex 158 arrisWrmDevWlanApSecuConfigTable 157–159 arrisWrmDevWlanApSecuConfigWep 158 arrisWrmDevWlanApSecuConfigWepK_gen 158 arrisWrmDevWlanApSecuConfigWepK_index 158 arrisWrmDevWlanApSecuConfigWepK_man 158 arrisWrmDevWlanApSecuConfigWepK_type 158 arrisWrmDevWlanApSecuConfigWpa2Obsecu 159 arrisWrmDevWlanApSecuConfigWpa2phrase 159 arrisWrmDevWlanApSecuConfigWpaEncry 159 arrisWrmDevWlanApSecuConfigWpaObsecu 159 arrisWrmDevWlanApSecuConfigWpaphrase 159 arrisWrmDevWlanQoSConfigEnable 159, 171 arrisWrmDevWlanQoSConfigHomeBandwidth 159, 171 arrisWrmDevWlanQoSConfigPrivateBandwidth 159, 171 arrisWrmDevWlanQoSConfigTotalBandwidth 159, 171 docDevEvSyslogAddressType 82 docsDevEventTable 81 docsDevEvSyslogAddress 82 docsDevResetNow 5, 14 docsDevSoftware 3, 17

281

docsDevSwAdminStatus 3–5, 17 docsDevSwFilename 13, 17 docsDevSwOperStatus 17, 80 docsDevSwServer 13, 17 docsDevSwServerAddress 17 docsDevSwServerAddressType 17 docsQosPktClassTable xvii dot1dTpFdbTable 155 DownstreamPacketClassification 118 esafeDevServiceIntImpact 9 firmware upgrade 6 ifAdminStatus 78, 119–120, 207 ifAdminStatus.10 120 ifAdminStatus.9 120 ifIndex 42, 69, 104–105 ifInOctets 69, 91 ifPhysAddress 35 ifTable 43 MaxCpeAllowed 68 PcIpClassification 118 PcIpSourcePortEnd 118 PcIpSourcePortStart 118 pktcDevEventTable 81 pktcDevEvFixedReporting 82, 84 pktcDevEvFixedTable 82, 84 pktcDevEvProgrammableReporting 84 pktcDevEvProgrammableTable 82, 84 pktcDevEvSyslogAddress 82, 84 pktcEnNcsEndPntFaxDetection 107 pktcEnNcsMinimumDtmfPlayout 107 pktcMtaDevCmsIpsecCtrl 20, 40 pktcMtaDevConfigFile 35 pktcMtaDevConfigHash 20, 28–29 pktcMtaDevCorrelationId 35 pktcMtaDevEnabled 119–120 pktcMtaDevEnableID 207 pktcMtaDevMacAddress 35 pktcMtaDevProvConfigHash 35 pktcMtaDevProvConfigKey 35 pktcMtaDevProvisioningEnrollment 35 pktcMtaDevProvisioningState 30 pktcMtaDevProvisioningStatus 35 pktcMtaDevSwCurrentVers 35 pktcMtaDevTypeIdentifier 35 pktcNcsEndPntConfigCallAgentId 207 pktcNcsEndPntConfigCallAgentUdpPort 207 pktcNcsEndPntConfigCallWaitingDelay 146 pktcNcsEndPntConfigCallWaitingMaxRep 146 pktcNcsEndPntConfigCriticalDialTO 120 pktcNcsEndPntConfigMaxHookFlash 49, 147 pktcNcsEndPntConfigMinHookFlash 49, 147 pktcNcsEndPntConfigPartialDialTO 120 pktcNcsEndPntStatusError 30 pktcSigDefCallSigDscp 149 pktcSigDefCallSigTos 149 pktcSigDefMediaStreamDscp 149 pktcSigDefMediaStreamTos 149 pktcSigDevCallerIdSigProtocol 141 pktcSigDevCIDDTASAfterLR 142 pktcSigDevCIDFskAfterDTAS 142 pktcSigDevCIDFskAfterRing 142 pktcSigDevCIDFskAfterRPAS 142 pktcSigDevCIDMode 49, 141 pktcSigDevCIDRingAfterFSK 142 pktcSigDevMultiFreqToneTable 49, 144, 146 pktcSigDevR0Cadence 241 pktcSigDevR7Cadence 241 pktcSigDevRgCadence 241 pktcSigDevRsCadence 241–242 pktcSigDevToneDbLevel 145 pktcSigDevToneFirstFrequency 144 pktcSigDevToneFourthFrequency 144


282

Chapter 10

pktcSigDevToneFreqAmpModePrtg 144 pktcSigDevToneFreqMode 144 pktcSigDevToneFreqRepeatCount 145 pktcSigDevToneNumber 144 pktcSigDevToneOffDuration 145 pktcSigDevToneOnDuration 145 pktcSigDevToneSecondFrequency 144 pktcSigDevToneSteady 144–145 pktcSigDevToneTable 49, 144, 146 pktcSigDevToneThirdFrequency 144 pktcSigDevToneType 144–145 pktcSigDevToneWholeToneRepeatCount 144–146 pktcSigDevVmwiDTASAfterLR 143 pktcSigDevVmwiFskAfterDTAS 143 pktcSigDevVmwiFskAfterRPAS 142 pktcSigDevVmwiMode 49, 142 pktcSigPowerRingFrequency 49, 141 ppCfgMtaCableTvEnable 91 ppCfgMtaCallpFeatureSwitch 52, 119 ppCfgMtaCountryTemplate 99, 144, 239 ppcfgMtaCountryTemplate 119 ppCfgMtaDevSPTestRootCertAdminStatus 87, 236, 238 ppCfgMtaDevSPTestRootCertFilename 87, 236, 238 ppCfgMtaDevSPTestRootCertServer 87, 236, 238 ppCfgMtaDevSPTestRootDownloadState 237 ppCfgMtaFeatureSwitch 68, 95, 104 ppCfgMtaTeleSyslogServIpAddr 82 ppCfgPortAdminState 207 ppCfgPortCallAgentName 207 ppCfgPortCallAgentUdpPort 207 ppCfgPortDialingMethod 49 ppCfgPortLoopCurrent 99 ppCfgPortMtaAdminState 207 ppCfgPortT38MaxDatagram 108 reference 203 rip2IfConfAuthType 160 rip2IfConfReceive 160 rip2IfConfSend 160 rip2IfConfTable 160 sipCfgAlertInfoR0 130, 190 sipCfgAlertInfoR1 130 sipCfgAlertInfoR2 131 sipCfgAlertInfoR3 131 sipCfgAlertInfoR4 131 sipCfgAlertInfoR5 131 sipCfgAlertInfoR6 131 sipCfgAlertInfoR7 131, 190 sipCfgAnonCallRejectionCapability 118, 192 sipCfgBusyDigitMap 129 sipCfgCallerIdDisplayCapability 118, 192 sipCfgCallerIdSendCapability 118, 192 sipCfgCallForwardCapability 118, 192 sipCfgCallForwardForbiddenNumbers 188 sipCfgCallHoldCapability 118, 192 sipCfgCallRedialCapability 118, 192 sipCfgCallReturnCapability 118, 192 sipCfgCallTransferCapability 118, 192 sipCfgCallWaitingCapability 118, 192 sipCfgCallWaitingStarCodeSurvivesReset 117, 188 sipCfgDefaultG711 43, 189 sipCfgDhcp60AnnouncementMode 134–135 sipCfgDialFeatActive 128–129 sipCfgDialFeatCode 127 sipCfgDialFeatMap 127 sipCfgDialFeatMode 128 sipCfgDialFeatName 127 sipCfgDialFeatTable 128–129, 191 sipCfgDialFeatTone 127 sipCfgDialProxyActive 126 sipCfgDialProxyCode 126 sipCfgDialProxyMap 126 sipCfgDialProxyMessageType 126

sipCfgDialProxyMethod 126 sipCfgDialProxyNumber 126 sipCfgDialProxyTable 191 sipCfgDialProxyTone 126 sipCfgDigitMap 120 sipCfgDomainOverride 124, 189 sipCfgEmergencyNumber 131, 188–189 sipCfgFeatureSettings 192 sipCfgGenLinger 124, 194 sipCfgInviteLinger 124, 194 sipCfgMaxRetrans 122, 124, 194 sipCfgMediaLoopbackNumber 133 sipCfgPacketizationRate 121 sipCfgPacketLoopbackNumber 133 sipCfgPenaltyBoxTimeout 71, 184 sipCfgPortCallByeDelay 131 sipCfgPortDisplayName 119 sipCfgPortFaxOnlyTimeout 130 sipCfgPortFeatureSettings 116, 121, 125, 190 sipCfgPortLogin 119 sipCfgPortMaxT38HSRedLevel 116 sipCfgPortPassword 120 sipCfgPortProxyAdr 115, 123 sipCfgPortProxyPort 115, 123 sipCfgPortProxyType 115, 123 sipCfgPortRegistrarAdr 115, 123 sipCfgPortRegistrarPort 115, 123 sipCfgPortRegistrarType 115, 123 sipCfgPortT38Mode 116, 130 sipCfgPortUserName 119–120 sipCfgPortWarmLineTimeout 128–129 sipCfgPortWarmOrHotlineNumber 128–129 sipCfgProvisionedCodecArray 43, 121 sipCfgProxyAdr 115, 120, 124 sipCfgProxyType 115, 120, 124 sipCfgRegExpires 122, 193 sipCfgRegistrarAdr 115, 120, 124 sipCfgRegistrarType 115, 120, 124 sipCfgRegTimerMax 36, 121, 193 sipCfgRegTimerMin 36, 121, 193 sipCfgRepeatDialing 186 sipCfgRepeatDialingInterval 129, 186, 188 sipCfgRepeatDialingSessionProgressTimer 130, 186, 188 sipCfgRepeatDialingTimeout 129, 188 sipCfgResetCallWaitingStarCode 117, 188 sipCfgSessionExpires 122 sipCfgSipFeatureSwitch 36, 71, 121 sipCfgT1 122, 124, 193 sipCfgT2 124 sipCfgT4 124 sipCfgThreeWayCallCapability 118, 192 sipCfgTimerB 194 sipCfgTimerF 124, 193–194 sysDescr 35 true 119 UpstreamPacketClassification 118 MIBs certificates, private 236 deprecated 209 duplicate 207 for root certificates 236 obsolete 207 obsolete battery 209 PacketCable OID changes 35 supported 203 minimizing service impacts, firmware upgrade 9 mode boost 98 considerations, downgrading, dual 11 fax-only 107, 130 feature switch, lockstep quarantine 52 selecting a provisioning 23


Index

modem support, G.729 46 modes DHCP parameters, provisioning 31 provisioning 19 monitoring provisioning status 78 MPTIME parameter feature switch, omit 54 SDP 54 MTA NCS, provisioning secure 85 coexistence feature switch 68 configuration file encryption, GUPI, with 22 example, SIP 221 feature switch 68 FQDN feature switch 73 functionality, controlling 98 maxCpeAllowed bypass feature switch 68 provisioning, SIP, refresh 123 mtaFilterBypass feature switch 68 multiple connections per line feature switch 56

N NCS loads to SIP, firmware upgrade, from earlier 8 TS4.5 SIP, firmware upgrade, from earlier 15 piggyback feature switch 52 provisioning secure MTA and 85 netwloop, SIP 133 networking, provisioning wireless mesh 164 netwtest, SIP 133 no ToD feature switch, halt on 69 non-sequential Caller ID feature switch 58 notes, provisioning 41 notification, TDD event 106 number, SIP emergency 131

O obsolete battery MIBs 209 MIBs 207 OID changes, MIBs, PacketCable 35 omit MPTIME parameter feature switch 54 Open Switch Interval 59 OPT177, discontinued loads 2 option support, DHCP 33 support, DHCP 34 support, DHCP 34 DHCP 82 options firmware upgrade 5 provisioning DHCP 134 required, DHCP 31 Organization Unique Identifier (OUI) 74 OSI, automatic 59 (OUI), Organization Unique Identifier 74 outbound method, Caller ID 117, 125 override DHCP, lease 34 feature switch, domain 73 feature switch, WAN isolation 70 SIP domain 124 over-temperature protection, configuring battery 92

P PacketACE 5 PacketCable support 69 feature switch, DQoS SF 54

283

event tables 82 OID changes, MIBs 35 provisioning 19 provisioning, interactions with QoS timeout 104 certificate 236 packetization rates 44 packets feature switch, count SYNC/MAP 69 forwarding IPv6 97 parameter feature switch, omit MPTIME 54 SDP, MPTIME 54 parameters feature switch, suppress SDP capability attribute 55 provisioning modes, DHCP 31 SDP, AES encryption 57 Payload configuring 56 feature switch 56 payload type 94 feature switch, RFC2833 57 PcIpClassification, MIB 118 PcIpSourcePortEnd, MIB 118 PcIpSourcePortStart, MIB 118 penalty box feature switch, SIP proxy 71 per-line proxy/registrar prohibited, post-provisioning 115 persistent, line status 108 phone example, DECT 225 PHS see Payload Header Suppression piggyback feature switch, NCS 52 pktcDevEventTable, MIB 81 pktcDevEvFixedReporting, MIB 82, 84 pktcDevEvFixedTable, MIB 82, 84 pktcDevEvProgrammableReporting, MIB 84 pktcDevEvProgrammableTable, MIB 82, 84 pktcDevEvSyslogAddress, MIB 82, 84 pktcEnNcsEndPntFaxDetection, MIB 107 pktcEnNcsMinimumDtmfPlayout, MIB 107 pktcMtaDevCmsIpsecCtrl, MIB 20, 40 pktcMtaDevConfigFile, MIB 35 pktcMtaDevConfigHash, MIB 20, 28–29 pktcMtaDevCorrelationId, MIB 35 pktcMtaDevEnabled, MIB 119–120 pktcMtaDevEnableID, MIB 207 pktcMtaDevMacAddress, MIB 35 pktcMtaDevProvConfigHash, MIB 35 pktcMtaDevProvConfigKey, MIB 35 pktcMtaDevProvisioningEnrollment, MIB 35 pktcMtaDevProvisioningState, MIB 30 pktcMtaDevProvisioningStatus, MIB 35 pktcMtaDevSwCurrentVers, MIB 35 pktcMtaDevTypeIdentifier, MIB 35 pktcNcsEndPntConfigCallAgentId, MIB 207 pktcNcsEndPntConfigCallAgentUdpPort, MIB 207 pktcNcsEndPntConfigCallWaitingDelay, MIB 146 pktcNcsEndPntConfigCallWaitingMaxRep, MIB 146 pktcNcsEndPntConfigCriticalDialTO, MIB 120 pktcNcsEndPntConfigMaxHookFlash, MIB 49, 147 pktcNcsEndPntConfigMinHookFlash, MIB 49, 147 pktcNcsEndPntConfigPartialDialTO, MIB 120 pktcNcsEndPntStatusError, MIB 30 pktcSigDefCallSigDscp, MIB 149 pktcSigDefCallSigTos, MIB 149 pktcSigDefMediaStreamDscp, MIB 149 pktcSigDefMediaStreamTos, MIB 149 pktcSigDevCallerIdSigProtocol, MIB 141 pktcSigDevCIDDTASAfterLR, MIB 142 pktcSigDevCIDFskAfterDTAS, MIB 142 pktcSigDevCIDFskAfterRing, MIB 142 pktcSigDevCIDFskAfterRPAS, MIB 142 pktcSigDevCIDMode, MIB 49, 141 pktcSigDevCIDRingAfterFSK, MIB 142


284

pktcSigDevMultiFreqToneTable, MIB 49, 144, 146 pktcSigDevR0Cadence, MIB 241 pktcSigDevR7Cadence, MIB 241 pktcSigDevRgCadence, MIB 241 pktcSigDevRsCadence, MIB 241–242 pktcSigDevToneDbLevel, MIB 145 pktcSigDevToneFirstFrequency, MIB 144 pktcSigDevToneFourthFrequency, MIB 144 pktcSigDevToneFreqAmpModePrtg, MIB 144 pktcSigDevToneFreqMode, MIB 144 pktcSigDevToneFreqRepeatCount, MIB 145 pktcSigDevToneNumber, MIB 144 pktcSigDevToneOffDuration, MIB 145 pktcSigDevToneOnDuration, MIB 145 pktcSigDevToneSecondFrequency, MIB 144 pktcSigDevToneSteady, MIB 144–145 pktcSigDevToneTable, MIB 49, 144, 146 pktcSigDevToneThirdFrequency, MIB 144 pktcSigDevToneType, MIB 144–145 pktcSigDevToneWholeToneRepeatCount, MIB 144–146 pktcSigDevVmwiDTASAfterLR, MIB 143 pktcSigDevVmwiFskAfterDTAS, MIB 143 pktcSigDevVmwiFskAfterRPAS, MIB 142 pktcSigDevVmwiMode, MIB 49, 142 pktcSigPowerRingFrequency, MIB 49, 141 policy daylight savings time 111 loop voltage management, setting 91 port range, provisioning dynamic RTP 10 3 ports IP 42 signaling 42 voice line 42 post-provisioning per-line proxy/registrar prohibited 115 SIP lines 123 ppCfgMtaCableTvEnable, MIB 91 ppCfgMtaCallpFeatureSwitch, MIB 52, 119 ppCfgMtaCountryTemplate, MIB 99, 144, 239 ppcfgMtaCountryTemplate, MIB 119 ppCfgMtaDevSPTestRootCertAdminStatus, MIB 87, 236, 238 ppCfgMtaDevSPTestRootCertFilename, MIB 87, 236, 238 ppCfgMtaDevSPTestRootCertServer, MIB 87, 236, 238 ppCfgMtaDevSPTestRootDownloadState, MIB 237 ppCfgMtaFeatureSwitch, MIB 68, 95, 104 ppCfgMtaTeleSyslogServIpAddr, MIB 82 ppCfgPortAdminState, MIB 207 ppCfgPortCallAgentName, MIB 207 ppCfgPortCallAgentUdpPort, MIB 207 ppCfgPortDialingMethod, MIB 49 ppCfgPortLoopCurrent, MIB 99 ppCfgPortMtaAdminState, MIB 207 ppCfgPortT38MaxDatagram, MIB 108 PRACK messages, SIP 182 priority, provisioning provisioning signaling 149 provisioning voice 149 privacy header feature switch, RFC3323 73 private MIBs, certificates 236 Service Provider Certificates 236 process, firmware upgrade 3 processing, hook flash 117, 125 prohibited, post-provisioning, per-line proxy/registrar 115 protection, configuring battery over-temperature 92 provisionable ring cadences feature switch 58 provisional response feature switch 56 provisioning 19, 39 CLI interaction with remote 162 considerations for European loads 35 DHCP options 134 DTM602 considerations 78

Chapter 10

dynamic RTP port range 103 echo cancellation tail 102 file error reporting, WRM 154 firmware upgrading, through 16 gain control 99 hook flash timing 147 interactions with QoS timeout, PacketCable 104 jitter buffer 113 methods, SIP 22 mode, selecting 23 modes 19 modes, DHCP parameters 31 notes 41 PacketCable 19 queue size 104 remote 162 restriction for EURO loads 20, 35 ring cadences 240 secure MTA and NCS 85 signaling priority 149 SIP, refresh MTA 123 status, monitoring 78 T.38 116 upstream buffer depth 104 voice priority 149 wireless mesh networking 164 WPA-Enterprise 167 proxy penalty box feature switch, SIP 71 proxy/registrar prohibited, post-provisioning, per-line 115 pulse example, gateway dial 219 support, dial 101

Q QoS DSx 41 PacketCable provisioning, interactions with 104 timeout, setting active 104 Quality of Service, Dynamic 41 quarantine endpoint, lockstep 52 mode feature switch, lockstep 52 queue size, provisioning 104

R rates, packetization 44 recorded charger temperature, highest 93 recovery, automatic call resource 108 redirect feature switch, CMS 57 REFER messages, SIP 182 reference, MIB 203 refresh MTA provisioning, SIP 123 reinit, DHCP 134 rejection handling, SIP call 71 related feature switch, RFC2833 64 relay, DTMF 43 remote loopback test 133 provisioning 162 provisioning, CLI interaction with 162 ringtone 72 remove authorization headers 72 Repeat Dialing feature, SIP 129 reporting configuring alarms and log 81 WRM provisioning file error 154 request, DHCP lease time 34 required, DHCP options 31 RESERVE feature switch, COMMIT or 57


Index

reset control feature switch, WRM 70 timer, loop voltage management 10 restriction for EURO loads, provisioning 20, 35 re-synchronization, time of day 110 RFC2131 138 RFC2388 end of event duration 108 RFC2833 43, 55, 107 DTMF interactions with 66 feature switch, send DTMF via 58 payload type 94 feature switch 57 related feature switch 64 RFC3323 privacy header feature switch 73 RFC3842 handshake feature switch 73 ring cadences feature switch, provisionable 58 cadences, provisioning 240 frequency, configuring 141 waveform, sinusoidal 102 waveform, trapezoidal 102 ringing configuring distinctive 130 waveform 102 ringtone, remote 72 rip2IfConfAuthType, MIB 160 rip2IfConfReceive, MIB 160 rip2IfConfSend, MIB 160 rip2IfConfTable, MIB 160 root certificates, MIBs for 236 RSIP wildcarding feature switch 55 RTCP ToS byte 107 RTP port range, provisioning dynamic 103 RTP/RTCP feature switch, AES encryption for 57 Rx/Tx gain, adjusting 101

S savings time policy, daylight 111 SDP AES encryption parameters 57 capability attribute parameters feature switch, suppress 55 capability descriptor, T.38-only 53 compliance feature switch 54 feature switch affecting 60 MPTIME parameter 54 secure MTA and NCS, provisioning 85 security, IP 40 selecting a provisioning mode 23 send DTMF via RFC2833 feature switch 58 service firmware upgrade, minimizing 9 firmware upgrade 40 Service private MIBs 236 certificate 236 setting active QoS timeout 104 allowed CPE counts 95 CLI timeout 92 policy, loop voltage management 91 shift feature switch, enable ifIndex 69 shutdown, controlling data 90 signaling ports 42 priority, provisioning 149 sinusoidal ring waveform 102 SIP BYE delay 131 call rejection handling 71 CM example 219 CODECs, supported by 121 dialing features supported 126

285

domain override 124 emergency number 131 feature switch 71 firmware upgrade, from earlier NCS loads to 8 firmware upgrade, from earlier NCS loads to TS4.5 15 hybrid features 128 INFO messages 182 lines, post-provisioning 123 loads, upgrading 16 local busy tone 71 loopback test 133 MTA example 221 netwloop 133 netwtest 133 PRACK messages 182 provisioning methods 22 proxy penalty box feature switch 71 REFER messages 182 refresh MTA provisioning 123 Repeat Dialing feature 129 T1 timer 122 T.38 configuration 130 sipCfgAlertInfoR0, MIB 130, 190 sipCfgAlertInfoR1, MIB 130 sipCfgAlertInfoR2, MIB 131 sipCfgAlertInfoR3, MIB 131 sipCfgAlertInfoR4, MIB 131 sipCfgAlertInfoR5, MIB 131 sipCfgAlertInfoR6, MIB 131 sipCfgAlertInfoR7, MIB 131, 190 sipCfgAnonCallRejectionCapability, MIB 118, 192 sipCfgBusyDigitMap, MIB 129 sipCfgCallerIdDisplayCapability, MIB 118, 192 sipCfgCallerIdSendCapability, MIB 118, 192 sipCfgCallForwardCapability, MIB 118, 192 sipCfgCallForwardForbiddenNumbers, MIB 188 sipCfgCallHoldCapability, MIB 118, 192 sipCfgCallRedialCapability, MIB 118, 192 sipCfgCallReturnCapability, MIB 118, 192 sipCfgCallTransferCapability, MIB 118, 192 sipCfgCallWaitingCapability, MIB 118, 192 sipCfgCallWaitingStarCodeSurvivesReset, MIB 117, 188 sipCfgDefaultG711, MIB 43, 189 sipCfgDhcp60AnnouncementMode, MIB 134–135 sipCfgDialFeatActive, MIB 128–129 sipCfgDialFeatCode, MIB 127 sipCfgDialFeatMap, MIB 127 sipCfgDialFeatMode, MIB 128 sipCfgDialFeatName, MIB 127 sipCfgDialFeatTable, MIB 128–129, 191 sipCfgDialFeatTone, MIB 127 sipCfgDialProxyActive, MIB 126 sipCfgDialProxyCode, MIB 126 sipCfgDialProxyMap, MIB 126 sipCfgDialProxyMessageType, MIB 126 sipCfgDialProxyMethod, MIB 126 sipCfgDialProxyNumber, MIB 126 sipCfgDialProxyTable, MIB 191 sipCfgDialProxyTone, MIB 126 sipCfgDigitMap, MIB 120 sipCfgDomainOverride, MIB 124, 189 sipCfgEmergencyNumber, MIB 131, 188–189 sipCfgFeatureSettings, MIB 192 sipCfgGenLinger, MIB 124, 194 sipCfgInviteLinger, MIB 124, 194 sipCfgMaxRetrans, MIB 122, 124, 194 sipCfgMediaLoopbackNumber, MIB 133 sipCfgPacketizationRate, MIB 121 sipCfgPacketLoopbackNumber, MIB 133 sipCfgPenaltyBoxTimeout, MIB 71, 184 sipCfgPortCallByeDelay, MIB 131


286

sipCfgPortDisplayName, MIB 119 sipCfgPortFaxOnlyTimeout, MIB 130 sipCfgPortFeatureSettings, MIB 116, 121, 125, 190 sipCfgPortLogin, MIB 119 sipCfgPortMaxT38HSRedLevel, MIB 116 sipCfgPortPassword, MIB 120 sipCfgPortProxyAdr, MIB 115, 123 sipCfgPortProxyPort, MIB 115, 123 sipCfgPortProxyType, MIB 115, 123 sipCfgPortRegistrarAdr, MIB 115, 123 sipCfgPortRegistrarPort, MIB 115, 123 sipCfgPortRegistrarType, MIB 115, 123 sipCfgPortT38Mode, MIB 116, 130 sipCfgPortUserName, MIB 119–120 sipCfgPortWarmLineTimeout, MIB 128–129 sipCfgPortWarmOrHotlineNumber, MIB 128–129 sipCfgProvisionedCodecArray, MIB 43, 121 sipCfgProxyAdr, MIB 115, 120, 124 sipCfgProxyType, MIB 115, 120, 124 sipCfgRegExpires, MIB 122, 193 sipCfgRegistrarAdr, MIB 115, 120, 124 sipCfgRegistrarType, MIB 115, 120, 124 sipCfgRegTimerMax, MIB 36, 121, 193 sipCfgRegTimerMin, MIB 36, 121, 193 sipCfgRepeatDialing, MIB 186 sipCfgRepeatDialingInterval, MIB 129, 186, 188 sipCfgRepeatDialingSessionProgressTimer, MIB 130, 186, 188 sipCfgRepeatDialingTimeout, MIB 129, 188 sipCfgResetCallWaitingStarCode, MIB 117, 188 sipCfgSessionExpires, MIB 122 sipCfgSipFeatureSwitch, MIB 36, 71, 121 sipCfgT1, MIB 122, 124, 193 sipCfgT2, MIB 124 sipCfgT4, MIB 124 sipCfgThreeWayCallCapability, MIB 118, 192 sipCfgTimerB, MIB 194 sipCfgTimerF, MIB 124, 193–194 size, provisioning queue 104 skip USM user name comparison feature switch 68 SNMP co-existence example 215 firmware upgrading, through 17 INFORM checks feature switch, bypass 68 SRV lookup feature switch 73 status firmware upgrade 80 monitoring provisioning 78 persistent, line 108 support DHCP option 43 33 DHCP option 51 34 DHCP option 60 34 dial pulse 101 DOCSIS 1.0 fragmentation 97 European flash 73 PacketCable 1.5 69 TLV-39 75 TLV-41 74 VMWI 49, 73 supported SIP, CODECs 121 CODECs 43 MIBs 203 SIP dialing features 126 suppress SDP capability attribute parameters feature switch 55 SYNC/MAP packets feature switch, count 69 sysDescr, MIB 35

Chapter 10

T T1 timer, SIP 122 T.38 capability descriptor feature switch 53 configuration 107 configuration, SIP 130 provisioning 116 T.38-only, SDP capability descriptor 53 tables, PacketCable event 82 TDD event notification 106 temperature, highest recorded charger 93 templates, country code 239 test remote, loopback 133 SIP loopback 133 TFTP timeout feature switch, disable 70 through provisioning, firmware upgrading 16 SNMP, firmware upgrading 17 time interaction with 110 re-synchronization 110 policy, daylight savings 111 timeout configuring ToD 110 feature switch, disable TFTP 70 setting active QoS 104 setting CLI 92 timer loop voltage management, reset 10 SIP T1 122 timing backoff/retry 136 feature switch, flash 58 default hook flash 239 TLV-11s, TLV-43, containing 74 TLV-39 support 75 TLV-41 support 74 TLV-43, containing TLV-11s 74 to EURO loads, upgrading 16 SIP, firmware upgrade, from earlier NCS loads 8 ToD see Time of day ToD feature switch, halt on no 69 timeout, configuring 110 tolerated grant jitter feature switch, DQoS 56 tone, SIP local busy 71 ToS byte, RTCP 107 field 149 traffic rate limiting 54 trapezoidal ring waveform 102 true, MIB 119 TS4.2 and earlier, firmware upgrading, from 18 TS4.5 SIP, firmware upgrade, from earlier NCS loads to 15

U updating Kerberos Key Distribution Center 85 KDC 85 upgrade example, firmware 216 from earlier NCS loads to SIP, firmware 8 from earlier NCS loads to TS4.5 SIP, firmware 15 MIB, firmware 6 minimizing service impacts, firmware 9 options, firmware 5 process, firmware 3 status, firmware 80


Index

287

upgrading firmware 2 from TS4.2 and earlier, firmware 18 SIP loads 16 through provisioning, firmware 16 through SNMP, firmware 17 to EURO loads 16 upstream buffer depth, provisioning 104 UpstreamPacketClassification, MIB 118 USB feature switch, disable 69 user name comparison feature switch, skip USM 68 using default, certificates 238 default root certificate 238 USM user name comparison feature switch, skip 68

V Vendor Class Identifier 34 Vendor Specific Information 33, 74 VMWI 59 support 49, 73 Voice Band Data 113 voice line ports 42 priority, provisioning 149 voltage management reset timer, loop 10 setting policy, loop 91

W Waiting Indicator, Message 73 WAN isolation override feature switch 70 warmline 128 example 223 waveform ringing 102 sinusoidal ring 102 trapezoidal ring 102 WDOCSIS load 2 WiDOX 2 wildcarding feature switch, RSIP 55 wireless mesh networking, provisioning 164 with MTA configuration file encryption, GUPI 22 RFC2833, DTMF interactions 66 WPA-Enterprise, provisioning 167 WRM configuration example 223 MaxCpeAllowed bypass feature switch 70 provisioning file error reporting 154 reset control feature switch 70 WTM552, MaxCPEAllowed interaction 95 WTM552/WTM652, MaxCPEAllowed interaction 153 WTM652, MaxCPEAllowed interaction 95


TS Provisioning R61S13

Recommend Documents